{"toc-home":[{"sectionHeader":null,"path":"/en-us/index","content":[" title: Welcome to the Amazon advanced tools center description: Welcome to the Amazon Ads advanced tools center. Learn more about our API, bulk operations, and Amazon Marketing Stream. date: 03/28/2023\n"," alerts:\n"],"documentType":"guide"},{"sectionHeader":null,"path":"/en-us/index","content":[" title: Welcome to the Amazon advanced tools center description: Welcome to the Amazon Ads advanced tools center. Learn more about our API, bulk operations, and Amazon Marketing Stream. date: 03/28/2023\n"," alerts:\n"],"documentType":"guide"}],"toc-developer-guides":[{"title":"Developer guides overview","sectionHeader":null,"path":"/en-us/guides/overview","content":[" Amazon Ads provides a number of advanced tools that give developers the ability to programmatically create and manage campaigns, as well as retrieve performance data.\n"],"documentType":"guide"},{"title":"Developer guides overview","sectionHeader":{"type":2,"text":"Use cases"},"path":"/en-us/guides/overview","content":[],"documentType":"guide"},{"title":"Developer guides overview","sectionHeader":{"type":3,"text":"Onboarding"},"path":"/en-us/guides/overview","content":[" To use all developer tools, you must first complete the onboarding process which includes registering an application and applying for access to the API. \n"],"documentType":"guide"},{"title":"Developer guides overview","sectionHeader":{"type":3,"text":"Reporting & measurement"},"path":"/en-us/guides/overview","content":[" Developers can use the Amazon Ads API and Amazon Marketing Stream to access performance metrics for Amazon Ads campaigns.\n"," The Ads API supports asynchronous report requests, while Amazon Marketing Stream provides near real-time access to metrics through your AWS account.\n","Request a report using the API - Get started with Amazon Marketing Stream\n"],"documentType":"guide"},{"title":"Developer guides overview","sectionHeader":{"type":3,"text":"Campaign management"},"path":"/en-us/guides/overview","content":[" You can also use the Amazon Ads API to create and manage sponsored ads and Amazon DSP campaigns. \n","Create a Sponsored Products campaign - Create a Sponsored Brands campaign - Create a Sponsored Display campaign (Amazon sellers or vendors) - Create a Sponsored Display campaign (advertisers that do not sell on Amazon)\n"],"documentType":"guide"},{"title":"Developer guides overview","sectionHeader":{"type":2,"text":"More information"},"path":"/en-us/guides/overview","content":["Full API reference - API best practices - Release notes - Support\n"],"documentType":"guide"},{"title":"Amazon Ads API Onboarding Overview","sectionHeader":null,"path":"/en-us/guides/onboarding/overview","content":[" The Amazon Ads API enables you to manage the advertising resources associated with an Amazon advertiser using a REST API.\n"," To use the Amazon Ads API, you must apply for access and be approved. Direct advertisers, partners, and integrators are all eligible to apply.\n"," Approved applicants can establish a client application through Login with Amazon (LwA) that serves as a credential for requests to the Amazon Ads API.\n"],"documentType":"guide"},{"title":"Amazon Ads API Onboarding Overview","sectionHeader":{"type":2,"text":"Establishing a client application"},"path":"/en-us/guides/onboarding/overview","content":[" This process does not require specific technical expertise. It includes three steps: \n","Create a Login with Amazon application. Requests to the Amazon Ads API are made by a client application administered by Login with Amazon. The client application is free to create, and no approval is required for this step.\n","Apply for permission to access the API. The application form includes questions about how your business intends to use the Amazon Ads API, as well as information about the Amazon Ads API License Agreement and the Data Protection Policy.\n","Assign API access to your LwA application. Once your application is approved, you will enable your LwA client application to make requests to the API.\n"],"documentType":"guide"},{"title":"Amazon Ads API Onboarding Overview","sectionHeader":{"type":2,"text":"First steps"},"path":"/en-us/guides/onboarding/overview","content":[" If you are ready to apply for access to the Amazon Ads API, start with step 1 of the onboarding process: Create a Login with Amazon application.\n"],"documentType":"guide"},{"title":"Create a Login with Amazon application","sectionHeader":null,"path":"/en-us/guides/onboarding/create-lwa-app","content":[" The first step in onboarding to the Amazon Ads API is to create a Login with Amazon (LwA) client application, which will later be used to make requests to the API.\n"," Once you have been approved to access the API, you will assign your access to this LwA application in a later step.\n"," To learn more about the role that LwA plays in the Amazon Ads API, see:\n","Amazon Ads API authorization overview - Login with Amazon (LwA) concepts\n"],"documentType":"guide"},{"title":"Create a Login with Amazon application","sectionHeader":{"type":2,"text":"Register with Amazon Developer"},"path":"/en-us/guides/onboarding/create-lwa-app","content":[" To create a Login with Amazon application, you must register as a developer on developer.amazon.com. \n"," To register as a developer, click Sign In.\n"," From the sign-in screen, either: \n","enter your email address and password to sign in with an existing Amazon account or - choose Create your Amazon Developer account to create a new account through Amazon Developer.\n"," You will be redirected to the developer registration page. Complete the form, accept the Amazon Developer Services Agreement, and select Submit.\n"],"documentType":"guide"},{"title":"Create a Login with Amazon application","sectionHeader":{"type":2,"text":"Create a new LwA security profile"},"path":"/en-us/guides/onboarding/create-lwa-app","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| After logging in to the Amazon Developer site using the account created above, click Developer Console. From the developer console, click Login with Amazon on the menu bar. | Login with Amazon |\n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| Click Create a New Security Profile. | Create a new security profile |\n"," You are redirected to the Security Profile Management page. In the form, enter:\n","Security Profile Name - Security Profile Description - Consent Privacy Notice URL\n"," For more information on these fields, see the LwA documentation.\n"," Select the Save button when you have entered this information.\n"],"documentType":"guide"},{"title":"Create a Login with Amazon application","sectionHeader":{"type":2,"text":"Retrieve your security credentials"},"path":"/en-us/guides/onboarding/create-lwa-app","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| After creating a new profile, you are redirected to the Login with Amazon page. This page includes a table that lists your security profile name and OAuth2 credentials. Locate the name of the security profile you created earlier, and click Show Client ID and Client Secret. | Show Client ID and Client Secret |\n"," Note these values, as they are essential credentials for accessing the Amazon Ads API. The client ID is passed in all requests to the API, and both the client ID and client secret are used to generate access tokens for the API. These values can be retrieved from this panel at any time.\n"],"documentType":"guide"},{"title":"Create a Login with Amazon application","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/onboarding/create-lwa-app","content":[" Once you have completed these steps, continue to the next step of the onboarding process: Apply for Advertising API access.\n"],"documentType":"guide"},{"title":"Apply for Amazon Ads API access","sectionHeader":null,"path":"/en-us/guides/onboarding/apply-for-access","content":[" Now that you have created an Amazon Developer account and a Login with Amazon application, the next step is to apply for access to the Amazon Ads API.\n"," How you apply for access will depend upon how your company intends to use the API. First, determine which of these categories best describes your business:\n","Partner : Businesses that build applications and software solutions to automate and help optimize advertising on behalf of others can access the Amazon Ads API as a third party. - Direct Advertiser : Advertisers that use the Amazon Ads API to automate, scale, and optimize advertising activities and reporting.\n"],"documentType":"guide"},{"title":"Apply for Amazon Ads API access","sectionHeader":{"type":2,"text":"To apply for API access as a Partner"},"path":"/en-us/guides/onboarding/apply-for-access","content":[" Partners will apply for API access through the Amazon Ads Partner Network, a self-service hub for agencies and tool providers to manage their business relationships with Amazon Ads. If your company has not registered for the Amazon Ads Partner Network, please do so by following the link above.\n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| Once registered, log-in to the Amazon Ads Partner Network Console. Select API Applications from the menu on the left, then click Request API Access.  | Screenshot of Partner Network menu |\n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| Next, from the Advertising API tab, click the Request API access button in the message box at top right. Complete the application form. Select Submit for review. | Screenshot of Partner Network \"Advertising API\" tab |\n","| IMAGE |  |\n","\\| ---- \\| ---- \\|\n","|  Complete the application form. At the bottom of the form, indicate which existing LwA applications you would like to link to your Partner Network account. Once you (i) are approved for API access and (ii) have assigned scope to the LwA application, then it will be linked to your Partner Network account. Until then, it will stay in a pending state once requested. See Next steps for further details on scope assignment, etc. | Screenshot of Partner Network application form |\n"],"documentType":"guide"},{"title":"Apply for Amazon Ads API access","sectionHeader":{"type":2,"text":"To apply for API access as a Direct Advertiser"},"path":"/en-us/guides/onboarding/apply-for-access","content":[" Direct advertisers may go directly to the application form by clicking the link below:\n","Apply for API access as a Direct Advertiser\n"," Sign in using the email address you used to create the Amazon Developer account.\n"," Next, complete the application form. Select Submit for review.\n"],"documentType":"guide"},{"title":"Apply for Amazon Ads API access","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/onboarding/apply-for-access","content":[" You should receive an email at the address you used to log in above to confirm receipt of your application.\n"," Review of your application may take up to 1 business day. Once your application has been reviewed, you will receive an email detailing your application status.\n"," If your application has been approved, read about the next step in the onboarding process: Assign API access to your LwA application. If your application is not approved, you will receive information about how to resolve the issue.\n"],"documentType":"guide"},{"title":"Apply for Amazon Ads API access","sectionHeader":{"type":3,"text":"Additional steps for the data provider API"},"path":"/en-us/guides/onboarding/apply-for-access","content":[" If you are setting up an account for the data provider API, there is an additional step to complete. \n"],"documentType":"guide"},{"title":"Assign API access to a Login with Amazon application","sectionHeader":null,"path":"/en-us/guides/onboarding/assign-api-access","content":[" Onboarding: Overview | 1. Create LwA client | 2. Apply for API access | 3. Assign access\n"," If your request for API access is approved by Amazon, you will receive an email from Amazon Ads. Click the link in this email to open a web page where you can assign API access to the Login with Amazon (LwA) application you created in step 1.\n"],"documentType":"guide"},{"title":"Assign API access to a Login with Amazon application","sectionHeader":{"type":2,"text":"Select your LwA application"},"path":"/en-us/guides/onboarding/assign-api-access","content":[" After clicking the link, you will see a message reminding you to create a client application through Login with Amazon as described in step 1 of this onboarding walkthrough. If you already completed step 1, click Continue to see a list of the LwA applications associated with the logged-in account. \n"," Select the Login with Amazon application you created in step 1 and click Submit. \n"," Once you have clicked the Submit button, you will see a confirmation page showing the client ID of your LwA application along with the scopes that your application can now use to request permission from user accounts to access data and services:\n","advertising::campaign_management: The required scope for most requests to the Amazon Ads API. - advertising::test:create_account: The required scope for creating test accounts.\n"," You will primarily use advertising::campaign_management to access data and services through the API.\n"],"documentType":"guide"},{"title":"Assign API access to a Login with Amazon application","sectionHeader":{"type":3,"text":"Additional recommended steps for members of the Amazon Ads Partner Network"},"path":"/en-us/guides/onboarding/assign-api-access","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| If you indicated in the form from step 2 which LwA application you would like to link and have now assigned scope, you should see that the application now shows as linked in your Partner Network Account under API applications. | Screenshot of Partner Network applications interface |\n"," If for any reason you did not request to link the relevant LwA application in the form from step 2, you can still choose to link an LwA application (with Ads scope) at this stage by navigating to API applications and then selecting Link application.\n"],"documentType":"guide"},{"title":"Assign API access to a Login with Amazon application","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/onboarding/assign-api-access","content":[" Your LwA client application for the Amazon Ads API has now been established. Any Amazon user account can now authorize your LwA application to access that account's advertising data and services through the API.\n"," From this point, you will use this Login with Amazon application to create and manage authorization credentials, which must be passed in the headers of any request to the API.\n"," To begin, see Getting started.\n"],"documentType":"guide"},{"title":"Additional setup steps for the data provider API","sectionHeader":null,"path":"/en-us/guides/onboarding/data-provider-api","content":[" This document describes the additional setup steps required to onboard an application to use the data provider API. \n"],"documentType":"guide"},{"title":"Additional setup steps for the data provider API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/onboarding/data-provider-api","content":[" Before moving on to the additional setup steps for the data provider API, verify that you have completed all the account setup steps for all APIs.\n"," As part of the API onboarding process, you were invited via email to use Jira for technical support. You must have followed the steps in the invitation and created a Jira account before you continue with setup for the data provider API. \n"],"documentType":"guide"},{"title":"Additional setup steps for the data provider API","sectionHeader":{"type":2,"text":"Submit an onboarding request in Jira"},"path":"/en-us/guides/onboarding/data-provider-api","content":[" To gain access to the data provider API, submit a support ticket via Jira stating that you would like to be onboarded to use the data provider API. Select /dp Data Provider as the Symptom Path when submitting the ticket. \n"," You will receive a response through Jira.\n"],"documentType":"guide"},{"title":"Additional setup steps for the data provider API","sectionHeader":{"type":2,"text":"Additional billing report setup steps (optional)"},"path":"/en-us/guides/onboarding/data-provider-api","content":[" Amazon Ads provides data provider monthly audience usage delivered in billing reports. Integrators who create segments with positive CPM will need to set up billing reports during the onboarding process. \n"," Billing reports are typically available on the 11th day of each month. These reports are delivered to an Amazon S3 bucket to which your authorized AWS Identity and Access Management (IAM) users or roles have access. \n"],"documentType":"guide"},{"title":"Additional setup steps for the data provider API","sectionHeader":{"type":3,"text":"Prerequisites"},"path":"/en-us/guides/onboarding/data-provider-api","content":[" Before you begin the additional billing report setup steps, you must have an AWS account. If you do not have an existing AWS Account, create a new AWS account now.\n"," A billing account is associated with one or more AWS Identity Access Management (IAM) users or roles. If you are not familiar with IAM, we recommend that you read and understand the topics in the What is IAM? documentation. After you have read this documentation, you will understand the differences between users and roles and will be able to decide if you should manage access to your billing reports using a role, a user, or both. \n"," If you have decided to create one or more users, you must complete this step before continuing with billing setup. If you have decided to create one or more roles, you must complete this step before continuing with billing setup.\n"],"documentType":"guide"},{"title":"Additional setup steps for the data provider API","sectionHeader":{"type":3,"text":"Billing report setup"},"path":"/en-us/guides/onboarding/data-provider-api","content":[" Make note of the IAM Amazon Resource Name (ARN) that you created in the prerequisites.\n"," Next, create a Jira support ticket with the title Access Request - Billing Request Access to Billing Reports. In the body of the support ticket, enter the following:\n"," Once your Jira ticket has been processed, you will receive a confirmation email that includes billing report access instructions.\n"],"documentType":"guide"},{"title":"Additional setup steps for the data provider API","sectionHeader":{"type":3,"text":"Steps to be able to raise invoices (optional)"},"path":"/en-us/guides/onboarding/data-provider-api","content":[" If you expect to charge audience fees, you will need to onboard to Payee Central to be able to raise invoices. You need to onboard to Payee Central for every country you want to do business in. Please follow the following steps:\n","Payee Central eLearning Portal is available to guide you through the onboarding process.\n","If you need additional assistance, you can sign up for our Payee Central Office Hours.\n","For assistance with Payee Central and any related onboarding/ongoing tasks, reach out using the Contact Us tab in Payee Central.\n"],"documentType":"guide"},{"title":"Additional setup steps for the data provider API","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/onboarding/data-provider-api","content":[" Now that you have onboarded to the data provider API, you can make API calls. To begin, learn how to create API authorization tokens.\n"],"documentType":"guide"},{"title":"Amazon Ads API Getting Started Overview","sectionHeader":null,"path":"/en-us/guides/get-started/overview","content":[" The Amazon Ads API enables you to manage the advertising resources associated with an Amazon advertiser using a REST API. Three credentials are required to authorize most requests to the API:\n","the client ID of a Login with Amazon application - an access token representing permission for the client application to act on behalf of a user account - the profile ID for the advertising account of the user in a specific marketplace\n"," This guide explains how to retrieve these required credentials.\n"],"documentType":"guide"},{"title":"Amazon Ads API Getting Started Overview","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/get-started/overview","content":[" To complete this guide, you will need:\n","A Login with Amazon client application approved to use the Amazon Ads API. If you have not yet established an approved client, see Onboarding. - Login credentials for an Amazon user account that manages Amazon Ads accounts. (If you do not have login credentials for an Amazon Ads account, learn about test accounts.)\n"],"documentType":"guide"},{"title":"Amazon Ads API Getting Started Overview","sectionHeader":{"type":2,"text":"Steps in this process"},"path":"/en-us/guides/get-started/overview","content":[" Retrieving credentials to access data and services for an advertiser involves three steps:\n","Create an authorization grant for an advertising account. Enable an advertising user account to grant access to your LwA client.\n","Generate access and refresh tokens. Redeem the authorization grant for an access token, which is used to call the API, and a refresh token, which is used to generate new access tokens.\n","Retrieve a profile. Retrieve a profile ID representing the user account in a specific advertising marketplace.\n"," Along with your LwA client ID, the access token and profile ID retrieved here can be used to authorize future requests to the API.\n"],"documentType":"guide"},{"title":"Amazon Ads API Getting Started Overview","sectionHeader":{"type":2,"text":"Get started"},"path":"/en-us/guides/get-started/overview","content":[" If you are ready to begin calling the Amazon Ads API, follow one of these two pathways:\n","\"Getting Started\" walkthrough\n","Amazon Ads API Postman collection\n"],"documentType":"guide"},{"title":"Getting started - Create an authorization grant","sectionHeader":null,"path":"/en-us/guides/get-started/create-authorization-grant","content":[" Getting started : Overview | 1. Create auth grant | 2. Generate access token | 3. Retrieve profiles\n"," As described in the \"Getting Started\" overview, an approved client application may make calls to the Amazon Ads API on behalf of an Amazon user account with access to Amazon Ads accounts.\n"," The relationship between client application and user account is administered by Login with Amazon (LwA). The user account must explicitly grant authorization to the client application through the LwA Authorization Code Grant process to generate an authorization code as described below.\n","To learn more about authorization in the Amazon Ads API, see the Authorization overview.\n"," There are two scenarios for requesting and granting authorization to access the advertising data and services associated with a user account:\n","Direct Advertiser : You want to use the API to access the advertising data and services associated with your own Amazon account. - Partner : A third party wants to authorize you to access the advertising data and services associated with their Amazon account.\n"," For either scenario, you will create an authorization URL.\n"],"documentType":"guide"},{"title":"Getting started - Create an authorization grant","sectionHeader":{"type":2,"text":"Create an authorization URL"},"path":"/en-us/guides/get-started/create-authorization-grant","content":[" To retrieve an authorization code, create an authorization URL that enables a user account to grant authorization to your client application. This process involves three steps:\n","Allow a return URL - Determine the URL prefix for your region - Determine the values for the required query parameters\n"],"documentType":"guide"},{"title":"Getting started - Create an authorization grant","sectionHeader":{"type":3,"text":"Allow a return URL"},"path":"/en-us/guides/get-started/create-authorization-grant","content":[" Log in to the Amazon Developer console using your Amazon Developer account and select Login with Amazon from the top menu. \n"," Choose the security profile you used to apply for API access, move your mouse to the \"gear\" icon under Manage on the right side of the screen, and select Web Settings from the menu.\n"," From the Web Settings panel, click Edit. Add a valid address in the Allowed Return URLs field and click Save. \n"],"documentType":"guide"},{"title":"Getting started - Create an authorization grant","sectionHeader":{"type":3,"text":"Determine the URL prefix for your region"},"path":"/en-us/guides/get-started/create-authorization-grant","content":[" Login with Amazon implements a different authorization URL prefix for each region. The prefix determines which Amazon account system the user signs into at consent time, so use the prefix that matches the advertiser's marketplace. For example, if a Japanese advertiser is directed to the NA prefix (amazon.com/ap/oa), they will sign in with their amazon.com account rather than their amazon.co.jp account, which may have no advertising access.\n","| Region | URL prefix | \n","\\|--------\\|------------\\|\n","| North America (NA) | https://www.amazon.com/ap/oa |\n","| Europe (EU) | https://eu.account.amazon.com/ap/oa |\n","| Far East (FE) | https://apac.account.amazon.com/ap/oa |\n"],"documentType":"guide"},{"title":"Getting started - Create an authorization grant","sectionHeader":{"type":3,"text":"Determine the values for the required query parameters"},"path":"/en-us/guides/get-started/create-authorization-grant","content":[" The authorization URL has the following query parameters:\n","| Parameter | Description |\n","\\|-----------\\|-------------\\|\n","| client_id | The Client ID associated with your Login with Amazon client application. For information on locating your client ID, see Create a Login with Amazon application. |\n","| scope | The OAuth 2.0 permission scope used to limit access of the application to the account of an advertiser. For the DSP, Sponsored Brands, Sponsored Display, Sponsored Products, and Amazon Attribution APIs, set scope to advertising::campaign_management. For the Data Provider API, set scope to advertising::audiences.|\n","| response_type | The type of response. Always set to code. |\n","| redirect_uri | The value from the Allowed Return URLs field of your Login with Amazon security profile, as set above. |\n"," To generate an authorization code in the North America (NA) region, replace YOUR_LWA_CLIENT_ID and YOUR_RETURN_URL in the URL below with your values:\n"," For instance, given the following values:\n","Client ID: amzn1.application-oa2-client.12345678901234567890 - Return URL: https://amazon.com\n"," The authorization grant URL would resemble:\n"],"documentType":"guide"},{"title":"Getting started - Create an authorization grant","sectionHeader":{"type":2,"text":"To grant access to your *own* Amazon Ads data"},"path":"/en-us/guides/get-started/create-authorization-grant","content":[" For instructions on gaining access to a third party's data, see \"To gain access to a third party's Amazon Ads data\" below.\n"," If you are granting permission to access your own advertising data and services, follow these steps:\n","Paste the authorization URL determined above into the address bar of your browser. Navigate to the URL.\n","Sign in using an Amazon user account with access to the Amazon Ads accounts you want to manage through the API. This account may not be the same as the Amazon Developer account you used to create the LwA client.\n","You will be redirected to a consent form listing the specific data and services included in the authorization grant. To grant access, select Allow.\n","You will be redirected to the redirect_uri that you specified previously, with query parameters appended to the URL. Copy the address from the address bar of your browser, and note the value of the code parameter (the xxxx in the example below):\n"],"documentType":"guide"},{"title":"Getting started - Create an authorization grant","sectionHeader":{"type":2,"text":"To gain access to a third party's Amazon Ads data"},"path":"/en-us/guides/get-started/create-authorization-grant","content":[" If you are requesting that a third party grant access to their advertising data and services, follow these steps: \n","Send the authorization URL determined above to the third party, with instructions to paste the URL into the address bar of their browser and navigate to the URL.\n","Instruct the third party to sign in using the Amazon user account that has access to the Amazon Ads accounts for which they wish to grant authorization.\n","The third party will be redirected to a consent form listing the specific data and services included in the authorization grant. Instruct the third party to select Allow if they consent to sharing these data and services with you.\n","They will be redirected to the redirect_uri that you specified previously, with query parameters appended to the URL. Instruct the third party to send this URL to you.\n"," Note the value of the code parameter (the xxxx in the example below):\n"],"documentType":"guide"},{"title":"Getting started - Create an authorization grant","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/get-started/create-authorization-grant","content":[" The code parameter in the redirect URL is an authorization code, which you can now use in the next step of the onboarding process: Retrieve access and refresh tokens.\n"],"documentType":"guide"},{"title":"Getting started - Generate access and refresh tokens","sectionHeader":null,"path":"/en-us/guides/get-started/retrieve-access-token","content":[" As described in the \"Getting Started\" overview, an approved client application may make calls to the Amazon Ads API on behalf of an Amazon user account with access to Amazon Ads accounts.\n"," In step 1 of the \"Getting started\" walkthrough, you created an authorization grant representing the agreement of a user account to enable access for your client application. To represent that agreement, Login with Amazon created an authorization code, which you will use to retrieve an access token for calling the API.\n","For a conceptual overview of access and refresh tokens in the Amazon Ads API, see Access Tokens.\n"," To create access and refresh tokens, follow these steps:\n"],"documentType":"guide"},{"title":"Getting started - Generate access and refresh tokens","sectionHeader":{"type":2,"text":"Retrieve your client ID and client secret"},"path":"/en-us/guides/get-started/retrieve-access-token","content":[" Sign in to Amazon Developer with the Amazon account you used to create your Login with Amazon client. Navigate to the Login with Amazon console and locate the client ID and client secret for the security profile to which you assigned API access in an earlier step.\n","For information on locating your client ID and client secret, see Create a Login with Amazon Application.\n"],"documentType":"guide"},{"title":"Getting started - Generate access and refresh tokens","sectionHeader":{"type":2,"text":"Call the authorization URL to request access and refresh tokens"},"path":"/en-us/guides/get-started/retrieve-access-token","content":[" To retrieve access and refresh tokens, select the authorization URL for your region:\n","| Region | Authorization URL |\n","\\|--------\\|-----\\|\n","| North America (NA) | https://api.amazon.com/auth/o2/token |\n","| Europe (EU) | https://api.amazon.co.uk/auth/o2/token |\n","| Far East (FE) | https://api.amazon.co.jp/auth/o2/token |\n"," Next, construct a POST request to retrieve access and refresh tokens. This request has the following query parameters:\n","| Parameter | Description |\n","\\|-----------\\|-------------\\|\n","| grant_type | Must be authorization_code.  |\n","| code | The authorization code retrieved in step 1. Note this code expires after 5 minutes. A new code may be generated by repeating the same steps. |\n","| redirect_uri | One of the values in the Allowed Return URLs field in your Login with Amazon account. |\n","| client_id | The Client ID of your Login with Amazon account. |\n","| client_secret | The Client Secret of your Login with Amazon account. |\n"," For example, to retrieve access and refresh tokens using cURL, substitute your values in the following request:\n"],"documentType":"guide"},{"title":"Getting started - Generate access and refresh tokens","sectionHeader":{"type":2,"text":"Access token response"},"path":"/en-us/guides/get-started/retrieve-access-token","content":[" The response to a successful token request is a JSON object with the following schema:\n","| Field | Description |\n","\\|-------\\|-------------\\|\n","| access_token | The access token. |\n","| token_type | The type of OAuth 2.0 token. Always set to bearer. |\n","| expires_in | The length of time until the access token expires, in seconds.|\n","| refresh_token | The refresh token. |\n"," For example:\n"," Note that access tokens are valid for 60 minutes. A new access token can be generated at any time using the refresh token. Refresh tokens issued on or after July 30, 2026 expire 365 days from the date of advertiser consent; refresh tokens issued before July 30, 2026 do not have a fixed expiration. For details, see Refresh tokens.\n"],"documentType":"guide"},{"title":"Getting started - Generate access and refresh tokens","sectionHeader":{"type":2,"text":"Using refresh tokens"},"path":"/en-us/guides/get-started/retrieve-access-token","content":[" Once tokens have been retrieved using the authorization code, a new access token can be retrieved at any time using the refresh token. A call using the refresh token can be made to the same URL determined above, but will include different parameters.\n","For more information, see Refresh tokens.\n"],"documentType":"guide"},{"title":"Getting started - Generate access and refresh tokens","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/get-started/retrieve-access-token","content":[" You now have the two essential credentials for a successful request to the Amazon Ads API:\n","The client ID of your Login with Amazon client application - The access token that enables your client to access advertising data and services for a particular user account\n"," However, as described in the \"Getting Started\" overview, the majority of requests to the API require using profiles to access data and services in a specific marketplace. \n"," To retrieve a list of profiles for an account, continue to the next step in the onboarding process: Retrieve a profile ID.\n"],"documentType":"guide"},{"title":"Onboarding Step 6 - Retrieve and use a profile ID","sectionHeader":null,"path":"/en-us/guides/get-started/retrieve-profiles","content":[" As described in the \"Getting Started\" overview, there are two essential authorization credentials for calling the Amazon Ads API:\n","The client ID of a Login with Amazon (LwA) client application that is approved for API access. - An access token representing permission for that client to access resources on behalf of an Amazon user account that manages Amazon Ads accounts.\n"," In addition, nearly all requests to the API require a profile ID representing the advertising account of the user in a specific marketplace. Once you have generated an access token, follow the steps below to retrieve a profile ID for use in requests to the API.\n","To review the steps so far, see the \"Getting Started\" overview. - For conceptual information regarding profiles in the Amazon Ads API, see Profiles.\n"],"documentType":"guide"},{"title":"Onboarding Step 6 - Retrieve and use a profile ID","sectionHeader":{"type":2,"text":"Access the Profiles resource"},"path":"/en-us/guides/get-started/retrieve-profiles","content":[" To retrieve a list of available profiles, make a GET request to the /v2/profiles endpoint in a region where the user account manages advertising accounts.\n","For a list of regional hosts, see API Endpoints. - For technical specifications, see the Profiles OpenAPI specification.\n"," For a user account that manages an advertising account in the MX marketplace, for instance, the request should be directed to the host for North America:\n"," The request has two required headers:\n","Amazon-Advertising-API-ClientId: The client identifier of the LwA client application. - Authorization: The string Bearer prepended to the access token.\n"," For a call to the North American host using cURL, substitute your values in the following request:\n"],"documentType":"guide"},{"title":"Onboarding Step 6 - Retrieve and use a profile ID","sectionHeader":{"type":3,"text":"Profiles response"},"path":"/en-us/guides/get-started/retrieve-profiles","content":[" The response to a successful call at this endpoint includes a list of profiles associated with the user account in the region of the API host.\n"," For example, the response from the North American host for a user account that manages exactly one advertising account (in the MX marketplace) would resemble the following:\n"],"documentType":"guide"},{"title":"Onboarding Step 6 - Retrieve and use a profile ID","sectionHeader":{"type":2,"text":"Pass the profile ID in subsequent requests"},"path":"/en-us/guides/get-started/retrieve-profiles","content":[" Aside from the /v2/profiles endpoint, requests to the Amazon Ads API can access resources for only one profile. The selected profile is determined by the profile ID passed as the Amazon-Advertising-API-Scope header.\n"," For subsequent requests to the API, you will pass your client ID, your access token, and a profile ID as the values for three required headers:\n","Amazon-Advertising-API-ClientID: Your client ID. - Authorization: The string Bearer prepended to the access token. - Amazon-Advertising-API-Scope: The profile ID for an advertising account in a specific marketplace.\n"],"documentType":"guide"},{"title":"Onboarding Step 6 - Retrieve and use a profile ID","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/get-started/retrieve-profiles","content":[" To get started using your credentials, see Making your first call.\n"],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":null,"path":"/en-us/guides/get-started/using-postman-collection","content":[" The Amazon Ads API Postman collection includes scripts to ease the management of authentication and authorization credentials for calling the API, as well as pre-built requests for demonstrating common uses of the API.\n"," As an alternative to our getting started walkthrough, many first-time callers may find Postman useful for understanding the API. \n"," The quick setup below offers step-by-step instructions for configuring the Postman collection to make requests to the API.\n"],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/get-started/using-postman-collection","content":[" To complete this guide, you will need:\n","The client ID and client secret of a Login with Amazon client application approved to use the Amazon Ads API. See Onboarding if you have not yet been approved for access. - Login credentials for an Amazon user account that manages Amazon Ads accounts. - Postman, a third-party tool that allows developers to make API calls via a user interface. You can use either the desktop or web-based application.\n"],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":{"type":2,"text":"Quick setup"},"path":"/en-us/guides/get-started/using-postman-collection","content":[],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":{"type":3,"text":"Import the collection and environment files"},"path":"/en-us/guides/get-started/using-postman-collection","content":["Download the Postman environment file and collection file from GitHub. 2. Import both files into Postman. To verify the import: 3. From the Environments selector, select the Amazon Ads API Environment to activate the environment. \n"],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":{"type":3,"text":"Configure the environment"},"path":"/en-us/guides/get-started/using-postman-collection","content":["From the left sidebar, select Environments, then select the Amazon Ads API Environment. 2. Manually set the Current Value for the following variables:\n","Save the changes to your environment.\n"],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":{"type":3,"text":"Generate an authorization grant code"},"path":"/en-us/guides/get-started/using-postman-collection","content":["From the Postman left sidebar, go to Collections > Amazon Ads API. 2. Select the Auth folder in the collection, then locate the GET Auth grant login request. 3. Open the Console in the Postman footer. 4. Send the request. This action tests the URL in the Postman preview window and logs the appropriate URL to the Postman console. 5. Copy the authorization grant URL from the console, visit the location in a web browser, and log in with an Amazon user account that manages Amazon Ads accounts. \n","You are redirected to the redirect_uri that you set in your environment file. An authorization grant code is appended to this URL as the code query parameter. \n"," The address in the URL bar of your browser should resemble the following, where XXXXX is the authorization grant code:\n"," Note this code for use in the next step. The authorization code represents permission from the user account for your client application to access the advertising data and services of that account.\n"],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":{"type":3,"text":"Retrieve access and refresh tokens"},"path":"/en-us/guides/get-started/using-postman-collection","content":["From the Auth folder of the collection, select the POST Access token from auth grant request. 2. In the Body of this request, find the code parameter and enter the code retrieved in the previous step. 3. Send the request.\n"," A successful request sets the access_token and refresh_token variables in your environment. \n"],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":{"type":3,"text":"Retrieve a profile ID"},"path":"/en-us/guides/get-started/using-postman-collection","content":["Select the Accounts folder in the collection. 2. Select the GET Profiles request and Send the request.\n"," The response to this request is a list of profiles, each of which represents the Amazon Ads account of the user account in a particular marketplace.\n"," By default, a script in the collection sets the profileId variable in the environment to the first profile returned in the response. This value is used in subsequent calls. To learn more about profiles, see Profiles.\n"],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/get-started/using-postman-collection","content":[" Your Postman environment now has the required credentials to make other requests to the Amazon Ads API:\n","Your client ID - An access token - A profile ID\n"," The Postman collection is configured to include these values in the headers for subsequent requests.\n"," To test a typical first call to the API, see Making your first call.\n"],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":{"type":2,"text":"Optional changes"},"path":"/en-us/guides/get-started/using-postman-collection","content":[],"documentType":"guide"},{"title":"Getting started - Using the Amazon Ads API Postman collection","sectionHeader":{"type":3,"text":"Regions"},"path":"/en-us/guides/get-started/using-postman-collection","content":[" The provided environment is configured to call the North American host for the Amazon Ads API. To access advertising data and services in Europe or Asia, change the api_url , auth_grant_url, and token_url variables in the environment to the appropriate regional hosts.\n","| Region | api_url | auth_grant_url | token_url |\n","\\| ------ \\| --------- \\| ---------------- \\| ----------- \\|\n","| NA | https://advertising-api.amazon.com | https://www.amazon.com/ap/oa | https://api.amazon.com/auth/o2/token |\n","| EU | https://advertising-api-eu.amazon.com | https://eu.account.amazon.com/ap/oa | https://api.amazon.co.uk/auth/o2/token |\n","| FE | https://advertising-api-fe.amazon.com | https://apac.account.amazon.com/ap/oa | https://api.amazon.co.jp/auth/o2/token |\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":null,"path":"/en-us/guides/get-started/first-call","content":[" You can use the Ads API for campaign management, reporting, and more. This tutorial helps you understand how to list all of your active sponsored ads (Sponsored Products, Sponsored Brands, and Sponsored Display) campaigns using the relevant GET campaigns endpoint.\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/get-started/first-call","content":[" To complete this tutorial, make sure you have:\n","Access to the Ads API - A Login with Amazon application client ID - A valid access token - A profile ID for an Amazon Ads account (for campaign management) - An advertising account ID (for reporting and cross-product operations)\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/get-started/first-call","content":[],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"URL prefixes"},"path":"/en-us/guides/get-started/first-call","content":[" The prefix you should use when calling the Ads API is based on the geography of the profile used in the request.\n","| URL | Region and marketplaces |\n","\\| --- \\| --- \\|\n","| https://advertising-api.amazon.com | North America (NA). Covers US, CA, MX, and BR marketplaces. |\n","| https://advertising-api-eu.amazon.com | Europe (EU). Covers UK, FR, IT, ES, DE, NL, SE, PL, BE, ZA, EG, AE, SA, TR, and IN marketplaces. |\n","| https://advertising-api-fe.amazon.com | Far East (FE). Covers JP, AU, and SG marketplaces. |\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"Headers"},"path":"/en-us/guides/get-started/first-call","content":[" Most calls to the Amazon Ads API require common headers:\n","| Header | Required? | Description | \n","\\|--------\\|-----------\\|-------------\\|\n","| Amazon-Ads-ClientId | Yes | The client ID related to a Login with Amazon application. |\n","| Authorization | Yes | A valid API access token in the format Bearer access_token. An access token is only valid for one hour. |\n","| Amazon-Advertising-API-Scope | Campaign management | Amazon Ads profile ID. Required for campaign management operations. |\n","| Amazon-Ads-AccountId | Reporting | Advertising account ID. Required for reporting and cross-product operations. |\n","| Accept | No |  The accept header is used to specify the version. If no Accept header is specified, it defaults to application/json. |\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"Sample requests"},"path":"/en-us/guides/get-started/first-call","content":[" If you are copying the samples, be sure to enter your own client ID, access token, and profile ID.\n"," Full reference: POST sp/campaigns/list\n"," Full reference: POST sb/v4/campaigns/list\n"," Full reference: GET sd/campaigns\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":2,"text":"Response"},"path":"/en-us/guides/get-started/first-call","content":[" A successful response to any of the GET campaigns endpoints returns a 200 response code. The response body contains a JSON array of campaign objects.\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"Sample"},"path":"/en-us/guides/get-started/first-call","content":[" The following sample response contains one Sponsored Display campaign.\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"Receiving an empty response"},"path":"/en-us/guides/get-started/first-call","content":[" If you do not have any campaigns of a certain ad type created yet, you receive a 200 response that contains an empty JSON array (\\[]). To check if you have active campaigns, log in to the Amazon advertising console.\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/get-started/first-call","content":[" Now that you understand the basic request and response structure for the Amazon Ads API, you can start working on the use case that suits your needs.\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"For advertisers with active campaigns"},"path":"/en-us/guides/get-started/first-call","content":["Pull sponsored ads performance data - Retrieve all sponsored ads campaigns, ad groups, ads, and targets - Create a Sponsored Products manual campaigns\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"For advertisers new to Amazon Ads"},"path":"/en-us/guides/get-started/first-call","content":[],"documentType":"guide"},{"title":"Monitor API performance with the integration dashboard","sectionHeader":null,"path":"/en-us/guides/get-started/api-integration-dashboard","content":[" The Amazon Ads API integration dashboard helps you monitor and improve your Ads API performance. \n"],"documentType":"guide"},{"title":"Monitor API performance with the integration dashboard","sectionHeader":{"type":2,"text":"Features"},"path":"/en-us/guides/get-started/api-integration-dashboard","content":[" Use the dashboard metrics to analyze your Ads API performance, identify bottlenecks, and discover opportunities for API integration improvement. The dashboard has metrics like call volume, throttle rate, and error rates, and lets you break down data by dimensions like products, functions, API resources, and geography. You can look at daily, weekly, and monthly trends, and filter on specific API call subsets to identify inefficiencies. The dashboard also gives you an hourly breakdown so that you can identify when an error spike happened. \n"," The dashboard is built using Amazon QuickSight. \n"],"documentType":"guide"},{"title":"Monitor API performance with the integration dashboard","sectionHeader":{"type":2,"text":"Access the dashboard"},"path":"/en-us/guides/get-started/api-integration-dashboard","content":[" When you sign into the Advanced Tools Center with an account that has access to the Ads API, you can access your dashboard from the My Apps tab in the navigation bar. \n"," If you have access to the Ads API but do not see a dashboard, your Amazon developer account may require Administrator or Developer permissions.\n"],"documentType":"guide"},{"title":"Monitor API performance with the integration dashboard","sectionHeader":{"type":2,"text":"Use the dashboard"},"path":"/en-us/guides/get-started/api-integration-dashboard","content":[],"documentType":"guide"},{"title":"Retrieving accounts in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/account-management/accounts/retrieve-accounts","content":[" You can now get sponsored ads accounts globally through a single API call, including their status, countries, profiles, and other metadata. You can call with a single ads account ID to get its properties, or omit the ads account ID to get all advertising accounts for the user account associated with the access token. \n"],"documentType":"guide"},{"title":"Retrieving accounts in the Amazon Ads API","sectionHeader":{"type":2,"text":"Accounts and regions"},"path":"/en-us/guides/account-management/accounts/retrieve-accounts","content":[" Accounts are now global in nature and can contain multiple countries. An advertiser registered for 3 countries will usually have 1 ads account ID and 3 country-specific profile IDs, though some advertisers may have separate ads accounts per country. Note that profiles are still needed to call most Amazon Ads APIs for campaign management, and the profile ID can now be retrieved globally through this endpoint.\n"],"documentType":"guide"},{"title":"Retrieving accounts in the Amazon Ads API","sectionHeader":{"type":2,"text":"Account status"},"path":"/en-us/guides/account-management/accounts/retrieve-accounts","content":[" The endpoints described below return a status for each account. Account statuses include:\n","CREATED - the account is ready and available for use. 2. PARTIALLY CREATED - the registration is still in progress. Some but not all countries are available for use. Poll again after 3-5 seconds. 3. PENDING - the registration is still in progress. No countries are available yet. Poll again after 3-5 seconds. 4. DISABLED - the registration failed because the advertiser is ineligible for a variety of reasons. Try again with new business or selling partner details.\n"],"documentType":"guide"},{"title":"Retrieving accounts in the Amazon Ads API","sectionHeader":{"type":2,"text":"Operations"},"path":"/en-us/guides/account-management/accounts/retrieve-accounts","content":[],"documentType":"guide"},{"title":"Retrieving accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Get an account"},"path":"/en-us/guides/account-management/accounts/retrieve-accounts","content":[" Call to get a single account given its ID.\n"," URL: GET /adsAccounts/{accountId}\n"," Example: GET /adsAccounts/amzn1.ads-account.g.87rerlyohs3b1cmj2rem03xmd\n"," Sample Response\n"],"documentType":"guide"},{"title":"Retrieving accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Get all accounts by user"},"path":"/en-us/guides/account-management/accounts/retrieve-accounts","content":[" This endpoint retrieves all ads accounts for the user account associated with the access token. Integrators may use this endpoint to populate navigational elements or perform multi-account actions.\n"," URL: POST /adsAccounts/list\n"," Sample Response\n"],"documentType":"guide"},{"title":"Retrieving accounts in the Amazon Ads API","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/account-management/accounts/retrieve-accounts","content":[" For many requests to the Amazon Ads API, for example a request to create a Sponsored Display campaign, you must include the profileId, rather than the ads account ID. With the profile ID you can call APIs for campaign creation, campaign management, reporting, and more. \n"],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/account-management/accounts/create-accounts","content":[" Amazon Ads supports registration via API for businesses who do and do not sell on Amazon. Integrators can offer an ingress to Amazon Ads directly from their portal, making it seamless for their advertisers to sign up for Amazon. With these APIs you can create a sponsored ads account and get its details all from your own interface. \n"],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":{"type":2,"text":"The account construct"},"path":"/en-us/guides/account-management/accounts/create-accounts","content":[" These account creation endpoints use an upgraded account construct. Accounts are now globalized in nature and come with a country dimension. Advertisers that are eligible for multiple countries now get one advertising account that spans all countries. \n"," Each country does have its own ID specific to each advertiser, which you need to make individual requests for most other APIs. See Profiles for more information on country-specific identifiers.\n"],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":{"type":2,"text":"Expected call flow for account creation"},"path":"/en-us/guides/account-management/accounts/create-accounts","content":["Authorize the Amazon user to your system via Login With Amazon 2. Get a token to verify the Amazon Ads Agreement has been accepted 3. Register an ads account 4. Get registration status and account details 5. Link to the Amazon Billing setup page\n"," These steps are explained in detail in this guide.\n"],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/account-management/accounts/create-accounts","content":[],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":{"type":3,"text":"Amazon login"},"path":"/en-us/guides/account-management/accounts/create-accounts","content":[" If you have already completed the onboarding and getting started sequences for the Amazon Ads API, you will have already created a Login With Amazon client application. You can use access tokens generated through Login With Amazon to administer advertising accounts on behalf of an Amazon user account.\n"," All users must have an Amazon login (username and password) in order to register an ads account. If a user already has a login, ideally with their work email address, they will sign in as part of the next step. If they do not have a login, they must create one. We recommend they use the email they use for their professional work, which differentiates the login from their Amazon shopping login, and we use email addresses for various types of verifications. To create a login, on the Login With Amazon (LwA) sign-in page, they can select Create Amazon Account to create a username and password.\n"],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":{"type":3,"text":"LwA authorization grant"},"path":"/en-us/guides/account-management/accounts/create-accounts","content":[" Before registering an Amazon Ads account, we require your users to authorize your client application to access advertising data from their Amazon user account as described in the previous section. Completing this step prior to ads account registration ensures the account is immediately available in your UI upon completing a registration.\n"," To set this up, learn how to create an authorization grant and retrieve access and refresh tokens.\n"," You will use this access token in the Authorization header of all requests below, along with your Amazon Ads API client ID, as described in the Authorization overview.\n"],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":{"type":2,"text":"Procedure for Amazon Ads account registration"},"path":"/en-us/guides/account-management/accounts/create-accounts","content":[],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":{"type":3,"text":"Step 1 - Terms and conditions token"},"path":"/en-us/guides/account-management/accounts/create-accounts","content":[" In order to register an ads account through the Amazon Ads API, you must verify that the user has seen and accepted our Terms and Conditions, also known as the Ads Agreement. \n"," To do so, you will call an API to generate a termsToken and termsUrl. You must surface a link (termsUrl) to the Ads Agreement for your users during ads account registration. This link is provided in the API. If you do not surface this, you will not receive a verified token nor will you be able to successfully register an ads account. When the user clicks that link, it will surface an Amazon page that has the Ads Agreement and an Accept and continue button. We recommend showing this as a small pop up window that auto-closes when the user clicks the button. \n"," When they click Accept and continue, the token will be active and you will submit that termsToken with the registration request in Step 2. We recommend storing the token in your system for future reference.\n"," Response:\n"," Response:\n"," You can add a link to the Ads Agreement in your Amazon Ads account registration form, which will open a window like the below.\n"],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":{"type":3,"text":"Step 2 - Register an account"},"path":"/en-us/guides/account-management/accounts/create-accounts","content":[" An advertiser who does not sell on Amazon can self-register from third-party systems like yours to get started with sponsored ads. To register, we require account and business details, which we will verify automatically within 2-10 seconds. Note that we only support US-based businesses at this time. \n"," Sample request\n"," You must include the name of the ads account (typically the brand or business name), country where advertising will occur (currently US only for this program), and all business details. Details include legal business name, phone, website, address, city, state, zip and country. \n"," Note that only a direct employee of the business can advertise. Unprofessional email addresses are not accepted and will result in a rejection. To prevent abuse, we also have controls to prevent an employee of one company registering on behalf of another. Be sure that it is clear in your UI that only employees of the business can register on their own behalf. Some agencies have special status to enroll on behalf of their clients automatically, but must still submit all the right legal business details of the client. Note that an agency without special status will need to ask their client to register themselves.\n"," Sample Response\n"," The response immediately returns an account ID in pending status. Full registration then happens asynchronously. \n"," Rejection Response Amazon may reject an account request for a variety of reasons, whether the business is not eligible at this time or violates an Amazon policy. If the initial response comes back with a status of DISABLED, there will be an error reason along with suggested error messages. \n"," Manual Review If an account request is rejected, the advertiser may request their information to be manually reviewed by Amazon. You can provide the below link in your error messages. They will be directed to an Amazon page where they can submit details directly to Amazon. Amazon will then contact them with a response and account details if they are approved. The account will immediately flow into your system as soon as the advertiser accepts it.\n"," To register an Amazon selling partner, such as an Amazon Vendor or Seller, the API is the same but the input parameters are different. You must obtain their selling partner ID (Vendor Group or Seller Central Account) in order to register. To get this ID, the advertiser can provide it manually, obtained from within their Vendor or Seller Central accounts.\n"," Sample request for an Amazon Seller\n"," You must provide the Seller Central account ID (MCID) of the seller, and the user must have direct permissions to that seller account. Indicate that it is an amazonSeller with their sellerCentralAccount ID. \n"," Sample request for an Amazon Vendor\n"," You must provide the Vendor Group of the advertiser, and the user must have direct permissions to that vendor group. Indicate that it is an amazonVendor with their vendorGroup ID. \n"," Sample Request for a Kindle-Direct Publishing (KDP) Author\n"," You must provide the email address of the author who owns the KDP account.\n"],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":{"type":3,"text":"Step 3 - Get registration status and account details "},"path":"/en-us/guides/account-management/accounts/create-accounts","content":[" Given an account ID, you can check its registration status and get back the associated countries, profiles, and other metadata. To get account and registration status, you will need to poll after a registration request, since registration can take anywhere from 3-30 seconds depending on input parameters. For example, a registration for a selling partner in one country will be much faster than one across 20 countries. We recommend polling every 3-5 seconds to check the account status. It may take up to a few seconds for the profile ID to be populated after account creation.\n"," See Retrieve accounts to learn how to retrieve account details.\n"],"documentType":"guide"},{"title":"Account creation in the Amazon Ads API","sectionHeader":{"type":2,"text":"Next Steps"},"path":"/en-us/guides/account-management/accounts/create-accounts","content":[" To set up billing for a newly created account, see Billing.\n"," To call an API, for example to create an SD campaign, you must submit the profileId, not the ads account ID. With the profile ID you can call campaign creation, campaign management, reporting, and more APIs. Some APIs do accept the globalized advertising account ID, and these are noted in their documentation. \n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":null,"path":"/en-us/guides/account-management/registration","content":[],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/account-management/registration","content":[" The Advertiser Account is the Amazon Ads enhanced workflow for onboarding advertisers and managing their full advertising activity across all ad products (Amazon DSP (ADSP) and Sponsored Ads) and countries. With this launch, customers with an Amazon DSP Seat can use Ads Console to onboard advertisers with a new streamlined account and billing setup. In this account, customers can operate across both ADSP and Sponsored Ads globally throughout the full advertising lifecycle, from campaign management and reporting to user management and billing.\n"," Previously, registration and account management functionality for Amazon Ads advertiser accounts was only available through the Ads Console. With this launch, Amazon Ads API customers can execute all account management related actions (create, view, update advertiser accounts, etc.) for all Amazon ad products and countries via API without the need to visit Ads Console to do so. Now, customers can register Advertiser Accounts at scale via public API, and they can use the resulting account identifiers to execute campaign management, reporting, billing and user management operations across all countries and ad products (ADSP, SA). \n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Primary endpoints"},"path":"/en-us/guides/account-management/registration","content":["POST /adsApi/v1/create/advertiserAccounts: Register one or multiple advertiser accounts by providing business details or importing them from a selling account token - POST /adsApi/v1/query/advertiserAccounts: Fetch account details and attributes (such as business, selling accounts, alternate identifiers for public APIs) for a given advertiser account, a group of advertiser accounts, or all advertiser accounts that a given user has access to - POST /adsApi/v1/update/advertiserAccounts: Update account details for advertiser accounts - POST /adsApi/v1/query/sellingAccounts: Fetch all Amazon retail selling accounts (for example, Seller, Vendor, Author, KDP, etc.) that a given user has access to, so that the resulting encrypted selling account token can be used to register an associated advertiser account.\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Prerequisites"},"path":"/en-us/guides/account-management/registration","content":[" Accept Amazon Advertising Terms and Conditions from POST /termsTokens.\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Steps to create an account"},"path":"/en-us/guides/account-management/registration","content":["Step 1: Optional Fetch Selling Account from POST /adsApi/v1/query/sellingAccounts - Step 2: Optional Fetch Amazon ADSP-enabled Manager Account - Step 3: Call POST /adsApi/v1/create/advertiserAccounts\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Advertiser Account Model"},"path":"/en-us/guides/account-management/registration","content":[" An advertiser account is required to create advertising campaigns in Sponsored Ads and ADSP. An advertiser account is defined by display name, business details, and selling account relationships. After an advertiser account is created, a user can query which accounts they have access to. An advertiser account can also be updated after creation.\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Selling Account Model"},"path":"/en-us/guides/account-management/registration","content":[" A selling account is an Amazon retail relationship. Commonly, these represent Seller Central, Vendor Central, Author Central, and similar portals. This means even if the user has access to a Seller Central account, that does not mean their Seller Central account can register with advertising. At this time, we only support querying selling accounts.\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":2,"text":"Common use cases"},"path":"/en-us/guides/account-management/registration","content":[" Described below are 5 common uses cases of the advertiser accounts APIs:\n","Accept Terms - Create Sponsored Ads Account - Retrieve registration status - Create Sponsored Ads Account with selling relationship - Create one account enabled for both Amazon DSP and Sponsored Ads - Update Advertiser Account\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Accept Terms"},"path":"/en-us/guides/account-management/registration","content":[" Before creating any new advertising accounts, a terms token must be accepted for the user behind the authorization header must have accepted the ADVERTISING terms. To do this, you must invoke the POST /termsTokens API which returns a termsToken which contains termsUrl. This URL must be accessed manually through the UI in order to accept the terms. This means you must have credentials for the user account, or ask your user to navigate the link. Once the termsUrl has been accepted once for each authorized “Direct Advertiser” or “Partner” (user), you do not need to do this again. See below for how to create a new termsToken with POST /termsTokens.\n"," Headers:\n"," Request body:\n"," Response:\n","TermsToken needs to be accepted for each user once. 2. TermsToken cannot be accepted solely with your Amazon API Client ID. It must be associated with an authorized user. This means if your APIs manage 2 authorized users, you need each of those users to agree to the terms and conditions for all of them to create Advertiser Accounts.\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Create Sponsored Ads Account"},"path":"/en-us/guides/account-management/registration","content":[" Before proceeding, please be sure to review and approve the Amazon Terms through POST /termsTokens API as described above or you will not be able to create accounts.\n"," An Amazon Advertising Account can be created with just your address details by calling POST /adsApi/v1/create/advertiserAccounts.\n"," Headers:\n"," Request body:\n"," Response:\n","displayName: The name that is displayed on your requested advertiser account. Also known as “account name“ in other contexts. - businessDetails: The business details like website, address, and businessRegistrationNumber. You must provide an address or addressToken in order to create an account. We use your businessDetails to verify your business to offer you access to more advertising campaign features like Sponsored Display and Sponsored TV\n","advertiserAccountId: Unique identifier for an Advertiser Account. - status: The account creation status. An account is always created as REGISTRATION_IN_PROGRESS .\n","AdvertiserAccounts are created asynchronously. The response contains an advertiserAccountId which you must use to call POST /adsApi/v1/query/advertiserAccounts to see when registration completes. We describe this more later in this section. 2. This is a batch API, so you can provide up to 100 accounts in the input. If this is your first time creating an account, we suggest only creating 1 account. 3. Your address must follow a specific format. Notably, states must be full-string ISO 3166 standard (for example, “Illinois“) and country must be a 2-letter ISO 3166 standard country code (for example, ”US“). 4. If you are registering with just your business details, you cannot have multiple accounts with the same displayName. 5. By default, the business details will be masked in the response. At this time, API integrators can only view a masked account address.\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Retrieve registration status"},"path":"/en-us/guides/account-management/registration","content":[" Now that the advertiser account has started account creation, you can retrieve its account registration status as well as the newly created account details using POST /adsApi/v1/query/advertiserAccounts.\n"," Headers:\n"," Request body:\n"," Fetch details for a specific account:\n"," Fetch all accounts:\n"," Response:\n","advertiserAccountIdFilter: List of advertiser account IDs. When passing this field, we will return more details about your account like businessDetails. If this is not provided, we will fetch all your accounts, but will not include all details on the account.\n","advertiserAccountId: Unique identifier for an Advertiser Account. - status: The account creation status. An account is always created as REGISTRATION_IN_PROGRESS. If registration is complete and successful, statusCode will be APPROVED. - isGlobalAccount: Designates if the account is global or not. You can only create global accounts. Marketplace-level accounts are legacy and will be globalized in the future. - alternateIds: Legacy marketplace accountIds. These values may be used to interact with other APIs which do not function at the global account level, but instead at the marketplace level, notably using profileId or dspAdvertiserId. profileId is passed into Amazon-Advertising-API-Scope for other APIs and dspAdvertiserId is passed in Amazon-Ads-AccountId . - sellingAccountLinkRequests: Selling Account Relationships tokens. These represent a retail relationship (like SellerCentral) that is associated with your account. We will discuss this more in a later section when creating accounts with a selling relationship.\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Create Sponsored Ads Account with selling relationship"},"path":"/en-us/guides/account-management/registration","content":[" In the last section, we described the base case of creating an account with only your business details. In this section, we will describe how to modify the request to register with your selling relationship (Seller Central, Vendor Central, Author Central, etc.). Registering an account with a selling relationship unlocks many new campaign management possibilities.\n"," To register with your selling relationship, you need to pass a sellingAccountToken. To get this, you must call POST /adsApi/v1/query/sellingAccounts.\n"," Headers:\n"," Request body:\n"," Fetch all Selling Accounts:\n"," Fetch details for a specific Selling Account:\n"," Response:\n","sellingAccountLinkToken: unique identifier for a selling account. Required to fetch more details about a specific selling account. - sellingProgram: the program of your selling account. Required to fetch more details about a specific selling account.\n","sellingAccountLinkToken: unique identifier for a selling account. This id is ephemeral and will change for any given selling account. - sellingProgram: the program of your selling account. This signals what kind of ad programs you will get access to upon registration - addressToken: token which encapsulates the address details under the address object. This address is derived from the address details of your selling portal. At this time, the address provided in the response will be masked with \\* , but the actual values behind the address are encapsulated in the addressToken .\n","There are 2 ways to call this API, with empty input ({}) and with sellingAccountLinkTokenFilter and sellingProgramFilter. Providing empty input will fetch all selling accounts which are eligible for Amazon Advertising, but it will only contain portals, sellingProgram, and sellingAccountLinkToken. If you want to know more details about the selling account, such as address, you can call with sellingAccountLinkTokenFilter and sellingProgramFilter. 2. sellingAccountLinkToken is ephemeral, so we suggest to not store this value in any of your systems. 3. Not all selling relationships are eligible for advertising. You may need to work with your Amazon Account Executive to get access.\n"," Once you have sellingAccountLinkToken and, optionally, your addressToken, you can then register your account with a selling relationship.\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Create one account enabled for both Amazon DSP and Sponsored Ads"},"path":"/en-us/guides/account-management/registration","content":[" In all the previous sections, we showed you how to create an advertiser account for sponsored ads only. In this section, we will show you how you can also register with ADSP (Amazon DSP). As a pre-requisite, you must have a manager account which is enabled in ADSP. A manager account is not an Advertiser Account or a Selling Account. It is an Account which links together Advertiser Accounts and other ManagerAccounts for the purpose of permission management and various other features. To create a Manager Account via the UI, go to https://advertising.amazon.com/am/managerAccounts/create. To request ADSP access for your Manager Account, please go to https://advertising.amazon.com/dsp/activate/request?entityId={manager-account-id}, where {manager-account-id} is your manager account ID. Once you have a manager account which is enabled in ADSP (has a seat), then simply pass managerAccountId, currencyCode, timeZoneIana, and industryVertical to POST /adsApi/v1/create/advertiserAccounts.\n"," Request body:\n","timeZoneIana: Required to register with ADSP. - industryVertical: Required to register with ADSP. - currencyCode: Required to register with ADSP. More details of supported currencies: https://advertising.amazon.com/help/GPSLAPLGE94Z2778 - managerAccountId: To register with ADSP, this must have an ADSP seat and thus be ADSP enabled.\n","To register with ADSP, ManagerAccount must have an ADSP seat and thus be ADSP enabled. If ManagerAccountId does not have a seat, then the account will only be created with Sponsored Ads access, and it will be linked to your manager account automatically.\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":3,"text":"Update Advertiser Account "},"path":"/en-us/guides/account-management/registration","content":[" To update your account, you can use POST /adsApi/v1/update/advertiserAccounts.\n"," Headers:\n"," Request body:\n","If your businessDetails are not verified, you should update your business details to accurately reflect your business to get access to more ad products like Sponsored Display and Sponsored TV. 2. Mutable Fields: 3. Immutable Fields\n"],"documentType":"guide"},{"title":"Account registration","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/account-management/registration","content":[" View the OpenAPI specifications:\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":null,"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" The QueryAdvertiserAccount API retrieves advertiser accounts associated with your credentials. Use this API to:\n","Discover all advertiser accounts you have access to - Filter accounts by type (global vs. non-global) - Retrieve detailed account information including selling relationships - Get account metadata like currency, timezone, and industry vertical\n"," This API supports pagination to handle large result sets efficiently.\n"," Endpoint: POST /adsApi/v1/query/advertiserAccounts\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" Before using this API, ensure you have:\n","OAuth 2.0 Access Token - Obtain from Amazon Ads authentication flow - Client ID - Register your application with Login with Amazon to get your Amazon-Ads-ClientId - Account Access - Your credentials must have access to at least one advertiser account\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":2,"text":"Key concepts"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Global vs. non-global accounts"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" Global accounts (isGlobalAccount: true)\n","Span multiple marketplaces and regions - Have a single advertiser account ID with format: amzn1.ads-account.g.26eqvvnjl03bvzcsjv6yp81x - Contain alternateIds for each marketplace (DSP IDs and Sponsored Ads profiles) - Used for unified cross-marketplace campaign management\n"," Non-global accounts (isGlobalAccount: false)\n","Marketplace-specific accounts - Have advertiser account ID format: amzn1.ads1.aa1.{country}.{entityId} (for example, amzn1.ads1.aa1.us.ENTITY465) - Contain DSP advertiser IDs in alternateIds - Legacy account structure for single-marketplace operations\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Account identifiers"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" The response includes multiple identifier types in alternateIds:\n"," For DSP (Demand-Side Platform):\n","dspAdvertiserId: Numeric DSP account identifier - region: Geographic region (NA, EU, FE)\n"," For Sponsored Ads:\n","entityId: Entity identifier for the marketplace - profileId: Profile identifier for API operations - countryCode: ISO country code (for example, US, CA, MX)\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"AlternateIds structure"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" DSP identifiers:\n"," Sponsored Ads identifiers:\n","| Field | Type | Description |\n","\\| --- \\| --- \\| --- \\|\n","| dspAdvertiserId | string | DSP advertiser identifier (numeric string) |\n","| region | string | DSP region: NA (North America), EU (Europe), FE (Far East) |\n","| countryCode | string | Sponsored Ads ISO 3166-1 alpha-2 country code |\n","| entityId | string | Sponsored Ads entity identifier |\n","| profileId | string | Sponsored Ads profile identifier for API operations |\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Selling relationships"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" Global accounts may include sellingAccountLinkRequests containing tokens that link to selling entities (sellers, vendors, authors). Use these tokens with the Query Selling Account API to retrieve detailed selling information.\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":2,"text":"Usage examples"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Example 1: Retrieve all global accounts"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" Request:\n"," Response:\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Example 2: Retrieve all non-global accounts"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" Request:\n"," Response:\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Example 3: Retrieve a specific account with full details"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" Request:\n"," Response:\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":2,"text":"Pagination"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" This API uses cursor-based pagination with nextToken.\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Pagination behavior"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":["Empty pages: The API may return advertiserAccounts: \\[] with a valid nextToken. Always continue iterating until no nextToken is returned. - Variable page size: maxResults is a maximum limit, not a guarantee. Actual pages may contain fewer results. - Complete iteration: To ensure you retrieve all accounts, continue calling the API with each nextToken until the response contains no nextToken.\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Pagination example"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" Initial request:\n"," Response with empty page:\n"," Subsequent request:\n"," Final response (no more pages):\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":2,"text":"Important behaviors"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Default filter behavior"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":["Omitting isGlobalAccountFilter returns only global accounts (equivalent to isGlobalAccountFilter: { include: \\[true] }) - To retrieve non-global accounts, explicitly set isGlobalAccountFilter: { include: \\[false] }\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Retrieving all accounts"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" To get complete account coverage, make two separate requests:\n","Global accounts: Omit isGlobalAccountFilter or set to \\[true] 2. Non-global accounts: Set isGlobalAccountFilter: { include: \\[false] }\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Account ID filter limitations"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":["advertiserAccountIdFilter only works with global account IDs (format: amzn1.ads-account.g.\\*) - Non-global ADSP account IDs cannot be searched directly - To find a specific non-global account, retrieve all non-global accounts and filter on the client side\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Detailed account information"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":["Use advertiserAccountIdFilter with specific global account IDs to retrieve full details including sellingAccountLinkRequests, status, currencyCode, and other metadata - Querying without filters returns basic account information\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Retrieving business details"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" The businessDetails field is only returned when a single global account ID is provided in the advertiserAccountIdFilter of the QueryAdvertiserAccount request. When multiple global account IDs are provided, businessDetails is omitted from the response entirely.\n"," To retrieve businessDetails for multiple accounts, call QueryAdvertiserAccount once per global account ID.\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":2,"text":"Working with selling relationships"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" The sellingAccountLinkRequests array contains tokens representing relationships between advertiser accounts and selling entities (seller, vendor, author).\n"," To get detailed selling account information:\n","Extract sellingAccountLinkToken from the QueryAdvertiserAccount response 2. Call the Query Selling Account API with the token\n"," Query Selling Account request:\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":2,"text":"Error responses"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"HTTP status codes"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":["| Status Code | Description |\n","\\| --- \\| --- \\|\n","| 200 | Success |\n","| 400 | Bad Request - Invalid parameters or malformed request |\n","| 401 | Unauthorized - Invalid or expired access token |\n","| 403 | Forbidden - Insufficient permissions |\n","| 429 | Too Many Requests - Rate limit exceeded |\n","| 500 | Internal Server Error |\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":3,"text":"Common errors"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" Invalid account IDs:\n"," This error occurs when the advertiserAccountIdFilter contains account IDs that do not exist or that your credentials do not have access to. Verify the account ID is correct and that your OAuth token has the appropriate permissions.\n"],"documentType":"guide"},{"title":"QueryAdvertiserAccount API","sectionHeader":{"type":2,"text":"FAQs"},"path":"/en-us/guides/account-management/query-advertiser-accounts","content":[" Q: Why am I getting empty advertiserAccounts arrays with a nextToken?\n"," A: This is expected behavior. The API uses cursor-based pagination that may return empty pages. Always iterate through all nextToken values until none is returned.\n"," Q: How do I get all accounts (both global and non-global)?\n"," A: Make two separate API calls:\n","One without isGlobalAccountFilter (or with \\[true]) for global accounts 2. One with isGlobalAccountFilter: { include: \\[false] } for non-global accounts\n"," Q: What is the difference between advertiserAccountId and the IDs in alternateIds?\n"," A: advertiserAccountId is the unified account identifier. alternateIds contains marketplace-specific identifiers (DSP IDs, entity IDs, profile IDs) used by different Amazon Ads products.\n"," Q: Can I search for non-global account IDs using advertiserAccountIdFilter?\n"," A: No. Only global account IDs (format: amzn1.ads-account.g.\\*) can be queried. For non-global accounts, retrieve all and filter on the client side.\n"," Q: How do I get selling account details?\n"," A: Extract sellingAccountLinkToken from sellingAccountLinkRequests and use it with the Query Selling Account API.\n"," Q: Why is businessDetails missing from my response?\n"," A: The businessDetails field is only returned when you provide a single global account ID in advertiserAccountIdFilter. If you request multiple global account IDs, businessDetails is omitted from the response. To retrieve businessDetails for multiple accounts, call QueryAdvertiserAccount once per global account ID.\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":null,"path":"/en-us/guides/account-management/manager-account-api","content":[" The Manager Account API provides endpoints for creating, updating, and querying manager accounts in the Amazon Ads API v1. Manager accounts enable advertisers and agencies to link and manage multiple advertising accounts from a single dashboard.\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/account-management/manager-account-api","content":[" Previously, manager accounts could only be created through the advertising console or the legacy POST /managerAccounts endpoint. With this launch, you can manage manager accounts at scale using the Amazon Ads API v1 batch endpoints.\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":3,"text":"Primary endpoints"},"path":"/en-us/guides/account-management/manager-account-api","content":["POST /adsApi/v1/create/managerAccounts: Create one or more manager accounts - POST /adsApi/v1/update/managerAccounts: Update one or more manager accounts - POST /adsApi/v1/query/managerAccounts: Query manager accounts by user or by ID\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":3,"text":"Prerequisites"},"path":"/en-us/guides/account-management/manager-account-api","content":[" Before using this API, ensure you have:\n","OAuth 2.0 Access Token — Obtain from the Amazon Ads authentication flow - Client ID — Register your application with Login with Amazon to get your Amazon-Advertising-API-ClientId\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":3,"text":"Manager account model"},"path":"/en-us/guides/account-management/manager-account-api","content":[" A manager account is defined by:\n","| Field | Type | Description |\n","\\| --- \\| --- \\| --- \\|\n","| managerAccountId | string | Unique identifier for the manager account (format: amzn1.ads1.ma1.\\*). Read-only, assigned on creation. |\n","| displayName | string | The display name of the manager account. Required on create. |\n","| accountUsageType | string | The intended usage type: PRODUCTION (default) or TEST. Set on create only, not updatable. |\n","| timeZoneIana | string | The time zone of the manager account in IANA format (e.g., America/New_York). Set on create only, not updatable. |\n","| industryVertical | string | The industry vertical categorization of the advertiser (e.g., Automotive, Financial Services). Set on create only, not updatable. |\n","| currencyCode | string | The currency used for the manager account (e.g., USD). Read-only; set by ADSP Activation, not through this API. |\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":2,"text":"Common use cases"},"path":"/en-us/guides/account-management/manager-account-api","content":["Create a manager account - Create a test manager account - Update a manager account - Query all manager accounts - Query specific manager accounts by ID\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":3,"text":"Create a manager account"},"path":"/en-us/guides/account-management/manager-account-api","content":[" Create one or more manager accounts with POST /adsApi/v1/create/managerAccounts. This is a batch API that accepts up to 10 manager accounts per request.\n"," Headers:\n"," Request body:\n"," Response:\n","displayName (required): The name displayed for the manager account. - accountUsageType (optional): Set to TEST to create a test account. Defaults to PRODUCTION if not provided. - timeZoneIana (optional): The time zone in IANA format (e.g., America/New_York). Not updatable after creation. - industryVertical (optional): The industry vertical of the advertiser (e.g., Entertainment, Financial Services). Not updatable after creation.\n","managerAccountId: Unique identifier for the newly created manager account. - index: The position of the item in the original request array, used to correlate batch results.\n","This is a batch API. You can create up to 10 manager accounts in a single request. 2. Per-item failures do not fail the entire batch. Successfully created accounts appear in the success array, and failures appear in the error array. 3. Each user has a limit on the number of manager accounts they can create. If you exceed this limit, the request will return an error.\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":3,"text":"Create a test manager account"},"path":"/en-us/guides/account-management/manager-account-api","content":[" To create a manager account for testing purposes, set accountUsageType to TEST. Test accounts are useful for development and integration testing without affecting production data.\n"," Request body:\n"," Response:\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":3,"text":"Update a manager account"},"path":"/en-us/guides/account-management/manager-account-api","content":[" Update one or more manager accounts with POST /adsApi/v1/update/managerAccounts. This is a batch API that accepts up to 10 manager accounts per request.\n"," Headers:\n"," Request body:\n"," Response:\n","| Mutable | Immutable |\n","\\| --- \\| --- \\|\n","| displayName | managerAccountId |\n","| | accountUsageType |\n","| | timeZoneIana |\n","| | industryVertical |\n","| | currencyCode |\n","You must include managerAccountId to identify which account to update. 2. Only fields you want to change need to be included in the request. 3. Attempting to update accountUsageType will result in an error.\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":3,"text":"Query all manager accounts"},"path":"/en-us/guides/account-management/manager-account-api","content":[" Retrieve all manager accounts accessible to the authorized user with POST /adsApi/v1/query/managerAccounts.\n"," Headers:\n"," Request body:\n"," Response:\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":3,"text":"Query specific manager accounts by ID"},"path":"/en-us/guides/account-management/manager-account-api","content":[" To retrieve details for specific manager accounts, use the managerAccountIdFilter.\n"," Request body:\n"," Response:\n","You can query up to 100 manager account IDs per request. 2. When querying by ID, only accounts you have permission to access are returned.\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":2,"text":"Pagination"},"path":"/en-us/guides/account-management/manager-account-api","content":[" The Query endpoint supports cursor-based pagination with nextToken.\n","Default page size: 100 results - Minimum page size: 10 - Maximum page size: 100\n"," To paginate, include the nextToken from the previous response in your next request:\n"," Continue calling the API with each nextToken until the response contains no nextToken.\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":2,"text":"Error handling"},"path":"/en-us/guides/account-management/manager-account-api","content":[],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":3,"text":"Batch error responses"},"path":"/en-us/guides/account-management/manager-account-api","content":[" Create and Update are batch APIs. Per-item errors are returned in the error array without failing the entire request.\n"," Example response with partial failure:\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":3,"text":"HTTP status codes"},"path":"/en-us/guides/account-management/manager-account-api","content":["| Status Code | Description |\n","\\| --- \\| --- \\|\n","| 200 | Success |\n","| 400 | Bad Request — Invalid parameters or malformed request |\n","| 401 | Unauthorized — Invalid or expired access token |\n","| 403 | Forbidden — Insufficient permissions |\n","| 429 | Too Many Requests — Rate limit exceeded |\n","| 500 | Internal Server Error |\n"],"documentType":"guide"},{"title":"Manager Account API developer guide","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/account-management/manager-account-api","content":[],"documentType":"guide"},{"title":"Permissions","sectionHeader":null,"path":"/en-us/guides/account-management/permissions","content":[" The permission levels of a user account for a given advertising account determine the ability of that user to either view or edit that advertising account.\n"," In the advertising console, the permissions set for the logged-in user account affect the behavior of the user interface. \n"," In the Amazon Ads API, the permissions set for the user account that logged in to create the authorization grant determine whether a given request will be authorized.\n"],"documentType":"guide"},{"title":"Permissions","sectionHeader":{"type":2,"text":"Permissions and profiles"},"path":"/en-us/guides/account-management/permissions","content":[" The profile ID of an advertising account is required to complete most requests to the API. By default, the GET /profiles endpoint displays only profiles with View and Edit permissions. The response can be adjusted using the apiProgram and accessLevel query parameters in the request.\n"," For example, the following request would return a list of profiles in North America for which the authorizing account has View permissions for reports:\n"," For more detail, view the technical specifications for profiles.\n"],"documentType":"guide"},{"title":"Permissions","sectionHeader":{"type":2,"text":"Response status"},"path":"/en-us/guides/account-management/permissions","content":[" Requests to the API for which the authorizing user account has permission to perform the requested action for the account whose profile ID is provided in the Amazon-Advertising-API-Scope header will be authorized.\n"," Requests will receive a 401 Unauthorized response if the authorizing account does not have the required permissions.\n"],"documentType":"guide"},{"title":"Permissions","sectionHeader":{"type":2,"text":"Setting permissions"},"path":"/en-us/guides/account-management/permissions","content":[" By default, the creator of a sponsored ads account has Admin permissions. In the advertising console, users with Admin access can enable other user accounts to access an advertising account by setting permissions. \n"," Admin users can choose from two methods to enable access for other user accounts: manager accounts and access controls.\n"],"documentType":"guide"},{"title":"Permissions","sectionHeader":{"type":3,"text":"Manager accounts"},"path":"/en-us/guides/account-management/permissions","content":[" Advertisers can allow access to a manager account, which can be assigned either Viewer or Editor permission. Learn more about manager accounts.\n"],"documentType":"guide"},{"title":"Permissions","sectionHeader":{"type":3,"text":"Access controls"},"path":"/en-us/guides/account-management/permissions","content":[" Advertisers can use access controls to invite another user account to the advertising account and determine the permission level of that user account.\n"," For vendor accounts, permission can be shared in the advertising console according to three default tiers:\n","Viewer: grants ability to view content and existing campaigns.\n","Editor: grants viewer privileges plus the ability to change content, create new ads, create portfolios, and manage existing campaigns.\n","Admin: grants editor privileges plus the ability to change payment settings and add or remove users.\n"," Alternatively, admin users can choose to grant granular permissions to a given user across six permission fields. Four of these fields affect behavior in the API. They are listed below, along with the names for the View and View and Edit permissions of each type as described in \"Permissions definitions\" in the support center. \n","| Name in console | View permission name | View and Edit permission name | Enables |\n","\\| --------------- \\| ---- \\| ------------- \\| ------- \\|\n","| Campaign manager | advertiser_campaign_view | advertiser_campaign_edit | Campaign management endpoints |\n","| Advertising reports | nemo_report_view | nemo_report_edit | Reporting endpoints |\n","| Stores builder | N/A | amazon_stores_edit | Stores endpoints |\n","| Billing history | nemo_transactions_view | nemo_transactions_edit | Billing endpoints |\n"," For seller accounts, admin users can manage granular permissions in Seller Central after inviting another user. View, View & Edit, and Admin permissions for seller accounts behave as described above for vendor accounts for those aspects of the account of a seller that affect the behavior of the API, including:\n","Campaign manager\n","Product Ads Performance Reports\n","Product Ads Invoice History\n","Stores builder\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":null,"path":"/en-us/guides/account-management/authorization/overview","content":[],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":{"type":2,"text":"Access to the Amazon Ads API"},"path":"/en-us/guides/account-management/authorization/overview","content":[" The Amazon Ads API provides programmatic access to Amazon Ads data and services. Like all Amazon users, Amazon Ads customers control access to their data. Because of this consideration, accessing the Amazon Ads API requires a careful authorization process.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":{"type":3,"text":"Access to data and services"},"path":"/en-us/guides/account-management/authorization/overview","content":[" As with the web-based user interface, Amazon Ads advertisers control access to their data and services via an Amazon login identity, which is an email address and password. A given advertiser must explicitly grant authorization for the account of the advertiser to be accessed through the API.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":{"type":3,"text":"Access to the API"},"path":"/en-us/guides/account-management/authorization/overview","content":[" Amazon Ads enables client applications administered by Login with Amazon (LwA) to make calls to the API. To gain access, a client must be approved for access by Amazon Ads, and an approved client identifier is a required credential for any API call.\n","For specific information on applying for API access, see our Onboarding Walkthrough. - For general information on Login with Amazon, see the Login with Amazon documentation\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":{"type":3,"text":"Advertiser and client"},"path":"/en-us/guides/account-management/authorization/overview","content":[" Both of the entities described above — advertiser and client application — must participate to make a successful call to the Amazon Ads API. The advertiser must first grant authorization to the client application, then the client application may pass the resulting credentials to the API to access the data and services of that specific advertiser.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":{"type":2,"text":"Authorization flow"},"path":"/en-us/guides/account-management/authorization/overview","content":[" To understand how an advertiser grants authorization to a client application, and how the client application then presents that authorization to the API, consider that authentication and authorization in the Amazon Ads API follow an OAuth 2.0 flow. \n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":{"type":3,"text":"OAuth 2.0"},"path":"/en-us/guides/account-management/authorization/overview","content":[" OAuth 2.0 is designed to enable a third party to obtain limited access to the resources or services associated with a resource owner. \n"," For example:\n"," In this diagram, the client represents a third party that acts on behalf of a resource owner. The client creates a request for the resource owner to consent to sharing resources. This request typically includes a scope that defines the resources and permissions to which the owner is granting access. \n"," The client retrieves an authorization grant representing the consent of the resource owner. The client then submits the authorization grant to the authorization server, which responds with an access token. The access token is a credential that is typically valid for a short period of time.\n"," The client passes the access token to the resource server and has permission to access the data and services of the resource owner defined by the scope for the time the access token is valid.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":{"type":3,"text":"OAuth 2.0 in the Amazon Ads API"},"path":"/en-us/guides/account-management/authorization/overview","content":[" Authorization in the Amazon Ads API follows a similar conceptual flow. The diagram below illustrates this more specifically.\n"," In the Amazon Ads API, the authorization server is provided by Login with Amazon. \n"," The client is a Login with Amazon application, which has an associated client identifier and client secret. \n"," The resource owner is an Amazon advertiser. By visiting a URL associated with the client identifier, the advertiser can use the Login with Amazon user interface to confirm their consent.\n"," Login with Amazon creates a one-time authorization code associated with both the advertiser and the client. The client then passes this authorization code to Login with Amazon, along with the client identifier and client secret, to retrieve an access token and a refresh token. The access token is valid for 60 minutes and is used to make API calls. The refresh token is used to generate new access tokens without requiring the advertiser to re-authorize. Refresh tokens issued on or after July 30, 2026 are valid for 365 days from the date of advertiser consent; refresh tokens issued before July 30, 2026 do not have a fixed expiration and remain valid until the advertiser revokes authorization. For details, see Refresh tokens.\n"," The client can pass the access token to the Amazon Ads API to retrieve a profile identifier associated with the advertiser that granted consent. Profiles in the Amazon Ads API represent an account of an advertiser in a specific marketplace.\n"," The client identifier, access token, and profile identifier are used to access the data and services of the advertiser through the Amazon Ads API. \n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":{"type":2,"text":"Required authorization headers"},"path":"/en-us/guides/account-management/authorization/overview","content":[" Based on the patterns described above, each request to the Amazon Ads API requires the following headers: - Amazon-Advertising-API-ClientId: The client identifier of an LwA application authorized to access the API. - Authorization: The string Bearer prepended to an access token representing the permission of that application to access data and services for a given Amazon user.\n"," Nearly all resources available through the Amazon Ads API also require an additional header:\n","Amazon-Advertising-API-Scope: A profile identifier representing an Amazon Ads account belonging to the Amazon user associated with the access token. \n"," If authorization headers are not included or are incorrect, a 401 Unauthorized response is returned. If the Amazon-Advertising-API-Scope header is not included when required or is incorrect, a 401 Unauthorized or 400 Bad Request response is returned.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":{"type":2,"text":"Key authorization concepts"},"path":"/en-us/guides/account-management/authorization/overview","content":["Amazon Ads advertisers control access to their data and services. - Amazon Ads API callers are client applications administered by Login with Amazon and approved by Amazon for API access. - Advertisers can choose to delegate access to their data and services to approved client applications via an OAuth 2.0 flow. - An API caller with an authorization grant from an advertiser can retrieve an access token for that advertiser via Login with Amazon. - An API caller can access the Amazon Ads API by providing the following in the request headers:\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Overview","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/account-management/authorization/overview","content":[" Learn more about related concepts:\n","Authorization Grants - Access Tokens - Refresh Tokens - Profiles - Login with Amazon documentation\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Grants","sectionHeader":null,"path":"/en-us/guides/account-management/authorization/authorization-grants","content":[" As explained in the Authorization Overview, a successful call to the Amazon Ads API requires an advertiser to explicitly grant authorization to a client application to access the data of the advertiser. \n"," This authorization process is handled by the Login with Amazon (LwA) service in multiple stages. The first manifestation of this is an authorization code.\n"," This section briefly reviews these identities:\n","Advertiser: An Amazon Ads customer account. - Client: A Login with Amazon client application approved to call the Amazon Ads API.\n"," As shown in the Authorization Overview, the authorization code represents the consent of a specific advertiser for a specific client to access the data and services of the advertiser through the Amazon Ads API. The authorization code is generated through a consent request enabled by Login with Amazon.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Grants","sectionHeader":{"type":2,"text":"Login with Amazon consent requests"},"path":"/en-us/guides/account-management/authorization/authorization-grants","content":[" Login with Amazon enables advertisers to grant authorization to clients through the LwA user interface. \n"," Upon visiting a specific URL in their web browser, the advertiser is prompted to log in using their Amazon credentials. Then the advertiser may choose to confirm their consent for the client that created the request to access the Amazon Ads data and services of the advertiser.\n","For more general information about authorization grants in LwA, see Authorization Grants.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Grants","sectionHeader":{"type":2,"text":"The consent request URL"},"path":"/en-us/guides/account-management/authorization/authorization-grants","content":[" The consent request page is served by Amazon from one of three regional hosts:\n","| Region | URL prefix | \n","\\|--------\\|------------\\|\n","| North America (NA) | https://www.amazon.com/ap/oa |\n","| Europe (EU) | https://eu.account.amazon.com/ap/oa |\n","| Far East (FE) | https://apac.account.amazon.com/ap/oa |\n"," The request is associated with a specific client application and scope via query parameters in a unique URL. \n","| Parameter | Description |\n","\\|-----------\\|-------------\\|\n","| client_id | The client identifier of the client application. |\n","| scope | The OAuth 2.0 permission scope describing the extent of the application access to an advertiser account.For most uses of the Amazon Ads API, set scope to advertising::campaign_management. For the Data Provider API, set scope to advertising::audiences. |\n","| response_type | The type of response. Always set to code. |\n","| redirect_uri | A URL to which the advertiser will be redirected after allowing access. |\n","| state | OPTIONAL. An opaque value used to maintain state between this request and the response. This value is included in the redirect. |\n","| code_challenge | OPTIONAL. Used to secure authorization code grants via Proof Key for Code Exchange (PKCE). |\n","| code_challenge_method | OPTIONAL. The method used to encode the code_verifier for the code_challenge parameter. |\n"," Example:\n"," Once the advertiser confirms consent, Login with Amazon generates an authorization code representing the permission of the advertiser for the client to access the data of the advertiser within the given scope.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Grants","sectionHeader":{"type":2,"text":"Retrieving authorization codes"},"path":"/en-us/guides/account-management/authorization/authorization-grants","content":[" After confirming consent, the advertiser is redirected to the redirect_uri specified in the request URL. The authorization code is appended as a query parameter. \n"," For a redirect_uri of https://www.amazon.com, for instance, the full redirect will resemble the following:\n"," The code parameter is the authorization code.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Grants","sectionHeader":{"type":2,"text":"Exchanging authorization codes for tokens"},"path":"/en-us/guides/account-management/authorization/authorization-grants","content":[" Once you have an authorization code, you can exchange it for an access token and refresh token. This exchange must happen within 5 minutes, as authorization codes expire after that time.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Grants","sectionHeader":{"type":3,"text":"Token exchange request"},"path":"/en-us/guides/account-management/authorization/authorization-grants","content":[" To exchange an authorization code for tokens, make a POST request to a Login with Amazon authorization server with the following parameters:\n","| Parameter | Description |\n","\\|-----------\\|-------------\\|\n","| grant_type | Must be authorization_code.  |\n","| code | The authorization code retrieved through the consent process. |\n","| redirect_uri | One of the values in the Allowed Return URLs field in your Login with Amazon account. Must match the redirect_uri used in the consent request. |\n","| client_id | The Client ID of the Login with Amazon account. |\n","| client_secret | The Client Secret of the Login with Amazon account. |\n"," The token exchange can be made to any of the three regional Login with Amazon hosts:\n","| Region | Token URL |\n","\\|--------\\|-----------\\|\n","| North America (NA) | https://api.amazon.com/auth/o2/token |\n","| Europe (EU) | https://api.amazon.co.uk/auth/o2/token |\n","| Far East (FE) | https://api.amazon.co.jp/auth/o2/token |\n"," The resulting tokens are valid globally across all regions.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Grants","sectionHeader":{"type":3,"text":"Example request"},"path":"/en-us/guides/account-management/authorization/authorization-grants","content":[],"documentType":"guide"},{"title":"Amazon Ads API Authorization Grants","sectionHeader":{"type":3,"text":"Token response"},"path":"/en-us/guides/account-management/authorization/authorization-grants","content":[" The response to a successful token request is a JSON object with the following schema:\n","| Field | Description |\n","\\|-------\\|-------------\\|\n","| access_token | The access token for making API calls. Valid for 60 minutes. |\n","| token_type | The type of OAuth 2.0 token. Always set to bearer. |\n","| expires_in | The length of time until the access token expires, in seconds (3600 for 60 minutes).|\n","| refresh_token | The refresh token for generating new access tokens. Refresh tokens issued on or after July 30, 2026 are valid for 365 days from the date of advertiser consent; refresh tokens issued before July 30, 2026 do not have a fixed expiration. For details, see Refresh tokens. |\n"," Example response:\n"," Access tokens begin with the characters Atza|, and refresh tokens begin with Atzr|. These characters are part of the token and should be included wherever the token is used.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Grants","sectionHeader":{"type":3,"text":"Next steps"},"path":"/en-us/guides/account-management/authorization/authorization-grants","content":[" You now have both an access token and a refresh token:\n","The access token is used as a credential for calls to the Amazon Ads API. Learn more about using access tokens. - The refresh token allows you to generate new access tokens without requiring the advertiser to re-authorize. Learn more about using refresh tokens.\n"],"documentType":"guide"},{"title":"Amazon Ads API Authorization Grants","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/account-management/authorization/authorization-grants","content":[" Learn more about related concepts:\n","Authorization Overview - Access Tokens - Refresh Tokens - Authorization Grants (Login with Amazon documentation)\n"],"documentType":"guide"},{"title":"Access Tokens in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/account-management/authorization/access-tokens","content":[" Access tokens are credentials that enable client applications to access advertiser data and services through the Amazon Ads API. As explained in the Authorization Overview, a successful call to the Amazon Ads API requires an advertiser to explicitly grant authorization to a client application.\n"," This authorization process is handled by the Login with Amazon (LwA) service using access tokens. In any call to the Amazon Ads API, the access token represents the consent of a specific advertiser for a specific client application to access the data and services of the advertiser.\n"],"documentType":"guide"},{"title":"Access Tokens in the Amazon Ads API","sectionHeader":{"type":2,"text":"Access token concepts"},"path":"/en-us/guides/account-management/authorization/access-tokens","content":["Access tokens are valid for 60 minutes from the time they are issued - They remain valid until expiration or until the advertiser revokes authorization - An access token represents the consent of a specific advertiser for a specific client application to access the data and services of the advertiser - Access tokens begin with the characters Atza| - Access tokens have a maximum size of 2048 bytes\n"],"documentType":"guide"},{"title":"Access Tokens in the Amazon Ads API","sectionHeader":{"type":2,"text":"Obtaining access tokens"},"path":"/en-us/guides/account-management/authorization/access-tokens","content":[" Access tokens are obtained through the Login with Amazon authorization process:\n","Initial authorization: Exchange an authorization code for tokens during the initial authorization process. This returns both an access token and a refresh token. See Authorization Grants for the complete process including authorization server URLs and token response format.\n","Token refresh: Use a refresh token to generate a new access token without requiring the advertiser to re-authorize. See Refresh Tokens for detailed information about maintaining long-term access.\n"],"documentType":"guide"},{"title":"Access Tokens in the Amazon Ads API","sectionHeader":{"type":2,"text":"Using access tokens in the Amazon Ads API"},"path":"/en-us/guides/account-management/authorization/access-tokens","content":[" A valid access token must be included in the Authorization header for any successful call to the Amazon Ads API. The token is appended to the string \"Bearer \" and passed as a single string.\n"," For example, the access token \"Atza|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR...\" would result in the following header:\n"," For a complete list of required authorization headers in the Amazon Ads API, see the Authorization Overview.\n"," For information about error responses to LwA authorization requests, see Access Token Errors.\n"],"documentType":"guide"},{"title":"Access Tokens in the Amazon Ads API","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/account-management/authorization/access-tokens","content":[" Learn more about related concepts:\n","Authorization Overview - Authorization Grants - Refresh Tokens - Access Tokens (Login with Amazon documentation)\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":null,"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" Refresh tokens provide a secure way to maintain long-term access to the data and services of an advertiser through the Amazon Ads API without requiring the advertiser to repeatedly grant authorization. Once obtained during the initial authorization process, a refresh token can be used to generate new access tokens as needed.\n"," This document focuses on using refresh tokens for ongoing access. For information about the initial authorization process, see Authorization Grants. For general information about access tokens, see Access Tokens.\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":2,"text":"Refresh token concepts"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":["For Amazon Ads API advertising scopes, refresh tokens issued on or after July 30, 2026 expire 365 days from the date of advertiser consent. Refresh tokens issued before July 30, 2026 do not have a fixed expiration and remain valid until the advertiser revokes authorization or another invalidation condition occurs. - They remain valid until expiration (where applicable) or until the advertiser revokes authorization - A refresh token can be used multiple times to generate new access tokens before expiration - Each successful token refresh returns both a new access token and the same refresh token - Refresh tokens begin with the characters Atzr| - Refresh tokens have a maximum size of 2048 bytes - A refresh token is specifically assigned to one client application and cannot be used by another client application\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":2,"text":"How to obtain refresh tokens"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" Refresh tokens are obtained during the initial authorization process when you exchange an authorization code for access tokens. The authorization code exchange returns both an access token and a refresh token in a single response.\n"," For detailed step-by-step instructions on the complete authorization flow and obtaining your first refresh token, see Authorization Grants.\n"," Once you have a refresh token, store it securely. You use it to generate new access tokens without requiring the advertiser to re-authorize your application.\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":2,"text":"Advertising API scopes"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" The 365-day refresh token expiration from the date of advertiser consent applies to refresh tokens issued on or after July 30, 2026 for the following advertising scopes. Refresh tokens issued for these scopes before July 30, 2026 are not affected and remain valid until the advertiser revokes authorization or another invalidation condition occurs.\n","| Scope | Description |\n","\\|-------\\|-------------\\|\n","| advertising::campaign_management | The required scope for most requests to the Amazon Ads API. |\n","| advertising::audiences | The required scope for the Data Provider API. |\n"," Refresh tokens are associated with the advertising scopes requested during the initial authorization. The scope(s) granted during authorization determine what operations the resulting access tokens can perform.\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":2,"text":"Using refresh tokens"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" To generate a new access token using a refresh token, make a POST request to a Login with Amazon authorization server. For authorization server URLs and regions, see Authorization Grants - Token exchange request.\n"," The request requires the following parameters:\n","| Parameter | Description |\n","\\|-----------\\|-------------\\|\n","| grant_type | Must be refresh_token |\n","| refresh_token | The refresh token value from a previous successful token request |\n","| client_id | The Client ID of your Login with Amazon application |\n","| client_secret | The Client Secret of your Login with Amazon application |\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":3,"text":"Example request"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":3,"text":"Token response format"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" A successful refresh token request returns a new access token along with the same refresh token. The response follows the same format as the initial token request. For details on the response structure, see Authorization Grants - Token response.\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":2,"text":"When refresh tokens become invalid"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" A refresh token becomes invalid when:\n","The token reaches its 365-day expiration from the date of advertiser consent (applies only to refresh tokens issued on or after July 30, 2026; refresh tokens issued before that date have no fixed expiration) - The advertiser explicitly revokes authorization through their Amazon account settings - The advertiser removes your application from their authorized applications - The Login with Amazon application credentials are changed or deleted - Amazon detects suspicious activity associated with the token\n"," When a refresh token is invalid, you receive an error response and must obtain a new authorization grant from the advertiser.\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":3,"text":"Error response"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" When attempting to use an invalid refresh token, you receive a 400 response with the following error:\n"," This indicates the refresh token is no longer valid. To restore access, you must obtain a new authorization grant from the advertiser. See Authorization Grants for step-by-step instructions on obtaining advertiser consent.\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":2,"text":"Best practices"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":3,"text":"Secure storage"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" Refresh tokens are sensitive credentials that provide long-term access to advertiser data:\n","Store refresh tokens securely using encryption - Never expose refresh tokens in client-side code or logs - Use secure credential management services (e.g., AWS Secrets Manager) - Implement access controls to limit who can retrieve refresh tokens\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":3,"text":"Error handling"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" Implement robust error handling for token refresh operations:\n","Handle network failures with retry logic - Detect and handle revoked refresh tokens - Log token refresh failures for monitoring - Have a fallback mechanism to re-authorize if refresh fails\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":3,"text":"Token rotation"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" Refresh tokens issued on or after July 30, 2026 expire 365 days from the date of advertiser consent. For these tokens, implement a token rotation strategy:\n","Monitor token age and proactively prompt advertisers to re-authorize before expiration - Set up alerts for tokens approaching the 365-day expiration - Implement token revocation capabilities in your application - Monitor for suspicious token usage patterns\n"," Refresh tokens issued before July 30, 2026 do not have a fixed expiration; the same monitoring and revocation capabilities are still recommended, but proactive re-authorization based on token age is not required for these tokens.\n"],"documentType":"guide"},{"title":"Refresh tokens","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/account-management/authorization/refresh-tokens","content":[" Learn more about related authorization concepts:\n","Authorization Overview - Authorization Grants - Access Tokens - Refresh Tokens (Login with Amazon documentation)\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":null,"path":"/en-us/guides/account-management/authorization/profiles","content":[" Profiles in the Amazon Ads API represent an advertiser 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"," Profiles play a crucial role in the Amazon Ads API by determining the management scope for a given call. A profile ID is a required credential to access the data and services of an advertiser in a specific marketplace.\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Authorization"},"path":"/en-us/guides/account-management/authorization/profiles","content":[" Calls to the Amazon Ads API require authorization based on OAuth 2.0. The following must be included in the request headers for any successful call:\n","The client ID of the application authorized to access the API \\* The access token representing the permission of the application to access data and services for a given advertiser\n"," In addition, nearly all resources available through the Amazon Ads API require passing a specific profile identifier in the request header. This value is passed as the Amazon-Advertising-API-Scope parameter. \n"," Even for advertisers with only one profile, this header is required. If the Amazon-Advertising-API-Scope header is not included or is incorrect, a 401 Unauthorized or 400 Bad Request response is returned. \n","For a general summary of authorization in the Amazon Ads API, see the Authorization Overview.\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Retrieving profiles"},"path":"/en-us/guides/account-management/authorization/profiles","content":[" A list of profiles for a given advertiser can be retrieved via a GET request at the /v2/profiles endpoint. This call does not require the Amazon-Advertising-API-Scope header. \n"," The retrieved list includes profiles associated with the advertiser whose permission is represented by the access token. Each profile in the retrieved list represents the account of the advertiser in a specific marketplace.\n"," The profileId of a given profile is passed in subsequent calls to the API to provide access to the resources of the advertiser in the marketplace of that profile.\n","For more information, see the technical specifications for the Profiles resource.\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Regions"},"path":"/en-us/guides/account-management/authorization/profiles","content":[" The Profiles resource returns only those profiles whose marketplace falls within the region covered by the API host to which the call is addressed. \n"," For example, an advertiser with accounts only in the JP and SG marketplaces will receive \\[ ] as the response body for a GET request at the North American host via https://advertising-api.amazon.com/v2/profiles. This advertiser should call the Far East host via https://advertising-api-fe.amazon.com/v2/profiles to retrieve profiles from that region.\n"," The profileId for a profile in a marketplace outside the region covered by a given host does not provide authorization for other operations on the host when passed as the Amazon-Advertising-API-Scope header. A 4XX - Unauthorized response is returned.\n","For a list of marketplaces available through each regional host, see our API Overview.\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Permissions"},"path":"/en-us/guides/account-management/authorization/profiles","content":[" By default, the GET /profiles endpoint displays only profiles with permission to view and edit campaigns. This can be adjusted using the apiProgram and accessLevel query parameters in the request.\n","Learn more about permissions.\n"," For example, the following request would return a list of profiles in North America for which the authorizing account has View permissions for reports:\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Profile types"},"path":"/en-us/guides/account-management/authorization/profiles","content":[" The Profiles resource includes an accountInfo object that includes metadata about the account associated with the profile. The type property describes the account type, and there are currently three types:\n","| type property value | Account type | Description |\n","\\|--------------\\|-----------------------\\|-------------\\|\n","|  vendor | Vendor| The account is a vendor account. Vendor accounts are used with Sponsored Products, Sponsored Brands, and Sponsored Display only. |\n","|  seller | Seller  | The account is a seller account. Seller accounts are used with Sponsored Products, Sponsored Brands, and Sponsored Display only. Note that for Sponsored Brands and Sponsored Display, the account must be enrolled in the Brand Registry. |\n","| agency  | Agency | The account is an agency account. Agency accounts are used with the DSP and Data Provider APIs only. |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Examples"},"path":"/en-us/guides/account-management/authorization/profiles","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"Retrieving profiles"},"path":"/en-us/guides/account-management/authorization/profiles","content":[" In this example, an advertiser operates accounts in the CA, MX, and US marketplaces. The advertiser has granted authorization to access their data and services to a client with ID amzn1.application-oa2-client.XXX, and the client has retrieved an access_token Atza|zZzZzZzZ.\n"," The following call to the API at the North American host will retrieve a list with three profiles:\n"," Response body:\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"Using profile IDs"},"path":"/en-us/guides/account-management/authorization/profiles","content":[" For this advertiser, each additional call to the API will be able to access resources associated with one of the above profiles. \n"," For instance, to access the Sponsored Products Campaigns resource for the account of this advertiser in MX, the profileId from the second profile above will be included as the Amazon-Advertising-API-Scope header.\n"," To access the accounts for US or CA, an additional request must be made for each profile, with the corresponding profileId passed as the Amazon-Advertising-API-Scope header.\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Profiles concepts"},"path":"/en-us/guides/account-management/authorization/profiles","content":["For Sponsored Ads, a profile represents an advertiser account in a specific marketplace. - For Amazon DSP, a profile represents an entity in a specific marketplace or region. - A client application authorized by a user account to access data and services can retrieve a list of profiles via a GET request at the /v2/profiles endpoint. - The profileId is included in most requests to the API to enable actions on that profile. The profileId is passed in the Amazon-Advertising-API-Scope header.\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/account-management/authorization/profiles","content":[" Learn more about concepts from this document:\n","Authorization Overview - Authorization Grants - Access Tokens - Profiles (OpenAPI specification)\n"],"documentType":"guide"},{"title":"Manager accounts in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/account-management/authorization/manager-accounts","content":[" Manager accounts enable advertisers and their agencies to link multiple advertising accounts. In the advertising console, this means they can manage users, handle billing, and view account-level alerts, insights, and performance metrics in a single dashboard.\n","Learn more about manager accounts in the advertising console support center.\n"," You can create manager accounts in the console or via the POST /managerAccounts endpoint in the Amazon Ads API. Any Amazon user account can create a manager account. An Amazon user account can have more than one manager account.\n"],"documentType":"guide"},{"title":"Manager accounts in the Amazon Ads API","sectionHeader":{"type":2,"text":"Authorization"},"path":"/en-us/guides/account-management/authorization/manager-accounts","content":[" To use manager accounts in the Amazon Ads API, a client application can provide an access token representing authorization from an Amazon user account that has access to a manager account. This access token authorizes the client application to make requests to the API on behalf of the linked accounts of the manager account.\n","Learn more about authorization in the Amazon Ads API. - Learn more about Login with Amazon authorization grants.\n"],"documentType":"guide"},{"title":"Manager accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Permissions"},"path":"/en-us/guides/account-management/authorization/manager-accounts","content":[" Linked sponsored ads accounts owned by a third party can choose in the console whether to enable Editor or Viewer permissions for the manager account. A manager account with Editor permission for a linked account may perform any operation in the API on behalf of that account. \n"," A manager account with Viewer permission can access data and generate reports, but will receive a 401 Unauthorized response to requests that require Editor permission.\n"],"documentType":"guide"},{"title":"Manager accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Profiles"},"path":"/en-us/guides/account-management/authorization/manager-accounts","content":[" The profile ID for a specific linked account can be used in requests to the API to access data and services for that account. The profile ID for each linked sponsored ads account is included in the response from the GET /managerAccounts endpoint.\n"," In addition, the GET /profiles endpoint returns all sponsored ads advertising accounts that have given Editor permission to a manager account owned by the authorized user, as well as any profiles directly owned by the user account.\n","Learn more about profiles.\n"],"documentType":"guide"},{"title":"Manager accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Managed DSP accounts"},"path":"/en-us/guides/account-management/authorization/manager-accounts","content":[" Managed service DSP advertisers need to use a manager account to call the reporting API. This process enables entity administrators to grant read-only permissions to a manager account for one or more advertisers within that entity.\n"," Linked DSP accounts are returned from the GET /managerAccounts endpoint with an accountType of DSP_ADVERTISING_ACCOUNT. Use the dspAdvertiserId field of a linked account as the account ID for a DSP reporting request.\n","Learn more about API authorization for managed service DSP accounts.\n"],"documentType":"guide"},{"title":"Manager accounts in the Amazon Ads API","sectionHeader":{"type":2,"text":"API operations"},"path":"/en-us/guides/account-management/authorization/manager-accounts","content":[],"documentType":"guide"},{"title":"Manager accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Create a manager account"},"path":"/en-us/guides/account-management/authorization/manager-accounts","content":[" To create a new manager account for the authorizing user account, make a request to POST /managerAccounts, providing values for managerAccountName and managerAccountType (either Advertiser or Agency) in the request body:\n"," Each manager account is created without linked accounts.\n","View the technical specifications for POST /managerAccounts.\n"],"documentType":"guide"},{"title":"Manager accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"List manager accounts"},"path":"/en-us/guides/account-management/authorization/manager-accounts","content":[" The response from GET /managerAccounts lists all manager accounts for the authorizing user account. Each manager account includes a list of up to 50 linked accounts. \n"," Example response for a user with one manager account and one linked sponsored ads account:\n","View the technical specifications for GET /managerAccounts.\n"],"documentType":"guide"},{"title":"Manager accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Associate or disassociate linked accounts"},"path":"/en-us/guides/account-management/authorization/manager-accounts","content":[" Manager accounts can most easily be associated with linked accounts via the advertising console. For instructions on linking accounts to a manager account, visit \"Add accounts to your manager account\" in the console support center. \n"," The API also has two endpoints for managing account associations:\n","See the specifications for POST /managerAccounts/{managerAccountId}/associate. - See the specifications for POST /managerAccounts/{managerAccountId}/disassociate.\n"," To use the POST /managerAccounts/{managerAccountId}/associate endpoint, the user account associated with the access token must have admin access to both the advertiser account and the manager account. \n"],"documentType":"guide"},{"title":"Test accounts overview","sectionHeader":null,"path":"/en-us/guides/account-management/test-accounts/overview","content":[" Advertising test accounts are a type of advertising account dedicated to testing. 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"," The test account creation API allows users to provision an advertising test account, which can then be used to test API functionality. \n"," An additional permission scope, advertising::test:create_account, is required to use the test account creation API. \n","For setup instructions, begin with authorization for test accounts.\n"],"documentType":"guide"},{"title":"Test accounts overview","sectionHeader":{"type":2,"text":"Features and functionality not supported"},"path":"/en-us/guides/account-management/test-accounts/overview","content":[" While we strive to have as much feature coverage as possible with test accounts, some features and aspects of functionality are currently not supported.\n"],"documentType":"guide"},{"title":"Test accounts overview","sectionHeader":{"type":3,"text":"Other features not supported"},"path":"/en-us/guides/account-management/test-accounts/overview","content":["Performance data: Sponsored ads created in test accounts will not be served to shoppers. As a result, performance data related to campaigns created with test accounts will not be available. This includes, but is not limited to, data such as clicks, impressions, sales, ACOS, and spend. - Insights API: Used for retrieving the top audiences that overlap with the provided audience. - For author test accounts, a test KDP account will be created for the Amazon user account. Manual creation of books will be blocked from bookshelf within this account. During test account creation, test e-books are automatically created for use in test campaigns. - Author test account creation is supported only for the following marketplaces: US, UK, ES, IT, FR, and DE.\n"],"documentType":"guide"},{"title":"Test accounts overview","sectionHeader":{"type":3,"text":"Features partially supported"},"path":"/en-us/guides/account-management/test-accounts/overview","content":[" The following features and APIs will work for test accounts, but will not provide the full experience intended.\n","Billing: Test accounts can be used to call the invoices API. However, no invoice data will generally be available, as the test ads are not served to shoppers in production.\n"],"documentType":"guide"},{"title":"Authorization for test accounts","sectionHeader":null,"path":"/en-us/guides/account-management/test-accounts/authorization-for-test-accounts","content":[" Authorization in the Amazon Ads API is handled by Login with Amazon according to an OAuth 2.0 call flow. To access data and services for a standard advertising account, requests to the API must include the client ID for an approved Login with Amazon application as well as an access token representing permission from an Amazon user account to access data and services within the advertising::campaign_management scope.\n","For an overview of authorization in the Amazon Ads API, see Authorization.\n"," Test account creation requires the additional advertising::test:create_account permission scope. This scope can be requested by any Login with Amazon client application approved to use the Amazon Ads API. \n"],"documentType":"guide"},{"title":"Authorization for test accounts","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/account-management/test-accounts/authorization-for-test-accounts","content":[" The following prerequisites are required to access the test accounts API:\n","A Login with Amazon client application approved for access to the Amazon Ads API. Approved clients are permitted to request the advertising::test:create_account permission scope. If you have not been approved for API access, please begin with our onboarding overview. 2. An Amazon user account that does not currently manage Amazon Ads accounts. We recommend creating a new Amazon user account for this purpose using a valid email address to which your development team has access. Note the login credentials for this account, and ensure that the Amazon account is valid in the marketplace in which you plan to use test accounts.\n"],"documentType":"guide"},{"title":"Authorization for test accounts","sectionHeader":{"type":2,"text":"Authorization grant"},"path":"/en-us/guides/account-management/test-accounts/authorization-for-test-accounts","content":[" The process for granting authorization for test accounts is similar to that described in Authorization grants.\n"],"documentType":"guide"},{"title":"Authorization for test accounts","sectionHeader":{"type":3,"text":"Authorization grant URL"},"path":"/en-us/guides/account-management/test-accounts/authorization-for-test-accounts","content":[" The simplest approach is to request both permission scopes from the test user account via a single authorization grant URL. \n"," As described in the Login with Amazon documentation, multiple scopes can be requested from a single authorization grant URL by separating the scopes with a URL-encoded space character (%20), as in the following example:\n"," For example, the URL for an authorization grant with both scopes (split into multiple lines for legibility) would resemble the following:\n"," The strings YOUR_LWA_CLIENT_ID and YOUR_RETURN_URL should be replaced with appropriate values for your Login with Amazon application. For information on determining these values and selecting the appropriate regional host, see Authorization grants.\n"],"documentType":"guide"},{"title":"Authorization for test accounts","sectionHeader":{"type":2,"text":"Retrieving access tokens"},"path":"/en-us/guides/account-management/test-accounts/authorization-for-test-accounts","content":[" Visit the URL determined above in a browser that is not signed in to any Amazon user account. Sign in using the account described in prerequisite 2 above, then allow permissions via the Login with Amazon user interface. \n"," You will be redirected to the specified redirect URL with the authorization grant code appended as the code query parameter. See Retrieving authorization codes.\n"," The retrieved code is valid for 5 minutes and can be used to retrieve access and refresh tokens as described in Access tokens.\n"],"documentType":"guide"},{"title":"Authorization for test accounts","sectionHeader":{"type":2,"text":"Using access tokens"},"path":"/en-us/guides/account-management/test-accounts/authorization-for-test-accounts","content":[" An access token retrieved by the method described above will grant the client application permission to:\n","Create test accounts as described in Creating test accounts through the advertising::test:create_account scope - Use the created test accounts to test requests to the API as described in Using test accounts through the advertising::campaign_management scope\n"," As with other access tokens for the Amazon Ads API, access tokens expire in 60 minutes. A new access token can be generated as needed using a refresh token. For more information, see Refresh tokens.\n"],"documentType":"guide"},{"title":"Creating test accounts","sectionHeader":null,"path":"/en-us/guides/account-management/test-accounts/create-test-accounts","content":[" The /testAccounts endpoint in the Amazon Ads API enables users to:\n","Request creation of a test advertising account with a POST request - Check account creation status with a GET request. \n"],"documentType":"guide"},{"title":"Creating test accounts","sectionHeader":{"type":2,"text":"Authorization headers"},"path":"/en-us/guides/account-management/test-accounts/create-test-accounts","content":[" Requests to the /testAccounts endpoint require the following headers:\n","Amazon-Advertising-API-ClientId: Your Login with Amazon client ID. - Authorization: An access token that represents permission for the client application to carry out test account creation on behalf of an Amazon user account, as described in Authorization for test accounts. The string Bearer is prepended.\n"," For more information about authorization headers in the Amazon Ads API, see Required authorization headers.\n"],"documentType":"guide"},{"title":"Creating test accounts","sectionHeader":{"type":2,"text":"Creating a test account"},"path":"/en-us/guides/account-management/test-accounts/create-test-accounts","content":[" A new test account can be created with a POST request at /testAccounts.\n"," The JSON request body has three parameters:\n","countryCode: The two-character country code for the marketplace in which the account will be created, one of: US, CA, MX, BR, UK, DE, FR, ES, IT, AE, SA, NL, SE, TR, PL, BE, EG, JP, AU, SG - accountType: Either VENDOR or AUTHOR. - accountMetaData (optional): An object with a single key, vendorCode, whose value is a vendor code to be applied to the test account.\n"],"documentType":"guide"},{"title":"Creating test accounts","sectionHeader":{"type":3,"text":"Supported marketplaces by account type"},"path":"/en-us/guides/account-management/test-accounts/create-test-accounts","content":["| Account type | Supported marketplaces |\n","\\| --- \\| --- \\|\n","| VENDOR | US, CA, BR, MX, JP, AU, SG, UK, IT, ES, FR, DE, AE, SA, NL, TR, PL, SE, EG, BE |\n","| AUTHOR | US, UK, IT, ES, FR, DE |\n"],"documentType":"guide"},{"title":"Creating test accounts","sectionHeader":{"type":3,"text":"Example JSON request body"},"path":"/en-us/guides/account-management/test-accounts/create-test-accounts","content":[],"documentType":"guide"},{"title":"Creating test accounts","sectionHeader":{"type":3,"text":"Example request using cURL"},"path":"/en-us/guides/account-management/test-accounts/create-test-accounts","content":[],"documentType":"guide"},{"title":"Creating test accounts","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/account-management/test-accounts/create-test-accounts","content":[" A successful response returns a 200 code and a JSON body in the following format:\n"," The requestId can be used to retrieve status information as described in the next section.\n"," See the technical specifications for information on error responses.\n"],"documentType":"guide"},{"title":"Creating test accounts","sectionHeader":{"type":2,"text":"Checking the status of an account creation request"},"path":"/en-us/guides/account-management/test-accounts/create-test-accounts","content":[" Creation status and details about created accounts can be retrieved with a GET request at /testAccounts. \n"," A requestId retrieved from a successful POST request can be passed as a query parameter to retrieve details about that request. A request without the requestId parameter will return a list of all test accounts created with the current client ID and authorizing user account.\n"],"documentType":"guide"},{"title":"Creating test accounts","sectionHeader":{"type":3,"text":"Example request using cURL"},"path":"/en-us/guides/account-management/test-accounts/create-test-accounts","content":[],"documentType":"guide"},{"title":"Creating test accounts","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/account-management/test-accounts/create-test-accounts","content":[" For a request using the requestId query parameter, a successful response returns a 200 code and JSON body in the following format:\n"," See the technical specifications for full information on the response schema and error responses.\n"," Once the status is COMPLETED, your advertising test account is ready to be used. \n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" Once you have successfully created a test account, you can use the same client ID and an access token with permission for the advertising::campaign_management scope to access other endpoints in the API.\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":2,"text":"Profiles"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" A GET request to the Profiles resource returns the profiles available for the authorized user account. Each profile in the Amazon Ads API represents the advertising account of a user account in a specific marketplace.\n"," For test accounts, the id key in accountInfo in a returned profile will match the id returned from a GET request at /testAccounts.\n"," To start testing the Amazon Ads API, use the profileId of a returned profile as the value for the Amazon-Advertising-API-Scope header in subsequent requests.\n","Learn more about profiles.\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":2,"text":"Testing Sponsored Products"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" Using the profileId of a test account, you can test any of the APIs under Sponsored Products. \n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":2,"text":"Testing Sponsored Brands"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" Using the profileId of a test account, you can test the APIs under Sponsored Brands. \n"," Please view the technical specifications for Sponsored Brands campaign creation to create any test campaigns just as you would in a real account.\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Moderation of Sponsored Brands campaigns"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" Amazon Ads test accounts are enabled with auto-moderation for ease of testing Sponsored Brands campaigns and APIs. Any Sponsored Brands campaign created under the test account will be approved and available to use for testing. \n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Testing creative assets for Sponsored Brands campaigns"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" A creative asset is required for creating Sponsored Brands campaign creatives. You can create new assets using test accounts in either of two ways:\n","Create a new asset using the stores/createAsset operation. Note the assetID returned in the response. 2. Use the assetID from the previous step to create a Sponsored Brands campaign.\n","Follow the process described in the creative assets API documentation to upload and register any new image asset. 2. Once an asset is registered, note the assetId returned from the registration request and use it to create a Sponsored Brands campaign.\n"," For either method, the campaign and creative will both be approved by auto-moderation. There is no need for separate moderation of the creative assets. The asset will be available under the brandEntityId used during the campaign creation.\n"," A list of existing assets can be retrieved with the stores/listAssets operation for use in future Sponsored Brands campaign creation.\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Unsupported Sponsored Brands APIs"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" The following APIs under Sponsored Brands are not supported for test accounts, and it is not recommended that they be used:\n","Category benchmark - Premoderation (Only SPONSORED_BRANDS will be supported)\n"," To learn about other unsupported features, see Features and functionality not supported for test accounts.\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Testing Sponsored Brands Video campaigns"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" A video asset is required for creating a Sponsored Brands video campaign. You can create a new video asset using test accounts with the Creative Asset Library API:\n","Use POST /assets/upload to generate an upload URL. The request body should include the video filename:\n","Upload your video file using a PUT request to the URL returned in step 1. Set the Content-Type header to match your video format (for example, video/quicktime for .mov files or video/mp4 for .mp4 files).\n","Register the uploaded video using POST /assets/register. The request body should include the upload URL, asset type, and brand entity ID:\n","Poll GET /assets with the returned assetId until the asset status is ACTIVE. Video processing can take up to 30 minutes due to transcoding.\n","Once the asset is active, use the assetId when creating your Sponsored Brands video campaign.\n"," For step-by-step instructions, see Creating assets.\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":2,"text":"Testing Sponsored Display"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" Using the authorization credentials and profileId of a test account, you can test requests to the Sponsored Display API.\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Creating a Sponsored Display campaign"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" To create a test campaign, use the authorization credentials for your test account and send a POST request to /sd/campaigns.\n"," Example request payload\n"," Example response\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Creating a Sponsored Display ad group"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" Using the campaign ID retrieved above, you can create an ad group and associate it with your test campaign via a POST request to /sd/adGroups.\n"," Example request payload\n"," Example response\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Creating a Sponsored Display product ad"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" Using the campaign ID and ad group ID, you can create a product ad via a POST request to /sd/productAds.\n"," Example request payload\n"," Example response\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Adding a creative asset"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" Using the authorization credentials for your test account, use the creative assets API to:\n","Generate an asset upload URL. - Upload a creative asset. - Register your creative asset and retrieve the asset ID.\n"," For step-by-step instructions, see Creating assets.\n"],"documentType":"guide"},{"title":"Using test accounts in the Amazon Ads API","sectionHeader":{"type":3,"text":"Creating a Sponsored Display creative"},"path":"/en-us/guides/account-management/test-accounts/use-test-accounts","content":[" Using the adGroupId and assetId retrieved in earlier steps, you can create a Sponsored Display creative via a POST request to /sd/creatives.\n"," Example request payload\n"],"documentType":"guide"},{"title":"Amazon Ads reporting overview","sectionHeader":null,"path":"/en-us/guides/reporting/overview","content":[" The Amazon Ads API provides a number of reporting features to help advertisers understand and optimize their campaign performance.\n"],"documentType":"guide"},{"title":"Amazon Ads reporting overview","sectionHeader":{"type":2,"text":"Reporting tools"},"path":"/en-us/guides/reporting/overview","content":["| Feature | Description |\n","\\| --- \\| --- \\|\n","| Amazon Marketing Stream (Version 2) | Complete advertising datasets delivered to your S3 bucket as Parquet files, with updates as frequent as every 15 minutes. Provides full reporting API v1 parity with total values, automated backfill up to 70 days on subscription creation, and no polling/throttling. Recommended for new integrations and recurring automated reporting at scale (>100 reports/day) |\n","| Reporting API v1 | A new ad-hoc programmatic interface for accessing Amazon Ads performance data. Combine any dimensions in a single request without selecting a report type. Supports multi-dimensional, cross-ad-product, and cross-account reporting with standardized metrics organized into Traffic, Engagement, and Conversion categories. |\n","| v3 reporting (Amazon Ads API) | To be shutoff after June 30, 2027. Daily and summary performance reports for sponsored ads and Amazon DSP campaigns. Available through the reporting component of the Amazon Ads API. |\n","| Amazon Marketing Stream (Version 1) | To be shutoff after June 30, 2027. Hourly delta-based traffic, conversion, and budget usage data delivered to Firehose or SQS. Migrate to Version 2 before hard shut off date of June 30, 2027. |\n","| Version 2 reporting (sponsored ads) | To be shutoff after June 30, 2027. 1-day performance reports for sponsored ads campaigns |\n","| Amazon DSP reporting | To be shutoff after June 30, 2027. Performance reports for Amazon DSP campaigns. |\n","| Amazon Attribution (beta) | Measures the impact of non-Amazon marketing strategies on Amazon shopping activity. |\n","| Amazon Brand Metrics (beta) | Quantifies opportunities for your brand at each stage of the customer journey on Amazon. |\n","| Marketing Mix Modeling | Aggregated Amazon sales and media performance reports needed for marketing mix modeling (MMM). |\n"],"documentType":"guide"},{"title":"Amazon Ads reporting overview","sectionHeader":{"type":2,"text":"Choosing a reporting surface that works for you"},"path":"/en-us/guides/reporting/overview","content":[" Amazon Marketing Stream Version 2 is the primary programmatic reporting surface for Amazon Ads, built for reporting at scale in the agentic era. It and the reporting API v1 serve different workflows; use the guidance below to decide which fits your use case.\n"," Use Amazon Marketing Stream when you need automated, recurring access to advertising performance data. Stream pushes data to your AWS environment as it becomes available, with no rate limiting or polling. Version 2 delivers complete datasets with every metric and dimension available in the reporting API v1. Stream should be used for building dashboards, running optimization logic, feeding AI and ML models, and managing data at scale across many accounts.\n"," Use the reporting API v1 when you need ad-hoc or periodic reports with predefined metrics and dimensions ready for stakeholder use. The reporting API v1 introduces multi-dimensional reporting, cross-ad-product reporting, and cross-account reporting, so you can get customized insights in a single request. It is designed for scheduled reporting workflows where you pull data on a set cadence.\n","| Use case | I want to... | Recommended solution |\n","\\| --- \\| --- \\| --- \\|\n","| Build responsive applications | Access raw, low-grain data to store in my own systems to power dashboards, analytics, or machine learning models | Amazon Marketing Stream (Version 2) |\n","| Intraday optimization | Adjust bids, budgets, or campaigns throughout the day using fresh performance data | Amazon Marketing Stream (Version 2) |\n","| Real-time dashboards | Keep internal systems and dashboards aligned with Amazon Ads metrics throughout the day | Amazon Marketing Stream (Version 2, updates every 15 minutes for performance data) |\n","| Large-scale reports | Manage data across multiple brands or thousands of accounts without throttling or delays | Amazon Marketing Stream (Version 2) |\n","| AI and predictive modeling | Feed ads performance data into modeling, forecasting, or anomaly detection | Amazon Marketing Stream (Version 2) |\n","| Simplify infrastructure | Consolidate reporting pipelines into one surface with consistent datasets and metrics | Amazon Marketing Stream (Version 2) |\n","| Predefined stakeholder-ready reports | Generate specific reports with predefined metrics and dimensions ready for stakeholder use, without additional transformation | reporting API v1 |\n","| Periodic or scheduled reporting | Refresh performance summaries daily, weekly, or monthly to track trends over time | reporting API v1 |\n","| Interactive data exploration | Browse, filter, and visualize reports directly within the Ads Console | Ads Console Reports |\n"],"documentType":"guide"},{"title":"Amazon Ads reporting overview","sectionHeader":{"type":2,"text":"Data freshness"},"path":"/en-us/guides/reporting/overview","content":[],"documentType":"guide"},{"title":"Amazon Ads reporting overview","sectionHeader":{"type":3,"text":"Sponsored ads"},"path":"/en-us/guides/reporting/overview","content":[" Initial impression and click data from sponsored ads campaigns is available using the API within 12 hours.\n"," Amazon validates every click to make sure advertisers are not charged unnecessarily. Most invalid traffic at the post-impression stage is invalidated in real time. However, some invalid traffic takes more time to detect. The invalid traffic detection system monitors traffic data for up to 30 days after the fact to recognize invalid traffic patterns. We recommend waiting at least 5 days for the most accurate click data to be available before evaluating campaign performance.\n"," Learn more about Traffic validation for clicks on sponsored ads campaigns.\n"," Conversion data is refreshed and validated at daily, weekly, and monthly intervals and is subject to change for up to 60 days back from the current date. We recommend re-retrieving reports monthly to help ensure your conversion metrics are up to date.\n"," Amazon Marketing Stream v2 delivers data updates and automated backfill up to 70 days on subscription creation, so your data self-corrects as attribution validation completes.\n"],"documentType":"guide"},{"title":"Amazon Ads reporting overview","sectionHeader":{"type":3,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/overview","content":[" For Amazon DSP campaigns, Amazon has a process in place to validate impression data and help ensure advertisers are not billed for invalidated impressions. Most invalid traffic at the post-impression stage is invalidated in real time. However, some invalid traffic takes more time to detect. The invalid traffic detection system monitors traffic data for up to 72 hours after the fact to recognize invalid traffic patterns.\n"," For details, see Gross and invalid traffic metrics.\n"],"documentType":"guide"},{"title":"Amazon Ads reporting overview","sectionHeader":{"type":2,"text":"Reports vs. exports"},"path":"/en-us/guides/reporting/overview","content":[" Reports include performance data like impressions or clicks for a chosen report type. Exports contain campaign metadata like budget or status. For example, a target export for Sponsored Products returns all the targeting clauses associated with Sponsored Products campaigns, while a target report contains performance data broken down at the target level.\n"," While reports can include certain metadata, we recommend requesting any metadata using the export resource for improved performance.\n"," Learn more about Exports.\n"],"documentType":"guide"},{"title":"Amazon Ads reporting overview","sectionHeader":{"type":2,"text":"Rate limits"},"path":"/en-us/guides/reporting/overview","content":[" The reporting API v1 allows one concurrent report per advertiser. Only one report can be running at a time for a given advertiser account. Based on average report run times, this single-report concurrency gate allows advertisers to run approximately 100 reports per day.\n"," If you submit a report request while another report is already running for the same advertiser, the request will be queued or receive a 429 response code. We recommend scheduling your reports throughout the day and serializing requests per advertiser to reduce occurrences of rate limiting.\n"," Amazon Marketing Stream removes rate-limiting concerns entirely. Because Stream pushes data to your AWS environment, there are no API calls to throttle.\n"],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/overview","content":[" The new Amazon Ads reporting API is an ad-hoc programmatic interface to access Amazon Ads performance data. Part of the Amazon Ads v1, the new reporting API follows the common model. Compared to the V3 API, the new reporting API offers the following features:\n","Multi-dimensional Reporting: Report types are no longer available or required as they were in the V3 API. Customers can now combine dimensions that were previously only available in separate reports (e.g., Geo x Technology). This improved data flexibility allows customers to combine dimensions to get customized insights for business needs.  Cross-Ad Product Reporting: Create reports that span different ad products and campaign types, providing a consolidated view of overall advertising performance that remains consistent as ad products evolve.  Cross-Account Reporting: For customers managing multiple ad accounts, generate a single report that spans across all the accounts you have access to and generate a unified performance view.\n"," Additionally, this release reflects a major update to Amazon Ads reporting in response to customer feedback, with updated standardization of metric names, definitions, and entity terminology across all ad products, simplifying cross-program reporting and unifying measurement for a more consistent customer experience.\n"],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":{"type":2,"text":"What has changed in the new Reporting API"},"path":"/en-us/guides/reporting/ads-v1/overview","content":[],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":{"type":3,"text":"Standardized terminology for core entities"},"path":"/en-us/guides/reporting/ads-v1/overview","content":[" Terminology for key system objects is now consistent across DSP and Sponsored Ads.\n","| DSP (V3 API)        | Sponsored Ads (V3 API) | New Reporting API |\n","\\|---------------------\\|------------------------\\|-------------------\\|\n","| Order               | Campaign               | Campaign          |\n","| Ad line / Line item | Ad group               | Ad group          |\n","| Creative            | Ad                     | Ad                |\n","| Click-throughs      | Clicks                 | Clicks            |\n"],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":{"type":3,"text":"Reporting on traffic date"},"path":"/en-us/guides/reporting/ads-v1/overview","content":[" All conversion metrics are now reported on \"traffic date,\" meaning conversions are reported on the date of the ad interaction rather than the date the conversion occurred. Previously, DSP reported conversions on the conversion date.\n"," Example: If a shopper clicked an ad on Oct 1 and purchased on Oct 3, the purchase conversion is now reported on Oct 1 (i.e. date of ad interaction). Previously, the purchase conversion would have been reported on Oct 3 (i.e. date of conversion).\n"," This update aligns DSP with Sponsored Ads, following industry best practices and improving the interpretability of rate metrics such as ROAS and Purchase rate, ensuring they represent outcomes relative to the traffic that generated them. You may observe higher conversion volumes earlier in campaign flight as DSP now reports conversions on the traffic date. Metric categorization Metrics are now clearly categorized as Traffic, Engagement, and Conversion metrics to improve discoverability and consistency across ad products:\n","Traffic metrics measure ad delivery (e.g., metric.impressions, metric.viewableImpressions, metric.clicks, metric.totalCost).  Engagement metrics measure shopper interaction or interest in the ad itself (e.g., metric.videoFirstQuartile, metric.videoCompletions).  Conversion metrics measure attributed outcomes for supported conversion types (e.g., metric.purchases, metric.detailPageViews, metric.addToCart, metric.offAmazonLeads, etc.).\n"," This categorization is reflected throughout the metrics library.\n"],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":{"type":3,"text":"Updated naming conventions for conversion metrics"},"path":"/en-us/guides/reporting/ads-v1/overview","content":[" Conversion metrics now follow a unified structure. A base metric (e.g., metric.detailPageViews, metric.addToList, metric.purchases) represents all conversions of that type.\n"," Qualified metrics include additional context for product relevance or traffic source:\n","metric.detailPageViews — All detail-page-view conversions  metric.detailPageViewsPromoted — Detail-page-view conversions for promoted products only  metric.detailPageViewsFromClicksPromoted — Detail-page-view conversions for promoted products, attributed to an ad click  metric.detailPageViewsFromViewsHalo — Detail-page-view conversions for products in the halo of the campaign (see next section), attributed to an ad view  metric.newToBrandDetailPageViewsFromClicksPromoted — Detail-page-view conversions for promoted products by shoppers who are new to the brand, attributed to an ad click\n"],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":{"type":3,"text":"Promoted and halo qualifiers"},"path":"/en-us/guides/reporting/ads-v1/overview","content":[" All conversion metrics now include Promoted and Halo qualified versions, distinguishing conversions for explicitly promoted products from those for highly relevant (\"Halo\") products defined by the expansion rules of each campaign. Additionally, terms such as \"Brand Halo\" and \"Other SKU\" are now standardized as \"Halo\".\n"],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":{"type":3,"text":"Removal of \"Total\" prefix in DSP metrics"},"path":"/en-us/guides/reporting/ads-v1/overview","content":[" The \"Total\" prefix previously used in DSP metrics has been deprecated. Base metrics (e.g., metric.purchases, metric.detailPageViews) now include all conversions—both promoted and halo.\n","| DSP (V3 API)       | New Reporting API         | Definition                                                     |\n","\\|--------------------\\|---------------------------\\|----------------------------------------------------------------\\|\n","| totalPurchases     | metric.purchases          | Includes all attributed purchases                              |\n","| purchases          | metric.purchasesPromoted  | Includes attributed purchases of directly promoted products    |\n","| purchasesBrandHalo | metric.purchasesHalo      | Includes attributed purchases of highly relevant (non-promoted) products |\n"],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":{"type":3,"text":"Removal of interval suffixes (1d, 7d, 14d, 30d)"},"path":"/en-us/guides/reporting/ads-v1/overview","content":[" Conversion metrics no longer include a look-back interval in their names. The base metric (e.g., metric.purchases, metric.sales, metric.unitsSold, metric.roas) always reflects the correct look-back for the campaign type.\n","Sponsored Products: Base metrics automatically align with campaign defaults—7-day look-back for sellers and 14-day look-back for vendors—consistent with the advertising console and downloadable reports. For example, metric.roas now corresponds to roas7d (sellers) or roas14d (vendors). \\* Other campaign types: The standard look-back is 14 days, except for DSP campaigns using flexible look-back windows, where metrics reflect the advertiser-selected click and view windows.\n"],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":{"type":3,"text":"Consistent labeling for off-Amazon conversions"},"path":"/en-us/guides/reporting/ads-v1/overview","content":[" All off-Amazon conversion metrics now include the prefix offAmazon (e.g., metric.offAmazonLeads, metric.offAmazonCheckouts). Previously, this qualifier appeared only when necessary to distinguish off-Amazon conversions from on-Amazon conversion types.\n"],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":{"type":3,"text":"Simplified metric syntax and terminology"},"path":"/en-us/guides/reporting/ads-v1/overview","content":[" Some terms have been replaced with clearer, more intuitive names:\n","effectiveCostPerAddToList → metric.costPerAddToList \\* effectiveRatePerMille (eRPM) → metric.returnPerThousandImpressions\n"," Less common acronyms have been expanded for readability (e.g., eCPATL → metric.costPerAddToList).\n"],"documentType":"guide"},{"title":"Overview of the Reporting v1 API","sectionHeader":{"type":2,"text":"Is the Reporting API right for me?"},"path":"/en-us/guides/reporting/ads-v1/overview","content":["| Use Case                       | I want...                                                                                                                                              | Recommended Solution                                                        |\n","\\|---------------------------------\\|--------------------------------------------------------------------------------------------------------------------------------------------------------\\|-----------------------------------------------------------------------------\\|\n","| Predefined stakeholder-ready reports | Generate specific reports with predefined metrics and dimensions that are ready for stakeholder use, without additional transformation. | Use the Reporting API.                                                      |\n","| Periodic or scheduled reporting | Schedule summarized reports (e.g., weekly or monthly) to review performance trends.                                                                    | Use the Reporting API.                                                      |\n","| Intuitive UI                    | Explore available columns intuitively when unsure what to include in the report.                                                                       | Consider Ads Console Reports.                                               |\n","| Build responsive applications   | Access raw, low-grain data to store in your own systems to power dashboards, analytics, or machine learning models across multiple use cases.           | Consider Amazon Marketing Stream.                                           |\n","| Intraday optimization           | Adjust bids, budgets, or campaigns throughout the day using near real-time performance data.                                                           | Consider Amazon Marketing Stream.                                           |\n","| Real-time dashboards            | Keep internal systems and dashboards aligned with Amazon Ads metrics throughout the day.                                                               | Consider Amazon Marketing Stream (latest delivery updates every 15 minutes). |\n","| Large-scale reports             | Manage data across multiple brands or thousands of accounts without throttling or delays.                                                              | Consider Amazon Marketing Stream.                                           |\n","| AI and predictive modeling      | Use ads performance data for modeling, forecasting, or anomaly detection.                                                                              | Consider Amazon Marketing Stream.                                           |\n","| Simplify infrastructure         | Consolidate reporting pipelines into one surface with consistent datasets and metrics.                                                                 | Consider Amazon Marketing Stream (offers the most extensive hourly data).   |\n"],"documentType":"guide"},{"title":"Getting started with the Reporting API v1","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/quickstart","content":[],"documentType":"guide"},{"title":"Getting started with the Reporting API v1","sectionHeader":{"type":2,"text":"Creating your first report"},"path":"/en-us/guides/reporting/ads-v1/quickstart","content":[" In Version 3 Reporting, you worked within report types. Each report type had a set of supported metrics, dimensions, and ad programs. So, you could generate a dspGeo report to get aggregated metrics per postal code, or you could generate a dspInventory report to get aggregated metrics per supply source. However, you did not have a way to combine all of that into one report. With the new reporting API, that is now possible.\n"," Your focus now is on fields. Fields can be either metric fields (e.g. metric.impressions) or dimension fields (e.g. campaign.id). When you create a report, you simply have to specify which fields you want to include in the report, and the aggregation will occur on all of your specified dimensions:\n"," POST /adsApi/v1/create/reports\n"," In the above example, the included dimensions are date, campaign, postalCode, and supplySource. The generated report will aggregate the desired metrics (e.g. metric.impressions) for each combination of your selected dimensions in a GROUP BY fashion.\n"," For example, the report above represents an eight day period of time (A=8). Say there were two active campaigns during that period (B=2). Each campaign was flighted in 10 postal codes (C=10), on 20 supply sources (D=20). The number of rows in the report would be A \\* B \\* C \\* D = 3200, and each row would include the metric totals for the dimension combination.\n"," When you submit your request, we will provide you with a report ID, along with other metadata, in the response:\n"],"documentType":"guide"},{"title":"Getting started with the Reporting API v1","sectionHeader":{"type":2,"text":"Retrieving your report"},"path":"/en-us/guides/reporting/ads-v1/quickstart","content":[" When you first create your report, the status will be PENDING, and the generation will occur asynchronously. It will transition through different statuses as the generation executes:\n","| Status     | Meaning                                                                                               | Terminal |\n","\\|-------------\\|-------------------------------------------------------------------------------------------------------\\|-----------\\|\n","| PENDING     | The report is pending, check back later.                                                              | -         |\n","| PROCESSING  | The report is processing, check back later.                                                           | -         |\n","| COMPLETED   | The report generation completed, see the completedReportParts for download information.               | Yes       |\n","| FAILED      | The report generation failed, see the failureCode and failureReason for more information.             | Yes       |\n"," You can check the status of your report at any time by retrieving the report. The recommended frequency is once per minute:\n"," POST /adsApi/v1/retrieve/reports\n"," The response will include the current status. Eventually, the report will transition to a terminal status — either COMPLETED or FAILED. In the event of a report generation failure, the response includes information about the failure. See Handling errors for a full explanation of this flow.\n"," When the report completes successfully, the response includes information about how to retrieve the report in the completedReportParts:\n"," Each report part will include a pre-signed S3 URL, and you can then download the report using your mechanism of choice. For example, with curl:\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":2,"text":"Dimensions"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" Dimensions determine the aggregation level of your report data. They define how your data is grouped in each row of your report, allowing you to analyze performance at different levels of granularity. For example, common dimensions include:\n","campaign : Groups data by campaign  adGroup : Groups data by ad group  ad : Groups data by individual ad  placement : Groups data by placement  advertisedProduct : Groups data by the product that was featured in the ad \\* convertedProduct : Groups data by the product that was attributed\n"," When you request a report with a specific dimension, each row will represent a unique value for that dimension, with all metrics aggregated accordingly.\n"," For a complete list of dimensions, see our dimension library.\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":2,"text":"Time dimensions"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" In the new reporting API, time is treated as another dimension. Previously, you provided a timeUnit to control the temporal aggregation of the report. For instance, you would pass DAILY as the time unit if you wanted the report to group data based on the date. Now, if you want to group data based on the date, you need to include date.value as one of your requested fields. That will result in the report being aggregated on the date dimension. The mapping below explains the connection between the two APIs:\n","| New Reporting API Field | Version 3 Reporting Time Unit    |\n","\\|--------------------------\\|---------------------------------\\|\n","| date.value               | DAILY                           |\n","| day.value                | N/A – new feature             |\n","| week.value               | WEEKLY                          |\n","| month.value              | MONTHLY                         |\n","| year.value               | N/A – new feature             |\n","| hour.value               | HOURLY                          |\n"," See the dimension library to learn more about the possible time dimensions.\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":2,"text":"Dimension fields"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" Every dimension has one or more associated fields. One of those fields is denoted as the primary key, and the value of that field uniquely identifies the dimension. For example, the primary key for campaign is campaign.id, and every campaign has a unique ID. Some dimensions also have additional attribute fields that provide additional context and detail for that dimension.\n"," For example, the campaign dimension includes the following fields (and more):\n","campaign.id (Primary Key) : The unique identifier for the campaign  campaign.name : The display name of the campaign  campaign.budgetAmount : The budget allocated to the campaign  campaign.bidStrategy : The bidding strategy applied  campaign.startDate : When the campaign started \\* campaign.endDate : When the campaign is scheduled to end\n"," Including dimension attributes in your report allows you to enrich your data with relevant metadata without changing the aggregation level. You can see all available attributes for each dimension in our dimension library.\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":2,"text":"Metric fields"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" Metrics are the quantifiable performance measurements in your report. They represent the numerical data you want to analyze, such as impressions, clicks, spend, and conversions. Metrics are aggregated and grouped according to the dimensions you request. For example, common metrics include:\n","metric.impressions : The number of times the ad was displayed.  metric.clicks : The number of times the ad was clicked.  metric.addToCart : The number of times a shopper added a product to their cart, attributed to an ad interaction. \\* metrics.sales : The sales from purchases attributed to an ad interaction.\n"," Each metric is calculated based on the dimensional grain of your report, providing insights into performance at your chosen level of detail. For complete definitions and calculation methods for all available metrics, see our metrics library.\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":2,"text":"Compatibility and requirements"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" While the system is designed for flexibility and comprehensive reporting, not all dimensions and metrics can be used together. Some metrics are only meaningful at specific levels of detail based on how the underlying data is collected and aggregated.\n"," For example:\n","The convertedProduct dimension is incompatible with the audienceSegment dimension  The audienceSegment dimension is incompatible with the supplySource dimension  The metric.userReach metric is incompatible with the postalCode dimension\n"," Additionally, some fields cannot be used unless you also include another field.\n"," For example:\n","The campaign.name field requires the campaign.id field  The metric.sales field requires the budgetCurrency.value field  The metric.convertedSales field requires the convertedCurrency.value field\n"," When building your reports, it is important to verify that (a) your requested fields are compatible with one another and (b) required fields are included. You can check the compatibility and requirements for every field in our dimension library and metrics library.\n"," If you attempt to create a report that misses one of those scenarios, you will be provided an error response with a detail message. The most common scenario you might encounter is incompatible fields. When that occurs, the error message will include additional information about what went wrong:\n"," In this scenario, you need to remove one of the conflicting fields to continue. Similarly, if you include a field without its required field, the error message will include an explanation:\n"," Refer to our errors documentation for more information about the types of errors that might occur and how to handle them.\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":2,"text":"Accounts"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" The new reporting API is the first multi-account API available from Amazon Ads. Previously, when you generated a report, you could only utilize a single account. For most use-cases, identity operated at a specific marketplace account level and was passed to the API in the form of a profile via the Amazon-Advertising-API-Scope HTTP header. In the new reporting API, up to 5 accounts at the same time within the accessRequestedAccounts configuration. Additionally, the requested accounts can be a mixture of ADSP regional accounts, global accounts and manager accounts. As a result, a single report can now span hundreds of individual marketplace accounts, greatly expanding your ability to retrieve data while also reducing the number of API requests you have to manage.\n","| Account Type          | Key to Use            |\n","\\|------------------------\\|----------------------\\|\n","| ADSP Regional Account  | advertiserAccountId  |\n","| Global Account         | advertiserAccountId  |\n","| Manager Account        | managerAccountId     |\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":3,"text":"DSP advertiser account identifiers"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" Amazon DSP advertiser accounts are being upgraded to global advertiser accounts. An upgraded advertiser has two identifiers: its DSP advertiser account ID (for example 591878351556755100) and its global advertiser account ID (for example amzn1.ads-account.g.euixi63ev9jmx2p4k9txcj8d4). The Amazon Ads console shows the global advertiser account ID for upgraded advertisers.\n"," When you request a report through a manager account, use the optional managerAccountDspGrouping field on each report to choose which identifier appears in advertiserAccount.id.\n","| Value | Result |\n","\\|---\\|---\\|\n","| DSP_ADVERTISER_ACCOUNT (default when omitted) | One row per DSP advertiser account, identified by its DSP advertiser account ID. Advertisers already upgraded to a global advertiser account may appear as a single row regardless of this setting. |\n","| GLOBAL_ADVERTISER_ACCOUNT | Rows identified by the global advertiser account ID. DSP advertiser accounts that belong to the same global advertiser account are grouped into a single row. Only applies to advertisers that have been upgraded. |\n"," The field has no effect on advertisers that have not been upgraded, or on requests that do not include a manager account in accessRequestedAccounts.\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":2,"text":"Empty and null values"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" When a field has no value for a given row, the representation depends on the output format of your report.\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":3,"text":"CSV format"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" Fields without a value are represented as empty strings. In the CSV file, this appears as an empty cell between delimiters:\n"," In this example, campaign.name has no value and is represented as an empty quoted string (\"\").\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":3,"text":"JSON format"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" Fields without a value are represented as null in the JSON output:\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":3,"text":"Why a field might have no value"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" There are several reasons a field may appear empty or null in your report. Some possible reasons are:\n","Some dimensions (the whole dimension, not a specific attribute alone) and metrics are not applicable to the specific ad type or campaign type in that row. For example, a metric that only applies to video ads will have no value for display ad rows.  Some dimension attributes are nullable by nature. For example, an optional campaign setting that was never configured.  Data is not yet available due to processing timelines. Some metrics may take longer to finalize than others. \\* Access restrictions prevent the value from being included for your account.\n"," A missing value does not imply zero. If a numeric metric has a measured value of zero, it will be explicitly reported as 0, not as an empty string or null.\n"],"documentType":"guide"},{"title":"Helpful concepts","sectionHeader":{"type":3,"text":"Recommendations for handling empty values"},"path":"/en-us/guides/reporting/ads-v1/helpful-concepts","content":[" When parsing report data, we recommend:\n"],"documentType":"guide"},{"title":"New features","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/new-features","content":[],"documentType":"guide"},{"title":"New features","sectionHeader":{"type":2,"text":"Expanded file formats"},"path":"/en-us/guides/reporting/ads-v1/new-features","content":[" In the new Reporting API, report formats have been expanded to support partitioned files, providing the ability to generate and work with much larger reports. Simply specify your format as either PARTITIONED_GZIP_JSON or PARTITIONED_CSV, and when the report is generated, it will be split up into multiple files. Currently, reports are split into up-to 1GB (uncompressed) chunks. Each of the partition files will be available in the completedReportParts property when you retrieve your report:\n"],"documentType":"guide"},{"title":"New features","sectionHeader":{"type":2,"text":"Metric currency conversion"},"path":"/en-us/guides/reporting/ads-v1/new-features","content":[" When working with global accounts, it is common for you to have sales and spend data for multiple budget currencies. In this situation, you cannot sum up currency related fields (e.g. metric.sales) to view top-level performance. The new reporting API allows you to convert any currency related metric field into a common currency, providing you the ability to see global account performance in aggregate.\n"," To use currency conversion, you need to:\n","Assign the currencyOfView setting to your desired currency code from the ISO 4217 standard (e.g. CAD) 2. Include the convertedCurrency.value dimension 3. Include any converted metric fields you desire (e.g. metric.salesConverted, metric.totalCostConverted)\n"," The resulting report will use daily currency rate tables to convert from your original currency into your desired output currency while also including the specified output currency in the convertedCurrency.value column. See the API specification for a complete list of the supported currencies.\n"],"documentType":"guide"},{"title":"New features","sectionHeader":{"type":2,"text":"Warning signals"},"path":"/en-us/guides/reporting/ads-v1/new-features","content":[" The new Reporting API can surface warning signals on a completed report. Warnings are non-fatal: they never prevent a report from completing, and the data you receive is still valid. Instead, each warning summarizes, at the field level, a condition affecting that field's values in the report — for example, that for some rows you are not permissioned to see the field for the requested account (so those values are redacted), or that the field is scheduled for a future deprecation. A warning is reported once per affected field, even though a signal may apply to only some of the rows in that field's column rather than all of them.\n"," Warnings are returned in the warnings array in the AdsApiv1RetrieveReport response (POST /adsApi/v1/retrieve/reports) once the report reaches a terminal state. The array is populated only when there is at least one warning to report; when a report has no warnings, warnings is null. Warnings are summarized per field: each entry identifies a single field and lists one or more signals that apply to that field's values in the report.\n"," Each warning entry has two properties:\n","field: The field from your request's query.fields that the warning applies to. - warningCodes: One or more signals that apply to that field. A single field can carry multiple signals.\n"],"documentType":"guide"},{"title":"New features","sectionHeader":{"type":3,"text":"Available warning signals"},"path":"/en-us/guides/reporting/ads-v1/new-features","content":["| Signal | Meaning |\n","\\|---\\|---\\|\n","| NO_PERMISSION | You are not permissioned to access this field for one or more of the accounts in your request. The report still completes, but the field's value is redacted for the accounts you are not permissioned for. See Empty and null values for how redacted values are represented. Review the account's permissions if you expected this field to be populated for every account. |\n","| PENDING_DEPRECATION | This field is scheduled to be deprecated but is not deprecated yet. It continues to return data for now. Plan to migrate away from this field before it is removed to avoid a future break in your reporting. |\n"],"documentType":"guide"},{"title":"Getting started with the Reporting v1 API","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/building-queries","content":[" The new reporting API provides much greater flexibility and freedom. This section provides example create report requests to demonstrate different use-cases and help you understand how they change the request shape. For brevity, the related headers and URL are not included. For a full account of how these APIs function, check the OpenAPI specification.\n"],"documentType":"guide"},{"title":"Getting started with the Reporting v1 API","sectionHeader":{"type":2,"text":"Simple Report for a Single Account"},"path":"/en-us/guides/reporting/ads-v1/building-queries","content":[" This is a baseline example for a single account, simple dimensions, and a few metrics.\n","Dimensions: date, campaign  Accounts: single account  Filter: N/A\n"],"documentType":"guide"},{"title":"Getting started with the Reporting v1 API","sectionHeader":{"type":2,"text":"Simple Report for Multiple Accounts"},"path":"/en-us/guides/reporting/ads-v1/building-queries","content":[" This is an extended example for multiple account types, simple dimensions, and a few metrics.\n","Dimensions: date, campaign  Accounts: multiple accounts  Filter: N/A\n"],"documentType":"guide"},{"title":"Getting started with the Reporting v1 API","sectionHeader":{"type":2,"text":"Multi-Dimensional Report"},"path":"/en-us/guides/reporting/ads-v1/building-queries","content":[" This is an example of a previously impossible scenario - reporting across multiple dimension categories.\n","Dimensions: date, adGroup, city, deviceType  Accounts: single account  Filter: N/A\n"],"documentType":"guide"},{"title":"Getting started with the Reporting v1 API","sectionHeader":{"type":2,"text":"Ad Product Filtered Report"},"path":"/en-us/guides/reporting/ads-v1/building-queries","content":[" By default, the new reporting API will include data from all ad products. This is an example of using filters to pull data on behalf of a specific ad product.\n","Dimensions: date, adGroup, city, deviceType  Accounts: single account  Filter: one ad product\n"],"documentType":"guide"},{"title":"Getting started with the Reporting v1 API","sectionHeader":{"type":2,"text":"Campaign ID Filtered Report"},"path":"/en-us/guides/reporting/ads-v1/building-queries","content":[" By default, the new reporting API will include data from all of your campaigns. This is an example of using filters to pull data on behalf of specific campaigns.\n","Dimensions: date, adGroup, city, deviceType  Accounts: single account  Filter: two campaigns\n"],"documentType":"guide"},{"title":"Handling errors","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/error-handling","content":[" When errors occur, the API provides all available context to support troubleshooting of that error. The API uses a common structure to model all request errors, regardless of the type. The shape of the API response will be:\n"," The response also includes a specific HTTP status code related to the type of error:\n","400: Bad Request  401: Unauthorized  403: Forbidden  429: Too Many Requests  500: Internal Server Error \\* 503: Service Unavailable\n"],"documentType":"guide"},{"title":"Handling errors","sectionHeader":{"type":2,"text":"Handling bad requests"},"path":"/en-us/guides/reporting/ads-v1/error-handling","content":[" When you receive a 400: Bad Request HTTP status code, you can inspect the code and message in the JSON response to understand what went wrong.\n","code: If the request contained a single error (e.g. an unknown field) the code will be set to the related error code (e.g. 400005). However, if the request contained multiple errors (e.g. an unknown field and a malformed period), the code will be set to the multi-error code (i.e. 400100). \\* message: The message will include comma-separated error messages for each error in the request. With this detail, you can adjust your request accordingly. For example: 400007: {MESSAGE_1}, 400015: {MESSAGE_2}, 400019: {MESSAGE_3}.\n"," For instance, you would receive the following error if you attempted to request an unknown metric:\n"," All of the possible error codes are documented below. This list may grow over time as use cases are expanded.\n"],"documentType":"guide"},{"title":"Handling errors","sectionHeader":{"type":3,"text":"Available error codes"},"path":"/en-us/guides/reporting/ads-v1/error-handling","content":["| Code   | Reason                                                                                                  |\n","\\|--------\\|---------------------------------------------------------------------------------------------------------\\|\n","| 400000 | The JSON request body provided was malformed.                                                           |\n","| 400001 | A generic client-related error occurred.                                                                |\n","| 400004 | The fields included fields that are incompatible with one another.                                      |\n","| 400005 | The fields included a reporting field ID that does not exist.                                           |\n","| 400006 | The fields included a field without also including its required field.                                  |\n","| 400007 | The period start date was after the period end date.                                                    |\n","| 400009 | The period was in the future.                                                                           |\n","| 400011 | The fields included the same field multiple times.                                                      |\n","| 400013 | The fields included a value that is not a properly formatted reporting field ID.                        |\n","| 400014 | The fields did not include at least one metric (e.g. metric.impressions).                               |\n","| 400015 | The fields did not include at least one Level of Detail dimension (e.g. campaign.id).                   |\n","| 400016 | The fields did not include at least one Time dimension (e.g. date.value).                               |\n","| 400017 | The provided format is not supported.                                                                   |\n","| 400019 | The number of accessRequestedAccounts exceeds the available limit.                                      |\n","| 400020 | The filter provided references invalid, unknown, or unallowed fields.                                   |\n","| 400021 | The filter may only have and or on provided at the root level.                                      |\n","| 400022 | The filter provided included an incomplete and filter.                                                |\n","| 400023 | The filter provided an invalid and filter.                                                            |\n","| 400025 | The period exceeded the available look-back for the included time dimensions.                           |\n","| 400026 | The accessRequestedAccounts provided are either unauthorized or do not have linked advertiser accounts. |\n","| 400027 | The included convertedCurrency.value field requires currencyOfView to be set.                           |\n","| 400100 | The request had multiple different errors.                                                              |\n","| 404001 | The requested reportId was not found.                                                                   |\n","| 500100 | An unhandled internal error occurred.                                                                   |\n"],"documentType":"guide"},{"title":"Handling errors","sectionHeader":{"type":2,"text":"Handling asynchronous failures"},"path":"/en-us/guides/reporting/ads-v1/error-handling","content":[" In the event of a failure, all available information is communicated about the failure in the retrieve report API response in the failureCode and failureReason attributes:\n"],"documentType":"guide"},{"title":"Handling errors","sectionHeader":{"type":3,"text":"Available failure codes"},"path":"/en-us/guides/reporting/ads-v1/error-handling","content":["| Code | Reason |\n","\\|------\\|--------\\|\n","| 001  | An unhandled internal failure occurred. Try again, and if the issue persists, contact support. |\n","| 002  | The report you requested was too large. Adjust your request to reduce the date period, number of accounts, or included fields. |\n"],"documentType":"guide"},{"title":"Dates and historical data retention","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dates","content":[],"documentType":"guide"},{"title":"Dates and historical data retention","sectionHeader":{"type":2,"text":"Measurement and aggregation dates"},"path":"/en-us/guides/reporting/ads-v1/dates","content":[" The new reporting API provides the ability to include multiple accounts from various different countries and timezones. By default, performance is measured and data is aggregated based on each campaign timezone, which can also be included in the report via the timeZone.value dimension field.\n"," So, when you generate a report that includes date.value, campaign.id, timeZone.value, and metric.impressions, the metric totals for each row will be based on the relative 24-hour period:\n","| date.value | campaign.id | timeZone.value | metric.impressions | Effective 24-hour period                 |\n","\\|-------------\\|----------------\\|----------------\\|--------------------\\|------------------------------------------\\|\n","| 11/5/2025   | {CAMPAIGN_1}   | EST            | 100                | 2025-11-05 05:00 Z → 2025-11-06 04:59 Z  |\n","| 11/5/2025   | {CAMPAIGN_2}   | GMT            | 200                | 2025-11-05 00:00 Z → 2025-11-05 23:59 Z  |\n","| 11/5/2025   | {CAMPAIGN_3}   | CET            | 300                | 2025-11-04 23:00 Z → 2025-11-05 22:59 Z  |\n","| 11/5/2025   | {CAMPAIGN_4}   | JST            | 400                | 2025-11-04 15:00 Z → 2025-11-05 14:59 Z  |\n"," Future releases will include support for UTC time zone normalization, enabling aggregation across a common 24-hour period.\n"],"documentType":"guide"},{"title":"Dates and historical data retention","sectionHeader":{"type":2,"text":"Date Periods"},"path":"/en-us/guides/reporting/ads-v1/dates","content":[" As mentioned above, the new reporting API uses campaign timezone for data aggregation. When you specify date periods, it uses the same methodology. In the example below, you would be requesting data from 2025-06-13 to 2025-06-19 in the relevant campaign timezones:\n"],"documentType":"guide"},{"title":"Dates and historical data retention","sectionHeader":{"type":2,"text":"Historical Data Retention"},"path":"/en-us/guides/reporting/ads-v1/dates","content":[" Another element to consider is data retention. As part of the Ads API v1 Reporting release, reporting data retention periods are being extended to provide deeper insights:\n","| Time Dimension   | Data Retention | Max Report Date Range |\n","\\|------------------\\|----------------\\|-----------------------\\|\n","| hour.value       | 14 days        | 14 days               |\n","| date.value       | 24 months      | 120 days              |\n","| week.value       | 24 months      | 15 months             |\n","| day.value        | 24 months      | 15 months             |\n","| dayOfWeek.value  | 24 months      | 15 months             |\n","| month.value      | 6 years        | 25 months             |\n","| year.value       | 6 years        | 6 years               |\n","| dateRange.value  | 6 years        | 6 years               |\n"," It is important to note that despite having extended access to historical data, combining extensive look backs with a large number of dimensions and metrics and a wide date range can result in the report generation failing due to the size of the expected report. It is recommended to limit the date range for reports, even when accessing extensive historical data.\n"],"documentType":"guide"},{"title":"Dates and historical data retention","sectionHeader":{"type":2,"text":"Dimensions with limited history"},"path":"/en-us/guides/reporting/ads-v1/dates","content":["| Dimension | Available from |\n","\\|-----------\\|----------------\\|\n","| Benchmark brand, Benchmark browse category, Benchmark browse category marketplace, Benchmark campaign goal | 6/1/2025 |\n"],"documentType":"guide"},{"title":"Limits and best practices","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/limits","content":[" Amazon Ads places limits on how its APIs can be accessed, and how data is generated.  It is important to be aware of these limits, as well as how APIs will react when those limits are breached so that you can account for that as part of your API integration.\n"],"documentType":"guide"},{"title":"Limits and best practices","sectionHeader":{"type":2,"text":"Request frequency"},"path":"/en-us/guides/reporting/ads-v1/limits","content":[" Amazon places limits on the frequency of requests to its APIs in general, as well as specific endpoints.  There are limits both on concurrent calls to its endpoints, as well as how frequent those calls are made.  If those limits are breached the system will return an HTTP 429 error code.  It is recommended to implement adaptive integrations which will react to these errors and reduce the number of calls made to the service.\n"],"documentType":"guide"},{"title":"Limits and best practices","sectionHeader":{"type":2,"text":"Report size and complexity"},"path":"/en-us/guides/reporting/ads-v1/limits","content":[" Reporting API v1 introduces the idea of flexible reporting, allowing a choice from an extensive list of metrics and dimensions, while also extending date ranges and historical look-back capabilities.  While these are powerful capabilities, when combined it can result in extremely large data files.\n"," When a report is submitted that will result in a file that is too large, that report request may fail immediately, or may fail after a period of attempting to process that report.  It is important to ensure that your download integration considers failure modes and how to react to them.  Repeating the same request may result in repetitive failures if the report is too large to process.\n"],"documentType":"guide"},{"title":"Limits and best practices","sectionHeader":{"type":2,"text":"Best practices"},"path":"/en-us/guides/reporting/ads-v1/limits","content":[" To avoid report request or generation failures, it is recommended to use the appropriate tools for specific use cases.\n"],"documentType":"guide"},{"title":"Migrating from: spCampaigns","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/report-types/sp-campaigns","content":[],"documentType":"guide"},{"title":"Migrating from: spCampaigns","sectionHeader":{"type":2,"text":"Version 3 Reporting API Example"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-campaigns","content":[" POST /reporting/reports\n"],"documentType":"guide"},{"title":"Migrating from: spCampaigns","sectionHeader":{"type":2,"text":"Reporting API v1 Example"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-campaigns","content":[" POST /adsApi/v1/create/reports\n","\n"],"documentType":"guide"},{"title":"Migrating from: spCampaigns","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-campaigns","content":[],"documentType":"guide"},{"title":"Migrating from: spPurchasedProduct","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/report-types/sp-purchased-product","content":[],"documentType":"guide"},{"title":"Migrating from: spPurchasedProduct","sectionHeader":{"type":2,"text":"Version 3 Reporting API Example"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-purchased-product","content":[" POST /reporting/reports\n"],"documentType":"guide"},{"title":"Migrating from: spPurchasedProduct","sectionHeader":{"type":2,"text":"Reporting API v1 Example"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-purchased-product","content":[" POST /adsApi/v1/create/reports\n","\n"],"documentType":"guide"},{"title":"Migrating from: spPurchasedProduct","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-purchased-product","content":[],"documentType":"guide"},{"title":"Migrating from: spAdvertisedProduct","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/report-types/sp-advertised-product","content":[],"documentType":"guide"},{"title":"Migrating from: spAdvertisedProduct","sectionHeader":{"type":2,"text":"Version 3 Reporting API Example"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-advertised-product","content":[],"documentType":"guide"},{"title":"Migrating from: spAdvertisedProduct","sectionHeader":{"type":2,"text":"Reporting API v1 Example"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-advertised-product","content":["\n"],"documentType":"guide"},{"title":"Migrating from: spAdvertisedProduct","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-advertised-product","content":[],"documentType":"guide"},{"title":"Migrating from: spSearchTerm","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/report-types/sp-search-term","content":[],"documentType":"guide"},{"title":"Migrating from: spSearchTerm","sectionHeader":{"type":2,"text":"Version 3 Reporting API Example"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-search-term","content":[" POST /reporting/reports\n"],"documentType":"guide"},{"title":"Migrating from: spSearchTerm","sectionHeader":{"type":2,"text":"Reporting API v1 Example"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-search-term","content":[" POST /adsApi/v1/create/reports\n","\n"],"documentType":"guide"},{"title":"Migrating from: spSearchTerm","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-search-term","content":[],"documentType":"guide"},{"title":"Migrating from: spTargeting","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/report-types/sp-targeting","content":[],"documentType":"guide"},{"title":"Migrating from: spTargeting","sectionHeader":{"type":2,"text":"Version 3 Reporting API Example"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-targeting","content":[],"documentType":"guide"},{"title":"Migrating from: spTargeting","sectionHeader":{"type":2,"text":"Reporting API v1 Example"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-targeting","content":["\n"],"documentType":"guide"},{"title":"Migrating from: spTargeting","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/report-types/sp-targeting","content":[],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":[],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":{"type":2,"text":"Currency"},"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":["Budget currency - Converted currency\n"],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":{"type":2,"text":"Time"},"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":["Date - Week - Day of month - Month - Year - Day of week - Hour - Date range\n"],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":{"type":2,"text":"Level of detail"},"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":["Advertiser account - Ad product - Portfolio - Insertion order - Campaign - Flight - Ad group - Ad\n"],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":{"type":2,"text":"Product"},"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":["Advertised product - Advertised product marketplace - Advertised product SKU - Converted product - Converted product marketplace - Product relevance\n"],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":{"type":2,"text":"Supply"},"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":["Supply source - Site or app - Placement - Placement size - Placement classification - Deal - Content genre - Content rating - Content type - Content title - Content creator - Live event property - Live event - Live event inventory type - Live event ad break - Live event ad slot - Brand suitability content exclusion category - Brand suitability inventory tier\n"],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":{"type":2,"text":"Technology"},"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":["Operating system - Browser name - Browser version - Device type - Environment\n"],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":{"type":2,"text":"Geography"},"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":["Country - Region - DMA - City - Postal code\n"],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":{"type":2,"text":"Audience"},"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":["Audience segment - Audience segment targeting status\n"],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":{"type":2,"text":"Targeting"},"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":["Frequency group - Target - Targeting - Targeting match type - Search term - Matched target\n"],"documentType":"guide"},{"title":"Dimensions library","sectionHeader":{"type":2,"text":"Conversion"},"path":"/en-us/guides/reporting/ads-v1/dimensions/library","content":["Conversion source - Conversion definition (off-Amazon) - Conversion type (off-Amazon) - Conversion source environment - Conversion source attribution type\n"],"documentType":"guide"},{"title":"Budget currency (Currency)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/currency/budget-currency","content":[" The Budget currency dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Budget currency (Currency)","sectionHeader":{"type":2,"text":"Budget currency (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/currency/budget-currency","content":["Reporting Field ID: budgetCurrency.value - Data Type: STRING - Description: The currency in which the advertising spend was made. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): orderCurrency - Version 3 Reporting Name (Sponsored Ads): campaignBudgetCurrencyCode\n"],"documentType":"guide"},{"title":"Budget currency (Currency)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/currency/budget-currency","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ✅ |\n","| Brand suitability inventory tier | ✅ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Budget currency (Currency)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/currency/budget-currency","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Budget currency (Currency)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/currency/budget-currency","content":[],"documentType":"guide"},{"title":"Converted currency (Currency)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/currency/converted-currency","content":[" The Converted currency dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Converted currency (Currency)","sectionHeader":{"type":2,"text":"Converted currency (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/currency/converted-currency","content":["Reporting Field ID: convertedCurrency.value - Data Type: STRING - Description: The currency selected by the customer to view metrics. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Converted currency (Currency)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/currency/converted-currency","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ✅ |\n","| Brand suitability inventory tier | ✅ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ✅ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Converted currency (Currency)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/currency/converted-currency","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Converted currency (Currency)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/currency/converted-currency","content":[],"documentType":"guide"},{"title":"Date (Time)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/time/date","content":[" The Date dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Date (Time)","sectionHeader":{"type":2,"text":"Date (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/date","content":["Reporting Field ID: date.value - Data Type: DATE - Description: The date included in the report. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): Date - Version 3 Reporting Name (Sponsored Ads): Date\n"],"documentType":"guide"},{"title":"Date (Time)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/date","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ✅ |\n","| Brand suitability inventory tier | ✅ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date range | ❌ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ✅ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Date (Time)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/date","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Date (Time)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/date","content":[],"documentType":"guide"},{"title":"Week (Time)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/time/week","content":[" The Week dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Week (Time)","sectionHeader":{"type":2,"text":"Week (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/week","content":["Reporting Field ID: week.value - Data Type: LONG - Description: The week of the year associated with the report. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): Week - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Week (Time)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/week","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ❌ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ✅ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Week (Time)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/week","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Week (Time)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/week","content":[],"documentType":"guide"},{"title":"Day of month (Time)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/time/day-of-month","content":[" The Day of month dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Day of month (Time)","sectionHeader":{"type":2,"text":"Day of Month (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/day-of-month","content":["Reporting Field ID: day.value - Data Type: LONG - Description: The day of the month associated with the report. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): Day - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Day of month (Time)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/day-of-month","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ✅ |\n","| Brand suitability inventory tier | ✅ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ❌ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ✅ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Day of month (Time)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/day-of-month","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Day of month (Time)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/day-of-month","content":[],"documentType":"guide"},{"title":"Month (Time)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/time/month","content":[" The Month dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Month (Time)","sectionHeader":{"type":2,"text":"Month (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/month","content":["Reporting Field ID: month.value - Data Type: LONG - Description: The month of the year associated with the report. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): Month - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Month (Time)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/month","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ❌ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ✅ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Month (Time)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/month","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Month (Time)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/month","content":[],"documentType":"guide"},{"title":"Year (Time)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/time/year","content":[" The Year dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Year (Time)","sectionHeader":{"type":2,"text":"Year (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/year","content":["Reporting Field ID: year.value - Data Type: LONG - Description: The year associated with the report. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): Year - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Year (Time)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/year","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ❌ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ✅ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n"],"documentType":"guide"},{"title":"Year (Time)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/year","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Year (Time)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/year","content":[],"documentType":"guide"},{"title":"Day of week (Time)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/time/day-of-week","content":[" The Day of week dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Day of week (Time)","sectionHeader":{"type":2,"text":"Day of week (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/day-of-week","content":["Reporting Field ID: dayOfWeek.value - Data Type: STRING - Description: The day of the week associated with the report - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Day of week (Time)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/day-of-week","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ✅ |\n","| Brand suitability inventory tier | ✅ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ❌ |\n","| Day of month | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ✅ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Day of week (Time)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/day-of-week","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Day of week (Time)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/day-of-week","content":[],"documentType":"guide"},{"title":"Hour (Time)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/time/hour","content":[" The Hour dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Hour (Time)","sectionHeader":{"type":2,"text":"Hour (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/hour","content":["Reporting Field ID: hour.value - Data Type: LONG - Description: The hour of the day associated with the report. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): hourOfDay - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Hour (Time)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/hour","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ❌ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Hour (Time)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/hour","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Hour (Time)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/hour","content":[],"documentType":"guide"},{"title":"Date range (Time)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/time/date-range","content":[" The Date range dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Date range (Time)","sectionHeader":{"type":2,"text":"Date range (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/date-range","content":["Reporting Field ID: dateRange.value - Data Type: DATE_RANGE - Description: The date range associated with the report. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Date range (Time)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/date-range","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ❌ |\n","| Day of month | ❌ |\n","| Day of week | ❌ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ✅ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ❌ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ❌ |\n","| Year | ❌ |\n"],"documentType":"guide"},{"title":"Date range (Time)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/date-range","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Date range (Time)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/time/date-range","content":[],"documentType":"guide"},{"title":"Advertiser account (Level of detail)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/advertiser-account","content":[" The Advertiser account dimension contains 4 fields, listed below:\n"],"documentType":"guide"},{"title":"Advertiser account (Level of detail)","sectionHeader":{"type":2,"text":"Advertiser account ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/advertiser-account","content":["Reporting Field ID: advertiserAccount.id - Data Type: STRING - Description: The unique ID associated with the advertiser account. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): advertiserId - Version 3 Reporting Name (Sponsored Ads): advertiserId\n"],"documentType":"guide"},{"title":"Advertiser account (Level of detail)","sectionHeader":{"type":2,"text":"Advertiser account name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/advertiser-account","content":["Reporting Field ID: advertiserAccount.name - Data Type: STRING - Description: The unique ID associated with the advertiser account. - Required fields: advertiserAccount.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): advertiserName - Version 3 Reporting Name (Sponsored Ads): advertiserName\n"],"documentType":"guide"},{"title":"Advertiser account (Level of detail)","sectionHeader":{"type":2,"text":"Manager accounts"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/advertiser-account","content":["Reporting Field ID: advertiserAccount.managerAccounts - Data Type: STRING - Description: The manager accounts that the advertiser account is associated with. - Required fields: advertiserAccount.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): managerAccountId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Advertiser account (Level of detail)","sectionHeader":{"type":2,"text":"Entity ID"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/advertiser-account","content":["Reporting Field ID: advertiserAccount.entityId - Data Type: STRING - Description: The entity that the advertiser account is associated with. - Required fields: advertiserAccount.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): entityId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Advertiser account (Level of detail)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/advertiser-account","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ✅ |\n","| Brand suitability inventory tier | ✅ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ✅ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Advertiser account (Level of detail)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/advertiser-account","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Advertiser account (Level of detail)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/advertiser-account","content":[],"documentType":"guide"},{"title":"Ad product (Level of detail)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-product","content":[" The Ad product dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Ad product (Level of detail)","sectionHeader":{"type":2,"text":"Ad product (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-product","content":["Reporting Field ID: adProduct.value - Data Type: STRING - Description: The Amazon ad product like Sponsored Products, Sponsored Brands, or Amazon DSP - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad product (Level of detail)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-product","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ✅ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Ad product (Level of detail)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-product","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Ad product (Level of detail)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-product","content":[],"documentType":"guide"},{"title":"Portfolio (Level of detail)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/portfolio","content":[" The Portfolio dimension contains 2 fields, listed below:\n"],"documentType":"guide"},{"title":"Portfolio (Level of detail)","sectionHeader":{"type":2,"text":"Portfolio ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/portfolio","content":["Reporting Field ID: portfolio.portfolioId - Data Type: STRING - Description: The unique ID associated with a portfolio. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): portfolioId\n"],"documentType":"guide"},{"title":"Portfolio (Level of detail)","sectionHeader":{"type":2,"text":"Portfolio name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/portfolio","content":["Reporting Field ID: portfolio.name - Data Type: STRING - Description: The name of the portfolio. - Required fields: portfolio.portfolioId 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): portfolio\n"],"documentType":"guide"},{"title":"Portfolio (Level of detail)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/portfolio","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Portfolio (Level of detail)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/portfolio","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Portfolio (Level of detail)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/portfolio","content":[],"documentType":"guide"},{"title":"Insertion order (Level of detail)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/insertion-order","content":[" The Insertion order dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Insertion order (Level of detail)","sectionHeader":{"type":2,"text":"Insertion order ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/insertion-order","content":["Reporting Field ID: insertionOrder.id - Data Type: STRING - Description: The ID associated with the insertion order. An insertion order is a contractual agreement between an advertiser and Amazon Ads. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Insertion order (Level of detail)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/insertion-order","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Insertion order (Level of detail)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/insertion-order","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Insertion order (Level of detail)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/insertion-order","content":[],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":[" The Campaign dimension contains 15 fields, listed below:\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.id - Data Type: STRING - Description: The unique ID associated with the campaign. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): orderId - Version 3 Reporting Name (Sponsored Ads): campaignId\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.name - Data Type: STRING - Description: The name of the campaign used to organize ad groups, apply a budget, and various other settings. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): order - Version 3 Reporting Name (Sponsored Ads): campaignName\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign OMS proposal ID"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.omsId - Data Type: STRING - Description: The unique ID associated with the campaign imported from Amazon's order management system (OMS). - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): proposalId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Global Campaign ID"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.globalCampaignId - Data Type: STRING - Description: The global campaign ID associated with the campaign. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign currency code"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.currencyCode - Data Type: STRING - Description: The three-letter currency code like USD, EUR, GBP, etc. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): orderCurrency - Version 3 Reporting Name (Sponsored Ads): campaignBudgetCurrencyCode\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign budget amount"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.budgetAmount - Data Type: LONG - Description: The total budget allocated for the campaign. - Required fields: budgetCurrency.value 📎, campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): orderBudget - Version 3 Reporting Name (Sponsored Ads): campaignBudget\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign budget type"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.budgetType - Data Type: STRING - Description: The way spending is structured for a campaign like \"daily\" indicating the spending limit per day or \"total\" indicating the entire campaign duration. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): NA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign delivery status"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.deliveryStatus - Data Type: STRING - Description: The status of the campaign like delivering, inactive, ended, etc. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): campaignStatus\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign start date"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.startDate - Data Type: DATE_TIME - Description: The date when the campaign is scheduled to start running and serving ads. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): orderStartDate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign end date"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.endDate - Data Type: DATE_TIME - Description: The date when the campaign is scheduled to stop running and serving ads. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): orderEndDate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign bid strategy"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.bidStrategy - Data Type: STRING - Description: The bid strategy for the campaign like front loaded or evenly spread. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign rule amount"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.ruleAmount - Data Type: LONG - Description: The modified campaign budget based on a rule. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): campaignRuleBasedBudgetAmount\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign cost type"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.costType - Data Type: STRING - Description: The way you pay for your ads like CPC and CPM. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): costType\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign PO number"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.purchaseOrderNumber - Data Type: STRING - Description: The ID assigned to a campaign for tracking purposes. Campaign PO number or external ID is optional. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): PO Number - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Campaign country"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["Reporting Field ID: campaign.country - Data Type: STRING - Description: The country in which the campaign is delivering. - Required fields: campaign.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): country - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ✅ |\n","| Brand suitability inventory tier | ✅ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.demandSideFees 📎 - metric.demandSideFeesConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.publisherEarnings 📎 - metric.publisherEarningsConverted 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.supplySideFees 📎 - metric.supplySideFeesConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.topOfSearchImpressionShare 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Campaign (Level of detail)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/campaign","content":[],"documentType":"guide"},{"title":"Flight (Level of detail)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/flight","content":[" The Flight dimension contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Flight (Level of detail)","sectionHeader":{"type":2,"text":"Flight ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/flight","content":["Reporting Field ID: flight.id - Data Type: STRING - Description: The unique ID associated with a specific campaign flight to track and manage campaign delivery. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): flightId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Flight (Level of detail)","sectionHeader":{"type":2,"text":"Flight name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/flight","content":["Reporting Field ID: flight.name - Data Type: STRING - Description: The name of the campaign flight. - Required fields: flight.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): flightName - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Flight (Level of detail)","sectionHeader":{"type":2,"text":"Flight start date"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/flight","content":["Reporting Field ID: flight.startDate - Data Type: DATE_TIME - Description: The date when the flight is scheduled to start running. - Required fields: flight.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): flightStartDate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Flight (Level of detail)","sectionHeader":{"type":2,"text":"Flight end date"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/flight","content":["Reporting Field ID: flight.endDate - Data Type: DATE_TIME - Description: The date when the flight is scheduled to stop running. - Required fields: flight.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): flightEndDate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Flight (Level of detail)","sectionHeader":{"type":2,"text":"Flight budget"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/flight","content":["Reporting Field ID: flight.budget - Data Type: LONG - Description: The total budget for the flight. - Required fields: budgetCurrency.value 📎, flight.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): flightBudget - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Flight (Level of detail)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/flight","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Flight (Level of detail)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/flight","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Flight (Level of detail)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/flight","content":[],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":[" The Ad group dimension contains 14 fields, listed below:\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.id - Data Type: STRING - Description: The unique ID associated with the ad group. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemId - Version 3 Reporting Name (Sponsored Ads): adGroupId\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.name - Data Type: STRING - Description: The name of an ad group that can have creatives, budgets, targeting, and other settings. - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemName - Version 3 Reporting Name (Sponsored Ads): adGroupName\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group delivery status"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.deliveryStatus - Data Type: STRING - Description: The status of the ad group like delivering, inactive, ended, etc. - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemStatus - Version 3 Reporting Name (Sponsored Ads): adStatus\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group start date"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.startDate - Data Type: DATE_TIME - Description: The date when the ad group is scheduled to start displaying ads. - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemStartDate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group end date"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.endDate - Data Type: DATE_TIME - Description: The date when the ad group is scheduled to stop displaying ads. - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemEndDate - Version 3 Reporting Name (Sponsored Ads): adGroupEndDate\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group type"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.type - Data Type: STRING - Description: The setting that determines the features and ad formats available to an ad group like display, video, audio, etc. - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemType - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group external ID"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.externalId - Data Type: STRING - Description: The user-defined ID that can be assigned to an ad group for tracking purposes or for integration with external systems. - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemExternalId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group OMS ID"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.omsId - Data Type: STRING - Description: The unique ID associated with the ad group imported from Amazon's order management system (OMS). - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemOmsId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group bid strategy"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.bidStrategy - Data Type: STRING - Description: The automated or manual approach to control how much to bid for ad placements within an ad group. - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group language targeting"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.languageTargeting - Data Type: STRING - Description: The setting that determines the language of the supply content the ad appears on. - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemlanguageTargeting - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group cost type"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.costType - Data Type: STRING - Description: The basis for charging advertising costs at an ad group level like CPC and CPM. - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemCostType - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group budget amount"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.budgetAmount - Data Type: STRING - Description: The total budget allocated for the ad group. - Required fields: adGroup.id 📎, budgetCurrency.value 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group comments"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.comments - Data Type: STRING - Description: The comments added to an ad group - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): lineItemComments - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Ad group optimization type"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["Reporting Field ID: adGroup.optimizationType - Data Type: STRING - Description: The KPI that the ad group goal is working to optimize. - Required fields: adGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): bidOptimization - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ✅ |\n","| Brand suitability inventory tier | ✅ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageHouseholdImpressionFrequency 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveReachRateLinearTV 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.householdFrequency1 📎 - metric.householdFrequency10Plus 📎 - metric.householdFrequency2 📎 - metric.householdFrequency3 📎 - metric.householdFrequency4 📎 - metric.householdFrequency5 📎 - metric.householdFrequency6 📎 - metric.householdFrequency7 📎 - metric.householdFrequency8 📎 - metric.householdFrequency9 📎 - metric.householdReach 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.incrementalReachRateLinearTV 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Ad group (Level of detail)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad-group","content":[],"documentType":"guide"},{"title":"Ad (Level of detail)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad","content":[" The Ad dimension contains 6 fields, listed below:\n"],"documentType":"guide"},{"title":"Ad (Level of detail)","sectionHeader":{"type":2,"text":"Ad ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad","content":["Reporting Field ID: ad.id - Data Type: STRING - Description: The unique ID associated with the ad. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): creativeId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad (Level of detail)","sectionHeader":{"type":2,"text":"Ad name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad","content":["Reporting Field ID: ad.name - Data Type: STRING - Description: The user-defined name for the ad used to populate an ad slot. - Required fields: ad.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): creativeName - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad (Level of detail)","sectionHeader":{"type":2,"text":"Ad format"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad","content":["Reporting Field ID: ad.format - Data Type: STRING - Description: The format of the ad like video, image, etc. - Required fields: ad.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): creativeType - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad (Level of detail)","sectionHeader":{"type":2,"text":"Ad size"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad","content":["Reporting Field ID: ad.size - Data Type: STRING - Description: The dimensions of the ad in pixels. - Required fields: ad.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): creativeSize - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad (Level of detail)","sectionHeader":{"type":2,"text":"Ad language"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad","content":["Reporting Field ID: ad.language - Data Type: STRING - Description: The primary language used in the ad. - Required fields: ad.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): creativeLanguage - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad (Level of detail)","sectionHeader":{"type":2,"text":"Ad external ID"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad","content":["Reporting Field ID: ad.externalId - Data Type: STRING - Description: User defined ID that can be assigned to an ad for tracking purposes or for integration with external systems. - Required fields: ad.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): creativeExternalId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Ad (Level of detail)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Ad (Level of detail)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Ad (Level of detail)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/level-of-detail/ad","content":[],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":[" The Advertised product dimension contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":{"type":2,"text":"Advertised product ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":["Reporting Field ID: advertisedProduct.id - Data Type: STRING - Description: The unique identifier of the product featured in the ad. - Required fields: advertisedProductMarketplace.value 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): featuredAsin - Version 3 Reporting Name (Sponsored Ads): advertisedAsin\n"],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":{"type":2,"text":"Advertised product name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":["Reporting Field ID: advertisedProduct.name - Data Type: STRING - Description: The display name of the product featured in the ad. - Required fields: advertisedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":{"type":2,"text":"Advertised product parent ID"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":["Reporting Field ID: advertisedProduct.parentProductId - Data Type: STRING - Description: The parent product identifier of the advertised product, used to group related product variations (if applicable). - Required fields: advertisedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":{"type":2,"text":"Advertised product brand"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":["Reporting Field ID: advertisedProduct.brand - Data Type: STRING - Description: The brand of the product featured in the ad. - Required fields: advertisedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":{"type":2,"text":"Advertised product category"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":["Reporting Field ID: advertisedProduct.category - Data Type: STRING - Description: The top-level category of the product featured in the ad. - Required fields: advertisedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":{"type":2,"text":"Advertised product subcategory"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":["Reporting Field ID: advertisedProduct.subcategory - Data Type: STRING - Description: The product subcategory of the product featured in the ad. - Required fields: advertisedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":{"type":2,"text":"Advertised product group"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":["Reporting Field ID: advertisedProduct.productGroup - Data Type: STRING - Description: The product classification assigned to the advertised product for accounting and reporting purposes. Contains product categories. - Required fields: advertisedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Advertised product (Product)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product","content":[],"documentType":"guide"},{"title":"Advertised product marketplace (Product)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product-marketplace","content":[" The Advertised product marketplace dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Advertised product marketplace (Product)","sectionHeader":{"type":2,"text":"Advertised product marketplace (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product-marketplace","content":["Reporting Field ID: advertisedProductMarketplace.value - Data Type: STRING - Description: The marketplace where the advertised product is sold. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Advertised product marketplace (Product)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product-marketplace","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Advertised product marketplace (Product)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product-marketplace","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Advertised product marketplace (Product)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product-marketplace","content":[],"documentType":"guide"},{"title":"Advertised product SKU (Product)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product-sku","content":[" The Advertised product SKU dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Advertised product SKU (Product)","sectionHeader":{"type":2,"text":"Advertised product SKU (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product-sku","content":["Reporting Field ID: advertisedProductSku.value - Data Type: STRING - Description: The SKU (stock keeping unit) assigned to the product featured in the ad. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Advertised product SKU (Product)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product-sku","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ✅ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Advertised product SKU (Product)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product-sku","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Advertised product SKU (Product)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/advertised-product-sku","content":[],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":[" The Converted product dimension contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":{"type":2,"text":"Converted product ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":["Reporting Field ID: convertedProduct.id - Data Type: STRING - Description: The unique identifier of the product attributed to the ad. - Required fields: convertedProductMarketplace.value 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): convertedAsin - Version 3 Reporting Name (Sponsored Ads): purchasedAsin\n"],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":{"type":2,"text":"Converted product name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":["Reporting Field ID: convertedProduct.name - Data Type: STRING - Description: The display name of the product attributed to the ad. - Required fields: convertedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): convertedProductName - Version 3 Reporting Name (Sponsored Ads): productName\n"],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":{"type":2,"text":"Converted product parent ID"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":["Reporting Field ID: convertedProduct.parentProductId - Data Type: STRING - Description: The parent product identifier of the attributed product, used to group related product variations (if applicable). - Required fields: convertedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): parentAsin - Version 3 Reporting Name (Sponsored Ads): parentAsin\n"],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":{"type":2,"text":"Converted product brand"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":["Reporting Field ID: convertedProduct.brand - Data Type: STRING - Description: The brand of the product attributed to the ad. - Required fields: convertedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): brandName - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":{"type":2,"text":"Converted product category"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":["Reporting Field ID: convertedProduct.category - Data Type: STRING - Description: The top-level category of the product attributed to the ad. - Required fields: convertedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): productCategory - Version 3 Reporting Name (Sponsored Ads): productCategory\n"],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":{"type":2,"text":"Converted product subcategory"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":["Reporting Field ID: convertedProduct.subcategory - Data Type: STRING - Description: The product subcategory of the product attributed to the ad. - Required fields: convertedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): productSubcategory - Version 3 Reporting Name (Sponsored Ads): productSubcategory\n"],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":{"type":2,"text":"Converted product group"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":["Reporting Field ID: convertedProduct.productGroup - Data Type: STRING - Description: The product classification assigned to the attributed product for accounting and reporting purposes. Contains product categories. - Required fields: convertedProduct.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): productGroup - Version 3 Reporting Name (Sponsored Ads): productGroup\n"],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ❌ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ✅ |\n","| Postal code | ❌ |\n","| Product relevance | ✅ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":["metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedUnitsSold 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonUnitsSold 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎\n","\n"],"documentType":"guide"},{"title":"Converted product (Product)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product","content":[],"documentType":"guide"},{"title":"Converted product marketplace (Product)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product-marketplace","content":[" The Converted product marketplace dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Converted product marketplace (Product)","sectionHeader":{"type":2,"text":"Converted product marketplace (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product-marketplace","content":["Reporting Field ID: convertedProductMarketplace.value - Data Type: STRING - Description: The marketplace where the conversion event for the attributed product occurred. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): marketplace - Version 3 Reporting Name (Sponsored Ads): marketplace\n"],"documentType":"guide"},{"title":"Converted product marketplace (Product)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product-marketplace","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ❌ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ✅ |\n","| Postal code | ❌ |\n","| Product relevance | ✅ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Converted product marketplace (Product)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product-marketplace","content":["metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedUnitsSold 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonUnitsSold 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎\n","\n"],"documentType":"guide"},{"title":"Converted product marketplace (Product)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/converted-product-marketplace","content":[],"documentType":"guide"},{"title":"Product relevance (Product)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/product/product-relevance","content":[" The Product relevance dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Product relevance (Product)","sectionHeader":{"type":2,"text":"Product relevance (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/product-relevance","content":["Reporting Field ID: productRelevance.value - Data Type: STRING - Description: Indicates whether the product was directly promoted in the campaign or attributed based on relevance to promoted products (halo). - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product relevance (Product)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/product-relevance","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ✅ |\n","| Converted product marketplace | ✅ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ❌ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ✅ |\n","| Postal code | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Product relevance (Product)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/product-relevance","content":["metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedUnitsSold 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonUnitsSold 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎\n","\n"],"documentType":"guide"},{"title":"Product relevance (Product)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/product/product-relevance","content":[],"documentType":"guide"},{"title":"Supply source (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/supply-source","content":[" The Supply source dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Supply source (Supply)","sectionHeader":{"type":2,"text":"Supply source (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/supply-source","content":["Reporting Field ID: supplySource.name - Data Type: STRING - Description: The inventory the campaign ran on like real-time bidding exchanges or Amazon-owned sites. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): supplySource - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Supply source (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/supply-source","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ✅ |\n","| Brand suitability inventory tier | ✅ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Supply source (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/supply-source","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.averageUserImpressionFrequency 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.exclusiveUserReachRate 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.userReach 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Supply source (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/supply-source","content":[],"documentType":"guide"},{"title":"Site or app (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/site-or-app","content":[" The Site or app dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Site or app (Supply)","sectionHeader":{"type":2,"text":"Site or app (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/site-or-app","content":["Reporting Field ID: siteApp.value - Data Type: STRING - Description: The app or websites where the campaign was run. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): Site - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Site or app (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/site-or-app","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Site or app (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/site-or-app","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Site or app (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/site-or-app","content":[],"documentType":"guide"},{"title":"Placement (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement","content":[" The Placement dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Placement (Supply)","sectionHeader":{"type":2,"text":"Placement name (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement","content":["Reporting Field ID: placement.name - Data Type: STRING - Description: The name of the placement on which the campaign was run. - Required fields: siteApp.value 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): placement - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Placement (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Placement (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Placement (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement","content":[],"documentType":"guide"},{"title":"Placement size (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement-size","content":[" The Placement size dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Placement size (Supply)","sectionHeader":{"type":2,"text":"Placement size (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement-size","content":["Reporting Field ID: placementSize.value - Data Type: STRING - Description: The dimensions of the placement in pixels. - Required fields: placement.name 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Placement size (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement-size","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Placement size (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement-size","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedRoasReconciled 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandRoasPromotedReconciled 📎 - metric.newToBrandRoasReconciled 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonRoasReconciled 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.roasPromotedReconciled 📎 - metric.roasReconciled 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalCostReconciled 📎 - metric.totalCostReconciledConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Placement size (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement-size","content":[],"documentType":"guide"},{"title":"Placement classification (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement-classification","content":[" The Placement classification dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Placement classification (Supply)","sectionHeader":{"type":2,"text":"Placement classification (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement-classification","content":["Reporting Field ID: placementClassification.value - Data Type: STRING - Description: The classification of ad placements into categories like top of search, gateway page, etc. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): placementClassification\n"],"documentType":"guide"},{"title":"Placement classification (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement-classification","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Placement classification (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement-classification","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Placement classification (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/placement-classification","content":[],"documentType":"guide"},{"title":"Deal (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/deal","content":[" The Deal dimension contains 4 fields, listed below:\n"],"documentType":"guide"},{"title":"Deal (Supply)","sectionHeader":{"type":2,"text":"Deal ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/deal","content":["Reporting Field ID: deal.id - Data Type: STRING - Description: The unique ID associated with the deal. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): dealId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Deal (Supply)","sectionHeader":{"type":2,"text":"Deal name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/deal","content":["Reporting Field ID: deal.name - Data Type: STRING - Description: The name of the deal. - Required fields: deal.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): deal - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Deal (Supply)","sectionHeader":{"type":2,"text":"Deal type"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/deal","content":["Reporting Field ID: deal.type - Data Type: STRING - Description: The type of deal such as Programmatic guaranteed, Private auction, Preferred deal etc - Required fields: deal.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): dealType - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Deal (Supply)","sectionHeader":{"type":2,"text":"Custom deal name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/deal","content":["Reporting Field ID: deal.customDealName - Data Type: STRING - Description: The custom deal name that was manually entered. - Required fields: deal.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Deal (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/deal","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Deal (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/deal","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Deal (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/deal","content":[],"documentType":"guide"},{"title":"Content genre (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-genre","content":[" The Content genre dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Content genre (Supply)","sectionHeader":{"type":2,"text":"Content genre (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-genre","content":["Reporting Field ID: contentGenre.value - Data Type: STRING - Description: The genre of the video or audio. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): contentGenre - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Content genre (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-genre","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Content genre (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-genre","content":["metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.clicks 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Content genre (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-genre","content":[],"documentType":"guide"},{"title":"Content rating (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-rating","content":[" The Content rating dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Content rating (Supply)","sectionHeader":{"type":2,"text":"Content rating (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-rating","content":["Reporting Field ID: contentRating.value - Data Type: STRING - Description: The rating of the video or audio like content suitable for teens and older audiences. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): contentRating - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Content rating (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-rating","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Content rating (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-rating","content":["metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.clicks 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Content rating (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-rating","content":[],"documentType":"guide"},{"title":"Content type (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-type","content":[" The Content type dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Content type (Supply)","sectionHeader":{"type":2,"text":"Content type (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-type","content":["Reporting Field ID: contentType.value - Data Type: STRING - Description: The type of the video or audio like movie, tv show, game, etc. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): contentType - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Content type (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-type","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Content type (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-type","content":["metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.clicks 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Content type (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-type","content":[],"documentType":"guide"},{"title":"Content title (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-title","content":[" The Content title dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Content title (Supply)","sectionHeader":{"type":2,"text":"Content title (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-title","content":["Reporting Field ID: contentTitle.value - Data Type: STRING - Description: The name of the video or audio. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): contentTitle - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Content title (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-title","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Content title (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-title","content":["metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.clicks 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Content title (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-title","content":[],"documentType":"guide"},{"title":"Content creator (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-creator","content":[" The Content creator dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Content creator (Supply)","sectionHeader":{"type":2,"text":"Content creator name (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-creator","content":["Reporting Field ID: contentCreator.name - Data Type: STRING - Description: The name of content creator on whose channel an ad is shown. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): creatorName - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Content creator (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-creator","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Content creator (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-creator","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Content creator (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/content-creator","content":[],"documentType":"guide"},{"title":"Live event property (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-property","content":[" The Live event property dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Live event property (Supply)","sectionHeader":{"type":2,"text":"Live event property (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-property","content":["Reporting Field ID: liveEventProperty.value - Data Type: STRING - Description: The rights package, league, or content property associated with the live event inventory. - Required fields: liveEvent.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Live event property (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-property","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Live event property (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-property","content":["metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.clicks 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Live event property (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-property","content":[],"documentType":"guide"},{"title":"Live event (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event","content":[" The Live event dimension contains 2 fields, listed below:\n"],"documentType":"guide"},{"title":"Live event (Supply)","sectionHeader":{"type":2,"text":"Live event ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event","content":["Reporting Field ID: liveEvent.id - Data Type: STRING - Description: The identifier for the live event or program against which the ad was delivered. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Live event (Supply)","sectionHeader":{"type":2,"text":"Live event name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event","content":["Reporting Field ID: liveEvent.name - Data Type: STRING - Description: The name of the live event or program against which the ad was delivered. - Required fields: liveEvent.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Live event (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Live event (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event","content":["metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.clicks 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Live event (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event","content":[],"documentType":"guide"},{"title":"Live event inventory type (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-inventory-type","content":[" The Live event inventory type dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Live event inventory type (Supply)","sectionHeader":{"type":2,"text":"Live event inventory type (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-inventory-type","content":["Reporting Field ID: liveEventInventoryType.value - Data Type: STRING - Description: The type or segment code of the ad break within the live event. - Required fields: liveEvent.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Live event inventory type (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-inventory-type","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Live event inventory type (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-inventory-type","content":["metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.clicks 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Live event inventory type (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-inventory-type","content":[],"documentType":"guide"},{"title":"Live event ad break (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-break","content":[" The Live event ad break dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Live event ad break (Supply)","sectionHeader":{"type":2,"text":"Live event ad break order (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-break","content":["Reporting Field ID: liveEventAdBreak.order - Data Type: STRING - Description: The order of the ad break within the live event schedule. - Required fields: liveEvent.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Live event ad break (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-break","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Live event ad break (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-break","content":["metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.clicks 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Live event ad break (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-break","content":[],"documentType":"guide"},{"title":"Live event ad slot (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-slot","content":[" The Live event ad slot dimension contains 2 fields, listed below:\n"],"documentType":"guide"},{"title":"Live event ad slot (Supply)","sectionHeader":{"type":2,"text":"Live event ad slot order (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-slot","content":["Reporting Field ID: liveEventAdSlot.order - Data Type: STRING - Description: The order of the ad slot within the live event ad break. - Required fields: liveEventAdBreak.order 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Live event ad slot (Supply)","sectionHeader":{"type":2,"text":"Live event ad slot type"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-slot","content":["Reporting Field ID: liveEventAdSlot.type - Data Type: STRING - Description: The sales model for the live-event ad slot. - Required fields: liveEventAdSlot.order 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Live event ad slot (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-slot","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Live event ad slot (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-slot","content":["metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.clicks 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Live event ad slot (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/live-event-ad-slot","content":[],"documentType":"guide"},{"title":"Brand suitability content exclusion category (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/brand-suitability-content-exclusion-category","content":[" The Brand suitability content exclusion category dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Brand suitability content exclusion category (Supply)","sectionHeader":{"type":2,"text":"Brand suitability content exclusion category (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/brand-suitability-content-exclusion-category","content":["Reporting Field ID: brandSuitabilityContentExclusionCategory.value - Data Type: STRING - Description: The content exclusion category applied to opt out of specific topics that don't align with brand values. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): contentCategory (dspBrandSuitability) - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand suitability content exclusion category (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/brand-suitability-content-exclusion-category","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ❌ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ❌ |\n","| Advertised product | ❌ |\n","| Advertised product marketplace | ❌ |\n","| Advertised product SKU | ❌ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ❌ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ❌ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ❌ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ❌ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ❌ |\n","| Postal code | ❌ |\n","| Product relevance | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ✅ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ❌ |\n","| Year | ❌ |\n"],"documentType":"guide"},{"title":"Brand suitability content exclusion category (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/brand-suitability-content-exclusion-category","content":["metric.impressions 📎\n","\n"],"documentType":"guide"},{"title":"Brand suitability content exclusion category (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/brand-suitability-content-exclusion-category","content":[],"documentType":"guide"},{"title":"Brand suitability inventory tier (Supply)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/brand-suitability-inventory-tier","content":[" The Brand suitability inventory tier dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Brand suitability inventory tier (Supply)","sectionHeader":{"type":2,"text":"Brand suitability inventory tier (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/brand-suitability-inventory-tier","content":["Reporting Field ID: brandSuitabilityInventoryTier.value - Data Type: STRING - Description: The inventory tier that groups ad-eligible inventory to help balance reach with brand suitability preferences. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): inventoryTier (dspBrandSuitability) - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand suitability inventory tier (Supply)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/brand-suitability-inventory-tier","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ❌ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ❌ |\n","| Advertised product | ❌ |\n","| Advertised product marketplace | ❌ |\n","| Advertised product SKU | ❌ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ❌ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ❌ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ❌ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ❌ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ❌ |\n","| Postal code | ❌ |\n","| Product relevance | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ✅ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ❌ |\n","| Year | ❌ |\n"],"documentType":"guide"},{"title":"Brand suitability inventory tier (Supply)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/brand-suitability-inventory-tier","content":["metric.impressions 📎\n","\n"],"documentType":"guide"},{"title":"Brand suitability inventory tier (Supply)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/supply/brand-suitability-inventory-tier","content":[],"documentType":"guide"},{"title":"Operating system (Technology)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/operating-system","content":[" The Operating system dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Operating system (Technology)","sectionHeader":{"type":2,"text":"Operating system (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/operating-system","content":["Reporting Field ID: operatingSystem.value - Data Type: STRING - Description: The operating system used by the customer to view the ad. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): operatingSystem - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Operating system (Technology)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/operating-system","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Operating system (Technology)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/operating-system","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Operating system (Technology)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/operating-system","content":[],"documentType":"guide"},{"title":"Browser name (Technology)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/browser-name","content":[" The Browser name dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Browser name (Technology)","sectionHeader":{"type":2,"text":"Browser name (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/browser-name","content":["Reporting Field ID: browserName.value - Data Type: STRING - Description: The browser used by the customer to view the ad. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): browserName - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Browser name (Technology)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/browser-name","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Browser name (Technology)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/browser-name","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Browser name (Technology)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/browser-name","content":[],"documentType":"guide"},{"title":"Browser version (Technology)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/browser-version","content":[" The Browser version dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Browser version (Technology)","sectionHeader":{"type":2,"text":"Browser version (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/browser-version","content":["Reporting Field ID: browserVersion.value - Data Type: STRING - Description: The version of the browser used by the customer to view the ad. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): browserVersion - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Browser version (Technology)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/browser-version","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Browser version (Technology)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/browser-version","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Browser version (Technology)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/browser-version","content":[],"documentType":"guide"},{"title":"Device type (Technology)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/device-type","content":[" The Device type dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Device type (Technology)","sectionHeader":{"type":2,"text":"Device type (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/device-type","content":["Reporting Field ID: deviceType.value - Data Type: STRING - Description: The device used by the customer to view the ad. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): deviceType - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Device type (Technology)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/device-type","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Device type (Technology)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/device-type","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Device type (Technology)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/device-type","content":[],"documentType":"guide"},{"title":"Environment (Technology)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/environment","content":[" The Environment dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Environment (Technology)","sectionHeader":{"type":2,"text":"Environment (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/environment","content":["Reporting Field ID: environment.value - Data Type: STRING - Description: The environment used by the customer to view the ad like web or app. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): Environment - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Environment (Technology)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/environment","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Environment (Technology)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/environment","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Environment (Technology)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/technology/environment","content":[],"documentType":"guide"},{"title":"Country (Geography)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/country","content":[" The Country dimension contains 2 fields, listed below:\n"],"documentType":"guide"},{"title":"Country (Geography)","sectionHeader":{"type":2,"text":"Country (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/country","content":["Reporting Field ID: country.name - Data Type: STRING - Description: The country where the ad was displayed. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): Country - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Country (Geography)","sectionHeader":{"type":2,"text":"Country code"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/country","content":["Reporting Field ID: country.code - Data Type: STRING - Description: The ISO code of the country where the ad was displayed. - Required fields: country.name 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): countryCode - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Country (Geography)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/country","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Country (Geography)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/country","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Country (Geography)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/country","content":[],"documentType":"guide"},{"title":"Region (Geography)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/region","content":[" The Region dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Region (Geography)","sectionHeader":{"type":2,"text":"Region (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/region","content":["Reporting Field ID: region.name - Data Type: STRING - Description: The state or region where the ad was displayed. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): Region - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Region (Geography)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/region","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Region (Geography)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/region","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Region (Geography)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/region","content":[],"documentType":"guide"},{"title":"DMA (Geography)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/dma","content":[" The DMA dimension contains 2 fields, listed below:\n"],"documentType":"guide"},{"title":"DMA (Geography)","sectionHeader":{"type":2,"text":"DMA® code (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/dma","content":["Reporting Field ID: dma.id - Data Type: STRING - Description: The unique ID assigned to a DMA®. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): dma - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"DMA (Geography)","sectionHeader":{"type":2,"text":"DMA®"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/dma","content":["Reporting Field ID: dma.name - Data Type: STRING - Description: The DMA® where the ad was displayed. DMA® regions are created and defined by Nielsen. - Required fields: dma.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): dmaName - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"DMA (Geography)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/dma","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"DMA (Geography)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/dma","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"DMA (Geography)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/dma","content":[],"documentType":"guide"},{"title":"City (Geography)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/city","content":[" The City dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"City (Geography)","sectionHeader":{"type":2,"text":"City (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/city","content":["Reporting Field ID: city.name - Data Type: STRING - Description: The city where the ad was displayed. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): City - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"City (Geography)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/city","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"City (Geography)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/city","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"City (Geography)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/city","content":[],"documentType":"guide"},{"title":"Postal code (Geography)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/postal-code","content":[" The Postal code dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Postal code (Geography)","sectionHeader":{"type":2,"text":"Postal code (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/postal-code","content":["Reporting Field ID: postalCode.value - Data Type: STRING - Description: The postal code where the ad was displayed. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): postalCode - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Postal code (Geography)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/postal-code","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Postal code (Geography)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/postal-code","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Postal code (Geography)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/geography/postal-code","content":[],"documentType":"guide"},{"title":"Audience segment (Audience)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment","content":[" The Audience segment dimension contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Audience segment (Audience)","sectionHeader":{"type":2,"text":"Audience segment ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment","content":["Reporting Field ID: audienceSegment.id - Data Type: STRING - Description: The ID assigned to a specific group of users with shared characteristics or behaviors. - Required fields: audienceSegment.classCode 📎, audienceSegment.name 📎, audienceSegment.source 📎, audienceSegment.type 📎, audienceSegmentCountry.code - Complementary fields: N/A - Version 3 Reporting Name (DSP): segmentId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Audience segment (Audience)","sectionHeader":{"type":2,"text":"Audience segment name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment","content":["Reporting Field ID: audienceSegment.name - Data Type: STRING - Description: The name of an audience segment. - Required fields: audienceSegment.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): Segment - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Audience segment (Audience)","sectionHeader":{"type":2,"text":"Audience segment type"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment","content":["Reporting Field ID: audienceSegment.type - Data Type: STRING - Description: The type of audience segment like remarketing. - Required fields: audienceSegment.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): segmentType - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Audience segment (Audience)","sectionHeader":{"type":2,"text":"Audience segment class code"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment","content":["Reporting Field ID: audienceSegment.classCode - Data Type: STRING - Description: A segment class like behavioral or user agent. - Required fields: audienceSegment.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): segmentClassCode - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Audience segment (Audience)","sectionHeader":{"type":2,"text":"Audience segment source"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment","content":["Reporting Field ID: audienceSegment.source - Data Type: STRING - Description: The source of the audience segment, for example AAX. - Required fields: audienceSegment.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Audience segment (Audience)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ❌ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ❌ |\n","| Advertised product marketplace | ❌ |\n","| Advertised product SKU | ❌ |\n","| Advertiser account | ✅ |\n","| Audience segment targeting status | ✅ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ❌ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ✅ |\n","| Postal code | ❌ |\n","| Product relevance | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Audience segment (Audience)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment","content":["metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartPromoted 📎 - metric.addToCartRatePromoted 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListPromoted 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicksPromoted 📎 - metric.sales 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎\n","\n"],"documentType":"guide"},{"title":"Audience segment (Audience)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment","content":[],"documentType":"guide"},{"title":"Audience segment targeting status (Audience)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment-targeting-status","content":[" The Audience segment targeting status dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Audience segment targeting status (Audience)","sectionHeader":{"type":2,"text":"Audience segment targeting status (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment-targeting-status","content":["Reporting Field ID: audienceSegmentTargetingStatus.value - Data Type: STRING - Description: The targeting status of the audience segment when the impression was delivered. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): segmentStatus - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Audience segment targeting status (Audience)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment-targeting-status","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ❌ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ❌ |\n","| Advertised product marketplace | ❌ |\n","| Advertised product SKU | ❌ |\n","| Advertiser account | ✅ |\n","| Audience segment | ✅ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ❌ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ✅ |\n","| Postal code | ❌ |\n","| Product relevance | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Audience segment targeting status (Audience)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment-targeting-status","content":["metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartPromoted 📎 - metric.addToCartRatePromoted 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListPromoted 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicksPromoted 📎 - metric.sales 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎\n","\n"],"documentType":"guide"},{"title":"Audience segment targeting status (Audience)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/audience/audience-segment-targeting-status","content":[],"documentType":"guide"},{"title":"Frequency group (Targeting)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/frequency-group","content":[" The Frequency group dimension contains 3 fields, listed below:\n"],"documentType":"guide"},{"title":"Frequency group (Targeting)","sectionHeader":{"type":2,"text":"Frequency group ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/frequency-group","content":["Reporting Field ID: frequencyGroup.id - Data Type: STRING - Description: The unique ID associated with the frequency group. A frequency group helps advertisers set caps on the number of times a unique user is exposed to an ads across multiple orders. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): frequencyGroupId - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Frequency group (Targeting)","sectionHeader":{"type":2,"text":"Frequency group name"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/frequency-group","content":["Reporting Field ID: frequencyGroup.name - Data Type: STRING - Description: The user-defined name of the frequency group. A frequency group helps advertisers set caps on the number of times a unique user is exposed to an ad across multiple orders. - Required fields: frequencyGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): frequencyGroupName - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Frequency group (Targeting)","sectionHeader":{"type":2,"text":"Frequency group type"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/frequency-group","content":["Reporting Field ID: frequencyGroup.type - Data Type: STRING - Description: The level at which the frequency cap is created, such as- advertiser or manager account - Required fields: frequencyGroup.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): frequencyGroupType - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Frequency group (Targeting)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/frequency-group","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ❌ |\n","| Ad group | ❌ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ❌ |\n","| Advertised product marketplace | ❌ |\n","| Advertised product SKU | ❌ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ❌ |\n","| Campaign | ❌ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ❌ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ❌ |\n","| Postal code | ❌ |\n","| Product relevance | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Frequency group (Targeting)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/frequency-group","content":["metric.averageUserImpressionFrequency 📎 - metric.userFrequency1 📎 - metric.userFrequency10Plus 📎 - metric.userFrequency2 📎 - metric.userFrequency3 📎 - metric.userFrequency4 📎 - metric.userFrequency5 📎 - metric.userFrequency6 📎 - metric.userFrequency7 📎 - metric.userFrequency8 📎 - metric.userFrequency9 📎 - metric.userReach 📎\n","\n"],"documentType":"guide"},{"title":"Frequency group (Targeting)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/frequency-group","content":[],"documentType":"guide"},{"title":"Target (Targeting)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/target","content":[" The Target dimension contains 4 fields, listed below:\n"],"documentType":"guide"},{"title":"Target (Targeting)","sectionHeader":{"type":2,"text":"Target ID (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/target","content":["Reporting Field ID: adGroupTarget.id - Data Type: STRING - Description: The identifier of the target. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): targetId\n"],"documentType":"guide"},{"title":"Target (Targeting)","sectionHeader":{"type":2,"text":"Target bid"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/target","content":["Reporting Field ID: adGroupTarget.bid - Data Type: STRING - Description: The bid amount for the target. - Required fields: adGroupTarget.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): keywordBid\n"],"documentType":"guide"},{"title":"Target (Targeting)","sectionHeader":{"type":2,"text":"Target type"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/target","content":["Reporting Field ID: adGroupTarget.targetType - Data Type: STRING - Description: The type of target like keyword, product, product categories, or product genre. - Required fields: adGroupTarget.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): targetingType\n"],"documentType":"guide"},{"title":"Target (Targeting)","sectionHeader":{"type":2,"text":"Target status"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/target","content":["Reporting Field ID: adGroupTarget.status - Data Type: STRING - Description: The current status of the target. - Required fields: adGroupTarget.id 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): adKeywordStatus\n"],"documentType":"guide"},{"title":"Target (Targeting)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/target","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Target (Targeting)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/target","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Target (Targeting)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/target","content":[],"documentType":"guide"},{"title":"Targeting (Targeting)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/targeting","content":[" The Targeting dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Targeting (Targeting)","sectionHeader":{"type":2,"text":"Targeting (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/targeting","content":["Reporting Field ID: targeting.value - Data Type: STRING - Description: The keyword, product or category you choose to reach shoppers. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): targeting\n"],"documentType":"guide"},{"title":"Targeting (Targeting)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/targeting","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Targeting (Targeting)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/targeting","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Targeting (Targeting)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/targeting","content":[],"documentType":"guide"},{"title":"Targeting match type (Targeting)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/targeting-match-type","content":[" The Targeting match type dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Targeting match type (Targeting)","sectionHeader":{"type":2,"text":"Targeting match type (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/targeting-match-type","content":["Reporting Field ID: targetingMatchType.value - Data Type: STRING - Description: The type of matching for keywords used in a bid. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): matchType\n"],"documentType":"guide"},{"title":"Targeting match type (Targeting)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/targeting-match-type","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Targeting match type (Targeting)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/targeting-match-type","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Targeting match type (Targeting)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/targeting-match-type","content":[],"documentType":"guide"},{"title":"Search term (Targeting)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/search-term","content":[" The Search term dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Search term (Targeting)","sectionHeader":{"type":2,"text":"Search term (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/search-term","content":["Reporting Field ID: searchTerm.value - Data Type: STRING - Description: The search term used by the customer. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): searchTerm\n"],"documentType":"guide"},{"title":"Search term (Targeting)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/search-term","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Matched target | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Search term (Targeting)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/search-term","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressionShare 📎 - metric.impressionShareRank 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Search term (Targeting)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/search-term","content":[],"documentType":"guide"},{"title":"Matched target (Targeting)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/matched-target","content":[" The Matched target dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Matched target (Targeting)","sectionHeader":{"type":2,"text":"Matched target (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/matched-target","content":["Reporting Field ID: matchedTarget.value - Data Type: STRING - Description: The product page where the ad appeared - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): matchedTargetAsin\n"],"documentType":"guide"},{"title":"Matched target (Targeting)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/matched-target","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ✅ |\n","| Ad product | ✅ |\n","| Advertised product | ✅ |\n","| Advertised product marketplace | ✅ |\n","| Advertised product SKU | ✅ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ✅ |\n","| Browser version | ✅ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ✅ |\n","| Content creator | ✅ |\n","| Content genre | ✅ |\n","| Content rating | ✅ |\n","| Content title | ✅ |\n","| Content type | ✅ |\n","| Conversion source | ❌ |\n","| Conversion source attribution type | ❌ |\n","| Conversion source environment | ❌ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ✅ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ✅ |\n","| Device type | ✅ |\n","| DMA | ✅ |\n","| Environment | ✅ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ✅ |\n","| Insertion order | ✅ |\n","| Live event | ✅ |\n","| Live event ad break | ✅ |\n","| Live event ad slot | ✅ |\n","| Live event inventory type | ✅ |\n","| Live event property | ✅ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ❌ |\n","| Conversion type (off-Amazon) | ❌ |\n","| Operating system | ✅ |\n","| Placement | ✅ |\n","| Placement classification | ✅ |\n","| Placement size | ✅ |\n","| Portfolio | ✅ |\n","| Postal code | ✅ |\n","| Product relevance | ❌ |\n","| Region | ✅ |\n","| Search term | ✅ |\n","| Site or app | ✅ |\n","| Supply source | ✅ |\n","| Targeting | ✅ |\n","| Targeting match type | ✅ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Matched target (Targeting)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/matched-target","content":["metric.5secondViewRateVideoAd 📎 - metric.5secondViewsVideoAd 📎 - metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToCartRate 📎 - metric.addToCartRatePromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToListRate 📎 - metric.addToListRatePromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.addToWatchlistRate 📎 - metric.agencyFees 📎 - metric.agencyFeesConverted 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillEnableRate 📎 - metric.alexaSkillInvocationRate 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.allViewsCostPerPurchase 📎 - metric.allViewsCostPerPurchaseFromClicks 📎 - metric.allViewsCostPerPurchaseFromClicksPromoted 📎 - metric.allViewsCostPerPurchasePromoted 📎 - metric.allViewsPurchaseFromClickRate 📎 - metric.allViewsPurchaseFromClickRatePromoted 📎 - metric.allViewsPurchaseRate 📎 - metric.allViewsPurchaseRateOverClicks 📎 - metric.allViewsPurchaseRateOverClicksPromoted 📎 - metric.allViewsPurchaseRatePromoted 📎 - metric.allViewsPurchases 📎 - metric.allViewsPurchasesFromClicks 📎 - metric.allViewsPurchasesFromClicksHalo 📎 - metric.allViewsPurchasesFromClicksPromoted 📎 - metric.allViewsPurchasesFromViews 📎 - metric.allViewsPurchasesFromViewsHalo 📎 - metric.allViewsPurchasesFromViewsPromoted 📎 - metric.allViewsPurchasesHalo 📎 - metric.allViewsPurchasesPromoted 📎 - metric.allViewsReturnPerThousandImpressions 📎 - metric.allViewsReturnPerThousandImpressionsPromoted 📎 - metric.allViewsRoas 📎 - metric.allViewsRoasFromClicks 📎 - metric.allViewsRoasFromClicksPromoted 📎 - metric.allViewsRoasFromViews 📎 - metric.allViewsRoasFromViewsPromoted 📎 - metric.allViewsRoasPromoted 📎 - metric.allViewsSales 📎 - metric.allViewsSalesConverted 📎 - metric.allViewsSalesFromClicks 📎 - metric.allViewsSalesFromClicksConverted 📎 - metric.allViewsSalesFromClicksHalo 📎 - metric.allViewsSalesFromClicksHaloConverted 📎 - metric.allViewsSalesFromClicksPromoted 📎 - metric.allViewsSalesFromClicksPromotedConverted 📎 - metric.allViewsSalesFromViews 📎 - metric.allViewsSalesFromViewsConverted 📎 - metric.allViewsSalesFromViewsHalo 📎 - metric.allViewsSalesFromViewsHaloConverted 📎 - metric.allViewsSalesFromViewsPromoted 📎 - metric.allViewsSalesFromViewsPromotedConverted 📎 - metric.allViewsSalesHalo 📎 - metric.allViewsSalesHaloConverted 📎 - metric.allViewsSalesPromoted 📎 - metric.allViewsSalesPromotedConverted 📎 - metric.allViewsUnitsSold 📎 - metric.allViewsUnitsSoldFromClicks 📎 - metric.allViewsUnitsSoldFromClicksHalo 📎 - metric.allViewsUnitsSoldFromClicksPromoted 📎 - metric.allViewsUnitsSoldFromViews 📎 - metric.allViewsUnitsSoldFromViewsHalo 📎 - metric.allViewsUnitsSoldFromViewsPromoted 📎 - metric.allViewsUnitsSoldHalo 📎 - metric.allViewsUnitsSoldPromoted 📎 - metric.amazonAudienceFees 📎 - metric.amazonAudienceFeesConverted 📎 - metric.amazonConsoleFees 📎 - metric.amazonConsoleFeesConverted 📎 - metric.appSubscriptionSignUpRate 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpenRate 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpenRate 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpenRate 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViewRate 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearchRate 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.clicks 📎 - metric.combinedCostPerPurchase 📎 - metric.combinedCostPerPurchaseFromClicks 📎 - metric.combinedPurchaseRate 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedReturnPerThousandImpressions 📎 - metric.combinedRoas 📎 - metric.combinedRoasFromClicks 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.completeListensAudioAd 📎 - metric.completeViewsVideoAd 📎 - metric.completionRateAudioAd 📎 - metric.completionRateVideoAd 📎 - metric.costPerAddToCart 📎 - metric.costPerAddToCartPromoted 📎 - metric.costPerAddToList 📎 - metric.costPerAddToListPromoted 📎 - metric.costPerAddToWatchlist 📎 - metric.costPerAlexaSkillEnable 📎 - metric.costPerAlexaSkillInvocation 📎 - metric.costPerAppSubscriptionSignUp 📎 - metric.costPerAppstoreFirstOpen 📎 - metric.costPerAppstoreFirstSessionHour 📎 - metric.costPerAppstoreOpen 📎 - metric.costPerAppstoreRepeatOpen 📎 - metric.costPerAppstoreRepeatSessionHour 📎 - metric.costPerAppstoreUsageHour 📎 - metric.costPerBrandStorePageView 📎 - metric.costPerBrandedSearch 📎 - metric.costPerCompletedListenAudioAd 📎 - metric.costPerCompletedViewVideoAd 📎 - metric.costPerDetailPageView 📎 - metric.costPerDetailPageViewFromClicks 📎 - metric.costPerDetailPageViewFromClicksPromoted 📎 - metric.costPerDetailPageViewPromoted 📎 - metric.costPerDownloadedVideoPlay 📎 - metric.costPerFreeTrialAppSubscriptionSignUp 📎 - metric.costPerFreeTrialSubscriptionSignUp 📎 - metric.costPerNewToBrandAddToCart 📎 - metric.costPerNewToBrandAddToCartPromoted 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearch 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.costPerNewToBrandDetailPageView 📎 - metric.costPerNewToBrandDetailPageViewPromoted 📎 - metric.costPerNewToBrandPurchase 📎 - metric.costPerNewToBrandPurchaseFromClicks 📎 - metric.costPerNewToBrandPurchasePromoted 📎 - metric.costPerPaidAppSubscriptionSignUp 📎 - metric.costPerPaidSubscriptionSignUp 📎 - metric.costPerProductReviewPageVisit 📎 - metric.costPerProductReviewPageVisitPromoted 📎 - metric.costPerPurchase 📎 - metric.costPerPurchaseFromClicks 📎 - metric.costPerPurchaseFromClicksPromoted 📎 - metric.costPerPurchasePromoted 📎 - metric.costPerRental 📎 - metric.costPerSubscribeAndSaveSubscription 📎 - metric.costPerSubscribeAndSaveSubscriptionPromoted 📎 - metric.costPerSubscriptionSignUp 📎 - metric.costPerTrailerPlay 📎 - metric.costPerVideoStreamPlay 📎 - metric.cpc 📎 - metric.cpcConverted 📎 - metric.cpm 📎 - metric.ctr 📎 - metric.customFeeBundle 📎 - metric.customFeeBundleConverted 📎 - metric.detailPageViewFromClickRate 📎 - metric.detailPageViewFromClickRatePromoted 📎 - metric.detailPageViewRate 📎 - metric.detailPageViewRatePromoted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlayRate 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.estimatedKindleUnlimitedRoyalties 📎 - metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicks 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViews 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesHalo 📎 - metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromoted 📎 - metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - metric.firstQuartileAudioAd 📎 - metric.firstQuartileVideoAd 📎 - metric.freeTrialAppSubscriptionSignUpRate 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUpRate 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.grossClicks 📎 - metric.impressions 📎 - metric.impressionsAudioAd 📎 - metric.impressionsVideoAd 📎 - metric.interactiveImpressions 📎 - metric.invalidClickRate 📎 - metric.invalidClicks 📎 - metric.invalidImpressionRate 📎 - metric.invalidImpressions 📎 - metric.kindleEditionNormalizedPagesRead 📎 - metric.kindleEditionNormalizedPagesReadFromClicks 📎 - metric.kindleEditionNormalizedPagesReadFromClicksHalo 📎 - metric.kindleEditionNormalizedPagesReadFromClicksPromoted 📎 - metric.kindleEditionNormalizedPagesReadFromViews 📎 - metric.kindleEditionNormalizedPagesReadFromViewsHalo 📎 - metric.kindleEditionNormalizedPagesReadFromViewsPromoted 📎 - metric.kindleEditionNormalizedPagesReadHalo 📎 - metric.kindleEditionNormalizedPagesReadPromoted 📎 - metric.kindleUnlimitedQualifiedBorrows 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicks 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViews 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted 📎 - metric.kindleUnlimitedQualifiedBorrowsHalo 📎 - metric.kindleUnlimitedQualifiedBorrowsPromoted 📎 - metric.longTermRoas 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.mainImdbAdClicks 📎 - metric.mainImdbAdImpressions 📎 - metric.managedServiceFees 📎 - metric.managedServiceFeesConverted 📎 - metric.measurableImpressions 📎 - metric.measurableRate 📎 - metric.mediaSpendCpm 📎 - metric.midpointAudioAd 📎 - metric.midpointVideoAd 📎 - metric.mutesAudioAd 📎 - metric.mutesVideoAd 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandAddToCartRate 📎 - metric.newToBrandAddToCartRatePromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearchRate 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViewRate 📎 - metric.newToBrandDetailPageViewRatePromoted 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchaseFromClickRate 📎 - metric.newToBrandPurchaseRate 📎 - metric.newToBrandPurchaseRatePromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandReturnPerThousandImpressions 📎 - metric.newToBrandReturnPerThousandImpressionsPromoted 📎 - metric.newToBrandRoas 📎 - metric.newToBrandRoasFromClicks 📎 - metric.newToBrandRoasFromClicksPromoted 📎 - metric.newToBrandRoasFromViews 📎 - metric.newToBrandRoasFromViewsPromoted 📎 - metric.newToBrandRoasPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.newtoBrandPurchaseRateOverClicks 📎 - metric.newtoBrandPurchaseRateOverClicksPromoted 📎 - metric.notificationClicks 📎 - metric.notificationOpens 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartRate 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplicationRate 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckoutRate 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContactRate 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversionRate 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonCostPerAddToShoppingCart 📎 - metric.offAmazonCostPerApplication 📎 - metric.offAmazonCostPerCheckout 📎 - metric.offAmazonCostPerContact 📎 - metric.offAmazonCostPerConversion 📎 - metric.offAmazonCostPerInstall 📎 - metric.offAmazonCostPerLead 📎 - metric.offAmazonCostPerOther 📎 - metric.offAmazonCostPerPageView 📎 - metric.offAmazonCostPerPurchase 📎 - metric.offAmazonCostPerPurchaseFromClicks 📎 - metric.offAmazonCostPerSearch 📎 - metric.offAmazonCostPerSignUp 📎 - metric.offAmazonCostPerSubscribe 📎 - metric.offAmazonInstallRate 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeadRate 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherRate 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViewRate 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchaseRate 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonReturnPerThousandImpressions 📎 - metric.offAmazonRoas 📎 - metric.offAmazonRoasFromClicks 📎 - metric.offAmazonRoasFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearchRate 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUpRate 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeRate 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.omnichannelMetricFees 📎 - metric.omnichannelMetricFeesConverted 📎 - metric.paidAppSubscriptionSignUpRate 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUpRate 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.pausesAudioAd 📎 - metric.pausesVideoAd 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.playsAudioAd 📎 - metric.productReviewPageVisitRate 📎 - metric.productReviewPageVisitRatePromoted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.progressAudioAd 📎 - metric.purchaseFromClickRate 📎 - metric.purchaseFromClickRatePromoted 📎 - metric.purchaseRate 📎 - metric.purchaseRateOverClicks 📎 - metric.purchaseRateOverClicksPromoted 📎 - metric.purchaseRatePromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentalRate 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.replaysVideoAd 📎 - metric.resumesAudioAd 📎 - metric.resumesVideoAd 📎 - metric.returnPerThousandImpressions 📎 - metric.returnPerThousandImpressionsPromoted 📎 - metric.rewardCost 📎 - metric.rewardCostConverted 📎 - metric.rewardGrants 📎 - metric.rewindsAudioAd 📎 - metric.roas 📎 - metric.roasFromClicks 📎 - metric.roasFromClicksPromoted 📎 - metric.roasFromViews 📎 - metric.roasFromViewsPromoted 📎 - metric.roasPromoted 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.skipsAudioAd 📎 - metric.skipsBackVideoAd 📎 - metric.skipsForwardVideoAd 📎 - metric.startsAudioAd 📎 - metric.startsVideoAd 📎 - metric.subscribeAndSaveSubscriptionRate 📎 - metric.subscribeAndSaveSubscriptionRatePromoted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUpRate 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.supplyCost 📎 - metric.supplyCostConverted 📎 - metric.thirdPartyFees 📎 - metric.thirdPartyFeesCm360 📎 - metric.thirdPartyFeesCm360Absorbed 📎 - metric.thirdPartyFeesCm360AbsorbedConverted 📎 - metric.thirdPartyFeesCm360Converted 📎 - metric.thirdPartyFeesComscore 📎 - metric.thirdPartyFeesComscoreAbsorbed 📎 - metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - metric.thirdPartyFeesComscoreConverted 📎 - metric.thirdPartyFeesConverted 📎 - metric.thirdPartyFeesCpm1 📎 - metric.thirdPartyFeesCpm1Absorbed 📎 - metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - metric.thirdPartyFeesCpm1Converted 📎 - metric.thirdPartyFeesCpm2 📎 - metric.thirdPartyFeesCpm2Absorbed 📎 - metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - metric.thirdPartyFeesCpm2Converted 📎 - metric.thirdPartyFeesCpm3 📎 - metric.thirdPartyFeesCpm3Absorbed 📎 - metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - metric.thirdPartyFeesCpm3Converted 📎 - metric.thirdPartyFeesDoubleVerify 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbed 📎 - metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - metric.thirdPartyFeesDoubleVerifyConverted 📎 - metric.thirdPartyFeesIas 📎 - metric.thirdPartyFeesIasAbsorbed 📎 - metric.thirdPartyFeesIasAbsorbedConverted 📎 - metric.thirdPartyFeesIasConverted 📎 - metric.thirdPartyPrebidFees 📎 - metric.thirdPartyPrebidFeesAdelaide 📎 - metric.thirdPartyPrebidFeesAdelaideConverted 📎 - metric.thirdPartyPrebidFeesConverted 📎 - metric.thirdPartyPrebidFeesDoubleVerify 📎 - metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - metric.thirdPartyPrebidFeesIas 📎 - metric.thirdPartyPrebidFeesIasConverted 📎 - metric.thirdPartyPrebidFeesNewsGuard 📎 - metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - metric.thirdPartyPrebidFeesOracleDataCloud 📎 - metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - metric.thirdPartyPrebidFeesPeer39 📎 - metric.thirdPartyPrebidFeesPeer39Converted 📎 - metric.thirdPartyPrebidFeesPixalate 📎 - metric.thirdPartyPrebidFeesPixalateConverted 📎 - metric.thirdPartyPrebidFeesScope3 📎 - metric.thirdPartyPrebidFeesScope3Converted 📎 - metric.thirdQuartileAudioAd 📎 - metric.thirdQuartileVideoAd 📎 - metric.totalCost 📎 - metric.totalCostConverted 📎 - metric.totalFees 📎 - metric.totalFeesConverted 📎 - metric.trailerPlayRate 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.unmutesAudioAd 📎 - metric.unmutesVideoAd 📎 - metric.vcpm 📎 - metric.vctr 📎 - metric.videoStreamPlayRate 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎 - metric.viewableDistribution 📎 - metric.viewableImpressions 📎 - metric.viewableRate 📎\n","\n"],"documentType":"guide"},{"title":"Matched target (Targeting)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/targeting/matched-target","content":[],"documentType":"guide"},{"title":"Conversion source (Conversion)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source","content":[" The Conversion source dimension contains 3 fields, listed below:\n"],"documentType":"guide"},{"title":"Conversion source (Conversion)","sectionHeader":{"type":2,"text":"Conversion source (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source","content":["Reporting Field ID: conversionSource.name - Data Type: STRING - Description: The system or integration that reported conversions to Amazon Ads. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversion source (Conversion)","sectionHeader":{"type":2,"text":"Conversion source owner"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source","content":["Reporting Field ID: conversionSource.owner - Data Type: STRING - Description: The entity that oversees how conversions from this source are collected and reported. - Required fields: conversionSource.name 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversion source (Conversion)","sectionHeader":{"type":2,"text":"Scaled"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source","content":["Reporting Field ID: conversionSource.scaled - Data Type: STRING - Description: This indicates whether the conversion was scaled by the source to represent a larger population. - Required fields: conversionSource.name 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversion source (Conversion)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ❌ |\n","| Advertised product marketplace | ❌ |\n","| Advertised product SKU | ❌ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ✅ |\n","| Postal code | ❌ |\n","| Product relevance | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Conversion source (Conversion)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source","content":["metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎\n","\n"],"documentType":"guide"},{"title":"Conversion source (Conversion)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source","content":[],"documentType":"guide"},{"title":"Conversion definition (off-Amazon) (Conversion)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-definition-off-amazon","content":[" The Conversion definition (off-Amazon) dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Conversion definition (off-Amazon) (Conversion)","sectionHeader":{"type":2,"text":"Conversion definition (off-Amazon) (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-definition-off-amazon","content":["Reporting Field ID: offAmazonConversionDefinition.value - Data Type: STRING - Description: The name of a custom conversion definition created by an advertiser within a broader conversion type. Conversion definitions let advertisers label and track conversion goals that matter to their business. - Required fields: conversionSourceEnvironment.value 📎, offAmazonConversionType.value 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversion definition (off-Amazon) (Conversion)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-definition-off-amazon","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ❌ |\n","| Advertised product marketplace | ❌ |\n","| Advertised product SKU | ❌ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ❌ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ✅ |\n","| Postal code | ❌ |\n","| Product relevance | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Conversion definition (off-Amazon) (Conversion)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-definition-off-amazon","content":["metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎\n","\n"],"documentType":"guide"},{"title":"Conversion definition (off-Amazon) (Conversion)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-definition-off-amazon","content":[],"documentType":"guide"},{"title":"Conversion type (off-Amazon) (Conversion)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-type-off-amazon","content":[" The Conversion type (off-Amazon) dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Conversion type (off-Amazon) (Conversion)","sectionHeader":{"type":2,"text":"Conversion type (off-Amazon) (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-type-off-amazon","content":["Reporting Field ID: offAmazonConversionType.value - Data Type: STRING - Description: The type of the conversion defined by Amazon Ads to represent common shopping events used to measure the success of campaigns on and off Amazon. - Required fields: conversionSourceEnvironment.value 📎, offAmazonConversionDefinition.value 📎 - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversion type (off-Amazon) (Conversion)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-type-off-amazon","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ❌ |\n","| Advertised product marketplace | ❌ |\n","| Advertised product SKU | ❌ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ❌ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ✅ |\n","| Postal code | ❌ |\n","| Product relevance | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Conversion type (off-Amazon) (Conversion)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-type-off-amazon","content":["metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎\n","\n"],"documentType":"guide"},{"title":"Conversion type (off-Amazon) (Conversion)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-type-off-amazon","content":[],"documentType":"guide"},{"title":"Conversion source environment (Conversion)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source-environment","content":[" The Conversion source environment dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Conversion source environment (Conversion)","sectionHeader":{"type":2,"text":"Conversion source environment (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source-environment","content":["Reporting Field ID: conversionSourceEnvironment.value - Data Type: STRING - Description: The environment used by the shopper to view the ad like web or app. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversion source environment (Conversion)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source-environment","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ❌ |\n","| Advertised product marketplace | ❌ |\n","| Advertised product SKU | ❌ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ✅ |\n","| Conversion source attribution type | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ✅ |\n","| Postal code | ❌ |\n","| Product relevance | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Conversion source environment (Conversion)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source-environment","content":["metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎\n","\n"],"documentType":"guide"},{"title":"Conversion source environment (Conversion)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source-environment","content":[],"documentType":"guide"},{"title":"Conversion source attribution type (Conversion)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source-attribution-type","content":[" The Conversion source attribution type dimension contains 1 field, listed below:\n"],"documentType":"guide"},{"title":"Conversion source attribution type (Conversion)","sectionHeader":{"type":2,"text":"Conversion source attribution type (Primary Key)"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source-attribution-type","content":["Reporting Field ID: conversionSourceAttributionType.value - Data Type: STRING - Description: The organization whose attribution logic is applied to the conversions. - Required fields: N/A - Complementary fields: N/A - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversion source attribution type (Conversion)","sectionHeader":{"type":2,"text":"Dimension Compatibility"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source-attribution-type","content":["| Dimension | Compatible |\n","\\|-----------\\|------------\\|\n","| Ad | ✅ |\n","| Ad group | ✅ |\n","| Target | ❌ |\n","| Ad product | ✅ |\n","| Advertised product | ❌ |\n","| Advertised product marketplace | ❌ |\n","| Advertised product SKU | ❌ |\n","| Advertiser account | ✅ |\n","| Audience segment | ❌ |\n","| Audience segment targeting status | ❌ |\n","| Brand suitability content exclusion category | ❌ |\n","| Brand suitability inventory tier | ❌ |\n","| Browser name | ❌ |\n","| Browser version | ❌ |\n","| Budget currency | ✅ |\n","| Campaign | ✅ |\n","| City | ❌ |\n","| Content creator | ❌ |\n","| Content genre | ❌ |\n","| Content rating | ❌ |\n","| Content title | ❌ |\n","| Content type | ❌ |\n","| Conversion source | ✅ |\n","| Conversion source environment | ✅ |\n","| Converted currency | ✅ |\n","| Converted product | ❌ |\n","| Converted product marketplace | ❌ |\n","| Country | ❌ |\n","| Date | ✅ |\n","| Date range | ✅ |\n","| Day of month | ✅ |\n","| Day of week | ✅ |\n","| Deal | ❌ |\n","| Device type | ❌ |\n","| DMA | ❌ |\n","| Environment | ❌ |\n","| Flight | ✅ |\n","| Frequency group | ❌ |\n","| Hour | ❌ |\n","| Insertion order | ✅ |\n","| Live event | ❌ |\n","| Live event ad break | ❌ |\n","| Live event ad slot | ❌ |\n","| Live event inventory type | ❌ |\n","| Live event property | ❌ |\n","| Matched target | ❌ |\n","| Month | ✅ |\n","| Conversion definition (off-Amazon) | ✅ |\n","| Conversion type (off-Amazon) | ✅ |\n","| Operating system | ❌ |\n","| Placement | ❌ |\n","| Placement classification | ❌ |\n","| Placement size | ❌ |\n","| Portfolio | ✅ |\n","| Postal code | ❌ |\n","| Product relevance | ❌ |\n","| Region | ❌ |\n","| Search term | ❌ |\n","| Site or app | ❌ |\n","| Supply source | ❌ |\n","| Targeting | ❌ |\n","| Targeting match type | ❌ |\n","| Week | ✅ |\n","| Year | ✅ |\n"],"documentType":"guide"},{"title":"Conversion source attribution type (Conversion)","sectionHeader":{"type":2,"text":"Compatible metrics"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source-attribution-type","content":["metric.addToCart 📎 - metric.addToCartFromClicks 📎 - metric.addToCartFromClicksHalo 📎 - metric.addToCartFromClicksPromoted 📎 - metric.addToCartFromViews 📎 - metric.addToCartFromViewsHalo 📎 - metric.addToCartFromViewsPromoted 📎 - metric.addToCartHalo 📎 - metric.addToCartPromoted 📎 - metric.addToList 📎 - metric.addToListFromClicks 📎 - metric.addToListFromClicksHalo 📎 - metric.addToListFromClicksPromoted 📎 - metric.addToListFromViews 📎 - metric.addToListFromViewsHalo 📎 - metric.addToListFromViewsPromoted 📎 - metric.addToListHalo 📎 - metric.addToListPromoted 📎 - metric.addToWatchlist 📎 - metric.addToWatchlistFromClicks 📎 - metric.addToWatchlistFromViews 📎 - metric.alexaSkillEnable 📎 - metric.alexaSkillEnableFromClicks 📎 - metric.alexaSkillEnableFromViews 📎 - metric.alexaSkillInvocations 📎 - metric.alexaSkillInvocationsFromClicks 📎 - metric.alexaSkillInvocationsFromViews 📎 - metric.appSubscriptionSignUps 📎 - metric.appSubscriptionSignUpsFromClicks 📎 - metric.appSubscriptionSignUpsFromViews 📎 - metric.appstoreFirstOpens 📎 - metric.appstoreFirstOpensFromClicks 📎 - metric.appstoreFirstOpensFromViews 📎 - metric.appstoreFirstSessionHours 📎 - metric.appstoreFirstSessionHoursFromClicks 📎 - metric.appstoreFirstSessionHoursFromViews 📎 - metric.appstoreOpens 📎 - metric.appstoreOpensFromClicks 📎 - metric.appstoreOpensFromViews 📎 - metric.appstoreRepeatOpens 📎 - metric.appstoreRepeatOpensFromClicks 📎 - metric.appstoreRepeatOpensFromViews 📎 - metric.appstoreRepeatSessionHours 📎 - metric.appstoreRepeatSessionHoursFromClicks 📎 - metric.appstoreRepeatSessionHoursFromViews 📎 - metric.appstoreUsageHours 📎 - metric.appstoreUsageHoursFromClicks 📎 - metric.appstoreUsageHoursFromViews 📎 - metric.brandStorePageViews 📎 - metric.brandStorePageViewsFromClicks 📎 - metric.brandStorePageViewsFromViews 📎 - metric.brandedSearches 📎 - metric.brandedSearchesFromClicks 📎 - metric.brandedSearchesFromViews 📎 - metric.combinedPurchases 📎 - metric.combinedPurchasesFromClicks 📎 - metric.combinedPurchasesFromViews 📎 - metric.combinedSales 📎 - metric.combinedSalesConverted 📎 - metric.combinedSalesFromClicks 📎 - metric.combinedSalesFromClicksConverted 📎 - metric.combinedUnitsSold 📎 - metric.combinedUnitsSoldFromClicks 📎 - metric.costPerNewToBrandBrandStorePageView 📎 - metric.costPerNewToBrandBrandStorePageViewConverted 📎 - metric.costPerNewToBrandBrandedSearchConverted 📎 - metric.detailPageViews 📎 - metric.detailPageViewsFromClicks 📎 - metric.detailPageViewsFromClicksHalo 📎 - metric.detailPageViewsFromClicksPromoted 📎 - metric.detailPageViewsFromViews 📎 - metric.detailPageViewsFromViewsHalo 📎 - metric.detailPageViewsFromViewsPromoted 📎 - metric.detailPageViewsHalo 📎 - metric.detailPageViewsPromoted 📎 - metric.downloadedVideoPlays 📎 - metric.downloadedVideoPlaysFromClicks 📎 - metric.downloadedVideoPlaysFromViews 📎 - metric.freeTrialAppSubscriptionSignUps 📎 - metric.freeTrialAppSubscriptionSignUpsFromClicks 📎 - metric.freeTrialAppSubscriptionSignUpsFromViews 📎 - metric.freeTrialSubscriptionSignUps 📎 - metric.freeTrialSubscriptionSignUpsFromClicks 📎 - metric.freeTrialSubscriptionSignUpsFromViews 📎 - metric.longTermSales 📎 - metric.longTermSalesConverted 📎 - metric.newToBrandAddToCart 📎 - metric.newToBrandAddToCartFromClicks 📎 - metric.newToBrandAddToCartFromClicksHalo 📎 - metric.newToBrandAddToCartFromClicksPromoted 📎 - metric.newToBrandAddToCartFromViews 📎 - metric.newToBrandAddToCartFromViewsHalo 📎 - metric.newToBrandAddToCartFromViewsPromoted 📎 - metric.newToBrandAddToCartHalo 📎 - metric.newToBrandAddToCartPromoted 📎 - metric.newToBrandBrandStorePageViewRate 📎 - metric.newToBrandBrandStorePageViews 📎 - metric.newToBrandBrandStorePageViewsFromClicks 📎 - metric.newToBrandBrandStorePageViewsFromViews 📎 - metric.newToBrandBrandedSearches 📎 - metric.newToBrandBrandedSearchesFromClicks 📎 - metric.newToBrandBrandedSearchesFromViews 📎 - metric.newToBrandDetailPageViews 📎 - metric.newToBrandDetailPageViewsFromClicks 📎 - metric.newToBrandDetailPageViewsFromClicksHalo 📎 - metric.newToBrandDetailPageViewsFromClicksPromoted 📎 - metric.newToBrandDetailPageViewsFromViews 📎 - metric.newToBrandDetailPageViewsFromViewsHalo 📎 - metric.newToBrandDetailPageViewsFromViewsPromoted 📎 - metric.newToBrandDetailPageViewsHalo 📎 - metric.newToBrandDetailPageViewsPromoted 📎 - metric.newToBrandPurchases 📎 - metric.newToBrandPurchasesFromClicks 📎 - metric.newToBrandPurchasesFromClicksHalo 📎 - metric.newToBrandPurchasesFromClicksPromoted 📎 - metric.newToBrandPurchasesFromViews 📎 - metric.newToBrandPurchasesFromViewsHalo 📎 - metric.newToBrandPurchasesFromViewsPromoted 📎 - metric.newToBrandPurchasesHalo 📎 - metric.newToBrandPurchasesPromoted 📎 - metric.newToBrandSales 📎 - metric.newToBrandSalesConverted 📎 - metric.newToBrandSalesFromClicks 📎 - metric.newToBrandSalesFromClicksConverted 📎 - metric.newToBrandSalesFromClicksHalo 📎 - metric.newToBrandSalesFromClicksHaloConverted 📎 - metric.newToBrandSalesFromClicksPromoted 📎 - metric.newToBrandSalesFromClicksPromotedConverted 📎 - metric.newToBrandSalesFromViews 📎 - metric.newToBrandSalesFromViewsConverted 📎 - metric.newToBrandSalesFromViewsHalo 📎 - metric.newToBrandSalesFromViewsHaloConverted 📎 - metric.newToBrandSalesFromViewsPromoted 📎 - metric.newToBrandSalesFromViewsPromotedConverted 📎 - metric.newToBrandSalesHalo 📎 - metric.newToBrandSalesHaloConverted 📎 - metric.newToBrandSalesPromoted 📎 - metric.newToBrandSalesPromotedConverted 📎 - metric.newToBrandUnitsSold 📎 - metric.newToBrandUnitsSoldFromClicks 📎 - metric.newToBrandUnitsSoldFromClicksHalo 📎 - metric.newToBrandUnitsSoldFromClicksPromoted 📎 - metric.newToBrandUnitsSoldFromViews 📎 - metric.newToBrandUnitsSoldFromViewsConverted 📎 - metric.newToBrandUnitsSoldFromViewsHalo 📎 - metric.newToBrandUnitsSoldFromViewsPromoted 📎 - metric.newToBrandUnitsSoldHalo 📎 - metric.newToBrandUnitsSoldPromoted 📎 - metric.offAmazonAddToShoppingCart 📎 - metric.offAmazonAddToShoppingCartFromClicks 📎 - metric.offAmazonAddToShoppingCartFromViews 📎 - metric.offAmazonAddToShoppingCartValueAverage 📎 - metric.offAmazonAddToShoppingCartValueSum 📎 - metric.offAmazonApplications 📎 - metric.offAmazonApplicationsFromClicks 📎 - metric.offAmazonApplicationsFromViews 📎 - metric.offAmazonApplicationsValueAverage 📎 - metric.offAmazonApplicationsValueSum 📎 - metric.offAmazonCheckouts 📎 - metric.offAmazonCheckoutsFromClicks 📎 - metric.offAmazonCheckoutsFromViews 📎 - metric.offAmazonCheckoutsValueAverage 📎 - metric.offAmazonCheckoutsValueSum 📎 - metric.offAmazonContacts 📎 - metric.offAmazonContactsFromClicks 📎 - metric.offAmazonContactsFromViews 📎 - metric.offAmazonContactsValueAverage 📎 - metric.offAmazonContactsValueSum 📎 - metric.offAmazonConversions 📎 - metric.offAmazonConversionsFromClicks 📎 - metric.offAmazonConversionsFromViews 📎 - metric.offAmazonConversionsOptimized 📎 - metric.offAmazonConversionsValueAverage 📎 - metric.offAmazonConversionsValueSum 📎 - metric.offAmazonConversionsValueSumOptimized 📎 - metric.offAmazonInstalls 📎 - metric.offAmazonInstallsFromClicks 📎 - metric.offAmazonInstallsFromViews 📎 - metric.offAmazonInstallsValueAverage 📎 - metric.offAmazonInstallsValueSum 📎 - metric.offAmazonLeads 📎 - metric.offAmazonLeadsFromClicks 📎 - metric.offAmazonLeadsFromViews 📎 - metric.offAmazonLeadsValueAverage 📎 - metric.offAmazonLeadsValueSum 📎 - metric.offAmazonOther 📎 - metric.offAmazonOtherFromClicks 📎 - metric.offAmazonOtherFromViews 📎 - metric.offAmazonOtherValueAverage 📎 - metric.offAmazonOtherValueSum 📎 - metric.offAmazonPageViews 📎 - metric.offAmazonPageViewsFromClicks 📎 - metric.offAmazonPageViewsFromViews 📎 - metric.offAmazonPageViewsValueAverage 📎 - metric.offAmazonPageViewsValueSum 📎 - metric.offAmazonPurchases 📎 - metric.offAmazonPurchasesFromClicks 📎 - metric.offAmazonPurchasesFromViews 📎 - metric.offAmazonSales 📎 - metric.offAmazonSalesConverted 📎 - metric.offAmazonSalesFromClicks 📎 - metric.offAmazonSalesFromClicksConverted 📎 - metric.offAmazonSalesFromViews 📎 - metric.offAmazonSalesFromViewsConverted 📎 - metric.offAmazonSalesOptimized 📎 - metric.offAmazonSalesOptimizedConverted 📎 - metric.offAmazonSearches 📎 - metric.offAmazonSearchesFromClicks 📎 - metric.offAmazonSearchesFromViews 📎 - metric.offAmazonSearchesValueAverage 📎 - metric.offAmazonSearchesValueSum 📎 - metric.offAmazonSignUps 📎 - metric.offAmazonSignUpsFromClicks 📎 - metric.offAmazonSignUpsFromViews 📎 - metric.offAmazonSignUpsValueAverage 📎 - metric.offAmazonSignUpsValueSum 📎 - metric.offAmazonSubscribe 📎 - metric.offAmazonSubscribeFromClicks 📎 - metric.offAmazonSubscribeFromViews 📎 - metric.offAmazonSubscribeValueAverage 📎 - metric.offAmazonSubscribeValueSum 📎 - metric.offAmazonUnitsSold 📎 - metric.offAmazonUnitsSoldFromClicks 📎 - metric.offAmazonUnitsSoldFromViews 📎 - metric.paidAppSubscriptionSignUps 📎 - metric.paidAppSubscriptionSignUpsFromClicks 📎 - metric.paidAppSubscriptionSignUpsFromViews 📎 - metric.paidSubscriptionSignUps 📎 - metric.paidSubscriptionSignUpsFromClicks 📎 - metric.paidSubscriptionSignUpsFromViews 📎 - metric.percentOfPurchasesNewToBrand 📎 - metric.percentOfPurchasesNewToBrandHalo 📎 - metric.percentOfPurchasesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrand 📎 - metric.percentOfSalesNewToBrandConverted 📎 - metric.percentOfSalesNewToBrandHalo 📎 - metric.percentOfSalesNewToBrandPromoted 📎 - metric.percentOfSalesNewToBrandPromotedConverted 📎 - metric.productReviewPageVisits 📎 - metric.productReviewPageVisitsFromClicks 📎 - metric.productReviewPageVisitsFromClicksHalo 📎 - metric.productReviewPageVisitsFromClicksPromoted 📎 - metric.productReviewPageVisitsFromViews 📎 - metric.productReviewPageVisitsFromViewsHalo 📎 - metric.productReviewPageVisitsFromViewsPromoted 📎 - metric.productReviewPageVisitsHalo 📎 - metric.productReviewPageVisitsPromoted 📎 - metric.purchases 📎 - metric.purchasesFromClicks 📎 - metric.purchasesFromClicksHalo 📎 - metric.purchasesFromClicksPromoted 📎 - metric.purchasesFromViews 📎 - metric.purchasesFromViewsHalo 📎 - metric.purchasesFromViewsPromoted 📎 - metric.purchasesHalo 📎 - metric.purchasesPromoted 📎 - metric.rentals 📎 - metric.rentalsFromClicks 📎 - metric.rentalsFromViews 📎 - metric.sales 📎 - metric.salesConverted 📎 - metric.salesFromClicks 📎 - metric.salesFromClicksConverted 📎 - metric.salesFromClicksHalo 📎 - metric.salesFromClicksHaloConverted 📎 - metric.salesFromClicksPromoted 📎 - metric.salesFromClicksPromotedConverted 📎 - metric.salesFromViews 📎 - metric.salesFromViewsConverted 📎 - metric.salesFromViewsHalo 📎 - metric.salesFromViewsHaloConverted 📎 - metric.salesFromViewsPromoted 📎 - metric.salesFromViewsPromotedConverted 📎 - metric.salesHalo 📎 - metric.salesHaloConverted 📎 - metric.salesPromoted 📎 - metric.salesPromotedConverted 📎 - metric.subscribeAndSaveSubscriptions 📎 - metric.subscribeAndSaveSubscriptionsFromClicks 📎 - metric.subscribeAndSaveSubscriptionsFromClicksHalo 📎 - metric.subscribeAndSaveSubscriptionsFromClicksPromoted 📎 - metric.subscribeAndSaveSubscriptionsFromViews 📎 - metric.subscribeAndSaveSubscriptionsFromViewsHalo 📎 - metric.subscribeAndSaveSubscriptionsFromViewsPromoted 📎 - metric.subscribeAndSaveSubscriptionsHalo 📎 - metric.subscribeAndSaveSubscriptionsPromoted 📎 - metric.subscriptionSignUps 📎 - metric.subscriptionSignUpsFromClicks 📎 - metric.subscriptionSignUpsFromViews 📎 - metric.trailerPlays 📎 - metric.trailerPlaysFromClicks 📎 - metric.trailerPlaysFromViews 📎 - metric.unitsSold 📎 - metric.unitsSoldFromClicks 📎 - metric.unitsSoldFromClicksHalo 📎 - metric.unitsSoldFromClicksPromoted 📎 - metric.unitsSoldFromViews 📎 - metric.unitsSoldFromViewsHalo 📎 - metric.unitsSoldFromViewsPromoted 📎 - metric.unitsSoldHalo 📎 - metric.unitsSoldPromoted 📎 - metric.videoStreamPlays 📎 - metric.videoStreamPlaysFromClicks 📎 - metric.videoStreamPlaysFromViews 📎\n","\n"],"documentType":"guide"},{"title":"Conversion source attribution type (Conversion)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/dimensions/conversion/conversion-source-attribution-type","content":[],"documentType":"guide"},{"title":"Metrics library","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":[],"documentType":"guide"},{"title":"Metrics library","sectionHeader":{"type":2,"text":"Delivery"},"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":["Impressions - Clicks - Viewability\n"],"documentType":"guide"},{"title":"Metrics library","sectionHeader":{"type":2,"text":"Amazon retail conversions"},"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":["Purchases - Purchases (all views) - Purchases (new to brand) - Detail page views - Detail page views (new to brand) - Add to cart - Add to cart (new to brand) - Branded searches - Branded searches (new to brand) - Brand store page views - Brand store page views (new to brand) - Add to list - Product review page visits - Subscribe & Save subscriptions - Long-term sales\n"],"documentType":"guide"},{"title":"Metrics library","sectionHeader":{"type":2,"text":"Costs and fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":["Costs - Fees - Third-party fees\n"],"documentType":"guide"},{"title":"Metrics library","sectionHeader":{"type":2,"text":"Amazon device conversions"},"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":["Subscription sign-ups - Paid subscription sign-ups - Free-trial subscription sign-ups - App subscription sign-ups - Paid app subscription sign-ups - Free-trial app subscription sign-ups - Appstore opens - Appstore first opens - Appstore repeat opens - Alexa skill enable - Alexa skill invocations - Kindle Edition Normalized Pages read - Kindle Unlimited qualified borrows\n"],"documentType":"guide"},{"title":"Metrics library","sectionHeader":{"type":2,"text":"Reach"},"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":["User reach - Household reach - Incremental reach (linear TV)\n"],"documentType":"guide"},{"title":"Metrics library","sectionHeader":{"type":2,"text":"Amazon video conversions"},"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":["Add to watchlist - Downloaded video plays - Rentals - Trailer plays - Video stream plays\n"],"documentType":"guide"},{"title":"Metrics library","sectionHeader":{"type":2,"text":"Impression share"},"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":["Search\n"],"documentType":"guide"},{"title":"Metrics library","sectionHeader":{"type":2,"text":"Engagement"},"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":["Interaction - Attention (video ad) - Attention (audio ad)\n"],"documentType":"guide"},{"title":"Metrics library","sectionHeader":{"type":2,"text":"Off-Amazon conversions"},"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":["Conversions (off-Amazon) - Purchases (off-Amazon) - Add to shopping cart (off-Amazon) - Applications (off-Amazon) - Checkouts (off-Amazon) - Contacts (off-Amazon) - Leads (off-Amazon) - Installs (off-Amazon) - Other (off-Amazon) - Page views (off-Amazon) - Searches (off-Amazon) - Sign-ups (off-Amazon) - Subscribe (off-Amazon)\n"],"documentType":"guide"},{"title":"Metrics library","sectionHeader":{"type":2,"text":"Combined conversions"},"path":"/en-us/guides/reporting/ads-v1/metrics/library","content":["Purchases (combined)\n"],"documentType":"guide"},{"title":"Impressions (Delivery)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/impressions","content":[" The Impressions metric family contains 6 fields, listed below:\n"],"documentType":"guide"},{"title":"Impressions (Delivery)","sectionHeader":{"type":2,"text":"Impressions"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/impressions","content":["Reporting Field ID: metric.impressions - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times the ad was displayed. This excludes impressions that were deemed invalid by traffic quality filters. Impressions = gross impressions - invalid impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): impressions - Version 3 Reporting Name (Sponsored Ads): impressions\n"],"documentType":"guide"},{"title":"Impressions (Delivery)","sectionHeader":{"type":2,"text":"Invalid impression rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/impressions","content":["Reporting Field ID: metric.invalidImpressionRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of gross impressions that were removed because they were deemed invalid by traffic quality filters. Invalid impression rate = invalid impressions / gross impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): invalidImpressionRate - Version 3 Reporting Name (Sponsored Ads): invalidImpressionRate\n"],"documentType":"guide"},{"title":"Impressions (Delivery)","sectionHeader":{"type":2,"text":"Invalid impressions"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/impressions","content":["Reporting Field ID: metric.invalidImpressions - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of impressions that were removed because they were deemed invalid by traffic quality filters. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): invalidImpressions - Version 3 Reporting Name (Sponsored Ads): invalidImpressions\n"],"documentType":"guide"},{"title":"Impressions (Delivery)","sectionHeader":{"type":2,"text":"Main IMDb ad impressions"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/impressions","content":["Reporting Field ID: metric.mainImdbAdImpressions - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times the main IMDb ad was displayed. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): masterImpressions - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Impressions (Delivery)","sectionHeader":{"type":2,"text":"CPM"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/impressions","content":["Reporting Field ID: metric.cpm - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total cost per thousand impressions. Cost per thousand impressions = (cost / impressions) \\* 1000 - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPM - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Impressions (Delivery)","sectionHeader":{"type":2,"text":"Media spend CPM"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/impressions","content":["Reporting Field ID: metric.mediaSpendCpm - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The cost of spending on media per thousand impressions. Media spend CPM = (media spend / impressions) \\* 1,000 - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Impressions (Delivery)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/impressions","content":[],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":[" The Clicks metric family contains 9 fields, listed below:\n"],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":{"type":2,"text":"Clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":["Reporting Field ID: metric.clicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times the ad was clicked. This excludes clicks that were deemed invalid by traffic quality filters. Clicks = gross clicks - invalid clicks - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): clicks - Version 3 Reporting Name (Sponsored Ads): clicks\n"],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":{"type":2,"text":"Gross clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":["Reporting Field ID: metric.grossClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total number of times the ad was clicked. This can include valid as well as invalid clicks. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): grossClickThroughs - Version 3 Reporting Name (Sponsored Ads): grossClickThroughs\n"],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":{"type":2,"text":"Invalid clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":["Reporting Field ID: metric.invalidClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of clicks that were removed because they were deemed invalid by traffic quality filters. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): invalidClickThroughs - Version 3 Reporting Name (Sponsored Ads): invalidClickThroughs\n"],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":{"type":2,"text":"Invalid click rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":["Reporting Field ID: metric.invalidClickRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of gross clicks that were removed because they were deemed invalid by traffic quality filters. Invalid click rate = invalid clicks / gross clicks - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): invalidClickThroughRate - Version 3 Reporting Name (Sponsored Ads): invalidClickThroughRate\n"],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":{"type":2,"text":"Viewable CTR (vCTR)"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":["Reporting Field ID: metric.vctr - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of viewable impressions that were clicked. vCTR = clicks / viewable impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): viewClickThroughRate - Version 3 Reporting Name (Sponsored Ads): viewClickThroughRate\n"],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":{"type":2,"text":"CTR"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":["Reporting Field ID: metric.ctr - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of impressions that were clicked. CTR = clicks / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): clickThroughRate - Version 3 Reporting Name (Sponsored Ads): clickThroughRate\n"],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":{"type":2,"text":"CPC"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":["Reporting Field ID: metric.cpc - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost paid per click. Cost per click (CPC) = cost / clicks - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.cpcConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPC - Version 3 Reporting Name (Sponsored Ads): costPerClick\n"],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":{"type":2,"text":"CPC (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":["Reporting Field ID: metric.cpcConverted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost paid per click. Cost per click (CPC) = cost / clicks.  Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":{"type":2,"text":"Main IMDb ad clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":["Reporting Field ID: metric.mainImdbAdClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times clicking on the main IMDb ad directed a user outside of the creative. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): masterClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Clicks (Delivery)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/clicks","content":[],"documentType":"guide"},{"title":"Viewability (Delivery)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/viewability","content":[" The Viewability metric family contains 6 fields, listed below:\n"],"documentType":"guide"},{"title":"Viewability (Delivery)","sectionHeader":{"type":2,"text":"Viewable CPM (vCPM)"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/viewability","content":["Reporting Field ID: metric.vcpm - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total cost per thousand viewable impressions. Cost per thousand viewable impressions (vCPM) = (cost / viewable impressions) \\* 1,000 - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Viewability (Delivery)","sectionHeader":{"type":2,"text":"Measurable impressions"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/viewability","content":["Reporting Field ID: metric.measurableImpressions - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of impressions that could be measured for viewability. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): measurableImpressions - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Viewability (Delivery)","sectionHeader":{"type":2,"text":"Measurable rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/viewability","content":["Reporting Field ID: metric.measurableRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of impressions that could be measured for viewability. Measurable rate = measurable impressions / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): measurableRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Viewability (Delivery)","sectionHeader":{"type":2,"text":"Viewable distribution"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/viewability","content":["Reporting Field ID: metric.viewableDistribution - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of impressions that were viewable. Viewable distribution = viewable impressions / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): viewabilityRate - Version 3 Reporting Name (Sponsored Ads): viewabilityRate\n"],"documentType":"guide"},{"title":"Viewability (Delivery)","sectionHeader":{"type":2,"text":"Viewable rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/viewability","content":["Reporting Field ID: metric.viewableRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of measurable impressions that were viewed. Viewable rate = vieweable impressions / measurable impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Viewability (Delivery)","sectionHeader":{"type":2,"text":"Viewable impressions"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/viewability","content":["Reporting Field ID: metric.viewableImpressions - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times the ad was viewed. This excludes impressions that were deemed invalid by traffic quality filters. An ad is counted as viewed when at least 50% of the ad shows on screen for at least 1 second for display ads and 2 seconds or longer for video ads. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): viewableImpressions - Version 3 Reporting Name (Sponsored Ads): viewableImpressions\n","\n"],"documentType":"guide"},{"title":"Viewability (Delivery)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/delivery/viewability","content":[],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":[" The Purchases metric family contains 56 fields, listed below:\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchases - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalPurchases - Version 3 Reporting Name (Sponsored Ads): purchases, orders14d, purchases7d, purchases14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.sales - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases attributed to an ad interaction. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.salesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalSales - Version 3 Reporting Name (Sponsored Ads): sales, sales7d, sales14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases attributed to an ad interaction. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.unitsSold - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units in purchases attributed to an ad interaction. A single purchase event can include multiple units of the same product. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalUnitsSold - Version 3 Reporting Name (Sponsored Ads): unitsSold, unitsSold7d, unitsSold14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.costPerPurchase - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a purchase conversion. Cost per purchase = total cost / purchases - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalECPP - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchaseRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of purchases relative to ad impressions. Purchase rate = purchases / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalPurchaseRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate over clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchaseRateOverClicks - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of click-attributed purchases relative to ad clicks. Purchase rate over clicks = purchases from clicks / clicks - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Return per thousand impressions"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.returnPerThousandImpressions - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Sales per thousand ad impressions. Return per thousand impressions = sales / (impressions / 1,000) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalERPM - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.roas - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend, calculated as attributed sales per unit of ad spend. ROAS = sales / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalROAS - Version 3 Reporting Name (Sponsored Ads): roas, roas7d, roas14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS (reconciled)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.roasReconciled - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend after reconciliation, calculated as attributed sales per unit of reconciled ad spend. Return on ad spend = sales / total cost reconciled - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Hour, Insertion order, Month, Placement, Placement size, Portfolio, Site or app, Supply source, Week, Year - Incompatible dimensions: Ad, Target, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement classification, Postal code, Product relevance, Region, Search term, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchasesFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalPurchasesClicks - Version 3 Reporting Name (Sponsored Ads): purchasesClicks, ordersClicks14d\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromClicks - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Sales from purchases attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.salesFromClicksConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): salesClicks, salesClicks14d\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromClicksConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Sales from purchases attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.unitsSoldFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units in purchases attributed to an ad click. A single purchase event can include multiple units of the same product. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): unitsSoldClicks - Version 3 Reporting Name (Sponsored Ads): unitsSoldClicks, unitsSoldClicks7d, unitsSoldClicks14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.costPerPurchaseFromClicks - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a click-attributed purchase. Cost per purchase from clicks = total cost / purchases from clicks - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase from click rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchaseFromClickRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of purchases from clicks relative to ad impressions. Purchase from click rate = purchases from clicks / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.roasFromClicks - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for click-attributed sales, calculated as sales from clicks per unit of ad spend. ROAS from clicks = sales from clicks / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): roasClicks7d, roasClicks14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchasesFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalPurchasesViews - Version 3 Reporting Name (Sponsored Ads): purchasesViews\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromViews - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases attributed to an ad view. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.salesFromViewsConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalSalesViews - Version 3 Reporting Name (Sponsored Ads): salesViews\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromViewsConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.unitsSoldFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units in purchases attributed to an ad view. A single purchase event can include multiple units of the same product. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): unitsSoldViews\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.roasFromViews - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for view-attributed sales, calculated as sales from views per unit of ad spend. ROAS from views = sales from views / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchasesPromoted - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for products that were directly promoted in the campaign. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): purchases - Version 3 Reporting Name (Sponsored Ads): purchasesPromoted, purchasesSameSku7d, purchasesSameSku14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesPromoted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.salesPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): sales - Version 3 Reporting Name (Sponsored Ads): salesPromoted, salesSameSku7d, salesSameSku14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (promoted, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.unitsSoldPromoted - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for products that were directly promoted in the campaign. A single purchase can include multiple units of the same product. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): unitsSold - Version 3 Reporting Name (Sponsored Ads): unitsSoldSameSku7d, unitsSoldSameSku14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.costPerPurchasePromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a purchase for a promoted product. Cost per purchase (promoted) = total cost / purchases (promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPP - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchaseRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of promoted purchases relative to ad impressions. Purchase rate (promoted) = purchases (promoted) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): purchaseRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate over clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchaseRateOverClicksPromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of click-attributed promoted purchases relative to ad clicks. Purchases rate over clicks (promoted) = purchases from clicks (promoted) / clicks - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Return per thousand impressions (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.returnPerThousandImpressionsPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales of promoted products per thousand ad impressions. Return per thousand impressions (promoted) = sales (promoted) / (impressions / 1,000) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eRPM - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.roasPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for sales of promoted products, calculated as promoted sales per unit of ad spend. ROAS (promoted) = sales (promoted) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): roas - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS (promoted, reconciled)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.roasPromotedReconciled - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for sales of promoted products after reconciliation, calculated as promoted sales per unit of reconciled ad spend. ROAS (promoted, reconciled) = sales (promoted) / total cost (reconciled) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Hour, Insertion order, Month, Placement, Placement size, Portfolio, Site or app, Supply source, Week, Year - Incompatible dimensions: Ad, Target, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement classification, Postal code, Product relevance, Region, Search term, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchasesFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for products that were directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): purchasesClicks - Version 3 Reporting Name (Sponsored Ads): purchasesPromotedClicks\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromClicksPromoted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign, attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.salesFromClicksPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): salesClicks - Version 3 Reporting Name (Sponsored Ads): salesPromotedClicks\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (promoted, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromClicksPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign, attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.unitsSoldFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for products that were directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): unitsSoldPromotedClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.costPerPurchaseFromClicksPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a click-attributed purchase for a promoted product. Cost per purchase from clicks (promoted) = total cost / purchases from clicks (promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): effectiveCostPerPurchasePromotedClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase from click rate (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchaseFromClickRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of promoted, click-attributed purchases relative to ad impressions. Purchase from click rate (promoted) = purchases from clicks (promoted) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): purchasesClicksRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.roasFromClicksPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for promoted sales attributed to an ad click. ROAS from clicks (promoted) = sales from clicks (promoted) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchasesFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for products that were directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): purchasesViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromViewsPromoted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign, attributed to an ad view. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.salesFromViewsPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (promoted, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromViewsPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign, attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.unitsSoldFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units in purchases for products that were directly promoted in the campaign, attributed to an ad view. A single purchase can include multiple units of the same product. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.roasFromViewsPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for promoted sales attributed to an ad view. ROAS from views (promoted) = sales from views (promoted) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchasesHalo - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): purchasesBrandHalo - Version 3 Reporting Name (Sponsored Ads): purchasesOtherSku7d, purchasesOtherSku14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesHalo - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.salesHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): salesOtherSku7d, salesOtherSku14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (halo, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.unitsSoldHalo - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed at an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): unitsSoldBrandHalo - Version 3 Reporting Name (Sponsored Ads): unitsSoldOtherSku7d, unitsSoldOtherSku14d \\[SP: 7d sellers / 14d vendors]\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchasesFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): purchasesBrandHaloClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromClicksHalo - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.salesFromClicksHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (halo, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromClicksHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.unitsSoldFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.purchasesFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): purchasesBrandHaloViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromViewsHalo - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.salesFromViewsHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (halo, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.salesFromViewsHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":["Reporting Field ID: metric.unitsSoldFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad view . - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Purchases (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases","content":[],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":[" The Purchases (all views) metric family contains 54 fields, listed below:\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchases - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases attributed to an ad interaction. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSales - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases attributed to an ad interaction. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.allViewsSalesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (all views, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases attributed to an ad interaction. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsUnitsSold - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units in purchases attributed to an ad interaction. A single purchase event can include multiple units of the same product. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsCostPerPurchase - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a purchase conversion. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Cost per purchase (all views) = total cost / purchases (all views) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchaseRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of purchases relative to ad impressions. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Purchase rate (all views) = purchases (all views) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate over clicks (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchaseRateOverClicks - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of click-attributed purchases relative to ad clicks. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Purchase rate over clicks (all views) = purchases from clicks (all views) / clicks - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Return per thousand impressions (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsReturnPerThousandImpressions - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Sales per thousand ad impressions. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Return per thousand impressions (all views) = sales (all views) / (impressions / 1,000) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsRoas - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend, calculated as attributed sales per unit of ad spend. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. ROAS (all views) = sales (all views) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchasesFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromClicks - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Sales from purchases attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.allViewsSalesFromClicksConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (all views, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromClicksConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Sales from purchases attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsUnitsSoldFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units in purchases attributed to an ad click. A single purchase event can include multiple units of the same product. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase from clicks (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsCostPerPurchaseFromClicks - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a click-attributed purchase. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Cost per purchase from clicks (all views) = total cost / purchases from clicks (all views) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase from click rate (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchaseFromClickRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of purchases from clicks relative to ad impressions. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Purchase from click rate (all views) = purchases from clicks (all views) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from clicks (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsRoasFromClicks - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for click-attributed sales, calculated as sales from clicks per unit of ad spend. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. ROAS from clicks (all views) = sales from clicks (all views) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from views (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchasesFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromViews - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.allViewsSalesFromViewsConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (all views, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromViewsConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from views (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsUnitsSoldFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units in purchases attributed to an ad view. A single purchase event can include multiple units of the same product. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from views (all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsRoasFromViews - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for view-attributed sales, calculated as sales from views per unit of ad spend. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. ROAS from views (all views) = sales from views (all views) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchasesPromoted - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for products that were directly promoted in the campaign. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesPromoted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.allViewsSalesPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (promoted, all views, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsUnitsSoldPromoted - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for products that were directly promoted in the campaign. A single purchase can include multiple units of the same product. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsCostPerPurchasePromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a purchase for a promoted product. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Cost per purchase (promoted, all views) = total cost / purchases (promoted, all views) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchaseRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of promoted purchases relative to ad impressions. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Purchase rate (promoted, all views) = purchases (promoted, all views) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate over clicks (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchaseRateOverClicksPromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of click-attributed promoted purchases relative to ad clicks. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Purchases rate over clicks (promoted, all views) = purchases from clicks (promoted, all views) / clicks - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Return per thousand impressions (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsReturnPerThousandImpressionsPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales of promoted products per thousand ad impressions. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Return per thousand impressions (promoted, all views) = sales (promoted, all views) / (impressions / 1,000) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsRoasPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for sales of promoted products, calculated as promoted sales per unit of ad spend. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. ROAS (promoted, all views) = sales (promoted, all views) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchasesFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for products that were directly promoted in the campaign, attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromClicksPromoted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign, attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.allViewsSalesFromClicksPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (promoted, all views, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromClicksPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign, attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsUnitsSoldFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for products that were directly promoted in the campaign, attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase from clicks (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsCostPerPurchaseFromClicksPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a click-attributed purchase for a promoted product. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Cost per purchase from clicks (promoted, all views) = total cost / purchases from clicks (promoted, all views) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase from click rate (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchaseFromClickRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of promoted, click-attributed purchases relative to ad impressions. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Purchase from click rate (promoted, all views) = purchases from clicks (promoted, all views) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from clicks (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsRoasFromClicksPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for promoted sales attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. ROAS from clicks (promoted, all views) = sales from clicks (promoted, all views) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from views (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchasesFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for products that were directly promoted in the campaign, attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromViewsPromoted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign, attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.allViewsSalesFromViewsPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (promoted, all views, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromViewsPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign, attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from views (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsUnitsSoldFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units in purchases for products that were directly promoted in the campaign, attributed to an ad view. A single purchase can include multiple units of the same product. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from views (promoted, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsRoasFromViewsPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for promoted sales attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. ROAS from views (promoted) = sales from views (promoted) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases (halo, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchasesHalo - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (halo, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesHalo - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.allViewsSalesHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (halo, all views, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold (halo, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsUnitsSoldHalo - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks (halo, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchasesFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (halo, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromClicksHalo - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.allViewsSalesFromClicksHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (halo, all views, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromClicksHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks (halo, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsUnitsSoldFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from views (halo, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsPurchasesFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (halo, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromViewsHalo - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.allViewsSalesFromViewsHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (halo, all views, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsSalesFromViewsHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from views (halo, all views)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":["Reporting Field ID: metric.allViewsUnitsSoldFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. This is calculated using the original attribution model, which includes all ad views for eligible campaigns. Metrics labeled “all views” are provided for comparison with the updated attribution model. For ongoing performance assessment, we recommend using the standard purchase metrics. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Purchases (all views) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-all-views","content":[],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":[" The Purchases (new to brand) metric family contains 63 fields, listed below:\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchases - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases by shoppers who had not purchased a product from the brand in the last 12 months. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalNewToBrandPurchases - Version 3 Reporting Name (Sponsored Ads): newToBrandPurchases, newToBrandPurchases14d\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSales - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from shoppers who had not purchased a product from the brand in the last 12 months. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.newToBrandSalesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalNewToBrandSales - Version 3 Reporting Name (Sponsored Ads): newToBrandSales, newToBrandSales14d\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (new to brand, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from shoppers who had not purchased a product from the brand in the last 12 months. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandUnitsSold - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units purchased by shoppers who had not purchased from the brand in the last 12 months, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalNewToBrandUnitsSold - Version 3 Reporting Name (Sponsored Ads): newToBrandUnitsSold, newToBrandUnitsSold14d\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandPurchase - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a purchase from a shopper who had  not purchased a product from the brand in the last 12 months. Cost per purchase (new to brand) = total cost / purchases (new to brand)) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalNewToBrandECPP - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchaseRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of new-to-brand purchases relative to ad impressions. Purchase rate (new to brand) = purchases (new to brand) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalNewToBrandPurchaseRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate over clicks (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newtoBrandPurchaseRateOverClicks - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of click-attributed new-to-brand purchases relative to ad clicks. Purchases from clicks (new to brand) = purchases from clicks (new to brand) / clicks - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Return per thousand impressions (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandReturnPerThousandImpressions - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: New-to-brand sales per thousand ad impressions. Return per thousand impressions (new to brand) = sales (new to brand) / (impressions / 1,000) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalNewToBrandERPM - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandRoas - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for new-to-brand sales. ROAS (new to brand) = sales (new to brand) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalNewToBrandROAS - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS (new to brand, reconciled)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandRoasReconciled - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for new-to-brand sales. ROAS (new to brand, reconciled) = sales (new to brand) / total cost (reconciled) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Hour, Insertion order, Month, Placement, Placement size, Portfolio, Site or app, Supply source, Week, Year - Incompatible dimensions: Ad, Target, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement classification, Postal code, Product relevance, Region, Search term, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Percent of purchases new to brand"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.percentOfPurchasesNewToBrand - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of attributed purchases by shoppers who had not purchased a product from the brand in the last 12 months. Percent of purchases new to brand = purchases (new to brand) / purchases - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalNewToBrandPurchasesPercentage - Version 3 Reporting Name (Sponsored Ads): newToBrandPurchasesPercentage, newToBrandPurchasesRate\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Percent of sales new to brand"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.percentOfSalesNewToBrand - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of attributed sales that were made by new-to-brand shoppers. Percent of sales new to brand = sales (new to brand) / sales - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.percentOfSalesNewToBrandConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): newToBrandSalesPercentage, newToBrandSalesPercentage14d\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Percent of sales new to brand (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.percentOfSalesNewToBrandConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of attributed sales that were made by new-to-brand shoppers. Values are displayed in the currency selected for conversion. Percent of sales new to brand = sales (new to brand) / sales - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchasesFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases by shoppers who had not purchased a product from the brand in the last 12 months, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalNewToBrandPurchasesClicks - Version 3 Reporting Name (Sponsored Ads): newToBrandPurchasesClicks\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromClicks - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from shoppers who had not purchased from the brand in the last 12 months, attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.newToBrandSalesFromClicksConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): newToBrandSalesClicks\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (new to brand, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromClicksConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from shoppers who had not purchased from the brand in the last 12 months, attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandUnitsSoldFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units purchased by shoppers who had not purchased from the brand in the last 12 months, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): newToBrandUnitsSoldClicks\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase from clicks (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandPurchaseFromClicks - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a click-attributed purchase by a shopper who had not purchased from the brand in the last 12 months. Cost per purchase from clicks (new to brand) = total cost / purchases from clicks (new to brand) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase from click rate (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchaseFromClickRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of click-attributed new-to-brand purchases relative to ad impressions. Purchase from click rate (new to brand) = purchases from clicks (new to brand) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from clicks (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandRoasFromClicks - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for click-attributed new-to-brand sales. ROAS from clicks (new to brand) = sales from clicks (new to brand) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from views (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchasesFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases by shoppers who had not purchased a product from the brand in the last 12 months, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from views (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandUnitsSoldFromViews - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units purchased by shoppers who had not purchased from the brand in the last 12 months, attributed to an ad view. - Required fields: N/A - Complementary fields: metric.newToBrandUnitsSoldFromViewsConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from views (new to brand, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandUnitsSoldFromViewsConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units purchased by shoppers who had not purchased from the brand in the last 12 months, attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromViews - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Sales by shoppers who had not purchased from the brand in the last 12 months, attributed to an ad view. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.newToBrandSalesFromViewsConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): newToBrandSalesViews\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (new to brand, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromViewsConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Sales by shoppers who had not purchased from the brand in the last 12 months, attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from views (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandRoasFromViews - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for new-to-brand sales from ad views. ROAS from views (new to brand) = sales from views (new to brand) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchasesPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases from new-to-brand shoppers for products directly promoted in the campaign. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandPurchases - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesPromoted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign by new-to-brand shoppers. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.newToBrandSalesPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandProductSales - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (new to brand, promoted, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign by new-to-brand shoppers. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandUnitsSoldPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold to new-to-brand shoppers for products that were directly promoted in the campaign. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandUnitsSold - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per purchase (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandPurchasePromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a purchase for a promoted product by a new-to-brand shopper. Cost per purchase (new to brand, promoted) = total cost / purchases  (new to brand, promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): NewToBrandECPP - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchaseRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of promoted, new-to-brand purchases relative to ad impressions. Purchase rate (promoted, new to brand) = purchases (promoted, new to brand) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): newToBrandPurchaseRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchase rate over clicks (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newtoBrandPurchaseRateOverClicksPromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of promoted, new-to-brand purchases relative to ad clicks. Purchase rate over clicks (promoted, new to brand) = purchases from clicks (promoted, new to brand) / clicks - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Return per thousand impressions (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandReturnPerThousandImpressionsPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The new-to-brand sales for promoted products per thousand ad impressions. Return per thousand impressions (new to brand) = sales (new to brand) / (impressions / 1,000) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): newToBrandERPM - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandRoasPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for new-to-brand sales for promoted products. ROAS (new to brand, promoted) = sales (new to brand, promoted) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): newToBrandROAS - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS (new to brand, promoted, reconciled)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandRoasPromotedReconciled - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for new-to-brand sales for promoted products after reconciliation. ROAS (new to brand, promoted) = sales (new to brand, promoted) / total cost reconciled - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Hour, Insertion order, Month, Placement, Placement size, Portfolio, Site or app, Supply source, Week, Year - Incompatible dimensions: Ad, Target, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement classification, Postal code, Product relevance, Region, Search term, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Percent of purchases new to brand (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.percentOfPurchasesNewToBrandPromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of promoted product purchases that were new to brand. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandPurchasesPercentage - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Percent of sales new to brand (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.percentOfSalesNewToBrandPromoted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of promoted product sales that were new to brand. Percent of sales new to brand (promoted) = sales (new to brand, promoted) / sales (promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.percentOfSalesNewToBrandPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Percent of sales new to brand (promoted, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.percentOfSalesNewToBrandPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of promoted product sales that were new to brand. Values are displayed in the currency selected for conversion. Percent of sales new to brand (promoted) = sales (new to brand, promoted) / sales (promoted) - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchasesFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases from new-to-brand shoppers for products directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandPurchasesClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromClicksPromoted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign by new-to-brand shoppers, attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.newToBrandSalesFromClicksPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (new to brand, promoted, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromClicksPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign by new-to-brand shoppers, attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandUnitsSoldFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for promoted products to new-to-brand shoppers, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from clicks (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandRoasFromClicksPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for click-attributed, new-to-brand sales for promoted products. ROAS from clicks (new to brand, promoted) = sales from clicks (new to brand, promoted) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from views (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchasesFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases from new-to-brand shoppers for products directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandPurchasesViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromViewsPromoted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign by new-to-brand shoppers, attributed to an ad view. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.newToBrandSalesFromViewsPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (new to brand, promoted, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromViewsPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from products that were directly promoted in the campaign by new-to-brand shoppers, attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from views (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandUnitsSoldFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for promoted products to new-to-brand shoppers, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"ROAS from views (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandRoasFromViewsPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for view-attributed, new-to-brand sales for promoted products. ROAS from views (new to brand, promoted) = sales from views (new to brand, promoted) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchasesHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times new-to-brand shoppers purchased a highly relevant product that was not directly promoted in the campaign. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandPurchasesBrandHalo - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesHalo - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign by new-to-brand shoppers. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.newToBrandSalesHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales (new to brand, halo, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign by new-to-brand shoppers.   Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandUnitsSoldHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for highly relevant products that were not directly promoted in the campaign to new-to-brand shoppers. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandUnitsSoldBrandHalo - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchasesFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of highly relevant product purchases that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandPurchasesBrandHaloClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromClicksHalo - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.newToBrandSalesFromClicksHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (new to brand, halo, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromClicksHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandUnitsSoldFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for highly relevant products that were not directly promoted in the campaign to new-to-brand shoppers, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Purchases from views (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandPurchasesFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of highly relevant product purchases that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandPurchasesBrandHaloViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromViewsHalo - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad view. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.newToBrandSalesFromViewsHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Sales from views (new to brand, halo, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandSalesFromViewsHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from highly relevant products that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Units sold from views (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.newToBrandUnitsSoldFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of units sold for highly relevant products that were not directly promoted in the campaign to new-to-brand shoppers, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Percent of purchases new to brand (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.percentOfPurchasesNewToBrandHalo - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of purchases by new-to-brand shoppers for highly relevant products that were not directly promoted in the campaign. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandPurchasePercentageBrandHalo - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Percent of sales new to brand (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":["Reporting Field ID: metric.percentOfSalesNewToBrandHalo - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of non-promoted but highly relevant product sales that were made by new-to-brand shoppers. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Purchases (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/purchases-new-to-brand","content":[],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":[" The Detail page views metric family contains 17 fields, listed below:\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalDetailPageView - Version 3 Reporting Name (Sponsored Ads): detailPageViews\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per detail page view"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.costPerDetailPageView - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a detail page view. Cost per detail page view = total cost / detail page views - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalECPDetailPageView - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page view rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of detail page views relative to ad impressions. Detail page view rate = detail page views / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalDetailPageViewRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalDetailPageViewClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per detail page view from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.costPerDetailPageViewFromClicks - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a click-attributed detail page view. Cost per detail page view from clicks = total cost / detail page views from clicks - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page view from click rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewFromClickRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views from clicks relative to ad impressions. Detail page views from click rate = etail page views from clicks / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalDetailPageViewViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views for products directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): detailPageViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per detail page view (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.costPerDetailPageViewPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a detail page view for a product directly promoted in the campaign. Cost per detail page view (promoted) = total cost / detail page views (promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPDetailPageView - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page view rate (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of detail page views for promoted products relative to ad impressions. Detail page view rate (promoted) = detail page views (promoted) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): detailPageViewRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewsFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views for products directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): detailPageViewClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per detail page view from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.costPerDetailPageViewFromClicksPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a click-attributed detail page view for a product directly promoted in the campaign. Cost per detail page view from clicks (promoted) = total cost / detail page views from clicks (promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): effectiveCostPerDetailPageViewPromotedClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page view from click rate (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewFromClickRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of click-attributed detail page views for promoted products relative to ad impressions. Detail page view rate from clicks (promoted) = detail page views from clicks (promoted) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): detailPageViewRatePromotedClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewsFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of view-attributed detail page views for products directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): detailPageViewViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): detailPageViewBrandHalo - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewsFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): detailPageViewBrandHaloClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":["Reporting Field ID: metric.detailPageViewsFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): detailPageViewBrandHaloViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Detail page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views","content":[],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":[" The Detail page views (new to brand) metric family contains 13 fields, listed below:\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views by shoppers who had not viewed a product from the brand in the last 12 months, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalNewToBrandDPVs - Version 3 Reporting Name (Sponsored Ads): newToBrandDetailPageViews\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per detail page view (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandDetailPageView - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a detail page view from a new-to-brand shopper. Cost per detail page view (new to brand) = total cost / detail page views (new to brand) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalNewToBrandECPDetailPageView - Version 3 Reporting Name (Sponsored Ads): newToBrandECPDetailPageView\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page view rate (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViewRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of detail page views by new-to-brand shoppers relative to ad impressions. Detail page view rate (new to brand) = detail page views (new to brand) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalNewToBrandDPVRate - Version 3 Reporting Name (Sponsored Ads): newToBrandDetailPageViewRate\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from clicks (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViewsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views by shoppers who had not viewed a product from the brand in the last 12 months, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalNewToBrandDPVClicks - Version 3 Reporting Name (Sponsored Ads): newToBrandDetailPageViewsClicks\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from views (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViewsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of detail page views by shoppers who had not viewed a product from the brand in the last 12 months, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalNewToBrandDPVViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand detail page views for products that were directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandDetailPageViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per detail page view (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandDetailPageViewPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a new-to-brand detail page view for a product that was directly promoted in the campaign. Cost per detail page view (new to brand, promoted) = total cost / detail page views (new to brand, promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): newToBrandECPDetailPageView - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page view rate (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViewRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of new-to-brand detail page views for promoted products relative to ad impressions. Detail page view rate (new to brand, promoted) = detail page views (new to brand, promoted) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): newToBrandDetailPageViewRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from clicks (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViewsFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand detail page views for products that were directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandDetailPageViewClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from views (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViewsFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand detail page views for products that were directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newToBrandDetailPageViewViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from clicks (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViewsFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Detail page views from views (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandDetailPageViewsFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Detail page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/detail-page-views-new-to-brand","content":[],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":[" The Add to cart metric family contains 13 fields, listed below:\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCart - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper added a product to their cart, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalAddToCart - Version 3 Reporting Name (Sponsored Ads): addToCart\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per add to cart"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.costPerAddToCart - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire an add-to-cart event. Cost per add to cart = total cost / add to cart - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalECPAddToCart - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCartRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of add-to-cart events relative to ad impressions. Add to cart rate = add to cart / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalAddToCartRate - Version 3 Reporting Name (Sponsored Ads): addToCartRate\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCartFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper added a product to their cart, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalAddToCartClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCartFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper added a product to their cart, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalAddToCartViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCartPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-cart events for products directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToCart - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per add to cart (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.costPerAddToCartPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire an add-to-cart event for a product that was directly promoted in the campaign. Cost per add to cart (promoted) = total cost / add to cart (promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPAddToCart - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart rate (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCartRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of add-to-cart events for promoted products relative to ad impressions. Add to cart rate (promoted) = add to cart  (promoted)/ impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): addToCartRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCartFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-cart events for products directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToCartClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCartFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-cart events for products directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToCartViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCartHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToCartBrandHalo - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCartFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToCartBrandHaloClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":["Reporting Field ID: metric.addToCartFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToCartBrandHaloViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Add to cart (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart","content":[],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":[" The Add to cart (new to brand) metric family contains 13 fields, listed below:\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCart - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-cart events by shoppers who had not added a product from the brand to their cart in the last 12 months, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): newToBrandAddToCart\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per add to cart (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandAddToCart - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a new-to-brand, add-to-cart event. Cost per add to cart (new to brand) = total cost / add to cart (new to brand) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart rate (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCartRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of add-to-cart events by new-to-brand shoppers relative to ad impressions. Add to cart rate (new to brand) = add to cart  (new to brand) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): newToBrandAddToCartRate\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from clicks (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCartFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-cart events by shoppers who had not added a product from the brand to their cart in the last 12 months, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): newToBrandAddToCartClicks\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from views (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCartFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-cart events by shoppers who had not added a product from the brand to their cart in the last 12 months, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCartPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand add-to-cart events for products directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per add to cart (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandAddToCartPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a new-to-brand, add-to-cart event for a product that was directly promoted in the campaign. Cost per add to cart (new to brand, promoted) = total cost / add to cart (new to brand, promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart rate (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCartRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of new-to-brand, add-to-cart events for promoted products relative to ad impressions. Add to cart rate (new to brand, promoted) = add to cart  (new to brand, promoted)/ impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from clicks (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCartFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand, add-to-cart events for products directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from views (new to brand, promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCartFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand, add-to-cart events for products directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCartHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand, add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from clicks (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCartFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand, add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to cart from views (new to brand, halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":["Reporting Field ID: metric.newToBrandAddToCartFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of new-to-brand, add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Add to cart (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-cart-new-to-brand","content":[],"documentType":"guide"},{"title":"Branded searches (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches","content":[" The Branded searches metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Branded searches (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Branded searches"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches","content":["Reporting Field ID: metric.brandedSearches - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): brandSearches - Version 3 Reporting Name (Sponsored Ads): brandedSearches\n"],"documentType":"guide"},{"title":"Branded searches (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per branded search"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches","content":["Reporting Field ID: metric.costPerBrandedSearch - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a branded search conversion. Cost per branded search = total cost / branded searches - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPBrandSearch - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Branded searches (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Branded search rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches","content":["Reporting Field ID: metric.brandedSearchRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of branded searches relative to ad impressions. Branded search rate = branded searches / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): brandSearchRate - Version 3 Reporting Name (Sponsored Ads): brandedSearchRate\n"],"documentType":"guide"},{"title":"Branded searches (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Branded searches from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches","content":["Reporting Field ID: metric.brandedSearchesFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): brandSearchesClicks - Version 3 Reporting Name (Sponsored Ads): brandedSearchesClicks\n"],"documentType":"guide"},{"title":"Branded searches (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Branded searches from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches","content":["Reporting Field ID: metric.brandedSearchesFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): brandSearchesViews - Version 3 Reporting Name (Sponsored Ads): brandedSearchesViews\n","\n"],"documentType":"guide"},{"title":"Branded searches (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches","content":[],"documentType":"guide"},{"title":"Branded searches (new to brand) (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches-new-to-brand","content":[" The Branded searches (new to brand) metric family contains 6 fields, listed below:\n"],"documentType":"guide"},{"title":"Branded searches (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Branded searches (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches-new-to-brand","content":["Reporting Field ID: metric.newToBrandBrandedSearches - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of branded searches by shoppers who had not searched for the brand in the last 12 months, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Branded searches (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per branded search (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandBrandedSearch - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a new-to-brand branded search conversion. Cost per branded search (new to brand) = total cost / branded searches (new to brand) - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.costPerNewToBrandBrandedSearchConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Branded searches (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per branded search (new to brand, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandBrandedSearchConverted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a new-to-brand branded search conversion. Values are displayed in the currency selected for conversion. Cost per branded search (new to brand) = total cost (converted) / branded searches (new to brand) - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Branded searches (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Branded search rate (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches-new-to-brand","content":["Reporting Field ID: metric.newToBrandBrandedSearchRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of new-to-brand branded searches relative to ad impressions. Branded search rate (new to brand) = branded searches (new to brand) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Branded searches (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Branded searches from clicks (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches-new-to-brand","content":["Reporting Field ID: metric.newToBrandBrandedSearchesFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of branded searches by shoppers who had not searched for the brand in the last 12 months, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Branded searches (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Branded searches from views (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches-new-to-brand","content":["Reporting Field ID: metric.newToBrandBrandedSearchesFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of branded searches by shoppers who had not searched for the brand in the last 12 months, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Branded searches (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/branded-searches-new-to-brand","content":[],"documentType":"guide"},{"title":"Brand store page views (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views","content":[" The Brand store page views metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Brand store page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Brand store page views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views","content":["Reporting Field ID: metric.brandStorePageViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times shoppers viewed a brand-store page, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand store page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per brand store page view"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views","content":["Reporting Field ID: metric.costPerBrandStorePageView - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a brand-store page view conversion. Cost per brand store page view = total cost / brand store page views - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand store page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Brand store page view rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views","content":["Reporting Field ID: metric.brandStorePageViewRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of brand-store page views relative to ad impressions. Brand store page view rate = brand store page views / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand store page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Brand store page views from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views","content":["Reporting Field ID: metric.brandStorePageViewsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times shoppers viewed a brand-store page, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand store page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Brand store page views from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views","content":["Reporting Field ID: metric.brandStorePageViewsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times shoppers viewed a brand-store page, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Brand store page views (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views","content":[],"documentType":"guide"},{"title":"Brand store page views (new to brand) (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views-new-to-brand","content":[" The Brand store page views (new to brand) metric family contains 6 fields, listed below:\n"],"documentType":"guide"},{"title":"Brand store page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Brand store page views (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandBrandStorePageViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of brand-store page views from shoppers with no store visit history for the brand in the last 12 months, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand store page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per brand store page view (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandBrandStorePageView - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a brand-store page view conversion for a new-to-brand shopper. Cost per brand store page view (new to brand) = total cost / brand store page views (new to brand) - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.costPerNewToBrandBrandStorePageViewConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand store page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per brand store page view (new to brand, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views-new-to-brand","content":["Reporting Field ID: metric.costPerNewToBrandBrandStorePageViewConverted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a brand-store page view conversion for a new-to-brand shopper. Cost per brand store page view (new to brand) = total cost / brand store page views (new to brand). Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand store page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Brand store page view rate (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandBrandStorePageViewRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of brand-store page views for new-to-brand shoppers relative to ad impressions. Brand store page view rate (new to brand) = brand store page views (new to brand) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand store page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Brand store page views from clicks (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandBrandStorePageViewsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of brand-store page views from shoppers with no store visit history for the brand in the last 12 months, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Brand store page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Brand store page views from views (new to brand)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views-new-to-brand","content":["Reporting Field ID: metric.newToBrandBrandStorePageViewsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of brand-store page views from shoppers with no store visit history for the brand in the last 12 months, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Brand store page views (new to brand) (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/brand-store-page-views-new-to-brand","content":[],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":[" The Add to list metric family contains 13 fields, listed below:\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToList - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper added a product to their wish list, gift list, or registry, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalAddToList - Version 3 Reporting Name (Sponsored Ads): addToList\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per add to list"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.costPerAddToList - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire an add-to-list event. Cost per add to list = total cost / add to list - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalECPAddToList - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToListRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of add-to-list events relative to ad impressions. Add to list rate = add to list / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalAddToListRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToListFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper added a product to their wish list, gift list, or registry, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalAddToListClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToListFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper added a product to their wish list, gift list, or registry, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalAddToListViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToListPromoted - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-list events for products directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToList - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per add to list (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.costPerAddToListPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire an add-to-list event for a product that was directly promoted in the campaign. Cost per add to list (promoted) = total cost / add to list (promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPAddToList - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list rate (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToListRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of add-to-list events for promoted products relative to ad impressions. (Add to list rate (promoted) = add to list  (promoted) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): addToListRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToListFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-list events for products directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToListClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToListFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-list events for products directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToListViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToListHalo - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-list events for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToListBrandHalo - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToListFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-list events for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToListBrandHaloClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Add to list from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":["Reporting Field ID: metric.addToListFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of add-to-list events for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToListBrandHaloViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Add to list (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/add-to-list","content":[],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":[" The Product review page visits metric family contains 13 fields, listed below:\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visits"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisits - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper visited an Amazon product review page, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalProductReviewPageVisits - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per review page visit"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.costPerProductReviewPageVisit - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire an Amazon product review page visit. Cost per review page visits = total cost / review page visits - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalECPProductReviewPageVisit - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visit rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisitRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of Amazon product review page visits relative to ad impressions. Review page visit rate = review page visit / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalProductReviewPageVisitRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visits from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisitsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number Amazon product review page visits attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalProductReviewPageVisitsClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visits from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisitsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Amazon product review page visits attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalProductReviewPageVisitsViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visits (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisitsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Amazon product review page visits for products directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): productReviewPageVisits - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per review page visit (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.costPerProductReviewPageVisitPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire am Amazon product review page visit for a product that was directly promoted in the campaign. Cost per review page visit (promoted) = total cost / review page visits (promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPProductReviewPageVisit - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visit rate (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisitRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of Amazon product review page visits for promoted products relative to ad impressions. Review page visit rate (promoted) = review page visits (promoted) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): productReviewPageVisitRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visits from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisitsFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Amazon product review page visits for products directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): productReviewPageVisitsClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visits from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisitsFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Amazon product review page visits directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): productReviewPageVisitsViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visits (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisitsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Amazon product review page visits for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): productReviewPageViewBrandHalo - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visits from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisitsFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Amazon product review page visits for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): productReviewPageViewBrandHaloClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Review page visits from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":["Reporting Field ID: metric.productReviewPageVisitsFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Amazon product review page visits for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): productReviewPageViewBrandHaloViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Product review page visits (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/product-review-page-visits","content":[],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":[" The Subscribe & Save subscriptions metric family contains 13 fields, listed below:\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscriptions"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptions - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Subscribe & Save subscriptions attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalSubscribeAndSave - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per Subscribe & Save subscription"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.costPerSubscribeAndSaveSubscription - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a Subscribe & Save subscription. Cost per Subscribe & Save subscription = total cost / Subscribe & Save subscriptions - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalECPSubscribeAndSave - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscription rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptionRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of Subscribe & Save subscriptions relative to ad impressions. Subscribe & Save subscription rate = Subscribe & Save subscriptions / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalSubscribeAndSaveRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscriptions from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptionsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number Subscribe & Save subscriptions attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalSubscribeAndSaveClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscriptions from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptionsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Subscribe & Save subscriptions attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): totalSubscribeAndSaveViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscriptions (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptionsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Subscribe & Save subscriptions for products directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newSubscribeAndSave - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Cost per Subscribe & Save subscription (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.costPerSubscribeAndSaveSubscriptionPromoted - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a Subscribe & Save subscription for a product that was directly promoted in the campaign. Cost per Subscribe & Save subscription (promoted) = total cost / Subscribe & Save subscriptions (promoted) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPnewSubscribeAndSave - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscription rate (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptionRatePromoted - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of Subscribe & Save subscriptions for promoted products relative to ad impressions. Subscribe & Save subscription rate (promoted) = Subscribe & Save subscriptions (promoted) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): newSubscribeAndSaveRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscriptions from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptionsFromClicksPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Subscribe & Save subscriptions for products directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newSubscribeAndSaveClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscriptions from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptionsFromViewsPromoted - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Subscribe & Save subscriptions directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newSubscribeAndSaveViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscriptions (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptionsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Subscribe & Save subscriptions for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newSubscribeAndSaveBrandHalo - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscriptions from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptionsFromClicksHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Subscribe & Save subscriptions for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newSubscribeAndSaveBrandHaloClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Subscribe & Save subscriptions from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":["Reporting Field ID: metric.subscribeAndSaveSubscriptionsFromViewsHalo - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of Subscribe & Save subscriptions for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): newSubscribeAndSaveBrandHaloViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Subscribe & Save subscriptions (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/subscribe-save-subscriptions","content":[],"documentType":"guide"},{"title":"Long-term sales (Amazon retail conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/long-term-sales","content":[" The Long-term sales metric family contains 3 fields, listed below:\n"],"documentType":"guide"},{"title":"Long-term sales (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Long-term sales"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/long-term-sales","content":["Reporting Field ID: metric.longTermSales - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP, Full-Funnel - Description: The projected sales for the next 12 months from incremental new-to-brand shopper engagement driven by your campaign. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.longTermSalesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): longTermSales - Version 3 Reporting Name (Sponsored Ads): longTermSales\n"],"documentType":"guide"},{"title":"Long-term sales (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Long-term ROAS"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/long-term-sales","content":["Reporting Field ID: metric.longTermRoas - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP, Full-Funnel - Description: Return on ad spend for long-term sales. Long-term ROAS = long-term sales / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): longTermRoas - Version 3 Reporting Name (Sponsored Ads): longTermRoas\n"],"documentType":"guide"},{"title":"Long-term sales (Amazon retail conversions)","sectionHeader":{"type":2,"text":"Long-term sales (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/long-term-sales","content":["Reporting Field ID: metric.longTermSalesConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP, Full-Funnel - Description: The projected sales for the next 12 months from incremental new-to-brand shopper engagement driven by your campaign. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): longTermSales - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Long-term sales (Amazon retail conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-retail-conversions/long-term-sales","content":[],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":[" The Costs metric family contains 9 fields, listed below:\n"],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":{"type":2,"text":"Supply cost"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":["Reporting Field ID: metric.supplyCost - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total amount spent on media supply. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.supplyCostConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): supplyCost - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":{"type":2,"text":"Supply cost (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":["Reporting Field ID: metric.supplyCostConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total amount spent on media supply. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): supplyCost - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":{"type":2,"text":"Total cost"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":["Reporting Field ID: metric.totalCost - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total amount spent on running the campaign. This excludes the third-party fees paid by the agency. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.totalCostConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalCost - Version 3 Reporting Name (Sponsored Ads): spend\n"],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":{"type":2,"text":"Total cost (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":["Reporting Field ID: metric.totalCostConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total amount spent on running the campaign. This excludes the third-party fees paid by the agency. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalCost - Version 3 Reporting Name (Sponsored Ads): spend\n"],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":{"type":2,"text":"Total cost (reconciled)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":["Reporting Field ID: metric.totalCostReconciled - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total amount spent on media, fees, and technology costs after reconciliation. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.totalCostReconciledConverted 📎 - Compatible dimensions: Ad group, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Hour, Insertion order, Month, Placement, Placement size, Portfolio, Site or app, Supply source, Week, Year - Incompatible dimensions: Ad, Target, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement classification, Postal code, Product relevance, Region, Search term, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":{"type":2,"text":"Total cost (reconciled, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":["Reporting Field ID: metric.totalCostReconciledConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total amount spent on media, fees, and technology costs after reconciliation. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Hour, Insertion order, Month, Placement, Placement size, Portfolio, Site or app, Supply source, Week, Year - Incompatible dimensions: Ad, Target, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement classification, Postal code, Product relevance, Region, Search term, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":{"type":2,"text":"Reward grants"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":["Reporting Field ID: metric.rewardGrants - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of rewards granted to shoppers who completed a high-value action after engaging with a reward-enabled ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":{"type":2,"text":"Reward cost"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":["Reporting Field ID: metric.rewardCost - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total cost of rewards granted to shoppers who engaged with a reward-enabled ad. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.rewardCostConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":{"type":2,"text":"Reward cost (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":["Reporting Field ID: metric.rewardCostConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The total cost of rewards granted to shoppers who engaged with a reward-enabled ad. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Costs (Costs and fees)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/costs","content":[],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":[" The Fees metric family contains 20 fields, listed below:\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Agency fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.agencyFees - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The percentage or flat fees deducted from the total budget to compensate the agency that is managing the media buy. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.agencyFeesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): agencyFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Agency fees (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.agencyFeesConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The percentage or flat fees deducted from the total budget to compensate the agency that is managing the media buy. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): agencyFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Amazon audience fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.amazonAudienceFees - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The fees that Amazon DSP charges customers to utilize Amazon-enabled targeting. The Amazon audience fee is calculated as a cost per thousand impressions. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.amazonAudienceFeesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): amazonAudienceFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Amazon audience fees (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.amazonAudienceFeesConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The fees that Amazon DSP charges customers to utilize Amazon-enabled targeting. The Amazon audience fee is calculated as a cost per thousand impressions. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): amazonAudienceFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Amazon console fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.amazonConsoleFees - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The technology fees that Amazon charges customers to access and use Amazon DSP. This fees is applied to the media supply costs. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.amazonConsoleFeesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): amazonPlatformFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Amazon console fees (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.amazonConsoleFeesConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The technology fees that Amazon charges customers to access and use Amazon DSP. This fees is applied to the media supply costs. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): amazonPlatformFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Custom fee bundle"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.customFeeBundle - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: A single fee charged for the use of multiple Amazon Ads products and services. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.customFeeBundleConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Custom fee bundle (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.customFeeBundleConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: A single fee charged for the use of multiple Amazon Ads products and services. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Demand-side fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.demandSideFees - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The sum of any billable fees an advertiser pays to use Amazon Ads products. This includes Amazon DSP tech fees, Amazon audience fees, and any third-party fees applied to campaigns. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.demandSideFeesConverted 📎 - Compatible dimensions: Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Insertion order, Month, Portfolio, Week, Year - Incompatible dimensions: Ad, Ad group, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Demand-side fees (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.demandSideFeesConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The sum of any billable fees an advertiser pays to use Amazon Ads products. This includes Amazon DSP tech fees, Amazon audience fees, and any third-party fees applied to campaigns. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Insertion order, Month, Portfolio, Week, Year - Incompatible dimensions: Ad, Ad group, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Managed service fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.managedServiceFees - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The percentage-based fee applied to the supply cost for Amazon campaign management services. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.managedServiceFeesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Managed service fees (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.managedServiceFeesConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The percentage-based fee applied to the supply cost for Amazon campaign management services. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Omnichannel metrics fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.omnichannelMetricFees - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: This fee is calculated based on a percentage of the supply cost. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.omnichannelMetricFeesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): omnichannelMetricsFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Omnichannel metrics fees (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.omnichannelMetricFeesConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: This fee is calculated based on a percentage of the supply cost. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): omnichannelMetricsFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Publisher earnings"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.publisherEarnings - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The net payment a publisher receives from Amazon Ads for serving ads on their supply. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.publisherEarningsConverted 📎 - Compatible dimensions: Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Insertion order, Month, Portfolio, Week, Year - Incompatible dimensions: Ad, Ad group, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Publisher earnings (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.publisherEarningsConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The net payment a publisher receives from Amazon Ads for serving ads on their supply. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Insertion order, Month, Portfolio, Week, Year - Incompatible dimensions: Ad, Ad group, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Supply-side fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.supplySideFees - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The amount a publisher pays Amazon Ads to sell their supply through an open auction. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.supplySideFeesConverted 📎 - Compatible dimensions: Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Insertion order, Month, Portfolio, Week, Year - Incompatible dimensions: Ad, Ad group, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Supply-side fees (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.supplySideFeesConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The amount a publisher pays Amazon Ads to sell their supply through an open auction. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Insertion order, Month, Portfolio, Week, Year - Incompatible dimensions: Ad, Ad group, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Total fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.totalFees - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The total fees an advertiser pays for their campaigns. This includes the supply cost, third-party fees, and any demand-side fees. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.totalFeesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"Total fees (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":["Reporting Field ID: metric.totalFeesConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The total fees an advertiser pays for their campaigns. This includes the supply cost, third-party fees, and any demand-side fees. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): totalFee - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Fees (Costs and fees)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/fees","content":[],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":[" The Third-party fees metric family contains 48 fields, listed below:\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (Comscore)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesComscore - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third party fees for using ComScore. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesComscoreConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeComScore - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (Comscore, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesComscoreConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third party fees for using ComScore. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeComScore - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (Comscore, absorbed)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesComscoreAbsorbed - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using Comscore. This cost is itemized in reports but absorbed by the user and excluded from total costs. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesComscoreAbsorbedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeComScoreAbsorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (Comscore, absorbed, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesComscoreAbsorbedConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using Comscore. This cost is itemized in reports but absorbed by the user and excluded from total costs. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeComScoreAbsorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 1)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm1 - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: A third-party technology fee. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesCpm1Converted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM1 - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 1, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm1Converted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: A third-party technology fee. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM1 - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 1, absorbed)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm1Absorbed - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using a third-party technology. This cost is itemized in reports but absorbed by the user and excluded from total costs. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesCpm1AbsorbedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM1Absorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 1, absorbed, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm1AbsorbedConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using a third-party technology. This cost is itemized in reports but absorbed by the user and excluded from total costs. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM1Absorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 2)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm2 - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: A third-party technology fee. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesCpm2Converted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM2 - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 2, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm2Converted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: A third-party technology fee. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM2 - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 2, absorbed)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm2Absorbed - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using al third-party technology. This cost is itemized in reports but absorbed by the user and excluded from total costs. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesCpm2AbsorbedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM2Absorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 2, absorbed, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm2AbsorbedConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using al third-party technology. This cost is itemized in reports but absorbed by the user and excluded from total costs. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM2Absorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 3)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm3 - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The fees for using a third-party data provider. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesCpm3Converted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM3 - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 3, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm3Converted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The fees for using a third-party data provider. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM3 - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 3, absorbed)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm3Absorbed - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using a third-party technology. This cost is itemized in reports but absorbed by the user and excluded from total costs. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesCpm3AbsorbedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM3Absorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CPM 3, absorbed, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCpm3AbsorbedConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using a third-party technology. This cost is itemized in reports but absorbed by the user and excluded from total costs. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeCPM3Absorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CM 360)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCm360 - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party fees for using Campaign Manager 360 (CM360). - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesCm360Converted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeDoubleclickCampaignManager - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CM 360, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCm360Converted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party fees for using Campaign Manager 360 (CM360). Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeDoubleclickCampaignManager - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CM 360, absorbed)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCm360Absorbed - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using Campaign Manager 360. This cost is itemized in reports but absorbed by the user and excluded from total costs - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesCm360AbsorbedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeDoubleclickCampaignManagerAbsorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (CM 360, absorbed, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesCm360AbsorbedConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using Campaign Manager 360. This cost is itemized in reports but absorbed by the user and excluded from total costs. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeDoubleclickCampaignManagerAbsorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (DoubleVerify)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesDoubleVerify - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party fees for using DoubleVerify. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesDoubleVerifyConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeDoubleVerify - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (DoubleVerify, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesDoubleVerifyConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party fees for using DoubleVerify. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeDoubleVerify - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (DoubleVerify, absorbed)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesDoubleVerifyAbsorbed - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using DoubleVerify. This cost is itemized in reports but absorbed by the user and excluded from total costs. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesDoubleVerifyAbsorbedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeDoubleVerifyAbsorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (DoubleVerify, absorbed, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesDoubleVerifyAbsorbedConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using DoubleVerify. This cost is itemized in reports but absorbed by the user and excluded from total costs. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeDoubleVerifyAbsorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (IAS)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesIas - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party fees for using Integral Ad Science (IAS). - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesIasConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeIntegralAdScience - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (IAS, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesIasConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party fees for using Integral Ad Science (IAS). Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeIntegralAdScience - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (IAS, absorbed)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesIasAbsorbed - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using Integral Ad Science (IAS). This cost is itemized in reports but absorbed by the user and excluded from total costs. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesIasAbsorbedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeIntegralAdScienceAbsorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (IAS, absorbed, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesIasAbsorbedConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The CPM fees for using Integral Ad Science (IAS). This cost is itemized in reports but absorbed by the user and excluded from total costs. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3pFeeIntegralAdScienceAbsorbed - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFees - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The total CPM fees for using third-party data providers. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyFeesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3PFees - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party fees (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyFeesConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The total CPM fees for using third-party data providers. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3PFees - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFees - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The fees for using third party pre-bid targeting in Amazon DSP. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyPrebidFeesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3PPreBidFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The fees for using third party pre-bid targeting in Amazon DSP. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3PPreBidFee - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (IAS)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesIas - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using Integral Ad Science (IAS). - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyPrebidFeesIasConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3PPreBidFeeIntegralAdScience - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (IAS, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesIasConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using Integral Ad Science (IAS). Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (OracleDataCloud)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesOracleDataCloud - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using OracleDataCloud. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyPrebidFeesOracleDataCloudConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3PPreBidFeeOracleDataCloud - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (OracleDataCloud, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesOracleDataCloudConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using OracleDataCloud. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (DoubleVerify)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesDoubleVerify - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using DoubleVerify. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyPrebidFeesDoubleVerifyConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3PPreBidFeeDoubleVerify - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (DoubleVerify, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesDoubleVerifyConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using DoubleVerify. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (NewsGuard)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesNewsGuard - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using NewsGuard. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyPrebidFeesNewsGuardConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (NewsGuard, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesNewsGuardConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using NewsGuard. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (Peer39)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesPeer39 - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using Peer39. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyPrebidFeesPeer39Converted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (Peer39, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesPeer39Converted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using Peer39. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (Pixalate)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesPixalate - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using Pixalate. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyPrebidFeesPixalateConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): 3PPreBidFeePixalate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (Pixalate, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesPixalateConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using Pixalate. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (Scope3)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesScope3 - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using Scope3. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyPrebidFeesScope3Converted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (Scope3, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesScope3Converted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using Scope3. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (Adelaide)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesAdelaide - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using Adelaide. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.thirdPartyPrebidFeesAdelaideConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"Third-party prebid fees (Adelaide, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":["Reporting Field ID: metric.thirdPartyPrebidFeesAdelaideConverted - Data Type: CURRENCY - Program eligibility: Amazon DSP - Description: The third-party prebid fees for using Adelaide. Values are displayed in the selected currency. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Third-party fees (Costs and fees)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/costs-and-fees/third-party-fees","content":[],"documentType":"guide"},{"title":"Subscription sign-ups (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/subscription-sign-ups","content":[" The Subscription sign-ups metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Subscription sign-ups"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/subscription-sign-ups","content":["Reporting Field ID: metric.subscriptionSignUps - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper signed up for a paid or free trial digital subscription for a product directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): subscriptionSignups - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per subscription sign-up"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/subscription-sign-ups","content":["Reporting Field ID: metric.costPerSubscriptionSignUp - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a subscription sign-up for a promoted product. Cost per subscription sign-up = total cost / subscription sign-ups - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPSubscriptionSignup - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Subscription sign-up rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/subscription-sign-ups","content":["Reporting Field ID: metric.subscriptionSignUpRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of subscription sign-ups for promoted products relative to ad impressions. Subscription sign-up rate = subscription sign-ups / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): subscriptionSignupRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Subscription sign-ups from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/subscription-sign-ups","content":["Reporting Field ID: metric.subscriptionSignUpsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number subscription sign-ups for a promoted product attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): subscriptionSignupClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Subscription sign-ups from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/subscription-sign-ups","content":["Reporting Field ID: metric.subscriptionSignUpsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of subscription sign-ups for a promoted product attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): subscriptionSignupViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/subscription-sign-ups","content":[],"documentType":"guide"},{"title":"Paid subscription sign-ups (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-subscription-sign-ups","content":[" The Paid subscription sign-ups metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Paid subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Paid subscription sign-ups"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-subscription-sign-ups","content":["Reporting Field ID: metric.paidSubscriptionSignUps - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper signed up for a paid digital subscription for a product directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): paidSubscriptionSignups - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Paid subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per paid subscription sign-up"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-subscription-sign-ups","content":["Reporting Field ID: metric.costPerPaidSubscriptionSignUp - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a paid subscription sign-up for a promoted product. Cost per paid subscription sign-up = total cost / paid subscription sign-ups - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPPaidSubscriptionSignup - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Paid subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Paid subscription sign-up rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-subscription-sign-ups","content":["Reporting Field ID: metric.paidSubscriptionSignUpRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of paid subscription sign-ups for promoted products relative to ad impressions. Paid subscription sign-up rate = paid subscription sign-ups / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): paidSubscriptionSignupRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Paid subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Paid subscription sign-ups from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-subscription-sign-ups","content":["Reporting Field ID: metric.paidSubscriptionSignUpsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of paid subscription sign-ups for a promoted product attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): paidSubscriptionSignupClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Paid subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Paid subscription sign-ups from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-subscription-sign-ups","content":["Reporting Field ID: metric.paidSubscriptionSignUpsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of paid subscription sign-ups for a promoted product attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): paidSubscriptionSignupViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Paid subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-subscription-sign-ups","content":[],"documentType":"guide"},{"title":"Free-trial subscription sign-ups (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-subscription-sign-ups","content":[" The Free-trial subscription sign-ups metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Free-trial subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Free trial subscription sign-ups"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-subscription-sign-ups","content":["Reporting Field ID: metric.freeTrialSubscriptionSignUps - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper signed up for a free trial digital subscription for a product directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): freeTrialSubscriptionSignups - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Free-trial subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per free trial subscription sign-up"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-subscription-sign-ups","content":["Reporting Field ID: metric.costPerFreeTrialSubscriptionSignUp - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a free trial subscription sign-up for a promoted product. Cost per free trial subscription sign-up = total cost / free trial subscription sign-ups - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPFreeTrialSubscriptionSignup - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Free-trial subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Free trial subscription sign-up rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-subscription-sign-ups","content":["Reporting Field ID: metric.freeTrialSubscriptionSignUpRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of free trial subscription sign-ups for promoted products relative to ad impressions. Free trial subscription sign-up rate = free trial subscription sign-ups / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): freeTrialSubscriptionSignupRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Free-trial subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Free trial subscription sign-ups from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-subscription-sign-ups","content":["Reporting Field ID: metric.freeTrialSubscriptionSignUpsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of free trial subscription sign-ups for a promoted product attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): freeTrialSubscriptionSignupClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Free-trial subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Free trial subscription sign-ups from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-subscription-sign-ups","content":["Reporting Field ID: metric.freeTrialSubscriptionSignUpsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of free trial subscription sign-ups for a promoted product attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): freeTrialSubscriptionSignupViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Free-trial subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-subscription-sign-ups","content":[],"documentType":"guide"},{"title":"App subscription sign-ups (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/app-subscription-sign-ups","content":[" The App subscription sign-ups metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"App subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"App subscription sign-ups"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/app-subscription-sign-ups","content":["Reporting Field ID: metric.appSubscriptionSignUps - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of paid and free trial app subscription sign-ups attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appSubscriptionSignUp - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"App subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per app subscription sign-up"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/app-subscription-sign-ups","content":["Reporting Field ID: metric.costPerAppSubscriptionSignUp - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire an app subscription sign-up. Cost per app subscription sign-up = total cost / app subscription sign-ups - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): appSubscriptionCost - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"App subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"App subscription sign-up rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/app-subscription-sign-ups","content":["Reporting Field ID: metric.appSubscriptionSignUpRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of app subscription sign-ups relative to ad impressions. App subscription sign-up rate = app subscription sign-ups / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): appSubscriptionSignUpRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"App subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"App subscription sign-ups from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/app-subscription-sign-ups","content":["Reporting Field ID: metric.appSubscriptionSignUpsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of paid and free trial app subscription sign-ups  attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appSubscriptionSignUpClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"App subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"App subscription sign-ups from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/app-subscription-sign-ups","content":["Reporting Field ID: metric.appSubscriptionSignUpsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of app subscription sign-ups (paid and free-trial) attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appSubscriptionSignUpViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"App subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/app-subscription-sign-ups","content":[],"documentType":"guide"},{"title":"Paid app subscription sign-ups (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-app-subscription-sign-ups","content":[" The Paid app subscription sign-ups metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Paid app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Paid app subscription sign-ups"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-app-subscription-sign-ups","content":["Reporting Field ID: metric.paidAppSubscriptionSignUps - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of paid app subscription sign-ups attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appSubscriptionSignUpPaid - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Paid app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per paid app subscription sign-up"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-app-subscription-sign-ups","content":["Reporting Field ID: metric.costPerPaidAppSubscriptionSignUp - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a paid app subscription sign-up. Cost per paid app subscription sign-up = total cost / paid app subscription sign-ups - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): appSubscriptionSignUpPaidCost - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Paid app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Paid app subscription sign-up rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-app-subscription-sign-ups","content":["Reporting Field ID: metric.paidAppSubscriptionSignUpRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of paid app subscription sign-ups relative to ad impressions. Paid app subscription sign-up rate = paid app subscription sign-ups / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): appSubscriptionSignUpPaidRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Paid app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Paid app subscription sign-ups from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-app-subscription-sign-ups","content":["Reporting Field ID: metric.paidAppSubscriptionSignUpsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of paid app subscription sign-ups attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appSubscriptionSignUpPaidClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Paid app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Paid app subscription sign-ups from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-app-subscription-sign-ups","content":["Reporting Field ID: metric.paidAppSubscriptionSignUpsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of paid app subscription sign-ups attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appSubscriptionSignUpPaidViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Paid app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/paid-app-subscription-sign-ups","content":[],"documentType":"guide"},{"title":"Free-trial app subscription sign-ups (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-app-subscription-sign-ups","content":[" The Free-trial app subscription sign-ups metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Free-trial app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Free trial app subscription sign-ups"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-app-subscription-sign-ups","content":["Reporting Field ID: metric.freeTrialAppSubscriptionSignUps - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of free trial app subscription sign-ups attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appSubscriptionSignUpFreeTrial - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Free-trial app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per free trial app subscription sign-up"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-app-subscription-sign-ups","content":["Reporting Field ID: metric.costPerFreeTrialAppSubscriptionSignUp - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a free trial app subscription sign-up. Cost per free trial app subscription sign-up = total cost / free trial app subscription sign-ups - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): appSubscriptionFreeTrialCost - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Free-trial app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Free trial app subscription sign-up rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-app-subscription-sign-ups","content":["Reporting Field ID: metric.freeTrialAppSubscriptionSignUpRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of free trial app subscription sign-ups relative to ad impressions. Free trial app subscription sign-up rate = free trial app subscription sign-ups / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): appSubscriptionSignUpFreeTrialRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Free-trial app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Free trial app subscription sign-ups from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-app-subscription-sign-ups","content":["Reporting Field ID: metric.freeTrialAppSubscriptionSignUpsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of free trial app subscription sign-ups attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appSubscriptionSignUpFreeTrialClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Free-trial app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"Free trial app subscription sign-ups from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-app-subscription-sign-ups","content":["Reporting Field ID: metric.freeTrialAppSubscriptionSignUpsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of free trial app subscription sign-ups attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appSubscriptionSignUpFreeTrialViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Free-trial app subscription sign-ups (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/free-trial-app-subscription-sign-ups","content":[],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":[" The Appstore opens metric family contains 9 fields, listed below:\n"],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore opens"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":["Reporting Field ID: metric.appstoreOpens - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times shoppers opened an app, including first time and reopens, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreOpens - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per appstore open"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":["Reporting Field ID: metric.costPerAppstoreOpen - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The average cost to acquire an appstore open. Cost per appstore open = total cost / appstore opens - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPAppStoreOpens - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore open rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":["Reporting Field ID: metric.appstoreOpenRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The rate of appstore opens relative to ad impressions. Appstore open rate = appstore opens / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): appStoreOpensRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore opens from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":["Reporting Field ID: metric.appstoreOpensFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times shoppers opened an app, including first time and reopens attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreOpensClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore opens from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":["Reporting Field ID: metric.appstoreOpensFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times shoppers opened an app, including first time and reopens attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreOpensViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore usage hours"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":["Reporting Field ID: metric.appstoreUsageHours - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The total hours spent using an app during first-time and repeat sessions attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreUsageHours - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per appstore usage hour"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":["Reporting Field ID: metric.costPerAppstoreUsageHour - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The average cost to acquire an appstore usage hour. Cost per appstore usage hour = total cost / appstore usage hours - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore usage hours from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":["Reporting Field ID: metric.appstoreUsageHoursFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The total hours spent using an app the first time and during repeat sessions, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreUsageHoursClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore usage hours from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":["Reporting Field ID: metric.appstoreUsageHoursFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The total hours spent using an app the first time and during repeat sessions, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreUsageHoursViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Appstore opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-opens","content":[],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":[" The Appstore first opens metric family contains 9 fields, listed below:\n"],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore first opens"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":["Reporting Field ID: metric.appstoreFirstOpens - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of first time app opens attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreFirstOpens - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per appstore first open"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":["Reporting Field ID: metric.costPerAppstoreFirstOpen - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The average cost to acquire an appstore first open. Cost per appstore first open = total cost / appstore first opens - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPAppStoreFirstOpens - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore first open rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":["Reporting Field ID: metric.appstoreFirstOpenRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The rate of appstore first opens relative to ad impressions. Appstore first open rate = appstore opens / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): appStoreFirstOpensRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore first opens from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":["Reporting Field ID: metric.appstoreFirstOpensFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of first time app opens attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreFirstOpensClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore first opens from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":["Reporting Field ID: metric.appstoreFirstOpensFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of first time app opens attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreFirstOpensViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore first session hours"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":["Reporting Field ID: metric.appstoreFirstSessionHours - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The total hours shoppers spent using an app during first time app sessions attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreFirstSessionHours - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per appstore first session hour"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":["Reporting Field ID: metric.costPerAppstoreFirstSessionHour - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The average cost to acquire an appstore first session hour. Cost per appstore first session hour = total cost / appstore first session hours - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore first session hours from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":["Reporting Field ID: metric.appstoreFirstSessionHoursFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The total hours shoppers spent using an app during first time app sessions attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreFirstSessionHoursClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore first session hours from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":["Reporting Field ID: metric.appstoreFirstSessionHoursFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The total hours shoppers spent using an app during first time app sessions attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): appStoreFirstSessionHoursViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Appstore first opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-first-opens","content":[],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":[" The Appstore repeat opens metric family contains 9 fields, listed below:\n"],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore repeat opens"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":["Reporting Field ID: metric.appstoreRepeatOpens - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of repeat app opens attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per appstore repeat opens"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":["Reporting Field ID: metric.costPerAppstoreRepeatOpen - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The average cost to acquire an appstore repeat open. Cost per appstore repeat open = total cost / appstore repeat opens - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore repeat open rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":["Reporting Field ID: metric.appstoreRepeatOpenRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The rate of appstore repeat opens relative to ad impressions. Appstore repeat open rate = appstore repeat opens / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore repeat opens from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":["Reporting Field ID: metric.appstoreRepeatOpensFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of repeat app opens attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore repeat opens from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":["Reporting Field ID: metric.appstoreRepeatOpensFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of repeat app opens attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore repeat session hours"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":["Reporting Field ID: metric.appstoreRepeatSessionHours - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The total hours shoppers spent using an app during repeat sessions attributed to an ad interaction. This excludes the first session. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per appstore repeat session hour"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":["Reporting Field ID: metric.costPerAppstoreRepeatSessionHour - Data Type: DECIMAL - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The average cost to acquire an appstore repeat session hour. Cost per appstore repeat session hour = total cost / appstore repeat session hours - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore repeat session hours from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":["Reporting Field ID: metric.appstoreRepeatSessionHoursFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The total hours shoppers spent using an app during repeat sessions attributed to an ad click. This excludes the first session. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"Appstore repeat session hours from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":["Reporting Field ID: metric.appstoreRepeatSessionHoursFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The total hours shoppers spent using an app during repeat sessions attributed to an ad view. This excludes the first session. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Appstore repeat opens (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/appstore-repeat-opens","content":[],"documentType":"guide"},{"title":"Alexa skill enable (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-enable","content":[" The Alexa skill enable metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Alexa skill enable (Amazon device conversions)","sectionHeader":{"type":2,"text":"Alexa skill enable"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-enable","content":["Reporting Field ID: metric.alexaSkillEnable - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times a shopper enabled an Alexa skill, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): alexaSkillEnable - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Alexa skill enable (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per Alexa skill enable"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-enable","content":["Reporting Field ID: metric.costPerAlexaSkillEnable - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Amazon DSP - Description: The average cost to acquire an Alexa skill enable event. Cost per Alexa skill enable = total cost / Alexa skill enable - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPAlexaSkillEnable - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Alexa skill enable (Amazon device conversions)","sectionHeader":{"type":2,"text":"Alexa skill enable rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-enable","content":["Reporting Field ID: metric.alexaSkillEnableRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Amazon DSP - Description: The rate of Alexa skill enable events relative to ad impressions. Alexa skill enable rate = Alexa skill enable / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): alexaSkillEnableRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Alexa skill enable (Amazon device conversions)","sectionHeader":{"type":2,"text":"Alexa skill enable from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-enable","content":["Reporting Field ID: metric.alexaSkillEnableFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times a shopper enabled an Alexa skill, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): alexaSkillEnableClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Alexa skill enable (Amazon device conversions)","sectionHeader":{"type":2,"text":"Alexa skill enable from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-enable","content":["Reporting Field ID: metric.alexaSkillEnableFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times a shopper enabled an Alexa skill, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): alexaSkillEnableViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Alexa skill enable (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-enable","content":[],"documentType":"guide"},{"title":"Alexa skill invocations (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-invocations","content":[" The Alexa skill invocations metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Alexa skill invocations (Amazon device conversions)","sectionHeader":{"type":2,"text":"Alexa skill invocations"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-invocations","content":["Reporting Field ID: metric.alexaSkillInvocations - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times shoppers launched a promoted Alexa skill, attributed to an ad interaction. This can include tap, touch, and voice invocations. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): skillInvocation - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Alexa skill invocations (Amazon device conversions)","sectionHeader":{"type":2,"text":"Cost per Alexa skill invocation"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-invocations","content":["Reporting Field ID: metric.costPerAlexaSkillInvocation - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Amazon DSP - Description: The average cost to acquire an Alexa skill invocation. Cost per Alexa skill invocation = total cost / Alexa skill invocations - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPSkillInvocation - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Alexa skill invocations (Amazon device conversions)","sectionHeader":{"type":2,"text":"Alexa skill invocation rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-invocations","content":["Reporting Field ID: metric.alexaSkillInvocationRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Amazon DSP - Description: The rate of Alexa skill invocations relative to ad impressions. Alexa skill invocation rate = Alexa skill invocations / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): skillInvocationRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Alexa skill invocations (Amazon device conversions)","sectionHeader":{"type":2,"text":"Alexa skill invocations from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-invocations","content":["Reporting Field ID: metric.alexaSkillInvocationsFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times shoppers launched a promoted Alexa skill, attributed to an ad click. This can include tap, touch, and voice invocations. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): skillInvocationClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Alexa skill invocations (Amazon device conversions)","sectionHeader":{"type":2,"text":"Alexa skill invocations from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-invocations","content":["Reporting Field ID: metric.alexaSkillInvocationsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times shoppers launched a promoted Alexa skill, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): skillInvocationViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Alexa skill invocations (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/alexa-skill-invocations","content":[],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":[" The Kindle Edition Normalized Pages read metric family contains 9 fields, listed below:\n"],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":{"type":2,"text":"KENP read"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":["Reporting Field ID: metric.kindleEditionNormalizedPagesRead - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): kindleEditionNormalizedPagesRead, kindleEditionNormalizedPagesRead14d\n"],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":{"type":2,"text":"KENP read from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":["Reporting Field ID: metric.kindleEditionNormalizedPagesReadFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): kindleEditionNormalizedPagesReadFromClicks\n"],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":{"type":2,"text":"KENP read from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":["Reporting Field ID: metric.kindleEditionNormalizedPagesReadFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): kindleEditionNormalizedPagesReadFromViews\n"],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":{"type":2,"text":"KENP read (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":["Reporting Field ID: metric.kindleEditionNormalizedPagesReadPromoted - Data Type: LONG - Description: The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for books directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":{"type":2,"text":"KENP read from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":["Reporting Field ID: metric.kindleEditionNormalizedPagesReadFromClicksPromoted - Data Type: LONG - Description: The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for books directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":{"type":2,"text":"KENP read from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":["Reporting Field ID: metric.kindleEditionNormalizedPagesReadFromViewsPromoted - Data Type: LONG - Description: The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for books directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":{"type":2,"text":"KENP read (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":["Reporting Field ID: metric.kindleEditionNormalizedPagesReadHalo - Data Type: LONG - Description: The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for highly relevant books that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":{"type":2,"text":"KENP read from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":["Reporting Field ID: metric.kindleEditionNormalizedPagesReadFromClicksHalo - Data Type: LONG - Description: The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for highly relevant books that were not directly promoted in the campaign, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":{"type":2,"text":"KENP read from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":["Reporting Field ID: metric.kindleEditionNormalizedPagesReadFromViewsHalo - Data Type: LONG - Description: The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for highly relevant books that were not directly promoted in the campaign, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Kindle Edition Normalized Pages read (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-edition-normalized-pages-read","content":[],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":[" The Kindle Unlimited qualified borrows metric family contains 27 fields, listed below:\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Kindle Unlimited qualified borrows"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.kindleUnlimitedQualifiedBorrows - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times a Kindle Unlimited user downloaded a book and read enough pages to qualify for a royalty payment, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): qualifiedBorrows\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated Kindle Unlimited royalties"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyalties - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows attributed to an ad interaction. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.estimatedKindleUnlimitedRoyaltiesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): royaltyQualifiedBorrows\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated Kindle Unlimited royalties (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows attributed to an ad interaction. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"KU qualified borrows from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.kindleUnlimitedQualifiedBorrowsFromClicks - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times a Kindle Unlimited user downloaded a book and read enough pages to qualify for a royalty payment, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): qualifiedBorrowsFromViews\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromClicks - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): royaltyQualifiedBorrowsFromClicks\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from clicks (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromClicksConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"KU qualified borrows from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.kindleUnlimitedQualifiedBorrowsFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: The number of times a Kindle Unlimited user downloaded a book and read enough pages to qualify for a royalty payment, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): qualifiedBorrowsFromClicks\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromViews - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows attributed to an ad view. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): royaltyQualifiedBorrowsFromViews\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from views (converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromViewsConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Kindle Unlimited qualified borrows (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.kindleUnlimitedQualifiedBorrowsPromoted - Data Type: LONG - Description: The number of times a Kindle Unlimited user downloaded a book that was directly promoted in the campaign and met the page-read threshold for a royalty, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated Kindle Unlimited royalties (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesPromoted - Data Type: CURRENCY - Description: Estimated Kindle Unlimited royalties for qualified borrows of books that were directly promoted in the campaign, attributed to an ad interaction. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated Kindle Unlimited royalties (promoted, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows of books that were directly promoted in the campaign, attributed to an ad interaction. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"KU qualified borrows from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted - Data Type: LONG - Description: The number of times a Kindle Unlimited user downloaded a book that was directly promoted in the campaign and met the page-read threshold for a royalty, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from clicks (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted - Data Type: CURRENCY - Description: Estimated Kindle Unlimited royalties for qualified borrows of books that were directly promoted in the campaign, attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from clicks (promoted, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows of books that were directly promoted in the campaign, attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"KU qualified borrows from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted - Data Type: LONG - Description: The number of times a Kindle Unlimited user downloaded a book that was directly promoted in the campaign and met the page-read threshold for a royalty, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from views (promoted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted - Data Type: CURRENCY - Description: Estimated Kindle Unlimited royalties for qualified borrows of books that were directly promoted in the campaign, attributed to an ad view. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from views (promoted, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromotedConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows of books that were directly promoted in the campaign, attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Kindle Unlimited qualified borrows (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.kindleUnlimitedQualifiedBorrowsHalo - Data Type: LONG - Description: The number of Kindle Unlimited downloads for highly relevant books not directly promoted in the campaign that met the page-read threshold for a royalty, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated Kindle Unlimited royalties (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesHalo - Data Type: CURRENCY - Description: Estimated Kindle Unlimited royalties for qualified borrows of highly relevant books that were not directly promoted in the campaign, attributed to an ad interaction. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.estimatedKindleUnlimitedRoyaltiesHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated Kindle Unlimited royalties (halo, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows of highly relevant books that were not directly promoted in the campaign, attributed to an ad interaction. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"KU qualified borrows from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo - Data Type: LONG - Description: The number of Kindle Unlimited downloads for highly relevant books not directly promoted in the campaign that met the page-read threshold for a royalty, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from clicks (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo - Data Type: CURRENCY - Description: Estimated Kindle Unlimited royalties for qualified borrows of highly relevant books that were not directly promoted in the campaign, attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from clicks (halo, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromClicksHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows of highly relevant books that were not directly promoted in the campaign, attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"KU qualified borrows from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo - Data Type: LONG - Description: The number of Kindle Unlimited downloads for highly relevant books not directly promoted in the campaign that met the page-read threshold for a royalty, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from views (halo)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo - Data Type: CURRENCY - Description: Estimated Kindle Unlimited royalties for qualified borrows of highly relevant books that were not directly promoted in the campaign, attributed to an ad view. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"Estimated KU royalties from views (halo, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":["Reporting Field ID: metric.estimatedKindleUnlimitedRoyaltiesFromViewsHaloConverted - Data Type: CURRENCY - Program eligibility: Sponsored Brands, Sponsored Display, Amazon DSP - Description: Estimated Kindle Unlimited royalties for qualified borrows of highly relevant books that were not directly promoted in the campaign, attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Kindle Unlimited qualified borrows (Amazon device conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-device-conversions/kindle-unlimited-qualified-borrows","content":[],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":[" The User reach metric family contains 13 fields, listed below:\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User reach"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userReach - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to an ad. For streaming TV ads, co-viewers are included in the user reach calculation. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Supply source, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Targeting, Targeting match type - Version 3 Reporting Name (DSP): reach - Version 3 Reporting Name (Sponsored Ads): cumulativeReach, reach\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"Average user impression frequency"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.averageUserImpressionFrequency - Data Type: DECIMAL - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The average number of ads exposed to each unique user. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Supply source, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Targeting, Targeting match type - Version 3 Reporting Name (DSP): frequencyAverage - Version 3 Reporting Name (Sponsored Ads): impressionsFrequencyAverage, frequencyAverage\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"Exclusive user reach rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.exclusiveUserReachRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of unique viewers reached by a streaming TV inventory that were not reached by any other streaming TV inventory in the campaign. Exclusive user reach rate = 100 x (exclusive reach for streaming TV inventory / total streaming TV reach). - Required fields: supplySource.name 📎 - Complementary fields: N/A - Compatible dimensions: Ad product, Advertiser account, Budget currency, Converted currency, Date, Date range, Day of month, Day of week, Month, Supply source, Week, Year - Incompatible dimensions: Ad, Ad group, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Targeting, Targeting match type - Version 3 Reporting Name (DSP): amazonExclusiveReachRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User frequency (1)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userFrequency1 - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to ads 1 time. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User frequency (2)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userFrequency2 - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to ads 2 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User frequency (3)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userFrequency3 - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to ads 3 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User frequency (4)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userFrequency4 - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to ads 4 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User frequency (5)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userFrequency5 - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to ads 5 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User frequency (6)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userFrequency6 - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to ads 6 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User frequency (7)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userFrequency7 - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to ads 7 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User frequency (8)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userFrequency8 - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to ads 8 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User frequency (9)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userFrequency9 - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to ads 9 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"User frequency (10+)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":["Reporting Field ID: metric.userFrequency10Plus - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique users exposed to ads 10 or more times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Frequency group, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"User reach (Reach)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/user-reach","content":[],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":[" The Household reach metric family contains 12 fields, listed below:\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household reach"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdReach - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): householdReach - Version 3 Reporting Name (Sponsored Ads): householdReach\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Average household impression frequency"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.averageHouseholdImpressionFrequency - Data Type: DECIMAL - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The average number of times a household was exposed to streaming TV ads. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): householdFrequencyAverage - Version 3 Reporting Name (Sponsored Ads): householdFrequencyAverage\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household frequency (1)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdFrequency1 - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads 1 time. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household frequency (2)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdFrequency2 - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads 2 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household frequency (3)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdFrequency3 - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads 3 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household frequency (4)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdFrequency4 - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads 4 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household frequency (5)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdFrequency5 - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads 5 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household frequency (6)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdFrequency6 - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads 6 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household frequency (7)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdFrequency7 - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads 7 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household frequency (8)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdFrequency8 - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads 8 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household frequency (9)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdFrequency9 - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads 9 times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"Household frequency (10+)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":["Reporting Field ID: metric.householdFrequency10Plus - Data Type: LONG - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of unique households exposed to streaming TV ads 10 or more times. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Household reach (Reach)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/household-reach","content":[],"documentType":"guide"},{"title":"Incremental reach (linear TV) (Reach)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/reach/incremental-reach-linear-tv","content":[" The Incremental reach (linear TV) metric family contains 2 fields, listed below:\n"],"documentType":"guide"},{"title":"Incremental reach (linear TV) (Reach)","sectionHeader":{"type":2,"text":"Exclusive reach rate (linear TV)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/incremental-reach-linear-tv","content":["Reporting Field ID: metric.exclusiveReachRateLinearTV - Data Type: PERCENTAGE - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of streaming TV reach that wasn't exposed to a linear TV campaign. Exclusive reach rate (linear TV) = 100 x (streaming TV reach - linear TV duplicates) / streaming TV reach. - Required fields: campaign.id 📎 - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): exclusiveLTVReachRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Incremental reach (linear TV) (Reach)","sectionHeader":{"type":2,"text":"Incremental reach rate (linear TV)"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/incremental-reach-linear-tv","content":["Reporting Field ID: metric.incrementalReachRateLinearTV - Data Type: PERCENTAGE - Program eligibility: Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of unique households reached on streaming TV compared to linear TV. Households included in linear TV reach aren't counted in streaming TV reach. Incremental reach rate (linear TV) = 100 x (streaming TV reach - linear TV duplicates) / linear TV reach - Required fields: campaign.id 📎 - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): incrementalLTVReachRate - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Incremental reach (linear TV) (Reach)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/reach/incremental-reach-linear-tv","content":[],"documentType":"guide"},{"title":"Add to watchlist (Amazon video conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/add-to-watchlist","content":[" The Add to watchlist metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Add to watchlist (Amazon video conversions)","sectionHeader":{"type":2,"text":"Add to watchlist"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/add-to-watchlist","content":["Reporting Field ID: metric.addToWatchlist - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper added a product to their watchlist attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToWatchlist - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to watchlist (Amazon video conversions)","sectionHeader":{"type":2,"text":"Cost per add to watchlist"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/add-to-watchlist","content":["Reporting Field ID: metric.costPerAddToWatchlist - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire an add-to-watchlist event. Cost per add to watchlist = total cost / add to watchlist - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPAddToWatchlist - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to watchlist (Amazon video conversions)","sectionHeader":{"type":2,"text":"Add to watchlist rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/add-to-watchlist","content":["Reporting Field ID: metric.addToWatchlistRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of add to watchlist relative to ad impressions. Add to watchlist rate = add to watchlist / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): addToWatchlistRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to watchlist (Amazon video conversions)","sectionHeader":{"type":2,"text":"Add to watchlist from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/add-to-watchlist","content":["Reporting Field ID: metric.addToWatchlistFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper added a product to their watchlist, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToWatchlistClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to watchlist (Amazon video conversions)","sectionHeader":{"type":2,"text":"Add to watchlist from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/add-to-watchlist","content":["Reporting Field ID: metric.addToWatchlistFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a shopper added a product to their watchlist, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToWatchlistViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Add to watchlist (Amazon video conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/add-to-watchlist","content":[],"documentType":"guide"},{"title":"Downloaded video plays (Amazon video conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/downloaded-video-plays","content":[" The Downloaded video plays metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Downloaded video plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Downloaded video plays"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/downloaded-video-plays","content":["Reporting Field ID: metric.downloadedVideoPlays - Data Type: LONG - Program eligibility: Sponsored Products, Amazon DSP - Description: The number of times a shopper downloaded and played a video product attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): downloadedVideoPlays - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Downloaded video plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Cost per downloaded video play"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/downloaded-video-plays","content":["Reporting Field ID: metric.costPerDownloadedVideoPlay - Data Type: DECIMAL - Program eligibility: Sponsored Products, Amazon DSP - Description: The average cost to acquire a downloaded video play. Cost per downloaded video play = total cost / downloaded video plays - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPDownloadedVideoPlays - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Downloaded video plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Downloaded video play rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/downloaded-video-plays","content":["Reporting Field ID: metric.downloadedVideoPlayRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Amazon DSP - Description: The rate of downloaded video plays relative to ad impressions. Downloaded video play rate = downloaded video plays / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): downloadedVideoPlayRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Downloaded video plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Downloaded video plays from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/downloaded-video-plays","content":["Reporting Field ID: metric.downloadedVideoPlaysFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Amazon DSP - Description: The number of times a shopper downloaded and played a video product, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): downloadedVideoPlaysClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Downloaded video plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Downloaded video play from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/downloaded-video-plays","content":["Reporting Field ID: metric.downloadedVideoPlaysFromViews - Data Type: LONG - Program eligibility: Amazon DSP - Description: The number of times a shopper downloaded and played a video product, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): downloadedVideoPlaysViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Downloaded video plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/downloaded-video-plays","content":[],"documentType":"guide"},{"title":"Rentals (Amazon video conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/rentals","content":[" The Rentals metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Rentals (Amazon video conversions)","sectionHeader":{"type":2,"text":"Rentals"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/rentals","content":["Reporting Field ID: metric.rentals - Data Type: LONG - Program eligibility: Sponsored Products, Amazon DSP - Description: The number of times a shopper rented a video attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): rentals - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Rentals (Amazon video conversions)","sectionHeader":{"type":2,"text":"Cost per rental"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/rentals","content":["Reporting Field ID: metric.costPerRental - Data Type: DECIMAL - Program eligibility: Sponsored Products, Amazon DSP - Description: The average cost to acquire a rental event. Cost per rental = total cost / rentals - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPRental - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Rentals (Amazon video conversions)","sectionHeader":{"type":2,"text":"Rental rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/rentals","content":["Reporting Field ID: metric.rentalRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Amazon DSP - Description: The rate of rentals relative to ad impressions. Rental rate = rentals / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): rentalRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Rentals (Amazon video conversions)","sectionHeader":{"type":2,"text":"Rentals from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/rentals","content":["Reporting Field ID: metric.rentalsFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Amazon DSP - Description: The number of times a shopper rented a video, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): rentalsClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Rentals (Amazon video conversions)","sectionHeader":{"type":2,"text":"Rentals from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/rentals","content":["Reporting Field ID: metric.rentalsFromViews - Data Type: LONG - Program eligibility: Amazon DSP - Description: The number of times a shopper rented a video, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): rentalsViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Rentals (Amazon video conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/rentals","content":[],"documentType":"guide"},{"title":"Trailer plays (Amazon video conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/trailer-plays","content":[" The Trailer plays metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Trailer plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Trailer plays"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/trailer-plays","content":["Reporting Field ID: metric.trailerPlays - Data Type: LONG - Program eligibility: Sponsored Products, Amazon DSP - Description: The number of times a shopper played a video trailer attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): playTrailers - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Trailer plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Cost per trailer play"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/trailer-plays","content":["Reporting Field ID: metric.costPerTrailerPlay - Data Type: DECIMAL - Program eligibility: Sponsored Products, Amazon DSP - Description: The average cost to acquire a trailer play. Cost per trailer play = total cost / trailer plays - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPPlayTrailer - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Trailer plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Trailer play rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/trailer-plays","content":["Reporting Field ID: metric.trailerPlayRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Amazon DSP - Description: The rate of trailer plays relative to ad impressions. Trailer play rate = trailer plays / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): playTrailerRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Trailer plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Trailer plays from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/trailer-plays","content":["Reporting Field ID: metric.trailerPlaysFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Amazon DSP - Description: The number of times a shopper played a video trailer, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): playTrailersClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Trailer plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Trailer plays from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/trailer-plays","content":["Reporting Field ID: metric.trailerPlaysFromViews - Data Type: LONG - Program eligibility: Amazon DSP - Description: The number of times a shopper played a video trailer, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): playTrailersViews - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Trailer plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/trailer-plays","content":[],"documentType":"guide"},{"title":"Video stream plays (Amazon video conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/video-stream-plays","content":[" The Video stream plays metric family contains 5 fields, listed below:\n"],"documentType":"guide"},{"title":"Video stream plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Video stream plays"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/video-stream-plays","content":["Reporting Field ID: metric.videoStreamPlays - Data Type: LONG - Program eligibility: Sponsored Products, Amazon DSP - Description: The number of times a shopper streamed a video, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): videoStreams - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Video stream plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Cost per video stream play"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/video-stream-plays","content":["Reporting Field ID: metric.costPerVideoStreamPlay - Data Type: DECIMAL - Program eligibility: Sponsored Products, Amazon DSP - Description: The average cost to acquire a video stream play. Cost per video stream play = total cost / video stream plays - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPVideoStream - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Video stream plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Video stream play rate"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/video-stream-plays","content":["Reporting Field ID: metric.videoStreamPlayRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Amazon DSP - Description: The rate of downloaded video plays relative to ad impressions. Downloaded video play rate = downloaded video plays / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoStreamsRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Video stream plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Video stream plays from clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/video-stream-plays","content":["Reporting Field ID: metric.videoStreamPlaysFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Amazon DSP - Description: The number of times a shopper streamed a video, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): videoStreamsClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Video stream plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"Video stream play from views"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/video-stream-plays","content":["Reporting Field ID: metric.videoStreamPlaysFromViews - Data Type: LONG - Program eligibility: Amazon DSP - Description: The number of times a shopper streamed a video, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Video stream plays (Amazon video conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/amazon-video-conversions/video-stream-plays","content":[],"documentType":"guide"},{"title":"Search (Impression share)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/impression-share/search","content":[" The Search metric family contains 3 fields, listed below:\n"],"documentType":"guide"},{"title":"Search (Impression share)","sectionHeader":{"type":2,"text":"Impression share rank"},"path":"/en-us/guides/reporting/ads-v1/metrics/impression-share/search","content":["Reporting Field ID: metric.impressionShareRank - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands - Description: The numeric rank of your account-wide impression share compared to all other advertisers. - Required fields: adProduct.value 📎, advertiserAccount.id 📎, searchTerm.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad product, Advertiser account, Budget currency, Converted currency, Date, Date range, Day of month, Day of week, Month, Search term, Week, Year - Incompatible dimensions: Ad, Ad group, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Search (Impression share)","sectionHeader":{"type":2,"text":"Impression share"},"path":"/en-us/guides/reporting/ads-v1/metrics/impression-share/search","content":["Reporting Field ID: metric.impressionShare - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands - Description: The percentage share of all your impressions compared to all other advertisers. - Required fields: adProduct.value 📎, advertiserAccount.id 📎, searchTerm.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad product, Advertiser account, Budget currency, Converted currency, Date, Date range, Day of month, Day of week, Month, Search term, Week, Year - Incompatible dimensions: Ad, Ad group, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, Campaign, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Search (Impression share)","sectionHeader":{"type":2,"text":"Top-of-search impression share"},"path":"/en-us/guides/reporting/ads-v1/metrics/impression-share/search","content":["Reporting Field ID: metric.topOfSearchImpressionShare - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands - Description: The percentage of impressions that appeared in top search results compared to the number of times they were eligible to appear in top search results. - Required fields: adProduct.value 📎, advertiserAccount.id 📎 - Complementary fields: N/A - Compatible dimensions: Ad product, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Month, Week, Year - Incompatible dimensions: Ad, Ad group, Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Insertion order, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Interaction (Engagement)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/interaction","content":[" The Interaction metric family contains 3 fields, listed below:\n"],"documentType":"guide"},{"title":"Interaction (Engagement)","sectionHeader":{"type":2,"text":"Interactive impressions"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/interaction","content":["Reporting Field ID: metric.interactiveImpressions - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The unique number of impressions from an interactive creative. This can include interactive videos, interactive audios, interactive display creatives, etc. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): interactiveImpressions - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Interaction (Engagement)","sectionHeader":{"type":2,"text":"Notification opens"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/interaction","content":["Reporting Field ID: metric.notificationOpens - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times emails or push notifications were opened per impression. Pre-rendered emails can be counted as opening a notification. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): notificationOpens - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Interaction (Engagement)","sectionHeader":{"type":2,"text":"Notification clicks"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/interaction","content":["Reporting Field ID: metric.notificationClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The unique number of clicks from an email or push notification per impression. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): notificationClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Interaction (Engagement)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/interaction","content":[],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":[" The Attention (video ad) metric family contains 17 fields, listed below:\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Starts (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.startsVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a video ad was played. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdStart - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"First quartile (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.firstQuartileVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times at least 25% of a video ad was played. If the ad was rewound, we use the total percentage of unduplicated video that was viewed to calculate the completion rate. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdFirstQuartile - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Midpoint (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.midpointVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times at least 50% of a video ad was played. If the ad was rewound, we use the total percentage of unduplicated video that was viewed to calculate the completion rate. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdMidpoint - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Third quartile (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.thirdQuartileVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times at least 75% of a video ad was played. If the ad was rewound, we use the total percentage of unduplicated video that was viewed to calculate the completion rate. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdThirdQuartile - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Complete views (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.completeViewsVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a video ad was played till the end. If the ad was rewound, we use the total percentage of unduplicated video that was viewed to calculate the completion rate. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdComplete - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Completion rate (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.completionRateVideoAd - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of video completions relative to the number of video starts. Completion rate (video) = complete views (video) / starts (video) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdCompletionRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Cost per completed view (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.costPerCompletedViewVideoAd - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a video completion. Cost per completed view (video)  = total cost / complete views (video) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPVideoAdCompletion - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Pauses (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.pausesVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user paused a video ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdPause - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Resumes (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.resumesVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user resumed playing a video ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdResume - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Mutes (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.mutesVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user muted a video ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdMute - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Unmutes (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.unmutesVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user unmuted a video ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdUnmute - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Replays (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.replaysVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user replayed a video ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdReplays - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Skips backs (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.skipsBackVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user skipped back a video ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdSkipBacks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Skips forward (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.skipsForwardVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user skipped forward a video ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdSkipForwards - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"Impressions (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.impressionsVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a video ad was displayed. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): videoAdImpressions - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"5-second views (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.5secondViewsVideoAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user watched at least 5 seconds of a video ad or the entire ad if it was shorter than 5 seconds. This is only available for Sponsored Brands video ads. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): video5SecondViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"5-second view rate (video ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":["Reporting Field ID: metric.5secondViewRateVideoAd - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The percentage of impressions where a user watched at least 5 seconds of a video ad or the entire ad if it was shorter than 5 seconds. This is only available for Sponsored Brands video ads. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): video5SecondViewRate - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Attention (video ad) (Engagement)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-video-ad","content":[],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":[" The Attention (audio ad) metric family contains 16 fields, listed below:\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Starts (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.startsAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times an audio ad was played. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdStart - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"First quartile (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.firstQuartileAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times at least 25% of an audio ad was played. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdFirstQuartile - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Midpoint (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.midpointAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times at least 50% of an audio ad was played. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdMidpoint - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Third quartile (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.thirdQuartileAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times at least 75% of an audio ad was played. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdThirdQuartile - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Complete listens (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.completeListensAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times an audio ad was played till the end. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdCompletions - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Completion rate (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.completionRateAudioAd - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of audio completions relative to the number of audio starts. Completion rate (audio) = complete listens (audio) / starts (audio) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdCompletionRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Cost per completed listen (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.costPerCompletedListenAudioAd - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire an audio completion. Cost per completed listen (audio) = total cost / complete listens (audio) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): eCPAudioAdCompletion - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Pauses (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.pausesAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user paused an audio ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdPause - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Resumes (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.resumesAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user resumed playing an audio ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdResume - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Mutes (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.mutesAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user muted an audio ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdMute - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Unmutes (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.unmutesAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user unmuted an audio ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdUnmute - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Rewinds (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.rewindsAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user rewinded an audio ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdRewind - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Skips (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.skipsAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times a user skipped an audio ad. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdSkip - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Impressions (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.impressionsAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times an audio ad was served. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdImpression - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Plays (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.playsAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times an audio ad was played for 2 seconds or longer. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"Progress (audio ad)"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":["Reporting Field ID: metric.progressAudioAd - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of times an audio ad was played until the time marker assigned by the publisher. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): audioAdProgression - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Attention (audio ad) (Engagement)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/engagement/attention-audio-ad","content":[],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":[" The Conversions (off-Amazon) metric family contains 9 fields, listed below:\n"],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Conversions (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":["Reporting Field ID: metric.offAmazonConversions - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of conversions that occurred off-Amazon attributed to an ad interaction. This includes all off-Amazon conversion types. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property - Version 3 Reporting Name (DSP): offAmazonConversions - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Conversions (off-Amazon, optimized)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":["Reporting Field ID: metric.offAmazonConversionsOptimized - Data Type: LONG - Description: The number of conversions that occurred off Amazon, attributed to an ad interaction, based on the conversion events selected for optimization. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per conversion (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerConversion - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon conversion. This includes all off-Amazon conversion types. Cost per conversion (off-Amazon) = total cost / conversions (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): offAmazonCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Conversion rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":["Reporting Field ID: metric.offAmazonConversionRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon conversions relative to the number of ad impressions. This includes all off-Amazon conversion types. Conversion rate  (off-Amazon) = conversions (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): offAmazonCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Conversions from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":["Reporting Field ID: metric.offAmazonConversionsFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon conversions attributed to an ad click. This includes all off-Amazon conversion types. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property - Version 3 Reporting Name (DSP): offAmazonClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Conversions from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":["Reporting Field ID: metric.offAmazonConversionsFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon conversions attributed to an ad view. This includes all off-Amazon conversion types. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property - Version 3 Reporting Name (DSP): offAmazonViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Conversions value sum (off-Amazon, optimized)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":["Reporting Field ID: metric.offAmazonConversionsValueSumOptimized - Data Type: LONG - Description: Sum of values associated with conversions off-Amazon, based on the conversion events selected for optimization. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Conversions value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":["Reporting Field ID: metric.offAmazonConversionsValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: Sum of values associated with conversions off-Amazon. - Required fields: offAmazonConversionDefinition.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Ad product, Advertiser account, Budget currency, Campaign, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Date, Date range, Day of month, Day of week, Insertion order, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Portfolio, Week, Year - Incompatible dimensions: Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Operating system, Placement, Placement classification, Placement size, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Conversions value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":["Reporting Field ID: metric.offAmazonConversionsValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with conversions off-Amazon. Conversions value average (off-Amazon) = conversions value sum (off-Amazon) / conversions (off-Amazon). - Required fields: offAmazonConversionDefinition.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Ad product, Advertiser account, Budget currency, Campaign, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Date, Date range, Day of month, Day of week, Insertion order, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Portfolio, Week, Year - Incompatible dimensions: Target, Advertised product, Advertised product marketplace, Advertised product SKU, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Hour, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Operating system, Placement, Placement classification, Placement size, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Conversions (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/conversions-off-amazon","content":[],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":[" The Purchases (off-Amazon) metric family contains 22 fields, listed below:\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Purchases (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonPurchases - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon purchases attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): offAmazonPurchases - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sales (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonSales - Data Type: CURRENCY - Program eligibility: Sponsored TV, Amazon DSP - Description: The sales from off-Amazon purchases attributed to an ad interaction. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.offAmazonSalesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sales (off-Amazon, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonSalesConverted - Data Type: CURRENCY - Program eligibility: Sponsored TV, Amazon DSP - Description: The sales from off-Amazon purchases attributed to an ad interaction. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sales (off-Amazon, optimized)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonSalesOptimized - Data Type: CURRENCY - Description: The sales from off-Amazon purchases attributed to an ad interaction, included only when purchases are configured as the optimization event. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.offAmazonSalesOptimizedConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sales (off-Amazon, optimized, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonSalesOptimizedConverted - Data Type: CURRENCY - Description: The sales from off-Amazon purchases attributed to an ad interaction, included only when purchases are configured as the optimization event. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Units sold (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonUnitsSold - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of product units in off-Amazon purchases, attributed to an ad interaction. A single purchase event can include multiple units of the same product. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property - Version 3 Reporting Name (DSP): offAmazonUnitsSold - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per purchase (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerPurchase - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon purchase conversion. Cost per purchase (off-Amazon) = total cost / purchases (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): offAmazonECPP - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Purchase rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonPurchaseRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon purchases relative to ad impressions. Purchase rate (off-Amazon) = purchases (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): offAmazonPurchaseRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Return per thousand impressions (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonReturnPerThousandImpressions - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: Off-Amazon sales per thousand ad impressions. Return per thousand impressions (off-Amazon) = sales (off-Amazon) / (impressions / 1,000) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): offAmazonERPM - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"ROAS (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonRoas - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: Return on ad spend for off-Amazon sales, calculated as attributed off-Amazon sales per unit of ad spend. ROAS (off-Amazon) = sales (off-Amazon) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): offAmazonROAS - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"ROAS (off-Amazon, reconciled)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonRoasReconciled - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: Return on ad spend for off-Amazon sales after reconciliation, calculated as attributed off-Amazon sales per unit of reconciled ad spend. ROAS (off-Amazon, reconciled) = sales (off-Amazon) / total cost (reconciled) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Hour, Insertion order, Month, Placement, Placement size, Portfolio, Site or app, Supply source, Week, Year - Incompatible dimensions: Ad, Target, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement classification, Postal code, Product relevance, Region, Search term, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonPurchasesFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon purchases attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): offAmazonPurchasesClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonSalesFromClicks - Data Type: CURRENCY - Program eligibility: Sponsored TV, Amazon DSP - Description: The sales from off-Amazon purchases attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.offAmazonSalesFromClicksConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (off-Amazon, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonSalesFromClicksConverted - Data Type: CURRENCY - Program eligibility: Sponsored TV, Amazon DSP - Description: The sales from off-Amazon purchases attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"ROAS from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonRoasFromClicks - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: Return on ad spend for click-attributed off-Amazon sales, calculated as off-Amazon sales from clicks per unit of ad spend. ROAS from clicks (off-Amazon) = sales from clicks (off-Amazon) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Purchases from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonPurchasesFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon purchases attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): offAmazonPurchasesViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sales from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonSalesFromViews - Data Type: CURRENCY - Program eligibility: Sponsored TV, Amazon DSP - Description: The sales from off-Amazon purchases attributed to an ad view. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.offAmazonSalesFromViewsConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonUnitsSoldFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of product units in off-Amazon purchases, attributed to an ad click. A single purchase event can include multiple units of the same product. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sales from views (off-Amazon, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonSalesFromViewsConverted - Data Type: CURRENCY - Program eligibility: Sponsored TV, Amazon DSP - Description: The sales from off-Amazon purchases attributed to an ad view. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per purchase from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerPurchaseFromClicks - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire a click-attributed off-Amazon purchase conversion. Cost per purchase from clicks (off-Amazon) = total cost / purchases from clicks (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Units sold from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonUnitsSoldFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of product units in off-Amazon purchases, attributed to an ad view. A single purchase event may include multiple units of the same product. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"ROAS from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":["Reporting Field ID: metric.offAmazonRoasFromViews - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: Return on ad spend for view-attributed off-Amazon sales, calculated as off-Amazon sales from views per unit of ad spend. ROAS from views (off-Amazon) = sales from view (off-Amazon) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Purchases (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/purchases-off-amazon","content":[],"documentType":"guide"},{"title":"Add to shopping cart (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/add-to-shopping-cart-off-amazon","content":[" The Add to shopping cart (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Add to shopping cart (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Add to shopping cart (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/add-to-shopping-cart-off-amazon","content":["Reporting Field ID: metric.offAmazonAddToShoppingCart - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon add to shopping cart conversions attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToShoppingCart - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to shopping cart (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Add to shopping cart rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/add-to-shopping-cart-off-amazon","content":["Reporting Field ID: metric.offAmazonAddToShoppingCartRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon add to shopping cart conversions relative to the number of ad impressions. Add to shopping cart rate (off-Amazon) = add to shopping cart (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): addToShoppingCartCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to shopping cart (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per add to shopping cart (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/add-to-shopping-cart-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerAddToShoppingCart - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon add to shopping cart conversion. Cost per add to shopping cart (off-Amazon) = total cost / add to shopping cart (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): addToShoppingCartCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to shopping cart (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Add to shopping cart from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/add-to-shopping-cart-off-amazon","content":["Reporting Field ID: metric.offAmazonAddToShoppingCartFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon add to shopping cart conversions attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToShoppingCartClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to shopping cart (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Add to shopping cart from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/add-to-shopping-cart-off-amazon","content":["Reporting Field ID: metric.offAmazonAddToShoppingCartFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon add to shopping cart conversions attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): addToShoppingCartViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to shopping cart (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Add to shopping cart value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/add-to-shopping-cart-off-amazon","content":["Reporting Field ID: metric.offAmazonAddToShoppingCartValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with off-Amazon add to shopping cart conversions. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): addToShoppingCartValueSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Add to shopping cart (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Add to shopping cart value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/add-to-shopping-cart-off-amazon","content":["Reporting Field ID: metric.offAmazonAddToShoppingCartValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with an off-Amazon add to shopping cart conversion. Add to shopping cart value average (off-Amazon) = add to shopping cart value sum (off-Amazon) / add to shopping cart (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): addToShoppingCartValueAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Add to shopping cart (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/add-to-shopping-cart-off-amazon","content":[],"documentType":"guide"},{"title":"Applications (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/applications-off-amazon","content":[" The Applications (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Applications (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Applications (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/applications-off-amazon","content":["Reporting Field ID: metric.offAmazonApplications - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of applications that occurred off Amazon attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): application - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Applications (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Application rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/applications-off-amazon","content":["Reporting Field ID: metric.offAmazonApplicationRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of applications relative to ad impressions. Application rate (off-Amazon) = applications (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): applicationCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Applications (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per application (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/applications-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerApplication - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon application. Cost per application (off-Amazon) = total cost / applications (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): applicationCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Applications (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Applications from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/applications-off-amazon","content":["Reporting Field ID: metric.offAmazonApplicationsFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of applications that occurred off Amazon attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): applicationClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Applications (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Applications from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/applications-off-amazon","content":["Reporting Field ID: metric.offAmazonApplicationsFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of applications that occurred off Amazon attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): applicationViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Applications (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Applications value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/applications-off-amazon","content":["Reporting Field ID: metric.offAmazonApplicationsValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with off-Amazon applications. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): applicationValueSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Applications (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Applications value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/applications-off-amazon","content":["Reporting Field ID: metric.offAmazonApplicationsValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with an off-Amazon application. Applications value average (off-Amazon) = applications value sum (off-Amazon) / applications (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): applicationValueAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Applications (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/applications-off-amazon","content":[],"documentType":"guide"},{"title":"Checkouts (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/checkouts-off-amazon","content":[" The Checkouts (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Checkouts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Checkouts (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/checkouts-off-amazon","content":["Reporting Field ID: metric.offAmazonCheckouts - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon checkouts attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): checkout - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Checkouts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Checkout rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/checkouts-off-amazon","content":["Reporting Field ID: metric.offAmazonCheckoutRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon checkouts relative to ad impressions. Checkout rate (off-Amazon) = checkouts (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): checkoutCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Checkouts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per checkout (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/checkouts-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerCheckout - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon checkout. Cost per checkout (off-Amazon) = total cost / checkouts (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): checkoutCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Checkouts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Checkouts from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/checkouts-off-amazon","content":["Reporting Field ID: metric.offAmazonCheckoutsFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon checkouts attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): checkoutClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Checkouts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Checkouts from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/checkouts-off-amazon","content":["Reporting Field ID: metric.offAmazonCheckoutsFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon checkouts attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): checkoutViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Checkouts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Checkouts value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/checkouts-off-amazon","content":["Reporting Field ID: metric.offAmazonCheckoutsValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with off-Amazon checkouts. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): checkoutValueSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Checkouts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Checkouts value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/checkouts-off-amazon","content":["Reporting Field ID: metric.offAmazonCheckoutsValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with an off-Amazon checkout. Checkouts value average (off-Amazon) = checkouts value sum (off-Amazon) / checkouts (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): checkoutValueAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Checkouts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/checkouts-off-amazon","content":[],"documentType":"guide"},{"title":"Contacts (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/contacts-off-amazon","content":[" The Contacts (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Contacts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Contacts (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/contacts-off-amazon","content":["Reporting Field ID: metric.offAmazonContacts - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon contacts attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): contact - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Contacts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Contact rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/contacts-off-amazon","content":["Reporting Field ID: metric.offAmazonContactRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon contacts relative to ad impressions. Contact rate (off-Amazon) = contacts (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): contactCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Contacts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per contact (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/contacts-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerContact - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon contact. Cost per contact (off-Amazon) = total cost / contacts (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): contactCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Contacts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Contacts from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/contacts-off-amazon","content":["Reporting Field ID: metric.offAmazonContactsFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon contacts attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): contactClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Contacts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Contacts from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/contacts-off-amazon","content":["Reporting Field ID: metric.offAmazonContactsFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon contacts attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): contactViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Contacts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Contacts value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/contacts-off-amazon","content":["Reporting Field ID: metric.offAmazonContactsValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with off-Amazon contacts. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): contactValueSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Contacts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Contacts value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/contacts-off-amazon","content":["Reporting Field ID: metric.offAmazonContactsValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with an off-Amazon contact. Contacts value average (off-Amazon) = contacts value sum (off-Amazon) / contacts (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): contactValueAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Contacts (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/contacts-off-amazon","content":[],"documentType":"guide"},{"title":"Leads (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/leads-off-amazon","content":[" The Leads (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Leads (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Leads (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/leads-off-amazon","content":["Reporting Field ID: metric.offAmazonLeads - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon leads attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): lead - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Leads (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Lead rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/leads-off-amazon","content":["Reporting Field ID: metric.offAmazonLeadRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon leads relative to ad impressions. Lead rate (off-Amazon) = leads (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): leadCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Leads (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per lead (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/leads-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerLead - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon lead. Cost per lead (off-Amazon) = total cost / leads (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): leadCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Leads (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Leads from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/leads-off-amazon","content":["Reporting Field ID: metric.offAmazonLeadsFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon leads attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): leadClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Leads (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Leads from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/leads-off-amazon","content":["Reporting Field ID: metric.offAmazonLeadsFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon leads attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): leadViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Leads (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Leads value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/leads-off-amazon","content":["Reporting Field ID: metric.offAmazonLeadsValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with off-Amazon leads. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): leadValueSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Leads (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Leads value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/leads-off-amazon","content":["Reporting Field ID: metric.offAmazonLeadsValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with an off-Amazon lead. Leads value average (off-Amazon) = leads value sum (off-Amazon) / leads (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): leadValueAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Leads (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/leads-off-amazon","content":[],"documentType":"guide"},{"title":"Installs (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/installs-off-amazon","content":[" The Installs (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Installs (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Installs (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/installs-off-amazon","content":["Reporting Field ID: metric.offAmazonInstalls - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon installs attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): mobileAppFirstStarts - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Installs (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Install rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/installs-off-amazon","content":["Reporting Field ID: metric.offAmazonInstallRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon installs relative to ad impressions. Install rate (off-Amazon) = installs (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): mobileAppFirstStartCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Installs (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per install (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/installs-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerInstall - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon install. Cost per install (off-Amazon) = total cost / installs (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): mobileAppFirstStartCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Installs (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Installs from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/installs-off-amazon","content":["Reporting Field ID: metric.offAmazonInstallsFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon installs attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): mobileAppFirstStartClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Installs (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Installs from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/installs-off-amazon","content":["Reporting Field ID: metric.offAmazonInstallsFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon installs attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): mobileAppFirstStartViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Installs (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Installs value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/installs-off-amazon","content":["Reporting Field ID: metric.offAmazonInstallsValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with off-Amazon installs. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): mobileAppFirstStartSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Installs (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Installs value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/installs-off-amazon","content":["Reporting Field ID: metric.offAmazonInstallsValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with an off-Amazon install. Installs value average (off-Amazon) = installs value sum (off-Amazon) / installs (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): mobileAppFirstStartAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Installs (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/installs-off-amazon","content":[],"documentType":"guide"},{"title":"Other (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/other-off-amazon","content":[" The Other (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Other (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Other (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/other-off-amazon","content":["Reporting Field ID: metric.offAmazonOther - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of advertiser-defined \"other\" conversions (not covered by other standard metrics) that occurred off Amazon, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): other - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Other (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Other rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/other-off-amazon","content":["Reporting Field ID: metric.offAmazonOtherRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of advertiser-defined \"other\" conversions relative to ad impressions. (Other rate (off-Amazon) = Other (off-Amazon) / Impressions) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): otherCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Other (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per other (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/other-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerOther - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an advertiser-defined \"other\" conversion off Amazon. Cost per other (off-Amazon) = Total cost / Other (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): otherCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Other (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Other from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/other-off-amazon","content":["Reporting Field ID: metric.offAmazonOtherFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of advertiser-defined \"other\" conversions attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): otherClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Other (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Other from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/other-off-amazon","content":["Reporting Field ID: metric.offAmazonOtherFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of advertiser-defined \"other\" conversions attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): otherViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Other (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Other value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/other-off-amazon","content":["Reporting Field ID: metric.offAmazonOtherValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with an advertiser-defined \"other\" conversion off Amazon. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): otherValueSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Other (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Other value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/other-off-amazon","content":["Reporting Field ID: metric.offAmazonOtherValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: Average value associated with advertiser-defined \"other\" conversions off Amazon. (Other value average (off-Amazon) = Other value sum (off-Amazon) / Other (off-Amazon)) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): otherValueAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Other (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/other-off-amazon","content":[],"documentType":"guide"},{"title":"Page views (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/page-views-off-amazon","content":[" The Page views (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Page views (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Page views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/page-views-off-amazon","content":["Reporting Field ID: metric.offAmazonPageViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon page views attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): pageViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Page views (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Page view rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/page-views-off-amazon","content":["Reporting Field ID: metric.offAmazonPageViewRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon page views relative to ad impressions. Page view rate (off-Amazon) = page views (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): pageViewCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Page views (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per page view (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/page-views-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerPageView - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon page view. Cost per page view (off-Amazon) = total cost / page views (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): pageViewCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Page views (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Page views from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/page-views-off-amazon","content":["Reporting Field ID: metric.offAmazonPageViewsFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon page views attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): pageViewClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Page views (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Page views from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/page-views-off-amazon","content":["Reporting Field ID: metric.offAmazonPageViewsFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon page views attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): pageViewViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Page views (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Page views value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/page-views-off-amazon","content":["Reporting Field ID: metric.offAmazonPageViewsValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with off-Amazon page views. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): pageViewValueSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Page views (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Page views value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/page-views-off-amazon","content":["Reporting Field ID: metric.offAmazonPageViewsValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with an off-Amazon page view. Page views value average (off-Amazon) = page views value sum (off-Amazon) / page views (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): pageViewValueAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Page views (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/page-views-off-amazon","content":[],"documentType":"guide"},{"title":"Searches (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/searches-off-amazon","content":[" The Searches (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Searches (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Searches (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/searches-off-amazon","content":["Reporting Field ID: metric.offAmazonSearches - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon searches attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): search - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Searches (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Search rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/searches-off-amazon","content":["Reporting Field ID: metric.offAmazonSearchRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon searches relative to ad impressions. Search rate (off-Amazon) = searches (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): searchCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Searches (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per search (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/searches-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerSearch - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon search. Cost per search (off-Amazon) = total cost / searches (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): searchCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Searches (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Searches from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/searches-off-amazon","content":["Reporting Field ID: metric.offAmazonSearchesFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon searches attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): searchClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Searches (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Searches from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/searches-off-amazon","content":["Reporting Field ID: metric.offAmazonSearchesFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon searches attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): searchViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Searches (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Searches value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/searches-off-amazon","content":["Reporting Field ID: metric.offAmazonSearchesValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with off-Amazon searches - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): searchValueSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Searches (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Searches value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/searches-off-amazon","content":["Reporting Field ID: metric.offAmazonSearchesValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with an off-Amazon search. Searches value average (off-Amazon) = searches value sum (off-Amazon) / searches (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): searchValueAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Searches (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/searches-off-amazon","content":[],"documentType":"guide"},{"title":"Sign-ups (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/sign-ups-off-amazon","content":[" The Sign-ups (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Sign-ups (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sign-ups (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/sign-ups-off-amazon","content":["Reporting Field ID: metric.offAmazonSignUps - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon sign-ups attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): signUp - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Sign-ups (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sign-up rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/sign-ups-off-amazon","content":["Reporting Field ID: metric.offAmazonSignUpRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon sign-ups relative to ad impressions. Sign-up rate (off-Amazon) = sign-ups (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): signUpCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Sign-ups (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per sign-up (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/sign-ups-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerSignUp - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon sign-up. Cost per sign-up (off-Amazon) = total cost / sign-ups (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): signUpCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Sign-ups (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sign-ups from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/sign-ups-off-amazon","content":["Reporting Field ID: metric.offAmazonSignUpsFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon sign-ups attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): signUpClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Sign-ups (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sign-ups from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/sign-ups-off-amazon","content":["Reporting Field ID: metric.offAmazonSignUpsFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon sign-ups, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): signUpViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Sign-ups (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sign-ups value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/sign-ups-off-amazon","content":["Reporting Field ID: metric.offAmazonSignUpsValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with off-Amazon sign-ups. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): signUpValueSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Sign-ups (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Sign-ups value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/sign-ups-off-amazon","content":["Reporting Field ID: metric.offAmazonSignUpsValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with an off-Amazon sign-up. Sign-ups value average (off-Amazon) = sign-ups value sum (off-Amazon) / sign-ups (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): signUpValueAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Sign-ups (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/sign-ups-off-amazon","content":[],"documentType":"guide"},{"title":"Subscribe (off-Amazon) (Off-Amazon conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/subscribe-off-amazon","content":[" The Subscribe (off-Amazon) metric family contains 7 fields, listed below:\n"],"documentType":"guide"},{"title":"Subscribe (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Subscribe (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/subscribe-off-amazon","content":["Reporting Field ID: metric.offAmazonSubscribe - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon subscribe conversions, attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): subscribe - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Subscribe rate (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/subscribe-off-amazon","content":["Reporting Field ID: metric.offAmazonSubscribeRate - Data Type: PERCENTAGE - Program eligibility: Sponsored TV, Amazon DSP - Description: The rate of off-Amazon subscribe conversions relative to ad impressions. Subscribe rate (off-Amazon) = subscribe (off-Amazon) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): subscribeCVR - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Cost per subscribe (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/subscribe-off-amazon","content":["Reporting Field ID: metric.offAmazonCostPerSubscribe - Data Type: DECIMAL - Program eligibility: Sponsored TV, Amazon DSP - Description: The average cost to acquire an off-Amazon subscribe conversion. Cost per subscribe (off-Amazon) = total cost / subscribe (off-Amazon) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): subscribeCPA - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Subscribe from clicks (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/subscribe-off-amazon","content":["Reporting Field ID: metric.offAmazonSubscribeFromClicks - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon subscribe conversions attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): subscribeClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Subscribe from views (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/subscribe-off-amazon","content":["Reporting Field ID: metric.offAmazonSubscribeFromViews - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The number of off-Amazon subscribe conversions attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): subscribeViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Subscribe value sum (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/subscribe-off-amazon","content":["Reporting Field ID: metric.offAmazonSubscribeValueSum - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The sum of values associated with off-Amazon subscribe conversions. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): subscribeValueSum - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Subscribe (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"Subscribe value average (off-Amazon)"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/subscribe-off-amazon","content":["Reporting Field ID: metric.offAmazonSubscribeValueAverage - Data Type: LONG - Program eligibility: Sponsored TV, Amazon DSP - Description: The average value associated with an off-Amazon subscribe conversion. Subscribe value average (off-Amazon) = subscribe value sum (off-Amazon) / subscribe (off-Amazon) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Audience segment, Audience segment targeting status, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): subscribeValueAverage - Version 3 Reporting Name (Sponsored Ads): N/A\n","\n"],"documentType":"guide"},{"title":"Subscribe (off-Amazon) (Off-Amazon conversions)","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/reporting/ads-v1/metrics/off-amazon-conversions/subscribe-off-amazon","content":[],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":null,"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":[" The Purchases (combined) metric family contains 16 fields, listed below:\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Purchases (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedPurchases - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases on and off Amazon attributed to an ad interaction. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): combinedPurchases - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"ROAS (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedRoas - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for sales on and off-Amazon, calculated as attributed combined sales per unit of ad spend. ROAS (combined) = sales (combined) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): combinedROAS - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"ROAS (combined, reconciled)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedRoasReconciled - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for sales on and off-Amazon after reconciliation, calculated as attributed combined sales per unit of reconciled ad spend. ROAS (combined, reconciled) = sales (combined) / total cost (reconciled) - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad group, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Budget currency, Campaign, Converted currency, Date, Date range, Day of month, Day of week, Hour, Insertion order, Month, Placement, Placement size, Portfolio, Site or app, Supply source, Week, Year - Incompatible dimensions: Ad, Target, Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Browser name, Browser version, City, Content creator, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Country, Deal, Device type, DMA, Environment, Flight, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Matched target, Conversion definition (off-Amazon), Conversion type (off-Amazon), Operating system, Placement classification, Postal code, Product relevance, Region, Search term, Targeting, Targeting match type - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"ROAS from clicks (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedRoasFromClicks - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Return on ad spend for click-attributed purchases on and off Amazon, calculated as attributed combined sales from clicks per unit of ad spend. ROAS from clicks (combined) = sales from clicks (combined) / total cost - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Sales (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedSales - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases on and off Amazon attributed to an ad interaction. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.combinedSalesConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): combinedProductSales - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Sales (combined, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedSalesConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases on and off Amazon attributed to an ad interaction. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Units sold (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedUnitsSold - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units in purchases on and off Amazon, attributed to an ad interaction. A single purchase event may include multiple units of the same product. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): combinedUnitsSold - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Cost per purchase (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedCostPerPurchase - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a purchase on or off Amazon. Cost per purchase (combined) = total cost / purchases (combined) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): combinedECPP - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Purchase rate (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedPurchaseRate - Data Type: PERCENTAGE - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The rate of attributed purchase events on and off Amazon relative to ad impressions. Purchase rate (combined) = purchases (combined) / impressions - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): combinedPurchaseRate - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Return per 1,000 impressions (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedReturnPerThousandImpressions - Data Type: DECIMAL - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: Sales on and off Amazon per thousand ad impressions. Return per thousand impressions (combined) = sales (combined) / (impressions / 1,000) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): combinedERPM - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Purchases from clicks (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedPurchasesFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of purchases on and off Amazon, attributed to an ad click. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): combinedPurchasesClicks - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedSalesFromClicks - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases on and off Amazon, attributed to an ad click. - Required fields: budgetCurrency.value 📎 - Complementary fields: metric.combinedSalesFromClicksConverted 📎 - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Sales from clicks (combined, converted)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedSalesFromClicksConverted - Data Type: CURRENCY - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases on and off Amazon, attributed to an ad click. Values are displayed in the currency selected for conversion. - Required fields: convertedCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Units sold from clicks (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedUnitsSoldFromClicks - Data Type: LONG - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The number of product units in purchases on and off Amazon, attributed to an ad click. A single purchase may include multiple units of the same product. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Cost per purchase from clicks (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedCostPerPurchaseFromClicks - Data Type: STRING - Program eligibility: Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The average cost to acquire a click-attributed on or off-Amazon purchase. Cost per purchase (combined) = total cost / purchases (combined) - Required fields: budgetCurrency.value 📎 - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Converted currency, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Conversion source, Conversion source attribution type, Conversion source environment, Converted product, Converted product marketplace, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon), Product relevance - Version 3 Reporting Name (DSP): N/A - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Purchases (combined) (Combined conversions)","sectionHeader":{"type":2,"text":"Purchases from views (combined)"},"path":"/en-us/guides/reporting/ads-v1/metrics/combined-conversions/purchases-combined","content":["Reporting Field ID: metric.combinedPurchasesFromViews - Data Type: LONG - Program eligibility: Sponsored Brands, Sponsored Display, Sponsored TV, Amazon DSP - Description: The sales from purchases on and off Amazon, attributed to an ad view. - Required fields: N/A - Complementary fields: N/A - Compatible dimensions: Ad, Ad group, Target, Ad product, Advertised product, Advertised product marketplace, Advertised product SKU, Advertiser account, Browser name, Browser version, Budget currency, Campaign, City, Content creator, Conversion source, Conversion source attribution type, Conversion source environment, Converted currency, Converted product, Converted product marketplace, Country, Date, Date range, Day of month, Day of week, Deal, Device type, DMA, Environment, Flight, Hour, Insertion order, Matched target, Month, Operating system, Placement, Placement classification, Placement size, Portfolio, Postal code, Product relevance, Region, Search term, Site or app, Supply source, Targeting, Targeting match type, Week, Year - Incompatible dimensions: Audience segment, Audience segment targeting status, Brand suitability content exclusion category, Brand suitability inventory tier, Content genre, Content rating, Content title, Content type, Frequency group, Live event, Live event ad break, Live event ad slot, Live event inventory type, Live event property, Conversion definition (off-Amazon), Conversion type (off-Amazon) - Version 3 Reporting Name (DSP): combinedPurchasesViews - Version 3 Reporting Name (Sponsored Ads): N/A\n"],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 3)","sectionHeader":null,"path":"/en-us/guides/reporting/v3/overview","content":[" Version 3 reporting in the Amazon Ads API improves the reporting experience for advertisers and integrators. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 3)","sectionHeader":{"type":2,"text":"Report types"},"path":"/en-us/guides/reporting/v3/overview","content":[" You can request reports with performance data broken down at different levels including campaign, ad group, ad, keyword, and target. For example, a campaign report contains performance data broken down by campaign for the specified day. An ad group report contains performance data broken down by ad group.  \n"," Learn more about available Report types. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 3)","sectionHeader":{"type":2,"text":"Format"},"path":"/en-us/guides/reporting/v3/overview","content":[" You can specify your desired format as part of the request. Different formats are available based on the type of report you are requesting. To view available formats, see Report types. \n"," Most report types are available for download in a compressed (gzip) format. Once unzipped, report data is in a JSON format. \n"," For a sample report, see Reading your report.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 3)","sectionHeader":{"type":2,"text":"Reporting period "},"path":"/en-us/guides/reporting/v3/overview","content":[" As part of the request, you can specify the time period for your report. Different reporting periods are available based on the type of report you are requesting. To view reporting period by report type, see Report types. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 3)","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/reporting/v3/overview","content":[],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":null,"path":"/en-us/guides/reporting/v3/get-started","content":[" This tutorial outlines how to asynchronously request and download reports for campaigns. \n"," Since Amazon Ads API reports are asynchronous, there are three calls you need to make to generate a report:\n","Request a report 2. Wait for report to generate 3. Download the report\n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":2,"text":"Headers"},"path":"/en-us/guides/reporting/v3/get-started","content":[" Each request described in this tutorial requires header parameters for authentication and account specification: \n","| Parameter | Description |\n","\\|--------------------------\\|---------------\\|\n","| Amazon-Ads-ClientId | The client ID associated with your Login with Amazon application. Used for authentication. |\n","| Authorization | Your access token. Used for authentication. |\n","| Amazon-Advertising-API-Scope | The profile ID associated with an advertising account in a specific marketplace. Make sure you are using the correct base URL for the marketplace associated to the profile. |\n","| Content-Type | Set to application/vnd.createasyncreportrequest.v3+json. |\n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":3,"text":"Reporting account headers"},"path":"/en-us/guides/reporting/v3/get-started","content":[" For reporting requests across all ad products:\n","Amazon-Ads-AccountId: Required for reporting requests across all ad products including ADSP, Sponsored Products, Sponsored Brands, and Sponsored Display.\n"," The advertiserAccount.id dimension in reporting corresponds directly to the account IDs available through the Accounts API, ensuring consistency between account management and reporting data.\n"," For an introduction to API authentication, see Authorization overview.\n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":2,"text":"Requesting reports"},"path":"/en-us/guides/reporting/v3/get-started","content":[" Version 3 reports support a variety of report types, time periods, and metrics. For more information on what configurations are supported, see Report types.\n"," All reports requests use a single endpoint: POST /reporting/reports. See the API reference for details on parameters.\n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":3,"text":"`timeUnit` and supported columns"},"path":"/en-us/guides/reporting/v3/get-started","content":[" Example request body: Summary\n"," Example request body: Daily\n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":3,"text":"`groupBy` "},"path":"/en-us/guides/reporting/v3/get-started","content":[" All report requests require the groupBy parameter in the report configuration. groupBy determines the level of the granularity for the report. See Report types to check what groupBy values are available for each report type. If supported for the report type, you can use multiple groupBy values in a request. \n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":3,"text":"Filters "},"path":"/en-us/guides/reporting/v3/get-started","content":[" Filters are determined at the groupBy level of the request. To understand what filters are available, refer to Report types.\n"," Example request body using filters\n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/reporting/v3/get-started","content":[" This sample shows a request for a summary Sponsored Products campaign report between July 5th and July 21st. \n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/reporting/v3/get-started","content":[" A successful request results in a 200 response that includes the requested report configuration, a reportId, and a status. Make note of the reportId for use in the next step.\n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":2,"text":"Checking report status"},"path":"/en-us/guides/reporting/v3/get-started","content":[" Once you have made a successful POST call, report generation can take up to three hours. Note that if you make duplicate requests to create a report with identical parameters, you will see a status code of 425, indicating that it is too soon to make the additional request. If this happens, you should wait for your existing request to complete before making another request. Alternatively, you can explore other reporting options such as Amazon Marketing Stream, which pushes data to partner or advertiser-owned AWS destinations in near real-time, without needing to call the API repeatedly.\n"," You can check the report generation status by using the reportId returned in the initial request to call the GET report endpoint: GET /reporting/reports/{reportId}.\n"," Example request\n"," Any successful call to the GET status endpoint returns a 200 status code. To check if report generation has completed, check the status parameter in the response body. If the report is still generating, status is set to PENDING or PROCESSING.\n"," When your report is ready to download, status returns as COMPLETED, and you will see an address in the url field.\n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":2,"text":"Downloading reports"},"path":"/en-us/guides/reporting/v3/get-started","content":[" Once your report is ready, the url field of a GET reporting/reports/{reportId} contains a link to the S3 bucket where you can download your report. You can make a GET call using cURL or enter the URL in your browser.  \n"],"documentType":"guide"},{"title":"Getting started with reports (version 3)","sectionHeader":{"type":2,"text":"Reading your report"},"path":"/en-us/guides/reporting/v3/get-started","content":[" Once you decompress your report file, you can see the raw JSON for the report. A sample report for the example used in this tutorial might resemble:\n"," This example returns impression, click, and cost data for two Sponsored Products campaigns. \n"," Now that you can generate a report, learn more about:\n","Metrics - Report types \n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":null,"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":[" New features include:\n","A single unified endpoint for all ad types - Multiple days of data in a single report - Summary and daily grain reporting  - Additional and standardized metrics - Sponsored Brands purchased product report  - Consistent dimensional data reporting - Bug fixes\n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":2,"text":"Report type comparison"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":[" Naming conventions used for report types have changed in version 3. The table below explains the relationships between version 2 report types and version 3 report types.\n","| Version 2 report name | Sponsored Products V3 report | Sponsored Brands V3 report | Sponsored Display V3 report |\n","\\|-----\\|-----\\|------\\|----\\|\n","| Campaign | Campaign grouped by campaign | Campaign | Campaign |\n","| Placement  | Campaign grouped by placement and campaign | Placement | N/A |\n","| Ad group | Campaign grouped by ad group and campaign | Ad group | Ad group |\n","| Product ad | Advertised product | N/A | Advertised product | \n","| Target | Targeting filtered by keywordType | Targeting filtered by keywordType | Targeting|\n","| Keyword | Targeting filtered by keywordType | Targeting filtered by keywordType | N/A |\n","| Search term | Search term | Search term | N/A |\n","| ASIN | Purchased product | Purchased product| Purchased product|\n","| Ad | N/A | Ad\n","| Matched target | N/A | N/A | Campaign grouped by matchedTarget  Ad group grouped by matchedTarget  Targeting grouped by matchedTarget |\n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":2,"text":"Endpoint equivalencies"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":["| Version 2 reporting | Version 3 reporting|\n","\\|-------\\|------\\|\n","| POST /v2/sp/{recordType}/report  POST /v2/hsa/{recordType}/report  POST /sd/{recordType}/reports |  POST /reporting/reports |\n","| GET /v2/reports/{reportId} | GET /reporting/reports/{reportId} |\n","| GET /v2/reports/{reportId}/download | GET /reporting/reports/{reportId} |\n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":3,"text":"New report: Sponsored Brands purchased product report"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":[" Advertisers can now gain product-level insights on ad-attributed sales data for Sponsored Brands campaigns.\n"," The new report includes all ad-attributed sales, including promoted products (purchases for products of your brand made by shoppers that clicked on your ad) and brand-halo (sales of any product in your advertised brands made by Amazon or other sellers).\n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":2,"text":"Metrics"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":[" Version 3 of the reporting API introduces some new metric or column names. Use this table to understand which metrics have changed.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":3,"text":"Metric/column comparison"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":["|Version 2 metric name\t|Version 3 column name (SP & SB purchased product)\t|Version 3 column name (All other reports)\t|\n","\\|----\\|------\\|-----\\|\n","|applicableBudgetRuleId\t|campaignApplicableBudgetRuleId\t|\t|\n","|applicableBudgetRuleName\t|campaignApplicableBudgetRuleName\t|\t|\n","|asin\t|advertisedAsin\t| promotedAsin\t|\n","|attributedBrandedSearches14d\t|\t|brandedSearchesClicks\t|\n","|attributedConversions14d\t|purchases14d\t|purchasesClicks\t|\n","|attributedConversions14dOtherSKU\t|purchasesOtherSku14d\t| conversionsBrandHaloClicks\t|\n","|attributedConversions14dSameSKU\t|purchasesSameSku14d\t|purchasesPromotedClicks\t|\n","|attributedConversions1d\t|purchases1d\t|\t|\n","|attributedConversions1dOtherSKU\t|purchasesOtherSku1d\t|\t|\n","|attributedConversions1dSameSKU\t|purchasesSameSku1d\t|\t|\n","|attributedConversions30d\t|purchases30d\t|\t|\n","|attributedConversions30dOtherSKU\t|purchasesOtherSku30d\t|\t|\n","|attributedConversions30dSameSKU\t|purchasesSameSku30d\t|\t|\n","|attributedConversions7d\t|purchases7d\t|\t|\n","|attributedConversions7dOtherSKU\t|purchasesOtherSku7d\t|\t|\n","|attributedConversions7dSameSKU\t|purchasesSameSku7d\t|\t|\n","|attributedDetailPageViewsClicks14d\t|\t|detailPageViewsClicks\t|\n","|attributedKindleEditionNormalizedPagesRead14d\t|kindleEditionNormalizedPagesRead14d\t|\t|\n","|attributedKindleEditionNormalizedPagesRoyalties14d\t|kindleEditionNormalizedPagesRoyalties14d\t|\t|\n","|attributedOrderRateNewToBrand14d\t|\t|newToBrandPurchasesRate\t|\n","|attributedOrdersNewToBrand14d\t|newToBrandPurchases14d\t|newToBrandPurchasesClicks\t|\n","|attributedOrdersNewToBrandPercentage14d\t|newToBrandPurchasesPercentage14d\t|newToBrandPurchasesPercentage\t|\n","|attributedSales14d\t|sales14d\t|salesClicks\t|\n","|attributedSales14dOtherSKU\t|salesOtherSku14d\t|\tsalesBrandHaloClicks|\n","|attributedSales14dSameSKU\t|attributedSalesSameSku14d\t|salesPromotedClicks\t|\n","|attributedSales1d\t|sales1d\t|\t|\n","|attributedSales1dOtherSKU\t|salesOtherSku1d\t|\t|\n","|attributedSales1dSameSKU\t|attributedSalesSameSku1d\t|\t|\n","|attributedSales30d\t|sales30d\t|\t|\n","|attributedSales30dOtherSKU\t|salesOtherSku30d\t|\t|\n","|attributedSales30dSameSKU\t|attributedSalesSameSku30d\t|\t|\n","|attributedSales7d\t|sales7d\t|\t|\n","|attributedSales7dOtherSKU\t|salesOtherSku7d\t|\t|\n","|attributedSales7dSameSKU\t|attributedSalesSameSku7d\t|\t|\n","|attributedSalesNewToBrand14d\t|\t|newToBrandSalesClicks\t|\n","|attributedSalesNewToBrandPercentage14d\t|\t|newToBrandSalesPercentage\t|\n","|attributedUnitsOrdered14d\t|unitsSoldClicks14d\t|\t|\n","|attributedUnitsOrdered14dOtherSKU\t|unitsSoldOtherSku14d\t| unitsSoldBrandHaloClicks\t|\n","|attributedUnitsOrdered14dSameSKU\t|unitsSoldSameSku14d\t|\t|\n","|attributedUnitsOrdered1d\t|unitsSoldClicks1d\t|\t|\n","|attributedUnitsOrdered1dOtherSKU\t|unitsSoldOtherSku1d\t|\t|\n","|attributedUnitsOrdered1dSameSKU\t|unitsSoldSameSku1d\t|\t|\n","|attributedUnitsOrdered30d\t|unitsSoldClicks30d\t|\t|\n","|attributedUnitsOrdered30dOtherSKU\t|unitsSoldOtherSku30d\t|\t|\n","|attributedUnitsOrdered30dSameSKU\t|unitsSoldSameSku30d\t|\t|\n","|attributedUnitsOrdered7d\t|unitsSoldClicks7d\t|\t|\n","|attributedUnitsOrdered7dOtherSKU\t|unitsSoldOtherSku7d\t|\t|\n","|attributedUnitsOrdered7dSameSKU\t|unitsSoldSameSku7d\t|\t|\n","|attributedUnitsOrderedNewToBrand14d\t|\t|newToBrandUnitsSoldClicks\t|\n","|attributedUnitsOrderedNewToBrandPercentage14d\t|\t|newToBrandUnitsSoldPercentage\t|\n","|biddingStrategy\t|campaignBiddingStrategy\t|\t|\n","|campaignBudget\t|campaignBudgetAmount\t|\t|\n","|campaignRuleBasedBudget\t|campaignRuleBasedBudgetAmount\t|\t|\n","|cost\t|cost, spend\t|cost\t|\n","|cumulativeReach |\t|cumulativeReach\t|\n","|currency\t|campaignBudgetCurrencyCode\t|\t|\n","|keywordStatus\t|adKeywordStatus\t|adKeywordStatus\t|\n","|keywordText\t|keyword\t|keywordText\t|\n","|matchType\t|keywordType, matchType\t|matchType\t|\n","|otherAsin\t|purchasedAsin\t|asinBrandHalo\t|\n","|placement\t|placementClassification\t|placementClassification\t|\n","|query\t|searchTerm\t|searchTerm\t|\n","|sku\t|advertisedSku\t| promotedSku\t|\n","|targetId\t|keywordId\t|targetingId\t|\n","|targetingExpression\t|keyword\t|targetingExpression\t|\n","|targetingText\t|targeting\t|targetingText\t|\n","|targetingType\t| keywordType, matchType |targetingType\t|\n","|unitsSold14d\t|unitsSold14d\t|unitsSold\t|\n","|vctr\t|\t|viewClickThroughRate\t|\n","|vtr\t|\t|viewabilityRate\t|\n","| viewAttributedUnitsOrdered14dOtherSKU | | unitsSoldBrandHalo|\n","| viewAttributedSales14dOtherSKU | | salesBrandHalo |\n","| viewAttributedConversions14dOtherSKU | | conversionsBrandHalo | \n","| viewImpressions | | impressionsViews| \n","| impressionsFrequencyAverage | | avgImpressionsFrequency | \n","| matchedTarget | | matchedTargetAsin|\n","| attributedDetailPageView14d | | detailPageViewsClicks |\n","| viewAttributedUnitsOrdered14d| | unitsSold | \n","| viewAttributedDetailPageView14d | | detailPageViews| \n","| viewAttributedConversions14d | |purchases |\n","| viewAttributedSales14d | | sales |\n","| viewAttributedOrdersNewToBrand14d | |newToBrandPurchases|\n","|  viewAttributedSalesNewToBrand14d | | newToBrandSales|\n","| viewAttributedUnitsOrderedNewToBrand14d | | newToBrandUnitsSold| \n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":3,"text":"New columns"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":[" Version 3 also introduces new columns not available in version 2, including: purchaseClickRate7d, purchaseClickRate14d, costPerClick, clickThroughRate, attributionType, productName, productCategory, date, startDate, endDate, acosClicks7d, acosClicks14d, roasClicks7d, roasClicks14d, brandedSearches, newToBrandPurchasesClicks, newToBrandSalesClicks, newToBrandUnitsSold14d, purchasesClicks, salesClicks, unitsSoldClicks, newToBrandDetailPageViews, newToBrandDetailPageViewsClicks, newToBrandDetailPageViewRate, newToBrandECPDetailPageView, addToCart, addToCartClicks, addToCartRate, eCPAddToCart, brandedSearchesViews, brandedSearchRate, eCPBrandSearch, newToBrandDetailPageViewViews, newToBrandDetailPageViewClicks.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":3,"text":"Expanded reporting period"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":["Many report types now support a 95 day reporting period (up from 60 days in version 2). - You can choose from daily or summary reporting. - Reports can contain multiple days of data. The number of days is determined by the report type. See Report types for details. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":3,"text":"Dimensional reporting data"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":[],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":3,"text":"Standard 14-day attribution window for Sponsored Brands and Sponsored Display"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":[" In version 3 reporting, Sponsored Display and Sponsored Brands adopt a standard 14-day attribution window for all applicable metrics. This release deprecated metrics with 1, 7, and 28 day attribution windows and drops suffixes in metric names, making it easier to read and analyze reporting information. For more details, see the Metric comparison table.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":3,"text":"View-based metrics for Sponsored Brands"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":[" Version 3 reporting supports view-based metrics for Sponsored Brands campaigns. Columns that do not end with Clicks generally include data attributed to both clicks and views. Columns that end with Clicks are only attributed to ad clicks. For full descriptions for each column, see Columns. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":3,"text":"Sponsored Display tactic"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":[" In version 2 reporting, you needed to specify the tactic as part of the report request, and the resulting report included only campaign data for that tactic. In version 3 reporting, you no longer need to specify tactic when requesting a report. Data from all Sponsored Display tactic types are returned in version 3 reports. If you want to check which tactic is associated to reporting data, you should call GET /sd/campaigns to retrieve the tactic for a given campaign, then join with the reporting data on campaignId.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting migration guide (version 3)","sectionHeader":{"type":3,"text":"Resolved Sponsored Products data quality issues"},"path":"/en-us/reference/migration-guides/reporting-v2-v3","content":[" Version 2 contained two known issues around Sponsored Products data quality.\n","A small number of Sponsored Products reports contained Sponsored Display performance data. 2. A small number of Sponsored Products reports did not include complete campaign data.\n"," These issues have been fixed in the version 3 reporting API.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/overview","content":[" The Amazon Ads API supports a number of report types based on campaign entity structure. Depending on the ad type, campaign performance can be broken down by various dimensions including campaign, ad group, ad, keyword, target, and ASIN.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":2,"text":"Account fields and dimensions"},"path":"/en-us/guides/reporting/v3/report-types/overview","content":[" When working with reporting API v3, you will encounter several account-related fields that ensure consistency between account management and reporting operations:\n","advertiserAccount.id: The primary account identifier used in report dimensions. This corresponds to the adsAccountId from the Accounts API and matches the value used in the Amazon-Ads-AccountId header. - Amazon-Ads-AccountId header: Use this header to specify which advertising account data you want to retrieve. The value should match the advertiserAccount.id in the report results. - accessRequested accounts: When making requests that span multiple accounts, use this field to specify which accounts you want to include in the report.\n"," The relationship between these fields ensures consistency between account management and reporting operations across all ad products.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":3,"text":"Availability by ad type"},"path":"/en-us/guides/reporting/v3/report-types/overview","content":[" Each type of sponsored ad supports different report types and has a separate path defined.\n","| Report type | Sponsored Products | Sponsored Brands | Sponsored Display | Sponsored Television | Amazon DSP | ALL |\n","\\|-------------\\|--------------------\\|------------------\\|------\\|--------\\|--------\\|-----\\|\n","| Ad | | ✓ | | | | |\n","| Ad group | | ✓ | ✓ | | | |\n","| Advertised product | ✓ |  | ✓ | | | | \n","| Audience | | | | | ✓ | | \n","| Audio and video (beta) | | | | | ✓ | | \n","| Benchmarks | | | | | | ✓ | \n","| Bid adjustments | | | | | ✓ | |\n","| Brand suitability | | | | | ✓ | |\n","| Campaign | ✓ | ✓ | ✓ | ✓ | ✓ | | \n","| Conversion Path | | | | | | ✓ | \n","| Geo | | | | | ✓ |  |\n","| Gross and invalid traffic | ✓ | ✓ | ✓ | | | |\n","| Inventory | | | | | ✓ |  |\n","| Placement | | ✓ | | | |  |\n","| Prompt Ad Extension | ✓ | ✓ | | | | |\n","| Product | | | | | ✓ |  |\n","| Purchased product | ✓ | ✓ | ✓ | | | |\n","| Reach and frequency | | | | | ✓ | |\n","| Search term | ✓ | ✓ | | | | |\n","| Targeting | ✓ | ✓ | ✓ |✓| | |\n","| Tech | | | | | ✓ |  |\n","| Video Ad Extension | ✓ | | | | |  |\n"],"documentType":"guide"},{"title":"Ad reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/ad","content":[" Advertised product reports contain performance data for campaigns at the ad level. \n"],"documentType":"guide"},{"title":"Ad reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/ad","content":["| Configuration | Sponsored Brands |\n","\\|----------\\|---------\\|-------\\|\n","| reportTypeId  | sbAds|\n","| Maximum date range | 31 days |\n","| Data retention | 60 days |\n","| timeUnit |SUMMARY or DAILY |\n","| groupBy | ads |\n","| format |GZIP_JSON |\n"],"documentType":"guide"},{"title":"Ad reports","sectionHeader":{"type":2,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/ad","content":[],"documentType":"guide"},{"title":"Ad reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/ad","content":[],"documentType":"guide"},{"title":"Ad reports","sectionHeader":{"type":3,"text":"Group by `ads`"},"path":"/en-us/guides/reporting/v3/report-types/ad","content":[" Additional metrics: N/A\n"," Filters: \n","adStatus (values: ENABLED,PAUSED,ARCHIVED)\n"],"documentType":"guide"},{"title":"Ad reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/ad","content":[],"documentType":"guide"},{"title":"Ad reports","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/ad","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":[" Ad group reports contain performance data broken down at the ad group level. Ad group reports include all campaigns of the requested sponsored ad type that have performance activity for the requested days. For example, a Sponsored Brands ad group report returns performance data for all Sponsored Brands ad groups that received impressions on the chosen dates. \n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":["| Configuration  | Sponsored Brands | Sponsored Display |\n","\\|----------\\|---------\\|---\\|\n","| reportTypeId | sbAdGroup | sdAdGroup |\n","| Maximum date range | 31 days | 31 days |\n","| Data retention |  60 days | 65 days |\n","| timeUnit | SUMMARY or DAILY | SUMMARY or DAILY |\n","| groupBy | adGroup| adGroup or matchedTarget|\n","| format | GZIP_JSON | GZIP_JSON |\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `adGroup`"},"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":[" Additional metrics: N/A\n"," Filters: \n","adStatus (values: ENABLED, PAUSED, ARCHIVED)\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":[" Additional metrics: N/A\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Sponsored Display"},"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `adGroup`"},"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":[" Additional metrics: cumulativeReach, impressionsFrequencyAverage, newToBrandDetailPageViewClicks, newToBrandDetailPageViewRate, newToBrandDetailPageViews, newToBrandDetailPageViewViews, newToBrandECPDetailPageView\n"," Filters: N/A\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `matchedTarget`"},"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":[" Additional metrics: matchedTargetAsin\n"," Filters: N/A\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/ad-group","content":[],"documentType":"guide"},{"title":"Advertised product reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/advertised-product","content":[" Advertised product reports contain performance data for products that are advertised as part of your campaigns. \n"],"documentType":"guide"},{"title":"Advertised product reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/advertised-product","content":["| Configuration | Sponsored Products | Sponsored Display |\n","\\|----------\\|---------\\|-------\\|------\\|\n","| reportTypeId | spAdvertisedProduct | sdAdvertisedProduct|\n","| Maximum date range | 31 days | 31 days | \n","| Data retention | 95 days | 65 days |\n","| timeUnit | SUMMARY or DAILY | SUMMARY or DAILY |\n","| groupBy | advertiser | advertiser | \n","| format | GZIP_JSON | GZIP_JSON |\n"],"documentType":"guide"},{"title":"Advertised product reports","sectionHeader":{"type":2,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/advertised-product","content":[],"documentType":"guide"},{"title":"Advertised product reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/advertised-product","content":[" Additional metrics: N/A\n"," Filters: \n","adCreativeStatus (values: ENABLED,PAUSED,ARCHIVED)\n"],"documentType":"guide"},{"title":"Advertised product reports","sectionHeader":{"type":2,"text":"Sponsored Display"},"path":"/en-us/guides/reporting/v3/report-types/advertised-product","content":[],"documentType":"guide"},{"title":"Advertised product reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/advertised-product","content":[" Additional metrics: N/A\n"," Filters: N/A\n"],"documentType":"guide"},{"title":"Advertised product reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/advertised-product","content":[],"documentType":"guide"},{"title":"Advertised product reports","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/advertised-product","content":[],"documentType":"guide"},{"title":"Advertised product reports","sectionHeader":{"type":3,"text":"Sponsored Display"},"path":"/en-us/guides/reporting/v3/report-types/advertised-product","content":[],"documentType":"guide"},{"title":"Audience reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/audience","content":[" Audience reports contain data based on your audience. \n"],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":["| Configuration | Amazon DSP | Sponsored Products\t| Sponsored Brands\t|\n","\\| -------- \\| --- \\| --- \\| --- \\|\n","| reportTypeId | dspAudience | spAudiences\t|sbAudiences\t|\n","| Maximum date range | 31 days | 31 days\t|31 days\t|\n","| Data retention | 95 days | 95 days\t|95 days\t|\n","| timeUnit | SUMMARY or DAILY | SUMMARY or DAILY\t|SUMMARY or DAILY\t|\n","| groupBy | order, or lineItem | campaign_bid_boost_segment | campaign_bid_boost_segment|\n","| format | GZIP_JSON or CSV | GZIP_JSON or XLSX\t|GZIP_JSON or XLSX\t|\n"],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":3,"text":"Group by `order`"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[" Additional metrics: orderName, orderId, orderCurrency, omsProposalId, orderStartDate, orderEndDate\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":3,"text":"Group by `lineItem`"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[" Additional metrics: lineItemName, lineItemId, lineItemComments, lineItemType, omsLineItemId, lineItemStartDate, lineItemEndDate\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":2,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":3,"text":"Group by `campaign_bid_boost_segment`"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[" Additional metrics: segmentName Filters: None\n"],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":2,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":3,"text":"Group by `campaign_bid_boost_segment`"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[" Additional metrics: segmentName Filters: None\n"],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":2,"text":"Sample requests"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":3,"text":"`dspAudience` report request body"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[],"documentType":"guide"},{"title":"Audience reports","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/audience","content":[],"documentType":"guide"},{"title":"Audio and video reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/audio-and-video","content":[" Audio and video reports contain data based on content genre and content rating.\n"],"documentType":"guide"},{"title":"Audio and video reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/audio-and-video","content":["| Configuration | Amazon DSP | \n","\\|----------\\|-----\\|\n","| reportTypeId | dspAudioAndVideo | \n","| Maximum date range | 395 days | \n","| Data retention | 395 days | \n","| timeUnit | SUMMARY | \n","| groupBy | campaign, ad, supplySource, creative, content | \n","| format | GZIP_JSON, XLSX, or CSV | \n"],"documentType":"guide"},{"title":"Audio and video reports","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/audio-and-video","content":[],"documentType":"guide"},{"title":"Audio and video reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/audio-and-video","content":[],"documentType":"guide"},{"title":"Audio and video reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/audio-and-video","content":[" Additional metrics: orderName, orderId\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Audio and video reports","sectionHeader":{"type":3,"text":"Group by `ad`"},"path":"/en-us/guides/reporting/v3/report-types/audio-and-video","content":[" Additional metrics: lineItemName, lineItemId\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Audio and video reports","sectionHeader":{"type":3,"text":"Group by `creative`"},"path":"/en-us/guides/reporting/v3/report-types/audio-and-video","content":[" Additional metrics: creativeName, creativeId\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Audio and video reports","sectionHeader":{"type":3,"text":"Group by `supplySource`"},"path":"/en-us/guides/reporting/v3/report-types/audio-and-video","content":[" Additional metrics: supplySource, supplySourceId\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Audio and video reports","sectionHeader":{"type":3,"text":"Group by `content`"},"path":"/en-us/guides/reporting/v3/report-types/audio-and-video","content":[" Additional metrics: contentGenre, contentRating, contentTitle, contentType\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Audio and video reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/audio-and-video","content":[],"documentType":"guide"},{"title":"Benchmarks reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/benchmarks","content":[" Benchmark reporting provides standardized performance comparisons against category peer brands, allowing advertisers to contextualize performance, evaluate optimization opportunities, and confidently invest with Amazon Ads. It displays your brand’s category performance against benchmarks broken out by Amazon ad product, ad format, and campaign goal type. \n"," Additional benefits of using Benchmarks:\n","Self-service access to standardized category benchmarks for planning and campaign optimization. - Report is provided at the brand level and is available for Amazon DSP and Sponsored Ads accounts. - Transparency attributes provide insight on peer set size. - Benchmarks are available starting from January 1, 2025 and update every 48 hours with the last campaign data.\n"," Benchmarks are available for the following metrics:\n","Percent of purchases new to brand - Purchase rate (new to brand) - Cost per purchase (new to brand) - Click-through rate (CTR) - Cost per click (CPC) - Completion rate (video) - Cost per completed view (video) - Cost per impressions (CPM)\n"],"documentType":"guide"},{"title":"Benchmarks reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/benchmarks","content":["| Configuration | Amazon DSP | Sponsored Ads |\n","\\|---------------\\|------------\\|---------------\\|\n","| reportTypeId | dspBenchmarks | crossProgramBenchmarks |\n","| Maximum date range x time unit | 456 days (monthly, weekly); 90 days (daily) | 456 days (monthly, weekly); 90 days (daily) |\n","| Data retention | 456 days | 456 days |\n","| timeUnit | DAILY, WEEKLY, MONTHLY | DAILY, WEEKLY, MONTHLY |\n","| groupBy | brandCategoryBenchmarks | brandCategoryBenchmarks |\n","| format | CSV or GZIP_JSON | CSV or GZIP_JSON |\n"],"documentType":"guide"},{"title":"Benchmarks reports","sectionHeader":{"type":2,"text":"All ad products"},"path":"/en-us/guides/reporting/v3/report-types/benchmarks","content":[],"documentType":"guide"},{"title":"Benchmarks reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/benchmarks","content":[],"documentType":"guide"},{"title":"Benchmarks reports","sectionHeader":{"type":3,"text":"Group by `brandCategoryBenchmarks`"},"path":"/en-us/guides/reporting/v3/report-types/benchmarks","content":[" Additional metrics: \n"," Filters:\n"," Amazon DSP\n","advertiserId\n"],"documentType":"guide"},{"title":"Benchmarks reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/benchmarks","content":[],"documentType":"guide"},{"title":"Benchmarks reports","sectionHeader":{"type":3,"text":"Sponsored Ads"},"path":"/en-us/guides/reporting/v3/report-types/benchmarks","content":[],"documentType":"guide"},{"title":"Benchmarks reports","sectionHeader":{"type":3,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/benchmarks","content":[],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/bid-adjustment","content":[" The bid adjustment report helps advertisers validate their bid adjustments application. It contains bid metrics broken down by bid adjustments rule and bid adjustments matched terms.\n"],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/bid-adjustment","content":["| Configuration\t| Amazon DSP                                             |\n","\\|----------\\|--------------------------------------------------------\\|\n","| reportTypeId | dspBidAdjustment                                     | \n","| Maximum date range | 31 days                                                | \n","| Data retention | 395 days\t                                              |\n","| timeUnit | SUMMARY or DAILY\t                                  |\n","| groupBy\t| bidAdjustmentRule and/or bidAdjustmentMatchedTerms |\n","| format | GZIP_JSON or CSV or XLSX                         |\n"],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/bid-adjustment","content":[" The DSP bid adjustment report is only available for accounts that are actively using bid adjustments on live DSP campaigns. The report is filtered to show only the line items with bid adjustments. If an advertiser pulls a report that contains line items both with and without bid adjustments, the report only shows the summary metrics for the line items that have bid adjustments.\n"," At least one groupBy value (bidAdjustmentRule and/or bidAdjustmentMatchedTerms) must be added to get the report.\n","With bidAdjustmentRule, the report is grouped at Advertiser, Order, Line, Rule, and Version level. We recommend keeping those fields in the columns list. Base metrics are available.  \\* With bidAdjustmentMatchedTerms, the report is grouped at Advertiser, Order, Line, Rule, Version, and Matched Terms level. We recommend keeping those fields in the columns list. These additional fields are available besides base metrics when using this group by: bidAdjustmentMatchedTerms, bidAdjustmentMatchedTermIds, bidAdjustment, and matchRate. The matchRate field is only available in daily reports.\n"," Similar to other reports, the date field can be added to the columns list when pulling a DAILY report.\n"],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/bid-adjustment","content":[],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":3,"text":"Group by `bidAdjustmentRule`"},"path":"/en-us/guides/reporting/v3/report-types/bid-adjustment","content":[" Filters: advertiserId\n"],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":3,"text":"Group by `bidAdjustmentMatchedTerms`"},"path":"/en-us/guides/reporting/v3/report-types/bid-adjustment","content":[" Additional metrics: bidAdjustmentMatchedTerms, bidAdjustmentMatchedTermIds, bidAdjustment, matchRate (available only in DAILY report)\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":2,"text":"Sample requests"},"path":"/en-us/guides/reporting/v3/report-types/bid-adjustment","content":[],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":3,"text":"Summary CSV report to get bids and win rate per Bid Adjustment Rule Version"},"path":"/en-us/guides/reporting/v3/report-types/bid-adjustment","content":[],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":3,"text":"Daily CSV report to get bids and win rate per Bid Adjustment Rule Version"},"path":"/en-us/guides/reporting/v3/report-types/bid-adjustment","content":[],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[" Brand suitability gives you control over where your ads appear based on the values of your brand and risk tolerance. You can customize these controls at the advertiser and line item level.\n"],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":["| Configuration\t| Amazon DSP                                  |\n","\\|----------\\|---------------------------------------------\\|\n","| reportTypeId | dspBrandSuitability                          | \n","| Maximum date range | 395 days                                     | \n","| Data retention | 395 days\t                                   |\n","| timeUnit | SUMMARY\t                                  |\n","| groupBy\t| campaign, ad, supplySource, inventoryTier, contentCategory |\n","| format | GZIP_JSON, CSV, or XLSX               |\n"],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[" Additional metrics: orderName, orderId\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":3,"text":"Group by `ad`"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[" Additional metrics: lineItemName, lineItemId\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":3,"text":"Group by `supplySource`"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[" Additional metrics: supplySource, \n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":3,"text":"Group by `inventoryTier`"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[" Additional metrics: inventoryTier\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":3,"text":"Group by `contentCategory`"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[" Additional metrics: contentCategory\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":2,"text":"Sample requests"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":3,"text":"Amazon DSP: Brand suitability report grouped by inventoryTier"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[],"documentType":"guide"},{"title":"Brand suitability reports","sectionHeader":{"type":3,"text":"Amazon DSP: Brand suitability report grouped by contentCategory"},"path":"/en-us/guides/reporting/v3/report-types/brand-suitability","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Campaign reports contain performance data broken down at the campaign level. Campaign reports include all campaigns of the requested sponsored ad type that have performance activity for the requested days. For example, a Sponsored Products campaign report returns performance data for all Sponsored Products campaigns that received impressions on the chosen dates. Campaign reports can also be grouped by ad group and placement for more granular data. \n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":["| Configuration | Sponsored Products | Sponsored Brands | Sponsored Display | Sponsored Television | Amazon DSP | \n","\\|----------\\|---------\\|---\\|------\\|-----\\|-----\\|\n","| reportTypeId | spCampaigns | sbCampaigns | sdCampaigns| stCampaigns | dspCampaign | \n","| Maximum date range | 31 days | 31 days | 31 days | 31 days | 31 days | \n","| Data retention | 95 days | 60 days | 65 days | 95 days | 95 days | \n","| timeUnit | SUMMARY, or DAILY |SUMMARY or DAILY | SUMMARY or DAILY | SUMMARY or DAILY | SUMMARY or DAILY | \n","| groupBy | campaign, adGroup, or campaignPlacement |campaign| campaign or matchedTarget | campaign or adGroup | campaign, ad, or creative | \n","| format | GZIP_JSON |GZIP_JSON| GZIP_JSON| GZIP_JSON | GZIP_JSON or CSV | \n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: campaignName, campaignId, campaignStatus, campaignBudgetAmount, campaignBudgetType, campaignRuleBasedBudgetAmount, campaignApplicableBudgetRuleId, campaignApplicableBudgetRuleName, campaignBudgetCurrencyCode, topOfSearchImpressionShare\n"," Filters: \n","campaignStatus (values: ENABLED, PAUSED, ARCHIVED)\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `adGroup`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: adGroupName, adGroupId, adStatus\n"," Filters: \n","adStatus (values: ENABLED, PAUSED, ARCHIVED)\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `campaignPlacement`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: placementClassification,campaignName, campaignId, campaignStatus, campaignBudgetAmount, campaignBudgetType, campaignRuleBasedBudgetAmount, campaignApplicableBudgetRuleId, campaignApplicableBudgetRuleName, campaignBudgetCurrencyCode, topOfSearchImpressionShare\n"," Filters:\n","campaignSite (values: AmazonBusiness)\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: campaignBudgetAmount, campaignBudgetCurrencyCode, campaignBudgetType, longTermSales, longTermROAS,  topOfSearchImpressionShare\n"," Filters: \n","campaignStatus (values: ENABLED, PAUSED, ARCHIVED)\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Sponsored Display"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: campaignBudgetAmount, campaignStatus, costType, cumulativeReach, impressionsFrequencyAverage, longTermSales, longTermROAS, newToBrandDetailPageViewClicks, newToBrandDetailPageViewRate, newToBrandDetailPageViews, newToBrandDetailPageViewViews, newToBrandECPDetailPageView, newToBrandSales\n"," Filters: N/A\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `matchedTarget`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: matchedTargetAsin\n"," Filters: N/A\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Sponsored Television"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: campaignName, campaignId, campaignStatus, campaignBudgetAmount, campaignBudgetType, campaignBudgetCurrencyCode, longTermSales, longTermROAS\n"," Filters: \n","campaignStatus (values: ENABLED, PAUSED, ARCHIVED)\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `adGroup`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: adGroupName, adGroupId, adStatus\n"," Filters: \n","adStatus (values: ENABLED, PAUSED, ARCHIVED)\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: exclusiveReachRate, incrementalReachRate, reach, householdReach, frequencyAverage, householdFrequencyAverage, longTermSales, longTermROAS\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `ad`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: lineItemBudget, lineItemId, lineItemName, lineItemExternalId, lineItemStartDate, lineItemEndDate, onTargetCPM, onTargetImpressionCost, onTargetImpressions, targetDemographic, lineItemBudgetCap, lineItemComment, lineItemDeliveryRate, lineItemStatus, lineItemType, lineItemLanguageTargeting, reach, householdReach, frequencyAverage, householdFrequencyAverage\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `creative`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: creativeName, creativeType, creativeSize, creativeId, creativeAdId, creativeLanguage, creativeWeight, lineItemApprovalStatus\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":3,"text":"Group by `flight`"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[" Additional metrics: flightName, flightBudget, flightId, flightStartDate, flightEndDate\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Campaign reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/campaign","content":[],"documentType":"guide"},{"title":"Conversion path reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/conversion-path","content":[" Conversion path reporting enables you to visualize combinations of ad products and formats that drive desired business outcomes. It displays your customers’ 30-day path to conversion, and top-converting paths across Amazon DSP, Sponsored TV, Sponsored Display, Sponsored Brands, and Sponsored Products.\n"," Additional benefits of using conversion paths:\n","Reveals the combination of ad products and formats that are most effective at moving customers through your funnel. - Reveals cross-channel paths to conversion. - Helps balance brand building and performance marketing. - Demonstrates full impact of media mixes. - Provides fast, continuous insights. - Enables quick identification of optimization opportunities. - Allows near real-time adjustments to Amazon Ads strategies. - Reporting is provided at the brand level, and can encompass multiple Amazon DSP and sponsored ads accounts, whether owned by agencies or the advertiser.\n"],"documentType":"guide"},{"title":"Conversion path reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/conversion-path","content":["| Configuration | All ad products | \n","\\|----------\\|-----\\|\n","| reportTypeId | conversionPath |\n","| Maximum date range | 90 days |\n","| Data retention | 95 days |\n","| timeUnit | SUMMARY |\n","| groupBy | brandConversionPath |\n","| format | CSV or GZIP_JSON |\n"],"documentType":"guide"},{"title":"Conversion path reports","sectionHeader":{"type":2,"text":"All ad products"},"path":"/en-us/guides/reporting/v3/report-types/conversion-path","content":[],"documentType":"guide"},{"title":"Conversion path reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/conversion-path","content":[],"documentType":"guide"},{"title":"Conversion path reports","sectionHeader":{"type":3,"text":"Group by `brandConversionPath`"},"path":"/en-us/guides/reporting/v3/report-types/conversion-path","content":[" Additional metrics: \n"," Filters: \n","brandName\n"],"documentType":"guide"},{"title":"Conversion path reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/conversion-path","content":[],"documentType":"guide"},{"title":"Geo reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/geo","content":[" Geography reports contain geographical data about your customers.\n"],"documentType":"guide"},{"title":"Geo reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/geo","content":["| Configuration | Amazon DSP | \n","\\|----------\\|-----\\|\n","| reportTypeId | dspGeo | \n","| Maximum date range | 31 days | \n","| Data retention | 95 days | \n","| timeUnit | SUMMARY or DAILY | \n","| groupBy | order, lineItem, country, region, city, postalCode, or dma | \n","| format | GZIP_JSON or CSV | \n"],"documentType":"guide"},{"title":"Geo reports","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/geo","content":[],"documentType":"guide"},{"title":"Geo reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/geo","content":[],"documentType":"guide"},{"title":"Geo reports","sectionHeader":{"type":3,"text":"Group by `order`"},"path":"/en-us/guides/reporting/v3/report-types/geo","content":[" Additional metrics: orderName, orderId, orderStartDate, orderEndDate, orderCurrency, orderBudget\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Geo reports","sectionHeader":{"type":3,"text":"Group by `lineItem`"},"path":"/en-us/guides/reporting/v3/report-types/geo","content":[" Additional metrics: lineItemName, lineItemId, lineItemStartDate, lineItemEndDate, lineItemBudget, lineItemComments, omsLineItemId\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Geo reports","sectionHeader":{"type":3,"text":"Group by `country`"},"path":"/en-us/guides/reporting/v3/report-types/geo","content":[" Additional metrics: country\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Geo reports","sectionHeader":{"type":3,"text":"Group by `region`"},"path":"/en-us/guides/reporting/v3/report-types/geo","content":[" Additional metrics: region\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Geo reports","sectionHeader":{"type":3,"text":"Group by `city`"},"path":"/en-us/guides/reporting/v3/report-types/geo","content":[" Additional metrics: city\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Geo reports","sectionHeader":{"type":3,"text":"Group by `postalCode`"},"path":"/en-us/guides/reporting/v3/report-types/geo","content":[" Additional metrics: postalCode\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Geo reports","sectionHeader":{"type":3,"text":"Group by `dma`"},"path":"/en-us/guides/reporting/v3/report-types/geo","content":[" Additional metrics: dmaCode, dmaName\n"],"documentType":"guide"},{"title":"Gross and invalid traffic reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/gross-and-invalid-traffic","content":[" The gross and invalid traffic report provides Sponsored Products, Sponsored Brands, and Sponsored Display advertisers transparency into the nature of traffic on their campaigns. This report includes all campaigns of the requested ad type and provides transparency on gross and invalid traffic metrics at campaign level for the requested days. For example, a Sponsored Products gross and invalid traffic report returns gross and invalid traffic metrics for all Sponsored Products campaigns that received impressions on the chosen dates.\n"],"documentType":"guide"},{"title":"Gross and invalid traffic reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/gross-and-invalid-traffic","content":["| Configuration | Sponsored Products | Sponsored Brands | Sponsored Display | \n","\\|----------\\|---------\\|------\\|------\\|\n","| reportTypeId | spGrossAndInvalids | sbGrossAndInvalids | sdGrossAndInvalids| \n","| Maximum date range | 365 days | 365 days | 365 days |\n","| Data retention | 365 days | 365 days | 365 days |\n","| timeUnit | SUMMARY or DAILY | SUMMARY or DAILY |SUMMARY or DAILY |\n","| groupBy | campaign |campaign | campaign |\n","| format | GZIP_JSON or CSV |GZIP_JSON or CSV |GZIP_JSON or CSV |\n"," Sponsored Products, Sponsored Brands, and Sponsored Display all support the same columns and configurations for the gross and invalid traffic report.\n"],"documentType":"guide"},{"title":"Gross and invalid traffic reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/gross-and-invalid-traffic","content":[],"documentType":"guide"},{"title":"Gross and invalid traffic reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/gross-and-invalid-traffic","content":[" Additional metrics: N/A\n"," Filters: \n","campaignStatus (values: ENABLED, PAUSED, ARCHIVED)\n"],"documentType":"guide"},{"title":"Gross and invalid traffic reports","sectionHeader":{"type":2,"text":"Sample call"},"path":"/en-us/guides/reporting/v3/report-types/gross-and-invalid-traffic","content":[],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[" Inventory reports contain data based on your inventory, such as deal and supply source information.\n"],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":["| Configuration | Amazon DSP | \n","\\|----------\\|-----\\|\n","| reportTypeId | dspInventory | \n","| Maximum date range | 31 days | \n","| Data retention | 95 days | \n","| timeUnit | SUMMARY or DAILY | \n","| groupBy | supplySource, site, campaign, creative, ad, placementSize, placement, or deal  | \n","| format | GZIP_JSON or CSV | \n"],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":3,"text":"Group by `supplySource`"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[" Additional metrics: supplySource\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":3,"text":"Group by `site`"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[" Additional metrics: site\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[" Additional metrics: orderExternalId, orderEndDate, orderCurrency, orderId, orderStartDate, orderBudget, orderName\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":3,"text":"Group by `creative`"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[" Additional metrics: creativeName, creativeType, creativeSize, creativeId\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":3,"text":"Group by `ad` "},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[" Additional metrics: lineItemBudget, lineItemComments, lineItemId, lineItemName, lineItemExternalId, lineItemStartDate, lineItemEndDate\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":3,"text":"Group by `placementSize`"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[" Additional metrics: placementSize\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":3,"text":"Group by `placement`"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[" Additional metrics: placement\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":3,"text":"Group by `deal`"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[" Additional metrics: deal, dealId, dealType\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Inventory reports","sectionHeader":{"type":3,"text":"Sample request body: `dspInventory` report"},"path":"/en-us/guides/reporting/v3/report-types/inventory","content":[],"documentType":"guide"},{"title":"Placement reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/placement","content":[" Placement reports contain performance data broken down by ad placement.\n"],"documentType":"guide"},{"title":"Placement reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/placement","content":["| Configuration  | Sponsored Brands |\n","\\|----------\\|---------\\|\n","| reportTypeId | sbCampaignPlacement |\n","| Maximum date range | 31 days |\n","| Data retention |  60 days |\n","| timeUnit | SUMMARY or DAILY |\n","| groupBy | campaign|\n","| format | GZIP_JSON |\n"],"documentType":"guide"},{"title":"Placement reports","sectionHeader":{"type":2,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/placement","content":[],"documentType":"guide"},{"title":"Placement reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/placement","content":[],"documentType":"guide"},{"title":"Placement reports","sectionHeader":{"type":3,"text":"Group by `campaignPlacement`"},"path":"/en-us/guides/reporting/v3/report-types/placement","content":[" Additional metrics: placementClassification\n"],"documentType":"guide"},{"title":"Placement reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/placement","content":[" Additional metrics: N/A\n"],"documentType":"guide"},{"title":"Placement reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/placement","content":[],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[" Prompt Ad Extension reports contain performance data for Sponsored Products and Sponsored Brands ads that include metrics for AI-powered prompt ads. Prompts are designed to help shoppers discover products through conversational experiences on Amazon by surfacing relevant product information through intelligent suggestions and guiding questions.\n"],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":2,"text":"About Prompts"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[" Prompts are a new ad format that integrates into your existing Sponsored Products and Sponsored Brands campaigns with zero additional setup required. They enhance product discovery at crucial shopper decision points by:\n","Showcasing your product expertise at scale during critical shopper decision moments - Engaging high-intent shoppers with relevant product information - Anticipating and answering shopper questions about your products\n"," Prompts with clicks will show in your existing Sponsored Products or Sponsored Brands reporting, and you can pause individual prompts through the Amazon Ads console.\n"],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":["| Configuration | Sponsored Products | Sponsored Brands |\n","\\|----------\\|---------\\|---------\\|\n","| reportTypeId | spPromptAdExtension | sbPromptAdExtension |\n","| Maximum date range | 90 days | 90 days |\n","| Data retention | 95 days | 95 days |\n","| timeUnit | SUMMARY or DAILY | SUMMARY or DAILY |\n","| groupBy | promptAdExtension | promptAdExtension |\n","| format | GZIP_JSON or XLSX | GZIP_JSON or XLSX |\n"],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":2,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":3,"text":"Group by `promptAdExtension`"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[" Additional metrics: N/A\n"," Filters:\n","marketplaceId (values: US)\n"],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":2,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":3,"text":"Group by `promptAdExtension`"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[" Additional metrics: N/A\n"," Filters:\n","marketplaceId (values: US)\n"],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[],"documentType":"guide"},{"title":"Prompt Ad Extension reports","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/prompt-ad-extension","content":[],"documentType":"guide"},{"title":"Product reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/product","content":[" Products reports contain data based on the products featured in your campaigns.\n"],"documentType":"guide"},{"title":"Product reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/product","content":["| Configuration | Amazon DSP | \n","\\|----------\\|-----\\|\n","| reportTypeId | dspProduct | \n","| Maximum date range | 31 days | \n","| Data retention | 95 days | \n","| timeUnit | SUMMARY or DAILY | \n","| groupBy | order or lineItem | \n","| format | GZIP_JSON or CSV | \n"],"documentType":"guide"},{"title":"Product reports","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/product","content":[],"documentType":"guide"},{"title":"Product reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/product","content":[],"documentType":"guide"},{"title":"Product reports","sectionHeader":{"type":3,"text":"Group by `order`"},"path":"/en-us/guides/reporting/v3/report-types/product","content":[" Additional metrics: orderName, orderId, orderBudget, orderStartDate, orderEndDate, orderCurrency, omsProposalId, orderExternalId\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Product reports","sectionHeader":{"type":3,"text":"Group by `lineItem`"},"path":"/en-us/guides/reporting/v3/report-types/product","content":[" Additional metrics: lineItemName, lineItemId, lineItemComments, lineItemBudget, lineItemStartDate, lineItemEndDate, omsLineItemId, lineItemExternalId\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":["| Configuration | Sponsored Products | Sponsored Brands | Sponsored Display |\n","\\|----------\\|---------\\|------\\|------\\|\n","| reportTypeId | spPurchasedProduct | sbPurchasedProduct| sdPurchasedProduct|\n","| Maximum date range | 31 days | 731 days | 31 days |\n","| Data retention | 95 days | 731 days | 65 days |\n","| timeUnit | SUMMARY or DAILY |SUMMARY or DAILY | SUMMARY or DAILY |\n","| groupBy | asin | purchasedAsin | asin|\n","| format | GZIP_JSON | GZIP_JSON |GZIP_JSON |\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":2,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[" Sponsored Products purchased product reports contain performance data for products that were purchased, but were not advertised as part of a campaign. The purchased product report contains both targeting expressions and keyword IDs. After you have received your report, you can filter on keywordType to distinguish between targeting expressions and keywords. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":3,"text":"Group by `asin`"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[" Additional metrics: N/A\n"," Filters: N/A\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":2,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[" Sponsored Brands purchased product reports contain performance data for products that were purchased as a result of your campaign.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":3,"text":"Group by `purchasedAsin`"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[" Additional metrics: N/A\n"," Filters: N/A\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":2,"text":"Sponsored Display"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":3,"text":"Group by `asin`"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[" Additional metrics: N/A\n"," Filters: N/A\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 3)","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/purchased-product","content":[],"documentType":"guide"},{"title":"Reach and frequency reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/reach","content":[" Reach and frequency reports contain reach and frequency metrics broken down by advertiser, supply source, and frequency group levels.\n"],"documentType":"guide"},{"title":"Reach and frequency reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/reach","content":["|Configuration\t| Amazon DSP\t                                            |\n","|---\t|--------------------------------------------------------|\n","|reportTypeId\t| dspReachFrequency\t                                     |\n","|Maximum date range\t| 31 days\t                                               |\n","|Data retention\t| 95 days\t                                               |\n","|timeUnit\t| SUMMARY or DAILY\t                                  |\n","|groupBy\t| \\[\"advertiser\"] or \\[\"advertiser\", \"supplySource\"] or \\[\"advertiser\", \"frequencyGroup\"] |\n","|format\t| GZIP_JSON or CSV\t                                  |\n"],"documentType":"guide"},{"title":"Reach and frequency reports","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/reach","content":[],"documentType":"guide"},{"title":"Reach and frequency reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/reach","content":[],"documentType":"guide"},{"title":"Reach and frequency reports","sectionHeader":{"type":3,"text":"Group by `advertiser`"},"path":"/en-us/guides/reporting/v3/report-types/reach","content":[" Additional metrics: N/A\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Reach and frequency reports","sectionHeader":{"type":3,"text":"Group by `supplySource`"},"path":"/en-us/guides/reporting/v3/report-types/reach","content":[" Additional metrics: supplySource, supplySourceId, amazonExclusiveReachRate\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Reach and frequency reports","sectionHeader":{"type":3,"text":"Group by `frequencyGroup`"},"path":"/en-us/guides/reporting/v3/report-types/reach","content":[" Additional metrics: frequencyGroupId, frequencyGroupName\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Reach and frequency reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/reach","content":[],"documentType":"guide"},{"title":"Search term reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/search-term","content":[" Search term reports contain search term performance metrics broken down by targeting expressions and keywords. Note that search term reports only include impressions that resulted in at least one ad click. Use the keywordType filter to include either targeting expressions or keywords in your report. \n"],"documentType":"guide"},{"title":"Search term reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/search-term","content":["| Configuration | Sponsored Products   | Sponsored Brands |\n","\\|----------\\|----------------------\\|------\\|\n","| reportTypeId | spSearchTerm       | sbSearchTerm |\n","| Maximum date range | 31 days              | 31 days |\n","| Data retention | 65 days              | 60 days |\n","| timeUnit | SUMMARY or DAILY |SUMMARY or DAILY |\n","| groupBy | searchTerm         |searchTerm |\n","| format | GZIP_JSON          |GZIP_JSON |\n"],"documentType":"guide"},{"title":"Search term reports","sectionHeader":{"type":2,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/search-term","content":[],"documentType":"guide"},{"title":"Search term reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/search-term","content":[],"documentType":"guide"},{"title":"Search term reports","sectionHeader":{"type":3,"text":"Group by `searchTerm`"},"path":"/en-us/guides/reporting/v3/report-types/search-term","content":[" Additional metrics: adKeywordStatus\n"," Filters: \n","keywordType (values: BROAD, PHRASE, EXACT, TARGETING_EXPRESSION, TARGETING_EXPRESSION_PREDEFINED)\n"],"documentType":"guide"},{"title":"Search term reports","sectionHeader":{"type":2,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/search-term","content":[],"documentType":"guide"},{"title":"Search term reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/search-term","content":[],"documentType":"guide"},{"title":"Search term reports","sectionHeader":{"type":3,"text":"Group by `searchTerm`"},"path":"/en-us/guides/reporting/v3/report-types/search-term","content":[" Additional metrics: adKeywordStatus\n"," Filters: \n","keywordType (values: BROAD, PHRASE, EXACT, TARGETING_EXPRESSION, TARGETING_EXPRESSION_PREDEFINED)\n"],"documentType":"guide"},{"title":"Search term reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/search-term","content":[],"documentType":"guide"},{"title":"Search term reports","sectionHeader":{"type":3,"text":"Sponsored Products: Targeting expressions only"},"path":"/en-us/guides/reporting/v3/report-types/search-term","content":[],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[" Targeting reports contain performance metrics broken down by both targeting expressions and keywords. \n"],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":["| Configuration | Sponsored Products | Sponsored Brands | Sponsored Display | Sponsored Television|\n","\\|----------\\|---------\\|------\\|------\\|------\\|\n","| reportTypeId | spTargeting | sbTargeting | sdTargeting| stTargeting|\n","| Maximum date range | 31 days | 31 days | 31 days |31 days |\n","| Data retention | 95 days | 60 days | 65 days |95 days | \n","| timeUnit | SUMMARY or DAILY | SUMMARY or DAILY |SUMMARY or DAILY |SUMMARY or DAILY |\n","| groupBy | targeting |targeting | targeting, matchedTarget |campaign, adGroup, or targeting |\n","| format | GZIP_JSON |GZIP_JSON |GZIP_JSON |GZIP_JSON |\n"],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":2,"text":"Requesting keywords vs. targets"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[" To see only targeting expressions, set the keywordType filter to TARGETING_EXPRESSION and TARGETING_EXPRESSION_PREDEFINED. To see only keywords, set the keywordType filter to BROAD, PHRASE, and EXACT.\n"],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":2,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Group by `targeting`"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[" Additional metrics: adKeywordStatus\n"," Filters: \n","adKeywordStatus (values: ENABLED,PAUSED,ARCHIVED) - keywordType (values: BROAD, PHRASE, EXACT, TARGETING_EXPRESSION, TARGETING_EXPRESSION_PREDEFINED)\n"],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":2,"text":"Sponsored Brands"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Group by `targeting`"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[" Additional metrics: N/A\n"," Filters: \n","adKeywordStatus (values: ENABLED,PAUSED,ARCHIVED) - keywordType (values: BROAD, PHRASE, EXACT, TARGETING_EXPRESSION, TARGETING_EXPRESSION_PREDEFINED, THEME)\n"],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":2,"text":"Sponsored Display"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Group by `targeting`"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[" Additional metrics: adKeywordStatus, newToBrandDetailPageViewClicks, newToBrandDetailPageViewRate, newToBrandDetailPageViews, newToBrandDetailPageViewViews, newToBrandECPDetailPageView\n"," Filters: N/A\n"],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Group by `matchedTarget`"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[" Additional metrics: matchedTargetAsin\n"," Filters: N/A\n"],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":2,"text":"Sponsored Television"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Group by `campaign`"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[" Additional metrics: campaignName, campaignId, campaignStatus, campaignBudgetAmount, campaignBudgetType, campaignBudgetCurrencyCode Filters:  - campaignStatus (values: ENABLED, PAUSED, ARCHIVED)\n"],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Group by `adGroup`"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[" Additional metrics: adGroupName, adGroupId, adStatus Filters:  - adStatus (values: ENABLED, PAUSED, ARCHIVED)\n"],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Group by `targeting`"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[" Additional metrics: adKeywordStatus\n"," Filters: \n","adKeywordStatus (values: ENABLED,PAUSED,ARCHIVED)\n"],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[],"documentType":"guide"},{"title":"Targeting reports","sectionHeader":{"type":3,"text":"Sponsored Products: Targeting expressions only"},"path":"/en-us/guides/reporting/v3/report-types/targeting","content":[],"documentType":"guide"},{"title":"Tech reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/tech","content":[" Technology reports contain data based on the technology of your customers.\n"],"documentType":"guide"},{"title":"Tech reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/tech","content":["| Configuration | Amazon DSP | \n","\\|----------\\|-----\\|\n","| reportTypeId | dspTech | \n","| Maximum date range | 31 days | \n","| Data retention | 95 days | \n","| timeUnit | SUMMARY or DAILY | \n","| groupBy | order, lineItem, operatingSystem, browserType, browserVersion, deviceType, or environmentType | \n","| format | GZIP_JSON or CSV | \n"],"documentType":"guide"},{"title":"Tech reports","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/reporting/v3/report-types/tech","content":[],"documentType":"guide"},{"title":"Tech reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/tech","content":[],"documentType":"guide"},{"title":"Tech reports","sectionHeader":{"type":3,"text":"Group by `order`"},"path":"/en-us/guides/reporting/v3/report-types/tech","content":[" Additional metrics: orderName, orderId, orderCurrency\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Tech reports","sectionHeader":{"type":3,"text":"Group by `lineItem`"},"path":"/en-us/guides/reporting/v3/report-types/tech","content":[" Additional metrics: lineItemName, lineItemId, lineItemComments, omsLineItemId\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Tech reports","sectionHeader":{"type":3,"text":"Group by `operatingSystem`"},"path":"/en-us/guides/reporting/v3/report-types/tech","content":[" Additional metrics: operatingSystemName\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Tech reports","sectionHeader":{"type":3,"text":"Group by `browserType`"},"path":"/en-us/guides/reporting/v3/report-types/tech","content":[" Additional metrics: browserName\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Tech reports","sectionHeader":{"type":3,"text":"Group by `browserVersion`"},"path":"/en-us/guides/reporting/v3/report-types/tech","content":[" Additional metrics: browserVersion\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Tech reports","sectionHeader":{"type":3,"text":"Group by `deviceType`"},"path":"/en-us/guides/reporting/v3/report-types/tech","content":[" Additional metrics: deviceName\n"," Filters: advertiserId\n"],"documentType":"guide"},{"title":"Tech reports","sectionHeader":{"type":3,"text":"Group by `environmentType`"},"path":"/en-us/guides/reporting/v3/report-types/tech","content":[" Additional metrics: environmentName\n"],"documentType":"guide"},{"title":"Video Ad Extension reports","sectionHeader":null,"path":"/en-us/guides/reporting/v3/report-types/video-ad-extension","content":[" Video Ad Extension reports contain performance data for Sponsored Products ads that include video creative, along with metrics for video engagement.\n"],"documentType":"guide"},{"title":"Video Ad Extension reports","sectionHeader":{"type":2,"text":"About video ad extensions"},"path":"/en-us/guides/reporting/v3/report-types/video-ad-extension","content":[" Video ad extensions integrate into your existing Sponsored Products campaigns with no additional setup required. They enhance product discovery by:\n","Showcasing your products in motion while shoppers browse and search - Highlighting product features that shoppers can navigate - Serving your standard image ad on placements where video is not eligible\n"," Because video ad extensions use your existing campaigns, ad groups, and ads, the campaignId, adGroupId, and adId values in this report match the values in your other Sponsored Products reports. A single ad can serve as either video or image depending on the placement, and impressions from both formats continue to appear in your existing Sponsored Products reporting.\n"," Video ad extensions are available for advertisers selling in the United States.\n"," This report identifies the extension with creativeExtensionId and its type with creativeExtensionType, which correspond to adExtensionId and adExtensionType in the campaign management API. This report does not include the extension's state, which you read with POST /adsApi/v1/query/adExtensions as described in Manage video ad extensions.\n"],"documentType":"guide"},{"title":"Video Ad Extension reports","sectionHeader":{"type":2,"text":"Configurations"},"path":"/en-us/guides/reporting/v3/report-types/video-ad-extension","content":["| Configuration | Sponsored Products |\n","\\|----------\\|---------\\|\n","| reportTypeId | spVideoAdExtension |\n","| Maximum date range | 90 days |\n","| Data retention | 95 days |\n","| timeUnit | SUMMARY or DAILY |\n","| groupBy | videoAdExtension |\n","| format | GZIP_JSON or XLSX |\n"],"documentType":"guide"},{"title":"Video Ad Extension reports","sectionHeader":{"type":2,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/video-ad-extension","content":[],"documentType":"guide"},{"title":"Video Ad Extension reports","sectionHeader":{"type":3,"text":"Base metrics"},"path":"/en-us/guides/reporting/v3/report-types/video-ad-extension","content":[],"documentType":"guide"},{"title":"Video Ad Extension reports","sectionHeader":{"type":3,"text":"Group by `videoAdExtension`"},"path":"/en-us/guides/reporting/v3/report-types/video-ad-extension","content":[" Additional metrics: N/A\n"," Filters:\n","marketplaceId (values: US)\n"],"documentType":"guide"},{"title":"Video Ad Extension reports","sectionHeader":{"type":2,"text":"Sample calls"},"path":"/en-us/guides/reporting/v3/report-types/video-ad-extension","content":[],"documentType":"guide"},{"title":"Video Ad Extension reports","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/guides/reporting/v3/report-types/video-ad-extension","content":[],"documentType":"guide"},{"title":"Reporting columns (version 3)","sectionHeader":null,"path":"/en-us/guides/reporting/v3/columns","content":[" All metrics available for the version 3 reporting API.\n"," Type: Decimal\n"," Description: The total CPM charges applied for using 3P data providers.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Total cost for using third-party pre-bid targeting.\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: The third party pre-bid fee applied for using DoubleVerify.\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: The third party pre-bid fee applied for using IntegralAdScience.\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: The third party pre-bid fee applied for using OracleDataCloud.\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: The third party pre-bid fee applied for using Pixalate.\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: A third-party fee applied to automotive data.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: CPM charge applied to impressions to track Automotive segment fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: A third-party fee applied.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: CPM charge applied to impressions to track general 3P technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: A third-party fee applied.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: CPM charge applied to impressions to track general 3P technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: A third-party fee applied.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: CPM charge applied to impressions to track general 3P technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: The third-party fee applied for using ComScore.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: CPM charge applied to impressions to track ComScore technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: The third-party fee applied for using DoubleVerify.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: CPM charge applied to impressions to track DoubleVerify technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: The third-party fee applied for using DoubleClick Campaign Manager.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: CPM charge applied to impressions to track Doubleclick Campaign Manager technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: The third-party fee applied for using Integral Ad Science.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: CPM charge applied to impressions to track Integral Ad Science technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a new-to-brand purchase conversion for a promoted product. (New-to-brand eCPP = Total cost / New-to-brand purchases) Use Total new-to-brand eCPP to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Advertising cost of sales based on purchases made within 14 days of an ad click.\n"," Report types: spTargeting, spSearchTerm, spAdvertisedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Advertising cost of sales based on purchases made within 7 days of an ad click.\n"," Report types: spTargeting, spSearchTerm, spAdvertisedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Unique numerical ID of the ad group.\n"," Report types: spCampaigns, sbAdGroups, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sbPurchasedProduct, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, stCampaigns, stTargeting, sbAds, spAdvertisedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: The format of the ad like video, image, etc.\n"," Report types: benchmarks\n"," Type: String\n"," Description: The name of the ad group as entered by the advertiser.\n"," Report types: spCampaigns, sbAdGroups, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sbPurchasedProduct, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, stCampaigns, stTargeting, sbAds, spAdvertisedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Unique numerical ID of the ad.\n"," Report types: sdAdvertisedProduct, sbAds, spAdvertisedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: Current status of a keyword.\n"," Report types: spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, sdTargeting, stTargeting\n"," Type: String\n"," Description: The name of the ad as entered by the advertiser.\n"," Report types: sbPromptAdExtension\n"," Type: String\n"," Description: Amazon ad product.\n"," Report types: benchmarks\n"," Type: String\n"," Description: Status of the ad group. \n"," Report types: spCampaigns, sbAdGroups, stCampaigns, stTargeting\n"," Type: Integer\n"," Description: Number of times shoppers added products from a brand to their cart, attributed to an ad view or click.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of times shoppers added a brand halo product to their cart, attributed to an ad view or click. Use Total ATC to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of times shoppers added a brand halo product to their cart, attributed to an ad click. Use Total ATC clicks to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of times shoppers added a brand halo product to their cart, attributed to an ad view. Use Total ATC views to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of times shoppers added products from a brand to their cart, attributed to an ad click.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Calculated by divididing addToCart by impressions.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sbAds, dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: Number of times shoppers added products from the brand to their cart, attributed to an ad view.\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad view or click. Use Total ATL to see all conversions for products from the brand.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, sbAds, spAdvertisedProduct, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of times shoppers added a brand halo product to a wish list, gift list, or registry, attributed to an ad view or click. Use Total ATL to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of times shoppers added a brand halo product to a wish list, gift list, or registry, attributed to an ad click. Use Total ATL clicks to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of times shoppers added a brand halo product to a wish list, gift list, or registry, attributed to an ad view. Use Total ATL views to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad click. Use Total ATL clicks to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad click.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, sbAds\n"," Type: Integer\n"," Description: Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad view.\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct\n"," Type: Integer\n"," Description: Rate of Add to List conversions for promoted products relative to the number of impressions. (ATLR = ATL / Impressions) Use Total ATLR to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad view. Use Total ATL views to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Add to shopping cart conversions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire an Add to shopping cart conversion. (ATSC CPA = Total cost / ATSC)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The number of Add to shopping cart conversions relative to the number of ad impressions. (ATSC CVR = ATSC / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of Add to shopping cart conversions attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Average value associated with an Add to Shopping cart conversion. (ATSC value average = ATSC value sum / ATSC)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Add to shopping cart conversion values\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Add to shopping cart conversions attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times Add to Watchlist was clicked on a featured product.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Add to Watchlist clicks attributed to ad click-throughs.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The number of Add to Watchlist clicks relative to the number of impressions. (ATWR = ATW / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of Add to Watchlist clicks attributed to ad impressions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: The ASIN or retailer offer ID associated to an advertised product. This value may differ in format and length from a standard 10-character ASIN.\n"," Report types: spPurchasedProduct, spAdvertisedProduct, spPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: The SKU being advertised. Not available for vendors.\n"," Report types: spPurchasedProduct, spAdvertisedProduct, spPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: The country assigned to the advertiser.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: String\n"," Description: The unique identifier for the advertiser.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, dspAudioAndVideo, dspReachFrequency, dspBidAdjustment, benchmarks\n"," Type: String\n"," Description: The customer that has an advertising relationship with Amazon.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, dspAudioAndVideo, dspReachFrequency, dspBidAdjustment, benchmarks\n"," Type: String\n"," Description: The time zone the advertiser uses for reporting and ad serving purposes.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: A percentage or flat fee removed from the total budget to compensate the agency that is managing the media buy.\n"," Report types: dspCampaign, dspInventory, dspGeo, dspTech\n"," Type: Integer\n"," Description: The number of Alexa skill enable conversions\n"," Report types: dspCampaign\n"," Type: Integer\n"," Description: The number of detail page view conversions attributed to ad click-throughs\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: The number of Alexa skill enable conversions relative to the number of ad impressions. (Alexa skill enable rate = Alexa skill enable / Impressions)\n"," Report types: dspCampaign\n"," Type: Integer\n"," Description: The number of alexa skill enable conversions attributed to ad impressions views\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: CPM charge applied to impressions that leverage Amazon behavioral targeting.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Average number of Amazon DSP audio occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: The technology fee applied to the media supply costs.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Average number of Amazon DSP display occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: Average number of Amazon DSP online video occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: Average number of Amazon DSP streaming TV occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: The percentage of unique viewers reached by a streaming TV inventory that were not reached by any other streaming TV inventory in the campaign. (Amazon exclusive reach rate = 100 X exclusive reach for streaming TV inventory / total streaming TV reach).\n"," Report types: dspReachFrequency\n"," Type: Integer\n"," Description: The number of first-time app opens attributed to a click or view on an ad\n"," Report types: dspCampaign, dspProduct\n"," Type: Integer\n"," Description: The number of first-time app opens attributed to a click on an ad\n"," Report types: dspCampaign, dspProduct\n"," Type: Decimal\n"," Description: The ratio of how often customers opened the app for the first time when an ad was displayed. This is calculated as first app opens divided by impressions.\n"," Report types: dspCampaign\n"," Type: Integer\n"," Description: The number of first-time app opens attributed to ad views.\n"," Report types: dspCampaign, dspProduct\n"," Type: Integer\n"," Description: The number of hours spent using the app during first-time app open sessions attributed to a click or view on ad ad.\n"," Report types: dspCampaign, dspProduct\n"," Type: Integer\n"," Description: The number of hours spent using the app during first-time app open sessions attributed to a click on an ad.\n"," Report types: dspCampaign, dspProduct\n"," Type: Integer\n"," Description: The number of hours spent using the app during first-time app open sessions attributed to ad views.\n"," Report types: dspCampaign, dspProduct\n"," Type: Integer\n"," Description: The number of first-time and recurring app opens attributed to a click or view on an ad\n"," Report types: dspCampaign, dspProduct\n"," Type: Integer\n"," Description: The number of first-time and recurring app opens attributed to a click on an ad\n"," Report types: dspCampaign, dspProduct\n"," Type: Decimal\n"," Description: The ratio of app opens to ad impressions. This is calculated as first-time and recurring app opens divided by impressions.\n"," Report types: dspCampaign\n"," Type: Integer\n"," Description: The number of first-time and recurring app opens attributed to ad views.\n"," Report types: dspCampaign, dspProduct\n"," Type: Decimal\n"," Description: The number of hours spent using the app during first-time and recurring app open sessions attributed to a click or view on ad ad.\n"," Report types: dspCampaign, dspProduct\n"," Type: Decimal\n"," Description: The number of hours spent using the app during first-time and recurring app open sessions attributed to a click on an ad.\n"," Report types: dspCampaign, dspProduct\n"," Type: Decimal\n"," Description: The number of hours spent using the app during first-time and recurring app open sessions attributed to ad views.\n"," Report types: dspCampaign, dspProduct\n"," Type: Decimal\n"," Description: The cost to acquire free trial and paid app subscriptions. This is calculated as total cost divided by app subscription sign-ups.\n"," Report types: dspGeo\n"," Type: Decimal\n"," Description: The cost to acquire free trial app subscriptions. This is calculated as total cost divided by free trial app subscription sign-ups.\n"," Report types: dspGeo\n"," Type: Integer\n"," Description: The number of free trial and paid app subscriptions associated with a click or view on your ad.\n"," Report types: dspProduct, dspGeo\n"," Type: Integer\n"," Description: The number of free trial and paid app subscriptions associated with a click on your ad.\n"," Report types: dspProduct, dspGeo\n"," Type: Integer\n"," Description: The number of free trial app subscriptions associated with a click or view on your ad.\n"," Report types: dspProduct, dspGeo\n"," Type: Integer\n"," Description: The number of free trial app subscriptions associated with a click on your ad.\n"," Report types: dspProduct, dspGeo\n"," Type: Decimal\n"," Description: The ratio of how often customers signed up for a free trial subscription when your ad was displayed. This is calculated as free trial app subscription sign-ups divided by impressions.\n"," Report types: dspGeo\n"," Type: Integer\n"," Description: The number of free trial app subscriptions associated with ad impressions.\n"," Report types: dspProduct, dspGeo\n"," Type: Integer\n"," Description: The number of paid app subscriptions associated with a click or view on your ad.\n"," Report types: dspProduct, dspGeo\n"," Type: Integer\n"," Description: The number of paid app subscriptions associated with a click on your ad.\n"," Report types: dspProduct, dspGeo\n"," Type: Decimal\n"," Description: The cost to acquire paid app subscriptions. This is calculated as total cost divided by paid app subscription sign-ups.\n"," Report types: dspGeo\n"," Type: Decimal\n"," Description: The ratio of how often customers signed up for a paid app subscription when your ad was displayed. This is calculated as paid app subscription sign-ups divided by impressions.\n"," Report types: dspGeo\n"," Type: Integer\n"," Description: The number of paid app subscriptions associated with ad impressions.\n"," Report types: dspProduct, dspGeo\n"," Type: Decimal\n"," Description: The ratio of how often customers signed up for a free trial or paid app subscription when your ad was displayed. This is calculated as app subscription sign-ups divided by impressions.\n"," Report types: dspGeo\n"," Type: Integer\n"," Description: The number of free trial and paid app subscriptions associated with ad impressions.\n"," Report types: dspProduct, dspGeo\n"," Type: Integer\n"," Description: The number of Application conversions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire an Application conversion. (Application CPA = Total cost / Application)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The number of Application conversions relative to the number of ad impressions. (Application CVR = Application / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of Application conversions attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Average value associated with an Application conversion. (Application value average = Application value sum / Application)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Application conversion values\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Application conversions attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: A unique block of letters and/or numbers that identify all products sold on Amazon.\n"," Report types: dspProduct\n"," Type: String\n"," Description: Represents a product that was purchased after an ad click but has a different SKU/ASIN than what was advertised.\n"," Report types: sdPurchasedProduct\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total value of sales occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total value of sales occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total value of sales occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: Describes whether a purchase is attributed to a promoted product or brand-halo effect.\n"," Report types: sbPurchasedProduct\n"," Type: Integer\n"," Description: Tracks the number of times that the audio ad companion banner was clicked.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times that the audio ad companion banner was displayed.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The number of audio completions relative to the number of audio starts.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times the audio ad plays to the end.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times the audio ad plays to 25% of its length.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times the audio ad plays to 50% of its length.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times a user mutes the audio ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a user pauses the audio ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Tracks an optimal audio ad time marker agreed upon with the publisher\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times a user resumes playback of the audio ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times a user rewinds the audio ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times a user skips the audio ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times audio ad starts playing.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times the audio ad plays to 75% of its length.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times a user skips the audio ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Tracks the number of times that some playback of the audio ad has occurred.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a Click to apply conversion. (eCPCTA = Total cost / CTA)\n"," Report types: dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire an Ad Details page view conversion on a Kindle E Ink device. (eCPDPVK = Total cost / DPVK)\n"," Report types: dspAudience\n"," Type: Decimal\n"," Description:  The amount the bid will be multiplied by. If a bid request is matched with multiple terms, this is your final bid adjustment from multiplying multiple factors together. \n"," Report types: dspBidAdjustment\n"," Type: String\n"," Description: The name of the bid adjustment rule or ruleDescription in API.\n"," Report types: dspBidAdjustment\n"," Type: String\n"," Description: A unique identifier for the bid adjustment rule.\n"," Report types: dspBidAdjustment\n"," Type: String\n"," Description: An identifier representing the version of a bid adjustment rule.\n"," Report types: dspBidAdjustment\n"," Type: String\n"," Description: The list of bid adjustment terms that matched with a bid request. \n"," Report types: dspBidAdjustment\n"," Type: String\n"," Description: The list of unique identifiers for the matched bid adjustment terms. \\[] (empty bracket) indicates default traffic without bid adjustments. The unique identifier for each bid adjustment term is generated by the system, and can be retrieved by downloading the CSV file (1st column) for the uploaded bid adjustments in the console, or using the GetBidModifierRule or ListBidModifierRules APIs.\n"," Report types: dspBidAdjustment\n"," Type: String\n"," Description: Bid optimization for Sponsored Display ad groups. For vCPM campaigns, the value is always reach. For CPC campaigns, value is either clicks or conversions.\n"," Report types: sdAdGroups, sdAdvertisedProduct\n"," Type:: Integer\n"," Description: Number of bids sent through the Amazon DSP. \n"," Report types: dspBidAdjustment\n"," Type: String\n"," Description: Brand advertising with Amazon Ads.\n"," Report types: benchmarks\n"," Type: String\n"," Description: The name of the brand the campaign is advertising.\n"," Report types: dspProduct, conversionPath\n"," Type: Decimal\n"," Description: The number of branded search conversions relative to the number of ad impressions. (Branded search rate = Branded searches / Impressions)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad interaction.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of branded search conversions attributed to ad click-throughs.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of branded search conversions attributed to ad impressions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Rate of Branded Searches relative to the number of impressions. (BS/Impressions)\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct\n"," Type: Integer\n"," Description: The number of searches that included the name of your brand occurring within 14 days of an ad click or view.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds\n"," Type: Integer\n"," Description: The number of searches that included the name of your brand occurring within 14 days of an ad click.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds\n"," Type: Integer\n"," Description: The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad view.\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting\n"," Type: String\n"," Description: The browse node category associated with the benchmarked brand.\n"," Report types: benchmarks\n"," Type: String\n"," Description: The web browsers the customers used to view the ad\n"," Report types: dspTech\n"," Type: String\n"," Description: The specific browser versions the customers used to view the ad\n"," Report types: dspTech\n"," Type: String\n"," Description: The ID associated to the active budget rule for a campaign.\n"," Report types: spCampaigns\n"," Type: String\n"," Description: The name associated to the active budget rule for a campaign.\n"," Report types: spCampaigns\n"," Type: String\n"," Description: The bidding strategy associated with a campaign.\n"," Report types: spCampaigns\n"," Type: Decimal\n"," Description: Total budget allocated to the campaign.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, sdCampaigns, stCampaigns, stTargeting, sbAds, spAdvertisedProduct, spGlobalAudiences, spGlobalAudiences, sbAudiences\n"," Type: String\n"," Description: The currency code associated with the campaign.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sbPurchasedProduct, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, stCampaigns, stTargeting, sbAds, spAdvertisedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension, crossProgramBenchmarks\n"," Type: String\n"," Description: One of daily or lifetime.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, stCampaigns, stTargeting, sbAds, spAdvertisedProduct, spGlobalAudiences, sbAudiences\n"," Type: String\n"," Description: The country in which the campaign is delivering.\n"," Report types: benchmarks\n"," Type: String\n"," Description: Campaign goal type.\n"," Report types: benchmarks\n"," Type: Integer\n"," Description: The ID associated with a campaign.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sbPurchasedProduct, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, stCampaigns, stTargeting, sbAds, spAdvertisedProduct, spGlobalAudiences, sbAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: The name associated with a campaign.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sbPurchasedProduct, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, stCampaigns, stTargeting, spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, sbAds, spAdvertisedProduct, spGlobalAudiences, sbAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: The code of the campaign cost type.\n"," Report types: sbPurchasedProduct\n"," Type: Decimal\n"," Description: The value of the rule-based budget for a campaign.\n"," Report types: spCampaigns\n"," Type: String\n"," Description: The status of a campaign.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, sdCampaigns, stCampaigns, stTargeting, spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, sbAds, spAdvertisedProduct, spGlobalAudiences, sbAudiences\n"," Type: Integer\n"," Description: The number of Checkout conversions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a Checkout conversion. (Checkout CPA = Total cost / Checkout)\n"," Report types: dspCampaign, dspInventory, dspAudience, dspGeo\n"," Type: Decimal\n"," Description: The number of Checkout conversions relative to the number of ad impressions. (Checkout CVR = Checkout / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience, dspGeo\n"," Type: Integer\n"," Description: The number of Checkout conversions attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Average value associated with a Checkout conversion. (Checkout value average = Checkout value sum / Checkout)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Checkout conversion values\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Checkout conversions attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: City.\n"," Report types: dspGeo\n"," Type: Integer\n"," Description: Total number of clicks on an ad.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, sbAds, spAdvertisedProduct, dspCampaign, dspInventory, dspTech, dspGeo, dspAudience, spGlobalAudiences, sbAudiences, dspProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Clicks divided by impressions.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, stCampaigns, stTargeting, spAdvertisedProduct, dspCampaign, dspInventory, dspTech, dspGeo, dspAudience, spGlobalAudiences, sbAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: The number of time Click to apply was clicked for a featured product.\n"," Report types: dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times Click to apply was clicked on other products from the same brands as the products tracked in the order, attributed to an ad.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: The number of Click to apply clicks attributed to ad click-throughs. These include clicks on other products from the same brands as the ASINs tracked in the order.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: The number of Click to apply clicks attributed to impressions. These include clicks on other products from the same brands as the ASINs tracked in the order.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: The number of click to apply conversions attributed to ad click-throughs.\n"," Report types: dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The number of Click to apply conversions relative to the number of impressions. (CTAR = CTA / Impressions)\n"," Report types: dspAudience\n"," Type: Integer\n"," Description: The number of Click to apply conversions attributed to ad impressions.\n"," Report types: dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a purchase conversion on or off Amazon. (Total cost / Combined purchases)\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Effective (average) revenue for sales on and off Amazon generated per thousand impressions. (Combined Sales / (Impressions / 1000))\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Sales (in local currency) for purchases on and off Amazon, attributed to an ad view or click.\n"," Report types: dspCampaign, dspInventory, dspGeo, dspTech\n"," Type: Decimal\n"," Description: Rate of attributed purchase events on and off Amazon, relative to ad impressions. (Combined purchases / Impressions)\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Number of purchase events on and off Amazon, attributed to an ad view or click. (Off-Amazon purchases + Total purchases (Amazon))\n"," Report types: dspCampaign, dspInventory, dspGeo\n"," Type: Integer\n"," Description: Number of purchase events on and off Amazon, attributed to an ad click. (Off-Amazon purchases clicks + Total purchases clicks (Amazon))\n"," Report types: dspCampaign, dspInventory, dspGeo\n"," Type: Integer\n"," Description: Number of purchase events on and off Amazon, attributed to an ad view. (Off-Amazon purchases views + Total purchases views (Amazon))\n"," Report types: dspCampaign, dspInventory, dspGeo\n"," Type: Decimal\n"," Description: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined product sales / Total cost)\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Units of product sold on and off Amazon, attributed to an ad view or click. A single purchase event can include multiple sold units.\n"," Report types: dspCampaign, dspInventory, dspGeo\n"," Type: Decimal\n"," Description: The number of video completions relative to the number of video starts. Completion rate (video) = complete views (video) / starts (video).\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The number of video completions relative to the number of video starts. It shows the performance of the bottom 25% peer brands.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The number of video completions relative to the number of video starts. It shows the performance of the median 50% of peer brands, where half of the peer brands performed above and half of the brands performed below the median.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The number of video completions relative to the number of video starts. It excludes the performance of the top 25% peer brands.\n"," Report types: benchmarks\n"," Type: Integer\n"," Description: The number of Contact conversions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a Contact conversion. (Contact CPA = Total cost / Contact)\n"," Report types: dspCampaign, dspInventory, dspAudience, dspGeo\n"," Type: Decimal\n"," Description: The number of Contact conversions relative to the number of ad impressions. (Contact CVR = Contact / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience, dspGeo\n"," Type: Integer\n"," Description: The number of Contact conversions attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Average value associated with a Contact conversion. (Contact value average = Contact value sum / Contact)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Contact conversion values\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Contact conversions attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type String\n"," Description: Content exclusion categories let you opt out of specific topics that do not align with your brand values.\n"," Report types: dspBrandSuitability\n"," Type: String\n"," Description: Genre of the show where the ad impression was delivered. (e.g., Horror, Drama)\n"," Report types: dspAudioAndVideo\n"," Type: String\n"," Description: DSP content rating for parental guidance (e.g., PG-13, R)\n"," Report types: dspAudioAndVideo\n"],"documentType":"guide"},{"title":"Reporting columns (version 3)","sectionHeader":{"type":3,"text":"contentTitle "},"path":"/en-us/guides/reporting/v3/columns","content":[" Type: String\n"," Description: The name or title of the show/program where the audio or video ad was played.\n"," Report types: dspAudioAndVideo\n"],"documentType":"guide"},{"title":"Reporting columns (version 3)","sectionHeader":{"type":3,"text":"contentType "},"path":"/en-us/guides/reporting/v3/columns","content":[" Type: String\n"," Description: The content type of the show/program where the audio or video ad was played.\n"," Report types: dspAudioAndVideo\n"," Type: String\n"," Description: The conversion type describes whether the conversion happened on a promoted or a brand halo ASIN.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 14 days of an ad click or view where the purchased SKU was different from the SKU advertised.\n"," Report types: sdPurchasedProduct\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 14 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: sdPurchasedProduct\n"," Type: Decimal\n"," Description: Total cost of ad clicks.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, spAdvertisedProduct, spGlobalAudiences, sbAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total cost divided by total number of clicks.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, sbAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: The average cost to acquire a video completion. Cost per completed view (video) = total cost / complete views (video).\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The average cost to acquire a video completion. It shows the performance of the top 25% peer brands.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The average cost to acquire a video completion. It shows the performance of the median 50% of peer brands, where half of the peer brands performed above and half of the brands performed below the median.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The average cost to acquire a video completion. It excludes the performance of the bottom 25% peer brands.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The average cost to acquire a purchase from a shopper who had not purchased a product from the brand in the last 12 months. Cost per purchase (new to brand) = total cost / purchases (new to brand).\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The average cost to acquire a purchase from a shopper who had not purchased a product from the brand in the last 12 months. It shows the performance of the top 25% peer brands.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The average cost to acquire a purchase from a shopper who had not purchased a product from the brand in the last 12 months. It shows the performance of the median 50% of peer brands, where half of the peer brands performed above and half of the brands performed below the median.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The average cost to acquire a purchase from a shopper who had not purchased a product from the brand in the last 12 months. It excludes the performance of the bottom 25% peer brands.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The cost per thousand impressions.\n"," Report types: stCampaigns, stTargeting, dspAudioAndVideo\n"," Type: String\n"," Description: Determines how the campaign will bid and charge. One of vCPM (cost per thousand viewable impressions) or CPC (cost per click). \n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sbAds\n"," Type: String\n"," Description: Country.\n"," Report types: dspGeo\n"," Type: Decimal\n"," Description: The average cost paid per click. Cost per click (CPC) = cost / clicks.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The average cost paid per click. It shows the performance of the top 25% peer brands.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The average cost paid per click. It shows the performance of the median 50% of peer brands, where half of the peer brands performed above and half of the brands performed below the median.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The average cost paid per click. It excludes the performance of the bottom 25% peer brands. \n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The total cost per thousand impressions. Cost per thousand impressions = (cost / impressions) \\* 1000.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The total cost per thousand impressions. It shows the performance of the top 25% peer brands.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The total cost per thousand impressions. It shows the performance of the median 50% of peer brands, where half of the peer brands performed above and half of the brands performed below the median.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The total cost per thousand impressions. It excludes the performance of the bottom 25% peer brands.\n"," Report types: benchmarks\n"," Type: String\n"," Description: A unique identifier assigned to a creative. When this is different from creativeId, creativeAdId is the value that can be used in our /dsp/creatives endpoints.\n"," Report types: dspCampaign\n"," Type: String\n"," Description: A unique identifier for the creative extension associated with the ad.\n"," Report types: spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: The type of creative extension (for example, VIDEO or PROMPTS).\n"," Report types: spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: A unique identifier assigned to a creative. When this is different from creativeAdId, creativeId cannot be used in our /dsp/creatives endpoints.\n"," Report types: dspCampaign, dspInventory, dspAudioAndVideo\n"," Type: String\n"," Description: The primary language in the creative.\n"," Report types: dspCampaign\n"," Type: String\n"," Description: Creative name.\n"," Report types: dspCampaign, dspInventory, dspAudioAndVideo\n"," Type: String\n"," Description: The dimensions of the creative in pixels.\n"," Report types: dspCampaign, dspInventory\n"," Type: String\n"," Description: The type of creative (for example static image, third party, or video).\n"," Report types: dspCampaign, dspInventory\n"],"documentType":"guide"},{"title":"Reporting columns (version 3)","sectionHeader":{"type":3,"text":"creativeweight "},"path":"/en-us/guides/reporting/v3/columns","content":[" Type: Integer\n"," Description: This is typically represented as an integer percentage, ranging from 0 to 100. For example, 30 would represent 30% weight for a particular creative.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: The percentage of impressions that were clicked. CTR = clicks / impressions.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The percentage of impressions that were clicked. It shows the performance of the bottom 25% peer brands.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The percentage of impressions that were clicked. It shows the performance of the median 50% of peer brands, where half of the peer brands performed above and half of the brands performed below the median.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The percentage of impressions that were clicked. It excludes the performance of the top 25% peer brands.\n"," Report types: benchmarks\n"],"documentType":"guide"},{"title":"Reporting columns (version 3)","sectionHeader":{"type":3,"text":"cumulativeReach"},"path":"/en-us/guides/reporting/v3/columns","content":[" Type: Integer\n"," Description: Total number of unique users exposed to an ad from either a campaign, ad group, or product ad over the lifetime of the campaign or the past six months, whichever is shorter. This metric is updated daily.\n"," Report types: sdCampaigns\n"," Type: String\n"," Description: Date when the ad activity ocurred in the format YYYY-MM-DD.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sbPurchasedProduct, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, stCampaigns, stTargeting, spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, sbAds, spAdvertisedProduct, dspCampaign, spGlobalAudiences, sbAudiences, dspReachFrequency,dspBidAdjustment, dspGeo, dspProduct, dspAudience, dspTech, dspInventory, benchmarks, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: The name of a deal.\n"," Report types: dspInventory\n"," Type: String\n"," Description: The unique identifier for the deal.\n"," Report types: dspInventory\n"," Type: String\n"," Description: The type of a deal.\n"," Report types: dspInventory\n"," Type: Integer\n"," Description: Number of detail page views for products in your brand halo, attributed to an ad view or click. Use Total DPV to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of detail page views for products in your brand halo, attributed to an ad click. Use Total DPV clicks to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of detail page views for products in your brand halo, attributed to an ad view. Use Total DPV views to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of detail page views for promoted products, attributed to an ad click. Use Total DPV clicks to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Detail page view rate for promoted products relative to the number of ad impressions. (DPV / Impressions = DPVR) Use Total DPVR to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Rate of click-attributed detail page view conversions for promoted products relative to the number of ad impressions. (DPVR Clicks = DPV clicks / Impressions) Use Total DPV Click Rate to see all conversions for products from the brand.\n"," Report types: dspAudience\n"," Type: Integer\n"," Description: Number of detail page views for promoted products, attributed to an ad view. Use Total DPV views to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of detail page views occurring within 14 days of an ad click or view.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of detail page views occurring within 14 days of an ad click.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds   Type: String\n"," Description: The Designated Market Areas¬¨¬®‚àö√ú (DMA) the customers were in when they viewed the ad. DMA regions are created and defined by Nielsen\n"," Report types: dspGeo\n"," Type: String\n"," Description: The Designated Market Areas¬¨¬®‚àö√ú (DMA) the customers were in when they viewed the ad. DMA regions are created and defined by Nielsen.\n"," Report types: dspGeo\n"," Type: Decimal\n"," Description: The number of downloaded video plays relative to the number of impressions. (Downloaded video play rate = Downloaded video plays / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of times a video was downloaded then played for the featured product.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of downloaded video plays attributed to ad click-throughs.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of downloaded video plays attributed to ad impressions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Effect cost per add to cart, calculated by cost divided by add-to-cart.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sbAds, dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire an Add to List conversion for a promoted product. (eCPATL = Total cost / ATL) Use Total eCPATL to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire an Add to Watchlist click (eCPATW = Total cost / ATW)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire an Alexa skill Enable conversion on a Kindle E Ink device. (eCP Alexa skill enable = Total cost / Alexa skill enable)\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: The average cost to acquire a first-time app open. This is calculated as total cost divided by first app opens.\n"," Report types: dspCampaign\n"," Type: Integer\n"," Description: The number of first-time and recurring app opens attributed to a click or view on an ad\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: The average cost to acquire an audio complete conversion (eCPVC = Total cost / audio complete)\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a Branded Search.\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost paid per click-through.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a detail page view for a promoted product. (eCPDPV = Total cost / DPV) Use Total eCPDPV to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a downloaded video play (eCPDVP = Total cost / Downloaded video plays)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The cost to acquire a free trial subscription for sponsored products. This is calculated as total cost divided by free trial subscription sign ups.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The total cost per thousand impressions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a purchase conversion for a promoted product. (eCPP = Total cost / Purchases) Use Total eCPP to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The cost to acquire a paid subscription for sponsored products. This is calculated as total cost divided by paid subscription sign ups.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a video trailer play (eCPPT = Total cost / Play trailers)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a product review page conversion for a promoted product. (eCPPRPV = Total cost / PRPV) Use Total eCPPRPV to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a rental (eCPR = Total cost / Rentals)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a Skill invocation conversion for a promoted Alexa skill. (Effective cost per skill invocation = Total cost / Skill invocations)\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo\n"," Type: Decimal\n"," Description: The cost to acquire a free trial or paid subscription for sponsored products. This is calculated as total cost divided by subscription sign ups.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a Video complete conversion (eCPVC = Total cost / Video complete)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a video download (eCPVD = Total cost / Video downloads)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a video stream. (eCPVS = Total cost / Video streams)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a Subscribe & Save subscription for a promoted product. (eCPSnSS = Total cost / SnSS) Use Total eCPSnSS to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) revenue for promoted products generated per thousand impressions. (eRPM = Sales / (Impressions / 1000)) Use Total eRPM to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a click-attributed detail page view conversion for a promoted product. (eCPDPV Clicks = Total cost / DPV clicks) Use Total eCPDPV Clicks to see all conversions for products from the brand.\n"," Report types: dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a click-attributed purchase for a promoted product. (eCPP Clicks = Total cost / Purchases clicks) Use Total eCPP Clicks to see all conversions for products from the brand.\n"," Report types: dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a Skill invocation conversion for a promoted Alexa skill. (Effective cost per skill invocation = Total cost / Skill invocations)\n"," Report types: dspProduct, dspAudience\n"," Type: Integer\n"," Description: The number of views of Ad Details pages on Kindle E Ink devices.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: The number of Detail page views (Kindle) on other products from the same brands as the products tracked in the order, attributed to an ad.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: The number of Detail page views (Kindle) attributed to ad click-throughs. These include clicks on other products from the same brands as the ASINs tracked in the order.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: The number of Detail page views (Kindle) attributed to impressions. These include clicks on other products from the same brands as the ASINs tracked in the order.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: The number of views of Ad Details pages on Kindle E Ink devices attributed to clicks on ads on Kindle E Ink devices.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: The number of views of Ad Details pages on Kindle E Ink devices attributed to views on ads on Kindle E Ink devices\n"," Report types: dspProduct\n"," Type: String\n"," Description: End date of summary period for a report in the format YYYY-MM-DD.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sbPurchasedProduct, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, stCampaigns, stTargeting, spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, sbAds, spAdvertisedProduct, spGlobalAudiences, sbAudiences, dspBidAdjustment, conversionPath, benchmarks, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: Entity (seat) ID.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspProduct, dspAudience\n"," Type: String\n"," Description: Break the data down by which environment the bid request came from: web or app. This dimension is connected to web and app inventory, not line item types.\n"," Report types: dspTech\n"],"documentType":"guide"},{"title":"Reporting columns (version 3)","sectionHeader":{"type":3,"text":"exclusiveReachRate"},"path":"/en-us/guides/reporting/v3/columns","content":[" Type: decimal\n"," Description: This metric measures the percentage of users who were reached ONLY by this specific campaign/line item and were not reached by any other campaigns in your media plan. The exclusiveReachRate is particularly useful when you want to understand how many users are being reached solely by a specific campaign, which can help in assessing campaign overlap and media efficiency. \n"," Report types: dspCampaign\n"," Type: String\n"," Description: The Amazon Standard Identification Number (ASIN) that was set as featured in the campaign.\n"," Report types: dspProduct\n"," Type: Decimal\n"," Description: The total budget of the campaign flight.\n"," Report types: dspCampaign\n"," Type: String\n"," Description: The end date of the campaign flight.\n"," Report types: dspCampaign\n"," Type: String\n"," Description: The unique ID associated with a specific campaign flight to track and manage campaign delivery.\n"," Report types: dspCampaign\n"," Type: String\n"," Description: The name of the campaign flight.\n"," Report types: dspCampaign\n"," Type: String\n"," Description: The start date of the campaign flight.\n"," Report types: dspCampaign\n"," Type: Integer\n"," Description: The number of free trial subscriptions for sponsored products associated with a click on your ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The ratio of how often customers signed up for a free trial for sponsored products when you ad was displayed. This is calculated as free trials divided by impressions.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of free trial subscriptions for sponsored products associated with ad impressions.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of free trial subscriptions for sponsored products associated with a click or view on your ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The number of times an ad is served to an individual/ device/ account in a period.\n"," Report types: stCampaigns, dspCampaign, dspReachFrequency\n"," Type: Long\n"," Description: The identifier of the frequency group.\n"," Report types: dspReachFrequency\n"," Type: String\n"," Description: The name of the frequency group as entered by the advertiser.\n"," Report types: dspReachFrequency\n"," Type: Integer\n"," Description: The total number of times the ad was clicked. This includes valid, potentially fraudulent, non-human, and other illegitimate clicks.\n"," Report types: spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, dspCampaign, dspInventory, dspGeo, dspTech, dspAudience\n"," Type: Integer\n"," Description: The total number of times the ad was displayed. This includes valid and invalid impressions such as potentially fraudulent, non-human, and other illegitimate impressions.\n"," Report types: spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, dspCampaign, dspInventory, dspGeo, dspAudioAndVideo, dspTech, dspAudience\n"," Type: Decimal\n"," Description: The number of times an ad is served to a household in a period.\n"," Report types: stCampaigns, dspCampaign\n"," Type: Integer\n"," Description: The number of unique households an ad impression is served to in a period.\n"," Report types: stCampaigns, dspCampaign\n"," Type: Decimal\n"," Description: The average number of exposures per unique user for an ad\n"," Report types: dspCampaign\n"," Type: Integer\n"," Description: Total number of ad impressions.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, sbAds, spAdvertisedProduct, dspCampaign, dspInventory, dspTech, dspGeo, dspAudience, dspAudioAndVideo, spGlobalAudiences, sbAudiences, dspProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Average number of times unique users were exposed to an ad over the lifetime of the campaign.\n"," Report types: sdCampaigns, sdAdGroups, sdAdvertisedProduct\n"," Type: Integer\n"," Description: Number of impressions that met the Media Ratings Council (MRC) viewability standard. See viewability details at https://advertising.amazon.com/library/guides/viewability.\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct\n"],"documentType":"guide"},{"title":"Reporting columns (version 3)","sectionHeader":{"type":3,"text":"incrementalReachRate"},"path":"/en-us/guides/reporting/v3/columns","content":[" Type: decimal\n"," Description: This metric represents the percentage of unique users reached by your campaign who were not reached by other campaigns in your media plan.\n"," Report types: dspCampaign\n"," Type: Integer\n"," Description: The number of impressions from an interactive creative. This includes, interactive video, interactive audio and interactive display creatives, and more.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: End date of report data.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, dspAudioAndVideo, dspReachFrequency\n"," Type: String\n"," Description: Start date of report data.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, dspAudioAndVideo, dspReachFrequency\n"," Type: Decimal\n"," Description: The percentage of gross click-throughs that were removed by the traffic quality filter. (Invalid click-throughs rate = invalid click-throughs / gross click-throughs)\n"," Report types: spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, dspCampaign, dspInventory, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Clicks that were removed by the traffic quality filter. This includes potentially fraudulent, non-human, and other illegitimate traffic.\n"," Report types: spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, dspCampaign, dspInventory, dspGeo, dspTech, dspAudience\n"," Type: Decimal\n"," Description: The percentage of gross impressions that were removed by the traffic quality filter. (Invalid impression rate = invalid impressions / gross impressions)\n"," Report types: spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, dspCampaign, dspInventory, dspGeo, dspTech, dspAudience\n"," Type: Integer\n"," Description: The number of impressions removed by a traffic quality filter. This includes potentially fraudulent, non-human, and other illegitimate traffic.\n"," Report types: spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, dspCampaign, dspInventory, dspGeo, dspAudioAndVideo, dspTech, dspAudience\n"," Type: String\n"," Description: Inventory tiers group ad-eligible inventory to help you balance reach with brand suitability preferences.\n"," Report types: dspBrandSuitability\n"," Type: String\n"," Description: Text of the keyword or a representation of the targeting expression (for Sponsored Products). For Sponsored Products targeting reports, the same value is returned in the targeting metric.\n"," Report types: spTargeting, spSearchTerm, spPurchasedProduct, stTargeting\n"," Type: Decimal\n"," Description: Bid associated with a keyword or targeting expression.\n"," Report types: spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, stTargeting\n"," Type: Integer\n"," Description: ID associated with a keyword or targeting expression.\n"," Report types: spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, stTargeting\n"," Type: String\n"," Description: Text of the keyword. \n"," Report types: sbTargeting, sbSearchTerm\n"," Type: String\n"," Description: Type of matching for the keyword used in bid. For keywords, one of: BROAD, PHRASE, or EXACT. For Sponsored Products reports, keywordType can also contain the type of targeting expressions, one of: TARGETING_EXPRESSION or TARGETING_EXPRESSION_PREDEFINED.\n"," Report types: spTargeting, sbTargeting, spSearchTerm, spPurchasedProduct, stTargeting\n"," Type: String\n"," Description: The number of views of Ad Details pages on Kindle E Ink devices.\n"," Report types: dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of views of Ad Details pages on Kindle E Ink devices attributed to clicks on ads on Kindle E Ink devices.\n"," Report types: dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The number of views of the Ad Details page relative to the number of ad impressions on Kindle E Ink devices. (DPVKR = DPVK / Impressions)\n"," Report types: dspAudience\n"," Type: Integer\n"," Description: The number of views of Ad Details pages on Kindle E Ink devices attributed to views on ads on Kindle E Ink devices\n"," Report types: dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of attributed Kindle edition normalized pages read within 14 days of ad click or ad view.\n"," Report types: sdAdGroup, sdAdvertisedProduct, sdCampaigns, sdPurchasedProduct, sdTargeting\n"," Type: Integer\n"," Description: Number of attributed Kindle edition normalized pages read within 14 days of ad click.\n"," Report types: sdAdGroup, sdAdvertisedProduct, sdCampaigns, sdPurchasedProduct, sdTargeting\n"," Type: Integer\n"," Description: Number of attributed Kindle edition normalized pages read within 14 days of ad view.\n"," Report types: sdAdGroup, sdAdvertisedProduct, sdCampaigns, sdPurchasedProduct, sdTargeting\n"," Type: Integer\n"," Description: Number of attributed Kindle edition normalized pages read within 14 days of ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, sbCampaigns, sbAdGroup, sbAds, sbCampaignPlacement, sbPurchasedProduct, sbSearchTerm\n"," Type: Decimal\n"," Description: The estimated royalties of attributed estimated Kindle edition normalized pages within 14 days of ad click or ad view.\n"," Report types: sdAdGroup, sdAdvertisedProduct, sdCampaigns, sdPurchasedProduct, sdTargeting\n"," Type: Decimal\n"," Description: The estimated royalties of attributed estimated Kindle edition normalized pages within 14 days of ad click.\n"," Report types: sdAdGroup, sdAdvertisedProduct, sdCampaigns, sdPurchasedProduct, sdTargeting\n"," Type: Decimal\n"," Description: The estimated royalties of attributed estimated Kindle edition normalized pages within 14 days of ad view.\n"," Report types: sdAdGroup, sdAdvertisedProduct, sdCampaigns, sdPurchasedProduct, sdTargeting\n"," Type: Decimal\n"," Description: The estimated royalties of attributed estimated Kindle edition normalized pages within 14 days of ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, sbCampaigns, sbAdGroup, sbAds, sbCampaignPlacement, sbPurchasedProduct, sbSearchTerm\n"," Type: Integer\n"," Description: The number of Lead conversions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a Lead conversion. (Lead CPA = Total cost / Lead)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The number of Lead conversions relative to the number of ad impressions. (Lead CVR = Lead / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of Lead conversions attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Average value associated with a Lead conversion. (Lead value average = Lead value sum / Lead)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Lead conversion values\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Lead conversions attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: Approval status for the line item\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: The total amount of money that be consumed by a line item.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: The total budget set for the line item.\n"," Report types: dspCampaign\n"," Type: String\n"," Description: Comments entered about the line item, such as optimization changes, variations in targeting, etc.\n"," Report types: dspCampaign\n"," Type: String\n"," Description: Comments entered about the line item, such as optimization changes, variations in targeting, etc.\n"," Report types: dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Delivery Rate of the order. Delivery Rate = (cost/budget)/(running days/total days) or (delivery impressions/budget impressions)/(running days/total days)\n"," Report types: dspCampaign\n"," Type: String\n"," Description: The last date for the flight of the line item.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo, dspAudience\n"," Type: String\n"," Description: Line item custom ID optionally entered by user.\n"," Report types: dspCampaign, dspInventory, dspProduct\n"," Type: String\n"," Description: A unique identifier assigned to a line item.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, dspAudioAndVideo, dspBidAdjustment\n"," Type: String\n"," Description: The language targeting setting for the line item.\n"," Report types: dspCampaign\n"," Type: String\n"," Description: Line item name.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, dspAudioAndVideo, dspBidAdjustment\n"," Type: String\n"," Description: The first date for the flight of the line item.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo, dspAudience\n"," Type: String\n"," Description: Status of the ad/line item\n"," Report types: dspCampaign\n"," Type: String\n"," Description: Type of the ad/line item\n"," Report types: dspCampaign, dspAudience\n"," Type: Integer\n"," Description: The number of times link-outs to landing page were clicked. \n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct\n"," Type Decimal\n"," Description The 12 month potential value of new-to-brand customer-brand engagements (DPV, Branded Search, ATC, Purchase) based on the average return on engagement of shoppers who completed these same actions 12 months ago with your brand, plus the 14d total sales of the campaign.\n"," Report types: sdCampaigns, sbCampaigns, stCampaigns, dspCampaign\n"," Type Decimal\n"," Description The 12 month potential return on ad spend of new-to-brand customer-brand engagements (DPV, Branded Search, ATC, Purchase) based on the average return on engagement of shoppers who completed these same actions 12 months ago with your brand, plus the 14d total sales of the campaign. Long-term ROAS = (Long-term Sales / Total cost)\n"," Report types: sdCampaigns, sbCampaigns, stCampaigns, dspCampaign\n"," Type: String\n"," Description: The Amazon-owned site the product is sold on.\n"," Report types: dspCampaign, dspInventory, dspProduct, spGlobalAudiences, sbAudiences, spPromptAdExtension, sbPromptAdExtension, spPurchasedProduct, spVideoAdExtension\n"," Type: Integer\n"," Description: A click on a master advertisement that directs the user to a destination outside of the creative.\n"," Report types: dspAudience\n"," Type: Integer\n"," Description: The number of times the master advertisement was displayed.\n"," Report types: dspAudience\n"," Type: Decimal\n"," Description: The percentage of eligible bid requests that matched with the bid adjustment terms. The values range from 0 to 100 where 100 represents 100%. \n"," Report types: dspBidAdjustment\n"," Type: String\n"," Description: Type of matching for the keyword used in bid. For keywords, one of: BROAD, PHRASE, or EXACT. For Sponsored Products reports, keywordType can also contain the type of targeting expressions, one of: TARGETING_EXPRESSION or TARGETING_EXPRESSION_PREDEFINED. \n"," Report types: spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, stTargeting\n"," Type: String\n"," Description: The ASIN associated with the product page where a Sponsored Display ad appeared.\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting\n"," Type: Integer\n"," Description: Number of impressions that were measured for viewability. The viewability metrics are available from October 1, 2019. Selecting a date range prior to October 1, 2019 will result in incomplete or inaccurate metrics.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Measurable impressions / total impressions. The viewability metrics are available from October 1, 2019. Selecting a date range prior to October 1, 2019 will result in incomplete or inaccurate metrics.\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Average value associated with a Mobile app first start conversion. (Mobile app first start value average = Mobile app first start value sum / Mobile app first start)\n"," Report types: dspTech, dspGeo\n"," Type: Decimal\n"," Description: The average cost to acquire a Mobile app first start conversion. (Mobile app first start CPA = Total cost / Mobile app first starts)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The number of Mobile app first start conversions relative to the number of ad impressions. (Mobile app first start CVR = Mobile app first start / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of Mobile app first start conversions attributed to ad click-throughs.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Mobile app first start conversion values\n"," Report types: dspTech, dspGeo\n"," Type: Integer\n"," Description: The number of Mobile app first start conversions attributed to ad impressions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times an app for the featured product was first started.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for all products, attributed to an ad view or click. This does not include replenishment subscription orders. Use Total SnSS to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for brand halo products, attributed to an ad view or click. This does not include replenishment subscription orders. Use Total SnSS to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for brand halo products, attributed to an ad click. This does not include replenishment subscription orders. Use Total SnSS clicks to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for brand halo products, attributed to an ad view. This does not include replenishment subscription orders. Use Total SnSS views to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for all products, attributed to ad clicks. This does not include replenishment subscription orders. Use Total SnSS to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The number of new Subscribe & Save subscriptions relative to the number of ad impressions\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for all products, attributed to ad views. This does not include replenishment subscription orders. Use Total SnSS to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of new-to-brand detail page views for all products from the brand, attributed to an ad click. \n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Calculated by dividing newToBrandDetailPageViews / impressions.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sbAds, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of new-to-brand detail page views for all products from the brand, attributed to an ad view\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who either clicked or viewed an ad.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who clicked an ad.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbAds\n"," Type: Decimal\n"," Description: Effective cost per new-to-brand detail page view, calculated by cost divided by new-to-brand detail page view.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sbAds, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Brand Store pages that were viewed and attributed to your ads.\n"," Report types: sbCampaigns\n"," Type: Decimal\n"," Description: Effective (average) revenue generated per thousand impressions from promoted products purchased by new-to-brand shoppers. (NTB eRPM = NTB Sales / (Impressions / 1000)) Use Total new-to-brand eRPM to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Sales (in local currency) of promoted products to new-to-brand shoppers, attributed to an ad view or click. Use Total new-to-brand product sales to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspGeo, dspProduct, dspTech\n"," Type: Decimal\n"," Description: Percent of ad-attributed purchases for brand halo products that were new to brand. Use Total percent of purchases new-to-brand to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Decimal\n"," Description: Rate of new-to-brand purchase conversions for promoted products relative to the number of ad impressions. (New-to-brand purchase rate = New-to-brand purchases / Impressions) Use Total new-to-brand purchase rate to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience, benchmarks\n"," Type: Decimal\n"," Description: The rate of new-to-brand purchases relative to ad impressions.  It shows the performance of the bottom 25% peer brands.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The rate of new-to-brand purchases relative to ad impressions. It shows the performance of the median 50% of peer brands, where half of the peer brands performed above and half of the brands performed below the median.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The rate of new-to-brand purchases relative to ad impressions. It excludes the performance of the top 25% peer brands.\n"," Report types: benchmarks\n"," Type: Integer\n"," Description: The number of first-time orders for brand products over a one-year lookback window resulting from an ad click or view. Not available for book vendors.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, conversionPath, sbPromptAdExtension\n"," Type: Integer\n"," Description: The number of first-time orders for brand products over a one-year lookback window. Not available for book vendors.\n"," Report types: sbPurchasedProduct\n"," Type: Integer\n"," Description: Number of new-to-brand purchases for brand halo products, attributed to an ad view or click. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days. Use Total new-to-brand purchases to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of new-to-brand purchases for brand halo products, attributed to an ad click. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days. Use Total new-to-brand purchases clicks to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of new-to-brand purchases for brand halo products, attributed to an ad view. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days. Use Total new-to-brand purchases views to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: The number of first-time orders for brand products over a one-year lookback window resulting from an ad click. Not available for book vendors.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The percentage of total orders that are new-to-brand orders within 14 days of an ad click. Not available for book vendors. \n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbAds, dspCampaign, dspProduct, dspAudience, sbPromptAdExtension\n"," Type: Decimal\n"," Description: The percentage of total orders that are new-to-brand orders within 14 days of an ad click. Not available for book vendors. \n"," Report types: sbPurchasedProduct\n"," Type: Decimal\n"," Description: The percentage of total orders that are new-to-brand orders. Not available for book vendors.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbAds\n"," Type: Integer\n"," Description: The number of new to branch purchases attributed to an ad view.\n"," Report types: stCampaigns, stTargeting, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Return on ad spend for new to brand sales\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Total value of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, conversionPath, sbPromptAdExtension\n"," Type: Decimal\n"," Description: Total value of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors.\n"," Report types: sbPurchasedProduct\n"," Type: Decimal\n"," Description: Total value of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds\n"," Type: Decimal\n"," Description: Percentage of total sales made up of new-to-brand purchases within 14 days of an ad click. Not available for book vendors. Same as newToBrandSalesPercentage14d.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbAds, sbPromptAdExtension\n"," Type: Decimal\n"," Description: Percentage of total sales made up of new-to-brand purchases within 14 days of an ad click. Not available for book vendors. Same as newToBrandSalesPercentage.\n"," Report types: sbPurchasedProduct\n"," Type: Decimal\n"," Description: Total value of sales by new to brand customers occurring within 14 days of an ad view. \n"," Report types: stCampaigns, stTargeting\n"," Type: Integer\n"," Description: Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sbAds, dspCampaign, dspInventory, dspProduct, dspGeo, dspTech, sbPromptAdExtension\n"," Type: Integer\n"," Description: Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors.\n"," Report types: sbPurchasedProduct\n"," Type: Integer\n"," Description: Units of brand halo products purchased by new-to-brand shoppers, attributed to an ad view or click. A new-to-brand purchase event can include multiple sold units. Use Total new-to-brand units sold to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sbAds\n"," Type: Decimal\n"," Description: Percentage of total attributed units ordered within 14 days of an ad click that are part of a new-to-brand purchase. Not available for book vendors. Same as newToBrandUnitsSoldPercentage14d.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbAds, sbPromptAdExtension\n"," Type: Decimal\n"," Description: Percentage of total attributed units ordered within 14 days of an ad click that are part of a new-to-brand purchase. Not available for book vendors. Same as newToBrandUnitsSoldPercentage.\n"," Report types: sbPurchasedProduct\n"," Type: Integer\n"," Description: The number of times the link inside an email or push notification was opened.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times an email or push notification was opened.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire for Off Amazon conversions\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Number of off-Amazon conversions relative to the number of ad impressions. (Off-Amazon conversions / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: Number of conversions that occured off Amazon attributed to an ad click. This includes all conversion types.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of conversions that occured off Amazon attributed to an ad view or click. This includes all conversion types.\n"," Report types: dspCampaign, dspInventory, dspGeo, dspAudience, dspTech\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire an off-Amazon purchase event. (Total cost / Off-Amazon purchases)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) revenue for sales included in off-Amazon purchases generated per thousand impressions. (Off-Amazon sales / (Impressions / 1000))\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Sales (in local currency) of promoted products to off Amazon shoppers, attributed to an ad view or click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo\n"," Type: Decimal\n"," Description: Rate of attributed off-Amazon purchase events relative to ad impressions. (Off-Amazon purchases / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Off Amazon Purchases\n"," Report types: dspCampaign, dspInventory, dspGeo, dspTech\n"," Type: Integer\n"," Description: Number of off-Amazon purchase events attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of off-Amazon purchase events attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Return on ad spend for off Amazon sales\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Units of product purchased off Amazon, attributed to an ad view or click. A single purchase event can include multiple sold units.\n"," Report types: dspCampaign, dspInventory, dspGeo\n"," Type: Integer\n"," Description: Number of conversions that occured off Amazon attributed to an ad view. This includes all conversion types.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: This fee is calculated based on a percentage of the supply cost\n"," Report types: dspCampaign\n"," Type: String\n"," Description: A unique identifier for a line item imported from the Amazon Order Management System (OMS).\n"," Report types: dspProduct, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: A unique identifier for an order imported from the Amazon Order Management System (OMS).\n"," Report types: dspProduct, dspAudience\n"," Type: Decimal\n"," Description: The total cost per thousand on-target impressions\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: The actual cost per thousand impressions (CPM) for impressions that reached your intended target audience. \n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: The total amount of money spent on the campaign when delivering on-target impressions\n"," Report types: dspCampaign\n"," Type: Integer\n"," Description: The number of times an advertisement was displayed within the advertiser’s target demographic segment, as measured by Nielsen Digital Ad Ratings\n"," Report types: dspCampaign\n"," Type: String\n"," Description: The operating systems the customers used to view the ad\n"," Report types: dspTech\n"," Type: Decimal\n"," Description: The total amount of money that be consumed by an order.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: String\n"," Description: Order currency.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, dspBenchmarks\n"," Type: String\n"," Description: The last day a line item within an order is eligible to run.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo, dspAudience\n"," Type: String\n"," Description: Order External ID or PO number\n"," Report types: dspCampaign, dspInventory, dspProduct\n"," Type: String\n"," Description: A unique identifier assigned to an order.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, dspAudioAndVideo, dspBidAdjustment\n"," Type: String\n"," Description: Order name.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, dspAudioAndVideo, dspBidAdjustment\n"," Type: String\n"," Description: The first day a line item within an order is eligible to run.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of orders within the last 14 days. Includes orders attributed to both clicks and views for vCPM campaigns, but only sales attributed to clicks for CPC campaigns.\n"," Report types: sbPurchasedProduct\n"," Type: Integer\n"," Description: Number of orders within the last 14 days attributed to ad clicks.\n"," Report types: sbPurchasedProduct\n"," Type: Integer\n"," Description: The number of Other conversions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire an Other conversion. (Other CPA = Total cost / Other)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: The number of Other conversions relative to the number of ad impressions. (Other CVR = Other / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of Other conversions attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Average value associated with an Other conversion. (Other value average = Other value sum / Other)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Other conversion values\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Other conversions attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a Page view conversion. (Page view CPA = Total cost / Page view)\n"," Report types: dspCampaign, dspInventory, dspAudience, dspGeo\n"," Type: Decimal\n"," Description: The number of Page view conversions relative to the number of ad impressions. (Page view CVR = Page view / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience, dspGeo\n"," Type: Integer\n"," Description: The number of Page view conversions attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Average value associated with a Page view conversion. (Page view value average = Page view value sum / Page view)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Page view conversion values\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Page view conversions attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Page view conversions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of paid subscriptions for sponsored products associated with a click on your ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Deciimal\n"," Description: The ratio of how often customers signed up for a paid subscription for sponsored products when you ad was displayed. This is calculated as paid subscriptions divided by impressions.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of paid subscriptions for sponsored products associated with ad impressions.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of paid subscriptions for sponsored products associated with a click or view on your ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: The Amazon Standard Identification Number (ASIN) that is the parent of this ASIN.\n"," Report types: dspProduct\n"," Type: String\n"," Description: Range of brands included in the peer set group of a brand.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The percentage of attributed purchases by shoppers who had not purchased a product from the brand in the last 12 months. Percent of purchases new to brand = purchases (new to brand) / purchases.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The percentage of attributed purchases by shoppers who had not purchased a product from the brand in the last 12 months. It shows the performance of the bottom 25% peer brands.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The percentage of attributed purchases by shoppers who had not purchased a product from the brand in the last 12 months. It shows the performance of the median 50% of peer brands, where half of the peer brands performed above and half of the brands performed below the median.\n"," Report types: benchmarks\n"," Type: Decimal\n"," Description: The percentage of attributed purchases by shoppers who had not purchased a product from the brand in the last 12 months. It excludes the performance of the top 25% peer brands.\n"," Report types: benchmarks\n"," Type: String\n"," Description: The name of the placement the campaign was run\n"," Report types: dspInventory\n"," Type: String\n"," Description: The page location where an ad appeared.\n"," Report types: spCampaigns, sbPlacement\n"," Type: Integer\n"," Description: The dimensions of the placement in pixels.  Only available when \"site\" is a dimension.\n"," Report types: dspInventory\n"," Type: Decimal\n"," Description: The number of video trailer plays relative to the number of impressions. (Play trailer rate = Play trailers / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of times a video trailer was played for the featured product.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of video trailer plays attributed to ad click-throughs.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of video trailer players attributed to ad impressions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The portfolio the campaign is associated with.\n"," Report types: spTargeting, spSearchTerm, spPurchasedProduct, stCampaigns, stTargeting, spAdvertisedProduct\n"," Type: String\n"," Description: The name of the portfolio associated with the campaign.\n"," Report types: spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: String\n"," Description: Postal code.\n"," Report types: dspGeo\n"," Type: String\n"," Description: The category the product is associated with on Amazon.\n"," Report types: sbPurchasedProduct, dspProduct\n"," Type: String\n"," Description: A distinct product grouping distinguishing products like books from watches and video games from toys. Contains categories.\n"," Report types: dspProduct\n"," Type: String\n"," Description: The name of the product.\n"," Report types: sbPurchasedProduct, dspProduct\n"," Type: Integer\n"," Description: Number of times shoppers visited the product review page for a brand halo product, attributed to an ad view or click. Use Total PRPV to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of times shoppers visited the product review page for a brand halo product, attributed to an ad click. Use Total PRPV clicks to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of times shoppers visited the product review page for a brand halo product, attributed to an ad view. Use Total PRPV views to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Deciaml\n"," Description: Rate of product review page visits for promoted products, relative to the number of ad impressions. (ATCR = ATC / Impressions) Use Total PRPVR to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: Number of times shoppers visited the product review page for a promoted product, attributed to an ad view or click. Use Total PRPV to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of times shoppers visited the product review page for a promoted product, attributed to an ad click. Use Total PRPV clicks to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of times shoppers visited the product review page for a promoted product, attributed to an ad view. Use Total PRPV views to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: A classification for the type of product being sold which determines its place in the Amazon retail catalog.\n"," Report types: dspProduct\n"," Type: String\n"," Description: The AI-generated conversational text displayed with the ad that helps shoppers discover products by providing intelligent suggestions, answering questions, and surfacing relevant product information at critical decision points.\n"," Report types: spPromptAdExtension, sbPromptAdExtension\n"," Type: String\n"," Description: The ASIN associated to an advertised product.\n"," Report types: sdAdvertisedProduct, sdPurchasedProduct\n"," Type: String\n"," Description: The SKU being advertised. Not available for vendors.\n"," Report types: sdAdvertisedProduct, sdPurchasedProduct\n"," Type: String\n"," Description: A unique identifier for an order imported from the Amazon Order Management System (OMS).\n"," Report types: dspCampaign\n"," Type: Decimal\n"," Description: Rate of ad-attributed purchase events relative to ad clicks within 14 days.\n"," Report types: spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Rate of ad-attributed purchase events relative to ad clicks within 7 days.\n"," Report types: spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Rate of ad-attributed purchase events for promoted products, relative to ad impressions. (Purchase rate = Purchases / Impressions) Use Total purchase rate to see all conversions for products from the brand.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: String\n"," Description: The ASIN or retailer offer ID of the product that was purchased. This value may differ in format and length from a standard 10-character ASIN.\n"," Report types: spPurchasedProduct, sbPurchasedProduct\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience, sbAudiences, conversionPath\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 14 days of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 1 day of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 30 days of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 7 days of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of times any quantity of a brand halo product was included in a purchase event, attributed to an ad view or click. Purchase events include new Subscribe & Save subscriptions and video rentals. Use Total purchases to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of times any quantity of a brand halo product was included in a purchase event, attributed to an ad click. Purchase events include new Subscribe & Save subscriptions and video rentals. Use Total purchases clicks to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of times any quantity of a brand halo product was included in a purchase event, attributed to an ad view. Purchase events include new Subscribe & Save subscriptions and video rentals. Use Total purchases views to see all conversions for products from the brand.\n"," Report types: dspProduct\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 14 days of an ad click.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Rate of click-attributed purchases for promoted products relative to the number of ad impressions. (Purchase Rate Clicks = Click-attributed purchases / Impressions) Use Total Purchase Click Rate to see all conversions for products from the brand.\n"," Report types: dspAudience\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 14 days of an ad click where the SKU purchased was different from the advertised SKU.\n"," Report types: spPurchasedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 1 day of an ad click where the SKU purchased was different from the advertised SKU.\n"," Report types: spPurchasedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 30 days of an ad click where the SKU purchased was different from the advertised SKU.\n"," Report types: spPurchasedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 7 days of an ad click where the SKU purchased was different from the advertised SKU.\n"," Report types: spPurchasedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 14 days of ad click or view where the purchased SKU was the same as the SKU advertised. Same as purchasesSameSku14d.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbAds\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised. Same as puchasesPromoted.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 1 day of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 14 days of an ad view.\n"," Report types: stCampaigns, stTargeting, dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, sbAds, spAdvertisedProduct\n"," Type: Integer\n"," Description: Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, sbAds\n"," Type: Integer\n"," Description: Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only.\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct\n"," Type: Integer\n"," Description: The number of unique users exposed to ads, counted either daily or over the last 6 months, depending on the selected time unit (Daily vs. Summary)\n"," Report types: stCampaigns, dspCampaign, dspReachFrequency\n"," Type: String\n"," Description: State or region.\n"," Report types: dspGeo\n"," Type: Decimal\n"," Description: The number of video rentals relative to the number of impressions. (Rental rate = Rentals / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of times a video was rented for the featured product.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of video rentals attributed to ad click-throughs.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of video rentals attributed to ad impressions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: Report granularity.\n"," Report types: dspProduct\n"," Type: Decimal\n"," Description: Return on ad spend.\n"," Report types: stCampaigns, stTargeting, dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Return on ad spend based on purchases made within 14 days of an ad click.\n"," Report types: spTargeting, spSearchTerm, spAdvertisedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Return on ad spend based on purchases made within 7 days of an ad click.\n"," Report types: spTargeting, spSearchTerm, spAdvertisedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Estimated royalty payment attributed to Kindle Unlimited users downloading the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, sbAds, spAdvertisedProduct\n"," Type: Decimal\n"," Description: Estimated royalty payment attributed to Kindle Unlimited users who clicked on the ad, downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct, sbAds\n"," Type: Decimal\n"," Description: Estimated royalty payment attributed to Kindle Unlimited users who viewed the ad, downloaded the book due to ad exposure, during the attribution window, and have read a percent of the book within the window, triggering a royalty payment. Relevant to book advertisers only.\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sdPurchasedProduct\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of an ad click or view. \n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspCampaign, dspInventory, sbAudiences, dspGeo, dspProduct, dspTech, conversionPath\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of an ad click. Includes sales attributed to both clicks and views for vCPM campaigns, but only sales attributed to clicks for CPC campaigns.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, sbPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total value of sales occurring within 1 day of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total value of sales occurring within 30 days of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total value of sales occurring within 7 days of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: For Sponsored Display vCPM campaigns, the total value of sales occurring within 14 days of an ad click or view where the purchased SKU was different from the SKU advertised.\n"," Report types: sdPurchasedProduct, dspProduct\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: sdPurchasedProduct\n"," Type: Integer\n"," Description: The total new-to-brand sales of brand halo products purchased by customers on Amazon after exposure to an ad.\n"," Report types: dspProduct\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of an ad click. \n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspProduct, dspGeo, sbAudiences\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of an ad click. \n"," Report types: sbPurchasedProduct\n"," Type: String\n"," Description: The currency code of the marketplace of the purchase event.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: spPurchasedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total value of sales occurring within 1 day of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: spPurchasedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total value of sales occurring within 30 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: spPurchasedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total value of sales occurring within 7 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of ad click or view where the purchased SKU was the same as the SKU advertised. Same as attributedSales14dSameSKU.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbAds, dspProduct\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of an ad view. \n"," Report types: stCampaigns, stTargeting\n"," Type: Integer\n"," Description: The number of Search conversions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The average cost to acquire a Search conversion. (Search CPA = Total cost / Search)\n"," Report types: dspCampaign, dspInventory, dspAudience, dspGeo\n"," Type: Decimal\n"," Description: The number of Search conversions relative to the number of ad impressions. (Search CVR = Search / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience, dspGeo\n"," Type: Integer\n"," Description: The number of Search conversions attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: The search term used by the customer. Same as query.\n"," Report types: spSearchTerm, sbSearchTerm\n"," Type: Decimal\n"," Description: Average value associated with a Search conversion. (Search value average = Search value sum / Search)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Search conversion values\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of Search conversions attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: The class of the segment, for example behavioral or user agent.\n"," Report types: dspAudience, spGlobalAudiences \n"," Type: String\n"," Description: A unique identifier assigned to an audience segment.\n"," Report types: dspAudience\n"," Type: String\n"," Description: A unique identifier assigned to the marketplace of the audience segment.\n"," Report types: dspAudience\n"," Type: String\n"," Description: The name of the audience segment.\n"," Report types: dspAudience, spGlobalAudiences, sbAudiences\n"," Type: String\n"," Description: The source of the segment, for example AAX.\n"," Report types: dspAudience\n"," Type: String\n"," Description: The type of segment, for example remarketing.\n"," Report types: dspAudience\n"," Type: Integer\n"," Description: Number of Sign-up conversions occurring off Amazon, attributed to an ad view or click.\n"," Report types: dspCampaign, dspGeo, dspAudience, dspInventory, dspTech\n"," Type: Decimal\n"," Description: The average cost to acquire a Sign-up conversion off Amazon. (Total cost / Sign-up)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Number of Sign-up conversions occurring off Amazon relative to the number of ad impressions. (Sign-up/ Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: Number of Sign-up conversions occurring off Amazon, attributed to an ad click.\n"," Report types: dspCampaign, dspGeo, dspAudience, dspInventory, dspTech\n"," Type: Decimal\n"," Description: Average value associated with a Sign-up conversion. (Sign-up value average = Sign-up value sum / Sign-up)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Sign-up conversion values\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of Sign-up conversions occurring off Amazon, attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: String\n"," Description: A Conversion Path is a sequence of ad touchpoints on the path of a customer to a given conversion event (e.g., purchases, detail page views). A simplified path collapses duplicate ad-touchpoints to the first ad-touchpoint interaction in the path.\n"," Report types: conversionPath\n"," Type: String\n"," Description: The site or group of sites the campaign ran on.\n"," Report types: dspInventory\n"," Type: Integer\n"," Description: The number of times shoppers launched a promoted Alexa skill, attributed to an ad view or click. This can include tap, touch, and voice invocations.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times shoppers launched a promoted Alexa skill, attributed to an ad click. This can include tap, touch, and voice invocations.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Rate of Skill invocation conversions relative to the number of impressions. (Skill invocation rate = Skill invocations / Impressions)\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times shoppers launched a promoted Alexa skill, attributed to an ad view. This can include tap, touch, and voice invocations.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Total cost of ad clicks.\n"," Report types: spCampaigns, spAdvertisedProduct, spGlobalAudiences, sbAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Description: Average number of Sponsored Brands display occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: Average number of Sponsored Brands video occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: Average number of Sponsored Display display occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: Average number of Sponsored Display occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: Average number of Sponsored Display video occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: Average number of Sponsored Products occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: Decimal\n"," Description: Average number of Sponsored TV streaming TV occurrences in the simplified path.\n"," Report types: conversionPath\n"," Type: String\n"," Description: Start date of summary period for a report in the format YYYY-MM-DD.\n"," Report types: spCampaigns, sbCampaigns, sbAdGroups, sbPlacement, spTargeting, sbTargeting, spSearchTerm, sbSearchTerm, spPurchasedProduct, sbPurchasedProduct, sdCampaigns, sdAdGroups, sdAdvertisedProduct, sdPurchasedProduct, stCampaigns, stTargeting, spGrossandInvalids, sbGrossandInvalids, sdGrossandInvalids, sbAds, spAdvertisedProduct, spGlobalAudiences, sbAudiences,dspBidAdjustment, conversionPath, benchmarks, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of Subscribe conversions occurring off Amazon, attributed to an ad view or click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Average cost to acquire a Subscribe conversion off Amazon. (Total cost / Subscribe)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Decimal\n"," Description: Number of Subscribe conversions occurring off Amazon, relative to the number of ad impressions. (Subscribe / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: Number of Subscribe conversions occurring off Amazon, attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Average value associated with a Subscribe conversion. (Subscribe value average = Subscribe value sum / Subscribe)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Sum of Subscribe conversion values\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of Subscribe conversions occurring off Amazon, attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of free trial and paid subscriptions for sponsored products associated with a click on your ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The ratio of how often customers signed up for a free trial or paid subscription for sponsored products when you ad was displayed. This is calculated as free trials and paid subscriptions divided by impressions.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of free trial and paid subscriptions for sponsored products associated with ad impressions.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of free trial and paid subscriptions for sponsored products associated with a click or view on your ad.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The total amount of money spent on media supply.\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: String\n"," Description: The inventory the campaign ran on, for example real-time bidding exchanges or Amazon-owned sites.\n"," Report types: dspInventory, dspAudioAndVideo, dspReachFrequency\n"," Type: Integer\n"," Description: The ID associated to the inventory the campaign ran on.\n"," Report types: dspReachFrequency\n"," Type: String\n"," Description: The Nielsen demographic segment the advertiser is transacting on\n"," Report types: dspCampaign\n"," Type: String\n"," Description: A string representation of the expression object used in the targeting clause.\n"," Report types: spTargeting, spSearchTerm\n"," Type: String\n"," Description: A string representation of the expression object used in the targeting clause.\n"," Report types: sbTargeting, sdTargeting\n"," Type: Integer\n"," Description: The identifier of the targeting expression.\n"," Report types: sbTargeting, sdTargeting\n"," Type: String\n"," Description: The targeting settings applied to the campaign. Examples include segments, content categories, and untargeted if no settings were applied.\n"," Report types: dspAudience\n"," Type: String\n"," Description: The text used in the targeting expression.\n"," Report types: sbTargeting, sdTargeting, stTargeting\n"," Type: String\n"," Description: The type of targeting used in the expression.\n"," Report types: sbTargeting\n"," Type: Decimal\n"," Description: The percentage of top-of-search impressions earned out of all the top-of-search impressions that were eligible for a given date range. Various factors determine the eligibility for an impression including campaign status and targeting status.\n"," Report types: spCampaigns, sbCampaigns, sbTargeting\n"," Type: Integer\n"," Description: Number of times shoppers added products from the brand to their cart, attributed to an ad view or click.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of times shoppers added products from the brand to their cart, attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Rate of Add to Cart conversions for products from the brand relative to the number of ad impressions. (Total ATCR = Total ATC / Impressions)\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Number of times shoppers added products from the brand to their cart, attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of times shoppers added products from the brand to a wish list, gift list, or registry, attributed to an ad view or click.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of times shoppers added products from the brand to a wish list, gift list, or registry, attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Rate of Add to List conversions for products from the brand relative to the number of impressions. (ATLR = ATL / Impressions)\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Number of times shoppers added products from the brand to a wish list, gift list or registry, attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: The total amount of money spent on running the campaign not including 3P fees paid by the agency.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of detail page views for all the brands and products attributed to an ad view or click.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of detail page views for all the brands and products attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Detail page view rate for the brands’ products, relative to the number of ad impressions. (Total DPV / Impressions = Total DPVR)\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Number of detail page views for all products from the brand, attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire an Add to Cart conversion for products from the brand. (Total eCPATC = Total cost / Total ATC)\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire an Add to List conversion for products from the brand. (Total eCPATL = Total cost / Total ATL)\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a detail page view for a product in your brand. (Total eCPDPV = Total cost / Total DPV)\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a purchase conversion for products from the brand. (Total eCPP = Total cost / Total purchases)\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a product review page conversion for products from the brand. (Total eCPPRPV = Total cost / Total PRPV)\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a Subscribe & Save subscription for products from the brand. (Total eCPSnSS = Total cost / Total SnSS)\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Effective (average) revenue for the brands’ products generated per thousand impressions. (Total eRPM = Sales / (Impressions / 1000))\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: The sum of all fees.\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Number of new-to-brand detail page views for all products from the brand, attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: The new-to-brand detail page view rate for products from the brand, relative to the number of ad impressions. (Total NTB - DPV / Impressions = Total DPVR)\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of new-to-brand detail page views for all products from the brand, attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: Number of new-to-brand detail page views for all products from the brand, attributed to an ad view or click.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Effective total cost for new-to-brand detail page view, calculated by cost divided by new-to-brand detail page view\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a new-to-brand purchase conversion for products from the brand. (Total new-to-brand eCPP = Total cost / Total new-to-brand purchases)\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Effective (average) revenue generated per thousand impressions from the brands’ products purchased by new-to-brand shoppers. (Total NTB eRPM = Total NTB Sales / (Impressions / 1000))\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Rate of new-to-brand purchase conversions for products from the brand relative to the number of ad impressions. (Total new-to-brand purchase rate = Total new-to-brand purchases / Impressions)\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Number of new-to-brand purchases for the brands’ products, attributed to an ad view or click. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of new-to-brand purchases for the brands’ products, attributed to an ad click. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Rate of new-to-brand purchase conversions for products from the brand relative to the number of ad impressions. (Total new-to-brand purchase rate = Total new-to-brand purchases / Impressions)\n"," Report types: dspCampaign, dspProduct\n"," Type: Integer\n"," Description: Number of new-to-brand purchases for the brands’ products, attributed to an ad view. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Return on advertising spend for new-to-brand purchases, measured as ad-attributed new-to-brand sales for products from the brand per local currency unit of ad spend. (Total new-to-brand ROAS = Total new to brand product sales / Total cost)\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Sales (in local currency) of the brands’ products purchased by new-to-brand shoppers, attributed to an ad view or click. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days.\n"," Report types: dspCampaign, dspInventory, dspGeo, dspProduct\n"," Type: Integer\n"," Description: Units of products from the brand purchased by shoppers who were new-to-brand, attributed to an ad view or click. A single new-to-brand purchase event can include multiple sold units.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Rate of product review page visits for products from the brand, relative to the number of ad impressions. (Total ATCR = Total ATC / Impressions)\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Number of times shoppers visited a product review page for products from the brand, attributed to an ad view or click.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of times shoppers visited a product review page for products from the brand, attributed to an ad click.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of times shoppers visited a product review page for products from the brand, attributed to an ad view.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Rate of ad-attributed purchase events for products from the brand relative to ad impressions. (Total purchase rate = Total purchases / Impressions)\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Number of times any quantity of a brand product was included in a purchase event, attributed to an ad view or click. Purchase events include new Subscribe & Save subscriptions and video rentals.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of times any quantity of a brand product was included in a purchase event, attributed to an ad click. Purchase events include new Subscribe & Save subscriptions and video rentals.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of times any quantity of a brand product was included in a purchase event, attributed to an ad view. Purchase events include new Subscribe & Save subscriptions and video rentals.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n"," Report types: dspCampaign, dspInventory\n"," Type: Decimal\n"," Description: Sales (in local currency) of the brands’ products, attributed to an ad view or click.\n"," Report types: dspCampaign, dspInventory,  dspTech, dspGeo, dspProduct\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for the brands and products, attributed to an ad view or click. This does not include replenishment subscription orders.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for the brands and products, attributed to an ad click. This does not include replenishment subscription orders.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Decimal\n"," Description: Rate of ad-attributed Subscribe & Save conversions for the brands’ products relative to ad impressions. (Total SnSSR = Total SnSS / Impressions)\n"," Report types: dspCampaign, dspInventory\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for the brands and products, attributed to an ad view. This does not include replenishment subscription orders.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Units of products from the brand purchased, attributed to an ad view or click. A single purchase event can include multiple sold units.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspGeo\n"," Type: Integer\n"," Description: Number of attributed units sold within 14 days of an ad click or view.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspCampaign, dspInventory, dspProduct, dspGeo, sbAudiences, dspTech\n"," Type: Integer\n"," Description: Number of attributed units sold within 14 days of an click or view. Only valid for Sponsored Brands version 3 campaigns, not Sponsored Brands video or multi-ad group (version 4) campaigns. Includes sales attributed to both clicks and views for vCPM campaigns, but only sales attributed to clicks for CPC campaigns.\n"," Report types: sbPurchasedProduct\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of units ordered within 14 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedUnitsOrdered14dOtherSKU.\n"," Report types: sdPurchasedProduct, dspProduct\n"," Type: Integer\n"," Description: Total number of units ordered within 14 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: sdPurchasedProduct\n"," Type: Integer\n"," Description: Number of attributed units sold within 14 days of an ad click.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, dspProduct, dspGeo, sbAudiences\n"," Type: Integer\n"," Description: Total number of units sold within 14 days of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, sbPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Total number of units ordered within 1 day of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Total number of units ordered within 30 days of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Total number of units ordered within 7 days of an ad click.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Total number of units ordered within 14 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: spPurchasedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Total number of units ordered within 1 day of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: spPurchasedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Total number of units ordered within 30 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: spPurchasedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Total number of units ordered within 7 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: spTargeting, spSearchTerm, spPurchasedProduct, spAdvertisedProduct, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Units of promoted products purchased, attributed to an ad click. A single click-attributed purchase event can include multiple sold units. Use Total Units Sold Clicks to see all conversions for products from the brand.\n"," Report types: dspProduct, dspGeo\n"," Type: Integer\n"," Description: Total number of units ordered within 14 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Total number of units ordered within 1 day of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Total number of units ordered within 30 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Total number of units ordered within 7 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: spCampaigns, spTargeting, spSearchTerm, spAdvertisedProduct, spGlobalAudiences, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of attributed units sold within 14 days of an ad view.\n"," Report types: stCampaigns, stTargeting\n"," Type: Decimal\n"," Description: The percentage of impressions where the customer watched the complete video or 5 seconds of the video (whichever is shorter). Sponsored Brands and Sponsored Products video-only metric.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sbAds, spVideoAdExtension\n"," Type: Integer\n"," Description: The number of impressions where the customer watched the complete video or 5 seconds (whichever is shorter). Sponsored Brands and Sponsored Products video-only metric.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sbAds, spVideoAdExtension\n"," Type: Integer\n"," Description: The number of times a video ad was clicked excluding clicks to the navigation (e.g. Play or Pause buttons).\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a video ad played to completion. If rewind occurred, completion was calculated on the total percentage of unduplicated video viewed.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a portion of a video was seen.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of ad clicks after a video ends.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times at least 25% of a video ad played. If rewind occurred, percent complete was calculated on the total percentage of unduplicated video viewed.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a video was served.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times at least 50% of a video ad played. If rewind occurred, percent complete was calculated on the total percentage of unduplicated video viewed.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a user muted the video ad.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a user paused the video ad.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a video was replayed.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a user unpaused the video ad.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a video was skipped backwards.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times an ad was skipped forward.\n"," Report types: dspCampaign, dspInventory, dspProduct, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a video ad was started.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times at least 75% of a video ad played. If rewind occurred, percent complete was calculated on the total percentage of unduplicated video viewed.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of times a user unmuted the video ad.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of impressions where the video was viewed to 100%.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, spVideoAdExtension\n"," Type: Integer\n"," Description: The number of video downloads relative to the number of impressions. (Video download rate = Video downloads / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of times a video was downloaded for the featured product.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of video downloads attributed to ad click-throughs.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of video downloads attributed to ad impressions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of impressions where the video was viewed to 25%.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, spVideoAdExtension\n"," Type: Integer\n"," Description: The number of impressions where the video was viewed to 50%.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, spVideoAdExtension\n"," Type: Integer\n"," Description: The number of times a video was streamed (played without downloading).\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of video streams attributed to ad click-throughs.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of video streams relative to the number of impressions. (Video stream rate = Video streams / Impressions)\n"," Report types: dspCampaign, dspInventory, dspAudience\n"," Type: Integer\n"," Description: The number of video streams attributed to ad impressions.\n"," Report types: dspCampaign, dspInventory, dspTech, dspGeo, dspAudience\n"," Type: Integer\n"," Description: The number of impressions where the video was viewed to 75%.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, stCampaigns, stTargeting, sbAds, spVideoAdExtension\n"," Type: String\n"," Description: The type of video creative served with the ad.\n"," Report types: spVideoAdExtension\n"," Type: Integer\n"," Description: The number of impressions where a customer unmuted the video.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sbAds\n"," Type: Decimal\n"," Description: Click-through rate for views (clicks divided by views).\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sbAds, spVideoAdExtension\n"," Type: Decimal\n"," Description: View-through rate (vtr). Views divided by impressions.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sdCampaigns, sdAdGroups, sdTargeting, sdAdvertisedProduct, sbAds, dspCampaign, dspInventory, spVideoAdExtension\n"," Type: Integer\n"," Description: Number of impressions that met the Media Ratings Council (MRC) viewability standard. See viewability details at https://advertising.amazon.com/library/guides/viewability.\n"," Report types: sbCampaigns, sbAdGroups, sbPlacement, sbTargeting, sbSearchTerm, sbAds, dspCampaign, dspInventory, dspGeo, dspTech, spPromptAdExtension, sbPromptAdExtension, spVideoAdExtension\n"," Type: Decimal\n"," Report types: The percentage of auctions your line item won. winRate = bids won / bids. The values range from 0 to 100 where 100 represents 100%. Note this is calculated using bids won in auction directly, not impression data that may involve traffic validation.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":null,"path":"/en-us/guides/reporting/v3/faq","content":[" Get answers to commonly asked questions about Amazon Ads version 3 reporting.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":2,"text":"About version 3"},"path":"/en-us/guides/reporting/v3/faq","content":[],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"What are the key needs for this latest API update?"},"path":"/en-us/guides/reporting/v3/faq","content":[" Campaign reporting is currently fragmented across Amazon Ads products. This results in developers spending more time and resources accessing and reconciling data, and leaving campaign managers frustrated waiting for the metrics that they need to optimize. The API enhancements for reporting aim to alleviate these challenges by consolidating all campaign reporting data in one place, streamlining the process of turning raw data into actionable insights. Now, developers and campaign managers can spend less time organizing data and more time solving business challenges.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"What are the benefits of the new reporting updates to the API compared to version 2?"},"path":"/en-us/guides/reporting/v3/faq","content":[" The key benefits that these reporting updates provide are:\n","All reports can be accessed from a single interface, have standardized metric names, and contain the same dimension names. 2. Date ranges up to 31 days, instead of one date at a time. 3. Longer historical reporting window of up to 95 days (versus 60 days for version 2 reports). 4. Common report schema for all ad programs. Currently we are starting with Sponsored Products and one Sponsored Brands report. 5. Supports JSON (GZIP files). Support for CSV files coming soon.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"What is the benefit of common request and response schemas? "},"path":"/en-us/guides/reporting/v3/faq","content":[" Currently, when reports for different ad products are obtained, it is a challenge to use these reports directly as they have different request schemas and metric names. The version 3 reporting endpoint provides a standard request schema and metric names for all reports, so consolidation of data can be streamlined and used to gain insights faster.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"In what regions will the updated API be available?"},"path":"/en-us/guides/reporting/v3/faq","content":[" The reporting updates are available worldwide (NA, EU, FE) wherever you can run sponsored ads.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"How do I start using the new API updates?"},"path":"/en-us/guides/reporting/v3/faq","content":[" See Get started with the version 3 reporting for detailed instructions on getting access to the API, the API reference, and our getting started tutorial.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"What reports are currently available?"},"path":"/en-us/guides/reporting/v3/faq","content":[" A complete list of reports and their mapping to version 2 reports can be found in our Migration guide.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":2,"text":"About version 2 deprecation"},"path":"/en-us/guides/reporting/v3/faq","content":[],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"Our integration uses the version 2 API specifications. Do we have to switch to the new specifications? "},"path":"/en-us/guides/reporting/v3/faq","content":[" Moving forward, there will be no changes to any existing version so you can continue using the version 2 for now. \n"," We will be deprecating the version 2 Sponsored Products endpoints (version 2) on March 30th, 2023, so we recommend upgrading as soon as possible. The new version adds upgraded historical data and date range functionality that could meet your data needs better. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"Does this mean the version 2 reporting endpoints will be deprecated?"},"path":"/en-us/guides/reporting/v3/faq","content":[" Yes, the current version 2 reporting endpoints for Sponsored Products will be deprecated on March 30th, 2023. This should give you sufficient time to migrate to the new schema. If you have any concerns with this timeline, contact the API support team at ads-api-support@amazon.com or reach out to your Amazon partner account manager.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":2,"text":"General questions"},"path":"/en-us/guides/reporting/v3/faq","content":[],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"What should I do if I have issues connecting to the new API or consuming the reports from it?"},"path":"/en-us/guides/reporting/v3/faq","content":[" You can report any difficulties connecting to the API by contacting the API support team at ads-api-support@amazon.com or reach out to your partner account manager for more information.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"What is the difference between an export and a report?"},"path":"/en-us/guides/reporting/v3/faq","content":[" Exports contain metadata about the campaign structure of an account at the time the export request was made. Reports contain campaign performance data, and may also contain metadata. For best performance we recommend requesting all metadata via exports, then joining metadata and performance data using an identifier or name.\n","Learn more about Reports. - Learn more about Exports. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"How long does it take for sponsored ads reporting data to become available?"},"path":"/en-us/guides/reporting/v3/faq","content":[" Initial impression and click data is available using the API within 12 hours. Note that small changes to impression and click data may happen up to three days after the initial click date due to the traffic validation process. We recommend retrieving click and impression data again after three days to ensure you have the latest data. \n"," Initial conversion data is available within 24 hours, but may change as part of the restatement process. Restatements of conversion data occur 1, 7, and 28 days after the conversion event. Because conversions are reported on the date of the ad interaction, restatement includes all dates in your attribution window. For example, if your attribution window is 14 days, restatement can update attribution up to 42 days (14 plus 28) after the report date.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"How long does a report take to generate?"},"path":"/en-us/guides/reporting/v3/faq","content":[" Report generation can take as long as three hours. \n"," Reports that request many fields may take longer to generate. To avoid large reports, you can:\n","specify only necessary metrics in your report request.  - make report requests that do not specify metadata (for example, campaignName, campaignId, adGroupName, adGroupId) in the report request body itself. Instead, retrieve metadata fields using an export and then merge the retrieved metadata into your report.\n"," Repeated calls to check report status may generate a 429 response, indicating that your requests have been throttled. To retrieve reports programmatically, your application logic should institute a delay between requests. For more information, see Retry logic with exponential backoff.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"How often should I pull a report?"},"path":"/en-us/guides/reporting/v3/faq","content":[" We currently recommend 1-2 report requests, per advertiser, per day, for each report type. This is based on data refresh rates.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"Why are my reports being rate limited?"},"path":"/en-us/guides/reporting/v3/faq","content":[" You may experience report limiting during busy times of day. To avoid excessive rate limiting, spread report requests throughout the day rather than requesting all at once.\n"," For more best practices, see Rate limiting.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"Why does the search term report only have a subset of the items included in the advertising console report?"},"path":"/en-us/guides/reporting/v3/faq","content":[" The search term report in the advertising console contains all search terms that had an impression, regardless of if that term resulted in a click. The API search term report only contains impressions that also had at least one click. Therefore you will see a difference in the number of entries between the console and API reports.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 3)","sectionHeader":{"type":3,"text":"Why is my report missing some Sponsored Brands records?"},"path":"/en-us/guides/reporting/v3/faq","content":[],"documentType":"guide"},{"title":"Creating ADSP Reports via API","sectionHeader":null,"path":"/en-us/guides/reporting/dsp/creating-reports","content":[" There are two methods of pulling Amazon DSP reports using our offline report API. The method you use depends on whether the account permission of the advertiser is Admin or ADSP Reports within your manager account. \n","|Account permission\t|Definition\t|Advertiser-to-Manager-Account relationship\t|\n","|---\t|---\t|---\t|\n","|Admin\t|The advertiser was created by this manager account and has a billing relationship with this manager account. An advertiser can only have an \"Admin\" relationship with one manager account.\t|many-to-one\t|\n","|ADSP Reports\t|The advertiser was linked to the manager account and does not have a billing relationship with this manager account. An advertiser can have an \"ADSP Reports\" relationship with multiple manager accounts. This method can be used to pull reports for managed service advertisers.\t|many-to-many\t|\n"],"documentType":"guide"},{"title":"Creating ADSP Reports via API","sectionHeader":{"type":2,"text":"Admin  "},"path":"/en-us/guides/reporting/dsp/creating-reports","content":[" When the account permission is Admin, this means this manager account created this advertiser. To use this method, your Manager Account will need to have Admin account permission for the advertiser. To check this, click on the Accounts tab and look at the Account permission column. It should say Admin next to the advertiser you want to pull reports for.\n"," Process for report API:\n","Make sure your Login with Amazon application is authorized by a DSP user on a Manager Account that has Admin account permission for the advertiser. 2. Retrieve your profileId using the GET/v2/profiles endpoint.\n","Pull the list of advertisers using GET/dsp/advertisers. Include the profileId in the Amazon-Advertising-API-Scope header.\n","Create a report using POST/reporting/reports. Include up to 100 advertiserIds in configuration.filters.values.\n"],"documentType":"guide"},{"title":"Creating ADSP Reports via API","sectionHeader":{"type":2,"text":"ADSP Reports "},"path":"/en-us/guides/reporting/dsp/creating-reports","content":[" The account permission is ADSP Reports when a user manually links an existing advertiser to a manager account. This process grants read-only reporting permissions at the individual advertiser level. It can be used when you want to give reporting-only access for only a specific advertiser(s) rather than all advertisers. This method can be used to pull reports for Amazon managed service advertisers.\n"," If the advertiser has already been linked, you should see an Account permission of ADSP Reports in your manager account Accounts tab:\n"," If the advertiser has not yet been linked, follow the process below. This process can only be completed using the Manager Account UI; there is no API-only solution at this time.  \n"," Process to link advertisers to manager account (if this is already done, skip to Report API process below):\n","Access the Manager Accounts UI.  2. Choose the Manager Account you wish to use, or create a new one. 3. Within the Manager Account, click Accounts, then Add account > Link existing account.  4. Click Request access. 5. Enter the DSP advertiser ID and marketplace. You can get these from a user who has admin access to the advertisers. If these are Amazon managed service advertisers, you can get this information from your Amazon account representative. 6. Click Add account. 7. Copy the approval link associated with the advertisers you just requested, then provide this URL to the user who has admin access to the advertisers. 8. Once approval has been granted, in your Manager Account Accounts tab, you should see an Account permission of ADSP Reports for this advertiser.\n"," Report API process:\n","To use the API, a user with access to this manager account needs to authorize your Login with Amazon application.  2. Retrieve the advertiser IDs that your manager account has access to using the GET /managerAccounts endpoint.\n"," Example response:\n","When creating a report using POST/reporting/reports, use the dspAdvertiserId from the above response in the Amazon-Ads-AccountId header AND in the configuration.filters.values array. Note that you can only create a report for one advertiser per report using this method.\n"," Example call:\n"],"documentType":"guide"},{"title":"Creating ADSP Reports via API","sectionHeader":{"type":2,"text":"Summary"},"path":"/en-us/guides/reporting/dsp/creating-reports","content":["|Account permission\t|Header used in /reporting/reports\t|Endpoint to retrieve header value\t|Works for Amazon managed service?\t|# of advertiserIds per report\t|Profile can be retrieved from GET /v2/profiles?\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Admin\t|Amazon-Advertising-API-Scope (value=profileId)\t|GET/v2/profiles\t|No\t|Up to 100\t|yes\t|\n","|ADSP Reports\t|Amazon-Ads-AccountId (value=dspAdvertiserId)\t|GET/managerAccounts\t|Yes\t|1\t|no\t|\n"],"documentType":"guide"},{"title":"Creating ADSP Reports via API","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/reporting/dsp/creating-reports","content":[" For more information on requesting reports, see:\n","Version 3 reporting overview \\* Get started with version 3 reports\n"],"documentType":"guide"},{"title":"Amazon DSP Reporting to v3","sectionHeader":null,"path":"/en-us/reference/migration-guides/dsp-reporting","content":[],"documentType":"guide"},{"title":"Amazon DSP Reporting to v3","sectionHeader":{"type":2,"text":"Metrics"},"path":"/en-us/reference/migration-guides/dsp-reporting","content":[" Version 3 of the reporting API introduces some new metric or column names. Use this table to understand which metrics have changed.\n","| Amazon DSP reporting | Amazon DSP v3 reporting |\n","\\|----------------------\\|------------------------\\|\n","| atc14d | addToCart |\n","| atcClicks14d | addToCartClicks |\n","| atcr14d | addToCartRate |\n","| atcViews14d | addToCartViews |\n","| atl14d | addToList |\n","| atlClicks14d | addToListClicks |\n","| atlr14d | addToListRate |\n","| atlViews14d | addToListViews |\n","| addedToShoppingCart14d | addToShoppingCart |\n","| addedToShoppingCartClicks14d | addToShoppingCartClicks |\n","| addedToShoppingCartCPA14d | addToShoppingCartCPA |\n","| addedToShoppingCartCVR14d | addToShoppingCartCVR |\n","| addedToShoppingCartViews14d | addToShoppingCartViews |\n","| addToWatchlist14d | addToWatchlist |\n","| addToWatchlistClicks14d | addToWatchlistClicks |\n","| addToWatchlistCVR14d | addToWatchlistRate |\n","| addToWatchlistViews14d | addToWatchlistViews |\n","| amazonAudienceFee | amazonDSPAudienceFee |\n","| amazonPlatformFee | amazonDSPConsoleFee |\n","| application14d | application |\n","| applicationClicks14d | applicationClicks |\n","| applicationCPA14d | applicationCPA |\n","| applicationCVR14d | applicationCVR |\n","| applicationViews14d | applicationViews |\n","| brandSearch14d | brandSearches |\n","| brandSearchClicks14d | brandSearchesClicks |\n","| brandSearchViews14d | brandSearchesViews |\n","| brandSearchRate14d | brandSearchRate |\n","| checkout14d | checkout |\n","| checkoutClicks14d | checkoutClicks |\n","| checkoutCPA14d | checkoutCPA |\n","| checkoutCVR14d | checkoutCVR |\n","| checkoutViews14d | checkoutViews |\n","| contact14d | contact |\n","| contactClicks14d | contactClicks |\n","| contactCPA14d | contactCPA |\n","| contactCVR14d | contactCVR |\n","| contactViews14d | contactViews |\n","| dpvClicks14d | detailPageViewClicks |\n","| dpvr14d | detailPageViewRate |\n","| dpv14d | detailPageViews |\n","| dpvViews14d | detailPageViewViews |\n","| downloadedVideoPlayRate14d | downloadedVideoPlayRate |\n","| downloadedVideoPlays14d | downloadedVideoPlays |\n","| downloadedVideoPlaysClicks14d | downloadedVideoPlaysClicks |\n","| downloadedVideoPlaysViews14d | downloadedVideoPlaysViews |\n","| eCPAtc14d | eCPAddToCart |\n","| eCPAtl14d | eCPAddtoList |\n","| addToWatchlistCPA14d | eCPAddToWatchlist |\n","| brandSearchCPA14d | eCPBrandSearch |\n","| eCPDPV14d | eCPDetailPageView |\n","| eCPDVP14d | eCPDownloadedVideoPlays |\n","| eCPP14d | eCPP |\n","| eCPPT14d | eCPPlayTrailer |\n","| eCPPRPV14d | eCPProductReviewPageVisit |\n","| ecpr14d | eCPRental |\n","| eCPnewSubscribeAndSave14d | eCPSubscribeAndSave |\n","| ecpvc | eCPVideoAdCompletion |\n","| ecpvd14d | eCPVideoDownload |\n","| eCPVS14d | eCPVideoStream |\n","| eRPM14d | eRPM |\n","| invalidClickThroughsRate | invalidClickThroughRate |\n","| lead14d | lead |\n","| leadClicks14d | leadClicks |\n","| leadCPA14d | leadCPA |\n","| leadCVR14d | leadCVR |\n","| leadViews14d | leadViews |\n","| lineItemName | lineItemName |\n","| mobileAppFirstStartClicks14d | mobileAppFirstStartClicks |\n","| mobileAppFirstStartsCPA14d | mobileAppFirstStartCPA |\n","| mobileAppFirstStartCVR14d | mobileAppFirstStartCVR |\n","| mobileAppFirstStarts14d | mobileAppFirstStarts |\n","| mobileAppFirstStartViews14d | mobileAppFirstStartViews |\n","| newToBrandECPP14d | NewToBrandECPP |\n","| newToBrandERPM14d | newToBrandERPM |\n","| newToBrandProductSales14d | newToBrandProductSales |\n","| newToBrandPurchaseRate14d | newToBrandPurchaseRate |\n","| newToBrandPurchases14d | newToBrandPurchases |\n","| newToBrandPurchasesClicks14d | newToBrandPurchasesClicks |\n","| newToBrandPurchasesViews14d | newToBrandPurchasesViews |\n","| newToBrandROAS14d | newToBrandROAS |\n","| newToBrandUnitsSold14d | newToBrandUnitsSold |\n","| offAmazonClicks14d | offAmazonClicks |\n","| totalPixel14d | offAmazonConversions |\n","| totalPixelCPA14d | offAmazonCPA |\n","| totalPixelCVR14d | offAmazonCVR |\n","| offAmazonECPP14d | offAmazonECPP |\n","| offAmazonERPM14d | offAmazonERPM |\n","| offAmazonProductSales14d | offAmazonProductSales |\n","| productPurchasedCVR | offAmazonPurchaseRate |\n","| productPurchased | offAmazonPurchases |\n","| offAmazonPurchasesClicks14d | offAmazonPurchasesClicks |\n","| offAmazonPurchasesViews14d | offAmazonPurchasesViews |\n","| offAmazonROAS14d | offAmazonROAS |\n","| offAmazonUnitsSold14d | offAmazonUnitsSold |\n","| offAmazonViews14d | offAmazonViews |\n","| other14d | other |\n","| otherClicks14d | otherClicks |\n","| otherCPA14d | otherCPA |\n","| otherCVR14d | otherCVR |\n","| otherViews14d | otherViews |\n","| pageViewClicks14d | pageViewClicks |\n","| pageViewCPA14d | pageViewCPA |\n","| pageViewCVR14d | pageViewCVR |\n","| pageView14d | pageViews |\n","| pageViewViews14d | pageViewViews |\n","| playTrailerRate14d | playTrailerRate |\n","| playTrailers14d | playTrailers |\n","| playerTrailersClicks14d | playTrailersClicks |\n","| playTrailersViews14d | playTrailersViews |\n","| pRPVr14d | productReviewPageVisitRate |\n","| pRPV14d | productReviewPageVisits |\n","| pRPVClicks14d | productReviewPageVisitsClicks |\n","| pRPVViews14d | productReviewPageVisitsViews |\n","| purchaseRate14d | purchaseRate |\n","| purchases14d | purchases |\n","| purchasesClicks14d | purchasesClicks |\n","| purchasesViews14d | purchasesViews |\n","| percentOfPurchasesNewToBrand14d | newToBrandPurchasesPercentage |\n","| rentalRate14d | rentalRate |\n","| rentals14d | rentals |\n","| rentalsClicks14d | rentalsClicks |\n","| rentalsViews14d | rentalsViews |\n","| ROAS14d | ROAS |\n","| sales14d | sales |\n","| search14d | search |\n","| searchClicks14d | searchClicks |\n","| searchCPA14d | searchCPA |\n","| searchCVR14d | searchCVR |\n","| searchViews14d | searchViews |\n","| signUpButton14d | signUp |\n","| signUpButtonClicks14d | signUpClicks |\n","| signUpCPA14d | signUpCPA |\n","| signUpCVR14d | signUpCVR |\n","| signUpViews14d | signUpViews |\n","| subscribe14d | subscribe |\n","| subscriptionPage14d | subscribe |\n","| newSubscribeAndSave14d | newSubscribeAndSave |\n","| newSubscribeAndSaveClicks14d | newSubscribeAndSaveClicks |\n","| newSubscribeAndSaveRate14d | newSubscribeAndSaveRate |\n","| newSubscribeAndSaveViews14d | newSubscribeAndSaveViews |\n","| subscribeClicks14d | subscribeClicks |\n","| subscribeCPA14d | subscribeCPA |\n","| subscribeCVR14d | subscribeCVR |\n","| subscriptionPageCVR14d | subscribeCVR |\n","| subscribeViews14d | subscribeViews |\n","| subscriptionPageViews14d | subscribeViews |\n","| totalAddToCart14d | totalAddToCart |\n","| totalAddToCartClicks14d | totalAddToCartClicks |\n","| totalAddToCartCVR14d | totalAddToCartRate |\n","| totalAddToCartViews14d | totalAddToCartViews |\n","| totalAddToList14d | totalAddToList |\n","| totalAddToListClicks14d | totalAddToListClicks |\n","| totalAddToListCVR14d | totalAddToListRate |\n","| totalAddToListViews14d | totalAddToListViews |\n","| totalDetailPageViews14d | totalDetailPageView |\n","| totalDetailPageClicks14d | totalDetailPageViewClicks |\n","| totalDetailPageViewsCVR14d | totalDetailPageViewRate |\n","| totalDetailPageViewViews14d | totalDetailPageViewViews |\n","| totalAddToCartCPA14d | totalECPAddtoCart |\n","| totalAddToListCPA14d | totalECPAddToList |\n","| totalDetaiPageViewCPA14d | totalECPDetailPageView |\n","| totalECPP14d | totalECPP |\n","| totalECPPRPV14d | totalECPProductReviewPageVisit |\n","| totalSubscribeAndSaveSubscriptionCPA14d | totalECPSubscribeAndSave |\n","| totalERPM14d | totalERPM |\n","| totalNewToBrandECPP14d | totalNewtoBrandECPP |\n","| totalNewToBrandERPM14d | totalNewtoBrandERPM |\n","| totalNewToBrandPurchaseRate14d | totalNewtoBrandPurchaseRate |\n","| totalNewToBrandPurchases14d | totalNewtoBrandPurchases |\n","| totalNewToBrandPurchasesClicks14d | totalNewtoBrandPurchasesClicks |\n","| totalNewToBrandPurchasesViews14d | totalNewtoBrandPurchasesViews |\n","| totalNewToBrandROAS14d | totalNewtoBrandROAS |\n","| totalNewToBrandProductSales14d | totalNewtoBrandSales |\n","| totalNewToBrandUnitsSold14d | totalNewToBrandUnitsSold |\n","| totalPRPVr14d | totalProductReviewPageVisitRate |\n","| totalPRPV14d | totalProductReviewPageVisits |\n","| totalPRPVClicks14d | totalProductReviewPageVisitsClicks |\n","| totalPRPVViews14d | totalProductReviewPageVisitsViews |\n","| totalPurchaseRate14d | totalPurchaseRate |\n","| totalPurchases14d | totalPurchases |\n","| totalPurchasesClicks14d | totalPurchasesClicks |\n","| totalPurchasesViews14d | totalPurchasesViews |\n","| totalROAS14d | totalROAS |\n","| totalSales14d | totalSales |\n","| totalSubscribeAndSaveSubscriptions14d | totalSubscribeAndSave |\n","| totalSubscribeAndSaveSubscriptionClicks14d | totalSubscribeAndSaveClicks |\n","| totalSubscribeAndSaveSubscriptionCVR14d | totalSubscribeAndSaveRate |\n","| totalSubscribeAndSaveSubscriptionViews14d | totalSubscribeAndSaveViews |\n","| totalUnitsSold14d | totalUnitsSold |\n","| unitsSold14d | unitsSold |\n","| videoComplete | videoAdComplete |\n","| videoCompletionRate | videoAdCompletionRate |\n","| videoFirstQuartile | videoAdFirstQuartile |\n","| videoMidpoint | videoAdMidpoint |\n","| videoMute | videoAdMute |\n","| videoPause | videoAdPause |\n","| videoResume | videoAdResume |\n","| videoStart | videoAdStart |\n","| videoThirdQuartile | videoAdThirdQuartile |\n","| videoUnmute | videoAdUnmute |\n","| videoDownloadRate14d | videoDownloadRate |\n","| videoDownloads14d | videoDownloads |\n","| videoDownloadsClicks14d | videoDownloadsClicks |\n","| videoDownloadsViews14d | videoDownloadsViews |\n","| videoStreams14d | videoStreams |\n","| videoStreamsClicks14d | videoStreamsClicks |\n","| videoStreamsRate14d | videoStreamsRate |\n","| videoStreamsViews14d | videoStreamsViews |\n"],"documentType":"guide"},{"title":"Amazon DSP Reporting to v3","sectionHeader":{"type":2,"text":"Deprecated metrics"},"path":"/en-us/reference/migration-guides/dsp-reporting","content":[" The following metrics have been deprecated: surveyStartClicks14d, surveyStart14d, surveyStartCPA14d, surveyStartCVR14d, surveyStartViews14d, surveyFinishClicks14d, surveyFinish14d, surveyFinishCPA14d, surveyFinishCVR14d, surveyFinishViews14d, bannerInteractionClicks14d, bannerInteraction14d, bannerInteractionCPA14d, bannerInteractionCVR14d, bannerInteractionViews14d, widgetInteractionClicks14d, widgetInteraction14d, widgetInteractionCPA14d, widgetInteractionCVR14d, widgetInteractionViews14d, gameInteractionClicks14d, gameInteraction14d, gameInteractionCPA14d, gameInteractionCVR14d, gameInteractionViews14d, emailLoadClicks14d, emailLoad14d, emailLoadCPA14d, emailLoadCVR14d, emailLoadViews14d, emailInteractionClicks14d, emailInteraction14d, emailInteractionCPA14d, emailInteractionCVR14d, emailInteractionViews14d, submitButtonClicks14d, submitButton14d, submitButtonCPA14d, submitButtonCVR14d, submitButtonViews14d, purchaseButtonClicks14d, purchaseButton14d, purchaseButtonCPA14d, purchaseButtonCVR14d, purchaseButtonViews14d, clickOnRedirectClicks14d, clickOnRedirect14d, clickOnRedirectCPA14d, clickOnRedirectCVR14d, clickOnRedirectViews14d, dropDownSelectionClicks14d, dropDownSelection14d, dropDownSelectionCPA14d, dropDownSelectionCVR14d, dropDownSelectionViews14d, subscriptionButtonClicks14d, subscriptionButton14d, subscriptionButtonCPA14d, subscriptionButtonCVR14d, subscriptionButtonViews14d, successPageClicks14d, successPage14d, successPageCPA14d, successPageCVR14d, successPageViews14d, thankYouPageClicks14d, thankYouPage14d, thankYouPageCPA14d, thankYouPageCVR14d, thankYouPageViews14d, registrationFormClicks14d, registrationForm14d, registrationFormCPA14d, registrationFormCVR14d, registrationFormViews14d, registrationConfirmPageClicks14d, registrationConfirmPage14d, registrationConfirmPageCPA14d, registrationConfirmPageCVR14d, registrationConfirmPageViews14d, storeLocatorPageClicks14d, storeLocatorPage14d, storeLocatorPageCPA14d, storeLocatorPageCVR14d, storeLocatorPageViews14d, brandStoreEngagement1Clicks, brandStoreEngagement1, brandStoreEngagement1CPA, brandStoreEngagement1CVR, brandStoreEngagement1Views, brandStoreEngagement2Clicks, brandStoreEngagement2, brandStoreEngagement2CPA, brandStoreEngagement2CVR, brandStoreEngagement2Views, brandStoreEngagement3Clicks, brandStoreEngagement3, brandStoreEngagement3CPA, brandStoreEngagement3CVR, brandStoreEngagement3Views, brandStoreEngagement4Clicks, brandStoreEngagement4, brandStoreEngagement4CPA, brandStoreEngagement4CVR, brandStoreEngagement4Views, brandStoreEngagement5Clicks, brandStoreEngagement5, brandStoreEngagement5CPA, brandStoreEngagement5CVR, brandStoreEngagement5Views, brandStoreEngagement6Clicks, brandStoreEngagement6, brandStoreEngagement6CPA, brandStoreEngagement6CVR, brandStoreEngagement6Views, brandStoreEngagement7Clicks, brandStoreEngagement7, brandStoreEngagement7CPA, brandStoreEngagement7CVR, brandStoreEngagement7Views, marketingLandingPageClicks14d, marketingLandingPageCPA14d, marketingLandingPageCVR14d, marketingLandingPageViews14d, homepageVisitClicks14d, homepageVisit14d, homepageVisitCPA14d, homepageVisitCVR14d, homepageVisitViews14d, videoStartedClicks, videoStarted, videoStartedCPA, videoStartedCVR, videoStartedViews, videoEndClicks, videoCompleted, videoCompletedCPA, videoCompletedCVR, videoCompletedViews, messageSentClicks14d, messageSent14d, messageSentCPA14d, messageSentCVR14d, messageSentViews14d, mashupClickToPageClicks, mashupClickToPage, mashupClickToPageCPA, mashupClickToPageCVR, mashupClickToPageViews, mashupBackupImageClicks, mashupBackupImage, mashupBackupImageCPA, mashupBackupImageCVR, mashupBackupImageViews, mashupAddToCartClicks14d, mashupAddToCart14d, mashupAddToCartCPA14d, mashupAddToCartClickCVR14d, mashupAddToCartViews14d, mashupAddToWishlistClicks14d, mashupAddToWishlist14d, mashupAddToWishlistCPA14d, mashupAddToWishlistCVR14d, mashupAddToWishlistViews14d, mashupSubscribeAndSaveClick14d, mashupSubscribeAndSave14d, mashupSubscribeAndSaveCPA14d, mashupSubscribeAndSaveCVR14d, mashupSubscribeAndSaveClickViews14d, mashupClipCouponClickClicks14d, mashupClipCouponClick14d, mashupClipCouponClickCPA14d, mashupClipCouponClickCVR14d, mashupClipCouponClickViews14d, signUpPageClicks14d, signUpPage14d, signUpPageCPA14d, signUpPageCVR14d, signUpPageViews14d, mashupShopNowClickClicks14d, mashupShopNowClick14d, mashupShopNowClickCPA14d, mashupShopNowClickCVR14d, mashupShopNowClickViews14d, referralClicks14d, referral14d, referralCPA14d, referralCVR14d, referralViews14d, acceptClicks14d, accept14d, acceptCPA14d, acceptCVR14d, acceptViews14d, declineClicks14d, decline14d, declineCPA14d, declineCVR14d, declineViews14d, gameLoadClicks14d, gameLoad14d, gameLoadCPA14d, gameLoadCVR14d, gameLoadViews14d, widgetLoadClicks14d, widgetLoad14d, widgetLoadCPA14d, widgetLoadCVR14d, widgetLoadViews14d, atc14d, atcClicks14d, atcr14d, atcViews14d, atl14d, atlClicks14d, atlr14d, atlViews14d, addedToShoppingCart14d, addedToShoppingCartClicks14d, addedToShoppingCartCPA14d, addedToShoppingCartCVR14d, addedToShoppingCartViews14d, addToWatchlist14d, addToWatchlistClicks14d, addToWatchlistCVR14d, addToWatchlistViews14d, amazonAudienceFee, amazonPlatformFee, application14d, applicationClicks14d, applicationCPA14d, applicationCVR14d, applicationViews14d, brandSearch14d, brandSearchClicks14d, brandSearchViews14d, brandSearchRate14d, checkout14d, checkoutClicks14d, checkoutCPA14d, checkoutCVR14d, checkoutViews14d, contact14d, contactClicks14d, contactCPA14d, contactCVR14d, contactViews14d, dpvClicks14d, dpvr14d, dpv14d, dpvViews14d, downloadedVideoPlayRate14d, downloadedVideoPlays14d, downloadedVideoPlaysClicks14d, downloadedVideoPlaysViews14d, eCPAtc14d, eCPAtl14d, addToWatchlistCPA14d, brandSearchCPA14d, eCPDPV14d, eCPDVP14d, eCPP14d, eCPPT14d, eCPPRPV14d, ecpr14d, eCPnewSubscribeAndSave14d, ecpvc, ecpvd14d, eCPVS14d, eRPM14d, invalidClickThroughsRate, lead14d, leadClicks14d, leadCPA14d, leadCVR14d, leadViews14d, lineItemName, mobileAppFirstStartClicks14d, mobileAppFirstStartsCPA14d, mobileAppFirstStartCVR14d, mobileAppFirstStarts14d, mobileAppFirstStartViews14d, newToBrandECPP14d, newToBrandERPM14d, newToBrandProductSales14d, newToBrandPurchaseRate14d, newToBrandPurchases14d, newToBrandPurchasesClicks14d, newToBrandPurchasesViews14d, newToBrandROAS14d, newToBrandUnitsSold14d, offAmazonClicks14d, totalPixel14d, totalPixelCPA14d, totalPixelCVR14d, offAmazonECPP14d, offAmazonERPM14d, offAmazonProductSales14d, productPurchasedCVR, productPurchased, offAmazonPurchasesClicks14d, offAmazonPurchasesViews14d, offAmazonROAS14d, offAmazonUnitsSold14d, offAmazonViews14d, other14d, otherClicks14d, otherCPA14d, otherCVR14d, otherViews14d, pageViewClicks14d, pageViewCPA14d, pageViewCVR14d, pageView14d, pageViewViews14d, playTrailerRate14d, playTrailers14d, playerTrailersClicks14d, playTrailersViews14d, pRPVr14d, pRPV14d, pRPVClicks14d, pRPVViews14d, purchaseRate14d, purchases14d, purchasesClicks14d, purchasesViews14d, percentOfPurchasesNewToBrand14d, rentalRate14d, rentals14d, rentalsClicks14d, rentalsViews14d, ROAS14d, sales14d, search14d, searchClicks14d, searchCPA14d, searchCVR14d, searchViews14d, eCPC, eCPM, signUpButton14d, signUpButtonClicks14d, signUpCPA14d, signUpCVR14d, signUpViews14d, subscribe14d, subscriptionPage14d, newSubscribeAndSave14d, newSubscribeAndSaveClicks14d, newSubscribeAndSaveRate14d, newSubscribeAndSaveViews14d, subscribeClicks14d, subscribeCPA14d, subscribeCVR14d, subscriptionPageCVR14d, subscribeViews14d, subscriptionPageViews14d, totalAddToCart14d, totalAddToCartClicks14d, totalAddToCartCVR14d, totalAddToCartViews14d, totalAddToList14d, totalAddToListClicks14d, totalAddToListCVR14d, totalAddToListViews14d, totalDetailPageViews14d, totalDetailPageClicks14d, totalDetailPageViewsCVR14d, totalDetailPageViewViews14d, totalAddToCartCPA14d, totalAddToListCPA14d, totalDetaiPageViewCPA14d, totalECPP14d, totalECPPRPV14d, totalSubscribeAndSaveSubscriptionCPA14d, totalERPM14d, totalNewToBrandECPP14d, totalNewToBrandERPM14d, totalNewToBrandPurchaseRate14d, totalNewToBrandPurchases14d, totalNewToBrandPurchasesClicks14d, totalNewToBrandPurchasesViews14d, totalNewToBrandROAS14d, totalNewToBrandProductSales14d, totalNewToBrandUnitsSold14d, totalPRPVr14d, totalPRPV14d, totalPRPVClicks14d, totalPRPVViews14d, totalPurchaseRate14d, totalPurchases14d, totalPurchasesClicks14d, totalPurchasesViews14d, totalROAS14d, totalSales14d, totalSubscribeAndSaveSubscriptions14d, totalSubscribeAndSaveSubscriptionClicks14d, totalSubscribeAndSaveSubscriptionCVR14d, totalSubscribeAndSaveSubscriptionViews14d, totalUnitsSold14d, unitsSold14d, videoComplete, videoCompletionRate, videoFirstQuartile, videoMidpoint, videoMute, videoPause, videoResume, videoStart, videoThirdQuartile, videoUnmute, videoDownloadRate14d, videoDownloads14d, videoDownloadsClicks14d, videoDownloadsViews14d, videoStreams14d, videoStreamsClicks14d, videoStreamsRate14d, videoStreamsViews14d\n"],"documentType":"guide"},{"title":"Amazon DSP Reporting to v3","sectionHeader":{"type":2,"text":"Date formatting"},"path":"/en-us/reference/migration-guides/dsp-reporting","content":[" DSP reporting used MMM DD, YYYY formatting, while v3 reporting uses YYYY-MM-DD formatting. \n"," For example, what was presented as Mar 02, 2024 in DSP v2 reporting is now presented as 2024-03-02.\n"],"documentType":"guide"},{"title":"Amazon DSP Reporting to v3","sectionHeader":{"type":2,"text":"Differences in headers"},"path":"/en-us/reference/migration-guides/dsp-reporting","content":[" v3 reporting introduces two new headers: Amazon-Advertising-API-Scope and Amazon-Ads-AccountId. You should only use one of these headers, not both, per request. The header you use depends on whether your advertiser has an Admin or ADSP Reports account permission in your manager account. For more information, see our guide to pulling ADSP reports.\n"],"documentType":"guide"},{"title":"Amazon DSP Reporting to v3","sectionHeader":{"type":2,"text":"advertiserId"},"path":"/en-us/reference/migration-guides/dsp-reporting","content":[" In order to use v3 reporting for DSP report types, you must provide your advertiserId within the filters field. \n"," Here is an example request body that requests a DSP campaign report:\n"],"documentType":"guide"},{"title":"Amazon DSP Reporting to v3","sectionHeader":{"type":2,"text":"Dimensions compared to groupBys"},"path":"/en-us/reference/migration-guides/dsp-reporting","content":[" DSP v2 reporting included a dimensions field that determined the level of granularity of your report data. In v3, groupBy serves a similar function. There are a few differences to note:\n","While including a groupBy unlocks additional metrics for you to request in your report, there are no metrics included by default.  - v3 inventory reports do not have a deal groupBy. In v2 reporting, inventory reports included a deal dimension.\n"],"documentType":"guide"},{"title":"Amazon DSP Reporting to v3","sectionHeader":{"type":2,"text":"Report types"},"path":"/en-us/reference/migration-guides/dsp-reporting","content":[],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 2)","sectionHeader":null,"path":"/en-us/guides/reporting/v2/overview","content":[" The version 2 reporting APIs help advertisers access performance data for sponsored ads (Sponsored Products, Sponsored Display, and Sponsored Brands).\n"],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 2)","sectionHeader":{"type":2,"text":"Report types"},"path":"/en-us/guides/reporting/v2/overview","content":[" You can request reports with performance data broken down at different levels including campaign, ad group, ad, keyword, and target. For example, a campaign report contains performance data broken down by campaign for the specified day. An ad group report contains performance data broken down by ad group.\n"," Learn more about available Report types. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 2)","sectionHeader":{"type":2,"text":"Format"},"path":"/en-us/guides/reporting/v2/overview","content":[" Reports are downloaded in a compressed (gzip) format. Once unzipped, report data is in a JSON format.\n"," For a sample report, see Reading your report.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 2)","sectionHeader":{"type":2,"text":"Reporting period "},"path":"/en-us/guides/reporting/v2/overview","content":[" For sponsored ads reports, each call to the API requests a single day of data. To get performance data for a longer reporting period, you need to make multiple calls to the API then aggregate the data. \n"," Reporting data is only available up to 60 days back from the current date via the API. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 2)","sectionHeader":{"type":2,"text":"Advertising console vs. API reports"},"path":"/en-us/guides/reporting/v2/overview","content":[" Both the advertising console and API provide mechanisms for retrieving sponsored ads campaign performance data. \n"," Learn more about reporting differences between the advertising console and API.\n"," To understand best practices around data freshness, see Frequently asked questions.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting overview (version 2)","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/reporting/v2/overview","content":[],"documentType":"guide"},{"title":"Getting started with reports for sponsored ads (version 2)","sectionHeader":null,"path":"/en-us/guides/reporting/v2/sponsored-ads-reports","content":[" This tutorial outlines how to asynchronously request and download reports for Sponsored Brands, and Sponsored Display campaigns. \n"," Since Amazon Ads API reports are asynchronous, there are three calls you need to make to generate a report:\n","Request a report 2. Wait for report to generate 3. Download the report\n"],"documentType":"guide"},{"title":"Getting started with reports for sponsored ads (version 2)","sectionHeader":{"type":2,"text":"Headers"},"path":"/en-us/guides/reporting/v2/sponsored-ads-reports","content":[" Each request described in this tutorial requires four header parameters: \n","| Parameter | Description |\n","\\|--------------------------\\|---------------\\|\n","| Amazon-Advertising-API-ClientId | The client ID associated with your Login with Amazon application. Used for authentication. |\n","| Authorization | Your access token. Used for authentication. |\n","| Amazon-Advertising-API-Scope | The profile ID associated with an advertising account in a specific marketplace. |\n","| Content-Type | Set to application/json. |\n"," For an introduction to API authentication, see Authorization overview.\n"],"documentType":"guide"},{"title":"Getting started with reports for sponsored ads (version 2)","sectionHeader":{"type":2,"text":"Requesting reports"},"path":"/en-us/guides/reporting/v2/sponsored-ads-reports","content":[" First, define the report specifications including ad and report type, date, and metrics.\n","Choose an ad type for your report. Each type of sponsored ad has a designated request endpoint, so make sure to use the right endpoint based on the sponsored ad type you need. \n","Choose a report type. Report type determines how your data is broken down in the report (for example, at the ad group or campaign level). Each sponsored ad type supports different report types. Enter the desired report type into the path in place of recordType. \n","Build your request body. All ad types require reportDate and metrics.  4. To request a report, call the desired POST endpoint (see the table in step 1) with your assembled request body. \n","Successful calls result in a 202 response that includes a reportId and a status of IN_PROGRESS. Take note of the reportId for use in the next step. \n"],"documentType":"guide"},{"title":"Getting started with reports for sponsored ads (version 2)","sectionHeader":{"type":2,"text":"Checking report status"},"path":"/en-us/guides/reporting/v2/sponsored-ads-reports","content":[" Once you have made a successful POST call, report generation can take up to 15 minutes. \n"," You can check the report generation status by using the reportId returned in step 4 to call the GET report endpoint.\n"," If you are copying the example request, make sure to use the correct URL for your geography, valid authentication credentials for your account, and your unique report ID.\n"," Any successful call to the GET status endpoint returns a 200 status code. To check if report generation has completed, check the status parameter in the response body. If the report is still generating, status is set to IN_PROGRESS:\n"," When your report is ready to download, the status returns as COMPLETE:\n"],"documentType":"guide"},{"title":"Getting started with reports for sponsored ads (version 2)","sectionHeader":{"type":2,"text":"Downloading reports"},"path":"/en-us/guides/reporting/v2/sponsored-ads-reports","content":[" Once your report is ready, use the reportId to call the download endpoint:\n"," A successful call returns a 307 redirect response. The redirect link points you to the S3 bucket where you can download your report file. The report file downloads as JSON compressed in gzip format. \n"," If you are copying the example request, make sure to use the correct URL for your geography, valid authentication credentials for your account, and your unique report ID.\n"," If using a cURL request, you should use the --output flag to specify a file for your report data.\n"],"documentType":"guide"},{"title":"Getting started with reports for sponsored ads (version 2)","sectionHeader":{"type":2,"text":"Reading your report"},"path":"/en-us/guides/reporting/v2/sponsored-ads-reports","content":[" Once you decompress your report file, you can see the raw JSON for the report. A sample report for the example used in this tutorial might resemble:\n"," This example returns impression, click, and cost data for two Sponsored Display campaigns. \n"," Now that you can generate a report, learn more about:\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":null,"path":"/en-us/guides/reporting/v2/report-types","content":[" The Ads API supports a number of report types based on campaign entity structure. Depending on the ad type, campaign performance can be broken down by campaign, ad group, ad, keyword, target, and ASIN.\n"," While most report types are determined by path parameters, some report types are also defined by the use of the segment parameter in the request body. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Availability by ad type"},"path":"/en-us/guides/reporting/v2/report-types","content":[" Each type of sponsored ad supports different report types and has a separate path defined.\n","| Report type | Sponsored Products DEPRECATED | Sponsored Brands | Sponsored Display |\n","\\|-------------\\|--------------------\\|------------------\\|-------------------\\|\n","| Campaign | x | x | x |\n","| Placement | x | x |  |\n","| Ad group | x | x | x |\n","| Product ad | x |  | x |\n","| Target | x | x | x |\n","| Keyword | x | x |  |\n","| Search term | x | x |  |\n","| ASIN | x |   | x |\n","| Ad |   | x |   |\n","| Matched target |   |   | x |\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":2,"text":"Campaign reports"},"path":"/en-us/guides/reporting/v2/report-types","content":[" Campaign reports contain performance data broken down at the campaign level. Campaign reports include all campaigns of the requested sponsored ad type that have performance activity for the requested day. For example, a Sponsored Products campaign report returns performance data for all Sponsored Products campaigns that received impressions on the chosen date. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Paths"},"path":"/en-us/guides/reporting/v2/report-types","content":["| Ad type |\tPath |\n","\\|--------\\|--------------------\\|\n","| Sponsored Products | /v2/sp/campaigns/report DEPRECATED|\n","| Sponsored Brands | /v2/hsa/campaigns/report |\n","| Sponsored Display | /sd/campaigns/report |\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Available metrics"},"path":"/en-us/guides/reporting/v2/report-types","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Sample requests"},"path":"/en-us/guides/reporting/v2/report-types","content":[" If you are copying the example request, make sure to use the correct URL for your geography and valid authentication credentials for your account. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":2,"text":"Placement reports"},"path":"/en-us/guides/reporting/v2/report-types","content":[" Placement reports show performance broken down by campaign and the position of the ad on the page. \n"," For Sponsored Products and Sponsored Brands, you can create a placement report by requesting a campaigns report and setting segment to placement in the request body. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Paths"},"path":"/en-us/guides/reporting/v2/report-types","content":["| Ad type |\tPath |\n","\\|--------\\|--------------------\\|\n","| Sponsored Products | /v2/sp/campaigns/report DEPRECATED |\n","| Sponsored Brands | /v2/hsa/campaigns/report |\n"," Note: Placement reports are not available for Sponsored Display campaigns.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Available metrics"},"path":"/en-us/guides/reporting/v2/report-types","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Sample requests"},"path":"/en-us/guides/reporting/v2/report-types","content":[" If you are copying the example request, make sure to use the correct URL for your geography and valid authentication credentials for your account.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":2,"text":"Ad group reports"},"path":"/en-us/guides/reporting/v2/report-types","content":[" Every campaign contains one or more ad groups that share targeting and bid settings. You can get performance data at the ad group level by creating an adGroups report. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Paths"},"path":"/en-us/guides/reporting/v2/report-types","content":["| Ad type |\tPath |\n","\\|--------\\|--------------------\\|\n","| Sponsored Products | /v2/sp/adGroups/report DEPRECATED| \n","| Sponsored Brands | /v2/hsa/adGroups/report |\n","| Sponsored Display | /sd/adGroups/report | \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Available metrics"},"path":"/en-us/guides/reporting/v2/report-types","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/reporting/v2/report-types","content":[" If you are copying the example request, make sure to use the correct URL for your geography and valid authentication credentials for your account. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":2,"text":"Product ad reports"},"path":"/en-us/guides/reporting/v2/report-types","content":[" Product ad reports show the performance of your advertised products. You can generate performance data at the advertised product level by requesting a productAds report.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Paths"},"path":"/en-us/guides/reporting/v2/report-types","content":["| Ad type |\tPath |\n","\\|--------\\|--------------------\\|\n","| Sponsored Products | /v2/sp/productAds/report DEPRECATED |\n","| Sponsored Display |\t/sd/productAds/report |\n"," Note: Product ad reports are not available for Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Available metrics"},"path":"/en-us/guides/reporting/v2/report-types","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Sample requests"},"path":"/en-us/guides/reporting/v2/report-types","content":[" If you are copying the example request, make sure to use the correct URL for your geography and valid authentication credentials for your account.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":2,"text":"Target reports"},"path":"/en-us/guides/reporting/v2/report-types","content":[" Targeting reports contain performance data related to targeting expressions. You can generate performance data at the target level by requesting a targets report.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Paths"},"path":"/en-us/guides/reporting/v2/report-types","content":["| Ad type |\tPath |\n","\\|--------------------\\|--------------------\\|\n","| Sponsored Products | /v2/sp/targets/report DEPRECATED|\n","| Sponsored Brands | /v2/hsa/targets/report |\n","| Sponsored Display | /sd/targets/report |\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Available metrics"},"path":"/en-us/guides/reporting/v2/report-types","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Sample requests"},"path":"/en-us/guides/reporting/v2/report-types","content":[" If you are copying the example request, make sure to use the correct URL for your geography and valid authentication credentials for your account. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":2,"text":"Keyword reports"},"path":"/en-us/guides/reporting/v2/report-types","content":[" Keywords reports return performance data broken down by the keyword used for targeting. You can generate performance data at the keyword level by requesting a keywords report.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Paths"},"path":"/en-us/guides/reporting/v2/report-types","content":["| Ad type |\tPath |\n","\\|--------------------\\|--------------------\\|\n","| Sponsored Products | /v2/sp/keywords/report DEPRECATED |\n","| Sponsored Brands | /v2/hsa/keywords/report |\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Available metrics"},"path":"/en-us/guides/reporting/v2/report-types","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Sample requests"},"path":"/en-us/guides/reporting/v2/report-types","content":[" If you are copying the example request, make sure to use the correct URL for your geography and valid authentication credentials for your account. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":2,"text":"Search term reports"},"path":"/en-us/guides/reporting/v2/report-types","content":[" Search term reports contain performance data broken out by the search term entered by a customer. Note that search term reports only include impressions that resulted in at least one ad click. \n"," For Sponsored Products and Sponsored Brands, you can create a search term report by requesting a keywords report and setting segment to query in the request body.  \n"," For Sponsored Products campaigns only, you can also request a search terms report for product-targeted campaigns by setting segment to query in the request body of a targets report. \n"," Note: The API does not currently support search terms reports for product-targeted Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Paths"},"path":"/en-us/guides/reporting/v2/report-types","content":["| Ad type |\tPath |\n","\\|--------------------\\|--------------------\\|\n","| Sponsored Products | /v2/sp/keywords/report DEPRECATED|\n","| Sponsored Products | /v2/sp/targets/report |\n","| Sponsored Brands | /v2/hsa/keywords/report |\n"," Note: Search term reports are not available for Sponsored Display campaigns.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Available metrics"},"path":"/en-us/guides/reporting/v2/report-types","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Sample requests"},"path":"/en-us/guides/reporting/v2/report-types","content":[" If you are copying the example request, make sure to use the correct URL for your geography and valid authentication credentials for your account.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":2,"text":"ASIN reports"},"path":"/en-us/guides/reporting/v2/report-types","content":[" ASIN reports contain halo conversions, or conversions that occur when a customer clicks on your ad, but places an order where the purchased SKU/ASIN was different from the SKU/ASIN advertised.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Paths"},"path":"/en-us/guides/reporting/v2/report-types","content":["| Ad type |\tPath |\n","\\|--------------------\\|--------------------\\|\n","| Sponsored Products | /v2/sp/asins/report DEPRECATED|\n","| Sponsored Display | /sd/asins/report |\n"," Note: ASIN reports are not available for Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Available metrics"},"path":"/en-us/guides/reporting/v2/report-types","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Sample requests"},"path":"/en-us/guides/reporting/v2/report-types","content":[" If you are copying the example request, make sure to use the correct URL for your geography and valid authentication credentials for your account.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":2,"text":"Ad reports"},"path":"/en-us/guides/reporting/v2/report-types","content":[" Ad reports help you understand how Sponsored Brands campaigns are performing at the ad level. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Paths"},"path":"/en-us/guides/reporting/v2/report-types","content":["| Ad type |\tPath |\n","\\|--------------------\\|--------------------\\|\n","| Sponsored Brands | /v2/hsa/ads/report |\n"," Note: To get performance data at the advertised product level for Sponsored Products and Sponsored Display, see Product ad reports.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Available metrics"},"path":"/en-us/guides/reporting/v2/report-types","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Sample requests"},"path":"/en-us/guides/reporting/v2/report-types","content":[" If you are copying the example request, make sure to use the correct URL for your geography and valid authentication credentials for your account.\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":2,"text":"Matched target reports"},"path":"/en-us/guides/reporting/v2/report-types","content":[" Matched target reports help you understand how Sponsored Display campaigns are performing based on the product detail page where they appeared. Matched target reports only contain ASIN values for product detail pages that recorded at least one ad click. Matched target reports for Sponsored Display can be broken down at the campaign, ad group, or target level.\n"," For Sponsored Display, you can create a matched target report by requesting a campaigns, adGroups, or targets report and setting segment to matchedTarget in the request body. \n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Paths"},"path":"/en-us/guides/reporting/v2/report-types","content":["| Ad type |\tPath |\n","\\|--------------------\\|--------------------\\|\n","| Sponsored Display campaigns | /sd/campaigns/report |\n","| Sponsored Display ad groups | /sd/adGroups/report |\n","| Sponsored Display targets | /sd/targets/report |\n"],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Available metrics"},"path":"/en-us/guides/reporting/v2/report-types","content":[],"documentType":"guide"},{"title":"Sponsored ads report types (version 2)","sectionHeader":{"type":3,"text":"Sample requests"},"path":"/en-us/guides/reporting/v2/report-types","content":[" If you are copying the example request, make sure to use the correct URL for your geography and valid authentication credentials for your account.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting metrics (version 2)","sectionHeader":null,"path":"/en-us/guides/reporting/v2/metrics","content":[" Every report in the Ads API is made of metrics. You specify the metrics that the report should include in your report request body. Each report type supports different metrics, and some report types may support different metrics based on the ad type. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting metrics (version 2)","sectionHeader":{"type":2,"text":"Sponsored ads"},"path":"/en-us/guides/reporting/v2/metrics","content":[" Metrics can be classified into three categories based on the type of data they represent:\n","Performance metrics  Dimensional metrics  Metadata\n"],"documentType":"guide"},{"title":"Sponsored ads reporting metrics (version 2)","sectionHeader":{"type":3,"text":"Performance metrics "},"path":"/en-us/guides/reporting/v2/metrics","content":[" Most of your report should be made up of performance metrics. The performance metrics available for each report type may change based on the ad type. \n"," Type: Integer\n"," Description: The number of searches that included the name of your brand occurring within 14 days of an ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Target, Ad, Matched target\n","\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 14 days of an ad click. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Ad, Matched target\n","\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Ad, Matched target\n","\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 24 hours of ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 24 hours of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 30 days of an ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within seven days of an ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: Number of attributed conversion events occurring within seven days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: This metric is in beta. Number of attributed detail page views occurring within 14 days of ad click.\n"," Report types: Campaign, Ad group, Product ad, Target, Ad, Matched target\n"," Type: Integer\n"," Description: The number of attributed detail page view conversions occurring within 14 days of ad click. \n"," Report types: Campaign, Placement, Ad group, Keyword, Target, Ad\n","\n"," Type: Integer\n"," Description: Number of attributed Kindle edition normalized pages read within 14 days of ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, ASIN, Target\n","\n"," Type: Integer\n"," Description: The estimated royalties of attributed estimated Kindle edition normalized pages within 14 days of ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, ASIN, Target\n","\n"," Type: Decimal\n"," Description: The number of new-to-brand orders relative to the number of clicks. New-to-brand order rate = new-to-brand orders / clicks. Not available for book vendors.\n"," Report types: Campaign, Placement, Ad group, Keyword, Target, Ad\n","\n"," Type: Integer \n"," Description: The number of first-time orders for brand products over a one-year lookback window. Not available for book vendors. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Product ad, Target, Ad, Matched target\n","\n"," Type: Decimal \n"," Description: The percentage of total orders that are new-to-brand orders. Not available for book vendors. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Target, Ad\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of an ad click. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Ad, Matched target\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: ASIN\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Ad, Matched target\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within 24 hours of an ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within 24 hours of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: ASIN\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within 24 hours of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within 30 days of an ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within 30 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: ASIN\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within seven days of an ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within seven days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: ASIN\n","\n"," Type: Decimal\n"," Description: Total value of sales occurring within seven days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Decimal\n"," Description: Total value of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Product ad, Target, Ad, Matched target\n","\n"," Type: Decimal\n"," Description: Percentage of total sales made up of new-to-brand purchases. Not available for book vendors. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Target, Ad\n","\n"," Type: Integer\n"," Description: Total number of units ordered within 14 days of an ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, ASIN, Target, Matched target\n","\n"," Type: Integer\n"," Description: Total number of units ordered within 14 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: Total number of units ordered within 14 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: Total number of units ordered within 24 hours of an ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, ASIN, Target, Matched target\n","\n"," Type: Integer\n"," Description: Total number of units ordered within 24 hours of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: Total number of units ordered within 24 hours of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target\n","\n"," Type: Integer\n"," Description: Total number of units ordered within 30 days of an ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, ASIN, Target, Matched target\n","\n"," Type: Integer\n"," Description: Total number of units ordered within 30 days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: Total number of units ordered within 30 days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target\n","\n"," Type: Integer\n"," Description: Total number of units ordered within 7 days of an ad click.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, ASIN, Target, Matched target\n","\n"," Type: Integer\n"," Description: Total number of units ordered within seven days of an ad click where the purchased SKU was different from the SKU advertised.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: Total number of units ordered within seven days of ad click where the purchased SKU was the same as the SKU advertised.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target\n","\n"," Type: Integer\n"," Description: Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click. Not available for book vendors. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Product ad, Target, Ad, Matched target\n","\n"," Type: Decimal\n"," Description: Percentage of total attributed units ordered within 14 days of an ad click that are part of a new-to-brand purchase. Not available for book vendors. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Target, Ad\n","\n"," Type: Integer\n"," Description: Total number of ad clicks. \n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Ad, Matched target\n","\n"," Type: Decimal\n"," Description: Total cost of ad clicks.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Ad, Matched target\n","\n"," Type: Integer\n"," Description: Number of attributed detail page views occurring within 14 days of click on an ad. Vendor-only field.\n"," Report types: Campaign, Placement, Ad group, Keyword, Target, Ad\n","\n"," Type: Integer\n"," Description: Total number of ad impressions.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Ad, Matched target\n","\n"," Type: Integer\n"," Description: Account-level ad-attributed impression rank for search terms.\n"," Report types: Keyword, Search term\n","\n"," Type: Decimal\n"," Description: Account-level ad-attributed impression share for search terms.\n"," Report types: Keyword, Search term\n","\n"," Type: Decimal\n"," Description: The percentage of top-of-search impressions earned out of all the top-of-search impressions that were eligible for a given date range. Various factors determine the eligibility for an impression including campaign status and targeting status.\n"," Report types: Campaign, Keyword, Target\n"," Type: Integer\n"," Description: Number of attributed units sold within 14 days of click on an ad. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Placement, Ad group, Keyword, Target, Ad\n","\n"," Type: Decimal\n"," Description: Click-through rate for views (clicks divided by views).\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Target, Ad, Product ad\n","\n"," Type: Decimal\n"," Description: The percentage of impressions where the customer watched the complete video or 5 seconds of the video (whichever is shorter). Sponsored Brands video-only metric.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Target, Ad\n","\n"," Type: Integer\n"," Description: The number of impressions where the customer watched the complete video or 5 seconds (whichever is shorter). Sponsored Brands video-only metric.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Target, Ad\n","\n"," Type: Integer\n"," Description: The number of impressions where the video was viewed to 100%. \n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Target, Ad, Product ad\n","\n"," Type: Integer\n"," Description: The number of impressions where the video was viewed to 25%.  \n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Target, Ad, Product ad\n","\n"," Type: Integer\n"," Description: The number of impressions where the video was viewed to 50%.  \n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Target, Ad, Product ad\n","\n"," Type: Integer\n"," Description: The number of impressions where the video was viewed to 75%.  \n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Target, Ad, Product ad\n","\n"," Type: Integer\n"," Description: The number of impressions where a customer unmuted the video. \n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Target, Ad, Product ad\n","\n"," Type: Integer\n"," Description: Number of impressions that met the Media Ratings Council (MRC) viewability standard. See viewability details at https://advertising.amazon.com/library/guides/viewability.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Target, Ad\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, this is the number of searches that included the name of your brand occurring within 14 days of an ad click or view. For CPC campaigns, this value is equal to attributedBrandedSearches14d.\n"," Report types: Campaign, Ad group, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 14 days of an ad click or view. For CPC campaigns, this value is equal to attributedConversions14d.\n"," Report types: Campaign, Ad group, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: This metric is in beta. For Sponsored Display vCPM campaigns, the total number of attributed detail page views occurring within 14 days of an ad click or view. For CPC campaigns, this value is equal to attributedDetailPageView14d.\n"," Report types: Campaign, Ad group, Product ad, Target, Matched target\n","\n"," Type: Integer \n"," Description: For Sponsored Display vCPM campaigns, the number of first-time orders for brand products over a one-year lookback window. Not available for book vendors. For CPC campaigns, this value is equal to attributedOrdersNewToBrand14d.\n"," Report types: Campaign, Ad group, Product ad, Target, Matched target\n","\n"," Type: Decimal\n"," Description: For Sponsored Display vCPM campaigns, the number of new-to-brand orders relative to the number of views. New-to-brand order rate = new-to-brand orders / views. Not available for book vendors. For CPC campaigns, this value is equal to attributedOrderRateNewToBrand14d. For Sponsored Brands only, this applies to attributed conversion events occurring within 14 days of an ad click or view.\n"," Report types: Campaign, Ad group, Product ad, Target, Matched target\n","\n"," Type: Decimal\n"," Description: For Sponsored Display vCPM campaigns, the total value of sales occurring within 14 days of an ad click or view. For CPC campaigns, this value is equal to attributedSales14d.\n"," Report types: Campaign, Ad group, Product ad, Target, Matched target\n","\n"," Type: Decimal\n"," Description: For Sponsored Display vCPM campaigns, the total value of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors. For CPC campaigns, this value is equal to attributedSalesNewToBrand14d.\n"," Report types: Campaign, Ad group, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of units ordered within 14 days of an ad click or view. For CPC campaigns, this value is equal to attributedUnitsOrdered14d.\n"," Report types: Campaign, Ad group, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors. For CPC campaigns, this value is equal to attributedUnitsOrderedNewToBrand14d.\n"," Report types: Campaign, Ad group, Product ad, Target, Matched target\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of units ordered within 24 hours of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedUnitsOrdered1dOtherSKU. Report types: ASIN\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of units ordered within seven days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedUnitsOrdered7dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of units ordered within 14 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedUnitsOrdered14dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of units ordered within 30 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedUnitsOrdered30dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Decimal\n"," Description: For Sponsored Display vCPM campaigns, the total value of sales occurring within 24 hours of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedSales1dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Decimal\n"," Description: For Sponsored Display vCPM campaigns, the total value of sales occurring within seven days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedSales7dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Decimal\n"," Description: For Sponsored Display vCPM campaigns, the total value of sales occurring within 14 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedSales14dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Decimal\n"," Description: For Sponsored Display vCPM campaigns, the total value of sales occurring within 30 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedSales30dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 24 hours of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedConversions1dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within seven days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedConversions7dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 14 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedConversions14dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 30 days of an ad click or view where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedConversions30dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: For Sponsored Display vCPM campaigns, the total number of attributed conversion events occurring within 24 hours of an ad click where the purchased SKU was different from the SKU advertised. For CPC campaigns, this value is equal to attributedConversions1dOtherSKU.\n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: The total number of attributed conversion events occurring within seven days of an ad click where the purchased SKU was different from the SKU advertised. \n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: The total number of attributed conversion events occurring within 14 days of an ad click where the purchased SKU was different from the SKU advertised. \n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: The total number of attributed conversion events occurring within 30 days of an ad click where the purchased SKU was different from the SKU advertised. \n"," Report types: ASIN\n","\n"," Type: Integer\n"," Description: The total number of viewable impressions. Only relevant for Sponsored Display vCPM campaigns.\n"," Report types: Campaign, Ad group, Product ad, Target, Matched target\n","\n"," Type: Decimal\n"," Description: View-through rate (vtr). Views divided by impressions.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Target, Ad, Product ad\n","\n"," Type: Decimal\n"," Description: Average number of times unique users were exposed to an ad over the lifetime of the campaign.\n"," Report types: Campaign, Ad group, Product ad\n","\n"," Type: Integer\n"," Description: Total number of unique users exposed to an ad from either a campaign, ad group, or product ad over the lifetime of the campaign or the past six months, whichever is shorter. This metric is updated daily.\n"," Report types:  Campaign, Ad group, Product ad\n","\n"],"documentType":"guide"},{"title":"Sponsored ads reporting metrics (version 2)","sectionHeader":{"type":3,"text":"Dimensional metrics"},"path":"/en-us/guides/reporting/v2/metrics","content":[" Dimensional metrics can be used to further segment certain report types. These metrics are automatically added to certain report types, and do not need to be included as part of the request metrics list.\n"," Type: String\n"," Description: The ASIN associated with the product page where a Sponsored Display ad appeared.\n"," Report types: Matched target\n","\n"," Type: String\n"," Description: The page location where an ad appeared. \n"," Report types: Placement\n","\n"," Type: String\n"," Description: The search term used by the customer. \n"," Report types: Search term\n","\n"],"documentType":"guide"},{"title":"Sponsored ads reporting metrics (version 2)","sectionHeader":{"type":3,"text":"Metadata "},"path":"/en-us/guides/reporting/v2/metrics","content":[" You can include necessary metadata attributes in your report, but we suggest limiting your use of these attributes, and requesting available metadata via an Export. The more metadata attributes you include in your report request, the larger your output file, and the longer your report will take to generate. \n"," Some metadata attributes are automatically added to certain report types, and do not need to be included in the metrics list. See Report types for more details.\n"," Type: Integer\n"," Description: Unique numerical ID of the ad.\n"," Report types: Product ad, Ad\n","\n"," Type: Integer\n"," Description: Unique numerical ID of the ad group.\n"," Report types: Ad group, Keyword, Search term, Product ad, ASIN, Target, Ad, Matched target\n","\n"," Type: String\n"," Description: The name of the ad group as entered by the advertiser.\n"," Report types: Ad group, Keyword, Search term, Product ad, ASIN, Target, Ad, Matched target\n","\n"," Type: String\n"," Description: The ID associated to the active budget rule for Sponsored Brands campaigns. For more information, see Including budget rules values in Reports.\n"," Report types: Campaign, Placement, Keyword\n","\n"," Type: String\n"," Description: The name associated to the active budget rule for Sponsored Brands campaigns. For more information, see Including budget rules values in Reports.\n"," Report types: Campaign, Placement, Keyword\n","\n"," Type: String\n"," Description: The ASIN associated to an advertised product. \n"," Report types: Product ad, ASIN\n","\n"," Type: String\n"," Description: Bid optimization for Sponsored Display ad groups. For vCPM campaigns, the value is always reach. For CPC campaigns, value is either clicks or conversions. \n"," Report types: Ad group, Product ad, Matched target\n","\n"," Type: String\n"," Description: true or false based on whether premium bid adjustments are enabled for a Sponsored Product campaign.\n"," Report types: Campaign\n","\n"," Type: Decimal\n"," Description: Total budget allocated to the campaign.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Ad, Matched target\n","\n"," Type: String\n"," Description: One of daily or lifetime.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target\n","\n"," Type: Integer\n"," Description: Unique numerical ID of a campaign.\n"," Report types: Campaign, Placement, Ad group, Product ad, Target, Keyword, Search term, ASIN, Ad, Matched target\n","\n"," Type: String\n"," Description: The name of the campaign as entered by the advertiser.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, ASIN, Target, Ad, Matched target\n","\n"," Type: Decimal\n"," Description: The value of the rule-based budget for Sponsored Brands campaigns. For more information, see Including budget rules values in Reports.\n"," Report types: Campaign, Placement, Keyword\n","\n"," Type: String\n"," Description: Current status of the campaign. One of active, paused, or archived.\n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, Target, Ad, Matched target\n","\n"," Type: String\n"," Description: Determines how the campaign will bid and charge. One of vCPM (cost per thousand viewable impressions) or CPC (cost per click). Only relevant for Sponsored Display campaigns.\n"," Report types: Campaign, Matched target\n","\n"," Type: String\n"," Description: The currency code associated with the campaign. \n"," Report types: Campaign, Placement, Ad group, Keyword, Search term, Product ad, ASIN, Target, Matched target\n","\n"," Type: Decimal\n"," Description: Advertiser-set bid value for keyword\n"," Report types: Keyword, Search term\n","\n"," Type: Integer\n"," Description: Unique numerical ID of the keyword.\n"," Report types: Keyword, Search term, ASIN\n","\n"," Type: String\n"," Description: The status of the keyword.\n"," Report types: Keyword, Search term\n","\n"," Type: String\n"," Description: Text of the keyword or phrase.\n"," Report types: Keyword, Search term, ASIN\n","\n"," Type: String\n"," Description: Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact.\n"," Report types: Keyword, Search term, ASIN\n","\n"," Type: String\n"," Description: Represents a product that was purchased after an ad click but has a different SKU/ASIN than what was advertised. \n"," Report types: ASIN\n","\n"," Type: String\n"," Description: The SKU being advertised. Not available for vendors.\n"," Report types: Product ad, ASIN\n","\n"," Type: String\n"," Description: A string representation of the expression object used in the targeting clause.\n"," Report types: Keyword, Search term, ASIN, Target, Matched target\n","\n"," Type: Integer\n"," Description: The identifier of the targeting expression.\n"," Report types: Keyword, Search term, ASIN, Target, Matched target\n","\n"," Type: String\n"," Description: The text used in the targeting expression.\n"," Report types: Search term, ASIN, Target, Matched target\n","\n"," Type: String\n"," Description: The type of targeting used in the expression.\n"],"documentType":"guide"},{"title":"Reporting in the advertising console vs. API (version 2)","sectionHeader":null,"path":"/en-us/guides/reporting/v2/advertising-console","content":[" The advertising console provides advertisers with another way to access reporting data. Reports generated through the Ads API are similar to the reports available in the advertising console, with a few key differences. \n"],"documentType":"guide"},{"title":"Reporting in the advertising console vs. API (version 2)","sectionHeader":{"type":2,"text":"Reporting period"},"path":"/en-us/guides/reporting/v2/advertising-console","content":[" You can configure console reports for customized date ranges (for example, one week, 90 days) while API reports contain only a single day of data. To replicate a console report using the API, you must request a report for each day, then aggregate the data.\n"," Reporting data is only available for 60 days via the API. Some console reports support longer reporting periods, so you may be able to access older data via the console. \n"],"documentType":"guide"},{"title":"Reporting in the advertising console vs. API (version 2)","sectionHeader":{"type":2,"text":"Discrepancies"},"path":"/en-us/guides/reporting/v2/advertising-console","content":[" Small data discrepancies between advertising console and API reports may occur and are expected due to differences in the traffic validation and data refresh processes. If you experience a data discrepancy of greater than 5%, please contact the API support team at ads-api-support@amazon.com.\n"],"documentType":"guide"},{"title":"Reporting in the advertising console vs. API (version 2)","sectionHeader":{"type":2,"text":"Report type comparison"},"path":"/en-us/guides/reporting/v2/advertising-console","content":[" For descriptions of report types in the advertising console, see Reports.\n"," The table below explains the relationship between API reports and console reports, and how to replicate console reports using the API.\n"," Note: Matching API and console reports may support different metrics. See API metrics and console report columns for a comparison.\n","| Ad type | Console report | API report | Details |\n","\\|--------------\\|----------------\\|------------\\|------------------------------------------------------------------------------------------------------\\|\n","| Sponsored Products, Sponsored Brands, Sponsored Brands Video, Sponsored Display | Campaign | Campaign or ad group  | The console and API campaign reports contain performance data at the campaign level. The API also provides an adGroups report with the same data broken out by ad group. The API reports provide additional attribution metrics for different day intervals (1, 7, 14, 30), but do not include calculated metrics found in the console report. |\n","| Sponsored Products, Sponsored Brands, Sponsored Brands Video | Placement | Placement | The console and API placement reports return performance data at the campaign and placement level. |\n","| Sponsored Products, Sponsored Display | Advertised product | Product ad | The console advertised product report and the API product ad report return conversion data for advertised ASINs. |\n","| Sponsored Products, Sponsored Display | Purchased product | ASIN and Product ad | The API productAds report only includes conversion data for advertised ASINs. The API asins report contains conversion data for ASINs that were not advertised. Aggregate the API ASIN and product ad reports to get all purchased product data for both advertised and non-advertised products. This report is only available for sellers. |\n","| Sponsored Products, Sponsored Brands, Sponsored Brands Video | Targeting | Keyword and Target | The console targeting report is an aggregate of campaign keyword and targeting data. To create the same report using the API, aggregate the data from the keyword and target reports. |\n","| Sponsored Products | Search terms | Search term | The console search term report contains both keyword and targeting data broken out by search term. To recreate the console search term report, request both a target and keyword report segmented by query, then aggregate the data. Note: Search terms only appear in the API report if they have at least one click while in the console report, search terms without clicks are included. |\n","| Sponsored Brands, Sponsored Brands Video | Search term | Search term | The console search terms report is an aggregate of all campaign targeting search terms data (keywords and product targets). The API report provides keyword search terms data using the query segment.  Note: The Advertising API does not support segmenting Sponsored Brands target reports by query at this time. Additionally, search terms only appear in the API report if they have at least one click while in the console report, search terms without clicks are included. Because of these differences, the API report will not be equivalent to the console report.  |\n","| Sponsored Display | Targeting | Target |  The API report provides the same data through the target report. The targeting tactic must be specified in the report request payload. Advertisers running Sponsored Display using different tactics should request a report for each tactic (T00020 and T00030) and aggregate the data.  |\n"],"documentType":"guide"},{"title":"Reporting in the advertising console vs. API (version 2)","sectionHeader":{"type":3,"text":"Unsupported report types"},"path":"/en-us/guides/reporting/v2/advertising-console","content":[" The following console report types are not available using the Amazon Ads API:\n","Sponsored Products Performance Over Time - Sponsored Products and Sponsored Brands Search Term Impression Share - Sponsored Products Budget\n"],"documentType":"guide"},{"title":"Reporting in the advertising console vs. API (version 2)","sectionHeader":{"type":2,"text":"Metric differences"},"path":"/en-us/guides/reporting/v2/advertising-console","content":[" Metric names in the advertising console may differ from metric names used by the API. For descriptions of each API metric, see Metrics. \n"],"documentType":"guide"},{"title":"Reporting in the advertising console vs. API (version 2)","sectionHeader":{"type":3,"text":"Advertising console reports "},"path":"/en-us/guides/reporting/v2/advertising-console","content":[" For more information about console report columns, see Report column definitions.\n"," Sponsored Products sellers\n","|Console report\t|Report column\t|API metric\t|\n","\\|--------\\|--------\\|--------\\|\n","|Targeting, Search term, Advertised product\t|7 Day Advertised SKU Units\t|attributedUnitsOrdered7dSameSKU\t|\n","|Purchased Product, Advertised product, Targeting, Search term\t|7 Day Other SKU Units\t|attributedUnitsOrdered7dOtherSKU\t|\n","|Campaign, Targeting, Advertised product, Placement, Search term\t|7 Day Total Orders\t|attributedConversions7d\t|\n","|Placement, Targeting, Advertised product, Search term\t|7 Day Total Units\t|attributedUnitsOrdered7d\t|\n","|Targeting, Advertised product, Search term\t|7 Day Conversion Rate\t|attributedConversions7d divided by clicks\t|\n","|Targeting, Advertised product, Search term\t|7 Day Advertised SKU Sales\t|attributedSales7dSameSKU\t|\n","|Campaign, Targeting, Advertised product, Placement, Search term\t|7 Day Total Sales\t|attributedSales7d\t|\n","|Purchased Product, Advertised product, Targeting, Search term\t|7 Day Other SKU Sales\t|attributedSales7dOtherSKU\t|\n"," Sponsored Products vendors\n","|Report\t|Report column\t|API metric\t|\n","|---\t|---\t|---\t|\n","|Placement, Campaign, Targeting, Search term\t|14 Day Total Orders\t|attributedConversions14d\t|\n","|Targeting, Placement, Search term\t|14 Day Total Units\t|unitsSold14d\t|\n","|Targeting\t|14 Day Conversion Rate\t|attributedConversions14d divided by clicks\t|\n","|Placement, Campaign, Targeting\t|14 Day Total Sales\t|attributedSales14d\t|\n"," Sponsored Brands and Sponsored Display (all account types)\n","|Ad Type\t|Report\t|Report column\t|API metric\t|\n","\\|-----------\\|-------\\|----------\\|--------\\|\n","|Sponsored Brands\t|Keyword, Keyword placement, Campaign, Campaign placement. Search term\t|14 Day Total Sales\t|attributedSales14d\t|\n","|Sponsored Display\t|Campaign, Targeting\t|14 Day Total Sales\t|attributedSales14d\t|\n","|Sponsored Brands\t|Keyword, Keyword placement, Campaign, Campaign placement, Search term\t|14 Day Total Orders\t|attributedConversions14d\t|\n","|Sponsored Display\t|Campaign, Targeting\t|14 Day Total Orders\t|attributedConversions14d\t|\n","|Sponsored Brands\t|Keyword, Keyword placement, Campaign, Campaign placement, Search term\t|14 Day Total Units\t|unitsSold14d\t|\n","|Sponsored Display\t|Campaign, Targeting\t|14 Day Total Units\t|unitsSold14d\t|\n","|Sponsored Brands\t|Keyword, Keyword placement, Campaign, Campaign placement, Search term\t|14 Day Conversion Rate\t|attributedConversions14ddivided by clicks\t|\n","|Sponsored Display\t|Campaign, Targeting\t|14 Day Conversion Rate\t|attributedConversions14ddivided by clicks\t|\n","|Sponsored Brands\t|Purchased report\t|14 Day New-to-brand Orders\t|newToBrandPurchases14d\t|\n","|Sponsored Display\t|Campaign, Targeting\t|14 Day New-to-brand Orders\t|attributedOrdersNewToBrand14d\t|\n","|Sponsored Brands\t|Purchased report\t|14 Day New-to-brand sales\t|newToBrandSales14d\t|\n","|Sponsored Display\t|Campaign, Targeting\t|14 Day New-to-brand sales\t|attributedSalesNewToBrand14d\t|\n","|Sponsored Brands\t|Purchased report\t|14 Day New-to-brand Units\t|newToBrandUnitsSold14d\t|\n","|Sponsored Display\t|Campaign, Targeting\t|14 Day New-to-brand Units\t|attributedUnitsOrderedNewToBrand14d\t|\n","| Ad Type | Console report | Console column name | API metric |\n","\\|---------\\|--------\\|-----------\\|------------\\|\n","| Sponsored Products | Campaign, Placement, Advertised product, Targeting, Search term | Spend | cost |\n","| Sponsored Products | Campaign, Placement, Advertised product, Targeting, Search term | Cost-Per-Click (CPC) | cost divided by clicks |\n","| Sponsored Products | Campaign, Placement, Advertised product, Targeting, Search term | Click-Thru Rate (CTR) | impressions divided by clicks |\n","| Sponsored Products | Advertised product | Advertised asin | asin |\n","| Sponsored Products | Campaign, Placement, Advertised product, Targeting, Search term | Total Advertising Cost of Sales (ACoS)  | cost divided by attributedSales14d |\n","| Sponsored Products | Campaign, Placement, Advertised product, Targeting, Search term | Total Return on Advertising Spend (RoAS)  | attributedSales14d divided by cost  |\n","| Sponsored Products, Sponsored Brands | Search term | Customer search term | query |\n","| Sponsored Display | Campaign, Targeting | Impressions | impressions |\n","| Sponsored Display | Campaign, Targeting | Viewable Impressions (vCPM) | viewableImpressions |\n","| Sponsored Display | Campaign, Targeting | Clicks | clicks |\n","| Sponsored Display | Campaign, Targeting | Click-Thru Rate (CTR) | impressions divided by clicks |\n","| Sponsored Display | Campaign, Targeting | 14 Day Detail Page Views (DPV) | attributedDetailPageView14d |\n","| Sponsored Display | Campaign, Targeting | Spend | cost |\n","| Sponsored Display | Campaign, Targeting | Cost-Per-Click (CPC) | cost divided by clicks |\n","| Sponsored Display | Campaign, Targeting | Cost per 1,000 viewable impressions (vCPM) | (cost divided by viewableImpressions) times 1,000 |\n","| Sponsored Display | Campaign, Targeting | Total Advertising Cost of Sales (ACoS) | cost divided by attributedSales14d |\n","| Sponsored Display | Campaign, Targeting | Total Return on Advertising Spend (RoAS) | attributedSales14d divided by cost |\n"],"documentType":"guide"},{"title":"Reporting in the advertising console vs. API (version 2)","sectionHeader":{"type":3,"text":"Advertising console campaigns UI"},"path":"/en-us/guides/reporting/v2/advertising-console","content":[" The advertising console campaigns UI contains a small subset of metrics for campaign performance. The values associated to these metrics differ based on the account type. Use the tables below to understand the values for different account and ad types.\n","|Console campaigns UI\t| Console report | API\t|\n","|---\t|---\t|---\t|\n","| Orders\t| 14 Day Total Orders\t| attributedConversions14d\t|\n","| Sales\t| 14 Day Total Sales\t| attributedSales14d\t|\n","| Orders (vCPM)\t| 14 Day Total Orders\t| viewAttributedConversions14d\t|\n","| Sales (vCPM)\t| 14 Day Total Sales\t| viewAttributedSales14d\t|\n","|Console campaigns UI\t| Console report | API\t|\n","|---\t|---\t|---\t|\n","| Orders\t| 7 Day Total Orders\t| attributedConversions7d\t|\n","| Sales\t| 7 Day Total Sales\t| attributedSales7d\t|\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":null,"path":"/en-us/guides/reporting/v2/faq","content":[" Get answers to commonly asked questions about reporting.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":2,"text":"General"},"path":"/en-us/guides/reporting/v2/faq","content":[],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"What is the difference between an export and a report?"},"path":"/en-us/guides/reporting/v2/faq","content":[" Exports contain metadata about the campaign structure of an account at the time the export request was made. Reports contain campaign performance data, and may also contain metadata. For best performance we recommend requesting all metadata via exports, then joining metadata and performance data using an identifier or name. \n","Learn more about Reports. - Learn more about Exports. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":2,"text":"Timing & reporting periods"},"path":"/en-us/guides/reporting/v2/faq","content":[],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"How long does it take for sponsored ads reporting data to become available?"},"path":"/en-us/guides/reporting/v2/faq","content":[" Initial impression and click data is available using the API within 12 hours. Note that small changes to impression and click data may happen up to three days after the initial click date due to the traffic validation process. We recommend retrieving click and impression data again after three days to ensure you have the latest data. \n"," Initial conversion data is available within 24 hours, but may change as part of the restatement process. Restatements of conversion data occur 1, 7, and 28 days after the conversion event. Because conversions are reported on the date of the ad interaction, restatement includes all dates in your attribution window. For example, if your attribution window is 14 days, restatement can update attribution up to 42 days (14 plus 28) after the report date.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"How do I run a sponsored ads report for a specific date range?"},"path":"/en-us/guides/reporting/v2/faq","content":[" API reports contain performance data for a single day only. If you need data from a specific date range, request a report for each day in the desired time range then aggregate the data. \n"," You can also retrieve reports for specific date ranges using the advertising console. The version 3 reporting API also supports reports with a specific date range. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"What is the available report history for the version 2 reporting API?"},"path":"/en-us/guides/reporting/v2/faq","content":[" Sponsored ads reports are available for 60 days using the API. For example, if today is January 1, 2022, the earliest possible date you can request data for is November 2, 2021. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"What if I need sponsored ads data older than 60 days?"},"path":"/en-us/guides/reporting/v2/faq","content":[" Some advertising console reports have a longer reporting period. To join console and API reporting data, you can use the campaign or ad group name as an index.\n"," You can also try using the version 3 reporting API. Some report types support longer reporting periods in the new version. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"What time zone is used for my reports?"},"path":"/en-us/guides/reporting/v2/faq","content":[" The time zone for a report is the time zone associated with the advertising account used to request the report, as determined by the profile ID provided in the request headers. To check the time zone for a given profile ID, use the GET /v2/profiles/{profileId} endpoint.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":2,"text":"Troubleshooting"},"path":"/en-us/guides/reporting/v2/faq","content":[],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"Why are my reports being rate limited?"},"path":"/en-us/guides/reporting/v2/faq","content":[" You may experience report limiting during busy times of day. To avoid excessive rate limiting, spread report requests throughout the day rather than requesting all at once.\n"," For more best practices, see Rate limiting.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"Why is my report taking so long to generate?"},"path":"/en-us/guides/reporting/v2/faq","content":[" Reports that request many metrics result in larger data files that may take longer to generate. To avoid large reports, specify necessary metrics only in your report request. Consider report requests that do not specify metadata (for example, campaignName, campaignId, adGroupName, adGroupId) in the report request body itself. Instead, retrieve metadata fields using an export and then merge the retrieved metadata into your report.  \n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"Why is my report empty?"},"path":"/en-us/guides/reporting/v2/faq","content":[" If there are no clicks or views associated to campaigns on the requested day, your report may contain no data or an empty JSON array (\\[]).   \n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"Why are my Sponsored Display reports not returning data?"},"path":"/en-us/guides/reporting/v2/faq","content":[" Make sure you understand the targeting tactic used by your campaigns. If your campaigns use both contextual targeting and audience targeting, you need to request two versions of each Sponsored Display report, one using \"tactic\": \"T00020\" and the other using \"tactic\": \"T00030\". You can then aggregate the data for full daily performance. \n"," The type of bid optimization may also have an impact on your reporting data. Sponsored Display campaigns have two options for bid optimization: cost per click (CPC) and cost per thousand viewable impressions (vCPM). \n"," If you have CPC campaigns, you can use the standard metrics for Sponsored Display reports: impressions, attributedConversions14d, attributedDetailPageView14d, attributedSales14d, attributedUnitsOrdered14d.\n"," If you have vCPM campaigns, you need to use the vCPM specific metrics:  viewAttributedConversions14d, viewAttributedDetailPageView14d, viewAttributedSales14d, viewAttributedUnitsOrdered14d, viewImpressions.\n"," If you have CPC campaigns only, vCPM specific metrics return the values associated with clicks only (meaning they will be the same as the standard metrics). To get full performance data for both cost types, include all metrics in your report request and then aggregate the data. \n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"Why are my Sponsored Brands reports not returning data?"},"path":"/en-us/guides/reporting/v2/faq","content":[" If you are running only Sponsored Brands Video campaigns, make sure you set creativeType to video in the request body. If creativeType is not set, the report returns data for non-video campaigns only. If you are running both video and non-video Sponsored Brands campaigns, make sure to create two report requests: one for video and one for non-video.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"Can I filter a Sponsored Brands report?"},"path":"/en-us/guides/reporting/v2/faq","content":[" Sponsored Brands reports do not currently support filtering using the stateFilter request body parameter available for Sponsored Display and Sponsored Products reports. By default, any campaign entity with performance data for the requested day will appear in your report. \n"," However, if certain metrics are included in a report request, the report will contain all historical campaign entities, regardless of whether performance data is available for a particular entity or whether the entity is active. This can result in a very large report that contains many rows with no performance data.\n"," To avoid large reports, do not include the following metrics in Sponsored Brands report requests:\n","campaignName  campaignStatus  campaignBudget  campaignBudgetType  adGroupName  keywordBid  keywordStatus  keywordText  matchType\n"," We recommend retrieving this information using an export, then joining the export and report using the relevant entity ID (for example, campaignId, keywordId). \n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"Why am I seeing Sponsored Display campaigns in my Sponsored Products report?"},"path":"/en-us/guides/reporting/v2/faq","content":[" This is a known issue in version 2 and may impact a small number of advertisers. This issue has been resolved in the version 3 reporting API.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"Why does the search term report only have a subset of the items included in the advertising console report?"},"path":"/en-us/guides/reporting/v2/faq","content":[" The Sponsored Brands and Sponsored Products search term reports in the advertising console contain all search terms that had an impression, regardless of whether that term resulted in a click. The API search term report only contains impressions that also had at least one click. Therefore you will see a difference in the number of entries between the console and API reports.\n"],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":2,"text":"Postman"},"path":"/en-us/guides/reporting/v2/faq","content":[],"documentType":"guide"},{"title":"Sponsored ads reporting FAQ (version 2)","sectionHeader":{"type":3,"text":"I am trying to [download a report](guides/reporting/v2/sponsored-ads-reports#downloading-reports) using Postman. Why am I not getting any data?"},"path":"/en-us/guides/reporting/v2/faq","content":[],"documentType":"guide"},{"title":"Brand Metrics API Overview","sectionHeader":null,"path":"/en-us/guides/reporting/brand-metrics/overview","content":[" Brand Metrics provides a new measurement solution that quantifies opportunities for your brand at each stage of the customer journey on Amazon, and helps brands understand the value of different shopping engagements that impact stages of that journey. You can now access Awareness and Consideration indices that compare your performance to peers using models predictive of consideration and sales. Brand Metrics quantifies the number of customers in the awareness and consideration marketing funnel stages and is built at scale to measure all shopping engagements with your brand on Amazon, not just ad-attributed engagements. Additionally, BM breaks out key shopping engagements at each stage of the shopping journey, along with the Return on Engagement, so you can measure the historical sales following a consideration event or purchase.\n"," The Brand Metrics API enables integrators to easily access Brand Metrics for Brands they support. \n"],"documentType":"guide"},{"title":"Brand Metrics API Overview","sectionHeader":{"type":2,"text":"Brand Metrics API open beta eligibility"},"path":"/en-us/guides/reporting/brand-metrics/overview","content":[" Please note: Brand Metrics is in open beta and available to professional sellers enrolled in Amazon Brand Registry and vendors that sell products on Amazon in the following markets: United States, Canada, Mexico, United Kingdom, Germany, France, India, Italy, Spain, Japan and Australia.\n"],"documentType":"guide"},{"title":"Brand Metrics API Overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/reporting/brand-metrics/overview","content":[],"documentType":"guide"},{"title":"Getting started with the Brand Metrics API","sectionHeader":null,"path":"/en-us/guides/reporting/brand-metrics/getting-started","content":[" To get started with the Brand Metrics API, you must first:\n","Set up your Advertising API developer account, if you have not already done so.\n","Obtain authorization or access for the Amazon Ads account of an eligible advertiser. \n"," To set up your Advertising API developer account, follow the steps in the Amazon Ads API Onboarding Overview.\n"," There are three ways to obtain authorization or access permission for the Amazon Ads account of an eligible advertiser:\n","Recommended approach: Create an OAuth Login With Amazon application and the advertiser uses it to grant you access to their profile.\n","The advertiser invites you to their ad console account via the email address associated with your API developer account.\n","The advertiser invites you to a manager account linked to their ad console account via the email address associated with your API developer account.\n"," Once you have completed the above requirements, you can use the Amazon Attribution API to read the following resources associated with your advertiser:\n","Profiles\n","Publishers\n","Attribution tags\n","Reports\n"],"documentType":"guide"},{"title":"Getting started with the Brand Metrics API","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/reporting/brand-metrics/getting-started","content":[" Learn how to use the Brand Metrics API.\n"],"documentType":"guide"},{"title":"How to use the Brand Metrics API","sectionHeader":null,"path":"/en-us/guides/reporting/brand-metrics/how-to","content":[" The following examples demonstrate how to call the Brand Metrics API using cURL. \n"],"documentType":"guide"},{"title":"How to use the Brand Metrics API","sectionHeader":{"type":2,"text":"Create a report request"},"path":"/en-us/guides/reporting/brand-metrics/how-to","content":[" Request:\n"," Response:\n"," Make note of the report identifier in the reportId field of the response.\n"],"documentType":"guide"},{"title":"How to use the Brand Metrics API","sectionHeader":{"type":2,"text":"Query the report resource for status"},"path":"/en-us/guides/reporting/brand-metrics/how-to","content":[" Use the report identifier to retrieve the status of the report.\n"," Request:\n"," Response:\n"," Once the status field is set to SUCCESSFUL, the value of the location property is the download URL for your report.\n"],"documentType":"guide"},{"title":"How to use the Brand Metrics API","sectionHeader":{"type":2,"text":"Sample report"},"path":"/en-us/guides/reporting/brand-metrics/how-to","content":[" The report can have two formats: CSV or JSON. Below are the sample reports for both CSV and JSON formats.\n"],"documentType":"guide"},{"title":"How to use the Brand Metrics API","sectionHeader":{"type":3,"text":"CSV sample"},"path":"/en-us/guides/reporting/brand-metrics/how-to","content":["|metricsComputationDate\t|brandName\t|categoryNodeName\t|categoryNodeTreeName\t|customerConversionRate\t|customerConversionRateCategoryMedian\t|customerConversionRateCategoryTopPerformers\t|engagedShopperRateLowerBound\t|engagedShopperRateUpperBound\t|engagedShopperRateCategoryMedianLowerBound\t|engagedShopperRateCategoryMedianUpperBound\t|engagedShopperRateCategoryTopPerformersLowerBound\t|engagedShopperRateCategoryTopPerformersUpperBound\t|newToBrandCustomerRate\t|newToBrandCustomerRateCategoryMedian\t|newToBrandCustomerRateCategoryTopPerformers\t|brandedSearchesOnly\t|brandedSearchesCategoryMedian\t|brandedSearchesCategoryTopPerformers\t|viewedDetailPageOnly\t|viewedDetailPageCategoryMedian\t|viewedDetailPageCategoryTopPerformers\t|viewedDetailPageOnlyReturnOnEngagement\t|viewedDetailPageROECategoryMedian\t|viewedDetailPageROECategoryTopPerformers\t|brandedSearchesAndDetailPageViews\t|brandedSearchesAndDetailPageViewsCategoryMedian\t|brandedSearchesAndDetailPageViewsCategoryTopPerformers\t|brandedSearchesAndDetailPageViewsReturnOnEngagement\t|brandedSearchesAndDetailPageViewsROECategoryMedian\t|brandedSearchesAndDetailPageViewsROECategoryTopPerformers\t|addToCarts\t|addToCartsCategoryMedian\t|addToCartsCategoryPerformers\t|addToCartsReturnOnEngagement\t|addToCartsROECategoryMedian\t|addToCartsROECategoryTopPerformers\t|brandCustomers\t|brandCustomersCategoryMedian\t|brandCustomersCategoryTopPerformers\t|brandCustomersReturnOnEngagement\t|brandCustomersROECategoryMedian\t|brandCustomersROECategoryTopPerformers\t|highValueCustomers\t|highValueCustomersCategoryMedian\t|highValueCustomersCategoryTopPerformers\t|highValueCustomersReturnOnEngagement\t|highValueCustomersROECategoryMedian\t|highValueCustomersROECategoryTopPerformers\t|awarenessIndex\t|considerationIndex\t|salesIndex\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Hockey\t|us-goods\t|0.11628\t|0.13043\t|0\t|0\t|5\t|0\t|5\t|0\t|0\t|0.886\t|0.944\t|0\t|71\t|639\t|0\t|224\t|205\t|0\t|0\t|0.95122\t|0\t|12\t|9\t|0\t|0\t|0\t|0\t|30\t|38\t|0\t|0\t|2.056\t|0\t|31\t|33\t|0\t|0\t|0\t|0\t|4\t|4\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Field Hockey/Balls\t|us-goods\t|0.03571\t|0.39452\t|0\t|0\t|5\t|10\t|20\t|0\t|0\t|1\t|0.831\t|0\t|90\t|254\t|0\t|24\t|89\t|0\t|0\t|0.33394\t|0\t|0\t|3.5\t|0\t|0\t|0\t|0\t|3\t|28.5\t|0\t|0\t|3.67477\t|0\t|0\t|34\t|0\t|0\t|0.30273\t|0\t|1\t|4.5\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Field Hockey/Player Equipment/Gloves\t|us-goods\t|0.3913\t|0.2248\t|0\t|5\t|10\t|10\t|20\t|0\t|0\t|0.778\t|0.7525\t|0\t|89\t|688.5\t|0\t|10\t|26\t|0\t|0\t|0.62479\t|0\t|0\t|2\t|0\t|0\t|0\t|0\t|4\t|6.5\t|0\t|0\t|4.8994\t|0\t|8\t|9\t|0\t|0\t|0\t|0\t|1\t|2.5\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Field Hockey/Protective Gear\t|us-goods\t|0.21277\t|0.2213\t|0\t|5\t|10\t|5\t|10\t|0\t|0\t|0.9\t|0.9\t|0\t|79\t|757\t|0\t|55\t|55\t|0\t|0\t|1.17679\t|0\t|8\t|5\t|0\t|0\t|0\t|0\t|11\t|11\t|0\t|0\t|1.69842\t|0\t|18\t|15\t|0\t|0\t|0\t|0\t|2\t|2\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Field Hockey/Protective Gear/Shin Guards\t|us-goods\t|0.21277\t|0.3913\t|0\t|5\t|10\t|5\t|10\t|0\t|0\t|0.9\t|0.9035\t|0\t|79\t|840.5\t|0\t|55\t|64.5\t|0\t|0\t|1.4735\t|0\t|8\t|5\t|0\t|0\t|0\t|0\t|11\t|11\t|0\t|0\t|7.01121\t|0\t|18\t|16.5\t|0\t|0\t|0\t|0\t|1\t|2\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Field Hockey/Player Equipment/Sticks\t|us-goods\t|0.14286\t|0.1125\t|0\t|5\t|10\t|5\t|10\t|0\t|0\t|1\t|1\t|0\t|84\t|1046\t|0\t|131\t|109.5\t|0\t|0\t|0.46382\t|0\t|3\t|10.5\t|0\t|0\t|0\t|0\t|13\t|17\t|0\t|0\t|1.72727\t|0\t|4\t|11.5\t|0\t|0\t|0\t|0\t|1\t|2\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Ice Hockey\t|us-goods\t|0.16442\t|0.15293\t|0.4577\t|0\t|5\t|0\t|5\t|0\t|5\t|0.77\t|0.909\t|0\t|61\t|61.5\t|56783.925\t|260\t|202.5\t|1647.15\t|0\t|0.79164\t|8.46689\t|11\t|6\t|295.7\t|0\t|0\t|19.90488\t|39\t|39\t|428.425\t|0\t|4.66902\t|46.22077\t|54\t|42\t|498.025\t|0\t|1.60122\t|17.87654\t|7\t|5\t|55.65\t|0\t|0\t|57.956\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Ice Hockey/Protective Gear\t|us-goods\t|0.27692\t|0.14286\t|0\t|0\t|5\t|0\t|5\t|0\t|0\t|0.556\t|0.885\t|0\t|81\t|252\t|0\t|38\t|231\t|0\t|0\t|0.81308\t|0\t|3\t|10\t|0\t|0\t|1.20806\t|0\t|6\t|44\t|0\t|0\t|3.9339\t|0\t|16\t|45\t|0\t|0\t|0\t|0\t|2\t|5\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Ice Hockey/Protective Gear/Shin Guards\t|us-goods\t|0.27692\t|0.19444\t|0\t|5\t|10\t|10\t|20\t|0\t|0\t|0.556\t|0.857\t|0\t|81\t|1621\t|0\t|38\t|38\t|0\t|0\t|1.36121\t|0\t|3\t|3\t|0\t|0\t|0\t|0\t|6\t|12\t|0\t|0\t|0\t|0\t|16\t|10\t|0\t|0\t|0\t|0\t|2\t|2\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Lacrosse\t|us-goods\t|0.14286\t|0.135\t|0\t|0\t|5\t|0\t|5\t|10\t|20\t|0.974\t|0.924\t|1\t|66\t|137.5\t|63498.17\t|314\t|233\t|1844.49\t|0\t|1.38325\t|9.8099\t|13\t|12.5\t|224.68\t|0\t|0\t|43.2834\t|47\t|56\t|491.045\t|0\t|5.36049\t|44.44481\t|34\t|53\t|762.705\t|0\t|1.84421\t|58.80889\t|4\t|6\t|86.15\t|0\t|0\t|62.1725\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Lacrosse/Accessories/Equipment Bags\t|us-goods\t|0.09511\t|0.14381\t|0\t|20\t|30\t|10\t|20\t|0\t|0\t|0.971\t|0.887\t|0\t|66\t|198\t|0\t|279\t|201\t|0\t|0\t|1.01248\t|0\t|13\t|6.5\t|0\t|0\t|1.25\t|0\t|41\t|33\t|0\t|0\t|8.21512\t|0\t|31\t|27\t|0\t|0\t|0.58317\t|0\t|4\t|3.5\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Rugby\t|us-goods\t|0.44118\t|0.11594\t|0\t|0\t|5\t|0\t|5\t|0\t|0\t|0.667\t|0.91\t|0\t|84\t|153\t|0\t|12\t|258\t|0\t|0\t|0.11423\t|0\t|0\t|4\t|0\t|0\t|0\t|0\t|7\t|44\t|0\t|0\t|0\t|0\t|13\t|33\t|0\t|0\t|0\t|0\t|2\t|4\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Tennis & Racquet Sports/Squash/Racquets\t|us-goods\t|0.11628\t|0.12897\t|0\t|5\t|10\t|30\t|40\t|0\t|0\t|0.9\t|0.8405\t|0\t|72\t|2962.5\t|0\t|56\t|275\t|0\t|0\t|3.40512\t|0\t|16\t|41.5\t|0\t|0\t|8.76774\t|0\t|4\t|44\t|0\t|0\t|33.34794\t|0\t|9\t|39\t|0\t|0\t|31.57797\t|0\t|1\t|5\t|0\t|0\t|19.83333\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Tennis & Racquet Sports/Squash\t|us-goods\t|0.11207\t|0.13131\t|0\t|0\t|5\t|5\t|10\t|0\t|0\t|0.846\t|0.8735\t|0\t|68\t|333\t|0\t|80\t|308.5\t|0\t|0\t|0.72368\t|0\t|18\t|23.5\t|0\t|0\t|0.99022\t|0\t|5\t|34.5\t|0\t|0\t|7.05969\t|0\t|11\t|49\t|0\t|0\t|2.78274\t|0\t|2\t|5.5\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports\t|us-goods\t|0.13071\t|0.14324\t|0.36264\t|0\t|5\t|0\t|5\t|0\t|5\t|0.854\t|0.938\t|0\t|40\t|49.5\t|73295.82\t|575\t|695.5\t|13753.385\t|1.7146\t|0.75931\t|12.70545\t|21\t|7\t|1658.25\t|6.77\t|0\t|34.92388\t|89\t|143.5\t|3434.51\t|8.59571\t|3.20752\t|59.22438\t|92\t|121\t|3903.85\t|4.71447\t|1.2651\t|26.94545\t|11\t|14\t|435.74\t|11.998\t|0\t|74.13692\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Tennis & Racquet Sports\t|us-goods\t|0.11207\t|0.13821\t|0.37093\t|0\t|5\t|0\t|5\t|0\t|0\t|0.846\t|0.939\t|0\t|68\t|66\t|47720.12\t|80\t|692\t|0\t|0\t|0.20443\t|7.53868\t|18\t|6\t|1589.11\t|0\t|0\t|23.20542\t|5\t|137\t|0\t|0\t|3.92289\t|28.69498\t|11\t|106\t|0\t|0\t|0.11022\t|45.07288\t|2\t|12\t|0\t|0\t|0\t|85.31\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Rugby/Clothing\t|us-goods\t|0.44118\t|0.15019\t|0\t|0\t|5\t|0\t|5\t|0\t|0\t|0.667\t|0.88\t|0\t|84\t|178\t|0\t|12\t|184\t|0\t|0\t|0\t|0\t|0\t|4\t|0\t|0\t|0\t|0\t|7\t|44\t|0\t|0\t|2.586\t|0\t|13\t|27\t|0\t|0\t|0\t|0\t|2\t|4\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Rugby/Clothing/Men\t|us-goods\t|0.44118\t|0.15019\t|0\t|0\t|5\t|0\t|5\t|0\t|0\t|0.667\t|0.885\t|0\t|84\t|176\t|0\t|12\t|178\t|0\t|0\t|0\t|0\t|0\t|3\t|0\t|0\t|0\t|0\t|7\t|50\t|0\t|0\t|0\t|0\t|13\t|27\t|0\t|0\t|0\t|0\t|2\t|4\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Rugby/Clothing/Men/Socks\t|us-goods\t|0.44118\t|N/A\t|0\t|60\t|80\t|N/A\t|N/A\t|0\t|0\t|0.667\t|N/A\t|0\t|84\t|N/A\t|0\t|12\t|N/A\t|0\t|0\t|N/A\t|0\t|0\t|N/A\t|0\t|0\t|N/A\t|0\t|7\t|N/A\t|0\t|0\t|N/A\t|0\t|13\t|N/A\t|0\t|0\t|N/A\t|0\t|2\t|N/A\t|0\t|0\t|N/A\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Ice Hockey/Player Equipment\t|us-goods\t|0.34783\t|0.09756\t|0\t|0\t|5\t|5\t|10\t|0\t|0\t|0.688\t|0.857\t|0\t|84\t|1950\t|0\t|21\t|162\t|0\t|0\t|0.61204\t|0\t|0\t|27\t|0\t|0\t|0\t|0\t|9\t|28\t|0\t|0\t|4.03824\t|0\t|14\t|45\t|0\t|0\t|0\t|0\t|2\t|5\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Lacrosse/Accessories\t|us-goods\t|0.09511\t|0.16488\t|0\t|5\t|10\t|5\t|10\t|0\t|0\t|0.971\t|0.8475\t|0\t|66\t|254\t|0\t|279\t|122.5\t|0\t|0\t|1.1146\t|0\t|13\t|10\t|0\t|0\t|0.55556\t|0\t|41\t|30.5\t|0\t|0\t|8.00635\t|0\t|31\t|45\t|0\t|0\t|1.15275\t|0\t|4\t|5\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports/Field Hockey/Player Equipment\t|us-goods\t|0.08046\t|0.1158\t|0\t|5\t|10\t|5\t|10\t|0\t|0\t|0.857\t|1\t|0\t|83\t|874\t|0\t|140\t|100.5\t|0\t|0\t|0.3125\t|0\t|3\t|6\t|0\t|0\t|0\t|0\t|17\t|16.5\t|0\t|0\t|2.05794\t|0\t|12\t|13.5\t|0\t|0\t|0\t|0\t|2\t|2\t|0\t|0\t|0\t|0\t|N/A\t|N/A\t|N/A\t|\n","|7/31/2021\t|YourAwesomeBrand\t|/Categories/Sports & Fitness\t|us-goods\t|0.12885\t|0.1158\t|0.31967\t|0\t|5\t|0\t|5\t|0\t|5\t|0.846\t|0.943\t|0\t|18\t|30\t|17936.06\t|658\t|1152\t|19605.99\t|1.48434\t|0.6011\t|9.51179\t|39\t|9\t|1854.87\t|5.7545\t|0\t|27.82146\t|94\t|201\t|0\t|10.1137\t|3.51739\t|43.15696\t|105\t|156\t|3839.695\t|5.5614\t|1.19101\t|31.44083\t|12\t|18\t|429.98\t|12\t|0.50297\t|104.03482\t|N/A\t|N/A\t|N/A\t|\n","|\t|YourAwesomeBrand\t|/Categories/Sports & Fitness/Sports/Other Sports\t|us-goods\t|0.14815\t|0.13131\t|0.37792\t|0\t|5\t|0\t|5\t|0\t|5\t|0.854\t|0.937\t|0\t|69\t|54\t|39976.455\t|232\t|249.5\t|1796.84\t|0\t|0.44727\t|6.84569\t|8\t|3\t|319.075\t|0\t|0\t|14.49356\t|36\t|45\t|404.675\t|0\t|2.73539\t|37.67465\t|43\t|36.5\t|420.78\t|0\t|0\t|19.20021\t|5\t|5\t|47.06\t|0\t|0\t|69.54465\t|N/A\t|N/A\t|N/A\t|\n"],"documentType":"guide"},{"title":"How to use the Brand Metrics API","sectionHeader":{"type":3,"text":"JSON sample"},"path":"/en-us/guides/reporting/brand-metrics/how-to","content":[],"documentType":"guide"},{"title":"Troubleshooting issues with the Brand Metrics API","sectionHeader":null,"path":"/en-us/guides/reporting/brand-metrics/troubleshooting","content":[" This troubleshooting guide is divided into three sections: Account authorization, reporting, and data issues. \n"],"documentType":"guide"},{"title":"Troubleshooting issues with the Brand Metrics API","sectionHeader":{"type":2,"text":"Account authorization"},"path":"/en-us/guides/reporting/brand-metrics/troubleshooting","content":[" To use the Brand Metrics API, your API developer account must have access to the advertising profile of an advertiser. Please refer to the authorization grant for authorization methods. \n"," I called the profiles endpoint but I do not see the profile of my advertiser in the response\n"," Your advertiser must grant you access to their profile, and then the profile should appear in the profiles endpoint response list within two hours. If you are using the API test domain, you should use the production domain instead. Please refer to the authorization grant and verify you have requested authorization correctly.\n"," I get an HTTP 403 response when I call a Brand Metrics endpoint using the profile of my advertiser, even though I am authorized\n"," The advertiser profile passed in the request may not be eligible for Brand Metrics. See the overview for eligibility requirements.\n"," An HTTP 403 response may indicate a lack of permissions for the account to view data for the brand or brands. If this is the case, it is up to the advertiser to register brands using the advertising console.   \n"," For Sellers - Their brand is not registered in Brand Registry. We rely on BrandRegistry to determine brand access permissions for sellers. Make sure that the seller account associated with your advertiser account has access to enhanced brand tools such as Vine, Brand Analytics, and the like. For more information about Brand Registry, see the announcement.\n"," For Vendors - The vendor does not have a verified brand relationship in BrandAid. We rely on BrandAid to determine brand access permissions for vendors. Other issues that may be preventing access is an unverified status with Brand Aid. For more information about the Brand management self-service console launch, see the announcement. \n"," If you are still experiencing issues, it may be possible that the brand is listed as a homonym. Please reach out to your account manager to investigate.  \n"],"documentType":"guide"},{"title":"Troubleshooting issues with the Brand Metrics API","sectionHeader":{"type":2,"text":"Reporting "},"path":"/en-us/guides/reporting/brand-metrics/troubleshooting","content":[" Why are some of metrics not available? \n"," Please note: Brand Metrics is in open beta and available to ~ 50% of brands. Brands that meet the eligibility criteria may not yet have access to Brand Metrics. We will continue to expand the open beta to eligible brands in 2022.\n"],"documentType":"guide"},{"title":"Overview of Brand Benchmarks","sectionHeader":null,"path":"/en-us/guides/reporting/brand-view-pro/overview","content":[" Amazon Brand View Pro (ABVP) is a competitive insights tool that provides Amazon sellers and advertisers with retail and media metrics to benchmark their on-Amazon brand performance against their peers. ABVP helps businesses optimize their Amazon marketing strategies by offering insights into sales growth, share of voice, traffic and conversion trends, and more. With ABVP 3P API access, advertisers can programmatically incorporate their ABVP reporting into their own internal tools and dashboards. Users can use the API to obtain the most recent ASIN-level and brand-level performance metrics.\n"],"documentType":"guide"},{"title":"Overview of Brand Benchmarks","sectionHeader":{"type":2,"text":"Eligibility"},"path":"/en-us/guides/reporting/brand-view-pro/overview","content":[" To be eligible for Amazon Brand View Pro (ABVP), advertisers must meet several advertising and retail criteria. Please reach out to your Amazon account team for details. Eligibility is assessed annually and advertisers with access to ABVP must continue to meet the criteria to maintain their participation. ABVP API access is not available to advertising agencies. It is offered only directly to advertisers who have completed onboarding to ABVP.\n"],"documentType":"guide"},{"title":"Overview of Brand Benchmarks","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/reporting/brand-view-pro/overview","content":[],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":null,"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":[],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":[" To get started, advertisers must complete the necessary setup and authorization steps for the Amazon Ads API, then find the correct credentials to access the Brand View Pro API.\n"],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":3,"text":"Set up API access"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":[" The below steps are a high-level summary of the steps one must perform to get started with the Amazon Ads API. This includes creating a Login with Amazon (LwA) application, obtaining API access approval, and configuring their environment to make authenticated calls to the API. \n"," For more detailed, step-by-step instructions, please see the API onboarding overview and API getting started overview. \n","Obtain an Amazon Developer account 2. Obtain access to the Amazon Ads API 3. Set up your environment for the Ads API\n"],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":3,"text":"Gain access to the Brand View Pro API"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":[" After the above steps are finished, Advertising API setup is complete. ABVP-specific setup is required.\n","Gain access to the ABVP advertiser entity. \n","Identify the manager account ID needed to call the API. \n","Find your advertiser code.\n"," The manager account ID and advertiser code will be used as parameters in calls to the Brand View Pro API.\n"],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":2,"text":"How to call the Amazon Brand View Pro API"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":[" There are two endpoints available in the API:\n","Fetch the latest ABVP report metadata using the allReportMetadata endpoint. - Retrieve a download URL for a specific ABVP report using the fetched report metadata in the getReport endpoint.\n"," Required parameters and example requests and responses are listed below. For full details, see the technical specifications for the ABVP API.\n"],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":3,"text":"Header parameters"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":["|Parameter |How to find the value\t|\n","|---\t|---\t|\n","|<YOUR_ACCESS_TOKEN>\t|Call the Login With Amazon authorization server using your refresh token for a valid access token. Learn more.\t|\n","|<YOUR_CLIENT_ID>\t|This is your Login With Amazon client ID.\t|\n","|<YOUR_MANAGER_ACCOUNT_ID>\t|This is the manager account ID of the ABVP entity. This can be found by checking https://advertising.amazon.com/mn as described above.\t|\n"],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":3,"text":"Path parameters"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":["|Parameter |How to find the value\t|\n","|---\t|---\t|\n","|<YOUR_ADVERTISER_CODE>\t|The advertiser code can be found in the URL of the ABVP dashboard of the advertiser as: https://advertising.amazon.com/bv#/ABVP/<YOUR_ADVERTISER_CODE>/dashboard\t|\n","|<REPORT_TYPE> \t|Used only in the GET report call. Obtained from first making the report metadata call\t|\n","|<INDEX_DATE>\t|Used only in the GET report call. Obtained from first making the report metadata call\t|\n"],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":3,"text":"Create a report metadata request"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":[],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":3,"text":"Create a report download request"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":[],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":2,"text":"Report types"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":[" There are two types of reports that can be downloaded from the report download endpoint. \n"],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":3,"text":"Brand Report"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":[" The Brand Report provides detailed metrics and insights related to the overall performance of your brand. This includes aggregated data across all ASINs associated with your brand providing a comprehensive view of key performance indicators. A sample of the report showing awareness data metrics such as glance views is shown below. \n","|Root  Browse Node\t|Level 2 Browse Node\t|Level 3 Browse Node\t|Level 4 Browse Node\t|Level 5 Browse Node\t|Brand Name\t|Brand Owner\t|Metric Name\t|Metric Type\t|YTD\t|TTM\t|Y: 2022\t|Y: 2023\t|Q: 2022 Q4\t|Q: 2023 Q1\t|Q: 2023 Q2\t|Q: 2023 Q3\t|Q: 2023 Q4\t|Q: 2024 Q1\t|Q: 2024 Q2\t|Q: 2024 Q3\t|M: 2022-10\t|M: 2022-11\t|M: 2022-12\t|M: 2023-1\t|M: 2023-2\t|M: 2023-3\t|M: 2023-4\t|M: 2023-5\t|M: 2023-6\t|M: 2023-7\t|M: 2023-8\t|M: 2023-9\t|M: 2023-10\t|M: 2023-11\t|M: 2023-12\t|M: 2024-1\t|M: 2024-2\t|M: 2024-3\t|M: 2024-4\t|M: 2024-5\t|M: 2024-6\t|M: 2024-7\t|M: 2024-8\t|M: 2024-9\t|WE: 2024-06-15\t|WE: 2024-06-22\t|WE: 2024-06-29\t|WE: 2024-07-06\t|WE: 2024-07-13\t|WE: 2024-07-20\t|WE: 2024-07-27\t|WE: 2024-08-03\t|WE: 2024-08-10\t|WE: 2024-08-17\t|WE: 2024-08-24\t|WE: 2024-08-31\t|WE: 2024-09-07\t|WE: 2024-09-14\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Clothing, Shoes & Jewelry\t|Girls\t|Clothing\t|Overalls\t|\t|MY BRAND\t|Own Brand\t|Glance Views\t|Absolute\t|165957\t|249593\t|279900\t|243708\t|55743\t|57421\t|50945\t|64200\t|71142\t|62790\t|49068\t|54099\t|18350\t|22065\t|15328\t|20542\t|18121\t|18758\t|16649\t|16928\t|17368\t|17217\t|24557\t|22426\t|25899\t|29591\t|15652\t|23664\t|19543\t|19583\t|17664\t|15030\t|16374\t|18924\t|25243\t|9932\t|3943\t|3547\t|3786\t|4402\t|4297\t|5249\t|3758\t|3434\t|6178\t|7562\t|5738\t|4362\t|3306\t|3186\t|\n","|Clothing, Shoes & Jewelry\t|Girls\t|Clothing\t|Overalls\t|\t|MY BRAND\t|Own Brand\t|Glance Views - YoY\t|Year-over-Year (YoY Growth)\t|0.9617\t|1.0981\t|6.7395\t|0.8707\t|1.3422\t|0.6787\t|0.6845\t|0.9858\t|1.2762\t|1.0935\t|0.9632\t|0.8427\t|0.0046\t|1.0545\t|0.7439\t|0.7934\t|0.5966\t|0.6618\t|0.5884\t|0.6551\t|0.856\t|0.79\t|1.1209\t|1.047\t|1.4114\t|1.3411\t|1.0211\t|1.152\t|1.0785\t|1.044\t|1.061\t|0.8879\t|0.9428\t|1.0991\t|1.0279\t|0.4429\t|0.9858\t|0.8568\t|0.9234\t|1.2624\t|0.9562\t|1.4646\t|1.0347\t|0.6958\t|1.1563\t|1.3957\t|0.9528\t|0.7215\t|0.5806\t|0.6468\t|\n","|Clothing, Shoes & Jewelry\t|Girls\t|Clothing\t|Overalls\t|\t|MY BRAND\t|Own Brand\t|Glance Views Share\t|Absolute\t|0.002\t|0.0023\t|0.0032\t|0.0022\t|0.0026\t|0.002\t|0.0019\t|0.0023\t|0.0027\t|0.0022\t|0.0019\t|0.0021\t|0.0026\t|0.0029\t|0.0022\t|0.0021\t|0.002\t|0.002\t|0.0019\t|0.0019\t|0.002\t|0.0017\t|0.0028\t|0.0027\t|0.0028\t|0.0032\t|0.0019\t|0.0023\t|0.0022\t|0.0021\t|0.002\t|0.0018\t|0.0019\t|0.0017\t|0.0028\t|0.0015\t|0.002\t|0.0017\t|0.0018\t|0.0021\t|0.0019\t|0.0015\t|0.0018\t|0.0017\t|0.003\t|0.0037\t|0.0029\t|0.0022\t|0.0015\t|0.0015\t|\n","|Clothing, Shoes & Jewelry\t|Girls\t|Clothing\t|Overalls\t|\t|MY BRAND\t|Own Brand\t|Glance Views Share - YoY\t|Year-over-Year (YoY Growth)\t|0.9999\t|1\t|0.9999\t|0.999\t|0.9993\t|0.9983\t|0.9982\t|0.9993\t|1.0001\t|1.0002\t|0.9999\t|0.9997\t|0.0097\t|0.9997\t|0.9988\t|0.9989\t|0.9976\t|0.9983\t|0.9979\t|0.9982\t|0.9987\t|0.9989\t|0.9998\t|0.9994\t|1.0003\t|1.0002\t|0.9998\t|1.0002\t|1.0002\t|1.0002\t|1.0001\t|0.9998\t|0.9999\t|1\t|1\t|0.9989\t|1\t|0.9997\t|0.9999\t|1.0004\t|1.0005\t|0.9997\t|1\t|0.9992\t|1.0004\t|1.001\t|0.9998\t|0.999\t|0.9987\t|0.9991\t|\n","|Clothing, Shoes & Jewelry\t|Girls\t|Clothing\t|Overalls\t|\t|MY BRAND\t|Own Brand\t|Conversion Rate\t|Absolute\t|0.2538\t|0.2206\t|0.2305\t|0.194\t|0.2402\t|0.2162\t|0.231\t|0.1693\t|0.1719\t|0.2276\t|0.2705\t|0.269\t|0.2254\t|0.2625\t|0.2257\t|0.2085\t|0.218\t|0.2229\t|0.23\t|0.2469\t|0.2165\t|0.2132\t|0.2007\t|0.1011\t|0.1724\t|0.2218\t|0.0767\t|0.187\t|0.2434\t|0.2609\t|0.2712\t|0.2718\t|0.2687\t|0.2216\t|0.349\t|0.156\t|0.2506\t|0.276\t|0.2829\t|0.2058\t|0.233\t|0.1911\t|0.2387\t|0.2746\t|0.2813\t|0.3436\t|0.3967\t|0.411\t|0.2356\t|0.2316\t|\n","|Clothing, Shoes & Jewelry\t|Girls\t|Clothing\t|Overalls\t|\t|MY BRAND\t|Own Brand\t|Conversion Rate - YoY\t|Year-over-Year (YoY Growth)\t|1.0507\t|0.9887\t|0.8762\t|0.9635\t|0.9368\t|1.0376\t|1.0045\t|0.8751\t|0.9317\t|1.0114\t|1.0395\t|1.0997\t|2.5359\t|1.0646\t|1.0267\t|1.0003\t|1.0688\t|1.0399\t|1.0153\t|1.0411\t|0.9472\t|0.9546\t|0.8822\t|0.7957\t|0.9469\t|0.9593\t|0.8511\t|0.9785\t|1.0254\t|1.0379\t|1.0412\t|1.0249\t|1.0521\t|1.0085\t|1.1483\t|1.0548\t|1.0453\t|1.0622\t|1.0875\t|0.9767\t|1.0225\t|0.9838\t|1\t|1.1309\t|1.097\t|1.0997\t|1.1818\t|1.2385\t|1.1464\t|1.1387\t|\n","|Clothing, Shoes & Jewelry\t|Girls\t|Clothing\t|Overalls\t|\t|MY BRAND\t|Own Brand\t|Conversion Rate Index~vs~Browse\t|Absolute\t|2.8073\t|2.4172\t|2.4721\t|2.378\t|2.8188\t|2.9282\t|2.7837\t|2.0358\t|1.9788\t|2.6034\t|2.7593\t|3.1265\t|0.0545\t|3.0501\t|2.8025\t|2.997\t|2.9114\t|2.8855\t|2.8237\t|2.9279\t|2.6028\t|2.7951\t|2.3539\t|1.1342\t|1.9501\t|2.5468\t|0.9041\t|2.33\t|2.7311\t|2.7805\t|2.8331\t|2.6776\t|2.7695\t|2.3826\t|3.6113\t|2.617\t|2.5173\t|2.8813\t|2.9567\t|2.352\t|2.7305\t|1.8996\t|2.6409\t|2.7845\t|2.9674\t|3.6493\t|4.1131\t|4.1213\t|2.4545\t|2.835\t|\n","|Clothing, Shoes & Jewelry\t|Girls\t|Clothing\t|Overalls\t|\t|MY BRAND\t|Own Brand\t|Conversion Rate Index~vs~Browse - YoY\t|Year-over-Year (YoY Growth)\t|1.104\t|0.849\t|1.2415\t|0.962\t|1.3935\t|1.5238\t|1.2228\t|0.6624\t|0.702\t|0.8891\t|0.9912\t|1.5358\t|0.0026\t|1.4904\t|1.3895\t|1.2982\t|1.8514\t|1.4832\t|1.2454\t|1.403\t|1.024\t|1.0115\t|0.7048\t|0.3662\t|0.769\t|0.835\t|0.3226\t|0.7775\t|0.9381\t|0.9636\t|1.0033\t|0.9145\t|1.064\t|0.8524\t|1.5342\t|2.3074\t|1.0285\t|1.1076\t|1.1931\t|0.7793\t|0.9443\t|0.6881\t|0.9004\t|1.6477\t|1.3139\t|1.2716\t|1.6457\t|2.1319\t|2.4256\t|2.7859\t|\n"],"documentType":"guide"},{"title":"Getting started with Brand View Pro API","sectionHeader":{"type":3,"text":"ASIN Report"},"path":"/en-us/guides/reporting/brand-view-pro/getting-started","content":[" The ASIN report provides more granular insights of how individual products within your brand are performing. A sample ASIN report is provided below.\n","|browse_path\t|brand\t|asin\t|item_name\t|Metric\t|period\t|value\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|/Beauty & Personal Care/Premium  Beauty/Foot, Hand & Nail Care/Nail Art & Polish\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Glance Views Share - YoY\t|Q: 2023-Q3\t|4.14286\t|\n","|/Beauty & Personal Care/Premium  Beauty/Foot, Hand & Nail Care/Nail Art & Polish\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Glance Views\t|Y: 2023\t|27994\t|\n","|/Beauty & Personal Care/Premium  Beauty/Bath & Body/Cleansers\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Units Share - YoY\t|M: 2024-02\t|21.4098\t|\n","|/Beauty & Personal Care/Premium  Beauty/Premium Brands/Clairol Professional\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Shipped Product Sales (SPS)\t|Y: 2023\t|171302.35\t|\n","|/Beauty & Personal Care/Premium  Beauty/Foot, Hand & Nail Care/Nail Art & Polish\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Glance Views Share - YoY\t|Q: 2023-Q3\t|1.11539\t|\n","|/Beauty & Personal Care/Premium  Beauty/Premium Beauty/Clairol Professional\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Glance Views\t|M: 2022-09\t|1068\t|\n","|/Beauty & Personal Care/Premium  Beauty/Foot, Hand & Nail Care/Nail Art & Polish\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Units Share - YoY\t|M: 2024-02\t|0.63724\t|\n","|/Beauty & Personal Care/Premium  Beauty/Foot, Hand & Nail Care/Nail Art & Polish\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Shipped Product Sales (SPS)\t|Y: 2023\t|219.68\t|\n","|/Beauty & Personal Care/Premium  Beauty/Premium Brands US 3P/OPI\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Units Share - YoY\t|M: 2023-05\t|0.70244\t|\n","|/Beauty & Personal Care/Premium  Beauty/Premium Beauty/Clairol Professional\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Glance Views\t|Y: 2023\t|192\t|\n","|/Beauty & Personal Care/Foot, Hand  & Nail Care/Nail Art & Polish/Nail Polish\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Glance Views Share - YoY\t|M: 2023-10\t|1.62097\t|\n","|/Beauty & Personal Care/Premium  Beauty/Hair Care/Hair Color\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Shipped Product Sales (SPS)\t|M: 2022-11\t|21623.79\t|\n","|/Beauty & Personal Care/Premium  Beauty/Foot, Hand & Nail Care/Nail Art & Polish\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Units Share - YoY\t|Q: 2024-Q1\t|1.01092\t|\n","|/Beauty & Personal Care/Premium  Beauty/Premium Beauty/Clairol Professional\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Glance Views\t|Y: 2023\t|7286\t|\n","|/Beauty & Personal Care/Premium  Beauty/Bath & Body/Cleansers\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Glance Views Share - YoY\t|Q: 2023-Q1\t|1\t|\n","|/Beauty & Personal Care/Premium  Beauty/Hair Care/Hair Color\t|MY_BRAND\t|MY_ASIN\t|MY_PRODUCT_NAME\t|Shipped Product Sales (SPS)\t|M: 2023-12\t|11.33\t|\n"],"documentType":"guide"},{"title":"Marketing Mix Modeling API Overview","sectionHeader":null,"path":"/en-us/guides/reporting/marketing-mix-modeling/overview","content":[" Marketing Mix Modeling (MMM) API is an asynchronous API that allows you to request reports containing aggregated Amazon sales and media performance signals needed for marketing mix modeling.\n"," The responses contain the same report files that would be output from the MMM application in the Amazon Ads console.\n"],"documentType":"guide"},{"title":"Marketing Mix Modeling API Overview","sectionHeader":{"type":2,"text":"Eligibility"},"path":"/en-us/guides/reporting/marketing-mix-modeling/overview","content":[" MMM is available through the North America (NA) region only, but you can request data for the following marketplaces:\n"],"documentType":"guide"},{"title":"Get started with Marketing Mix Modeling","sectionHeader":null,"path":"/en-us/guides/reporting/marketing-mix-modeling/get-started","content":[" To get started with the MMM API, you need to have:\n","Onboard with the Amazon Ads API. 1. Registered with a manager account for the MMM service.\n"],"documentType":"guide"},{"title":"Get started with Marketing Mix Modeling","sectionHeader":{"type":2,"text":"Onboard to Amazon Ads API"},"path":"/en-us/guides/reporting/marketing-mix-modeling/get-started","content":[" To onboard to the Amazon Ads APIs, complete the following steps:\n","Create a Login with Amazon application and get Amazon Ads API access. Requests to the Amazon Ads API are made by a client application administered by Login with Amazon. 2. Create an authorization grant. To generate the necessary access tokens to successfully perform an API request:\n"],"documentType":"guide"},{"title":"Get started with Marketing Mix Modeling","sectionHeader":{"type":2,"text":"Registering for MMM"},"path":"/en-us/guides/reporting/marketing-mix-modeling/get-started","content":[" To work with MMM programmatically, you must first register for MMM in the Amazon Ads Console.\n","Create or sign in to your Amazon Ads US account. 2. Register for MMM in the Amazon Ads console. You may select an existing manager account or create a new one. You will need your manager account ID to call the API. This can be found at the Manager Account page in the top left corner.\n"],"documentType":"guide"},{"title":"Get started with Marketing Mix Modeling","sectionHeader":{"type":3,"text":"Brand group access"},"path":"/en-us/guides/reporting/marketing-mix-modeling/get-started","content":[" Once your registration has been approved, contact mmm-support@amazon.com to help you set up brand access.\n"],"documentType":"guide"},{"title":"Get started with Marketing Mix Modeling","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/reporting/marketing-mix-modeling/get-started","content":[],"documentType":"guide"},{"title":"Introduction to the MMM data feed","sectionHeader":null,"path":"/en-us/guides/reporting/marketing-mix-modeling/mmm-data-feed","content":[" This document clarifies the various inputs and outputs of the MMM data feed. It summarizes input parameters and outlines the output files generated from these inputs.\n"],"documentType":"guide"},{"title":"Introduction to the MMM data feed","sectionHeader":{"type":2,"text":"Brand groups"},"path":"/en-us/guides/reporting/marketing-mix-modeling/mmm-data-feed","content":[" You can request MMM data for brands that sell or advertise on Amazon. MMM program managers set up brand groups as part of the MMM onboarding process. For more information, see Brand group access.\n"],"documentType":"guide"},{"title":"Introduction to the MMM data feed","sectionHeader":{"type":2,"text":"Time unit"},"path":"/en-us/guides/reporting/marketing-mix-modeling/mmm-data-feed","content":[" The report time unit determines how data is aggregated, either DAILY or WEEKLY. DAILY aggregation allows any report date range selection, while WEEKLY aggregation requires full weeks ending on Saturday or Sunday. \n"," Amazon requires a one-week period to verify data accuracy and complete aggregation so report data will be available up to the previous week’s Sunday. Requested data covers a maximum of the past three years.\n"],"documentType":"guide"},{"title":"Introduction to the MMM data feed","sectionHeader":{"type":2,"text":"Metrics type"},"path":"/en-us/guides/reporting/marketing-mix-modeling/mmm-data-feed","content":[],"documentType":"guide"},{"title":"Introduction to the MMM data feed","sectionHeader":{"type":2,"text":"Geographic granularity"},"path":"/en-us/guides/reporting/marketing-mix-modeling/mmm-data-feed","content":[" Data is also aggregated by geographic granularity of COUNTRY, POSTAL_CODE, or DMA. POSTAL_CODE data is available in Canada, Germany, Spain, France, Italy, the United States, and the United Kingdom, while DMA data is limited to the United States.\n"],"documentType":"guide"},{"title":"Introduction to the MMM data feed","sectionHeader":{"type":2,"text":"Report files"},"path":"/en-us/guides/reporting/marketing-mix-modeling/mmm-data-feed","content":[" The output files generated depend on the selected inputs and report type. Each file is structured to align with the chosen reporting parameters. Refer to the table below for descriptions of the output files and how input selections impact file generation.\n"," If Display or Sponsored Ads media files are missing from a report, verify that the corresponding campaigns were included in the report inputs.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":null,"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" This tutorial outlines how to request and download reports for Marketing Mix Model (MMM).\n"," Because MMM APIs are asynchronous, there are multiple steps to using the APIs:\n","Get brand groups 2. Review ASINs 3. Review campaigns 4. Request a report 5. Wait for the report to generate 6. Download the report\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":["Complete required steps to get started with the MMM API. - Learn more about the inputs and outputs of the MMM data feed. - Ensure you are using the North America (NA) API endpoint (https://advertising-api.amazon.com).\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Headers"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" In addition to the individual API parameters, the following header parameters are required for most of your calls.\n","| Header                                 | Description                                               |\n","\\|:---------------------------------------\\|:----------------------------------------------------------\\|\n","| Amazon-Advertising-API-ClientId        | The client ID related to a Login with Amazon application. |\n","| Amazon-Advertising-API-Manager-Account | The ID of the manager account you registered with MMM.    |\n","| Authorization                          | Login with Amazon token in the form of Bearer token.     |\n","| Content-type                           | application/json                                          |\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Listing brand groups"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" The first step is to get the brand group you would like to request data for. You will need to call the POST /mmm/v1/brandGroups/list endpoint.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" This sample shows a request for your approved brand groups.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample response"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" A successful request results in a 200 response that includes an array of brand groups. Please note the brandGroupId value. You will use this value in the next steps.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Reviewing ASINs"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" You can review the ASIN values in a brand group before running a report to verify that all expected products are present.\n"," Use the brandGroupId returned in the previous step to call the GET products endpoint: GET /mmm/v1/brandGroups/{brandGroupId}/products.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample response"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" A successful response contains the products sold within the last 3 years for the brand group.\n"," If nextToken is not null, call the endpoint again with nextToken as a query parameter to get the next page of results.\n"," A report will include the subset of these products with orders inside the report date range.\n"," Review each product title and categories to confirm that it belongs in the brand group.\n"," If you need to add or remove products from the brand group, you can create overrides for those ASIN values.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Reviewing campaigns"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" You can also review the campaigns associated with the products in the brand group.\n"," Use the same brandGroupId to call the GET campaigns endpoint: GET /mmm/v1/brandGroups/{brandGroupId}/campaigns.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample response"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" A successful response contains the Sponsored Ads and Amazon DSP campaigns run in the last 3 years that are associated with at least one ASIN in the brand group\n"," If nextToken is not null, call the endpoint again with nextToken as a query parameter to get the next page of results.\n"," A report will contain the subset of these campaigns whose dates overlap the report date range.\n"," You can create overrides to adjust the campaigns in the brand group.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Creating overrides"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" Brand group overrides can be used to modify the products and campaigns in a brand group before running a report.\n"," If your products and campaigns already look correct, you can skip ahead to request a report.\n"," To add a product to a brand group, create an ASIN override with type INCLUDE. This will also add any campaigns associated with that ASIN to the brand group. To remove a product from a brand group, create an ASIN override with type EXCLUDE. Campaigns that are not associated with any other ASIN values in the brand group will also be removed.\n"," You can similarly include or exclude specific campaigns by their ID values.\n"," The best practice is to create ASIN overrides first to see how that impacts the campaigns in the brand group. Then you can create campaign ID overrides as needed. To add an ASIN or campaign ID to a brand group, your manager account must have permission to access that data. You will receive a 403 error code for requests that are not permitted. Contact mmm-support@amazon.com if you are seeing unexpected permissions issues when creating overrides. Once overrides are created, you should review ASINs and review campaigns again to verify that everything looks correct before requesting a report.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" Up to 100 overrides can be created in each request. \n"," See the API reference for all available parameters.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample response"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" A successful request results in a 207 response containing the overrideId for each created override.\n"," Each item in success or error has the index of the item in the original request.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Listing overrides"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" Use the POST /mmm/v1/brandGroupOverrides/list endpoint to get the overrides in your manager account.\n"," You can optionally filter by brandGroupId.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample response"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Deleting overrides"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" You can delete overrides using the overrideId to restore the default products and campaigns in a brand group.\n"," Use the POST /mmm/v1/brandGroupOverrides/delete endpoint.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" Up to 100 overrides can be deleted in each request.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample response"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" A successful request results in a 207 response containing the overrideId for each deleted override.\n"," Each item in success or error has the index of the item in the original request.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Requesting reports"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" MMM reports support a variety of different input parameters. See the MMM data feed for more information.\n"," To create a report, use the POST /mmm/v1/reports endpoint.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" This sample is a report request for media and sales data ranging from 2024-01-01 to 2024-03-31, aggregated to a weekly time unit and postal code geography.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample response"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" A successful request results in a 200 response that includes the report. Note the reportId for use in the following step to check the generation status.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Checking report status"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" After you have made a successful request, report generation may take up to 24 hours. Check the report generation status by using the reportId from the response of the create request. You will call the GET report endpoint: GET /mmm/v1/reports/{reportId}.\n"," If results are not available within 24 hours, contact mmm-support@amazon.com.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" A successful call to the GET endpoint returns a 200 status code. You can look at the status field of the response to check if your report has finished generating. Below is a table of possible statuses:\n","| Status     | Description                                                                         |\n","\\|:-----------\\|:------------------------------------------------------------------------------------\\|\n","| PENDING    | Report has been created and is awaiting processing.                                          |\n","| PROCESSING | Report is processing.                                                               |\n","| SUCCEEDED  | Report is complete. Check urls for the output files.                             |\n","| FAILED     | Report processing failed. Check the failureCode and failureMessage for details. |\n","| CANCELED   | Report is canceled. Contact mmm-support@amazon.com if this is unexpected.         |\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":2,"text":"Downloading reports"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[" After the status of your report is SUCCEEDED, it is ready. The urls field of the response body contains links to download the report files. You can make a GET call using cURL or enter the URL in your browser to download the file.\n"],"documentType":"guide"},{"title":"Calling the MMM API","sectionHeader":{"type":3,"text":"Sample response"},"path":"/en-us/guides/reporting/marketing-mix-modeling/call-the-api","content":[],"documentType":"guide"},{"title":"Campaign management in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/campaign-management/overview","content":[" The Campaign Management APIs represent functionality needed to create, read, update, and delete campaign management objects for Campaigns, Ad Groups, Ads, Targets, and Ad Associations. These Campaign Management APIs are ad product-agnostic and use the same set versioning across the board, and one set of feature naming to represent similar ideas.\n"," The Amazon Ads API currently supports campaign management operations for:\n","Amazon DSP - Sponsored Brands - Sponsored Products - Sponsored Display - Sponsored Television\n"],"documentType":"guide"},{"title":"Campaign management in the Amazon Ads API","sectionHeader":{"type":2,"text":"Campaign management entities"},"path":"/en-us/guides/campaign-management/overview","content":[" The API currently covers five entities: campaigns, ad groups, targets, ads, and ad associations.\n"," See the entity guides overview or these individual guides for information about each entity:\n","| Entity | API Specification |\n","\\|-------\\|-------------------\\|\n","| Campaign | Campaign API Specification |\n","| Ad Group | Ad Group API Specification |\n","| Ad | Ad API Specification |\n","| Target | Target API Specification |\n","| Ad Association | Ad Association API Specification |\n"],"documentType":"guide"},{"title":"Campaign management in the Amazon Ads API","sectionHeader":{"type":2,"text":"Current limitations"},"path":"/en-us/guides/campaign-management/overview","content":[],"documentType":"guide"},{"title":"Campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Campaign management scale"},"path":"/en-us/guides/campaign-management/overview","content":[" The goal is to allow multiple-ad product support within payload for writes and reads without scale differences across ad products.\n","At launch, calls will be bound to one ad product at a time. - At launch, API rate limits (TPS) will be per each ad product.\n"," Following launch, we will:\n","Enable support for multi-ad product operations in the same payload and move rate limiting to payload level, allowing mixing of ad products. This helps use cases such as bulk updates across ad products without orchestration of multiple write calls.  - Continue to increase the scaling across ad products to create a consistent TPS experience.\n"],"documentType":"guide"},{"title":"Campaign entities in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/campaign-management/entities/overview","content":[" Campaigns group ads that share common objectives and optimization strategies. Campaigns may also have budgets, fees, and frequency caps settings that are defaults to all ad groups, targets, and ads that are associated with the campaign.\n"," Specific attributes for each ad product are preserved in the common model based on the adProduct attribute of a given campaign or child entity.\n"],"documentType":"guide"},{"title":"Campaign entities in the Amazon Ads API","sectionHeader":{"type":2,"text":"Entity relationships"},"path":"/en-us/guides/campaign-management/entities/overview","content":[" The general structure of campaigns for sponsored ads and Amazon DSP.\n"],"documentType":"guide"},{"title":"Campaign entities in the Amazon Ads API","sectionHeader":{"type":2,"text":"Entity guides"},"path":"/en-us/guides/campaign-management/entities/overview","content":[" The following documents contain information about available attributes by ad product for each type of entity.\n","| Entity | API Specification |\n","\\|-------\\|-------------------\\|\n","| Campaign | Campaign API Specification |\n","| Ad Group | Ad Group API Specification |\n","| Ad | Ad API Specification |\n","| Target | Target API Specification |\n","| Ad Association | Ad Association API Specification |\n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/campaign-management/entities/campaign","content":[" Campaigns group ads that share common objectives and optimization strategies. Campaigns may also have budgets, fees, and frequency caps settings that are defaults to all ad groups, targets, and ads that are associated with the campaign.\n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Campaign parameters by ad product"},"path":"/en-us/guides/campaign-management/entities/campaign","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| adProduct                                                           \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| autoCreationSettings                                                \t| ○\t| ✓\t| ○\t|  \t| \n","| autoCreationSettings.autoCreateTargets                              \t| ○\t| ✓\t| ○\t|  \t| \n","| brandId                                                             \t| ○\t|  \t| ○\t|  \t| \n","| budgets                                                   \t| ◐\t| ✓◐\t| ✓◐\t| ◐\t| \n","| campaignId                                                          \t| □\t| □\t| □\t| □\t| \n","| costType                                                            \t| ○\t|  \t| ✓\t|  \t| \n","| countries                                                           \t| ○\t| ○\t| ○\t| ○\t| \n","| countries.CountryCode\\[]                                             \t| ○\t| ○\t| ○\t| ○\t| \n","| creationDateTime                                                    \t| □\t| □\t| □\t| □\t| \n","| endDateTime                                                         \t| ○\t| ○\t| ○\t| □\t| \n","| fees                                                         \t| ◐\t|  \t|  \t| ◐\t| \n","| flights                                                   \t| ◐\t|  \t|  \t| ✓◐\t| \n","| frequencies                                           \t| ◐\t|  \t|  \t| ◐\t| \n","| isMultiAdGroupsEnabled                                              \t| □\t|  \t| □\t|  \t| \n","| lastUpdatedDateTime                                                 \t| □\t| □\t| □\t| □\t| \n","| marketplaceConfigurations                                           \t|  \t|  \t|  \t|  \t| \n","| marketplaceScope                                                    \t| ○\t| ✓\t| ✓\t|  \t| \n","| marketplaces                                                        \t| ○\t| ○\t| ○\t| ○\t| \n","| marketplaces.Marketplace\\[]                                          \t| ○\t| ○\t| ○\t| ○\t| \n","| name                                                                \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| optimizations                                                       \t| ○\t| ○\t| ○\t| ✓\t| \n","| optimizations.bidSettings                             \t| ◐\t| ◐\t| ◐\t| ✓◐\t| \n","| optimizations.budgetSettings                       \t| ◐\t| ◐\t|  \t| ◐\t| \n","| optimizations.goalSettings                           \t| ◐\t|  \t| ◐\t| ◐\t| \n","| optimizations.primaryInventoryTypes         \t| ◐\t|  \t|  \t| ◐\t| \n","| portfolioId                                                         \t| ○\t| ○\t| ○\t|  \t| \n","| productCategoryId                                                   \t| ○\t|  \t|  \t|  \t| \n","| purchaseOrderNumber                                                 \t| ○\t|  \t|  \t| ○\t| \n","| salesChannel                                                        \t| ○\t|  \t| ○\t|  \t| \n","| siteRestrictions                                                    \t| ○\t| ○\t|  \t|  \t| \n","| siteRestrictions.SiteRestriction\\[]                                  \t| ○\t| ○\t|  \t|  \t| \n","| skanAppId                                                           \t| ○\t|  \t|  \t| ○\t| \n","| startDateTime                                                       \t| ○\t| ✓\t| ✓\t| □\t| \n","| state                                                               \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| status                                                              \t| □\t| □\t| □\t| □\t| \n","| tags                                                                \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[]                                                          \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[].key                                               \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| tags.Tag\\[].value                                             \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| targetsAmazonDeal                                                   \t| □\t|  \t|  \t| □\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/campaign-management/entities/campaign","content":[],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"BidSettings"},"path":"/en-us/guides/campaign-management/entities/campaign","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| bidAdjustments                                                                                         \t| ○\t| ○\t| ○\t|  \t| \n","| bidAdjustments.audienceBidAdjustments                                                                  \t| ○\t| ○\t| ○\t|  \t| \n","| bidAdjustments.audienceBidAdjustments.AudienceBidAdjustment\\[]                                   \t| ○\t| ○\t| ○\t|  \t| \n","| bidAdjustments.placementBidAdjustments                                                                 \t| ○\t| ○\t| ○\t|  \t| \n","| bidAdjustments.placementBidAdjustments.PlacementBidAdjustment\\[]                                 \t| ○\t| ○\t| ○\t|  \t| \n","| bidAdjustments.shopperSegmentBidAdjustments                                                            \t| ○\t|  \t| ○\t|  \t| \n","| bidAdjustments.shopperSegmentBidAdjustments.ShopperSegmentBidAdjustment\\[]                       \t| ○\t|  \t| ○\t|  \t| \n","| bidStrategy                                                                                            \t| ○\t| ○\t| ○\t| ✓\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"BudgetSettings"},"path":"/en-us/guides/campaign-management/entities/campaign","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| budgetAllocation                                            \t| ○\t|  \t|  \t| ○\t| \n","| flightBudgetRolloverStrategy                                \t| ○\t|  \t|  \t| ○\t| \n","| offAmazonBudgetControlStrategy                              \t| ○\t| ○\t|  \t|  \t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Budgets"},"path":"/en-us/guides/campaign-management/entities/campaign","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| Budget\\[]                                                              \t| ○\t| ○\t| ○\t| ○\t| \n","| Budget\\[].budgetType                                                   \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| Budget\\[].budgetValue                                                  \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| Budget\\[].budgetValue.monetaryBudgetValue                       \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| Budget\\[].recurrenceTimePeriod                                         \t| ○\t| ✓\t| ✓\t| ✓\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Fees"},"path":"/en-us/guides/campaign-management/entities/campaign","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| CampaignFee\\[]                                           \t| ○\t|  \t|  \t| ○\t| \n","| CampaignFee\\[].feeType                                   \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFee\\[].feeValue                                  \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFee\\[].feeValueType                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Flights"},"path":"/en-us/guides/campaign-management/entities/campaign","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| CampaignFlight\\[]                                                 \t| ○\t|  \t|  \t| ○\t| \n","| CampaignFlight\\[].budget                                          \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFlight\\[].budget.budgetType                        \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFlight\\[].budget.budgetValue                       \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFlight\\[].endDateTime                                     \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFlight\\[].flightId                                        \t| ○\t|  \t|  \t| ○\t| \n","| CampaignFlight\\[].startDateTime                                   \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Frequencies"},"path":"/en-us/guides/campaign-management/entities/campaign","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| Frequency\\[]                                                        \t| ○\t|  \t|  \t| ○\t| \n","| Frequency\\[].eventMaxCount                                          \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].frequencyTargetingSetting                              \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].timeCount                                              \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].timeUnit                                               \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"GoalSettings"},"path":"/en-us/guides/campaign-management/entities/campaign","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| currencyCode                              \t| □\t|  \t|  \t| □\t| \n","| goal                                      \t| ○\t|  \t| □\t| □\t| \n","| kpi                                       \t| ○\t|  \t| ✓\t| ✓\t| \n","| kpiValue                                  \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"PrimaryInventoryTypes"},"path":"/en-us/guides/campaign-management/entities/campaign","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| PrimaryInventoryType\\[]                              \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The adgroup entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/campaign-management/entities/ad-group","content":[" Ad groups are used to group ads that have common targeting, strategy, and creatives.\n"],"documentType":"guide"},{"title":"The adgroup entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"AdGroup parameters by ad product"},"path":"/en-us/guides/campaign-management/entities/ad-group","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| adGroupId                                                 \t| □\t| □\t| □\t| □\t| \n","| adProduct                                                 \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| advertisedProductCategoryIds                              \t| ○\t|  \t|  \t| ○\t| \n","| bid                                               \t| ◐\t| ✓◐\t|  \t| ✓◐\t| \n","| budgets                                       \t| ◐\t|  \t|  \t| ◐\t| \n","| campaignId                                                \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| creationDateTime                                          \t| □\t| □\t| □\t| □\t| \n","| creativeRotationType                                      \t| ○\t|  \t|  \t| ✓\t| \n","| endDateTime                                               \t| ○\t|  \t|  \t| ✓\t| \n","| fees                                             \t| ◐\t|  \t|  \t| ◐\t| \n","| frequencies                               \t| ◐\t|  \t|  \t| ◐\t| \n","| inventoryType                                             \t| ○\t|  \t|  \t| ✓\t| \n","| lastUpdatedDateTime                                       \t| □\t| □\t| □\t| □\t| \n","| marketplaceConfigurations                                 \t|  \t|  \t|  \t|  \t| \n","| marketplaceScope                                          \t| ○\t| □\t| □\t|  \t| \n","| marketplaces                                              \t| ○\t| □\t| □\t|  \t| \n","| marketplaces.Marketplace\\[]                                \t| ○\t|  \t|  \t|  \t| \n","| name                                                      \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| optimization                             \t| ◐\t|  \t|  \t| ✓◐\t| \n","| pacing                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| pacing.deliveryProfile                                    \t| ○\t|  \t|  \t| ✓\t| \n","| purchaseOrderNumber                                       \t| ○\t|  \t|  \t| ○\t| \n","| startDateTime                                             \t| ○\t|  \t|  \t| ✓\t| \n","| state                                                     \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| status                                                    \t| □\t| □\t| □\t| □\t| \n","| tags                                                      \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[]                                                \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[].key                                       \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| tags.Tag\\[].value                                     \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| targetingSettings                   \t| ◐\t|  \t|  \t| ✓◐\t| \n"],"documentType":"guide"},{"title":"The adgroup entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/campaign-management/entities/ad-group","content":[],"documentType":"guide"},{"title":"The adgroup entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Bid"},"path":"/en-us/guides/campaign-management/entities/ad-group","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| baseBid                                                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| currencyCode                                                                                 \t| □\t| □\t|  \t| □\t| \n","| defaultBid                                                                                   \t| ○\t| ✓\t|  \t|  \t| \n","| marketplaceSettings                                                                          \t| ○\t|  \t|  \t|  \t| \n","| marketplaceSettings.AdGroupBidMarketplaceSetting\\[]                                           \t| ○\t|  \t|  \t|  \t| \n","| marketplaceSettings.AdGroupBidMarketplaceSetting\\[].currencyCode                         \t| ○\t|  \t|  \t|  \t| \n","| marketplaceSettings.AdGroupBidMarketplaceSetting\\[].defaultBid                           \t| ○\t|  \t|  \t|  \t| \n","| marketplaceSettings.AdGroupBidMarketplaceSetting\\[].marketplace                          \t| ○\t|  \t|  \t|  \t| \n","| maxAverageBid                                                                                \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The adgroup entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Budgets"},"path":"/en-us/guides/campaign-management/entities/ad-group","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| Budget\\[]                                                              \t| ○\t|  \t|  \t| ○\t| \n","| Budget\\[].budgetType                                                   \t| ○\t|  \t|  \t| ✓\t| \n","| Budget\\[].budgetValue                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| Budget\\[].budgetValue.monetaryBudgetValue                         \t| ○\t|  \t|  \t| ✓\t| \n","| Budget\\[].recurrenceTimePeriod                                         \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The adgroup entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Fees"},"path":"/en-us/guides/campaign-management/entities/ad-group","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| Fee\\[]                                                     \t| ○\t|  \t|  \t| ○\t| \n","| Fee\\[].addToBudgetSpentAmount                              \t| ○\t|  \t|  \t| ✓\t| \n","| Fee\\[].feeType                                             \t| ○\t|  \t|  \t| ✓\t| \n","| Fee\\[].feeValue                                            \t| ○\t|  \t|  \t| ✓\t| \n","| Fee\\[].thirdPartyProvider                                  \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The adgroup entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Frequencies"},"path":"/en-us/guides/campaign-management/entities/ad-group","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| Frequency\\[]                                                        \t| ○\t|  \t|  \t| ○\t| \n","| Frequency\\[].eventMaxCount                                          \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].frequencyTargetingSetting                              \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].timeCount                                              \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].timeUnit                                               \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The adgroup entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Optimization"},"path":"/en-us/guides/campaign-management/entities/ad-group","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| bidStrategy                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| budgetSettings                                                 \t| ○\t|  \t|  \t| ○\t| \n","| budgetSettings.budgetAllocation                                \t| ○\t|  \t|  \t| ○\t| \n","| budgetSettings.dailyMinSpendValue                              \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The adgroup entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"TargetingSettings"},"path":"/en-us/guides/campaign-management/entities/ad-group","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| amazonViewability                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| amazonViewability.includeUnmeasurableImpressions                              \t| ○\t|  \t|  \t| ✓\t| \n","| amazonViewability.viewabilityTier                                             \t| ○\t|  \t|  \t| ✓\t| \n","| automatedTargetingTactic                                                      \t| □\t|  \t|  \t| □\t| \n","| defaultAudienceTargetingMatchType                                             \t| ○\t|  \t|  \t| ○\t| \n","| enableLanguageTargeting                                                       \t| ○\t|  \t|  \t| ○\t| \n","| siteLanguage                                                                  \t| □\t|  \t|  \t| □\t| \n","| tacticsConvertersExclusionType                                                \t| ○\t|  \t|  \t| ○\t| \n","| targetedPGDealId                                                              \t| ○\t|  \t|  \t| ○\t| \n","| timeZoneType                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| userLocationSignal                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| videoCompletionTier                                                           \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/campaign-management/entities/ad","content":[" An ad is the smallest unit of an advertising campaign. An ad represents the creative and advertised products that a customer sees and interacts with.\n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Ad parameters by ad product"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| activeCreative                                           \t| □\t|  \t| □\t|  \t| \n","| adGroupId                                                \t| ○\t| ✓\t| ✓\t|  \t| \n","| adId                                                     \t| □\t| □\t| □\t| □\t| \n","| adProduct                                                \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| adType                                                   \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| campaignId                                               \t| □\t| □\t| □\t|  \t| \n","| creationDateTime                                         \t| □\t| □\t| □\t| □\t| \n","| creative                                                 \t| ○\t| ○\t| ○\t| ○\t| \n","| creative.audioCreative                 \t| ◐\t|  \t|  \t| ◐\t| \n","| creative.componentCreative         \t| ◐\t|  \t| ◐\t| ◐\t| \n","| creative.displayCreative             \t| ◐\t|  \t|  \t| ◐\t| \n","| creative.productCreative             \t| ◐\t| ◐\t|  \t|  \t| \n","| creative.thirdPartyCreative       \t| ◐\t|  \t|  \t| ◐\t| \n","| creative.videoCreative                 \t| ◐\t|  \t|  \t| ◐\t| \n","| lastUpdatedDateTime                                      \t| □\t| □\t| □\t| □\t| \n","| marketplaceConfigurations                                \t|  \t|  \t|  \t|  \t| \n","| marketplaceScope                                         \t| ○\t| □\t| □\t|  \t| \n","| marketplaces                                             \t| ✓\t| □\t| □\t| ✓\t| \n","| marketplaces.Marketplace\\[]                               \t| ○\t|  \t|  \t| ○\t| \n","| name                                                     \t| ○\t|  \t| ✓\t| ✓\t| \n","| state                                                    \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| status                                                   \t| □\t| □\t| □\t|  \t| \n","| tags                                                     \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[]                                               \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[].key                                      \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| tags.Tag\\[].value                                    \t| ○\t| ✓\t| ✓\t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/campaign-management/entities/ad","content":[],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AssetBasedCreativeSettings"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| additionalHtml                                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| bodyText                                                                                              \t| ○\t|  \t|  \t| ○\t| \n","| brand                                                                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| callToActions                                                                                         \t| ○\t|  \t|  \t| ✓\t| \n","| callToActions.assetBasedCreativeCallToActionSettings                                                  \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.assetBasedCreativeCallToActionSettings.callToActionType                            \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.assetBasedCreativeCallToActionSettings.deepLinkingBehavior                         \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.assetBasedCreativeCallToActionSettings.url                                         \t| ○\t|  \t|  \t| ✓\t| \n","| clickTrackingUrls                                                                                     \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[]                                                               \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[].url                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| creativeSizes                                                                                         \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[]                                                                                  \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[].height                                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| creativeSizes.Size\\[].width                                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| customVideos                                                                                          \t| ○\t|  \t|  \t| ○\t| \n","| customVideos.assetId                                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| customVideos.assetVersion                                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| disclaimers                                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| headlines                                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls                                                                                \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[]                                                          \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[].url                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes                                                                                        \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes.ComponentInventoryType\\[]                                                               \t| ○\t|  \t|  \t| ○\t| \n","| language                                                                                              \t| ○\t|  \t|  \t| ✓\t| \n","| logos                                                                                                 \t| ○\t|  \t|  \t| ○\t| \n","| logos.Image\\[]                                                                                         \t| ○\t|  \t|  \t| ○\t| \n","| logos.Image\\[].assetId                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| logos.Image\\[].assetVersion                                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| logos.Image\\[].formatProperties                                                                   \t| ○\t|  \t|  \t| ○\t| \n","| optimizationGoalKpi                                                                                   \t| ○\t|  \t|  \t| ✓\t| \n","| responsiveSizingBehavior                                                                              \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages                                                                                          \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[]                                                                                  \t| ○\t|  \t|  \t| ○\t| \n","| squareImages.Image\\[].assetId                                                                     \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[].assetVersion                                                                \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[].formatProperties                                                            \t| ○\t|  \t|  \t| ○\t| \n","| tallImages                                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[]                                                                                    \t| ○\t|  \t|  \t| ○\t| \n","| tallImages.Image\\[].assetId                                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[].assetVersion                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[].formatProperties                                                              \t| ○\t|  \t|  \t| ○\t| \n","| wideImages                                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[]                                                                                    \t| ○\t|  \t|  \t| ○\t| \n","| wideImages.Image\\[].assetId                                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[].assetVersion                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[].formatProperties                                                              \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AudioCreative"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| standardAudioSettings                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| standardAudioSettings.audio                                                                     \t| ○\t|  \t|  \t| ✓\t| \n","| standardAudioSettings.audio.assetId                                                        \t| ○\t|  \t|  \t| ✓\t| \n","| standardAudioSettings.audio.assetVersion                                                   \t| ○\t|  \t|  \t| ✓\t| \n","| standardAudioSettings.impressionTrackingUrls                                                    \t| ○\t|  \t|  \t| ○\t| \n","| standardAudioSettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                         \t| ○\t|  \t|  \t| ○\t| \n","| standardAudioSettings.language                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| standardAudioSettings.products                                                                  \t| ○\t|  \t|  \t| ○\t| \n","| standardAudioSettings.products.AdvertisedProducts\\[]                                        \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"BrandStoreSettings"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| additionalHtml                                                                                \t| ○\t|  \t|  \t| ○\t| \n","| bodyText                                                                                      \t| ○\t|  \t|  \t| ○\t| \n","| brand                                                                                         \t| ○\t|  \t|  \t| ✓\t| \n","| callToActions                                                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| callToActions.brandStoreCallToActionSettings                                                  \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.brandStoreCallToActionSettings.callToActionType                            \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.brandStoreCallToActionSettings.deepLinkingBehavior                         \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.brandStoreCallToActionSettings.url                                         \t| ○\t|  \t|  \t| ✓\t| \n","| clickTrackingUrls                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[]                                                       \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[].url                                              \t| ○\t|  \t|  \t| ✓\t| \n","| creativeSizes                                                                                 \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[]                                                                          \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[].height                                                              \t| ○\t|  \t|  \t| ✓\t| \n","| creativeSizes.Size\\[].width                                                               \t| ○\t|  \t|  \t| ✓\t| \n","| disclaimers                                                                                   \t| ○\t|  \t|  \t| ○\t| \n","| headlines                                                                                     \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[]                                                  \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[].url                                         \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes                                                                                \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes.ComponentInventoryType\\[]                                                       \t| ○\t|  \t|  \t| ○\t| \n","| language                                                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| logos                                                                                         \t| ○\t|  \t|  \t| ○\t| \n","| logos.assetId                                                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| logos.assetVersion                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| logos.formatProperties                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| logos.formatProperties.FormatProperties\\[]                                                \t| ○\t|  \t|  \t| ○\t| \n","| optimizationGoalKpi                                                                           \t| ○\t|  \t|  \t| ✓\t| \n","| responsiveSizingBehavior                                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages                                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[]                                                                          \t| ○\t|  \t|  \t| ○\t| \n","| squareImages.Image\\[].assetId                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[].assetVersion                                                        \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[].formatProperties                                                    \t| ○\t|  \t|  \t| ○\t| \n","| tallImages                                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[]                                                                            \t| ○\t|  \t|  \t| ○\t| \n","| tallImages.Image\\[].assetId                                                               \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[].assetVersion                                                          \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[].formatProperties                                                      \t| ○\t|  \t|  \t| ○\t| \n","| wideImages                                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[]                                                                            \t| ○\t|  \t|  \t| ○\t| \n","| wideImages.Image\\[].assetId                                                               \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[].assetVersion                                                          \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[].formatProperties                                                      \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ComponentCreative"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| assetBasedCreativeSettings\t| ◐\t|  \t|  \t| ◐\t| \n","| automaticCollectionSettings        \t| ◐\t|  \t| ◐\t|  \t| \n","| brandStoreSettings                \t| ◐\t|  \t|  \t| ◐\t| \n","| dynamicCollectionSettings  \t| ◐\t|  \t|  \t|  \t| \n","| manualCollectionSettings    \t| ◐\t|  \t| ◐\t|  \t| \n","| productCollectionSettings (Deprecated)  \t| ◐\t|  \t| ◐\t|  \t| \n","| productVideoSettings            \t| ◐\t|  \t| ◐\t|  \t| \n","| responsiveEcommerceSettings\t| ◐\t|  \t|  \t| ◐\t| \n","| storeSpotlightSettings        \t| ◐\t|  \t| ◐\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"DisplayCreative"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| standardDisplaySettings                                                                                 \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.adChoicesPosition                                                               \t| ○\t|  \t|  \t| ✓\t| \n","| standardDisplaySettings.callToAction                                                                    \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.callToAction.clickToAppDisplayCallToActionSettings                         \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.callToAction.clickToUrlDisplayCallToActionSettings                         \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.clickTrackingUrls                                                               \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.clickTrackingUrls.CreativeTrackingUrl\\[]                                    \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.creativeSizes                                                                   \t| ○\t|  \t|  \t| ✓\t| \n","| standardDisplaySettings.creativeSizes.Size\\[]                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| standardDisplaySettings.customImages                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| standardDisplaySettings.customImages.Image\\[]                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| standardDisplaySettings.impressionTrackingUrls                                                          \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                               \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.language                                                                        \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"DynamicCollectionSettings"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| products                                                                         \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[]                                                    \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].globalStoreSetting                            \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].marketplaceSettings                           \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].productId                                     \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].productIdType                                 \t| ✓\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductId                             \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductIdType                         \t| ○\t|  \t|  \t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AutomaticCollectionSettings"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| -- \\| --- \\| -- \\| --- \\| \n","| sharedSettings                                                                   \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brand                                                             \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos                                                        \t| ○\t|  \t| ○\t|  \t| \n","| sharedSettings.brandLogos.assetId                                           \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos.assetVersion                                      \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos.formatProperties                                  \t| ○\t|  \t| ○\t|  \t|\n","| productExclusions                                                                \t| ○\t|  \t| ○\t|  \t| \n","| productExclusions.AdvertisedProducts\\[]                                           \t| ○\t|  \t| ○\t|  \t| \n","| productExclusions.AdvertisedProducts\\[].productId                            \t| ○\t|  \t| ✓\t|  \t| \n","| productExclusions.AdvertisedProducts\\[].productIdType                        \t| ○\t|  \t| ✓\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ManualCollectionSettings"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| -- \\| --- \\| - \\| --- \\| \n","| sharedSettings                                                                   \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brand                                                             \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos                                                        \t| ○\t|  \t| ○\t|  \t| \n","| sharedSettings.brandLogos.assetId                                           \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos.assetVersion                                      \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos.formatProperties                                  \t| ○\t|  \t| ○\t|  \t| \n","| productInclusions                                                                \t| ○\t|  \t| ✓\t|  \t| \n","| productInclusions.AdvertisedProducts\\[]                                           \t| ○\t|  \t| ✓\t|  \t| \n","| productInclusions.AdvertisedProducts\\[].productId                            \t| ○\t|  \t| ✓\t|  \t| \n","| productInclusions.AdvertisedProducts\\[].productIdType                        \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage                                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageType                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageUrl                                                       \t| ○\t|  \t| ○\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ProductCollectionSettings"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| brand                                                                                                     \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos                                                                                                \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[]                                                                                        \t| ○\t|  \t| ○\t|  \t| \n","| brandLogos.Image\\[].assetId                                                                           \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].assetVersion                                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].formatProperties                                                                  \t| ○\t|  \t| ○\t|  \t| \n","| creativePropertiesToOptimize                                                                              \t| ○\t|  \t| ○\t|  \t| \n","| creativePropertiesToOptimize.ProductCollectionCreativePropertiesToOptimize\\[]                              \t| ○\t|  \t| ○\t|  \t| \n","| customImages                                                                                              \t| ○\t|  \t| ✓\t|  \t| \n","| customImages.Image\\[]                                                                                      \t| ○\t|  \t| ○\t|  \t| \n","| customImages.Image\\[].assetId                                                                         \t| ○\t|  \t| ✓\t|  \t| \n","| customImages.Image\\[].assetVersion                                                                    \t| ○\t|  \t| ✓\t|  \t| \n","| customImages.Image\\[].formatProperties                                                                \t| ○\t|  \t| ○\t|  \t| \n","| enableCreativeAutoTranslation                                                                             \t| ○\t|  \t| ○\t|  \t| \n","| headlines                                                                                                 \t| ○\t|  \t| ○\t|  \t| \n","| landingPage                                                                                               \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageAsins                                                                              \t| ○\t|  \t| ○\t|  \t| \n","| landingPage.landingPageAsins.asins                                                                   \t| ○\t|  \t| ○\t|  \t| \n","| landingPage.landingPageType                                                                               \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageUrl                                                                                \t| ○\t|  \t| ○\t|  \t| \n","| moderationStatus                                                                                          \t| ○\t|  \t| ○\t|  \t| \n","| moderationStatus.moderationStatus                                                                         \t| ○\t|  \t| ✓\t|  \t| \n","| products                                                                                                  \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[]                                                                             \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[].globalStoreSetting                                                     \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].marketplaceSettings                                                    \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].productId                                                              \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[].productIdType                                                          \t| ✓\t|  \t| ✓\t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductId                                                      \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductIdType                                                  \t| ○\t|  \t|  \t|  \t| \n","| untranslatedHeadlines                                                                                     \t| ○\t|  \t| ○\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ProductCreative"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| productCreativeSettings                                                                      \t| ○\t| ✓\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct                                                    \t| ○\t| ✓\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.globalStoreSetting                            \t| ○\t| ✓\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.marketplaceSettings                           \t| ○\t|  \t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.productId                                     \t| ○\t| ✓\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.productIdType                                 \t| ✓\t| ✓\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.resolvedProductId                             \t| ○\t| ○\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.resolvedProductIdType                         \t| ○\t| ○\t|  \t|  \t| \n","| productCreativeSettings.headline                                                             \t| ○\t| ○\t|  \t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ProductVideoSettings"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| brand                                                                            \t| ○\t|  \t| ○\t|  \t| \n","| brandLogos                                                                       \t| ○\t|  \t| ○\t|  \t| \n","| brandLogos.Image\\[]                                                               \t| ○\t|  \t| ○\t|  \t| \n","| brandLogos.Image\\[].assetId                                                  \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].assetVersion                                             \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].formatProperties                                         \t| ○\t|  \t| ○\t|  \t| \n","| enableCreativeAutoTranslation                                                    \t| ○\t|  \t| ○\t|  \t| \n","| headlines                                                                        \t| ○\t|  \t| ○\t|  \t| \n","| landingPage                                                                      \t| ○\t|  \t| ○\t|  \t| \n","| landingPage.landingPageType                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageUrl                                                       \t| ○\t|  \t| ○\t|  \t| \n","| moderationStatus                                                                 \t| ○\t|  \t| ○\t|  \t| \n","| moderationStatus.moderationStatus                                                \t| ○\t|  \t| ✓\t|  \t| \n","| products                                                                         \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[]                                                    \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[].globalStoreSetting                            \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].marketplaceSettings                           \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].productId                                     \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[].productIdType                                 \t| ✓\t|  \t| ✓\t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductId                             \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductIdType                         \t| ○\t|  \t|  \t|  \t| \n","| untranslatedHeadlines                                                            \t| ○\t|  \t| ○\t|  \t| \n","| untranslatedVideos                                                               \t| ○\t|  \t| ✓\t|  \t| \n","| untranslatedVideos.Video\\[]                                                       \t| ○\t|  \t| ○\t|  \t| \n","| untranslatedVideos.Video\\[].assetId                                          \t| ○\t|  \t| ✓\t|  \t| \n","| untranslatedVideos.Video\\[].assetVersion                                     \t| ○\t|  \t| ✓\t|  \t| \n","| videos                                                                           \t| ○\t|  \t| ✓\t|  \t| \n","| videos.Video\\[]                                                                   \t| ○\t|  \t| ○\t|  \t| \n","| videos.Video\\[].assetId                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| videos.Video\\[].assetVersion                                                 \t| ○\t|  \t| ✓\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ResponsiveEcommerceSettings"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| clickTrackingUrls                                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[]                                                                     \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[].url                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| creativePropertiesToOptimize                                                                                \t| ○\t|  \t|  \t| ○\t| \n","| creativePropertiesToOptimize.ResponsiveEcommerceCreativePropertiesToOptimize\\[]                              \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes                                                                                               \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[]                                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[].height                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| creativeSizes.Size\\[].width                                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| disclaimers                                                                                                 \t| ○\t|  \t|  \t| ○\t| \n","| headlines                                                                                                   \t| ○\t|  \t|  \t| ○\t| \n","| images                                                                                                      \t| ○\t|  \t|  \t| ○\t| \n","| images.Image\\[]                                                                                              \t| ○\t|  \t|  \t| ○\t| \n","| images.Image\\[].assetId                                                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| images.Image\\[].assetVersion                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| images.Image\\[].formatProperties                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls                                                                                      \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[]                                                                \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[].url                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes                                                                                              \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes.ComponentInventoryType\\[]                                                                     \t| ○\t|  \t|  \t| ○\t| \n","| language                                                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| logos                                                                                                       \t| ○\t|  \t|  \t| ○\t| \n","| logos.assetId                                                                                               \t| ○\t|  \t|  \t| ✓\t| \n","| logos.assetVersion                                                                                          \t| ○\t|  \t|  \t| ✓\t| \n","| logos.formatProperties                                                                                      \t| ○\t|  \t|  \t| ○\t| \n","| logos.formatProperties.FormatProperties\\[]                                                              \t| ○\t|  \t|  \t| ○\t| \n","| optimizationGoalKpi                                                                                         \t| ○\t|  \t|  \t| ✓\t| \n","| products                                                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| products.AdvertisedProducts\\[]                                                                               \t| ○\t|  \t|  \t| ○\t| \n","| products.AdvertisedProducts\\[].globalStoreSetting                                                       \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].marketplaceSettings                                                      \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].productId                                                                \t| ○\t|  \t|  \t| ✓\t| \n","| products.AdvertisedProducts\\[].productIdType                                                            \t| ✓\t|  \t|  \t| ✓\t| \n","| products.AdvertisedProducts\\[].resolvedProductId                                                        \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductIdType                                                    \t| ○\t|  \t|  \t|  \t| \n","| recAdVariations                                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| recAdVariations.ResponsiveEcommerceAdVariations\\[]                                                           \t| ○\t|  \t|  \t| ○\t| \n","| responsiveSizingBehavior                                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| supportedThirdPartySellers                                                                                  \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"StoreSpotlightSettings"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| brand                                                                                                  \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos                                                                                             \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[]                                                                                     \t| ○\t|  \t| ○\t|  \t| \n","| brandLogos.Image\\[].assetId                                                                        \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].assetVersion                                                                   \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].formatProperties                                                               \t| ○\t|  \t| ○\t|  \t| \n","| cards                                                                                                  \t| ○\t|  \t| ✓\t|  \t| \n","| cards.CardCreativeElement\\[]                                                                            \t| ○\t|  \t| ○\t|  \t| \n","| cards.CardCreativeElement\\[].headline                                                              \t| ○\t|  \t| ✓\t|  \t| \n","| cards.CardCreativeElement\\[].landingPage                                                           \t| ○\t|  \t| ○\t|  \t| \n","| cards.CardCreativeElement\\[].products                                                              \t| ○\t|  \t| ○\t|  \t| \n","| creativePropertiesToOptimize                                                                           \t| ○\t|  \t| ○\t|  \t| \n","| creativePropertiesToOptimize.StoreSpotlightCreativePropertiesToOptimize\\[]                              \t| ○\t|  \t| ○\t|  \t| \n","| enableCreativeAutoTranslation                                                                          \t| ○\t|  \t| ○\t|  \t| \n","| headlines                                                                                              \t| ○\t|  \t| ○\t|  \t| \n","| landingPage                                                                                            \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageType                                                                            \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageUrl                                                                             \t| ○\t|  \t| ✓\t|  \t| \n","| moderationStatus                                                                                       \t| ○\t|  \t| ○\t|  \t| \n","| moderationStatus.moderationStatus                                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| untranslatedHeadlines                                                                                  \t| ○\t|  \t| ○\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ThirdPartyCreative"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| thirdPartyDisplaySettings                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.adChoicesPosition                                                         \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyDisplaySettings.additionalHtml                                                            \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.clickTrackingUrls                                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.clickTrackingUrls.CreativeTrackingUrl\\[]                              \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.creativeSizes                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyDisplaySettings.creativeSizes.Size\\[]                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyDisplaySettings.impressionTrackingUrls                                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.language                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyDisplaySettings.thirdPartyTagHostingSource                                                \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyVideoSettings                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyVideoSettings.impressionTrackingUrls                                                      \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyVideoSettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                           \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyVideoSettings.language                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyVideoSettings.vastUrl                                                                     \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"VideoCreative"},"path":"/en-us/guides/campaign-management/entities/ad","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| onlineVideoSettings                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.callToActions                                                             \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.callToActions.VideoCallToAction\\[]                                    \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.clickTrackingUrls                                                         \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.clickTrackingUrls.CreativeTrackingUrl\\[]                              \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.impressionTrackingUrls                                                    \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                         \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.language                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| onlineVideoSettings.products                                                                  \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.products.globalStoreSetting                                          \t| ○\t|  \t|  \t|  \t| \n","| onlineVideoSettings.products.marketplaceSettings                                         \t| ○\t|  \t|  \t|  \t| \n","| onlineVideoSettings.products.productId                                                   \t| ○\t|  \t|  \t| ✓\t| \n","| onlineVideoSettings.products.productIdType                                               \t| ✓\t|  \t|  \t| ✓\t| \n","| onlineVideoSettings.products.resolvedProductId                                           \t| ○\t|  \t|  \t|  \t| \n","| onlineVideoSettings.products.resolvedProductIdType                                       \t| ○\t|  \t|  \t|  \t| \n","| onlineVideoSettings.videos                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| onlineVideoSettings.videos.assetId                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| onlineVideoSettings.videos.assetVersion                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| streamingTvSettings                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.callToActions                                                             \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.callToActions.VideoCallToAction\\[]                                    \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.impressionTrackingUrls                                                    \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                         \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.language                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| streamingTvSettings.products                                                                  \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.products.AdvertisedProducts\\[]                                        \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.videos                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| streamingTvSettings.videos.assetId                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| streamingTvSettings.videos.assetVersion                                                  \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/campaign-management/entities/target","content":[" Targets allow advertisers to influence when ads will or will not appear, as well as specify how much to bid for an ad when these conditions are met.\n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Target parameters by ad product"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| adGroupId                                                                          \t| ○\t| ○\t| ✓\t| ✓\t| \n","| adProduct                                                                          \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| bid                                                                                \t| ○\t| ○\t| ○\t|  \t| \n","| bid.bid                                                                            \t| ○\t| ○\t| ✓\t|  \t| \n","| bid.currencyCode                                                                   \t| □\t| □\t| □\t|  \t| \n","| bid.marketplaceSettings                                                            \t| ○\t|  \t|  \t|  \t| \n","| bid.marketplaceSettings.TargetBidMarketplaceSetting\\[]                       \t| ○\t|  \t|  \t|  \t| \n","| campaignId                                                                         \t| ○\t| ○\t| ○\t|  \t| \n","| creationDateTime                                                                   \t| □\t| □\t| □\t| □\t| \n","| lastUpdatedDateTime                                                                \t| □\t| □\t| □\t| □\t| \n","| marketplaceConfigurations                                                          \t|  \t|  \t|  \t|  \t| \n","| marketplaceScope                                                                   \t| ○\t| □\t| □\t|  \t| \n","| marketplaces                                                                       \t| ○\t| □\t| □\t|  \t| \n","| marketplaces.Marketplace\\[]                                                         \t| ○\t|  \t|  \t|  \t| \n","| negative                                                                           \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| state                                                                              \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| status                                                                             \t| □\t| □\t| □\t| □\t| \n","| tags                                                                               \t| ○\t| ○\t|  \t|  \t| \n","| tags.Tag\\[]                                                                         \t| ○\t| ○\t|  \t|  \t| \n","| tags.Tag\\[].key                                                              \t| ○\t| ✓\t|  \t|  \t| \n","| tags.Tag\\[].value                                                            \t| ○\t| ✓\t|  \t|  \t| \n","| targetDetails                                                                      \t| ○\t| ○\t| ○\t| ○\t| \n","| targetDetails.adInitiationTarget                            \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.adPlayerSizeTarget                            \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.appTarget                                              \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.audienceTarget                                    \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.contentCategoryTarget                      \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.contentGenreTarget                            \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.contentInstreamPositionTarget      \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.contentOutstreamPositionTarget    \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.contentRatingTarget                          \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.dayPartTarget                                      \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.deviceTarget                                        \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.domainTarget                                        \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.foldPositionTarget                            \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.inventorySourceTarget                      \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.keywordTarget                                      \t| ◐\t| ◐\t| ◐\t| ◐\t| \n","| targetDetails.locationTarget                                    \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.nativeContentPositionTarget          \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.productCategoryTarget                      \t| ◐\t| ◐\t| ◐\t| ◐\t| \n","| targetDetails.productTarget                                      \t| ◐\t| ◐\t| ◐\t| ◐\t| \n","| targetDetails.themeTarget                                          \t| ◐\t| ◐\t| ◐\t| ◐\t| \n","| targetDetails.thirdPartyTarget                                \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.videoAdFormatTarget                          \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.videoContentDurationTarget            \t| ◐\t|  \t|  \t| ◐\t| \n","| targetId                                                                           \t| □\t| □\t| □\t| □\t| \n","| targetLevel                                                                        \t| □\t| □\t| □\t| □\t| \n","| targetType                                                                         \t| ✓\t| ✓\t| ✓\t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/campaign-management/entities/target","content":[],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdInitiationTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| videoInitiationType                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdPlayerSizeTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| adPlayerSize                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AppTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| appId                                \t| ○\t|  \t|  \t| ✓\t| \n","| appType                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AudienceTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| acrossGroupOperator                                                                    \t| ○\t|  \t|  \t| ○\t| \n","| audienceId                                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| audienceId.defaultValue                                                                \t| ○\t|  \t|  \t| ○\t| \n","| audienceId.marketplaceSettings                                                         \t| ○\t|  \t|  \t|  \t| \n","| audienceId.marketplaceSettings.StringMarketplaceSetting\\[]                       \t| ○\t|  \t|  \t|  \t| \n","| groupId                                                                                \t| ○\t|  \t|  \t| ○\t| \n","| inGroupOperator                                                                        \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ContentCategoryTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| contentCategoryId                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ContentGenreTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| contentGenre                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ContentInstreamPositionTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| instreamPosition                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ContentOutstreamPositionTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| outstreamPosition                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ContentRatingTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| contentRatingType                                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| contentRatingTypeDetails                                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| contentRatingTypeDetails.dspContentRating                                                     \t| ○\t|  \t|  \t| ○\t| \n","| contentRatingTypeDetails.dspContentRating.dspContentRating                             \t| ○\t|  \t|  \t| ✓\t| \n","| contentRatingTypeDetails.twitchContentRating                                                  \t| ○\t|  \t|  \t| ○\t| \n","| contentRatingTypeDetails.twitchContentRating.twitchContentRating                       \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"DayPartTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| dayOfWeek                                        \t| ○\t|  \t|  \t| ✓\t| \n","| timeOfDay                                        \t| ○\t|  \t|  \t| ✓\t| \n","| timeOfDay.endTime                                \t| ○\t|  \t|  \t| ✓\t| \n","| timeOfDay.startTime                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"DeviceTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| deviceOrientation                              \t| ○\t|  \t|  \t| ○\t| \n","| deviceType                                     \t| ○\t|  \t|  \t| ✓\t| \n","| mobileDevice                                   \t| ○\t|  \t|  \t| ○\t| \n","| mobileEnvironment                              \t| ○\t|  \t|  \t| ○\t| \n","| mobileOs                                       \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"DomainTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| domainTargetDetails                                                                         \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetDetails.advertiserDomainList                                                    \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.advertiserDomainList.inheritFromAdvertiser                       \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetDetails.domainFileTarget                                                        \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.domainFileTarget.domainFileId                                    \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.domainFileTarget.domainFileKey                                   \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetDetails.domainFileTarget.domainFileName                                  \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetDetails.domainFileTarget.domainFileUrl                                   \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.domainListTarget                                                        \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.domainListTarget.domainListId                                    \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetDetails.domainNameTarget                                                        \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.domainNameTarget.domainName                                      \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetType                                                                            \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"FoldPositionTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| foldPosition                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"InventorySourceTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| inventorySourceId                                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| inventorySourceId.defaultValue                                                                \t| ○\t|  \t|  \t| ○\t| \n","| inventorySourceId.marketplaceSettings                                                         \t| ○\t|  \t|  \t|  \t| \n","| inventorySourceId.marketplaceSettings.StringMarketplaceSetting\\[]                       \t| ○\t|  \t|  \t|  \t| \n","| inventorySourceType                                                                           \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"KeywordTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| keyword                                            \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| matchType                                          \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| nativeLanguageKeyword                              \t| ○\t| ○\t| ○\t|  \t| \n","| nativeLanguageLocale                               \t| ○\t| ○\t| ○\t|  \t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"LocationTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| locationId                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"NativeContentPositionTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| nativePosition                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ProductCategoryTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| productCategoryRefinement                                                                                                \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| productCategoryRefinement.marketplaceSettings                                                                            \t| ○\t|  \t|  \t|  \t| \n","| productCategoryRefinement.marketplaceSettings.ProductCategoryRefinementMarketplaceSetting\\[]                       \t| ○\t|  \t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement                                                                      \t| ○\t| ✓\t| ○\t| ○\t| \n","| productCategoryRefinement.productCategoryRefinement.productAgeRangeId                                             \t| ○\t| ○\t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productAgeRangeIdResolved                                     \t| ○\t| ○\t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productBrandId                                                \t| ○\t| ○\t| ○\t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productBrandIdResolved                                        \t| ○\t| ○\t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productCategoryId                                             \t| ○\t| ○\t| ○\t| ○\t| \n","| productCategoryRefinement.productCategoryRefinement.productCategoryIdResolved                                     \t| ○\t| ○\t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productPriceGreaterThan                                       \t| ○\t| ○\t| ○\t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productPriceLessThan                                          \t| ○\t| ○\t| ○\t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productPrimeShippingEligible                                  \t| ○\t| ○\t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productRatingGreaterThan                                      \t| ○\t| ○\t| ○\t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productRatingLessThan                                         \t| ○\t| ○\t| ○\t|  \t| \n","| productGenreRefinement                                                                                                   \t| ○\t| ○\t|  \t|  \t| \n","| productGenreRefinement.productGenreId                                                                                    \t| ○\t| ✓\t|  \t|  \t| \n","| productGenreRefinement.productGenreIdResolved                                                                            \t| ○\t| ○\t|  \t|  \t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ProductTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| matchType                                                                            \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| product                                                                              \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| product.marketplaceSettings                                                          \t| ○\t|  \t|  \t|  \t| \n","| product.marketplaceSettings.ProductMarketplaceSetting\\[]                       \t| ○\t|  \t|  \t|  \t| \n","| product.productId                                                                    \t| ○\t| ✓\t| ○\t|  \t| \n","| productIdType                                                                        \t| ✓\t| ✓\t| ✓\t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ThemeTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| matchType                              \t| ✓\t| ✓\t| ✓\t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ThirdPartyTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| thirdPartyTargetDetails                                                                                                     \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyTargetDetails.doubleVerifyAuthenticAttention                                                                      \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyAuthenticAttention.universalAttention                                            \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyTargetDetails.doubleVerifyAuthenticBrandSafety                                                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyAuthenticBrandSafety.doubleVerifySegmentId                                       \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.appAgeRating                                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.appStarRating                                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.contentCategories                                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.contentCategoriesWithRisk                                            \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.excludeAppsWithInsufficientRating                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.unknownContent                                                       \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyCustomContextualSegmentId                                                               \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyCustomContextualSegmentId.doubleVerifySegmentId                                  \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyFraudInvalidTraffic                                                                     \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyFraudInvalidTraffic.blockAppAndSites                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyFraudInvalidTraffic.excludeAppsAndSites                                          \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyFraudInvalidTraffic.excludeImpressions                                           \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyStandardDisplayBrandSafety                                                              \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyStandardDisplayBrandSafety.contentCategories                                     \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyStandardDisplayBrandSafety.contentCategoriesWithRisk                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyStandardDisplayBrandSafety.unknownContent                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyViewability                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyViewability.averageCompletionAndFullyViewableRateTargeting                       \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyViewability.brandExposureViewabilityTargeting                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyViewability.includeUnmeasurableImpressions                                       \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyViewability.mrcViewabilityTargeting                                              \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.excludeContent                                                  \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyAdult                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyAlcohol                                           \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyGambling                                          \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyHateSpeech                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyIllegalDownloads                                  \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyIllegalDrugs                                      \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyOffensiveLanguage                                 \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyViolence                                          \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceContextualAvoidance                                                                \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceContextualAvoidance.avoidanceSegments                                       \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceContextualTargeting                                                                \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceContextualTargeting.topicalSegments                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceContextualTargeting.verticalSegments                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceFraudInvalidTraffic                                                                \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceFraudInvalidTraffic.targetSetting                                           \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceQualitySync                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceQualitySync.segmentId                                                       \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceViewability                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceViewability.standard                                                        \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyTargetDetails.integralAdScienceViewability.viewabilityTargeting                                            \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.newsGuardBrandGuardMisinformationSafety                                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.newsGuardBrandGuardMisinformationSafety.avoidanceList                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.newsGuardBrandGuardTrustedNewsTargeting                                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.newsGuardBrandGuardTrustedNewsTargeting.targetingList                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.pixalateFraudInvalidTraffic                                                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.pixalateFraudInvalidTraffic.excludeAppsAndDomains                                            \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.pixalateFraudInvalidTraffic.excludeIpAddressAndUserAgents                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.pixalateFraudInvalidTraffic.excludeOttAndMobileDevices                                       \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.pixalateFraudInvalidTraffic.excludeRemovedAppsFromAppStores                                  \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetType                                                                                                        \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"VideoAdFormatTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| videoAdFormat                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"VideoContentDurationTarget"},"path":"/en-us/guides/campaign-management/entities/target","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| duration                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The adassociation entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/campaign-management/entities/ad-association","content":[" Ad associations apply to Amazon DSP ad groups only and correspond to ad creative associations in earlier versions of the campaign management API.\n"],"documentType":"guide"},{"title":"The adassociation entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"AdAssociation parameters by ad product"},"path":"/en-us/guides/campaign-management/entities/ad-association","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| \n","| adAssociationId                              \t| □\t| □\t| \n","| adGroupId                                    \t| ✓\t| ✓\t| \n","| adId                                         \t| ✓\t| ✓\t| \n","| endDateTime                                  \t| ○\t| ○\t| \n","| startDateTime                                \t| ○\t| ○\t| \n","| state                                        \t| ✓\t| ✓\t| \n","| weight                                       \t| ○\t| ○\t| \n"],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/campaign-management/example-payloads","content":[" This document includes example request payloads for campaign management operations in the Amazon Ads API. Learn more about the campaign management API.\n"," The examples are arranged by ad product, then by resource, with an example payload for each available operation on each resource.\n"],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Technical notes"},"path":"/en-us/guides/campaign-management/example-payloads","content":["IDs included in these examples should be replaced with appropriate IDs for the resources in your account. - Additional optional fields may be available for some requests. For complete information, see: - For complete information on request paths and header values, see the OpenAPI specification.\n"],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Contents"},"path":"/en-us/guides/campaign-management/example-payloads","content":["| Ad product | Resources |  |  |  |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| Sponsored Products | Campaign | Ad group | Ad | Target |\n","| Sponsored Brands | Campaign | Ad group | Ad | Target |\n","| Sponsored Display | Campaign | Ad group | Ad | Target |\n","| Sponsored TV | Campaign | Ad group | Ad | Target |\n","| Amazon DSP | Campaign | Ad group | Ad | Target |\n"],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":2,"text":"Sponsored Products "},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Campaign"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Ad Group"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Ad"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Target"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":2,"text":"Sponsored Brands"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Campaign"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Ad Group"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Ad"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Target"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":2,"text":"Sponsored Display"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Campaign"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Ad Group"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Ad"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Target"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":2,"text":"Sponsored TV"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Campaign"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Ad Group"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Ad"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Target"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Campaign"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Ad Group"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Ad"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Example request payloads for campaign management in the Amazon Ads API","sectionHeader":{"type":3,"text":"Target"},"path":"/en-us/guides/campaign-management/example-payloads","content":[],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":null,"path":"/en-us/guides/campaign-management/global-campaigns","content":[" Global advertising makes it easier for Amazon selling partners to advertise globally, whether they sell in two or fifteen countries. With global campaign APIs you can create and manage Sponsored Products campaigns that target any number of marketplaces from a single campaign (for example, one campaign can target US, GB, and DE together). This guide covers global campaigns for Sponsored Products (GCM-SP), available on the Ads API v1 campaign management APIs (/adsApi/v1/).\n"," The sequence of API calls to create and manage global campaigns is as follows:\n","Call the account APIs to get or create a Global Account if you don't already have one. If you already have an existing Ads account using Profiles, it's highly likely you already have a Global Account. You can also update, delete, and get Global Account properties. 2. Call the Global Campaign APIs to create a global campaign, supplying your own inputs per marketplace. You can also get and update your global campaigns. 3. Call the Reporting API or Amazon Marketing Stream to view the performance of your global campaigns.\n"," You provide all campaign parameters for all marketplaces. These values can either be entered directly by you, or you can provide the values for one marketplace and receive the localized values for all other marketplaces using the localization APIs available in our public API documentation.\n"," This guide includes example requests and responses for various scenarios, which you can use to build out your backend.\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":2,"text":"Global Account (prerequisite)"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" API overview: Register for a single advertising account that covers all countries where you sell globally. Advertising accounts are globalized in nature, so they come with a country dimension: advertisers eligible for multiple countries get one advertising account that spans all of them. Each country has its own ID specific to each advertiser, which you'll use to make individual requests for most other APIs.\n"," For existing Ads accounts: If you already have a Profile that you use with the existing Amazon Ads APIs, you already have a Global Account. Use the /adsAccounts/list API to list all of your existing accounts and find the Global Account ID linked to your Profile. You do not need to create a new Global Account via registration if you already have one linked to your Profile.\n"," How it's used: The Global Account ID is passed in the required Amazon-Ads-AccountId header on every Global SP create, query, update, and delete call.\n"," For more information, see Create accounts.\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":2,"text":"Global reporting"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" API overview: View the performance of your global campaigns. Only the spCampaigns report surfaces global campaigns.\n"," Required? Yes — if you don't integrate with the reporting API, you won't be able to see the performance of your global campaigns.\n"," For more information, see Reporting Overview.\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":2,"text":"Before you start — conventions"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" A few conventions apply to every GCM-SP request, so they aren't repeated in each scenario below.\n"," Endpoints. Global SP uses the same endpoints as existing Sponsored Products. Every operation is a POST, including get/list (query) and delete:\n"," Headers. These are required on every call:\n"," Marketplace-aware fields. Every resource is global, so it carries:\n","marketplaceScope — always \"GLOBAL\". - marketplaces — the list of marketplaces the resource applies to (a child's list must be a subset of its parent's). Use the ISO code GB for the United Kingdom. Supported: AE, AU, BE, BR, CA, DE, EG, ES, FR, GB, IN, IT, JP, MX, NL, PL, SA, SE, SG, TR, US. - marketplaceConfigurations — per-marketplace overrides (for example, pausing one marketplace). When you don't specify an override, the global value applies everywhere.\n"," Responses. Create, update, and delete return HTTP 207 (multi-status) with success, error, and partialSuccess arrays, each entry keyed by its index in your request. Query returns HTTP 200 with the resource array plus a nextToken for pagination; status fields are always included.\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":2,"text":"Global campaign APIs"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" These APIs are used to create global campaigns, where the advertiser enters all campaign parameters for all marketplaces. These values can either be provided by the advertiser, or the advertiser can provide the campaign values for one marketplace and receive the localized values for all other marketplaces using the localization APIs available in our public API documentation.\n"," A global campaign can run in all marketplaces where your products are available, or you can choose to target it to a single marketplace or a specific set of marketplaces. You can also let the campaign auto-expand to new marketplaces as they become available (autoScaleGlobalCampaign: AUTO) or expand it only when you update it explicitly (MANUAL).\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":2,"text":"Example requests and successful responses"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" In this section we detail various global campaign example scenarios and their successful responses. We will continue to update this guide with more example scenarios.\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":3,"text":"Scenario 1: Auto targeting across three marketplaces"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" Launch a global campaign targeting three marketplaces (US, GB, DE) with auto targeting. The budgets are $100, £80, €60; bids of $0.98, £0.57, €0.47. The global campaign is in the ENABLED state, while in GB it is in a PAUSED state.\n"," URL: /adsApi/v1/create/campaigns   HTTP method: POST\n"," Request:\n"," Response:\n"," Get campaign — get details of a global campaign.\n"," URL: /adsApi/v1/query/campaigns   HTTP method: POST\n"," Request:\n"," Response:\n"," The campaign is paused only in GB, so the global deliveryStatus is LIMITED: US and DE deliver, GB does not.\n"," URL: /adsApi/v1/create/adGroups   HTTP method: POST\n"," Request:\n"," Response:\n"," Ads are created one per marketplace. Below is the US ad; repeat this call for GB (product B09B8X9RGM) and DE (product B09B96TG33), each with its own marketplaces value.\n"," URL: /adsApi/v1/create/ads   HTTP method: POST\n"," Request:\n"," Response:\n"," Get ad\n"," URL: /adsApi/v1/query/ads   HTTP method: POST\n"," Request:\n"," Response:\n"," With auto targeting (autoCreateTargets: true), targets are created for you — no explicit target create is required in this scenario. The API automatically generates THEME targets: four match types (KEYWORDS_CLOSE_MATCH, KEYWORDS_LOOSE_MATCH, PRODUCT_COMPLEMENTS, PRODUCT_SUBSTITUTES) per marketplace, each single-marketplace and ENABLED. Retrieve them with a targets query scoped to the ad group.\n"," Get targets (auto-created)\n"," URL: /adsApi/v1/query/targets   HTTP method: POST\n"," Request:\n"," Response (the same four THEME targets are created for each marketplace — US shown here; GB and DE get an identical set):\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":3,"text":"Scenario 2: Manual keyword targeting across three marketplaces"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" Launch a global campaign targeting three marketplaces (US, CA, ES) with manual targeting, and budgets of $100, $80, €60; bids of $0.98, $0.57, €0.45. Use keyword targeting with the keyword \"Amazon echo dot (newest edition)\" in US and CA, and \"Amazon Echo Dot (modelo más reciente)\" in ES.\n"," URL: /adsApi/v1/create/campaigns   HTTP method: POST\n"," Request:\n"," Response:\n"," URL: /adsApi/v1/create/adGroups   HTTP method: POST\n"," Request:\n"," Response:\n"," Ads are created one per marketplace. Below is the US ad; repeat for CA (B09B8V1LZ3) and ES (B0CQTJ59FR).\n"," URL: /adsApi/v1/create/ads   HTTP method: POST\n"," Request:\n"," Response:\n"," Keyword targets are created one per marketplace. Below is the US keyword \"Amazon echo dot (newest edition)\"; repeat for CA (\"Amazon echo dot (newest edition)\") and ES (\"Amazon Echo Dot (modelo más reciente)\"), each with its own marketplaces and bid.\n"," URL: /adsApi/v1/create/targets   HTTP method: POST\n"," Request:\n"," Response:\n"," For the ES keyword, send the same call with \"marketplaces\": \\[\"ES\"], the ES bid, and keywordTarget.keyword = \"Amazon Echo Dot (modelo más reciente)\". For native-language keywords, add nativeLanguageKeyword and nativeLanguageLocale to keywordTarget.\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":3,"text":"Scenario 3: Manual product targeting across four marketplaces"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" Launch a global campaign targeting four marketplaces (US, CA, GB, AU) with manual targeting, and budgets of $100, $80, £75, $90; bids of $0.98, $0.57, £0.47, $1.03. Use product targeting with a per-marketplace ASIN.\n"," URL: /adsApi/v1/create/campaigns   HTTP method: POST\n"," Request:\n"," Response:\n"," URL: /adsApi/v1/create/adGroups   HTTP method: POST\n"," Request:\n"," Response:\n"," Ads are created one per marketplace. Below is the US ad; repeat for CA (B09B8V1LZ3), GB (B09B8X9RGM), and AU (B09B8YP8KY).\n"," URL: /adsApi/v1/create/ads   HTTP method: POST\n"," Request:\n"," Response:\n"," Product targets are created one per marketplace. Below is the US target; repeat for CA (B003456), GB (B006789), and AU (B002389).\n"," URL: /adsApi/v1/create/targets   HTTP method: POST\n"," Request:\n"," Response:\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":3,"text":"Scenario 4: Manage an existing global campaign"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" Manage an existing global campaign: pause it in one marketplace, expand it to a new marketplace, then archive it. All mutations are POST.\n"," Set a per-marketplace state override with marketplaceConfigurations — the rest of the campaign keeps delivering.\n"," URL: /adsApi/v1/update/campaigns   HTTP method: POST\n"," Request:\n"," Response:\n"," Update marketplaces and include the budget for the new marketplace in the same call — a marketplaces-only update is rejected with FIELD_VALUE_IS_NULL. Afterwards, update the ad group / ad / target marketplaces to match.\n"," URL: /adsApi/v1/update/campaigns   HTTP method: POST\n"," Request:\n"," Response:\n"," Child resources (ad group, ad, target) are updated the same way on their own endpoints — POST /adsApi/v1/update/{adGroups|ads|targets} — keyed by adGroupId, adId, or targetId respectively (for example, change an ad group bid, pause an ad, or change a target bid).\n"," URL: /adsApi/v1/delete/campaigns   HTTP method: POST\n"," Request:\n"," Response:\n"," The same delete pattern applies to child resources with adGroupIds, adIds, and targetIds (delete children before archiving the parent, since a cascade already archives them).\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":2,"text":"Appendix — reference"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":3,"text":"Query filters"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" Every query requires adProductFilter and marketplaceScopeFilter (GLOBAL). Additional filters: campaignIdFilter, adGroupIdFilter, adIdFilter, targetIdFilter, stateFilter, nameFilter, targetTypeFilter, plus maxResults and nextToken.\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":3,"text":"Delivery status"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" Query responses include a status object with a global deliveryStatus plus per-market marketplaceSettings. deliveryStatus is one of DELIVERING, LIMITED, NOT_DELIVERING, UNAVAILABLE. deliveryReasons explain a non-delivering/limited status; common values include CAMPAIGN_PAUSED, CAMPAIGN_INCOMPLETE, CAMPAIGN_OUT_OF_BUDGET, CAMPAIGN_PENDING_START_DATE, CAMPAIGN_END_DATE_REACHED, CAMPAIGN_ARCHIVED, AD_GROUP_PAUSED, AD_PAUSED, TARGET_PAUSED, OUT_OF_STOCK, NOT_IN_BUYBOX, and moderation/policing reasons.\n"," In status.marketplaceSettings\\[], the API returns the marketplace ID (for example, A1F83G8C2ARO7P for the UK) rather than the country code. Examples in this guide use country codes for readability.\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":3,"text":"Key fields"},"path":"/en-us/guides/campaign-management/global-campaigns","content":["marketplaceScope — always \"GLOBAL\"; required on every create. - marketplaces — country codes the resource applies to; a child's set must be a subset of its parent's. Ads and targets carry a single marketplace. - marketplaceConfigurations — per-marketplace overrides on campaigns and ad groups (state, name, startDateTime, endDateTime, optimizations, tags). - autoCreationSettings.autoCreateTargets — true for auto targeting, false for manual keyword/product targets. - autoScaleGlobalCampaign — AUTO (auto-expand to new marketplaces) or MANUAL. - state — ENABLED, PAUSED, or ARCHIVED (archived is terminal). - bidStrategy — MANUAL, SALES_DOWN_ONLY, SALES_UP_AND_DOWN, RULE_BASED, or NEW_TO_BRAND (Global SP-only). Bid strategy is campaign-level; only bid values differ per marketplace. - targetType — KEYWORD, PRODUCT, PRODUCT_CATEGORY, THEME. - productIdType — ASIN (vendor accounts) or SKU (seller accounts). - currencyCode — the marketplace's local currency (USD for US, GBP for GB, EUR for DE/FR/IT/ES, etc.).\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":3,"text":"FAQs"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[" Can I mix SP and Global SP campaigns under one account? Yes — different campaign types, managed independently.\n"," What if I omit marketplaceConfigurations? The global (top-level) value applies uniformly to all marketplaces.\n"," Can I use different bid strategies per marketplace? No. bidStrategy is campaign-level; only bid values differ per marketplace.\n"," Can I create a global campaign with a single marketplace? Yes — start with one and expand later.\n"," Will additional ad products get global feature support? Yes, this is planned. We will provide updates through release notes and updates to spec and this guide.\n"],"documentType":"guide"},{"title":"Global campaigns for Sponsored Products","sectionHeader":{"type":2,"text":"Related resources"},"path":"/en-us/guides/campaign-management/global-campaigns","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":null,"path":"/en-us/guides/conversions/01-overview","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Conversion Tracking"},"path":"/en-us/guides/conversions/01-overview","content":[" In the world of digital advertising, accurate conversion tracking is the cornerstone of effective campaign management and optimization. Amazon Ads recognizes this critical need and offers a comprehensive suite of conversion tracking solutions to cater to diverse advertiser requirements.\n"," Amazon Ads distinguishes between two types of conversions. First, there are on-Amazon conversions, which occur within the Amazon platforms. These conversions, such as product purchases or add-to-cart actions, are automatically tracked and readily available to advertisers through both the Amazon Ads Console user interface and APIs. For those seeking deeper insights, these conversion metrics are also accessible via Amazon Marketing Cloud (AMC), enabling advanced analysis and reporting.\n"," The second category, off-Amazon conversions, addresses the need to track customer actions that take place outside of Amazon such as the digital properties of advertisers and social media. Amazon provides four distinct methods for tracking these off-platform conversions: Amazon Ad Tag (AAT), Amazon Attribution Tags, Amazon Marketing Cloud (AMC), and the Amazon Conversions API (CAPI). Each of these solutions is tailored to specific scenarios and business needs, offering advertisers the flexibility to choose the most suitable approach for their unique requirements.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"The diagram below shows the data flow for each of these approaches"},"path":"/en-us/guides/conversions/01-overview","content":[" Note: For off-Amazon conversion data to appear in AMC tables using CAPI v1, two steps are required. First, create a Conversion Definition. Second, associate that definition with a campaign. Simply uploading data through Conversions API or AAT without completing both steps will not make your conversion data visible in AMC. On-Amazon conversion data automatically appears in AMC tables. \n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Definitions:"},"path":"/en-us/guides/conversions/01-overview","content":[" Conversion: Conversion in Amazon Ads refers to a specific, measurable action taken by a user after interacting with an advertisement. This action is typically one that is valuable to the advertiser and indicates progress in the customer journey towards a purchase or other desired outcome. Conversions can occur either on the Amazon platform (on-Amazon) or on the digital properties of an advertiser (off-Amazon).\n"," On-Amazon conversions: On-Amazon conversions are customer actions that occur directly on the Amazon platform after viewing or clicking an advertisement.\n"," Off-Amazon conversions: Off-Amazon conversions are customer actions that occur outside of the Amazon platform, typically on the website or app of an advertiser, but could cover any eventType Event Type.\n"," Ad-attributed conversions: Conversions are ad-attributed if a user was served a traffic event within the 28-day period prior to the conversion event.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Conversion Attribution"},"path":"/en-us/guides/conversions/01-overview","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Match Keys and Identity Resolution"},"path":"/en-us/guides/conversions/01-overview","content":[" Match keys represent the customer and device identifier values to be used for attribution to traffic events. ID resolution is the process of matching the identifiers in the uploaded file to a corresponding Amazon user record. This allows you to join your uploaded data with Amazon data at the user level.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Conversions on Amazon"},"path":"/en-us/guides/conversions/01-overview","content":[" The native tracking capabilities within Amazon.com provide essential conversion data for individual product listings, serving as the foundation for performance analysis on the platform. This tracking method requires no additional setup as it is automatically enabled. When customers interact with ads on Amazon and make purchases or add items to their cart, the Amazon internal system captures these interactions seamlessly. The data flows directly into your advertising platform, where multi-touch attribution distributes conversion credit across customer touch points.\n"," Use Case: Track conversions on Amazon.com.\n"," Data Availability: Reporting API and AMC.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Amazon Ad Tag (AAT)"},"path":"/en-us/guides/conversions/01-overview","content":[" For businesses with their own websites, Amazon AAT provides a client-side solution for firing and logging events. Implementation begins with generating a unique AAT ID using the Amazon Ads Console or Amazon Ads API. This unique ID can then be leveraged within the Amazon AAT JavaScript on your website to create a bridge between your site and the Amazon Ads Event Manager. For example, you can add the AAT code to your thank you page that shows after purchase completion to log off-Amazon purchases. When customers interact with your ads and complete actions on your website, the AAT transmits these events back to Amazon. \n"," For more information on how to use AAT, refer to AAT documentation.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Amazon Attribution Tags"},"path":"/en-us/guides/conversions/01-overview","content":[" External marketing efforts require a different approach, which is where the Amazon Attribution API system plays a crucial role. First, you create unique tracking URLs for each marketing campaign through the Amazon Ads Console or Amazon Ads API. These tagged links, when implemented in your social media, email, or other external marketing channels, create a tracking pathway. As customers click these links and eventually make purchases on Amazon, the system connects these external touchpoints to actual Amazon conversions, giving you clear visibility into your off-Amazon marketing effectiveness. This data is available through the attribution reporting API.\n"," For more information on how to use Amazon Attribution tags, please see Attribution API documentation.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Amazon Ads Conversions API (CAPI) v1 "},"path":"/en-us/guides/conversions/01-overview","content":[" For enterprises that have conversion events data such as conversions that happen on their own retail site, and would like to bring them to the Amazon Ads platform to attribute them to ads placed from Amazon Ads, the Amazon Ads Conversions API offers server-side tracking capabilities. First, you will create a conversion definition using Conversion API and link that to an order and then upload the events data. This method is particularly useful for tracking conversions that happen on the websites of advertisers or third-party sites, with data accessible through both the Reporting API and the AMC. \n"," Note: CAPI v1 is being replaced by the Events API. Please use the Events API going forward, Events API FAQs. \n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Events API (CAPI) v2"},"path":"/en-us/guides/conversions/01-overview","content":[" If you have conversion events data, such as conversions from your own retail website, and would like to attribute them to Amazon Ads campaigns, the Events API off-Amazon event import offers server-side tracking capabilities. This method is particularly useful for tracking conversions that happen on the websites of advertisers or third-party sites, with data accessible through both the Reporting API and the AMC. \n"," For more information on how to use Events API, please see Events API Developer Guide: Events API Developer Guide.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Conversions via Amazon Marketing Cloud (AMC)"},"path":"/en-us/guides/conversions/01-overview","content":[" The AMC Advertiser data upload (ADU) API allows you to upload customizable datasets including conversions data to an AMC instance. Advertiser uploaded datasets can include any combination of columns defined by the advertiser. ADU APIs on Amazon Ads are also referred to as ADU 2.0. \n"," For more information on how to use ADU, please see: ADU Developer Guide.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Conversions via Amazon Marketing Cloud on AWS Clean Rooms (AMC on ACR)"},"path":"/en-us/guides/conversions/01-overview","content":[" Amazon Marketing Cloud (AMC) on AWS Clean Rooms enables advertisers (you) to seamlessly collaborate with Amazon Ads exclusive signals, generate enhanced insights, and discover new audiences, all without having to move any conversions data outside of your Amazon Web Services (AWS) environment. \n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":null,"path":"/en-us/guides/conversions/02-capi","content":[" The Conversions API enables Amazon Ads advertisers to import events that originate from their web, app, or offline properties as conversion definitions as defined below, as well as manage conversion definitions for events imported via the Conversions API.\n"," To use the Conversions API, you must have an Advertiser account within the Amazon DSP console. Create a new advertiser. If you already have an advertiser account, you can move to the next step.\n"," You must have a Self-Service ADSP account with complete access to the DSP entity for you to be able to upload conversions events via CAPI v1. If you only have access to the ADSP advertiser account, you will not be able to upload conversions events via CAPI v1. If you only have access to the ADSP account, please use Events API.\n","Self-Service (SS) Accounts. Supported  Manager Accounts (MA). Not Supported  Managed Service (MS) Accounts Not Supported\n"," Use Case:  Track conversions that happen on the website of the advertiser.\n"," Data Availability: Reporting API and the AMC.\n"," Implementation Steps:\n","Enable the Conversions API in Amazon DSP 2. Create a conversion definition 3. Associate conversion definition to an order 4. Import conversion events\n"," Enable the Conversions API in Amazon DSP\n","Accept the terms and conditions within your Amazon DSP advertiser. 2. Open your Amazon DSP advertiser and select your entity. 3. Select your advertiser from the list. 4. Navigate to the \"Events Manager\" tab in the left-hand navigation. 5. Read and accept the terms and conditions. 6. Take note of the advertiser ID as this will be required for creating conversion definition and enabling event feeds in the next steps.\n"," Create a Conversions Definition\n"," Create conversion definitions (required). To create a conversion definition, make a POST request to the /accounts/{accountId}/dsp/conversionDefinitions endpoint. Repeat this step for each event that you wish to track and report separately, for example Purchase, Add to Cart, Subscription. Please take note of the conversion definition ID returned in the success response as you will use this identifier in the next step. Alternatively, you can use the get list endpoint to retrieve the conversion definition ID.\n"," Get a List of Conversion Definitions\n"," Get a list of conversion definitions. To get a list of conversion definitions associated with the Amazon advertiser account, make a POST request to the /accounts/{accountId}/dsp/conversionDefinitions/list endpoint.\n"," Associate conversion definition to an order\n"," You must associate your conversion definition to an order for the conversions to be attributed. To associate a conversion definition to an order, make a POST request to the /accounts/{accountId}/dsp/orders/{orderId}/conversionDefinitionAssociations endpoint.\n"," Import conversion events\n"," To send events, make a POST request to the /accounts/{accountId}/dsp/conversionDefinitions/eventData endpoint. You can deliver events in batch or streaming. Requests are limited to 5 transactions per second per advertiser. If any events you send in the batch are invalid, they will be rejected and other valid events in the batch will be accepted.\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":2,"text":"Troubleshooting & FAQs"},"path":"/en-us/guides/conversions/02-capi","content":[],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"Events show as delivered in CDP but do not appear in Amazon. Why? "},"path":"/en-us/guides/conversions/02-capi","content":[" This usually indicates: \n","Wrong region selected in destination settings   Amazon account permissions not properly set   Data validation issues on the Amazon side   Processing delays (wait up to 30 minutes)   Verify your Advertiser ID is correct and active  Check Amazon Events Manager for processing errors  Ensure you have accepted T&C in Amazon.\n"," If available Check the Event Delivery in the partner platform for detailed error messages and verify your Amazon account configuration.\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"What do the Error Codes Mean?"},"path":"/en-us/guides/conversions/02-capi","content":[" Error Code Description Solution\n","400 Bad Request - Invalid payload Check JSON formatting and required fields  401 Unauthorized - Authentication failed Re-authenticate Amazon connection  403 Forbidden - Insufficient permissions Verify Amazon account permissions  429 Rate Limited - Too many requests Implement request throttling  500 Server Error - Amazon API issue Retry request, contact support if persistent\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"How long does it take for events to appear in Amazon?"},"path":"/en-us/guides/conversions/02-capi","content":[" Events typically appear in Amazon Events Manager within 30 minutes. For attribution in campaign reports, allow up to 24 hours for complete processing.\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"It is noticed that the event count is almost duplicated. Also, we are able to see that there is a high percentage % of excluded events"},"path":"/en-us/guides/conversions/02-capi","content":[" This is common as the events will be excluded if the client is sending the same dedupe ID. See here for instructions: https://advertising.amazon.com/help/GP5ZEF499J3K976K\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"What is the maximum number of events I can send?"},"path":"/en-us/guides/conversions/02-capi","content":[" You can batch up to 500 events per API request. For high-volume implementations, use batching for better efficiency while monitoring for any rate limiting.\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"Where can I see the Events Manager event feed in ADSP and the conversion definitions I have built? How should I expect it to look?  "},"path":"/en-us/guides/conversions/02-capi","content":["Check the \"Events Manager\" section at the Advertiser-level within ADSP which accommodates the new conversion definitions within Events Manager. ADSP users can expect to see the below fields in this table:    Conversion Source: Where ADSP received the conversion from (example: Amazon Ad Tag, Conversion API) as well as the conversion type (example: web, offline, app)    Conversion Name: The conversion definition name that ADSP received from the advertiser (reminder that Events Manager supports user-defined event names)    Conversion Type: The category of event that the advertiser defined - one of our 10 defaults (or Other)   Conversion Method: The counting methodology that the advertiser tells ADSP to use when sending the conversion definition. \"Every\" would count every conversion event passed to ADSP whereas \"Only the First\" would uniquely count conversion for the first time a user completes the intended action within a 24-hour period    Default conversion value: This optional field to associate a value with a conversion will have two options for the advertiser to utilize. An advertiser can either assign a static value to a conversion (i.e. - all conversions on this product are $20) or dynamically pass in the value associated with a conversion (i.e. - this shopping cart has $57.50 worth of items in it). If a different value is being passed through directly on the AAT/CAPI signal, that will trump any data entered manually in this field  Off-Amazon Conversions: Any value will be considered monetary when a currency type is provided (it will default to non-monetary if not defined), and reporting will provide product sales, units sold, ROAS, reconciled ROAS and eRPM.   All Additional Conversions (Pageview, Application, etc.): Only non-monetary values are supported as there is not a currency field associated with these conversion definitions, and we will provide value sum and value average in reporting.    Last Activity: The last time an event was sent to ADSP   \\* Last Update: The last time a change was made to the setting of a conversion definition (i.e. - type, method or static value changes)\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"Where will this conversion reporting be available? "},"path":"/en-us/guides/conversions/02-capi","content":[" As Events Manager supports user-defined conversion events, we cannot support all of these events within existing standard reports across ADSP (only pre-defined events will be available across all report types). The user-defined events from Events Manager will be included in the \"Off-Amazon\" metrics (Off-Amazon metrics include any conversions supplied by a third-party who is not Amazon). These reports will support the granularity of: Advertiser, Order, Line, Creative, Conversion, and Source\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"How do I see Conversion metrics in Reporting"},"path":"/en-us/guides/conversions/02-capi","content":["Campaign Manager tables – supports pre-defined Conversion event type (e.g. SignUp, Subscribe)  In Campaign Manager view, click Customize columns > Off-Amazon conversions and select the event type matched to your conversion definition.   Example: Add to shopping cart conversion type will match up to ATSC in DSP reporting\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"How do I see reporting, example Event reporting by conversion name? "},"path":"/en-us/guides/conversions/02-capi","content":["Custom reporting > Report Center – supports custom conversion names  Click into Amazon DSP reports > New custom report > select Off-Amazon from dropdown   Conversion event name will be reported in this downloadable report. Reported conversions are needed first in order to show data rows.\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"Can I use this integration with Amazon Sponsored Ads? "},"path":"/en-us/guides/conversions/02-capi","content":[" This integration is primarily designed for Amazon DSP (Demand-Side Platform). For Sponsored Ads, you may need additional configuration or a different approach.\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"Can I send historical data?  "},"path":"/en-us/guides/conversions/02-capi","content":[" Events must be sent within 7 days of when they occurred. Amazon will reject events older than 7 days to ensure data freshness and attribution accuracy.\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"My events are being rejected. What should I check? "},"path":"/en-us/guides/conversions/02-capi","content":[" Common validation issues:\n","Missing required user match keys (need at least one: email, phone, mobile ID, etc.)   Incorrect currency format (use ISO-4217 codes like USD, EUR)   Invalid custom attribute names (only letters, numbers, underscores allowed)   Missing required fields for purchase events (currency, value)   Events older than 7 days \\*  Malformed JSON payload\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"Can I send custom events not in the preset mappings? "},"path":"/en-us/guides/conversions/02-capi","content":[" Yes, you can create custom mappings in CDP (if applicable) and use the OTHER event type in Amazon for events that do not fit standard categories. Include relevant custom attributes to provide business context.\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"We have a consent setup in place that prevents data from being sent to Amazon CAPI unless the required consents (Ad User Data and Ad Storage) are granted. Is this enough? I also do not have any information on TCF and GPP strings, how should these be handled?"},"path":"/en-us/guides/conversions/02-capi","content":[" You can send TCF or Amazon Consent Signal (AdStorage and UserData). Only 1 consent signal should be sent. However, in case both events are sent - TCF is used as the primary signal. TCF and GPP consist of an encoded consent string which can be decoded to detailed consent information. Please refer to this documentation for an example of how the dataset request looks like on Amazon Ads: https://advertising.amazon.com/API/docs/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-sets#specifying-user-privacy-choices\n"],"documentType":"guide"},{"title":"Conversions via Conversions API (CAPI v1)","sectionHeader":{"type":3,"text":"Where can I get additional help?"},"path":"/en-us/guides/conversions/02-capi","content":[" Support resources: 1. CDP Partner Support (preferred due to visibility of their infrastructure and ability to effectively troubleshoot CDP related issues) 2. Amazon Advertising Support: Through your Amazon Advertising Console\n"],"documentType":"guide"},{"title":"Conversions via Events API (AKA CAPI v2)","sectionHeader":null,"path":"/en-us/guides/conversions/03-events-api","content":[" For businesses seeking a more flexible, server-to-server (S2S) solution, the Amazon Events API (CAPIv2) enables advertisers to send conversion events directly from their backend systems, CRM, or Customer Data Platform (CDP) to Amazon Ads. This eliminates browser-based dependencies, improves data accuracy, and ensures conversions that occur outside of Amazon are captured reliably.\n"," Implementation begins with authenticating through Login with Amazon (LWA) and obtaining the appropriate scope for the DSP entity of the advertiser. Once authentication is complete, advertisers can use the POST /adsApi/v1/create/events endpoint to transmit event payloads that include key identifiers (such as hashed email, phone, or mobile IDs), event details (type, timestamp, and value), and consent signals.\n"," Conversions sent through Events API are used for attribution/measurement for associated campaigns, the results are available in ADSP reports. Events are also available in analytics tools such as AMC and ADM. This event-first model allows advertisers to stream real-time conversions, track offline transactions, and measure cross-channel performance using a single, unified integration.\n"," Note: Events API supports advertiser-owned (self-service). Advertisers can upload conversions data through Events API if they have admin access to the seat/entity or if they have Events Manager API permission at the ADSP account level. This enables agency-driven or multi-brand advertisers to consolidate event management under a single account structure (more on this here).\n"," Use Case: Send conversion events directly from server-side environments (e.g., CDPs, backend applications) to Amazon Ads.\n"," Data Availability: ADSP Reporting, Amazon Marketing Cloud (AMC), Ads Data Manager (ADM)\n"," Implementation Steps:\n"],"documentType":"guide"},{"title":"Conversions via Amazon Advertising Tags (AdTags)","sectionHeader":null,"path":"/en-us/guides/conversions/04-ad-tags","content":[" For businesses with their own websites, AAT provides a client-side solution for firing and logging events. Implementation begins with generating a unique AdTag ID using the Amazon Ads Console or Amazon Ads API. This unique ID can then be leveraged within the Amazon AdTag JavaScript on your website to create a bridge between your site and the Amazon Ads Event Manager. For example, you can add the AdTag code to your thank you page that shows after purchase completion to log off-Amazon purchases. When customers interact with your ads and complete actions on your website, the AdTag transmits these events back to Amazon.\n"," Once you have your Amazon AdTag configured, you can associate AAT events to conversion events within the Amazon DSP Event Manager, or via API. This data can then be incorporated into reports, leveraged in AMC, used to create audiences, and associated to campaigns to improve outcomes and support Brand+ tactics.\n"," Note: You can only create one tag per advertiser. However, you can fire different AAT events by changing the value passed in via the trackEvent parameter.\n"," Use Case: Track events occurring on an advertiser’s own website.\n"," Data Availability: Reporting API and AMC \n"," Implementation Steps:\n","Get an AdTag for the advertiser 2. Create an Amazon Ads conversion definition 3. Associate an AAT event to a conversion definition 4. Associate order to conversion definition\n"],"documentType":"guide"},{"title":"Conversions via Amazon Attribution Tags","sectionHeader":null,"path":"/en-us/guides/conversions/05-attribution-tags","content":[" External marketing efforts require a different approach, which is where the Amazon Attribution Tag system plays a crucial role. First, create unique tracking URLs for each marketing campaign through the Amazon Ads Console or Amazon Ads API. These tagged links, when implemented in your social media, email, or other external marketing channels, create a tracking pathway. As customers click these links and eventually make purchases on Amazon, the system connects these external touchpoints to actual Amazon conversions, giving you clear visibility into your off-Amazon marketing effectiveness. These data are available through attribution reporting API.\n"," Use Case: Track conversions from external advertising.\n"," Data Availability: Attribution Tag Reports\n"," Implementation Steps:\n","Get publishers (Google Ads 1, Facebook Ads 2,...)  2. Create an Amazon Attribution Tag 3. Insert into the ad as landing page  (Publisher dependent) 4. Report\n"],"documentType":"guide"},{"title":"Conversions via Amazon Data Manager (ADM)","sectionHeader":null,"path":"/en-us/guides/conversions/06-ads-data-manager","content":[" Ads data manager is an Amazon Ads offering with options that enable advertisers to securely upload their first-party (1P) data to Amazon Ads using either an intuitive user interface (Ads data manager console) or Ads data manager APIs. While the Events API focuses on real-time conversion tracking, ADM provides a broader scope for data management, including audience creation and event data handling.\n"],"documentType":"guide"},{"title":"Conversions via Amazon Marketing Cloud (AMC)","sectionHeader":null,"path":"/en-us/guides/conversions/07-amc","content":[" The advertiser data upload (ADU) API of AMC allows advertisers to upload customizable datasets including conversions data to an AMC instance. Advertiser uploaded datasets can include any combination of columns defined by the advertiser. ADU APIs on Amazon Ads are also referred to as ADU 2.0.\n"," Uploaded conversions data can be joined with existing AMC data for analysis and campaign optimization. For instance, an advertiser might use the Events API to track purchases made after viewing a particular ad campaign. This data could then be used within AMC to create an audience segment of high-value customers who have made multiple purchases. This segment could then be targeted with a loyalty campaign, the results of which would again be tracked through the Events API.\n"," Note: The conversion uploaded via ADU is only available in AMC. However it can be used to create audiences and sent to ADSP.\n"],"documentType":"guide"},{"title":"Conversions via Amazon Marketing Cloud on AWS Clean Rooms (AMC on ACR)","sectionHeader":null,"path":"/en-us/guides/conversions/08-amc-on-acr","content":[" Amazon Marketing Cloud (AMC) on AWS Clean Rooms enables you to seamlessly collaborate with Amazon Ads exclusive signals, generate enhanced insights, and discover new audiences, all without having to move any underlying data outside of your Amazon Web Services (AWS) environment. AMC on AWS Clean Rooms delivers a comprehensive view of customer interactions and business outcomes that can generate insights and activate audiences in the Amazon DSP and in Sponsored Ads.\n"," You can share conversions data with AMC on ACR and join with existing AMC data for analysis and campaign optimization. This data could then be used within AMC to create an audience segment of high-value customers who have made multiple purchases. This segment could then be targeted with a loyalty campaign, the results of which would again be tracked through the Events API.\n"," Note: The conversion shared with AMC on ACR is only available in AMC. However it can be used to create audiences for use in Amazon DSP and in Sponsored Ads.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":null,"path":"/en-us/guides/conversions/faq","content":[],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"How Can I Improve the Match Rates?"},"path":"/en-us/guides/conversions/faq","content":["Include more user identifiers (email, phone, mobile ID)  Verify PII data is properly formatted before sending  Add geographic information (city, state, postal code)  Include user agent for web events  Use consistent external IDs across touchpoints\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"What is the difference between Amazon Ad Tag (AAT) and Amazon Conversions API (CAPI)?"},"path":"/en-us/guides/conversions/faq","content":[" AAT tracks events from the browser (client-side) and can be affected by ad blockers, network issues, or privacy settings. CAPI sends events directly from your server, providing more reliable data transmission. Using both together (with proper deduplication) gives you the most comprehensive tracking.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"If AAT or CAPI conversions are coming from multiple sources, how does the reporting logic know which one to pick?"},"path":"/en-us/guides/conversions/faq","content":[],"documentType":"guide"},{"title":"Exports overview","sectionHeader":null,"path":"/en-us/guides/exports/overview","content":[],"documentType":"guide"},{"title":"Exports overview","sectionHeader":{"type":2,"text":"What is exports?"},"path":"/en-us/guides/exports/overview","content":[" Use exports to efficiently retrieve the structure of your Amazon Ads campaigns. Exports are generated asynchronously and can be requested at multiple levels. \n"],"documentType":"guide"},{"title":"Exports overview","sectionHeader":{"type":2,"text":"Exports vs. reports"},"path":"/en-us/guides/exports/overview","content":[" While reports contain performance data for a specified day, exports provide metadata about your campaigns at the time of the request. In other words, you can use exports to retrieve metadata on all configured campaigns, ad groups, targeting expressions, and more, depending on the campaign type. \n"],"documentType":"guide"},{"title":"Exports overview","sectionHeader":{"type":2,"text":"Exports vs. list operations"},"path":"/en-us/guides/exports/overview","content":[" Exports return similar information to GET and GET /extended operations for campaigns, ad groups, keywords, and other campaign entities. Exports run asynchronously while GET and GET /extended are synchronous. If you have many campaigns or a complex campaign structure and are looking to pull information on all campaigns in your account, we suggest using exports.\n"," If you need details for a single campaign, use a GET request with query parameters instead of an export. \n"],"documentType":"guide"},{"title":"Exports overview","sectionHeader":{"type":2,"text":"Sample export output"},"path":"/en-us/guides/exports/overview","content":[" View sample JSON for:\n","Campaigns - Ad groups - Targets - Ads\n"],"documentType":"guide"},{"title":"Exports overview","sectionHeader":{"type":2,"text":"Export availability by ad type"},"path":"/en-us/guides/exports/overview","content":[" Each ad product supports different types of exports. \n","| Export type | Sponsored Products | Sponsored Brands | Sponsored Display |\n","\\|---------------\\|----\\|----\\|----\\|\n","| campaigns | x | x | x |\n","| adGroups | x | x | x |\n","| targets | x | x | x |\n","| ads | x | x | x |\n"],"documentType":"guide"},{"title":"Exports overview","sectionHeader":{"type":2,"text":"Fields by ad product and export type"},"path":"/en-us/guides/exports/overview","content":[" Exports follow the common model for the entity type requested. Each ad product can contain a subset of the available fields for that entity. \n"," To view all fields available, see:\n","Campaign common model - Ad group common model - Targets common model - Ads common model\n"," You can use the following tables to understand which fields are available for each ad product, and how each field maps to the campaign management APIs:\n","Campaign mapping table - Ad group mapping table - Target mapping table - Ads mapping table\n"],"documentType":"guide"},{"title":"Exports overview","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/exports/overview","content":[],"documentType":"guide"},{"title":"Get started with exports","sectionHeader":null,"path":"/en-us/guides/exports/get-started","content":[" This tutorial outlines how to asynchronously request and download exports for Amazon Ads campaigns. \n"," Exports contain metadata related to your campaigns. You can request exports at different levels (for example, campaign, ad group, target). Exports contain information about campaigns or ad groups at the time of the request. It is not possible to retrieve historical metadata via export.\n"," Since exports are asynchronous, there are three calls you need to make to generate an export:\n","Request an export 2. Wait for export to generate 3. Download the export\n"],"documentType":"guide"},{"title":"Get started with exports","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/exports/get-started","content":[" Each request described in this tutorial requires three header parameters: \n","| Parameter | Description |\n","\\|--------------------------\\|---------------\\|\n","| Amazon-Advertising-API-ClientId | The client ID associated with your Login with Amazon application. Used for authentication. |\n","| Authorization | Your access token. Used for authentication. |\n","| Amazon-Advertising-API-Scope | The profile ID associated with an advertising account in a specific marketplace. |\n"," For an introduction to API authentication, see Authorization overview.\n"],"documentType":"guide"},{"title":"Get started with exports","sectionHeader":{"type":2,"text":"Steps"},"path":"/en-us/guides/exports/get-started","content":[],"documentType":"guide"},{"title":"Get started with exports","sectionHeader":{"type":3,"text":"1. Requesting exports"},"path":"/en-us/guides/exports/get-started","content":[" First, define what type of export you need. \n","Choose a type for your export. Each type has its own path. The request body structure for each type is the same, but note that a different Accept / Content-Type header must be used depending on the type of export (campaign or ad group).\n","Add an adProductFilter. In the request body, you must specify at least one ad product for the export, for example \"adProductFilter\":\"SPONSORED_PRODUCTS\". \n","To request an export, call the desired POST endpoint (see step 1) with your assembled request body. \n","Successful calls result in a 202 response that includes an exportId and status of IN_PROGRESS. Take note of the exportId for use in the next step. \n"],"documentType":"guide"},{"title":"Get started with exports","sectionHeader":{"type":3,"text":"2. Checking export status"},"path":"/en-us/guides/exports/get-started","content":[" You can check the export generation status by using the exportId returned in the previous step to call the GET /exports/{exportId} endpoint.\n","| Endpoint |\n","\\|-----\\|\n","| GET /exports/{exportId}|\n"," Successful calls to the GET status endpoint return a 200 status code.\n"," To check if export generation has completed, check the status property in the response body. If the report is still generating, status is set to IN_PROGRESS.\n"," When your export is ready to download, the status returns as COMPLETED:\n"],"documentType":"guide"},{"title":"Get started with exports","sectionHeader":{"type":3,"text":"3. Downloading exports"},"path":"/en-us/guides/exports/get-started","content":[" Once your export is ready, you can download the export file directly from the url returned in the GET /exports/{exportId} call. \n"," Each call to GET /exports/{exportId} will generate a new download URL that is valid for only one hour. The urlExpiresAt property indicates the expiration time of the download URL. \n"," Calls to GET /exports/{exportId} will generate a new download URL for an export up to 24 hours after the successful completion of the export.\n"," The export downloads as JSON compressed in gzip format. \n"," To view sample JSON, see:\n","Campaigns - Ad groups - Targets - Ads\n"],"documentType":"guide"},{"title":"Get started with exports","sectionHeader":{"type":2,"text":"Using export metadata"},"path":"/en-us/guides/exports/get-started","content":[" Use exports in your application logic to improve the efficiency of other requests to the Amazon Ads API. For example, to generate reports most efficiently, we recommend excluding campaign metadata from report requests, then joining report results to export metadata using the unique IDs for entities depending on the entity.\n"],"documentType":"guide"},{"title":"Get started with exports","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/exports/get-started","content":[],"documentType":"guide"},{"title":"Exports entities overview","sectionHeader":null,"path":"/en-us/guides/exports/entities/overview","content":[],"documentType":"guide"},{"title":"Exports entities overview","sectionHeader":{"type":2,"text":"What are exports entities?"},"path":"/en-us/guides/exports/entities/overview","content":[" The model for Exports provides advertisers with a standard way to refer to common concepts across different ad products (Sponsored Products, Sponsored Brands, Sponsored Display).\n"," Exports has common models for:\n","Campaigns - Ad groups - Targets - Ads\n"," The API also supports common enums that are referenced within each model.\n"],"documentType":"guide"},{"title":"Exports entities overview","sectionHeader":{"type":2,"text":"Hierarchy"},"path":"/en-us/guides/exports/entities/overview","content":[" All Amazon ad products share a similar structure. An advertising account can have multiple campaigns. Each campaign can have multiple ad groups, and ad groups can contain many ads and targets. \n"],"documentType":"guide"},{"title":"Exports entities overview","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/exports/entities/overview","content":[],"documentType":"guide"},{"title":"Exports campaigns model overview","sectionHeader":null,"path":"/en-us/guides/exports/entities/campaigns","content":[" Campaigns are used to group ads that share a budget, objective, and optimization strategy. Campaigns can be one of a number of different ad products, including Sponsored Products, Sponsored Brands, Sponsored Display, and Amazon DSP.\n"],"documentType":"guide"},{"title":"Exports campaigns model overview","sectionHeader":{"type":2,"text":"Schema"},"path":"/en-us/guides/exports/entities/campaigns","content":[" Campaigns contains the following fields. Read-only indicates that the field is part of the model, but cannot be modified by advertisers. Required indicates that a field will always appear in the model. \n","| Common field | Type | Required | Read-only | Description |\n","\\|--- \\|--- \\|--- \\|--- \\|--- \\|\n","| campaignId | String | TRUE | TRUE | The unique numerical ID associated with a campaign. |\n","| adProduct | Enum |  |  | The ad product associated with the campaign. |\n","| portfolioId | String |  |  | Optional. Shows the portfolio ID associated with a campaign. |\n","| name | String | TRUE |  | The advertiser-specified name of the campaign. |\n","| startDate | String |  |  | The start date of the campaign. |\n","| endDate | String |  |  | The end date of the campaign. |\n","| lastUpdatedDateTime | String | TRUE | TRUE | The date and time that the campaign was last updated. |\n","| creationDateTime | String | TRUE | TRUE | The date and time that the campaign was created. |\n","| state | Enum | TRUE |  | The state of the campaign. |\n","| deliveryStatus | Enum | TRUE | TRUE | An overall status indicating whether the campaign is delivering or not. |\n","| deliveryReasons | Enum |  | TRUE | A list of reasons why the campaign is not delivering and the reasons behind the delivery status. |\n","| brandEntityId | String |  |  | The brand entity ID that the campaign is associated with. Required for sellers creating Sponsored Brands campaigns. |\n","| optimization.bidStrategy | Enum |  |  | The auto bidding strategy applied to the campaign. |\n","| optimization.placementBidAdjustments.placement | Enum |  |  | The selection of the placement associated with bid adjustment settings. |\n","| optimization.placementBidAdjustments.percentage | Integer |  |  | The selection of the percentage change associated with a given placement and bid adjustment settings. |\n","| optimization.shopperSegmentBidAdjustment.shopperSegment | Enum |  |  | The selection of the shopper segment associated with bid adjustment settings. |\n","| optimization.shopperSegmentBidAdjustment.percentage | Integer |  |  | The selection of the percentage change associated with a given shopper segment and bid adjustment settings. |\n","| optimization.shopperCohortBidAdjustment.shopperCohortType | Enum |  |  | The selection of the type associated with a shopper cohort. |\n","| optimization.shopperCohortBidAdjustment.percentage | Integer |  |  | The selection of the percentage change associated with a given shopper cohort bid. |\n","| optimization.shopperCohortBidAdjustment.audienceSegments.audienceId | String |  |  | The unique numerical ID associated with an audience segment. |\n","| optimization.shopperCohortBidAdjustment.audienceSegments.audienceSegmentType | Enum |  |  | The selection of the type associated with an audience segment. |\n","| budgetCaps.budgetType | Enum | TRUE |  | The type of budget. |\n","| budgetCaps.recurrenceTimePeriod | Enum | TRUE |  | The recurrence time period that the budget cap is associated with. |\n","| budgetCaps.budgetValue.monetaryBudget.currencyCode | Enum | TRUE |  | The currency associated with this monetary budget. |\n","| budgetCaps.budgetValue.monetaryBudget.amount | Decimal | TRUE |  | The monetary amount of the budget cap in the given currency. |\n","| budgetCaps.budgetValue.monetaryBudget.ruleAmount | Decimal |  | TRUE | The monetary amount of the budget when a budget rule is applied. |\n","| targetingSettings | Enum |  |  | The type of targeting supported by the campaign. |\n","| costType | Enum |  |  | The way the campaign bids and is charged. |\n","| tags.key | String |  |  | Open ended labels with a key value pair applied to the campaign. |\n","| tags.value | String |  |  | Open ended labels with a key value pair applied to the campaign. |\n"],"documentType":"guide"},{"title":"Exports campaigns model overview","sectionHeader":{"type":2,"text":"Ad product mapping"},"path":"/en-us/guides/exports/entities/campaigns","content":[" The mapping table shows how current versions of different ad products map to the common campaign model. Over time, we will move to standardize the fields in each individual API to the common campaign model.\n","| Ad product | Latest version |\n","\\|-----\\|-------\\|\n","| Sponsored Products | Version 3 |\n","| Sponsored Brands | Version 4 |\n","| Sponsored Display | Version 1 |\n","| Sponsored Television | Version 1 |\n"," For Amazon Marketing Stream, the table below references the campaigns dataset.\n"," Legend\n"," x: The ad product uses the common field name in its current version.\n"," N/A: The ad product contains the field in the common model schema, but not in its current version schema. \n"," Empty cell: The field is not represented for the ad product.\n","| Common field | Sponsored Products | Sponsored Brands | Sponsored Display | Amazon Marketing Stream | Sponsored TV |\n","\\|--- \\|--- \\|--- \\|--- \\|--- \\|-----\\|\n","| campaignId | x | x | x | x | x |\n","| adProduct | N/A | N/A | N/A | x | N/A |\n","| portfolioId | x | x | x | x |  |\n","| name | x | x | x | x | x |\n","| startDate | x | x | x | startDateTime | x |\n","| endDate | x | x | x | endDateTime | x |\n","| lastUpdatedDateTime | extendedData.lastUpdateDateTime | lastUpdatedDate | lastUpdatedDate | audit.lastUpdatedDateTime | extendedData.lastUpdateDate |\n","| creationDateTime | extendedData.creationDateTime | extended.creationDateTime | extended.creationDateTime | audit.creationDateTime | extendedData.creationDate |\n","| state | x | x | x | x | x |\n","| deliveryStatus | N/A | N/A | N/A |  | N/A |\n","| deliveryReasons | servingStatus | servingStatus | servingStatus |  |  |\n","| brandEntityId |  | x |  |  |  |\n","| optimization.bidStrategy | dynamicBidding.strategy | bidding.bidOptimizationStrategy |  | bidSetting.bidStrategy |  |\n","| optimization.placementBidAdjustments.placement | dynamicBidding.placementBidding.placement | bidding.bidAdjustmentsByPlacement.placement |  | bidSetting.placementBidAdjustment.placement |  |\n","| optimization.placementBidAdjustments.percentage | dynamicBidding.placementBidding.percentage | bidding.bidAdjustmentsByPlacement.percentage |  | bidSetting.placementBidAdjustment.percentage |  |\n","| optimization.shopperSegmentBidAdjustment.shopperSegment |  | bidding.bidAdjustmentsByShopperSegment.shopperSegment |  |  |  |\n","| optimization.shopperSegmentBidAdjustment.percentage |  | bidding.bidAdjustmentsByShopperSegment.percentage |  |  |  |\n","| budgetCaps.budgetType | N/A | N/A | N/A |  | N/A |\n","| budgetCaps.recurrenceTimePeriod | budgetType | budget.budgetType | budgetType | budget.budgetCap.recurrence.recurrenceType | budgetSettings.budget.recurrenceType |\n","| budgetCaps.budgetValue.monetaryBudget.currencyCode | N/A | N/A | N/A | budget.budgetCap.monetaryBudget.currencyCode | budgetSettings.budget.budgetValue.budgetCurrencyCode |\n","| budgetCaps.budgetValue.monetaryBudget.amount | budget.budget | budget | budget | budget.budgetCap.monetaryBudget.amount | budgetSettings.budget.budgetValue.amount |\n","| budgetCaps.budgetValue.monetaryBudget.ruleAmount | budget.effectiveBudget | ruleBasedBudget.value | ruleBasedBudget.value |  |  |\n","| targetingSettings | targetingType |  | tactic | x |  |\n","| costType |  | x | x |  |  |\n","| tags.key | x | x |  | x | x |\n","| tags.value | x | x |  | x | x |\n"],"documentType":"guide"},{"title":"Exports campaigns model overview","sectionHeader":{"type":2,"text":"Representations"},"path":"/en-us/guides/exports/entities/campaigns","content":[" The following table shows the different areas where campaigns are surfaced in the Amazon Ads API.\n","| Feature | Operations | User guides |\n","\\|------\\|------\\|---------\\|\n","| sp/campaigns | POST /sp/campaigns  POST /sp/campaigns/list  PUT /sp/campaigns  POST /sp/campaigns/delete | SP campaign model diagram  SP campaigns overview |\n","| sb/v4/campaigns | POST /sb/v4/campaigns  POST /sb/v4/campaigns/list  PUT /sb/v4/campaigns  POST /sb/v4/campaigns/delete | SB campaign model diagram  SB campaigns overview |\n","| sd/campaigns | POST /sd/campaigns  GET sd/campaigns  PUT /sd/campaigns  DELETE /sd/campaigns/{campaignId} | SD campaigns overview |\n","| Amazon Marketing Stream | N/A | Campaigns dataset |\n","| campaigns/exports | POST /campaigns/exports | Exports overview |\n","| st/campaigns | POST /st/campaigns  POST /st/campaigns/list  PUT /st/campaigns  POST /st/campaigns/delete |  |\n"],"documentType":"guide"},{"title":"Exports campaigns model overview","sectionHeader":{"type":2,"text":"JSON examples"},"path":"/en-us/guides/exports/entities/campaigns","content":[" Below you can find examples of how each ad product represents a campaign. \n"],"documentType":"guide"},{"title":"Exports campaigns model overview","sectionHeader":{"type":3,"text":"Generic"},"path":"/en-us/guides/exports/entities/campaigns","content":[" The generic sample includes a JSON representation of all possible fields in the common schema.\n"],"documentType":"guide"},{"title":"Exports campaigns model overview","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/guides/exports/entities/campaigns","content":[],"documentType":"guide"},{"title":"Exports campaigns model overview","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/guides/exports/entities/campaigns","content":[],"documentType":"guide"},{"title":"Exports campaigns model overview","sectionHeader":{"type":3,"text":"Sponsored Display"},"path":"/en-us/guides/exports/entities/campaigns","content":[],"documentType":"guide"},{"title":"Exports ad groups model overview","sectionHeader":null,"path":"/en-us/guides/exports/entities/ad-groups","content":[" Ad groups are used to group ads that have common targeting, strategy, and creatives.\n"],"documentType":"guide"},{"title":"Exports ad groups model overview","sectionHeader":{"type":2,"text":"Schema"},"path":"/en-us/guides/exports/entities/ad-groups","content":[" Ad groups contain the following fields. Read-only indicates that the field is part of the model, but cannot be modified by advertisers. Required indicates that a field will always appear as part of model. \n","| Field | Description | Type | Required | Read only |\n","\\|--- \\|--- \\|--- \\|--- \\|--- \\|\n","| adGroupId | The unique identifier of the ad group. | String | TRUE | TRUE |\n","| campaignId | The unique identifier of the campaign the ad group belongs to. | String | TRUE |  |\n","| adProduct | The ad product that the ad group belongs to. | Enum | TRUE |  |\n","| name | The name of the ad group. | String | TRUE |  |\n","| state | The user-set state of the ad group. | Enum | TRUE |  |\n","| deliveryStatus | An overall status indicating whether the ad group is delivering or not. | Enum | TRUE | TRUE |\n","| deliveryReasons | A list of reasons why the ad group is not delivering and the reasons behind the delivery status. | Enum |  | TRUE |\n","| creativeType | The creative type that this ad group contains. | String |  |  |\n","| creationDateTime | The date and time that the ad group was created. | datetime | TRUE | TRUE |\n","| lastUpdatedDateTime | The date and time that the ad group was last updated. | datetime | TRUE | TRUE |\n","| bid.defaultBid | The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction. | double | TRUE |  |\n","| bid.currencyCode | The currency code the bid is expressed in. | Enum | TRUE |  |\n","| optimization.goalSetting.goal | The type of goal associated with the ad group. | Enum |  |  |\n","| optimization.goalSetting.kpi | The way the goal associated with the ad group is measured. | Enum |  |  |\n"],"documentType":"guide"},{"title":"Exports ad groups model overview","sectionHeader":{"type":2,"text":"Ad product mapping"},"path":"/en-us/guides/exports/entities/ad-groups","content":[" The mapping table shows how current versions of different ad products map to the common ad group model. Over time, we will move to standardize the fields in each individual API to the common ad group model.\n","| Ad product | Latest version |\n","\\|-----\\|-------\\|\n","| Sponsored Products | Version 3 |\n","| Sponsored Brands | Version 4 |\n","| Sponsored Display | Version 1 |\n","| Sponsored Television | Version 1 |\n"," For Amazon Marketing Stream, the table below references the ad groups dataset.\n"," Legend\n"," x: The ad product uses the common field name in its current version.\n"," N/A: The ad product contains the field in the common model schema, but not in its current version schema. \n"," Empty cell: The field is not represented for the ad product.\n","| Common field | Sponsored Products | Sponsored Brands | Sponsored Display | Amazon Marketing Stream | Sponsored TV |\n","\\|--- \\|--- \\|--- \\|--- \\|----\\|---- \\|\n","| adGroupId | x | x | x | x | x |\n","| campaignId | x | x | x | x | x |\n","| adProduct | N/A | N/A | N/A | x | N/A |\n","| name | x | x | x | x | x |\n","| state | x | x | x | x | x |\n","| deliveryStatus | N/A | N/A | servingStatus |  | N/A |\n","| deliveryReasons | extendedData.servingStatus | extendedData.servingStatus | N/A |  |  |\n","| creativeType |  |  | x |  |  |\n","| creationDateTime | extendedData.creationDateTime | extendedData.creationDate | creationDate | audit.creationDateTime | extendedData.creationDate |\n","| lastUpdatedDateTime | extendedData.lastUpdateDateTime | extendedData.lastUpdateDate | lastUpdateDate | audit.lastUpdatedDateTime | extendedData.lastUpdateDate |\n","| bid.defaultBid | defaultBid |  | defaultBid | bidValue.defaultBid.value | defaultBid.bid |\n","| bid.currencyCode | N/A |  | N/A | bidValue.defaultBid.currencyCode |  |\n","| optimization.goalSettings.goal |  |  | bidOptimization |  |  |\n","| optimization.goalSettings.Kpi |  |  | derived from bidOptimization |  |  |\n"],"documentType":"guide"},{"title":"Exports ad groups model overview","sectionHeader":{"type":2,"text":"Representations"},"path":"/en-us/guides/exports/entities/ad-groups","content":[" The following table shows the different areas where ad groups are surfaced in the Amazon Ads API.\n","| Feature | Operations | User guides |\n","\\|------\\|------\\|---------\\|\n","| sp/adGroups | POST /sp/adGroups  POST /sp/adGroups/list  PUT /sp/adGroups  POST /sp/adGroups/delete | SP campaign model diagram  SP ad groups overview |\n","| sb/v4/adGroups | POST /sb/v4/adGroups  POST /sb/v4/adGroups/list  PUT /sb/v4/adGroups  POST /sb/v4/adGroups/delete | SB campaign model diagram |\n","| sd/adGroups | POST /sd/adGroups  GET sd/adGroups  PUT /sd/adGroups  DELETE /sd/adGroups/{adGroupId} | SD campaigns overview |\n","| Amazon Marketing Stream | N/A | Ad groups dataset |\n","| adGroups/exports | POST /adGroups/exports | Exports overview |\n","| st/adGroups | POST /st/adGroups  POST /st/adGroups/list  PUT /st/adGroups  POST /st/adGroups/delete |  |\n"],"documentType":"guide"},{"title":"Exports ad groups model overview","sectionHeader":{"type":2,"text":"JSON examples"},"path":"/en-us/guides/exports/entities/ad-groups","content":[" Below you can find examples of how each ad product represents an ad group. \n"],"documentType":"guide"},{"title":"Exports ad groups model overview","sectionHeader":{"type":3,"text":"Generic"},"path":"/en-us/guides/exports/entities/ad-groups","content":[" The generic sample includes a JSON representation of all possible fields in the common schema.\n"],"documentType":"guide"},{"title":"Exports ad groups model overview","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/guides/exports/entities/ad-groups","content":[],"documentType":"guide"},{"title":"Exports ad groups model overview","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/guides/exports/entities/ad-groups","content":[],"documentType":"guide"},{"title":"Exports ad groups model overview","sectionHeader":{"type":3,"text":"Sponsored Display"},"path":"/en-us/guides/exports/entities/ad-groups","content":[],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":null,"path":"/en-us/guides/exports/entities/ads","content":[" An ad is the smallest unit of an advertising campaign. An ad represents the creative and advertised products that a customer sees and interacts with. In the Amazon Ads API, the common ad model represents ads, product ads, and ad creatives found across sponsored ads campaigns. \n"],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":2,"text":"Ad types"},"path":"/en-us/guides/exports/entities/ads","content":[" Amazon Ads supports a variety of ad types depending on the ad product. \n","| Ad type | Description | Sponsored Products | Sponsored Brands | Sponsored Display |\n","\\|------\\|-----\\|------\\|------\\|--\\|----\\|----\\|\n","| PRODUCT_AD | Product ads are built based on the advertised product and an optional headline. | x |  | x |\n","| IMAGE | Features one or more custom images. |  |  | x |\n","| VIDEO | Features one or more videos. For Sponsored Brands, includes both video and brand video ad types. |  | x | x |\n","| PRODUCT_COLLECTION | Features a collection of products along with a custom image. |  | x |  |\n","| STORE_SPOTLIGHT | Features an Amazon Store and chosen sub-pages. |  | x |  |\n"],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":2,"text":"Schema"},"path":"/en-us/guides/exports/entities/ads","content":[" Ads contain the following fields. Read-only indicates that the field is part of the model, but cannot be modified by advertisers. Required indicates that a field will always appear as part of model. \n","| Common field | Type | Required | Read-only | Description                                                                                                                                                |\n","\\|--- \\|--- \\|--- \\|--- \\|---\\|\n","| adId | string | Required | Read Only | The unique identifier of the ad.                                                                                                                           |\n","| adGroupId | string | Required |  | The unique identifier of the ad group.                                                                                                                     |\n","| adProduct | Enum | Required |  | The ad product associated to the ad.                                                                                                                       |\n","| state | Enum | Required |  | The user-set state of the ad.                                                                                                                              |\n","| name | string |  |  | The user-set name of the ad.                                                                                                                               |\n","| creationDateTime | datetime | Required | Read Only | The date and time that the ad was created.                                                                                                                 |\n","| lastUpdatedDateTime | datetime | Required | Read Only | The date and time that the ad was last updated.                                                                                                            |\n","| deliveryStatus | Enum | Required | Read Only | The overall status indicating whether the ad is delivering or not.                                                                                         |\n","| deliveryReasons | Enum |  | Read Only | A list of reasons why the ad is not delivering.                                                                                                            |\n","| adVersionId | string |  | Read Only | The version associated with the ad.                                                                                                                        |\n","| adType | Enum | Required |  | The type of the ad.                                                                                                                                        |\n","| creative | obj | Required |  | An object containing creative and landing page details.                                                                                                    |\n","| creative.products | array |  |  | The products or subject to be featured as part of the ad.                                                                                                  |\n","| creative.products.productIdType | Enum |  |  | The type of product ID.                                                                                                                                    |\n","| creative.products.productId | string |  |  | The ID associated with the product.                                                                                                                        |\n","| creative.brandLogo | obj |  |  | The brand logo asset shown on the ad.                                                                                                                      |\n","| creative.brandLogo.assetId | string |  |  | The asset library ID associated with the brand logo image asset.                                                                                           |\n","| creative.brandLogo.assetVersion | string |  |  | The version of the brand logo asset.                                                                                                                       |\n","| creative.brandLogo.formatProperties | obj |  |  | Allows you to crop the brand logo asset.                                                                                                                   |\n","| creative.brandLogo.formatProperties.top | integer |  |  | Desired coordinates for the top of the cropped image.                                                                                                      |\n","| creative.brandLogo.formatProperties.left | integer |  |  | Desired coordinates for the left of the cropped image.                                                                                                     |\n","| creative.brandLogo.formatProperties.width | integer |  |  | The desired width of the cropped image.                                                                                                                    |\n","| creative.brandLogo.formatProperties.height | integer |  |  | The desired height of the cropped image.                                                                                                                   |\n","| creative.customImages | array |  |  | Allows you to specify custom images to be used in the creative.                                                                                            |\n","| creative.customImages.assetId | string |  |  | The asset library ID associated with the custom image asset.                                                                                               |\n","| creative.customImages.assetVersion | string |  |  | The version of the custom image asset.                                                                                                                     |\n","| creative.customImages.formatProperties | obj |  |  | Allows you to crop the custom image asset.                                                                                                                 |\n","| creative.customImages.formatProperties.top | integer |  |  | Desired coordinates for the top of the cropped image.                                                                                                      |\n","| creative.customImages.formatProperties.left | integer |  |  | Desired coordinates for the left of the cropped image.                                                                                                     |\n","| creative.customImages.formatProperties.width | integer |  |  | The desired width of the cropped image.                                                                                                                    |\n","| creative.customImages.formatProperties.height | integer |  |  | The desired height of the cropped image.                                                                                                                   |\n","| creative.videos | array |  |  | Videos associated with the creative.                                                                                                                       |\n","| creative.videos.assetId | string |  |  | The asset library ID associated with the video asset.                                                                                                      |\n","| creative.videos.assetVersion | string |  |  | The version of the video asset.                                                                                                                            |\n","| creative.headline | string |  |  | The headline or custom text associated with the ad.                                                                                                        |\n","| creative.brandName | string |  |  | The brand name displayed in the ad.                                                                                                                        |\n","| creative.landingPage | obj |  |  | The details of the landing page for the ad.                                                                                                                |\n","| creative.landingPage.landingPageType | Enum |  |  | The type of landing page associated with the ad.                                                                                                           |\n","| creative.landingPage.landingPageUrl | string |  |  | The URL of the landing page.                                                                                                                               |\n","| creative.cards | array |  |  | Defines sections of the ad that have a different group of creative elements (assets, headlines, CTAs) and landing page specific to that portion of the ad. |\n","| creative.cards.headline | string |  |  | The headline associated to the card.                                                                                                                       |\n","| creative.cards.landingPage | obj |  |  | The landing page associated to the card.                                                                                                                   |\n","| creative.cards.landingPage.landingPageType | Enum |  |  | The type of landing page associated to the card.                                                                                                           |\n","| creative.cards.landingPage.landingPageUrl | string |  |  | The URL of the landing page associated to the card.                                                                                                        |\n","| creative.cards.product | obj |  |  | The product associated with the card.                                                                                                                      |\n","| creative.cards.products.productIdType | Enum |  |  | The type of identifier for the product associated with the card.                                                                                           |\n","| creative.cards.products.productId | string |  |  | The identifier of the product associated with the card.                                                                                                    |\n"],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":2,"text":"Ad product mapping"},"path":"/en-us/guides/exports/entities/ads","content":[" The mapping table shows how current versions of different ad products map to the common ad group model. Over time, we will move to standardize the fields in each individual API to the common ad group model.\n","| Ad product | Latest version |\n","\\|-----\\|-------\\|\n","| Sponsored Products | Version 3 |\n","| Sponsored Brands | Version 4 |\n","| Sponsored Display | Version 1 |\n","| Sponsored TV | Version 1|\n"," For Amazon Marketing Stream, the table below references the ads dataset.\n"," Legend\n"," x: The ad product uses the common field name in its current version.\n"," N/A: The ad product contains the field in the common model schema, but not in its current version schema. \n"," Empty cell: The field is not represented for the ad product.\n","| Common field | Sponsored Products | Sponsored Brands | Sponsored Display | Amazon Marketing Stream |\n","\\|--- \\|--- \\|--- \\|--- \\|--- \\|\n","| adId | x | x | x | x |\n","| adGroupId | x | x | x | x |\n","| adProduct | SPONSORED_PRODUCTS | SPONSORED_BRANDS | SPONSORED_DISPLAY | x |\n","| state | x | x | x | x |\n","| name |  | x | adName | x |\n","| creationDateTime | x | creationDate | creationDate | audit.creationDateTime |\n","| lastUpdatedDateTime | x | lastUpdatedDate | lastUpdatedDate | audit.lastUpdatedDateTime |\n","| deliveryStatus | servingStatus mapped to DELIVERING or NOT_DELIVERING | servingStatus mapped to DELIVERING or NOT_DELIVERING | servingStatus mapped to DELIVERING or NOT_DELIVERING |  |\n","| deliveryReasons | servingStatus | servingStatus | servingStatus |  |\n","| adVersionId |  | creativeVersion (property of SB creative) |  |  |\n","| adType | PRODUCT_AD | creative.type | creativeType or PRODUCT_AD |  |\n","| creative.products.productIdType | ASIN or SKU | ASIN | ASIN or SKU |  |\n","| creative.products.productId | asin / sku | creative.asins | asin / sku | asin / sku |\n","| creative.brandLogo |  |  | properties.brandLogo (property of SD creative) |  |\n","| creative.brandLogo.assetId |  | creative.brandLogoAssetId | properties.brandLogo.assetId (property of SD creative) |  |\n","| creative.brandLogo.assetVersion |  | creative.brandLogoAssetId (appended) | properties.brandLogo.assetVersion (property of SD creative) |  |\n","| creative.brandLogo.formatProperties |  | brandLogoCrop | properties.brandLogo.croppingCoordinates (property of SD creative) |  |\n","| creative.brandLogo.formatProperties.top |  | brandLogoCrop.top | properties.brandLogo.croppingCoordinates.top (property of SD creative) |  |\n","| creative.brandLogo.formatProperties.left |  | brandLogoCrop.left | properties.brandLogo.croppingCoordinates.left (property of SD creative) |  |\n","| creative.brandLogo.formatProperties.width |  | brandLogoCrop.width | properties.brandLogo.croppingCoordinates.width (property of SD creative) |  |\n","| creative.brandLogo.formatProperties.height |  | brandLogoCrop.height | properties.brandLogo.croppingCoordinates.height (property of SD creative) |  |\n","| creative.customImages.assetId |  | creative.customImageAssetId | creativeElements.squareImages.assetId creativeElements.horizontalImages.assetId creativeElements.verticalImages.assetId (property of SD creative) |  |\n","| creative.customImages.assetVersion |  | creative.customImageAssetId (version appended) | creativeElements.squareImages.assetVersion creativeElements.horizontalImages.assetVersion creativeElements.verticalImages.assetVersion (property of SD creative) |  |\n","| creative.customImages.formatProperties |  | customImageCrop | creativeElements.squareImages.croppingCoordinates creativeElements.horizontalImages.croppingCoordinates creativeElements.verticalImages.croppingCoordinates (property of SD creative) |  |\n","| creative.customImages.formatProperties.top |  | customImageCrop.top | creativeElements.squareImages.croppingCoordinates.top creativeElements.horizontalImages.croppingCoordinates.top creativeElements.verticalImages.croppingCoordinates.top (property of SD creative) |  |\n","| creative.customImages.formatProperties.left |  | customImageCrop.left | creativeElements.squareImages.croppingCoordinates.left creativeElements.horizontalImages.croppingCoordinates.left creativeElements.verticalImages.croppingCoordinates.left (property of SD creative) |  |\n","| creative.customImages.formatProperties.width |  | customImageCrop.width | creativeElements.squareImages.croppingCoordinates.width creativeElements.horizontalImages.croppingCoordinates.width creativeElements.verticalImages.croppingCoordinates.width (property of SD creative) |  |\n","| creative.customImages.formatProperties.height |  | customImageCrop.height | creativeElements.squareImages.croppingCoordinates.height creativeElements.horizontalImages.croppingCoordinates.height creativeElements.verticalImages.croppingCoordinates.height (property of SD creative) |  |\n","| creative.videos.assetId |  | creative.videoAssetId | properties.video.assetId |  |\n","| creative.videos.assetVersion |  | creative.videoAssetId (version appended) | properties.video.assetVersion |  |\n","| creative.headline |  | creative.headline | properties.headline | customText (SP only) |\n","| creative.brandName |  | creative.brandName |  |  |\n","| creative.landingPage |  | landingPage |  |  |\n","| creative.landingPage.landingPageType |  | landingPage.pageType | landingPageType | landingPage.type |\n","| creative.landingPage.landingPageUrl |  | landingPage.url | landingPageUrl | landingPage.url |\n","| creative.cards |  | creative.subpages |  |  |\n","| creative.cards.headline |  | creative.subpages.pageTitle |  |  |\n","| creative.cards.landingPage.landingPageType |  | STORE |  |  |\n","| creative.cards.landingPage.landingPageUrl |  | creative.subpages.url |  |  |\n","| creative.cards.product |  |  |  |  |\n","| creative.cards.products.productIdType |  | ASIN |  |  |\n","| creative.cards.products.productId |  | creative.subpages.asin |  |  |\n"],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":2,"text":"Representations"},"path":"/en-us/guides/exports/entities/ads","content":[" The following table shows the different areas where ads are surfaced in the Amazon Ads API.\n","| Resource | User guides |\n","\\|------\\|------\\|\n","| sp/productAds | SP campaign model diagram  SP product ads overview |\n","| sb/v4/ads | SB campaign model diagram |\n","| sb/adCreatives | SB campaign model diagram |\n","| sd/productAds | SD campaigns overview |\n","| sd/creatives | Creatives guide |\n","| st/ads | ST guide |\n","| st/creatives | ST guide |\n","| Amazon Marketing Stream | Ads dataset |\n","| ads/exports | Exports overview |\n"," Below you can find examples of how each ad product represents an ad.\n"],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":3,"text":"Generic"},"path":"/en-us/guides/exports/entities/ads","content":[" The generic sample includes a JSON representation of all possible fields in the common schema.\n"],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":3,"text":"Sponsored Products generic"},"path":"/en-us/guides/exports/entities/ads","content":[],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":3,"text":"Sponsored Brands generic"},"path":"/en-us/guides/exports/entities/ads","content":[],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":3,"text":"Sponsored Display generic"},"path":"/en-us/guides/exports/entities/ads","content":[],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":3,"text":"Product ad"},"path":"/en-us/guides/exports/entities/ads","content":[],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":3,"text":"Image"},"path":"/en-us/guides/exports/entities/ads","content":[],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":3,"text":"Video"},"path":"/en-us/guides/exports/entities/ads","content":[],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":3,"text":"Product collection"},"path":"/en-us/guides/exports/entities/ads","content":[],"documentType":"guide"},{"title":"Exports ads model overview","sectionHeader":{"type":3,"text":"Store spotlight"},"path":"/en-us/guides/exports/entities/ads","content":[],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":null,"path":"/en-us/guides/exports/entities/targets","content":[" Targets allow advertisers to influence when ads will or will not appear, as well as specify how much to bid for an ad when these conditions are met. Targeting conditions can be “inclusions” (negative = false) or “exclusions” (negative = true, also known as negative targets). \n"],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":2,"text":"Targeting types"},"path":"/en-us/guides/exports/entities/targets","content":[" Amazon Ads supports a variety of targeting types depending on the ad product. Some targeting types also have the option to support negative targeting (exclusions). Targets are typically applied at the ad group level, however some types of negative targets are also available at the campaign level. \n","| Targeting type | Supports negative | Supports campaign-level | Description | Sponsored Products | Sponsored Brands | Sponsored Display |\n","\\|------\\|-----\\|------\\|------\\|--\\|----\\|----\\|\n","| AUTO | No | No | Targets chosen by Amazon based on a high-level match type or criteria. | x | x | x |\n","| AUDIENCE | No |  No |Targets based on a selected chosen Amazon audience. |  | | x |\n","| KEYWORD | Yes | Yes; negative Sponsored Products targets only | Targets based on customer search terms. | x | x | |\n","| PRODUCT_CATEGORY | Yes | Yes; negative Sponsored Products targets only | Targets based on a specified Amazon product category with optional refinements like brand, price, and rating. | x | x | x |\n","| PRODUCT | Yes | Yes; negative Sponsored Products targets only | Targets based on a specified Amazon product ASIN. | x | x | x |\n","| PRODUCT_CATEGORY_AUDIENCE | No | No | Targets based on customer views or purchases on an Amazon product category (with optional refinements), within a specified lookback window. | | | x |\n","| PRODUCT_AUDIENCE | No | No | Targets based on customer views or purchases on an Amazon product ASIN, within a specified lookback window. | | | x |\n","| THEME | No | No | Targets keywords related to a theme. | x | | |\n"],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":2,"text":"Schema"},"path":"/en-us/guides/exports/entities/targets","content":[" Targets contains the following fields. Read-only indicates that the field is part of the model, but cannot be modified by advertisers. Required indicates that a field will always appear in the model. \n","|Common field\t| Type\t                                                    |Required\t|Read only\t|Description\t|\n","\\|-----\\|----------------------------------------------------------\\|-----\\|-----\\|-----\\|\n","|targetId\t| string\t                                                  |Required\t|Read Only\t|The unique identifier of the target.\t|\n","|adGroupId\t| string\t                                                  |\t|\t|The unique identifier of the ad group that the target belongs to.\t|\n","|campaignId | string                                                   | | | The campaignId associated with the target (for campaign-level targets only).|\n","|adProduct\t| Enum\t      |Required\t|\t|The ad product that the target belongs to.\t|\n","|state\t| Enum\t          |Required\t|\t|The user set state of the target.\t|\n","|negative\t| boolean\t                                                 |Required\t|\t|Whether to target (false) or exclude (true) the given target.\t|\n","|deliveryStatus\t| Enum\t |Required\t|Read Only\t|This is an overall status if the target is delivering or not.\t|\n","|deliveryReasons\t| Enum |\t|Read Only\t|This is a list of reasons why the target is not delivering and the reasons behind the delivery status.\t|\n","|creationDateTime\t| datetime\t                                                |Required\t|Read Only\t|The date time that the target was created.\t|\n","|lastUpdatedDateTime\t| datetime\t                                                |Required\t|Read Only\t|The date time that the target was last updated.\t|\n","|bid.bid\t| double\t                                                  |\t|\t|The bid applied to the target.\t|\n","|bid.currencyCode\t| Enum\t   |\t|\t|The currency code of the bid applied to the target.\t|\n","|targetType\t| Enum\t     |Required\t|\t|The type of target.\t|\n","|targetDetails.matchType\t| Enum\t      |\t|\t|The match type associated with the target. Differs based on the targetType. \t|\n","|targetDetails.keyword\t| string\t                                                  |\t|\t|The keyword text to target.\t|\n","|targetDetails.nativeLanguageKeyword\t| string\t                                                  |\t|\t|The unlocalized keyword text in the preferred locale of the advertiser.\t|\n","|targetDetails.nativeLanguageLocale\t| string\t                                                  |\t|\t|The locale preference of the advertiser. For example, if the advertiser’s preferred language is Simplified Chinese, set the locale to zh_CN. Supported locales include: Simplified Chinese (locale: zh_CN) for US, UK and CA. English (locale: en_GB) for DE, FR, IT and ES.\t|\n","|targetDetails.productCategoryId\t| string\t                                                  |\t|\t|The product category to target.\t|\n","|targetDetails.productCategoryResolved\t| string\t                                                  |\t|Read Only\t|The resolved human readable name of the category.\t|\n","|targetDetails.productBrand\t| string\t                                                  |\t|\t|Refinement to target a specific brand within the product category.\t|\n","|targetDetails.productBrandResolved\t| string\t                                                  |\t|Read Only\t|The resolved human readable name of the brand.\t|\n","|targetDetails.productGenre\t| string\t                                                  |\t|\t|Refinement to target a specific product genre within the product category.\t|\n","|targetDetails.productPriceLessThan\t| string\t                                                  |\t|\t|Refinement to target products with a price less than the value within the product category.\t|\n","|targetDetails.productPriceGreaterThan\t| string\t                                                  |\t|\t|Refinement to target products with a price greater than the value within the product category.\t|\n","|targetDetails.productRatingLessThan\t| string\t                                                  |\t|\t|Refinement to target products with a rating less than the value within the product category.\t|\n","|targetDetails.productRatingGreaterThan\t| string\t                                                  |\t|\t|Refinement to target products with a rating greater than the value within the product category.\t|\n","|targetDetails.productAgeRange\t| string\t                                                  |\t|\t|Refinement to target products for a specific age range (given as an ID) within the product category.\t|\n","|targetDetails.productAgeRangeResolved\t| string\t                                                  |\t|\t| The resolved product age range to target.\t|\n","|targetDetails.productPrimeShippingEligible\t| boolean\t                                                 |\t|\t|Refinement to target products that are prime shipping eligible within the product category.\t|\n","|targetDetails.asin\t| string\t                                                  |\t|\t|The product ASIN to target.\t|\n","|targetDetails.event\t| Enum\t          |\t|\t|The product based event to target the audience.\t|\n","|targetDetails.lookback\t| integer\t                                                 |\t|\t|The lookback period in days to target the audience for the specified product event.\t|\n","|targetDetails.audienceId\t| string\t                                                  |\t|\t| An audience identifier retrieved from the audiences/list resource.\t|\n"],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":2,"text":"Ad product mapping"},"path":"/en-us/guides/exports/entities/targets","content":[" The mapping table shows how current versions of different ad products map to the common target model. Over time, we will move to standardize the fields in each individual API to the common target model.\n","| Ad product | Latest version |\n","\\|-----\\|-------\\|\n","| Sponsored Products | Version 3 |\n","| Sponsored Brands | Version 3 |\n","| Sponsored Display | Version 1 |\n"," For Amazon Marketing Stream, the table below references the targets dataset.\n"," Legend\n"," x: The ad product uses the common field name in its current version.\n"," N/A:  The ad product contains the field in the common model schema, but not in its current version schema. \n"," Empty cell: The field is not represented for the ad product.\n","|Common field\t|Sponsored Products\t|Sponsored Brands\t|Sponsored Display\t|Amazon Marketing Stream\t|\n","\\|----\\|------\\|------\\|------\\|-----\\|\n","|targetId\t|keywordId, targetId, negativeKeywordId\t|keywordId, targetId\t|x\t|x\t|\n","|adGroupId\t|x\t|x\t|x\t|x\t|\n","|campaignId\t|x\t|\t|\t|x\t|\n","|adProduct\t|N/A\t|N/A\t|N/A\t|x\t|\n","|state\t|x\t|x\t|x\t|x\t|\n","|negative\t|N/A\t|N/A\t|N/A\t|x\t|\n","|deliveryStatus\t|N/A\t|N/A\t|N/A\t|\t|\n","|deliveryReasons\t|extendedData.servingStatus\t|N/A\t|N/A\t|\t|\n","|creationDateTime\t|extendedData.creationDateTime\t|N/A\t|creationDate\t|audit.creationDateTime\t|\n","|lastUpdatedDateTime\t|extendedData.lastUpdateDateTime\t|N/A\t|lastUpdateDate\t|audit.lastUpdatedDateTime\t|\n","|bid.bid\t|bid\t|bid\t|bid\t|bid\t|\n","|bid.currencyCode\t|N/A\t|N/A\t|N/A\t|currencyCode\t|\n","|targetType\t|N/A\t|N/A\t|N/A\t|x\t|\n","|targetDetails.matchType\t|expression.type (target), matchType (keyword)\t|expression.type (target), matchType (keyword), themes.themeType (theme)\t|expression.type\t|{targetType}.matchType\t|\n","|targetDetails.keyword\t|keywordText\t|keywordText\t|\t|keywordTarget.keyword\t|\n","|targetDetails.nativeLanguageKeyword\t|nativeLanguageKeyword\t|nativeLanguageKeyword\t|\t|keywordTarget. nativeLanguageKeyword\t|\n","|targetDetails.nativeLanguageLocale\t|nativeLanguageLocale\t|N/A\t|\t|keywordTarget.nativeLanguageLocale\t|\n","|targetDetails.productCategoryId\t|expression.value where \"type\": \"ASIN_CATEGORY_SAME_AS\"\t|expressions.value where \"type\": \"asinCategorySameAs\"\t|expression.value where \"type\": \"asinCategorySameAs\"\t|{targetType}.targetingClause\t|\n","|targetDetails.productCategoryResolved\t|resolvedExpression.value where \"type\": \"ASIN_CATEGORY_SAME_AS\"\t|resolvedExpressions.value where \"type\": \"asinCategorySameAs\"\t|resolvedExpression.value where \"type\": \"asinCategorySameAs\"\t|{targetType}.targetingClause\t|\n","|targetDetails.productBrand\t|expression.value where \"type\": \"ASIN_BRAND_SAME_AS\"\t|expressions.value where \"type\":\"asinBrandSameAs\"\t|expression.value where \"type\":\"asinBrandSameAs\"\t|{targetType}.targetingClause\t|\n","|targetDetails.productBrandResolved\t|resolvedExpression.value where \"type\": \"ASIN_BRAND_SAME_AS\"\t|resolvedExpressions. value where \"type\":\"asinBrandSameAs\"\t|resolvedExpression.value where \"type\":\"asinBrandSameAs\"\t|{targetType}.targetingClause\t|\n","|targetDetails.productGenre\t|expression.value where \"type\": \"ASIN_GENRE_SAME_AS\"\t|\t|expression.value where \"type\":\"asinGenreSameAs\"\t|{targetType}.targetingClause\t|\n","|targetDetails.productGenreResolved\t|resolvedExpression.value where \"type\": \"ASIN_GENRE_SAME_AS\"\t|\t|resolvedExpression.value where \"type\":\"asinGenreSameAs\"\t|{targetType}.targetingClause\t|\n","|targetDetails.productPriceLessThan\t|expression.value where \"type\": \"ASIN_PRICE_LESS_THAN\" or \"type\": \"ASIN_PRICE_BETWEEN\" (bottom of range)\t|expressions.value where \"type\":\"asinPriceLessThan\" or \"type\": \"asinPriceBetween\" (bottom of range)\t|expression.value where \"type\":\"asinPriceLessThan\" or \"type\": \"asinPriceBetween\" (bottom of range)\t|{targetType}.targetingClause\t|\n","|targetDetails.productPriceGreaterThan\t|expression.value where \"type\": \"ASIN_PRICE_GREATER_THAN\" or \"type\": \"ASIN_PRICE_BETWEEN\" (top of range)\t|expressions.value where \"type\":\"asinPriceGreaterThan\" or \"type\": \"asinPriceBetween\" (top of range)\t|expression.value where \"type\":\"asinPriceGreaterThan\" or \"type\": \"asinPriceBetween\" (top of range)\t|{targetType}.targetingClause\t|\n","|targetDetails.productRatingLessThan\t|expression.value where \"type\": \"ASIN_REVIEW_RATING_LESS_THAN\" or \"type\": \"ASIN_REVIEW_RATING_BETWEEN\" (bottom of range)\t|expressions.value where \"type\":\"asinReviewRatingLessThan\" or \"type\": \"asinReviewRatingBetween\" (bottom of range)\t|expression.value where \"type\":\"asinReviewRatingLessThan\" or \"type\": \"asinReviewRatingBetween\" (bottom of range)\t|{targetType}.targetingClause\t|\n","|targetDetails.productRatingGreaterThan\t|expression.value where \"type\": \"ASIN_REVIEW_RATING_GREATER_THAN\" or \"type\": \"ASIN_REVIEW_RATING_BETWEEN\" (top of range)\t|expressions.value where \"type\":\"asinReviewRatingGreaterThan\" or \"type\": \"asinReviewRatingBetween\" (top of range)\t|expression.value where \"type\":\"asinReviewRatingGreaterThan\" or \"type\": \"asinReviewRatingBetween\" (top of range)\t|{targetType}.targetingClause\t|\n","|targetDetails.productAgeRange\t|expression.value where \"type\": \"ASIN_AGE_RANGE_SAME_AS\"\t|\t|expression.value where \"type\": \"asinAgeRangeSameAs\"\t|{targetType}.targetingClause\t|\n","|targetDetails.productAgeRangeResolved\t|resolvedExpression.value where \"type\": \"ASIN_AGE_RANGE_SAME_AS\"\t|\t|resolvedExpression.value where \"type\": \"asinAgeRangeSameAs\"\t|{targetType}.targetingClause\t|\n","|targetDetails.productPrimeShippingEligible\t|expression.value where \"type\": \"ASIN_IS_PRIME_SHIPPING_ELIGIBLE\"\t|\t|expression.value where \"type\": \"asinIsPrimeShippingEligible\"\t|{targetType}.targetingClause\t|\n","|targetDetails.asin\t|expression.value where \"type\": \"ASIN_EXPANDED_FROM\" or \"type:\" \"ASIN_SAME_AS\"\t|expression.value where \"type:\"asinSameAs\"\t|expression.value where \"type:\"asinSameAs\"\t|{targetType}.targetingClause\t|\n","|targetDetails.event\t|\t|\t|expression.type\t|{targetType}.targetingClause\t|\n","|targetDetails.lookback\t|\t|\t|expression.value.value where \"expression.value.type\": \"views\" or \"expression.value.type\": \"purchases\"\t|{targetType}.targetingClause\t|\n","|targetDetails.audienceId\t|\t|\t|expression.value.type.value where \"expression.value.type\": \"audienceSameAs\"\t|{targetType}.targetingClause\t|\n"],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":2,"text":"Representations"},"path":"/en-us/guides/exports/entities/targets","content":[" The following table shows the different areas where targets are surfaced in the Amazon Ads API.\n","| Feature | Operations | User guides |\n","\\|------\\|------\\|---------\\|\n","| sp/targets | POST /sp/targets  POST /sp/targets/list  PUT /sp/targets  POST /sp/targets/delete | SP targeting overview |\n","| sp/negativeTargets sp/campaignNegativeTargets | POST /sp/negativeTargets  POST /sp/negativeTargets/list  PUT /sp/negativeTargets  POST /sp/negativeTargets/delete  POST /sp/campaignNegativeTargets  POST /sp/campaignNegativeTargets/list  PUT /sp/campaignNegativeTargets  POST /sp/campaignNegativeTargets/delete | SP negative targeting overview |\n","| sp/keywords | POST /sp/keywords  POST /sp/keywords/list  PUT /sp/keywords  POST /sp/keywords/delete | SP campaign model diagram  SP keywords overview |\n","| sp/negativeKeywords  sp/campaignNegativeKeywords| POST /sp/negativeKeywords  POST /sp/negativeKeywords/list  PUT /sp/negativeKeywords  POST /sp/negativeKeywords/delete POST  /sp/campaignNegativeKeywords  POST /sp/campaignNegativeKeywords/list  PUT /sp/campaignNegativeKeywords  POST /sp/campaignNegativeKeywords/delete| SP negative keywords overview |\n","| sb/targets | POST /sb/targets  POST /sb/targets/list  PUT /sb/targets  DELETE /sb/targets/{targetId} | SB targets overview |\n","| sb/negativeTargets | POST /sb/negativeTargets  POST /sb/negativeTargets/list  PUT /sb/negativeTargets  DELETE /sb/negativeTargets/{targetId} | SB negative targets overview |\n","| sb/keywords | POST /sb/keywords  GET /sb/keywords  PUT /sb/keywords  DELETE /sb/keywords/{keywordId} | SB keywords overview |\n","| sb/negativeKeywords | POST /sb/negativeKeywords  GET /sb/negativeKeywords  PUT /sb/negativeKeywords  DELETE /sb/negativeKeywords/{keywordId} | SB negative keywords overview |\n","| sb/themes | POST /sb/themes/list  PUT /sb/themes  POST /sb/themes | Theme targeting overview |\n","| sd/targeting | POST /sd/targets  GET sd/targets  GET sd/targets/extended  PUT /sd/targets  DELETE /sd/targets/{targetId} | SD audiences overview  SD contextual targeting overview|\n","| sd/negativeTargeting | POST /sd/negativeTargets  GET sd/negativeTargets  GET sd/negativeTargets/extended  PUT /sd/negativeTargets  DELETE /sd/negativeTargets/{targetId} | |\n","| Amazon Marketing Stream | N/A | Targets dataset |\n","| targets/exports | POST /targets/exports | Exports overview |\n"],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":2,"text":"JSON examples"},"path":"/en-us/guides/exports/entities/targets","content":[" Below you can find examples of how each ad product represents a target. \n"],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Generic"},"path":"/en-us/guides/exports/entities/targets","content":[" The generic sample includes a JSON representation of all possible fields in the common schema.\n"],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/guides/exports/entities/targets","content":[" This example includes all possible fields that could be present in a Sponsored Products target, regardless of targetType.\n"],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/guides/exports/entities/targets","content":[" This example includes all possible fields that could be present in a Sponsored Brands target, regardless of targetType.\n"],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Sponsored Display"},"path":"/en-us/guides/exports/entities/targets","content":[" This example includes all possible fields that could be present in a Sponsored Display target, regardless of targetType.\n"],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Auto target"},"path":"/en-us/guides/exports/entities/targets","content":[],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Keyword target"},"path":"/en-us/guides/exports/entities/targets","content":[],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Product category target"},"path":"/en-us/guides/exports/entities/targets","content":[],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Product target"},"path":"/en-us/guides/exports/entities/targets","content":[],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Product category audience target"},"path":"/en-us/guides/exports/entities/targets","content":[],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Product audience target"},"path":"/en-us/guides/exports/entities/targets","content":[],"documentType":"guide"},{"title":"Exports targets model overview","sectionHeader":{"type":3,"text":"Audience target"},"path":"/en-us/guides/exports/entities/targets","content":[],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":null,"path":"/en-us/guides/exports/entities/enums","content":[" This document contains the enums referenced by the exports model. When enum values in the exports model differ from those used in campaign management APIs, the values table contains extra columns to show equivalencies. \n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"adProduct"},"path":"/en-us/guides/exports/entities/enums","content":[" Description:  An ad product is a top-level offering from Amazon Ads, with a given feature set, business rules, and consistent logic.\n","| Values |\n","\\|-----\\|\n","| SPONSORED_PRODUCTS |\n","| SPONSORED_BRANDS |\n","| SPONSORED_DISPLAY |\n"," Referenced by: Campaigns, ad groups\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"adType"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: The type or format of an ad.\n","| Values|\n","\\|-----\\|\n","| PRODUCT_AD | \n","| IMAGE |\n","| VIDEO |\n","| PRODUCT_COLLECTION |\n","| STORE_SPOTLIGHT | \n"," Referenced by: Ad\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"audienceSegmentType"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: Specifies types of audience segment.\n","| Values              |\n","\\|---------------------\\|\n","| SPONSORED_ADS_AMC |\n","| BEHAVIOR_DYNAMIC    |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"bidStrategy"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: The auto bidding strategy applied to the campaign.\n","|Values\t|Sponsored Products (dynamicBidding)\t|Sponsored Brands (bidOptimizationStrategy)\t|\n","|---\t|---\t|---\t|\n","|SALES_DOWN_ONLY\t|LEGACY_FOR_SALES\t|none\t|\n","|SALES\t|AUTO_FOR_SALES\t|MAXIMIZE_IMMEDIATE_SALES\t|\n","|NEW_TO_BRAND\t|none\t|MAXIMIZE_NEW_TO_BRAND_CUSTOMERS\t|\n","|RULE_BASED\t|RULE_BASED\t|none if a bidRule is present\t|\n","|none / null\t|MANUAL\t| \t|\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"budgetType"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: The type of budget associated with the campaign.\n","| Values |\n","\\|-----\\|\n","| MONETARY |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"costType"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: The way the campaign is charged. \n","| Values |\n","\\|-----\\|\n","| CPC |\n","| VCPM | \n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"currencyCode"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: An ISO 4217 standard currency code for all currency-related attributes.\n","|Values\t|\n","\\|-----\\|\n","|AED\t|\n","|AUD\t|\n","|BRL\t|\n","|CAD\t|\n","|CHF\t|\n","|CNY\t|\n","|DKK\t|\n","|EUR\t|\n","|GBP\t|\n","|INR\t|\n","|JPY\t|\n","|MXN\t|\n","|NOK\t|\n","|SAR\t|\n","|SEK\t|\n","|SGD\t|\n","|TRY\t|\n","|USD\t|\n","|BHD\t|\n","|CNH\t|\n","|CZK\t|\n","|HKD\t|\n","|HUF\t|\n","|ILS\t|\n","|JOD\t|\n","|KWD\t|\n","|PLN\t|\n","|QAR\t|\n","|RON\t|\n","|THB\t|\n","|ZAR\t|\n","|ARS\t|\n","|BGN\t|\n","|BOB\t|\n","|CLP\t|\n","|COP\t|\n","|CRC\t|\n","|DOP\t|\n","|DZD\t|\n","|EGP\t|\n","|GTQ\t|\n","|HNL\t|\n","|HRK\t|\n","|IDR\t|\n","|JMD\t|\n","|KRW\t|\n","|MAD\t|\n","|MYR\t|\n","|NGN\t|\n","|NZD\t|\n","|PAB\t|\n","|PEN\t|\n","|PHP\t|\n","|PKR\t|\n","|PYG\t|\n","|RSD\t|\n","|RUB\t|\n","|TND\t|\n","|TWD\t|\n","|UAH\t|\n","|UYU\t|\n","|VND\t|\n"," Referenced by: Campaigns, ad groups\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"deliveryReasons"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: This is a list of reasons that explains the delivery status of the entity. It explains why the entity is delivering or not delivering. This is not defined by the user and is read only.\n","|Values\t|Sponsored Products\t|Sponsored Brands\t|Sponsored Display\t|\n","\\|-----\\|------\\|-------\\|--------\\|\n","|CAMPAIGN_PAUSED\t|CAMPAIGN_PAUSED\t|CAMPAIGN_PAUSED\t|CAMPAIGN_PAUSED\t|\n","|CAMPAIGN_ARCHIVED\t|CAMPAIGN_ARCHIVED\t|CAMPAIGN_ARCHIVED\t|CAMPAIGN_ARCHIVED\t|\n","|CAMPAIGN_PENDING_START_DATE\t|PENDING_START_DATE\t|PENDING_START_DATE\t|PENDING_START_DATE\t|\n","|CAMPAIGN_END_DATE_REACHED\t|ENDED\t|ENDED\t|ENDED\t|\n","|CAMPAIGN_REJECTED\t|REJECTED\t|REJECTED\t| \t|\n","|CAMPAIGN_PENDING_REVIEW\t|PENDING_REVIEW\t|PENDING_REVIEW\t| \t|\n","|CAMPAIGN_INCOMPLETE\t|CAMPAIGN_INCOMPLETE\t|CAMPAIGN_INCOMPLETE\t| \t|\n","|CAMPAIGN_OUT_OF_BUDGET\t|CAMPAIGN_OUT_OF_BUDGET\t|CAMPAIGN_OUT_OF_BUDGET\t|CAMPAIGN_OUT_OF_BUDGET\t|\n","|PORTFOLIO_OUT_OF_BUDGET\t|PORTFOLIO_OUT_OF_BUDGET\t| \t| \t|\n","|PORTFOLIO_END_DATE_REACHED\t|PORTFOLIO_ENDED\t|PORTFOLIO_ENDED\t| \t|\n","|PORTFOLIO_ARCHIVED\t|PORTFOLIO_ARCHIVED\t|PORTFOLIO_ARCHIVED\t| \t|\n","|PORTFOLIO_PAUSED\t|PORTFOLIO_PAUSED\t|PORTFOLIO_PAUSED\t| \t|\n","|PORTFOLIO_PENDING_START_DATE\t|PORTFOLIO_PENDING_START_DATE\t|PORTFOLIO_PENDING_START_DATE\t| \t|\n","|ADVERTISER_POLICING_SUSPENDED\t|ADVERTISER_POLICING_SUSPENDED\t|ADVERTISER_POLICING_SUSPENDED\t| \t|\n","|ADVERTISER_POLICING_PENDING_REVIEW\t|ADVERTISER_POLICING_PENDING_REVIEW\t|ADVERTISER_POLICING_PENDING_REVIEW\t| \t|\n","|ADVERTISER_ARCHIVED\t|ADVERTISER_ARCHIVED\t|ADVERTISER_ARCHIVED\t| \t|\n","|ADVERTISER_OUT_OF_BUDGET\t|ADVERTISER_OUT_OF_BUDGET AND ACCOUNT_OUT_OF_BUDGET\t|ADVERTISER_ACCOUNT_OUT_OF_BUDGET\t|ACCOUNT_OUT_OF_BUDGET\t|\n","|ADVERTISER_PAUSED\t|ADVERTISER_PAUSED\t|ADVERTISER_PAUSED\t|ADVERTISER_PAUSED\t|\n","|ADVERTISER_PAYMENT_FAILURE\t|ADVERTISER_PAYMENT_FAILURE\t|ADVERTISER_PAYMENT_FAILURE\t|ADVERTISER_PAYMENT_FAILURE\t|\n","|ADVERTISER_OUT_OF_PREPAY_BALANCE\t| \t|ADVERTISER_OUT_OF_PREPAY_BALANCE\t| \t|\n","|ADVERTISER_INELIGIBLE\t| \t|INELIGIBLE\t| \t|\n","|AD_GROUP_PAUSED\t|AD_GROUP_PAUSED\t|AD_GROUP_PAUSED\t|AD_GROUP_PAUSED\t|\n","|AD_GROUP_ARCHIVED\t|AD_GROUP_ARCHIVED\t|AD_GROUP_ARCHIVED\t|AD_GROUP_ARCHIVED\t|\n","|AD_GROUP_INCOMPLETE\t|AD_GROUP_INCOMPLETE\t|AD_GROUP_INCOMPLETE\t|AD_GROUP_INCOMPLETE\t|\n","|AD_GROUP_POLICING_PENDING_REVIEW\t|AD_GROUP_POLICING_PENDING_REVIEW\t|AD_GROUP_POLICING_PENDING_REVIEW\t| \t|\n","|AD_GROUP_LOW_BID\t|AD_GROUP_LOW_BID\t|AD_GROUP_LOW_BID\t|AD_GROUP_LOW_BID\t|\n","|AD_GROUP_PENDING_REVIEW\t|PENDING_REVIEW\t| \t| \t|\n","|AD_GROUP_REJECTED\t|REJECTED\t| \t| \t|\n","|TARGET_POLICING_SUSPENDED\t|TARGETING_CLAUSE_POLICING_SUSPENDED\t| \t| \t|\n","|TARGET_PAUSED\t|TARGETING_CLAUSE_PAUSED\t| \t|TARGET_STATUS_PAUSED\t|\n","|TARGET_ARCHIVED\t|TARGETING_CLAUSE_ARCHIVED\t| \t|TARGET_STATUS_ARCHIVED\t|\n","|TARGET_BLOCKED\t|TARGETING_CLAUSE_BLOCKED\t| \t| \t|\n","|AD_PAUSED\t|AD_PAUSED\t|AD_PAUSED\t|AD_STATUS_PAUSED\t|\n","|AD_ARCHIVED\t|AD_ARCHIVED\t|AD_ARCHIVED\t|AD_STATUS_ARCHIVED\t|\n","|AD_POLICING_PENDING_REVIEW\t|AD_POLICING_PENDING_REVIEW\t|AD_POLICING_PENDING_REVIEW\t| \t|\n","|AD_POLICING_SUSPENDED\t|AD_POLICING_SUSPENDED\t|AD_POLICING_SUSPENDED\t| \t|\n","|AD_CREATION_FAILED\t|AD_CREATION_OFFLINE_FAILED or AD_CREATION_FAILED\t| \t| \t|\n","|AD_CREATION_IN_PROGRESS\t|AD_CREATION_OFFLINE_PENDING or AD_CREATION_OFFLINE_IN_PROGRESS\t| \t| \t|\n","|LANDING_PAGE_NOT_AVAILABLE\t|LANDING_PAGE_NOT_AVAILABLE or AD_LANDING_PAGE_NOT_AVAILABLE\t| \t| \t|\n","|NOT_BUYABLE\t|NOT_BUYABLE or AD_NOT_BUYABLE\t| \t|NOT_BUYABLE\t|\n","|NOT_IN_BUYBOX\t|NOT_IN_BUYBOX or AD_NOT_IN_BUYBOX\t| \t|NOT_IN_BUYBOX\t|\n","|NOT_IN_POLICY\t| \t| \t|NOT_IN_POLICY\t|\n","|OUT_OF_STOCK\t|OUT_OF_STOCK or AD_OUT_OF_STOCK\t| \t|OUT_OF_STOCK\t|\n","|AD_MISSING_IMAGE\t|MISSING_IMAGE or AD_MISSING_IMAGE\t| \t|MISSING_IMAGE\t|\n","|SECURITY_SCAN_PENDING_REVIEW\t|SECURITY_SCAN_PENDING_REVIEW\t| \t| \t|\n","|SECURITY_SCAN_REJECTED\t|SECURITY_SCAN_REJECTED\t| \t| \t|\n","|STATUS_UNAVAILABLE\t|STATUS_UNAVAILABLE\t| \t| \t|\n","|NO_INVENTORY\t|NO_INVENTORY\t| \t| \t|\n","|NO_PURCHASABLE_OFFER\t|NO_PURCHASABLE_OFFER or AD_NO_PURCHASABLE_OFFER\t| \t| \t|\n","|AD_INELIGIBLE\t|INELIGIBLE or AD_INELIGIBLE\t|INELIGIBLE\t| \t|\n","|CREATIVE_MISSING_ASSET\t| \t| \t| \t|\n","|CREATIVE_PENDING_REVIEW\t| \t|SUBMITTED_FOR_MODERATION or PENDING_MODERATION_REVIEW\t|PENDING_REVIEW\t|\n","|CREATIVE_REJECTED\t|AD_GROUP_POLICING_CREATIVE_REJECTED\t|REJECTED_BY_MODERATION or AD_GROUP_POLICING_CREATIVE_REJECTED\t|REJECTED\t|\n","|AD_MISSING_DECORATION\t|AD_MISSING_DECORATION\t| \t|MISSING_DECORATION\t|\n","|PIR_RULE_EXCLUDED\t|PIR_RULE_EXCLUDED\t| \t| \t|\n","|AD_NOT_DELIVERING\t|CAMPAIGN_ADS_NOT_DELIVERING\t| \t|CAMPAIGN_ADS_NOT_DELIVERING |\n","|OTHER\t| \t| \t| \t|\n"," Referenced by: Campaigns, ad groups\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"deliveryStatus"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: This is an overall status if the entity is delivering or not. This is not defined by the user and is read only.\n","|Values|\n","\\|-----\\|\n","| DELIVERING |\n","| NOT_DELIVERING |\n","| UNAVAILABLE |\n"," Referenced by: Campaigns, ad groups\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"event"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: A target event is an event used in audience targets to define what product event to target based on.\n","| Allowed values|\n","\\|-----\\|\n","| PURCHASE |\n","| VIEW |\n"," Referenced by: Targets\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"goal"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: The objective of the campaign or ad group.\n","| Allowed values | Sponsored Display |\n","\\|-----\\|-----\\|\n","| AWARENESS | reach |\n","| CONSIDERATION | clicks |\n","| CONVERSIONS | conversions | \n"," Referenced by: ad groups\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"kpi"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: The way a goal is measured. \n","| Allowed values |\n","\\|-----\\|\n","| CLICKS |\n"," Referenced by: ad groups\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"landingPageType"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: The type of landing page used in an ad. Only certain landing page types are supported for each ad type.\n","| Values | IMAGE | VIDEO | PRODUCT_COLLECTION | STORE_SPOTLIGHT |\n","\\|-------\\|---\\|-----\\|------\\|------\\|\n","| PRODUCT_LIST | | | x | |\n","| STORE | x | x | x | x |\n","| CUSTOM_URL | | | x| | \n","| DETAIL_PAGE | | x | | | \n","| OFF_AMAZON_LINK | x | | | |\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"matchType"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: This is the type of matching that Amazon will apply to the given target. Different match types are available based on the target type and ad product.\n","|Allowed values\t| Description | Sponsored Products\t|Sponsored Brands\t|Sponsored Display\t|\n","\\|------\\|-----\\|-----\\|-------\\|\n","|SEARCH_LOOSE_MATCH\t|Targets customers using search terms loosely related to your products. |QUERY_BROAD_REL_MATCHES\t|N/a\t|N/a\t|\n","|SEARCH_CLOSE_MATCH\t|Targets customers using search terms closely related to your products.| QUERY_HIGH_REL_MATCHES\t|N/a\t|N/a\t|\n","|PRODUCT_SUBSTITUTES\t|Targets customers who view detail pages of products similar to yours.| ASIN_SUBSTITUTE_RELATED\t|N/a\t|N/a\t|\n","|PRODUCT_COMPLEMENTS\t|Targets customers who view detail pages of products that complement your product.| ASIN_ACCESSORY_RELATED\t|N/a\t|N/a\t|\n","|PRODUCT_SIMILAR\t| Targets customers who view detail pages of products similar to yours.|N/a\t|N/a\t|similarProduct\t|\n","|SEARCH_RELATED_TO_YOUR_BRAND\t| A set of keywords that are often used to search for brands and promote brand impressions. |N/a\t|KEYWORDS_RELATED_TO_YOUR_BRAND\t|N/a\t|\n","|SEARCH_RELATED_TO_YOUR_LANDING_PAGES\t|A set of keywords that promote brand discovery and can help drive traffic to brand store page or product detail pages. |N/a\t|KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES\t|N/a\t|\n","|Allowed values\t| Description | Sponsored Products\t|Sponsored Brands\t|\n","\\|--------\\|-------\\|------\\|\n","|BROAD\t|Offers broad exposure to customer shopping queries. Search terms may include keyword terms in any order, and may also include singulars, plurals, variations, synonyms, and related terms. | BROAD\t|broad\t|\n","|PHRASE\t| For Sponsored Products, the search term must contain the exact phrase or sequence of words. It is more restrictive than broad match. Phrase match also includes the plural form of the keyword. In Sponsored Brands campaigns, this match type includes search terms matching the meaning of the keyword. |PHRASE\t|phrase\t|\n","|EXACT\t| The search term must exactly match the keyword or close variations of the keyword. The sequence of words must also match. This is the most restrictive keyword match type. |EXACT\t|exact\t|\n","|Allowed values\t|Sponsored Products\t|Sponsored Brands\t|Sponsored Display\t|\n","\\|--------\\|-------\\|-------\\|-------\\|\n","|PRODUCT_EXACT\t|ASIN_SAME_AS\t|asinSameAs\t|asinSameAs\t|\n","|PRODUCT_SIMILAR\t|ASIN_EXPANDED_FROM\t|N/a\t|N/a\t|\n","|Allowed values\t|Sponsored Display mapping\t|\n","\\|-------\\|-----\\|\n","|PRODUCT_EXACT\t|exactProduct\t|\n","|PRODUCT_SIMILAR\t|relatedProduct, similarProduct\t|\n","| Allowed values | Sponsored Products |\n","\\| --- \\| --- \\|\n","| KEYWORDS_RELATED_TO_YOUR_BRAND | brand | \n","| KEYWORDS_RELATED_TO_GIFTS | gift |\n","| KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY | category |\n"," Referenced by: Targets\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"placement"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: Refers to the placement where an ad appears.\n","| Values | Sponsored Products | Sponsored Brands |\n","\\|-----\\|-------\\|------\\|\n","| HOME_PAGE | | HOME | \n","| TOP_OF_SEARCH | PLACEMENT_TOP | |\n","| PRODUCT_PAGE | PLACEMENT_PRODUCT_PAGE | DETAIL_PAGE | \n","| REST_OF_SEARCH | REST_OF_SEARCH | |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"recurrenceTimePeriod "},"path":"/en-us/guides/exports/entities/enums","content":[" Description: The possible recurrence options for a budget.\n","|Values|\n","\\|-----\\|\n","| DAILY |\n","| LIFETIME |\n","| OTHER |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"productIdType"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: The type of ID used to identify a product.\n","| Values |\n","\\|-------\\|\n","| ASIN |\n","| SKU |\n"," Referenced by: Ads\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"shopperCohortType"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: Specifies types of shopper cohort.\n","| Values                             |\n","\\|------------------------------------\\|\n","| AUDIENCE_SEGMENT |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"shopperSegment"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: Specifies types of shoppers. \n","| Values |\n","\\|----\\|\n","| NEW_TO_BRAND_PURCHASE |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"state"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: The user-chosen state of a campaign.\n","|Values|\n","\\|-----\\|\n","| ENABLED |\n","| PAUSED |\n","| ARCHIVED |\n","| OTHER |\n"," Referenced by: Campaigns, ad groups\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"targetingSettings"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: Used to indicate the type of targeting supported by the campaign.\n","|Values| Description |\n","\\|-----\\|------\\|\n","| MANUAL | Sponsored Products manual targeting.| \n","| AUTO |  Sponsored Products auto targeting. |\n","| T00020 | Sponsored Display contextual targeting. |\n","| T00030 | Sponsored Display audience targeting. | \n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Exports common enums","sectionHeader":{"type":3,"text":"targetType"},"path":"/en-us/guides/exports/entities/enums","content":[" Description: A target type defines the type of target criteria you are targeting for inclusion or exclusion on the given ad group or campaign.\n","|Values|\n","\\|-----\\|\n","| AUTO | \n","| KEYWORD | \n","| PRODUCT_CATEGORY | \n","| PRODUCT | \n","| PRODUCT_CATEGORY_AUDIENCE | \n","| PRODUCT_AUDIENCE |\n","| AUDIENCE | \n"," Referenced by: Targets\n"],"documentType":"guide"},{"title":"Exports FAQ","sectionHeader":null,"path":"/en-us/guides/exports/faq","content":[],"documentType":"guide"},{"title":"Exports FAQ","sectionHeader":{"type":3,"text":"What is the intended use case of the exports API?"},"path":"/en-us/guides/exports/faq","content":[" The intended use case of the exports API is to allow customers who manage multiple advertisers to synchronize their advertising data with Amazon advertising data one to two times a day. Customers should not use the exports API to continually retrieve real-time advertising data.\n"],"documentType":"guide"},{"title":"Exports FAQ","sectionHeader":{"type":3,"text":"How does throttling work for the exports API?"},"path":"/en-us/guides/exports/faq","content":[" The exports API uses a queue-based throttling system, where all developers who onboard to the API are assigned a cap on how many in-progress requests they can have at once per endpoint. The default cap for all customers is 5 jobs per endpoint. \n"," For example, a customer can only request 5 exports with entity type campaign at once, and then the customer must wait for at least one request to complete before they can submit another request for a campaign export. To request an increase to your job limit, please contact our support team.\n"],"documentType":"guide"},{"title":"Exports FAQ","sectionHeader":{"type":3,"text":"What ad products are supported by exports?"},"path":"/en-us/guides/exports/faq","content":[" Exports support Sponsored Products, Sponsored Brands, and Sponsored Display. Each ad product supports campaign, ad group, target, and ad export types.\n"],"documentType":"guide"},{"title":"Exports FAQ","sectionHeader":{"type":3,"text":"How long are export download URLs valid?"},"path":"/en-us/guides/exports/faq","content":[" Export download URLs are valid for one hour. Each call to GET /exports/{exportId} generates a new download URL. You can generate new download URLs for up to 24 hours after the export completes.\n"],"documentType":"guide"},{"title":"Exports FAQ","sectionHeader":{"type":3,"text":"Can I retrieve historical campaign metadata via exports?"},"path":"/en-us/guides/exports/faq","content":[" No. Exports contain information about campaigns at the time of the request. It is not possible to retrieve historical metadata via exports.\n"],"documentType":"guide"},{"title":"Exports FAQ","sectionHeader":{"type":3,"text":"How often should I request exports?"},"path":"/en-us/guides/exports/faq","content":[],"documentType":"guide"},{"title":"Sponsored Products overview","sectionHeader":null,"path":"/en-us/guides/sponsored-products/overview","content":[" Sponsored Products campaigns allow you to advertise your products in high-visibility placements on Amazon.com. Sponsored Products are available for vendors, sellers, and Kindle Direct Publishing authors. \n"," You can use the Amazon Ads API to create and manage Sponsored Products campaigns, as well as retrieve campaign performance data. \n"],"documentType":"guide"},{"title":"Sponsored Products overview","sectionHeader":{"type":2,"text":"Campaign management"},"path":"/en-us/guides/sponsored-products/overview","content":[" To learn more about creating and managing Sponsored Products campaigns using the API, see:\n","Campaign structure  Creating a manual targeting campaign  Creating an auto targeting campaign  Entity limits  Full API reference\n"],"documentType":"guide"},{"title":"Sponsored Products overview","sectionHeader":{"type":2,"text":"Reporting"},"path":"/en-us/guides/sponsored-products/overview","content":[" The Ads API reporting functionality provides a variety of reports to help you retrieve historical impression, click, cost, and conversion data for your Sponsored Products campaigns. \n"," Learn more:\n","Reporting Documentation \\* Full API reference\n"],"documentType":"guide"},{"title":"Sponsored Products campaign structure","sectionHeader":null,"path":"/en-us/guides/sponsored-products/get-started/campaign-structure","content":[" Creating Sponsored Products campaigns using the Amazon Ads API requires making multiple calls to create the entities that make up a campaign. The number of entities you need to create is determined by the type of campaign you are creating, either manual or auto. \n"," Both manual and auto campaigns require you to create, at minimum, campaigns, ad groups, and product ads. However, for manual campaigns, the advertiser also has complete control over keywords and product targeting expressions. For auto campaigns, Amazon suggests relevant targeting expressions and keywords based on the products you are advertising. Both auto and manual campaigns also support negative keyword and product targeting. \n"],"documentType":"guide"},{"title":"Sponsored Products campaign structure","sectionHeader":{"type":2,"text":"Auto campaigns"},"path":"/en-us/guides/sponsored-products/get-started/campaign-structure","content":[" For auto campaigns, advertisers only need to create a campaign, ad group, and product ad. Amazon assigns targeting expressions and keywords, although advertisers can choose to define auto targeting expressions if desired. \n"," The following diagram shows an example of an auto campaign with two ad groups. Each ad group is advertising two products (product ads). The first ad group has a negative targeting expression, while the second uses an auto targeting expression and negative keyword. \n"],"documentType":"guide"},{"title":"Sponsored Products campaign structure","sectionHeader":{"type":2,"text":"Manual campaigns"},"path":"/en-us/guides/sponsored-products/get-started/campaign-structure","content":[" For manual campaigns, advertisers also need to create a campaign, ad group, and product ad, but they must also include at least one product targeting expression or keyword in each ad group. \n"," The following diagram shows an example of a manual campaign with two ad groups, and each ad group has two product ads. The first ad group targets two keywords and also has a negative keyword. The second ad group targets both an individual product and a category of products, and includes a negative targeting expression.\n"],"documentType":"guide"},{"title":"Sponsored Products campaign structure","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/sponsored-products/get-started/campaign-structure","content":["Creating auto campaigns  Creating manual campaigns  Entity limits\n"],"documentType":"guide"},{"title":"Creating auto campaigns","sectionHeader":null,"path":"/en-us/guides/sponsored-products/get-started/auto-campaigns","content":[" Auto campaigns use Amazon automated targeting capabilities to assign relevant keywords and targeting expressions to Sponsored Products campaigns. If you are new to creating Sponsored Products campaigns, we recommend starting with an auto campaign to understand what targeting works best for your products. \n"],"documentType":"guide"},{"title":"Creating auto campaigns","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/get-started/auto-campaigns","content":["Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in the tutorial.  \\* Understand the structure of Sponsored products campaigns.\n"],"documentType":"guide"},{"title":"Creating auto campaigns","sectionHeader":{"type":2,"text":"Steps"},"path":"/en-us/guides/sponsored-products/get-started/auto-campaigns","content":["Create a campaign using the POST /adsApi/v1/create/campaigns endpoint. To create an auto campaign, make sure autoCreateTargets is set to true in the autoCreationSettings.\n","Create at least one ad group using the POST /adsApi/v1/create/adGroups endpoint. Each ad group should contain one or more products that share similar characteristics (for example, price, category, genre).\n","Create at least one product ad per ad group using the POST /adsApi/v1/create/ads endpoint.\n","(Optional) Set up auto targeting using the PUT /adsApi/v1/update/targets endpoint. Auto targeting allows you to set bids for targeting groups based on the relationship to the products you are advertising. You can set different bids for search terms that are close matches or loose matches, or product detail pages that are substitutes or complements to your products. If you choose to use auto targeting expressions, the bids you set for each expression replace the default bid for the ad group. \n","(Optional) Set up negative targeting. You can use negative keyword targeting or negative product targeting to stop ads from showing on certain search results, brands, or product detail pages. Negative targets can be applied at the campaign and ad group level. All negative targets are also created through the targets API POST /adsApi/v1/create/targets by setting the negative field to true.\n"],"documentType":"guide"},{"title":"Creating manual campaigns","sectionHeader":null,"path":"/en-us/guides/sponsored-products/get-started/manual-campaigns","content":[" Manual campaigns give advertisers full control over targeting, including manually creating product targeting expressions and adding keywords. If you are new to creating Sponsored Products campaigns, we recommend starting with an auto campaign. \n"],"documentType":"guide"},{"title":"Creating manual campaigns","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/get-started/manual-campaigns","content":["Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in the tutorial.   Understand the general structure for Sponsored Products campaigns.  (Optional) Create an auto campaign so you can identify keywords or targeting expressions to use in your manual campaign.\n"],"documentType":"guide"},{"title":"Creating manual campaigns","sectionHeader":{"type":2,"text":"Steps"},"path":"/en-us/guides/sponsored-products/get-started/manual-campaigns","content":["Create a campaign using the POST /adsApi/v1/create/campaigns endpoint. To create a manual campaign, make sure autoCreateTargets is set to false in the autoCreationSettings.\n","Create at least one ad group using the POST /adsApi/v1/create/adGroups endpoint. Each ad group should contain one or more products that share similar characteristics (for example, price, category, genre).\n","Create at least one product ad per ad group using the POST /adsApi/v1/create/ads endpoint.\n","Add targeting to the ad group. Ad groups for manual campaigns must have at least one associated targeting expression (product or category) or keyword.  5. (Optional) Set up negative targeting. You can use negative keyword targeting or negative product targeting to stop ads from showing on certain search results, brands, or product detail pages. Negative targets can be applied at the campaign and ad group level. All negative targets are also created through the targets API POST /adsApi/v1/create/targets by setting the negative field to true.\n"],"documentType":"guide"},{"title":"Sponsored Product Features Availability by Marketplace","sectionHeader":null,"path":"/en-us/guides/sponsored-products/features","content":[" This document lists descriptions and marketplace availability for all Sponsored Products features.\n"],"documentType":"guide"},{"title":"Sponsored Product Features Availability by Marketplace","sectionHeader":{"type":2,"text":"Campaign Management"},"path":"/en-us/guides/sponsored-products/features","content":["Campaigns allow you to advertise your products in high-visibility placements on Amazon.com. For more information, see Sponsored Products overview.  AdGroups provides the ability to organize, manage, and track performance of the products within your campaign.  Product ads represent the individual products that you want to advertise within your campaign.  Keyword Targeting lets you have more control over your targeting and spend, identifying keywords for which you want your ads to appear and optimizing bids for each.  Negative Keyword Targeting lets you prevent ads from appearing on shopping results pages that do not meet your campaign or ad group objectives. \\* Product Targeting lets you have more control over your targeting and spend, identifying products for which you want your ads to appear and optimizing bids for each.\n"," Relevant resource:\n","/adsApi/v1/\\*/campaigns  \\[/adsApi/v1//adGroups](api-spec-v1-adgroups#tag/AdGroups/operation/CreateAdGroup)  \\[/adsApi/v1//ads](api-spec-v1-ads#tag/Ads/operation/CreateAd)  \\[/adsApi/v1//targets](api-spec-v1-targets#tag/Targets/operation/CreateTarget)\n"," Marketplace availability:\n","North America: United States (US), Canada (CA), Mexico (MX)  South America: Brazil (BR)  Europe: Germany (DE), Spain (ES), France (FR), Italy (IT), United Kingdom (UK), Netherlands (NL), Sweden (SE), Turkey (TR), Poland (PL), Belgium (BE)  Middle East: United Arab Emirates (UAE), Egypt (EG), Saudi Arabia (SA)  Asia Pacific: Japan (JP), India (IN), Australia (AU), Singapore (SG) \\* Africa: South Africa (ZA)\n"],"documentType":"guide"},{"title":"Sponsored Product Features Availability by Marketplace","sectionHeader":{"type":2,"text":"Rule-based bidding"},"path":"/en-us/guides/sponsored-products/features","content":[" For any existing campaign running for at least 30 days, you can apply a bidding rule with a guardrail of ROAS and Amazon Ads may then adjust your base bids up and down to increase conversions while maintaining your guardrails.\n"," Relevant resource:\n","/sp/rules/campaignOptimization\n"," Marketplace availability:\n","North America: United States (US), Canada (CA), Mexico (MX)  Europe: United Kingdom (UK), Germany (DE), France (FR)  Asia Pacific: Japan (JP)\n"],"documentType":"guide"},{"title":"Sponsored Product Features Availability by Marketplace","sectionHeader":{"type":2,"text":"Consolidated recommendations"},"path":"/en-us/guides/sponsored-products/features","content":[" This feature gets the top consolidated recommendations across bid, budget, and targeting for a campaign. All recommendations are refreshed every day. \n"," Relevant resource:\n","/sp/campaign/recommendations\n"," Marketplace availability:\n","North America: United States (US)\n"],"documentType":"guide"},{"title":"Sponsored Product Features Availability by Marketplace","sectionHeader":{"type":2,"text":"Product recommendations"},"path":"/en-us/guides/sponsored-products/features","content":[" This feature returns suggested ASINs to target in a product targeting campaign.\n"," Relevant resources:\n","/sp/targets/products/recommendations\n"," Marketplace availability:\n","North America: United States (US), Canada (CA), Mexico (MX)  South America: Brazil (BR)  Europe: Germany (DE), Spain (ES), France (FR), Italy (IT), United Kingdom (UK), Netherlands (NL), Sweden (SE), Turkey (TR), Poland (PL), Belgium (BE)  Middle East: United Arab Emirates (UAE), Egypt (EG), Saudi Arabia (SA)  Asia Pacific: Japan (JP), India (IN), Australia (AU), Singapore (SG) \\* Africa: South Africa (ZA)\n"],"documentType":"guide"},{"title":"Sponsored Product Features Availability by Marketplace","sectionHeader":{"type":2,"text":"Theme-based bid suggestions (Beta)"},"path":"/en-us/guides/sponsored-products/features","content":[" This feature delivers suggestions and impact metrics for multiple themes, allowing you to choose a bid from a theme that is best aligned with your campaign.\n"," Relevant resources: \n","sp/targets/bid/recommendations\n"," Marketplace availability:\n","North America: United States (US), Canada (CA)  Europe: Germany (DE), Spain (ES), France (FR), United Kingdom (UK)  Asia Pacific: Japan (JP), India (IN)\n"],"documentType":"guide"},{"title":"Sponsored Product Features Availability by Marketplace","sectionHeader":{"type":2,"text":"Budget recommendation"},"path":"/en-us/guides/sponsored-products/features","content":[" This feature provides an estimated budget needed to keep the campaign in budget for the full 24-hour period, the share of time the campaign was in budget during the past seven days, and estimated impressions the campaign might have generated had it adopted the recommended budget.\n"," Relevant resources: \n","sp/campaigns/budgetRecommendations\n"," Marketplace availability:\n","North America: United States (US), Canada (CA), Mexico (MX)  Europe: Germany (DE), Spain (ES), France (FR), United Kingdom (UK), Italy (IT)  Asia Pacific: Japan (JP), India (IN), Australia (AU) \\* Middle East: United Arab Emirates (UAE)\n"],"documentType":"guide"},{"title":"Creating Sponsored Products campaigns","sectionHeader":null,"path":"/en-us/guides/sponsored-products/campaigns","content":[" Campaigns are the highest level of the Sponsored Products entity hierarchy. You can learn more about the other components of campaigns in Campaign hierarchy.\n"," Budget, targeting type, start date, and end date are all defined at the campaign level.\n"," Learn more:\n","Building an auto targeting campaign \\* Building a manual campaign\n"],"documentType":"guide"},{"title":"Creating Sponsored Products campaigns","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/sponsored-products/campaigns","content":[],"documentType":"guide"},{"title":"Creating Sponsored Products campaigns","sectionHeader":{"type":3,"text":"Endpoint "},"path":"/en-us/guides/sponsored-products/campaigns","content":[],"documentType":"guide"},{"title":"Creating Sponsored Products campaigns","sectionHeader":{"type":3,"text":"Examples"},"path":"/en-us/guides/sponsored-products/campaigns","content":[],"documentType":"guide"},{"title":"Creating Sponsored Products campaigns","sectionHeader":{"type":2,"text":"Response"},"path":"/en-us/guides/sponsored-products/campaigns","content":[" A successful call returns a 207 response code and indicates the indexes and campaign IDs of the campaigns created. \n"],"documentType":"guide"},{"title":"Creating Sponsored Products campaigns","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/sponsored-products/campaigns","content":[" Once you have created a campaign, you need to create at least one ad group.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products ad groups","sectionHeader":null,"path":"/en-us/guides/sponsored-products/ad-groups","content":[],"documentType":"guide"},{"title":"Creating Sponsored Products ad groups","sectionHeader":{"type":2,"text":"Creating ad groups"},"path":"/en-us/guides/sponsored-products/ad-groups","content":[" Ad groups provide the ability to organize, manage, and track performance of the products within your campaign. Products placed together in an ad group share the same bids and targeting (keyword or product). Each campaign consists of one or more ad groups.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products ad groups","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/ad-groups","content":[" To create an ad group, you must first create a campaign to get the campaignId. You can learn more about campaign creation in Sponsored Products campaigns.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products ad groups","sectionHeader":{"type":2,"text":"Best practices"},"path":"/en-us/guides/sponsored-products/ad-groups","content":["Ad group name: Assign an ad group name that is descriptive and meaningful to you. Ad group names must be unique within a campaign, but you can use the same ad group name in different campaigns. Your ad group name is only used for display purposes in the campaign manager and is not visible to shoppers.  Keyword or product targeting:  AdGroup Bid: The AdGroup default bid amount applies to all child entities (keywords, targeting expressions, etc.) of the ad group if you do not define bids for the child entities explicitly. For instance, if a keyword child entity does not include a defined bid, the keyword assumes the default bid for the ad group. To learn more, see Sponsored Products campaign structure.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products ad groups","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/sponsored-products/ad-groups","content":[],"documentType":"guide"},{"title":"Creating Sponsored Products ad groups","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/ad-groups","content":[],"documentType":"guide"},{"title":"Creating Sponsored Products ad groups","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/ad-groups","content":[" If you are copying the sample, be sure to enter your own client ID, access token, campaign ID, and profile ID. \n"],"documentType":"guide"},{"title":"Creating Sponsored Products ad groups","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/ad-groups","content":[" A successful response returns a 207 response code. The error array contains any error messages that can occur when creating an ad group. The success array returns the ad group object which contains the adGroupId.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products ad groups","sectionHeader":{"type":3,"text":"Next steps"},"path":"/en-us/guides/sponsored-products/ad-groups","content":[],"documentType":"guide"},{"title":"Creating Sponsored Products product ads","sectionHeader":null,"path":"/en-us/guides/sponsored-products/product-ads","content":[" Product ads are the smallest unit of your campaign and represent the individual products that you want to advertise. You can learn more about campaign structure in Campaign hierarchy.\n"," Each product ad is associated to a single product, either by SKU (sellers) or ASIN (vendors and authors). \n"," Each product ad is associated to an ad group. We recommend grouping similar products, or products that share similar targeting criteria, in the same ad group. \n"],"documentType":"guide"},{"title":"Creating Sponsored Products product ads","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/product-ads","content":["Create a campaign \\* Create an ad group\n"],"documentType":"guide"},{"title":"Creating Sponsored Products product ads","sectionHeader":{"type":2,"text":"Checking product eligibility"},"path":"/en-us/guides/sponsored-products/product-ads","content":[" To check if a product is eligible for advertising, you can use the POST /eligibility/product/list endpoint. Products must be in stock in order for the ad to serve. \n"],"documentType":"guide"},{"title":"Creating Sponsored Products product ads","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/product-ads","content":[" This example checks the eligibility of ASIN B0B9VJLZ69.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products product ads","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/sponsored-products/product-ads","content":[" To create a product ad, you must include adGroupId, asin (vendors and KDP authors) or sku (sellers), and state.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products product ads","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/product-ads","content":[],"documentType":"guide"},{"title":"Creating Sponsored Products product ads","sectionHeader":{"type":3,"text":"Examples"},"path":"/en-us/guides/sponsored-products/product-ads","content":[" Vendors should include an ASIN in the request body. \n"," If you are a seller who needs to find a SKU associated with a product, you can look in Seller Central. If you know the ASIN associated with your product, you can also use the Product metadata endpoint to get the SKU if you already know the ASIN. \n"," KDP authors can choose whether to add custom ad copy to their ads using the headline field. Note that if you add headline to a product ad, you can only have one product ad in that ad group. If you do not use headline, you can have multiple product ads in the ad group.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products product ads","sectionHeader":{"type":2,"text":"Response"},"path":"/en-us/guides/sponsored-products/product-ads","content":[" A successful call returns a 207 response code. The response body contains a JSON array of objects that have the status for each ad object in the request.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products product ads","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/sponsored-products/product-ads","content":[" For manual campaigns, once you have created a product ad, you need to add either a keyword or targeting clause. \n","Add keywords \\* Add targeting clauses\n"],"documentType":"guide"},{"title":"Ad extensions overview","sectionHeader":null,"path":"/en-us/guides/sponsored-products/ad-extensions/overview","content":[],"documentType":"guide"},{"title":"Ad extensions overview","sectionHeader":{"type":2,"text":"What are ad extensions?"},"path":"/en-us/guides/sponsored-products/ad-extensions/overview","content":[" An ad extension adds a capability to an ad that you have already created. You do not create a new ad, campaign, or ad group.\n"," Video ad extensions attach video creative to a Sponsored Products ad. On eligible placements, the ad renders as an interactive video with navigable chapters. On all other placements, the same ad renders as a standard image.\n"," Ad extensions are intended for advertisers who already run Sponsored Products campaigns and want to add video without rebuilding campaign structure.\n"],"documentType":"guide"},{"title":"Ad extensions overview","sectionHeader":{"type":2,"text":"Ad extension types"},"path":"/en-us/guides/sponsored-products/ad-extensions/overview","content":[" The adExtensionType field identifies which capability an extension provides.\n","| adExtensionType | Description |\n","\\| --- \\| --- \\|\n","| VIDEO | Attaches video creative to an ad. |\n","| PROMPTS | Attaches shopper prompt text to an ad. |\n"," This guide covers VIDEO extensions for Sponsored Products. One video extension is supported per ad.\n"],"documentType":"guide"},{"title":"Ad extensions overview","sectionHeader":{"type":2,"text":"Video features"},"path":"/en-us/guides/sponsored-products/ad-extensions/overview","content":[" You supply one to five video clips, and Amazon assembles them into the single video that serves in the ad. Each clip becomes a feature, which functions as a chapter of the assembled video. A shopper taps the seek button on a feature to jump directly to that section.\n"," Each feature carries a headline and an optional description. Set optimizeText to true to let Amazon optimize that text for shopper relevance.\n"," The API supports the SPOTLIGHT video type, which is the assembly method described above.\n"],"documentType":"guide"},{"title":"Ad extensions overview","sectionHeader":{"type":2,"text":"Extension states"},"path":"/en-us/guides/sponsored-products/ad-extensions/overview","content":[" Set the state field to one of the following values to control whether video serves.\n","| state | Delivery behavior |\n","\\| --- \\| --- \\|\n","| ENABLED | Video serves on eligible placements. |\n","| PAUSED | Video stops serving, and the ad continues to serve as an image. |\n"," Queries also accept ARCHIVED in stateFilter.\n"],"documentType":"guide"},{"title":"Ad extensions overview","sectionHeader":{"type":2,"text":"Availability"},"path":"/en-us/guides/sponsored-products/ad-extensions/overview","content":[" Video renders only on placements that are eligible for video. All other placements render the standard image ad. Adding video does not remove an ad from any placement.\n"],"documentType":"guide"},{"title":"Ad extensions overview","sectionHeader":{"type":2,"text":"Required and optional endpoints"},"path":"/en-us/guides/sponsored-products/ad-extensions/overview","content":[" You attach and change video creative through the Ads endpoints. POST /adsApi/v1/update/ads sets the video creative on an existing ad, and POST /adsApi/v1/query/ads reads it back, so an integration can add and maintain video without calling the AdExtensions endpoints.\n"," The AdExtensions endpoints are optional. Use POST /adsApi/v1/query/adExtensions to read delivery state, and POST /adsApi/v1/update/adExtensions to pause or resume video without changing creative. Pausing preserves the assembled video, so resuming does not resubmit it for review when the creative is unchanged.\n"],"documentType":"guide"},{"title":"Ad extensions overview","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/sponsored-products/ad-extensions/overview","content":[" Complete the onboarding process to register an application and apply for API access, then confirm the following:\n","Request the advertising::campaign_management scope for your Login with Amazon application. - Confirm that the advertiser account is enabled for Sponsored Products video; selling in the United States does not by itself enable an account. If it is not enabled, contact your Amazon Ads account representative. - Identify an existing Sponsored Products ad in a United States campaign. To create one, see Sponsored Products product ads. - Prepare a video file that meets the creative requirements listed below.\n"," Video files must meet the following requirements:\n","| Requirement | Value |\n","\\| --- \\| --- \\|\n","| Format | MP4 or MOV |\n","| Minimum duration | 7 seconds |\n","| Aspect ratio | 16:9 horizontal, 1920x1080 recommended |\n","| Maximum file size | 500 MB |\n","| Audio | Not supported, and removed during processing |\n"],"documentType":"guide"},{"title":"Ad extensions overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/sponsored-products/ad-extensions/overview","content":[" Once you understand how ad extensions work, attach video creative to an existing ad.\n"],"documentType":"guide"},{"title":"Create video ad extensions","sectionHeader":null,"path":"/en-us/guides/sponsored-products/ad-extensions/create-video-ad-extension","content":[" There are two ways to create a video ad extension. You can create a new ad with video in a single call, or you can add video to a Sponsored Products ad that already exists. Both paths send spotlightVideos on the ad, and in both cases the ad serves video on eligible placements after creative review completes.\n"],"documentType":"guide"},{"title":"Create video ad extensions","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/ad-extensions/create-video-ad-extension","content":[" Review the prerequisites in the ad extensions overview. You also need the following.\n"," A profile ID. Campaign management requests identify the advertiser with the Amazon-Advertising-API-Scope header, which holds a profile ID. See Profiles for how the header works, and QueryAdvertiserAccount API to retrieve the accounts your credentials can reach. Profile IDs are returned under alternateIds, keyed by countryCode. Video ad extensions are available in the United States, so use the US entry.\n"," A registered video asset. Register the video file with the Creative Asset Library to obtain an assetId and an assetVersion. Registration returns a pre-signed upload URL that expires after 15 minutes. Upload the file before the URL expires. For the full registration and upload sequence, see Asset Library overview.\n"],"documentType":"guide"},{"title":"Create video ad extensions","sectionHeader":{"type":2,"text":"Create a new ad with video"},"path":"/en-us/guides/sponsored-products/ad-extensions/create-video-ad-extension","content":[" Send spotlightVideos on POST /adsApi/v1/create/ads to create the ad and its video extension in a single call. This path assumes you have already created a campaign and an ad group to hold the ad. To create them, see Sponsored Products product ads.\n"," The create operation requires more fields than the update operation:\n","| Field | Description |\n","\\| --- \\| --- \\|\n","| adGroupId | Required. The ad group that holds the ad. |\n","| adProduct | Required. Use SPONSORED_PRODUCTS. |\n","| adType | Required. Use PRODUCT_AD. |\n","| state | Required. Use ENABLED to make the ad eligible for delivery. |\n","| creative | Required. |\n","| advertisedProduct.productId | Required. The product to advertise. |\n","| advertisedProduct.productIdType | Required. ASIN or SKU. |\n","| spotlightVideos.optimizeText | Required on create. Optional on update. |\n","| spotlightVideos.videos | Required on create. One to five video objects. |\n"],"documentType":"guide"},{"title":"Create video ad extensions","sectionHeader":{"type":2,"text":"Add video to an existing ad"},"path":"/en-us/guides/sponsored-products/ad-extensions/create-video-ad-extension","content":[" Call POST /adsApi/v1/update/ads to set the spotlight video creative on an ad that already exists. Send the assetId and assetVersion values returned when you registered the asset.\n"," The following fields apply to spotlight video creative:\n","| Field | Description |\n","\\| --- \\| --- \\|\n","| adId | Required. The identifier of the ad that receives the video. |\n","| spotlightVideos.optimizeText | Optional. Set to true to let Amazon optimize headlines and descriptions. |\n","| spotlightVideos.videos | Required when you attach or replace video creative. One to five video objects. |\n","| videos\\[].assetId | Required. The Creative Asset Library identifier for the video. |\n","| videos\\[].assetVersion | Required. The asset version returned during registration. |\n","| videos\\[].headline | Required. The feature title shown on the thumbnail. Maximum 15 characters. |\n","| videos\\[].description | Optional. The feature description. |\n"],"documentType":"guide"},{"title":"Create video ad extensions","sectionHeader":{"type":2,"text":"Creative text limits"},"path":"/en-us/guides/sponsored-products/ad-extensions/create-video-ad-extension","content":[" The API enforces a maximum of 15 characters on each headline and 55 characters on each description. A request that exceeds either limit fails validation. Creative review applies additional guidance that the API does not check: keep each headline to 3 words and each description to 6 words.\n"],"documentType":"guide"},{"title":"Create video ad extensions","sectionHeader":{"type":2,"text":"Response"},"path":"/en-us/guides/sponsored-products/ad-extensions/create-video-ad-extension","content":[" Both operations return 207 with success, partialSuccess, and error arrays. Each entry in all three arrays carries an index that maps to the position of the ad in the request. Read all three, because a request can be partially applied.\n"],"documentType":"guide"},{"title":"Create video ad extensions","sectionHeader":{"type":2,"text":"Confirm that the extension exists"},"path":"/en-us/guides/sponsored-products/ad-extensions/create-video-ad-extension","content":[" Call POST /adsApi/v1/query/adExtensions to read the extension for the ad.\n"," A state value of ENABLED confirms that the extension is active. Amazon reviews all video creative before it serves, and the first review typically completes within 48 to 72 hours.\n"],"documentType":"guide"},{"title":"Create video ad extensions","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/sponsored-products/ad-extensions/create-video-ad-extension","content":[" Once video creative is attached, you can read delivery state, pause video, and replace creative.\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":null,"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":2,"text":"How video ad extensions work"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[" A video ad extension holds the finished video that serves in a Sponsored Products ad. Amazon assembles that video from the clips you upload, and renderedAssetId identifies the assembled result. Three operations manage the extension after it exists. Query the extension to read delivery state, update the extension to pause or resume video, and update the ad to change the source clips.\n"," The extension is a child of the ad. Deleting or archiving the ad removes the extension with it.\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[" To manage an extension, you must first attach video creative to an existing ad. For instructions, see Create video ad extensions.\n"," You also need a profile ID for the Amazon-Advertising-API-Scope header, and one of the following permissions: advertiser_campaign_edit or advertiser_campaign_view. Changing creative requires advertiser_campaign_edit.\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":2,"text":"Best practices"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":["Query before you update creative: The spotlightVideos.videos array replaces the existing array rather than appending to it. Read the current list, merge your changes, then send the complete array.  Read state together with status: The state field reports the value that you set. The status.deliveryStatus field reports whether video is serving, and status.deliveryReasons explains why it is not.  Pause instead of removing creative: Setting state to PAUSED stops video and keeps the ad serving as an image. Removing creative discards the assembled video and requires a new creative review.  Batch related updates: Batching reduces the number of calls and lowers the chance of throttling. Each endpoint has its own limit: POST /adsApi/v1/update/adExtensions accepts up to 50 extensions, and POST /adsApi/v1/update/ads accepts up to 1000 ads.  Allow time for creative review: Video does not serve until review completes. An initial review typically completes within 48 to 72 hours.\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":2,"text":"Query extension state"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[" If you are copying the sample, be sure to enter your own client ID, access token, ad ID, and profile ID.\n"," Every filter requires an include array. A bare array is not accepted.\n","| Field | Description |\n","\\| --- \\| --- \\|\n","| adExtensionTypeFilter.include | Use VIDEO for video extensions. |\n","| adProductFilter.include | Use SPONSORED_PRODUCTS for Sponsored Products ads. |\n","| stateFilter.include | Accepts ENABLED, PAUSED, and ARCHIVED. |\n","| adIdFilter.include | Optional. Omit this filter to return all extensions on the profile. |\n","| adGroupIdFilter.include | Optional. Filters by ad group identifier. |\n","| adExtensionIdFilter.include | Optional. Filters by extension identifier. |\n","| adExtensionStatusFilter.include | Optional. Accepts OPTED_OUT, which indicates that the advertiser has opted out of the extension. |\n","| maxResults | Optional. Defaults to 1000, which is also the maximum. |\n","| nextToken | Optional. The pagination token returned by a previous response. |\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[" A successful response returns a 200 response code and one object for each extension. Use nextToken to page through large result sets until the response omits the token.\n"," The renderedAssetId field identifies the video asset rendered in the ad. The videoType field identifies how Amazon assembles the creative. Spotlight video reports SPOTLIGHT.\n"," The deliveryStatus field draws from a shared enum with four values: DELIVERING, NOT_DELIVERING, LIMITED, and UNAVAILABLE. Video ad extensions report DELIVERING or NOT_DELIVERING, because LIMITED applies to resources that span multiple marketplaces.\n"," An empty adExtensions array means that no extension on the profile matched your filters. Confirm that adExtensionTypeFilter includes VIDEO, and widen stateFilter to include ENABLED, PAUSED, and ARCHIVED.\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":2,"text":"Pause and resume video"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[" Send PAUSED to stop video without stopping the ad. Send ENABLED in the same request shape to resume video delivery. A single request accepts up to 50 extensions.\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[" A successful response returns a 207 response code. A paused extension reports deliveryStatus as NOT_DELIVERING with AD_EXTENSION_PAUSED in deliveryReasons. The ad continues to serve as a standard image.\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":2,"text":"Update video creative"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[" Use this operation to change headlines, change descriptions, or replace video assets. You do not need to recreate the ad or the extension.\n"," To add a video without removing the existing videos, follow this sequence:\n","Call POST /adsApi/v1/query/ads to read the current video list for the ad. 2. Merge the new video objects into the list that you retrieved. 3. Send the complete merged array in spotlightVideos.videos.\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[" A successful response returns a 207 response code. The success array returns the updated ads, the partialSuccess array returns ads whose update was applied in part, and the error array contains any error messages. All three arrays carry an index that maps to the position of the ad in the request. Read all three, because a partial failure returns entries in more than one array.\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":2,"text":"Creative review"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[" Amazon reviews all video creative before it serves. Initial review typically completes within 48 to 72 hours. A resubmission typically completes within 24 to 48 hours.\n"," Check approval status and rejection reasons in the campaign manager. The API does not expose a review status endpoint for video ad extensions.\n","| Reason | Fix |\n","\\| --- \\| --- \\|\n","| Still images presented as video | Use recorded video footage instead of a sequence of static images. |\n","| Black bars on the sides of the video | Supply 16:9 horizontal video, 1920x1080 recommended. |\n","| Headline too long | Keep the headline to 3 words. The API rejects a value longer than 15 characters before it reaches review. |\n","| Description too long | Keep the description to 6 words. The API rejects a value longer than 55 characters before it reaches review. |\n","| Creative policy violation | Review the Amazon Ads creative acceptance policies and resubmit. |\n"],"documentType":"guide"},{"title":"Manage video ad extensions","sectionHeader":{"type":2,"text":"Error handling"},"path":"/en-us/guides/sponsored-products/ad-extensions/manage-video-ad-extensions","content":[" The ad extensions operations return the following errors.\n","| HTTP status | code | Meaning |\n","\\| --- \\| --- \\| --- \\|\n","| 400 | BAD_REQUEST | A field in the request is missing or invalid. |\n","| 401 | UNAUTHORIZED | The access token is missing or expired. |\n","| 403 | FORBIDDEN | The profile lacks permission for this operation. |\n","| 404 | NOT_FOUND | The ad or the extension does not exist. |\n","| 413 | CONTENT_TOO_LARGE | The request exceeds the batch size limit. |\n","| 429 | TOO_MANY_REQUESTS | The request rate limit is exceeded. |\n","| 500 | INTERNAL_ERROR | An unexpected server error occurred. |\n"," The code values above come from a shared enum. A validation failure can also return a more specific code, such as FIELD_VALUE_IS_INVALID or RESOURCE_ID_NOT_FOUND. Match on the value that you receive rather than assuming one code for each status.\n"," An error response carries a code and a message. A multi-status response wraps each error in an errors array that can also carry fieldLocation.\n"," These operations also return 502, 503, and 504 during transient failures. Retry those with the same backoff strategy described below.\n"],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":null,"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[" Auto-assembled videos are assembled from existing uploaded video clips. No new content is generated using AI. As with any  Sponsored Products ad, advertisers are only charged when shoppers click on the video. \n"," Auto-assembled videos serve on eligible video placements. On all other placements, the same ad continues to render as a standard image. Your existing campaigns, budgets, bids, and targeting remain unchanged.\n"],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":2,"text":"Identifying auto-assembled videos"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[" Auto-assembled videos use the same VIDEO ad extension type as advertiser-uploaded videos. The videoType field distinguishes them:\n","| videoType | Description |\n","\\| --- \\| --- \\|\n","| SPOTLIGHT | Video creative uploaded by the advertiser. |\n","| AUTO_ASSEMBLED | Video creative generated by Amazon on behalf of the advertiser. |\n"],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":["Complete the onboarding process to register an application and apply for API access. - Request the advertising::campaign_management scope for your Login with Amazon application. - Identify the profile ID for the marketplace where your campaigns run. The profile ID is passed in the Amazon-Advertising-API-Scope header on every request.\n","\n"],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":2,"text":"Opt out of auto-assembled videos"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"How opt-out works"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[" All campaigns are opted in to auto-assembled videos by default. The optOuts structure on the Campaign entity allows advertisers to opt out at the campaign level. To opt out, add AUTO_ASSEMBLED to the optOuts.videoExtension list. To opt back in, send an empty list.\n","| Campaign state | optOuts value | Behavior |\n","\\| --- \\| --- \\| --- \\|\n","| Default (no optOuts stored) | null or absent | Opted in — Amazon may generate auto-assembled videos |\n","| Opted out | { \"videoExtension\": \\[\"AUTO_ASSEMBLED\"] } | Opted out — no auto-assembled videos created |\n","| Opted back in | { \"videoExtension\": \\[] } | Opted in — Amazon may generate auto-assembled videos |\n"],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Example — Opt out"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Example — Opt back in"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[" A successful response returns 207 with a success array and an error array. Each entry carries an index that maps to the position of the campaign in the request.\n","\n"],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":2,"text":"Query campaign opt-out status"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[" The response includes the optOuts field on each campaign. If optOuts is absent or videoExtension does not contain AUTO_ASSEMBLED, the campaign is opted in.\n","| Field | Description |\n","\\| --- \\| --- \\|\n","| optOuts | Optional. Absent or null means the campaign is opted in to all video extension types. |\n","| optOuts.videoExtension | List of VideoType values the campaign has opted out of. Maximum 2 values. |\n","\n"],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":2,"text":"Query auto-assembled video extensions"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[" Query video extensions across the profile. The API does not support filtering by videoType directly — filter the response client-side by keeping only extensions where adExtensionSettings.videoExtension.videoType equals AUTO_ASSEMBLED.\n"," Every filter requires an include array. A bare array is not accepted.\n"],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":[],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":3,"text":"Extension states"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":["| state | deliveryStatus | Meaning |\n","\\| --- \\| --- \\| --- \\|\n","| PROPOSED | NOT_DELIVERING | Video is pending advertiser review. Not yet serving. |\n","| ENABLED | DELIVERING | Video is serving on eligible placements. |\n","| PAUSED | NOT_DELIVERING | Video was paused by the advertiser. Ad serves as image. |\n","\n"],"documentType":"guide"},{"title":"Auto-assembled videos","sectionHeader":{"type":2,"text":"Error handling"},"path":"/en-us/guides/sponsored-products/auto-assembled-videos","content":["| HTTP status | code | Meaning |\n","\\| --- \\| --- \\| --- \\|\n","| 400 | BAD_REQUEST | A field in the request is missing or invalid. |\n","| 401 | UNAUTHORIZED | The access token is missing or expired. |\n","| 403 | FORBIDDEN | The profile lacks permission for this operation. |\n","| 429 | TOO_MANY_REQUESTS | The request rate limit is exceeded. |\n","| 500 | INTERNAL_ERROR | An unexpected server error occurred. |\n"," These operations also return 502, 503, and 504 during transient failures. Retry those with exponential backoff.\n"],"documentType":"guide"},{"title":"Creating keywords","sectionHeader":null,"path":"/en-us/guides/sponsored-products/keywords/overview","content":[" Learn more:\n","Getting started with keyword recommendations \\* Get started with keyword bid recommendations\n"],"documentType":"guide"},{"title":"Creating keywords","sectionHeader":{"type":2,"text":"Create a keyword"},"path":"/en-us/guides/sponsored-products/keywords/overview","content":[" Once you have the recommended keywords, you can create keywords to associate to a campaign and ad group.\n"],"documentType":"guide"},{"title":"Creating keywords","sectionHeader":{"type":3,"text":"Endpoint "},"path":"/en-us/guides/sponsored-products/keywords/overview","content":[],"documentType":"guide"},{"title":"Creating keywords","sectionHeader":{"type":3,"text":"Examples"},"path":"/en-us/guides/sponsored-products/keywords/overview","content":[" Standard \n"," Most advertisers should not use nativeLanguageLocale and should use the following request body structure:\n"," Using nativeLanguageLocale \n"," Advertisers who are advertising in other regions can use the nativeLanguageLocale and nativeLanguageKeyword parameters to specify the equivalent keyword in their preferred language for reporting purposes.\n"],"documentType":"guide"},{"title":"Sponsored Products keyword recommendations overview","sectionHeader":null,"path":"/en-us/guides/sponsored-products/keywords/suggestions","content":[" Sponsored Products keyword recommendations allow you to retrieve bid suggestions for keyword targets along with impact metrics for a given list of ASINs or a specified campaign identifier and associated ad group identifier. In the response, recommended keywords are ranked using your chosen sort dimension while providing bid suggestions for the keywords from different themes.\n"," There are currently three versions of the keywords recommendation resource: version 3, version 4, and version 5. If you have currently integrated with either version 3 or version 4, integrate with version 5 as soon as possible.\n"],"documentType":"guide"},{"title":"Sponsored Products keyword recommendations overview","sectionHeader":{"type":2,"text":"Version 3"},"path":"/en-us/guides/sponsored-products/keywords/suggestions","content":[" Version 3 introduced keyword recommendations and allowed the retrieval of recommendations either for a given list of ASINs or a specified campaign identifier and associated ad group identifier. The response supported sorting by either the clicks, conversions, or default dimensions.\n"],"documentType":"guide"},{"title":"Sponsored Products keyword recommendations overview","sectionHeader":{"type":2,"text":"Version 4"},"path":"/en-us/guides/sponsored-products/keywords/suggestions","content":[" Version 4 includes all the features of version 3, but adds search term metrics. Search term impression share indicates the percentage share of all ad-attributed impressions you received on that keyword in the last 30 days. This metric helps advertisers identify potential opportunities based on their share on relevant keywords. Search term impression rank indicates your ranking among all advertisers for the keyword by ad impressions in a marketplace. It tells an advertiser how many advertisers had higher share of ad impressions. Search term information is only available for keywords the advertiser targeted with ad impressions.\n"],"documentType":"guide"},{"title":"Sponsored Products keyword recommendations overview","sectionHeader":{"type":2,"text":"Version 5"},"path":"/en-us/guides/sponsored-products/keywords/suggestions","content":[" Version 5 includes all the features of version 4 and adds theme-based bid recommendations that return improved bid recommendations for each keyword. Theme-based bid recommendations provide themes and impact metrics along with each bid suggestion to help you choose the right bid for your keyword target. Version 5 also adds impact metrics that include insights on the increase in clicks and purchase orders with bid values, helping you choose the right bid for your targets. The response includes three suggested bids for each keyword. The resource includes three sets of impact metrics aggregated at the ad group level associated with each of the low, median, and high bids, respectively.  Note that impact metrics are based on historic performance of similar products to provide guidance on choosing a bid, and are not estimates of expected performance. Also, impact metrics are computed on the assumption that a campaign has not run out of budget. Version 5 provides bids along with historic impact metrics of weekly clicks and purchase orders to provide guidance on which bid to choose. The suggested bids are returned at the keyword level, and the impact metrics are aggregated at the ad group level.\n"," The impact metrics reflect performance aggregated across all the recommended keywords in the response. If you want to see the impact metrics only for a select subset of the keywords, you can use the keyword recommendations service with this subset only to receive bids and impact metrics for this set. Alternately, you can also request to receive top N keywords when ordered by the dimensions (conversions and clicks) which will return metrics corresponding to only this set of N keywords. \n"],"documentType":"guide"},{"title":"Sponsored Products keyword recommendations overview","sectionHeader":{"type":2,"text":"Getting started with Sponsored Products keyword recommendations"},"path":"/en-us/guides/sponsored-products/keywords/suggestions","content":[" The POST /sp/targets/keywords/recommendations resource retrieves recommended keyword targets given either a list of ad ASINs or a specified campaign identifier and associated ad group identifier. In the request, specify this choice using the recommendationType field.\n"," In the response, keyword recommendations are ranked in descending order of clicks or impressions, depending on the value that the sortDimension field is set to in the request. This may be one of clicks, conversions, or default.  \n"," Note that you can include your own keyword targets to be ranked alongside the keyword recommendations by using the targets array in your request body.\n"," Finally, use the locale field to localize keywords to the specified locale. Supported marketplace to locale mappings can be retrieved using the /keywords/localize resource. \n"],"documentType":"guide"},{"title":"Sponsored Products keyword recommendations overview","sectionHeader":{"type":2,"text":"Examples"},"path":"/en-us/guides/sponsored-products/keywords/suggestions","content":[" To get keyword recommendations for a new ad group, sort the keywords by clicks, and use \"Dynamic Bidding - Up and Down.\"\n"," Request body:\n"," Response body:\n"," To get keyword recommendations for a new ad group, sort the keywords by conversions, use fixed bidding, and see how your own keywords perform against the suggested keywords.\n"," Request body:\n"," Response:\n"," To get two keyword recommendations for an existing ad group and sort the keywords using the default ranking heuristic, but without bid suggestions.\n"," Request body:\n"," Response:\n"],"documentType":"guide"},{"title":"Sponsored Product keyword groups targeting","sectionHeader":null,"path":"/en-us/guides/sponsored-products/keyword-group-targeting","content":[" Keyword Groups targeting automatically identifies and targets highly relevant keyword targets for ads. Keyword Groups targeting is based on specified product ASINs and continuously refreshes them over time to maximize ad performance.\n"],"documentType":"guide"},{"title":"Sponsored Product keyword groups targeting","sectionHeader":{"type":2,"text":"Retrieve list of recommended keyword groups"},"path":"/en-us/guides/sponsored-products/keyword-group-targeting","content":[" The Keyword Groups recommendations API uses the product ASINs as input and returns suggested Keyword Groups to target.\n"," Endpoint: /sp/targeting/recommendations/keywordGroups\n"],"documentType":"guide"},{"title":"Sponsored Product keyword groups targeting","sectionHeader":{"type":3,"text":"Parameters"},"path":"/en-us/guides/sponsored-products/keyword-group-targeting","content":["|Name\t|Optional\t|Type\t|Location\t|Description\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|asins\t|No\t|List\t|Body\t|A list of Strings representing the ASINs for which you want to get Keyword Groups recommendations.\t|\n","|locale\t|Yes\t|String\t|Header\t|User specified locale. If nothing is passed the default for the marketplace will be used. The value should conform to the IETF BCP 47 standard, using language tags composed of language- and optionally region specific sub-tags (for example, en-us for American English and fr-CA for Canadian French).\t|\n"],"documentType":"guide"},{"title":"Sponsored Product keyword groups targeting","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/sponsored-products/keyword-group-targeting","content":[],"documentType":"guide"},{"title":"Sponsored Product keyword groups targeting","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/keyword-group-targeting","content":[],"documentType":"guide"},{"title":"Creating product and category targeting expressions","sectionHeader":null,"path":"/en-us/guides/sponsored-products/product-targeting/overview","content":[" Manual Sponsored Products campaigns require you to add at least one targeting clause. You can either use keyword targeting or product targeting (discussed in this document). Targeting is assigned at the ad group level. All products in an ad group will share targeting clauses. \n"," Product targeting can be applied at either the product, category, or brand level. For example, you can target a specific running shoe product by ASIN, or running shoes as a category using the category ID. \n"," You can learn more about campaign structure in Campaign hierarchy.\n"],"documentType":"guide"},{"title":"Creating product and category targeting expressions","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/product-targeting/overview","content":[" Before creating product targeting expressions, you need to\n","Create a manual campaign  Create an ad group  Create at least one product ad in each ad group  Get recommendations for what ASINs to target (optional)  Get recommendations for what categories to target (optional)\n"],"documentType":"guide"},{"title":"Creating product and category targeting expressions","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/sponsored-products/product-targeting/overview","content":[],"documentType":"guide"},{"title":"Creating product and category targeting expressions","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/product-targeting/overview","content":[],"documentType":"guide"},{"title":"Creating product and category targeting expressions","sectionHeader":{"type":3,"text":"Targeting individual products"},"path":"/en-us/guides/sponsored-products/product-targeting/overview","content":[" When you target individual products, you can choose to target a specific ASIN exactly, or target a specific ASIN and other similar ASINs, including substitutes, complements, and other related products. You can learn more about expanded ASIN targeting in the advertising console help center.\n"," One ASIN\n"," This example creates a product targeting expression for ASIN B07FKDZPZW.\n"," Multiple ASINs\n"," You can only add one ASIN per targeting clause. If you want to target multiple ASINs, you should create two targeting clauses. \n"," ASIN and related products\n"," This example creates a targeting expression for ASIN B07YT8NVF9, as well as other related ASINs.\n"],"documentType":"guide"},{"title":"Creating product and category targeting expressions","sectionHeader":{"type":3,"text":"Targeting product categories"},"path":"/en-us/guides/sponsored-products/product-targeting/overview","content":[" Creating targeting expressions for product categories supports more refinements than expressions for a single ASIN.\n"," Category without refinements\n"," This example shows the expression to target an entire category with no refinements. \n"," Category with refinements\n"," This example shows how to create a targeting expression with multiple refinements (brand and rating between). When using refinements, you must first define the category.\n"],"documentType":"guide"},{"title":"Creating product and category targeting expressions","sectionHeader":{"type":2,"text":"Response"},"path":"/en-us/guides/sponsored-products/product-targeting/overview","content":[" A successful request results in a 207 response that contains individual status messages for each targeting clause you created. You should check that the success array contains all objects you intended to create. Any failures are indicated in the error array. \n"," For category targeting expressions that contain an ID (category ID, brand ID, age range ID, or genre ID), the resolved expression object contains a readable description related to the ID.\n"],"documentType":"guide"},{"title":"Creating product and category targeting expressions","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/product-targeting/overview","content":[],"documentType":"guide"},{"title":"Product targeting suggestions","sectionHeader":null,"path":"/en-us/guides/sponsored-products/product-targeting/suggestions","content":[" If you do not know what products to target, Amazon can recommend products based on the ASINs you are advertising. \n"],"documentType":"guide"},{"title":"Product targeting suggestions","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/sponsored-products/product-targeting/suggestions","content":[" You can either request recommendations by theme or by ASIN. Recommendations by theme returns a list of themes (for example, similar items or complementary items). Each theme includes a list of ASINs that fall into that category. Recommendations by ASIN returns a list of ASINs. Each ASIN includes an explanation of what theme it matches. See the examples below for more information. The type of response is determined by the value of the Accept header. \n"],"documentType":"guide"},{"title":"Product targeting suggestions","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/product-targeting/suggestions","content":[],"documentType":"guide"},{"title":"Product targeting suggestions","sectionHeader":{"type":3,"text":"By `ASIN`"},"path":"/en-us/guides/sponsored-products/product-targeting/suggestions","content":[],"documentType":"guide"},{"title":"Product targeting suggestions","sectionHeader":{"type":3,"text":"By theme"},"path":"/en-us/guides/sponsored-products/product-targeting/suggestions","content":[" You can then use the recommendations to create a targeting expression. \n"],"documentType":"guide"},{"title":"Category targeting suggestions and refinements","sectionHeader":null,"path":"/en-us/guides/sponsored-products/product-targeting/category-suggestions-refinements","content":[" Category targeting allows you to target entire categories of products. There are various refinements available to filter the categories. \n"],"documentType":"guide"},{"title":"Category targeting suggestions and refinements","sectionHeader":{"type":2,"text":"Get all categories"},"path":"/en-us/guides/sponsored-products/product-targeting/category-suggestions-refinements","content":[" If you have not done category targeting before, you first need to understand what categories are available.  \n"],"documentType":"guide"},{"title":"Category targeting suggestions and refinements","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/product-targeting/category-suggestions-refinements","content":[],"documentType":"guide"},{"title":"Category targeting suggestions and refinements","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/product-targeting/category-suggestions-refinements","content":[" The response returns a tree of all categories currently available on Amazon.com.\n"],"documentType":"guide"},{"title":"Category targeting suggestions and refinements","sectionHeader":{"type":2,"text":"Get suggested categories"},"path":"/en-us/guides/sponsored-products/product-targeting/category-suggestions-refinements","content":[" You can also request suggested categories based on a list of ASINs. This endpoint takes a list of ASINs and returns related categories that you could target. Note that all inputted ASINs should be similar, as the recommendations are for all ASINs in the request.\n"],"documentType":"guide"},{"title":"Category targeting suggestions and refinements","sectionHeader":{"type":3,"text":"Endpoint "},"path":"/en-us/guides/sponsored-products/product-targeting/category-suggestions-refinements","content":[],"documentType":"guide"},{"title":"Category targeting suggestions and refinements","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/product-targeting/category-suggestions-refinements","content":[" The response includes any associated categories, as well as the minimum and maximum number of products in that category.\n"],"documentType":"guide"},{"title":"Category targeting suggestions and refinements","sectionHeader":{"type":2,"text":"Category refinements"},"path":"/en-us/guides/sponsored-products/product-targeting/category-suggestions-refinements","content":[" Categories may have refinements available that you can use to further target ASINs within a category. Possible refinements include brands, age ranges, and genres.\n"],"documentType":"guide"},{"title":"Category targeting suggestions and refinements","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/product-targeting/category-suggestions-refinements","content":[],"documentType":"guide"},{"title":"Category targeting suggestions and refinements","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/product-targeting/category-suggestions-refinements","content":[" The response includes any brands, age ranges, and genres associated with the category. Not all categories will have associated brands, age ranges, and genres. You can use the IDs in the response as part of your targeting expression.\n"],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":null,"path":"/en-us/guides/sponsored-products/auto-targeting","content":[" Auto targeting expressions let you choose different bids for groups of search terms and products within an auto targeting campaign.\n"," If you do not set up any auto targeting clauses, your ad group uses the default bid you assigned during ad group creation for all targeting. However, you can use auto targeting expressions to specify different bids for different types of targeting expressions.\n"],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":["Create an auto targeting campaign.\n","Create an ad group. After this step, four auto targeting expressions are automatically created.\n","Create at least one product ad in the ad group. \n"],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":2,"text":"Get target IDs"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":[" First you need to retrieve the target IDs for the auto targeting expressions created as part of your campaign. \n"],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":[],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":[" The response body should include all auto targeting expressions that were automatically created for your campaign and ad group. The targeting clauses do not contain a bid at this stage. \n"," Make a note of the targetId for each expression to use in future steps.\n"],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":2,"text":"Get bid recommendations"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":[" You can use theme-based bid recommendations to get suggested bids for each expression type. You will need to enter the campaignId and adGroupId. Your adGroupId should have a valid product ad child entity. \n"],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":[],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":3,"text":"Request"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":[],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":[" The response contains minimum, median, and maximum suggested bids for each type of targeting expression.\n"],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":2,"text":"Update bids for targeting expressions"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":[" Once you know what bid you would like to use for each auto targeting expression, you can update the bids.\n"],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":[],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":[],"documentType":"guide"},{"title":"Automatic targeting","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/sponsored-products/auto-targeting","content":["Add negative product targeting\n","Add negative keyword targeting\n"],"documentType":"guide"},{"title":"Negative keyword targeting","sectionHeader":null,"path":"/en-us/guides/sponsored-products/negative-targeting/keywords","content":[" Negative keywords help prevent ads from appearing on shopping results pages that do not meet your campaign objectives. Negative keyword targeting can be used at either the campaign level or ad group level. \n"],"documentType":"guide"},{"title":"Negative keyword targeting","sectionHeader":{"type":2,"text":"Campaign versus ad group-level negative keyword targeting"},"path":"/en-us/guides/sponsored-products/negative-targeting/keywords","content":[" When using negative keyword targeting at the campaign level, the targeting will apply to all ad groups created under that specific campaign. When the negative keyword targeting is done at the ad group level, it will only apply to that specific ad group. \n"],"documentType":"guide"},{"title":"Negative keyword targeting","sectionHeader":{"type":3,"text":"Endpoints"},"path":"/en-us/guides/sponsored-products/negative-targeting/keywords","content":[],"documentType":"guide"},{"title":"Negative keyword targeting","sectionHeader":{"type":2,"text":"Campaign level negative keyword creation"},"path":"/en-us/guides/sponsored-products/negative-targeting/keywords","content":[],"documentType":"guide"},{"title":"Negative keyword targeting","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/negative-targeting/keywords","content":[],"documentType":"guide"},{"title":"Negative keyword targeting","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/negative-targeting/keywords","content":[" A successful response will return a 207 that contains an error array for any errors present and a success array with the campaignNegativeKeywordId.\n"],"documentType":"guide"},{"title":"Negative keyword targeting","sectionHeader":{"type":2,"text":"Ad group level negative keyword creation"},"path":"/en-us/guides/sponsored-products/negative-targeting/keywords","content":[],"documentType":"guide"},{"title":"Negative keyword targeting","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-products/negative-targeting/keywords","content":[],"documentType":"guide"},{"title":"Negative keyword targeting","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-products/negative-targeting/keywords","content":[" A successful response will return a 207 that contains an error array for any errors present and a success array with the NegativeKeywordId.\n"],"documentType":"guide"},{"title":"Negative targeting","sectionHeader":null,"path":"/en-us/guides/sponsored-products/negative-targeting/product-brand","content":[" Both auto and manual Sponsored Products campaigns can use negative product targeting. Negative product targeting allows you to exclude certain products and brands from your targeting. You can learn more about negative product targeting in the advertising console documentation. \n"," You can create a negative targeting expression at either the ad group or campaign level. Any campaign-level negative product targeting expression will impact all ad groups using product targeting in the campaign. Negative product targeting is optional for all Sponsored Products campaigns.\n"," You can learn more about campaign structure in Campaign hierarchy.\n"],"documentType":"guide"},{"title":"Negative targeting","sectionHeader":{"type":2,"text":"Endpoints"},"path":"/en-us/guides/sponsored-products/negative-targeting/product-brand","content":[],"documentType":"guide"},{"title":"Negative targeting","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/negative-targeting/product-brand","content":[" Before creating product targeting expressions, you need to:\n","Create a manual or auto campaign\n","Create an ad group\n","Create at least one product ad\n","Add product or keyword targeting (manual campaigns only)\n"],"documentType":"guide"},{"title":"Negative targeting","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/sponsored-products/negative-targeting/product-brand","content":[],"documentType":"guide"},{"title":"Negative targeting","sectionHeader":{"type":3,"text":"Examples"},"path":"/en-us/guides/sponsored-products/negative-targeting/product-brand","content":[],"documentType":"guide"},{"title":"Negative targeting","sectionHeader":{"type":2,"text":"Response"},"path":"/en-us/guides/sponsored-products/negative-targeting/product-brand","content":[" A successful request results in a 207 response that contains individual status messages for each targeting clause you created. You should check that the success array contains all objects you intended to create. Any failures are indicated in the error array. \n"],"documentType":"guide"},{"title":"Budget recommendations & missed opportunities","sectionHeader":null,"path":"/en-us/guides/sponsored-products/budget-recommendations-and-missed-opportunities","content":[" The budget recommendations resource returns the recommended daily budget and estimated missed opportunities metrics for campaigns.\n"," This resource returns the following metrics: \n","Recommended daily budget - Estimated budget needed to keep the campaign in budget for the full 24-hour period. Consider this budget to minimize the chances of the campaign running out of budget. 2. Percent time in budget - The share of time the campaign was in budget during the past seven days. 3. Estimated missed impressions, clicks and sales for all campaigns - These are the estimated additional impressions, clicks and sales the campaign might have generated if it had adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual impressions, clicks, and sales.\n"],"documentType":"guide"},{"title":"Budget recommendations & missed opportunities","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/budget-recommendations-and-missed-opportunities","content":[" We recommend waiting until a campaign has been active nine days to use this endpoint.\n"],"documentType":"guide"},{"title":"Budget recommendations & missed opportunities","sectionHeader":{"type":2,"text":"Endpoint"},"path":"/en-us/guides/sponsored-products/budget-recommendations-and-missed-opportunities","content":[],"documentType":"guide"},{"title":"Budget recommendations & missed opportunities","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/sponsored-products/budget-recommendations-and-missed-opportunities","content":[" A list of campaignIds is needed for the request body. \n"],"documentType":"guide"},{"title":"Budget recommendations & missed opportunities","sectionHeader":{"type":2,"text":"Response"},"path":"/en-us/guides/sponsored-products/budget-recommendations-and-missed-opportunities","content":[" Scenario 1: A successful response with a suggested budget as well as the estimated missed impressions, clicks, and sales. In the budgetRuleRecommendation object, you can see the suggested budget increase percentage for a specific budget rule. This object will only be populated if at least one budget rule has been created. \n"," Scenario 2: A successful response with a suggested budget but with no estimated missed impressions, clicks, or sales. Since the percentTimeInBudget parameter value is not less than one, the campaign is in budget and there are no missed opportunities. \n"," Scenario 3: A successful response but with null suggested budget, missed opportunities, and budget rule recommendation. This means that there is not enough historical data to make a recommendation. \n"],"documentType":"guide"},{"title":"Budget recommendations & missed opportunities","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/sponsored-products/budget-recommendations-and-missed-opportunities","content":[],"documentType":"guide"},{"title":"Theme-based bid suggestions - Quick-start guide","sectionHeader":null,"path":"/en-us/guides/sponsored-products/bid-suggestions/theme-based-bid-suggestions-quickstart-guide","content":[],"documentType":"guide"},{"title":"Theme-based bid suggestions - Quick-start guide","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/sponsored-products/bid-suggestions/theme-based-bid-suggestions-quickstart-guide","content":[" Theme-based bid suggestions delivers suggestions and impact metrics for multiple themes, allowing you to choose a bid from a theme that is best aligned with your campaign. \n"," The first theme released offers bid suggestions to generate sales, and the impact metrics are weekly clicks and purchase orders received by similar products. The bid suggestions are calculated from a group of recent winning bids for similar products, updated periodically to reflect the marketplace changes. Bid suggestions will use the local currency of the marketplace that the API endpoint is associated with. \n"],"documentType":"guide"},{"title":"Theme-based bid suggestions - Quick-start guide","sectionHeader":{"type":2,"text":"Impact metrics"},"path":"/en-us/guides/sponsored-products/bid-suggestions/theme-based-bid-suggestions-quickstart-guide","content":[" With these new impact metrics, you can look at the increase in clicks and purchase orders with bid values to choose the right bid for your targets. \n"," To receive the metrics for keyword targeting, the API must be called with a minimum number of five keywords per ad group. The response includes three suggested bids for each keyword. In addition, the response includes three sets of impact metrics aggregated at the ad group level associated with each of the low, median, and high bids, respectively. \n"," The request and response for automatic targeting work similarly, but there is no minimum requirement on the number of match types selected. The impact metrics are based on historic performance of similar products to provide guidance on choosing a bid, and are not estimates of expected performance. They are also computed assuming your campaign does not run out of budget. \n"],"documentType":"guide"},{"title":"Theme-based bid suggestions - Quick-start guide","sectionHeader":{"type":2,"text":"Frequently asked questions"},"path":"/en-us/guides/sponsored-products/bid-suggestions/theme-based-bid-suggestions-quickstart-guide","content":[" The current bid suggestion service provides bids with no supporting impact metrics. Theme-based bid suggestions provides bids along with historic impact metrics of weekly clicks and purchase orders to provide guidance on which bid to choose. The suggested bids are returned at the targeting clause level, and the impact metrics are aggregated at the ad group level.\n"," Theme-based bid suggestions is being released in open beta now. The current service will be deprecated in the future, but we will provide months of advance notice before this happens. During this period, both the current service and the new theme-based bid suggestions will be active and supported. However, we will no longer release any feature improvements in the current bid suggestion service. We encourage you to try out the new theme-based bid suggestions and benefit from the improved functionality.\n"," Theme-based bid suggestions support both new campaigns and existing campaigns. Bids that are already set in campaigns will not be impacted by the new suggestions. You would need to adopt the bids from theme-based bid suggestions to impact campaigns.\n"," No, there are no new reports that need to be used with this feature. You can use the Search Term Report, Campaign Performance Report, and Impression Rank report to get the regular advertising metrics you access today.\n"],"documentType":"guide"},{"title":"Theme-based bid suggestions - Quick-start guide","sectionHeader":{"type":2,"text":"Code samples"},"path":"/en-us/guides/sponsored-products/bid-suggestions/theme-based-bid-suggestions-quickstart-guide","content":[" SP campaigns: Name - ThemeBasedBidRecommendation, URL - /sp/targets/bid/recommendations, Method – POST\n"],"documentType":"guide"},{"title":"Theme-based bid suggestions - Quick-start guide","sectionHeader":{"type":3,"text":"Scenario 1: You want to receive bid suggestions and impact metrics for a new automatic targeting campaign."},"path":"/en-us/guides/sponsored-products/bid-suggestions/theme-based-bid-suggestions-quickstart-guide","content":[],"documentType":"guide"},{"title":"Theme-based bid suggestions - Quick-start guide","sectionHeader":{"type":3,"text":"Scenario 2:  You want to receive bid suggestions and impact metrics for a new keyword targeting campaign."},"path":"/en-us/guides/sponsored-products/bid-suggestions/theme-based-bid-suggestions-quickstart-guide","content":[],"documentType":"guide"},{"title":"Theme-based bid suggestions - Quick-start guide","sectionHeader":{"type":3,"text":"Scenario 3: You want to receive bid suggestions and impact metrics for an existing automatic targeting ad-group."},"path":"/en-us/guides/sponsored-products/bid-suggestions/theme-based-bid-suggestions-quickstart-guide","content":[" Same as scenario 1 response.\n"],"documentType":"guide"},{"title":"Theme-based bid suggestions - Quick-start guide","sectionHeader":{"type":3,"text":"Scenario 4: You want to receive bid suggestions and impact metrics for an existing keyword targeting ad group."},"path":"/en-us/guides/sponsored-products/bid-suggestions/theme-based-bid-suggestions-quickstart-guide","content":[],"documentType":"guide"},{"title":"Creating Sponsored Products target promotions","sectionHeader":null,"path":"/en-us/guides/sponsored-products/target-promotion","content":[" Target promotion is a performance advertising strategy that identifies targets for further refinement to drive more efficient spend against high-performing targets and reduce spend on low-performing targets across all campaigns at scale. This combines the common practice of target harvesting, which identifies targets to move from broader targeting (for example, automatic targeting) to more focused targeting (for example, manual targeting with broad match), with optimized bids and budget changes.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products target promotions","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-products/target-promotion","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in this tutorial.\n"],"documentType":"guide"},{"title":"Creating Sponsored Products target promotions","sectionHeader":{"type":2,"text":"Examples"},"path":"/en-us/guides/sponsored-products/target-promotion","content":[" Endpoint: POST /sp/targetPromotionGroups\n"," This endpoint creates a target promotion group and an associated manual keyword targeting campaign, ad group, and ads, as well as an associated manual product targeting campaign, ad group, and ads, based on the adGroupId of the given auto-targeting campaign and the selection of adIds.\n"," Additionally, you can use this endpoint to create a target promotion group by specifying ad groups of an existing manual targeting campaign to associate with a matching auto-targeting ad group. The match is based on the products (ASIN/SKU) in the ads of the auto-targeting ad group.\n"," Request for creating new manual targeting campaigns: \n"," Request to associate an existing manual targeting campaign ad group with an auto-targeting campaign ad group:\n"," Response:\n"," Endpoint: POST /sp/targetPromotionGroups/recommendations\n"," This endpoint returns the target recommendations for a combination of advertiser, marketplace, and any of these filters: adGroupId, adId, and campaignId filter.\n"," In this example, we are filtering results by adId:\n"," Response:\n"," Endpoint: POST /sp/targetPromotionGroups/list\n"," This endpoint returns the target promotion groups for an advertiser, marketplace, and any of these filters: targetPromotionGroupId, adGroupId, and campaignId filter.\n"," In this example, we are filtering results by adGroupId:\n"," Response:\n"," Endpoint: POST /sp/targetPromotionGroups/targets\n"," This endpoint assigns keyword and/or product targets to the respective manual targeting ad groups within the specified target promotion group.\n"," Request:\n"," Response:\n"," Endpoint: POST /sp/targetPromotionGroups/targets/list\n"," This endpoint retrieves targets created through target promotion group APIs for a specific advertiser and marketplace, and allows filtering by targetPromotionGroupID, adGroupID, and campaignID.\n"," In this example, we are filtering results by targetPromotionGroupId:\n"," Response:\n"],"documentType":"guide"},{"title":"Sponsored Brands overview","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/overview","content":[" Sponsored Brands gives advertisers the ability to use different ad formats to showcase a brand. Sponsored Brands is available to vendors and sellers. Depending on your campaign objectives and ad format, you can choose between manual collection, automatic collection, store spotlight, or video.\n"],"documentType":"guide"},{"title":"Sponsored Brands overview","sectionHeader":{"type":2,"text":"Campaign management"},"path":"/en-us/guides/sponsored-brands/overview","content":[" To learn more about using the product-specific Sponsored Brands API to create and manage Sponsored Brands campaigns, visit the pages below:\n","Campaign structure  Creating a campaign  Full API reference \\* Postman collection\n"],"documentType":"guide"},{"title":"Sponsored Brands overview","sectionHeader":{"type":2,"text":"Reporting"},"path":"/en-us/guides/sponsored-brands/overview","content":[" The Ads API reporting functionality provides a variety of reports to help you retrieve historical impression, click, cost, and conversion data for your Sponsored Brands campaigns.\n"," Learn more: \n","Report types \\* Getting started with reports\n"],"documentType":"guide"},{"title":"Sponsored Brands overview","sectionHeader":{"type":2,"text":"Campaign status mapping between Sponsored Brands v4 API and advertising console"},"path":"/en-us/guides/sponsored-brands/overview","content":[" This table provides mapping of the Sponsored Brands v4 campaign creation servingStatus and how it correlates with the campaign status in the advertising console.\n","| SBv4 serving status                              | Description                                                               | Advertising console status |\n","\\|--------------------------------------------------\\|---------------------------------------------------------------------------\\|-------------------\\|\n","| ADVERTISER_STATUS_ENABLED                        | The status of the advertiser is enabled.                                        | enabled           |\n","| ADVERTISER_POLICING_PENDING_REVIEW               | The advertiser is pending review because of a policing reason.             | paused            |\n","| ADVERTISER_POLICING_SUSPENDED                    | The status of the advertiser is suspended because of a policing reason.         | paused            |\n","| ADVERTISER_PAUSED                                | The status of the advertiser is paused.                                         | paused            |\n","| ADVERTISER_ARCHIVED                              | The status of the advertiser is archived.                                       | archived          |\n","| ADVERTISER_PAYMENT_FAILURE                       | The internal status of the advertiser is suspended.                             | paused            |\n","| ADVERTISER_ACCOUNT_OUT_OF_BUDGET                 | The advertiser is out of budget for all Sponsored Ads campaigns.           | paused            |\n","| ADVERTISER_OUT_OF_PREPAY_BALANCE                 | The advertiser is out of prepay balance for all Sponsored Ads campaigns.   | paused            |\n","| ADVERTISER_EXCEED_SPEND_LIMIT                   | The advertiser spends over the daily limit.                                | paused            |\n","| CAMPAIGN_STATUS_ENABLED                          | The status of the campaign is enabled.                                          | enabled           |\n","| CAMPAIGN_PAUSED                                  | The status of the campaign is paused.                                           | paused            |\n","| CAMPAIGN_ARCHIVED                                | The status of the campaign is archived.                                         | archived          |\n","| CAMPAIGN_INCOMPLETE                              | The campaign does not contain any ads or targeting clauses.                | paused            |\n","| CAMPAIGN_OUT_OF_BUDGET                           | The campaign is out of budget.                                             | paused            |\n","| PORTFOLIO_STATUS_ENABLED                         | The status of the portfolio is enabled.                                         | paused            |\n","| PORTFOLIO_PAUSED                                 | The status of the portfolio is paused.                                          | paused            |\n","| PORTFOLIO_ARCHIVED                               | The status of the portfolio is archived.                                        | archived          |\n","| PORTFOLIO_OUT_OF_BUDGET                          | The portfolio is out of budget.                                            | archived          |\n","| PORTFOLIO_PENDING_START_DATE                     | The start date of the portfolio is in the future.                               | paused            |\n","| PORTFOLIO_ENDED                                  | The end date of the portfolio is in the past.                                   | paused            |\n","| INELIGIBLE                                       | The ad offer is ineligible.                                                | paused            |\n","| ELIGIBLE                                         | The ad offer is eligible.                                                  | enabled           |\n","| ENDED                                            | The end date of the campaign is in the past.                                    | paused            |\n","| PENDING_REVIEW                                   | The campaign is pending review.                                            | paused            |\n","| PENDING_START_DATE                               | The start date of the campaign is in the future.                                | paused            |\n","| REJECTED                                         | The campaign is rejected by the moderation process.                        | paused            |\n","| UNKNOWN                                          | The serving status is unknown. Please contact us for support.              | paused            |\n"],"documentType":"guide"},{"title":"Sponsored Brands version 4 features and benefits","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/v4-features","content":[" On October 2022, Sponsored Brands introduced hierarchical version 4 campaigns, featuring multiple ad groups and ads. Prior to this launch, advertisers lacked the ability to create a Sponsored Brands advertising campaign aligned with their marketing strategy. The introduction of ad groups enhances flexibility, particularly for managing campaigns across programs, as both Sponsored Products and Sponsored Display already support ad groups. \n"],"documentType":"guide"},{"title":"Sponsored Brands version 4 features and benefits","sectionHeader":{"type":2,"text":"Key benefits"},"path":"/en-us/guides/sponsored-brands/v4-features","content":["Consolidate and simplify campaign structure in a way that works for you by creating ad groups that align with your marketing strategies and goals.  2. Goal based campaigns: The Sponsored Brands version 4 campaigns allow you to create goal based campaigns to help different brands prioritize different brand building goals depending on their marketing strategy and their brand building journey. You can create campaigns with new goals: \"drive page visits\" and \"grow brand impression share\", each with a unique set of campaign controls to achieve that goal. 3. Theme targeting: To help drive advertiser goals, theme targeting is a new method to control your campaign targeting. It uses machine learning algorithms to account for historical performance targets and brand interactions to create a large set of keywords. It then categorizes those keywords into relevant groups to use with your campaigns. Two targeting groups are currently available: \"Keywords related to your landing pages\" and \"Keywords related to your brand.\" These targeting groups are pre-selected to simplify the campaign creation process for advertisers. 4. Vertical videos: Advertisers can now launch vertical video campaigns with a Store as the landing page. Vertical video is available under \"Drive page visit\" goal, enabling advertisers to highlight a collection of one, two, or three advertised products. Under the \"Grow brand impression share\" goal, advertisers can launch a video campaign without, or with one, or two, or three advertised products. Shoppers clicking on an advertised product will visit the product detail page; shoppers clicking on any other ad element will visit the Store of the brand on Amazon.  5. Slideshow: Advertisers can create creative Slideshow ads, that will appear at the top of search results page. Slideshow ads are an extension of the existing lifestyle creative, with a carousel of 2-5 lifestyle images that auto-rotate. Shoppers can engage with the slideshow by pausing it at any point in time or switching between different images by making forward or backward swipes. 6. New reporting: Accessing a wide range of new metrics, including addToCartViews, newToBrandDetailPageViewViews, and newToBrandDetailPageViewClicks for Sponsored Brands version 4 campaigns.  7. Accessibility and editability: Supports creative edits for all ad formats and edit landing page URL. You can assign individual landing page URLs to each ad within the same ad group. You can update your ad group based campaign landing page URLs without recreating a new ad group or campaign. 8. Monitor performance of ad group campaigns with reports. You can easily retrieve reports at campaign, keywords, campaign placement, search terms, purchase product, and more using singular reporting version 3 APIs. You no longer need to run separate reporting for two Sponsored Brands version 3 and Sponsored Brands version 4 campaigns. 9. Make the most of testing based on your goals, whether that is building brand awareness, driving consideration, or increasing sales. You can test targeting against different ad formats or landing pages and measure the performance. Plus, you can test different versions of the same ad formats within the same ad group to get a better understanding of shopper behavior. 10. Use consistent strategies across sponsored ads to run your campaigns more effectively. The ad groups feature is also available for both Sponsored Products and Sponsored Display.\n"],"documentType":"guide"},{"title":"Sponsored Brands version 4 features and benefits","sectionHeader":{"type":2,"text":"Handling version 3 campaigns"},"path":"/en-us/guides/sponsored-brands/v4-features","content":[" The Sponsored Brands version 3 campaigns are in \"Lights On\" mode and have not received new advertiser features or new measurement metrics since October 2022. We highly recommend migrating these campaigns to version 4 campaigns using Sponsored Brands version 4 APIs or cloning them using the ad console. By migrating, you can enhance your campaigns and take advantage of these new capabilities. \n"],"documentType":"guide"},{"title":"Sponsored Brands version 4 features and benefits","sectionHeader":{"type":2,"text":"Feature availability"},"path":"/en-us/guides/sponsored-brands/v4-features","content":["|Feature group\t|Feature\t|Version 3\t|Version 4\t|\n","|---\t|---\t|---\t|---\t|\n","|Goal\t|BRAND_IMPRESSION_SHARE\t|Not Available\t|Available\t|\n","|\t|PAGE_VISIT\t|Not Available\t|Available\t|\n","|\t|Smart default\t|Not Available\t|Available\t|\n","|Cost type\t|CPC\t|Available\t|Available\t|\n","|\t|VCPM\t|Not Available\t|Available\t|\n","|Campaigns|Capability to create multiple ad groups and ads\t|Not Available\t|Available\t|\n","|Targeting\t|Keyword\t|Available\t|Available\t|\n","|\t|Product \t|Available\t|Available\t|\n","|\t|Theme \t|Not Available\t|Available\t|\n","|Ad format\t|Manual Collection\t|Not Available\t|Available\t|\n","|\t|Automatic Collection\t|Not Available\t|Available\t|\n","|\t|Store spotlight \t|Available\t|Available\t|\n","|\t|Brand video\t|Not Available\t|Available\t|\n","|\t|Vertical video\t|Not Available\t|Available\t|\n","|\t|Slideshow with custom images\t|Not Available\t|Available\t|\n","|Creatives\t|Creative edits\t|Product collection\t|Available for all ad creatives (manual collection, auto collection, store spotlight, video, brand video, multi-ASIN video, vertical video, slideshows)\t|\n","|\t|Landing Page Edits\t|Not Available\t|Available\t|\n","|Reporting\t|New metrics: addToCart, addToCartRate, eCPAddToCart, newToBrandDetailPageViews, newToBrandDetailPageViewRate, newToBrandECPDetailPageViews\t|Not Available\t|Available\t|\n","|\t|Support of ad group ID and ad ID in SB purchased product report\t|Not Available\t|Available\t|\n","|\t|Version 3 reporting\t|Not Available\t|Available\t|\n","|Amazon Marketing Stream\t|Amazon Marketing Stream\t|Not Available\t|Available\t|\n","|Authors\t|Manual Collection and Video\t|Not Available\t|Available\t|\n","|\t|Creative Edits\t|Not Available\t|Available\t|\n","|\t|Kindle Edition Normalized Page (KNEP) - Reads and Royalties metric\t|Not Available\t|Available\t|\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/features","content":[" This document lists descriptions and marketplace availability for all Sponsored Brands features.\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Campaigns"},"path":"/en-us/guides/sponsored-brands/features","content":[" Campaigns allow you to advertise your products in high-visibility placements on Amazon.com. For more information, see Sponsored Brands overview\n"," Relevant resource:\n","/sb/v4/campaigns\n"," Marketplace availability: All marketplaces.\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Ad groups"},"path":"/en-us/guides/sponsored-brands/features","content":[" This feature provides the ability to organize, manage, and track performance of the products within your campaign.\n"," Relevant resource:\n","/sb/v4/adGroups\n"," Marketplace availability: All marketplaces.\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Collections ad"},"path":"/en-us/guides/sponsored-brands/features","content":[" Collections let you feature 3-10 related products from your catalog in a single ad experience across high-visibility placements. With AI-powered automatic collections, Amazon dynamically curates the most relevant products for each shopper, while manual collections allow you to hand-pick your selection, see collections overview.\n"," Relevant resources:\n","/sb/v4/ads/autoCollection \\* /sb/v4/ads/manualCollection\n"," Marketplace availability:\n","North America: United States (US)  Europe: Germany (DE), United Kingdom (UK)  Asia Pacific: Japan (JP)\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Store spotlight ad"},"path":"/en-us/guides/sponsored-brands/features","content":[" Store spotlight ad type features a brand logo, a custom headline, and your Store on Amazon with at least three subpages. For more information, see store spotlight overview.\n"," Relevant resource:\n","/sb/v4/ads/storeSpotlight\n"," Marketplace availability: All marketplaces.\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Video and brand video ad"},"path":"/en-us/guides/sponsored-brands/features","content":[" Video ad type allows you to promote a single product and link that video to a product detail page. Brand video ad type promotes your brand and can link to your Store. For more information between both video formats, see video overview.\n"," Relevant resources:\n","/sb/v4/ads/video \\* /sb/v4/ads/brandVideo\n"," Marketplace availability: All marketplaces.\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Keyword targeting"},"path":"/en-us/guides/sponsored-brands/features","content":[" With keyword targeting, Amazon matches your keywords to the search terms of a customer and displays the branded headline and advertised products in your campaign.\n"," Relevant resource:\n","/sb/keywords\n"," Marketplace availability: All marketplaces. \n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Negative keyword targeting"},"path":"/en-us/guides/sponsored-brands/features","content":[" Negative keywords prevent your keyword targeted ads from displaying when the shopping queries of a shopper match your negative keywords.\n"," Relevant resource:\n","/sb/negativeKeywords\n"," Marketplace availability: All marketplaces.\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Product targeting"},"path":"/en-us/guides/sponsored-brands/features","content":[" Product targeting allows you to choose specific products, categories, brands, or other product features that are relevant to the product in your ad.\n"," Relevant resource:\n","/sb/targets\n"," Marketplace availability: \n","North America: United States (US), Canada (CA)  Europe: Germany (DE), Spain (ES), France (FR), Italy (IT), United Kingdom (UK), India (IN)  Asia Pacific: Japan (JP)\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Negative product targeting"},"path":"/en-us/guides/sponsored-brands/features","content":[" Negative product targeting allows you to exclude certain products and brands from your targeting.\n"," Relevant resource:\n","/sb/negativeTargets\n"," Marketplace availability:\n","North America: United States (US), Canada (CA)  Europe: Germany (DE), Spain (ES), France (FR), Italy (IT), United Kingdom (UK), India (IN)  Asia Pacific: Japan (JP)\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Theme-based targeting"},"path":"/en-us/guides/sponsored-brands/features","content":[" Theme-based targeting is a curated set of keywords that enable brands to simplify the campaign creation process and improve campaign performance through well-performing targets.\n"," Relevant resource:\n","/sb/themes\n"," Marketplace availability:\n","North America: United States (US), Canada (CA), Mexico (MX)  South America: Brazil (BR)  Europe: Germany (DE), Spain (ES), France (FR), Italy (IT), United Kingdom (UK), Belgium (BE), Poland (PL), Netherlands (NL), Sweden (SE), Turkey (TR)  Middle East: United Arab Emirates (AE), Saudi Arabia (SA), Egypt (EG)  Asia Pacific: Australia (AU), Japan (JP), India (IN), Singapore (SG)\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Exports"},"path":"/en-us/guides/sponsored-brands/features","content":[" Exports provide metadata on all configured campaigns, ad groups, targeting expressions, and more, depending on the campaign type. For more information, please see exports overview.\n"," Relevant resource:\n","/campaigns/export\n"," Marketplace availability: All marketplaces.\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Moderation"},"path":"/en-us/guides/sponsored-brands/features","content":[" The moderation API allows you to get the review process status of an ad or page to determine whether it was approved or if changes need to be made.\n"," Relevant resource:\n","/moderation/results\n"," Marketplace availability: All marketplaces.\n"],"documentType":"guide"},{"title":"Sponsored Brands features by marketplace","sectionHeader":{"type":2,"text":"Pre moderation"},"path":"/en-us/guides/sponsored-brands/features","content":[" The pre moderation API allows you to check different components of an ad or page to validate before submitting for moderation review. \n"," Relevant resource:\n","/premoderation\n"],"documentType":"guide"},{"title":"Campaign structure for Sponsored Brands","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/campaigns/structure","content":[" Creating Sponsored Brands campaigns using the Amazon Ads API requires making multiple calls to create the entities that make up a campaign. Campaigns require you to create, at minimum, a campaign, ad group, ad, and either keyword or product target.\n"," Refer to the diagram below to understand the campaign hierarchy.\n","Campaigns: Campaigns group your ads by their advertising budgets and dates.  Ad groups: Ad groups let you organize and manage your ads by brands, keywords, products, categories, ad formats, landing pages, or other classifications that tie to your goals. Please note that you can only include a single type of ad in each ad group.  Ads: Use ads to manage different variations of your creatives. An ad can have different creative formats including manual collection, auto collection, video or store spotlight.  Creative asset: Each ad can contain a mix of image and video creatives.  Keyword or product targeting: An ad group can use either keyword targeting or product targeting. Keyword targeting allows you to target specific customer search terms for which you want your ads to appear and optimize bids for each. Product targeting can be applied at either the product, category, or brand level.\n"," This example shows a campaign with two ad groups. In one ad group, there are two brand video ads each with a video creative as well as keyword targeting. In the other ad group, there are Manual and Automatic Collection ads each with a logo as well as keyword targeting.\n"],"documentType":"guide"},{"title":"Getting started with campaigns","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/campaigns/get-started-with-campaigns","content":[],"documentType":"guide"},{"title":"Getting started with campaigns","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/campaigns/get-started-with-campaigns","content":["Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in the tutorial. \\* Understand the structure of Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Getting started with campaigns","sectionHeader":{"type":3,"text":"Step 1: Create a campaign"},"path":"/en-us/guides/sponsored-brands/campaigns/get-started-with-campaigns","content":[" The first step is to create a campaign using the POST /sb/v4/campaigns endpoint. \n"," Bidding strategies can be specified at the campaign level. Bidding can be done automatically by Amazon to optimize bids for placements other than top of search or by specifying a custom bidding adjustment. \n"," Goal-based campaigns offer a streamlined campaign creation and management workflow to enhance your campaign performance. Each goal comes with a unique set of target and bid recommendations, designed to maximize success metrics and expand opportunities to display ads and reach potential customers on Amazon. \n"," Parameters to create goal-based campaigns\n","|Parameter\t|Optional\t|Description\t|Default\t|\n","|---\t|---\t|---\t|---\t|\n","|goal\t|Yes\t|The goal type of the campaign.  BRAND_IMPRESSION_SHARE - This goal will show your ads to shoppers searching for your brand.  PAGE_VISIT - This goal drives traffic to your landing and detail pages through all placements.   |PAGE_VISIT\t  |\n","|costType\t|Yes\t|The costType can be set to determine how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace CPC - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad. VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\t|CPC\t|\n","|smartDefault\t|Yes\t|The smartDefault parameter specifies a list of strategies for a campaign. Each element in smartDefault can be set to determine which default strategy to use. MANUAL - No default targeting is created. If MANUAL is added on the list, no other strategies are allowed on the list (the list must contain only one item). TARGETING - Theme targeting is automatically created when creating an ad group.\t|If no goal is present in request, MANUAL is set by default. If a goal is present, TARGETING is set by default. \t|\n"," Validation rules\n"," Both goal and costType parameters must be included in the request body in order to create a goal-based campaign. If the request body contains only one of these parameters, the response will return a validation error of INVALID_ARGUMENT. Depending on the goal, either a goal-based campaign focused on brand impression or driving traffic to your landing page and detail page is created along with a set of target and bid recommendations to improve campaign performance.\n","|Goal type\t|costType\t|Result\t|\n","|---\t|---\t|---\t|\n","|Not included in request\t|Not included in request\t|Default goal type is PAGE_VISIT with a costType of CPC\t|\n","|Not included in request\t|Included in request\t|INVALID_ARGUMENT error\t|\n","|Included in request\t|Not included in request\t|INVALID_ARGUMENT error\t|\n","|Included in request\t|Included in request\t|Creates a goal-based campaign\t|\n"," Sample request\n"," The smartDefault parameter with \\[\"TARGETING\"] value automatically creates theme-based targeting based on the goal selected. In this example, the theme targeting is created with a focus on brand impression. \n"," For goal type BRAND_IMPRESSION_SHARE, only costType VCPM is available. If you try to use costType CPC for goal type BRAND_IMPRESSION_SHARE, the following error will occur:\n"],"documentType":"guide"},{"title":"Getting started with campaigns","sectionHeader":{"type":3,"text":"Step 2: Create ad group"},"path":"/en-us/guides/sponsored-brands/campaigns/get-started-with-campaigns","content":[" Create at least one ad group using the POST /sb/v4/adGroups endpoint. Use the campaignId returned in step 1 to create your ad group.\n"," Sample request\n"," This sample request creates an ad group associated to one campaign. A successful call returns a 207 response code and indicates the adGroupId of the ad group created.\n"],"documentType":"guide"},{"title":"Getting started with campaigns","sectionHeader":{"type":3,"text":"Step 3: Upload and register assets"},"path":"/en-us/guides/sponsored-brands/campaigns/get-started-with-campaigns","content":[" You can upload and register a video or image asset prior to creating an ad by using the creative asset library API.\n"],"documentType":"guide"},{"title":"Getting started with campaigns","sectionHeader":{"type":3,"text":"Step 4: Create an ad"},"path":"/en-us/guides/sponsored-brands/campaigns/get-started-with-campaigns","content":[" Once you have the assetId from the previous step, you can create an ad. The ad types are collections, video, brand video and store spotlight. There has to be at least one ad in an ad group and an ad group cannot have more than one ad type.\n"," To learn more about the requirements for each ad type, see:\n","Collections  Video (including brand video)  Store spotlight\n"," Ad restrictions when using a brand impression share goal\n"," If you create a campaign with a goal of BRAND_IMPRESSION_SHARE, you must use one of the following creative types: \n","Manual collection directing to a Store landing page - Store spotlight directing to a Store landing page - Brand video ad pointing to a Store landing page\n"],"documentType":"guide"},{"title":"Getting started with campaigns","sectionHeader":{"type":3,"text":"Step 5: Add targeting to your ad group"},"path":"/en-us/guides/sponsored-brands/campaigns/get-started-with-campaigns","content":[" Once you have created an ad in an ad group, you need to add targeting. An ad group can be associated to either product or keyword targeting expressions.\n","For keyword targeting, use the POST /sb/keywords endpoint.  For product targeting, use the POST /sb/targets endpoint.  For theme targeting, use the POST /sb/themes endpoint.\n"],"documentType":"guide"},{"title":"Getting started with campaigns","sectionHeader":{"type":3,"text":"Step 6: Check the moderation status"},"path":"/en-us/guides/sponsored-brands/campaigns/get-started-with-campaigns","content":[" You can check the moderation status of your ads by passing the adId as the id in the Moderation API.\n"],"documentType":"guide"},{"title":"Getting started with campaigns","sectionHeader":{"type":3,"text":"Step 7: Make any changes to your ads or creatives"},"path":"/en-us/guides/sponsored-brands/campaigns/get-started-with-campaigns","content":[],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Jump to: Campaigns | Ad groups | Ads | Creatives | Reports\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Campaigns"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Version 4 supports create, update, read, and delete options for campaigns. \n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Listing campaigns"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" See details for campaigns using the POST /sb/v4/campaigns/list endpoint.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Updating campaigns"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Update a multi-ad group campaign using the PUT /sb/v4/campaigns endpoint. \n"," Sample request\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Deleting campaigns"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Delete multi-ad group campaigns, using the POST /sb/v4/campaigns/delete endpoint. \n"," Sample request\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Ad groups"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Listing ad groups"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" List ad groups that you want to update using the POST /sb/v4/adGroups/list endpoint.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Updating ad groups"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Update ad group status using the PUT /sb/v4/adGroups endpoint.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Deleting ad groups"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Use the POST /sb/v4/adGroups/delete endpoint to archive an ad group. \n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Ads"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Listing ads"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Use the POST /sb/v4/ads/list endpoint to list the ads. The list endpoint returns ads created using both version 3 and version 4. \n"," Sample request: all ads\n"," Sample response\n"," In the following example response, the first returned ad was created as part of a version 3 campaign, so it does not contain an adId or ad name. The second ad was created as part of a version 4/multi-ad group campaign, so it contains both an adId and an ad name.\n"," Sample request: filter by adId\n"," You can use filters to return specific ads by adId. \n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Updating ads"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Use the PUT /sb/v4/ads endpoint to update the status or name of an ad. \n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Deleting ads"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Use the POST /sb/v4/ads/delete endpoint to delete an ad. \n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Creatives"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Listing creatives"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Gets an array of all Sponsored Brands creatives that qualify the given resource identifiers and filters.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Updating video creatives"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Creates a new version of an existing video creative for given Sponsored Brands video ad by supplying new video creative content.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Updating brand video creatives"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Creates a new version of an existing video creative for given Sponsored Brands brand video ad by supplying new video creative content.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Reports"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-multi-ad-group-campaigns","content":[" Use the version 2 reporting endpoint: POST /v2/hsa/{reportType}/report.\n"," Sample request body\n"," Sample response\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands optimization rules","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/campaigns/managing-optimization-rules","content":[" Sponsored Brands optimization rules (beta) API simplifies the campaign management process. With only a few inputs, you can set up performance-based parameters to remove the guesswork from selecting an exact bid for each target.\n"," For campaigns with a goal of PAGE_VISIT, you can apply a cost-based rule for clicks (CPC). The system then uses machine learning models to define the bids while adjusting base bids up and down with the goal of increasing outcomes, all while adhering to the cost-based rules. Additionally, the system may add targets while your campaign is running to try to stay at or below a cost per order value you have specified.\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands optimization rules","sectionHeader":{"type":2,"text":"How it works"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-optimization-rules","content":[" Advertisers specify an advertising objective in the form of their campaign goal, the products they would like to advertise, a daily budget, and an average cost they are willing to pay per click or 1k viewable impressions. There are two important levers that can help influence marketing goals and costs today.\n","Targets selected: Different targeting allows advertisers to reach different audiences, and ads may be more relevant to some than others. When selecting targets, they should be 1) relevant to the advertised products and 2) broad enough to help advertisers reach as many shoppers as possible. The machine learning models that serve ads will be adjusting bids in real time for every opportunity to ensure the cost stays at the desired value, wherever the ad is rendered, while only paying when it works. \\* Bid values: Bids signal the most an advertiser is willing to pay for an action (view or click) on each of the targets. \n"," When advertisers use campaign goal, our machine learning models help choose the right targets and bids that can drive a desired action at the specified (maximum) cost and budget. We want each campaign to achieve as many possible actions as long as the costs are under the specified target cost per action (CPA), without spending more than the daily budget. Bids and targets are optimized by models that look at the past campaign performance and similar campaigns: if costs are too high, bids are reduced, and if they are below the target, they are increased to get more total scale. Bids and targets can be quickly adjusted based on changes in competition (for example, another brand is targeting similar audiences with higher willingness to pay, or traffic changes due to seasonal factors) to ensure advertisers stay within their desired range, all while getting as much scale as possible. While Amazon Ads cannot guarantee performance, if the campaign is not meeting the cost target over a 21-day period (excluding special days), we recommend adjusting cost target or budget to allow our systems to achieve that goal.\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands optimization rules","sectionHeader":{"type":3,"text":"Step 1: Create a campaign"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-optimization-rules","content":[" The first step is to create a campaign using the POST /sb/v4/campaigns endpoint. A successful call returns a 207 response code and indicates the campaignId of the campaign created.\n"," If the campaign goal is selected, smartDefault will be automatically added with TARGETING to help apply dynamic theme based keywords, and in the future, OPTIMIZATION can be automatically added with an optimization rule with a recommended cost threshold based on the goal and promoted page. Otherwise, you can set the smartDefault of the campaign to MANUAL for complete targeting and bid controls. For additional ad group and ad creation instructions, see Getting started with campaigns.\n"," Sample request\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands optimization rules","sectionHeader":{"type":3,"text":"Step 2: Create an optimization rule"},"path":"/en-us/guides/sponsored-brands/campaigns/managing-optimization-rules","content":[" Retrieve a recommended optimization rule metric using POST /sb/recommendations/optimization. This API uses your landing page metadata and associated brand data to calculate an effective target metric, balancing auction performance with cost-effectiveness.\n"," You can pass the same landing page information used in ad endpoints, either prior to creating them or after.\n"," The response includes a recommended value to set for your optimization rule campaign along with a minimum recommended value.\n"," Create an optimization rule using the POST /sb/rules/optimization endpoint. This will help each campaign achieve as many possible actions as long as the costs are under the specified target cost.\n"," Use the campaignId from step 1 in the entityId. A successful call returns a 207 response code and indicates the optimizationRuleId of the campaign created.\n"],"documentType":"guide"},{"title":"Managing Sponsored Brands optimization rules","sectionHeader":{"type":3,"text":"Step 3: Manage optimization rules for your campaigns "},"path":"/en-us/guides/sponsored-brands/campaigns/managing-optimization-rules","content":[" If you need to adjust or update an optimization rule, use the PUT /sb/rules/optimization endpoint. Similarly, if you want to disassociate an optimization rule from a campaign, you can use the POST /sb/rules/optimization/disassociate endpoint.\n"," You can disassociate a rule by calling the following endpoint. Once the rule has been disassociated from the campaign, you can reuse the same rule by calling the associate endpoint.\n"," To associate a rule to an existing campaign, use the POST /sb/rules/optimization/associate endpoint. You can use the optimizationRuleId that does not have an association with a campaign. A successful call returns a 207 response code and indicates that the campaign has been associated with the optimizationRuleId passed in the request.\n"],"documentType":"guide"},{"title":"Creating Sponsored Brands ad groups","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/ad-groups","content":[],"documentType":"guide"},{"title":"Creating Sponsored Brands ad groups","sectionHeader":{"type":2,"text":"Creating ad groups"},"path":"/en-us/guides/sponsored-brands/ad-groups","content":[" Ad groups provide the ability to organize, manage, and track performance of the products within your campaign. Ads placed together in an ad group share the targeting (keyword or product). Each campaign consists of one or more ad groups.\n"],"documentType":"guide"},{"title":"Creating Sponsored Brands ad groups","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/ad-groups","content":[" To create an ad group, you must first create a campaign to get the campaignId. You can learn more about campaign creation in Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Creating Sponsored Brands ad groups","sectionHeader":{"type":2,"text":"Best practices"},"path":"/en-us/guides/sponsored-brands/ad-groups","content":["Ad group name: Assign an ad group name that is descriptive and meaningful to you. Ad group names must be unique within a campaign, but you can use the same ad group name in different campaigns. Your ad group name is only used for display purposes in the campaign manager and is not visible to shoppers. \\* Keyword or product targeting:\n"],"documentType":"guide"},{"title":"Creating Sponsored Brands ad groups","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/sponsored-brands/ad-groups","content":[],"documentType":"guide"},{"title":"Creating Sponsored Brands ad groups","sectionHeader":{"type":3,"text":"Endpoint"},"path":"/en-us/guides/sponsored-brands/ad-groups","content":[],"documentType":"guide"},{"title":"Creating Sponsored Brands ad groups","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-brands/ad-groups","content":[" If you are copying the sample, be sure to enter your own client ID, access token, campaign ID, and profile ID. \n"],"documentType":"guide"},{"title":"Creating Sponsored Brands ad groups","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-brands/ad-groups","content":[" A successful response returns a 207 response code. The error array contains any error messages that can occur when creating an ad group. The success array returns the ad group object which contains the adGroupId.\n"],"documentType":"guide"},{"title":"Creating Sponsored Brands ad groups","sectionHeader":{"type":3,"text":"Next steps"},"path":"/en-us/guides/sponsored-brands/ad-groups","content":[],"documentType":"guide"},{"title":"Ad types overview","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/ads/overview","content":[" Sponsored Brands ads allow you to use different ad formats to showcase your brand. Depending on your campaign objectives and ad format you can choose between collections, store spotlight, or video.\n","Collections: Use this format to feature 3-10 related products in a single ad unit. You can choose between two collection types: automatic and manual collections. Collection ads highlight key product details, link to product detail pages and also connect shoppers to a branded experience where they can explore more products from your brand.  Product collection DEPRECATED: Use this format when you would like to feature a brand logo along with a selection of your products. When Amazon shoppers click a product image, it takes them to the product detail page.  Store spotlight: Use this format when you want to promote a store, including its subpages. \\* Video: Use this format when you want to feature a horizontal or a vertical video telling your brand story, and being able to link to a product detail page or store. Campaigns leading to a store can select a variety of advertised products, or display a video-only creative.\n"," Ads generally contain these components:\n","Brand details, such as a logo and name  Creative asset (where applicable)  Landing page \\* Advertised products\n"],"documentType":"guide"},{"title":"Ad types overview","sectionHeader":{"type":2,"text":"Creative asset"},"path":"/en-us/guides/sponsored-brands/ads/overview","content":[" A creative asset can either be an image or video. An example of an image creative would be your brand logo or a custom image that represents your products or brand in a lifestyle setting. You can also showcase your brand or products using a video creative.\n"],"documentType":"guide"},{"title":"Ad types overview","sectionHeader":{"type":2,"text":"Landing page"},"path":"/en-us/guides/sponsored-brands/ads/overview","content":[" The landing page is where shoppers are directed after they interact with your ad. Landing page options are custom (your own URL), your Store on Amazon, or a product detail page. You can assign different landing pages to each ad within your ad group and edit them.\n"," Below are restrictions where a landing page update is not allowed:\n","| Details                                                                                                         | Automatic Collections | Manual Collections | Product Collection DEPRECATED | Store Spotlight | Brand Video | Video - product detail page |\n","\\|-----------------------------------------------------------------------------------------------------------------\\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| Change new landing page to a custom URL landing page                                                            | N/A | N/A | Permitted | N/A | N/A | N/A |\n","| Change store landing page to a custom URL landing page                                                          | N/A | N/A | Permitted | Permitted | Permitted | N/A |\n","| Change store landing page to a new landing page                                                                 | N/A | Permitted | Permitted | Permitted | Permitted | N/A |\n","| Change custom URL landing page to a store landing page                                                          | N/A | N/A | Permitted | N/A | N/A | N/A |\n","| Change custom URL landing page to a new landing page                                                            | N/A | N/A | Permitted | N/A | N/A | N/A |\n","| Change store landing page to a new store landing page                                                           | N/A | Permitted | Permitted | Permitted | Permitted | N/A |\n","| Change store landing page to a product detail page landing page                                                 | N/A | N/A | N/A | N/A | N/A | Not permitted |\n","| Change product detail landing page to store landing page                                                        | N/A | N/A | N/A | N/A | N/A | Not permitted |\n","| Change one store page to another store main or sub-page within the same store                                   | N/A | Permitted | Permitted | permitted | permitted | N/A |\n","| Advertiser with New LP wants to add/remove ASINs on their existing landing page that are not featured in the ad | N/A | N/A | Permitted | N/A | N/A | N/A |\n","| Add or remove ASINs not featured in the ad on an existing landing page                                          | N/A | N/A | Permitted | N/A | N/A | N/A |\n","| Add or remove ASINs featured in the ad on an existing landing page                                              | N/A | N/A | Permitted | N/A | N/A | N/A |\n","| Add or remove ASINs not featured in your ad for your stores landing page                                        | N/A | Permitted | Permitted | Permitted | Permitted | N/A |\n","| Add or remove ASINs featured in your ad for your stores landing page                                            | N/A | Permitted | Permitted | Permitted | Permitted | N/A |\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" Collections is an ad format that lets you promote multiple related products in a single ad unit. With AI-powered automatic collections, Amazon dynamically curates the most relevant products for each shopper, while manual collections allows you to hand-pick your selection. Collections highlight key product details for quick evaluation and purchase and connect shoppers to branded experiences where they can explore additional related products your brand.\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":2,"text":"Choose a collection type"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" Choose between two collection types:\n","Automatic collections - Let the Amazon AI dynamically group the most relevant products from your catalog into collections based on your keyword targets and shopper search queries.  \\* Manual collections - Select 3-10 related products to feature in your ad. This ad type supports keyword or product targeting and gives you full control over which products to showcase.\n"," Note: You cannot change your collection type after your ad group has been created. You can only create one automatic collection ad request per ad group.\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":2,"text":"Automatic collections"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" You must have the following before creating a collection ad:\n","An ad group ID  A campaign ID  The brand name you want to appear on the ad \\* Your keyword targets\n"," Note: We automatically create relevant titles and landing pages for your collections. The title, logo, and brand name link to the landing page, while products in the ad link to product detail pages. \n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":2,"text":"Manual collections"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" You must have the following before creating a collection ad:\n","An ad group ID  A campaign ID  A minimum of 3 related products from your catalog (max 10)  The brand name you want to appear on the ad  Landing page selection:\n"," Note: We automatically create relevant titles for your collections. The title, logo, and brand name link to the landing page you select, while products in the ad link to product detail pages.\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":2,"text":"Collections specifications"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Brand Logo specifications"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" Brand logo is optional for collection ads. If you choose to include a brand logo, it must meet the following requirements:\n","| Specification | Details |\n","\\| --- \\| --- \\|\n","| Image size | 400 x 400 px or larger |\n","| File size | 1MB or smaller |\n","| File format | PNG or JPG |\n","| Content | Logo must fill the image or have a white or transparent background. For more information, visit Brand Logo Creative Acceptance Policy. |\n"," Note: Custom or lifestyle images, and videos are NOT supported for collection ads.\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":2,"text":"Examples"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Automatic collection ads"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" The POST /sb/v4/ads/autoCollection endpoint creates new automatic collection ads. The Amazon AI dynamically groups the most relevant products from your catalog into collections based on your keyword targets and shopper search queries. Products in the ad link to product detail pages, and the ad title, logo, and brand name link to a new landing page. You are required to supply only the brand name. Remaining fields are optional including brand logo.\n"," Example request body: Automatic collection\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Automatic collections ads with product exclusion (optional)"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" The POST /sb/v4/ads/autoCollection endpoint creates new automatic collection ads. Product exclusions prevent specific products from appearing in your automatic collection ads within the same ad group. Use this feature when you do not want certain products from your catalog to appear in your ads, even if they match your targeting criteria. You can exclude up to 1000 products.\n"," Example request body: Automatic collection with product exclusions\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Manual collection ads with new landing page"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" Use manual collections to feature 3-10 related products you choose from your catalog. \n"," Example request body: Manual collection ads with new landing page\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Manual collection ads with store landing page"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" If you set pageType to STORE, this will link to an existing Amazon store page. The store URL must be included in the landing page object as shown in the example below. Learn more about Stores.\n"," Example request body: STORE\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Update brand logo in automatic collection ads"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" The POST /sb/ads/creatives/autoCollection endpoint updates existing brand logo information for an automatic collection ad. The adId parameter represents the ID of the existing automatic collection ad. The brandLogoAssetID and brandLogoCrop parameters represent the updated brand logo asset ID and crop information.\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Update product exclusions in automatic collection ads"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" The POST /sb/ads/creatives/autoCollection endpoint updates the product exclusions for an existing automatic collection ad. The adId parameter represents the ID of the existing automatic collection ad. The asinExclusions parameter represents the list of products that need to be excluded from the automatic collection ad, so that the Amazon AI-generated ads exclude these products from the ad creatives.\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Change to a new landing page from existing store landing page"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" The POST /sb/ads/creatives/manualCollection endpoint updates an existing manual collection ad landing page from Amazon store to a new landing page. The adId parameter represents the ID of the existing manual collection ad. The creative object contains the details of the updated ad setting information for the landing page. You are required to supply the existing information in addition to the updated information. You can also use the same endpoint to update multiple creative object information for the manual collection ad. \n"," Example request body: Change manual collection ads landing page information to PRODUCT_LIST\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Change to a store landing page from existing new landing page"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" The POST /sb/ads/creatives/manualCollection endpoint updates an existing collection new landing page (PRODUCT_LIST) to a store landing page (STORE). The adId parameter represents the ID of the existing manual collection ad. The creative object contains the details of the updated ad setting information for the new landing page.\n"," Example request body: Change manual collection ads landing page information to STORE\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Update list of products promoted in manual collection ads"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" The POST /sb/ads/creatives/manualCollection endpoint updates an existing list of promoted products from the ad. The adId parameter represents the ID of the existing manual collection ad. The asins parameter represents the new list of products updated in the ad. \n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Update brand logo in manual collection ads"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" The POST /sb/ads/creatives/manualCollection endpoint updates existing brand logo information. The adId parameter represents the ID of the existing manual collection ad. The brandLogoAssetID and brandLogoCrop parameters represent the updated brand logo asset ID and crop information. \n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":2,"text":"Frequently Asked Questions"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"What do collections ads look like to shoppers?"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" Collection ads are a product-centric experience with 3-10 related products, featuring product images and key product details. Collection ads display your brand logo, an auto-generated title, and a call-to-action that directs shoppers to a branded experience where they can explore more products from your catalog, free from competitors. All products in the ad link to product detail pages. \n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"How can I tell if my ad is a manual collection, an automatic collection, or a product collection? "},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" You can use the existing POST API /sb/v4/ads/list to identify collection ads. If the creative type is MANUAL_COLLECTION or AUTO_COLLECTION, then they are classified as collection ads. This API returns the latest creative type, including manual collection and automatic collection.\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"What should I do when my ad is under moderation review?"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" If your ad is under moderation review, please wait until the moderation is completed. In case your ad is rejected due to ad policy violation, you can edit your ad using the POST API /sb/ads/creatives/autoCollection or /sb/ads/creatives/manualCollection.\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Why should I use automatic collections?"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" Automatic collections use the Amazon AI to curate the most relevant set of products for each shopper based on your campaign goals, keyword targets and shopper queries. This ensures that shoppers see the products most likely to match their intent, while freeing advertisers from manual setup.\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Can I change an existing product collection ad to a manual collection or automatic collection ad?"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[" No, an existing product or manual collection ad cannot be converted into an automatic collection. If you wish to use automatic collections for an existing campaign, you must create a new automatic collection ad group. Likewise, automatic collection ads cannot be converted back into a manual collection. To disable an automatic collection, you can pause or archive the ad.\n"],"documentType":"guide"},{"title":"Collections","sectionHeader":{"type":3,"text":"Can I add more than one automatic collection ad into ad group?"},"path":"/en-us/guides/sponsored-brands/ads/collections","content":[],"documentType":"guide"},{"title":"Video ad","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/ads/video","content":[" This ad format features a horizontal or vertical video that tells your brand story or showcases an individual product or a collection of products. Video ads are eligible for mobile and desktop placements in shopping results.\n"," See the API reference for video or the API reference for brand video.\n"],"documentType":"guide"},{"title":"Video ad","sectionHeader":{"type":2,"text":" Video vs. Brand video formats"},"path":"/en-us/guides/sponsored-brands/ads/video","content":[" If your goal is to drive conversion and purchases of an individual product, you can use the video resource to promote a single product and link that video to the product detail page. \n"," If your goal is to drive awareness and consideration, you can use the brand video resource to promote your brand and link that video to your Store.\n"," Under the Drive Page Visits goal, brand video campaigns allow for one, two, or three advertised products. Under the Grow Brand Impression Share goal, brand video campaigns allow for none, one, two, or three advertised products. In both advertising goals, you can use a horizontal or vertical video. If you are using a store as a landing page, the ASIN featured in the creative must also appear on your store landing page.\n"],"documentType":"guide"},{"title":"Video ad","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/ads/video","content":[" Both types of campaigns require the following information:\n","A campaign ID  An ad group ID  Gather creative components \\* Upload any needed assets using the asset library API\n"],"documentType":"guide"},{"title":"Video ad","sectionHeader":{"type":2,"text":"Video creative components"},"path":"/en-us/guides/sponsored-brands/ads/video","content":[],"documentType":"guide"},{"title":"Video ad","sectionHeader":{"type":3,"text":"Video "},"path":"/en-us/guides/sponsored-brands/ads/video","content":[" Video creatives that take shoppers to a Detail page contain a featured advertised product, a brand logo, a headline, a brand name, and a video.\n","|Asset\t|Notes\t|\n","|---\t|---\t|\n","|Featured video\t|Upload a video using the creative asset library. See video requirements and best practices. Only horizontal video is allowed.\t|\n","|Featured ASIN\t|Make sure your ASIN is eligible.\t|\n"],"documentType":"guide"},{"title":"Video ad","sectionHeader":{"type":3,"text":"Brand video"},"path":"/en-us/guides/sponsored-brands/ads/video","content":[" Brand video creatives that link to a brand store also contain a brand logo, a headline, a brand name, a video, and can advertise a collection of products.\n","|Content| Description|\n","|---\t|---\t|\n","|Brand logo image\t|Upload your logo using the creative asset library.  Image size:  400 x 400 px or larger File size:  1MB or smallerFile format : PNG or JPGContent: Logo must fill the image or have a white or transparent background\t|\n","|Headline\t|Headline copy should meet the Amazon advertising standards. Maximum length is 50 characters for all geographies other than Japan (30 characters)\t|\n","|Brand name\t|The name of your brand will display in the creative. \t|\n","| Advertised products |Under the Drive Page Visits goal, brand video campaigns allow for one, two, or three advertised products. Under the Grow Brand Impression Share goal, brand video campaigns allow for none, one, two, or three advertised products. In both advertising goals, you can use horizontal or vertical video.  |\n"],"documentType":"guide"},{"title":"Video ad","sectionHeader":{"type":3,"text":"Vertical video specifications"},"path":"/en-us/guides/sponsored-brands/ads/video","content":["|Specifications\t|Description\t|\n","|---\t|---\t|\n","|File Format\t|Any\t|\n","|Aspect ratio\t|9:16\t|\n","|Dimensions\t|720x1280, 1080x1920, or 2160x3840\t|\n","|Duration\t|6-45 seconds\t|\n","|Framerate\t|23.976, 23.98, 24, 25, 29.97, 29.98, or 30 FPS\t|\n","|Video Bitrate\t|1 mbps or more\t|\n","|Video Codec\t|H.264 or H.265\t|\n","|Number of Video streams\t|1\t|\n","|Audio Sample Rate\t|44.1 kHz or higher\t|\n","|Audio Bitrate\t|96 kbps or more\t|\n","|Audio Codec\t|PCM, AAC, or MP3\t|\n"],"documentType":"guide"},{"title":"Video ad","sectionHeader":{"type":2,"text":"Examples"},"path":"/en-us/guides/sponsored-brands/ads/video","content":[],"documentType":"guide"},{"title":"Video ad","sectionHeader":{"type":3,"text":"Product detail landing page request"},"path":"/en-us/guides/sponsored-brands/ads/video","content":[" For product detail landing page video campaigns, you do not need to specify a landing page. Amazon uses the ASIN specified in the creative and directs customers that click on the ad directly to that product detail page. \n"," See API reference for video.\n"],"documentType":"guide"},{"title":"Video ad","sectionHeader":{"type":3,"text":"Store landing page request"},"path":"/en-us/guides/sponsored-brands/ads/video","content":[" Brand video requires a STORE landing page type. Ensure the ASIN used in your creative is also featured on the Store page URL. You can check what ASINs are present on the page using the GET /pageAsins endpoint.\n"," See API reference for brand video.\n"],"documentType":"guide"},{"title":"Video ad","sectionHeader":{"type":3,"text":"Change to a new Store landing page from existing Brand video ad"},"path":"/en-us/guides/sponsored-brands/ads/video","content":[" The POST sb/ads/creatives/brandVideo endpoint changes an existing Brand video ad landing page to a new Store landing page. The adId parameter represents the ID of the existing landing page. The creative object contains the details of the updated creative for the new landing page.\n"," Endpoint: /sb/ads/creatives/brandVideo\n"],"documentType":"guide"},{"title":"Store spotlight ad","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/ads/store-spotlight","content":[" Store spotlight can help drive traffic to your Store. This ad format features your brand logo, a custom headline, and your Store on Amazon with at least three subpages. When Amazon shoppers click the ad tile, it will direct them to a specified subpage within the Store. Clicking the brand logo or the headline will direct shoppers to your main Store page. Learn more about Stores.\n"," See the API reference for more details.\n"],"documentType":"guide"},{"title":"Store spotlight ad","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/ads/store-spotlight","content":[" You must have the following before creating a store spotlight ad:\n","A campaign ID  An ad group ID  An existing Store homepage URL  Three subpages with the following information for each subpage:  An assetId for the brand image using the asset library API\n"],"documentType":"guide"},{"title":"Store spotlight ad","sectionHeader":{"type":2,"text":"Examples"},"path":"/en-us/guides/sponsored-brands/ads/store-spotlight","content":[],"documentType":"guide"},{"title":"Store spotlight ad","sectionHeader":{"type":3,"text":"Create a Store spotlight ad"},"path":"/en-us/guides/sponsored-brands/ads/store-spotlight","content":[" For the landingPage.url, make sure to include the Store home page URL. Ensure that for each subpage, the ASIN specified in the asin key is present in the subpage specified in the url key.\n"],"documentType":"guide"},{"title":"Store spotlight ad","sectionHeader":{"type":3,"text":"Change to a new Store Spotlight landing page from existing Store Spotlight landing page"},"path":"/en-us/guides/sponsored-brands/ads/store-spotlight","content":[" The POST sb/ads/creatives/storeSpotlight endpoint changes an existing Store Spotlight ad landing page to a new Store Spotlight landing page. The adId parameter represents the ID of the existing Store Spotlight landing page. The creative object contains the details of the updated creative for the new landing page.\n"," Endpoint: /sb/ads/creatives/storeSpotlight\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" With the product collection ad type, you can promote your products from a landing page of your choice. This ad features your brand logo, a custom headline, and three or more products. When Amazon shoppers click the image of a product, it takes them to the product detail page. Clicking the brand logo or the headline directs shoppers to your store or a custom landing page that you designate.\n"," See the API reference for more details.\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" You must have the following before creating a product collection ad:\n","An assetId for any creatives being used in the ad:  An ad group ID  A campaign ID  Three eligible ASINs to show in the ad  A headline for the ad \\* The brand name you want to appear on the ad\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":2,"text":"Creative specifications"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" A creative must meet certain requirements before it can be accepted. Below are specifications for both a brand logo and a custom image.\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Brand Logo specifications"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":["|Specification\t|Details|\n","|---\t|---\t|\n","|Image size\t|400 x 400 px or larger\t|\n","|File size\t|1MB or smaller\t|\n","|File format\t|PNG or JPG\t|\n","|Content\t|Logo must fill the image or have a white or transparent background. For more information, visit Brand Logo Creative Acceptance Policy.|\t \n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Custom image specifications"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":["|Specification\t|Details\t|\n","|---\t|---\t|\n","|Image size\t|1200 x 628 px or larger\t|\n","|File size\t|5MB or smaller\t|\n","|File format\t|PNG or JPG\t|\n","|Content\t|No text, graphics, or logos added to the image. For more information, visit Custom Image Creative Acceptance Policy.\t|\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Vertical video specifications"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":["|Specifications\t|Description\t|\n","|---\t|---\t|\n","|File Format\t|Any\t|\n","|Aspect ratio\t|9:16\t|\n","|Dimensions\t|720x1280, 1080x1920, or 2160x3840\t|\n","|Duration\t|6-45 seconds\t|\n","|Framerate\t|23.976, 23.98, 24, 25, 29.97, 29.98, or 30 FPS\t|\n","|Video Bitrate\t|1 mbps or more\t|\n","|Video Codec\t|H.264 or H.265\t|\n","|Number of Video streams\t|1\t|\n","|Audio Sample Rate\t|44.1 kHz or higher\t|\n","|Audio Bitrate\t|96 kbps or more\t|\n","|Audio Codec\t|PCM, AAC, or MP3\t|\n","|Content\t|No text, graphics, or logos added to the image. For more information, visit Custom Image Creative Acceptance Policy.\t|\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":2,"text":"Examples"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Simple landing page"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" A simple landing page supports up to one hundred ASINs, including the three ASINs advertised in the creative. If you want a simple landing page, set pageType as PRODUCT_LIST and include a list of ASINs on the landing page object as shown in the example below: \n"," Example request body: PRODUCT_LIST\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Store"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" If you set pageType to STORE, this will reference an existing Amazon store page. The store URL must be included in the landing page object as shown in the example below. Learn more about Stores. \n"," Example request body: STORE\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Custom URL"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" If you are a vendor and you have a custom landing page, you can set pageType to CUSTOM_URL. The landing page must include the ASINs of at least three products that are advertised as part of the campaign.\n"," Example request body: CUSTOM_URL\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Custom image"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" To add a custom image, you must first get an assetId using the asset library API. Within the creative object, you can specify the dimensions of the custom image. If you do not specify dimensions, the custom image will default to an image size of 1200 x 628 px.\n"," Request example with custom image crop dimensions:\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Change to a new landing page from existing simple landing page"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" The POST sb/ads/creatives/productCollectionExtended endpoint changes an existing product collection ad landing page to a new landing page. The adId parameter represents the ID of the existing product collection ad. The creative object contains the details of the updated creative for the new landing page.\n"," Endpoint: sb/ads/creatives/productCollectionExtended\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Change to a Store landing page from existing simple landing page"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Change to a custom URL landing page from existing simple landing page"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":2,"text":"Frequently Asked Questions"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Why should we add a custom image? What are the benefits of using a custom image?"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" Historical data shows that, on average, Sponsored Brands ads with a branded creative generate a 50% increase in CTR and a 60% increase in branded search compared to ads with only product images.\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"What are branded creatives? Is product collection with a custom image or Lifestyle considered a branded creative?"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" Yes, product collection with a custom image (also known as a Lifestyle image) is considered a branded creative. Product collection without a custom image is not considered a branded creative.\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"What is the visual difference between a product collection `ASIN`-only creative and a product collection custom image creative?"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" The main difference between a product collection ASIN-only creative and a product collection custom image is the presence of the custom image. A product collection custom image ad may contain zero or one products, but an ASIN-only ad with zero or one product does not display on Amazon.\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"How can I identify campaigns with no custom images?"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" You can use the existing POST API /sb/v4/ads/list to identify if your creative is missing a custom image or not. This API returns the latest creative status, including if the moderation is pending or rejected.\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"What should I do when my creative is under moderation review?"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" If your creative is under moderation review, please wait until the moderation is completed. In case your creative is rejected due to ad policy violation, you can edit your creative using the POST API /sb/ads/creatives/productCollection.\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"We are not integrated with creative edit features. How can we edit product collection ads using ad console?"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" Please follow the instructions in this YouTube tutorial.\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"What if I do not have a suitable custom image?"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[" For existing campaigns, we recommend that you edit your campaign to include a custom image from your computer, asset library, or, if available to you, create a GenAI image using the beta feature found at image generation. If your existing campaign links to your Store landing page, then Amazon Ads can generate an image from your Store in your ASIN-only product collection ads if applicable. Additionally, you can build a Sponsored Brands video ad if you have video assets or a Store spotlight ad if you have a Store.\n"," Please reach out to us in the Amazon Ads API Service Desk for more information on how to use Gen AI through APIs.\n"],"documentType":"guide"},{"title":"Product collection ad","sectionHeader":{"type":3,"text":"Do I have to upload one custom image per `ASIN` in the product collection?"},"path":"/en-us/guides/sponsored-brands/ads/product-collection","content":[],"documentType":"guide"},{"title":"Creating keyword targeting","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/targeting/keyword-targeting","content":[" With keyword targeting, Amazon matches your keywords to the search terms of a customer and displays the branded headline and advertised products in your campaign. Keyword targeting in Sponsored Brands has semantic matching. Instead of having a word-to-word matching only, it uses a meaning-based approach. For instance, if a customer searches for \"running shoes,\" campaigns that target semantically equivalent keywords such as \"jogging shoes\" and \"shoes for running\" are eligible to bid on that search.\n"," In addition, for Sponsored Brands campaigns, you can choose words that must be present in the shopping query in order for your ad to run. Broad match modifiers can be added by adding the plus symbol \"+\" in front of the keyword. For example, if you use the keyword \"+kids shoes\" with a broad match modifier, then the ad will match only the searches that contain the word \"kids.\" The ad may match to \"kids sneakers\" or \"running shoes for kids\" but they will not match any shopping query that does not contain the word \"kids,\" such as \"sneakers\" or \"running shoes.\"\n"],"documentType":"guide"},{"title":"Creating keyword targeting","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/targeting/keyword-targeting","content":[" You must have the following before creating a keyword:\n","A campaign Id \\* An ad group Id\n"," If you do not know what keywords to target, try using the keyword recommendations resource. If you need suggested bids for keywords from Amazon, use the bid recommendations resource. \n"],"documentType":"guide"},{"title":"Creating keyword targeting","sectionHeader":{"type":2,"text":"Creating keywords"},"path":"/en-us/guides/sponsored-brands/targeting/keyword-targeting","content":[" Endpoint \n"," Parameters\n","| Name | Optional | Type | Description |\n","\\|--- \\|--- \\|--- \\|--- \\|\n","| adGroupId | No | string | The ad group to associated the campaign with |\n","| campaignId | No | string | The campaign to associated the target |\n","| keywordText | No | string | The keyword text |\n","| nativeLanguageKeyword | Yes | string | The unlocalized keyword text in the preferred locale of the advertiser. |\n","| nativeLanguageLocale | Yes | string | The locale preference of the advertiser. For example, if the preferred language of the advertiser is Simplified Chinese, set the locale to zh_CN. Supported locales include: Simplified Chinese (locale: zh_CN) for US, UK and CA. English (locale: en_GB) for DE, FR, IT and ES. |\n","| matchType | No | string | The type of match. For more information, see match types in the advertising console support center. |\n","| bid | No | number | Bid associated with this keyword. |\n"," The max number of keywords that can be created per request is one hundred. For most advertisers, the following request body structure is recommended:\n"," Using nativeLanguageLocale Advertisers who are advertising in other regions can use the nativeLanguageLocale and nativeLanguageKeyword parameters to specify the equivalent keywordText in their preferred language for reporting purposes.\n"],"documentType":"guide"},{"title":"Creating keyword targeting","sectionHeader":{"type":2,"text":"Get keyword recommendations"},"path":"/en-us/guides/sponsored-brands/targeting/keyword-targeting","content":[" The POST /sb/recommendations/keyword resource retrieves recommended keywords given either a list of ASINs that will be on the landing page for the ad or a specific Stores page URL. Vendors can also provide the URL of a custom landing page. If inputting a URL, the ASINs featured on that landing page are used to generate keyword recommendations. \n"],"documentType":"guide"},{"title":"Creating keyword targeting","sectionHeader":{"type":3,"text":"Getting keyword recommendations based on creative `ASIN`s and types"},"path":"/en-us/guides/sponsored-brands/targeting/keyword-targeting","content":[" If a list of ASINs is provided in the creativeAsins parameter, Amazon will rank the keyword recommendations higher for that list of ASINs than the ASINs provided either in the asins object or the landing page. If a creativeType is provided, Amazon will rank keyword recommendations based on either a static image or a video. The table below shows where recommendations are generated from depending on the identifier chosen. Please note that both these parameters are optional and not required to obtain a keyword recommendation. \n","| Identifier | Description | Recommendations generated from |\n","\\|--- \\|--- \\|--- \\|\n","| PRODUCT_COLLECTION | Showcase multiple products within a branded shopping experience | Static image |\n","| AUTHOR_COLLECTION | Showcase books under your name that direct to your Book Brand landing page | Static image |\n","| STORE_SPOTLIGHT | Showcase your brand logo, headline, and up to 3 product categories or sub-pages | Static image |\n","| VIDEO | Display a video ad promoting a product that redirects to its landing page | Video |\n","| BRAND_VIDEO | Display a branded video ad that redirects shoppers to your Brand Store landing page | Video |\n"," Endpoint\n"," Scenario 1: three ASINs are passed in the request body with the creative parameters.\n"," Response\n"," In this response, the field translation returned null because a locale was not specified in the request body. The recommendationId field is a unique ID for each recommended keyword. Match type PHRASE is the only option for keyword suggestions. \n"," The searchTermImpressionShare indicates the percentage share of all ad-attributed impressions you received on that keyword in the last 7 days. This metric helps advertisers identify potential opportunities based on their share on relevant keywords. The searchTermImpressionRank indicates your ranking among all advertisers for the keyword by ad impressions in a marketplace. It tells an advertiser how many advertisers had higher share of ad impressions. Search term information is only available for keywords the advertiser targeted with ad impressions. If either field is null, it means there is not enough data to show a ranking. The addKeyword value for the type parameter means that Amazon recommends adding the returned keyword recommendation to your ad group. \n"," Scenario 2: three ASINs are passed in the request body with locale provided.\n"," Response\n"," In this response, you can see the suggested keyword translation to Simplified Chinese under the translation field.\n"],"documentType":"guide"},{"title":"Creating keyword targeting","sectionHeader":{"type":3,"text":"URL"},"path":"/en-us/guides/sponsored-brands/targeting/keyword-targeting","content":[" Endpoint\n"," Scenario 1: URL passed in the request body with creative parameters\n"," Response\n"," In this response, you can see the keyword recommendations returned are based on the creative parameters passed in the request. If the creative parameters were not included in the request, the keyword recommendations would be based on the ASINs located within the provided url, which can be a store URL or a custom URL.\n"],"documentType":"guide"},{"title":"Creating keyword targeting","sectionHeader":{"type":2,"text":"Get bid recommendations for keywords"},"path":"/en-us/guides/sponsored-brands/targeting/keyword-targeting","content":[" The /sb/recommendations/bids resource provides bid recommendations for up to one hundred keywords per request.\n"," Endpoint\n"," Request\n"," Response\n"," In the response, you can see the recommendedBid object having a recommended bid range as well as the recommended bid from that range. \n"],"documentType":"guide"},{"title":"Creating negative keyword targeting","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/targeting/negative-keyword-targeting","content":[" Negative keywords prevent your keyword targeted ads from displaying when the shopping queries of a shopper match your negative keywords. You can use negative keywords to exclude poorly performing keywords. This can help reduce your advertising cost and help increase your return on ad spend (ROAS). Negative keyword targeting can be used at the ad group level which will affect any ads under that specific ad group. \n"," Visit the support console for more information on negative product targeting.\n"," If you do not know what keywords to target, try using the negative keyword recommendations resource to get a list of negative keywords.\n"],"documentType":"guide"},{"title":"Creating negative keyword targeting","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/targeting/negative-keyword-targeting","content":[" You must have the following before creating a keyword:\n","A campaign ID \\* An ad group ID\n"],"documentType":"guide"},{"title":"Creating negative keyword targeting","sectionHeader":{"type":2,"text":"Create negative keyword targeting"},"path":"/en-us/guides/sponsored-brands/targeting/negative-keyword-targeting","content":[" Endpoint:\n"],"documentType":"guide"},{"title":"Creating negative keyword targeting","sectionHeader":{"type":3,"text":"Parameters"},"path":"/en-us/guides/sponsored-brands/targeting/negative-keyword-targeting","content":["| Name | Optional | Type | Description |\n","\\|--- \\|--- \\|--- \\|--- \\|\n","| adGroupId | No | string | The ad group to associated the campaign with |\n","| campaignId | No | string | The campaign to associated the target |\n","| keywordText | No | string | The keyword text |\n","| matchType | No | string | The negative match type. For more information, see negative keyword match types in the Amazon Ads support center. |\n","\\| \\| \\| \\| \\|\n"],"documentType":"guide"},{"title":"Creating negative keyword targeting","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-brands/targeting/negative-keyword-targeting","content":[],"documentType":"guide"},{"title":"Creating negative keyword targeting","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-brands/targeting/negative-keyword-targeting","content":[" A successful request results in a 207 response that contains a keywordId as shown below:\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" Product targeting allows you to choose specific products, categories, brands, or other product features that are relevant to the product in your ad. Use this strategy to help customers discover your product when searching products on Amazon. You can either choose to target individual products, or categories of products. \n"," You can view the suggested products section to get a list of recommended products for targeting if you are not sure what product to target. If you need help choosing a category to target, view the get all categories section to get a list of all available categories on Amazon.\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" You must have the following before creating product targeting expressions:\n","A campaign ID  An ad group ID  Create at least one product ad in each ad group.\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":2,"text":"Creating product targeting"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" Endpoint\n"," Parameters\n","|Name\t|Optional\t|Type\t|Description\t|\n","|---\t|---\t|---\t|---\t|\n","|adGroupId\t|No\t|string\t|The ad group to associate the campaign with\t|\n","|campaignId\t|No\t|string\t|The campaign to associate the target with\t|\n","|expression.type\t|No\t|string\t|For product targeting, always set to ASIN_SAME_AS (target an exact ASIN) or ASIN_EXPANDED_FROM (target an exact ASIN and other similar ASINs).\t|\n","|expression.value\t|No\t|string\t|The ASIN of the product you want to target.\t|\n","|bid\t|yes\t|float\t|Bid for the expression. If not specified, the ad group bid is used. See bid constraints by marketplace to see the maximum allowable bid (in local currency). For more information on bidding, visit cost-per-click bids\t|\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":3,"text":"Example"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" One ASIN This example creates a product targeting expression for ASIN B070000000. In this example, the bid will default to the ad group bid.\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" A successful request results in a 200 response that contains individual status messages for each targeting clause you created. You should check that the success array contains all objects you intended to create. Any failures are indicated in the createTargetErrorResults error array.\n"," Multiple ASINs You can only add one ASIN per targeting clause. If you want to target multiple ASINs, you should create two targeting clauses.\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":2,"text":"Creating product category targeting"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" You can target entire product categories, or add refinements. \n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":3,"text":"Supported expression types"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" All category targeting expressions must include ASIN_CATEGORY_SAME_AS. Different refinements are available based on the category.\n","|Predicate\t|Description\t|Example value\t|\n","|---\t|---\t|---\t|\n","|ASIN_CATEGORY_SAME_AS\t|Target the same category as the category expressed. Value is a category ID.\t|11056341\t|\n","|ASIN_BRAND_SAME_AS\t|Target the brand that is the same as the brand expressed. Value is a brand ID.\t|7048034011\t|\n","|ASIN_PRICE_LESS_THAN\t|Target a price that is less than the price expressed. Value is a price in account currency.\t|20.5\t|\n","|ASIN_PRICE_BETWEEN\t|Target a price that is between the prices expressed. Value is two prices in account currency separated by a hyphen.\t|10.5-12.5\t|\n","|ASIN_PRICE_GREATER_THAN\t|Target a price that is greater than the price expressed. Value is a price in account currency.\t|10.75\t|\n","|ASIN_REVIEW_RATING_LESS_THAN\t|Target a review rating less than the review rating that is expressed. Value is a number less than 5.\t|4\t|\n","|ASIN_REVIEW_RATING_BETWEEN\t|Target a review rating that is between the review ratings expressed.\t| 3-5\t|\n","|ASIN_REVIEW_RATING_GREATER_THAN\t|Target a review rating that is greater than the review rating expressed. Value is a number greater than 1.\t|3\t|\n"," Category with multiple refinements\n"," Endpoint: POST sb/targets\n"," The expression targets category 2522102011 with products specific to 7048034011 brand with a review rating between 3 and 4.5 stars.\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" A successful request results in a 200 response that contains individual status messages for each targeting clause you created. You should check that the success array contains all objects you intended to create. Any failures are indicated in the createTargetErrorResults array.\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":2,"text":"Product category targeting suggestions and refinements"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":3,"text":"Suggested products"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" If you do not know what products to target, Amazon can recommend products based on the ASINs you are advertising.\n"," Endpoint: POST sb/recommendations/targets/product/list\n"," Get a list of recommended products for targeting\n"," Response\n"," If the nextToken is populated, there are paginated results. To view the rest of the paginated results, you can specify this token for a future request to obtain the next page of results.\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":3,"text":"Get suggested categories"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" Endpoint: POST sb/recommendations/targets/category\n"," You can also request suggested categories based on a list of ASINs. This endpoint takes a list of ASINs and returns related categories that you could target. Note that all inputted ASINs should be similar, as the recommendations are for all ASINs in the request.\n"," The id parameter shown here is the categoryRefinementId. The categoryRefinementId is required in the path if using the GET /sb/targets/categories/{categoryRefinementId}/refinements endpoint.\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":3,"text":"Get all categories"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" Endpoint: GET /sb/targets/categories\n"," This endpoint returns a tree of all categories currently available on Amazon.com. You must add the query parameter supplySource.\n"," Example\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":3,"text":"Category refinements"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" Endpoint: GET /sb/targets/categories/{categoryRefinementId}/refinements\n"," Categories may have refinements available that you can use to further target ASINs within a category. Possible refinements include brands, age ranges, and genres. \n"," Example\n"," Response\n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":2,"text":"Bid recommendations "},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" Amazon can recommend bids based on keywords or targeting expressions. \n"],"documentType":"guide"},{"title":"Creating product targeting","sectionHeader":{"type":3,"text":"Examples"},"path":"/en-us/guides/sponsored-brands/targeting/product-targeting","content":[" Endpoint: POST /sb/recommendations/bids\n"," Bid recommendations by category\n"," Response\n"," Bid recommendations by ASIN\n"," Response\n"],"documentType":"guide"},{"title":"Creating negative product targeting","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/targeting/negative-product-targeting","content":[" Negative product targeting allows you to exclude certain products and brands from your targeting. You can create a negative targeting expression at the ad group level. All ads in an ad group will share targeting clauses.\n"," Visit the console for more information on negative product targeting.\n"],"documentType":"guide"},{"title":"Creating negative product targeting","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/targeting/negative-product-targeting","content":[" You must have the following before creating a keyword:\n","A campaign Id \\* An ad group Id\n"],"documentType":"guide"},{"title":"Creating negative product targeting","sectionHeader":{"type":2,"text":"Creating negative product targeting"},"path":"/en-us/guides/sponsored-brands/targeting/negative-product-targeting","content":[" Endpoint\n","| Name | Optional | Type | Description |\n","\\|--- \\|--- \\|--- \\|--- \\|\n","| adGroupId | No | string | The ad group to associate the campaign with |\n","| campaignId | No | string | The campaign to associate the target with |\n","| expressions.type | No | string | Either asinBrandSameAs or asinSameAs |\n","| expressions.value | No | string | You can get suggested brand IDs by keyword using the POST /sb/recommendations/targets/brand endpoint. |\n","\\| \\| \\| \\| \\|\n"," A successful request results in a 200 response that contains a targetId as shown below:\n"],"documentType":"guide"},{"title":"Sponsored Brands theme-based targeting","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/targeting/theme-based-targeting","content":[" Theme-based targeting is a curated set of keywords that enable brands to simplify the campaign creation process and improve campaign performance through well-performing targets. KEYWORDS_RELATED_TO_YOUR_BRAND gathers a set of keywords that are often used to search for brands and promote brand impressions. KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES provides a set of relevant keywords that drive traffic to brand store page or product detail pages. \n"],"documentType":"guide"},{"title":"Sponsored Brands theme-based targeting","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/targeting/theme-based-targeting","content":[" You must have the following before creating a keyword:\n","A campaign Id \\* An ad group Id\n"],"documentType":"guide"},{"title":"Sponsored Brands theme-based targeting","sectionHeader":{"type":2,"text":"Creating theme-based targeting"},"path":"/en-us/guides/sponsored-brands/targeting/theme-based-targeting","content":[" Endpoint\n"," Parameters\n","|Name\t|Optional\t|Type\t|Description\t|\n","|---\t|---\t|---\t|---\t|\n","|adGroupId\t|No\t|string\t|The identifier of the ad group to which the target is associated.\t|\n","|campaignId\t|No\t|string\t|The identifier of the campaign to which the target is associated.\t|\n","|themeType\t|No\t|string\t| KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.  KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages. Note: Additional theme types may be added in the future.\t|\n","|bid\t|no\t|number\t|The associated bid. Note that this value must be less than the budget associated with the advertiser account\t|\n"," Example\n"," Response\n"],"documentType":"guide"},{"title":"Sponsored Brands theme-based targeting","sectionHeader":{"type":2,"text":"Updating theme target"},"path":"/en-us/guides/sponsored-brands/targeting/theme-based-targeting","content":[" Endpoint\n"," Parameters\n","|Name\t|Optional\t|Type\t|Description\t|\n","|---\t|---\t|---\t|---\t|\n","|adGroupId\t|No\t|string\t|The identifier of the ad group to which the target is associated.\t|\n","|campaignId\t|No\t|string\t|The identifier of the campaign to which the target is associated.\t|\n","|themeId\t|No\t|string\t|The identifier of the theme target.\t|\n","|bid\t|No\t|number\t|The associated bid. Note that this value must be less than the budget associated with the Advertiser account\t|\n","|state\t|No\t|string\t|The state of the theme target. Can be set to enabled, paused, or archived.\t|\n"," Example\n"," Response\n"],"documentType":"guide"},{"title":"Sponsored Brands theme-based targeting","sectionHeader":{"type":2,"text":"Get a list of theme targets"},"path":"/en-us/guides/sponsored-brands/targeting/theme-based-targeting","content":[" Endpoint\n","|Name\t|Optional\t|Type\t|Description\t|\n","|---\t|---\t|---\t|---\t|\n","|nextToken\t|Yes\t|string\t|Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the NextToken field is empty, there are no further results.\t|\n","|maxResults\t|Yes\t|string\t|Sets a limit on the number of results returned by an operation.\t|\n","|themeIdFilter\t|Yes\t|string\t|A list of theme target identifiers. List limit is 100 items.\t|\n","|adGroupIdFilter\t|Yes\t|string\t|A list of ad group identifiers. List limit is 100 items.\t|\n","|campaignIdFilter\t|Yes\t|string\t|A list of campaign identifiers. List limit is 100 items.\t|\n","|stateFilter\t|Yes\t|string\t|A list of theme target states. State enums are paused, enabled, or archived.\t|\n","|themeTypeFilter\t|Yes\t|string\t|A list of theme target types. Types include: KEYWORDS_RELATED_TO_YOUR_BRAND KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES\t|\n"," Example\n"," Response\n"],"documentType":"guide"},{"title":"Shopper cohort bidding","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/bidding/shopper-cohort","content":[],"documentType":"guide"},{"title":"Shopper cohort bidding","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-brands/bidding/shopper-cohort","content":["Complete the Amazon Ads API onboarding and getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in the tutorial. \\* Understand the structure of Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Shopper cohort bidding","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/sponsored-brands/bidding/shopper-cohort","content":[" Sponsored Brands bidding control allows you to adjust bids and engage with audiences created in Amazon Marketing Cloud (AMC), a privacy-safe cloud-based clean room solution. For example, using the bidding controls, you can single out shoppers who clicked a certain product but did not purchase it, and then selectively modify the bids for these shoppers within your campaigns. Afterwards, you can view the campaign performance for these shoppers using our reporting tools.\n"],"documentType":"guide"},{"title":"Shopper cohort bidding","sectionHeader":{"type":2,"text":"Check the availability of AMC audience groups"},"path":"/en-us/guides/sponsored-brands/bidding/shopper-cohort","content":[" For more guidance on creating an AMC audience group, read our rule-based audiences guide or learn how to create audiences using the AMC UI.\n"," You can grab a list of targetable AMC audiences through the Audience Discovery API:\n"],"documentType":"guide"},{"title":"Shopper cohort bidding","sectionHeader":{"type":2,"text":"Using sponsored cohort bidding"},"path":"/en-us/guides/sponsored-brands/bidding/shopper-cohort","content":[" After finding a targetable audience, reference it when creating a campaign:\n"],"documentType":"guide"},{"title":"Shopper cohort bidding","sectionHeader":{"type":2,"text":"FAQs"},"path":"/en-us/guides/sponsored-brands/bidding/shopper-cohort","content":[" We only allow one audience group per one campaign. If you want to adjust the bid for a new segment, you either need to create a new campaign for this new segment or replace the existing segment in the existing campaign with the new segment.\n"," Access the Amazon Marketing Cloud tab in the measurement and reporting section. Then, select the instance and advertiser to run a query with. Finally, download the report from the AMC reporting tab.\n"," Sample query:\n"," You can update the segment and bid adjustment percentage through the API.\n"," You can use both cost control and shopper cohort bidding in Sponsored Brands to optimize the cost while engaging with a specific shopper cohort. If you choose to adjust bids for an AMC shopper segment while cost control is enabled, the expected cost target of this AMC segment is adjusted accordingly. This allows you to value certain shopper cohorts while still controlling your campaign cost. For example, if you set the cost control for a campaign at $2.0, and then increase the bid for an AMC segment by 50%, the target cost KPI for this segment will ultimately be adjusted to $2.0 x (1+50%), or $3.0.\n"],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":null,"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[" Reserve share of voice enables advertisers to secure top-of-search (TOS) Sponsored Brands placements for branded keywords at a fixed, upfront price. By reserving branded keywords, advertisers ensure that their ad will appear on Sponsored Brands top-of-search placement for those branded queries most of the time. Branded search represents one of the most valuable opportunities to engage shoppers who are actively seeking a brand. Yet advertisers often experience variability in how their brand appears in search results, which can make it harder to consistently connect with these high-intent shoppers. With this feature, brands can count on predictable presence to boost brand visibility on top-of-search and shoppers can engage with branded content matching their queries. \n"],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":2,"text":"Get started with reserve share of voice"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[" To get started with reserve share of voice, complete the following steps:\n","(Optional) Get keyword recommendation. 2. (Optional) Validate keywords. 3. (Optional) Get pricing. 4. Create a deal. 5. Create at least five deal targets. 6. Set deal.state to PROPOSED. This step triggers the internal pricing engine to calculate the price and assign it to the deal. 7. Create a campaign with targetPGDealId. You can only create a campaign with targetPGDealId for a deal in the PROPOSED state.\n"],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":2,"text":"Reserve share of voice operations"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"Get keyword recommendations for branded keywords"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"Keyword validation"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[" To reserve keywords not in the recommendation list, call this API to check whether they can be reserved.\n"],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"Get Pricing"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"Create a deal"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"Create deal targets"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"List deal targets"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"Delete deal target"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"Update deal state to proposed"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[" This API will also assign a price to the deal using the pricing API.\n"],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"Get deal by deal ID"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"Create a reserve share of voice campaign"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[],"documentType":"guide"},{"title":"Reserve share of voice","sectionHeader":{"type":3,"text":"Delete deal"},"path":"/en-us/guides/sponsored-brands/reserve-share-of-voice","content":[" A deal in PROPOSED state cannot be modified. This means update deal, add deal target, and delete deal target are not allowed. However, you can delete a PROPOSED deal if currentTime is less than deal.startDateTime - 12 hours. If you delete a deal, it also deletes associated deal targets and archives the associated campaigns.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":null,"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":[],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":{"type":2,"text":"I. Introduction"},"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":[" Sponsored Brands (SB) advertisers can now upgrade their legacy (Version 3) campaigns to the new ad group-based structure (Version 4). This migration provides key benefits such as enhanced campaign organization through structured ad groups, access to new theme targeting options, shopper cohort bidding, cost controls, landing page edits, etc. The upgrade unifies campaign management for all Sponsored Brands advertising, streamlining the advertiser experience. \n"," To facilitate this transition, we have developed migration APIs that enable advertisers and partners to independently convert their campaigns to the new structure.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":{"type":2,"text":"II. What are the key benefits?"},"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":[" Below are the key benefits of using new ad group campaigns. See FAQ#26 for full list.\n","Consolidate and simplify campaign structure in a way that works for you by creating ad groups that align with your marketing strategies and goals.  2. New reporting:  The V4 campaigns supports new metrics such as brandedSearchesViews, brandedSearchRate, eCPBrandSearch, addToCartViews, newToBrandDetailPageViewViews, and newToBrandDetailPageViewClicks. 3. Goal-based campaigns: The V4 campaigns allow you create goal-based campaigns to help different brands prioritize different brand building goals depending on their marketing strategy and their brand building journey. You can create campaigns with new goals: “Drive Page Visits”, “Grow Brand Impressions Share”, “Acquire new customers”\\* and “Ad Views”\\*; each with a unique set of campaign controls to achieve that goal. 4. Theme-based targeting: To help drive advertiser goals, theme targeting is a new method to control your campaign targeting. It uses advanced machine learning algorithms that take into account historical performance targets and brand interactions to create a large set of keywords. It then categorizes those keywords into relevant groups to use with your campaigns. Two targeting groups are available in this launch: “Keywords related to your landing pages.” and “Keywords related to your brand”. These targeting groups will be pre-selected to simplify the campaign creation process for advertisers. 5. New ad formats: 6. Accessibility and Editability: Supports creative edits for all ad formats and edit landing page URL. Each ad can have individual landing pages within same ad group. You can now update your ad group based campaigns landing page URLs without recreating new ad group or campaign. 7. Monitor performance of ad group campaigns with reports. You can easily retrieve reports based on keywords, campaign placement, search terms, attributed purchases, and more. Plus, you will no longer need to run separate reports for different campaign types and manually calculate the performance of your ad spend for Sponsored Brands. 8. Make the most of testing based on your goals, whether that is building brand awareness, driving consideration, or increasing sales. You can test targeting against different ad formats or landing pages and measure the performance. Plus, you can test different versions of the same ad formats within the same ad group to get a better understanding of shopper behavior. 9. Use consistent strategies across Amazon Ads sponsored ads products to run your campaigns more effectively. The ad groups feature is also available for both Sponsored Products and Sponsored Display.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":{"type":2,"text":"III. Limitations "},"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":["The Migration API works asynchronously. When the API is called, it does not instantly migrate the campaigns. Instead, the campaigns are migrated in the background. Status APIs must be called to check the current migration status.  An advertiser can run only one ongoing migration job at a time. Submitting a list of Campaign IDs for migration while another job is in progress will cause the new job to fail.  We do not recommend using shadow campaigns for migration unless you need to create and retrieve new Campaign IDs to update your system before other entities are created.   Migrated campaigns may require re-moderation according to the latest ad policies. Consequently, they may take up to 72 hours to complete the moderation process.  While ad spends for migrated campaigns (from legacy systems) will be backfilled, discrepancies may occur due to the nature of the distributed system. The system might receive impression events after the legacy (Version 3) campaign has been migrated and archived. \\* Legacy (Version 3) campaigns will archive immediately after the new campaign is created and all associated entities (ads, creatives, keywords) are verified to match the V3 campaign.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":{"type":2,"text":"IV. Migration Sequence"},"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":[],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":{"type":2,"text":"V. Sample Requests"},"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":[],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/migrationJob"},"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":[" The enableThemeTargeting property adds theme-based targeting based to your new version 4 campaigns. Default is true; to disable, set to false.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/migrationJob/results"},"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":[],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/migrationJob/status"},"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":[],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":{"type":2,"text":"VI. Important notes"},"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":["Begin with zero sales/impressions campaigns in XX numbers, and wait for the migration job to complete. Since the advertiser can only run one migration job at a time, it is recommended to wait for the ongoing migration job to finish before starting another.  The start date of the migrated campaign will be updated to the date the migration begins, while the campaign name will remain the same with a migrated suffix appended.  Once a legacy (Version 3)  campaign enters the migration phase, avoid making any updates or deletions to related entities such as ad groups, ads, keywords, or targets. Modifying these entities during migration may disrupt the process and result in an incomplete migration.  Ensure that the brandEntityId is included in the startMigrationJob request for seller accounts. If not provided, the migration job will attempt to fetch the existing brandEntityId associated with the campaign. If multiple or no brandEntityId is found, the campaign migration will fail.  The legacy campaign ID can be retrieved from the tags of the migrated version 4 campaign. It is stored under the legacyCampaignId key in the tags of the migrated campaign.  Ensure that the legacy campaign has a custom image added under creative. If no custom image is present, the campaign migration will fail.  The supported landing pages for V2 campaigns include Simple Landing Page, Stores Page, Detail Page, and Custom Landing Page. The campaign migration will fail for non-supported custom landing pages. \\* The migration job duration can vary from several minutes to several hours, depending on the overall traffic received by the Migration APIs.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns using the legacy campaigns migration API","sectionHeader":{"type":2,"text":"VII. Frequently Asked Questions"},"path":"/en-us/reference/migration-guides/sb-v3-v4-api","content":[" Advertiser can use phased migration approach, focusing on systematically moving low-impact campaigns and advertisers with fewer campaigns. By starting with a small, carefully selected subset of campaigns, teams can identify potential issues, validate performance metrics, and ensure a smooth transition. The migration strategy prioritizes gradual implementation, allowing for real-time issue detection and mitigation, which protects advertiser interests and maintains system integrity. This methodical approach enables advertisers to confidently move their campaigns while minimizing potential disruptions, ultimately creating a more robust and reliable advertising ecosystem that supports incremental transformation and risk management.\n"," This APIs only supports Sponsored Brands legacy campaign with the campaign state enabled or paused is eligible for migration. The campaign with archived status are not eligible for the migration.\n"," Migration Deadline Requirements\n"," Advertisers must complete campaign migrations in two phases:\n","Deadline:  October 19th, 2025 \\* Action: Migrate all campaigns with no impressions\n","Phase#2:  Impression and Sales Generating Campaigns\n","Deadline: December 31st, 2025 \\* Action: Migrate campaigns with active impressions and sales\n"," Automatic Migration Contingency:  Automatic Migration Contingency: If advertisers do not complete voluntary migrations by October 19th, Amazon will archive the zero impression campaigns and automatically migrate the all Version 3 (V3) campaigns to Version 4 (V4) campaigns starting January 1st, 2026. \n"," With the Amazon Theme Targeting, advertisers can now effortlessly expand their campaign reach using advanced machine learning algorithms. Customers benefit from intelligent keyword discovery that automatically identifies relevant search terms based on landing pages and brand interactions. By pre-selecting targeting groups, advertisers can simplify campaign creation, reduce manual keyword research, and increase the likelihood of reaching potential customers more effectively.\n"," With the Amazon Migration API, advertisers can now manage campaign transitions with precision and data integrity. The migration process ensures a clean transfer of campaign settings and structures while preventing unintended performance data carryover. Advertisers gain control over their data continuity by leveraging shadow campaign migration, enabling them to manually link and track performance metrics across version transitions. This approach empowers advertisers to maintain comprehensive performance insights while supporting a systematic, controlled migration that prioritizes data accuracy and system flexibility.\n"," With the Amazon Migration Console, advertisers can now easily track and manage campaign transitions with unprecedented clarity. The Ad Console automatically distinguishes migrated campaigns by appending a -migrated postfix to new Version 4 campaigns, while legacy campaigns are clearly marked as Archived. This transparent approach ensures advertisers can seamlessly monitor their campaign status, with legacy campaigns automatically archiving only after successful Version 4 campaign creation. If migration encounters issues, the original campaign remains original status, preventing potential disruptions to ongoing advertising efforts.\n"," After creating a staged campaign, only the campaignId will be accessible. However, this campaignId cannot be used to retrieve the campaign data. Once you are ready to enable staged campaign you should invoke POST /sb/v4/legacyCampaigns/migrationJob API with isStagedMigration as false to enable the staged campaign.  The campaign data and all its child entities can only be accessed after campaign migration is successfully completed. \n"," No, campaigns under pending moderation will not be allowed to migrate. You can request the migration once moderation is approved/rejected. Any legacy campaign with the state enabled or paused and for which moderation is not pending is eligible for migration.\n"," You should retry once, Amazon will be alarmed in such case and will look at potential options to resolve such cases. Sometimes it can be a simple retryable network glitch and other times it may be due to the fact that old campaign not being compatible with new campaign. Either ways migration job will not archive legacy campaign unless new campaign is created with all the properties of legacy campaigns. We will expose another field called error codes along with error reason so that you can retry/not retry based on the response.\n"," Currently for non retryable errors you should not retry migration but rather reach out to Amazon API support team for guidance. For retry-able errors you can retry upto 3 times per day.\n"," For the very first instance we would recommend 10 campaigns and closely track the status along with details of new campaign to understand end to end impact. Once, small scale testing is done you can go upto 1000-1500 per job(number will get finalized once we go through stress testing).\n"," The max limit 1000 campaigns. \\*number will get finalized once we go through stress testing.\n"," It is important not to manually archive legacy campaigns once new campaigns are created in the staging phase. This is because staged campaigns are not live campaigns. Staged campaigns are not active, so they will not receive any clicks or impressions. If you archive the campaign manually then campaign will not be converted through migration APIs. You will have to create fresh campaign through existing campaign using similar properties\n"," New campaigns maybe moderated as per latest policies, currently there is an open item in progress to try and auto approve/reject based on legacy campaign’s migration status\n"," It will fail with non retryable error. \n"," Post launch of new campaign, you can use V4 campaign management APIs for campaign, adgroup, ad and fetch campaign, adgroup, ad for legacy and migrated campaign to migrate all entities. You can also verify keywords by invoking /sb/keywords and /sb/negativeKeywords by using legacy and migrated campaignIds.\n"," You can create a new campaign using current campaign management APIs or through Ad console based on current properties of a legacy campaign. However they will go through moderation again and re-moderated. Key advantage with this approach is you can archive/disable legacy campaign based on your control and also provides flexibility to use some of the new features at the time of campaign creation itself.\n"," We would recommend creating a campaign with new properties through v4 campaign management APIs if you need to go beyond cloning of the campaign. Migration API will only clone the campaign properties without adding any new controls to avoid unwanted discrepancies. All newly cloned campaigns will default to “Drive Page Visits” as goal with  CPC as a costType.\n"," No, this is not allowed. Only enabled and paused campaigns without any pending moderation are in scope of migration.\n"," Make sure no updates have been applied to campaign since staging and reach out Amazon support for further deep dive because its possible that you can miss last updates during transition state.\n"," Ideally we expect this to be as near as possible to avoid the possibility of campaign properties being updated or re-moderated. \n"," The migration job duration can vary from several minutes to several hours, depending on the overall traffic received by the Migration APIs.\n"," If your campaign migration fails, you can identify the error reason by checking the status reason of the campaign in the response from the POST /sb/v4/legacyCampaigns/migrationJob/results API. The failure is most likely due to a validation error, which means the advertiser needs to update the campaign to make it compatible for migration.\n"," While it is unlikely that this will happen, if your campaign migration fails without a status reason, please reach out to API support for assistance at the following link: API Support.\n"," We store the legacy campaignId in the tags of newly migrated campaign. You can find the legacy campaignId under those tags.\n","|No\t|Feature Group\t|Feature\t|Legacy Campaigns\t|Adgroup Campaigns\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|1\t|Goal\t|BRAND_IMPRESSION_SHARE\t|Not Available\t|Available\t|\n","|2\t|\t|PAGE_VISIT\t|Not Available\t|Available\t|\n","|5\t|\t|Smart Default\t|Not Available\t|Available\t|\n","|6\t|CostType\t|CPC\t|Available\t|Available\t|\n","|7\t|\t|VCPM\t|Not Available\t|Available\t|\n","|8\t|\t|Capability to create Multi Adgroup and Ad\t|Not Available\t|Available\t|\n","|\t|Bidding\t|AMC Shopper Cohort Bidding\t|Not Available\t|Available\t|\n","|\t|\t|New to Brand Cohort Bidding\t|Not Available\t|Upcoming\\*\\*\t|\n","|\t|\t|Top of Search Placement Bidding\t|Not Available\t|Upcoming\\*\\*\t|\n","|9\t|Targeting\t|Keyword\t|Available\t|Available\t|\n","|10\t|\t|Product Targeting\t|Available\t|Available\t|\n","|11\t|\t|Theme Targeting\t|Not Available\t|Available\t|\n","|12\t|Ad Format\t|Brand Video\t|Not Available\t|Available\t|\n","|13\t|\t|Vertical Video\t|Not Available\t|Available\t|\n","|14\t|\t|Slideshow with custom images\t|Not Available\t|Available\t|\n","|15\t|Creatives\t|Creative Edits\t|Basic available for Product Collection only\t|Available for all ad creatives (Product Collection, Store Spotlight, Video, Brand Video, Multi-ASIN Video, Vertical Video, Slideshows)\t|\n","|16\t|\t|Landing Page Edits\t|Not Available\t|Available\t|\n","|17\t|Reporting\t|New Metrics: addToCart, addToCartRate, eCPAddToCart, newToBrandDetailPageViews, newToBrandDetailPageViewRate, newToBrandECPDetailPageViews\t|Not Available\t|Available\t|\n","|18\t|\t|Support of Adgroup ID and Ad ID in SB Purchased Product Reporting\t|Not Available\t|Available\t|\n","|19\t|\t|V3 Reporting\t|Will be avaible Q3, 2024\t|Available\t|\n","|20\t|\t|Future new metrics support\t|Not Available\t|Available\t|\n","|21\t|Amazon Marketing Stream (AMS)\t|Amazon Marketing Stream (AMS)\t|Not Available\t|Available\t|\n","|22\t|Authors\t|Product Collection and Video\t|Not Available\t|Available\t|\n","|23\t|\t|Creative Edits\t|Not Available\t|Available\t|\n","|24\t|\t|Kindle Edition Normalized Page (KNEP) - Reads and Royalties metric\t|Not Available\t|Available\t|\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":null,"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" Sponsored Brands advertisers can now create ad groups to better organize and manage their campaigns. Ad groups are a way to organize and manage your campaign by brand, keywords, product, category, ad format, landing page, or other classifications that tie to your goals or marketing strategy. Brands can test different creatives within the same ad group, enabling advertisers to compare the performance and develop a better understanding of Amazon shopper behaviors.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Key benefits"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":["Structure your campaigns in a way that works for you by creating ad groups that align with your marketing strategies and goals. 2. Monitor performance of ad group campaigns with reports. You can easily retrieve reports based on keywords, campaign placement, search terms, attributed purchases, and more. Plus, you will no longer need to run separate reports for different campaign types and manually calculate the performance of your ad spend for Sponsored Brands.  3. Make the most of testing based on your goals, whether that is building brand awareness, driving consideration, or increasing sales. You can test targeting against different ad formats or landing pages and measure the performance. Plus, you can test different versions of the same ad formats within the same ad group to get a better understanding of shopper behavior.  4. Use consistent strategies across Amazon Ads sponsored ads products to run your campaigns more effectively. The ad groups feature is also available for both Sponsored Products and Sponsored Display.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Endpoint equivalencies"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":["| Version 3 | Version 4 beta | Version 4 general availability |\n","\\|-----------\\|------------\\|-------------\\|\n","| POST /sb/campaigns | POST /sb/beta/campaigns | POST /sb/v4/campaigns |\n","| GET /sb/campaigns  GET /sb/campaigns/{campaignId} | POST /sb/beta/campaigns/list | POST /sb/v4/campaigns/list |\n","| PUT /sb/campaigns | - | PUT /sb/v4/campaigns |\n","| DELETE /sb/campaigns/{campaignId} | - | POST /sb/v4/campaigns/delete |\n","| GET /sb/adGroups  GET /sb/adGroups/{adGroupId} | POST /sb/beta/adGroups/list | POST /sb/v4/adGroups/list |\n","| - | POST /sb/beta/adGroups | POST /sb/v4/adGroups |\n","| - | POST /sb/beta/adGroups/delete | POST /sb/v4/adGroups/delete |\n","| - | PUT /sb/beta/adGroups | PUT /sb/v4/adGroups |\n","| - | POST /sb/beta/ads/list | POST /sb/v4/ads/list |\n","| - | POST /sb/beta/ads/video | POST /sb/v4/ads/video |\n","| - | POST /sb/beta/ads/brandVideo | POST /sb/v4/ads/brandVideo |\n","| - | POST /sb/beta/ads/productCollection | POST /sb/v4/ads/productCollection |\n","| - | POST /sb/beta/ads/storeSpotlight | POST /sb/v4/ads/storeSpotlight |\n","| - | PUT /sb/beta/ads | PUT /sb/v4/ads |\n","| - | POST /sb/beta/ads/delete | POST /sb/v4/ads/delete |\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Frequently asked questions"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"How much time do I have to migrate from the beta endpoints to the general availability endpoints?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" The version 4 beta end points will be available until August 31, 2023. After August 31th, all request calls that use the beta endpoints will be rejected. \n"," See Deprecations for more information. \n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Is there any difference between version 4 beta and general availability endpoints?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" No, there are no functional or contractual changes between version 4 general availability and open beta endpoints.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"How are multi-ad group campaigns different from the current campaign structure?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" The current campaign endpoints do not allow you to create or update ad groups, or associate ad creatives to ad groups. The current campaigns contain read-only ad groups where creatives are associated with campaigns instead of ad groups. \n"," In this guide, we refer to the current campaigns without multi-ad group support as legacy campaigns whereas campaigns with multi-ad group support are referred to as multi-ad group campaigns. The new multi-ad group campaigns contain three entities: campaigns, ad groups, and ads. Refer to diagram below to understand campaign hierarchy.\n","Campaigns: Campaigns group your ads by their advertising budgets and dates.   Ad groups: Ad groups let you organize and manage your ads by brand, keywords, product, category, ad format, landing page, or other classifications that tie to your goals.  Ads: Use ads to manage different variations of your creatives. Associate multiple ads with each ad group that share the same landing page but different ASINs, headlines, life style images, product category, or videos.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"What API changes are required to support multi-ad group campaigns?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" We recommend you migrate to the newest version of Sponsored Brands campaign management APIs, which are now generally available. The new version lets advertisers create and manage multi-ad group campaigns, as well as read any previously created Sponsored Brands campaigns. The list campaigns response includes a new field isMultiAdGroupsEnabled that returns true if the campaign is built on the newest version. \n"," You can view our Creating multi-ad group campaigns tutorial to view the steps and examples for using the new endpoints. \n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"What is the impact of using the existing [version 3 GET campaigns endpoint](sponsored-brands/3-0/openapi#tag/Campaigns/operation/listCampaigns)?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" The current version 3 GET endpoint provides you with limited support for multi-ad group campaigns. The GET response will only include the first creative from the multi-ad group campaign. \n"," If you are using the version 3.3 GET campaigns endpoint, then the response includes optional fields isMultiAdGroupsEnabled, adGroupCount, and adCount. These fields will help you determine whether campaign is multi-ad group enabled and the number of ad groups and ads in the campaign. We recommend that you use the version 4 campaigns list endpoint to retrieve campaign-level details for all campaign types.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Can I add multiple ad groups to legacy campaigns?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" Adding new ad groups to legacy campaigns is not allowed. The ad groups for these campaigns only support GET operations. Ad group creation and management are only supported for new multi-ad group campaigns through new version 4 endpoints. If you try to update a legacy ad group using the version 4 endpoints, you will receive an INVALID_ARGUMENT error.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"How do I update or archive multi-ad group campaigns?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" View our Managing multi-ad group campaigns guide for more information.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"What changes are required to retrieve reporting data using reporting API?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" To retrieve reporting data for multi-ad group campaigns, you must include \"creativeType\": \"all\" as part of your report request. Reports using this filter return reporting data from both multi-ad group and legacy campaigns.\n"," For Ads reports, multi-ad group campaigns will support the adId metric so you can track the performance of your ads. For legacy campaigns, you will not receive adId in the ad report.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Is there any impact to targeting and recommendation APIs?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" There is no change to the targeting or recommendation endpoints. The existing endpoints are compatible with all types of campaigns. There is no moderation for keywords in new campaigns. The keywords become active as soon as they are added to ad groups.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Are there any changes to ad creative moderation?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" For multi ad group campaigns, only ads get moderated for the ad policy. If your ad gets rejected due to an ad policy violation, then your campaign status remains unchanged. In legacy campaigns, the creatives are linked to campaigns so if the creative gets rejected due to ad policy your campaigns status will change to rejected. You can use the moderation API to check the moderation status of your ads. \n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"What ad formats are supported?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" The new APIs support ad format Product Collection, Store Spotlight, Video and Brand Video. You can take advantage of our new ad format brand video to link your branded video to store pages. \n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Is there any change to creatives in version 4?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" Yes, you need to use the Asset library API upload both video and image creatives and generate an assetId. You can then use the assetId when creating ads. \n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Do ads created as part of version 3 campaigns have an `adId`?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" No. Any ads created as part of a version 3 campaign will not have an associated adId or name. To learn more, see Managing ads.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Why are some of my creatives missing fields in [`POST sb/v4/ads/list`](sponsored-brands/3-0/openapi/prod#tag/Ads/operation/ListSponsoredBrandsAds) and [`GET sb/campaigns`](sponsored-brands/3-0/openapi#tag/Campaigns/operation/listCampaigns)?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" Some advertisers have experienced a known issue where older creatives are missing creative-level fields. To ensure you receive all creative-level fields, we suggest uploading a more recent version of the creative asset.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Why is my campaign `state` showing as `ENABLED` in version 4 for legacy campaigns?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" The campaign state for legacy campaigns differs in the response from version 3 and version 4 GET campaigns endpoints. The campaign state in version 3 includes a combination of action taken by the user and campaign serving status. In the version 4 GET response, we have standardized state management for legacy and multi-ad group campaigns where campaign state field represents user action, and campaign servingStatus in the extended data fields will help you identify the serving state of the campaign. This approach brings similarity with Sponsored Products and Sponsored Display campaign state management. If you are looking to maintain similar state response for legacy campaigns, we recommend that you start using a combination of campaign state and campaign service status.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":["Campaigns version 4 API reference - Ad groups version 4 API reference - Ads version 4 API reference - Creating campaigns - Managing multi-ad group campaigns\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"June 2023 update"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" Sponsored Brands is changing the backend data storage for legacy version 3 APIs for consistency across all sponsored ads programs. Sponsored Brands version 3 campaign management APIs now create new campaigns and drafts using version 4 multi-ad group campaign structure. There is no change to the API contracts or request/response objects. All version 3 campaign management APIs will continue to work as expected without any changes. \n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Who is affected?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" Advertisers, agencies, and tool providers currently using Sponsored Brands (SB) legacy version 3 APIs to create campaigns or drafts. This backend change was completed in the US marketplace on May 22, 2023, followed by all other supported marketplaces on August 10, 2023.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"What is the impact?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":["|API\t|Description\t|\n","|---\t|---\t|\n","|POST /sb/campaigns\t|Any new campaigns created using this endpoint will create campaigns with one ad groups and one ad. The name of the ad group and ad will be the same as the name of campaign. WARNING: If multiple ads or ad groups are added to the campaign, the version 3 GET /sb/campaigns endpoint will return the creative/adFormat of only the first ad from the campaign.\t|\n","|POST /sb/drafts/campaigns\t|New drafts will be saved as a version 4 campaign in the backend.\t|\n","|POST /sb/drafts/campaigns/submit\t|If you have an existing draft or brand new draft, upon submission, the campaign will be converted into a multi-ad group campaign.\t|\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Why are we making this change?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" All Amazon sponsored ads programs are moving towards a common domain model that uses an industry-standard ad groups data structure. With this change, advertisers get a standard experience for new campaigns across legacy version 3 and version 4 APIs. The new campaigns created after 05/23 will have ad groups campaign structure and support campaign management through both version 3 and version 4.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Will there be any impact to my Amazon advertising console experience?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" The advertising console will show campaigns in the  multiple ad groups format going forward. You can drill down further into the hierarchy across campaign, ad groups, and ads. These workflows and information cards have been available in the advertising console since October 2022. If you are already using the advertising console to create campaigns, you will now see consistent behavior for campaigns created using the version 3 APIs. \n"," A campaign details page for legacy campaigns is shown in the screenshot below. On the screen, there are no ad group features.\n"," The image below depicts an example of a campaign detail page for a multi-ad group campaign. On-screen ad group features are emphasized \n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"What if I create additional ad groups or ads in the Amazon advertising console? "},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" If you create additional ad groups or ads in a campaign created using version 3 APIs, you will see only the first ad group. If there are other ad groups or ads in the campaign, they will not be visible in version 3 APIs. Legacy Sponsored Brands version 3 APIs will not get any new features. We encourage our partners to migrate to Sponsored Brand version 4 APIs to take advantage of new features and create campaigns with multiple ad groups.\n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"What changes are required to retrieve reporting data using reporting API?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" There will be no impact to reporting. The performance data for all campaigns created via the advertising console, bulksheets, legacy version 3 APIs, and version 4 APIs will be included in the version 2 reporting APIs. \n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Are there any changes to ad creative moderation?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[" In legacy campaigns, the creatives were linked to campaigns, so if the creative was rejected due to ad policy, then your entire campaign status was changed to rejected. In the new ad groups based campaigns, individual ads are moderated for ad policy adherence. Your campaign status will remain unchanged even if one of the ads in the ad groups hierarchy is rejected. You can use the moderation API to check the moderation status of your ads. \n"],"documentType":"guide"},{"title":"Migrating to version 4 Sponsored Brands campaigns","sectionHeader":{"type":3,"text":"Need help?"},"path":"/en-us/reference/migration-guides/sb-v3-v4","content":[],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":null,"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" This guide helps you transition from the deprecated Product Collection ad type to the new Collections (Manual and Automatic) ad type for Sponsored Brands.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" There are two collection types:\n","Manual Collections - Select 3-10 related products to feature in your ad. This ad type supports keyword or product targeting and gives you full control over which products to showcase. \\* Automatic Collections - Let the Amazon AI dynamically group the most relevant products from your catalog into collections based on your keyword targets and shopper search queries.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":2,"text":"Key Benefits"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":["Expand product discoverability - Feature up to 10 related products in a single ad (vs. 3 with Product Collection), engaging shoppers in high-visibility placements across the Amazon Store.  Branded shopping experience - Collections highlight key product details (titles, ratings, pricing, delivery) for quick evaluation and purchase, and connect shoppers to branded landing pages where they can explore more from your catalog.  Scaled campaign creation and optimization - Automatic Collections use Amazon AI to surface the best combination of products based on keyword targets and shopper queries - no need to manually set up and optimize multiple campaigns.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":2,"text":"Timeline"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":["| Date | What happens |\n","\\| --- \\| --- \\|\n","| June 2026 | Product Collection ad type is deprecated. |\n","| August 2026 | Requests to create new Product Collection ads will succeed but create a Manual Collection ad instead. Any custom images provided will be accepted but will not render. Manual collections require at least 3 ASINs; requests with fewer than 3 ASINs will fail. Manual collection titles are limited to 32 characters, requests to create Product Collection ads with headlines over 32 characters will fail. |\n","| January 2027 | Final shutoff. All API requests to create Product Collection ads will be rejected with an error. |\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":2,"text":"Endpoint equivalencies"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"If you are on [Amazon Ads API V0](sponsored-brands/3-0/openapi/prod)"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":["| Description | Deprecated endpoint | New endpoint | Reference | Request Payload Example |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| Create Manual collection ads | POST /sb/v4/ads/productCollection  POST /sb/v4/ads/productCollectionExtended | POST /sb/v4/ads/manualCollection | CreateSponsoredBrandsManualCollectionAds | Manual collection ads with new landing page |\n","| Create Automatic collection ads | - | POST /sb/v4/ads/autoCollection | CreateSponsoredBrandsAutoCollectionAds | Automatic collection ads |\n","| Update Manual collection ads by creating new version | POST /sb/ads/creatives/productCollection  POST /sb/ads/creatives/productCollectionExtended | POST /sb/ads/creatives/manualCollection | UpdateSponsoredBrandsManualCollectionAds | Change to a new landing page |\n","| Update Automatic collection ads by creating new version | - | POST /sb/ads/creatives/autoCollection | UpdateSponsoredBrandsAutoCollectionAds | Update brand logo in automatic collection ads |\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"If you are on [Amazon Ads API V1](reference/amazon-ads/overview)"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":["| Description | Deprecated field | New field | Reference | Request Payload Example |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| Create Manual collection ads | creative.componentCreative.productCollectionSettings | creative.componentCreative.manualCollectionSettings | CreateAd API with manualCollectionSettings | Create ad - manual collection |\n","| Create Automatic collection ads | - | creative.componentCreative.autoCollectionSettings | CreateAd API with autoCollectionSettings | Create ad - automatic collection |\n","| Update Manual collection ads | creative.componentCreative.productCollectionSettings | creative.componentCreative.manualCollectionSettings | UpdateAd API with manualCollectionSettings | - |\n","| Update Automatic collection ads | - | creative.componentCreative.autoCollectionSettings | UpdateAd API with autoCollectionSettings | - |\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":2,"text":"Frequently asked questions"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"How much time do I have to migrate from the Product Collection endpoints to the Collections endpoints?"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" The Product Collection endpoints will continue to function until January 2027. Starting August 2026, requests to create new Product Collection ads will succeed but create a Manual collection ad instead. Any custom images provided will be accepted but will not render. Post January 2027, all requests to create Product Collection ads will be rejected with an error.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"What happens if I do not update my API integrations by August 2026?"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" Starting August 2026, requests to create new Product Collection ads will succeed but create a Manual collection ad instead. Any custom images provided will be accepted but will not render. Manual collections require at least 3 ASINs, requests to create Product collections with less than 3 ASINs will fail. Manual collection titles are limited to 32 characters, requests to create Product Collection ads with headlines over 32 characters will fail.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"What are the key differences between Product Collection and Collections endpoints?"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" Collections endpoints let you feature more products per ad (up to 10 vs. 3), generate titles automatically, and use AI to select products for you. Lifestyle images are no longer supported, and landing pages are auto-generated for Automatic Collections.\n","| Request Field | Product Collection (Deprecated) | Manual Collection | Auto Collection |\n","\\| --- \\| --- \\| --- \\| --- \\|\n","| Products per ad | 0 - 3 | 3 - 10 | 3 - 10 (automatically selected from your catalog by Amazon AI) |\n","| Title/Headline | Required | Auto-generated or provide your own (optional) | Auto-generated |\n","| Lifestyle image | Required | Not supported | Not supported |\n","| Landing page | Brand store or New landing page | Brand store or New landing page | Auto-generated |\n","| Brand logo | Required | Optional | Optional |\n","| Targeting | Keyword or Product | Keyword or Product | Keyword only |\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"Will my existing Product Collection ads stop serving impressions?"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" No. Existing Product Collection ads will continue to serve impressions and can be read, queried, paused, or deleted via the current API endpoints. No action is needed for running ads.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"Do I need to recreate my existing Product Collection ads as Collections?"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" No. We will provide tools and guidance to help you migrate existing Product Collection ads to the Collections format. Migration guidelines will be released soon.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"Can I use the same campaign and ad group structure?"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" Yes. Collections ads use the same campaign and ad group hierarchy. You only need to change the ad creation endpoint and request payload. Refer to examples for reference.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"How do I identify existing Collection ads in the ListAds response?"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" The creativeType field distinguishes ad types: PRODUCT_COLLECTION for legacy ads, MANUAL_COLLECTION and AUTO_COLLECTION for the new ad types.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"Are reporting endpoints affected? What about my Product collections historic data?"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" No. Existing Sponsored Brands reporting endpoints and reports continue to work for all collection types without changes. Product collections historic data will remain accessible.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"Can I convert an existing Manual Collection ad to an Automatic Collection?"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[" No. You cannot convert between collection types. Create a new ad group with the desired collection type instead.\n"],"documentType":"guide"},{"title":"Migration Guide for Product Collection to Collections Ad Type","sectionHeader":{"type":3,"text":"Where can I get help?"},"path":"/en-us/reference/migration-guides/sb-product-collection","content":[],"documentType":"guide"},{"title":"Amazon Ads API for Sponsored Display overview","sectionHeader":null,"path":"/en-us/guides/sponsored-display/overview","content":[" Sponsored Display is a self-service, retail aware display marketing solution that helps you grow your business and brand on Amazon by engaging shoppers across the purchase journey on and off Amazon.\n"," The Amazon Ads API for Sponsored Display enables integrators to programmatically access Sponsored Display (SD) to build applications to automate, scale, and optimize SD campaigns. The API is described using an OpenAPI specification, an industry standard for describing API services. The OpenAPI document for Sponsored Display is published to the developer portal and can also be downloaded for local use. \n"],"documentType":"guide"},{"title":"Amazon Ads API for Sponsored Display overview","sectionHeader":{"type":2,"text":"Campaign management"},"path":"/en-us/guides/sponsored-display/overview","content":[" The Sponsored Display API is based on the HTTP protocol, with GET, POST, PUT, and DELETE operations. The API aligns with RESTful design principals to align HTTP methods with corresponding actions. For example, the HTTP GET operation retrieves resources, which can potentially be cached for performance benefits. The HTTP POST operation typically creates resources, while the PUT operation updates resources. The HTTP DELETE operation archives resources. \n"," The API provides resource representations using a consistent URI hierarchy. For example, the top-level URI is /sd/campaigns. To work with individual resources, the API includes a path parameter to specify an identifier. For example, in the GET /sd/campaigns/{campaignId} URI, {campaignId} is the identifier of a single campaign that can be retrieved, deleted, or modified. \n"," For efficiency, most resources include a minimal set of fields and associated values. However, if you require the full set of fields and values, include the /extended path parameter at the end of the URI. For example, GET /sd/campaigns/extended or GET /sd/campaigns/extended/{campaignId} include the servingStatus, creationDate, and lastUpdatedDate fields, while GET /sd/campaigns or GET /sd/campaigns/{campaignId} does not.\n"," Sponsored Display campaigns are created by generating and associating child resources. There is an order in which resources must be created:\n","Campaign is the top-level resource used to define your campaign. It requires a unique campaign identifier and name to differentiate it from other campaigns. This resource includes fields such as budget, campaign start date, campaign end date, and the like.\n","Ad group provides a logical grouping of common product ads with associated bid amounts. Each ad group is associated to a single campaign.\n","Product ad is a specific advertisement run as part of your campaign. Each product ad is associated with a single ad group.\n","Targeting clauses are targeting expressions used to target products, categories, or audiences. The target expression you specify is based on the type of campaign and applies at the ad group level.\n"],"documentType":"guide"},{"title":"Amazon Ads API for Sponsored Display overview","sectionHeader":{"type":2,"text":"Tactics"},"path":"/en-us/guides/sponsored-display/overview","content":[" Sponsored Display campaigns are differentiated by tactic. A tactic defines the targeting strategy for the campaign. \n"," Sponsored Display campaigns focus on two campaigns types: \n","Contextual targeting.\n","Audiences.\n"," These campaign types are available to both seller brand owners and vendors. Note that advertisers that do not sell on Amazon can only use Audience targeting. \n"," The following targeting strategies are supported:\n","| Targeting strategy | Identifier in the API | Advertiser type |\n","\\|--------------------\\|-----------------\\|--------\\|\n","| Contextual targeting | T00020 | Seller, vendor | \n","| Audiences | T00030  | Seller, vendor, advertisers that do not sell on Amazon. | \n"],"documentType":"guide"},{"title":"Amazon Ads API for Sponsored Display overview","sectionHeader":{"type":2,"text":"Bid optimization"},"path":"/en-us/guides/sponsored-display/overview","content":[" The Sponsored Display bid optimization strategies allow you to specify the metrics against which Sponsored Display should optimize when bidding for impressions. Sponsored Display displays ads to different audiences depending on the metric that you want to optimize. Within the Sponsored Display campaign, you can choose different costType of either vcpm or cpc. Within an adGroup, you can then choose the bidOptimization for the ad group. Default behavior is to optimize for clicks.\n","| IMAGE | |\n","\\| --- \\| --- \\|\n","| Regardless of your bid optimization selection, if we find an opportunity where your ad is more likely to lead to viewable impressions, page visits, or conversions based on the bid optimization you selected, we may increase your bid for that auction by up to 300%.Similarly, if we find an opportunity that looks less likely to lead to your bid optimization goal, we might lower your bid for that auction. For example, when bidding for ad placements, Amazon can currently adjust a bid of $1 up to a maximum of $4 when there are opportunities for higher expected result. | Bid optimization strategies |\n"," There are 3 bid optimization strategies for Sponsored Display campaigns:\n","| bidOptimization | costType | Description |\n","\\|--------------------\\|-----------------\\|--------\\|--------\\|\n","| clicks | cpc | Default Optimize for page visits and reporting |\n","| conversions | cpc  | Optimize for conversion |\n","| reach | vcpm  | Optimize for viewable impressions. We recommend starting with $5 USD bids for each target to begin testing with this awareness strategy. $1 is the minimum bid for vCPM. |\n"],"documentType":"guide"},{"title":"Amazon Ads API for Sponsored Display overview","sectionHeader":{"type":2,"text":"Security"},"path":"/en-us/guides/sponsored-display/overview","content":[" The Amazon Ads APIs uses the Amazon Identity Provider to authenticate and authorize requests. This security scheme is consistent across all Amazon Ads products.\n"," The Amazon Ad API requires three mandatory headers for each request:\n","Amazon-Advertising-API-ClientId\n","Amazon-Advertising-API-Scope\n","Authorization\n"," The Amazon-Advertising-API-ClientId header contains the client identifier that you registered with the Amazon Ads API platform. It represents a unique identity for your application. This value should not be shared with anyone else since it represents entitlement to your Amazon Ads API.\n"," The Amazon-Advertising-API-Scope header contains the profile Id of your advertiser. You can retrieve this Id using the profiles resource.\n"," The Authorization header is an industry-standard header that includes an OAuth access token. It follows the format: Authorization: Bearer <access_token>.\n"," To learn more about creating an authorization token, see creating API authorization and refresh tokens.\n"," Next steps\n"," If you have already set up your account, you are ready to learn create Sponsored Display campaigns using Postman.\n"," To learn more about all the features that are available by marketplace, see features.\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":null,"path":"/en-us/guides/sponsored-display/features","content":[" This document lists descriptions and marketplace availability for all Sponsored Display features.\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":2,"text":"Bid optimizations"},"path":"/en-us/guides/sponsored-display/features","content":[" Bid optimizations determine how the campaign will bid and charge. For Sponsored Display, there is CPC and vCPM. \n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Cost per click (CPC)"},"path":"/en-us/guides/sponsored-display/features","content":[" Relevant resource:\n","/sd/campaigns\n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Cost per thousand viewable impressions (vCPM)"},"path":"/en-us/guides/sponsored-display/features","content":[" Relevant resource:\n","/sd/campaigns \n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":2,"text":"Creatives"},"path":"/en-us/guides/sponsored-display/features","content":[" With creatives, advertisers can add or edit their video, headlines, logos or custom product images for existing campaigns.   \n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Creative customization (Videos, headlines, and logos)"},"path":"/en-us/guides/sponsored-display/features","content":[" Relevant resource:\n","/sd/creatives\n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Headline real-time moderation"},"path":"/en-us/guides/sponsored-display/features","content":[" Relevant resource:\n","/sd/creatives   \n"," Marketplace availability: \n","North America: United States (US), Canada (CA) \\* Europe: United Kingdom (UK)\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Custom image creatives"},"path":"/en-us/guides/sponsored-display/features","content":[" Leverage an automated image or a custom product image.  \n"," Relevant resource:\n","/sd/creatives   \n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":2,"text":"Recommendations"},"path":"/en-us/guides/sponsored-display/features","content":[" Recommendations provide insight into potential products, categories, and bids that can help increase the probability of ad clicks and drive product awareness and conversions.   \n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Bid recommendations"},"path":"/en-us/guides/sponsored-display/features","content":[" Relevant resource:\n","/sd/targets/bid/recommendations\n"," Marketplace availability:\n","North America: United States (US), Canada (CA), Mexico (MX)  Europe: Germany (DE), Spain (ES), France (FR), Italy (IT), United Kingdom (UK), Netherlands (NL)   Middle East: United Arab Emirates (AE) \\* Asia Pacific: Japan (JP), India (IN), Australia (AU)\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Category suggestions"},"path":"/en-us/guides/sponsored-display/features","content":[" When Sponsored Display advertisers submit a list of products to advertise, they will now receive improved category recommendations.  \n"," Relevant resource:\n","/sd/targets/recommendations  \n"," Marketplace availability: \n","North America: United States (US), Canada (CA), Mexico (MX)  South America: Brazil (BR)  Europe: Germany (DE), Spain (ES), France (FR), Italy (IT), United Kingdom (UK), Netherlands (NL),   Middle East: United Arab Emirates (AE)  Asia Pacific: Japan (JP), India (IN), Australia (AU)\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Product suggestions"},"path":"/en-us/guides/sponsored-display/features","content":[" When Sponsored Display advertisers submit a list of products to advertise, they will now receive improved product recommendations.  \n"," Relevant resource:\n","/sd/targets/recommendations  \n"," Marketplace availability: \n","North America: United States (US), Canada (CA), Mexico (MX)  South America: Brazil (BR)  Europe: Germany (DE), Spain (ES), France (FR), Italy (IT), United Kingdom (UK), Netherlands (NL),   Middle East: United Arab Emirates (AE)  Asia Pacific: Japan (JP), India (IN), Australia (AU)\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":2,"text":"Metrics"},"path":"/en-us/guides/sponsored-display/features","content":[" Metrics define what performance data is included in Sponsored Display reports.   \n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"New-to-brand (NTB)"},"path":"/en-us/guides/sponsored-display/features","content":[" Relevant resource:\n","/sd/{recordType}/report\n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Detail Page View (DPV)"},"path":"/en-us/guides/sponsored-display/features","content":[" DPV metrics help you understand how many shoppers are visiting your product pages as a result of your Sponsored Display campaigns. \n"," Relevant resource:\n","/sd/{recordType}/report  \n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":2,"text":"Brand Safety - API"},"path":"/en-us/guides/sponsored-display/features","content":[" Send a list of domains that you do not want to show your ads off-site on. DENY LIST of apps and sites to protect your brand.   \n"," Relevant resource:\n","/sd/brandSafety/deny  \n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":2,"text":"Product ads"},"path":"/en-us/guides/sponsored-display/features","content":[" Organize and manage ads within a campaign and use portfolios to organize campaigns based on your advertising needs.  \n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Ad groups"},"path":"/en-us/guides/sponsored-display/features","content":[" Use ad groups to group your ads by brand, product, category, price range, or other classifications like theme or targeting strategy.  \n"," Relevant resource:\n","/sd/adGroups  \n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Portfolios"},"path":"/en-us/guides/sponsored-display/features","content":[" Portfolios are a group of campaigns that you can organize to meet your advertising needs. Create portfolios by brand, product category, or by season to provide structure and manage your advertising activity.  \n"," Relevant resource:\n","/sd/campaigns \n"," Marketplace availability: \n","North America: United States (US), Canada (CA), Mexico (MX)  Europe: Belgium (BE), Germany (DE), Spain (ES), France (FR), Italy (IT), United Kingdom (UK), Netherlands (NL), Sweden (SE), Poland (PL), Turkey (TR)  Middle East: United Arab Emirates (AE), Saudi Arabia (SA), Egypt (EG) \\* Asia Pacific: Japan (JP), India (IN), Australia (AU), Singapore (SG)\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":2,"text":"Targeting"},"path":"/en-us/guides/sponsored-display/features","content":[" Use audience to reach customers both on and off Amazon and contextual targeting to reach customers on Amazon.  \n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Contextual targeting"},"path":"/en-us/guides/sponsored-display/features","content":[" Creates targeting clauses for products or categories.   \n"," Relevant resource:\n","/sd/targets  \n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Audiences - Views remarketing"},"path":"/en-us/guides/sponsored-display/features","content":[" Targets a customer based on past activity. For example, if a customer views a specific product or category, ads can be used to re-engage them.  \n"," Relevant resource:\n","/sd/targets  \n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Audiences - Amazon audiences"},"path":"/en-us/guides/sponsored-display/features","content":["In-market: In-market audiences allow advertisers to engage audiences who are in the same category as their advertised products.  Lifestyle: Positioned for awareness campaigns, these audiences reflect a variety of shopping and viewing signals, including shopping on Amazon, browsing on IMDb, streaming on Prime Video, or streaming on Twitch.  Interests: Interest-based audiences allow advertisers to help raise awareness with prospective buyers based on what they frequently browse and buy. \\* Life Events: Life Events audiences give brands the opportunity to drive awareness and consideration for relevant products based around life moments  \n"," Relevant resource:\n","/sd/targets  \n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Audiences - Purchases remarketing"},"path":"/en-us/guides/sponsored-display/features","content":[" Remarket to previous purchasers of their own products, related products, as well as products from specific retail categories.   \n"," Relevant resource:\n","/sd/targets  \n"," Marketplace availability: All marketplaces\n"],"documentType":"guide"},{"title":"Sponsored Display Feature Availability by Marketplace","sectionHeader":{"type":3,"text":"Negative targeting"},"path":"/en-us/guides/sponsored-display/features","content":[" Negative contextual targeting excludes shoppers' brands or products from displaying ads in shopping results or detail pages.  \n"," Relevant resource:\n","/sd/negativeTargets  \n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":null,"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" Audiences provides flexible controls through on-site and off-site remarketing to help convert previous detail page visitors generated from organic or paid efforts; as well as audience discovery across exact products, similar products, or entire categories to help expand reach.\n"," To complement our custom-built audiences, which leverage Amazon shopping signals to expand reach with intuitive, flexible targeting controls (i.e., Views) you can also use Amazon audiences, which gives advertisers access to a large catalog of audience segments that are easy-to-use and ready-to-go. Amazon audiences is a way to engage new customers as well as to help advertisers better learn about their brand on Amazon. Sponsored ads users are now able to select audiences in a similar way to how they would describe the core customer of their brand—for example, \"Outdoor Enthusiasts\" or \"Environmentally Conscious Shoppers\", and these self-service advertisers can now directly connect the language used in their overall brand marketing strategy to Sponsored Display.\n","Learn more about Amazon audiences for Sponsored Display\n","View technical specifications for the audiences API\n"," Audiences campaigns follow the standard Amazon Ads API structure to create and manage campaigns. These campaigns are very similar to Sponsored Display contextual targeting campaigns or Sponsored Products campaigns. If you have previously created these types of campaigns, you will find the concepts very similar.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":2,"text":"Building a Sponsored Display audiences campaign"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" Follow these steps to create a Sponsored Display audiences campaign.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":3,"text":"Step 1: Creating campaigns"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" In this example, the tactic field value of T00030 specifies an audiences campaign.\n"," A successful response returns a campaign identifier. This identifier is used to create an ad group in the next step. \n"," We now support a new costType of vcpm so you can optimize bids for viewable impressions for awareness campaigns, when the goal is to reach a larger audience. Note that vcpm bidding is fundamentally different than cpc bidding. With vcpm you are bidding for 1,000 viewable impressions, whereas with cpc you are bidding for 1 click. Here is an example:\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":3,"text":"Step 2: Create an ad group"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" In this example, we will be creating an ad group. We now include additional controls to optimize bids based on campaign objectives with bidOptimization. When building campaigns, advertisers can choose between higher consideration or conversion goals. When selecting clicks, ads will serve to audiences more likely to click on your ad. When selecting conversions, the bids will be optimized for higher conversion rates, showing your ads to shoppers more likely to purchase the product. When selecting reach, the bids will be optimized for viewable impressions, allowing your ads to show to more shoppers. Please note, when selecting costType of cpc the bidOptimization will be either clicks or conversions.\n"," Here is an example of creating an adGroup when the costType of the campaign is set to vcpm. Please note, when selecting costType of vcpm the bidOptimization must be set to reach.\n"," A successful response returns an ad group identifier. This identifier is used to create product ads and target expressions in the next step.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":3,"text":"Step 3: Create product ads"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" A successful response returns an ad identifier.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":3,"text":"Step 4: Create target clauses"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" Once you have created target clauses, your campaign is active and serving ads.\n"," For each step described above, additional operations are available to read, update and delete the respective components (Campaign, Ad Group, Product Ads, Target Expressions). The OpenAPI specification describes the format for each request. In the next section, we will explore our audience discovery tools.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":2,"text":"Discovering all the Amazon audiences available for targeting"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":3,"text":"Taxonomy API"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" The taxonomy API allows advertisers to browse the Amazon audiences catalog hierarchy, level-by-level to discover audiences that they want to target. This API allows you to find audiences via a tree-like structure, where each level contains one or more categories. When you reach the bottom of the tree, the API will not return any categories (i.e., \"categories\": \\[]). This API does not return the audience segments; instead, you use the category path from this API to call the audience discovery API to discover audiences.\n","View specifications for the taxonomy API\n"," When you build a category path, you start with the top-level node using the following request and build the category path from each response.\n"," The subsequent request can be the following:\n"," Finally, when you reach the bottom of the tree, it will return:\n"," The next step will use the results of the categoryPath to discover audiences using the discovery API.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":3,"text":"Discovery API "},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" The discovery API includes many filters such as category, categoryPath, audienceName and audienceId. You can use multiple filters together such as categoryPath and audienceName to return audiences that satisfy both clauses.\n","View specifications for the audiences discovery API\n"," You can also specify multiple search criteria within each filter values field - each of them is treated as an OR condition so if you want to search for audience names containing both basketball and soccer, you would specify these audience names within the values field. \n"," The following request returns categories from in-market that include both soccer and basketball audiences available.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":2,"text":"Overlapping audiences "},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" The audience insights API helps surface other audiences that are similar to your selected audience and that you may want to target in your campaigns. You can use any audience returned from the discovery API as an input to generate overlapping audiences. \n","View specifications for the audience insights API\n"," For example, to retrieve overlapping audiences for an audience with ID equal to 1234567890:\n"," The API will return the top 30 audiences that overlap with the selected audience and meet the specified criteria. Below you will see a sample with the selected audience and just its top 3 overlapping audiences shown. \n"," You can use one or more filters to narrow the results. The API offers filters for audienceCategory, minimumAudienceSize, maximumAudienceSize, minimumOverlapAffinity, and maximumOverlapAffinity. \n"," For example, the following request returns the top 30 overlapping audiences that are in the in-market audienceCategory and have a minimumOverlapAffinity of 2.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":2,"text":"Additional Campaign management examples"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" The retrieve operation uses the HTTP GET method with no HTTP request body to retrieve a single campaign or all campaigns.\n"," For example, to retrieve a single campaign with an identifier equal to 1234567890:\n"," Retrieve all campaigns for the advertiser:\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":3,"text":"Update Campaign Settings"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" The update operation uses the HTTP PUT method to modify campaign values. It uses the same structure as the create request except that it requires the campaignId field. For example:\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":3,"text":"Delete Campaign"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" The delete operation uses the HTTP DELETE method (no HTTP body) to delete a single campaign. For example, to delete a campaign with identifier equal to 1234567890:\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":2,"text":"Reference"},"path":"/en-us/guides/sponsored-display/audience-targeting","content":[" The complete list of audience targeting clauses are defined below and in our documentation :\n","| Targeting clause example | Description |\n","\\|---------------------------\\|-------------\\|\n","| views(exactProduct lookback=30) | Target an audience that has viewed the advertised ASINs in the past 7, 14, 30, 60, or 90 days, depending on the lookback. |\n","| views(similarProduct lookback=14) | Target an audience that has viewed similar products to the advertised ASINs in the past 7, 14, 30, 60, or 90 days, depending on the lookback. |\n","| purchases(exactProduct lookback=7) | Target an audience that has purchased the advertised ASINs in the past 7, 14, 30, 60, 90, 180 or 365 days, depending on the lookback. |\n","| purchases(relatedProduct lookback=14) | Target an audience that has purchased related products to the advertised ASINs in the past 7, 14, 30, 60, 90, 180 or 365 days, depending on the lookback. |\n","| asinCategorySameAs=12345 | Target an audience that has viewed or purchased products in the given category in the past, depending on the lookback. |\n","| asinBrandSameAs=12345 | Target an audience that has viewed or purchased products in the given brand in the past, depending on the lookback. |\n","| asinPriceBetween=1-50, asinPriceGreaterThan=1, asinPriceLessThan, asinReviewRatingLessThan, asinReviewRatingGreaterThan, asinReviewRatingBetween | Target an audience that has viewed or purchased products based on ASIN specific criteria |\n","| asinIsPrimeShippingEligible | Target an audience that has viewed or purchased products that is Prime shipping eligible |\n","| asinAgeRangeSameAs | Target an audience that has viewed or purchased products within a specific age range (only applies to specific categories such as toys & games) |\n","| asinGenreSameAs | Target an audience that has viewed or purchased products within a specific genre (only applies to Books category) |\n","| lookback | The lookback window for the audience. You can now choose between 7, 14, 30, 60, or 90 days for views and 7, 14, 30, 60, 90, 180 or 365 days for purchases. |\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":null,"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" Contextual targeting helps promote your product among audiences who are actively browsing your product or similar products and categories with ads that appear on relevant product detail pages. Additionally, category and similar product targeting will allow advertisers to reach more of their audiences at more points in their shopping and entertainment journey. The contextual targeting strategy will now allow advertisers to reach audiences both in the Amazon store and outside the Amazon store when customers view content related to targeting strategies. \n"," Contextual targeting campaigns follow the standard Amazon Ads API structure to create and manage campaigns, using the same grammar as Sponsored Products campaigns. If you have previously created Sponsored Products campaigns, you will find the concepts very similar.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":{"type":2,"text":"Building Sponsored Display contextual targeting campaigns"},"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" Follow these steps to create a Sponsored Display contextual targeting campaign.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":{"type":3,"text":"Step 1: Creating campaigns"},"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" Either tactic field value of T00020 or T00030 can specify a contextual targeting campaign:\n"," A successful response returns a campaign identifier. This identifier is used to create an ad group in the next step.  \n"," We support a costType of vcpm so you can optimize bids for viewable impressions for awareness campaigns, when the goal is to reach a larger audience. Note that vcpm bidding is fundamentally different than cpc bidding. With vcpm you are bidding for 1,000 viewable impressions, whereas with cpc you are bidding for 1 click. Here is an example:\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":{"type":3,"text":"Step 2: Create an ad group"},"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" In this example, we will be creating an ad group. We now include additional controls to optimize bids based on campaign objectives with bidOptimization. When building campaigns, advertisers can choose between higher consideration or conversion goals. When selecting clicks, ads will serve to audiences more likely to click on your ad. When selecting conversions, the bids will be optimized for higher conversion rates, showing your ads to shoppers more likely to purchase the product. When selecting reach, the bids will be optimized for viewable impressions, allowing your ads to show to more shoppers. Please note, when selecting costType of cpc the bidOptimization will be either clicks or conversions.\n"," Here is an example of creating an adGroup when the costType of the campaign is set to vcpm. Please note, when selecting costType of vcpm the bidOptimization must be set to reach.\n"," A successful response returns an ad group identifier. This identifier is used to create product ads and target expressions in the next steps.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":{"type":3,"text":"Step 3: Create product ads"},"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" A successful response returns an ad identifier.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":{"type":3,"text":"Step 4: Create target clauses examples"},"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" Once you have created targeting expressions, your campaign is active and serving ads.\n"," For each step described above, additional operations are available to read, update, and delete the respective components (Campaign, Ad Group, Product Ads, Target Expressions). The Open API specification describes the format for each request. The next section explores examples for campaign management.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":{"type":2,"text":"Campaign management"},"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" The retrieve operation uses the HTTP GET method with no HTTP request body to retrieve a single campaign or all campaigns.\n"," For example, to retrieve a single campaign with an identifier equal to 1234567890: \n"," Similarly, you can retrieve all campaigns for the advertiser:\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":{"type":3,"text":"Update Campaign Settings"},"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" The update operation uses the HTTP PUT method to modify campaign values. It uses the same structure as the create request except that it requires the campaignId field. For example:\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":{"type":3,"text":"Delete Campaign"},"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" The delete operation uses the HTTP DELETE method (no HTTP body) to delete a single campaign. For example, to delete a campaign with identifier equal to 295680062861815:\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":{"type":2,"text":"Negative targeting"},"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" Negative Targeting is available to contextual targeting campaigns using the /sd/negativeTargets resource. This resource follows the same format as regular targeting expressions defined in /sd/targets with the exception being that all targeting expressions are negated within the ad group.\n"," For example, if you have already created targeting expressions to target a category with an identifier equal to 45678. \n"," You can exclude brands from being targeted within the category, such as a brand identifier equal to 98765 by using the following (same body but different resource):\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display contextual targeting API","sectionHeader":{"type":2,"text":"Reference"},"path":"/en-us/guides/sponsored-display/contextual-targeting","content":[" Each available contextual targeting clause is defined below.\n","| Contextual targeting clause | Description |\n","\\|---------------------------\\|-------------\\|\n","| asinSameAs | Target products with the same ASIN |\n","| asinCategorySameAs | Target products with the same category |\n","| asinBrandSameAs | Target products with the same brand |\n","| asinPriceBetween, asinPriceGreaterThan, asinPriceLessThan, asinReviewRatingLessThan, asinReviewRatingGreaterThan, asinReviewRatingBetween | Target an audience that has viewed products based on ASIN specific criteria |\n","| asinIsPrimeShippingEligible | Target products that are Prime shipping eligible |\n","| asinAgeRangeSameAs | Target products within a specific age range (only applies to specific categories such as toys & games) |\n","| asinGenreSameAs | Target products within a specific genre (only applies to Books category) |\n","| similarProduct | Target products that are similar to the advertised ASIN |\n"," Next steps\n"," If you have already set up your account, you are ready to create Sponsored Display campaigns using Postman.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display entertainment targets","sectionHeader":null,"path":"/en-us/guides/sponsored-display/entertainment-targeting","content":[" Sponsored Display entertainment targeting provides all advertisers an easier and streamlined way of reaching audiences in an entertainment mindset (people who are either actively engaged in entertainment or have shown interest in it). Advertisers can now reach and influence audiences with genres of entertainment - customers listening to classical music, playing racing games, watching a horror movie, streaming esports, or reading reviews on their favorite blogging sites, now or in the past. Self-service advertisers can now use Amazon Ads to reach audiences in their entertainment journey across Twitch, IMDb, Amazon, and third-party publishers. \n"," In order to facilitate entertainment targeting in Sponsored Display, the /sd/targets resource has been extended with the ability to create entertainment targeting clauses.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display entertainment targets","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-display/entertainment-targeting","content":[" Make sure you have created a Sponsored Display campaign, ad group, and product ad. Note that you can create entertainment targets for either contextual (T00020) or audience (T00030) campaigns.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display entertainment targets","sectionHeader":{"type":2,"text":"Creating entertainment targets"},"path":"/en-us/guides/sponsored-display/entertainment-targeting","content":[" You can use POST /sd/targets to create an entertainment target.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"How to build Sponsored Display entertainment targets","sectionHeader":{"type":2,"text":"Retrieving entertainment targets"},"path":"/en-us/guides/sponsored-display/entertainment-targeting","content":[" To retrieve entertainment targets, you can use the GET /sd/targets/{targetId} endpoint.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"How to build Sponsored Display entertainment targets","sectionHeader":{"type":2,"text":"Discovering entertainment target categories"},"path":"/en-us/guides/sponsored-display/entertainment-targeting","content":[" For entertainment targeting, a new predicate has been added called contentCategorySameAs which takes in an IAB category as the value. The complete list of allowed IAB categories can be found in the table below.\n","|Category\t|Subcategory\t|Value\t|\n","\\|-------\\|--------\\|--------\\|\n","|Movies and Television\t|All Movies and Television\t|amzn1.iab-content.SPSHQ5\t|\n","|Movies and Television\t|Action or Adventure\t|amzn1.iab-content.325\t|\n","|Movies and Television\t|Animation or Anime\t|amzn1.iab-content.641\t|\n","|Movies and Television\t|Biographies\t|amzn1.iab-content.44\t|\n","|Movies and Television\t|Comedy\t|amzn1.iab-content.646\t|\n","|Movies and Television\t|Documentary\t|amzn1.iab-content.332\t|\n","|Movies and Television\t|Drama\t|amzn1.iab-content.647\t|\n","|Movies and Television\t|Factual\t|amzn1.iab-content.648\t|\n","|Movies and Television\t|Family\t|amzn1.iab-content.645\t|\n","|Movies and Television\t|Fantasy\t|amzn1.iab-content.335\t|\n","|Movies and Television\t|History\t|amzn1.iab-content.EZWB7V\t|\n","|Movies and Television\t|Holiday\t|amzn1.iab-content.649\t|\n","|Movies and Television\t|Horror\t|amzn1.iab-content.336\t|\n","|Movies and Television\t|Lifestyle\t|amzn1.iab-content.TIFQA5\t|\n","|Movies and Television\t|Music Video\t|amzn1.iab-content.650\t|\n","|Movies and Television\t|Musicals\t|amzn1.iab-content.156\t|\n","|Movies and Television\t|Mystery\t|amzn1.iab-content.331\t|\n","|Movies and Television\t|Reality TV\t|amzn1.iab-content.651\t|\n","|Movies and Television\t|Romance\t|amzn1.iab-content.326\t|\n","|Movies and Television\t|Science Fiction\t|amzn1.iab-content.652\t|\n","|Movies and Television\t|Soap Opera\t|amzn1.iab-content.642\t|\n","|Movies and Television\t|Special Interest (Indie or Art House)\t|amzn1.iab-content.643\t|\n","|Movies and Television\t|Sports Radio\t|amzn1.iab-content.370\t|\n","|Movies and Television\t|Talk Show\t|amzn1.iab-content.A0AH3G\t|\n","|Movies and Television\t|True Crime\t|amzn1.iab-content.KHPC5A\t|\n","|Movies and Television\t|Western\t|amzn1.iab-content.KHPC6A\t|\n","|Music and Radio\t|All Music and Radio\t|amzn1.iab-content.338\t|\n","|Music and Radio\t|Blues\t|amzn1.iab-content.360\t|\n","|Music and Radio\t|Classical Music\t|amzn1.iab-content.346\t|\n","|Music and Radio\t|Comedy (Music and Audio)\t|amzn1.iab-content.348\t|\n","|Music and Radio\t|Pop, Contemporary Hits, or Top 40 Music\t|amzn1.iab-content.349\t|\n","|Music and Radio\t|Country Music\t|amzn1.iab-content.350\t|\n","|Music and Radio\t|Dance and Electronic Music\t|amzn1.iab-content.351\t|\n","|Music and Radio\t|Hip Hop Music\t|amzn1.iab-content.355\t|\n","|Music and Radio\t|Inspirational or New Age Music\t|amzn1.iab-content.356\t|\n","|Music and Radio\t|Jazz\t|amzn1.iab-content.357\t|\n","|Music and Radio\t|Oldies or Adult Standards\t|amzn1.iab-content.358\t|\n","|Music and Radio\t|R&B, Soul or Funk Music\t|amzn1.iab-content.362\t|\n","|Music and Radio\t|Reggae\t|amzn1.iab-content.359\t|\n","|Music and Radio\t|Rock Music\t|amzn1.iab-content.363\t|\n","|Music and Radio\t|Songwriters or Folk\t|amzn1.iab-content.353\t|\n","|Music and Radio\t|World or International Music\t|amzn1.iab-content.352\t|\n","|Video Games\t|All Video Games\t|amzn1.iab-content.680\t|\n","|Video Games\t|Action-Adventure Games\t|amzn1.iab-content.691\t|\n","|Video Games\t|Casual Games\t|amzn1.iab-content.693\t|\n","|Video Games\t|Puzzle Video Games\t|amzn1.iab-content.698\t|\n","|Video Games\t|Racing Video Games\t|amzn1.iab-content.VK7KD0\t|\n","|Video Games\t|Role-Playing Video Games\t|amzn1.iab-content.687\t|\n","|Video Games\t|Simulation Video Games\t|amzn1.iab-content.688\t|\n","|Video Games\t|Sports Video Games\t|amzn1.iab-content.689\t|\n","|Video Games\t|Strategy Video Games\t|amzn1.iab-content.690\t|\n","|Video Games\t|PC Games\t|amzn1.iab-content.684\t|\n","|Video Games\t|Mobile Games\t|amzn1.iab-content.683\t|\n","|Video Games\t|Console Games\t|amzn1.iab-content.681\t|\n","|Video Games\t|eSports\t|amzn1.iab-content.682\t|\n"],"documentType":"guide"},{"title":"How to build Sponsored Display entertainment targets","sectionHeader":{"type":2,"text":"FAQ"},"path":"/en-us/guides/sponsored-display/entertainment-targeting","content":[],"documentType":"guide"},{"title":"How to build Sponsored Display entertainment targets","sectionHeader":{"type":3,"text":"What are the benefits of using entertainment targeting?"},"path":"/en-us/guides/sponsored-display/entertainment-targeting","content":[" Using entertainment audiences may help with reaching an engaged audience in their entertainment journey as they are streaming or playing media or researching their favorite games and movies on blog sites or leaving reviews on their experiences. This helps you to expand your reach beyond shopping audiences. Additionally, you can ensure your brand ads show up next to a content category or genre that aligns with your ad messaging. Note that we always strive to ensure brand safety, avoiding content that is considered to be inappropriate for advertising.  \n"],"documentType":"guide"},{"title":"How to build Sponsored Display entertainment targets","sectionHeader":{"type":3,"text":"How are these entertainment audiences different from current entertainment segments in Amazon Audiences?"},"path":"/en-us/guides/sponsored-display/entertainment-targeting","content":[" Entertainment audiences have a wider reach allowing you to connect to a larger set of customers. Current entertainment segments allow you to reach audiences who have viewed such content in the past. The new entertainment audiences allow you to additionally reach audiences currently viewing entertainment content. These new audiences also reach broader audiences across all Amazon premiere entertainment properties like Twitch, IMDB, and Prime Video as against the current entertainment segments that are specific to past content views on individual properties. \n"],"documentType":"guide"},{"title":"How to build Sponsored Display entertainment targets","sectionHeader":{"type":3,"text":"If I use entertainment targeting, where will my ads show up?"},"path":"/en-us/guides/sponsored-display/entertainment-targeting","content":[" Your ads could appear on Amazon owned and operated entertainment publishers, such as Twitch and IMDb, Amazon.com, and reputable third-party publishers including those in the entertainment space that are available through Amazon Publisher Services (APS) and third-party exchanges.  \n"],"documentType":"guide"},{"title":"How to build Sponsored Display entertainment targets","sectionHeader":{"type":3,"text":"Why are sites like Twitch so important for advertisers?"},"path":"/en-us/guides/sponsored-display/entertainment-targeting","content":[],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":null,"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[" Dynamic segments can be used through the Amazon Ads API by creating a contextual targeting clause of type \"similarProduct\".\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":{"type":2,"text":"Benefits"},"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[" With dynamic segments, advertisers can target additional products that are similar to those being advertised. The products selected by similar product targeting are based on the advertised product and are dynamically generated based on the retail data. \n"," Dynamic segments help advertisers reach relevant audiences most likely to click and help drive traffic to advertised products. These segments allow advertisers to launch campaigns quickly and easily to help create product consideration. \n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":{"type":2,"text":"Usage"},"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":{"type":3,"text":"\"Similar product\" targeting in the Amazon Ads console"},"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[" When advertisers create new campaigns in the Amazon Ads console, \"Similar to advertised products\" targeting is added automatically. This targeting can be optionally removed.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":{"type":3,"text":"Creating a `similarProduct` target in the Amazon Ads API"},"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[" For advertisers creating campaigns through the Amazon Ads API, a targeting clause of type \"similarProduct\" must be explicitly created to add a dynamic segment.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":{"type":2,"text":"Usage notes and recommendations"},"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":{"type":3,"text":"Availability"},"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[" Dynamic targets are available in the Amazon Ads console and API across US, CA, UK, DE, FR, IT, ES, AE, JP, AU, NL, IN, and MX. \n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":{"type":3,"text":"Tactics"},"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[" While dynamic targets are best suited for the \"Optimize for page visits\" tactic as it helps to display ads on detail pages of similar products, it can be used for expanding reach while using \"Optimize for viewable impressions\" or it can be used for driving conversions from customers already evaluating similar products when using \"Optimize for conversions\". \n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":{"type":3,"text":"With other product targeting"},"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[" Dynamic segments should be used to broaden the targeting for any contextual campaigns being created. When used with other product targeting clauses, it helps advertisers show ads on product pages which are not covered by the explicit list of products being targeted but are often viewed or purchased as a substitute or complement of the advertised product. \n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":{"type":3,"text":"With campaign targeting"},"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[" Dynamic segments should also be used along with category targeting, as unlike retail categories, these are dynamic targets and can help advertisers engage users on similar products across multiple retail categories. This is also different from category targeting because you could also target products that are similar but not necessarily within the same category.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display dynamic segments overview","sectionHeader":{"type":2,"text":"Additional Information"},"path":"/en-us/guides/sponsored-display/dynamic-segments","content":[" For more examples of building campaigns, ad groups, product ads, and targets, please review our contextual targeting developer guide. \n"," For full technical details, please review our updated Sponsored Display targeting API documentation.\n"],"documentType":"guide"},{"title":"Discover targetable entities for Sponsored Display","sectionHeader":null,"path":"/en-us/guides/sponsored-display/targetable-entities","content":[" The targetable entities search API enables you to programmatically query for segments or entities to target based on a given set of keywords. This API provides semantic search, spelling correction, and prefix completion capabilities.\n"],"documentType":"guide"},{"title":"Discover targetable entities for Sponsored Display","sectionHeader":{"type":2,"text":"Types of targetable entities supported"},"path":"/en-us/guides/sponsored-display/targetable-entities","content":["| Sponsored Display target type | Targetable entities API target type | Description |\n","\\|-------\\|-------\\|------\\|\n","| Contextual targeting | PRODUCT_CATEGORY | Helps promote your product among audiences who are actively browsing your product or similar products and categories with ads that appear on relevant product detail pages. |\n","| Audience targeting | AUDIENCE | Gives advertisers access to a large catalog of audience segments that are easy-to-use and ready-to-go. Amazon audiences is a way to engage new customers as well as to help advertisers better learn about their brand on Amazon. |\n","| View and purchase remarketing | PRODUCT_CATEGORY_AUDIENCE | Based on view-to-purchase data (shoppers viewing or purchasing these products are likely to purchase your advertised product). |\n","| Entertainment targeting | CONTENT_CATEGORY | Helps advertisers reach engaged audience during their entertainment journey |\n"],"documentType":"guide"},{"title":"Discover targetable entities for Sponsored Display","sectionHeader":{"type":2,"text":"Scenario 1: Search all targetable entities by keyword"},"path":"/en-us/guides/sponsored-display/targetable-entities","content":[" Use POST /targetableEntities/list to search for targetable entities of all types that relate to keyword auto.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Discover targetable entities for Sponsored Display","sectionHeader":{"type":2,"text":"Scenario 2: Search all targetable entities by keyword"},"path":"/en-us/guides/sponsored-display/targetable-entities","content":[" Use POST /targetableEntities/list to search for targetable entities of all types that relate to keyword auto.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Discover targetable entities for Sponsored Display","sectionHeader":{"type":2,"text":"Scenario 3: Search only contextual targets using a keyword"},"path":"/en-us/guides/sponsored-display/targetable-entities","content":[" Use POST /targetableEntities/list to search for contextual targets that relate to keyword auto.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Discover targetable entities for Sponsored Display","sectionHeader":{"type":2,"text":"Scenario 4: Search only view/purchase remarketing targets using a keyword"},"path":"/en-us/guides/sponsored-display/targetable-entities","content":[" Use POST /targetableEntities/list to search for view/purchase targets that relate to keyword auto.\n"," Sample request\n"," Sample response\n"," Use POST /targetableEntities/paths/list to get all entity paths.\n"],"documentType":"guide"},{"title":"Discover targetable entities for Sponsored Display","sectionHeader":{"type":2,"text":"Scenario 1: Identify direct children of a path "},"path":"/en-us/guides/sponsored-display/targetable-entities","content":[" Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Discover targetable entities for Sponsored Display","sectionHeader":{"type":2,"text":"Scenario 2: Identify top level paths for Contextual Targeting"},"path":"/en-us/guides/sponsored-display/targetable-entities","content":[],"documentType":"guide"},{"title":"Sponsored Display Recommendations API","sectionHeader":null,"path":"/en-us/guides/sponsored-display/recommendations","content":[" Amazon provides insight into potential products, categories, and bids that can help increase the probability of ad clicks and drive product awareness and conversions. When creating or managing campaigns to target products or categories, you can create target clauses containing ASINs or categories to show your advertised product both on and off Amazon. This strategy allows you to defend your product pages, upsell products within your catalog, or grow your business in adjacent product or categories. \n"," The following recommendations are currently supported:\n","| Targeting Strategy | Identifier in the API | Recommendations Type \n","\\|--------------------\\|-----------------\\|--------\\|\n","| Product targeting | T00020 | product, similar product, category, & bids | \n","| Audiences | T00030  | exact product, similar product, category, & bids | \n"," Product & Category Targeting Recommendations\n"," The Sponsored Display product & category Recommendations enable you to programmatically query for recommended products or categories to target based on a given set of advertised products (ASINs or SKU). These recommendations are based on view-to-purchase data (shoppers viewing these recommended products are likely to purchase your advertised product). The service also recommends targets for new products with minimal low page views using catalog metadata, thereby ensuring better coverage for you. The key factors driving better scale and performance is to provide optimal targeting that is broad enough to get scale and relevant enough to get good performance. This data is refreshed as new information is learned about optimal products or categories to target so you should actively query the API to learn about new recommendations. The recommended products in the response are also ranked based on detail page views of target products and their similarity with advertised products, such that the highest ranked recommendation is likely to generate more ad clicks for you. The recommendation service is built specifically for Sponsored Display and should be used instead of Sponsored Products or Sponsored Brand Product recommendation APIs. \n"," If you plan to include multiple similar ASINs within an Ad Group then you should call the API with those ASINs in a single request. Alternatively, you can also call the API with a single ASIN only so you get recommendations for an ASIN only. The service can be called without creating campaigns so you can experiment and gain insight into potential ASINs to target. You can then easily create or update campaigns using the Amazon Ads API and include the ASINs within target clauses.\n"," Using the Targeting Recommendations API\n"," The recommendations API is described in the Sponsored Display Open API specification. The request body allows you to define multiple input parameters, for example:\n","The Content-Type field specifies the version of the Recommendation API. The original version (3.0) only supported products. The latest release (3.1) supports both products and categories. - The tactic field defines the campaign type.  - The products array contains one or more goal ASINs. These ASINs represent the advertised product within a campaign. The top 100 ASINs within the request are used to generate recommendations.  - The typeFilter is an array of values that define the type of recommendations. The supported values are PRODUCT & CATEGORY. Please note that tactic T00030 only allows CATEGORY.\n"," The response from this request returns the following:\n"," The response from the recommendations service contains an array of product ASINs ranked by potential scale. Specifically, ASINs with a higher rank have the potential to display on a larger number of product detail pages. Even ASINs with lower rank are still relevant so you should review all the recommendations to make sure you do not miss out on the opportunities. The categories returned contain a field targetableAsinCountRange which contains a range of ASINs within each category to provide guidance on the potential scale.\n"," Using the Bid Recommendations API\n"," Bid recommendations provides recommended bids for target clauses with median, lower and upper boundaries based on historical bid values for the ASINs in a recent period. The specified bid optimization and cost type are used to optimize the bid recommendations for your campaign goals. These recommendations help advertisers select a bid which will more likely win impressions and generate clicks for the targeted ad to the shopper. The bid recommendation is provided at the target level using the exact structure of existing target clauses, which enables you to programmatically reuse campaign target clauses and obtain bid recommendations.\n"," For more information, visit the updated Bid Recommendations API.\n"," You need:\n","The targetingClauses, which you can gather from:\n","The products (ASIN) in an adGroup, which you can gather from:  \n"," Using this information, here is an example of a bid recommendations call:\n","The Content-Type header specifies the version of the Recommendation API. The latest release (3.2) supports bid recommendations and bidOptimization inputs. - The bidOptimization field in the payload contains a bidOptimization of clicks or conversions.  - The costType field in the payload contains a costType of the campaign, this can be cpc.  - The products field in the payload contains one or more goal ASINs. These ASINs represent the advertised product within a campaign. The top 100 ASINs within the request are used to generate recommendations.  - The targetingClauses field in the payload is used alongside the products to determine the bid recommendation. Currently the API accepts up to 100 targeting clauses, which returns a set of bid values in an array with the same order as the request.\n"," The response from the above request returns the following bid recommendations based on the product (product advertised) and targeting clause:\n"," If you have multiple target clauses, you get the same number of bid recommendations:\n"," This returns:\n"," Additional examples for audience views with similarProduct & exactProduct targeting: \n"," This returns:\n"," Summary\n"," When you have identified the ideal ASIN or categories for your campaign, you can then include them in your product targeting: \n","Create new campaigns with targeting clauses using the recommended ASINs or categories. 2. Update existing campaigns with targeting clauses using the recommendations. 3. For 1) and 2), update target bid value based on bid recommendations. \n"],"documentType":"guide"},{"title":"Brand safety developer guide","sectionHeader":null,"path":"/en-us/guides/sponsored-display/brand-safety","content":[" The Sponsored Display Brand Safety API is available for vendors and sellers registered within Amazon Brand Registry in the US, CA, UK, DE, ES, FR, IT, NL, BR, MX, and UAE. Sponsored Display can run ads onsite and offsite on third-party sites and mobile apps. The brand safety functionality gives you more control over where your ads serve to protect your brand and block ads from delivering on third-party sites that do not align with your brand. You can upload a list of domains / mobile applications where you want to prevent ads from showing in your Sponsored Display campaigns. This feature will be available at the advertiser level, allowing each advertiser to control where their ads are shown off Amazon. \n"," Specifically, we do not allow ads to be served on third-party sites in the following content categories:\n","Accidents and disasters  Alcohol  Excessive profanity and obscenities   Extreme violence  Hate speech  Illegal content  Illicit and recreational drugs  Online gambling  Pornographic or sexually explicit content   Sale of firearms and ammunition   Terrorism \\* Tobacco\n"," Our lists are continuously updated from independent brand safety providers to filter out content from these categories. In addition, certain products are not permitted or are subject to additional requirements under our Restricted Products policy, and our Community Guidelines. Amazon does not display ads on certain products even when permitted under the Restricted Products policy, such as sexual wellness products or sensitive historic memorabilia.\n"," When building your brand safety list, you do not need to enumerate all possible web sites since Amazon Brand Safety will provide protection for the categories listed above. Your list should include sites that do not align with your brand or any other business reasons.\n"," A single brand safety list is configured per advertiser. You can upload items to the brand safety list with increments of 10,000 items per request, where items can be either website or mobile applications.\n"," The main API available to create and manage deny lists is /sd/brandSafety/deny. It contains the following operations:\n","Retrieve items: GET /sd/brandSafety/deny 2. Append items to list: POST /sd/brandSafety/deny 3. Delete list: DELETE /sd/brandSafety/deny\n"," We do not support updating lists at this time. If you need to modify or remove items from the list, you will need to delete the list and re-upload the list. If you do not have a local copy of the list, you can download the list using the GET /sd/brandSafety/deny endpoint.\n"," When you perform the above operations, you will get a requestId that acknowledges that the request has been processed.\n"," You can then use the GET /sd/brandSafety/:requestId/status API to retrieve the status of the API passing in your requestId. When this API returns COMPLETED then the operation has finished but this API does not tell you the actual results of the operation. \n"," You will need to use the GET /sd/brandSafety/:requestId/results API to retrieve the actual results from the operation. When deleting a list, this operation is not available. More details on validating a deleted list are described later in the document. You can examine individual domain entries to understand whether a particular domain was updated successfully.\n"],"documentType":"guide"},{"title":"Brand safety developer guide","sectionHeader":{"type":2,"text":"Building the brand safety list"},"path":"/en-us/guides/sponsored-display/brand-safety","content":[" You can build a brand safety list that denies the following:\n","Block the entire web site (e.g., example.com) \\* Block sub-domains from a web site (e.g., api.example.com or docs.example.com)\n"," The format for web sites is example.com or example.net and must follow the domain naming standards per here. Furthermore, only ASCII characters are supported. The list does not support character representation from non-ASCII character sets.\n"," Brand Safety Lists are created using the POST /sd/brandSafety/deny operation by including the following payload in the request.\n","example.com would deny list all sub-domains, in addition to example.com.  com.example.myapp would deny list the Android mobile application with the Android Id com.example.myapp  1234567890 would deny list the IOS application with the IOS id 1234567890. \n"," You can add up to 10K entries into the list when using the API. If you need to send > 10K, you will need to send the items in another request.\n"],"documentType":"guide"},{"title":"Brand safety developer guide","sectionHeader":{"type":2,"text":"Instructions"},"path":"/en-us/guides/sponsored-display/brand-safety","content":[" Prerequisites:\n","You must download Postman from here. \\* You must import the Brand Safety collection and environment file into your workspace.\n"," In this section, you will run API requests to manage brand safety lists. A postman collection has been provided that contains pre-configured requests. When you run requests, it will capture response information as variables, to be used in subsequent requests. Before you run these requests, you will need to fetch the Refresh Token using the OAuth Refresh Token request or manually add one to the Postman script.\n"," For more information on setting up your environment, see here.\n"],"documentType":"guide"},{"title":"Brand safety developer guide","sectionHeader":{"type":3,"text":"Use Case 1: Add Domains / Mobile Apps to Brand Safety List"},"path":"/en-us/guides/sponsored-display/brand-safety","content":[" Use the operation POST /sd/brandSafety/deny to add items to the Brand Safety List. \n"," The response returns the following:\n"," When you check the status immediately using the operation GET /sd/brandSafety/:requestId/status, you will likely see the following:\n"," After a few minutes, when you try the request again (depending on the size of the list), you will see the following:\n"," You can examine the detailed response for the requestId using the operation: GET /sd/brandSafety/:requestId/results\n"," You can verify the full domain list using the operation: GET /sd/brandSafety/deny\n"],"documentType":"guide"},{"title":"Brand safety developer guide","sectionHeader":{"type":3,"text":"Use Case 2: Delete Brand Safety List"},"path":"/en-us/guides/sponsored-display/brand-safety","content":[" If you want to delete the Brand Safety List, you will simply call the operation DELETE /sd/brandSafety/deny\n"," The response will return the following: \n"," After a few minutes, when you check the status using the operation GET /sd/brandSafety/:requestId/status (depending on the size of the list), you will see the following:\n"," The operation: GET /sd/brandSafety/:requestId/results is not available for the DELETE operation; however, you can call the GET /sd/brandSafety/deny operation and verify that the domain list is empty.\n"],"documentType":"guide"},{"title":"Brand safety developer guide","sectionHeader":{"type":3,"text":"Use Case 3: Update the Brand Safety List"},"path":"/en-us/guides/sponsored-display/brand-safety","content":[" If you need to update items in the list, you will need to delete the list using the operation DELETE /sd/brandSafety/deny and then create items using the operation POST /sd/brandSafety/deny. You can follow instructions Use Case 2 for delete and then steps in Use Case 1 to create items within the brand safety list.\n"," Appendix:\n","When a user adds domains to their Brand Safety Deny List, the request is processed asynchronously, and a requestId is provided to the user.   This requestId can be used to view the request results for up to 90 days from when the request was submitted. The results provide the status of each domain in the given request.   Request results may contain multiple pages. This endpoint will only be available once the request has completed processing.   To see the status of the request you can call GET /sd/brandSafety/{requestId}/status. Note that this endpoint only lists the results of POST requests to GET /sd/brandSafety/deny. It does not reflect the results of DELETE requests.  Currently we do not accept Unicode domains. We do accept Punycode domains.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display creatives API","sectionHeader":null,"path":"/en-us/guides/sponsored-display/creatives","content":[" Sponsored Display allows advertisers to upload a video, custom headline, logo, or custom image for their campaigns that is used when serving your ads. Advertisers can use the headline, logo or custom image to reinforce their brand imagery and highlight the experience with their advertised product.\n"," In this release, we provide a Creative API that allows you to upload a headline, logo, and custom image and associate that creative to different ad groups. Before you use the API, you need to have your logo or custom image within the Creative Assets. If you already have an image uploaded and know the asset ID, you can skip to the Creative API section.\n"," To follow the steps of this creative developer guide, please download and reference the creatives Postman collection for Sponsored Display.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display creatives API","sectionHeader":{"type":2,"text":"Get entity information"},"path":"/en-us/guides/sponsored-display/creatives","content":[" Make sure you have a valid OAuth token. Using the creative Postman collection, expand the oauth folder to run the requests to obtain a new access token, such as using the OAuth Refresh Token request to get a new access token.\n"," 1) Expand the oauth folder and run the Gets profile information request. It will use the access token configured within the environment.\n"," The response will return the following:\n"," The entity ID will be based on the accountInfo → id field, which you will use in Step 3 below.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display creatives API","sectionHeader":{"type":2,"text":"Creative Assets API"},"path":"/en-us/guides/sponsored-display/creatives","content":[" In this section, you will use the Creative Assets API to upload a new logo (an image) that you can use when creating creatives for your campaigns.\n"," The Creative Assets API requires the following steps:\n","Create an upload location for your new asset — this step provides a URL that you will use to upload your image. 2. Upload an image using the URL obtained from step 1.  3. Register the asset within your account to enable access to the newly uploaded asset.\n"," Expand the assets folder to examine the Creative Assets requests. All 3 steps are required to create an asset: \n","Creates an upload location to upload an asset. (POST request)  2. Upload image. (PUT request)  3. Registers an uploaded asset with Creative Assets with optional contextual and tagging information. (POST request)\n"," Step 1\n"," In the request body, you specify the name of the file you will upload. It must match the actual filename. The suffix (for example, png) of the file name is required. The only image types supported are JPEG, JPG and PNG (case insensitive).\n"," The response from this request returns the following:\n"," You will use this URL in step 2. It is automatically populated using the upload_url variable in the Postman request URL field. The URL usually expires after 15 minutes so you will need to get a new one if it has expired. \n"," Step 2\n"," Upload the image you want to use as the logo through Postman by choosing \"binary\" option and select a file as payload. The filename must match the exact name of the file you specified in the previous step. The asset image height should not be smaller than 100px, width should not be smaller than 600px, and the size of the image should not exceed 1MB. The image can be in either png, jpg, or jpeg format. \n"," Step 3\n"," In the request body, you can specify the following:\n","The variable entity_id is pulled from Step 0 and filename and upload_url are used from step 1.   The assetType must be IMAGE, and the assetSubTypeList must contain a single value which is either LOGO, PRODUCT_IMAGE, AUTHOR_IMAGE, LIFESTYLE_IMAGE, or OTHER_IMAGE.   You can add any tags to enable searching of your assets.  \\* The accounts field allows you to specify one or more entity IDs that will use the asset. If you want to use the image for other entity IDs later, upload the logo image again and register the asset with the new entity IDs, and do not include the previous entity IDs that you already used. In the request from the Postman collection, it will use the entity from Step 0 where you obtained the profile information.\n"," The response from this request returns the following:\n"," Optionally, you can search for assets using one of the following:\n","Retrieves an asset along with the metadata: returns asset details based on the assetId.  \\* Search assets: returns one or more assets based on the search criteria.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display creatives API","sectionHeader":{"type":2,"text":"Creative API"},"path":"/en-us/guides/sponsored-display/creatives","content":[" The Creative API allows you to create creatives using a headline, logo or custom image, where the logo and custom image are referenced using the assetId created in the previous section.\n"," Before you call creative APIs, please make sure you have created a campaign, ad group, product ad, and target already. When you create a product ad, please make sure the ASIN or SKU you are using is valid and available to you. You need to make sure you have a new adGroupId available to perform the following steps to add a creative to an ad group.\n"," Expand the sd → creatives folders to examine the requests.\n"," Step 1\n"," You will use the assetId and versionId obtained from step 3 of the Creative Assets API. The Postman scripts provide them as variables based on execution of requests from the previous section. Asset image height should not be smaller than 100px, width should not be smaller than 600px.\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display creatives API","sectionHeader":{"type":3,"text":"Example of creating a `brandLogo` in the Amazon Ads API"},"path":"/en-us/guides/sponsored-display/creatives","content":[" The response from this request returns the following:\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display creatives API","sectionHeader":{"type":3,"text":"Example of creating a `customImage` in the Amazon Ads API"},"path":"/en-us/guides/sponsored-display/creatives","content":[" The response from this request returns the following:\n"," Step 2\n"," You can use the PUT call to edit creative variables including assetId, headline, and croppingCoordinates associated to that creative for the given adGroupId.\n"," A creative in PENDING_REVIEW status cannot be updated. You have to wait until the creative is approved or rejected. Once your creative has been approved or rejected, you can update the creative. When you update, if you are not changing anything in the headline and brandLogo section, the update creative API will directly return a 200 OK and the moderation status of the creative will remain the same as before. Only when you update the creative with some changes in the headline and logo, the moderation status will be reset to PENDING_REVIEW and your changed creative will go into the moderation process. \n"," The response from this request returns the following:\n"," Step 3\n"," You can use this call to preview the HTML that will be used to generate the image for the new custom creative, including the newly added logo and headline. \n"," The response from this request returns the following:\n"," If you want to preview the creative without customization, you can use the payload below. properties is also optional. \"creative\": {} will also work.\n"," If you want to preview the creative without customization, you can use the payload below: \n"," The response from this request returns the following:\n"," Please note, when you specify size, isMobile, isOnAmazon in the preview configuration, the following values are available for creative previews: (The values in the column of isMobile and isOnAmazon should be all LOWER case).\n","| Size (widthxheight) | isMobile | isOnAmazon | \n","\\|--------------------\\|-----------------\\|--------\\|\n","| 245x250 | FALSE | TRUE | \n","| 650x130| FALSE  | TRUE | \n","| 414x125 | TRUE | TRUE |\n","| 320x50 | FALSE | TRUE| \n","| 160x600 | FALSE | TRUE| \n","| 300x250 | FALSE | TRUE | \n","| 728x90 | FALSE | TRUE | \n","| 970x250 | FALSE | TRUE | \n","| 300x600 | FALSE | TRUE |  \n","| 980x55 | FALSE | TRUE |\n","| 300x600 | FALSE | TRUE |\n","| 270x150 | TBD | TBD |\n"," You will get an escaped HTML in the preview creative API response. You need to unescape the HTML and save it into a file (for example, PreviewCreative.html). You will need to create another HTML file using iframe which should have the same size as the creative, and then you can open the iframe HTML in your browser and you will see the creative. \n"," Sample iframe file code with size 414x125: \n"," Step 4\n"," You can use this call to get a list of creatives for each adGroupId including the customized headline and assetId associated with the adGroupId.\n"," The response from this request returns the following as an example:\n"," Step 4\n"," You can use this call to get the moderationStatus from a given creativeId using the creativeIdFilter.\n"," The response from this request returns the following as an example. Please note that contentType can also be CUSTOM_IMAGE:\n"],"documentType":"guide"},{"title":"Amazon Ads Sponsored Display creatives API","sectionHeader":{"type":2,"text":"Other good things to know"},"path":"/en-us/guides/sponsored-display/creatives","content":[" ProductAd\n"," When you create a product ad in a campaign, please make sure to use a valid and available ASIN or SKU. A creative cannot render with an invalid ASIN or SKU. \n"," TPS limitation\n"," Currently for creative APIs, we only allow 1 TPS for POST, GET, and PUT requests. Higher TPS will be throttled.\n"," Headline\n","Cannot be empty string  Length cannot be more than 50 characters  Cannot contain illegal characters: <  >  #  ^  !  ...  Capitalized characters cannot be more than 50%, but this validation will not be enabled if the headline length <= 10 characters  Cannot contain emojis, for example \\\\uD83D \\\\uDE41\n"," Logo or Custom Image\n"," When registering the asset, you can specify proper values to make sure the following validation criteria are met: \n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":null,"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Amazon Ads has billions of shopping, streaming and browsing signals to help you attract new customers to your small business.\n"," Use the power of our insights to reach relevant audiences throughout their shopping and entertainment journeys with our Sponsored Display ads, even if you do not sell in the Amazon store. \n"," After reading this guide, you should understand the required steps to create a Sponsored Display campaign using our Amazon Ads APIs to advertise products or services not sold on Amazon in categories not already available on Amazon.com. \n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"Onboarding"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Join Amazon Ads Partner Network"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" As a partner or agency, looking to get started with Amazon Ads APIs, you will have to set up the Amazon Business Account in Amazon Ads Partner Network.\n","Create an Amazon Business Account by following the \"Join Partner Network\" registration flow.  You will be prompted to create:  Once completed , you will receive an email notification (1-2 business days) about your Amazon Ads Partner Network registration. \\* Approved applicants can establish a client application through Login with Amazon (LwA) that serves as a credential for requests to the Amazon Ads API. \n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Create a manager account"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" After joining partner network, create a manager account which allows to manage multiple advertiser accounts across multiple ad products. Manager accounts help to:\n","Link different types of ad accounts.  Link advertiser accounts in multiple countries.  Link other manager accounts to view and manage all advertising accounts under the management of your organization in a single place while maintaining data separation for different buying teams.\n"," Refer to this documentation for more details:\n","Manager Account in Support Center. \\* Manager Account developer guide. \n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Complete the API onboarding process"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" To call Amazon Ads APIs, you will register as a developer to start the LWA application. When approved, this email address will be associated to your Amazon Ads API permissions (SLA for this step is up to 48 hours).\n","Complete the LWA application.  Apply for API access.  Assign Ads API access to your LWA client application.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Authorize your LwA application"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Once your LwA client application for the Amazon Ads API has been established, any Amazon user account can now authorize your LwA application to access the advertising data and services of that account through the API. \n"," From this point, you will use this Login with Amazon application to create and manage authorization credentials, which must be passed in the headers of any request to the API. To begin, see Getting started.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Acceptance of Ads Agreement"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" This is a prerequisite for registering an Ads account through the Amazon Ads API. The purpose of surfacing terms token is to ensure that legal Terms & Conditions (“T&Cs”) are surfaced by the API integrator and are accepted by the LWA user (advertiser who signed into the API service of the partner by using Login with Amazon). This is a 2-step process:\n","The API integrator must call POST /termsTokens API to generate a termsToken and termsUrl. The terms token url will contain a link to the Ads Agreement. Upon clicking that link, an Amazon Ads Agreement page along with the Accept & Continue button will be surfaced to the user.  \\* The LWA user must accept the Terms & Conditions. Upon the acceptance of Terms & Conditions, a token is activated. Each token is associated with one account request. The terms acceptance rule is the same for single account and bulk account registration.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Account registration and billing"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Register an Ads account for a business that does not sell on Amazon by calling POST /adsAccounts. Below is an example.\n"," At the moment, the US marketplace is supported for businesses that do not sell on Amazon. There are two methods to do so:\n","Single advertiser account creation: A SMB/small business request their agency to create an Ads account on their behalf. Here is the API endpoint for it POST/adsAccounts.  \\* Bulk Account Creation: We recommend using this option for partners allowing them to create Ads accounts in bulk at once on behalf of several advertisers. Here is the API endpoint: POST /adsAccounts/batch that needs to be called and a complete API call example.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example request "},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Create your batch Ads accounts:\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example request "},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" The response immediately returns an account ID in pending status. Registration will happen asynchronously. The index field corresponds to the order in which the accounts are sent in the request. The response immediately returns an account ID in pending status. Full registration then happens asynchronously.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"User Permissions and Invitations"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" A user account permission plays a crucial role in managing access and control over Ads account. Permissions define what actions a user can perform within their Ads account. In the Amazon Ads API, permissions associated with the user account that initiates the authorization grant are crucial for determining whether subsequent API requests will be authorized. \n","Setting Permissions: By default, the creator of a Sponsored Ads account has Admin permissions. Admin users can choose from two methods to enable access for other user accounts: \n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Set up billing for a newly created account"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" The Billing APIs setup process process establishes who is going to pay for your advertising spend with Amazon Ads by setting a billing profile and what payment method will be used by setting a payment profile. Billing set up is a prerequisite for creating and advertising campaigns on Amazon.\n"," Below are the types of Payment methods available via API. The definition of each Payment method can be found here:\n","PAY_BY_INVOICE (PBI) - gives eligible Amazon Business customers an extended due date for payment by purchasing on credit.  \\* CREDIT_CARD - This is available for individual accounts for agency/partner that have a group of advertisers who prefer using their corporate CC on the account directly. You can learn more about payment methods here. \n"," Please refer to our Billing API documentation for further details.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"1. Create a campaign"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Use the POST /sd/campaigns endpoint to create a campaign. Advertisers who do not sell on Amazon must use the tactic T00030 which denotes an audience targeting campaign and define a start date, end date, daily budget (no minimums) to get started. You can choose between a cost type of cost per click (cpc) or cost per thousand views (vcpm).\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example requests"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" CPC campaign:\n"," vCPM campaign:\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example response"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Record your campaign ID for use in the next step.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"2. Create one or more ad groups"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Once you have created a campaign, you need to create at least one ad group. Use the POST sd/adGroups endpoint to create an ad group using the campaignId generated in step 1. \n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"bidOptimization"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" The bidOptimization in the ad group should correspond to the costType you chose for the campaign. cpc campaigns must use clicks as the bidOptimization. vcpm campaigns must use reach as the bidOptimization. For advertisers that do not sell on Amazon, conversions is not yet supported.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"creativeType"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Ad groups can contain multiple product ads, but only one type of creative. For example, you can have one ad group with multiple image creatives, but you cannot have one ad group that contains both image and video creatives. If you do not enter a creativeType, the ad group will use IMAGE by default. \n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example requests"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" CPC campaign:\n"," vCPM campaign:\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example response"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"3. Add locations (optional)"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Advertisers that do not sell on Amazon can use location-based targeting as part of their Sponsored Display campaigns. Locations are optional, but if you want to use them, they should be added after creating product ads and before creating targeting clauses. Within United States, you can target by City, State, Zip code or DMA.\n","For more details, see our Locations guide.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"3. Add targeting"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Advertisers that do not sell on Amazon can use audience targeting in their campaigns. Once you have identified the audience you want to use, you can add targeting clauses at the ad group level using POST /sd/targets. For more information on setting up audience targeting, see Audience targeting campaigns. \n","Use the Targetable entities search API to programmatically query for segments or categories to target based on a given a set of keywords. For more information, please click here. \\* Alternatively, you can call the these APIs to: (1.) discover audiences by browsing the catalog hierarchy, (2.) apply filters to narrow down to specific audiences, and (3.) identify overlapping audiences.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example request"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example response"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"5. Create one or more product ads"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Once you have a campaign and at least one ad group, you can create a product ad using the POST /sd/productAds endpoint. Product ads represent a product or service that you are advertising. For advertisers not selling on Amazon, you must include these parameters including a link to an off-Amazon website landing page for your product or service. Please refer to Sponsored Ads Guidelines and Acceptance Policies for more details. \n","| Parameter | Description |\n","\\|-------\\|-------\\|\n","| adGroupId | The ID of the ad group you created in step 2. |\n","| campaignId | The ID of the campaign associated to the ad group. |\n","| landingPageURL| A link to an off-Amazon website landing page for your product or service. |\n","| landingPageType | Always set to OFF_AMAZON_LINK. |\n","| adName | A unique name for your ad. |\n","| state | The state of the ad. |\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example request"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example response"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"6a. Add creative assets to an ad"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Advertisers that do not sell on Amazon must build a creative to use for a Sponsored Display campaign.\n"," For advertisers that do not sell on Amazon, all creatives require a headline, logo, and custom images (rectangle and square). Any image assets first need to be uploaded using the Asset library API. Once you have uploaded all necessary assets, you can build a creative using the POST /sd/creatives endpoint.\n"," You can learn more about building creatives in our Creative guide.\n"," Example request:\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example response"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"6b. Add multiple images to creatives"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Advertisers can also upload multiple image creatives per adGroup. When multiple creatives are available, we will show all creatives in a carousel fashion on selected ad placements where ad slots support carousel format. \n"," For each image asset to be used in the creative, please provide cropping coordinates for all 3 aspect ratios (horizontal image, square image, and vertical image). The cropping coordinates for each image are mandatory. We recommend using the same asset for all aspect ratios and applying cropping coordinates to trim the image. Upload a horizontal image and use the same asset for all aspect ratios with different cropping coordinates. Build a creative using the POST /sd/creatives endpoint.\n"," Minimum pixel requirements for each aspect ratio are:\n","horizontalImage  : Minimum 1200x628 px (1:191 : 1)  squareImage : Minimum 628x628 px (1 : 1)  verticalImage : Minimum 353x628 px (9:16)\n"," Example request:\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example response"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"7. Pre-Moderation API (optional)"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" For advertisers launching Sponsored Display campaigns, the unified pre-moderation API offers real-time policy guidance based on the technical, creative, and policy components of an ad. The unified pre-moderation API ensures ad compliance before moderation, enabling alignment with sponsored ads policy guidelines.\n","Refer to the pre-moderation guide for common reasons a campaign might be rejected during moderation review. A pre-moderation API sample can be found here, along with links to relevant ad policies for additional explanation of the guidelines.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"8. Moderation check"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Once you have created a campaign, ad group, product ad, and targeting clauses, your campaign is ready to begin serving on your inputted start date. Note that your campaign must go through our moderation process and be approved to begin serving ads. While moderation is taking place, your ad will be under “Pending review” status for up to 72 hours.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Moderation status for ad landing page"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" You can call the POST moderation/results API to get the moderation status of the landing page of your ad. This API will return a moderation status of approved or rejected for the given ad.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Example request"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" Set the adProgramType parameter to SPONSORED_DISPLAY . The id value is the adId retrieved in step 5.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Response with approved moderation status"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Response with rejected moderation status"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Moderation status for an ad creative"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" You can call the GET /sd/creatives API to get the moderation status of an ad creative. This API will return detailed rejection reasons for ad creatives if rejected by moderation. This API accepts either adGroupId or creativeId as filter parameters. The creativeId filter will return the moderation results for that creative. The adGroupId filter will return the moderation status of all creatives under that ad group.\n"],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Request with creative ID"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Response if moderation is approved"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Response if moderation is rejected"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Request with ad group ID"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Response with moderation rejected"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[],"documentType":"guide"},{"title":"Sponsored Display for all advertisers","sectionHeader":{"type":3,"text":"Reporting "},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/get-started","content":[" To view campaign performance data, you can use the reporting API. \n"," For more information, see:\n","Report types - Get started with reporting\n"],"documentType":"guide"},{"title":"Sponsored Display locations guides","sectionHeader":null,"path":"/en-us/guides/sponsored-display/non-amazon-sellers/locations","content":[" Locations allow non-Amazon sellers to serve ads to users in a certain region. Location targeting is optional.\n"],"documentType":"guide"},{"title":"Sponsored Display locations guides","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/locations","content":[" Follow the steps to create a Sponsored Display campaign for advertisers that do not sell on Amazon.\n"],"documentType":"guide"},{"title":"Sponsored Display locations guides","sectionHeader":{"type":2,"text":"Exploring available locations"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/locations","content":[" Advertisers can use the POST /locations/list API to search for available locations and retrieve a location ID.\n"],"documentType":"guide"},{"title":"Sponsored Display locations guides","sectionHeader":{"type":3,"text":"Example: Filtering by state"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/locations","content":[" Request:\n"," Response:\n"],"documentType":"guide"},{"title":"Sponsored Display locations guides","sectionHeader":{"type":3,"text":"Example: Filtering by ZIP code"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/locations","content":[" Request:\n"," Response:\n"," Take note of the locations.id for use when adding the location to your campaign. \n"],"documentType":"guide"},{"title":"Sponsored Display locations guides","sectionHeader":{"type":2,"text":"Adding locations to an ad group "},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/locations","content":[" Use POST /sd/locations to add locations to your campaign. The type of expression should be set to location while the value should be the location ID. \n"],"documentType":"guide"},{"title":"Sponsored Display locations guides","sectionHeader":{"type":2,"text":"Retrieving locations"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/locations","content":[" To see the locations associated with a specific campaign or ad group, you can call GET/sd/locations using the campaignIdFilter or adGroupIdFilter. \n"," A sample response with two location expressions associated might resemble:\n"],"documentType":"guide"},{"title":"Sponsored Display locations guides","sectionHeader":{"type":2,"text":"Deleting locations"},"path":"/en-us/guides/sponsored-display/non-amazon-sellers/locations","content":[" To delete locations associated with a specific campaign or ad group, you can call the POST/sd/locations/delete(sponsored-display/3-0/openapi#tag/Locations-(beta)/operation/archiveLocations) using the locationExpressionIdFilter. \n"," A sample response to archive the above two location expression ids might resemble:\n"],"documentType":"guide"},{"title":"Setting up the Sponsored Display Postman collection","sectionHeader":null,"path":"/en-us/guides/sponsored-display/tutorials/postman","content":[" This tutorial walks you through the steps to build and update Sponsored Display campaigns using Postman. \n","If you have not already done so, you must register for the Sponsored Display API and wait for an email confirmation with instructions to complete the onboarding process. If you have registered, make note of your client identifier and client secret.  Download and install Postman.  Download the product targeting collection.  Download the audiences collection.  Download the recommendations collection.  Download the environment file.  Download the Amazon audiences collection.  Download the Brand safety collection.  Download the Creatives collection\n"],"documentType":"guide"},{"title":"Setting up the Sponsored Display Postman collection","sectionHeader":{"type":2,"text":"Import the Sponsored Display collections and environment setting files. "},"path":"/en-us/guides/sponsored-display/tutorials/postman","content":[" To import the product and audiences collections, follow these steps:\n"],"documentType":"guide"},{"title":"Setting up the Sponsored Display Postman collection","sectionHeader":{"type":2,"text":"Import the environment file. "},"path":"/en-us/guides/sponsored-display/tutorials/postman","content":[" To import the environment file, follow these steps:\n"],"documentType":"guide"},{"title":"Setting up the Sponsored Display Postman collection","sectionHeader":{"type":2,"text":"Configure environment variables"},"path":"/en-us/guides/sponsored-display/tutorials/postman","content":[" To configure the environment variables, follow these steps:\n","In the right-hand section of Postman, ensure that collections is selected. Find the collection named Amazon SD API (Contextual).  2. Click the arrow icon to expand the folder. 3. Click on the environment dropdown beside the collection tabs at the top right of the Postman user interface. 4. Select Amazon SD API. 5. Click on the manage environments icon. 6. When the manage environments dialog opens, select Amazon SD API. 7. Enter the initial value for the following variables:\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":null,"path":"/en-us/guides/sponsored-display/tutorials/how-to-build-audt-campaigns","content":[" This how-to walks you through the steps to build Sponsored Display campaigns.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/sponsored-display/tutorials/how-to-build-audt-campaigns","content":[" Follow the setup instructions here. If you have previously setup the Sponsored Display Postman collections, you can skip these steps.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":2,"text":"Instructions"},"path":"/en-us/guides/sponsored-display/tutorials/how-to-build-audt-campaigns","content":[" Obtain an access token\n"," Execute the following steps to obtain a new access token. If you have already acquired an access token, but it has expired, you can use the OAuth Refresh Token request to replace the expired access token. Otherwise, follow the instructions in this step.\n","In the collections tab, select Amazon SD API (AUDT) to expand the subfolders.\n","In the subfolders, select OAuth.\n","Select the GET OAuth Access Code request.\n","Select the send button to send the request.\n","The response is a web page populated with a login form. Select preview.\n","Select OAuth Form Login to simulate a form login. This will use the email and password you configured in your environment earlier. Note that if you are logging in for the first time, you are redirected to a consent page to give permission.\n","The OAuth Form Login returns an authorization code. This code is an intermediary code that is returned to your redirect_uri. The Postman script copies this value to the correct variable for the next step.\n","Open the OAuth Code to Token request. Select send. An access token and refresh token are included in the response. For example:\n","You will also need a value for the Amazon-Advertising-API-Scope header. Select the GET profile information request and select send. The response includes the value in the profileId field.\n"," Create a Sponsored Display campaign\n"," To create a Sponsored Display campaign using Postman, follow these steps:\n","In the Postman collection, open the create one or more campaigns request. Select the body tab and modify the field values to reflect your campaign. For example:\n","Click the send button and verify that your request is successful. For example:\n","Open the subsequent request. Get a requested campaign and select send. The value of campaignId from the previous response is copied automatically to the subsequent request.\n","Repeat the same steps to create and retrieve the remaining components.\n","The final response from GET Gets a targeting clause specified by identifier. resembles the following:\n"," Modify existing campaigns using the Sponsored Display API\n"," You can also modify Sponsored Display campaigns to update values or delete resources. Expand the Modify Campaigns folder within the Amazon SD API collection to experiment with these requests and modify the campaigns based on your requirements. Each component contains a PUT (updating) and DELETE (archiving) resource.\n"," Reporting\n"," You can also request and download reports to understand detailed metrics about the performance of your campaigns. Expand the Report folder and examine the requests:\n","Create a report request: initiates a request to generate a report. This operation returns a report identifier.\n","Get the status of a report previously requested: check the status of the report using the report identifier.\n","Download a previously requested report: downloads the completed report using the report identifier.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":2,"text":"Automate testing of Sponsored Display Campaigns using Postman"},"path":"/en-us/guides/sponsored-display/tutorials/how-to-build-audt-campaigns","content":[" In the previous sections, you created campaigns by calling the Sponsored Display API manually. You can also automate campaign creation, including creating campaigns in bulk using the Postman Collection Runner. \n","In Postman, select the Runner button at the top left-hand corner. This opens a new window.\n","In Collection Runner, select the Amazon SD API (AUDT) collection.\n","For Environment, select Amazon SD API.\n","For the RUN ORDER, Deselect All. Then, select all requests starting from OAuth Refresh Token. This assumes you have a valid access token. If you do not, you can manually make the OAuth requests to get an access token as described in the previous sections. \n","Open create one or more campaigns request. Enter a unique name. If you do not enter a unique name, the first call will fail because of a duplicate campaign name.\n","Select Run Amazon SD API.\n","Verify the results. If the results are expected, you have successfully automated Sponsored Display campaign creation.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display Audiences campaigns","sectionHeader":{"type":2,"text":"Summary"},"path":"/en-us/guides/sponsored-display/tutorials/how-to-build-audt-campaigns","content":[" In this tutorial, you learned how to use the Audiences API to create and update campaigns, enabling you to target audiences and drive awareness and sales for your products.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display contextual targeting campaigns","sectionHeader":null,"path":"/en-us/guides/sponsored-display/tutorials/how-to-build-ct-campaigns","content":[" This how-to walks you through the steps to build Sponsored Display campaigns.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display contextual targeting campaigns","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/sponsored-display/tutorials/how-to-build-ct-campaigns","content":[" Follow the setup instructions here. If you have previously setup the Sponsored Display Postman collections, you can skip these steps.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display contextual targeting campaigns","sectionHeader":{"type":2,"text":"Instructions"},"path":"/en-us/guides/sponsored-display/tutorials/how-to-build-ct-campaigns","content":[" Obtain an access token\n"," Execute the following steps to obtain a new access token. If you have already acquired an access token, but it has expired, you can use the OAuth Refresh Token request to replace the expired access token. Otherwise, follow the instructions in this step.\n","In the collections tab, select Amazon SD API (Contextual) to expand the subfolders.\n","In the subfolders, select OAuth.\n","Select the GET OAuth Access Code request.\n","Select the send button to send the request.\n","The response is a web page populated with a login form. Select preview.\n","Select OAuth Form Login to simulate a form login. This uses the email and password you configured in your environment earlier. Note that if you are logging in for the first time, you are redirected to a consent page to give permission.\n","The OAuth Form Login returns an authorization code. This code in an intermediary code that is returned to your redirect_uri. The Postman script copies this value to the correct variable for the next step.\n","Open the OAuth Code to Token request. Select send. An access token and refresh token are included in the response. For example:\n","You will also need a value for the Amazon-Advertising-API-Scope header. Select the GET profile information request and select send. The response includes the value in the profileId field.\n"," Create a Sponsored Display campaign\n"," To create a Sponsored Display campaign using Postman, follow these steps:\n","In the Postman collection, open the create one or more campaigns request. Select the body tab and modify the field values to reflect your campaign. For example:\n","Click the send button and verify that your request is successful. For example:\n","Open the subsequent request. Get a requested campaign and select send. The value of campaignId from the previous response is copied automatically to the subsequent request.\n","Repeat the same steps to create and retrieve the remaining components.\n","The final response from GET Gets a targeting clause specified by identifier. resembles the following:\n"," Modify existing campaigns using the Sponsored Display API\n"," You can also modify Sponsored Display campaigns to update values or delete resources. Expand the Modify Campaigns folder within the Amazon SD API collection to experiment with these requests and modify the campaigns based on your requirements. Each component contains a PUT (updating) and DELETE (archiving) resource.\n"," Reporting\n"," You can also request and download reports to understand detailed metrics about the performance of your campaigns. Expand the Report folder and examine the requests:\n","Create a report request: initiates a request to generate a report. This operation returns a report identifier.\n","Get the status of a report previously requested: check the status of the report using the report identifier.\n","Download a previously requested report: downloads the completed report using the report identifier.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display contextual targeting campaigns","sectionHeader":{"type":2,"text":"Automate testing of Sponsored Display Campaigns using Postman"},"path":"/en-us/guides/sponsored-display/tutorials/how-to-build-ct-campaigns","content":[" In the previous sections, you created campaigns by calling the Sponsored Display API manually. You can also automate campaign creation, including creating campaigns in bulk using the Postman Collection Runner. \n","In Postman, select the Runner button at the top left-hand corner. This opens a new window.\n","In Collection Runner, select the Amazon SD API (Contextual) collection.\n","For Environment, select Amazon SD API.\n","For the RUN ORDER, Deselect All. Then, select all requests starting from OAuth Refresh Token. This assumes you have a valid access token. If you do not, you can manually make the OAuth requests to get an access token as described in the previous sections. \n","Open create one or more campaigns request. Enter a unique name. If you do not enter a unique name, the first call will fail because of a duplicate campaign name.\n","Select Run Amazon SD API.\n","Verify the results. If the results are expected, you have successfully automated Sponsored Display campaign creation.\n"],"documentType":"guide"},{"title":"How to build Sponsored Display contextual targeting campaigns","sectionHeader":{"type":2,"text":"Summary"},"path":"/en-us/guides/sponsored-display/tutorials/how-to-build-ct-campaigns","content":[],"documentType":"guide"},{"title":"Optimize Sponsored Display campaigns with recommendations","sectionHeader":null,"path":"/en-us/guides/sponsored-display/tutorials/optimize-campaigns-recommendations","content":[" This tutorial walks you through the steps to build and update Sponsored Display campaigns from recommendations.\n"],"documentType":"guide"},{"title":"Optimize Sponsored Display campaigns with recommendations","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/sponsored-display/tutorials/optimize-campaigns-recommendations","content":[" Follow the setup instructions here. If you have previously set up the Sponsored Display Postman collections, you can skip these steps.\n"],"documentType":"guide"},{"title":"Optimize Sponsored Display campaigns with recommendations","sectionHeader":{"type":2,"text":"Instructions"},"path":"/en-us/guides/sponsored-display/tutorials/optimize-campaigns-recommendations","content":[" The recommendations API is protected using OAuth and requires a valid access token. You will need to perform the following steps:\n","Obtain an access token 2. Call the Recommendations service 3. Create or Update Sponsored Display campaigns\n"],"documentType":"guide"},{"title":"Optimize Sponsored Display campaigns with recommendations","sectionHeader":{"type":3,"text":"Step 1. Obtain an access token"},"path":"/en-us/guides/sponsored-display/tutorials/optimize-campaigns-recommendations","content":[" Execute the following steps to obtain a new access token. If you have already acquired an access token, but it has expired, you can use the OAuth Refresh Token request to replace the expired access token. Otherwise, follow these instructions:\n","In the collections tab, select Amazon SD API (Contextual) to expand the subfolders. 2. In the subfolders, select OAuth. 3. Select the GET OAuth Access Code request. 4. Select the send button to send the request. 5. The response is a web page populated with a login form. Select preview. 6. Select OAuth Form Login to simulate a form login. This will use the email and password you configured in your environment earlier. Note that if you are logging in for the first time, you are redirected to a consent page to give permission. 7. The OAuth Form Login returns an authorization code. This code is an intermediary code that is returned to your redirect_uri. The Postman script copies this value to the correct variable for the next step. 8. Open the OAuth Code to Token request. Select send. An access token and refresh token are included in the response. For example:\n","You will also need a value for the Amazon-Advertising-API-Scope header. Select the GET profile information request and select send. The response includes the value in the profileId field.\n"],"documentType":"guide"},{"title":"Optimize Sponsored Display campaigns with recommendations","sectionHeader":{"type":3,"text":"Step 2. Call the Recommendations service"},"path":"/en-us/guides/sponsored-display/tutorials/optimize-campaigns-recommendations","content":[" Use the Postman collection to call the Recommendations API.\n","In the collections tab, select Amazon SD API Recommendations and expand the Recommendations subfolder. 2. Select the SD Product Recommendations operation. 3. Select the Body tab and modify the payload with your ASIN within the products array:\n"," Note: You can include multiple ASINs within the products array using the same object structure.\n","Click Send. The response returns a rank-ordered set of recommended product ASINs.  5. Click on the Tests tab and review the code. In line 8, the rank number specifies the ASIN to save into the variable targetASIN. You can change this value to use a different rank number. 6. Open the Get Amazon ASIN Details request to call the Amazon detail page for the recommended ASIN. In the response, toggle the Pretty tab to Preview to examine the Web page.\n"],"documentType":"guide"},{"title":"Optimize Sponsored Display campaigns with recommendations","sectionHeader":{"type":3,"text":"Step 3. Create or Update Sponsored Display campaigns"},"path":"/en-us/guides/sponsored-display/tutorials/optimize-campaigns-recommendations","content":[" To create a Sponsored Display campaign using Postman, follow the steps from this tutorial with the exception of creating a target clause. Use the instructions below to create a target clause from the recommended ASIN:\n","Open the Amazon SD API (Contextual) collection and select the body tab and modify the field values to reflect your campaign. Specifically, change the expression object value attribute to {{targetASIN}}. The value of {{targetASIN}} is automatically copied from the previous request. You would use the same request to update existing campaigns with target clauses using the recommended ASINs. \n","Click the send button and verify that your request is successful. For example:\n","You can remove existing target clauses that are not performing well using the following:\n"," This approach allows you to programmatically optimize your target clauses based on product recommendations combined with campaign performance by removing target clauses with poor performance.\n"],"documentType":"guide"},{"title":"Optimize Sponsored Display campaigns with recommendations","sectionHeader":{"type":2,"text":"Summary"},"path":"/en-us/guides/sponsored-display/tutorials/optimize-campaigns-recommendations","content":[" In this tutorial, you learned how to use the product recommendations API to create and update campaigns, enabling you to optimize the performance of your campaigns based on your campaign goals.\n"],"documentType":"guide"},{"title":"Sponsored TV overview","sectionHeader":null,"path":"/en-us/guides/sponsored-tv/overview","content":[" Sponsored TV is a self-service, programmatic ad solution that helps advertisers build their brand in front of new audiences across streaming TV services like Freevee, Twitch, and other Streaming TV publishers. Brands can easily amplify their full-funnel marketing mix with Sponsored TV, discovering, reaching, and inspiring audiences as they watch their favorite shows, streamers and movies.\n"],"documentType":"guide"},{"title":"Sponsored TV overview","sectionHeader":{"type":2,"text":"Get started"},"path":"/en-us/guides/sponsored-tv/overview","content":[" To learn how to get started using Sponsored TV, see Sponsored TV eligibility requirements.\n"],"documentType":"guide"},{"title":"Sponsored TV overview","sectionHeader":{"type":2,"text":"Campaign management"},"path":"/en-us/guides/sponsored-tv/overview","content":[" To learn more about creating and managing Sponsored TV campaigns using the API, see:\n","Campaign structure  Creating a campaign  Managing campaigns \\* Full API reference\n"],"documentType":"guide"},{"title":"Sponsored TV overview","sectionHeader":{"type":2,"text":"Creatives"},"path":"/en-us/guides/sponsored-tv/overview","content":[" To learn more about creating and managing Sponsored TV creatives, see the creatives overview.\n"],"documentType":"guide"},{"title":"Sponsored TV overview","sectionHeader":{"type":2,"text":"Reporting"},"path":"/en-us/guides/sponsored-tv/overview","content":[" The Ads API reporting functionality provides a variety of reports to help you retrieve historical impression, click, cost, and conversion data for your Sponsored TV campaigns.\n"," Learn more:\n"],"documentType":"guide"},{"title":"Campaign structure for Sponsored TV","sectionHeader":null,"path":"/en-us/guides/sponsored-tv/campaigns/campaign-structure","content":[" Creating Sponsored TV campaigns using the Amazon Ads API requires making multiple calls to create the entities that make up a campaign. Campaigns require you to create, at minimum, a campaign, ad group, ad, creative, and targeting.\n"," Refer to the diagram below to understand campaign hierarchy.\n","Campaigns: Campaigns group your ads by their advertising budgets and dates.  Ad groups: Ad groups let you organize and manage your ads by products, categories, or other classifications that tie to your goals.  Ads: Use ads to manage a product. Select a product from your brand to include in your ad group. This product will be the landing page for your ad.  Creative asset: Each ad contains a video creative. The creative for your campaign is a critical component to the success of an advertising campaign.  Targeting: Each ad group will have its own content-based audience and in-market category segment. Choosing the right segments for each product can help with your consideration goals. For more information, see targeting.\n"," This example shows a campaign with one ad group. In one ad group, there is one ad with a video creative as well as content category targeting.\n"],"documentType":"guide"},{"title":"Sponsored TV getting started","sectionHeader":null,"path":"/en-us/guides/sponsored-tv/campaigns/get-started","content":[],"documentType":"guide"},{"title":"Sponsored TV getting started","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-tv/campaigns/get-started","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in this tutorial.\n"],"documentType":"guide"},{"title":"Sponsored TV getting started","sectionHeader":{"type":2,"text":"Step 1: Create a campaign"},"path":"/en-us/guides/sponsored-tv/campaigns/get-started","content":[" When creating a Sponsored TV campaign, you can specify the budget settings you want the campaign to have. Currently, only US marketplace is supported for the budgetCurrencyCode parameter.\n"," Endpoint: POST /st/campaigns\n"," A successful response returns campaignId. This identifier is used to create an ad group in the next step.\n"],"documentType":"guide"},{"title":"Sponsored TV getting started","sectionHeader":{"type":2,"text":"Step 2: Create an ad group"},"path":"/en-us/guides/sponsored-tv/campaigns/get-started","content":[" Create at least one ad group using the POST /st/adGroups endpoint. Use the campaignId returned in step 1 to create your ad group. For more information, see ad groups.\n"],"documentType":"guide"},{"title":"Sponsored TV getting started","sectionHeader":{"type":2,"text":"Step 3: Create a target clause"},"path":"/en-us/guides/sponsored-tv/campaigns/get-started","content":[" After you create an ad group, you can add a targeting expression focusing on content, in-market ASIN category or Amazon audience targeting. For more information, see targeting. Sponsored TV supports targeting recommendations based on ASIN, which can be accessed through the steps mentioned here. Targeting Recommendations can be searched for by keyword here.\n"," Endpoint: POST /st/targets\n"," Sponsored TV also supports targeting recommendations based on ASIN for in-market categories. For more information, see targeting recommendations based on ASIN.\n"],"documentType":"guide"},{"title":"Sponsored TV getting started","sectionHeader":{"type":2,"text":"Step 4: Upload and register assets"},"path":"/en-us/guides/sponsored-tv/campaigns/get-started","content":[" You can upload and register a video asset prior to creating an ad by using the creative asset library API.\n"],"documentType":"guide"},{"title":"Sponsored TV getting started","sectionHeader":{"type":2,"text":"Step 5: Create a Creative"},"path":"/en-us/guides/sponsored-tv/campaigns/get-started","content":[" After you obtain the assetID from the previous step, you can associate the asset to an ad group by creating a creative using the POST /st/creatives endpoint. For more information, see creatives overview.\n"],"documentType":"guide"},{"title":"Sponsored TV getting started","sectionHeader":{"type":2,"text":"Step 6: Create an ad"},"path":"/en-us/guides/sponsored-tv/campaigns/get-started","content":[" Using the adGroupId, you can create an ad by using the POST /st/ads endpoint. The request to create an ad differs by whether you have a seller or vendor account. For more information, see ads.\n"],"documentType":"guide"},{"title":"Sponsored TV getting started","sectionHeader":{"type":2,"text":"Step 7: Check moderation status"},"path":"/en-us/guides/sponsored-tv/campaigns/get-started","content":[],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":null,"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" Jump to: Campaigns | Ad groups | Ads | Creatives\n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":2,"text":"Campaigns"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" Listed below are the update, read, and delete options for campaigns.\n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":3,"text":"Listing campaigns"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" To get a list of Sponsored TV campaigns, use the POST /st/campaigns/list endpoint. \n"," Sample request: \n"," Sample response:\n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":3,"text":"Updating campaigns"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" To update a campaign, use the PUT /st/campaigns/ endpoint.\n"," Sample request: \n"," Sample response: \n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":3,"text":"Deleting campaigns"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" To delete a campaign, use the POST /st/campaigns/delete endpoint.\n"," Sample request: \n"," Sample response:\n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":2,"text":"Ad groups"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":3,"text":"Listing ad groups"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" To get a list of Sponsored TV ad groups, use the POST /st/adGroups/list endpoint. \n"," Sample request: \n"," Sample response:\n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":3,"text":"Updating ad groups"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" To update an ad group, use the PUT /st/adGroups/ endpoint.\n"," Sample request:\n"," Sample response:\n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":3,"text":"Deleting ad groups"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" To delete an ad group, use the POST /st/adsGroups/delete endpoint which will mark the ad group status as ARCHIVED.\n"," Sample request:\n"," Sample response: \n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":2,"text":"Ads"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":3,"text":"Listing ads"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" To get a list of Sponsored TV ads, use the POST /st/ads/list endpoint.\n"," Sample request:\n"," Sample response:\n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":3,"text":"Updating ads"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" To update ads, use the PUT /st/ads endpoint.\n"," Sample request:\n"," Sample response:\n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":3,"text":"Deleting ads"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" To delete an ad, use the POST /st/ads/delete\n"," Sample request:\n"," Sample response:\n"],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":2,"text":"Creatives"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[],"documentType":"guide"},{"title":"Sponsored TV managing campaign","sectionHeader":{"type":3,"text":"Update creative"},"path":"/en-us/guides/sponsored-tv/campaigns/manage-campaigns","content":[" To update a Creative, use the PUT /st/creatives/ endpoint.\n"," Sample request: \n"," Sample response:\n"],"documentType":"guide"},{"title":"Sponsored TV ad groups","sectionHeader":null,"path":"/en-us/guides/sponsored-tv/ad-groups","content":[" Ad groups are a way to organize, manage, and gain insights on the performance of the products within your campaign. Products placed together in an ad group share the same bids and targeting.\n"],"documentType":"guide"},{"title":"Sponsored TV ad groups","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-tv/ad-groups","content":[" In order to create an ad group, you must first create a campaign to get the campaignId. You can learn more about campaign creation in Sponsored TV campaigns.\n"],"documentType":"guide"},{"title":"Sponsored TV ad groups","sectionHeader":{"type":2,"text":"Best practices"},"path":"/en-us/guides/sponsored-tv/ad-groups","content":["Ad group name: Assign an ad group name that is descriptive and meaningful to you. Ad group names must be unique within a campaign, but you can use the same ad group name in different campaigns. Your ad group name is only used for display purposes in the campaign manager and is not visible to customers. \\* Default bid: The default bid amount applies to all targeting expressions of the ad group if you do not define bids for the targeting expressions explicitly. Choosing a competitive bid can help you win more auctions and increase awareness of your brand and products.\n"],"documentType":"guide"},{"title":"Sponsored TV ad groups","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/sponsored-tv/ad-groups","content":[" Endpoint\n"," A successful response returns adGroupId. This identifier is used to specify target expressions, associate creative, and associate ads in the next steps.\n"],"documentType":"guide"},{"title":"Sponsored TV targeting","sectionHeader":null,"path":"/en-us/guides/sponsored-tv/targeting","content":[" Sponsored TV targeting consists of two targeting expression types. The CONTENT_CATEGORY_SIMILAR_TO expression type targets audiences that are likely to be interested in specific types of content, including documentaries, music videos, and TV genres (such as drama) or products in categories sold on Amazon like \"Built-in Dishwashers\" or \"Women's Sports Apparel.\" The ASIN_CATEGORY_SIMILAR_TO expression type targets the ASIN category that is similar to the specified category. Standard Amazon audiences can be used using the expression types AUDIENCE_SAME_AS_INTEREST, AUDIENCE_SAME_AS_IN_MARKET, AUDIENCE_SAME_AS_LIFESTYLE, and AUDIENCE_SAME_AS_LIFE_EVENT. \n"],"documentType":"guide"},{"title":"Sponsored TV targeting","sectionHeader":{"type":2,"text":"Targeting recommendations"},"path":"/en-us/guides/sponsored-tv/targeting","content":[" Sponsored TV supports targeting recommendations based on either of the following:\n","ASIN \\* Search keyword\n"],"documentType":"guide"},{"title":"Sponsored TV targeting","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-tv/targeting","content":["You must have an ad group ID\n"],"documentType":"guide"},{"title":"Sponsored TV targeting","sectionHeader":{"type":2,"text":"Creating a targeting clause"},"path":"/en-us/guides/sponsored-tv/targeting","content":[" Below is a table of all the likely content interests that are usable with CONTENT_CATEGORY_SIMILAR_TO expression type:\n","|Content Interest\t|Value\t|\n","|---\t|---\t|\n","|Action or Adventure\t|amzn1.iab-content.325\t|\n","|Animation or Anime\t|amzn1.iab-content.641\t|\n","|Biographies\t|amzn1.iab-content.44\t|\n","|Comedy\t|amzn1.iab-content.646\t|\n","|Documentary\t|amzn1.iab-content.332\t|\n","|Drama\t|amzn1.iab-content.647\t|\n","|Factual\t|amzn1.iab-content.648\t|\n","|Family or Children\t|amzn1.iab-content.645\t|\n","|Fantasy\t|amzn1.iab-content.335\t|\n","|History\t|amzn1.iab-content.EZWB7V\t|\n","|Holiday\t|amzn1.iab-content.649\t|\n","|Horror\t|amzn1.iab-content.336\t|\n","|Lifestyle\t|amzn1.iab-content.TIFQA5\t|\n","|Music Video\t|amzn1.iab-content.650\t|\n","|Musical\t|amzn1.iab-content.156\t|\n","|Mystery\t|amzn1.iab-content.331\t|\n","|News\t|amzn1.iab-content.1020\t|\n","|Reality TV\t|amzn1.iab-content.651\t|\n","|Romance\t|amzn1.iab-content.326\t|\n","|Science Fiction\t|amzn1.iab-content.652\t|\n","|Soap Opera\t|amzn1.iab-content.642\t|\n","|Special Interest (Indie or Art House)\t|amzn1.iab-content.643\t|\n","|Sports\t|amzn1.iab-content.483\t|\n","|Talk Show\t|amzn1.iab-content.A0AH3G\t|\n","|True Crime\t|amzn1.iab-content.KHPC5A\t|\n","|Video Game\t|amzn1.iab-content.680\t|\n","|Western\t|amzn1.iab-content.KHPC6A\t|\n","|Young Adult\t|amzn1.iab-content.51\t|\n"],"documentType":"guide"},{"title":"Sponsored TV targeting","sectionHeader":{"type":3,"text":"Request"},"path":"/en-us/guides/sponsored-tv/targeting","content":[" Endpoint: POST /st/targets\n"],"documentType":"guide"},{"title":"Sponsored TV targeting","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-tv/targeting","content":[],"documentType":"guide"},{"title":"Sponsored TV targeting","sectionHeader":{"type":2,"text":"Targeting recommendations based on `ASIN`"},"path":"/en-us/guides/sponsored-tv/targeting","content":[" Sponsored TV supports targeting recommendations based on ASIN for in-market categories, which can be accessed through the steps mentioned in the targeting recommendations API reference with typeFilter CATEGORY.\n"," Endpoint: POST /sd/targets/recommendations.\n"],"documentType":"guide"},{"title":"Sponsored TV targeting","sectionHeader":{"type":3,"text":"Request"},"path":"/en-us/guides/sponsored-tv/targeting","content":[],"documentType":"guide"},{"title":"Sponsored TV targeting","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/sponsored-tv/targeting","content":[],"documentType":"guide"},{"title":"Sponsored TV creative overview","sectionHeader":null,"path":"/en-us/guides/sponsored-tv/creatives/overview","content":[" A Sponsored TV creative is the video component to your campaign. Through your creative, you can showcase your product and brand that invites customers to interact with your ad.\n"],"documentType":"guide"},{"title":"Sponsored TV creative overview","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-tv/creatives/overview","content":["Upload a video asset using the asset library to get assetId.\n"],"documentType":"guide"},{"title":"Sponsored TV creative overview","sectionHeader":{"type":2,"text":"Creative management"},"path":"/en-us/guides/sponsored-tv/creatives/overview","content":[" To learn more about using the API to create and manage sponsored TV creatives, visit the pages below:\n","Creative moderation \\* Creative preview\n"],"documentType":"guide"},{"title":"Sponsored TV creative overview","sectionHeader":{"type":2,"text":"Sponsored TV specification requirements"},"path":"/en-us/guides/sponsored-tv/creatives/overview","content":[" Below is a table showing the specifications of the video component. For more information on Sponsored TV specifications and guidelines, see Amazon Ads streaming TV ad policies.\n","|Specification\t|Details\t|\n","|---\t|---\t|\n","|Maximum file size\t|500MB\t|\n","|Aspect ratio\t|16:9\t|\n","|Required duration\t|6 to 45 sec  Note: Most video tools show rounded durations for video creative, therefore double-checking the asset(s) in a professional video editing tool with frame accuracy and controls down to milliseconds is recommended.\t|\n","|Minimum frame size\t|1920x1080\t|\n","|Minimum video bitrate\t|4mbps\t|\n","|Recommended video bitrate\t|8mbps\t|\n","|Video frame rate (fps)\t|23.976 (recommended), 24, 25, or 29.97 fps\t|\n","|Video frame rate mode\t|Constant\t|\n","|Minimum audio bitrate\t|192kbps\t|\n","|Audio sample rate\t|44.1kHz or 48kHz\t|\n","|Supported Formats\t|Video: H.264 or H.265; Audio: PCM or AAC\t|\n","|Audio Channel\t|Minimum of 2-Channels\t|\n"],"documentType":"guide"},{"title":"Sponsored TV creative overview","sectionHeader":{"type":2,"text":"Example"},"path":"/en-us/guides/sponsored-tv/creatives/overview","content":[" Once you have the assetId and assetVersion from using the asset library, you can associate the asset to an ad group by creating a creative. \n"," Request: \n"," Endpoint: POST /st/creatives\n"," Response: \n"," A successful response returns a creativeId.\n"],"documentType":"guide"},{"title":"Sponsored TV creative moderation","sectionHeader":null,"path":"/en-us/guides/sponsored-tv/creatives/creative-moderation","content":[" Your video asset will go through a moderation process, which includes technical specification and video quality checks. This document explains how to use the creative moderation endpoints to check moderation status and get more information if a video asset is rejected. \n"],"documentType":"guide"},{"title":"Sponsored TV creative moderation","sectionHeader":{"type":2,"text":"Check moderation status"},"path":"/en-us/guides/sponsored-tv/creatives/creative-moderation","content":[" To check if your asset has been REJECTED for moderation, you can use the /st/creatives/moderations/list endpoint.\n"," In the response, you can see the moderation status as REJECTED and the video URL source.\n"],"documentType":"guide"},{"title":"Sponsored TV creative moderation","sectionHeader":{"type":2,"text":"Get more information regarding rejection status"},"path":"/en-us/guides/sponsored-tv/creatives/creative-moderation","content":[" To get more information as to why your asset is REJECTED, you can use the /st/creatives/moderations/policyViolations/list endpoint. This endpoint returns a policy description citing what violations the creative asset has and what needs to be modified. \n"],"documentType":"guide"},{"title":"Sponsored TV creative preview","sectionHeader":null,"path":"/en-us/guides/sponsored-tv/creatives/creative-preview","content":[" The creative preview endpoint provides a preview of how the video will look in the ad itself. In the request body, you can either get the preview by using the assetProperties object or the creativeId. Once you specify whether you want to use creativeId or assetProperties, you must also specify the previewConfiguration. \n"],"documentType":"guide"},{"title":"Sponsored TV creative preview","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-tv/creatives/creative-preview","content":["creativeId - if using the creativeId parameter. See creative overview for more details. \\* assetId and assetVersion - if using the assetProperties object. See creating assets to obtain these values.\n"],"documentType":"guide"},{"title":"Sponsored TV creative preview","sectionHeader":{"type":2,"text":"Preview configuration"},"path":"/en-us/guides/sponsored-tv/creatives/creative-preview","content":[" The previewConfiguration object contains the configuration settings for the preview. \n"],"documentType":"guide"},{"title":"Sponsored TV creative preview","sectionHeader":{"type":3,"text":"Parameters"},"path":"/en-us/guides/sponsored-tv/creatives/creative-preview","content":["|Parameter\t|Type\t|Description\t|Optional   |\n","|---\t|---\t|---\t|\n","|safeZoneEnabled\t|boolean\t|If set to true, any interactive elements added by Sponsored TV to your ad creative are in the left-hand side of your ad. For more information, see Sponsored TV interactive experiences section.\t|Yes |\n","|callToActionPosition\t|string\t|The location of the CallToAction prompt. Can choose either LEFT or RIGHT.\t| Yes |\n","|asin\t|string\t|Amazon Standard Identification Number: The code that identifies the product being advertised. Vendors should use the asin parameter. |No |\n","|sku\t|string\t|Stock Keeping Unit: The unique identifier for the product being advertised. Sellers should use the sku parameter.\t| No | \n","|callToAction\t|string\t|Prompt to encourage the customer to take a desired action. When callToAction is not provided, the system provides a preview for all supported callToAction values. Currently only SHOP_NOW callToAction and base video preview are supported. The SHOP_NOW prompt takes the customer to the product landing page. \t|Yes| \n"],"documentType":"guide"},{"title":"Sponsored TV creative preview","sectionHeader":{"type":3,"text":"Vendor request"},"path":"/en-us/guides/sponsored-tv/creatives/creative-preview","content":[" Endpoint: POST /st/creatives/preview\n"],"documentType":"guide"},{"title":"Sponsored TV creative preview","sectionHeader":{"type":3,"text":"Seller request"},"path":"/en-us/guides/sponsored-tv/creatives/creative-preview","content":[" Endpoint: POST /st/creatives/preview\n"],"documentType":"guide"},{"title":"Sponsored TV creative preview","sectionHeader":{"type":2,"text":"Getting preview using creative ID"},"path":"/en-us/guides/sponsored-tv/creatives/creative-preview","content":[" Endpoint: POST /st/creatives/preview\n"],"documentType":"guide"},{"title":"Sponsored TV creative preview","sectionHeader":{"type":2,"text":"Getting preview using the asset properties"},"path":"/en-us/guides/sponsored-tv/creatives/creative-preview","content":[" To use the assetProperties object, you must have the assetId and assetVersion. \n"," Endpoint: POST /st/creatives/preview\n"],"documentType":"guide"},{"title":"Sponsored TV creative preview","sectionHeader":{"type":2,"text":"Response preview"},"path":"/en-us/guides/sponsored-tv/creatives/creative-preview","content":[" A successful response includes escaped HTML. You need to unescape the HTML and save it as a separate HTML file.\n"," The iframe has the same size as the default video size of 1920x1080. You can then open the iframe HTML in your browser to preview the video. \n"," Below is a sample iframe file code with a size of 480x270.\n"],"documentType":"guide"},{"title":"Sponsored TV ads","sectionHeader":null,"path":"/en-us/guides/sponsored-tv/ads","content":[" A Sponsored TV ad includes the details of the product from your brand. This product is the landing page for your ad. When a viewer interacts remotely with your ad and scans your ad QR code, they link to the detail page of this product.\n"],"documentType":"guide"},{"title":"Sponsored TV ads","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/sponsored-tv/ads","content":["Have an ad group ID\n"],"documentType":"guide"},{"title":"Sponsored TV ads","sectionHeader":{"type":2,"text":"Create an ad"},"path":"/en-us/guides/sponsored-tv/ads","content":[" The request to create an ad differs by whether you have a seller or vendor account. Seller accounts will set the entityType header to SELLER_CENTRAL_ACCOUNT, while vendors will set entityType to VENDOR. A successful response returns an adID.\n"," Endpoint: POST /st/ads\n"],"documentType":"guide"},{"title":"Sponsored TV ads","sectionHeader":{"type":3,"text":"Request for seller account"},"path":"/en-us/guides/sponsored-tv/ads","content":[" Response: \n"],"documentType":"guide"},{"title":"Sponsored TV ads","sectionHeader":{"type":3,"text":"Request for vendor account"},"path":"/en-us/guides/sponsored-tv/ads","content":[" Response:\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":null,"path":"/en-us/guides/dsp/developer-guide","content":[],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/dsp/developer-guide","content":[" The DSP campaign management APIs enable self-serve advertisers to programmatically manage their Amazon DSP campaign data (campaigns, ad groups, targeting). Use cases include:\n","Track campaigns in your own tools: Sync campaign metadata with your own data storage solution and surface in a custom UI to track all of your campaigns.  Simplify campaign creation: Build templates or custom workflows that reduce the time it takes to create a new campaign.   Automate campaign optimization: Automatically adjust bids and budgets in real-time to maximize campaign performance. \\* Targeting: Target specific inventory and audiences, add domain exclusions, and easily add or remove targets to maximize campaign performance. \n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Amazon DSP API Object Hierarchy"},"path":"/en-us/guides/dsp/developer-guide","content":[],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Campaign Creation Workflow"},"path":"/en-us/guides/dsp/developer-guide","content":[" The following steps guide you through creating a live campaign from start to finish.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Step 1: Create a campaign"},"path":"/en-us/guides/dsp/developer-guide","content":[" In this step, you define your campaign name, optimization settings, flight dates and budgets, frequency caps, and (optionally) budget caps, agency fee, PO number, and comments.\n"," Example: Create a campaign\n"," For the goalSetting object, only the kpi field is required on create. The value for goal is automatically inferred from the kpi value and can only be found in the list operation response. Here is the mapping of goal to kpi:\n","| goal (read-only) | kpi |\n","\\|--- \\|--- \\|\n","| AWARENESS | REACH |\n","| CONSIDERATION | CLICK_THROUGH_RATE, COST_PER_CLICK, COST_PER_VIDEO_COMPLETION, VIDEO_COMPLETION_RATE, COST_PER_DETAIL_PAGE_VIEW, DETAIL_PAGE_VIEW_RATE |\n","| CONVERSIONS | RETURN_ON_AD_SPEND, TOTAL_RETURN_ON_AD_SPEND, COST_PER_ACTION, COMBINED_RETURN_ON_AD_SPEND, COST_PER_SIGN_UP, COST_PER_FIRST_APP_OPEN |\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Step 2: Create an ad group"},"path":"/en-us/guides/dsp/developer-guide","content":[" When creating an ad group, you define the inventory type, advertised product categories, start and end dates, budget, pacing, optimization settings, bid, frequency caps, creative rotation type, and some targeting settings. Optionally, you may also provide fees, budget caps, a purchase order number, and comments. Advertised product categories refer to the category of products being advertised and can be retrieved from the advertised product categories discovery API. \n"," These inventory types are scheduled for deprecation on June 30, 2025: STANDARD_DISPLAY, AMAZON_MOBILE_DISPLAY, AAP_MOBILE_APP, VIDEO. We recommend you do not create new ad groups with these inventory types. Instead, create ad groups with these inventory types: DISPLAY, STREAMING_TV, ONLINE_VIDEO.\n"," Example: Create an ad group\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Step 3: Add/remove targeting on the ad group "},"path":"/en-us/guides/dsp/developer-guide","content":[" A few targeting fields can be found in the targetingSettings object in /dsp/v1/adGroups; however, any targeting setting where multiple targets can be applied to an ad group is found in the Universal Targets endpoint, /dsp/v1/targets. The Universal Targets endpoint allows you to add or remove different types of targeting objects across multiple ad groups in a single request. There are separate endpoints for adding and removing targets, so if you need to add and remove targets, you do this in two API requests.\n"," During the ad group creation workflow, default targets are automatically applied for devices, inventory, day parts, advertiser domain list, and video ad format.\n"," 3a) Example: Add domain and location targeting to an ad group\n"," To retrieve the geoLocation ID, use the geoLocations discovery endpoint, /dsp/geoLocations.\n"," 3b) Example: Remove domain and location targeting from an ad group\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Step 4: Associate creatives to the ad group"},"path":"/en-us/guides/dsp/developer-guide","content":[" You can use the adCreatives association endpoints to associate both legacy as well as new creatives to ad groups. \n"," Example: Associate an ad creative to an ad group\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Step 5: Enable conversion tracking on the campaign (optional)"},"path":"/en-us/guides/dsp/developer-guide","content":[" On the campaign, if you have chosen a kpi (for example, RETURN_ON_AD_SPEND) that requires tracking products sold on Amazon (ASINs), then you must associate products to the campaign.\n"," Example: Associate products (ASINs) to a campaign\n"," On the campaign, if you have chosen a kpi (for example, COST_PER_ACTION) that requires tracking off-Amazon conversions, then you must associate conversion definitions to the campaign.\n"," Visit the DSP support center for more information on using the conversions API for off-amazon event tracking and on conversion API security FAQs.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Step 6: Add, remove, and/or update campaign flights (optional)"},"path":"/en-us/guides/dsp/developer-guide","content":[" During campaign creation, you may create up to 12 flights in the campaign creation request. If you would like to add, remove, and/or update flights after campaign creation, you can use the flights array in PATCH /dsp/v1/campaigns. The flights array acts as a full replacement of all flights on a campaign. To add, delete, and/or update flights, include the full list of existing flights and only update those you wish to change. \n","To update existing flights, include all fields including flightId.   To add new flights, include all fields except flightId.   To delete flights, do not include them. Flights with a start date in the past cannot be deleted.  If you do not want to make any changes to flights, leave the array null.  Campaigns can have a max of 12 current + future flights. Campaigns can have a max of 150 total flights.\n"," Alternatively, you can also do this using the flights endpoint.\n"," https://advertising.amazon.com/API/docs/en-us/dsp-ad-group-campaign-flights\n"," Example: Add flights to a campaign - flights endpoint\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Step 7: Activate the campaign and ad group(s) "},"path":"/en-us/guides/dsp/developer-guide","content":[" The final step in launching a campaign is to activate both the campaign and ad group(s). Note that activation cannot be done during campaign or ad group creation. These can only be activated with the PATCH operation.\n"," Example: Activate a campaign\n"," Example: Activate an ad group\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Using audience targeting"},"path":"/en-us/guides/dsp/developer-guide","content":[" The structure of audience targeting has changed from the previous API. The new structure is simplified and less likely to lead to errors during setup. \n"," New audience structure:\n","Up to 500 audiences can be associated per ad group.  All audiences within the same group must either be included or excluded.  You can specify up to 10 inclusion groups and 1 exclusion group.  To add audiences to a group, you must specify a groupId. Only numbers 1 through 11 (formatted as strings) are accepted (for example, \"1\").    The intraOperator and interOperator fields have been removed from the write operations. Instead, the boolean logic is set automatically:  \\* There are future plans to update the ADSP UI to match this simplified workflow. Until then, ad groups can be set up with the old structure in the UI. To enable you to read the old structure, the /dsp/v1/targets/list endpoint has the legacy fields inGroupOperator and acrossGroupOperator. These fields cannot be included in write operations as the operators are set automatically.\n"," What happens if you try to edit an ad group that does not follow the new structure?\n","For line items with more than 10 inclusion and/or 1 exclusion groups, you receive an error when trying to add new audiences or groups; however, you are allowed to delete existing audiences and groups. \\* For groups that have both inclusion and exclusion audiences, you cannot add new audiences to these groups. However, you are allowed to delete these audiences/groups, add new audiences to other groups, and add new groups.\n"," Example: Add audience targets to an ad group\n"," Example: List audience targets on an ad group\n"," Response:\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Using the discovery APIs"},"path":"/en-us/guides/dsp/developer-guide","content":[" The Discovery APIs are a group of endpoints that list all the object IDs eligible to be applied to a specific ad group. For example, the Inventory - Exchanges endpoint provides a list of inventory exchange IDs that are eligible to be targeted given a set of ad group filters. These endpoints have two purposes: 1) To provide the identifiers, and 2) To tell you which objects are eligible to be applied to an ad group.\n"," Discovery APIs:\n","Advertised Product Categories: The category of the products or services being advertised. These categories are sent to publishers and exchanges to determine whether a campaign is eligible to run on a given set of inventory. All ad groups must have at least one advertised product category. 2. Audiences: Audiences can be Amazon-created, custom built by the user, or created by a third-party data provider. 3. Domain Lists: User-created lists of site domains for targeting. Note that these lists can only be created and edited in the ADSP UI. 4. IAB Content Categories: The category of the inventory content as defined by the Interactive Advertising Bureau. 5. Inventory - Deals: Deals are curated groupings of inventory with specific prices and dates. All ad groups must target at least one deal or exchange. 6. Inventory - Exchanges: Includes third-party exchanges and SSPs, Amazon owned and operated inventory, and Amazon Publisher Direct. All ad groups must target at least one deal or exchange. 7. Locations: Includes countries, states, postal codes, DMAs, and cities for targeting. 8. Products: A type of contextual targeting using ASINs. 9. Product Categories: A type of contextual targeting using ASIN categories. 10. Streaming TV Apps: Streaming TV apps used for targeting on video ad groups. 11. Third-Party Target Segments: Segments from third-party vendors including DoubleVerify and Oracle Data Cloud.\n"," Note: There is no discovery endpoint for mobile app identifiers. To retrieve these, you can pull them from the Google Play Store and the Apple App Store.\n"," Example: List inventory exchange IDs eligible to be targeted by a standard display ad group\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Default behavior"},"path":"/en-us/guides/dsp/developer-guide","content":[" For some settings, a value is set for certain fields automatically, usually during the campaign or ad group creation workflow. If you do not want these default values applied, you can remove or update the defaults after ad group creation.\n"," List of Defaults:\n","| Workflow | API(s) where you can list and update the default values | Field | API Default value |\n","\\|--- \\|--- \\|--- \\|--- \\|\n","| Campaign and ad group creation | /dsp/v1/campaigns  /dsp/v1/adGroups | state | INACTIVE |\n","| Ad group creation and update | /dsp/v1/adGroups | budgetAmount | Varies based on optimization. Users are not allowed to edit budgetAmount when automateBudgetAllocation=true at both the campaign and ad group levels. Instead, it is set automatically by the optimization systems. To edit budgetAmount, change automateBudgetAllocation to false. |\n","| Ad group creation | /dsp/v1/targets | dayPartTarget | All dayparts are included. |\n","| Ad group creation | /dsp/v1/targets | deviceTarget | All eligible devices are included. |\n","| Ad group creation | /dsp/v1/targets | inventorySourceTarget | All eligible inventory sources (excluding deals and inventory groups) are included. |\n","| Ad group creation | /dsp/v1/targets | domainTargetDetails.advertiserDomainList | boolean: true. This does not apply to ad groups where inventoryType=AAP_MOBILE_APP because these do not support domain targeting. |\n","| Ad group creation | /dsp/v1/targets | videoAdFormatTarget | All ad formats. This only applies to ad groups where inventoryType=VIDEO. |\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":null,"path":"/en-us/guides/dsp/campaign-management-faq","content":[],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":2,"text":"General"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"What functionality is supported?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" The DSP campaign management APIs support the below features.\n","Customer type: Amazon self service.  Ad group inventory types: Display, Streaming TV, Online Video, Audio  Deals: Preferred, Private Auction, Programmatic Guaranteed, and Amazon Guaranteed (read only)\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"What functionality is not supported via the new CM APIs?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" The DSP campaign management APIs do not currently support the below features.\n","Customer type: Amazon managed service.  Ad group inventory types: Podcast, Digital Out-Of-Home  Deals: Creating or updating campaigns targeting Amazon Guaranteed deals. Read-only support is enabled.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"Why do the APIs use \"campaign\" and \"ad group\" whereas the UI uses \"order\" and \"line item\"?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" Campaigns and ad groups are alternative names for orders and line items. These APIs were designed to more closely align with our Sponsored Ads APIs which use the \"campaign\" and \"ad group\" terminology. Even though the object names differ from the UI, the objects and data are the same across the UI and API.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":2,"text":"Campaigns"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"I cannot find the `goal` or `productLocation` field on campaigns."},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" In the new campaign endpoint, only the kpi field is required on campaign creation. The value for goal is now automatically inferred from the kpi value and can be found in the campaign list operation response. As a result, you no longer need to reference the legacy /dsp/goalConfigurations discovery endpoint.\n"," The productLocation field has been removed from the DSP campaign management APIs as it is no longer used for optimization.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"When I set `automatedBudgetAllocation` to `false` at the campaign level, it is still set to `true` at the ad group level. Is this expected?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" Yes, this is expected behavior and a change from the legacy APIs. In the DSP campaign management APIs, automateBudgetAllocation is now independently set at the campaign and ad group levels. In order for automated budget allocation to be enabled, it must be set to true at both the campaign and ad group levels separately. Note that this is slightly different from the ADSP Console UI, where if automateBudgetAllocation=false at the order level, the line item will automatically change to a manual budget.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"Were the flight `spentAmount` and `remainingAmount` fields removed from the new campaign API?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" Yes, the flight spentAmount and remainingAmount fields from the legacy Order API have been removed in the new API. Instead, you can pull flight spend amount from the Amazon Marketing Stream ADSP performance data set.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"I am not able to edit some campaigns/ad groups. When I try to update them, I receive an `AMAZON_DEAL_NOT_SUPPORTED` error."},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" Campaigns and ad groups targeting Amazon Guaranteed deals are supported on a read-only basis. This is because Amazon Guaranteed deals are on a deprecation path, and will be replaced by Programmatic Guaranteed deals instead. \n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"Some of my campaigns/ad groups are missing the `deliveryStatus` and/or `state` fields. Is this expected?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" If your campaign/ad group has not ended, it should never be missing the deliveryStatus or state field. However, there may be some older ended campaigns or ad groups that are missing the deliveryStatus and/or state fields. We recommend updating your logic such that whenever a campaign or ad group has an end date in the past, and these fields are missing, the deliveryStatus becomes ENDED and state becomes INACTIVE.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"Some of my campaigns have `goal=OTHER`, but the UI shows `goal=Awareness`. Why?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" Some older campaigns were created without any goal value; however, the UI has no option to show a null goal value, so it defaults to Awareness. In this case, the API is correct while the UI is incorrect. This should only affect a smaller number of older, ended campaigns.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"Where can I find the `autoOptimizations` field that was in the legacy `/orders` API?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" The replacement fields in the DSP campaign management APIs are automateBudgetAllocation and automateBidAllocation. Note that automateBidAllocation is read only, and only appears in the response for POST /dsp/v1/campaigns/list. This is because, starting in Sept 2023, there was a change in ADSP optimization settings. Campaigns created after this month could no longer use the automateBidAllocation field, so you will only see this field on old legacy campaigns as read only.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":2,"text":"Ad Groups"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"I noticed some `inventoryTypes` are on a deprecation path. Which ones should I use?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" We recommend you do not create new ad groups with these inventoryTypes, as they will be removed in the next major version: STANDARD_DISPLAY, AMAZON_MOBILE_DISPLAY, AAP_MOBILE_APP, VIDEO. Instead, please use these new inventoryTypes: DISPLAY, ONLINE_VIDEO, STREAMING_TV.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"The `targetingSettings` field on ad groups is missing many target types. Where can I find these?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" Only a limited set of targeting fields are in the targetingSettings field on /dsp/v1/adGroups. Most targeting settings are found in our targeting endpoint, /dsp/v1/targets.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"Can I delete ad groups via the API? Can I retrieve deleted ad groups via the API?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" Currently, users may only delete ad groups via the Amazon DSP native UI. This is a hard delete, meaning that once deleted, the ad group will no longer be visible in the UI and can no longer be retrieved via API. However, deleted ad group performance data will still exist in reports pulled via both UI and API.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":2,"text":"Targets"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"After creating an ad group, there is a delay before I can retrieve the default targets. Is this expected?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" This is expected behavior, as the campaign management read APIs are eventually consistent. For retrieving default targets after ad group creation, the p99 time to wait is 20s and maximum is 30s. \n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"Why does the structure for audience targeting in the API not match what is in the UI?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" The new API audience targeting structure represents a simplified format that more closely aligns with industry standards and prevents common setup errors. Detailed audience targeting instructions can be found in our migration and getting started guides.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"What happens if I try to edit an ad group that has the legacy audience targeting structure?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":["For line items with more than 10 inclusion and/or 1 exclusion groups, you will receive an error when trying to add new audiences or groups; however, you will be allowed to delete existing audiences and groups. \\* For groups that have both inclusion & exclusion audiences, you will not be able to add new audiences to these groups. However, you are allowed to delete these audiences/groups, add new audiences to other groups, and add new groups.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"When adding targets and one fails, the entire request fails. Is this expected?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" Yes, currently our /dsp/v1/targets endpoint is atomic, meaning it does not support partial success. If any single target fails, the entire operation will fail. \n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"Does the targets API support partial success?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" The targets API supports partial success across different targetTypes, but it does not support partial success within a single targetType on a single ad group. This means that if you send a geo target and a domain target and one fails, the other can still succeed. However, if you send two domain targets on one ad group and one target fails, then the whole request will fail.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"Why can I not change the `state` field on targets from `ENABLED` to `DISABLED`?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" The state field on our /dsp/v1/targets endpoint currently only has one possible value: ENABLED. We do not support any other states. This means that if a target is removed from an ad group, it will no longer appear in the targets list response. It is not currently possible to have a disabled target on an ad group.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"Which `targetTypes` support the `negative` attribute?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[" The negative boolean field in /dsp/v1/targets can be either true or false for these target types: audienceTarget, locationTarget, domainTarget, appTarget, productCategoryTarget, productTarget. For all other target types, negative must be false, as these target types do not support exclusion targeting.\n"],"documentType":"guide"},{"title":"ADSP Campaign Management API FAQ","sectionHeader":{"type":3,"text":"The UI supports `dspContentRatingTarget` and `contentGenreTarget` for online video ad groups, but the API does not. Why?"},"path":"/en-us/guides/dsp/campaign-management-faq","content":[],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":null,"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The new campaign management APIs enable self-serve advertisers and their partners to programmatically manage their Amazon DSP campaign data (campaigns, ad groups, targeting). These new APIs replace the previous campaign management APIs.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"New API Highlights"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":["The campaign list endpoint now includes flights in the response so that you can read complete campaign data for up to 100 campaigns at a time.   Campaign and ad group endpoints support PATCH operations (partial updates) so you can update individual fields (e.g. budget) without sending all fields.   Targeting has its own endpoint and supports adding or removing individual targets so you do not have to replace the full array of existing targets. \\* The new APIs are available worldwide in all marketplaces where ADSP operates.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Endpoint Equivalencies"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":["| Old endpoint | New endpoint |\n","\\| -----------  \\| ------------ \\|\n","| GET /dsp/lineItems/ | POST /dsp/v1/adGroups/list  POST /dsp/v1/targets/list |\n","| POST /dsp/lineItems/ | POST /dsp/v1/adGroups  POST /dsp/v1/targets  POST /dsp/v1/targets/deleteByObject | \n","| PUT /dsp/lineItems/ | PATCH /dsp/v1/adGroups |\n","| GET /dsp/lineItems/{lineItemId} | POST /dsp/v1/adGroups/list | \n","| GET /dsp/targeting/domain | POST /dsp/v1/targets/list | \n","| PUT /dsp/targeting/domain | POST /dsp/v1/targets  POST /dsp/v1/targets/deleteByObject | \n","| POST /dsp/lineItems/{lineItemId}/deliveryActivationStatus | PATCH /dsp/v1/adGroups | \n","| GET /dsp/orders/ | POST /dsp/v1/campaigns/list |\n","| POST /dsp/orders/ | POST /dsp/v1/campaigns | \n","| PUT /dsp/orders/ | PATCH /dsp/v1/campaigns |\n","| GET /dsp/orders/{orderId} | POST /dsp/v1/campaigns/list |\n","| n/a | POST /dsp/v1/campaigns/{campaignId}/flights/list | \n","| n/a | POST /dsp/v1/campaigns/{campaignId}/flights/delete | \n","| n/a | POST /dsp/v1/campaigns/{campaignId}/flights | \n","| n/a | PATCH /dsp/v1/campaigns/{campaignId}/flights | \n","| GET /dsp/orders/{orderId}/conversionTracking | N/A | \n","| PUT /dsp/orders/{orderId}/conversionTracking | N/A | \n","| GET /dsp/orders/{orderId}/conversionTracking/pixels | Pixels have been deprecated and replaced by Amazon Ad Tags. |\n","| PUT /dsp/orders/{orderId}/conversionTracking/pixels | Pixels have been deprecated and replaced by Amazon Ad Tags. | \n","| GET /dsp/orders/{orderId}/conversionTracking/products | GET /dsp/v1/campaigns/{campaignId}/conversionTracking/products | \n","| PUT /dsp/orders/{orderId}/conversionTracking/products | POST /dsp/v1/campaigns/{campaignId}/conversionTracking/products  POST /dsp/v1/campaigns/{campaignId}/conversionTracking/products/delete | \n","| GET /dsp/orders/{orderId}/conversionTracking/products/export | N/A |\n","| POST /dsp/orders/{orderId}/deliveryActivationStatus | PATCH /dsp/v1/campaigns | \n","| GET /dsp/productCategories | POST /dsp/v1/advertisedProductCategories/list | \n","| GET /dsp/supplySources | POST /dsp/v1/inventorySourceExchanges/list  POST /dsp/inventorySourceDeals/list | \n","| GET /dsp/iabContentCategories | POST /dsp/v1/iabContentCategories/list | \n","| GET /dsp/preBidTargeting/doubleVerify/customContextualSegments\t | POST /dsp/v1/thirdPartyTargetSegments/list |\n","| GET /dsp/preBidTargeting/oracleDataCloud/customPredicts | POST /dsp/v1/thirdPartyTargetSegments/list |\n","| GET /dsp/preBidTargeting/oracleDataCloud/standardPredicts | POST /dsp/v1/thirdPartyTargetSegments/list |\n","| GET /dsp/apps | POST /dsp/v1/apps/list | \n","| GET /dsp/domainLists | POST /dsp/v1/domainLists/list | \n","| N/A | POST /dsp/v1/products/list | \n","| N/A | POST /dsp/v1/productCategories/list | \n","| GET /dsp/pixels | Pixels have been deprecated and replaced by Amazon Ad Tags. | \t\n","| GET /dsp/goalConfigurations | N/A | \n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Entity naming"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" In the new endpoints, orders have been renamed to campaigns, and line items have been renamed to ad groups. The identifiers for these objects remain the same.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Authorization"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The new endpoints require an Advertiser header (Amazon-Ads-AccountId). This is your Amazon DSP advertiser ID, which can be retrieved from the advertiser endpoint. \n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Update operations"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The previous campaign and ad group endpoints used the PUT operation for updates which required a full replacement of all fields. The new endpoints utilize PATCH (partial updates) which means you can send only the fields you wish to update, and any fields not included in the request will remain unchanged. \n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Read operations"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The previous endpoints used the GET operation to read resources; and orders and line items had two separate GET endpoints: 1) a batch read endpoint that returned up to 100 orders/line items for a subset of fields, and 2) a read endpoint that returned a single order/line item with all fields. The new endpoints now support the ability to read up to 100 campaigns and ad groups with all fields included in the response. The batch read endpoints are implemented as POST /list operations which allows you to use filters in the request body. \n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Campaign flights"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" Flights are now returned in the campaign list operation. Because all campaigns must have at least one flight, flights are a required field in the campaign create operation. However, once a campaign is created, you must use the separate flight endpoints to update, add, or remove flights. The new flights endpoint allows you to add or remove individual flights without sending the full list of all existing flights. If you need to delete, update, and create new flights, the sequence should be delete first, then update, then create.\n"," The spentAmount and remainingAmount fields of the flight object are no longer returned in the campaign list endpoint. We recommend you retrieve spend data using the ADSP report API.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Campaign optimization"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" In the new campaign endpoint, only the kpi field is required on campaign creation. The value for goal is automatically inferred from the kpi value and can be found in the campaign list operation response. As a result, you no longer need to reference the legacy /dsp/goalConfigurations discovery endpoint. \n"," The productLocation field has been removed from the new APIs as it is no longer used for optimization. \n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Ad group inventoryType"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The field called lineItemType in the previous API is now called inventoryType in dsp/v1/adGroups. \n"," These inventoryTypes are scheduled for deprecation on June 30, 2025: STANDARD_DISPLAY, AMAZON_MOBILE_DISPLAY, AAP_MOBILE_APP, VIDEO. We recommend you do not create new ad groups with these inventoryTypes. Instead, use these inventoryTypes: DISPLAY, ONLINE_VIDEO, STREAMING_TV.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Targeting"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" Targeting is no longer part of the line item object and can be managed in its own dedicated endpoint: /dsp/v1/targets. This new endpoint allows you to add multiple targets across multiple ad groups within a single request. It also allows you to add or remove individual targets without sending all the existing targets.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Audience targeting"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The structure of audience targeting has changed from the previous API. The new structure is simplified and less likely to lead to errors during setup. \n"," New audience structure:\n","Up to 500 audiences can be associated per ad group.  All audiences within the same group must either be included or excluded.  You can specify up to 10 inclusion groups and 1 exclusion group.  To add audiences to a group, you must specify a groupId. Only numbers 1 through 11 (formatted as strings) are accepted (e.g., \"1\").    We removed the intraOperator and interOperator fields from the write operations. Instead, the boolean logic will be set automatically:  \\* A small percentage of old audience targets used explicit intraOperator and acrossGroupOperator, which can no longer be created in all interfaces. These fields cannot be included in write operations as the operators are set automatically, but will surface in read operations.\n"," What happens if I try to edit an ad group that does not follow the new structure?\n","For line items with more than 10 inclusion and/or 1 exclusion groups, you will receive an error when trying to add new audiences or groups; however, you will be allowed to delete existing audiences and groups. \\* For groups that have both inclusion & exclusion audiences, you will not be able to add new audiences to these groups. However, you are allowed to delete these audiences/groups, add new audiences to other groups, and add new groups.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Audience targeting example - legacy API"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" This example is a truncated request that sets audience targeting using the legacy /dsp/lineItems endpoint:\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Audience targeting example - new API"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" This example sets the same audience targeting using the new /dsp/v1/targets endpoint:\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Contextual targeting"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The new APIs include a new type of contextual targeting. Through the Amazon retail taxonomy of over 40K product categories, advertisers can select specific Amazon products (ASINs) or categories (browse nodes), and express the type of content where they want their ads shown on Amazon.com and 3rd party supply. To retrieve the contextual targeting IDs, use these discovery endpoints:\n","Products: /dsp/v1/products/list - Product Categories: /dsp/v1/productCategories/list\n"," Once the IDs have been retrieved, you can use /dsp/v1/targets (using the productTarget and productCategoryTarget objects) to add the targets to an ad group.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Deal IDs"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" Deals now have a new ID format. To retrieve a list of deal IDs that can be used in the /dsp/v1/targets endpoint, use the new deal discovery API. Deal IDs returned from the legacy /dsp/supplySources are not supported in the /dsp/v1/targets endpoint.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Discovery APIs"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The new APIs include new versions of all the legacy discovery APIs except for these:\n","|Legacy Discovery API\t|Status\t|Function\t|Note\t|\n","|---\t|---\t|---\t|---\t|\n","|GET /dsp/pixels\t|Deprecation path\t|Gets list of pixels that can be used for off-Amazon conversion tracking.\t|Pixels were deprecated as of Jan '24 and can no longer be added to campaigns.\t|\n","|GET /dsp/goalConfigurations\t|Deprecation path\t|Gets list of possible configurations for campaign goals.\t|Campaign goals were simplified and there is no longer a need for this endpoint.\t|\n","|GET /dsp/geoLocations\t|Active\t|Gets list of geolocation IDs that can be targeted on an ad group.\t|Users will continue to use this endpoint as it did not require any updates.\t|\n","|POST /audiences/list\t|Active\t|Gets list of audience IDs that can be targeted on an ad group.\t|Users will continue to use this endpoint as it did not require any updates.\t|\n","|POST /audiences/taxonomy/list\t|Active\t|Gets the taxonomy for audiences.\t|Users will continue to use this endpoint as it did not require any updates.\t|\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Inventory Discovery "},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The legacy /dsp/supplySources endpoint has been replaced by two new endpoints: \n","|New Endpoint\t|Function\t|\n","|---\t|---\t|\n","|/dsp/inventorySourceDeals/list\t|Gets a list of deal IDs that can be targeted on an ad group.\t|\n","|/dsp/v1/inventorySourceExchanges/list\t|Gets a list of Amazon owned & operated, Amazon Publisher Direct, and third-party exchange inventory source Ids that can be targeted on an ad group.\t|\n"," Note that the supplySourceType field has been renamed to inventorySourceType and has new enum values:\n","|supplySourceType (legacy)\t|inventorySourceType (new)\t|New endpoint\t|Note\t|\n","|---\t|---\t|---\t|---\t|\n","|AMAZON_EXCLUSIVE\t|AMAZON\t|/dsp/v1/inventorySourceExchanges/list\t|This refers only to Amazon owned & operated inventory and no longer includes Amazon Publisher Direct which is now a separate category.\t|\n","|AMAZON_EXCLUSIVE\t|AMAZON_PUBLISHER_DIRECT\t|/dsp/v1/inventorySourceExchanges/list\t|This now has its own category. APD provides direct access to thousands of premium third-party video, display, and audio publishers around the world.\t|\n","|OPEN_EXCHANGE\t|THIRD_PARTY_EXCHANGE\t|/dsp/v1/inventorySourceExchanges/list\t|This refers to third-party exchanges such as OpenX and Pubmatic.\t|\n","|DEAL\t|N/A\t|/dsp/inventorySourceDeals/list\t|Deal Ids are now retrieved in a separate endpoint.\t|\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Programmatic Guaranteed deals"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The new APIs include support for Programmatic Guaranteed (PG) deals. PG deals are guaranteed, negotiated deals, which include pre-specified date ranges, fixed impression goals, predefined inventory with targeting parameters, and fixed rates. Most targeting and other ad group settings (e.g. frequency caps) are disabled when targeting PG deals because these settings are typically built into the PG deal itself.\n"," To create a PG deal targeted ad group: 1) Use /dsp/inventorySourceDeals/list with DEAL_TYPE=PROGRAMMATIC_GUARANTEED to find the deal ID. 2) Send the deal ID in /dsp/v1/adGroups, using field targetingSettings.targetedPGDealId, when creating or editing an ad group.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Versioning"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The new APIs utilize path-based versioning instead of header-based versioning. All new endpoints begin with /dsp/v1/. You no longer need to send an Accept header.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Date format"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The new APIs use the RFC3339 profile of ISO-8601 (YYYY-MM-DDThh:mm:ssTZD) as their date format.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Conversion tracking"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" Pixels were deprecated at the end of 2023 and can no longer be used on new campaigns. Campaigns tracking off-Amazon conversions should now associate conversion definitions to an order using this endpoint. \n"," To retrieve the full list of products used for conversion tracking, you no longer need to export the list as a file. Instead, you can paginate through the full list using this endpoint.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Campaign and ad group activation"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" Campaigns and ad groups are created in an inactive state and must be activated before they can begin serving. In the old APIs, activation was done via a separate deliveryActivationStatus endpoint. In the new APIs, activation is done via the PATCH operation on the campaign or ad group endpoints.\n"," New API example - set ad group to active:\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Error model"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" The error model has been improved. Key changes include:\n","Removed fieldName, errorDetails, and top level message.  Renamed errorType to errorCode.  Renamed message to errorMessage.  New fields:  Added requestId to response for successful calls. This should be included when submitting support tickets so that our support team can find the request in our logs. \\* If success or error array is empty, the array will be omitted from the response.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Defaults"},"path":"/en-us/reference/migration-guides/adsp-campaign-management","content":[" As with the legacy APIs, certain default values are set automatically. In the new APIs, it is not possible to override these defaults when creating a campaign or ad group. You can view and edit the default values by using the APIs listed below.\n","|Workflow\t|API used to read the defaults\t|API used to edit the defaults\t|Field\t|API Default value\t|Notes\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Campaign & ad group creation\t|POST /dsp/v1/campaigns/list  POST /dsp/v1/adGroups/list\t|PATCH /dsp/v1/campaigns  PATCH /dsp/v1/adGroups\t|state\t|INACTIVE\t|It is not possible to set state=ACTIVE during the creation workflow.\t|\n","|Ad group creation and update\t|POST /dsp/v1/adGroups/list\t|PATCH /dsp/v1/adGroups\t|budgetAmount\t|The value varies based on optimization.\t|Users are not allowed to edit budgetAmount when automateBudgetAllocation=true at both the campaign and ad group levels. Instead, it is set automatically by our optimization systems. To edit budgetAmount, change automateBudgetAllocation to false.\t|\n","|Ad group creation\t|POST /dsp/v1/targets/list\t|POST /dsp/v1/targets  POST /dsp/v1/targets/deleteByObject |dayPartTarget\t|All dayparts are included.\t|\t|\n","|Ad group creation\t|POST /dsp/v1/targets/list\t|POST /dsp/v1/targets  POST /dsp/v1/targets/deleteByObject |deviceTarget\t|All eligible devices are included.\t|\t|\n","|Ad group creation\t|POST /dsp/v1/targets/list\t|POST /dsp/v1/targets  POST /dsp/v1/targets/deleteByObject |inventorySourceTarget\t|All eligible inventory sources (excluding deals and inventory groups) are included.\t|\t|\n","|Ad group creation\t|POST /dsp/v1/targets/list\t|POST /dsp/v1/targets  POST /dsp/v1/targets/deleteByObject |domainTarget\t|advertiserDomainList.inheritFromAdvertiser=true\t|This does not apply when inventoryType=AAP_MOBILE_APP because these ad groups do not support domain targeting.\t|\n","|Ad group creation\t|POST /dsp/v1/targets/list\t|POST /dsp/v1/targets  POST /dsp/v1/targets/deleteByObject |videoAdFormatTarget\t|All ad formats are included.\t|This only applies when inventoryType=VIDEO.\t|\n"],"documentType":"guide"},{"title":"Targeting Programmatic Guaranteed Deals","sectionHeader":null,"path":"/en-us/guides/dsp/targeting-pg-deals","content":[" Programmatic Guaranteed (PG) deals are pre-negotiated, invitation-only deals where the seller guarantees a fixed volume of impressions at a fixed price. The seller manages targeting and decisioning. When targeting a PG deal, there are specific validation rules that must be followed. Additionally, PG Share of Voice (PG SOV) deals have their own validation rules.\n"],"documentType":"guide"},{"title":"Targeting Programmatic Guaranteed Deals","sectionHeader":{"type":3,"text":"Steps for targeting PG deals via API"},"path":"/en-us/guides/dsp/targeting-pg-deals","content":["Create campaign  2. Find available PG deal IDs 3. Create ad group targeting PG deal ID\n"],"documentType":"guide"},{"title":"Targeting Programmatic Guaranteed Deals","sectionHeader":{"type":3,"text":"1. Create campaign"},"path":"/en-us/guides/dsp/targeting-pg-deals","content":[" Create a campaign following the below validation rules.\n","flights.startDateTime must be <=deal startDate. flights.endDateTime must be >=deal endDate  frequencies.frequencyType=UNCAPPED  optimization.goalSetting.kpi != REACH \\* optimization.bidStrategy=PRIORITIZE_KPI_TARGET\n"," PG SOV validation rules:\n","optimization.bidStrategy=SPEND_BUDGET_IN_FULL\n"," API:\n"," Example API call:\n"," Response:\n"],"documentType":"guide"},{"title":"Targeting Programmatic Guaranteed Deals","sectionHeader":{"type":3,"text":"2. Find available PG deals for targeting"},"path":"/en-us/guides/dsp/targeting-pg-deals","content":[" Find deals where dealType=PROGRAMMATIC_GUARANTEED, and the deal start/end dates are aligned with your campaign start/end dates.\n"," API:\n"," Example API call:\n"," Response:\n"," Note: For PG SOV deals, priceType will be FLAT_FEE instead of FIXED_CPM.\n"],"documentType":"guide"},{"title":"Targeting Programmatic Guaranteed Deals","sectionHeader":{"type":3,"text":"3. Create ad group targeting PG deal"},"path":"/en-us/guides/dsp/targeting-pg-deals","content":[" Create an ad group following the below validation rules.\n","creativeRotationType=RANDOM  advertisedProductCategoryIds=343050382647447279  pacing.deliveryProfile=ASAP  targetingSettings.videoCompletionTier=ALL_TIERS  targetingSettings.amazonViewability.viewabilityTier=ALL_TIERS  targetingSettings.includeUnmeasurableImpressions=false  targetingSettings.timeZoneType=ADVERTISER_REGION  targetingSettings.userLocation=EVERYWHERE  targetingSettings.userLocationSignal=CURRENT  targetingSettings.targetedPGDealId must include one valid PG deal ID.  optimization.bidStrategy=PRIORITIZE_KPI_TARGET  bid.baseBid and bid.maxAverageCPM must be set to the PG deal price  frequencies.frequencyType=UNCAPPED  A PG campaign can have multiple ad groups.  A PG ad group can only target one PG deal. \\* A PG deal can be targeted by multiple campaigns and ad groups.\n"," PG SOV validation rules:\n","A PG SOV campaign can only have one ad group.  A PG SOV ad group can only target one PG SOV deal.  A PG SOV deal can only be targeted by one ad group. \\* optimization.bidStrategy=SPEND_BUDGET_IN_FULL\n"," API:\n"," Example API call:\n"," Response:\n"],"documentType":"guide"},{"title":"IAS contextual targeting segments","sectionHeader":null,"path":"/en-us/guides/dsp/tutorials/contextual-segments","content":[],"documentType":"guide"},{"title":"IAS contextual targeting segments","sectionHeader":{"type":2,"text":"Full list of contextual segments"},"path":"/en-us/guides/dsp/tutorials/contextual-segments","content":[],"documentType":"guide"},{"title":"IAS contextual targeting segments","sectionHeader":{"type":3,"text":"Vertical"},"path":"/en-us/guides/dsp/tutorials/contextual-segments","content":["| Segment ID   | Segment name |\n","\\| ------------ \\| ------------ \\|\n","| \"3006622\" | \"Agriculture & Farming\" | \n","| \"3006625\" | \"Agriculture & Farming - Chicken Owner\" | \n","| \"3006626\" | \"Agriculture & Farming - Duck Owner\" | \n","| \"3006627\" | \"Agriculture & Farming - Horse Owner\" | \n","| \"3006624\" | \"Agriculture & Farming - Livestock\" | \n","| \"3006623\" | \"Agriculture & Farming - Organic Farming\" | \n","| \"3008527\" | \"Automotive\" | \n","| \"3006608\" | \"Automotive - Auto Parts & Auto Repair\" | \n","| \"3006910\" | \"Automotive - Auto Racing\" | \n","| \"3006605\" | \"Automotive - Auto Recalls\" | \n","| \"3006604\" | \"Automotive - Auto Shows\" | \n","| \"3005007\" | \"Automotive - City Car\" | \n","| \"3006606\" | \"Automotive - Commercial Trucks\" | \n","| \"3007857\" | \"Automotive - Electric & Hybrid Cars\" | \n","| \"3005009\" | \"Automotive - Family Car\" | \n","| \"3005022\" | \"Automotive - Luxury Car\" | \n","| \"3005030\" | \"Automotive - Sport Car\" | \n","| \"3005032\" | \"Automotive - SUV\" | \n","| \"3006607\" | \"Automotive - Used Cars\" | \n","| \"3008890\" | \"Automotive - Light-Duty Trucks\" | \n","| \"3005036\" | \"Baby Care\" | \n","| \"3005037\" | \"Baby Care - Baby Food\" | \n","| \"3005044\" | \"Consumer Electronics - Apple/iPhone\" | \n","| \"3005045\" | \"Consumer Electronics - Samsung\" | \n","| \"3005038\" | \"Consumer Electronics - Gaming Consoles\" | \n","| \"3005039\" | \"Consumer Electronics - Laptops, Desktops, PCs\" | \n","| \"3005040\" | \"Consumer Electronics - Smartphones, Tablets\" | \n","| \"3005041\" | \"Consumer Electronics - TV, Smart TV\" | \n","| \"3005042\" | \"Consumer Electronics - Wearables\" | \n","| \"3005043\" | \"Consumer Electronics - Appliances\" | \n","| \"3007356\" | \"Education\" | \n","| \"3006364\" | \"Energy\" | \n","| \"3006365\" | \"Energy - Oil\" | \n","| \"3006366\" | \"Energy - Coal\" | \n","| \"3006367\" | \"Energy - Electricity\" | \n","| \"3006368\" | \"Energy - Nuclear Energy\" | \n","| \"3006369\" | \"Energy - Green Energy\" | \n","| \"3006370\" | \"Energy - Natural Gas\" | \n","| \"3005055\" | \"Entertainment - Music Events\" | \n","| \"3005057\" | \"Entertainment - Pay-per-view Services\" | \n","| \"3005061\" | \"Entertainment - Sports Events\" | \n","| \"3008367\" | \"Entertainment - Women's Sports\" | \n","| \"3005063\" | \"Entertainment - Theater Events\" | \n","| \"3005053\" | \"Entertainment - Horror Movies & Books\" | \n","| \"3005059\" | \"Entertainment - Romance Movies & Books\" | \n","| \"3005046\" | \"Entertainment - Action/Adventure Movies & Books\" | \n","| \"3005047\" | \"Entertainment - Anime/Animation Movies & Books\" | \n","| \"3005048\" | \"Entertainment - Children/Family Movies & Books\" | \n","| \"3005049\" | \"Entertainment - Brand Classic Movies & Books\" | \n","| \"3005051\" | \"Entertainment - Crime Movies & Books\" | \n","| \"3005050\" | \"Entertainment - Comedy Movies & Books\" | \n","| \"3005054\" | \"Entertainment - LGBTQ+ Movies & Books\" | \n","| \"3005065\" | \"Entertainment - Western Movies & Books\" | \n","| \"3005064\" | \"Entertainment - War/Military Movies & Books\" | \n","| \"3005058\" | \"Entertainment - Political Movies & Books\" | \n","| \"3005060\" | \"Entertainment - Sci-fi/Fantasy Movies & Books\" | \n","| \"3005062\" | \"Entertainment - Brand Sports Movies & Books\" | \n","| \"3005052\" | \"Entertainment - Documentary\" | \n","| \"3008574\" | \"Entertainment - Spanish & Latin Music\" | \n","| \"3008509\" | \"Entertainment - Rap & Hip Hop Music\" | \n","| \"3005066\" | \"Fashion - Kid's Apparel\" | \n","| \"3005068\" | \"Fashion - Men's Fashion\" | \n","| \"3005067\" | \"Fashion - Luxury\" | \n","| \"3005069\" | \"Fashion - Women's Fashion\" | \n","| \"3005070\" | \"Financial - Bank Account\" | \n","| \"3005071\" | \"Financial - Business Bank Account\" | \n","| \"3005072\" | \"Financial - Family Bank Account\" | \n","| \"3005073\" | \"Financial - Credit Cards\" | \n","| \"3005074\" | \"Financial - Loans & Mortgages\" | \n","| \"3005075\" | \"Financial - Personal/Family Investments\" | \n","| \"3005076\" | \"Food & Beverage - Beer\" | \n","| \"3005077\" | \"Food & Beverage - Biscuits & Cereal\" | \n","| \"3005078\" | \"Food & Beverage - Gourmet Food\" | \n","| \"3005079\" | \"Food & Beverage - Healthy Food\" | \n","| \"3007488\" | \"Food & Beverage - Meat\" | \n","| \"3005080\" | \"Food & Beverage - Ready-to-eat Meal\" | \n","| \"3005081\" | \"Food & Beverage - Salty Snacks\" | \n","| \"3005082\" | \"Food & Beverage - Soft Drinks\" | \n","| \"3005083\" | \"Food & Beverage - Spirits\" | \n","| \"3005084\" | \"Food & Beverage - Sweet Snacks\" | \n","| \"3005085\" | \"Food & Beverage - Vegetarian/Vegan\" | \n","| \"3005086\" | \"Food & Beverage - Wine\" | \n","| \"3005087\" | \"Gambling - Online Betting\" | \n","| \"3005088\" | \"Gambling - Online Gambling\" | \n","| \"3005089\" | \"Games & Toys - Children's Toys\" | \n","| \"3005090\" | \"Games & Toys - Video & Online Games\" | \n","| \"3005091\" | \"House Care - Cleaning Appliances\" | \n","| \"3005092\" | \"House Care - Home Cleaning Products\" | \n","| \"3005093\" | \"House Care - Washing Soap/Powder\" | \n","| \"3005094\" | \"Insurance - Car Insurance\" | \n","| \"3005095\" | \"Insurance - Health Insurance\" | \n","| \"3005096\" | \"Insurance - Home Insurance\" | \n","| \"3006616\" | \"Logistics & Transportation\" | \n","| \"3006617\" | \"Logistics & Transportation - Air Freight\" | \n","| \"3006618\" | \"Logistics & Transportation - Cargo Ship\" | \n","| \"3006619\" | \"Logistics & Transportation - Freight Train\" | \n","| \"3006620\" | \"Logistics & Transportation - Road Cargo\" | \n","| \"3008524\" | \"Logistics & Transportation - Stock Shortage\" | \n","| \"3005097\" | \"Personal Care - Body Care\" | \n","| \"3005099\" | \"Personal Care - Makeup\" | \n","| \"3005100\" | \"Personal Care - Men's Care\" | \n","| \"3005102\" | \"Personal Care - Women's Hairstyling\" | \n","| \"3005098\" | \"Personal Care - Hair Loss\" | \n","| \"3005101\" | \"Personal Care - Plastic Surgery\" | \n","| \"3005103\" | \"Pharma - Flu\" | \n","| \"3005105\" | \"Pharma - Hay Fever\" | \n","| \"3005106\" | \"Pharma - Headache & Migraine\" | \n","| \"3005107\" | \"Pharma - Painkillers\" | \n","| \"3005108\" | \"Pharma - Vitamins & Supplements\" | \n","| \"3005119\" | \"Retail - Supermarkets & Department Stores\" | \n","| \"3005112\" | \"Retail - Food\" | \n","| \"3005111\" | \"Retail - Fashion\" | \n","| \"3005109\" | \"Retail - Art & Entertainment\" | \n","| \"3005110\" | \"Retail - Consumer Electronics\" | \n","| \"3005115\" | \"Retail - Office Furniture\" | \n","| \"3005117\" | \"Retail - Pharmaceuticals\" | \n","| \"3005113\" | \"Retail - Home & Garden\" | \n","| \"3005118\" | \"Retail - Sports Equipment\" | \n","| \"3005114\" | \"Retail - Objects for Children\" | \n","| \"3005116\" | \"Retail - Pet Food\" | \n","| \"3005120\" | \"Society - Career Change\" | \n","| \"3005122\" | \"Society - Donors & Volunteers/Philanthropy/Medical Fund\" | \n","| \"3005121\" | \"Society - Outdoor Activities\" | \n","| \"3005123\" | \"Society - Starting a Family\" | \n","| \"3005124\" | \"Society - Sweet Sixteen\" | \n","| \"3005125\" | \"Telco - Business Connectivity\" | \n","| \"3005126\" | \"Telco - Family Voice\" | \n","| \"3005127\" | \"Telco - Mobile\" | \n","| \"3005128\" | \"Travel - Airline Tickets\" | \n","| \"3006597\" | \"Travel - Asia\" | \n","| \"3005129\" | \"Travel - Budget Travel\" | \n","| \"3005130\" | \"Travel - Casino Vacations\" | \n","| \"3006595\" | \"Travel - Central & South America\" | \n","| \"3006596\" | \"Travel - Europe\" | \n","| \"3005131\" | \"Travel - Family Holidays\" | \n","| \"3005132\" | \"Travel - Luxury Holidays\" | \n","| \"3006594\" | \"Travel - North America\" | \n","| \"3005133\" | \"Travel - Senior Travel\" | \n","| \"3005134\" | \"Travel - Traveling with Pets\" | \n","| \"3005135\" | \"Wellness/Healthy Living - Diet\" | \n","| \"3005138\" | \"Wellness/Healthy Living - Weight Loss\" | \n","| \"3005137\" | \"Wellness/Healthy Living - Healthy Living\" | \n","| \"3005136\" | \"Wellness/Healthy Living - Fitness\" |\n","| \"3009532\" | \"Automotive - Motorcycles\" |\n","| \"3010097\" | \"Consumer Electronics - Dell\" |\n","| \"3010098\" | \"Consumer Electronics - Acer\" |\n","| \"3010099\" | \"Consumer Electronics - Asus\" |\n","| \"3010096\" | \"Consumer Electronics -Lenovo\" |\n","| \"3009681\" | \"Food & Beverage - Japanese Food\" |\n","| \"3010239\" | \"Language - English\" |\n","| \"3010238\" | \"Language - Arabic\" |\n","| \"3010240\" | \"Language - Bulgarian\" |\n","| \"3010241\" | \"Language - Catalan\" |\n","| \"3010327\" | \"Language - Chinese Simplified\" |\n","| \"3010329\" | \"Language - Chinese Traditional\" |\n","| \"3010243\" | \"Language - Croatian\" |\n","| \"3010244\" | \"Language - Czech\" |\n","| \"3010245\" | \"Language - Danish\" |\n","| \"3010246\" | \"Language - Dutch\" |\n","| \"3010247\" | \"Language - Finnish\" |\n","| \"3010248\" | \"Language - French\" |\n","| \"3010249\" | \"Language - German\" |\n","| \"3010250\" | \"Language - Hungarian\" |\n","| \"3010251\" | \"Language - Hindi\" |\n","| \"3010252\" | \"Language - Indonesian\" |\n","| \"3010253\" | \"Language - Italian\" |\n","| \"3010254\" | \"Language - Japanese\" |\n","| \"3010255\" | \"Language - Korean\" |\n","| \"3010256\" | \"Language - Norwegian\" |\n","| \"3010257\" | \"Language - Polish\" |\n","| \"3010258\" | \"Language - Portuguese\" |\n","| \"3010259\" | \"Language - Romanian\" |\n","| \"3010260\" | \"Language - Russian\" |\n","| \"3010261\" | \"Language - Serbian\" |\n","| \"3010262\" | \"Language - Slovak\" |\n","| \"3010263\" | \"Language - Slovenian\" |\n","| \"3010264\" | \"Language - Spanish\" |\n","| \"3010265\" | \"Language - Swedish\" |\n","| \"3010266\" | \"Language - Thai\" |\n","| \"3010267\" | \"Language - Turkish\" |\n","| \"3010268\" | \"Language - Vietnamese\" |\n","| \"3010495\" | \"Language - Bengali\" |\n","| \"3010496\" | \"Language - Gujarati\" |\n","| \"3010497\" | \"Language - Marathi\" |\n","| \"3010498\" | \"Language - Punjabi\" |\n","| \"3010499\" | \"Language - Tamil\" |\n","| \"3010500\" | \"Language - Telugu\" |\n","| \"3010501\" | \"Language - Malayalam\" |\n","| \"3010502\" | \"Language - Kannada\" |\n","| \"3010503\" | \"Language - Urdu\" |\n","| \"3010504\" | \"Language - Estonian\" |\n","| \"3010505\" | \"Language - Greek\" |\n","| \"3010506\" | \"Language - Latvian\" |\n","| \"3010507\" | \"Language - Lithuanian\" |\n","| \"3010885\" | \"Language - Malay\" |\n","| \"3010886\" | \"Language - Persian\" |\n","| \"3010887\" | \"Language - Ukrainian\" |\n","| \"3010888\" | \"Language - Hebrew\" |\n","| \"3010889\" | \"Language - Belarusian\" |\n","| \"3012760\" | \"Language- Tagalog\" |\n","| \"3012757\" | \"Language - Filipino\" |\n","| \"3010449\" | \"Language - English - Positive and Neutral Content\" |\n","| \"3010450\" | \"Language - Arabic - Positive and Neutral Content\" |\n","| \"3010451\" | \"Language - Bulgarian - Positive and Neutral Content\" |\n","| \"3010452\" | \"Language - Catalan - Positive and Neutral Content\" |\n","| \"3010453\" | \"Language - Chinese Simplified - Positive and Neutral Content\" |\n","| \"3010454\" | \"Language - Chinese Traditional - Positive and Neutral Content\" |\n","| \"3010455\" | \"Language - Croatian - Positive and Neutral Content\" |\n","| \"3010456\" | \"Language - Czech - Positive and Neutral Content\" |\n","| \"3010457\" | \"Language - Danish - Positive and Neutral Content\" |\n","| \"3010458\" | \"Language - Dutch - Positive and Neutral Content\" |\n","| \"3010459\" | \"Language - Finnish - Positive and Neutral Content\" |\n","| \"3010460\" | \"Language - French - Positive and Neutral Content\" |\n","| \"3010461\" | \"Language - German - Positive and Neutral Content\" |\n","| \"3010462\" | \"Language - Hungarian - Positive and Neutral Content\" |\n","| \"3010463\" | \"Language - Hindi - Positive and Neutral Content\" |\n","| \"3010464\" | \"Language - Indonesian - Positive and Neutral Content\" |\n","| \"3010465\" | \"Language - Italian - Positive and Neutral Content\" |\n","| \"3010466\" | \"Language - Japanese - Positive and Neutral Content\" |\n","| \"3010467\" | \"Language - Korean - Positive and Neutral Content\" |\n","| \"3010468\" | \"Language - Norwegian - Positive and Neutral Content\" |\n","| \"3010469\" | \"Language - Polish - Positive and Neutral Content\" |\n","| \"3010470\" | \"Language - Portuguese - Positive and Neutral Content\" |\n","| \"3010471\" | \"Language - Romanian - Positive and Neutral Content\" |\n","| \"3010472\" | \"Language - Russian - Positive and Neutral Content\" |\n","| \"3010473\" | \"Language - Serbian - Positive and Neutral Content\" |\n","| \"3010474\" | \"Language - Slovak - Positive and Neutral Content\" |\n","| \"3010475\" | \"Language - Slovenian - Positive and Neutral Content\" |\n","| \"3010476\" | \"Language - Spanish - Positive and Neutral Content\" |\n","| \"3010477\" | \"Language - Swedish - Positive and Neutral Content\" |\n","| \"3010478\" | \"Language - Thai - Positive and Neutral Content\" |\n","| \"3010479\" | \"Language - Turkish - Positive and Neutral Content\" |\n","| \"3010480\" | \"Language - Vietnamese - Positive and Neutral Content\" |\n","| \"3010481\" | \"Language - Bengali - Positive and Neutral Content\" |\n","| \"3010482\" | \"Language - Gujarati - Positive and Neutral Content\" |\n","| \"3010483\" | \"Language - Marathi - Positive and Neutral Content\" |\n","| \"3010484\" | \"Language - Punjabi - Positive and Neutral Content\" |\n","| \"3010485\" | \"Language - Tamil - Positive and Neutral Content\" |\n","| \"3010486\" | \"Language - Telugu - Positive and Neutral Content\" |\n","| \"3010487\" | \"Language - Malayalam - Positive and Neutral Content\" |\n","| \"3010488\" | \"Language - Kannada - Positive and Neutral Content\" |\n","| \"3010489\" | \"Language - Urdu - Positive and Neutral Content\" |\n","| \"3010490\" | \"Language - Estonian - Positive and Neutral Content\" |\n","| \"3010491\" | \"Language - Greek - Positive and Neutral Content\" |\n","| \"3010492\" | \"Language - Latvian - Positive and Neutral Content\" |\n","| \"3010493\" | \"Language - Lithuanian - Positive and Neutral Content\" |\n","| \"3010895\" | \"Language - Malay - Positive and Neutral Content\" |\n","| \"3010896\" | \"Language - Persian - Positive and Neutral Content\" |\n","| \"3010897\" | \"Language - Ukrainian - Positive and Neutral Content\" |\n","| \"3010898\" | \"Language - Hebrew - Positive and Neutral Content\" |\n","| \"3010899\" | \"Language - Belarusian - Positive and Neutral Content\" |\n","| \"3012762\" | \"Language- Tagalog- Positive and Neutral Content \" |\n","| \"3012759\" | \"Language- Filipino - Positive and Neutral Content \" |\n","| \"3009653\" | \"Society - Retirement Planning\" |\n"],"documentType":"guide"},{"title":"IAS contextual targeting segments","sectionHeader":{"type":3,"text":"Topical"},"path":"/en-us/guides/dsp/tutorials/contextual-segments","content":["| Segment ID   | Segment name |\n","\\| ------------ \\| ------------ \\|\n","| \"3005141\" | \"Infectious Diseases & Outbreaks - Negative Sentiment\" | \n","| \"3005139\" | \"Infectious Diseases & Outbreaks - Positive Sentiment\" | \n","| \"3005140\" | \"Remote Working\" | \n","| \"3006302\" | \"Diversity Inclusion\" | \n","| \"3006362\" | \"Pollution\" | \n","| \"3006363\" | \"Pollution - Positive Sentiment\" | \n","| \"3006610\" | \"B2B\" | \n","| \"3007987\" | \"Positive Content\" | \n","| \"3008351\" | \"Luxury Goods\" | \n","| \"3008644\" | \"Construction & Engineering\" | \n","| \"3008629\" | \"Love\" | \n","| \"3008630\" | \"Love & Romance\" | \n","| \"3008791\" | \"True Crime\" |\n","| \"3009527\" | \"DIY & Home Improvement\" |\n","| \"3009821\" | \"Arts and Crafts DIY\" |\n","| \"3011902\" | \"News Homepages\" |\n","| \"3013168\" | \"News Opinion Sections\" |\n","| \"3012557\" | \"Culture & Community - Multicultural\" |\n","| \"3012519\" | \"Culture & Community - AAPI\" |\n","| \"3012514\" | \"Culture & Community - Latinx\" |\n","| \"3012493\" | \"Culture & Community - LGBTQIA+\" |\n","| \"3012679\" | \"Culture & Community - Black\" |\n","| \"3005200\" | \"WINTER - Valentine's Day\" |\n","| \"3005163\" | \"WINTER - Hanukkah\" |\n","| \"3005189\" | \"WINTER - Super Bowl\" |\n","| \"3005193\" | \"WINTER - The Grammys\" |\n","| \"3005195\" | \"WINTER - The Oscars\" |\n","| \"3005161\" | \"WINTER - Green Monday\" |\n","| \"3005150\" | \"WINTER - Consumer Electronics Show\" |\n","| \"3005157\" | \"WINTER - Fitness in the New Year\" |\n","| \"3005204\" | \"WINTER - Winter Getaway Travel\" |\n","| \"3005203\" | \"WINTER - Winter Apparel\" |\n","| \"3005205\" | \"WINTER - Winter Sports Equipment\" |\n","| \"3008526\" | \"WINTER - Lunar New Year\" |\n","| \"3008596\" | \"WINTER - Boxing Day\" |\n","| \"3008675\" | \"WINTER - FIFA Men's World Cup\" |\n","| \"3008680\" | \"WINTER - New Year's Resolutions\" |\n","| \"3005169\" | \"SPRING - Mother's Day\" |\n","| \"3005154\" | \"SPRING - Easter\" |\n","| \"3005186\" | \"SPRING - Spring Break\" |\n","| \"3005187\" | \"SPRING - Spring Fashion\" |\n","| \"3005188\" | \"SPRING - Spring Getaway\" |\n","| \"3005155\" | \"SPRING - Father's Day\" |\n","| \"3005159\" | \"SPRING - French Open\" |\n","| \"3005198\" | \"SPRING - UEFA Europa League Final\" |\n","| \"3005197\" | \"SPRING - UEFA Champions League Final\" |\n","| \"3005168\" | \"SPRING - Memorial Day\" |\n","| \"3005190\" | \"SPRING - Tax Day\" |\n","| \"3005153\" | \"SPRING - Earth Day\" |\n","| \"3005148\" | \"SPRING - Cinco de Mayo\" |\n","| \"3005158\" | \"SPRING - Free Comic Book Day\" |\n","| \"3005167\" | \"SPRING - Masters Tournament\" |\n","| \"3005173\" | \"SPRING - NBA Playoffs\" |\n","| \"3005174\" | \"SPRING - NCAA Basketball Playoffs\" |\n","| \"3005177\" | \"SPRING - NHL Playoffs\" |\n","| \"3005178\" | \"SPRING - MLB Opening Day\" |\n","| \"3005156\" | \"SUMMER - FIFA Women's World Cup\" |\n","| \"3005202\" | \"SUMMER - Wimbledon Grand Slam\" |\n","| \"3005164\" | \"SUMMER - ICC Cricket World Cup\" |\n","| \"3005194\" | \"SUMMER - The Open Championship\" |\n","| \"3005192\" | \"SUMMER - The Ashes\" |\n","| \"3005165\" | \"SUMMER - Independence Day\" |\n","| \"3005181\" | \"SUMMER - Ramadan\" |\n","| \"3005145\" | \"SUMMER - Beach Fashion/Swimwear\" |\n","| \"3005183\" | \"SUMMER - Seaside Vacations\" |\n","| \"3005182\" | \"SUMMER - Rugby World Cup\" |\n","| \"3005180\" | \"SUMMER - Premier League Opening Weekend\" |\n","| \"3005185\" | \"SUMMER - South by Southwest (SXSW)\" |\n","| \"3005170\" | \"SUMMER - Music Festivals (UK)\" |\n","| \"3005171\" | \"SUMMER - Music Festivals (US)\" |\n","| \"3005179\" | \"SUMMER - PGA Championship\" |\n","| \"3005201\" | \"SUMMER - The Vuelta a España\" |\n","| \"3005196\" | \"SUMMER - Tour de France\" |\n","| \"3005160\" | \"SUMMER - Giro d'Italia\" |\n","| \"3005172\" | \"SUMMER - Music Festivals (IT)\" |\n","| \"3006456\" | \"SUMMER - Olympics\" |\n","| \"3007631\" | \"SUMMER - UEFA European Championship\" |\n","| \"3008578\" | \"SUMMER - Australia Day\" |\n","| \"3005143\" | \"FALL - Back to School - Elementary and High School\" |\n","| \"3005144\" | \"FALL - Back to School - College and University\" |\n","| \"3005199\" | \"FALL - US Open\" |\n","| \"3005176\" | \"FALL - NFL Kickoff\" |\n","| \"3005162\" | \"FALL - Halloween\" |\n","| \"3005152\" | \"FALL - The Día de Muertos\" |\n","| \"3005191\" | \"FALL - Thanksgiving\" |\n","| \"3005149\" | \"FALL - Columbus Day\" |\n","| \"3005166\" | \"FALL - Labor Day\" |\n","| \"3005146\" | \"FALL - Black Friday\" |\n","| \"3005184\" | \"FALL - Small Business Saturday\" |\n","| \"3005151\" | \"FALL - Cyber Monday\" |\n","| \"3005147\" | \"FALL - Christmas\" |\n","| \"3005175\" | \"FALL - New York Fashion Week\" |\n","| \"3005142\" | \"FALL - Autumn Fashion\" |\n","| \"3008292\" | \"FALL - Diwali and Festive Season\" |\n","| \"3008293\" | \"FALL - Indian Wedding Season\" |\n","| \"3008366\" | \"FALL - 11.11 E-Commerce Sales\" |\n","| \"3006632\" | \"AUDIENCE PROXY - Starting a Family\" |\n","| \"3007499\" | \"AUDIENCE PROXY - Expecting Mothers\" |\n","| \"3006633\" | \"AUDIENCE PROXY - Marriage\" |\n","| \"3006634\" | \"AUDIENCE PROXY - New Career\" |\n","| \"3006635\" | \"AUDIENCE PROXY - Car Ownership\" |\n","| \"3006636\" | \"AUDIENCE PROXY - Home Ownership\" |\n","| \"3006637\" | \"AUDIENCE PROXY - Holiday Shoppers\" |\n","| \"3006638\" | \"AUDIENCE PROXY - Business Travelers\" |\n","| \"3006639\" | \"AUDIENCE PROXY - Small Business Owners\" |\n","| \"3006642\" | \"AUDIENCE PROXY - Self-Employed\" |\n","| \"3006643\" | \"AUDIENCE PROXY - Car Enthusiasts\" |\n","| \"3006644\" | \"AUDIENCE PROXY - Sports Enthusiasts\" |\n","| \"3006645\" | \"AUDIENCE PROXY - Fitness Enthusiasts\" |\n","| \"3006646\" | \"AUDIENCE PROXY - Music Enthusiasts\" |\n","| \"3006647\" | \"AUDIENCE PROXY - Tech Enthusiasts\" |\n","| \"3006819\" | \"AUDIENCE PROXY - Software and IT Professionals\" |\n","| \"3006893\" | \"AUDIENCE PROXY - Pet Owners\" |\n","| \"3007008\" | \"AUDIENCE PROXY - Sustainability & Environmentally Conscious\" |\n","| \"3007500\" | \"AUDIENCE PROXY - Gluten & Dairy Free\" |\n","| \"3007896\" | \"AUDIENCE PROXY - Smoking Cessation\" |\n","| \"3008357\" | \"AUDIENCE PROXY - Martial Arts Enthusiasts\" |\n","| \"3008475\" | \"AUDIENCE PROXY - Travel Enthusiasts\" |\n","| \"3008617\" | \"AUDIENCE PROXY - Movie & TV Enthusiasts\" |\n","| \"3009742\" | \"AUDIENCE PROXY - Social Media Enthusiasts\" |\n","| \"3013931\" | \"User Generated Content\" |\n"],"documentType":"guide"},{"title":"IAS contextual targeting segments","sectionHeader":{"type":3,"text":"Contextual avoidance "},"path":"/en-us/guides/dsp/tutorials/contextual-segments","content":["| Segment ID   | Segment name |\n","\\| ------------ \\| ------------ \\|\n","| \"1500195\" | \"Infectious Diseases & Outbreaks - Negative Sentiment\" | \n","| \"1500078\" | \"Infectious Diseases & Outbreaks\" | \n","| \"1500671\" | \"Protests & Demonstrations\" | \n","| \"1500672\" | \"Protests & Demonstrations - Negative Emotions\" | \n","| \"1500693\" | \"Cyber Security\" | \n","| \"1500691\" | \"Natural Disasters\" | \n","| \"1500690\" | \"Corporate Culture & Labor Relations\" | \n","| \"1500692\" | \"Sensitive Social Issues\" | \n","| \"1500860\" | \"Japan Emperor\" | \n","| \"1500902\" | \"Politics\" | \n","| \"1500903\" | \"Politics - Negative Content\" | \n","| \"1505819\" | \"Discrimination Avoidance\" | \n","| \"1506278\" | \"Pollution\" | \n","| \"1506279\" | \"Pollution - Negative Sentiment\" | \n","| \"1506447\" | \"Thai Monarchy\" | \n","| \"1506453\" | \"Olympics\" | \n","| \"1507473\" | \"Pop Culture\" | \n","| \"1506436\" | \"Pop Culture - Negative Content\" | \n","| \"1507358\" | \"Smoking\" | \n","| \"1507394\" | \"Animal Cruelty\" | \n","| \"1507589\" | \"Conspiracy Theories\" | \n","| \"1507610\" | \"Dating\" | \n","| \"1507653\" | \"Death, Injury or Military Conflict\" | \n","| \"1507654\" | \"Crime\" | \n","| \"1507655\" | \"Sexual Content\" | \n","| \"1507657\" | \"Arms & Ammunition\" | \n","| \"1507658\" | \"Obscenities\" | \n","| \"1507659\" | \"Online Piracy\" | \n","| \"1507660\" | \"Terrorism\" | \n","| \"1507661\" | \"Incitement of Hatred\" | \n","| \"1507663\" | \"Illegal and Recreational Drugs\" | \n","| \"1507080\" | \"JICDAQ Brand Safety Japan Specific\" | \n","| \"1508646\" | \"British Royal Family\" | \n","| \"1508815\" | \"Chinese Party Politics\" | \n","| \"1508964\" | \"Arms and Ammunition - High Risk\" | \n","| \"1508965\" | \"Arms and Ammunition - Medium Risk\" | \n","| \"1508966\" | \"Crime - High Risk\" | \n","| \"1508967\" | \"Crime - Medium Risk\" | \n","| \"1508981\" | \"Cyber Security - High Risk\" | \n","| \"1508982\" | \"Cyber Security - Medium Risk\" | \n","| \"1508968\" | \"Death, Injury or Military Conflict - High Risk\" | \n","| \"1508970\" | \"Death, Injury or Military Conflict - Medium Risk\" | \n","| \"1508979\" | \"Illegal and Recreational Drugs - High Risk\" | \n","| \"1508980\" | \"Illegal and Recreational Drugs - Medium Risk\" | \n","| \"1508975\" | \"Incitement of Hatred - High Risk\" | \n","| \"1508976\" | \"Incitement of Hatred - Medium Risk\" | \n","| \"1508977\" | \"Obscenities - High Risk\" | \n","| \"1508978\" | \"Obscenities - Medium Risk\" | \n","| \"1508973\" | \"Online Piracy - High Risk\" | \n","| \"1508974\" | \"Online Piracy - Medium Risk\" | \n","| \"1508985\" | \"Sensitive Social Issues - High Risk\" | \n","| \"1508986\" | \"Sensitive Social Issues - Medium Risk\" | \n","| \"1508962\" | \"Sexual Content - High Risk\" | \n","| \"1508963\" | \"Sexual Content - Medium Risk\" | \n","| \"1508983\" | \"Terrorism - High Risk\" | \n","| \"1508984\" | \"Terrorism - Medium Risk\" |\n","| \"1510542\" | \"British Royal Family\" |\n","| \"1509531\" | \"Anti-vaccine\" |\n","| \"1509884\" | \"Cost of Living\" |\n","| \"1509974\" | \"Arms and Ammunition - Medium Risk - Entertainment\" |\n","| \"1509975\" | \"Arms and Ammunition - Medium Risk - News\" |\n","| \"1509976\" | \"Arms and Ammunition - Medium Risk - Video Gaming\" |\n","| \"1509977\" | \"Crime - Medium Risk - Entertainment\" |\n","| \"1509978\" | \"Crime - Medium Risk - News\" |\n","| \"1509979\" | \"Crime - Medium Risk - Video Gaming\" |\n","| \"1509998\" | \"Cyber Security - Medium Risk - Entertainment\" |\n","| \"1509999\" | \"Cyber Security - Medium Risk - News\" |\n","| \"1510000\" | \"Cyber Security - Medium Risk - Video Gaming\" |\n","| \"1509980\" | \"Death, Injury or Military Conflict - Medium Risk - Entertainment\" |\n","| \"1509981\" | \"Death, Injury or Military Conflict - Medium Risk - News\" |\n","| \"1509982\" | \"Death, Injury or Military Conflict - Medium Risk - Video Gaming\" |\n","| \"1509983\" | \"Illegal and Recreational Drugs - Medium Risk - Entertainment\" |\n","| \"1509984\" | \"Illegal and Recreational Drugs - Medium Risk - News\" |\n","| \"1509985\" | \"Illegal and Recreational Drugs - Medium Risk - Video Gaming\" |\n","| \"1509986\" | \"Incitement of Hatred - Medium Risk - Entertainment\" |\n","| \"1509987\" | \"Incitement of Hatred - Medium Risk - News\" |\n","| \"1509988\" | \"Incitement of Hatred - Medium Risk - Video Gaming\" |\n","| \"1509989\" | \"Obscenities - Medium Risk - Entertainment\" |\n","| \"1509990\" | \"Obscenities - Medium Risk - News\" |\n","| \"1509991\" | \"Obscenities - Medium Risk - Video Gaming\" |\n","| \"1509992\" | \"Online Piracy - Medium Risk - Entertainment\" |\n","| \"1509993\" | \"Online Piracy - Medium Risk - News\" |\n","| \"1509994\" | \"Online Piracy - Medium Risk - Video Gaming\" |\n","| \"1509995\" | \"Sensitive Social Issues - Medium Risk - Entertainment\" |\n","| \"1509996\" | \"Sensitive Social Issues - Medium Risk - News\" |\n","| \"1509997\" | \"Sensitive Social Issues - Medium Risk - Video Gaming\" |\n","| \"1509971\" | \"Sexual Content - Medium Risk - Entertainment\" |\n","| \"1509972\" | \"Sexual Content - Medium Risk - News\" |\n","| \"1509973\" | \"Sexual Content - Medium Risk - Video Gaming\" |\n","| \"1510001\" | \"Terrorism - Medium Risk - Entertainment\" |\n","| \"1510002\" | \"Terrorism - Medium Risk - News\" |\n","| \"1510003\" | \"Terrorism - Medium Risk - Video Gaming\" |\n","| \"1510669\" | \"Misinformation\" |\n","| \"1510711\" | \"Qatar World Cup\" |\n","| \"1510878\" | \"Kids Content\" |\n","| \"1510727\" | \"Misinformation - High Risk\" |\n","| \"1510678\" | \"Misinformation - Medium Risk\" |\n","| \"1510679\" | \"Misinformation - Medium Risk - Entertainment\" |\n","| \"1510680\" | \"Misinformation - Medium Risk - News\" |\n","| \"1510681\" | \"Misinformation - Medium Risk - Video Gaming\" |\n","| \"1511375\" | \"Politics - Democratic Party \" |\n","| \"1511377\" | \"Politics - GOP\" |\n","| \"1512790\" | \"News Homepages\" |\n","| \"1512396\" | \"News Opinion Sections\" |\n","| \"1506621\" | \"Agriculture & Farming\" |\n","| \"1500079\" | \"Auto\" |\n","| \"1500080\" | \"Baby Products\" |\n","| \"1500096\" | \"Baby Products - Baby Care\" |\n","| \"1500097\" | \"Baby Products - Baby Food\" |\n","| \"1500081\" | \"Consumer Electronics\" |\n","| \"1500098\" | \"Consumer Electronics - Gaming Consoles\" |\n","| \"1500099\" | \"Consumer Electronics - Laptop, Desktop, PC\" |\n","| \"1500100\" | \"Consumer Electronics - Smartphone, Tablet\" |\n","| \"1500101\" | \"Consumer Electronics - TV, Smart TV\" |\n","| \"1500102\" | \"Consumer Electronics - Wearables\" |\n","| \"1500103\" | \"Consumer Electronics - Appliances\" |\n","| \"1507355\" | \"Education\" |\n","| \"1506280\" | \"Energy\" |\n","| \"1506282\" | \"Energy - Nuclear Energy\" |\n","| \"1506283\" | \"Energy - Green Energy\" |\n","| \"1506284\" | \"Energy - Natural Gas\" |\n","| \"1506285\" | \"Energy - Oil\" |\n","| \"1506286\" | \"Energy - Coal\" |\n","| \"1506287\" | \"Energy - Electricity\" |\n","| \"1500082\" | \"Entertainment\" |\n","| \"1500104\" | \"Entertainment - Music Events\" |\n","| \"1500105\" | \"Entertainment - Pay-per-view Services\" |\n","| \"1500106\" | \"Entertainment - Sports Events\" |\n","| \"1500107\" | \"Entertainment - Theatre Events\" |\n","| \"1500083\" | \"Fashion\" |\n","| \"1500108\" | \"Fashion - Kid's Apparel\" |\n","| \"1500111\" | \"Fashion - Luxury\" |\n","| \"1500109\" | \"Fashion - Men's Fashion\" |\n","| \"1500110\" | \"Fashion - Women's Fashion\" |\n","| \"1500084\" | \"Finance\" |\n","| \"1500113\" | \"Finance - Bank Account, Business\" |\n","| \"1500114\" | \"Finance - Bank Account, Family\" |\n","| \"1500112\" | \"Finance - Banking\" |\n","| \"1500115\" | \"Finance - Credit Cards\" |\n","| \"1510207\" | \"Finance - Cryptocurrency\" |\n","| \"1510208\" | \"Finance - Cryptocurrency - Negative Content\" |\n","| \"1500116\" | \"Finance - Loans & Mortgages\" |\n","| \"1500117\" | \"Finance - Personal/Family Investing\" |\n","| \"1500085\" | \"Food and Beverage\" |\n","| \"1500118\" | \"Food and Beverage - Beer\" |\n","| \"1500119\" | \"Food and Beverage - Biscuits, Cereals\" |\n","| \"1500120\" | \"Food and Beverage - Gourmet\" |\n","| \"1500121\" | \"Food and Beverage - Healthy Food\" |\n","| \"1500122\" | \"Food and Beverage - Ready-to-eat Meals\" |\n","| \"1500123\" | \"Food and Beverage - Salty Snacks\" |\n","| \"1500124\" | \"Food and Beverage - Soft Drinks\" |\n","| \"1500125\" | \"Food and Beverage - Spirits\" |\n","| \"1500126\" | \"Food and Beverage - Sweet Snacks\" |\n","| \"1500127\" | \"Food and Beverage - Vegan/Vegetarian\" |\n","| \"1500128\" | \"Food and Beverage - Wine\" |\n","| \"1500086\" | \"Gambling\" |\n","| \"1500129\" | \"Gambling - Online Betting\" |\n","| \"1500130\" | \"Gambling - Online Gambling\" |\n","| \"1500087\" | \"Games and Toys\" |\n","| \"1500131\" | \"Games and Toys - Children's Toys\" |\n","| \"1500132\" | \"Games and Toys - Video Games, Online Games\" |\n","| \"1500088\" | \"House Care\" |\n","| \"1500133\" | \"House Care - Cleaning Appliances\" |\n","| \"1500134\" | \"House Care - Household Cleaning Products\" |\n","| \"1500135\" | \"House Care - Washing Soap, Powder\" |\n","| \"1500089\" | \"Insurance\" |\n","| \"1500136\" | \"Insurance - Auto, Motor Insurance\" |\n","| \"1500137\" | \"Insurance - Health\" |\n","| \"1500138\" | \"Insurance - Home\" |\n","| \"1510285\" | \"Language - English\" |\n","| \"1510286\" | \"Language - Arabic\" |\n","| \"1510287\" | \"Language - Bulgarian\" |\n","| \"1510288\" | \"Language - Catalan\" |\n","| \"1510328\" | \"Language - Chinese Simplified\" |\n","| \"1510332\" | \"Language - Chinese Traditional\" |\n","| \"1510290\" | \"Language - Croatian\" |\n","| \"1510291\" | \"Language - Czech\" |\n","| \"1510284\" | \"Language - Danish\" |\n","| \"1510292\" | \"Language - Dutch\" |\n","| \"1510293\" | \"Language - Finnish\" |\n","| \"1510294\" | \"Language - French\" |\n","| \"1510295\" | \"Language - German\" |\n","| \"1510296\" | \"Language - Hungarian\" |\n","| \"1510297\" | \"Language - Hindi\" |\n","| \"1510298\" | \"Language - Indonesian\" |\n","| \"1510299\" | \"Language - Italian\" |\n","| \"1510300\" | \"Language - Japanese\" |\n","| \"1510301\" | \"Language - Korean\" |\n","| \"1510302\" | \"Language - Norwegian\" |\n","| \"1510303\" | \"Language - Polish\" |\n","| \"1510304\" | \"Language - Portuguese\" |\n","| \"1510305\" | \"Language - Romanian\" |\n","| \"1510306\" | \"Language - Russian\" |\n","| \"1510307\" | \"Language - Serbian\" |\n","| \"1510308\" | \"Language - Slovak\" |\n","| \"1510309\" | \"Language - Slovenian\" |\n","| \"1510310\" | \"Language - Spanish\" |\n","| \"1510311\" | \"Language - Swedish\" |\n","| \"1510312\" | \"Language - Thai\" |\n","| \"1510313\" | \"Language - Turkish\" |\n","| \"1510314\" | \"Language - Vietnamese\" |\n","| \"1510508\" | \"Language - Bengali\" |\n","| \"1510509\" | \"Language - Gujarati\" |\n","| \"1510510\" | \"Language - Marathi\" |\n","| \"1510511\" | \"Language - Punjabi\" |\n","| \"1510512\" | \"Language - Tamil\" |\n","| \"1510513\" | \"Language - Telugu\" |\n","| \"1510514\" | \"Language - Malayalam\" |\n","| \"1510515\" | \"Language - Kannada\" |\n","| \"1510516\" | \"Language - Urdu\" |\n","| \"1510517\" | \"Language - Estonian\" |\n","| \"1510518\" | \"Language - Greek\" |\n","| \"1510519\" | \"Language - Latvian\" |\n","| \"1510520\" | \"Language - Lithuanian\" |\n","| \"1510890\" | \"Language - Malay\" |\n","| \"1510891\" | \"Language - Persian\" |\n","| \"1510892\" | \"Language - Ukrainian\" |\n","| \"1510893\" | \"Language - Hebrew\" |\n","| \"1510894\" | \"Language - Belarusian\" |\n","| \"1512761\" | \"Language- Tagalog\" |\n","| \"1512758\" | \"Language - Filipino\" |\n","| \"1506611\" | \"Logistics & Transportation\" |\n","| \"1506612\" | \"Logistics & Transportation - Air Freight\" |\n","| \"1506613\" | \"Logistics & Transportation - Cargo Ship\" |\n","| \"1507359\" | \"Logistics & Transportation - Freight Train\" |\n","| \"1506615\" | \"Logistics & Transportation - Road Cargo\" |\n","| \"1500090\" | \"Personal Care\" |\n","| \"1500139\" | \"Personal Care - Body Care\" |\n","| \"1500140\" | \"Personal Care - Hair Loss\" |\n","| \"1500141\" | \"Personal Care - Makeup\" |\n","| \"1500142\" | \"Personal Care - Men's Care\" |\n","| \"1500143\" | \"Personal Care - Plastic Surgery\" |\n","| \"1500144\" | \"Personal Care - Women's Hair Styling\" |\n","| \"1500091\" | \"Pharma\" |\n","| \"1500092\" | \"Retail\" |\n","| \"1500151\" | \"Retail - Arts & Entertainment\" |\n","| \"1500152\" | \"Retail - Consumer Electronics\" |\n","| \"1500153\" | \"Retail - Fashion\" |\n","| \"1500154\" | \"Retail - Food\" |\n","| \"1500155\" | \"Retail - Home & Garden\" |\n","| \"1500156\" | \"Retail - Children's Toys & Objects\" |\n","| \"1500157\" | \"Retail - Office Furniture & Supplies\" |\n","| \"1500158\" | \"Retail - Pet Food\" |\n","| \"1500159\" | \"Retail - Pharmacies\" |\n","| \"1500160\" | \"Retail - Sports Equipment\" |\n","| \"1500161\" | \"Retail - Supermarkets & Department Stores\" |\n","| \"1500162\" | \"Career Change\" |\n","| \"1500166\" | \"Outdoor Activities \" |\n","| \"1500163\" | \"Philanthropy\" |\n","| \"1500164\" | \"Starting a Family\" |\n","| \"1500093\" | \"Telco\" |\n","| \"1500167\" | \"Telco - Business Connectivity\" |\n","| \"1500168\" | \"Telco - Mobile\" |\n","| \"1500094\" | \"Travel\" |\n","| \"1500169\" | \"Travel - Airline Tickets\" |\n","| \"1500170\" | \"Travel - Casino Vacations\" |\n","| \"1500171\" | \"Travel - Family Holidays\" |\n","| \"1500172\" | \"Travel - Luxury\" |\n","| \"1500173\" | \"Travel - Senior\" |\n","| \"1500174\" | \"Travel - Traveling with Pets\" |\n","| \"1500095\" | \"Wellness & Healthy Living\" |\n","| \"1500176\" | \"Wellness & Healthy Living - Diet\" |\n","| \"1500178\" | \"Wellness & Healthy Living - Fitness\" |\n","| \"1500175\" | \"Wellness & Healthy Living - Weight Loss\" |\n","| \"1513949\" | \"Made for Advertising Sites\" |\n","| \"1513948\" | \"Made for Advertising Sites and Sites with Ad Clutter\" |\n","| \"1513741\" | \"Brand Safety Vietnam Specific\" |\n","| \"1515904\" | \"Misinformation - Politics\" |\n","| \"1513584\" | \"User Generated Content\" |\n"],"documentType":"guide"},{"title":"IAS contextual targeting segments","sectionHeader":{"type":2,"text":"Example"},"path":"/en-us/guides/dsp/tutorials/contextual-segments","content":[" To use IAS contextual segment targeting, specify the relevant segment IDs in the target object of the line item while creating or updating the line item.\n"," The three available categories are vertical targeting segments, topical targeting segments, and contextual avoidance segments. See part of an example request below that makes use of all three categories.\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":null,"path":"/en-us/guides/dsp/creative-management","content":[],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/dsp/creative-management","content":[" The new Amazon DSP Ad Creative Management APIs enable advertisers to programmatically manage Amazon DSP ad creatives (supporting Display, Video, Audio, Third Party, and Component Formats). Use cases include:\n","Creating and updating ad creatives: Create new Ad Creatives by specifying properties such as assets and products which can be used to serve on Amazon DSP ad groups.\n","Viewing ad creative moderation results: View the moderation results for your ad creatives to receive actionable feedback on Amazon DSP ad creative policy guidelines. \n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Ad creative object hierarchy"},"path":"/en-us/guides/dsp/creative-management","content":[" These APIs streamline the process of creating, validating, and managing creatives in Amazon DSP. They involve two fundamental objects:\n","Ad Creative: This is the parent-level object that holds all information about a creative, such as metadata, assets, and information about the product being promoted. It is the base from which all creatives are generated and managed.\n","Ad Experience: Ad Experiences represent the rendered view of a creative given the elements provided by the adCreative object. It allows developers to visualize the ad in its final form, further enabling them to adjust and optimize their creative. Each Ad Experience represents a specific rendering of the Ad Creative. Ad creatives require at least one associated Ad Experience to serve on an Amazon DSP ad group. \n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Create an ad creative"},"path":"/en-us/guides/dsp/creative-management","content":[" The following steps guide you through creating an Ad Creative, associating it to an Ad Experience, and reviewing any Amazon DSP moderation policy responses. \n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Step 1: Generate an Ad Creative"},"path":"/en-us/guides/dsp/creative-management","content":[" In this step, you will use an asset (previously uploaded to the Amazon Ads Asset Library), a click through, and an impression tracker to create a new Ad Creative object. In the response, you will receive an Ad Creative ID that references the object you created.\n"," The response from the API will be:\n","| Country code | Languages |\n","\\| -- \\| -- \\| \n","| US | English, Spanish | \n","|CA| English, French |\n","|NL| Dutch, English, French |\n","|DE| German, English, Czech, Polish, Turkish, French, Italian, Spanish |\n","|ES| Spanish, Portuguese, French, English, German, Italian |\n","|AE| English, Arabic |\n","|SA| Arabic, English |\n","|JP| Japanese, English, Chinese |\n","|FR| French, English, German, Italian, Spanish |\n","|IT| Italian, English, French, German, Spanish |\n","|UK| English, French, German, Italian, Spanish |\n","|IN| English, Hindi, Tamil, Telugu, Kannada, Marathi, Malayalam, Bengali, Gujarati, Punjabi |\n","|AU| English |\n","|MX| Spanish, English |\n","|BR| Portuguese, English |\n","|SE| Swedish, English, Norwegian, Finnish, Danish.  |\n","|TR | Turkish |\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Step 2:  Associate an Ad Experience"},"path":"/en-us/guides/dsp/creative-management","content":[" Use the adCreativeId acquired in Step 1 to call the updateAdExperience API. You must associate an Ad Experience with your Ad Creative before adding it to an ad group. \n"," The API will return a 204 no content response if the request was successful. Each Ad Experience you associate to the Ad Creative will have its own set of requirements on the Ad Creative model. The Ad Experiences API is an all or nothing operation: this means that if any of the requested Ad Experiences are invalid for the specified Ad Creative, none of the requested Ad Experiences will be added to the Ad Creative. Error responses include validation messages for each of the requested Ad Experiences. \n"," The list of Ad Experiences available to be associated to your Ad Creative will depend on the adCreativeFormatType selected in Step 1. For a DISPLAY Ad Creative, only display Ad Experiences can be added. The table below details the current mapping:\n","|Ad Creative Format Type\t| Ad Experiences\t                             |\n","|---\t|---------------------------------------------|\n","|DISPLAY\t| STANDARD_DISPLAY\t                         |\n","|VIDEO\t| ONLINE_VIDEO, STREAMING_TV_VIDEO\t       |\n","|COMPONENT\t| RESPONSIVE_ECOMMERCE\t                     |\n","|AUDIO\t| AUDIO\t                                    |\n","|THIRD_PARTY\t| THIRD_PARTY_VIDEO, THIRD_PARTY_DISPLAY\t |\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Step 3: View Ad Creative moderation "},"path":"/en-us/guides/dsp/creative-management","content":[" Once an Ad Creative has been associated to a line item, Amazon DSP will begin screening content moderation policies against the Ad Creative. Moderation decisions enforce Amazon DSP and associated publisher policies to ensure the Ad Creative content meets the criteria of the supply it is targeted to serve. \n"," The Ad Creative API Moderation endpoint vends granular moderation statuses for each of the selected Ad Experiences. This means it is possible for one Ad Experience to be approved and start serving while another is rejected. Additionally, moderations statuses for a given Ad Experience may differ for each line item it is associated to (in this case the response from this API will be APPROVED_WITH_EXCEPTIONS). To see the status and reason for each (Ad Group, Ad Creative) pair, please use the association moderation API.\n"," The GET response will look something like:\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Step 4: View Ad Creative moderation results at the component level"},"path":"/en-us/guides/dsp/creative-management","content":[" Amazon DSP moderates certain ad creatives at the component level. That means, along with moderating the overall ad creatives, individual components, such as images, are also being moderated, so that you can figure out which components are causing your creative rejection and fix the issue. This component level moderation is only enabled for standard display and asset based creatives. \n"," The response will look something like:\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"A note on legacy creatives"},"path":"/en-us/guides/dsp/creative-management","content":[" Creatives created without using the new Ad Creative APIs (which may include creatives created with legacy types in the Amazon DSP ads console) are not supported by default in this new API. You will not be able to read, update or create legacy creative IDs or legacy creative types using this API. \n"," We have released support for updating and reading a subset of legacy creative types. These types will not support the association or removal of Ad Experiences, and it is not possible to associate a legacy creative type to a new Ad Creative created via this API. The following table is a map of adCreativeFormatType to legacy creative types supported by this API. \n","|Ad Creative Format Type\t| Legacy Ad Experiences\t                          |\n","|---\t|-------------------------------------------------|\n","|DISPLAY\t| IMAGE, IMAGE_MOBILE_OO, IMAGE_MOBILE_AAP\t |\n","|VIDEO\t| LEGACY_VIDEO\t                                 |\n","|COMPONENT\t| LEGACY_RESPONSIVE_ECOMMERCE\t                  |\n","|AUDIO\t| AUDIO\t                                          |\n","|THIRD_PARTY\t| LEGACY_THIRD_PARTY_VIDEO\t                     |\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Additional APIs"},"path":"/en-us/guides/dsp/creative-management","content":[],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Updating existing ad creatives"},"path":"/en-us/guides/dsp/creative-management","content":[" Any updates to an Ad Creative will apply to all Ad Experiences associated with that Ad Creative. As a result, when updating an Ad Creative, the updates must be valid for all associated Ad Experiences. Otherwise, the request will fail, and you will be given errors detailing why it failed.\n"," Notes: \n","For list fields, the full list must be provided. Partial updates within a list are not currently supported. \\* If updating adCreativeFormatProperties, the adCreativeFormatType field must be provided as well. The adCreativeFormatType field is immutable, and so the input must match what is already listed on the creative.\n"," Example PATCH /dsp/v1/adCreatives/{adCreativeId} for responsive eCommerce:\n"," The response will be a 204 no content if successful. \n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Listing ad creatives"},"path":"/en-us/guides/dsp/creative-management","content":[" You can query for your Ad Creatives based on the provided Amazon DSP Advertiser/Account ID within the header. We also support additional filtering of these responses based on a provided list of Ad Creative IDs. This API will return all properties provided by the POST and PATCH Ad Creative APIs.\n"," All include fields within the API request are optional. If none are provided, the API returns a paginated list (with a page size of 50) of the Ad Creatives associated with the Account ID in the request header. If there are more Ad Creatives to return than can fit on a single page, a nextToken string will be returned in the response that can be provided on a subsequent API request to fetch the next page. \n"," An example response:\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Previewing ad creatives"},"path":"/en-us/guides/dsp/creative-management","content":[" The Preview API enables you to view a sample impression response for a selected experience of your Ad Creative. You can further specify previewOverrides which allows you to preview different variations of a given Ad Experience. For example, you can select which ASIN to preview for a RESPONSIVE_ECOMMERCE creative. The preview API will return an HTML string that can be rendered in your browser. \n"," The API supports both previewing using an existing adCreativeId and previewing by providing an Ad Creative model, just like the input in step 1: generate an ad creative. For an existing Ad Creative, it is possible to preview an Ad Experience not associated to that Ad Creative, as long as that experience has the same adCreativeFormatType as the selected Ad Creative. \n"," Responsive eCommerce POST /dsp/v1/adCreatives/preview sample payload:\n"," Sample response:\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Pre-validating ad experiences"},"path":"/en-us/guides/dsp/creative-management","content":[" Sometimes, while building a new Ad Creative, you might want to know which Ad Experiences your current Ad Creative can associate to without actually completing the task of associating it to any Ad Experience. For example, imagine you are building a UI that displays a list of Ad Experiences, but which greys out Ad Experiences the Ad Creative cannot be associated with. In that case, you need to use the creative validation API. This API will take an existing adCreativeId and return the list of Ad Experiences that can be associated to its adCreativeFormatType. For each experience, there will be a boolean flag indicating if the experience is valid, and if the experience is not valid, you will see a list of reasons why.\n"," Sample response:\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Viewing associated ad experiences"},"path":"/en-us/guides/dsp/creative-management","content":[" Since Ad Experiences are modeled as a separate resource from Ad Creatives, we do not return the list of associated Ad Experiences in the listAdCreatives API. However, we do offer the GET Ad Experiences API. This API takes an adCreativeId as input and returns the list of associated ad experiences within the response.\n"," Sample response:\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Specific ad experience examples"},"path":"/en-us/guides/dsp/creative-management","content":[],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Videos"},"path":"/en-us/guides/dsp/creative-management","content":[" This request creates a VIDEO adCreative and sets trackingUrls items to both preselected ad experiences and to all adExperiences.\n"," This request associates an ONLINE_VIDEO ad experience to the video ad creative above:\n"," This request creates a VIDEO adCreative and sets trackingUrls items to both preselected ad experiences and to all adExperiences.\n"," This request associates a STREAMING_TV_VIDEO adExperience to the newly created video ad creative:\n"," Prior to creating an online video ad creative, you must first upload and register a video asset in the asset library. To be a valid asset for online video, the video must meet the following criteria:\n","The video must have an assetStatus of ACTIVE. A video becomes active once it finishes transcoding. Any creative you try to save while the status is PROCESSING will throw a validation error.  \\* The video must pass the DEMAND_SIDE_PLATFORM_OLV specification profile in the asset library.\n","Online video creatives do not currently support CLICK trackers.  Online video creatives only support URL click actions.  Online video creatives should have a hostedType of AMAZON_HOSTED\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Standard Display"},"path":"/en-us/guides/dsp/creative-management","content":[" This request associates a STANDARD_DISPLAY ad experience to the newly created Display ad creative.\n"," Prior to creating a Standard Display adCreative, you must first upload and register an asset in the asset library. To be a valid standard display ad creative asset, the asset must meet the following criteria:\n","AdCreative image assets must be of type PNG, JPG, JPEG, or GIF.\n","Required fields for standard display eligible adCreatives are name, assets, and clickActions of clickActionType URL.  An adCreative cannot have more than 10 assets.  For the assets being added, the creativeSizes field must include the applicable width and height combinations. \\* The country field may optionally be omitted. For users with an Advertiser Account (beta), the creative may then be associated with line items spanning multiple marketplaces. However, please note that each marketplace must support the language of the creative. Please refer to supported languages in each ad marketplace for supported languages.\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Responsive eCommerce"},"path":"/en-us/guides/dsp/creative-management","content":[" This request associates a RESPONSIVE_ECOMMERCE ad experience to the newly created Component ad creative.\n"," Preview by model example request:\n"," Prior to creating a responsive eCommerce ad creative, you must first upload and register an asset in the asset library. To be a valid responsive eCommerce ad creative asset, the asset must meet the following criteria:\n","AdCreative image assets must be of type PNG, JPG, or JPEG.\n","Required fields for Responsive eCommerce are name, products, language, country, hostedType  View our API reference to see the limits on each individual field  When calling preview, ensure you include a sizeFilter, productFilter and retailFormatFilter\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Third party video"},"path":"/en-us/guides/dsp/creative-management","content":[" This request creates a THIRD_PARTY ad creative format and sets trackingUrls items to both preselected ad experiences and to all adExperiences.\n"," This request associates a THIRD_PARTY_VIDEO ad experience to the newly created third party ad creative:\n"," To create a third party video ad creative, you must provide a valid VAST or VPAID tag.  View our video requirements for more details. \n","Third party video creatives do not currently support CLICK trackers.  Third party video creatives only support a single VAST or VPAID tag.  Third party video creatives support Nielsen DAR tags as an impression tracking url. \n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Third party display"},"path":"/en-us/guides/dsp/creative-management","content":[" This request associates a STANDARD_DISPLAY ad experience to the newly created Display ad creative:\n"," The tag provided to create the Third Party Display ad-experience will be processed, and some macros will be replaced for the approved third-party ad servers. If the ad server is not supported in the list, you can still create the ad experience, but no replacements will be done for that particular tag source.\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":null,"path":"/en-us/reference/migration-guides/dsp-creatives","content":[],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":[" The DSP creative management APIs enable self-serve advertisers and their partners to programmatically manage their Amazon DSP AdCreatives, AdCreative-AdGroup associations and moderations. These new APIs replace the previous creative management APIs.\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"New API Highlights"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":["The API provides a single, unified structure (the adCreative) that can host multiple variations (the adExperiences). This simplifies management and enhances the creative process by allowing users to experiment with and optimize multiple renderings or versions of a creative without having to create a new adCreative object each time.  These APIs use the Amazon Ads API Common Model which provides a standardized model and field names for each entity across ad products.  These APIs are available in all marketplaces where ADSP operates:  The API supports PATCH operations (partial updates) so you can update individual field without sending all the fields.   The list endpoint can support up to 100 objects read at a time.   createCreativeAssociation, patchCreativeAssociation and deleteCreativeAssociation support a batch size of 20.   The new eligibleCreatives API can list the basic ad creative objects eligible to associate with given ad group. \\* The new AdCreative association API can update the association object state (ACTIVE, INACTIVE). \n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Endpoint Equivalencies"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":[],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"AdCreative entity"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":["|Old Endpoint\t|New Endpoint\t|Notes\t|\n","|---\t        |---\t        |---\t|\n","|GET /dsp/creatives/\t|POST /dsp/adCreatives/list\t|Read operation will be handled by one LIST endpoint  which returns a list of creative objects based on the supplied filters.\t| \n","|GET /dsp/creatives/image\t| POST /dsp/adCreatives/list | |\n","|GET /dsp/creatives/video\t| POST /dsp/adCreatives/list | | \n","|GET /dsp/creatives/rec\t| POST /dsp/adCreatives/list | | \n","|GET /dsp/creatives/thirdparty\t| POST /dsp/adCreatives/list | |\n","|POST /dsp/creatives/image\t| POST /dsp/v1/adCreatives\t|One single endpoint will be used to create the adCreative object.\t|\n","|POST /dsp/creatives/video\t| POST /dsp/v1/adCreatives | |\n","|POST /dsp/creatives/rec\t| POST /dsp/v1/adCreatives | |\n","|POST /dsp/creatives/thirdparty\t| POST /dsp/v1/adCreatives | |\n","|PUT /dsp/creatives/image\t|PATCH /dsp/v1/adCreatives/{adCreativeId}\t|One single endpoint will be used to update the adCreative object.\t|\n","|PUT /dsp/creatives/video\t|PATCH /dsp/v1/adCreatives/{adCreativeId} | | \n","|PUT /dsp/creatives/rec\t|PATCH /dsp/v1/adCreatives/{adCreativeId} | |\n","|PUT /dsp/creatives/thirdparty\t|PATCH /dsp/v1/adCreatives/{adCreativeId} | |\n","|\t|GET /dsp/v1/adExperiences\t|New endpoint to get Ad Experiences associated to a creative\t|  \n","|\t|PUT /dsp/v1/adExperiences\t|New endpoint to update Ad Experiences associated to a creative\t| \n","|\t|GET /dsp/adCreatives/{adCreativeId}/validation\t|New endpoint to get validation for all Ad Experiences within the adCreative. \t|\n","|POST /dsp/creatives/image/preview\t|POST /dsp/v1/adCreatives/preview\t|One single endpoint to preview the adCreative.\t|\n","|POST /dsp/creatives/video/preview\t|POST /dsp/v1/adCreatives/preview| |\n","|POST /dsp/creatives/rec/preview\t|POST /dsp/v1/adCreatives/preview| |\n","|POST /dsp/creatives/thirdparty/preview\t|POST /dsp/v1/adCreatives/preview | | \n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"AdCreative-AdGroup assocation"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":["|Old Endpoint\t|New Endpoint\t|\n","|---\t        |---\t        | \n","|POST /dsp/lineItemCreativeAssociations\t|POST /dsp/v1/adCreatives/associations/adGroups\t|\n","|POST /dsp/lineItemCreativeAssociations |POST /dsp/v1/adCreatives/associations/adGroups/delete\t|\n","|PUT /dsp/lineItemCreativeAssociations\t|PATCH /dsp/v1/adCreatives/associations/adGroups\t|\n","|GET /dsp/lineItemCreativeAssociations\t|POST /dsp/v1/adCreatives/associations/adGroups/list\t|\n","|\t|POST /dsp/v1/adCreatives/associations/adGroups/eligibleCreatives/list\t|\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":3,"text":"Moderation"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":["|Old Endpoint\t|New Endpoint\t|\n","|---\t        |---\t        | \n","| GET /dsp/moderation/creatives\t|GET /dsp/v1/adCreatives/{adCreativeId}/moderation\t|\n","|\t| POST /dsp/v1/adCreatives/associations/adGroups/moderations/list\t|\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Entity naming"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":[" In the new endpoints, creatives have been renamed to adCreative. AdExperience, which represents the rendered view of a creative, is introduced as part of the adCreative object.\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Authorization"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":[" These endpoints require an Advertiser header (Amazon-Ads-AccountId). This is your Amazon DSP advertiser ID, which can be retrieved from the advertiser endpoint. \n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Update operations"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":[" The previous creative and association endpoints used the PUT operation for updates which required a full replacement of all fields. The new endpoints utilize PATCH (partial updates) which means you can send only the fields you wish to update and any fields not included in the request will remain unchanged. \n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Read operations"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":[],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Error model"},"path":"/en-us/reference/migration-guides/dsp-creatives","content":[" The error model has been improved. Key changes include:\n","Removed fieldName, errorDetails, and top level message.  Renamed errorType to errorCode.  Renamed message to errorMessage.  New fields:  Added requestId to response for successful calls. This should be included when submitting support tickets so that our support team can find the request in our logs. \\* If success or error array is empty, the array will be omitted from the response.\n"],"documentType":"guide"},{"title":"Amazon DSP creative management","sectionHeader":{"type":2,"text":"Creative creation "},"path":"/en-us/reference/migration-guides/dsp-creatives","content":[" This example is a sample request to create legacy Video template:\n"," This example is a sample request to create a VIDEO adCreative and set trackingUrls to a selected adExperience.\n"," This example is a sample request to associate the STREAMING_TV_VIDEO adExperience the above video Ad Creative.\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":null,"path":"/en-us/guides/dsp/creative-associations","content":[" The Amazon DSP Creative Association Management API is a set of API endpoints that allow developers to programmatically manage their Amazon DSP creative association data.\n"," Use cases include:\n","Viewing association eligibility of ad creatives  Associating ad creatives with ad groups  Updating configurations of ad creative associations  Deleting ad creative associations  Viewing the moderation results of ad creative association\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":2,"text":"Amazon DSP API Ad Creative Association Object Hierarchy"},"path":"/en-us/guides/dsp/creative-associations","content":[],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":2,"text":"Ad Creative Association Creation Workflow"},"path":"/en-us/guides/dsp/creative-associations","content":[" The following steps guide you through reviewing the association eligibility of an ad creative and creating an ad creative association.\n","To create an ad group, review our getting started with Amazon DSP campaign management guide. \\* To create an ad creative, please review the developer guidance of the ad creative creation API.\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":3,"text":"Step 1: Reviewing the association eligibility of ad creatives"},"path":"/en-us/guides/dsp/creative-associations","content":[" In this step, you will use a list of ad group IDs and get a list of ad creatives which are eligible to associate with some given ad groups.\n"," Only the adGroupIdFilter field is required. You can add additional filters:  ad creative ID  ad creative name  ad creative format type (it also supports legacy creative template name in this filter). The concept of format type can be found in the Ad Creative API Developer Guidance.  ad creative moderation status\n"," Each filter except adCreativeModerationStatusFilter supports up to 20 items. Fuzzy search is supported in adCreativeNameFilter and adCreativeFormatTypeFilter.\n"," Some ad creatives may not be eligible with all the ad groups provided in the request. The eligibleAdGroupIds field shows you which ad group IDs are eligible for each ad creative to associate with. \n"," To request more data fields of the ad creative, you can enable includeExtendedDataFields.\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":3,"text":"Step 2: Create an association between an ad creative and an ad group"},"path":"/en-us/guides/dsp/creative-associations","content":[" In this step, you will use the adGroupId and adCreativeId received in the step one to create an association between them.\n"," This is a batch endpoint which can support up to 20 associations at a time.\n"," You can find all successful associations in the success list and all unsuccessful associations in the error list.\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":2,"text":"Ad Creative Association Management Workflow"},"path":"/en-us/guides/dsp/creative-associations","content":[" The following steps guide you through:\n","Reviewing the moderation results of ad creative associations  Updating an ad creative association configuration  Deleting an ad creative association\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":3,"text":"Step 1: Review the moderation result of an ad creative association"},"path":"/en-us/guides/dsp/creative-associations","content":[" In this step, you will use adGroupId and adCreativeId to fetch the moderation results of associations. Moderation results contain feedback from our Amazon DSP policy guidelines. You can then respond by updating or deleting the association.\n"," You can provide an adGroupIdFilter, an adCreativeIdFilter, or both. If you provide both, this endpoint will return only the association in which BOTH the adGroupId AND the adCreativeId are present. Each filter supports up to 20 items.\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":3,"text":"Step 2: Update an ad creative association"},"path":"/en-us/guides/dsp/creative-associations","content":[" Update the configuration of an existing association. \n"," This is a batch endpoint that can support up to 20 associations at a time.\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":3,"text":"Step 3: Delete an ad creative association"},"path":"/en-us/guides/dsp/creative-associations","content":[" Delete an existing ad creative association.\n"," This is a batch endpoint that can support up to 20 associations at a time.\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":2,"text":"Retrieve all of your ad creative associations"},"path":"/en-us/guides/dsp/creative-associations","content":[" Retrieve all creative associations for a given advertiser. You can filter by adCreativeId and adGroupId. Each filter supports up to 20 items.\n"," To request more data fields of the ad creative, you can enable includeExtendedDataFields.\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":2,"text":"Default behavior"},"path":"/en-us/guides/dsp/creative-associations","content":[" The Amazon DSP API sets values for certain fields automatically if no value is provided in the request.\n","|Workflow\t|API where you can list and update the default values\t|Field\t|API Default value\t|\n","|---\t|---\t|---\t|---\t|\n","|Create an ad creative association\t|/dsp/v1/adCreatives/associations/adGroups/eligibleCreatives/list\t|maxResult\t|100\t|\n","|Create an ad creative association\t|/dsp/v1/adCreatives/associations/adGroups\t|state\t|ACTIVE\t|\n","|Manage the ad creative association\t|/dsp/v1/adCreatives/associations/adGroups/moderations/list\t|maxResult\t|100\t|\n","|Review ad creative association\t|dsp/v1/adCreatives/associations/adGroups/list\t|maxResult\t|100\t|\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":2,"text":"API Rule"},"path":"/en-us/guides/dsp/creative-associations","content":[" This section lists key validation rules in each API.\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":3,"text":"Rules of `createCreativeAssociationsV1` API"},"path":"/en-us/guides/dsp/creative-associations","content":["| Field\t        | Optional\t | Rule\t                                                                                   |\n","\\|---------------\\|-----------\\|-----------------------------------------------------------------------------------------\\|\n","| adGroupId\t    | No\t       | Ad group must exist.\t                                                                   |\n","| adCreativeId\t | No\t       | Ad creative must exist.\t                                                                |\n","| weight\t       | Yes\t      | Cannot be set if rotationType in adGroup is random. Accepted value is 1, 999\t       |\n","| state\t        | Yes\t      | Accepted values are ACTIVE or INACTIVE\t                                                 |\n","| startDate\t    | Yes\t      | It needs to be later than the startDate of the ad group and earlier than the endDate of the association.\t |\n","| endDate\t      | Yes\t      | It needs to be earlier than the endDate of the ad group and later than the startDate of the association.\t |\n"," Ad creative types and ad group types need to be compatible. Compatibility rules are as follows:\n","|AdGroup Type\t| AdCreative Type\t                                                                                                                                                                   |\n","|---\t|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n","|Standard Display\t| Responsive eCommerce, Image, Third party, Standard Display\t                                                                                                                        |\n","|Amazon Mobile Display\t| Responsive eCommerce, Image - mobile O&O, Standard Display\t                                                                                                                        |\n","|AAP Mobile App\t| Responsive eCommerce, Image - mobile AAP, Third party - mobile AAP, Fire Tablet - Amazon Video Ads\t                                                                                |\n","|Display\t| Responsive eCommerce, Image, Image - mobile AAP, Image - mobile O&O, Third party, Third party - mobile AAP, Fire Tablet - Amazon Video Ads, Image - Fire Tablet, Standard Display\t |\n","|Video\t| Legacy Video, Streaming TV, Online Video, Third party - video, Video Creative Builder\t                                                                                             |\n","|Streaming TV\t| Streaming TV\t                                                                                                                                                                      |\n","|Online Video\t| Online Video\t                                                                                                                                                                      |\n","|Audio\t| Audio, Audio - Interactive audio ads\t                                                                                                                                             |\n","|Podcast\t| Audio - Podcast\t                                                                                                                                                                   |\n"," There are specific rules per ad experience. Ad group with amazon mobile web targeting requires the associated creative to have 2x resolution asset. Standard Display ad experience without 2x resolution image cannot be associated with Amazon Mobile Display ad group. It will result in 0 impressions when associating with a Display ad group which only has amazon mobile web targeting. \n"," If the ad group targets Twitch supply (Twitch video mobile app, Twitch video mobile web, APS video), the Audio creative must have a video asset, and the duration must be within 12s - 15s, or 27s - 30s.\n"," It requires the ad group to target connected devices. If you are using a deal, the deal needs to include connected devices. For example Audio - audience guaranteed - interactive creative deal type. If the ad group targets only Amazon Music Free inventory or Third Party inventory, it requires at least one of the following publishers not in the block list:  IHeartRadio App  Federated Alexa  Salem  Prisa  Estrella  Chavez  Entravision  Beasley\n"," If Audio - Interactive audio ads creative has Remind Me chosen as the call to action, it needs to meet the following rules:  For absolute time reminder type, the reminder date must occur after the endDate of the ad group.  For weekly recurring time reminder type, there must be at least 1 reminder date occurring after the endDate of the ad group.\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":3,"text":"Rules of `patchCreativeAssociationsV1` API"},"path":"/en-us/guides/dsp/creative-associations","content":["| Field\t        | Optional\t | Rule\t                                                                                   |\n","\\|---------------\\|-----------\\|-----------------------------------------------------------------------------------------\\|\n","| adGroupId\t    | No\t       | One association between the given ad group and creative must exist.                          |\n","| adCreativeId\t | No\t       | One association between the given ad group and creative must exist.                             |\n","| weight\t       | Yes\t      | Cannot be set if rotationType in adGroup is random. Accepted value is 1, 999\t       |\n","| state\t        | Yes\t      | Accepted values are ACTIVE or INACTIVE\t                                                 |\n","| startDate\t    | Yes\t      | It needs to be later than the startDate of the ad group and earlier than the endDate of the association.\t |\n","| endDate\t      | Yes\t      | It needs to be earlier than the endDate of the ad group and later than the startDate of the association.\t |\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":3,"text":"Rules of `deleteCreativeAssociationsV1` API"},"path":"/en-us/guides/dsp/creative-associations","content":["| Field\t        | Optional\t | Rule\t                                                           |\n","\\|---------------\\|-----------\\|-----------------------------------------------------------------\\|\n","| adGroupId\t    | No\t       | One association between the given ad group and creative must exist. |\n","| adCreativeId\t | No\t       | One association between the given ad group and creative must exist.  |\n"],"documentType":"guide"},{"title":"Amazon DSP creative associations","sectionHeader":{"type":3,"text":"Rules of `listEligibleCreativesV1` API"},"path":"/en-us/guides/dsp/creative-associations","content":["| Field\t        | Optional\t | Rule\t                                                                                   |\n","\\|---------------\\|-----------\\|-----------------------------------------------------------------------------------------\\|\n","| adGroupId\t    | No\t       | Ad group must exist.     | \n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":null,"path":"/en-us/guides/dsp/tactics","content":[],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/dsp/tactics","content":[" The Brand+ and Performance+ tactics of Amazon DSP are AI-powered advertising solutions that leverage Amazon first-party  data to optimize campaign performance. These solutions serve both endemic advertisers (selling on-Amazon) and non-endemic advertisers (selling off-Amazon) by automating ad group creation and optimization levers.\n"," Performance+ tactics drive immediate conversions through customer acquisition, remarketing, retention, consideration and search strategies, while Brand+ tactics identify and engage future customers via a prospecting tactic.\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":2,"text":"Understanding tactics"},"path":"/en-us/guides/dsp/tactics","content":[" Tactics are machine learning-optimized ad groups that deliver enhanced performance through specialized targeting strategies. Amazon DSP offers three primary tactical approaches: Awareness, Consideration, and Conversions.\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":3,"text":"Designed to drive awareness and influence potential customers"},"path":"/en-us/guides/dsp/tactics","content":["Prospecting tactic: Reach consumers who are highly likely to show interest and engage with your brand or product\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":3,"text":"Designed specifically to drive consideration outcomes"},"path":"/en-us/guides/dsp/tactics","content":["Unified Consideration tactic: Reach shoppers similar to those who previously viewed a product detail page\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":3,"text":"Designed specifically to drive conversion outcomes"},"path":"/en-us/guides/dsp/tactics","content":["Customer acquisition tactic: Reach shoppers who are similar to past purchasers  Remarketing tactic: Reach shoppers who have viewed a product detail page, searched for your product or visited your homepage   Retention tactic: Reach shoppers who have purchased your product \\* Search tactic: Reach shoppers who have made searches relevant to your products\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":2,"text":"Key benefits of using tactics"},"path":"/en-us/guides/dsp/tactics","content":["Automated campaign setup and optimization  AI-powered audience targeting  Pre-configured ML predictive technology aligned with goal objectives  Transparent performance monitoring  Control over brand safety, geography, and inventory selection \\* Integration with Amazon first-party signals for better targeting\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":2,"text":"Tactics workflow"},"path":"/en-us/guides/dsp/tactics","content":[" The following steps guide you through creating a live campaign and tactics from start to finish. Amazon DSP tactics are available through two API surfaces: the DSP V1 API (/dsp/v1/) and Ads API v1 (/adsApi/v1/). Ads API v1 is the latest API version, improving developer experience. Improvements have been made to simplify the P+ setup experience in Ads API v1, making quickActions and guidance APIs optional.\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":3,"text":"Step 1: Campaign creation: Configure tactic-eligible campaign settings"},"path":"/en-us/guides/dsp/tactics","content":[" In this step, you define your campaign name, primary inventory types, goals, flight dates & budgets, frequency caps, and (optionally) budget caps, agency fee, PO number, and comments. Before proceeding, review the eligibility criteria outlined in the Create a campaign with Brand+ or Performance+ to ensure your campaign meets the necessary requirements.\n"," Example: Create a tactic eligible campaign\n"," Expected response:\n"," The response includes eligibleAutomatedTargetingTactics and ineligibleAutomatedTargetingTactics based on your campaign configuration. This information provides you insight on what tactics can be chosen with your selection options. Criteria reasons behind eligibility can be found here.\n"," Example: Create a tactic eligible campaign\n"," For the campaign to be tactic eligible, the campaign should have appropriate primaryInventoryTypes selected.  \n","It serves as an indication of the primary intended media types of the advertiser  Amazon DSP uses it to recommend appropriate tactics  It does not limit or restrict the actual types of ad groups that can be created within the campaign  Advertisers can still manually create ad groups with different inventory  You can revisit later if you forget to populate this, by setting it in an update call.\n"," Choose appropriate goal kpi in the campaign, to request relevant tactics. \n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":3,"text":"Step 2.a: [Endemic Campaigns] Enable conversion tracking on the campaign"},"path":"/en-us/guides/dsp/tactics","content":[" When selecting products for your campaign, you must designate at least one ASIN as \"featured.\" These featured ASIN values are essential as their performance data powers the ML algorithms that drive targeting. This enables Amazon DSP to deliver optimized targeting for your tactics. For Brand+, prospecting works for endemic campaigns. For Performance+, unified consideration, remarketing, customer acquisition, retention and search work for endemic campaigns.\n"," Example: Associate products (ASINs) to a campaign\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":3,"text":"Step 2.b: [Non-Endemic Campaigns] Enable off-Amazon conversions on the campaign"},"path":"/en-us/guides/dsp/tactics","content":[" For non-endemic advertisers, tactics have specific conversion event requirements:\n","Customer Acquisition requires a designated optimized conversion event.  Remarketing requires a Page View conversion event (optimization selection not required).  Retention requires an Off-Amazon Purchase or Sign Up conversion event (optimization selection not required).\n"," Please refer to the Conversions API documentation to learn more about how to set up conversion events for your application. For Brand+, prospecting works for non-endemic campaigns. For Performance+, customer acquisition, remarketing, and retention work for non-endemic campaigns.\n"," Example: Associate off-Amazon conversions to a campaign\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":3,"text":"Step 3: Tactic creation"},"path":"/en-us/guides/dsp/tactics","content":[" The Ads API v1 lets you create tactic ad groups directly by specifying the automatedTargetingTactic field in targetingSettings. This eliminates the need for separate recommendation and quick action API calls. Using the older DSP V1 APIs does not show this information, requiring two additional API steps with Guidance and Quick Actions API. The guidance and quick actions APIs are optional in this workflow.\n"," Example: Create a tactic ad group\n"," Supported tactic types:\n","REMARKETING — Reach shoppers who have viewed a product detail page, searched for your product or visited your homepage  CUSTOMER_ACQUISITION — Reach shoppers who are similar to past purchasers  RETENTION — Reach shoppers who have purchased your product  PROSPECTING — Reach consumers who are highly likely to show interest and engage with your brand  SEARCH — Reach shoppers who have made searches relevant to your products \\* MAXIMIZE_PERFORMANCE — Optimize for best overall performance\n"," Tactic eligibility validation: to create a tactic ad group for an ineligible campaign or with an incompatible configuration, you receive a validation error in the response:\n"," The DSP V1 API uses a two-part flow: first retrieve recommended tactics via the Guidance API, then create them via the Quick Actions API.\n"," Step 3a: Retrieve available tactics\n"," Based on both on- and off-Amazon conversion events, and goal outcomes, call the DSP Guidance APIs to retrieve Amazon-recommended ad groups. The List Campaign Guidance API responds with a list of recommendations and action IDs. Action IDs are used to create recommended tactics.\n"," Example: Retrieve all available tactics for a campaign\n"," Record the actionIds from the response. These actionIds are required for creating tactics in subsequent steps. The recommendations are based on your campaign settings and eligibility criteria.\n"," Step 3b: Create tactics via Quick Actions\n"," Using the actionIds obtained above, create tactic ad groups via the DSP Quick Actions APIs.\n"," Example: Start execution of multiple quick actions\n"," For details on polling execution status, refer to the DSP Quick Actions APIs guide.\n"," The tactics have the following properties set under an ad group: \n","inventoryType: Based on the primaryInventoryTypes selected at campaign level. This value determines what inventory to display creatives on. - automatedTargetingTactic: The targeting strategy for the ad group. - tacticsConvertersExclusionType: The exclusion criteria applied to audiences based on purchases. Customer acquisition, remarketing, unified consideration and search tactics exclude past converters by default. The exclusion lookback periods vary by tactic and conversion type. To learn more, refer to audience exclusions by tactic type.\n"," For example, running a Remarketing - Display recommendation creates a tactic with: \n","name: Remarketing - Display  automatedTargetingTactic: REMARKETING  tacticsConvertersExclusionType: RECENT_PURCHASERS\n"," If you wish to edit the tacticsConvertersExclusionType, you can use the PATCH update ad group API to reset it as per your own custom requirements.\n"," You can view and modify all ad groups (tactic and non-tactic) via the campaign management ad group APIs.\n"," Using the Ads API v1:\n"," Using the DSP V1 API:\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":3,"text":"Step 4: (optional) Edit tactic settings  "},"path":"/en-us/guides/dsp/tactics","content":[" While advertisers can manage targeting settings (locations, audiences, etc.) including creating, modifying, and removing different types of targets, there are certain guardrails to note for tactics:\n","Include at least one third-party inventory source for Online Video or Display  Options include Amazon Publisher Direct, 3P Exchanges, or non-guaranteed deals  Use the Inventory Source Discovery API to find available inventory sources\n","Users cannot add any contextual targeting like \"keywords\", \"product categories\" for tactics\n","Can add audience suppression lists for first-party advertiser audiences \\* Cannot suppress In-Market or Lifestyle audience segments\n"," Example: Add excluded audience targets to an ad group\n"," Using the Ads API v1:\n"," Using the DSP V1 API:\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":3,"text":"Step 5: Creative association: Link appropriate creative assets"},"path":"/en-us/guides/dsp/tactics","content":[" You can use the Amazon DSP creative association endpoints to associate creatives to tactics.\n"," Using the Ads API v1:\n"," Using the DSP V1 API:\n"],"documentType":"guide"},{"title":"Performance+ and Brand+ Tactics: Amazon DSP Guide","sectionHeader":{"type":3,"text":"Step 6: Activate campaign & tactics"},"path":"/en-us/guides/dsp/tactics","content":[" The final step in launching a campaign is to activate both the campaign and ad group(s). Note that activation cannot be done during campaign or ad group creation.\n"," Using the Ads API v1:\n"," Activate using the UPDATE operation with state set to ENABLED.\n"," Example: Activate a campaign\n"," Example: Activate an ad group\n"," Using the DSP V1 API:\n"," Activate using the PATCH operation with state set to ACTIVE.\n"," Example: Activate a campaign\n"," Example: Activate an ad group\n"],"documentType":"guide"},{"title":"Data Provider API","sectionHeader":null,"path":"/en-us/guides/dsp/data-provider","content":[" Use the Data Provider API to create audiences using either your own customer records or customer records from external data providers. Populate your audiences with IDs corresponding to records in the following formats:\n","COOKIE - IDs corresponding to cookies sent to Amazon from data providers.  MAID - mobile advertising identifiers.  EXTERNAL_USER_ID - external IDs created either by data providers or by you while uploading hashed customer data.\n"," After creating a data provider audience, you can use it like any other Amazon DSP audience. \n"],"documentType":"guide"},{"title":"Data Provider API","sectionHeader":{"type":2,"text":"Upload hashed first-party customer data"},"path":"/en-us/guides/dsp/data-provider","content":[" To create an audience from your own records, first upload hashed personally-identifiable information (PII) records using POST /dp/records/hashed.\n"," The POST /dp/records/hashed endpoint attempts to match your hashed records with internal Amazon customer records. For privacy reasons, you will not be able to see which matches were successful.\n"],"documentType":"guide"},{"title":"Data Provider API","sectionHeader":{"type":3,"text":"Hash your data"},"path":"/en-us/guides/dsp/data-provider","content":[" Before uploading, you may need to hash your data. To do so, first organize your data according to our formatting guidelines. Download our template to create correctly organized tables that have some or all of the headers below:\n","Email: email  Phone: phone  First name: first_name  Last name: last_name  Street address: address  City: city  State / Province: state \\* Postal code: zip\n"," Your table must have between 10,000 and 5,000,000 rows. Finally, use our hashing tool to hash your data.\n"," Alternatively, if you intend to use your own SHA-256 hashing tool, make sure that you follow our formatting guidelines to avoid errors in the uploading process.\n"],"documentType":"guide"},{"title":"Data Provider API","sectionHeader":{"type":3,"text":"Upload your hashed data to a record"},"path":"/en-us/guides/dsp/data-provider","content":[" Now that your data is hashed, you can upload it to create a record.\n"," Each record requires you to provide an externalId of your choice. Later, you use this ID to associate the record to a data provider audience. \n"],"documentType":"guide"},{"title":"Data Provider API","sectionHeader":{"type":2,"text":"Create a new data provider audience"},"path":"/en-us/guides/dsp/data-provider","content":[" Use POST v2/dp/audiencemetadata/:\n"," This audience will not have any customers in it until you explicitly associate a record.\n"," Make sure to specify the correct data source country for each of your audiences. Otherwise, your uploaded data may receive lower internal match rates.\n"],"documentType":"guide"},{"title":"Data Provider API","sectionHeader":{"type":2,"text":"Associate or disassociate your records with your data provider audience"},"path":"/en-us/guides/dsp/data-provider","content":[" Provide a list of customer records to be associated with the audience as an array of identifiers. Only the matched customer records will be associated with the audience.\n"," The value field corresponds to the audienceId returned to you in the v2/dp/audiencemetadata/ response. \n"," To disassociate records from your audience, use the same endpoint but with op changed from add to remove.\n"],"documentType":"guide"},{"title":"Data Provider API","sectionHeader":{"type":2,"text":"(optional) Remove your user data"},"path":"/en-us/guides/dsp/data-provider","content":[" To completely remove user data that you provided, use PATCH /v2/dp/users:\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":null,"path":"/en-us/guides/dsp/deals","content":[" The Amazon Ads deals API allows you to manage third party (3P) advertising deals that you have negotiated and executed in Amazon DSP (ADSP) so you can use those deals to place ads through the Amazon DSP platform. The ADSP deals API currently does not provide functionality to negotiate or execute a deal. The ADSP platform uses the exchangeID and the externalDealID to identify the deal during ad placement. The deals API also generates an internal dealId that must be used to manage the deals within ADSP.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/dsp/deals","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your client ID and access token. You need these to make all the calls referenced in this tutorial.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":2,"text":"Creating and using 3P deal objects"},"path":"/en-us/guides/dsp/deals","content":[" There are three high-level steps in creating and using a deals object in ADSP using the Amazon Ads API:\n","Retrieve the profile ID of the profile you want to create the deal object for. A profile ID in the Amazon Ads API corresponds to accounts in the Amazon Ads console. 2. Create and manage a deal object. 3. Associate the deal object with an ad group.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":2,"text":"Retrieve a profile ID"},"path":"/en-us/guides/dsp/deals","content":[" Profiles in the Amazon Ads API represent an advertiser account in a specific marketplace.  A profile ID is required for requests to the deals API. The list of profile IDs can be retrieved using GET /v2/profiles. Once you identify the profile you want to use, you provide the profileId value as the Amazon-Advertising-API-Scope header in subsequent calls to the deals API.\n"," The following call retrieves a list of all accounts in the region associated with the user account that provided the access token:\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":2,"text":"Create and manage 3P deals in ADSP"},"path":"/en-us/guides/dsp/deals","content":[],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":3,"text":"Discover the exchanges that Amazon DSP supports for deals"},"path":"/en-us/guides/dsp/deals","content":[" ADSP supports a list of exchanges for deals. Before creating an object, you can use POST /dsp/inventory/deals/exchanges/list to get the list of all supported exchanges. Exchanges in the response include an exchange ID, which is required to create a deal object.\n"," The following call returns all supported exchanges:\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":3,"text":"Create a new 3P deal"},"path":"/en-us/guides/dsp/deals","content":[" The exchangeId, externalDealId, and terms of the deal must be provided to create a deal object. The terms of the deal are used during the ad bidding process. A 3P deal can be created in ADSP using POST /dsp/inventory/deals. Once created, the deal can be used to target negotiated supply on a line item. \n"," The following API call creates a deal with the attributes specified in the data section:\n","priceMillis: Floor price for private auction deal and Fixed CPM for preferred deal - priceType: FLOOR_RATE for private auction deals and FIXED_CPM for preferred deals - dealType: PRIVATE_AUCTION or PREFERRED or PROGRAMMATIC_GUARANTEED\n","Users cannot create 3P deals on Supply Side Platforms (SSPs) integrated for automated ingestion of deals: Amazon media, Amazon Publisher Services, Google Ads Manager (AdX), Magnite DV+ (Rubicon Project), Xandr (Appnexus). Deals will be automatically ingested into the ADSP account of the customer.  externalDealId is the deal ID provided by the publisher or 3P SSP. Amazon DSP generates an internal dealId returned in the success message that must be used to refer to the deal object moving forward (for example, for updating the created 3P deal).  Amazon Audience Guaranteed deal types cannot be created via API and are on a path to deprecation stretching to 2025. These deals can however be discovered using the list deals operation described below.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":3,"text":"List existing deals"},"path":"/en-us/guides/dsp/deals","content":[" You can retrieve a list of deals for the specified profileId in an ADSP account using POST /dsp/inventory/deals/list. You can use the filters described in the specification to narrow down the list. \n"," The following API call retrieves all the deals in scope:\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":3,"text":"Update deals"},"path":"/en-us/guides/dsp/deals","content":[" After a deal is created, it can be updated using PUT /dsp/inventory/deals/{dealId}. \n"," The following API call updates the priceMillis attribute of the deal created in the create new 3P deal section with 22400 \n","dealType cannot change from PROGRAMMATIC_GUARANTEED to anything else. However, dealType can change between PRIVATE_AUCTION and PREFERRED.  externalDealId and exchangeId cannot be updated after a deal has been created.  startDateTime cannot be updated once it has become current or past.\n"," No body is returned for the response.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":2,"text":"Assign recommended advertisers"},"path":"/en-us/guides/dsp/deals","content":[" You can use PUT /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertisers to update recommended advertiser permissions by adding advertisers to or removing advertisers from the advertiser permission list for a given deal.\n","POST /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertiser/list provides the list of advertiserIds currently set as recommended for a given deal. \\* DELETE /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertisers deletes the entire list of advertiserIds currently set as recommended on a given deal.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":2,"text":"Associate the deal object with an ad line item"},"path":"/en-us/guides/dsp/deals","content":[" When a deal object is created in ADSP, it is not used until it is associated with an advertisement line item. Please see ADSP developer guide for additional details on ADSP advertisement object hierarchy. Associating a deal with a line item involves two steps:\n","Identify a deal to associate. 2. Associate the deal with the line item.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":3,"text":"Identify a deal to associate"},"path":"/en-us/guides/dsp/deals","content":[" You can call POST /dsp/inventorySourceDeals/list to retrieve a list of deals matching the submitted filters and sorted per the chosen criteria. The API response also includes metadata associated to each deal targeted by an ad group. \n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":3,"text":"Associate the deal with the line item"},"path":"/en-us/guides/dsp/deals","content":[" You can use PATCH /dsp/v1/adGroups to update a line item with the programmatically guaranteed deal you identified in the previous step. You can also create a new line item with POST /dsp/v1/adGroups.\n"," For preferred and private auction deals, use /dsp/v1/targets to associate with campaigns.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":3,"text":"Get list of line items targeting a given deal"},"path":"/en-us/guides/dsp/deals","content":[" You can use GET /dsp/inventory/deals/{dealId}/lineItems to retrieve all line items targeting a given deal. In order to receive bid responses, deals must be actively targeted by a line item as a supply source.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":3,"text":"Retrieve performance data on a deal"},"path":"/en-us/guides/dsp/deals","content":[" The POST /dsp/inventory/deals/performance/list endpoint enables you to retrieve campaign performance and supply-side metrics for selected deals, either submitted as a query input, or matching the submitted filters.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP deals API","sectionHeader":{"type":3,"text":"Retrieve inferred attributes on a deal"},"path":"/en-us/guides/dsp/deals","content":[" You can use GET /dsp/inventory/deals/{dealId}/inferredAttributes to retrieve inferred directional attributes for a specific deal. Attributes are deemed inferred when they are the result of observing the bid requests for each deal. Inferred attributes differ from declarative attributes, which are set once by publishers and customers when registering a deal. Because inferred attributes are the result of observation, they may change over time.\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Introduction, Business Value and Strategic Overview","sectionHeader":null,"path":"/en-us/guides/dsp/forecasting/introduction_business_value_strategic_overview","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Introduction, Business Value and Strategic Overview","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/guides/dsp/forecasting/introduction_business_value_strategic_overview","content":[" The Amazon DSP (ADSP) Forecasting API represents a strategic opportunity to enhance campaign planning and optimization capabilities through advanced predictive analytics. This API provides campaign-level performance, delivery, and spend forecasts that can significantly improve advertising ROI and strategic decision-making.\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Introduction, Business Value and Strategic Overview","sectionHeader":{"type":3,"text":"Key Strategic Benefits"},"path":"/en-us/guides/dsp/forecasting/introduction_business_value_strategic_overview","content":["Predictive Campaign Planning: Access to sophisticated forecasting models that predict campaign performance before budget allocation - Risk Mitigation: Delivery confidence indicators help identify potential underperformance before campaigns launch - Budget Optimization: Spend forecasting enables more accurate budget allocation and prevents over/under-spending - Competitive Advantage: Advanced forecasting capabilities differentiate your platform in the market - Data-Driven Decisions: Replace guesswork with statistical forecasts for campaign metrics\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Introduction, Business Value and Strategic Overview","sectionHeader":{"type":3,"text":"ROI Impact"},"path":"/en-us/guides/dsp/forecasting/introduction_business_value_strategic_overview","content":[" Integration with the ADSP Forecasting API can deliver measurable business value: - Improvement in campaign performance through better planning - Reduced campaign waste by identifying delivery issues before launch - Enhanced client satisfaction through more accurate performance predictions - Increased platform stickiness via advanced forecasting features\n","\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Introduction, Business Value and Strategic Overview","sectionHeader":{"type":2,"text":"Business Value & Strategic Overview"},"path":"/en-us/guides/dsp/forecasting/introduction_business_value_strategic_overview","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Introduction, Business Value and Strategic Overview","sectionHeader":{"type":3,"text":"Market Positioning"},"path":"/en-us/guides/dsp/forecasting/introduction_business_value_strategic_overview","content":[" The ADSP Forecasting API enables your platform to offer enterprise-grade campaign forecasting capabilities typically available only to large advertising agencies. This positions your solution as a sophisticated, data-driven platform that can compete with industry leaders.\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Introduction, Business Value and Strategic Overview","sectionHeader":{"type":3,"text":"Competitive Advantages"},"path":"/en-us/guides/dsp/forecasting/introduction_business_value_strategic_overview","content":["Advanced Forecasting Models: Leverage the Amazon machine learning algorithms trained on massive datasets 2. Multi-Metric Predictions: Forecast across multiple KPIs simultaneously (CPC, CPA, ROAS, reach, etc.) 3. Confidence Indicators: Provide clients with delivery confidence levels for risk assessment 4. Replanning Recommendations: Automated suggestions for campaign optimization\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Introduction, Business Value and Strategic Overview","sectionHeader":{"type":3,"text":"Use Cases & Applications"},"path":"/en-us/guides/dsp/forecasting/introduction_business_value_strategic_overview","content":["Pre-launch performance predictions for budget approval processes - Scenario modeling for different budget allocations - Timeline optimization based on delivery forecasts\n","Real-time spend forecasting to prevent budget overruns - Automated alerts for campaigns at risk of under-delivery - Dynamic budget reallocation recommendations\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting API Overview and Capabilities","sectionHeader":null,"path":"/en-us/guides/dsp/forecasting/api_overview_capabilities","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting API Overview and Capabilities","sectionHeader":{"type":2,"text":"API Overview & Capabilities"},"path":"/en-us/guides/dsp/forecasting/api_overview_capabilities","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting API Overview and Capabilities","sectionHeader":{"type":3,"text":"What is the ADSP Forecasting API?"},"path":"/en-us/guides/dsp/forecasting/api_overview_capabilities","content":[" The Amazon DSP Forecasting API provides campaign-level performance, delivery, and spend forecasts. It offers the same forecasting capabilities available through the Amazon DSP forecasting widgets, but accessible programmatically for integration into your own platforms and workflows.\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting API Overview and Capabilities","sectionHeader":{"type":3,"text":"Core Capabilities"},"path":"/en-us/guides/dsp/forecasting/api_overview_capabilities","content":["Performance Predictions: Forecast key metrics like CPC, CPA, ROAS before campaign launch - Delivery Forecasting: Predict campaign delivery confidence and potential issues - Spend Forecasting: Estimate budget utilization and pacing throughout campaign flight\n","Support for up to 5 flights per campaign forecast - Individual flight performance predictions - Cross-flight optimization recommendations\n","Daily: Day-by-day performance predictions - Weekly: Week-over-week aggregated forecasts - Monthly: Monthly performance summaries - Lifetime: Total campaign performance predictions\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting API Overview and Capabilities","sectionHeader":{"type":3,"text":"Available Endpoints"},"path":"/en-us/guides/dsp/forecasting/api_overview_capabilities","content":[" Purpose: Retrieve campaign forecasts by campaign ID Method: POST (retrieve by ID for better performance than query operations) Rate Limits: Subject to standard Amazon Ads API rate limiting\n"," Key Features: - Batch processing (up to 1 campaign per request in current version) - Flexible metric selection (all metrics or specific subset) - Optional curve data for advanced visualizations - Replanning recommendations when enabled\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting API Overview and Capabilities","sectionHeader":{"type":3,"text":"Supported Forecast Metrics"},"path":"/en-us/guides/dsp/forecasting/api_overview_capabilities","content":["| Metric Code | Full Name | Description | Business Value |\n","\\|-------------\\|-----------\\|-------------\\|----------------\\|\n","| DC | Delivery Confidence | Probability of full campaign delivery | Risk assessment |\n","| TAS | Total Available Spend | Maximum spendable budget | Budget planning |\n","| AIMP | Available Impressions | Total impressions available | Reach planning |\n","| AREA | Available Reach | Unique users reachable | Audience planning |\n","| EIMP | Expected Impressions | Predicted impression delivery | Performance forecasting |\n","| EREA | Expected Reach | Predicted unique reach | Audience forecasting |\n","| CPC | Cost Per Click | Predicted cost per click | Efficiency planning |\n","| CPA | Cost Per Action | Predicted cost per conversion | ROI planning |\n","| CPM | Cost Per Mille | Predicted cost per thousand impressions | Media planning |\n","| ROAS | Return on Ad Spend | Predicted return on investment | Profitability forecasting |\n","| CAS | Capped Available Spend | Budget-constrained available spend | Budget optimization |\n","| IREA | Incremental Reach | Additional unique users reached | Incremental planning |\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting API Overview and Capabilities","sectionHeader":{"type":3,"text":"Advanced Features"},"path":"/en-us/guides/dsp/forecasting/api_overview_capabilities","content":["Bid/Spend vs. Performance curves for optimization - Multiple periodicity options for different planning horizons - Focus points highlighting optimal performance ranges\n","Automated suggestions for campaign optimization - Scenario-based recommendations with performance predictions - Alternative flight configurations for improved delivery\n","HIGH: Strong confidence in delivery predictions - MEDIUM: Moderate confidence with some uncertainty - LOW: Limited confidence, higher risk scenarios - UNAVAILABLE: Insufficient data for confidence assessment\n","Explains key factors driving campaign delivery - Explains why a forecast may be unavailable due to settings - Covers major delivery constraints (bid, targeting, frequency capping, etc.)\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting API Overview and Capabilities","sectionHeader":{"type":3,"text":"Data Freshness & Accuracy"},"path":"/en-us/guides/dsp/forecasting/api_overview_capabilities","content":["Forecasts are generated using real-time market data - Models are continuously updated with latest performance trends - Accuracy varies by market conditions and campaign parameters - Historical performance data improves forecast precision\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Request and Response Examples","sectionHeader":null,"path":"/en-us/guides/dsp/forecasting/request_and_response_examples","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Request and Response Examples","sectionHeader":{"type":2,"text":"Request & Response Examples"},"path":"/en-us/guides/dsp/forecasting/request_and_response_examples","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Request and Response Examples","sectionHeader":{"type":3,"text":"Basic Campaign Forecast Request"},"path":"/en-us/guides/dsp/forecasting/request_and_response_examples","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Request and Response Examples","sectionHeader":{"type":3,"text":"Advanced Request with Specific Metrics"},"path":"/en-us/guides/dsp/forecasting/request_and_response_examples","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Request and Response Examples","sectionHeader":{"type":3,"text":"Successful Response Example"},"path":"/en-us/guides/dsp/forecasting/request_and_response_examples","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Request and Response Examples","sectionHeader":{"type":3,"text":"Response with Replanning Recommendations"},"path":"/en-us/guides/dsp/forecasting/request_and_response_examples","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Request and Response Examples","sectionHeader":{"type":3,"text":"Multiple Flight Request Example"},"path":"/en-us/guides/dsp/forecasting/request_and_response_examples","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Request and Response Examples","sectionHeader":{"type":3,"text":"Response Data Interpretation"},"path":"/en-us/guides/dsp/forecasting/request_and_response_examples","content":["low: Conservative estimate (lower bound) - high: Optimistic estimate (upper bound)   - mean: Expected value (most likely outcome)\n","HIGH: 80-95% confidence in delivery - MEDIUM: 60-79% confidence in delivery - LOW: 40-59% confidence in delivery - UNAVAILABLE: Insufficient data for assessment\n","X-axis: Typically spend or bid values - Y-axis: Performance metrics at different spend levels - Focus Points: Optimal performance ranges identified by the algorithm\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Metrics and Data Structures","sectionHeader":null,"path":"/en-us/guides/dsp/forecasting/metrics_and_data_structures","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Metrics and Data Structures","sectionHeader":{"type":2,"text":"Metrics & Data Structures"},"path":"/en-us/guides/dsp/forecasting/metrics_and_data_structures","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Metrics and Data Structures","sectionHeader":{"type":3,"text":"Forecast Metrics Detailed Reference"},"path":"/en-us/guides/dsp/forecasting/metrics_and_data_structures","content":["Description: Predicted average cost for each click on your ads - Business Value: Budget planning and bid optimization - Interpretation: Lower values indicate more efficient click acquisition - Use Cases: Bid strategy optimization, budget allocation, competitive analysis\n","Description: Predicted cost for each conversion or desired action - Business Value: ROI planning and performance forecasting - Interpretation: Should be compared against customer lifetime value - Use Cases: Campaign profitability assessment, budget justification\n","Description: Predicted cost per thousand ad impressions - Business Value: Brand awareness campaign planning - Interpretation: Lower CPM allows broader reach for same budget - Use Cases: Reach optimization, brand awareness campaigns\n","Description: Predicted revenue return for every dollar spent - Business Value: Profitability forecasting and campaign justification - Interpretation: Values >1.0 indicate profitable campaigns - Use Cases: Budget allocation, campaign prioritization, ROI reporting\n","Description: Probability that campaign will fully deliver planned budget/impressions - Business Value: Risk assessment and campaign planning - Range: 0.0 - 1.0 (often expressed as percentage) - Interpretation: - Use Cases: Campaign risk assessment, budget planning, client communication\n","Description: Total number of ad impressions available for your targeting - Business Value: Market size assessment and reach planning - Interpretation: Higher values indicate larger addressable audience - Use Cases: Market opportunity assessment, targeting refinement\n","Description: Predicted number of impressions your campaign will deliver - Business Value: Reach forecasting and delivery planning - Relationship: Should be ≤ AIMP (Available Impressions) - Use Cases: Reach planning, frequency capping, delivery forecasting\n","Description: Total number of unique users reachable with your targeting - Business Value: Audience size assessment - Interpretation: Represents maximum unique audience size - Use Cases: Audience planning, targeting optimization\n","Description: Predicted number of unique users your campaign will reach - Business Value: Unique audience forecasting - Relationship: Should be ≤ AREA (Available Reach) - Use Cases: Brand awareness planning, audience development\n","Description: Additional unique users reached beyond existing campaigns - Business Value: Incremental audience growth assessment - Interpretation: Measures non-overlapping audience expansion - Use Cases: Campaign portfolio optimization, audience expansion\n","Description: Maximum amount that could be spent given market conditions - Business Value: Budget opportunity assessment - Interpretation: Indicates market capacity for your targeting - Use Cases: Budget planning, market opportunity sizing\n","Description: Available spend limited by your budget constraints - Business Value: Realistic spend forecasting within budget limits - Relationship: CAS ≤ TAS (always constrained by budget) - Use Cases: Budget utilization forecasting, pacing optimization\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Metrics and Data Structures","sectionHeader":{"type":3,"text":"Data Structure Specifications"},"path":"/en-us/guides/dsp/forecasting/metrics_and_data_structures","content":[" Interpretation Guidelines: - low: 10th percentile outcome (conservative planning) - mean: 50th percentile outcome (expected result) - high: 90th percentile outcome (optimistic scenario) - Range Width: high minus low indicates forecast uncertainty\n"," Confidence Interpretations: - HIGH: 80-95% probability of full delivery - MEDIUM: 60-79% probability of full delivery - LOW: 40-59% probability of full delivery - UNAVAILABLE: Insufficient data for assessment\n"," Periodicity Use Cases: - DAILY: Day-by-day pacing and optimization - WEEKLY: Weekly performance planning - MONTHLY: Monthly budget and performance planning - LIFETIME: Total campaign performance forecasting\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Metrics and Data Structures","sectionHeader":{"type":3,"text":"Curve Data Interpretation"},"path":"/en-us/guides/dsp/forecasting/metrics_and_data_structures","content":[" X-Axis Labels: - SPEND: Monetary spend amount - BID: Bid amount for auctions - TAS: Total available spend at this point - CAS: Capped available spend at this point\n"," Y-Axis Labels: - DC: Delivery confidence at this spend level - AIMP/EIMP: Impression forecasts at this spend level - AREA/EREA: Reach forecasts at this spend level - CPC/CPA/CPM: Cost metrics at this spend level - ROAS: Return on ad spend at this spend level\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting Reference Codes","sectionHeader":null,"path":"/en-us/guides/dsp/forecasting/reference_codes","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Reference Codes","sectionHeader":{"type":2,"text":"Reference Codes"},"path":"/en-us/guides/dsp/forecasting/reference_codes","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Reference Codes","sectionHeader":{"type":3,"text":"Python Implementation"},"path":"/en-us/guides/dsp/forecasting/reference_codes","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting Reference Codes","sectionHeader":{"type":3,"text":"Forecast Curve Data Visualization "},"path":"/en-us/guides/dsp/forecasting/reference_codes","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting FAQs","sectionHeader":null,"path":"/en-us/guides/dsp/forecasting/faq","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting FAQs","sectionHeader":{"type":2,"text":"Frequently Asked Questions (FAQ)"},"path":"/en-us/guides/dsp/forecasting/faq","content":[],"documentType":"guide"},{"title":"Amazon DSP Forecasting FAQs","sectionHeader":{"type":3,"text":"Q1: How do I forecast for different targeting settings without creating multiple campaigns?"},"path":"/en-us/guides/dsp/forecasting/faq","content":[" Answer: This is one of the most common use cases for the ADSP Forecasting API. You can test different targeting scenarios using a single campaign by following this workflow:\n","Create a test campaign using the Amazon DSP Campaign Management API 2. Create a line item with your base targeting settings 3. Note the campaign and flight IDs for forecasting\n","Update targeting settings using the Campaign Management API\n","Request forecast using the updated campaign configuration\n","Analyze results and compare performance predictions 4. Repeat with different targeting configurations\n","Cost-effective: No need to create multiple campaigns - Consistent comparison: Same campaign structure across scenarios - Rapid iteration: Quick testing of different targeting strategies - Resource efficient: Minimal API calls and campaign management overhead\n","\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting FAQs","sectionHeader":{"type":3,"text":"Q2: What is the difference between `allMetrics: true` and selecting specific metrics?"},"path":"/en-us/guides/dsp/forecasting/faq","content":[" Answer: \n"," All Metrics (allMetrics: true): - Returns all available forecast metrics for the campaign - Includes performance, delivery, and reach metrics - Larger response payload but comprehensive data - Best for: Initial analysis, comprehensive reporting, data exploration\n"," Selected Metrics (allMetrics: false + selectedMetrics array): - Returns only specified metrics - Smaller, faster responses - Reduced data transfer and processing time - Best for: Focused analysis, production applications, performance optimization\n"," Example:\n","\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting FAQs","sectionHeader":{"type":3,"text":"Q3: How accurate are the forecasts and what factors affect accuracy?"},"path":"/en-us/guides/dsp/forecasting/faq","content":[" Answer: \n"," Accuracy Factors: - Historical data availability: More campaign history = better accuracy - Market stability: Volatile periods may reduce forecast precision - Targeting specificity: Very narrow targeting may have limited data - Seasonality: Holiday periods and events can impact predictions - Campaign complexity: Simple campaigns typically forecast more accurately\n"," Accuracy Guidelines: - High confidence (DC > 0.8): Typically 85-95% accurate for delivery - Medium confidence (DC 0.6-0.8): Typically 70-85% accurate - Low confidence (DC < 0.6): Use with caution, consider alternative strategies\n"," Best Practices for Accuracy: - Use forecasts for relative comparisons between scenarios - Combine with historical performance data - Update forecasts regularly as market conditions change - Consider confidence levels when making decisions\n","\n"],"documentType":"guide"},{"title":"Amazon DSP Forecasting FAQs","sectionHeader":{"type":3,"text":"Q4: Can I forecast for campaigns that have not been created yet?"},"path":"/en-us/guides/dsp/forecasting/faq","content":[" Answer: No, the ADSP Forecasting API requires existing campaign and flight IDs. However, you can use a \"template campaign\" approach:\n","Create template campaigns for different campaign types (brand awareness, conversion, retargeting) 2. Configure with typical settings for each campaign type 3. Use for forecasting by updating settings as needed 4. Apply insights to new campaign creation\n"],"documentType":"guide"},{"title":"Bid adjustments overview","sectionHeader":null,"path":"/en-us/guides/dsp/bid-adjustments/overview","content":[" Bid adjustments, previously known as bid modifiers, let you adjust bids up or down for a specific criteria at bidding time for a single line item.\n"," Besides selecting a bid strategy, you can maintain nuanced and customized bidding with bid adjustments within a single line item. Bid adjustments are applied at line item level and work in tandem with Amazon DSP automated optimization.\n"," Amazon DSP generates bids based on the predicted value of the impressions, how the campaign is performing against its Target KPI, and how it is pacing against its flight budget. Bid adjustments adjust one of these components of Amazon DSP bid generation - the predicted value of the impressions, not the final bids.\n"],"documentType":"guide"},{"title":"Get started with the bid adjustments API","sectionHeader":null,"path":"/en-us/guides/dsp/bid-adjustments/getting-started","content":[],"documentType":"guide"},{"title":"Get started with the bid adjustments API","sectionHeader":{"type":2,"text":"Amazon Ads API onboarding"},"path":"/en-us/guides/dsp/bid-adjustments/getting-started","content":[" To use the bid adjustments API, advertisers will first need to onboard the Amazon Ads API. See steps to onboard the Amazon Ads API. If you have any general questions about onboarding to or using Amazon Ads API, you may reach out for support via the API Support team.\n"],"documentType":"guide"},{"title":"Get started with the bid adjustments API","sectionHeader":{"type":3,"text":"Authorize the client ID to new DSP `accountId` (advertiser id)"},"path":"/en-us/guides/dsp/bid-adjustments/getting-started","content":[" Bid adjustments API access is through client ID; therefore, you do not need to request additional access if you are a partner trying to work with a different DSP customer. You will need your DSP customer to invite you to access their DSP account. This can be done via Account access and settings on the Amazon DSP console. Once this is done, you will be granted account access via both API and the Amazon DSP console.\n"],"documentType":"guide"},{"title":"Get started with the bid adjustments API","sectionHeader":{"type":2,"text":"Bid adjustments API access"},"path":"/en-us/guides/dsp/bid-adjustments/getting-started","content":[" When making any bid adjustments API requests, please ensure that the below headers (Amazon Ads API required headers) are correctly specified. All three headers below are required for ALL API calls.\n","|Header\t|Purpose\t|\n","|---\t|---\t|\n","|Amazon-Advertising-API-ClientId\t|The identifier of a client associated with a \"Login with Amazon\" account.\t|\n","|Amazon-Advertising-API-Scope\t|The identifier of a profile associated with the advertiser account.\t|\n","|Amazon-Ads-AccountId\t|The Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.\t|\n"],"documentType":"guide"},{"title":"Bid adjustments API guide","sectionHeader":null,"path":"/en-us/guides/dsp/bid-adjustments/guide","content":[],"documentType":"guide"},{"title":"Bid adjustments API guide","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/dsp/bid-adjustments/guide","content":[],"documentType":"guide"},{"title":"Bid adjustments API guide","sectionHeader":{"type":2,"text":"Terminologies"},"path":"/en-us/guides/dsp/bid-adjustments/guide","content":[" Bid adjustment term\n"," A bid adjustment term has 2 primary elements to apply if a bid request matches the criteria:\n","Dimension(s) matching criteria. \\* Bid adjustment.\n"," Bid adjustment rule\n"," A setting that contains 1 or more bid adjustment terms. Each bid adjustment rule is defined in one JavaScript Object Notation (JSON) file uploaded through an Application Programming Interface (API). A bid adjustment rule can be associated with multiple line items. However, only 1 bid adjustment rule can be associated with a line item at the same time. If you try to associate a new bid adjustment rule with an ad line that has an existing bid adjustment rule, the latest bid adjustment rule will take effect and override the older one.\n"," Bid adjustment\n"," The value to multiply the predicted impression value with if the bid request matches the bid adjustment dimensions. The minimum value is 0, the maximum is 10.0. Decimals will be truncated to 2 decimal places (Example: 1.25). A bid adjustment of 1 does not change anything.\n"," You can adjust bids across dimensions like domain, app, device, location, and Amazon Audiences.\n"],"documentType":"guide"},{"title":"Bid adjustments API guide","sectionHeader":{"type":2,"text":"Bid adjustment rule schema"},"path":"/en-us/guides/dsp/bid-adjustments/guide","content":[" Note that all field names and dimension names are required to use camel case in API calls. For example, if ruleEXPRESSION is provided instead of ruleExpression, or dimension name devicetype is provided instead of deviceType, then the API will throw a validation error. The file size for a bid adjustment rule must not exceed 1MB.\n"," The bid adjustment rule that you create will only be available in the region it was initially created in, based on the regionalized Advertising API you are using. See the Amazon Ads API overview for a detailed breakdown of the 3 regions (North America \\[NA], Europe, \\[EU], and Far East \\[FE]) and associated endpoints.\n","| Field Name\t      | Purpose of Field\t                                                                                                                                                                                                                                                                                                                                                                                                                                         |Data Type\t|\n","|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---\t|\n","| ruleDescription\t | Description of what the bid adjustment rule is about. This is metadata for audit/tracking purposes.\t                                                                                                                                                                                                                                                                                                                                                         |String\t|\n","| ruleExpression\t  | The bid adjustment rule expression holds all the bid adjustment terms and how to reconcile multiple bid adjustment terms matching the bid request by onMultipleMatches. Each term specifies the dimensions to match, and the bidAdjustment amount.                                                                                                                                                                                                          | String\n","| terms\t           | Each term object is a data blob that specifies the dimension matching criteria and bid adjustment. Dimension values are list type. You must provide dimension values using list notation \\[], even if there is only 1 dimension value. You may also pass multiple dimension values, and the term will apply if any value gets matched (OR condition). You can write up to 1000 terms in each bid adjustments rule.\t                              |ListObject\n","| onMultipleMatches| Specify how to reconcile multiple bid adjustment terms matching the bid request. Default is APPLY_PRODUCT and currently this is the only supported value. If APPLY_PRODUCT is specified, bid adjustment from multiple terms will be multiplied together.                                                                                                                                                                                            | Enum\n","| bidAdjustment| The value to multiply the predicted impression value with if the bid request matches the bid adjustment dimensions. The minimum value is 0, the maximum is 10.0. Note that decimals will be truncated to 2 decimal places (for example, 1.25).                                                                                                                                                                                                                  |Decimal\n","| negative (optional)| This is for setting negative bid adjustment. This is a true/false field, with true indicating that the bid adjustment will be applied when none of the dimensions match (NOT A AND NOT B AND NOT C etc.). For example, if you want to set bid adjustment for all domains other than \"cnn.com\" and \"bbc.com\", you may set a negative bid adjustment when none of \"cnn.com\" and \"bbc.com\" matched. This is an optional field, and the default is false. | Boolean\n"],"documentType":"guide"},{"title":"Bid adjustments API guide","sectionHeader":{"type":2,"text":"How do bid adjustments work?"},"path":"/en-us/guides/dsp/bid-adjustments/guide","content":[" Bid adjustments work in conjunction with all existing bid strategies and Amazon DSP automated optimization. You can create either single dimension bid adjustments or multi-dimension bid adjustments.\n"],"documentType":"guide"},{"title":"Bid adjustments API guide","sectionHeader":{"type":3,"text":"Example: Single dimension bid adjustments"},"path":"/en-us/guides/dsp/bid-adjustments/guide","content":[" It assigns one bid adjustment value to a single dimension value.\n","|Device type\t|Bid adjustment\t|\n","|---\t|---\t|\n","|TV\t|2\t|\n","|PC\t|0.6\t|\n","|Phone\t|1.5\t|\n"],"documentType":"guide"},{"title":"Bid adjustments API guide","sectionHeader":{"type":3,"text":"Multi-dimension bid adjustments"},"path":"/en-us/guides/dsp/bid-adjustments/guide","content":[" It assigns one bid adjustment value to an intersection of 2 or more dimensions. Multiple dimensions are used at the same time to set the matching criteria. In the below example, when all conditions are satisfied: country = \"US\" AND region = \"NY\" AND city = \"New York\", a bid adjustment of 1.5 will be applied.\n","|Country\t|Region\t|City\t|Bid adjustment\t|\n","|---\t|---\t|---\t|---\t|\n","|US\t|NY\t|New York\t|1.5\t|\n"," Negative option\n"," This is a true/false field and default is false. You can use a negative field to \"exclude\" certain dimension values. In the below example, if negative is set to true, it means if domain is not foo.com, a bid adjustment of 1.1 will be applied.\n","|Domain\t|Bid adjustment\t|Negative\t|\n","|---\t|---\t|---\t|\n","|foo.com\t|1.1\t|TRUE\t|\n"," Multi-value input\n"," You can use a list of values for multi-value input for a specific dimension. Use brackets to contain the list of values and each value will need to be quoted and separated by comma. In the above example, when either domain is matched, a bid adjustment of 1.25 will be applied.\n","|Domain\t|Bid adjustment\t|\t\n","|---\t|---\t|\t\t\n","|\"foo.com\", \"foo1.com\",  \"foo2.com\", \"foo3.com\"\t|1.25\t|\t\n"," The above is equivalent to the following:\n","|Domain\t|Bid adjustment\t|\n","|---\t|---\t|\n","|foo.com\t|1.25\t|\n","|foo1.com\t|1.25\t|\n","|foo2.com\t|1.25\t|\n","|foo3.com\t|1.25\t|\n"],"documentType":"guide"},{"title":"Bid adjustments API guide","sectionHeader":{"type":2,"text":"How are bid adjustments calculated?"},"path":"/en-us/guides/dsp/bid-adjustments/guide","content":[" Example 1  Single dimension and multi-dimension bid adjustment\n"," Suppose you have bid adjustments like the ones below. You have 1 single dimension bid adjustment for domain and 1 multi-dimension bid adjustment with device type and operating system.\n","|Domain\t|Device type\t|Operating system\t|Bid adjustment\t|\n","|---\t|---\t|---\t|---\t|\n","|foo.com\t|\t|\t|0.75\t|\n","|\t|\"Phone\", \"Tablet\"\t|iOS\t|1.25\t|\n"," How the final bid adjustment is calculated based on the above bid adjustment terms:\n","|Device  type\t|Operating system\t|Domain\t|Final bid adjustment\t|\n","|---\t|---\t|---\t|---\t|\n","|Phone\t|iOS\t|foo2.com\t|bid adjustment = bid  adjustment \\* 1.25\t|\n","|Tablet\t|iOS\t|foo1.com\t|bid adjustment = bid  adjustment \\* 1.25\t|\n","|Tablet\t|iOS\t|foo.com\t|bid adjustment = bid  adjustment \\* 1.25 \\* 0.75\t|\n","|Phone\t|Android\t|foo.com\t|bid adjustment = bid  adjustment \\* 0.75\t|\n","|Phone\t|Android\t|foo2.com\t|No match, bid adjustment  unchanged\t|\n","|Tablet\t|Android\t|foo2.com\t|No match, bid adjustment  unchanged\t|\n","|PC\t|iOS\t|foo1.com\t|No match, bid adjustment  unchanged\t|\n"," Example 2  Single dimension bid adjustment with negative field\n"," For single dimension bid adjustments, including the negative field means that the bid adjustment will be applied if the dimension value does not match in the bid request.\n","|Domain\t|Bid adjustment\t|Negative\t|\n","|---\t|---\t|---\t|\n","|\"foo.com\",\"foo1.com\"\t|1.5\t|TRUE\t|\n","|\"foo2.com\",\"foo3.com\"\t|2\t|\t|\n"," How the final bid adjustment will be calculated based on the above terms:\n","|Domain\t|Final bid adjustment\t|\n","|---\t|---\t|\n","|foo.com\t|No match, bid adjustment unchanged\t|\n","|foo1.com\t|No match, bid adjustment unchanged\t|\n","|foo2.com\t|bid adjustment = bid adjustment \\* 1.5 \\* 2\t|\n","|foo3.com\t|bid adjustment = bid adjustment \\* 1.5 \\* 2\t|\n","|foo4.com\t|bid adjustment = bid adjustment \\* 1.5\t|\n","|foo5.com\t|bid adjustment = bid adjustment \\* 1.5\t|\n"," Example 3 Multi-dimension bid adjustment with negative field\n"," For multi-dimension bid adjustments, including the negative field means that the bid adjustment will only be applied if none of the dimensions match in the bid request. You can take this as a negative term for each dimension to be satisfied: if (NOT A) AND (NOT B) AND (NOT C), apply bid adjustment.\n","|Domain\t|Device type\t|Operating system\t|Bid adjustment\t|Negative\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|\"foo.com\",\"foo1.com\"\t|Phone\t|iOS\t|1.5\t|TRUE\t|\n","|\"foo2.com\",\"foo3.com\"\t|\t|\t|2\t|\t|\n"," How the final bid adjustment will be calculated based on the above terms:\n","|Domain\t|Device type\t|Operating system\t|Final bid adjustment\t|\n","|---\t|---\t|---\t|---\t|\n","|foo.com\t|Tablet\t|Android\t|No match, bid adjustment unchanged\t|\n","|foo4.com\t|Tablet\t|Android\t|bid adjustment = bid adjustment \\* 1.5\t|\n","|foo2.com\t|Tablet\t|Android\t|bid adjustment = bid adjustment \\* 1.5 \\* 2\t|\n","|foo2.com\t|Phone\t|iOS\t|bid adjustment = bid adjustment \\* 2\t|\n","|foo5.com\t|Phone\t|iOS\t|No match, bid adjustment unchanged\t|\n"],"documentType":"guide"},{"title":"Tips and best practices for the ADSP bid adjustments API","sectionHeader":null,"path":"/en-us/guides/dsp/bid-adjustments/dimensions","content":[],"documentType":"guide"},{"title":"Tips and best practices for the ADSP bid adjustments API","sectionHeader":{"type":2,"text":"Dimensions with strict enumerations"},"path":"/en-us/guides/dsp/bid-adjustments/dimensions","content":[" The below dimensions only allow the following enumerations, in the exact data type specified. If anything else is provided (for example, String instead of Integer, or an incorrect value), the API will respond with a 4xx client error.\n","|Dimension Name\t|Valid Values\t|Datatype\t|Explanation\t|\n","|---\t|---\t|---\t|---\t|\n","|adFormat\t|\\[\"DISPLAY\", \"AUDIO\", \"VIDEO\"]\t|String\t|There are currently 3 valid formats. Values must choose from the list.\t|\n","|deviceType\t|\\[\"Tablet\", \"PC\", \"TV\", \"Phone\", \"SetTopBox\", \"Unknown\", \"ConnectedDevice\", \"Robot\"]\t|String\t|There are currently 8 valid formats. Values must choose from the list.\t|\n","|slotPosition\t|\\[\"ABOVE\", \"BELOW\", \"UNKNOWN\"]\t|String\t|There are currently 3 valid formats. Values must choose from the list.\t|\n","|supplySourceType\t|\\[\"AMAZON\", \"AMAZON_PUBLISHER_DIRECT\", \"THIRD_PARTY_EXCHANGE\"]\t|String\t|There are currently 3 valid formats. Values must choose from the list.\t|\n"],"documentType":"guide"},{"title":"Tips and best practices for the ADSP bid adjustments API","sectionHeader":{"type":2,"text":"String type dimensions matching"},"path":"/en-us/guides/dsp/bid-adjustments/dimensions","content":[" All the string type dimensions are case insensitive matching except appId.\n"],"documentType":"guide"},{"title":"Tips and best practices for the ADSP bid adjustments API","sectionHeader":{"type":2,"text":"Supported dimensions list"},"path":"/en-us/guides/dsp/bid-adjustments/dimensions","content":["|Category\t|Dimension\t|Data Type\t| Definition and Values |\n","|---\t|---\t|---\t|---    |\n","|Supply/ Site / Slot\t|domain\t|string\t| Domain of a site. Example: \"foo.com\". Values are case insensitive. |\n","|Supply/ Site / Slot\t|appId\t|string\t| Application identifiers unique to the app and independent of the exchange. On Android, this should be a bundle or package name. On iOS, it is typically a numeric ID. Example: \"com.foo.mygame\". Values are case sensitive.\t |\n","|Supply/ Site / Slot\t|appName\t|string\t| Name of the app. Example: \"My Weather App\". Values are case insensitive.  |\n","|Supply/ Site / Slot\t|dealId\t|string\t| Deal id to match against. Example: \"346361066859317070\", \"296560903047013107\". Values are case insensitive. Retrieve deals using dsp deals api  |\n","|Supply/ Site / Slot\t|slotSize\t|string\t| The pixel size of the slot for the ad. This functions the same as the creative size with the slot-creative matching process. Example: 300x50.   |\n","|Supply/ Site / Slot\t|slotPosition\t|string\t| Whether the slot is above, or below the fold. Valid Values: ABOVE, BELOW, UNKNOWN. Values are case insensitive.  |\n","|Supply/ Site / Slot\t|supplySource\t|string\t| Supply source of the inventory. Example: \"Twitch\", \"Amazon Publisher Direct\", \"Verizon Media Exchange\". Values are case insensitive, derived from inventory sources api.  |\n","|Supply/ Site / Slot\t|supplySourceType\t|string\t| Filter category of the supply source. Valid Values: AMAZON, AMAZON_PUBLISHER_DIRECT, THIRD_PARTY_EXCHANGE. Values are case insensitive, derived from inventory sources api.  |\n","|Geography\t|country\t|string\t| The ISO 3166-1 alpha-2 country code, based on the IP address of the user. Example: \"JP\". Valid values: download ADSPBidAdjustmentsDimensionValueReference.xlsx for valid value inputs. Values must be chosen from the list.  Values are case insensitive.\t                             |\n","|Geography\t|region\t|string\t| The geographical state, based on the IP address of the user. Valid values: download ADSPBidAdjustmentsDimensionValueReference.xlsx for reference. Values may fall outside the list. You may use combination of region and country to avoid ambiguity.  Values are case insensitive.\t               |\n","|Geography\t|dma\t|string\t| Nielsen Designated Market Area code. Example: \"DMA501\" would be used for Nielsen DMA corresponding to New York, NY. Valid values: download ADSPBidAdjustmentsDimensionValueReference.xlsx for valid value inputs. Values must be chosen from the list.   Values are case insensitive.\t |\n","|Geography\t|city\t|string\t| Full name of the city. Valid values: download ADSPBidAdjustmentsDimensionValueReference.xlsx for valid value inputs. Values must be chosen from the list.  You may use combination of city, region and country to avoid ambiguity.  Values are case insensitive.\t                                  |\n","|Geography\t|postalCode\t|string\t| The postal code with 2-letter country code prefix, based on the IP address of the user.  Use '-' as a separator between country code and postal code without space. Space, hyphen or any special characters within a valid postal code should be kept. Example: US-33166, JP-344-0063. Values are case insensitive.\t                                                                                        |\n","|Environment\t|deviceType\t|string\t| The device type of the user viewing the ad. Valid Values:  Phone, Tablet, PC, TV, ConnectedDevice, SetTopBox, Robot, Unknown.  Values are case insensitive.\t |\n","|Environment\t|deviceMake\t|string\t| The make of the device. Example: \"APPLE\", \"GOOGLE\", \"SAMSUNG\", \"AMAZON\".  Valid values: download ADSPBidAdjustmentsDimensionValueReference.xlsx for reference. Values may fall outside the list.  Values are case insensitive.\t                                                        |\n","|Environment\t|operatingSystem\t|string\t| The operating system of the user viewing the page.  Example: \"MacOS\", \"Windows\", \"iOS\", \"Android\", \"Fire OS\". Valid values: download ADSPBidAdjustmentsDimensionValueReference.xlsx for reference. Values may fall outside the list.  Values are case insensitive.\t                    |\n","|Environment\t|browser\t|string\t| The browser family of the user viewing the page.  Example: \"Chrome\", \"Mozilla\", \"Safari\", \"Firefox\". Valid values: download ADSPBidAdjustmentsDimensionValueReference.xlsx for reference. Values may fall outside the list.  Values are case insensitive.\t                             |\n","|Ad Format\t|adFormat\t|string\t| The media type of an ad. Valid values: DISPLAY, AUDIO, VIDEO.  Values are case insensitive. |\n","|Audience / Segment\t|behavioralSegment\t|string\t| Unique identifier for Amazon Audiences. Selection of segments in Audience for the campaign is required in order to use them in bid adjustments.  Example: \"407259404244917362\". |\n"],"documentType":"guide"},{"title":"Tips and best practices for the ADSP bid adjustments API","sectionHeader":{"type":2,"text":"Supported dimension value reference"},"path":"/en-us/guides/dsp/bid-adjustments/dimensions","content":[],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":null,"path":"/en-us/guides/dsp/bid-adjustments/reports","content":[" The bid adjustments report allows advertisers to access aggregated bid data through offline reporting. Advertisers can query metrics at the bid adjustment matched term level for their orders and lines within specified time periods.\n"," There are two types of report available: \n","Daily-level report: Metrics include match rate, bids, and win rate. Metadata includes bid adjustments. This report can cover one day or multiple days. For example, if advertisers select a week, the report will show 7 rows for each combination of selected columns - one for each day. \\* Summary report: This report covers any time unit other than daily, and the metrics are aggregated over the specified time period. Only bids and win rate metrics are available. Metadata includes bid adjustments.\n"],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":2,"text":"Bid adjustment report type"},"path":"/en-us/guides/dsp/bid-adjustments/reports","content":[" For more information about bid adjustment report types, see dspBidAdjustment.\n"],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":2,"text":"Example usage"},"path":"/en-us/guides/dsp/bid-adjustments/reports","content":["Verify if any bid adjustment terms you wrote got any traffic (and by how much) with match rate metric. Note that match rate metric is currently only available in Daily report.  \n","Check your final bid adjustments values when there are multiple terms matched\n","Validate if your bid adjustments are working in a non-A/B testing environment. \n","Validate if your bid adjustments are working in an A/B test environment. \n","Analyze the relationship between bid adjustments and win rate delta ((test-control)/control)\n","Analyze pattern: Understand the patterns of the bid adjustments terms on bids or win rate metrics to help you make decisions on the bid adjustments values. \n"],"documentType":"guide"},{"title":"Bid adjustments reports","sectionHeader":{"type":2,"text":"FAQs"},"path":"/en-us/guides/dsp/bid-adjustments/reports","content":["Why is my win rate still low despite applying a large bid adjustment?\n","Why do I see a lower win rate for segments where I have set a higher bid adjustment? For example, if I set a bid adjustment of 2.0 for mobile traffic and see a 15% win rate, while desktop traffic with a bid adjustment of 1.5 shows a 25% win rate, why is the higher bid adjustment not winning more auctions?\n","Why do I see lower win rates in rows with higher bids (bid volumes)? For example, if I bid on 10,000 auctions for popular sites and get a 15% win rate, while I bid on 1,000 auctions for niche sites and get a 30% win rate, why are the popular sites not winning at similar rates?\n","Why does match rate not sum up to 100%?\n","Why do I see low bid volumes for a specific domain (e.g. foo.com) alone while I see large amounts of bids for the same domain with other dimensions?\n","Why do I see extremely large bid adjustment value?\n"],"documentType":"guide"},{"title":"Bid adjustments testing","sectionHeader":null,"path":"/en-us/guides/dsp/bid-adjustments/testing","content":[" To measure the impact of your bid adjustments, first validate if your bid adjustments terms have been matched and applied to any traffic and by how much, and then determine if this is within your use case expectation. You can verify the match rate through bid adjustment reporting. If you have set up multiple bid adjustments terms, you can also verify the final bid adjustments value applied through the bidAdjustment column. \n"," After you have validated that your terms have been matched and applied to traffic within your expectations, run an A/B test with a controlled group to measure the impact of your bid adjustments. \n"],"documentType":"guide"},{"title":"Bid adjustments testing","sectionHeader":{"type":2,"text":"Set up A/B test environment to test bid adjustments on ADSP "},"path":"/en-us/guides/dsp/bid-adjustments/testing","content":[" Amazon DSP provides 10 Customer holdout groups for A/B testing. Each group contains 10% of randomly assigned Amazon customers, allowing you to create controlled experiments. \n"," Before you get started:\n","Ensure you have enough budget and time for statistically significant results. \\* Randomize group assignments for each new test to avoid potential cross contamination between experiments or any long-term bias.\n"," Complete the following steps to set up basic A/B testing:\n","Create two identical orders. Each order should have only one line item.\n","Make both orders identical except for the bid adjustments you are testing. Turn off Automated budget optimization to ensure your testing line items are not affecting each other, or affected by other line items.\n"," Complete the following steps to set up control and test groups: \n","Split users 50/50 between control and test. 1. Randomly assign 5 holdout groups to control, 5 to test. 1. To add the groups, from the audience picker in line item setting:\n","Add bid adjustments to the test line item(s). Optionally, you can add bid adjustments of 1.0 with the same bid adjustments terms to the control line item(s) to get a comparison view for the bid report. See How to get report from A/B test. To understand the change in traffic matching (match rate), bids volume and win rate, A/B test is highly recommended to measure true impact. \n"],"documentType":"guide"},{"title":"Bid adjustments testing","sectionHeader":{"type":2,"text":"How to get report from A/B test"},"path":"/en-us/guides/dsp/bid-adjustments/testing","content":[" To get overall bid adjustments impact on campaign outcome, pull reports for orders/line items metrics to compare.  \n"," If you want to analyze further on how the bid adjustments terms affect the traffic (% of bid requests, represented by match rate), bids or win rate, you can download bid report from bid adjustments report. To compare the control vs test group results for bid metrics, you can choose to associate the control line item(s) with the same bid adjustment terms, applying bid adjustments value of 1.0. This will not change any bidding for the control line item(s), but will enable you to get the same report as your test line item(s) to do comparisons. For a usage example, see Bid Adjustments reports.\n"],"documentType":"guide"},{"title":"Tips and best practices for the ADSP bid adjustments API","sectionHeader":null,"path":"/en-us/guides/dsp/bid-adjustments/best-practices","content":[],"documentType":"guide"},{"title":"Tips and best practices for the ADSP bid adjustments API","sectionHeader":{"type":2,"text":"When to use bid adjustments"},"path":"/en-us/guides/dsp/bid-adjustments/best-practices","content":[" Default automated optimization already uses many campaign and Amazon proprietary signals. (Learn more about bid optimization.)\n"," We recommend using bid adjustments whenever the system is not able to acquire the signals needed to get to best optimization for you. Examples may include but are not limited to:\n","Customized business goals: optimize goals that are currently not supported by Amazon DSP.  Customized attribution window and events: how you count conversions can differ from Amazon DSP.  Offline sales, delayed conversions, online conversion data such as conversion values that are not incorporated into real-time bidding flow.  Contextual and inventory quality signals, media quality signals.  Signals from brand lift and conversion lift studies. \\* Signals from cross-channel marketing measurement, media mix modeling.\n"," You do not need to use bid adjustments if you are only using the specific campaign data that Amazon DSP is already using to optimize bids with. Adjusting the bids in this case may negatively impact the performance of your campaign as the default optimization may already reach the goal at its maximum.\n"],"documentType":"guide"},{"title":"Tips and best practices for the ADSP bid adjustments API","sectionHeader":{"type":2,"text":"Tips for using bid adjustments"},"path":"/en-us/guides/dsp/bid-adjustments/best-practices","content":[],"documentType":"guide"},{"title":"Rate and size limits for the ADSP bid adjustments API","sectionHeader":null,"path":"/en-us/guides/dsp/bid-adjustments/limits","content":[],"documentType":"guide"},{"title":"Rate and size limits for the ADSP bid adjustments API","sectionHeader":{"type":2,"text":"Request quotas for each Bid Adjustments API operation"},"path":"/en-us/guides/dsp/bid-adjustments/limits","content":[" The Bid Adjustments API establishes quotas for the number of API operations requested in each second. The request quotas differ for the API operations. When you exceed an API request quota, the service throttles the request.\n","|Endpoint\t|Default value (requests per second) \t|\n","|---\t|---\t|\n","|POST /dsp/rules/bidmodifier\t|10\t|\n","|POST /dsp/rules/bidmodifier/list\t|5\t|\n","|DELETE /dsp/rules/bidmodifier/{bidModifierRuleId}\t|10\t|\n","|GET /dsp/rules/bidmodifier/{bidModifierRuleId}\t|10\t|\n","|DELETE /dsp/rules/bidmodifier/{bidModifierRuleId}/associations\t|10\t|\n","|PUT /dsp/rules/bidmodifier/{bidModifierRuleId}/associations\t|10\t|\n","|POST /dsp/rules/bidmodifier/{bidModifierRuleId}/associations/list\t|10\t|\n","|POST /dsp/rules/bidmodifier/{bidModifierRuleId}/associations/validate\t|10\t|\n"],"documentType":"guide"},{"title":"Rate and size limits for the ADSP bid adjustments API","sectionHeader":{"type":2,"text":"System limits"},"path":"/en-us/guides/dsp/bid-adjustments/limits","content":["| Limit type\t           | Maximum value\t | Description\t                                                                              |\n","\\|-----------------------\\|----------------\\|-------------------------------------------------------------------------------------------\\|\n","| Size limit\t           | 1 MB\t          | Total payload size for a bid adjustment rule\t                                             |\n","| Terms in rule\t        | 1,000\t         | Number of terms (for example, Term 1: mobile devices, Term 2: regions, ... Term 1000: browsers)\t |\n","| Values per dimension\t | 1,000\t         | Number of distinct values allowed per dimension\t                                          |\n","| Rule description\t     | 1,024 chars\t   | Character limit for rule descriptions\t                                                    |\n","| Ad group IDs\t         | 1,000\t         | Number of ad groups that can be associated in one API call\t                               |\n","| Bid modifiers\t        | 1,000\t         | Maximum number of rules returned in List API\t                                             |\n","| Number of Rules       | 2,000          | Maximum number of rules that can be created by advertiser                                 |\n"],"documentType":"guide"},{"title":"Rate and size limits for the ADSP bid adjustments API","sectionHeader":{"type":2,"text":"Concurrency and consistency"},"path":"/en-us/guides/dsp/bid-adjustments/limits","content":[" The Bid Adjustments API does not guarantee strong consistency for create, update, or delete operations within a 5-minute window. After a successful mutating call, a subsequent GET for the same rule or association — or the downstream serving systems that consume it — may not reflect the change for up to 5 minutes.\n"," If two or more mutating requests target the same rule or association in close succession, the API may reject one of the racing requests with HTTP 423 ConcurrentModificationException. This response is safe to retry.\n"," To minimize 423 responses:\n","Serialize create, update, and delete calls against the same bidModifierRuleId or (advertiserId, adGroupId) association.  On 423, retry with exponential backoff. The error is marked retryable and supported SDK clients will retry automatically.  Wait at least a few seconds between successive edits to the same rule before relying on the result of a subsequent read.\n"],"documentType":"guide"},{"title":"Rate and size limits for the ADSP bid adjustments API","sectionHeader":{"type":2,"text":"Increasing Quotas"},"path":"/en-us/guides/dsp/bid-adjustments/limits","content":[" To increase a quota, follow these steps and it will be reviewed on a case-by-case basis.\n"],"documentType":"guide"},{"title":"Bid adjustments FAQs","sectionHeader":null,"path":"/en-us/guides/dsp/bid-adjustments/frequently-asked-questions","content":[],"documentType":"guide"},{"title":"Bid adjustments FAQs","sectionHeader":{"type":2,"text":"How do I access the product feature? What are the supply that are available?"},"path":"/en-us/guides/dsp/bid-adjustments/frequently-asked-questions","content":[" The feature is available to all advertisers WW for non-guaranteed ads (open and private auctions) on Amazon DSP in both Amazon DSP console and API. Fire TV and Fire Tablet ads are currently not supported.\n"],"documentType":"guide"},{"title":"Bid adjustments FAQs","sectionHeader":{"type":2,"text":"Are there any restrictions for using bid adjustments?"},"path":"/en-us/guides/dsp/bid-adjustments/frequently-asked-questions","content":[" Please refer to our Audience Creation Policy and Prohibited Audience Categories.\n"," If you updated your Advertiser settings to exclude demographic signals, bid adjustments will require you to remove audiences with demographic signals in bid adjustments rule and remove the dimensions city and postal code from the bid adjustments rule.\n"," Dimensions such as postal code and city are restricted to the list of cities and postal codes supported.\n"],"documentType":"guide"},{"title":"Bid adjustments FAQs","sectionHeader":{"type":2,"text":"What does bid adjustment actually change?"},"path":"/en-us/guides/dsp/bid-adjustments/frequently-asked-questions","content":[" Amazon DSP generates bids based on the predicted value of the impressions, how the campaign is performing against its Target KPI, and how it is pacing against its flight budget. Bid adjustments adjust one of these components of Amazon DSP bid generation - the predicted value of the impressions, not the final bids. Amazon DSP will continue raising your bids to ensure the budget is spent in full or optimize bids to maximize performance and delivery at or near your Target KPI. Your adjusted bids will be capped by the optional max average CPM field if it is set. This is to ensure that we have mechanisms to still meet other objectives of the advertiser such as pacing, Target KPI and maximum average CPM (if chosen). This means that if you set the bid adjustment as 2 for an impression opportunity, you may not see exact 2X in final bid price, but a directional positive shift in the bid price towards 2X.\n"],"documentType":"guide"},{"title":"Bid adjustments FAQs","sectionHeader":{"type":2,"text":"What if the bid adjustment is set to 0?"},"path":"/en-us/guides/dsp/bid-adjustments/frequently-asked-questions","content":[" If you make the bid adjustment to 0, this means we will adjust the predicted value of impressions to 0. However, this may not completely override the bid price to 0 as the bid price could be affected by other factors such as pacing, Target KPI and maximum average CPM (if chosen). Therefore, the effect of setting bid adjustments to 0 will be different from targeting exclusions. We recommend using targeting exclusions if your goal is to completely exclude the inventory from bidding.\n"],"documentType":"guide"},{"title":"Bid adjustments FAQs","sectionHeader":{"type":2,"text":"What is the maximum amount that the predicted value can be adjusted?"},"path":"/en-us/guides/dsp/bid-adjustments/frequently-asked-questions","content":[" Each single bid adjustment can go up to 10 individually, with the combined final bid adjustments also capped at 10. The final bid is ultimately limited by the maximum average CPM set for the ad line.\n"],"documentType":"guide"},{"title":"Bid adjustments FAQs","sectionHeader":{"type":2,"text":"What happens if the same dimension matches twice?"},"path":"/en-us/guides/dsp/bid-adjustments/frequently-asked-questions","content":[],"documentType":"guide"},{"title":"Guidance and Quick Actions","sectionHeader":null,"path":"/en-us/guides/dsp/guidance-and-quick-actions","content":[" The Guidance API enables self-service advertisers to programmatically access and implement Amazon DSP recommendations. This API allows you to integrate Amazon machine learning optimization suggestions into your own tools and workflows. Use cases include:\n","Automate campaign optimization: Receive and apply pre-flight and in-flight recommendations to improve campaign pacing and performance. - Build custom optimization workflows: Integrate recommendations into your existing campaign management tools to create automated optimization rules. - Track optimization opportunities: Monitor recommendations across your portfolio and understand the impact of implemented changes.\n"],"documentType":"guide"},{"title":"Guidance and Quick Actions","sectionHeader":{"type":2,"text":"Where are recommendations available?"},"path":"/en-us/guides/dsp/guidance-and-quick-actions","content":[" Recommendations are provided at two stages of the campaign workflow: 1) pre-flight and 2) in-flight.\n"," During the pre-flight workflow, we offer tactics and pre-flight guidance:\n"," Tactics offer pre-configured ad groups to maximize performance and utilize a specific targeting strategy. Eligible campaigns receive tactics recommendations when querying for campaign guidance and can create the suggested ad groups through the Quick Actions API.\n"," Pre-flight guidance helps to optimize your created ad groups before launch using machine learning. These recommendations analyze your campaign parameters and suggest optimal values for maximum average CPM and ad group frequency caps. Users can request recommendations for newly created campaigns and ad groups using any of the guidance API endpoints.\n"," Available pre-flight ad group delivery optimizations - Maximum Average CPM - Frequency Cap\n"," During the in-flight workflow, we offer in-flight guidance:\n"," In-flight guidance helps to optimize active campaigns by identifying delivery and performance improvement opportunities. These recommendations analyze real-time campaign data to suggest actionable optimizations for your campaign. The API continuously monitors your live campaigns and generates recommendations when it identifies campaigns at risk of underpacing or ad groups with rejected creatives.\n"," Available in-flight recommendations - Under delivery Guidance: Based on recent delivery we predict that this campaign will under deliver by the end of its flight.\n"],"documentType":"guide"},{"title":"Guidance and Quick Actions","sectionHeader":{"type":2,"text":"How can I access the guidance API? "},"path":"/en-us/guides/dsp/guidance-and-quick-actions","content":[" There are two main APIs for interacting with guidance, one to query for any available guidance and one to automatically execute the recommended actions provided.\n"],"documentType":"guide"},{"title":"Guidance and Quick Actions","sectionHeader":{"type":3,"text":"Example:"},"path":"/en-us/guides/dsp/guidance-and-quick-actions","content":[" Make a call to POST /dsp/v1/guidance/campaigns/list using the following request body to list guidance for a specific campaign\n"," The API returns the following body. Some fields have been removed.\n"," The response indicates that the queried campaign is underpacing and increasing the max average CPM of a specific ad group to $8 will help.\n"," You can then make a call to POST /dsp/v1/quickactions/cc193cg7-a195-4c66-8c82-cf0392dca2f4/executions to create an execution for the action associated to the returned recommendation. By default this will also automatically start this execution and increase the max average CPM of the relevant ad group.\n"],"documentType":"guide"},{"title":"Guidance and Quick Actions","sectionHeader":{"type":2,"text":"API Endpoints:"},"path":"/en-us/guides/dsp/guidance-and-quick-actions","content":[" Guidance API - POST /dsp/v1/guidance/adGroups/list - List Ad Group Guidance - POST /dsp/v1/guidance/campaigns/list - List Campaign Guidance - POST /dsp/v1/guidance/advertisers/list - List Advertiser Guidance\n"," Quick Actions API - POST /dsp/v1/quickactions/{actionId}/executions - Create an execution for a Quick Action - PUT /dsp/v1/quickactions/{actionId}/executions/{executionId}/start - Start an execution - GET /dsp/v1/quickactions/{actionId}/executions/{executionId} - Get an execution - POST /dsp/v1/quickactions/batchGetExecutions - Batch get executions - POST /dsp/v1/quickactions/batchCreateExecutions - Batch create executions\n"],"documentType":"guide"},{"title":"Guidance and Quick Actions","sectionHeader":{"type":2,"text":"Implementation Guidelines: "},"path":"/en-us/guides/dsp/guidance-and-quick-actions","content":["Guidance Polling - Our recommendations are regularly updated to ensure they are accurate. We recommend polling for them daily, to enable you to access recommendations as soon as they are actionable.  - Quick Actions Polling - The state of quick action executions can be queried using the get executions endpoint. We recommend polling every 30 seconds to monitor the success of the action. \n"],"documentType":"guide"},{"title":"Guidance and Quick Actions","sectionHeader":{"type":2,"text":"Common use cases"},"path":"/en-us/guides/dsp/guidance-and-quick-actions","content":[],"documentType":"guide"},{"title":"Overlapping Audiences","sectionHeader":null,"path":"/en-us/guides/dsp/overlapping-audiences","content":[" The Overlapping Audiences API helps surface other audiences that are similar to your selected audience and that you may want to target in your campaigns. You can use any audience returned from the Discovery API as an input to generate overlapping audiences.\n"," For example, to retrieve overlapping audiences for an audience with ID equal to 1234567890:\n"," The API will return the top 30 audiences that overlap with the selected audience and meet the specified criteria. Below you see a sample with the selected audience and just its top 3 overlapping audiences shown.\n"," You can use one or more filters to narrow the results. The API offers filters for audienceCategory, minimumOverlapAffinity, and maximumOverlapAffinity.\n"," For example, the following request returns the top 30 overlapping audiences that are in the in-market audienceCategory and have a minimumOverlapAffinity of 2.\n"],"documentType":"guide"},{"title":"Persona builder","sectionHeader":null,"path":"/en-us/guides/dsp/persona-builder","content":[" The Persona Builder API helps brands get insights on custom, composite audience expressions. The API provides the following functionality: \n","Get a banded size -- an upper and lower bound estimate -- of the number of unique customers within your audience - Get demographic insights - Discover the top retail categories purchased by customers in your audience - Find overlapping audiences - Review Prime Video insights for your audience\n"," To use the API, first define your audience using audienceTargetingExpression. You can use any custom-built, demographic, in-market, interest, life event, lifestyle, advertiser, or lookalike audience returned from the Audience discovery API. You can either use these audiences themselves or combine them together to define an audienceTargetingExpression. For example, this expression defines a custom audience consisting of both Amazon \"interested in technology\" and \"in market for headphones\" audiences:\n"],"documentType":"guide"},{"title":"Persona builder","sectionHeader":{"type":2,"text":"Banded size estimates"},"path":"/en-us/guides/dsp/persona-builder","content":[" To get the banded size for your audience expression, call the following API endpoint with the audience expression:\n"," The API returns the estimated size, from lower to upper bound, of the audience in this expression.\n"],"documentType":"guide"},{"title":"Persona builder","sectionHeader":{"type":2,"text":"Demographic insights"},"path":"/en-us/guides/dsp/persona-builder","content":[" To get demographic insights for your audience expression, call the following API endpoint: \n"," The API returns a list of demographic insights, such as age and gender. Affinity, overlap percentage, and segment ID of the corresponding demographic audience are provided for each insight. \n"],"documentType":"guide"},{"title":"Persona builder","sectionHeader":{"type":2,"text":"Top categories purchased"},"path":"/en-us/guides/dsp/persona-builder","content":[" To get insights on top retail categories purchased, call the following API endpoint: \n"," The API returns a list of top retail categories purchased, including the browse node name and path. Results are paginated.\n"],"documentType":"guide"},{"title":"Persona builder","sectionHeader":{"type":2,"text":"Overlapping audiences"},"path":"/en-us/guides/dsp/persona-builder","content":[" To get insights on top overlapping audiences, call the following API endpoint: \n"," The API returns a list of top overlapping audiences for this audience expression, including audience category, forecast daily impressions, and forecast daily reach for each overlapping audience. Results are paginated. You can also filter the results to a specific set of audience categories only.\n"],"documentType":"guide"},{"title":"Persona builder","sectionHeader":{"type":2,"text":"Prime Video"},"path":"/en-us/guides/dsp/persona-builder","content":[" To get insights on top Prime Video content and artists streamed, call the following API endpoint: \n"," The API returns a list of top Prime Video genres, actors, directors, series, and movies and a dateRange value that specifies the corresponding time period. You can filter these to get results for a specific insight type, for example, for top movies only.\n"],"documentType":"guide"},{"title":"Persona builder","sectionHeader":{"type":2,"text":"Save your audience expression to Amazon DSP using the combined audience API"},"path":"/en-us/guides/dsp/persona-builder","content":[" This audience expression can be saved to Amazon DSP as a combined audience using the combined audience API. To do this, use the following API call:\n"," The API creates the combined audience and returns its audience ID.\n"],"documentType":"guide"},{"title":"Persona builder","sectionHeader":{"type":2,"text":"View an existing combined audience"},"path":"/en-us/guides/dsp/persona-builder","content":[" To view an existing combined audience, use the following API call with the audience ID:\n"," The API returns the following information about this audience:\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":null,"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[" The DSP Campaign Insights API provides performance insights for Brand+ and Performance+ campaigns, focusing on audience composition and conversion timing metrics. This API helps advertisers understand their automated targeting performance and build trust in ML-generated audience composition.\n"," Current Version: v1   Base URL: /dsp/v1/campaign/insights   Response Format: JSON   Authentication: SigV4 with required permissions\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":2,"text":"Supported campaign types and tactics"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":3,"text":"Designed to drive awareness and influence potential customers"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":["Prospecting tactic: Reach consumers who are highly likely to show interest and engage with your brand or product\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":3,"text":"Designed specifically to drive consideration outcomes"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":["Unified Consideration tactic: Reach shoppers similar to those who previously viewed a product detail page\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":3,"text":"Designed specifically to drive conversion outcomes"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":["Customer acquisition tactic: Reach shoppers who are similar to past purchasers  Remarketing tactic: Reach shoppers who have viewed a product detail page, searched for your product or visited your homepage  Retention tactic: Reach shoppers who have purchased your product\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":2,"text":"API reference"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[" For complete API documentation, see the DSP Campaign Insights API reference.\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":2,"text":"Usage examples"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":3,"text":"Example 1: Get campaign level insights"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[" Request:\n"," Response: Returns both campaign-level and tactic-level insights\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":3,"text":"Example 2: Get ad group/line item specific insights"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[" Request:\n"," Response: Returns insights specific to the ad group\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":3,"text":"Example 3: Batch request"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[" Request:\n"," Response: Returns insights for multiple campaigns/ad groups\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":2,"text":"Rate limits and performance"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":["Request Limit: Maximum 25 requests per API call - Rate Limiting: Standard DSP API rate limits apply - Latency SLA: <1 second (P99) - Availability SLA: 99%\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":2,"text":"Data availability"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":3,"text":"Minimum requirements"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":["Campaign must be active with Brand+ OR Performance+ tactics - Campaign must be active for a minimum of ~8 days\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":2,"text":"Changelog"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":3,"text":"Current features (Live)"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[" Released with Brand+ and Performance+ tactics support in US marketplace.\n","Shopper trait insights for PROSPECTING, UNIFIED_CONSIDERATION, CUSTOMER_ACQUISITION, REMARKETING, RETENTION tactics - Time to convert insights - Batch request support\n"],"documentType":"guide"},{"title":"DSP Campaign Insights API","sectionHeader":{"type":3,"text":"Upcoming features"},"path":"/en-us/guides/dsp/dsp-campaign-insights-api","content":[],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Inventory API","sectionHeader":null,"path":"/en-us/guides/deal-management/overview","content":[" The Amazon Ads Inventory API allows you to create, update, and manage advertising deals within ADSP, including associating deals with seats, labels, and inventory groups. It also supports managing proposals and commitments. The ADSP platform uses the exchangeID and the exchangeDealId to identify the deal during ad placement; the exchangeDealId is the deal ID provided by an exchange/SSP, visible in the ADSP UI, and used by exchanges/SSPs when communicating with advertisers. The inventory API also generates an internal advertisingDealId, distinct from the exchangeDealId, that must be used to manage the deals within ADSP.  The Proposal Management APIs provide functionality to negotiate and execute deals with various SSPs through a structured proposal workflow.  The Commitment Management API enables buyers to create and manage spending commitments tied to deals on Amazon DSP.\n"," The API currently covers the following entities:\n","| Entity | API Specification |\n","\\| -----------  \\| ------------ \\|\n","| AdvertisingDeal | Advertising Deal API Specification |\n","| BuyerSeats | Buyer Seat API Specification |\n","| DealAdvertiserAccess  | DealAdvertiserAccess API Specification |\n","| DealAdvertiserAccessEntry | DealAdvertiserAccessEntry API Specification |\n","| DealAvails | DealAvails API Specification |\n","| DealPerformance | DealPerformance API Specification |\n","| DealPlanningMetrics | DealPlanningMetrics API Specification |\n","| InventoryGroup | InventoryGroup API Specification |\n","| Label | Label API Specification |\n","| Supplier | Supplier API Specification |\n","| SupplierAdProduct | SupplierAdProduct API Specification |\n","| SupplierAdProductPrice | SupplierAdProductPrice API Specification |\n","| SupplierProposal | SupplierProposal API Specification |\n","| SupplierProposedDeal | SupplierProposedDeal API Specification |\n","| SupplierProposedDealForecast | SupplierProposedDealForecast API Specification |\n","| SupplierProposedDealHistoricalVersion | SupplierProposedDealHistoricalVersion API Specification |\n","| SupplierProposedDealRevision | SupplierProposedDealRevision API Specification |\n","| SupplierProposalDestination | SupplierProposalDestination API Specification |\n","| SupplierPublisher | SupplierPublisher API Specification |\n","| SupplierTargetItem | SupplierTargetItem API Specification |\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Inventory API","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/deal-management/overview","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your client ID and access token. You will need these to make all the calls referenced in this tutorial.\n"," Be sure to also note the values for Content-Type in the example requests.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Inventory API","sectionHeader":{"type":2,"text":"Creating and using deal objects"},"path":"/en-us/guides/deal-management/overview","content":[" There are three high-level steps in creating and using a deals object in ADSP using the Amazon Ads API:\n","Retrieve the profile ID of the profile you want to create the deal object for. A profile ID in the Amazon Ads API corresponds to accounts in the Amazon Ads console. 2. Create and manage a deal object. 3. Associate the deal object with an ad group.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Inventory API","sectionHeader":{"type":2,"text":"Creating and using proposal objects"},"path":"/en-us/guides/deal-management/overview","content":[" The Amazon DSP Deal Proposals API is specifically for creating and managing deals with Amazon Publisher Direct (APD), Amazon Publisher Cloud (APC) and with Amazon Owned & Operated publishers (Prime Video and Twitch).\n"," To negotiate a proposal with APD/APC and Amazon Owned & Operated publishers and get an approved deal, the following steps are involved:\n","Retrieve the profile ID of the profile you want to create the deal object for. A profile ID in the Amazon Ads API corresponds to accounts in the Amazon Ads console. 2. Create and manage a proposal object. You can negotiate the proposal with APC/APD and Amazon Owned & Operated publishers. After a proposal is approved, the user gets a deal object. 3. Associate the deal object with an ad group.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Inventory API","sectionHeader":{"type":2,"text":"Retrieve a profile ID"},"path":"/en-us/guides/deal-management/overview","content":[" Profiles in the Amazon Ads API represent the account of an advertiser in a specific marketplace. A profile ID is required for requests to the deals API. The list of profile IDs can be retrieved using GET /v2/profiles. Once you identify the profile you want to use, you will provide the profileId value as the Amazon-Advertising-API-Scope header in subsequent calls to the deals API.\n"," The following call will retrieve a list of all accounts in the region associated with the user account that provided the access token:\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" An AdvertisingDeal represents a deal between an advertiser and an Amazon Ads offering. Deals allow advertisers to negotiate specific terms for ad inventory, including pricing, placement, and delivery guarantees. The Amazon DSP platform uses the exchangeId and exchangeDealId to identify the deal during ad placement, while the API generates an internal advertisingDealId for managing deals within Amazon DSP.\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"AdvertisingDeal parameters"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| advertisingDealId | A unique identifier generated by ADSP for a deal. This is not the same as the identifier provided by an exchange/SSP for a deal. | □ |\n","| exchangeDealId | An identifier provided by an exchange/SSP for a deal. This is the deal ID visible in the ADSP UI and used by exchanges/SSPs when communicating with advertisers. | ○ |\n","| exchangeId | The exchange/SSP that provides the deal. | ○ |\n","| dealType | The type of the deal such as share of voice. | ✓ |\n","| dealTargetType | The target type of the deal such as branded keyword. | ○ |\n","| name | The name of the deal. | ✓ |\n","| replacingDealId | The ID of an advertising deal that this deal intends to replace. | ○ |\n","| adProduct | The ad product associated with the deal. | ✓ |\n","| state | User intended state of the deal. Set to DRAFT during creation if empty. | ○ |\n","| startDateTime | The start date time for the deal. | ✓ |\n","| endDateTime | The end date time for the deal. | ✓ |\n","| price | Overall price of the advertising deal. | ◐ |\n","| status | Actual status of the deal after processing/moderation. | □ |\n","| customPublisherDescription | Custom description of the publisher providing inventory for this deal. | ○ |\n","| supplyInventoryTypes | The inventory type of the deal declared by the supplier. Use this field to find deals compatible with an ad group. For a DISPLAY ad group, query deals with supplyInventoryType DISPLAY. For a STREAMING_TV or ONLINE_VIDEO ad group, query deals with supplyInventoryType VIDEO. For an AUDIO or PODCAST ad group, query deals with supplyInventoryType AUDIO. Deals with an empty supplyInventoryTypes list have no inventory type restriction. Valid values: DISPLAY, VIDEO, AUDIO. | ○ |\n","| deviceType | The device type that the deal is expected to deliver. Constrains what device types can be used when targeting this deal. | ○ |\n","| countryCode | The country code associated with the deal. | ○ |\n","| moderationRejectionReason | The reason for moderation rejection. | □ |\n","| creationDateTime | The date time that the deal was created. | □ |\n","| lastUpdatedDateTime | The date time that the deal was last updated. | □ |\n","| placements | The placement for the deal such as TOP_OF_SEARCH. | ○ |\n","| creativeRequirements | Creative requirements associated with the deal. | ◐ |\n","| terms | Terms for the deal including pricing, guarantees, and budget. | ◐ |\n","| supplyMetadata | Live-events supply classification for the deal, such as the sports, leagues, and broadcasters that a certified live-sports deal covers. | ◐ |\n","| supplierProposedDealId | The proposed deal associated with this advertising deal. | ○ |\n","| startDateTimeRange | A date-time range filter for the deal start date. Used to query deals whose startDateTime falls within the specified range. | ○ |\n","| endDateTimeRange | A date-time range filter for the deal end date. Used to query deals whose endDateTime falls within the specified range. | ○ |\n","| creationDateTimeRange | A date-time range filter for the deal creation date. Used to query deals whose creationDateTime falls within the specified range. | ○ |\n","| priceRange | A price range filter for the deal price. Used to query deals whose price value falls within the specified range for the given currency. | ○ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealPrice"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| currencyCode | The currency code associated with the price. Computed based on the default currency of the marketplace. | ✓ |\n","| value | The monetary amount of the price in the given currency. | ✓ |\n","| priceType | The type of the price. | ✓ |\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| FLAT_FEE | Deprecated. Use FIXED_PRICE instead. |\n","| FIXED_PRICE | Sale price for a specific ad placement regardless of auction performance. |\n","| FIXED_CPM | Fixed cost per thousand impressions. Buyer pays this exact CPM for every impression won. Used for PREFERRED and PROGRAMMATIC_GUARANTEED deals. |\n","| FLOOR_RATE | Minimum bid price for auction. Buyer must bid at or above this floor to compete. Used for PRIVATE_AUCTION deals. |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealStatus"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| status | Status of the deal. | ✓ |\n","| statusReason | A human readable string explaining the status reason. | ○ |\n","| statusDateTime | Timestamp when the deal entered this status. | ○ |\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| DRAFT | The deal has not been submitted yet. |\n","| PROPOSED | The deal has been submitted for moderation. |\n","| MODERATION_REJECTED | The deal is rejected during moderation process due to policy violation. |\n","| MODERATION_APPROVED | The deal has passed moderation. |\n","| ACCEPTED | The deal is accepted by the advertiser. |\n","| ADVERTISER_REJECTED | The deal is rejected by the advertiser. |\n","| ACTIVE | Deal is ready to serve from SSP perspective. SSP will send bid requests for this deal. |\n","| PAUSED | Deal is temporarily paused from SSP perspective. SSP will not send bid requests for this deal. |\n","| SCHEDULED | Deal is approved and scheduled but has not yet reached its start date. |\n","| ENDED | Deal has passed its end date and is no longer active. |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"CreativeRequirements"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| preApprovalPermission | Indicates whether creative requires pre-approval from exchange/SSP. Values: REQUIRED, ALLOWED, NOT_ALLOWED. | ○ |\n","| clearanceLevel | Indicates whether creative approval is mandatory before deal goes live. Values: RESTRICTIVE, PERMISSIVE. | ○ |\n","| creativeSource | Indicates who hosts and serves the creative for this deal. PUBLISHER means the creative is hosted by the publisher's ad server. ADVERTISER means the creative is provided by the demand side. Values: PUBLISHER, ADVERTISER. | ○ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealTerms"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| price | The price structure for the deal including currency, amount, and price type. | ✓ |\n","| guaranteed | If true, deal is a Programmatic Guaranteed deal. | ✓ |\n","| marketplaceDeal | If true, deal is available to all Amazon DSP entities globally. Marketplace deals cannot be edited by individual buyers. | ✓ |\n","| impressions | The number of impressions for the deal. Required for guaranteed deals. For non-guaranteed deals, indicates expected impressions as guidance. | ○ |\n","| shareOfVoicePercentage | Guaranteed share-of-voice percentage. Used for SOV-based PG deals. Value must be > 0 and <= 100. Mutually exclusive with budget. | ○ |\n","| budget | Target spend of the advertising deal. Applicable to PG deals. | ○ |\n","| forecast | Forecasting for the deal. | ◐ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealForecast"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| estimatedImpressions | Estimated total impressions that can be expected for the deal. | ◐ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"SupplyMetadata"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Supply-specific metadata for the deal, categorized by supply type. One category is populated, identifying the type of supply the deal covers. Live-sports deals populate sportsMetadata.\n"," Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| sportsMetadata | Live-sports classification for the deal, including its sports, leagues, and broadcasters. Populated for certified live-sports deals. | ◐ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"SportsMetadata"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Live-sports classification for the deal. Each field is a list of IDs from the corresponding Amazon Ads Live-Events taxonomy. IDs are scoped to their own taxonomy and are not comparable across fields.\n"," Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| sports | IDs of the sports associated with the deal, such as American Football. | ○ |\n","| leagues | IDs of the leagues associated with the deal, such as the National Football League. | ○ |\n","| broadcasters | IDs of the broadcasters associated with the deal. | ○ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealType values"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| SHARE_OF_VOICE | Share of voice deal. |\n","| PREFERRED | Preferred deal. |\n","| PROGRAMMATIC_GUARANTEED | Programmatic guaranteed deal. |\n","| PRIVATE_AUCTION | Private auction deal. |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealState values"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| DRAFT | The deal is in draft state and has not been proposed. |\n","| PROPOSED | The deal has been proposed. |\n","| ACCEPTED | The deal has been accepted. |\n","| REJECTED | The deal has been rejected. |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealTargetType values"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| BRANDED_KEYWORD | Deal targets branded keywords. |\n","| UNBRANDED_KEYWORD | Deal targets unbranded keywords. |\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[" A BuyerSeat is an identifier exchanged between Supply-Side Platforms (SSPs) and the Amazon DSP in programmatic advertising. Buyer seats are used for deal eligibility (SSPs include allowed seats in bid requests), spend tracking (included in bid responses), and deal discovery (associating deals with specific buyers).\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":2,"text":"Buyer Seat parameters"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| buyerSeatId | Unique identifier for the buyer seat. Server-generated with format prefix indicating account level (AMZA for advertiser, AMZN for manager account, AMZG for group). | □ |\n","| adProduct | The ad product associated with this buyer seat. | ○ |\n","| seatType | The type of the buyer seat, indicating its purpose in the programmatic transaction. | ✓ |\n","| exchangeId | The exchange/SSP that this seat applies to. | ○ |\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":2,"text":"Supported operations"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":3,"text":"Create Buyer Seats"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[" Creates buyer seats for an advertiser. Requires exactly 2 items in the request (one DEAL_CREATION and one SPEND_TRACKING).\n","Endpoint: POST /adsApi/v1/create/buyerSeats/dsp - Required header: Amazon-Ads-AccountId - Idempotent: If seats already exist for the advertiser, returns existing seat IDs as success.\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":3,"text":"List Buyer Seats"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[" Lists buyer seats resolved per exchange, including parent seats from the account hierarchy.\n","Endpoint: GET /adsApi/v1/buyerSeats/dsp - Required header: Amazon-Ads-AccountId or Amazon-Ads-Manager-AccountId - Filters: buyerSeatType (max 3), exchangeId (max 100) - Pagination: Default 50, max 200 results per page\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":3,"text":"BuyerSeatType values"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| DEAL_CREATION | Identifier shared with publishers/SSPs when setting up deals. Used to allowlist which buyers can bid on a deal. |\n","| SPEND_TRACKING | Identifier included in bid responses for buyer recognition and spend tracking by exchanges. |\n","| BID_TIME | Identifier used to recognize the buyer seat at bid time. |\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":3,"text":"Seat hierarchy"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[" Buyer seats exist at multiple account levels. When listing seats, all applicable tiers are returned per exchange:\n","| Level | ID prefix | Description |\n","\\| --- \\| --- \\| --- \\|\n","| Advertiser | AMZA | Seats specific to a single advertiser. Created via the Create API. The full seat ID follows the format AMZA + unique identifier (for example, AMZAK6ZZGGQRHGN5). |\n","| Manager Account | AMZN | Seats shared by all advertisers under a manager account. Auto-generated when the first advertiser is created. Format: AMZN + unique identifier. |\n","| Group | AMZG | Seats shared across multiple manager accounts in a holding company group. Format: AMZG + unique identifier. |\n"],"documentType":"guide"},{"title":"Commitment","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/commitment","content":[" A Commitment represents a spending agreement between an advertiser and Amazon Ads. Commitments define a total committed spend over a specified time period and can be scoped to specific advertisers, campaigns, or deals. The fulfillment level determines how aggressively the system prioritizes meeting the commitment target, while the spend calculation mode controls the aggregation level for tracking progress.\n"],"documentType":"guide"},{"title":"Commitment","sectionHeader":{"type":2,"text":"Commitment parameters"},"path":"/en-us/guides/deal-management/entities/commitment","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| commitmentId | A unique identifier for the commitment. | □ |\n","| commitmentName | The name of the commitment. | ✓ |\n","| adProduct | The ad product associated with this commitment. | ○ |\n","| currencyCode | The currency code associated with the commitment. | ✓ |\n","| committedSpend | The total committed spend for the commitment. | ✓ |\n","| startDateTime | The start date and time of the commitment. | ✓ |\n","| endDateTime | The end date and time of the commitment. | ✓ |\n","| fulfillmentLevel | The fulfillment level of the commitment. | ✓ |\n","| spendCalculationMode | The spend calculation mode of a commitment. | ✓ |\n","| advertiserIds | Advertiser IDs associated with the commitment. Maximum 1000 entries. | ○ |\n","| advertiserIdExclusions | Advertiser IDs excluded from the commitment. Maximum 1000 entries. | ○ |\n","| campaignIds | Campaign IDs associated with the commitment. Maximum 1000 entries. | ○ |\n","| campaignIdExclusions | Campaign IDs excluded from the commitment. Maximum 1000 entries. | ○ |\n","| dealIds | Deal IDs associated with the commitment. Maximum 1000 entries. | ○ |\n","| dealIdExclusions | Deal IDs excluded from the commitment. Maximum 1000 entries. | ○ |\n"],"documentType":"guide"},{"title":"Commitment","sectionHeader":{"type":2,"text":"Enumerations"},"path":"/en-us/guides/deal-management/entities/commitment","content":[],"documentType":"guide"},{"title":"Commitment","sectionHeader":{"type":3,"text":"FulfillmentLevel values"},"path":"/en-us/guides/deal-management/entities/commitment","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| LEVEL_0 | Tracking-only commitments. |\n","| LEVEL_5 | Prioritize commitment over campaign performance. |\n"],"documentType":"guide"},{"title":"Commitment","sectionHeader":{"type":3,"text":"SpendCalculationMode values"},"path":"/en-us/guides/deal-management/entities/commitment","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| MANAGER_ACCOUNT | Spend is aggregated at the manager account level. |\n","| ADVERTISER_ACCOUNT | Spend is aggregated at the advertiser account level. |\n","| CAMPAIGN | Spend is aggregated at the campaign level. |\n"],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[" CommitmentSpend provides spend tracking details for a commitment, broken down by a configurable dimension (advertiser, campaign, or deal). It reports accrued spend, spend at risk, and projected spend values, enabling advertisers to monitor their progress toward fulfilling a commitment.\n"],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":2,"text":"CommitmentSpend parameters"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| commitmentId | Identifier for the commitment spend record. | ✓ |\n","| adProduct | The ad product associated with this commitment spend. | ○ |\n","| spendDimensionType | Dimension level at which commitment spend is tracked. | ✓ |\n","| currencyCode | Currency code associated with the spend detail. | ✓ |\n","| accruedToDateTime | Timestamp for accrual spend. | ✓ |\n","| accruedSpendValue | Actual accrual spend amount in commitment currency. | ○ |\n","| spendAtRiskValue | Spend at risk amount in commitment currency. | ○ |\n","| projectedSpendValue | Projected spend amount in commitment currency. | ○ |\n"],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":3,"text":"CommitmentSpendIdentifier"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[" The composite identifier for a commitment spend record.\n"," Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| commitmentId | Commitment ID associated with the commitment. | ✓ |\n","| spendDimension | Identifiers for commitment spend detail. | ○ |\n"],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":3,"text":"SpendDimension"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[" A union type representing the dimension entity for which spend is tracked. Only one of the following fields is populated at a time.\n"," Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| advertiserAccountId | Identifier for an advertising account. | ○ |\n","| campaignId | Identifier for a campaign entity. | ○ |\n","| dealId | Identifier for a deal entity. | ○ |\n"],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":2,"text":"Enumerations"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":3,"text":"SpendDimensionType values"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| COMMITMENT | Commitment level spend detail. |\n","| ADVERTISER | Advertiser level spend detail. |\n","| CAMPAIGN | Campaign level spend detail. |\n","| DEAL | Deal level spend detail. |\n"],"documentType":"guide"},{"title":"DealAdvertiserAccess","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/deal-advertiser-access","content":[" DealAdvertiserAccess controls which Amazon DSP advertisers can target a deal. Uses a strategy-based approach where ALLOW means only listed advertisers can target, and BLOCK means listed advertisers cannot target.\n"],"documentType":"guide"},{"title":"DealAdvertiserAccess","sectionHeader":{"type":2,"text":"DealAdvertiserAccess parameters"},"path":"/en-us/guides/deal-management/entities/deal-advertiser-access","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealAdvertiserAccessId | A unique identifier for the access record. | □ |\n","| adProduct | The ad product associated with this access record. | ○ |\n","| advertisingDealId | Reference to the associated advertising deal. | ✓ |\n","| strategy | The access strategy. ALLOW means advertisers in the list can target this deal (allowed list). BLOCK means advertisers in the list cannot target this deal (blocked list). | ✓ |\n","| createdDateTime | Timestamp when the access record was first created. | ○ |\n","| lastUpdatedDateTime | Timestamp when the access record was last modified. | ○ |\n"],"documentType":"guide"},{"title":"DealAdvertiserAccess","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/deal-advertiser-access","content":[],"documentType":"guide"},{"title":"DealAdvertiserAccess","sectionHeader":{"type":3,"text":"AdvertiserAccessStrategy values"},"path":"/en-us/guides/deal-management/entities/deal-advertiser-access","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| ALLOW | Advertisers in the list CAN target this deal. All other advertisers are blocked. |\n","| BLOCK | Advertisers in the list CANNOT target this deal. All other advertisers are allowed. |\n"],"documentType":"guide"},{"title":"DealAdvertiserAccessEntry","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/deal-advertiser-access-entry","content":[" A DealAdvertiserAccessEntry is an individual advertiser entry in the access list of a deal. Supports pagination over large advertiser lists.\n"],"documentType":"guide"},{"title":"DealAdvertiserAccessEntry","sectionHeader":{"type":2,"text":"DealAdvertiserAccessEntry parameters"},"path":"/en-us/guides/deal-management/entities/deal-advertiser-access-entry","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealAdvertiserAccessEntryId | A unique identifier for this access entry. | □ |\n","| adProduct | The ad product associated with this access entry. | ○ |\n","| dealAdvertiserAccessId | Reference to the associated deal advertiser access record. | ✓ |\n","| advertiserId | Reference to the advertiser granted or denied access. | ✓ |\n"],"documentType":"guide"},{"title":"DealAvails","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/deal-avails","content":[" DealAvails provides bid opportunity counts for an advertising deal over the last 7 days, aggregated by selected attributes. An optional targeting expression filters the eligible avails count.\n"],"documentType":"guide"},{"title":"DealAvails","sectionHeader":{"type":2,"text":"DealAvails parameters"},"path":"/en-us/guides/deal-management/entities/deal-avails","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealAvailsId | A unique identifier for the deal avails record. | □ |\n","| advertisingDealId | The advertising deal this avails record belongs to. | ✓ |\n","| inventoryType | Inventory type attribute. Null when not sliced by inventory type. | ○ |\n","| creativeSize | Creative size attribute (width x height in DIPS). | ○ |\n","| supplierSellerId | The supplier seller associated with this avails record. | ○ |\n","| audienceId | Audience segment for this avails slice. | ○ |\n","| appId | App for this avails slice. | ○ |\n","| domainEntry | Domain for this avails slice. | ○ |\n","| deviceType | Device type for this avails slice. | ○ |\n","| countryCode | Country code (ISO 3166-1 alpha-2) for this avails slice. | ○ |\n","| groupByAttributes | Attributes to break results down by. When empty or omitted, results are aggregated to one entry per deal. | ○ |\n","| eligibleAvailsTargeting | Optional targeting filter for the eligibleAvails count. Does not affect totalAvails or which attribute rows are returned. | ◐ |\n","| totalAvails | Total bid opportunities over the last 7 days for this deal, including bids, no-bids, and punts. Not filtered by the EligibleAvailsTargeting. | □ |\n","| eligibleAvails | Bid opportunities over the last 7 days eligible for bidding (bids and no-bids, excluding punts). Filtered by the EligibleAvailsTargeting when provided. | □ |\n"],"documentType":"guide"},{"title":"DealAvails","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/deal-avails","content":[],"documentType":"guide"},{"title":"DealAvails","sectionHeader":{"type":3,"text":"EligibleAvailsTargeting"},"path":"/en-us/guides/deal-management/entities/deal-avails","content":[" Targeting that filters eligible avails. All targeting dimensions are AND'd together. Within a dimension, entries are composed via groupId. The combined total of entries across all targeting dimensions must not exceed 1000.\n"," Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| audienceTargetingEntries | Audience targeting entries. Entries are grouped by groupId. Within a group, audiences are OR'd (union). Across included groups, groups are AND'd (intersection). | ◐ |\n","| locationTargetingEntries | Location targeting entries. | ◐ |\n","| deviceTypeTargetingEntries | Device type targeting entries. | ◐ |\n","| appTargetingEntries | App targeting entries. | ◐ |\n","| domainTargetingEntries | Domain targeting entries. | ◐ |\n","| inventoryTypeTargetingEntries | Inventory type targeting entries. | ◐ |\n","| creativeSizeTargetingEntries | Creative size targeting entries. | ◐ |\n","| supplierSellerTargetingEntries | Supplier seller targeting entries. | ◐ |\n"," Each targeting entry structure contains the following common fields:\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| (target reference) | The target to include or exclude (audience, location, device type, etc.). | ✓ |\n","| groupId | Identifies the group this entry belongs to. Entries sharing the same groupId are OR'd together. | ✓ |\n","| negative | When true, this entry belongs to a negative (exclusion) group. Defaults to false when omitted. | ○ |\n"],"documentType":"guide"},{"title":"DealPerformance","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/deal-performance","content":[" DealPerformance provides performance metrics for a deal, including bid activity, spend, impressions, and engagement metrics.\n"],"documentType":"guide"},{"title":"DealPerformance","sectionHeader":{"type":2,"text":"DealPerformance parameters"},"path":"/en-us/guides/deal-management/entities/deal-performance","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealPerformanceId | A unique identifier for the performance record. | □ |\n","| advertisingDealId | Reference to the associated advertising deal. | ✓ |\n","| bidRequests | The volume of bids with this deal ID that are eligible for the Amazon DSP. | ○ |\n","| bidResponses | The number of bid responses sent back to SSP or publisher for the applicable deal ID. | ○ |\n","| recognizedBids | The number of bid requests which include a recognized deal ID. | ○ |\n","| availsTotal | The total number of impression opportunities. | ○ |\n","| availsByDeviceType | A list of avails broken down by device type. | ◐ |\n","| totalSpend | The total amount spent on the deal over the period of time specified. | ○ |\n","| averageCpm | Historical cost per thousand impressions over the period of time specified. | ○ |\n","| totalImpressions | The number of times an advertisement was displayed. | ○ |\n","| viewableImpressions | The number of impressions that were viewable. | ○ |\n","| measurableImpressions | The number of impressions that were measurable. | ○ |\n","| completionCount | The number of times a video or audio ad is completed. | ○ |\n","| clickthroughCount | The number of times an ad is clicked. | ○ |\n","| conversionCount | The number of times an impression resulted in an action. | ○ |\n"],"documentType":"guide"},{"title":"DealPerformance","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/deal-performance","content":[],"documentType":"guide"},{"title":"DealPerformance","sectionHeader":{"type":3,"text":"AvailsForDeviceType"},"path":"/en-us/guides/deal-management/entities/deal-performance","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| deviceType | The device type. | ✓ |\n","| impressionOpportunities | The number of impression opportunities per day per device. | ✓ |\n"],"documentType":"guide"},{"title":"DealPlanningMetrics","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/deal-planning-metrics","content":[" DealPlanningMetrics provides planning metrics for a deal, including viewability rates, video completion rates, and cost metrics.\n"],"documentType":"guide"},{"title":"DealPlanningMetrics","sectionHeader":{"type":2,"text":"DealPlanningMetrics parameters"},"path":"/en-us/guides/deal-management/entities/deal-planning-metrics","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealPlanningMetricsId | A unique identifier for the planning metrics record. | □ |\n","| advertisingDealId | Reference to the associated advertising deal. | ✓ |\n","| viewRate | Rate of ad impressions that were measured as viewable. | ○ |\n","| measuredRate | Rate of impressions that were measurable for viewability. | ○ |\n","| videoCompletionRate | Rate of video ad views that were viewed to completion. | ○ |\n","| clickThroughRate | Rate of delivered ad impressions that users clicked on. | ○ |\n","| effectiveCPM | Effective CPM actually cleared for impressions. | ○ |\n","| viewableCPM | Average CPM actually cleared for impressions that were deemed in view. | ○ |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/inventory-group","content":[" An Inventory Group is a grouping of advertising deals that can be applied to ad groups for campaign targeting. Represents a curated collection of programmatic deals bundled together to simplify deal management and targeting.\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":2,"text":"Inventory Group parameters"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| inventoryGroupId | Unique identifier for the inventory group. | □ |\n","| name | The name of the inventory group. | ✓ |\n","| description | Optional description of the inventory group. Provides additional context about the deals included and intended use. | ○ |\n","| inventoryType | The type of inventory/media in this group. Determines what creative formats can be used when targeting this inventory group. | ✓ |\n","| curationSourceType | The type of curation source for this inventory group. Indicates how the inventory group was created and by whom. Defaults to ADVERTISER_CURATED if not provided and is immutable. | ○ |\n","| curationSourceSettings | Configuration settings specific to the curation source type. When curationSourceType is AMAZON_CURATED_AGENT, the AutomaticDealSelectionControls variant is used to define deal eligibility preferences. | ○ |\n","| adProduct | The ad product this inventory group is associated with. | ○ |\n","| advertisingDealIds | Collection of advertising deal IDs included in this inventory group. | ○ |\n","| createdByAccountId | The account that created this inventory group. | ○ |\n","| createdInRegion | The region where this inventory group was created. | ○ |\n","| creationDateTime | The date and time the inventory group was created. | □ |\n","| lastUpdatedDateTime | The date and time the inventory group was last updated. | □ |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":[],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":3,"text":"CurationSourceType values"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| AMAZON_CURATED_AGENT | Inventory group was created or recommended through the Automatic Deal Selection system, which uses machine learning to identify optimal deal combinations. |\n","| AMAZON_CURATED | Inventory group was manually curated by Amazon. |\n","| ADVERTISER_CURATED | Inventory group was manually curated by the advertiser or agency. |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":3,"text":"CurationSourceSettings"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":[" A union type containing configuration settings specific to a curation source type. Each variant contains settings applicable to a particular curation mode. Currently, only inventory groups with curationSourceType of AMAZON_CURATED_AGENT support these settings.\n","| Variant | Description |\n","\\| --- \\| --- \\|\n","| AutomaticDealSelectionControls | Advertiser-configured preferences that constrain which deals the automated recommendation system can recommend. |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":3,"text":"AutomaticDealSelectionControls"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":[" Advertiser-configured preferences that constrain which deals the automated recommendation system can recommend. These preferences filter the candidate deal pool before recommendations are generated.\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| adGroupId | The ad group associated with these automatic deal selection controls. | ✓ |\n","| dealTypePreference | Preference controlling which types of deals are eligible for automated recommendations based on their marketplace listing status. When not set, all deal types are eligible. | ○ |\n","| supplyAllowlist | Configuration for which supply sources (exchanges/SSPs) are permitted when generating deal recommendations. When not set, all supply sources are permitted. | ○ |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":3,"text":"DealTypePreference values"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| ALL | All deal types are eligible regardless of marketplace listing status. |\n","| EXCLUDE_PUBLICLY_AVAILABLE | Only private deals are eligible. Publicly available deals are excluded. |\n","| PUBLICLY_AVAILABLE_ONLY | Only publicly available deals are eligible. Private deals are excluded. |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":3,"text":"SupplyAllowlist"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":[" A union type defining which supply sources are permitted for deal recommendations.\n","| Variant | Description |\n","\\| --- \\| --- \\|\n","| CustomSources | Only the specified supply sources are permitted. Requires a list of supplySourceIds (1–1000). |\n","| AmazonOwnedAndOperated | Only deals from Amazon owned and operated supply sources are permitted. |\n","| OpenInternet | Only deals from open internet supply sources are permitted. |\n"],"documentType":"guide"},{"title":"Label","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/label","content":[" A Label is a user-defined tag for organizing and categorizing DSP objects such as deals and inventory groups. Labels are global - once created, they are visible across the account and can be applied to any supported object type.\n"],"documentType":"guide"},{"title":"Label","sectionHeader":{"type":2,"text":"Label parameters"},"path":"/en-us/guides/deal-management/entities/label","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| labelId | Unique identifier for the label. Server-generated with AMZNLBL prefix (e.g., AMZNLBL17F28BCKZST2KW58JG7). | □ |\n","| adProduct | The ad product associated with this label. | ○ |\n","| labelName | Display name of the label. Must be unique. Maximum 255 characters. | ✓ |\n","| state | The state of the label. Supported value: ENABLED. | ✓ |\n","| creationDateTime | The date and time the label was created. | □ |\n","| lastUpdatedDateTime | The date and time the label was last updated. | □ |\n"],"documentType":"guide"},{"title":"Label","sectionHeader":{"type":2,"text":"Supported operations"},"path":"/en-us/guides/deal-management/entities/label","content":[],"documentType":"guide"},{"title":"Label","sectionHeader":{"type":3,"text":"Query Labels"},"path":"/en-us/guides/deal-management/entities/label","content":[" Retrieve labels, filtered by the type of object they are associated with.\n","Endpoint: POST /adsApi/v1/query/labels/dsp - Required headers: Amazon-Ads-AccountId, Amazon-Ads-ClientId - Filters: - Filter priority: labelIdFilter > labelNameFilter > labelObjectTypeFilter (only one applied) - Pagination: maxResults (default 100, max 1000) + nextToken - Sort: Results are returned alphabetically by label name (case-insensitive)\n"],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/label-object-association","content":[" A Label Object Association links a label to an advertising object, enabling cross-entity organizational grouping. A single label can be associated with multiple objects across different object types, such as deals and inventory groups.\n"],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":{"type":2,"text":"Label Object Association parameters"},"path":"/en-us/guides/deal-management/entities/label-object-association","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| labelObjectAssociationId | Unique identifier for the label-to-object association. Maximum 255 characters. | □ |\n","| adProduct | The ad product associated with this label-object association. | ○ |\n","| labelId | The identifier of the label being associated with the object. | ✓ |\n","| labelObjectId | The identifier of the advertising object this label is applied to (e.g., a deal ID, ad group ID). | ✓ |\n","| labelObjectType | The type of advertising object this label is applied to. | ✓ |\n","| creationDateTime | The date and time the association was created. | □ |\n","| lastUpdatedDateTime | The date and time the association was last updated. | □ |\n"],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/label-object-association","content":[],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":{"type":3,"text":"LabelObjectType values"},"path":"/en-us/guides/deal-management/entities/label-object-association","content":[" The types of advertising objects that labels can be applied to.\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| AD_GROUP | An ad group within a campaign. |\n","| CAMPAIGN | A campaign managed through campaign management. |\n","| DEAL | An advertising deal in the deals domain. |\n","| INVENTORY_GROUP | An inventory group for supply management in the deals domain. |\n"],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":{"type":2,"text":"Supported operations"},"path":"/en-us/guides/deal-management/entities/label-object-association","content":[],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":{"type":3,"text":"Query Label Object Associations"},"path":"/en-us/guides/deal-management/entities/label-object-association","content":[" Retrieve label-object associations, filtered by label or by the object they are associated with.\n","Endpoint: POST /adsApi/v1/query/labelObjectAssociations - Required headers: Amazon-Ads-AccountId, Amazon-Ads-ClientId - Filters: - Pagination: maxResults (default 100, max 5000) + nextToken\n"],"documentType":"guide"},{"title":"Publisher","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/publisher","content":[" A Publisher represents a business entity that owns and/or operates the apps, sites, or video streams where ads are displayed. Identified by domain or app_id from the bid request.\n"],"documentType":"guide"},{"title":"Publisher","sectionHeader":{"type":2,"text":"Publisher parameters"},"path":"/en-us/guides/deal-management/entities/publisher","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| publisherId | The unique identifier of the publisher (Long serialized as String). | □ |\n","| name | Normalized publisher name. NULL when isConfidential is true. | ○ |\n","| rootDomain | Root domain from ads.txt. PSL+1 root. NULL for app-only publishers. | ○ |\n","| publisherOwnerId | The identifier of the company that owns the content rights of this publisher. | ○ |\n","| isConfidential | Whether identity is confidential. | ○ |\n","| isActive | Whether this publisher is active. | ○ |\n","| adProduct | The ad product associated with this publisher. | ✓ |\n"],"documentType":"guide"},{"title":"Seller","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/seller","content":[" A Seller represents a business entity with rights to sell the inventory of a Publisher, holding accounts with Suppliers. Exchange-agnostic: same Seller record regardless of how many exchanges carry its inventory.\n"],"documentType":"guide"},{"title":"Seller","sectionHeader":{"type":2,"text":"Seller parameters"},"path":"/en-us/guides/deal-management/entities/seller","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| sellerId | The unique identifier of the seller (Long serialized as String). | □ |\n","| name | Display name. Normalized across all advertising systems. NULL when isConfidential is true. | ○ |\n","| sellerParentId | The identifier of the parent holding company that owns this seller. | ○ |\n","| isConfidential | Whether identity is confidential per IAB sellers.json. | ○ |\n","| isActive | Whether this seller is currently active. | ○ |\n","| adProduct | The ad product associated with this seller. | ✓ |\n"],"documentType":"guide"},{"title":"Supplier","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier","content":[" A Supplier represents an exchange or SSP that provides deal inventory to Amazon DSP.\n"],"documentType":"guide"},{"title":"Supplier","sectionHeader":{"type":2,"text":"Supplier parameters"},"path":"/en-us/guides/deal-management/entities/supplier","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierId | The unique identifier of the supplier (Long serialized as String). | □ |\n","| supplierName | Canonical display name of the Supplier. Normalized across systems. | ✓ |\n","| domain | Corporate SCO domain in sellers.json supply chain object (e.g., pubmatic.com). | ○ |\n","| brandId | The brand associated with this Supplier. | ○ |\n","| owner | Parent owner company name of the Supplier. Defaults to brand name if unspecified. | ○ |\n","| type | Classification of the integration type of the supplier. | ○ |\n","| integrationType | How the supplier connects to ADSP. | ○ |\n","| state | Lifecycle state of the supplier. | ○ |\n","| isActive | Whether this supplier is currently active. | ○ |\n","| mediaTypes | Media types supported (e.g., AUDIO, VIDEO, BANNER, NATIVE). | ○ |\n","| environments | Delivery environments supported (e.g., MOBILE_APP, WEB, CTV). | ○ |\n","| exchangeName | Legacy exchange identifier (e.g., RUBICON). | ○ |\n","| countries | ISO 3166-1 alpha-2 country codes where supplier operates. | ○ |\n","| previousSupplierId | If migrated from a previous supplier, references the previous Supplier entity. | ○ |\n","| extensions | Extended metadata as a JSON blob (e.g., exchange IDs, IAB identifiers). | ○ |\n","| description | Human-readable description of the supplier. | ○ |\n","| adProduct | The ad product associated with this supplier. | ✓ |\n"],"documentType":"guide"},{"title":"SupplierAdProduct","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-ad-product","content":[" A SupplierAdProduct represents a purchasable advertising product offered by a supplier, with associated constraints and configurations for deal creation.\n"],"documentType":"guide"},{"title":"SupplierAdProduct","sectionHeader":{"type":2,"text":"SupplierAdProduct parameters"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierAdProductId | The supplier ad product unique identifier. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| name | The name of the supplier ad product. | ✓ |\n","| supplierId | The supplier for this supplier ad product. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination for this supplier ad product. | ○ |\n","| supplierPublisherId | Unique publisher id. | ○ |\n","| dealType | The deal type for this supplier ad product. | ✓ |\n","| priceType | The price type for this supplier ad product. | ○ |\n","| creativeRequirements | Creative requirements for this supplier ad product. | ◐ |\n","| constraints | Publisher defined constraints for deal creation from this supplier ad product. | ◐ |\n","| supplierAdProductExtension | Supplier-specific information related to the associated supplier for the supplier ad product. | ◐ |\n","| supplierAdProductType | The proposal type for this supplier ad product. | ○ |\n","| customPublisherDescription | The unstructured name of this product, similar to customPublisherDescription in AdvertisingDeal. | ○ |\n","| countryConfigurations | Supported countries for this supplier ad product. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierAdProduct","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product","content":[],"documentType":"guide"},{"title":"SupplierAdProduct","sectionHeader":{"type":3,"text":"CountryConfiguration"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| country | The country code. | ✓ |\n","| currency | The currency code. | ○ |\n","| timezone | The timezone. | ○ |\n"],"documentType":"guide"},{"title":"SupplierAdProductPrice","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-ad-product-price","content":[" SupplierAdProductPrice follows the resource pattern for implementing an RPC call. Calling the create action on this resource will fetch the price for a SupplierAdProduct for the configuration provided in supplierAdProductPriceDescription at the time that the query was performed.\n"],"documentType":"guide"},{"title":"SupplierAdProductPrice","sectionHeader":{"type":2,"text":"SupplierAdProductPrice parameters"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product-price","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierAdProductPriceDescription | The description of the supplier ad product price request parameters. | ◐ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| price | The total price of a proposed deal configuration. This includes the sum of all prices within itemizedPrice. | ✓ |\n","| itemizedPrice | Itemized breakdown of the price components. | □ |\n","| lastUpdatedProductPriceDateTime | The timestamp at which the rate was calculated. | □ |\n"],"documentType":"guide"},{"title":"SupplierAdProductPrice","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product-price","content":[],"documentType":"guide"},{"title":"SupplierAdProductPrice","sectionHeader":{"type":3,"text":"SupplierAdProductPriceDescription"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product-price","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierId | The proposal supplier ID. | ○ |\n","| supplierProposalDestinationId | The proposal supplier proposal destination ID. | ○ |\n","| supplierAdProductPriceDescriptionType | The type of supplier ad product price, such as AMAZON_MEDIA. | ✓ |\n","| supplierAdProductId | The supplier ad product ID. | ✓ |\n","| startDateTime | Start datetime for rate calculation. | ✓ |\n","| endDateTime | End datetime for rate calculation. | ○ |\n","| creativeRequirements | Creative requirements for this supplier ad product price. | ◐ |\n","| advertiserAccountId | The advertiser ID. A required field since advertiserId may impact the price returned. | ✓ |\n","| countries | The country or countries for rate calculation. | ○ |\n","| targeting | Supplier targeting configuration. | ◐ |\n","| deliveryIntent | Delivery control settings including frequency caps and goals. Used by Amazon Media to adjust the quoted rate based on delivery constraints. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierAdProductPrice","sectionHeader":{"type":3,"text":"PriceComponent"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product-price","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| priceComponentType | Type of the price component. Determines if this component pertains to seller price or a third party fee. | ✓ |\n","| price | Price value for this component. | □ |\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| SUPPLIER_PRICE | The price component pertains to the seller price. |\n","| THIRD_PARTY_DATA_TARGETING_FEE | The price component pertains to a third party data targeting fee. |\n"],"documentType":"guide"},{"title":"SupplierProposal","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposal","content":[" A SupplierProposal is a deal proposal consisting of a collection of proposed deals configured from the publisher products of a supplier. A proposal may only have 15 associated proposed deals.\n"],"documentType":"guide"},{"title":"SupplierProposal","sectionHeader":{"type":2,"text":"SupplierProposal parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposal","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposalId | The unique identifier for the proposal. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierId | The supplier identifier. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination identifier. | ○ |\n","| externalProposalId | The external proposal identifier from the supplier system. | ○ |\n","| supplierProposalExtension | Attributes that are specific to a supplier. | ◐ |\n","| status | The current status of the proposal. | ✓ |\n","| state | The lifecycle state of the proposal, such as DRAFT, PROPOSED, or ARCHIVED. Distinct from status, which tracks the workflow progression. | ○ |\n","| stateReason | Additional context for the current state, such as the reason for archiving. | ○ |\n","| countries | The country this proposal is located. | ○ |\n","| name | The user provided proposal name. | ✓ |\n","| notes | User provided notes for this proposal. | ○ |\n","| startDateTime | The proposal start date. | ○ |\n","| endDateTime | The proposal end date. | ○ |\n","| supplierProposalType | The type of the proposal. | ○ |\n","| version | The version number of the proposal. | ✓ |\n","| creationDateTime | The date time that the proposal was created. | □ |\n","| lastUpdatedDateTime | The date time that the proposal was last updated. | □ |\n","| supplierProposedDealIds | The proposed deals associated with this proposal. | ○ |\n","| advertiserAccountId | The ADSP advertiser ID for this proposal. When null, the proposal is treated as a manager account level proposal. | ○ |\n"],"documentType":"guide"},{"title":"SupplierProposal","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-proposal","content":[],"documentType":"guide"},{"title":"SupplierProposal","sectionHeader":{"type":3,"text":"SupplierProposalStatus"},"path":"/en-us/guides/deal-management/entities/supplier-proposal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| status | Status of the proposal. | ✓ |\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| CANCELLED | A proposal that was previously submitted to a supplier, but was marked as canceled by the buyer before it was approved. |\n","| DRAFT | A proposal that is in draft status, meaning that it may include changes that have not been submitted to a supplier. |\n","| COUNTER_DRAFT | A proposal that is undergoing negotiation with a supplier, where the buyer has begun draft changes to a received proposal but has not yet submitted them. |\n","| PENDING | The buyer has submitted a proposal to a supplier and is waiting for the supplier to take action. |\n","| REJECTED | A proposal has been rejected by the supplier and negotiation has ended. No further changes may be done. |\n","| REVIEWED | All proposed deals related to this proposal have been reviewed and further action by the buyer is required. |\n","| REVIEWED_PARTIAL | Some proposed deals in this proposal have been approved, while some are in PENDING status. |\n","| SUPPLIER_REVIEWED | The supplier has reviewed the proposals and are awaiting buyer action. |\n"],"documentType":"guide"},{"title":"SupplierProposalDestination","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposal-destination","content":[" A SupplierProposalDestination represents a destination configuration for supplier proposals. It defines the name, description, and allowed countries for a proposal destination.\n"],"documentType":"guide"},{"title":"SupplierProposalDestination","sectionHeader":{"type":2,"text":"SupplierProposalDestination parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposal-destination","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposalDestinationId | The identifier ID for this supplier proposal destination. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierProposalDestinationName | The name for the supplier proposal destination. | ✓ |\n","| description | The description of the supplier proposal destination. | ○ |\n","| countries | The list of ISO 3166-1 alpha-2 formatted country codes allowed for the supplier proposal destination. Maximum of 49 entries. | ○ |\n"],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[" A SupplierProposedDeal represents a deal configuration submitted to a supplier for approval. Proposed deals are associated with a supplier proposal and contain the deal terms, targeting, and creative requirements.\n"],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":{"type":2,"text":"SupplierProposedDeal parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealId | The unique identifier for the proposed deal. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierProposalId | The unique ID of the associated proposal for this proposed deal. Only 15 proposed deals may be associated with a proposal. | ✓ |\n","| dealName | The name of the deal. | ✓ |\n","| description | The description of the deal. | ○ |\n","| terms | The terms for this deal. | ◐ |\n","| startDateTime | The delivery start date. | ✓ |\n","| endDateTime | The delivery end date. | ✓ |\n","| supplierProposedDealExtension | Attributes that are specific to a supplier. The extension type is defined by supplierProposedDealType. | ◐ |\n","| supplierProposedDealType | The proposed deal type. | ○ |\n","| notes | User provided notes for this proposed deal. | ○ |\n","| supplierId | The supplier ID for this deal. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination id for this deal. | ○ |\n","| dealType | The deal type for this proposed deal. | ✓ |\n","| externalDealId | The deal ID of the supplier for this proposed deal. Does not get created until the deal is submitted. | ○ |\n","| advertisingDealId | The ADSP deal ID for this proposed deal. Does not get created until the deal is submitted. | ○ |\n","| supplierPublisherId | Unique publisher id. | ○ |\n","| countries | The country for the proposed deal. | ○ |\n","| dealStatus | The current status of the proposed deal. | ◐ |\n","| state | The lifecycle state of the proposed deal, such as DRAFT, PROPOSED, or ARCHIVED. Distinct from dealStatus, which tracks the workflow progression. | ○ |\n","| stateReason | Additional context for the current state, such as the reason for archiving. | ○ |\n","| isBuyerApproved | Whether the buyer has approved the proposed deal. | ○ |\n","| isSupplierApproved | Whether the seller has approved the proposed deal. | ○ |\n","| version | The version number of the proposed deal. | ○ |\n","| proposalVersion | The proposal version corresponding to this proposed deal version. | ○ |\n","| submissionFailure | Metadata object containing information on why a proposed deal failed to finalize when submitted to the supplier. | ◐ |\n","| creationDateTime | The date time that the proposed deal was created. | ✓ |\n","| lastUpdatedDateTime | The date time that the proposed deal was last updated. | ✓ |\n","| creativeRequirements | Creative requirements for this proposed deal. | ◐ |\n","| deliveryIntent | Delivery control settings for this proposed deal. | ◐ |\n","| supplierAdProductId | The supplier ad product unique identifier. | ○ |\n","| customPublisherDescription | Custom description of the publisher providing inventory for this deal. | ○ |\n","| targeting | Supplier targeting configuration. | ◐ |\n","| advertiserAccountId | The ADSP advertiser ID for this proposal. When null, the proposal is treated as a manager account level proposal. | ○ |\n","| forecast | Forecast summary returned by the supplier for this proposed deal, such as available impressions. | ○ |\n"],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":{"type":3,"text":"SupplierProposedDealStatus"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealStatus | Status of the proposed deal. | ✓ |\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| APPROVED | The deal has been submitted and approved by the supplier and added to the ADSP for use. |\n","| APPROVED_CURRENT | The deal is the current approved version after a revision was approved. |\n","| APPROVED_PENDING_REGISTRATION | The deal has been approved by the supplier, but is in the process of being made targetable in the ADSP. |\n","| CANCELLED | The deal has been canceled in both ADSPs and the systems of the supplier. |\n","| DRAFT | The deal has not yet been submitted to the supplier and may be edited. |\n","| DRAFT_REVISION | The deal is a draft revision of an approved deal and may be edited. |\n","| COUNTER_DRAFT | The deal is a counter draft. |\n","| ERROR | Something has gone wrong during the submission of the deal and requires intervention to recover. |\n","| PENDING | The deal is waiting to be updated asynchronously and is not ready to be targeted. |\n","| REJECTED | The deal was rejected for approval by the supplier, and may be edited before being resubmitted. |\n","| REJECTED_REVISED | A previously rejected deal that has since been modified and is ready to be resubmitted. |\n","| REVISED | The deal is a previous version that has been superseded by a newer approved revision. |\n","| REVISION_APPROVED_PENDING_REGISTRATION | The revision has been approved by the supplier, but is in the process of being made targetable. |\n","| SELLER_RESPONDED | The seller responded with a new deal. Waiting for the decision of the buyer. |\n","| SUBMITTED | The deal is currently being evaluated for approval by the supplier. |\n","| SUBMITTED_REVISION | The deal revision is currently being evaluated for approval by the supplier. |\n","| SUBMITTED_TERMINATE | The deal is currently being evaluated for termination by the supplier. |\n","| TERMINATED | The deal has been terminated by the supplier and ingested into the ADSP. |\n","| TERMINATED_PENDING_REGISTRATION | The deal has been terminated by the supplier, but is in the process of being reflected in the ADSP. |\n"],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":{"type":3,"text":"SubmissionFailure"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| traceId | Trace identifier for the submission failure. | ○ |\n","| failures | List of submission failure details. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":{"type":3,"text":"SubmissionFailureField"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| code | The failure code. | ○ |\n","| message | The failure message. | ○ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealForecast","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-forecast","content":[" SupplierProposedDealForecast follows the resource pattern for implementing an RPC call. Calling the create action on this resource will generate a forecast for a supplier based on the configuration provided in supplierProposedDealForecastDescription.\n"],"documentType":"guide"},{"title":"SupplierProposedDealForecast","sectionHeader":{"type":2,"text":"SupplierProposedDealForecast parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-forecast","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealForecastDescription | The description of the supplier forecast request parameters. | ◐ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| forecastSummary | Forecast summary metrics. | ◐ |\n","| creationDateTime | The timestamp at which the forecast was generated. | ✓ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealForecast","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-forecast","content":[],"documentType":"guide"},{"title":"SupplierProposedDealForecast","sectionHeader":{"type":3,"text":"SupplierProposedDealForecastDescription"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-forecast","content":[" The request body includes a subset of SupplierProposedDeal fields relevant to generating a forecast.\n"," Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealName | The name of the deal. | ✓ |\n","| description | The description of the deal. | ○ |\n","| terms | The terms for this deal. | ◐ |\n","| startDateTime | The delivery start date. | ✓ |\n","| endDateTime | The delivery end date. | ✓ |\n","| supplierProposedDealExtension | Attributes that are specific to a supplier. The extension type is defined by supplierProposedDealType. | ◐ |\n","| supplierProposedDealType | The proposed deal type. | ○ |\n","| notes | User provided notes for this proposed deal. | ○ |\n","| supplierId | The supplier ID for this deal. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination id for this deal. | ○ |\n","| dealType | The deal type for this proposed deal. | ✓ |\n","| countries | The country for the proposed deal. | ○ |\n","| state | The lifecycle state of the proposed deal, such as DRAFT, PROPOSED, or ARCHIVED. Distinct from dealStatus, which tracks the workflow progression. | ○ |\n","| stateReason | Additional context for the current state, such as the reason for archiving. | ○ |\n","| creativeRequirements | Creative requirements for this proposed deal. | ◐ |\n","| deliveryIntent | Delivery control settings for this proposed deal. | ◐ |\n","| supplierAdProductId | The supplier ad product unique identifier. | ○ |\n","| customPublisherDescription | Custom description of the publisher providing inventory for this deal. | ○ |\n","| targeting | Supplier targeting configuration. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealForecast","sectionHeader":{"type":3,"text":"ImpressionsForecastSummary"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-forecast","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| availableImpressions | The total impressions available for purchase. | ✓ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealHistoricalVersion","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-historical-version","content":[" A SupplierProposedDealHistoricalVersion captures a historical version of a proposed deal, preserving past states differentiated by version number.\n"],"documentType":"guide"},{"title":"SupplierProposedDealHistoricalVersion","sectionHeader":{"type":2,"text":"SupplierProposedDealHistoricalVersion parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-historical-version","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealHistoricalVersionId | Composite identifier for proposed deal historical version. | ◐ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierProposalId | The unique ID of the associated proposal for this proposed deal. | ✓ |\n","| dealName | The name of the deal. | ✓ |\n","| description | The description of the deal. | ○ |\n","| terms | The terms for this deal. | ◐ |\n","| startDateTime | The delivery start date. | ✓ |\n","| endDateTime | The delivery end date. | ✓ |\n","| supplierProposedDealExtension | Attributes that are specific to a supplier. The extension type is defined by supplierProposedDealType. | ◐ |\n","| supplierProposedDealType | The proposed deal type. | ○ |\n","| notes | User provided notes for this proposed deal. | ○ |\n","| supplierId | The supplier ID for this deal. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination id for this deal. | ○ |\n","| dealType | The deal type for this proposed deal. | ✓ |\n","| externalDealId | The deal ID of the supplier for this proposed deal. | ○ |\n","| advertisingDealId | The ADSP deal ID for this proposed deal. | ○ |\n","| countries | The country for the proposed deal. | ○ |\n","| dealStatus | The current status of the proposed deal. | ✓ |\n","| state | The lifecycle state of the proposed deal, such as DRAFT, PROPOSED, or ARCHIVED. Distinct from dealStatus, which tracks the workflow progression. | ○ |\n","| stateReason | Additional context for the current state, such as the reason for archiving. | ○ |\n","| isBuyerApproved | Whether the buyer has approved the proposed deal. | ○ |\n","| isSupplierApproved | Whether the seller has approved the proposed deal. | ○ |\n","| version | The version number of the proposed deal. | ○ |\n","| proposalVersion | The proposal version corresponding to this proposed deal version. | ○ |\n","| submissionFailure | Metadata object containing information on why a proposed deal failed to finalize. | ◐ |\n","| creationDateTime | The date time that the proposed deal was created. | □ |\n","| lastUpdatedDateTime | The date time that the proposed deal was last updated. | □ |\n","| creativeRequirements | Creative requirements for this proposed deal. | ◐ |\n","| deliveryIntent | Delivery control settings for this proposed deal. | ◐ |\n","| supplierAdProductId | The supplier ad product unique identifier. | ○ |\n","| customPublisherDescription | Custom description of the publisher providing inventory for this deal. | ○ |\n","| targeting | Supplier targeting configuration. | ◐ |\n","| advertiserAccountId | The ADSP advertiser ID for this proposal. When null, the proposal is treated as a manager account level proposal. | ○ |\n","| supplierPublisherId | Unique publisher id. | ○ |\n","| forecast | Forecast summary returned by the supplier for this proposed deal, such as available impressions. | ○ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealHistoricalVersion","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-historical-version","content":[],"documentType":"guide"},{"title":"SupplierProposedDealHistoricalVersion","sectionHeader":{"type":3,"text":"SupplierProposedDealHistoricalVersionIdentifier"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-historical-version","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealId | The proposed deal identifier. | ✓ |\n","| version | The version number of the proposed deal. | ✓ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealRevision","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-revision","content":[],"documentType":"guide"},{"title":"SupplierProposedDealRevision","sectionHeader":{"type":2,"text":"SupplierProposedDealRevision parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-revision","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealRevisionDescription | The description of the supplier proposed deal revision request parameters. | ◐ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierProposedDealId | The unique identifier for the proposed deal. | ✓ |\n","| version | The version number of the revised proposed deal. | ✓ |\n","| dealStatus | The current status of the revised proposed deal. | ✓ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealRevision","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-revision","content":[],"documentType":"guide"},{"title":"SupplierProposedDealRevision","sectionHeader":{"type":3,"text":"SupplierProposedDealRevisionDescription"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-revision","content":[" Modifiable fields for a proposed deal revision. A revision can only be created for an approved SupplierProposedDeal.\n"," Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealId | The unique identifier for the proposed deal to revise. | ✓ |\n","| dealName | The name of the deal. | ○ |\n","| description | The description of the deal. | ○ |\n","| terms | The terms for this deal. | ◐ |\n","| startDateTime | The delivery start date. | ○ |\n","| endDateTime | The delivery end date. | ○ |\n","| supplierProposedDealExtension | Attributes that are specific to a supplier. | ◐ |\n","| supplierProposedDealType | The proposed deal type. | ○ |\n","| notes | User provided notes for this proposed deal. | ○ |\n","| deliveryIntent | Delivery control settings for this proposed deal. | ◐ |\n","| state | The lifecycle state of the proposed deal, such as DRAFT, PROPOSED, or ARCHIVED. Distinct from dealStatus, which tracks the workflow progression. | ○ |\n","| stateReason | Additional context for the current state, such as the reason for archiving. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination id for this deal. | ○ |\n","| targeting | Supplier targeting configuration. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierPublisher","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-publisher","content":[" A SupplierPublisher represents a content provider that offers ad inventory through a supplier.\n"],"documentType":"guide"},{"title":"SupplierPublisher","sectionHeader":{"type":2,"text":"SupplierPublisher parameters"},"path":"/en-us/guides/deal-management/entities/supplier-publisher","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierPublisherId | The publisher identifier. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierPublisherExtension | Supplier-specific information related to the associated supplier for the publisher. The extension type is defined by supplierPublisherType. | ◐ |\n","| supplierPublisherType | The proposal type for this publisher. | ○ |\n","| supplierId | The supplier id for this publisher. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination id for this publisher. | ○ |\n","| name | The publisher name. | ○ |\n","| logos | Publisher logos. | ◐ |\n","| supportedCreatives | Creative configurations supported by this publisher. | ◐ |\n","| countryConfigurations | Supported countries for this publisher. | ◐ |\n","| dealTypes | Supported deal types. | ○ |\n","| constraints | Constraint options. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierPublisher","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-publisher","content":[],"documentType":"guide"},{"title":"SupplierPublisher","sectionHeader":{"type":3,"text":"Logo"},"path":"/en-us/guides/deal-management/entities/supplier-publisher","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| size | Logo dimensions. | ○ |\n","| type | Logo file type. | ○ |\n","| url | Logo URL. | ○ |\n"],"documentType":"guide"},{"title":"SupplierTargetItem","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-target-item","content":[" A SupplierTargetItem represents an individual targeting item that can be used when configuring supplier targeting for a proposed deal.\n"],"documentType":"guide"},{"title":"SupplierTargetItem","sectionHeader":{"type":2,"text":"SupplierTargetItem parameters"},"path":"/en-us/guides/deal-management/entities/supplier-target-item","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| id | Unique identifier for the targeting item. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| name | Name of the targeting item. | ✓ |\n","| supplierTargetType | The type of targeting for this item. | ✓ |\n","| supplierId | Supplier identifier. | ○ |\n","| supplierProposalDestinationId | Supplier proposal destination identifier. | ○ |\n","| supplierAdProductId | The supplier ad product associated with this targeting item. | ○ |\n","| countries | Countries where this targeting item is available. | ○ |\n","| category | Categories for this targeting item. | ○ |\n","| description | Description of the targeting item. | ○ |\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":null,"path":"/en-us/guides/deal-management/deal-management","content":[" The Inventory Management API provides the ability to manage the deals that buyers have negotiated with external and Amazon Owned & Operated suppliers so you can use those deals to place ads through the Amazon DSP platform.\n"," Inventory Groups are a collection of deals, and we provide an API to manage the Inventory Groups so that buyers can use those directly to target at an adGroup level.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Deal Management"},"path":"/en-us/guides/deal-management/deal-management","content":[],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Create a Deal"},"path":"/en-us/guides/deal-management/deal-management","content":[" This endpoint allows you to create a deal object matching the submitted parameters. If your deal is not autoingested to ADSP, you can manually register that in ADSP using the endpoint POST /adsApi/v1/create/advertisingDeals. \n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Update a Deal"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can update a created deal using the endpoint POST /adsApi/v1/update/advertisingDeals.\n"," A deal updated with an end date in the past will be marked as expired in ADSP. \n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get list of Deals"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can get the list of deals based on filters provided in POST /adsApi/v1/query/advertisingDeals.\n"," Deals can be filtered by their live-sports classification (sports, leagues, and broadcasters); see Live-events supply taxonomies to resolve the IDs to names.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Deal Avails"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can get real-time ad opportunities metrics for specified deals with targeting-aware calculations using endpoint POST /adsApi/v1/query/dealAvails.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Deal Planning Metrics"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can get directional average metrics for the input deals. These metrics are meant for planning purposes and not to match customer campaign performance data. Use endpoint POST /adsApi/v1/query/dealPlanningMetrics\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Deal Performance Metrics"},"path":"/en-us/guides/deal-management/deal-management","content":[" This endpoint enables you to retrieve campaign performance and supply side metrics for select deals, either submitted as a query input, or matching the submitted filters. Use endpoint POST /adsApi/v1/query/dealPerformances\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Link a deal to an `adGroup`"},"path":"/en-us/guides/deal-management/deal-management","content":[" To link an advertising deal object to an adGroup, you can create a targeting object using POST /adsApi/v1/create/targets and link that targeting object to adGroup. Select targetType =\"Inventory_Source\" with TargetDetails containing InventorySourceType=\"DEAL\".\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Live-events supply taxonomies"},"path":"/en-us/guides/deal-management/deal-management","content":[" Deals that cover live-sports supply are classified with supplyMetadata.sportsMetadata, which holds lists of sports, leagues, and broadcasters IDs (see the AdvertisingDeal entity reference). Each ID references an entry in one of three Amazon Ads Live-Events taxonomies, published as static JSON:\n","| Taxonomy | URL |\n","\\| --- \\| --- \\|\n","| Sports | https://d1bs9luyrau13z.cloudfront.net/taxonomy/sports |\n","| Leagues | https://d1bs9luyrau13z.cloudfront.net/taxonomy/leagues |\n","| Broadcasters | https://d1bs9luyrau13z.cloudfront.net/taxonomy/broadcasters |\n"," Each taxonomy is independent: an ID is only meaningful within its own taxonomy, and the same numeric value refers to different entities across taxonomies (sport 1 is American Football; league 1 is the National Football League; broadcaster 1 is Disney).\n"," Each document is a JSON object with an array keyed by taxonomy name plus a version and a lastModified timestamp. For example, the sports taxonomy:\n"," To resolve a deal's IDs to names, match each ID in sportsMetadata against the id field in the corresponding taxonomy. A deal with sportsMetadata.leagues of \\[\"1\", \"8\"] covers the National Football League and Major League Baseball.\n"," The taxonomies are stable reference data that changes infrequently. Cache the documents and refresh periodically rather than fetching them on every request; use the version field to detect changes.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Get Deal Advertiser Access"},"path":"/en-us/guides/deal-management/deal-management","content":[" To get details of which Amazon DSP advertisers can target a deal, you can use the endpoint POST /adsApi/v1/query/dealAdvertiserAccessEntries.\n"," To get the details of the access (allow or block) by advertiser ID use POST /adsApi/v1/retrieve/dealAdvertiserAccesses.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Add the Advertiser Access"},"path":"/en-us/guides/deal-management/deal-management","content":[" To add the access of an advertiser on a deal, use endpoint POST /adsApi/v1/create/dealAdvertiserAccessEntries.\n"," To create a deal advertiser access record use POST /adsApi/v1/create/dealAdvertiserAccesses. It uses a strategy-based approach where ALLOW means only listed advertisers can target, and BLOCK means listed advertisers cannot target.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Remove the advertiser access"},"path":"/en-us/guides/deal-management/deal-management","content":[" To delete advertisers from a deal advertiser access list POST /adsApi/v1/delete/dealAdvertiserAccessEntries\n"," To delete a deal advertiser access record and all associated entries POST /adsApi/v1/delete/dealAdvertiserAccesses\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Buyer Seat Management"},"path":"/en-us/guides/deal-management/deal-management","content":[" A buyer seat is an identifier exchanged between Supply-Side Platforms (SSPs) and the Amazon DSP in programmatic advertising. There are two seat types:\n","DEAL_CREATION — shared with publishers/SSPs when setting up deals, used to allowlist which buyers can bid. - SPEND_TRACKING — included in bid responses for buyer recognition and spend tracking by exchanges.\n"," Seats exist at multiple account levels, identified by the prefix of their seat ID:\n","AMZA (Advertiser) — specific to a single advertiser. Created via the Create API. - AMZN (Manager Account) — shared by all advertisers under a manager account. Auto-generated. - AMZG (Group) — shared across multiple manager accounts in a holding company group.\n"," Seats are applicable across exchanges by default.\n"," For full details on the BuyerSeat resource, see BuyerSeat entity reference.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Create Buyer Seats"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can create buyer seats for an advertiser using POST /adsApi/v1/create/buyerSeats. This creates seats for deal creation and spend tracking purposes. Seats are server-generated and unique per advertiser.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"List Buyer Seats"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can list buyer seats for an advertiser or manager account, resolved per exchange, using GET /adsApi/v1/buyerSeats. The response includes seats from all applicable account levels (advertiser, manager account, and group).\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Inventory Group Management"},"path":"/en-us/guides/deal-management/deal-management","content":[" For more details on API usage for Amazon-curated inventory groups, please refer to the Automatic Deal Selection for Inventory Groups section.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Create Inventory Group"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can create your own inventory groups by using POST /adsApi/v1/create/inventoryGroups.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Update Inventory Group "},"path":"/en-us/guides/deal-management/deal-management","content":[" You can update the inventory groups by overwriting the existing metadata using POST /adsApi/v1/update/inventoryGroups. \n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Retrieve list of Inventory Groups"},"path":"/en-us/guides/deal-management/deal-management","content":[" To get a list of inventory groups based on the sorting and filtering criteria provided in the request you can use POST /adsApi/v1/query/inventoryGroups.\n"," To retrieve Inventory Groups in bulk, use POST /adsApi/v1/retrieve/inventoryGroups.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Link an Inventory Group to an `adGroup`"},"path":"/en-us/guides/deal-management/deal-management","content":[" To link an advertising inventory group object to an adGroup, you can create a targeting object using POST /adsApi/v1/create/targets and link that targeting object to adGroup. Select targetType =\"Inventory_Source\" with TargetDetails containing InventorySourceType=\"INVENTORY_GROUP\".\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Automatic Deal Selection for Inventory Groups"},"path":"/en-us/guides/deal-management/deal-management","content":[" This section documents how to use the inventory group (IG) APIs for both Automatic Deal Selection (ADS) inventory groups and standard inventory groups.\n"," An inventory group's curationSourceType determines how it is curated. There are three values:\n","| curationSourceType | Curated by | Category |\n","\\| --- \\| --- \\| --- \\|\n","| ADVERTISER_CURATED | The advertiser or agency, manually (explicit deals) | Standard |\n","| AMAZON_CURATED | Amazon, manually | Standard |\n","| AMAZON_CURATED_AGENT | Amazon's Automatic Deal Selection (ADS) system | ADS |\n"," ADS inventory groups use the AMAZON_CURATED_AGENT curation source type. Deals are selected and managed by Amazon on your behalf and controlled through Deal Eligibility Controls (DEC), rather than being explicitly listed by the advertiser. The workflow is:\n","Create an IG with the AMAZON_CURATED_AGENT curation source type. 2. Attach the IG to the line item via the targeting API to enroll in ADS. 3. Update Deal Eligibility Controls (DEC). 4. Detach the IG from the line item to unenroll from ADS. 5. Re-enroll the IG if needed.\n"," Standard inventory groups are advertiser-managed deal packages that use the ADVERTISER_CURATED curation source type with explicit deals. (Amazon can also manually curate standard inventory groups as AMAZON_CURATED; those are system-managed and cannot be created through the public API.) This guide's standard-IG workflow covers ADVERTISER_CURATED:\n","Create an IG with the ADVERTISER_CURATED curation source type (with explicit deals). 2. Attach the IG to the line item via the targeting API. 3. Update the IG (name, deals). 4. Detach the IG from the line item.\n","| Constraint | Detail |\n","\\| --- \\| --- \\|\n","| Eligible line item types | Streaming TV (STV) Awareness only — the ad group must be Streaming TV (STREAMING_TV) and belong to an Awareness campaign (funnelStage = AWARENESS or AWARENESS_V2) |\n","| Inventory group type | Must be inventoryType: \"VIDEO\" |\n","| Curation source type | Must be AMAZON_CURATED_AGENT |\n","| Deals | advertisingDealIds must be null or empty — ADS deals are system-managed |\n","| adGroupId | Required in curationSourceSettings — this is the line item (ad group) ID |\n"," API: POST /adsApi/v1/create/inventoryGroups\n"," Request:\n"," Request fields:\n","| Field | Required | Description |\n","\\| --- \\| --- \\| --- \\|\n","| name | Yes | 1–250 characters |\n","| inventoryType | Yes | Must be \"VIDEO\" for ADS |\n","| curationSourceType | Yes | Must be \"AMAZON_CURATED_AGENT\" |\n","| curationSourceSettings | No | Optional — omit to accept default Deal Eligibility Controls (dealTypePreference: ALL, all supply). Provide it to configure DEC. |\n","| curationSourceSettings.automaticDealSelectionControls.adGroupId | Conditional | Required when curationSourceSettings is provided — the line item ID to associate with |\n","| curationSourceSettings.automaticDealSelectionControls.dealTypePreference | No | \"ALL\" (default), \"EXCLUDE_PUBLICLY_AVAILABLE\", or \"PUBLICLY_AVAILABLE_ONLY\" |\n","| curationSourceSettings.automaticDealSelectionControls.supplyAllowlist | No | Union type — pick ONE of the variants below |\n"," Supply allowlist variants (mutually exclusive):\n","| Variant | Meaning | Example |\n","\\| --- \\| --- \\| --- \\|\n","| amazonOwnedAndOperated: { enabled: true } | Restrict to Amazon O&O supply (1P only) | { \"supplyAllowlist\": { \"amazonOwnedAndOperated\": { \"enabled\": true } } } |\n","| openInternet: { enabled: true } | Restrict to open internet supply (3P only) | { \"supplyAllowlist\": { \"openInternet\": { \"enabled\": true } } } |\n","| customSources: { supplySourceIds: \\[\"src-1\", ...] } | Restrict to specific supply sources (1–1000). See Appendix: Valid supply source IDs. | { \"supplyAllowlist\": { \"customSources\": { \"supplySourceIds\": \\[\"src-1\"] } } } |\n","| (omit supplyAllowlist entirely) | ALL supply — no restriction | (don't include the field) |\n"," Successful response (HTTP 207):\n"," Possible errors:\n","| Error code | Condition | Message |\n","\\| --- \\| --- \\| --- \\|\n","| FIELD_VALUE_IS_INVALID | name is null/blank | \"name is required at index {i}\" |\n","| CONTENT_TOO_LARGE | name > 250 chars | \"name exceeds maximum length of 250 characters at index {i}\" |\n","| CONTENT_TOO_LARGE | > 100 items in request | \"Maximum 100 inventory groups allowed per request\" |\n","| FIELD_VALUE_IS_INVALID | advertisingDealIds provided for ADS | \"advertisingDealIds cannot be provided for AMAZON_CURATED_AGENT inventory groups at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | adGroupId is null/blank when curationSourceSettings is provided | \"adGroupId is required when curationSourceSettings is provided at index {i}\" |\n","| ACTION_NOT_SUPPORTED | curationSourceSettings on non-AMAZON_CURATED_AGENT IG | \"curationSourceSettings is only supported for AMAZON_CURATED_AGENT inventory groups at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | supplyAllowlist.amazonOwnedAndOperated.enabled = false | \"To remove the supply filter, omit supplyAllowlist entirely at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | supplyAllowlist.openInternet.enabled = false | \"To remove the supply filter, omit supplyAllowlist entirely at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | DEC too restrictive (zero eligible deals) | \"Deal eligibility controls are too restrictive — no deals match the specified criteria\" |\n","| ACTION_NOT_SUPPORTED | curationSourceType = AMAZON_CURATED (system-managed) | \"AMAZON_CURATED inventory groups cannot be created via public API\" |\n","| FIELD_VALUE_IS_INVALID | Unsupported inventoryType | \"Unsupported inventoryType: {value}\" |\n","| INTERNAL_ERROR | Backend unavailable | \"Service temporarily unavailable\" |\n"," API: POST /adsApi/v1/create/targets\n"," Association of an inventory group to an ad group (line item) is done via the targeting API. This creates a target of type INVENTORY_SOURCE that links the IG to the ad group.\n"," Request:\n"," Request fields:\n","| Field | Required | Description |\n","\\| --- \\| --- \\| --- \\|\n","| adGroupId | Yes | The ad group (line item) ID to target |\n","| adProduct | Yes | Must be \"AMAZON_DSP\" |\n","| targetType | Yes | Must be \"INVENTORY_SOURCE\" |\n","| state | Yes | \"ENABLED\" to activate |\n","| negative | Yes | Must be false for inventory groups |\n","| targetDetails.inventorySourceTarget.inventorySourceId.defaultValue | Yes | The inventory group ID from Step 1 |\n","| targetDetails.inventorySourceTarget.inventorySourceType | Yes | Must be \"INVENTORY_GROUP\" |\n"," The association is persisted asynchronously, so allow a short delay after a successful response before querying the association (it is eventually consistent).\n"," Possible errors:\n","| Error | Condition |\n","\\| --- \\| --- \\|\n","| Validation failure | IG does not exist |\n","| Validation failure | Duplicate target — IG already attached to this ad group |\n","| Validation failure | ADS 1:1 constraint — ad group already has a different ADS IG |\n","| Validation failure | ADS 1:1 constraint — ADS IG is already associated with a different ad group |\n","| Validation failure | Deal limit exceeded |\n"," API: POST /adsApi/v1/update/inventoryGroups\n"," For AMAZON_CURATED_AGENT inventory groups, only curationSourceSettings updates are allowed. Any attempt to change name, description, or advertisingDealIds is rejected.\n"," Update DEC request:\n"," To reset DEC to defaults (all deal types, all supply), nullify the curationSourceSettings field on update. Nullifying a field is different from omitting it:\n","Omitting curationSourceSettings leaves the existing DEC unchanged. - Nullifying curationSourceSettings clears it, resetting DEC to dealTypePreference: ALL and supplyAllowlist: ALL (no restriction).\n"," Field nullification follows the Domain Model convention: include the field's path in the request's nullified-fields set (rather than sending the field with a value). Refer to the update request semantics for how to mark a field as nullified in a bulk update. The update body itself only needs the target IG:\n"," with curationSourceSettings marked as nullified. On an AMAZON_CURATED_AGENT IG, an update that neither provides nor nullifies curationSourceSettings is rejected (see the error table below).\n"," Possible errors:\n","| Error code | Condition | Message |\n","\\| --- \\| --- \\| --- \\|\n","| ACTION_NOT_SUPPORTED | Changing name/deals/description on ADS IG | \"AMAZON_CURATED_AGENT inventory groups only support curationSourceSettings updates at index {i}\" |\n","| ACTION_NOT_SUPPORTED | Neither curationSourceSettings provided nor nullified | Same as above |\n","| ACTION_NOT_SUPPORTED | curationSourceSettings on non-AMAZON_CURATED_AGENT IG | \"curationSourceSettings is only supported for AMAZON_CURATED_AGENT inventory groups at index {i}\" |\n","| RESOURCE_ID_NOT_FOUND | IG ID not found | \"Inventory group not found: {id}\" |\n","| FIELD_VALUE_IS_INVALID | DEC too restrictive (zero eligible deals) | \"Deal eligibility controls are too restrictive — no deals match the specified criteria\" |\n","| FIELD_VALUE_IS_INVALID | adGroupId null/blank | \"adGroupId is required when curationSourceSettings is provided at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | supplyAllowlist.\\*.enabled = false | \"To remove the supply filter, omit supplyAllowlist entirely at index {i}\" |\n","| TOO_MANY_REQUESTS | Pre-fetch throttled | \"Request throttled, please retry\" |\n","| INTERNAL_ERROR | Pre-fetch failed | \"Failed to retrieve existing inventory groups\" |\n"," API: POST /adsApi/v1/delete/targets\n"," Unenrollment is done by deleting the targeting association via the targeting API.\n"," Request:\n"," On detach, the ADS IG is archived (status becomes INVENTORY_GROUP_ARCHIVED), not deleted, and continues to occupy the 1:1 slot on that ad group. See Step 5 for the re-enrollment implications.\n"," Possible errors:\n","| Error | Condition |\n","\\| --- \\| --- \\|\n","| Validation failure | Target ID does not exist |\n","| Validation failure | Multiple ADS IGs in a single DELETE request |\n","| Downstream failure | The operation is rejected (e.g., package associated with a different line item) |\n"," After unenrolling, the archived association is retained, and re-enrollment must use the same ADS IG ID that was originally associated with the ad group.\n"," Call POST /adsApi/v1/create/targets with the same ADS IG ID:\n"," How to find the original ADS IG ID:\n","Stored by the caller — Store the IG-to-ad-group mapping in your own system at creation time. This is the recommended approach. 2. Query the InventoryGroups API — POST /adsApi/v1/query/inventoryGroups lists all ADS IGs owned by the entity, but does not reveal which ad group each IG was previously associated with. 3. Error-driven discovery — If you use the wrong ADS IG ID, the error response includes the correct one.\n"," Using a different ADS IG ID for the same ad group fails:\n"," Standard inventory groups are advertiser-managed deal packages. The advertiser explicitly selects which deals to include.\n"," API: POST /adsApi/v1/create/inventoryGroups\n"," Request:\n"," Request fields:\n","| Field | Required | Description |\n","\\| --- \\| --- \\| --- \\|\n","| name | Yes | 1–250 characters |\n","| description | No | 0–1000 characters |\n","| inventoryType | Yes | \"VIDEO\", \"DISPLAY\", or \"AUDIO\" |\n","| advertisingDealIds | No | List of deal IDs (max 100 per IG) |\n","| curationSourceType | No | Defaults to \"ADVERTISER_CURATED\" if omitted |\n"," Successful response (HTTP 207):\n"," Possible errors:\n","| Error code | Condition | Message |\n","\\| --- \\| --- \\| --- \\|\n","| FIELD_VALUE_IS_INVALID | name is null/blank | \"name is required at index {i}\" |\n","| CONTENT_TOO_LARGE | name > 250 chars | \"name exceeds maximum length of 250 characters at index {i}\" |\n","| CONTENT_TOO_LARGE | description > 1000 chars | \"description exceeds maximum length of 1000 characters at index {i}\" |\n","| CONTENT_TOO_LARGE | > 100 deals per IG | \"Maximum 100 deals allowed per inventory group, got {n} at index {i}\" |\n","| CONTENT_TOO_LARGE | > 100 items in request | \"Maximum 100 inventory groups allowed per request\" |\n","| FIELD_VALUE_IS_INVALID | Unsupported inventoryType | \"Unsupported inventoryType: {value}\" |\n"," API: POST /adsApi/v1/create/targets\n"," Use the targeting API (same as ADS):\n"," Standard IGs support many-to-many associations — one IG can target multiple ad groups, and one ad group can have multiple IGs.\n"," Possible errors:\n","| Error | Condition |\n","\\| --- \\| --- \\|\n","| Validation failure | IG does not exist |\n","| Validation failure | Duplicate target — IG already attached to this ad group |\n","| Validation failure | Deal limit exceeded |\n"," API: POST /adsApi/v1/update/inventoryGroups\n"," You can update name and advertisingDealIds for standard IGs:\n","| Field | Required | Description |\n","\\| --- \\| --- \\| --- \\|\n","| inventoryGroupId | Yes | The IG to update |\n","| name | No | New name (if omitting, existing name is kept). Cannot be nullified. |\n","| advertisingDealIds | No | New deal list. Send \\[] to clear all deals. Omit to keep existing. |\n"," Possible errors:\n","| Error code | Condition | Message |\n","\\| --- \\| --- \\| --- \\|\n","| RESOURCE_ID_NOT_FOUND | IG ID not found | \"Inventory group not found: {id}\" |\n","| FIELD_VALUE_IS_INVALID | Name nullified | \"name is required and cannot be cleared at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | Description update attempted | \"description updates are not currently supported\" |\n","| ACTION_NOT_SUPPORTED | curationSourceSettings on non-ADS IG | \"curationSourceSettings is only supported for AMAZON_CURATED_AGENT inventory groups at index {i}\" |\n","| CONTENT_TOO_LARGE | > 100 deals per IG | \"Maximum 100 deals allowed per inventory group, got {n} at index {i}\" |\n","| TOO_MANY_REQUESTS | Pre-fetch throttled | \"Request throttled, please retry\" |\n"," API: POST /adsApi/v1/delete/targets\n"," For standard IGs, the association is fully removed. Re-association can be done with any IG (no 1:1 constraint).\n","| Aspect | ADS (AMAZON_CURATED_AGENT) | Standard (ADVERTISER_CURATED) |\n","\\| --- \\| --- \\| --- \\|\n","| curationSourceType | \"AMAZON_CURATED_AGENT\" (required) | \"ADVERTISER_CURATED\" (default, can be omitted) |\n","| inventoryType | \"VIDEO\" only | \"VIDEO\", \"DISPLAY\", or \"AUDIO\" |\n","| Eligible line items | Streaming TV (STV) Awareness only (STREAMING_TV + Awareness campaign) | Any line item type |\n","| advertisingDealIds | Must be null/empty (deals are system-managed) | Advertiser-specified (0–100 deals) |\n","| description | Not supported (field ignored) | Accepted at create (1000 char max) |\n","| curationSourceSettings | Optional — provide to configure DEC; omit to accept defaults (dealTypePreference: ALL, all supply) | Not supported (returns ACTION_NOT_SUPPORTED) |\n","| adGroupId | Conditional — required only when curationSourceSettings is provided (the line item ID) | N/A |\n","| Attach API | POST /adsApi/v1/create/targets | POST /adsApi/v1/create/targets |\n","| Detach API | POST /adsApi/v1/delete/targets | POST /adsApi/v1/delete/targets |\n","| Detach behavior | IG is archived (INVENTORY_GROUP_ARCHIVED) — still occupies 1:1 slot | Association is removed |\n","| Re-enrollment | Must use the same IG ID | No constraint — any IG can be re-associated |\n","| Line item association | 1:1 (one IG per line item) | Many-to-many (multiple IGs to multiple line items) |\n","| Update: name | Not allowed (rejected) | Allowed |\n","| Update: deals | Not allowed (rejected) | Allowed (send \\[] to clear) |\n","| Update: description | Not allowed (rejected) | Not currently supported |\n","| Update: curationSourceSettings (DEC) | Allowed (the only mutable field) | Not supported |\n","| Bulk limit | 100 per request | 100 per request |\n","| Operation | ADS IG API | Standard IG API |\n","\\| --- \\| --- \\| --- \\|\n","| Create IG | POST /adsApi/v1/create/inventoryGroups | POST /adsApi/v1/create/inventoryGroups |\n","| Attach to line item | POST /adsApi/v1/create/targets | POST /adsApi/v1/create/targets |\n","| Update IG | POST /adsApi/v1/update/inventoryGroups (DEC only) | POST /adsApi/v1/update/inventoryGroups (name, deals) |\n","| Detach from line item | POST /adsApi/v1/delete/targets | POST /adsApi/v1/delete/targets |\n","| Query IGs | POST /adsApi/v1/query/inventoryGroups (filter: AMAZON_CURATED_AGENT) | POST /adsApi/v1/query/inventoryGroups (filter: ADVERTISER_CURATED) |\n","| Constraint | ADS IG | Standard IG |\n","\\| --- \\| --- \\| --- \\|\n","| 1:1 IG-to-ad-group | Enforced — one ADS IG per ad group, one ad group per ADS IG | Not enforced — many-to-many |\n","| Re-enrollment | Must use same IG ID | No constraint |\n","| Batch delete | Cannot delete multiple ADS targets in a single request | No restriction |\n","| Media type match | Not validated at targeting time | Not validated at targeting time |\n"," ADS flow:\n"," Standard IG flow:\n"," DEC controls which deals ADS can select for the line item.\n"," dealTypePreference (deal library preference) controls which deal library the system draws deals from when selecting inventory for the line item. In the DSP UI, this corresponds to the \"Deal Library Preference\" setting — it determines whether ADS considers deals from the public marketplace (available to all advertisers), private/exclusive deals (negotiated specifically for the advertiser), or both.\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| ALL | Both public marketplace deals and private/exclusive deals are eligible (default) |\n","| EXCLUDE_PUBLICLY_AVAILABLE | Only private/exclusive deals — excludes publicly available marketplace deals |\n","| PUBLICLY_AVAILABLE_ONLY | Only publicly available marketplace deals — excludes private/exclusive deals |\n"," Example 1 — use all deal types (default). The system can select from any deal in both public and private libraries:\n"," Example 2 — private deals only. Restrict to deals negotiated specifically for this advertiser. Publicly available marketplace deals are excluded:\n"," Example 3 — marketplace deals only. Restrict to deals available in the public marketplace (open auction deals, open PMPs). Private/exclusive deals are excluded:\n"," Example 4 — combined with supply allowlist. Private deals only, restricted to Amazon O&O supply:\n"," supplyAllowlist mode:\n","| API value | Description |\n","\\| --- \\| --- \\|\n","| amazonOwnedAndOperated: { enabled: true } | Only Amazon-owned supply |\n","| openInternet: { enabled: true } | Only open internet (third-party) supply |\n","| customSources: { supplySourceIds: \\[...] } | Specific supply source IDs (1–1000). See Appendix: Valid supply source IDs. |\n","| (omit supplyAllowlist) | All supply eligible |\n"," Before persisting DEC, the system verifies that at least one deal matches the specified criteria. If zero deals match, the request is rejected with FIELD_VALUE_IS_INVALID.\n","Idempotent creation — Re-creating the same ADS IG for the same line item returns the existing inventory group ID. 2. DEC persistence on create — DEC is always persisted after IG creation. If DEC persistence fails, the entire create operation is reported as failed. 3. DEC defaults — If curationSourceSettings is null or has null automaticDealSelectionControls, DEC defaults to ALL/ALL (all deal types, all supply). 4. Archive on detach — When an ADS IG is removed from a line item, it is archived (status = INVENTORY_GROUP_ARCHIVED), not deleted. This preserves audit history. 5. Single line item association — An ADS inventory group can only be associated with one line item at a time. 6. Bulk operations — Up to 100 inventory groups can be created or updated per request.\n"," To avoid errors, callers should:\n","Persist the IG ID to ad group ID mapping — critical for re-enrollment. 2. Always use inventoryType: \"VIDEO\" for ADS IGs. 3. Always set curationSourceType: \"AMAZON_CURATED_AGENT\" explicitly for ADS IGs. 4. Never provide advertisingDealIds for ADS IGs. 5. Always include adGroupId when providing curationSourceSettings. 6. Use the targeting API (POST /adsApi/v1/create/targets, POST /adsApi/v1/delete/targets) to attach and detach ADS IGs. 7. Delete ADS targets one at a time — never batch multiple ADS target deletions in a single request. 8. Verify the ad group is a Streaming TV (STV) Awareness ad group (STREAMING_TV on an Awareness campaign) before enrolling in ADS. 9. Start with permissive DEC (ALL/ALL) and narrow gradually. 10. Allow for eventual consistency after targeting operations.\n"," When using customSources.supplySourceIds in the supplyAllowlist, you must provide valid supply source IDs. Supply sources are grouped by SSP (supply-side platform). Each ID is a numeric identifier that must be passed as a JSON string (for example, \"100\", not 100) — this matches the supplySourceIds type used throughout the examples in this guide. Pass the IDs (not the SSP names). You can pass IDs from multiple SSPs in a single supplySourceIds array (1–1000 IDs supported).\n"," Amazon (O&O):\n"," APS (Amazon Publisher Services):\n"," Third-party SSPs:\n","| SSP name | Supply source IDs |\n","\\| --- \\| --- \\|\n","| Google AdX (Authorized Buyers) | 1401, 1403, 1404 |\n","| Smartclip | 1984, 1985, 2018 |\n","| Magnite Streaming | 1979, 1980, 1981 |\n","| Unruly | 1967, 2066, 2069 |\n","| Stroer | 1212, 1213, 1214, 1949, 2075, 2077 |\n","| Spotify Ad Exchange (SAX) | 1223 |\n","| Index | 1978, 2048, 2049 |\n","| Sovrn | 1929 |\n","| OpenX | 1302, 1303, 1304 |\n","| MediaGrid | 2028, 2030 |\n","| Yieldmo | 1651, 1653 |\n","| LoopMe | 2091, 2093 |\n","| Triplelift | 1551, 1553, 1556 |\n","| Equativ | 2025, 2026 |\n","| Nativo | 1571, 1573 |\n","| OneTag | 2003, 2004 |\n","| Magnite DV+ | 1701, 1703 |\n","| Improve Digital | 2020, 2021 |\n","| Kargo | 2071, 2073, 2074 |\n","| Unity | 2129 |\n","| BeachFront | 1950, 1951 |\n","| FreeWheel | 1973, 1974, 1983 |\n","| YieldOne | 1923, 1997 |\n","| Connatix | 2010, 2011 |\n","| Sharethrough | 1561, 1563, 1566 |\n","| TVer | 2035, 2060, 2061 |\n","| GumGum | 2110 |\n","| AJA | 1991, 1992, 1998 |\n","| Microsoft Monetize | 1201, 1203, 1204 |\n","| Exte | 2166, 2169 |\n","| Verizon Media Exchange | 1602, 1604 |\n","| Ogury | 2144, 2145 |\n","| Vungle Exchange | 1709 |\n","| Media.net | 1989, 2081 |\n","| Roku | 2180 |\n","| Dailymotion | 1886, 1887 |\n","| Ad Generation | 1954, 1955 |\n","| Fluct | 1926 |\n","| Teads | 1942, 1943 |\n","| PubMatic | 1503, 1505, 1506 |\n","| InMobi | 1996 |\n","| ironSource | 2007 |\n","| Yieldlab | 1920, 1994, 2076 |\n","| Smaato | 1966 |\n"," Example — restrict to only Amazon O&O + Roku + FreeWheel supply:\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Label Management"},"path":"/en-us/guides/deal-management/deal-management","content":[" Labels are global, user-defined tags for organizing DSP objects (deals, inventory groups). Once created, labels are visible across the account and can be applied to any supported object type.\n"," For full details on the Label resource, see Label entity reference.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Query Labels"},"path":"/en-us/guides/deal-management/deal-management","content":[" Query labels visible to the entity of the caller, filtered by object type, using POST /adsApi/v1/query/labels. Supports filtering by label ID or name. Results are sorted alphabetically.\n"," For other label operations such as creating, updating labels, and managing label-object associations, contact the SupplyDesk team.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Query Labels associations"},"path":"/en-us/guides/deal-management/deal-management","content":[" Query labels associated to various objects (like Inventory Group, Deal etc.) by passing either a labelIdFilter or labelObjectIdFilter in POST /adsApi/v1/query/labelObjectAssociations. \n"," For other label association operations such as creating, deleting labels associations, contact the SupplyDesk team.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Supply Management"},"path":"/en-us/guides/deal-management/deal-management","content":[],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Supplier "},"path":"/en-us/guides/deal-management/deal-management","content":[" A supplier represents a business entity directly integrated with ADSP that sends inventory to bid on. Retrieve the list of available suppliers using POST /adsApi/v1/query/suppliers.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Publisher"},"path":"/en-us/guides/deal-management/deal-management","content":[" A publisher is a business entity that owns and/or operates the apps, sites, or video streams where ads are displayed. Retrieve the list of available publishers using POST /adsApi/v1/query/publishers.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Seller"},"path":"/en-us/guides/deal-management/deal-management","content":[],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":null,"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" The Proposal Management API enables buyers to create and manage Programmatic Guaranteed (PG) deals with Amazon Owned and Operated (Amazon O&O) publishers, called \"Amazon Media\" in the UI, such as Prime Video and Twitch. It also supports PG and Private Auction (PA) deals with Amazon Publisher Direct (APD) and Amazon Publisher Cloud (APC) and supports Private Auction deals with Netflix.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"ADSP Proposal level hierarchy"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"How does it work?"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" For Amazon O&O publishers such as Prime Video and Twitch, buyers can create PG deals. Deals are programmatically reviewed and approved based on a set of pre-defined rules.\n"," For third-party publishers via APC and APD, the workflow follows a request-for-proposal model. Buyers submit a proposal, publishers review and respond with deal terms, and both parties can approve, reject, or counter until an agreement is reached. Once agreed, the publisher generates the deal, which becomes available directly in the proposal for activation.\n"," APC enables Signal Enhanced Deals, which combine advertiser audiences with Amazon retail, streaming, and publisher first-party signals to package deals around high-relevance content. APD supports standard deals based on available publisher inventory.\n"," For Netflix as a first-party supply source, buyers can create Private Auction deals with floor-rate pricing through the Amazon DSP Deal Proposals API. The workflow follows a buyer-initiated RFP model where buyers submit a proposal with country-level targeting and video creative specifications, and Netflix's automated seller responds with a quoted floor price and inventory forecast. Buyers can then approve, counter, or resubmit until agreement is reached.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"Supported use cases"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" The Proposals API supports four use cases. Buyers can create PG deals with Amazon O&O publishers, with automated deal proposal review and configurable supply-side targeting, budget, deal duration, frequency cap, and other deal parameters. Buyers can also propose PG and PA deals to APC and APD publishers via a request-for-proposal flow, with configurable deal parameters that depend on the selected ad product. APC additionally supports Signal Enhanced Deals, which layer advertiser audiences with Amazon and publisher signals. Netflix supports PA deals with rich audience and contextual targeting across multiple dimensions—including demographics, interests, device type, dayparting, content genre, and geography—enabling advertisers to programmatically negotiate and activate deals against Netflix's premium video inventory without manual publisher review.\n"," APC deals are great for buyers seeking enhanced control and optimization over their PG and PA buys, particularly those with AMC Audiences strategies or ID-less traffic approaches, as well as advertisers blocked from using Amazon Audiences due to policy/compliance restrictions (e.g., 3PAS creatives or competitive brands). In the APC workflow, buyers can select desired Amazon audience segments (standard or custom) that publishers securely overlay with their owned & operated signals to identify and package content that the desired audiences are most likely to watch.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"Create a proposal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" A proposal contains one or more proposed deals. To create a deal via the Proposals API, first create a proposal, then create a proposed deal that references it. The endpoints below walk through the steps to create a proposal.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Proposal Destination"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" A supplier proposal destination represents a counterparty available to a buyer for negotiating deals (e.g., Amazon O&O, APC, APD, or Netflix) and determines which publishers and ad products can be selected in subsequent steps. Retrieve the list of available suppliers using POST /adsApi/v1/query/supplierProposalDestinations.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Publisher"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Select a publisher to scope the ad products and pricing available in subsequent steps. Retrieve the list of publishers available for the selected supplier using POST /adsApi/v1/query/supplierPublishers. Currently only APD supports this feature. \n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Ad Product"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Select an ad product to define what the proposed deal will target. Retrieve the list of ad products available for the selected supplier and publisher using POST /adsApi/v1/query/supplierAdProducts.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Ad Product Price"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Retrieve the price for the selected ad product using POST /adsApi/v1/create/supplierAdProductPrices. Currently only \"Amazon Media\" supports fetching prices. In all other destinations, the counterparty will provide the price.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Proposed Deal Forecast"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" For the Amazon O&O workflow only, retrieve a forecast for the proposed deal based on the targeting, dates, price, and other deal parameters using POST /adsApi/v1/create/supplierProposedDealForecasts.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Targeting"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Optionally apply supplier-side targeting constraints to the proposed deal. Retrieve the list of targeting options available for the selected ad product using POST /adsApi/v1/query/supplierTargetItems. \n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Create Supplier Proposed Deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Create a proposed deal containing the supplierProposalDestination, publisher, ad product, price, and any optional targeting selected in the prior steps. Create the proposed deal using POST /adsApi/v1/create/supplierProposedDeals.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Create Supplier Proposal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" After creating one or more proposed deals, create the proposal that contains them using POST /adsApi/v1/create/supplierProposals.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"Modify proposal or proposed deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Proposed Deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Retrieve the proposed deals for a proposal using POST /adsApi/v1/query/supplierProposedDeals.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Update Supplier Proposed Deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Update an existing proposed deal using POST /adsApi/v1/update/supplierProposedDeals.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Proposal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Retrieve the proposals for an ADSP advertiser using POST /adsApi/v1/query/supplierProposals.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Update Supplier Proposal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Update an existing proposal using POST /adsApi/v1/update/supplierProposals. Currently Amazon O&O, APC and APD workflow supports it.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Submit Supplier Proposed Deal Revision"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Submit a revised proposed deal when a proposal is in REVIEWED, SUPPLIER_REVIEWED, or REVIEWED_PARTIAL state. The proposed deal must be APPROVED or APPROVED_CURRENT and it must be in an active state. Behavior differs by workflow. For the Amazon O&O workflow, a proposed deal can be revised after it is accepted or rejected by the publisher. Submit the revision using POST /adsApi/v1/create/supplierProposedDealRevisions. For the APD and APC workflow, once a proposal is reviewed (accepted or rejected by either party), the proposed deal cannot be revised further; during negotiation, counter responses from the buyer or publisher are recorded as revisions of the proposed deal. Netflix workflow does not support it.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Update Supplier Proposed Deal Revision"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" For the Amazon O&O workflow only, update a submitted revision using POST /adsApi/v1/update/supplierProposedDealRevisions.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Proposed Deal History"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Retrieve the historical versions of a proposed deal, including all prior revisions, using POST /adsApi/v1/query/supplierProposedDealHistoricalVersions. Currently only the Amazon O&O workflow uses this endpoint. The APC and APD workflows support revisions through their own negotiation flow, so they do not use this endpoint. The Netflix workflow does not support revisions. Retrieve the historical versions of a proposed deal, including all prior revisions, using POST /adsApi/v1/query/supplierProposedDealHistoricalVersions. Currently the Amazon O&O, APC, and APD workflows support this. The Netflix workflow does not.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"Netflix Proposal & Proposed Deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Netflix is both the supplier and the publisher, so the Netflix workflow has no publisher-selection step. Discovery goes directly from destination to ad product to targeting items. Netflix deals are Private Auction with floor-rate pricing and use video creative. Netflix supports one proposed deal per proposal, so create a separate proposal for each deal. Each Netflix ad product declares a mandatory fixed targeting group (for the United States, a LOCATION_COUNTRY group) that the proposed deal must include.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Create and submit a Netflix deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Query the Netflix ad products for the destination. Each product lists its deal type, pricing, budget minimum, and required targeting. After you create the proposal, create and submit the proposed deal in a single step with POST /adsApi/v1/create/supplierProposedDeals: set the deal state to PROPOSED.\n"," On create, send these required fields:\n","The product's required country targeting group. - The video creative requirements. - terms.guaranteed, terms.marketplaceDeal, and supplierProposedDealExtension.\n"," If you omit the country group or the creative requirements, Netflix rejects the deal. A create or update returns HTTP 207 with a per-item error array. An empty error array means the item succeeded, so inspect each item's error rather than the top-level HTTP status. Netflix's automated seller then responds with a quoted CPM, which sets the deal's floor price, and an inventory forecast.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Respond to a Netflix seller response"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" After Netflix responds, approve or counter through the proposed-deal endpoint POST /adsApi/v1/update/supplierProposedDeals with a deal state: set the state to PROPOSED to accept Netflix's terms, or to DRAFT to counter, then edit the terms and submit again. Approve and counter are supported only on the proposed-deal endpoint, not on update/supplierProposals. Netflix does not support supply-side frequency caps, and a Netflix proposed deal cannot be revised after you approve it.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Netflix deal lifecycle"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Netflix uses a buyer-initiated request-for-proposal model with an automated seller. The table below lists the deal and proposal status at each step. The DRAFT and SUBMITTED rows are the two states of the single atomic create+submit call, not two separate API calls. If Netflix soft-rejects a submitted deal, the deal stays in SUBMITTED; correct the configuration (most often a missing required targeting group) and submit again.\n","| Deal status | Action (who) | New deal status | Proposal status |\n","\\|---\\|---\\|---\\|---\\|\n","| — | Create (buyer) | DRAFT | DRAFT |\n","| DRAFT | Submit (buyer, atomic state:PROPOSED) | SUBMITTED | PENDING |\n","| SUBMITTED | Respond (Netflix) | SELLER_RESPONDED | SUPPLIER_REVIEWED |\n","| SELLER_RESPONDED | Approve (buyer, state:PROPOSED) | APPROVED_PENDING_REGISTRATION | REVIEWED |\n","| SELLER_RESPONDED | Counter (buyer, state:DRAFT) | COUNTER_DRAFT | COUNTER_DRAFT |\n","| APPROVED_PENDING_REGISTRATION | Finalize (Netflix) | APPROVED | REVIEWED |\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Netflix targeting"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Query selectable targeting items with POST /adsApi/v1/query/supplierTargetItems; supplierAdProductIdFilter is required on this endpoint. Netflix supports 21 target types:\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":null,"path":"/en-us/guides/deal-management/commitment-management","content":[" The Commitment Management API enables buyers to create and manage spending commitments on Amazon DSP. A commitment defines a total spend target over a specified time period and can be scoped to specific advertisers, campaigns, or deals. The API also provides spend tracking capabilities to monitor progress toward fulfilling commitments.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":2,"text":"Key concepts"},"path":"/en-us/guides/deal-management/commitment-management","content":["Commitment — A spending agreement that defines a committed spend amount, time period, and fulfillment rules. Commitments can be scoped using inclusion and exclusion lists for advertisers, campaigns, and deals. - Fulfillment level — Controls how aggressively the system prioritizes meeting the commitment target. LEVEL_0 is tracking-only, while LEVEL_5 prioritizes commitment fulfillment over campaign performance. - Spend calculation mode — Determines the aggregation level for tracking spend: manager account, advertiser account, or campaign. - Commitment spend — Tracks accrued, at-risk, and projected spend values for a commitment, broken down by dimension (advertiser, campaign, or deal).\n"," For full details on the data model, see Commitment entity reference and CommitmentSpend entity reference.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":2,"text":"Commitment Management"},"path":"/en-us/guides/deal-management/commitment-management","content":[],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"List Commitments"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Retrieve a list of commitments using GET /adsApi/v1/commitments. This endpoint returns commitments visible to the caller based on the account context.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"Create a Commitment"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Create a new commitment by specifying the commitment name, currency, committed spend amount, start and end dates, fulfillment level, and spend calculation mode. Optionally scope the commitment to specific advertisers, campaigns, or deals using inclusion or exclusion lists.\n"," Use endpoint POST /adsApi/v1/create/commitments.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"Query Commitments"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Query commitments based on sorting and filtering criteria provided in the request using POST /adsApi/v1/query/commitments. This is useful for finding commitments that match specific criteria such as date ranges, ad products, or fulfillment levels.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"Retrieve Commitments"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Retrieve commitments in bulk by providing a list of commitment IDs using POST /adsApi/v1/retrieve/commitments.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"Update a Commitment"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Update an existing commitment using POST /adsApi/v1/update/commitments. You can modify the commitment name, committed spend, dates, fulfillment level, spend calculation mode, and the advertiser, campaign, or deal inclusion and exclusion lists.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":2,"text":"Commitment Spend Tracking"},"path":"/en-us/guides/deal-management/commitment-management","content":[],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"Retrieve Commitment Spend"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Retrieve spend tracking details for one or more commitments using POST /adsApi/v1/retrieve/commitmentSpends. The response includes:\n","Accrued spend — The actual spend amount accrued to date in the commitment currency. - Spend at risk — The amount of spend that may not count toward the commitment. - Projected spend — The forecasted total spend based on current pacing.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":null,"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[" This page shared details about migration from product specific endpoints to generally available unified endpoints. The new APIs are available worldwide in all marketplaces where ADSP operates.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Endpoint Equivalencies"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Product specific endpoints to unified endpoints mapping"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":["| Old endpoint | New endpoint |\n","\\| -----------  \\| ------------ \\|\n","| Inventory Management Endpoints |  |\n","| POST /adsApi/v1/create/inventoryGroups/dsp | POST /adsApi/v1/create/inventoryGroups |\n","| POST /adsApi/v1/update/inventoryGroups/dsp | POST /adsApi/v1/update/inventoryGroups |\n","| POST /adsApi/v1/query/inventoryGroups/dsp | POST /adsApi/v1/query/inventoryGroups |\n","| POST /adsApi/v1/retrieve/inventoryGroups/dsp|  POST /adsApi/v1/query/inventoryGroups|\n","| Commitment Management Endpoints |  |\n","| POST /adsApi/v1/retrieve/commitmentSpends/dsp | POST /adsApi/v1/retrieve/commitmentSpends |\n","| GET /adsApi/v1/commitments/dsp | GET /adsApi/v1/commitments |\n","| POST /adsApi/v1/create/commitments/dsp | POST /adsApi/v1/create/commitments |\n","| POST /adsApi/v1/query/commitments/dsp | POST /adsApi/v1/query/commitments |\n","| POST /adsApi/v1/retrieve/commitments/dsp | POST /adsApi/v1/retrieve/commitments |\n","| POST /adsApi/v1/update/commitments/dsp | POST /adsApi/v1/update/commitments |\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Commitments Management API migration (product specific to unified endpoints)"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[" From Commitment and CommitmentSpends endpoint perspective, we have removed /dsp from currently available Commitment APIs. Above table shares the old and new endpoint equivalents. For each endpoint we have added an optional adProduct parameter. At present we only support “Amazon_DSP” adProduct. The unified endpoints are functionally identical to the /dsp variants; the only difference is the URL pattern and the addition of an optional adProduct parameter to scope the request (replacing the implicit /dsp scoping). There are no schema changes, no request or response changes. User should:\n","Update endpoint URLs — remove /dsp from the path  2. Verify response parity (schemas are identical)  3. Remove old endpoint calls once verified \n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Inventory Management API migration (product specific to unified endpoints)"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[" From BuyerSeats, Inventory Groups, Labels, DealAdvertiserAccessEntries and DealAdvertiserAccesses APIs, we have removed /dsp from the currently available Inventory Management APIs. Above table shares the old and new endpoint equivalents. For each endpoint we have added an optional adProduct parameter. At present we only support “Amazon_DSP” adProduct. The unified endpoints are functionally identical to the /dsp variants; the only difference is the URL pattern and the addition of an optional adProduct parameter to scope the request (replacing the implicit /dsp scoping). There are no schema changes, no request or response changes. User should:\n","Update endpoint URLs — remove /dsp from the path  2. Verify response parity (schemas are identical)  3. Remove old endpoint calls once verified \n"," Please note that the POST /adsApi/v1/retrieve/inventoryGroups/dsp is replaced by POST /adsApi/v1/query/inventoryGroups endpoint.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Upcoming Legacy to Unified API migration"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[" In future, we will perform migration campaign from legacy to unified endpoints. The new inventory APIs enable self-serve advertisers and their partners to programmatically manage their Amazon DSP deals , proposal and commitments data. These new APIs replace the previous deals management APIs, previous deal performance and exchanges APIs, previous deals proposal APIs, previous deals advertiser permissions APIs and previous Inventory Group APIs.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Legacy endpoints to unified endpoints mapping"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":["| Old endpoint | New endpoint |\n","\\| -----------  \\| ------------ \\|\n","| Deal Management Legacy Endpoints |  |\n","| POST /dsp/inventorySourceDeals/list | POST /adsApi/v1/query/advertisingDeals |\n","| POST /dsp/inventory/deals/list | POST /adsApi/v1/query/advertisingDeals |\n","| PUT /dsp/inventory/deals/{dealId} | POST /adsApi/v1/update/advertisingDeals |\n","| POST /dsp/inventory/deals | POST /adsApi/v1/create/advertisingDeals |\n","| GET /dsp/inventory/deals/{dealId}/lineItems | POST /adsApi/v1/query/targets |\n","| POST /dsp/inventory/deals/inferredAttributes/list | POST /adsApi/v1/query/dealAvailses |\n","| POST /dsp/inventory/deals/{dealId}/inferredAttributes/supplySellers/list | POST /adsApi/v1/query/dealAvailses |\n","| GET /dsp/inventory/deals/{dealId}/inferredAttributes | POST /adsApi/v1/query/dealAvailses |\n","| POST /dsp/inventory/deals/performance/list | POST /adsApi/v1/query/dealPerformances |\n","| POST /dsp/inventory/deals/exchanges/list | tbd |\n","| POST /dsp/v1/seats/advertisers/create | POST /adsApi/v1/create/buyerSeats |\n","| POST /dsp/v1/seats/advertisers/current/list | GET /adsApi/v1/buyerSeats |\n","| POST /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertiser/list | n/a |\n","| DELETE /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertisers | n/a |\n","| PUT /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertisers | n/a |\n","| POST /dsp/inventory/deals/{dealId}/advertiserPermissions | n/a |\n","| GET /dsp/inventory/deals/{dealId}/advertiserPermissions | n/a |\n","| PUT /dsp/inventory/deals/{dealId}/advertiserPermissions/advertiserList | POST /adsApi/v1/create/dealAdvertiserAccessEntries, POST /adsApi/v1/delete/dealAdvertiserAccessEntries |\n","| GET /dsp/inventory/deals/{dealId}/advertiserPermissions/advertiserList | POST /adsApi/v1/query/dealAdvertiserAccessEntries, POST /adsApi/v1/retrieve/dealAdvertiserAccesses |\n","| DELETE /dsp/inventory/deals/{dealId}/advertiserPermissions | POST /adsApi/v1/delete/dealAdvertiserAccesses, POST /adsApi/v1/delete/dealAdvertiserAccessEntries |\n","| POST /dsp/seats/current/list | GET /adsApi/v1/buyerSeats |\n","| n/a | POST /adsApi/v1/query/labels |\n","| n/a | POST /adsApi/v1/query/labelObjectAssociations |\n","| n/a | POST /adsApi/v1/query/dealPlanningMetricses |\n","| Inventory Group Endpoints |  |\n","| POST /dsp/v1/inventory/inventoryGroups | POST /adsApi/v1/create/inventoryGroups |\n","| PUT /dsp/v1/inventory/inventoryGroups | POST /adsApi/v1/update/inventoryGroups |\n","| POST /dsp/v1/inventory/inventoryGroups/list | POST /adsApi/v1/query/inventoryGroups |\n","| POST /dsp/v1/inventory/eligibility/inventoryGroups/list | POST /adsApi/v1/query/inventoryGroups |\n","| n/a | POST /adsApi/v1/update/inventoryGroups |\n","| n/a | POST /adsApi/v1/query/inventoryGroups |\n","| n/a | POST /adsApi/v1/create/inventoryGroups |\n","| Proposal Management Endpoints |  |\n","| POST /dsp/inventory/proposals | POST /adsApi/v1/create/supplierProposals |\n","| PUT /dsp/inventory/proposal/{proposalId}/status | POST /adsApi/v1/update/supplierProposals |\n","| POST /dsp/inventory/proposalSource/{sourceId}/publisherProduct/{publisherProductId}/rate | POST /adsApi/v1/create/supplierAdProductPrices |\n","| POST /dsp/inventory/proposalSource/{sourceId}/publisherProducts/list | POST /adsApi/v1/query/supplierAdProducts |\n","| POST /dsp/inventory/proposalSource/{sourceId}/publishers/list | POST /adsApi/v1/query/supplierPublishers |\n","| POST /dsp/inventory/proposalSources/amazonMedia/{amazonMediaPublisherId}/signals/collections/list | POST /adsApi/v1/query/supplierTargetItems |\n","| POST /dsp/inventory/proposalSources/list | POST /adsApi/v1/query/supplierProposalDestinations |\n","| POST /dsp/inventory/proposalSource/{sourceId}/productOfferings/list | POST /adsApi/v1/query/supplierAdProducts |\n","| n/a | POST /adsApi/v1/query/supplierProposals |\n","| n/a | POST /adsApi/v1/query/supplierProposedDeals |\n","| n/a | POST /adsApi/v1/create/supplierProposedDeals |\n","| n/a | POST /adsApi/v1/create/supplierProposedDealRevisions |\n","| n/a | POST /adsApi/v1/update/supplierProposedDealRevisions |\n","| n/a | POST /adsApi/v1/create/supplierProposedDealForecasts |\n","| n/a | POST /adsApi/v1/query/supplierProposedDealHistoricalVersions |\n","| n/a | POST /adsApi/v1/update/supplierProposedDeals |\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Versioning"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[],"documentType":"guide"},{"title":"Inventory Management FAQ","sectionHeader":null,"path":"/en-us/guides/deal-management/faq","content":[],"documentType":"guide"},{"title":"Inventory Management FAQ","sectionHeader":{"type":3,"text":"What deal types are supported by the Inventory Management API?"},"path":"/en-us/guides/deal-management/faq","content":[" Inventory Management APIs support Private Auction (PA), Preferred deal (PD), Programmatic Guaranteed (PG) deals.\n"],"documentType":"guide"},{"title":"Inventory Management FAQ","sectionHeader":{"type":3,"text":"What is the difference between the Inventory Management API and the Proposal Management API?"},"path":"/en-us/guides/deal-management/faq","content":[" Inventory Management APIs are used to perform Create, Read, Update, Delete (as applicable) operations on deals, inventory groups, labels, buyer seats etc. Proposal Management APIs allow buyers to create and manage PG and PA deals with Amazon Owned and Operated publishers, Amazon Publisher Direct (APD) and Amazon Publisher Cloud (APC) and PA deals with Netflix.\n"],"documentType":"guide"},{"title":"Inventory Management FAQ","sectionHeader":{"type":3,"text":"How do I get started?"},"path":"/en-us/guides/deal-management/faq","content":[" Refer to Overview.\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Cloud","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/overview","content":[" Amazon Marketing Cloud (AMC) is a secure, privacy-safe, and cloud-based clean room solution, in which partners and advertisers can structure custom queries to explore unique measurement questions, easily perform analytics across pseudonymized signals to address top business priorities, and build custom audiences ready for campaign deployment. AMC allows you to create reports over event-level Amazon Ads inputs such as impressions and clicks from Amazon DSP ads, sponsored ads, and Amazon Live campaigns, as well as purchase events from Amazon stores. The instructions in the next few sections will assist you in making use of APIs to automate workflows, establish integrations, and develop tools and applications at scale.\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"What are the benefits of AMC for advertisers?"},"path":"/en-us/guides/amazon-marketing-cloud/overview","content":[" With AMC, advertisers are able to more clearly answer measurement questions, gain further actionable insights, and build custom audiences ready for campaign activations. Some common use cases AMC can help you with are:\n","Obtain more in-depth findings about a particular campaign. - Illustrate customer shopping journey in terms of media exposure, frequency, timing, etc. - Understand the collective impact of media mix and isolate the incremental impact of a particular media usage. - Assess how Amazon media contributes to sales at various Amazon store types and advertiser D2C channels. - Look for correlation between engagement and audience attributes, and find your optimal audience segments. - Assign credits to various touchpoints on the path-to-conversion of customers. - Utilize ad engagement and conversion signals across channels and sources to build bespoke audiences for direct activation via Amazon DSP.  - Subscribe to Paid Features (beta) powered by Amazon Ads and third-party providers to expand the scope and depth of insights.\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"Key features"},"path":"/en-us/guides/amazon-marketing-cloud/overview","content":[" Advertisers and partners can now access Amazon Marketing Cloud APIs from the Amazon Ads advanced tools center, along with APIs for other Amazon Ads solutions such as sponsored ads and Amazon DSP. As the rest of Amazon Ads APIs, these new AMC APIs follow the industry-standard OAuth 2.0 authorization framework and use a consistent base URL to gain access to AMC resources.\n"," The new AMC APIs currently support features including reporting, signal management, and advertiser audience management.\n"," The migration of the AMC APIs to Amazon Ads API offers further enhanced security, usability, and performance, allowing developers to easily utilize, manage, and build with these APIs. Specifically,\n","Developers can now use the same authorization and authentication mechanism as rest of the Amazon Ads solution APIs, via client applications administered by Login with Amazon. This streamlines and simplifies the set up and access to relevant AMC accounts and instances. - Multiple users and partner organizations can now access one AMC instance at the same time. This enables more scalable AMC usage and operations, and it is especially beneficial for partners handling multiple AMC instances across advertisers. - Developers can now find AMC APIs grouped by functional categories, and following a standard endpoint naming convention composed of base URL, API path, and resources. This helps developers to easily comprehend and identify the APIs to use.\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"Where is AMC available?"},"path":"/en-us/guides/amazon-marketing-cloud/overview","content":["North America: United States, Canada, Mexico - South America: Brazil - Europe: Germany, Spain, France, Italy, Netherlands, United Kingdom, Sweden, Turkey, Poland, Belgium, Ireland - Middle East: Saudi Arabia, United Arab Emirates, Egypt - Asia Pacific: Australia, India, Japan, Singapore - Africa: South Africa, Nigeria\n"],"documentType":"guide"},{"title":"How does Amazon Marketing Cloud work","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/how-amc-works","content":[" Pseudonymized inputs from Amazon Ads campaign events such as ad impressions, ad clicks, and ad-attributed conversions that span across media, including streaming TV, audio, video, display, and sponsored ads are uploaded into AMC instances. Examples of common signal types that are uploaded include direct-to-consumer (D2C) store sales information, CRM records, and product catalog mapping.\n","| TILES Did you know?                                                                                                                                                                                                                        |\n","\\| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| AMC prioritizes privacy and security by design by accepting only pseudonymized information. All information in your AMC instance is handled in strict accordance with the Amazon privacy notice, and raw event information cannot be exported. |\n"," The signals you choose to upload stay within your dedicated AMC instance, and cannot be accessed or exported by Amazon.\n"," Through AMC, you may want to analyze the journey and path to conversion of your audience, or audience penetration, or want to consider the frequency distribution of an ad or optimal frequency that leads to a conversion.\n"," All analysis takes place within AMC, across dimensions like audiences, device, time, or campaigns to name a few and results are aggregated to generate anonymous reports that you can export.\n"],"documentType":"guide"},{"title":"How does Amazon Marketing Cloud work","sectionHeader":{"type":2,"text":"AMC UI and APIs"},"path":"/en-us/guides/amazon-marketing-cloud/how-amc-works","content":[" Amazon Marketing Cloud (AMC) is accessible through two primary methods:\n","Access via the web-based user interface within Amazon Ads console\n","Programmatic integration through the Amazon Ads API\n"," Please note that the AMC user interface is currently available exclusively in English, with no localization options for other languages.\n"],"documentType":"guide"},{"title":"How does Amazon Marketing Cloud work","sectionHeader":{"type":2,"text":"Gain access to AMC"},"path":"/en-us/guides/amazon-marketing-cloud/how-amc-works","content":[" AMC supports two access models:\n"," Self-service access (a single advertiser per instance). If you have a sponsored ads account or a global advertising account, you can use AMC self-service access to automatically create an AMC instance for that account and start using AMC within minutes. Each account gets a single instance scoped to that one advertiser; you cannot add other advertisers to it.\n","Access AMC through the user interface by navigating to AMC within your Amazon Ads console, or, after you onboard to the Amazon Ads API, follow the instructions in Instant self-service access to AMC.\n"," Account-based access (multiple instances and advertisers). If you want an instance whose scope includes multiple advertisers or Amazon DSP advertisers, use an account that supports multiple instances:\n","Manager accounts are the self-service option. A manager account can own multiple AMC instances, and each instance can include multiple advertisers linked to the manager account. For details, see AMC administration functions.\n","AMC accounts are provisioned by your AdTech AE or Partner when you apply for access. Your account is managed by a user your organization designates as the \"AMC admin\", who can create instances, add advertiser IDs to instances, and add users to view and analyze data in the assigned instances. For details, see AMC administration functions.\n"],"documentType":"guide"},{"title":"How does Amazon Marketing Cloud work","sectionHeader":{"type":2,"text":"AMC accounts and instances"},"path":"/en-us/guides/amazon-marketing-cloud/how-amc-works","content":[" To use AMC, you must first understand AMC account and instances, the fundamental building blocks of AMC that allow for a hierarchical structure.\n"," An AMC account represents the advertiser or agency as the top-level organizational unit, and contains one or more instance(s). An instance is the actual AMC \"clean room\" that is set up for a given advertiser or company.\n"],"documentType":"guide"},{"title":"How does Amazon Marketing Cloud work","sectionHeader":{"type":3,"text":"AMC accounts"},"path":"/en-us/guides/amazon-marketing-cloud/how-amc-works","content":[" Access to AMC is managed at the account level. An admin user can create instances, grant organization users access to specific instances within the account, and invite additional admins. This granular access control allows selective user access to accounts and instances, enabling agencies to manage multiple accounts across multiple advertisers, brands, or entities under a single corporate umbrella.\n"," For details see AMC account management.\n"],"documentType":"guide"},{"title":"How does Amazon Marketing Cloud work","sectionHeader":{"type":3,"text":"AMC instances"},"path":"/en-us/guides/amazon-marketing-cloud/how-amc-works","content":[" An instance contains records from only a single brand or company. AMC allows for the following types of instances:\n","Standard instances: Contains Amazon Ads events for a single advertiser, and mapped to one or multiple Amazon DSP accounts and or sponsored ads entities. Admin users can create standard instances.\n","Sandbox instances: Contains synthetic signals generated to mimic the structure and statistical properties of AMC signals. All AMC accounts have been granted a sandbox instance. This type of instance is not supported for AMC instances created using the instant access API.\n","Collaboration instances: The integration of AMC on AWS Clean Rooms enables advertisers to seamlessly collaborate with Amazon Ads exclusive signals, using your data from the AWS environment of the advertiser. Reach out to your AdTech AE to request a collaboration instance. This type of instance is not supported for AMC instances created using the instant access API.\n"],"documentType":"guide"},{"title":"How does Amazon Marketing Cloud work","sectionHeader":{"type":3,"text":"Data in your AMC instance"},"path":"/en-us/guides/amazon-marketing-cloud/how-amc-works","content":[" Data in your instance can be Amazon owned or customer or advertiser owned.\n"," Data from your Amazon Ads campaign events can include impressions and clicks from Amazon DSP ads and Amazon sponsored ads campaigns, as well as purchase events from Amazon stores to perform advanced analytics.\n"," After your instance is set up, it is back-filled with 13 months of Amazon-owned advertising insights (if available) from your DSP or sponsored ads accounts. Advertising events accumulate for up to 13 months in your instance. This means your instance will always have the most recent 13 months of event-level information.\n"," You can also bring in your own customizable datasets to AMC instances using Advertiser data upload. The datasets containing supported identifiers can be joined with AMC data to attribute off-Amazon events (purchases, sign-ups, store visits, etc.) to Amazon advertising events such as impressions and clicks.\n"," You can then leverage both signals from your Amazon campaigns and your uploaded datasets for planning and measurement use cases to gain insights, optimize campaigns, and finally create audiences.\n"," You can also opt-in for AMC Paid features to avail more datasets and insights for deeper analysis of your campaigns and audience creation outcomes.\n"," For details, see AMC data sources and review the important notes for querying the data sources.\n"],"documentType":"guide"},{"title":"How does Amazon Marketing Cloud work","sectionHeader":{"type":3,"text":"Queries in AMC"},"path":"/en-us/guides/amazon-marketing-cloud/how-amc-works","content":[" AMC allows you to access the data from your instances through the use of queries written in AMC Structured Query Language (AMC-SQL). Queries can be written to generate custom metrics and insights tailored to your business, enabling you to make more informed decisions on your campaign spend.\n"," AMC SQL is a custom query language that supports most of the basic SQL operations, designed to help advertisers interact with event-level records to generate aggregated outputs, which lead to insights for campaign measurement, audience analysis, media optimization, or to create audiences.\n"," When you submit a query for processing, the AMC data aggregation thresholds are enforced to ensure the output contains aggregated and anonymous results to protect customer privacy.\n"," You can use the AMC workflow management service to programmatically manage your queries.\n"," After you run your queries, you can get your results in any of the following ways:\n","Through a download URL.\n","Through your connected S3 bucket, to which your query results are stored.\n"],"documentType":"guide"},{"title":"AMC consent management","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc_consent_management","content":[" If you transmit or make available to Amazon Ads any personal information in connection with your use of any Amazon advertising services in the UK and EEA, you must share a valid consent signal and the country code in which consent was granted by the customer. \n"],"documentType":"guide"},{"title":"AMC consent management","sectionHeader":{"type":2,"text":"Consent Signals"},"path":"/en-us/guides/amazon-marketing-cloud/amc_consent_management","content":[" You can use one of the following to communicate privacy choices of UK and EEA users to Amazon Ads:\n","The IAB European Transparency & Consent Framework (TCF) signal(s)\n","Global Privacy Protocol (GPP)\n","Amazon Consent Signal (ACS)\n"],"documentType":"guide"},{"title":"AMC consent management","sectionHeader":{"type":3,"text":"Country Code"},"path":"/en-us/guides/amazon-marketing-cloud/amc_consent_management","content":[" You must share a country code when passing consented data of customers to Amazon Ads. The country code is a 2-character string in the ISO 3166 format that indicates in which country the consent was given (for example, US, GB or DE).\n"],"documentType":"guide"},{"title":"AMC consent management","sectionHeader":{"type":3,"text":"What is Amazon Consent Signal?"},"path":"/en-us/guides/amazon-marketing-cloud/amc_consent_management","content":[" In addition to supporting the Interactive Advertising Bureau (IAB) Transparency & Consent Framework (TCF) signal and Global Privacy Protocol (GPP), Amazon Ads has introduced Amazon Consent Signal (ACS) which enables you to transmit the privacy choices of end users to Amazon Ads in the UK and EEA. There are three required parameters: \n"," Acceptable values: 2-character ISO 3166 format (for example, US, GB, DE).\n"," If CountryCode is missing, Amazon may reject the data record entirely.\n"," Acceptable values are GRANTED or DENIED.\n"," Accepted inputs: GRANTED, DENIED, or NULL.\n"," Please refer to Sending Personal Information to Amazon Ads & Amazon Consent Signal requirements to know more about the policy.\n"," The above-mentioned data decoration standards for country codes and consent signals apply to all advertisers and 3Ps using AMC.\n","Provide consent for uploads using Advertiser data upload APIs\n","Provide consent for data in AMC - AWS Clean Rooms collaboration instances\n"],"documentType":"guide"},{"title":"Get started with Amazon Marketing Cloud","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/get-started/get-started","content":[" To work with AMC APIs, you need to have:\n","An AMC instance with the basic requirements to start querying your data. - A Login with Amazon account through which you have onboarded the Amazon Ads API. - An S3 bucket to store the output of your queries (optional).\n"],"documentType":"guide"},{"title":"Get started with Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"Requirements for an AMC instance"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/get-started","content":[" To work with AMC programmatically, you must have an instance that fulfills the following basic requirements for utilizing AMC:\n","Planned campaigns, or campaigns that were live in the last 28 days. - Working knowledge of AMC SQL. - DSP advertiser IDs and/or sponsored ads IDs to be included in your AMC instance.\n"],"documentType":"guide"},{"title":"Get started with Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"Onboard the Amazon Ads API"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/get-started","content":[" After you have access to an AMC account, and possess your instance identifier, you will have to set up your Amazon Ads API developer account. Onboarding the Amazon Ads APIs requires you to perform the following steps:\n","Create a Login with Amazon application. 2. Apply for permission to access the API. The application form includes questions about how your business intends to use the Amazon Ads API, as well as information about the Amazon Ads API License Agreement, the Data Protection Policy, and 3. Create an authorization grant. To generate the necessary access tokens to successfully perform an API request, you first need to create an authorization grant and then retrieve access and refresh tokens.\n"],"documentType":"guide"},{"title":"Get started with Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"Set up S3 buckets (optional)"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/get-started","content":[" AMC offers the flexibility of viewing the outputs of your workflows either through:\n","a download URL using the GET /amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId}/downloadUrls endpoint, - or by sending your query execution results to an S3 bucket that is linked to your instance.\n"," Once your instance is created, update your instance to include your connected AWS account and S3 bucket name. You will then use the CloudFormation link generated to create an S3 bucket within your account, and grant the AMC account to save your query results to that S3 bucket.\n"," Since the bucket is created within your account, it is therefore a bucket that is owned by your AWS account.\n"," The S3 bucket for AMC is used to store the results of both ad-hoc workflows and scheduled workflows. CloudFormation is used to set up the S3 bucket and link it to the AMC instance. For more information on CloudFormation, refer to What is CloudFormation? in AWS documentation.\n"],"documentType":"guide"},{"title":"Get started with Amazon Marketing Cloud","sectionHeader":{"type":3,"text":"Create S3 bucket using CloudFormation"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/get-started","content":[" To create the S3 bucket using CloudFormation:\n","Sign in to your AWS account as the admin user. 2. Click the CloudFormation URL. This is the URL that is displayed on the Instance Info page in the AMC UI. 3. The creation of the S3 bucket will begin. On the Stacks page, you will see the Status. Wait for this to reach CREATE_COMPLETE. 4. Once the Status field displays CREATE_COMPLETE, select the AMC stack and navigate to the Resources tab. From the Physical ID column, click the link to the S3 bucket.\n","The S3 bucket is displayed. When the S3 bucket is first created, it is empty. Once you begin to execute queries and/or schedule them, you will see folders for each workflow. Here is what it will look like after you execute queries, or after scheduled queries are run.\n"," The S3 bucket is used to store the results of both ad-hoc workflows and scheduled workflows. Each folder maps 1:1 with a query or \"workflow\".\n"," AMC output data is accessed through three primary resources:\n","workflows - A workflow maps 1:1 with a SQL query. - workflowExecutions - A workflowExecution runs a workflow on an ad-hoc basis. - workflow schedules - A workflow schedule runs a defined workflow on a predefined cadence and interval.\n"," Each workflow will have a folder automatically created in S3 once it has been either scheduled or executed. For more details on the S3 folder path, see Understand S3 Folder Path.\n"],"documentType":"guide"},{"title":"Get started with Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"AMC rate limits"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/get-started","content":[" AMC enforces API rate limits to ensure all clients can use AMC effectively. API rate limits are defined as a maximum number of calls a client can make to each platform endpoint within a time period. If your app makes a lot of API requests in a short period of time then it may receive a 429 error response. The limits are subject to change.\n"," AMC has limits on the concurrency of workflow executions at both the account and instance level. For more details, see Query execution limits\n"],"documentType":"guide"},{"title":"Get started with Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/get-started","content":[],"documentType":"guide"},{"title":"Get access to AMC using self-service APIs","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/get-started/instant-access-to-amc","content":[" If you have a sponsored ads account or a global advertising account, you can use AMC instant self-service access to automatically create an AMC instance associated with that account, allowing you access to AMC within minutes. The instance is scoped to that single advertiser.\n"],"documentType":"guide"},{"title":"Get access to AMC using self-service APIs","sectionHeader":{"type":2,"text":"Requirements"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/instant-access-to-amc","content":["Customers have onboarded to Amazon Ads API. For more information, refer to Get started. \\* Customer must have a sponsored ads account (and know its sponsored ads entity ID) or a global advertising account (and know its global advertising account ID, which begins with amzn1.ads-account.g.).\n"],"documentType":"guide"},{"title":"Get access to AMC using self-service APIs","sectionHeader":{"type":3,"text":"Configure header parameters"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/instant-access-to-amc","content":["| Header                               | Description                                                                                                                                                           |\n","\\|--------------------------------------\\|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|\n","| Amazon-Advertising-API-ClientId      | The client ID related to a Login with Amazon application.                                                                                                             |\n","| Amazon-Advertising-API-MarketplaceId | The marketplace identifier for the marketplace of the advertiser. For global advertising accounts, always use US (ATVPDKIKX0DER).                                             |\n","| Amazon-Advertising-API-AdvertiserId  | Your advertiser account ID: the sponsored ads entity ID for a sponsored ads account, or the global advertising account ID (beginning with amzn1.ads-account.g.) for a global advertising account. This is not an AMC entity ID. Use it for API calls to instances created with AMC instant self-service access APIs. |\n","| Authorization                        | Login with Amazon token in the form of Bearer {token}.                                                                                                                 |\n"],"documentType":"guide"},{"title":"Get access to AMC using self-service APIs","sectionHeader":{"type":2,"text":"Get access to your instance"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/instant-access-to-amc","content":["Use the GET /amc/instances endpoint to retrieve your instance.\n","If you receive the message \"Terms and conditions must be accepted to continue,\" you must accept the terms and conditions before you can proceed. Log into the AMC UI using the email address that is associated with Login with Amazon. If you have not logged into the AMC UI before, you will need to create an account using the email address associated with Login with Amazon. AMC terms and conditions must be accepted once in each region (NA, EU, and FE) where the AMC instance is going to be created and accessed.\n"," Sample response\n","Continue to call the GET /amc/instances endpoint in a loop until the creationStatus is COMPLETED. AMC instance creation takes up to 300 seconds.\n"," Sample response\n","The instance created will be a standard AMC instance. Note that Sandbox and collaboration instances are not created using the self-service APIs. 5. Once it is complete, you are ready to access the instance using AMC APIs. Note the supported and unsupported endpoints listed below.\n"],"documentType":"guide"},{"title":"Get access to AMC using self-service APIs","sectionHeader":{"type":2,"text":"Supported/unsupported endpoints"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/instant-access-to-amc","content":[],"documentType":"guide"},{"title":"Get access to AMC using self-service APIs","sectionHeader":{"type":3,"text":"Supported"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/instant-access-to-amc","content":[" Most AMC APIs are supported when using an instant self-service access instance, including reporting and audiences APIs. The following table outlines the AMC administration APIs that are supported with self-service instances.\n"," Note: This is not an exhaustive list of supported endpoints.\n","| Endpoints                                   |\n","\\|---------------------------------------------\\|\n","| GET /amc/instances                          |\n","| GET /amc/instances/{instanceId}             |\n","| PUT /amc/instances/{instanceId} (Supported for updating awsAccountId, s3BucketName, and instanceName)           |\n","| GET /amc/instances/{instanceId}/advertisers |\n"],"documentType":"guide"},{"title":"Get access to AMC using self-service APIs","sectionHeader":{"type":3,"text":"Not supported"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/instant-access-to-amc","content":[" With self-service instances, operations like creating new instances, deleting instances, adding advertisers to instances, and other instance, account, and user modifications are not supported. The following table lists the AMC administration endpoints that are not supported.\n"," Using the following endpoints for an on-demand instance is not supported and will return 400.\n","| Endpoints                                                                 |\n","\\|---------------------------------------------------------------------------\\|\n","| PUT /amc/instances/{instanceId} (Not supported for updating advertiserName) |\n","| POST /amc/instances                                                       |\n","| DELETE /amc/instances/{instanceId}                                        |\n","| GET /amc/instances/{instanceId}/advertisers/updates                       |\n","| GET /amc/instances/{instanceId}/advertisers/updates/{update}              |\n","| POST /amc/instances/{instanceId}/advertisers/updates                      |\n"," Additionally, access to the advertiser data upload APIs is not supported for self-service instances. The following data upload operations will return a 400.\n","| Endpoints                                                                 |\n","\\|---------------------------------------------------------------------------\\|\n","| POST /amc/advertiserData/{instanceId}/dataSets |\n","| POST /amc/advertiserData/{instanceId}/dataSets/list                                                       |\n","| DELETE /amc/advertiserData/{instanceId}/dataSets/{dataSetId}                                        |\n","| GET /amc/advertiserData/{instanceId}/dataSets/{dataSetId}                       |\n","| PUT /amc/advertiserData/{instanceId}/dataSets/{dataSetId}              |\n","| POST /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns                      |\n","| DELETE /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns/{columnName}                      |\n","| PUT /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns/{columnName}                      |\n","| POST /amc/advertiserData/{instanceId}/uploads/{dataSetId}                      |\n","| POST /amc/advertiserData/{instanceId}/uploads/list                      |\n","| GET /amc/advertiserData/{instanceId}/uploads/{dataSetId}/{uploadId}                      |\n","| POST /amc/advertiserData/{instanceId}/userDeletionRequest                      |\n","| POST /amc/advertiserData/{instanceId}/userDeletionRequest/list                      |\n","| GET /amc/advertiserData/{instanceId}/userDeletionRequest/{userDeletionRequestId}                      |\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/get-started/make-your-first-call","content":[" The tutorial in this section will walk you through the steps to set up your header parameters and make your first AMC call for advertisers.\n"," Before you can begin with any of the tutorials, you must have:\n","One of the following account types:  Established a client application on Amazon Ads API through Login with Amazon  Completed all the prerequisites as described in the Get started section, and generated access token to gain access to Amazon Ads API.\n"," To make your first call, we will use the GET method of the amc/instances endpoint to retrieve the instance(s) associated with your account.\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/make-your-first-call","content":[" To make your first call, you will need to know the following:\n","Your base URL - Your marketplace identifiers - Header parameters\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"Ads API base URLs"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/make-your-first-call","content":[" All of the APIs share a common URL prefix depending on the region. These URLs are:\n","| Region        | Base URL                                                                    |\n","\\| ------------- \\| --------------------------------------------------------------------------- \\|\n","| North America | https://advertising-api.amazon.com       |\n","| Europe        | https://advertising-api-eu.amazon.com |\n","| APAC          | https://advertising-api-fe.amazon.com |\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"Marketplace"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/make-your-first-call","content":[" The marketplace identifiers called in requests through the Amazon-Advertising-API-MarketplaceId header parameter are tied to a country, as listed in the tables below:\n","| Country                  | Marketplace ID | Country code |\n","\\| :----------------------- \\| :------------: \\| :----------: \\|\n","| Brazil                   | A2Q3Y263D00KWC |      BR      |\n","| Canada                   | A2EUQ1WTGCTBG2 |      CA      |\n","| Mexico                   | A1AM78C64UM0Y8 |      MX      |\n","| United States of America | ATVPDKIKX0DER |      US      |\n","| Country              | Marketplace ID | Country code |\n","\\| :------------------- \\| :------------: \\| :----------: \\|\n","| Germany              | A1PA6795UKMFR9 |      DE      |\n","| Spain                | A1RKKUPIHCS9HS |      ES      |\n","| France               | A13V1IB3VIYZZH |      FR      |\n","| Italy                | APJ6JRA9NG5V4 |      IT      |\n","| Netherlands          | A1805IZSGTT6HS |      NL      |\n","| Sweden               | A2NODRKZP88ZB9 |      SE      |\n","| Turkey               | A33AVAJ2PDY3EV |      TR      |\n","| United Kingdom       | A1F83G8C2ARO7P |      UK      |\n","| Saudi Arabia         | A17E79C6D8DWNP |      SA      |\n","| United Arab Emirates | A2VIGQ35RCS4UG |      AE      |\n","| Country   | Marketplace ID | Country code |\n","\\| :-------- \\| -------------- \\| ------------ \\|\n","| Australia | A39IBJ37TRP1C6 | AU           |\n","| Japan     | A1VC38T7YXB528 | JP           |\n","| India     | A21TJRUUN4KGV  | IN           |\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"Header parameters"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/make-your-first-call","content":[" In addition to the individual API parameters, the following header parameters are required for most of your calls.\n","| Header                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |\n","\\| :----------------------------------- \\| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| Amazon-Advertising-API-ClientId      | The client ID related to a Login with Amazon application.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |\n","| Amazon-Advertising-API-MarketplaceId | The marketplace identifier for the marketplace in the request. Marketplaces are tied to the country.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |\n","| Amazon-Advertising-API-AdvertiserId  | For instant self-service access, this is your advertiser account ID: the sponsored ads entity ID for a sponsored ads account, or the global advertising account ID (beginning with amzn1.ads-account.g.) for a global advertising account. Otherwise, this is your AMC account identifier (provided by your Amazon Ads account executive) or your manager account ID.   |\n","| Authorization                        | Login with Amazon token in the form of Bearer {token}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |\n","| Content-type                         | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |\n","The Amazon-Advertising-API-MarketplaceId parameter is exclusive to AMC APIs and is not required for other Amazon Ads APIs. Make sure you specify the marketplace of your account when calling AMC APIs. For global advertising accounts and manager accounts, always use the US marketplace (ATVPDKIKX0DER). \\* Similarly, the Amazon-Advertising-API-AdvertiserId is a mandatory header parameter, required for all AMC APIs. For instant self-service access, this is your advertiser account ID: the sponsored ads entity ID for a sponsored ads account, or the global advertising account ID (beginning with amzn1.ads-account.g.) for a global advertising account. Otherwise, this is an AMC account identifier (provided by your Amazon Ads account executive when you onboarded AMC) or your manager account ID. To determine the AMC account identifier, you can access the AMC console with your user identifier and password, and grab the entity identifier value that is displayed in the URL. The alphanumeric code that is prefixed with ENTITY is your account identifier. You can also use the GET operation of the /amc/accounts endpoint that returns a list of all the accounts your client ID has access to. An example of an account identifier is: ENTITY1AA1AA11AAA1.\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":2,"text":"Your first call"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/make-your-first-call","content":[" Now, retrieve all the instances in your account using one of the following approaches:\n","Using cURL - Using Postman\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"Using cURL"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/make-your-first-call","content":[" You can use cURL to retrieve all instances in your account using the North America URL prefix.\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":3,"text":"Using Postman"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/make-your-first-call","content":[" In this example, we use Postman, an API platform that has an easy-to-use graphical user interface (GUI).\n","Download and install Postman. 2. Open Postman and click Create new collection. The collection will be used to group requests and for inheritance of authorization parameters, saving time and effort. 3. Name your collection (for example, Amazon Ads APIs). 4. Set up your environment and collection by following these instructions. 5. Generate an authorization grant code and retrieve access and refresh tokens to complete your authorization.\n"," Your authorization credentials will expire after 24 hours. When the authorization credentials expire, you will receive an HTTP 403 forbidden response when calling the API. To update, you need to re-generate your authorization credentials and update the parameters in the collection's Authorization tab with the regenerated details. Refer to Generate API access credentials for more information about generating the tokens.\n","Click Add request within the newly created collection to create a new request. This will inherit the authorization parameters of the collection. 7. Name your request (for example, Retrieve all instances).\n"," By default, Postman creates a GET request.\n","In the request URL field, enter the base AMC API URL and append the endpoint path for the workflow executions resource (/instances). Using the North America URL prefix, your request will look something like the example below.\n","On the Headers tab, add the mandatory header parameters with the appropriate values for each. 10. Click Send. If successful, you will receive a response with the HTTP status code 200 OK and the following response parameters:\n"," If you receive a response code other than 200, check if your credentials are authenticated and that your token has not expired.\n"," If you receive the message \"Terms and conditions must be accepted to continue,\" you must accept the terms and conditions before you can proceed. Log into the AMC UI using the email address that is associated with Login with Amazon. If you have not logged into the AMC UI before, you will need to create an account using the email address associated with Login with Amazon. AMC terms and conditions must be accepted once in each region (NA, EU, and FE) where the AMC instance is going to be created and accessed.\n"],"documentType":"guide"},{"title":"Make your first call","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/get-started/make-your-first-call","content":[" For instances created using instant self-service access API, you can begin using the AMC APIs to run reporting workflows and create audiences. Note that adding and modifying accounts, users, and instance scope is not supported for instances created using instant self-service access API.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - API administration overview","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/admin/1_amc_administration","content":[" As the administrator of an AMC account, you can programmatically perform tasks like managing accounts, instances, and users in your organization. You can also manage and invite users in your organization to your account and elevate their role to an administrator.\n"," In addition to the programmatic methods described in this section, AMC account admins have an alternative option for managing accounts and instance access directly through the user interface. From the Ads console, admins can navigate to Administration > Account access & settings to configure account permissions and settings. For more information, refer to Add or remove users from your organization's account.\n"," The developer guide details the following areas that an AMC administrator manages:\n","Accounts: An AMC account represents an advertiser or partner organization, is managed by an account administrator, who can invite other users to access or administer the account. - Users: AMC has two primary types of users, \"Admins\" responsible for managing AMC accounts and instances, and \"Viewers\" - users with the ability to view and use the accounts. - Instances: An instance is the actual AMC \"clean room\" that is set up for a given advertiser or company. Event-level signals for a given set of advertiser IDs start to accumulate in the instances and made available for querying. A single AMC account can contain more than one \"instance\". \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/admin/account-management","content":[" An AMC account represents an advertiser or partner organization. Each account can have one or more \"instances\" associated with the account. This top-level account, also known as an AMC entity, is managed by an account administrator, who can then invite other users to access or administer the account.\n"," We will refer to the account administrator as \"admin\" or \"admin user\" in this section. The admin user has permissions to associate and manage one or more AMC instances, and add users to instances in the account.\n"," In the sections below, we will discuss how to manage an account using the AMC account administration APIs and perform tasks to manage users in the organization.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":2,"text":"Retrieve AMC account Id"},"path":"/en-us/guides/amazon-marketing-cloud/admin/account-management","content":[" To work with your AMC account, you must know your AMC account Id.\n"," When you register for Amazon Ads, and are approved for AMC access, an Amazon Ads account executive would have created your AMC account and provided you your AMC account Id.  The AMC account ID, also known as the entity identifier, is a unique alphanumeric code that identifies your AMC account.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":3,"text":"Retrieve AMC account Id from AMC console"},"path":"/en-us/guides/amazon-marketing-cloud/admin/account-management","content":[" If you already have access to the AMC console, you can log in using your credentials and find your AMC account ID in the URL. The AMC account ID is the alphanumeric code prefixed with \"ENTITY\". For example, a valid AMC account ID (entity identifier) could be \"ENTITY1AA1AA11AAA1\".\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":3,"text":"Retrieve AMC account Id using AMC APIs"},"path":"/en-us/guides/amazon-marketing-cloud/admin/account-management","content":[" Alternatively, if you have already onboarded Amazon Ads API using your Login with Amazon credentials, use the GET operation of the /amc/accounts resource.\n"," The mandatory header parameters for this operation are:\n","| Header                          | Description                                               |\n","\\| ------------------------------- \\| --------------------------------------------------------- \\|\n","| Amazon-Advertising-API-ClientId | The client ID related to a Login with Amazon application. |\n","| Authorization                   | Login with Amazon token in the form of Bearer {token}.    |\n"," Note the value of the accountId in the above response and use that to pass it as the value for the Amazon-Advertising-API-AdvertiserId header parameter, required for most AMC calls.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":3,"text":"Retrieve advertiser accounts"},"path":"/en-us/guides/amazon-marketing-cloud/admin/account-management","content":[" For AMC to access data from your Amazon advertising campaigns, you will need to provide your advertiser account information. Visit the pages below to know how to retrieve your advertiser account ids.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":2,"text":"Manage users"},"path":"/en-us/guides/amazon-marketing-cloud/admin/account-management","content":[" As an AMC administrator, you are your organization's nominated \"system admin\". You can manage multiple advertising accounts from your organization and can programmatically invite users from your organization to join the AMC account.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":3,"text":"Invite users"},"path":"/en-us/guides/amazon-marketing-cloud/admin/account-management","content":[" Users can be invited to join your organization's AMC account as administrators or as viewers.\n"," Use the POST /user-invitations endpoint to create an invitation.\n"," To create an admin user, the permissionSet property in your request payload must be set to admin. For a non-admin user, the permissionSet property must be set to viewer.\n"," Invited users are sent an email with the invitationId. To join the AMC account, the invited user must accept the AMC terms and conditions to redeem the invite.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":3,"text":"Redeem invite"},"path":"/en-us/guides/amazon-marketing-cloud/admin/account-management","content":[" The invited user must click the link in the invitation email to view and accept the terms.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":3,"text":"Update user invitation"},"path":"/en-us/guides/amazon-marketing-cloud/admin/account-management","content":[" To update user invitations that you have already sent, use the PUT /user-invitations endpoint. You can update the invitation state to revoke the invitation or resend the invitation.\n"," For more details on the user invitation management APIs, see the user invitation reference documentation.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" An AMC instance is the actual cloud-based clean room that is set up for a given advertiser or company in which event-level signals for the given set of advertiser Ids start to accumulate. The signals in instances are made available for querying to generate analytics and build audiences. Some advertisers have multiple instances to represent different business units, brands, or subsidiaries, but as long as those instances all represent the same company advertising on Amazon they can be within one instance created under a single account.\n"," Admin users can create instances and then add the identifiers of the advertisers (whether sponsored ads or Amazon DSP) to include in the instance.\n"," The day an instance is created, it is back-filled with 13 months of advertising insights, allowing you to query and accumulate for up to 13 months. This means that one year after you created your instance, you will always have the most recent 13 months of event-level information in the instance.\n","For instances that have been live for over 13 months, they will contain the most recent 13 months of records, with older records having aged out.\n","Before running queries, note that AMC does not ingest data at real-time and propagates your ad activity data after a time-lag. As a best practice, AMC recommends that you select a date range of 48-hours prior to the current date.\n","An S3 bucket associated with your instance is an optional requirement. When your instance is created, admin user can set up an S3 bucket to which the instance will write results.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":2,"text":"Create an instance"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" AMC now offers admin users the ability to create instances.\n"," Use the POST operation of the /amc/instances endpoint to create an instance with the instance name as the only mandatory request parameter. The mandatory header parameters are listed below:\n","| Header                                  | Description                                                                                                                            |\n","\\| --------------------------------------- \\| -------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| Amazon-Advertising-API-ClientId      | The client Id related to a Login with Amazon application.                                                                              |\n","| Amazon-Advertising-API-MarketplaceId | The marketplace identifier for the marketplace. |\n","| Amazon-Advertising-API-AdvertiserId  | The AMC account identifier. See Retrieve accounts.                            |\n","| Authorization                           | Login with Amazon token in the form of Bearer {token}.                                                                               |\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" The following optional parameters can be passed as the request body:\n","advertiserName: Optionally, pass the name of the advertiser (advertiserName) associated with the instance you are creating, ensure that the advertiser name can only contain letters (both uppercase and lowercase), numbers, and spaces. Special characters (except spaces) are not allowed in the advertiser name, and the advertiser name cannot start or end with a space.\n","awsAccountId: If required, and if you are using a connected Amazon Web Service (AWS) account in which you will create an Amazon S3 bucket to receive your query results, you can specify the awsAccountId of connected AWS account.\n","s3BucketName: If you have already created an Amazon S3 bucket, you can also optionally pass the Amazon S3 (s3BucketName) bucket name to which the results of the queries run in this instance will be saved.\n"," Following is a sample request body with all the optional parameters included:\n"," AMC will validate your request and respond as shown below.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":3,"text":"Sample response"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" The operation initiates a request to create a standard instance.\n"," The instance request process goes through the following statuses until the request succeeds and an instance is ready:\n","REQUESTED: Instance creation is successfully requested.\n","SUBMITTED: Instance creation request is submitted for processing.\n","IN_PROGRESS: Instance creation is in progress.\n","SUCCEEDED: This field is no longer in use, and is replaced with the COMPLETED status.\n","COMPLETED: Instance creation is successful.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":3,"text":"View instance details"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" To view the details or the status of a specific instance, use the GET /amc/instances/{instanceId} endpoint.\n"," To view all instance details associated with your account, use GET /amc/instances.\n"," The response displays the following fields, that can be edited using the PUT/amc/instances/{instanceId}:\n","instanceName: The name of the instance\n","The other fields are internal-only and have set expected values.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":2,"text":"Update instance information"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" To update an instance, use PUT/amc/instances/{instanceId}. You can request modifications only after the status of the instance is COMPLETED. You can modify values for the following parameters:\n","instanceName\n","advertiserName\n","awsAccountId\n","s3BucketName\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":3,"text":"Update connected AWS account"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" The POST/amc/instances/{instanceId}/updateCustomerAwsAccount operation allows you to manage the AWS account associated with your instance. Results (from both manual queries run in the UI and automated queries scheduled through APIs) are delivered to the S3 bucket associated with your AWS account. The updateCustomerAwsAccount operation accepts the awsAccountId and the S3 bucket name as the payload of the request body and returns a CloudFormation link that you can use to update the S3 bucket.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":3,"text":"Delete an instance"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" To delete a specific instance, use DELETE/amc/instances/{instanceId}. The requested instance is deleted only if the creationStatus of the requested instance is SUCCEEDED.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":2,"text":"Add or remove advertisers"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" After successfully creating your instance, you can add the IDs of the advertiser accounts you want to include in your instance using the POST /amc/instances/{instanceId}/advertisers/updates endpoint.\n"," While all instances start with the same standard configuration, the type of advertisers you add to your instance determines its classification as a sponsored ads or an Amazon DSP instance. AMC also allows for a hybrid instance, which contains both sponsored ads and Amazon DSP advertisers.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":3,"text":"Add a single advertiser to an instance"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" Depending on the type of advertiser you add (Amazon DSP advertiser or sponsored ads advertiser), the request body is constructed as illustrated below:\n","| Request body parameter | Amazon DSP advertisers                                                                                                                  | Sponsored ads advertiser                                                                                                                                                                                                                                                       |\n","\\| :--------------------- \\| :-------------------------------------------------------------------------------------------------------------------------------------- \\| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| advertiserType     | DISPLAY                                                                                                                                 | SPONSORED_ADS                                                                                                                                                                                                                                                                  |\n","| id                 | Numerical ID, retrieved using GET /dsp/advertisers. Copy the value of the advertiserId returned in the response body. | ID prefixed with ENTITY, retrieved using POST /adsAccounts/list. Copy the value of the entityId parameter in the response body.                                                                                               |\n","| marketplaceId      | Not required for Amazon DSP advertisers.                                                                                                | Required for sponsored ads account. Use the marketplace ID tied to the country of your sponsored ads account. Note that this marketplaceId may differ from the marketplaceId of your AMC account. |\n"," Sample request - sponsored ads\n"," Sample response - sponsored ads\n"," Sample request - Amazon DSP\n"," Sample response - Amazon DSP\n"," The request creates an advertiser update for the requested AMC instance to add (or remove) advertiser ids to the instance.\n"," AMC now automatically approves advertiser additions for single advertiser requests. When an admin user requests to add a single advertiser to any instance type, AMC verifies that the advertiser's data can be accessed for the instance's account.\n"," For AMC account instances, AMC verifies the access of the requesting admin user to the advertiser account through one of the following methods:\n","| Advertiser Type  | Admin User Verification     |\n","\\| --- \\|---  \\|\n","| Amazon DSP    | Direct console access   AMC verifies if the requesting admin user has direct access to the account of the advertiser through the Amazon Ads console. You can also validate your direct access using Advertising User Permissions Management APIs.  If the verification is successful, the requested advertiser ID is immediately added to the instance with access to 13 months of historical data.          |\n","| Sponsored ads | Direct console access   AMC verifies if the requesting admin user has direct access to the account of the advertiser through the Amazon Ads console.  You can also validate your access using Advertising User Permissions Management APIs.  or  Indirect API-only access: - The requesting admin user has been granted access to the data of the advertiser through a Login with Amazon (LwA) authorization. Indirect API-only access only applies to partner accounts. The LwA application that was granted access must be linked to the partner account and the requesting AMC admin user invoking the API must be a user in the partner account.  - The initial relationship of the requesting admin user with the advertiser data is established by making API calls. This can be done either through one campaign management call or two calls of any other type. Note that after making the initial API calls, there is a mandatory 3-day waiting period. This time allows AMC to establish and verify the connection between the LwA client ID of the requesting admin user and the advertiser account.  Note that to ensure the authorization relationship is current and active, the initial API call must have been made within the last 90 days.   -  Submit your request to add the advertiser using the POST/amc/instances/{instanceId}/advertisers/updates endpoint. Ensure that this call is made 3 days after the mandatory wait period.    Once verified, the requested advertiser ID is immediately added to the instance with access to 13 months of historical data. If the access of the requesting admin user to the data of the advertiser cannot be verified, the following error message is returned, and the request is rejected. This request was rejected because the requesting user does not have access to the following advertisers included in the request: ${advertisers}. You can resolve this by gaining direct access to the advertiser account(s) via the Amazon Ads console, or access to the advertiser data through a Login with Amazon (LwA) authorization and make at least one API call within the past 90 days before making this request again.  For more information on LwA access, see Add users to your organization's developer account. |\n"," For manager account instances, AMC does not verify the requesting user's individual access to each advertiser. Instead, access is determined by whether the advertiser account is linked to the manager account. The requesting user must be an administrator of the manager account.\n"," The type of link required depends on the advertiser type:\n","Sponsored ads advertisers: any link between the sponsored ads account and the manager account is sufficient to add the advertiser to the manager account's instances.\n","Amazon DSP advertisers: an admin link is required. This admin link exists only between a DSP account (CFID) and the manager account that created that DSP account.\n"," The same-brand requirement still applies: advertisers combined in a single manager account instance must belong to the same brand or parent company, and requests that cannot be confirmed programmatically follow the same review and rejection behavior described above.\n"," Keeping advertisers accessible. AMC continuously verifies that every advertiser attached to a manager account instance is still accessible through the manager account. If an advertiser account is later unlinked from the manager account, AMC blocks the instance from further use until you resolve the issue. To restore access, either remove the affected advertiser from the instance, or re-link the advertiser account to the manager account.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":3,"text":"Add multiple advertisers to an instance"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" You can add up to 10 advertiser Ids to an instance in a single modification call. However, an instance is limited to 2,000 advertiser Ids in total.\n"," Sample request - sponsored ads\n"," Sample response - sponsored ads\n"," Sample request - Amazon DSP\n"," Sample response - Amazon DSP\n"," When verifying multiple advertiser additions in a request, AMC validates and approves the advertiser Ids addition requests as described below:\n"," Approval for multiple sponsored ads entities added to an instance\n"," For requests with multiple sponsored ads entities for inclusion in an instance, AMC first performs the standard admin user access verification. Then, AMC will verify the relationship of the requesting admin user with the advertiser.\n"," If AMC cannot programmatically confirm the relationship of the requesting admin user with the advertiser Ids, the request will require a manual review. The AMC team will evaluate the relationship of the requesting admin user within 2 business days and then send either an approval or rejection notification.\n"," You can check the status of your request using the GET /amc/instances/{instanceId}/advertisers/updates/{updateId} endpoint. This endpoint requires the updateId from your POST request.\n"," If the manual review shows that the sponsored ads advertiser Ids are not linked to the account of the requesting admin user, the following error message shows up, and the request is rejected.\n"," Before resubmitting the request, ensure all the advertiser Ids belong to the same brand.\n"," When both validations are successful, the request is approved automatically, and the sponsored ads advertiser Ids are added to the instance, with access to 13 months of historical data.\n"," Approval for multiple Amazon DSP advertiser Ids to an instance\n"," Any requests for multiple DSP advertiser Ids additions go through the  admin user access verification.\n","If AMC cannot validate the direct access of the requesting admin user to the advertiser Ids, the request will be sent for a manual approval, which is subject to a 2-business days SLA.\n","If the access of the requesting admin user is verified for the set of advertisers being added to the instance, the request returns a successful 200 response.\n"," The successful advertiser addition request is then queued for a manual review to verify that all advertisers belong to the same brand.\n"," You can check the status of your request within two business days of submission using the GET /amc/instances/{instanceId}/advertisers/updates/{updateId} endpoint. This endpoint requires the updateId from your POST request.\n"," Approval for agency or partner managed instances\n"," In case of agency or partner managed instances, AMC first checks if the agency or partner has the necessary permissions to access the data of the advertiser following the admin user access verification.\n"," In addition, to obtaining the Login with Amazon (LwA) authorization to access the data of the advertiser, agency or partner users  must do the following to establish the initial relationship with advertiser data:\n","Make API calls on behalf of the advertiser. This can be done either through one campaign management call or two calls of any other type.\n","Wait for the mandatory 3-day period after the initial calls to allow AMC to establish and verify the connection between the partner LwA client ID and the account of the advertiser.\n","Submit the request to add advertiser IDs of the client to the partner-managed instance using the POST/amc/instances/{instanceId}/advertisers/updates endpoint. \n"," For sponsored ads advertiser inclusion, requests will be rejected if the access of the partner user cannot be verified.\n"," For DSP advertiser inclusion requests, if AMC cannot verify the direct access of the requesting user through the admin user access verification process, the request will be sent for a manual approval, and may require a written confirmation from the advertiser authorizing your partnership.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":3,"text":"Retrieve advertiser update status"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" Use the GET/amc/instances/{instanceId}/advertisers/updates endpoint for details on advertiser update requests and statuses for a specific instance.\n"," If you want to get details for a specific update request use the GET /amc/instances/{instanceId}/advertisers/updates/{updateId} operation.\n"," The status of your update request could be one of the following:\n","PENDING\n","UPDATING\n","COMPLETED\n","REJECTED\n"," Note that the numeral 0 (zero) will be considered as the first  updateId and subsequent modification request ids will increment by 1.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":2,"text":"Sandbox instances"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" All AMC accounts have automatic access to a sandbox instance. The sandbox instance provides a synthetic testing environment for hands-on learning, signal investigation and query iteration without impacting live instances.\n"," To identify your sandbox instance, use the GET/amc/instances/{instanceId} endpoint.\n"," Your response body will contain the instanceType of each instance. The value for sandbox instances for the instanceType is SANDBOX.\n"," Refer to the AMC sandbox developer guide for more details.\n"],"documentType":"guide"},{"title":"Instance management","sectionHeader":{"type":2,"text":"Collaboration instances"},"path":"/en-us/guides/amazon-marketing-cloud/admin/instance-management","content":[" AMC customers can use AWS Clean Rooms for securely associating advertiser first-party data to a collaboration and collecting data outputs from queries across their data and AMC data, without having to move any underlying data outside of their AWS environment.\n"," AMC allows you to create an instance to create a collaboration with AWS Clean Rooms.\n"," For more details, see Set up a collaboration instance.\n"," If you want to bring identity data to your collaboration, the following instances API endpoints will help you through the identity data upload process:\n","GET/amc/instances/{instanceId}/collaboration to retrieve your collaboration instance information.\n","POST/amc/instances/{instanceId}/collaboration/idnamespaces/list to retrieve a list of ID namespace not associated with a collaboration instance, so that you can select one of the not-connected namespaces returned to create a mapping table.\n","POST /amc/instances/{instanceId}/collaboration/idmappingtables to create an ID mapping table.\n","GET /amc/instances/{instanceId}/collaboration/idmappingtables/{idMappingTableId}/jobs/{jobId} to retrieve the ID mapping job status for the requested AMC instance.\n"," After creating an ID mapping table, use the following endpoints to manage ID mapping tables.\n","| Endpoint                                                                                      | Description                                                                                          |\n","\\| --------------------------------------------------------------------------------------------- \\| ---------------------------------------------------------------------------------------------------- \\|\n","| POST /amc/instances/{instanceId}/collaboration/idmappingtables/{idMappingTableId}/refresh | Updates the data in the given ID. Mapping Table in the collaboration for the requested AMC instance. |\n","| GET /amc/instances/{instanceId}/collaboration/idmappingtables/{idMappingTableId}/jobs/{jobId} | Retrieves the ID mapping job metadata for the requested AMC instance.                                |\n","| DELETE /amc/instances/{instanceId}/collaboration/idmappingtables/{idMappingTableId} | Deletes the given ID Mapping Table in the collaboration for the requested AMC instance.              |\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/reporting/workflow-management-service","content":[" 1\\. Manage a workflow | 2. Manage a workflow schedule | 3. Manage workflow executions | 4. Get your workflow results\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Overview "},"path":"/en-us/guides/amazon-marketing-cloud/reporting/workflow-management-service","content":[" The AMC workflow management service provides you the ability to create, store, and execute parameterized workflows. Workflows can be executed \"on-demand\" or can be scheduled to run at a specific time via the AMC built-in scheduler.\n"," Learn how to:\n","Manage a workflow - Manage a workflow schedule - Manage workflow executions\n"," After you execute your workflows, learn how to get your query results. \n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/reporting/create-workflow","content":[" Workflows are queries with associated metadata that take previously defined data sources as input and use them to generate a given output (also known as a \"report\").  The Workflow resource is essentially a SQL query that is mapped to a unique identifier (workflowId) that you provide when defining the workflow. When you define your workflowId, the id must comprise only alphanumeric characters, numbers, with periods, dashes, and underscores being the only special characters allowed (e.g. Streaming_T.V_Performance-Report2023)\n"," You can reference the workflow using the workflowId for reuse, or for execution on-demand, or schedule it to be run at a specified time.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Create a workflow"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/create-workflow","content":[" The AMC Workflows API helps you create and manage workflows programmatically. Once defined and saved, a workflow on its own will not produce any output data; you will have to either execute it on-demand or schedule it to be run at a specified time. To run at a specific time, use the Schedules resources to run the query via the AMC built-in scheduler or on-demand through the Workflow Execution resources.\n"," For this tutorial, to create a workflow, use the POST operation of the workflows resource with the instanceId as the path parameter.\n"," Workflows are created with the following mandatory request body parameters:\n","workflowId: This is an alphanumeric string that you will specify. Workflow identifiers can only contain alphanumeric characters, periods, dashes, and underscores, without any spaces. This identifier will be used to identify the workflow when scheduling or executing on-demand. \\* sqlQuery: The SQL script to use to construct and output your report. The query must be a single-line query and stripped of tabs and new-line delimiters before adding to the JSON object. Semicolons are not required at the end of the query.\n"," Assume you want to create a workflow with a basic query and save it with a unique name that you will refer to when scheduling or executing it.\n"," The following workflow uses a SQL query that returns total purchases with a 9-day conversion window.\n"," To pass the above query in the sqlQuery parameter, remove all line breaks so that the query is a single line query that JSON will be able to support.\n"," You will name this workflow my-first-workflow and pass this name as the unique workflowId.\n"," In this example, you will append aggregation threshold columns as additional request body parameters.\n"," Sample request\n"," A successful call returns an HTTP status code: 200 OK. You can use the workflowId to schedule an execution or retrieve information on the workflow.\n"," You can go ahead and schedule the workflow for a timed execution, or call the POST operation of the workflowExecutions resource to execute the workflow.\n"," The result of running this workflow will output the columns campaign, and total_orders_9d, listing the names of the campaigns with a total purchases with a 9-day conversion window.\n","|TILES Did you know?|\n","\\|--\\|\n","|The Use Cases tab in the AMC console is home to the Use Case library, where you can explore through Amazon-authored SQL queries, also known as instructional queries (IQs), no-code Templates, and Solutions designed by our experts to help you leverage common measurement and analytics use cases. To learn more, visit Use Case library (link only available for AMC UI users). |\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":3,"text":"Include custom parameters"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/create-workflow","content":[" The AMC workflows API supports the ability to create custom parameters (link only available for AMC UI users), then allows you to pass values to these parameters at execution. This provides the ability to streamline query execution by reducing the values that need to be hard-coded in the query, and by providing you the ability to inject metadata.\n"," Supported simple data types\n","BINARY - BOOLEAN - BYTE - DATE - DOUBLE - FLOAT - INTEGER - LONG - SHORT - STRING - TIMESTAMP\n"," Supported complex data types\n","ARRAY of one of the supported simple data types above\n"," In the workflow, you define what parameters can be referenced in the query, and you can optionally supply a default value (defaultValue) for the parameter. If you do not specify the defaultValue, you must set the value later in the workflow executions, as described in Step 2: Invoking custom parameters in workflow executions.\n"," Sample request\n"," The following example defines three custom parameters on the workflow, each of a different data type:\n"," Once defined in a workflow, the custom parameters can then be invoked in workflow executions.\n"," When you run the workflow execution, you can optionally override that defaultValue with a different value (for example, if you want to run the same query but with a different parameter). In the workflow execution, you can change the values using parameterValues, which is a map from the name of the custom parameter to the new value. For example, you could define the following in the /workflowExecutions request:\n"," Then, when the execution runs, you reference the custom parameter using:\n"," During the workflow execution, the custom parameter will use the parameterValues definition first (for example, myCustomParameter1 will use 9001). If not specified, it will use the defaultValue from the workflow definition (for example, the array myCustomParameter3 will use the default values defined in the workflow).\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":3,"text":"Append aggregation threshold columns"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/create-workflow","content":[" Different fields (columns) in AMC have different requirements in terms of minimum user granularity counts contained in the aggregated query results.\n"," After you define your basic SQL query, the workflows resource also accepts parameters to further qualify the output of your query. Column outputs are classified into categories based on the combination of the aggregation threshold level and the filtering restrictions, which we refer to as aggregation threshold. When defining your workflow, you can append these aggregation threshold columns with the help of the following parameters:\n","filteredMetricsDiscriminatorColumn - distinctUserCountColumn - filteredReasonColumn\n"," By default, rows that do not meet the minimum distinct user count requirements will be completely filtered out of the workflow output.\n"," If the filteredMetricsDiscriminatorColumn parameter is included when defining a workflow, then rows that do not meet the minimum distinct user count requirements will have values removed and then the output will be re-aggregated with AggregationType.SUM.\n"," The value you provide for the filteredMetricsDiscriminatorColumn parameter becomes the heading of the Boolean column that will be added to the workflow output. This Boolean column identifies rows with and without values in columns removed. Unchanged rows will have a value of FALSE for this column, while rows with fields removed will have a value of TRUE.\n"," This field is entered in the workflow definition as a top-level field:\n"," In the above example, the workflow will output a column titled \"filtered\" that will contain Boolean values.\n"," Example: Filtering behavior with and without filteredMetricsDiscriminatorColumn\n"," Example Raw Data\n","| impressions (metric) (NONE) \t| clicks  (metric)  NONE \t| device_type (dimension) (LOW) \t| postal_code (dimension) (HIGH) \t| impressions distinct user count \t| clicks  distinct user count \t|\n","|-----------------------------\t|------------------------\t|-------------------------------\t|--------------------------------\t|---------------------------------\t|-----------------------------\t|\n","|     1100                    \t|     300                \t|     iPhone                    \t|     11111                      \t|     50                          \t|     13                      \t|\n","|     200                     \t|     100                \t|     Android                   \t|     22222                      \t|     30                          \t|     8                       \t|\n","|     1300                    \t|     500                \t|     Android                   \t|     33333                      \t|     133                         \t|     87                      \t|\n","|     1700                    \t|     700                \t|     Android                   \t|     44444                      \t|     108                         \t|     359                     \t|\n"," After executing workflow without filteredMetricsDiscriminatorColumn\n"," The three rows where the distinct user count of either impressions, clicks, or both is less than 100 are omitted from the output.\n","| impressions (metric) (NONE)|  clicks  (metric)  NONE | device_type (dimension) (LOW) | postal_code (dimension) (HIGH) |\n","\\| :--------------------------\\|  :--------------------- \\| :---------------------------- \\| :----------------------------- \\|\n","| 1700                       |  700                    | Android                       | 44444                          |\n"," After executing workflow with filteredMetricsDiscriminatorColumn of \"filtered\"\n"," The three rows where the distinct user count of either impressions, clicks, or both is less than 100 are included in the output.\n"," For these rows, columns with an aggregation threshold of 100 have values of NULL and the filteredMetricsDiscriminatorColumn, \"filtered\" is set to TRUE.\n"," The second and third rows of the original table are re-aggregated into a single row because their postal_code values match after the filtering.\n","| impressions (metric) (NONE) \t| clicks  (metric)  NONE | device_type (dimension) (LOW) \t| postal_code (dimension) (HIGH) \t| Filtered (dimension) NONE |\n","|-----------------------------|------------------------\t|-------------------------------\t|--------------------------------\t|---------------------------\t|\n","|     1100                    |     300                \t|     iPhone                    \t|     NULL                       \t|     TRUE                  \t|\n","|     1500                    \t|     600                \t|     Android                   \t|     NULL                       \t|     TRUE                  \t|\n","|     1700                    \t|     700                \t|     Android                   \t|     44444                      \t|     FALSE                 \t|\n"," In addition to the filteredMetricsDiscriminatorColumn, a distinctUserCountColumn can be added to receive the count of distinct users considered by the AMC privacy mechanisms.\n"," The value you provide for the distinctUserCountColumn parameter becomes the heading of the column that will be added to the workflow output. The values in the rows help you understand how far off the user count is from the aggregation threshold of the column. The value in this column may differ from the simple sum(distinct user_id) calculation, as the AMC calculation considers other factors.\n"," At the workflow level:\n"," The new column is added to the query output:\n","| impressions (metric) (NONE) \t| clicks  (metric)  NONE \t| device_type (dimension) (LOW) \t| postal_code (dimension) (HIGH) \t| du_count (dimension) NONE \t|\n","|-----------------------------\t|------------------------\t|-------------------------------\t|--------------------------------\t|---------------------------\t|\n","|     1100                    \t|     300                \t|     iPhone                    \t|     NULL                       \t|     13                    \t|\n","|     1500                    \t|     600                \t|     Android                   \t|     NULL                       \t|     22                    \t|\n","|     1700                    \t|     700                \t|     Android                   \t|     44444                      \t|     157                   \t|\n"," If the filteredReasonColumn is included in the workflow definition, an additional column with this name will be included in the workflow output, that will contain a description of the reason why that data was filtered out of the row for privacy reasons, and NULL if no data was filtered out of the row.\n"," This column is intended to provide the following information in one place:\n","The fact that the row was filtered out. - The type of distinct user count that was the reason for filtering (standard, effective, or equivalent).\n","Minimum required user count (if there are multiple columns with separate requirements, maximum of the minimum-required value across these columns will be displayed). - Actual user count (the minimum, if there are multiple user count columns). - The data source responsible for the filter-out to happen. - (In scenarios where the query used the same data source multiple times) - the path responsible for the data filter-out to happen, and the total number of paths present in the query.\n"," The column output will be structured as:\n"," Examples:\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"View all workflows"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/create-workflow","content":[" Once you have created a workflow, you can list the details of all the workflows created within the instance using the GET operation of workflows resource. If you have defined many workflows in your instance, you could limit the number of results that show up in each page by defining the nextToken and limit parameters as part of the request body. \n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"View a specific workflow"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/create-workflow","content":[" To view the details of a specific workflow within your instance, pass the workflowId of the workflow in the GET operation of workflows resource.\n"," The following is the endpoint to view a specific workflow with the identifier my-first-workflow, under your instance.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Update a workflow"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/create-workflow","content":[" The PUT operation of the workflows resource updates the values in a specific workflow. It uses the same structure as the create workflow request, except that it requires the workflowId field.\n"," To update a workflow:\n","Use the GET operation of the workflows resource to retrieve the specific workflow you want to update.  2. Provide the updated values for the individual parameters you want to modify as part of the body of the request.  3. Use the PUT operation (of the workflows resource) with the workflowId as a path parameter to update the workflow. For example:\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Delete a workflow"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/create-workflow","content":[" The DELETE operation of the workflows resource deletes a single workflow. For example, the endpoint to delete a workflow with the identifier my-first-workflow will be:\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/create-workflow","content":["Manage a workflow schedule  or,  - Manage workflow executions - Get your workflow results\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/reporting/schedule-workflow","content":[" The schedules resource allows you to define the cadence at which a saved workflow will run. Creating a schedule for a workflow helps define the specificity of the run by allowing you to set the specific time interval, day of the week, and time of day to execute the workflow.\n"," When the schedule is triggered, it will run the workflow and place the results in the S3 bucket associated with the instance for the given workflow.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Create a schedule"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/schedule-workflow","content":[" To create a schedule for a workflow you defined, use the POST operation of the schedules resource with the instance identifier as the path parameter.\n"," Here is an example of a schedule object in the JSON format.\n"," In the above example, we created a schedule my-first-schedule for the workflow, my-first-workflow, we created earlier. The defined schedule will trigger a run of the my-first-workflow workflow at a five-hour offset from midnight in UTC every week on Tuesday. The interval and amount of data contained within the report are the same, so this would generate a report for the data from the previous Tuesday at the specified offset from UTC until the current Tuesday at the same hour offset.\n"," To determine the correct value of the hour offset, use the aggregationHourUtc parameter. Convert your desired start time to Coordinated Universal Time (UTC) and calculate the offset in hours from 12 a.m. (midnight) UTC. For example, 10 a.m. MST is 4 p.m. UTC, which is 16 hours from midnight UTC. So, to run the SQL query in the my-first-workflow every Tuesday at 10 am, the value for the aggregationHourUtc parameter will be 16.\n"," To enable a schedule, set the ScheduleEnabled parameter to true. When this value is set to false the workflow will not be queued for execution even with an associated schedule.\n"," A successful call returns an HTTP status code 200 OK and queues the workflow for execution as per the defined schedule.\n"," After execution, the report is generated to output a file suffixed with -ver1.csv and sent to your S3 bucket approximately 6–7 hours after the scheduled run time. The report generated omits invalid traffic.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"View all schedules within an instance"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/schedule-workflow","content":[" To list all schedules defined within your instance, use the GET operation of the schedules resource with the instance identifier as the path parameter.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"View a schedule"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/schedule-workflow","content":[" To view a specific schedule within an instance, use the GET operation of the schedules resource with the instance identifier and schedule identifier of the requested schedule as path parameters. For example, to view the details of my-first-schedule, the schedule we created earlier, use the following call:\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Update a schedule"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/schedule-workflow","content":[" The PUT operation of the schedules resource updates the values in a specific schedule. It uses the same structure as the create schedule request.\n"," To update a schedule:\n","First, retrieve the specific schedule.  - Next, provide the updated values for the individual parameters you want to modify as part of the body of the request.  - Then, use the PUT operation of the schedules resource to save the changes.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Delete a schedule"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/schedule-workflow","content":[" To delete a schedule within an instance, use the DELETE operation of the schedules resources. Pass the instance identifier and schedule identifier as path parameters.\n"," Once deleted, the workflow associated with the schedule will not execute at the cadence that was defined in the schedule. To execute the workflow, you will need to either create another schedule or execute the workflow ad hoc, using the workflowExecutions resource.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/schedule-workflow","content":[],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/reporting/execute-workflow","content":[" The WorkflowExecutions resource allows you to run a previously saved workflow. The resource also allows you to create a workflow and execute it on demand (ad hoc workflow execution).\n"," When executing an ad hoc workflow, define the SQL query in the body of the request and include the additional parameters to output your results.\n"," For both types of workflows, use the POST operation of the WorkflowExecutions resource.\n"," The response object contains the created workflow execution which represents the status of the execution.\n","| TILES Did you know ?                                                                                                                                                                                                                                                                                 |\n","\\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \\|\n","| Before a workflow execution runs, AMC checks the query against previously run executions. AMC will not return results if you have run multiple, similar queries (those with slightly different filtering expressions) on non-sensitive fields to obtain information associated with a sensitive value. |\n"," This is done to protect the identity of the audience information within the datasets you query. \n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Execute a saved workflow"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/execute-workflow","content":[" To execute a previously saved workflow, you will need to pass the instance identifier as a mandatory path parameter. You will include the workflowId as part of the body of the request. You can also include some optional parameters as part of the body of the request to further customize the report your query/workflow outputs and define dates for the query to consider as the time window. Then use the following endpoint to execute your saved workflow:\n"," Before you execute your workflow, understand the following optional parameters you can pass in your workflow execution request that will shape your output.\n","timeWindowType - Data freshness\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":3,"text":"Time window type"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/execute-workflow","content":[" The type of time window to use for specifying input data for the workflow execution. If not provided, the time window type of MOST_RECENT_DAY will be used. Valid options are:\n","EXPLICIT: The start and end of the time window must be explicitly provided in the request. - MOST_RECENT_DAY: The time window will be the most recent 1-day window for which the instance is likely to have data, aligned to day boundaries. - MOST_RECENT_WEEK: The time window will be the most recent 1-week window for which the instance is likely to have data, aligned to day boundaries. - CURRENT_MONTH: The time window will be the start of the current month up to the most recent time for which the instance is likely to have data. - PREVIOUS_MONTH: The time window will be the entire previous month.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/execute-workflow","content":[" AMC does not ingest data in real-time and propagates your ad activity data after a time-lag. As a best practice, AMC recommends that you select a date range of 48-hours prior to the current date. This is because the result of your query may be incomplete as the data can take up to 48 hours to process and be available in your instances.\n"," Sample request\n"," In this sample request, execute the my-first-workflow workflow created when discussing how to create a workflow. Notice how the workflow is referenced using the workflowId and the timeWindowType is set to EXPLICIT. Since the timeWindowType is set to EXPLICIT, the timeWindowStart and timeWindowEnd values are provided.\n"," After you run the workflow, AMC returns a workflow execution Id (workflowExecutionId) that you will need to retrieve from the results.\n"," Sample response\n"," You can append aggregation threshold columns when defining the workflow execution.\n"," To understand each of the response parameters, see the Workflow Execution API reference.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":3,"text":"Query execution limit"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/execute-workflow","content":[" An AMC account has no limit on the active workflow executions (that is, workflow executions with the status of running or pending).\n"," However, at an instance level, the following limits are applied:\n","10 workflow executions can run in parallel at the instance level for API \\* 200 workflow executions can run in parallel at the account level for API\n"," Note that, at the account level, there is no limit to the number of workflow executions queued. For example, at any given point, an account can run a maximum of 200 workflow executions running concurrently from the multiple instances associated with it, and have any number of workflow executions from instances queued for processing.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"View a workflow execution"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/execute-workflow","content":[" Gets status information about the requested workflow execution.\n"," Possible workflow execution statuses\n","| Status Name | Description                                                                                                                                             |\n","\\| :---------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| PENDING     | The workflow execution has not yet started running. It may be queueing to run, waiting for data to become available, or waiting until a specified time. |\n","| RUNNING     | The workflow execution is running.                                                                                                                      |\n","| SUCCEEDED   | The workflow execution has finished successfully.                                                                                                       |\n","| FAILED      | The workflow execution failed.                                                                                                                          |\n","| CANCELLED   | The workflow execution was cancelled before succeeding or failing.                                                                                      |\n"," For details on the response parameters, see the response of POST operation of the workflowExecutions.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"View workflow executions"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/execute-workflow","content":[" Returns workflow execution details for a specific workflow identifier.\n"," The other parameter you can use to list workflow executions is the minCreationTime, which is a date filter based on the time that the workflow execution was created. It is in the yyyy-MM-dd'T'HH:mm:ss format. When the minCreationTime is specified, the response returns all workflow executions created after the specified time window.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Update a workflow execution"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/execute-workflow","content":[" The PUT operation of the workflowExecutions resource updates the values in a workflow execution definition. It uses the same structure as the POST workflowExecutions request.\n"," To update a workflow execution definition, retrieve the specific workflow execution identifier. Next, provide the updated values for the parameters you want to modify. Then, use the PUT operation of the workflowExecutions resource to save the changes.\n"," Updates the requested workflow execution.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Delete a workflow execution definition"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/execute-workflow","content":[" To delete a workflow execution definition within an instance, use the DELETE operation of the workflowExecutions resources. Pass the instance identifier and workflow executions identifier as path parameters.\n"," Deletes the requested workflow execution.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/execute-workflow","content":[],"documentType":"guide"},{"title":"Get your results","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/reporting/get-your-results","content":[" In the previous section, we executed workflows, which in turn processed SQL queries to output results as a Comma Separated Value (.csv) file.\n"," You can retrieve your results by generating a download URL or if you have set up an Amazon S3 bucket for your instance, you can retrieve reports via S3.\n"],"documentType":"guide"},{"title":"Get your results","sectionHeader":{"type":2,"text":"Download your query results"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/get-your-results","content":[" To retrieve a pre-signed URL for downloading workflow execution results from S3, copy the workflowExecutionId from the response returned in the POST operation of the workflowExecutions resource.\n"," In our example, the workflowExecutionId is: 2b04762b-cbdb-47c7-be39-42a585ecd40e.\n"," Now, pass the instance identifier and the workflow execution identifier you retrieved as path parameters in the following request:\n"," This request will return a URL where your report can be directly downloaded. Copy the URL and enter it into a browser to download the resulting CSV file.\n"," It may take some time for the report to generate. If your report is not ready, you will receive the following response:\n"," We will now navigate to our S3 bucket where the output of the query is saved.\n"],"documentType":"guide"},{"title":"Get your results","sectionHeader":{"type":2,"text":"View your workflow output in the Amazon S3 bucket"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/get-your-results","content":[" If you have defined an S3 bucket to store the results of your query execution, your workflow executions generate CSV files and direct those to your S3 bucket.\n"," Access the S3 bucket and locate the CSV file for the workflow execution that we ran in the previous section.\n"," To access the Amazon S3 bucket:\n","Log in to the AMC UI and navigate to the Instance info page. 2. Locate the S3 bucket name. This will be the name of the S3 bucket created in the connected AWS account. 3. Log in to the connected AWS account and navigate to the S3 Buckets page. For more details, see  Methods for accessing a bucket. 4. Choose your AMC S3 bucket. Each folder maps 1:1 to a workflow. In other words, there is a folder for each individual SQL query. 5. Search for the folder with the workflowId that was generated or named (in our example, my-first-workflow). 6. Within the folder, you will see sub-folders based on any schedules or workflow executions that have been created. For more details, see Understand the S3 Folder Path.\n"," The following depicts a workflow that was run weekly as well as ad hoc:\n","Open one of the workflow folders. Within the folder is a CSV file and another folder containing metadata. You can download the CSV file and open it to view the results of the query. You can also download the metadata to view additional information about the workflow that was run, including the SQL query used.\n"],"documentType":"guide"},{"title":"Get your results","sectionHeader":{"type":3,"text":"Understand the S3 folder path"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/get-your-results","content":[" AMC creates unique folder paths within the connected S3 bucket to organize different AMC reports. The folder path for a report written to S3 looks like this:\n"," The first part of the path (amc-myinstance-2ofoqzvk) contains the amc- prefix, your AMC instance name, and a hash value. The hash (in this example 2ofoqzvk) ensures that the full S3 bucket name amc-myinstance-2ofoqzvk is globally unique.\n"," The second part of the path (workflow=my_report_daily) provides the name of the workflow that generated the report file.\n"," The third part (schedule=daily) is the schedule, either daily, weekly, or adhoc. Scheduled reports are sent to the daily or weekly paths based on the value for aggregationPeriod set within the schedule.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/reporting/ad-hoc-workflow","content":[" An ad hoc workflow allows you to create and execute a query on-demand. You can then download the output of the query or access your connected S3 bucket to check the output.\n"," Before you test out the API by sending your request, it is important to understand that if any personal information (such as an individual email address or phone number) is added to a request, the query will not output desired results.\n"," We will use the POST method with the /workflowExecutions endpoint path, as well as the Body of the request containing a JSON object with the following parameters:\n","sqlQuery: The SQL query must be a single-line query and stripped of tabs and new-line delimiters before added to the JSON object. Semicolons are not required at the end of the query. - timeWindowType: The type of time window to use for specifying input data for the workflow execution. In our example, we will use MOST_RECENT_WEEK. The other predefined values for most recent day, current month, previous month, and custom (explicit) time windows.\n"," For this example, we will be running a basic SQL query that aggregates total cost, impressions, and reach at the advertiser and campaign level. The query is below:\n"," Note how we convert the SQL query to a single line.\n"," Sample request payload\n"," We will use the single-line query as the value to pass for the sqlQuery parameter. The following is an example of the message body:\n"," When executed, this value will run the query for the last 7 days. There are also predefined values for most recent day, current month, previous month, and custom (explicit) time windows.\n"," We can call the POST workflow execution endpoint using one of the following approaches:\n","Using cURL\n","Using Postman\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":3,"text":"Using cURL"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/ad-hoc-workflow","content":[" You can use cURL to create an ad hoc workflow using the North America URL prefix.\n"," Sample request\n"," Sample response\n"," Note the workflowExecutionId from the response. This identifier will be used to Download a CSV file containing query results.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":3,"text":"Using Postman"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/ad-hoc-workflow","content":[" In this example, we will be using Postman, an API platform that has an easy-to-use graphical user interface (GUI).\n","Download and install Postman.\n","Open Postman and click Create new collection. The collection will be used to group our requests and for inheritance of authorization parameters, saving us a lot of time and effort.\n","Name your collection (for example, Amazon Ads APIs).\n","Set up your environment and collection by following these instructions.\n","Generate an authorization grant code and retrieve access and refresh tokens to complete your authorization.\n"," Your authorization credentials will expire after 24 hours. When the authorization credentials expire, you will receive an HTTP 403 forbidden response when calling the API. To update, you will need to re-generate your authorization credentials and update the parameters in the collection Authorization tab with the regenerated details. Refer to Generate API access credentials for more information about generating the tokens.\n","Click Add request within the newly created collection to create a new request. This will inherit the authorization parameters of the collection.\n","Name your request (for example, Execute ad hoc workflow).\n"," By default, Postman creates a GET request. Make sure the HTTP method is set to POST.\n","In the request URL field, enter the base AMC API URL and append the endpoint path for the workflow executions resource (/workflowExecutions). Using the North America URL prefix, your request will look something like the example below, with your unique instance being called as a variable.\n","On the Headers tab, add the mandatory header parameters with the appropriate values for each.\n","Next, we will enter the JSON object in the request body as described in the example below.\n","Click Send. If successful, you will receive a response with the HTTP status code 200 OK and the following response parameters:\n"," If you receive a response code other than 200, check if your credentials are authenticated and that your token has not expired.\n","Note the workflowExecutionId from the response, because we will need it in the next section.\n"],"documentType":"guide"},{"title":"Workflow management service","sectionHeader":{"type":2,"text":"View your workflow results"},"path":"/en-us/guides/amazon-marketing-cloud/reporting/ad-hoc-workflow","content":[" If you have an S3 bucket configured to store the output of your workflow results, access your S3 bucket to view your report. Alternatively, refer to the steps below to generate a URL to download your workflow results in the CSV format.\n"," To download your workflow results, you will need to copy the workflowExecutionId from the response of the ad hoc execution that we previously ran. We will use the workflowExecutionId with the /workflowExecutions/{workflowExecutionId}/downloadUrls endpoint to retrieve a link for the results.\n"," To create a new request to download the results of our query:\n","Copy the workflowExecutionId from the response returned in the previous section. In our example, the workflowExecutionId is: a111111c-111f-1111-b1f1-11d111f1c1d1\n","Create a new request and select the GET method.\n","Enter the request URL, inserting the workflowExecutionId from the previous step into the following URL:\n","Copy the URL and enter it into a browser to download the resulting CSV file.\n"," It may take some time for the report to generate. If your report is not ready, you will receive the following response:\n"," If you receive the above message, wait for 15 minutes and try the request again.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Custom models","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/overview","content":[" AMC custom models (ACM) is an integration between AWS Clean Rooms ML: Custom Models and Amazon Marketing Cloud (AMC), offering custom modeling capabilities for audience creation. With ACM, you can leverage your own machine learning algorithms within a privacy-safe environment to train custom models using event-level signals from AMC, in combination with your own first-party signals (for example to model Amazon vs off-Amazon conversion propensity) for audience creation and activation (Amazon DSP and sponsored ads).\n"," Custom Modeling allows you to leverage AMC data to generate novel predictions that can be leveraged to generate rule-based (SQL query) audiences, lookalike audiences, or other model-based use-cases. Audiences created using custom models can target specific attributes such as conversion propensity, churn-prediction, new-to-brand prediction, and modelled customer-lifetime-value.\n"," Components definition\n"," The following components can be customized to fit your specific use cases:\n","Algorithms: The algorithms to use for training and inferencing, -   SQL queries: The SQL queries to generate the input data for -   Model code: Model code is designed in such a way that the -   Metrics: The metrics to measure model accuracy. Your training -   Hyperparameters for model tuning: When calling the AMC API to\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Custom models","sectionHeader":{"type":2,"text":"AMC datasets available for modeling"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/overview","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Onboarding Guide","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/getting_started","content":[" Before implementing ACM, it is essential to understand the requirements, technical expertise, and component setup needed for successful deployment. It is important to note that ACM requires a nuanced approach to building and tuning a model due to the requirement of maintaining Clean Room event level privacy throughout the process. This section outlines AMC Instance requirements and your responsibility as a user.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Onboarding Guide","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/getting_started","content":[" ACM only supports resources set up in the North American (NA) region.\n"," ACM is powered by AWS Clean Rooms. This means, you must set up a new\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Prereqs","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/preliminary_setup","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Prereqs","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/preliminary_setup","content":[" Before getting started with this guide ensure you have met the following prerequisites.\n","You have onboarded the AMC APIs on Amazon Ads. -   You have set up an ACR collaboration instance. -   You can access the AWS account associated with the collaboration. -   You have the ability to create IAM policies and roles through AWS -   You have Docker installed on your local machine. -   You have access to Amazon Ads APIs and AWS APIs. -   You have the permissions to upload images to ECR.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Prereqs","sectionHeader":{"type":2,"text":" AMC on AWS Clean Rooms Collaboration"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/preliminary_setup","content":["Create an AMC collaboration account using self-serve APIs or contact\n","Configure your AMC on AWS Clean Rooms collaboration. See Set up\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - User Responsibilities","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/user_responsibilities","content":[" Before you start using ACM, you need to understand and accept the following responsibilities:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Pricing","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/pricing","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Pricing","sectionHeader":{"type":2,"text":"AWS pricing for custom models"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/pricing","content":[" The costs associated with AWS Clean Rooms usage records are billed to the AWS account associated with the AMC collaboration instance. The fees charged for AWS Clean Rooms are determined by (1) the volume of data used for training and inferencing (number of records), and (2) compute used for training and inferencing (SageMaker).\n"," See AWS Clean Rooms Pricing.\n","Data storage in Amazon S3 -   Data cataloging 1P data using AWS Glue -   Hosting custom container images in ECR -   Testing model containers (outside AWS Clean Rooms) using SageMaker\n"," AWS fees are billed to the AWS account provided to set up the AMC on AWS Clean Rooms Collaboration. You can find the AWS account used for billing in the Instance Info tab of the AMC UI, under Connected AWS account ID.\n"],"documentType":"guide"},{"title":"Resource Lifecycle","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/resource-lifecycle","content":[" All AMC Custom Models resources have finite lifetimes. Understanding these expiration timelines is critical for building reliable, production-ready pipelines.\n"],"documentType":"guide"},{"title":"Resource Lifecycle","sectionHeader":{"type":2,"text":"Resource Expiration"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/resource-lifecycle","content":["| Resource | Lifetime | After Expiration |\n","\\|----------\\|----------\\|-----------------\\|\n","| ML Input Channel (MLIC) | 30 days | Status becomes INACTIVE. Cannot be used for training or inference. Recreate with the same query. |\n","| Trained Model | 30 days | Status becomes INACTIVE. Cannot be used for inference. Must retrain. |\n","| Inference Job | 30 days | Status becomes INACTIVE. Results are no longer accessible. Re-run the inference job. |\n","| Modeled Dataset | 365 days | Status becomes INACTIVE. Re-run the full pipeline (inference + export). |\n","| Presigned URLs (error logs, exports) | Short-lived (minutes to hours) | Call the GET API again to generate a new presigned URL. |\n"],"documentType":"guide"},{"title":"Resource Lifecycle","sectionHeader":{"type":2,"text":"Incremental Training and Expiration"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/resource-lifecycle","content":[" When you train a model incrementally (using a parent model), the new model inherits the earliest expiration time of the parent model, capped at 29 days. This means:\n","If your parent model expires in 5 days, the new incremental model also expires in 5 days - To maximize the lifetime of the new model, train incrementally from freshly created parent models\n"],"documentType":"guide"},{"title":"Resource Lifecycle","sectionHeader":{"type":2,"text":"Planning for Expiration"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/resource-lifecycle","content":[" Since most resources expire after 30 days, plan your pipeline cadence accordingly:\n","Create all split MLICs in the same session — do not let the first MLIC expire before you finish creating the rest 2. Submit training jobs promptly after MLIC creation — verify each MLIC status is ACTIVE before calling createTrainedModel 3. Retrain before expiration if you need continuous inference capability — expired models cannot be used or renewed 4. Monitor resource status — check the status field via GET APIs to detect resources approaching expiration\n"],"documentType":"guide"},{"title":"Resource Lifecycle","sectionHeader":{"type":2,"text":"Status Lifecycle"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/getting-started/resource-lifecycle","content":[" All resources follow the same status pattern:\n"],"documentType":"guide"},{"title":"Model Configuration Overview","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/model_config_overview","content":[" To successfully deploy custom models in AMC, you need to meet specific requirements for SageMaker images, Configured Model Algorithm Associations (CMAA), and ML Input Channels (MLIC). The following sections detail these requirements and provide guidance for configuring your models.\n"],"documentType":"guide"},{"title":"Model Configuration Overview","sectionHeader":{"type":2,"text":"Prerequisites for SageMaker Model Development"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/model_config_overview","content":[" Before building your custom model, ensure you have:\n","Development Environment:\n","AWS Permissions:\n","Technical Knowledge:\n","AMC Access:\n","Clean Rooms Setup:\n"],"documentType":"guide"},{"title":"SageMaker Image Requirements","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/sagemaker_requirements","content":[" AMC Custom Models requires your machine learning code to be packaged as SageMaker-compatible Docker containers. You need to create two separate containers:\n","A training container that handles model training - An inference container that generates predictions\n"],"documentType":"guide"},{"title":"SageMaker Image Requirements","sectionHeader":{"type":2,"text":"Container Structure"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/sagemaker_requirements","content":[" Both containers must follow the SageMaker container specification, which includes:\n","Standard directory structure for model artifacts - Defined entry points for training/inference scripts - Proper handling of environment variables - Implementation of required API endpoints (inference only)\n"," For detailed technical specifications, refer to the SageMaker Custom Container Documentation.\n"],"documentType":"guide"},{"title":"SageMaker Image Requirements","sectionHeader":{"type":2,"text":"Base Images"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/sagemaker_requirements","content":[" You can build your containers using either:\n"],"documentType":"guide"},{"title":"SageMaker Image Requirements","sectionHeader":{"type":2,"text":"Key Requirements"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/sagemaker_requirements","content":["Training Container:\n","Inference Container:\n"],"documentType":"guide"},{"title":"Container validation","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/container_validation","content":[" Test with synthetic data using AMC Sandbox\n"," Synthetic input data can be generated using an AMC Sandbox Instance. An AMC Sandbox Instance can be used to generate event-level synthetic data for model development.\n"],"documentType":"guide"},{"title":"Container validation","sectionHeader":{"type":2,"text":"Test on SageMaker"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/container_validation","content":[],"documentType":"guide"},{"title":"CMAA Requirements","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_config","content":[" The Configured Model Algorithm (CMA) and its association (CMAA) define how your custom model integrates with the AMC-AWS Clean Rooms collaboration. These configurations are immutable — any changes require creating new CMA and CMAA instances.\n"," For implementation details, refer to the AWS Clean Rooms Custom Models Documentation.\n"],"documentType":"guide"},{"title":"CMAA Requirements","sectionHeader":{"type":2,"text":"Configured Model Algorithm (CMA)"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_config","content":[" A CMA defines the core components of your model:\n"],"documentType":"guide"},{"title":"CMAA Requirements","sectionHeader":{"type":2,"text":"Configured Model Algorithm Association (CMAA)"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_config","content":[" The CMAA connects your CMA to the collaboration and defines execution parameters:\n"],"documentType":"guide"},{"title":"CMAA Requirements","sectionHeader":{"type":3,"text":"Required Configurations"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_config","content":["Model Artifacts Export:\n","Privacy Configuration:\n"],"documentType":"guide"},{"title":"CMAA Requirements","sectionHeader":{"type":3,"text":"Service Role Requirements"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_config","content":[" The CMAA must reference an IAM role that allows: - Reading container images from ECR - Publishing metrics to CloudWatch - Accessing necessary AWS Clean Rooms resources\n"],"documentType":"guide"},{"title":"CMAA Requirements","sectionHeader":{"type":2,"text":"Best Practices"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_config","content":["Naming Conventions:\n","Metric Definitions:\n","Resource Management:\n"],"documentType":"guide"},{"title":"Log Configuration Policy Details","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_log_policy","content":[" Proper log configuration is crucial for debugging and monitoring custom models in AMC. There are two approaches to accessing logs: full log capture and automatic error summary egress.\n"],"documentType":"guide"},{"title":"Log Configuration Policy Details","sectionHeader":{"type":2,"text":"Full Log Capture"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_log_policy","content":[" To enable full log capture, configure the log policy to allow access only to the Audience Generator account:\n"],"documentType":"guide"},{"title":"Log Configuration Policy Details","sectionHeader":{"type":3,"text":"Important Considerations"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_log_policy","content":["Exclusive Access:\n","Log Access Process:\n"],"documentType":"guide"},{"title":"Log Configuration Policy Details","sectionHeader":{"type":2,"text":"Automatic Error Summary Egress"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_log_policy","content":[" For automated access to error summaries, implement the following log policy configuration in either or both the TrainedModel or TrainedModelInferenceJob container definitions:\n"],"documentType":"guide"},{"title":"Log Configuration Policy Details","sectionHeader":{"type":3,"text":"Accessing Error Summaries"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_log_policy","content":[" Once the offending TrainedModel or TrainedModelInferenceJob run has failed, the status details field will contain a presigned URL with the error summary content.\n"],"documentType":"guide"},{"title":"Log Configuration Policy Details","sectionHeader":{"type":3,"text":"Error Summary Contents"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_log_policy","content":["Redacted version of error logs - No PII or sensitive numerical data - Basic error information and stack traces - System-level error messages\n"],"documentType":"guide"},{"title":"MLIC Requirements","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/mlinput-channels/mlic_requirements","content":[" ML Input Channels (MLIC) manage the data preparation pipeline for model training and inference in AMC Custom Models. These channels must be properly configured to ensure successful model execution and data privacy compliance.\n"],"documentType":"guide"},{"title":"MLIC Requirements","sectionHeader":{"type":2,"text":"Performance Optimization"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/mlinput-channels/mlic_requirements","content":["Data Volume Management:\n","Resource Utilization:\n","Error Prevention:\n"],"documentType":"guide"},{"title":"MLIC Requirements","sectionHeader":{"type":2,"text":"Best Practices"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/mlinput-channels/mlic_requirements","content":["Data Preparation:\n","Version Control:\n","Monitoring:\n"],"documentType":"guide"},{"title":"Data Sources","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/mlinput-channels/data_sources","content":[" AMC Custom Models allows you to leverage AMC data in ML modeling tasks. The AMC Measurement UI can be used to design the queries (with aggregation) to understand the use case to explore. Then it is possible to build an audience query using the \\_for_audiences tables and the sources available can be found here.\n"],"documentType":"guide"},{"title":"Data Sources","sectionHeader":{"type":2,"text":"Data Source Requirements"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/mlinput-channels/data_sources","content":[" MLICs must use tables with the \\_for_audiences suffix. These tables are specifically designed for audience targeting and modeling purposes:\n"],"documentType":"guide"},{"title":"Data Sources","sectionHeader":{"type":2,"text":"Query Requirements"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/mlinput-channels/data_sources","content":[],"documentType":"guide"},{"title":"Data Sources","sectionHeader":{"type":3,"text":"Required Elements"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/mlinput-channels/data_sources","content":["User Identification:\n","Time Windows:\n","Data Structure:\n"],"documentType":"guide"},{"title":"Data Sources","sectionHeader":{"type":3,"text":"Example Query Structure"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/mlinput-channels/data_sources","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[" The following section provides a high-level overview of the custom modeling workflow in AMC.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":2,"text":"Model authoring"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":3,"text":"[Data exploration and SQL query generation](guides/amazon-marketing-cloud/custom-models/mlinput-channels/data_sources)"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[" Design the AMC SQL queries for the input data for training and inference you want to pass to your SageMaker container at runtime.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":3,"text":"[Model requirements](guides/amazon-marketing-cloud/custom-models/modeling-requirements/sagemaker_requirements)"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[" Your model image must conform to SageMaker custom model container specifications.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":2,"text":"Model deployment and execution"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":3,"text":"Model packaging, hosting, and validation"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[" After your code is ready and packaged as a SageMaker compatible Docker image, upload the image to ECR and associate a service role to the repository so AWS Clean Rooms can read the image.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":3,"text":"[Model association](guides/amazon-marketing-cloud/custom-models/modeling-requirements/acrml_config)"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[" After a valid Docker image exists within ECR, create a configuredModelAlgorithm using  the AWS Clean Rooms UI or API. This configuredModelAlgorithm can be associated to the AMC collaboration to create a configuredModelAlgorithmAssociation (CMAA), which is used during model training and inference.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":3,"text":"[MLIC Creation](guides/amazon-marketing-cloud/custom-models/workflow/mlic_creation)"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[" Using your AMC query and the CMAA created above, create an ML Input Channel.  This MLIC manages what data is used for model training and inference.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":3,"text":"[Model Training](guides/amazon-marketing-cloud/custom-models/workflow/model_training)"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[" Start a Model Training Job for your CMAA. When the training completes successfully,  trained model weights and parameters will be serialized and stored by ACRML for use in model inference.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":3,"text":"[Model Inference](guides/amazon-marketing-cloud/custom-models/workflow/model_inference)"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[" Start a Trained Model Inference Job to run your trained model against other AMC data.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":3,"text":"[Modeled Dataset Creation](guides/amazon-marketing-cloud/custom-models/workflow/export_results)"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[" Using the results from your model inference job, a modeled dataset can be created. This dataset can then be used in other AMC products.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - workflow overview","sectionHeader":{"type":2,"text":"Audience creation and activation"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/high_level_workflow","content":[" After the inference data is successfully uploaded and available for querying in AMC, use Rule-Based Audience (RBA) or Look-Alike Audience (LAL) capabilities to create audiences based on the data for media activation. These audiences can then be activated by pushing them to Amazon DSP for further use.\n"],"documentType":"guide"},{"title":"MLIC Creation","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/mlic_creation","content":[" Create an mlInputChannel using your query and configuredModelAlgorithmAssociation by calling the createMLInputChannel API. The mlInputChannel is responsible for preparing the data used for training and inference.\n"," Service architecture\n"],"documentType":"guide"},{"title":"Model Inference Job Creation","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/model_training","content":[" Create a new TrainedModelJob using the mlInputChannel and configuredModelAlgorithmAssociation described above by calling the CreateTrainedModel API. AMC will call the AWS Clean Rooms API to execute the container image and create a new TrainedModel. As a part of the training container the trained model is saved for inference purposes.\n"," As your container is executing, you can view the metrics generated (by your code) in the CloudWatch Metrics Dashboard.\n"," Service architecture\n"],"documentType":"guide"},{"title":"Modeled Inference Job Creation","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/model_inference","content":[" Upon successful model training, create a new TrainedModelInferenceJob using the mlInputChannel and trainedModel  by calling the TrainedModelInferenceJob API endpoint.\n"," Service architecture\n"," After a model is trained, it is serialized and saved in the AWS Clean Rooms environment for subsequent inferencing. During inferencing, your container code receives an input data (from an ML input data) in the form of an HTTP request, and must respond with the desired inference results (i.e., predicted values). The results are stored in the AWS Clean Rooms and can be uploaded to a new modeled dataset in AMC for audience creation.\n"],"documentType":"guide"},{"title":"Modeled Dataset Creation","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/workflow/export_results","content":[" After generating the inference output, you will provide the upload table schema to the inference output to define how it will look in AMC. Once the table is created, use the ModeledDatasetUpload APIs to upload the inference output data to the newly created table in AMC.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" A ProtectedQueryExecutionError (PQEE) occurs when your ML Input Channel (MLIC) query exceeds the processing limits of the AMC query engine. The query is syntactically valid — it parses and compiles — but the engine cannot execute it within its resource constraints.\n"," PQEEs can be resolved by optimizing the query itself, or by splitting the work across multiple simpler MLICs.\n"," Key characteristics of PQEEs:\n","The error message typically reads: ProtectedQueryExecutionError. The query failed to execute or references query size and/or complexity is not supported. - PQEEs are not caused by bad SQL syntax. Your query is valid; it is just too resource-intensive to execute.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":2,"text":"Common Causes"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" PQEEs generally arise from one or more of these factors:\n","| Cause | Example |\n","\\|-------\\|---------\\|\n","| Large time windows | Querying many months of dsp_impressions_for_audiences |\n","| Complex JOIN operations | Multiple large tables joined, especially with hidden cartesian products |\n","| Many columns | Feature engineering queries computing large numbers of columns |\n","| Non-sargable filters | ARRAY_CONTAINS in WHERE clause forcing full scans |\n","| Deeply nested CTEs | Many CTE levels with large intermediate datasets |\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":2,"text":"Strategy 1: Optimize Your Query"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" Before splitting into multiple MLICs, try optimizing the query itself. The AMC SQL optimization guide covers the key techniques in detail:\n"," The most impactful optimizations for PQEE resolution:\n","Use sargable filters — replace ARRAY_CONTAINS in WHERE with CTE + INNER JOIN or IN clause - Eliminate hidden cartesian joins — aggregate in CTEs first, then join - Prefer UNION ALL over JOIN when row-by-row matching is not needed - Optimize JOIN order — smallest table first, INNER over LEFT, avoid FULL OUTER\n"," On reducing time windows: If your use case allows a shorter lookback period, that can resolve PQEEs quickly. However, many use cases genuinely require long time windows — CLTV models need 6+ months of purchase history, seasonal analysis needs a full year, and NTB models need enough history to distinguish new from returning customers. If you need the full time window, do not compromise your model quality — use the split+join pattern in Strategy 2 instead.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":2,"text":"Strategy 2: Split Into Multiple MLICs (The Split+Join Pattern)"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" When query optimization alone does not resolve PQEEs, the recommended approach is to split your complex query into multiple simpler MLICs and combine the results in your training container.\n"," This is the most reliable workaround for PQEEs.\n"," Cost note: Combining multiple input channels in your container increases the data volume processed during training, which can increase job duration and cost. Plan your splits to balance query simplicity against the additional processing time.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"How It Works"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" Instead of one MLIC that does everything:\n"," You create several simpler MLICs, each covering a portion of the work:\n"," Each MLIC becomes an input channel to your training job (up to 20). Your container code reads all channels and combines them.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Split Strategy 1: By Date Range"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" Use when your query spans a long time period. Create multiple MLICs with the same query but different timeWindowStart/timeWindowEnd values on the API call.\n"," Example: A 90-day lookback becomes three 30-day MLICs:\n","| Channel Name | timeWindowStart | timeWindowEnd |\n","\\|-------------\\|-------------------\\|-----------------\\|\n","| jan_data | 2025-01-01T00:00:00Z | 2025-02-01T00:00:00Z |\n","| feb_data | 2025-02-01T00:00:00Z | 2025-03-01T00:00:00Z |\n","| mar_data | 2025-03-01T00:00:00Z | 2025-04-01T00:00:00Z |\n"," Each MLIC uses the same query — the time window parameters scope the data:\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Split Strategy 2: By Columns"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" Use when you compute many features and the sheer number of columns causes the PQEE. Create separate MLICs for each feature group:\n","MLIC \"impression_features\": Impression-related columns only - MLIC \"conversion_features\": Purchase-related columns only - MLIC \"engagement_features\": Click/engagement columns only\n"," Each query is simpler and touches fewer data sources.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Split Strategy 3: By Segment"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" Use when your query has multiple OR conditions or processes different populations:\n","MLIC \"retargeting_users\": Only retargeting campaign data - MLIC \"prospecting_users\": Only prospecting campaign data\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Combining MLICs in Your Container"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" When your training job runs, the data of each MLIC is available as a subdirectory under /opt/ml/input/data/ named by its channel.\n"," Use when all MLICs have the same schema and you want to simply concatenate them:\n"," Use when you know the channel names and want explicit control:\n"," Use when you split by columns or segments and need to join on user_id:\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":2,"text":"End-to-End Example: CLTV Model With Split MLICs"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" This illustrative example shows how to build a Customer Lifetime Value model using the split+join pattern when a single MLIC with a long lookback window causes PQEEs.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Step 1: Design Your Splits"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":["| Channel Name | Purpose | Query Scope |\n","\\|-------------\\|---------\\|-------------\\|\n","| purchase_q1 | Purchase features, months 1-2 | conversions table, 60 days |\n","| purchase_q2 | Purchase features, months 3-4 | conversions table, 60 days |\n","| purchase_q3 | Purchase features, months 5-6 | conversions table, 60 days |\n","| impression_features | Ad exposure features, full period | impressions table, 180 days |\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Step 2: Create Each MLIC"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" Create four MLICs via the API. Each uses a simple query — the time scoping comes from the timeWindowStart/timeWindowEnd parameters on the MLIC creation request:\n","| Channel | timeWindowStart | timeWindowEnd |\n","\\|---------\\|-------------------\\|-----------------\\|\n","| purchase_q1 | 2025-01-01T00:00:00Z | 2025-03-01T00:00:00Z |\n","| purchase_q2 | 2025-03-01T00:00:00Z | 2025-05-01T00:00:00Z |\n","| purchase_q3 | 2025-05-01T00:00:00Z | 2025-07-01T00:00:00Z |\n","| impression_features | 2025-01-01T00:00:00Z | 2025-07-01T00:00:00Z |\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Step 3: Create Training Job"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" Reference all four MLICs as input channels in your createTrainedModel request. The mlInputChannels field is a top-level array:\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Step 4: Container Code"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":2,"text":"Important Caveats"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"`ROW_NUM()` Is Not Consistent Across Queries"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" If your SQL uses ROW_NUM() (or ROW_NUMBER()), the numbering is not deterministic across separate queries. The same user may get different row numbers in different MLICs.\n"," Workaround: Use a deterministic column (like a timestamp, hashed ID, or natural key) for ordering in your container code rather than relying on SQL-assigned row numbers.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"MLIC Expiration"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" MLICs expire after 30 days. If you create your split MLICs over several days, ensure all of them are still active when you create the training job. A good practice is to create all split MLICs in the same session.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Channel Name Conventions"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" Choose descriptive channel names that make your container code self-documenting. Names like q1_data, impression_features, conversion_features are much clearer than channel_1, channel_2, channel_3.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Test With Small Scope First"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" Before creating all your split MLICs with production time windows:\n","Test each query with a short time window to confirm it succeeds 2. Then scale to your target time window per MLIC 3. If a split MLIC still causes a PQEE, split it further (e.g., 60 days → two 30-day MLICs)\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":3,"text":"Cost Awareness"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[" More input data in your training container means longer processing time and higher job cost. If you split into many channels with large datasets, monitor your job duration to ensure it stays within expectations.\n"],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":2,"text":"Decision Tree: PQEE Resolution"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":[],"documentType":"guide"},{"title":"Resolving ProtectedQueryExecutionError","sectionHeader":{"type":2,"text":"Summary"},"path":"/en-us/guides/amazon-marketing-cloud/custom-models/troubleshooting/pqee_resolution","content":["| Approach | When to Use | Effort |\n","\\|----------\\|------------\\|--------\\|\n","| Query optimization | Always try first — see guide | Low — query changes only |\n","| Reduce time window | Long lookback periods (if use case allows) | Low — API parameter change |\n","| Split by date range | Time-window-driven PQEEs | Medium — multiple MLICs + container code |\n","| Split by columns | Feature-count-driven PQEEs | Medium — multiple MLICs + container merge |\n","| Split by segment | Segment-driven PQEEs | Medium — multiple MLICs + container merge |\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" With AMC rule-based audience creation, advertisers can now go one step further from deriving audience insights to directly creating custom audiences for use in Amazon Demand Side Platform (Amazon DSP), Sponsored Brands, Sponsored Products, and Sponsored Display. Advertisers have the same flexibility to use a query to create custom audiences in AMC that best support their advertising and business goals, or create a seed group for lookalike modeling.\n"," Using the rule-based audiences API, you can build and activate custom audiences utilizing eligible signals in your AMC instance, across Sponsored Brands, Sponsored Products, Sponsored Display, Amazon DSP, and Amazon shopping insights (beta), as well as your own signals brought to AMC.\n"," Audiences created in AMC are made available in your advertiser account (Amazon DSP or sponsored ads accounts). These audiences can be used in targeting in Amazon DSP or Sponsored Display and in bid modifiers in Sponsored Products and Sponsored Brands.\n"," AMC audiences for Amazon DSP\n"," You can create AMC custom audiences for relevant line items similar to how regular Amazon DSP audiences are selected today.\n"," AMC audiences for sponsored ads\n"," You can create AMC custom audiences for use in the respective sponsored ads products, as described below:\n","Sponsored Brands: you can selectively modify the bids for them when launching your campaigns.\n","Sponsored Products: by adjusting bids when creating and managing campaigns.\n","Sponsored Display: where you can specify the custom AMC audience for targeting with your campaigns.\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":3,"text":"Rule-based audiences API endpoints"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" The rule-based audiences service provides the following API endpoints to create and manage audiences:\n","| Method | Endpoint                                   | Description                                                                        |\n","\\| ------ \\| ------------------------------------------ \\| ---------------------------------------------------------------------------------- \\|\n","| POST   | /amc/audiences/query                       | Create a rule-based audience and send it to Amazon DSP or a sponsored ads account. |\n","| GET    | /amc/audiences/query                       | List status and other metadata for all audiences. Get all rule-based audience      |\n","| GET    | /amc/audiences/query/{audienceExecutionId} | List rule-based audience metadata for a specific audience execution identifier     |\n","| PUT    | /amc/audiences/query/{audienceExecutionId} | Update rule-based audience metadata for a specific audience execution identifier   |\n","| DEL    | /amc/audiences/query/{audienceExecutionId} | Deletes failed rule-based audience for a specific audience execution identifier    |\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":3,"text":"Rate limits"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" The following table lists throttling limits for rule-based audience APIs.\n","| Endpoint                                       | Rate limit | Burst limit |\n","\\| ---------------------------------------------- \\| ---------- \\| ----------- \\|\n","| POST /amc/audiences/query                      | 5          | 5           |\n","| GET /amc/audiences/query                       | 5          | 10          |\n","| GET /amc/audiences/query/{audienceExecutionId} | 5          | 10          |\n"," The rate limit defines the number of allowed requests per second. The burst limit defines the number of requests your API can handle concurrently.\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":2,"text":"Create rule-based audiences"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" Before you can start creating rule-based audiences, you must first define your use case for which you want to create audiences. And, then write appropriate queries that will give you the best fit for your use case.\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":3,"text":"Available data for rule-based audiences queries"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" To understand the data available, refer to the AMC Data sources. The following is a list of AMC data sources that can be used to create AMC rule-based audiences:\n","| Dataset category                | Dataset                                                                   | Available for Amazon DSP audience queries? | Available for sponsored ads audience queries? |\n","\\| ------------------------------- \\| ------------------------------------------------------------------------- \\| ------------------------------------------ \\| ---------------------------------------------- \\|\n","| Amazon ads                      | amazon_attributed_events_by_conversion_time_for_audiences          | Y                                          | Y                                              |\n","| Amazon ads                      | amazon_attributed_events_by_traffic_time_for_audiences             | Y                                          | Y                                              |\n","| Amazon ads                      | conversions_for_audiences                                               | Y                                          | Y                                              |\n","| Amazon ads                      | conversions_with_relevance_for_audiences                              | Y                                          | Y                                              |\n","| Amazon ads                      | dsp_clicks_for_audiences                                               | Y                                          | Y                                              |\n","| Amazon ads                      | dsp_impressions_by_matched_segments_for_audiences                   | Y                                          | Y                                              |\n","| Amazon ads                      | dsp_impressions_by_user_segments_for_audiences                      | Y                                          | Y                                              |\n","| Amazon ads                      | dsp_impressions_for_audiences                                          | Y                                          | Y                                              |\n","| Amazon ads                      | dsp_views_for_audiences                                                | Y                                          | Y                                              |\n","| Amazon ads                      | sponsored_ads_traffic_for_audiences                                   | Y                                          | Y                                              |\n","| Amazon ads                      | dsp_video_events_feed_for_audiences                                  | Y | N |         \n","| Paid features   | conversions_all_for_audiences                                          | Y                                          | Y                                              |\n","| Paid features   | audience_segments_amer_inmarket_for_audiences                        | Y                                          | N                                              |\n","| Paid features   | audience_segments_amer_lifestyle_for_audiences                       | Y                                          | N                                              |\n","| Paid features   | audience_segments_apac_inmarket_for_audiences                        | Y                                          | N                                              |\n","| Paid features   | audience_segments_apac_lifestyle_for_audiences                       | Y                                          | N                                              |\n","| Paid features   | audience_segments_eu_inmarket_for_audiences                          | Y                                          | N                                              |\n","| Paid features | audience_segments_eu_lifestyle_for_audiences                         | Y                                          | N                                              |\n","| Paid features    | segment_metadata_for_audiences                                         | Y                                          | N                                              |\n","| Paid features    | amazon_brand_store_page_views(\\_non_endemic)\\_for_audiences       | Y                                          | N                                              |\n","| Paid features   | amazon_brand_store_engagement_events(\\_non_endemic)\\_for_audiences | Y                                          | N                                              |\n","| Paid features    | amazon_retail_purchases_for_audiences | Y                                          | Y    |\n","| Paid features    | amazon_your_garage_all_for_audiences | Y                                          | Y    |\n","| Paid features    | amazon_pvc_enrollments_for_audiences | Y                                          | Y    |\n","| Paid features    | amazon_pvc_streaming_events_feed_for_audiences | Y                                          | Y    |\n","| Paid features    | ncs_cpg_insights_stream_for_audiences   | Y    | N   |\n","| Advertiser Uploaded             | First-party table names (will not include the \\_for_audiences suffix) | Y                                          | Y                                              |\n"," If you wish to use an Advertiser Uploaded table, there is no change to the table name; however the user_id column is the column identified as isMainUserId when uploaded.\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":3,"text":"Rule-based audiences: header parameters"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" The following header parameters are required for all rule-based audience requests\n","| Header                                         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                         |\n","\\| ---------------------------------------------- \\| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| Amazon-Advertising-API-ClientId             | The client ID related to a Login with Amazon application.                                                                                                                                                                                                                                                                                                                                                                                           |\n","| Authorization                                  | A valid API access token in the format Bearer {token}.                                                                                                                                                                                                                                                                                                                                                                                             |\n","| Accept                                         | application/json                                                                                                                                                                                                                                                                                                                                                                                                                                    |\n","| Amazon-Marketing-Cloud-Audience-InstanceId | The Amazon Marketing Cloud instance identifier. This identifier can be found on the Instance Info page of the AMC UI.                                                                                                                                                                                                                                                                                                                             |\n","| Amazon-Advertising-API-EntityId             | The Amazon Marketing Cloud entity identifier. Your AMC Amazon Ads account executive would have provided you this identifier when you on-boarded to AMC. Alternatively, access the AMC console with your user identifier and password, and grab the entity identifier value that is displayed in the URL. The alphanumeric code that is prefixed with ENTITY is your account identifier. An example of an entity identifier is:  ENTITY1AA1AA11AAA1. |\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":3,"text":"Steps to create rule-based audiences"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" The following section lists the steps, the tables, and the SQL queries that you will need when creating rule-based audiences\n"," AMC audiences are constructed from user_ids. This means, when writing rule-based audience queries, the SELECT statement must contain user_id.\n"," If you want to know how large an audience is prior to submitting your audience creation request, you can query traditional AMC APIs to get that information.This is a best practice to follow, as audiences may fail to generate if they are of insufficient size. AMC rule-based audiences require a minimum audience size of 2,000 records; target 2,500 records or more to prevent failure. AMC lookalike audiences require a minimum of 500 and a maximum of 500,000.\n"," Here is an example of how a query could be executed in AMC API to count the number of user_ids given a set of constraints:\n"," In this example, you can wrap the user_id in COUNT because user_id can never be returned in AMC measurement queries.\n"," After you determine the audience size, use the POST operation of the /amc/audiences/query resource to create the audience.\n"," Once you create an audience and it is made available in Amazon DSP or in your sponsored ads campaigns, you cannot edit it. If your audience fails, however, you can edit the query, date range, and auto adjust the date. For more information, refer to Manage failed audiences.\n"," Unlike the AMC measurement queries, AMC Audience queries do not send data to your S3 bucket (as it contains private user_id data). Instead, audiences are sent directly to the application that requested the audiences, which is Amazon DSP or your sponsored ads campaigns.\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":3,"text":"Constraints for AMC audience creation"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" Query deal_id\n"," If the deal_id column is populated for a given row in the following tables, the row containing the deal_id value will not be available for querying.\n","dsp_clicks_for_audiences\n","dsp_impressions_by_matched_segments_for_audiences\n","dsp_impressions_by_user_segments_for_audiences\n","dsp_impressions_for_audiences\n"," Query tracked_asin and tracked_item\n"," Some tracked_asin values reflect products that are sensitive in nature. These tracked_asin values have been removed from both tracked_asin and tracked_item to prevent them from being used for audience activation.\n"," user_behavior_segment_ids and matched_behavior_segment_ids\n"," The dsp_impressions_for_audiences table does not contain the columns:\n","user_behavior_segment_ids\n","matched_behavior_segment_ids\n"," Targetable user_ids\n"," Only the adUserId type is targetable for audience creation, even though your measurement queries may include other user_id types. The 90% adUserId coverage is an important factor limiting the full audience size.\n"," Opt-outs and exclusions\n"," The final audience omits users that have opted out of targeting, as well as any users identified as potential children, even though their data may be present in your measurement query.\n"," Deduplication and reconciliation issues\n"," The incomplete deduplication and merging of user IDs can result in a small percentage of users being excluded from the final audience, even though those audiences may have been counted in your measurement queries.\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":2,"text":"Create a rule-based audience"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" Use the POST operation of the /amc/audiences/query endpoint to create a rule-based audience execution metadata.\n"," This operation starts the execution workflow to create an audience. This is an idempotent operation.\n"," When creating audiences, it is important for you to understand how the following parameters govern the output of your audience:\n","audienceName:  The audienceName, a required field when creating the audience, will be displayed in the target application (Amazon DSP or your sponsored ads accounts). It is recommended to use a unique audience name each time you create an audience.\n","advertiserId: The advertiser ID of the Amazon DSP account or the sponsored ads account to which you are activating the audience. The advertiser identifiers for both Amazon DSP and sponsored ads associated with your AMC instance are displayed on the Instance Info page of the AMC console.\n","refreshRateDays: The value of refreshRateDays determines how frequently the SQL query is re-run and the existing audience is completely overwritten with new data. The refreshRateDays parameter allows you to (1) keep the audience active in the target application and (2) re-run the SQL query at a specified interval.\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":3,"text":"Get all rule-based audiences for a specific AMC instance"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" The GET /amc/audiences/query endpoint returns list of execution metadata information for a given instanceId.\n"," This endpoint accepts maxResults and nextToken as query parameters.\n"," The maxResults query parameter limits the number of audience execution metadata objects returned in the response. If there are more objects left to retrieve, the response will include an encrypted token (nextToken), which can be used to retrieve the next set of results. If the total number of results creates a response larger than 1MB, the results will be truncated to 1MB.\n"," The response body contains all the audience creation metadata, as described on the POST operation. In addition, the following status-related details are returned too:\n","lastRefreshedTime: The most recent date and time the audience was refreshed (that is, the SQL query was re-run per the refreshRateDays) and pushed to advertiser accounts in the target application. Each time the audience is refreshed and the new audience data overwrites the existing audience in the target application, this attribute is updated.\n","status: The status of the audience execution. Can be one of the following:\n","statusReason: If the status field displays FAILED, the statusReason provides additional information about why the audience creation failed. For example, the following statusReason is returned when you do not use audience-specific tables in the query:\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":3,"text":"Get the rule-based audience metadata for a specific audience identifier"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" Refer to the Response body of the POST parameter operation to get the audienceExecutionId\n"," If the response returns the status of SUCCEEDED, you can view the audience in the advertiser account it was created for.\n"," If the response returns a status of FAILED, you can view the statusReason to determine the cause of the failure.\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":3,"text":"View and use your custom audiences"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" After an audience is created for an Amazon DSP account, it is activated and made available for use in Amazon DSP. To view the audience details:\n","Use GET /amc/audiences/query/{audienceExecutionId} to retrieve the DspCanonicalId.\n","Use POST /audiences/list, in the request body provide the DspCanonicalId to filter by audienceId.\n","Filter through category= Custom-built and subCategory = AMC.\n"," You can also log into the Amazon Ads console to view the audience. Navigate to Custom-built > AMC under the Audience tab in Amazon DSP.\n"," After an audience is created for your sponsored ads account, you can retrieve it using the POST /targetableEntities/list endpoint. Use AUDIENCE as the targetTypeFilter and pass \"Audience Category\", \"Custom-built\", \"AMC\" as the value for pathsFilter, as shown below:\n"," This call will list all the AMC audiences created for the sponsored ads campaigns. Note the audienceId to activate the audience in your sponsored ads campaigns.\n"," After you retrieve the audienceId, you modify the based on specific audience segments when creating Sponsored Products campaigns (POST /sp/campaigns) and Sponsored Brands campaigns (POST /sb/campaigns ).\n"," When creating a Sponsored Display campaign, create a target using POST/sd/targets and provide the audienceId you created using rule-based audiences.\n"],"documentType":"guide"},{"title":"Rule based audiences","sectionHeader":{"type":3,"text":"Manage failed audiences"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-audiences","content":[" AMC allows you to update or delete audiences that failed during creation.\n"," By updating or deleting the failed audiences, you can ensure that your audience list contains only relevant audiences.\n"," To update a rule-based audience that failed during creation, use the PUT /amc/audiences/query/{audienceExecutionId} endpoint of the API to modify the query you used to create your rule-based audience.\n"," This endpoint allows you to update the following parameters:\n","timeWindowStart\n","timeWindowEnd\n","query\n","timeWindowRelative\n","workflowId\n","inputParameters\n","parameterValues\n"," A successful call returns an HTTP status code of 200 OK and the audience with updated values is created. The audience will take between 2 - 24 hours to synchronize with the advertiser account in the target application.\n"," Use the DELETE /amc/audiences/query/{audienceExecutionId} endpoint to remove audiences that failed to create through the POST operation of the /amc/audiences/query endpoint.\n"," If the status field of the GET /amc/audiences/query/{audienceExecutionId} endpoint response displays FAILED, the statusReason provides additional information about why the audience creation failed.\n"," For example, the following statusReason is returned when you do not use audience-specific tables in the query:\n"," An audience creation can fail due to any of the following reasons:\n","The audience submitted does not reach 2,000 user_ids, which is the minimum number required to create audiences.\n","In the SQL query, you referenced a table that was not supported for Audiences.\n"],"documentType":"guide"},{"title":"Rule-based lookalike audiences","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-lookalike","content":[" The AMC rule-based audiences lookalike API allows you to build lookalike audiences to expand your reach and enhance the effectiveness of your advertising efforts, while ensuring the security and privacy of customer and business data. The AMC rule-based audience lookalike API allows you to create an audience similar to an AMC rule-based audience seed that can be used in Amazon Demand Side Platform (Amazon DSP), Sponsored Brands, Sponsored Products, and Sponsored Display campaigns, to reach millions of shoppers, thereby increasing your targeting capabilities. The rule-based audience lookalike API is an extension of the current AMC rule-based audiences API. Using the same query language and datasets as rule-based audiences, you can define the seed audience from which AMC will model the lookalike audience.\n"," The API uses rule-based audiences as the seed to build an audience with similar characteristics (that is, an audience that \"looks like\" the seed audience). This allows you to leverage your effective rule-based audiences to create lookalike audiences and further expand your reach.\n"],"documentType":"guide"},{"title":"Rule-based lookalike audiences","sectionHeader":{"type":3,"text":"Create a lookalike audience"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/rule-based-lookalike","content":[" The rule-based audiences lookalike API provides the following API endpoint to manage rule-based audiences lookalike audiences:\n"," Creates a rule-based audience lookalike execution metadata. This operation starts the execution workflow to create lookalike audience and activate it in the target product.\n"," When creating the rule-based audience lookalike execution metadata, make note of the following parameters to help you tailor your output:\n","lookalikeAudienceExpectedReach: The lookalikeAudienceExpectedReach, a required field for creating lookalike audiences, sets the target size of the lookalike audience. Here you specify if you want to create audiences based on the similarity of the characteristics of the seed audience or if you intend to create a broader set of audiences (and not prioritize the audience creation based on its similarity with the seed audience).\n","refreshRateDays: The value of refreshRateDays determines how frequently the SQL query is re-run and the existing seed audience is completely overwritten with new data. The refreshRateDays parameter allows you to \n"," If the response returns the status of SUCCEEDED, you can view the audience in the advertiser account it was created for.\n"," If the response returns a status of FAILED, you can view the statusReason to determine the cause of the failure.\n"," For example, the following statusReason is returned when you do not use audience-specific tables in the query:\n"," Some of the reasons for a lookalike audience creation to fail are:\n"],"documentType":"guide"},{"title":"Advertiser audiences","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/audiences/advertiser-audience-using-adu","content":[" The Advertiser Data Upload (ADU) APIs enable you to create first-party audience segments in Amazon Marketing Cloud (AMC) using advertiser audiences. The audiences created in AMC are activated in the Amazon Demand-Side Platform (Amazon DSP), where you can use them for your targeting needs. \n"],"documentType":"guide"},{"title":"Advertiser audiences","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/advertiser-audience-using-adu","content":["Ensure you have access to AMC and have completed Amazon Ads API onboarding. - Familiarize yourself with ADU APIs and set up an S3 bucket. \n"],"documentType":"guide"},{"title":"Advertiser audiences","sectionHeader":{"type":3,"text":"Rule-based audience with Advertiser audiences"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/advertiser-audience-using-adu","content":[" This tutorial helps you with the creation of advertiser audiences using your proprietary first-party customer data uploaded through the Advertiser Data Upload (ADU) APIs.  Choosing between advertiser audiences APIs and S3 Upload APIs\n"," The choice between advertiser audiences APIs and S3 Upload (via the AMC Advertiser Data Upload API) APIs depends largely on the role of your organization, technical capabilities, and data management needs.\n"," The advertiser audiences API is particularly well-suited for SaaS providers, especially Customer Data Platforms (CDPs), along with agencies and consultancies that need to build permanent, \"always-on\" data integrations with Amazon Ads. This API is also appropriate for direct advertisers who have the technical resources and capability to build and maintain an ongoing API integration. Organizations choosing this route should be prepared for continuous management and have dedicated technical teams to support the integration. The Advertiser Audience APIs can create an audience in Amazon DSP by default, with no further alterations by the user in AMC.\n"," However, the S3 Upload APIs are often a better choice if your primary need is to upload first-party signals related to sales, conversions, or other non-audience metrics and do further filtering or transformation. This API is also more appropriate if you plan to manage your data uploads on an ad hoc or periodic basis rather than requiring continuous synchronization. It offers more flexibility for data types and requires less technical overhead to maintain if performing infrequent or ad-hoc uploads.\n","| Factor              | Advertiser audiences API | S3 Upload API \n","\\|---------------------\\|--------------------------\\|----------------------------\\|               \n","| Integration type    | Permanent                | Flexible                   |\n","| Upload frequency    | Continuous               | As needed                  |\n","| Use case            | Audience management      | Open-ended data types      |\n"],"documentType":"guide"},{"title":"Advertiser audiences","sectionHeader":{"type":3,"text":"Process overview"},"path":"/en-us/guides/amazon-marketing-cloud/audiences/advertiser-audience-using-adu","content":["Create a dataset definition 2. Upload hashed customer data 3. Set the country code 4. Create a rule-based audience\n"," Creating a dataset defines the schema that you will be uploading data to. Each time data is uploaded through the ADU APIs, it is validated against the schema you define. If any rows or columns in the file do not conform to the schema, the upload will be rejected. You can use the /amc/advertiserData/{instanceId}/dataSets API endpoint to create a new dataset.\n"," After you create a dataset definition, you can upload hashed first-party customer data to AMC. To do this, you need to prepare the data following required guidelines. Once you have prepared the data, you can use the steps described to upload the prepared data. After the upload, AMC will match the hashed users to Amazon users and populate the user_id column accordingly. In addition, AMC will remove all other data from a row once a user_id has been assigned to that row.\n"," When creating a dataset, you can specify the country code either at the row-level or dataset-level. You also have the option of setting the country code on the upload level. To learn more about setting the country code at the upload-level, refer to Setting the country code. \n"],"documentType":"guide"},{"title":"Data sets","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-overview","content":[" Advertiser data upload (ADU) allows advertisers to upload customizable datasets to an AMC instance. Advertiser-uploaded datasets can include any combination of columns defined by the advertiser. ADU APIs on Amazon Ads are also referred to as ADU 2.0.\n","| TILES WARNING                                                                                                                                                                                                                 |\n","\\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| Data that was uploaded using the previous version of ADU (ADU 1.0) can no longer be queried. To continue querying datasets that you had uploaded in ADU 1.0, delete the previously uploaded data, and re-upload using ADU 2.0. |\n"," Advertiser-uploaded datasets can include any combination of columns defined by the advertiser. Examples include (but are not limited to):\n","Off-Amazon conversion events - Store visits and in-store purchases - Additional product metadata - CRM Audience Segments - Advertiser mapping tables (e.g., DSP Advertiser to Sponsored Ads Advertiser)\n"," Datasets containing supported identifiers can be joined with AMC data to attribute off-Amazon events (purchases, sign-ups, store visits, etc.) to Amazon advertising events such as impressions and clicks.\n"],"documentType":"guide"},{"title":"Data sets","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-overview","content":["Amazon Marketing Cloud Terms must be accepted (in the UI) prior to using the data upload feature. If Terms and Conditions are not accepted, all API calls will respond with a 401 error code and error message. 2. Access to the AMC API on Amazon Ads API. AMC Data upload is an API-only feature. Note that you need the Campaign Management and Data Provider scopes associated with your developer credentials (Client ID). For more information on getting started with Amazon Ads API, see onboarding. 3. An AWS account and permissions to create an S3 bucket to store upload files.\n"],"documentType":"guide"},{"title":"Data sets","sectionHeader":{"type":2,"text":"Data upload process overview"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-overview","content":[" The high-level process to upload data to an AMC instance is described below.\n"],"documentType":"guide"},{"title":"Data sets","sectionHeader":{"type":3,"text":"Step 1 – Prepare your data"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-overview","content":[" Prepare the data to be uploaded to the AMC instance. For more information, refer to Prepare data.\n"],"documentType":"guide"},{"title":"Data sets","sectionHeader":{"type":3,"text":"Step 2 – Set up the S3 bucket"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-overview","content":[" Create an S3 bucket, if not already created, and configure it for storing data files to be uploaded. For more information, refer to Set up the S3 bucket.\n"],"documentType":"guide"},{"title":"Data sets","sectionHeader":{"type":3,"text":"Step 3 – Create datasets"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-overview","content":[" Create a new dataset using the Dataset API. For more information, refer to Data sets.\n"],"documentType":"guide"},{"title":"Data sets","sectionHeader":{"type":3,"text":"Step 4 - Upload data to the datasets"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-overview","content":[" Upload data to the new dataset by using the Upload API. For more information, refer to Data uploads.\n"],"documentType":"guide"},{"title":"Data sets","sectionHeader":{"type":3,"text":"Step 5 - Optionally, modify columns"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-overview","content":[],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" Before you begin creating datasets and uploading data, thoroughly read this topic to understand guidelines and requirements for the files and data you will upload, including compression options, file formats, and standardization and hashing data containing personally identifiable information (PII).\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":2,"text":"Compression options"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" To facilitate faster uploads, we recommend that files are compressed before uploading. \n"," AMC supports file compressions with algorithms BZIP, GZIP, ZIP, SNAPPY, or no compression with NONE.\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":2,"text":"Large files"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" Large files should be separated for optimal upload. We recommend partitioning files larger than 1GB into multiple files for upload. When uploading files larger than 1GB, the file read operation may fail during the upload process.\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":2,"text":"File format requirements"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" AMC accepts the following formats of files for upload:\n","CSV - JSON - Parquet\n"," All options have specific formatting requirements for the upload files.\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":3,"text":"CSV file requirements"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" CSV files must be UTF-8 encoded.\n"," The CSV format allows for any fieldDelimiter. For example, you can use comma-separated values (\",\") or tab-separated values (\"\\\\t\"); pipe-separated values (\"|\") are also common.\n"," Example CSV file\n"," Example CSV request body\n"," The following is an example of how to define the CSV fileFormat in the Create Upload API request body:\n"," Example TSV file\n"," The example below shows an example Tab-separated values (TSV) file.\n"," Example TSV request body\n"," The following is an example of how to define the TSV fileFormat in the Create Upload API request body:\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":3,"text":"JSON file requirements"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" JSON files must contain one object per row of data. An example of the accepted JSON format can be seen below.\n"," Example JSON file\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":3,"text":"Parquet file requirements"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" While there are no specific requirements for preparing parquet files, we recommend that you look up instructions to help you get started, depending on what you are using:\n","Python/Pandas - Spark SQL\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":2,"text":"Fact vs dimension datasets"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" Before data can be uploaded, a dataset must be created to store that data. AMC supports two types of datasets: Fact and Dimension.\n"," FACT datasets are used to store time-series data (event-level data), and require either a TIMESTAMP or DATE column for AMC to partition the uploaded files. Queries run on fact data will only evaluate against events that fall within the time range of the query. Example: Uploading purchase events, each with a TIMESTAMP type column, then querying for purchases that occurred on Tuesday.\n"," Dimension datasets can be used to upload a static table, or any information which is not time-bound. Queries run on dimension data will evaluate against the current set of records that have been uploaded at the time the query executes. Example: Uploading a customer list, which is a fixed set of records, with no time component, then querying for the count of customers aggregated by zip code.\n"," If a dataset has a column flagged as main event time (mainEventTime), it will be a fact dataset. Otherwise, it will be a dimension dataset.\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":2,"text":"Data types, timestamp, and date formats"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" Dataset columns can be defined with the following data types. Ensure all values conform to the specified data types and format before uploading.\n"," Pay close attention to the accepted formats for TIMESTAMP and DATE columns.\n"," Where possible, string values will be coerced to the corresponding numerical type and vice-versa, but no guarantees are made on the casting process.\n"," The table below lists the format of accepted data types:\n","| Data Type                  | Format                                             | Example              |\n","\\| ---------------------------- \\| ---------------------------------------------------- \\| ---------------------- \\|\n","| STRING                     | UTF-8 encoded character data                       | My string data       |\n","| DECIMAL                    | Numerical with two floating point level precision. | 123.45               |\n","| INTEGER (int 32-bit)       | 32-bit numerical, no floating points               | 12345                |\n","| LONG (int 64-bit)          | 64-bit numerical, no floating points               | 1233454565875646     |\n","| TIMESTAMP (must be in UTC) | yyyy-MM-ddThh:mm:ssZ                             | 2022-08-02T08:00:00Z |\n","| DATE                       | yyyy-MM-dd                                       | 2022-08-02           |\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":2,"text":"Partition Scheme (Period)"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" Before you begin uploading data, consider the partition scheme you want for the dataset. The partition scheme controls how granularly you can query the dataset. For example, if set to hourly, you can run queries down to the hour for time-based events. Although the default is daily, you can configure the partition size (the period parameter) when you create the dataset.\n"," The following options are supported:\n","PT1H (hourly partition) - P1D (daily partition) - this is the default option - P1M (monthly partition)\n"," Some examples:\n"," If you specify your dataset period to be monthly (P1M), then your queries corresponding to last Thursday will involve reading a month's worth of data. This is because Thursday is stored in a single partition with all other data for the month.\n"," If you specify the dataset as hourly (PT1H), and upload records that take place over the span of a year and query analytics for last Thursday, then the queries will read data within 24 hourly partitions that correspond to Thursday, causing this query to be more efficient.\n"," So, if you have a small volume of events and frequently query for analytics across long time windows, then hourly partitioning could cause queries to run more slowly. For example, if there are only a handful of events per day, and data are partitioned hourly (PT1H), and queries run once a quarter, many small partitions are read, when fewer, larger partitions would be more efficient.\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":2,"text":"ID resolution and supported identifiers"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" ID resolution is the process of matching the identifiers in the uploaded file to a corresponding Amazon user record. This allows you to join your uploaded data with Amazon data at the user level.\n"," The ID resolution process is as follows:\n","When uploading data, each record is processed, and if successful, will be matched with an existing Amazon user record. - When a match is found, a value for user_id (an anonymous user ID corresponding to an Amazon user) will be inserted in the row. The original identifiers are discarded and will not be made available to query in AMC. - Records that contain a value for user_id can then be joined with Amazon data, enabling advertisers to attribute off-Amazon events to Amazon media events within AMC.\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":3,"text":"Hashed PII column options"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" To facilitate ID resolution, you can upload a file containing identifiers such as email address or phone numbers.\n"," To perform ID resolution, the uploaded data should contain one or more of the supported identifier columns.\n","| Parameter | Description                                                                                                                                                                                                                                    |\n","\\| ----------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \\|\n","| user_id   | Column name for the unique user_id field. Specify the column that can be used to distinctly reference each row of your data. For example, Primary_key, Row_ID, or Record_ID. The event data should have the same value as this column. |\n","| FIRST_NAME | Column name for first name field.                                            |\n","| LAST_NAME  | Column name for last name field.                                             |\n","| EMAIL     | Column name for email field.                                                 |\n","| PHONE     | Column name for phone number.                                                |\n","| ADDRESS   | Column name for address field (street number and street name).              |\n","| CITY      | Column name for city name field.                                             |\n","| STATE     | Column name for state field.                                                 |\n","| ZIP       | Column name for zip code field.                                              |\n","| COUNTRY_CODE   | Column name for country field.                                               |\n"," The following code snippet is an example of defining a hashed email column when creating the dataset:\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":3,"text":"External identifier column options"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":["| Parameter  | Description                                                                 |\n","\\| ------------ \\| ----------------------------------------------------------------------------- \\|\n","| MAID       | Column name for Mobile Ad ID (MAID) field                                  |\n","| LIVERAMP | Column name for LiveRamp (RampID) field transcoded in Amazon identity space |\n","| EXPERIAN | Column name for Experian ID field                                           |\n","| REALID   | Column name for RealID field                                               |\n","| NEUSTAR  | Column name for Neustar ID field                                           |\n","| MERKLE   | Column name for Merkle ID field                                            |\n","| KANTAR   | Column name for Kantar ID field                                            |\n","| SAMBATV  | Column name for SambaTV ID field                                           |\n"," When a dataset is defined with a MAID column, AMC will attempt to resolve those IDs to an Amazon ID. The Amazon ID will be used to join with existing datasets.\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":2,"text":"Setting country codes"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" The country code is 2-character string in the ISO 3166 format that indicates from which country the data was collected (for example, US or GB).\n"," Although this is an optional field, it is highly recommended that you specify a country code when uploading data.\n","| TILES Did you know?                                                                                                                                                                                                 |\n","\\| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| For any data you upload that does not specify a country code, AMC will automatically default to a country code of UNKNOWN. This will result in lower match rates, and lower usability for data provided to our APIs. |\n"," Therefore, it is strongly encouraged to include country codes in your first-party datasets.\n"," The country code can be set on several levels: row-level, upload-level, or dataset-level.\n","| If you want to...                                     | Use...        | The result                                                                                   | Priority order | For more information...                                                                                                                                                                         |\n","\\| ------------------------------------------------------- \\| --------------- \\| ---------------------------------------------------------------------------------------------- \\| ---------------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| Upload data from different countries in same file     | Row-level     | This allows you to set different country codes to different rows, in a more granular manner. | 1              | Refer to Setting the country code (row-level or dataset-level). |\n","| Upload data from multiple countries in multiple files | Upload-level  | The country code will be applied to all records in the upload.                               | 2              | Refer to Setting the country code at upload-level.                       |\n","| Upload data from a single country                     | Dataset-level | The country code will be applied to all records in the dataset.                              | 3              | Refer to Setting the country code (row-level or dataset-level). |\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":2,"text":"Standardization and hashing"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" Any files that contain PII, such as email addresses or phone numbers, must be standardized and hashed before uploading to AMC.\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":3,"text":"Standardization Rules"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" Raw values in a hashed identifier column must be standardized before they go through the hashing process. Standardization is the process of transforming raw data to a more standard and consistent format (for example, converting all letters to lowercase).\n"," For the majority of fields, the standardization process is simple. Certain fields like phone number and address require additional transformations. \n"," The full set of rules for hashed data, including all conventions for street post and prefixes can be found here (link only available for Ads Console users). To access this content, you must log into your Ads Console account.\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":3,"text":"Hash Method – SHA-256"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[" Once the data has been standardized, all hashed identifier columns will need to be hashed via the SHA-256 hash method. An example of how to hash an email value in Python 3 can be seen below.\n"],"documentType":"guide"},{"title":"Advertiser data upload - prepare data","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-prepare-data","content":[],"documentType":"guide"},{"title":"Create and manage s3 bucket","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-s3-bucket","content":[" Follow the steps in this topic to set up an S3 bucket and configure it for storing data files to be uploaded. The process below covers creating an S3 bucket and applying permissions so that AMC can read data files from the bucket.\n","Create the S3 bucket - Optional: KMS Encryption Key Usage - Set permissions for the S3 bucket - Define tags\n"],"documentType":"guide"},{"title":"Create and manage s3 bucket","sectionHeader":{"type":2,"text":"Create an S3 bucket"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-s3-bucket","content":[" The S3 bucket can be within the Connected AWS Account associated to the AMC instance you will be uploading data to, or within a different AWS account.\n","Navigate to the S3 console and click \"Create Bucket\". 2. Under \"General configuration\" give the bucket a name, for example, \"data-upload-tutorial\" and select the AWS region. The remaining settings can be left to their default options. 3. Click \"Create bucket\".\n"],"documentType":"guide"},{"title":"Create and manage s3 bucket","sectionHeader":{"type":2,"text":"Optional: KMS Encryption Key Usage"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-s3-bucket","content":[" AMC supports customer encrypted data using AWS Key Management Service (KMS). This is optional. If you do not choose to provide a KMS encryption key, the data will be encrypted at rest by default.\n"," The benefit to using a customer generated encryption key is the ability to revoke the access of AMC to previously uploaded data at any point. In addition, customers can monitor encryption key access via AWS CloudTrail event logs.\n"," To enable server-side encryption of customer datasets with AWS Key Management Service, consider the following process:\n","Create symmetric encryption key in AWS KMS.\n","Apply default encryption to S3 bucket where datasets are stored via the key created in step 1. See Enable default encryption with AWS Key Management Service (KMS). 3. When creating a new dataset, you must include the key ARN. See Encrypt the Dataset with AWS Key Management Service (KMS).\n"],"documentType":"guide"},{"title":"Create and manage s3 bucket","sectionHeader":{"type":3,"text":"Create Encryption Key with AWS Key Management Service (KMS)"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-s3-bucket","content":[" If you have selected to use KMS encryption keys, complete the following steps to create the keys:\n","In the AWS console, navigate to Key Management Service (KMS) by searching for KMS in the global search bar. 2. From the KMS service homepage, click on the create key button in the top right. 3. Under Step 1 > Configure Key, select Symmetric for Key Type. In Advanced options, leave KMS selected and select Multi-Region key. Click Next. 4. Under Step 2 > Add Labels, add the key alias which will serve as the display name. Complete the remaining optional fields as necessary. Click next. 5. Under Step 3 > Define key administrative permissions, select the users and/or roles who can administer the key. Click next. 6. Under Step 4 > Define key usage permissions add the AMC Instance AWS accounts to the Other AWS accounts section.\n","Click Next. On the last page (Step 5) review the key details and click Finish to complete the key creation process.\n"],"documentType":"guide"},{"title":"Create and manage s3 bucket","sectionHeader":{"type":3,"text":"Enable default encryption with AWS Key Management Service (KMS)**"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-s3-bucket","content":[" If you have selected to use KMS encryption keys and have created the keys, complete the following steps to enable encryption for the S3 bucket.\n","Open the newly created S3 bucket, and navigate to the Properties tab. 2. In Default encryption, click Edit and use the following settings:\n","Server-side encryption with AWS Key Management Service keys: Select to enable. - AWS KMS key: Select from created KMS keys or provide key ARN.\n"],"documentType":"guide"},{"title":"Create and manage s3 bucket","sectionHeader":{"type":2,"text":"Set permissions for the S3 bucket"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-s3-bucket","content":[" Next, set permissions so the AMC instance can read data files from the S3 bucket.\n","Open the S3 bucket, and navigate to the Permissions tab. 2. Within the Permissions tab, add the following permissions object under Bucket Policy > Edit.\n","Replace {bucket_name} with the name of the newly created bucket. - Replace {Data upload AWS account ID} with the Data upload account ID on the Instance info page of the AMC UI.\n"],"documentType":"guide"},{"title":"Create and manage s3 bucket","sectionHeader":{"type":2,"text":"Define tags"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-s3-bucket","content":[" While defining your bucket policy, note that you included \"tagging options\" to the Action element. These options ensure that your S3 bucket and/or the objects within the selected bucket are tagged to the correct instance to which data is being uploaded from. After you include the s3:GetObjectTagging and s3:GetBucketTagging options, you will need to define tags for either the bucket or the object to associate them with your instance.\n"," To define a tag for your instance, perform the following steps:\n","Navigate to your Amazon S3 console and click on the bucket name you want to associate tags to. 2. Click Properties and scroll to the Tags section. Click Edit. 3. Click Add tag to define a key for the tag and provide a value for the key. For our purpose, define the key as instanceId and type the identifier of the instance you use to upload data as the value for the key.\n","Click Save.\n"," To tag an instance to an object, perform the following steps:\n","Navigate to your Amazon S3 console and click on the bucket name to view the objects associated with the bucket. 2. Click the specific object you want to associate your instance with. 3. The object details page appears, listing all properties associated with the object.\n","Scroll to the Tags section. Click Edit. 5. Click Add tag to define a key for the tag and provide a value for the Key. For our purpose, define the key as instanceId and type the identifier of the instance you use to upload data as the value for the key. 6. Be sure to click Save.\n"," The S3 bucket is ready for use, and you can start creating datasets upload your data.\n"],"documentType":"guide"},{"title":"Create and manage s3 bucket","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-s3-bucket","content":[" After setting up the S3 bucket, you can:\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-sets","content":[" Creating a dataset defines the schema you will be uploading data to. Whenever data is uploaded, it is validated against the schema; if any rows/columns in the file do not conform to the schema, then the upload is rejected.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":2,"text":"Supported Methods"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-sets","content":["| Method                                                                 | Endpoint                                                                                                              | Description                                                                                                                                                                  |\n","\\| ---------------------------------------------------------------------- \\| --------------------------------------------------------------------------------------------------------------------- \\| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| POST   | /amc/advertiserData/{instanceId}/dataSets             | Create new dataset                                                                                                                                                           |\n","| GET       | /amc/advertiserData/{instanceId}/dataSets/{dataSetId}    | Retrieve a specific dataset                                                                                                                                                  |\n","| DELETE | /amc/advertiserData/{instanceId}/dataSets/{dataSetId} | Deletes the specified data set. WARNING: This is an irreversible action. All data associated with the data set will be deleted and will no longer be available for querying. |\n","| PUT    | /amc/advertiserData/{instanceId}/dataSets/{dataSetId} | Update the description of a dataset                                                                                                                                          |\n","| POST    | /amc/advertiserData/{instanceId}/dataSets/list         | Retrieve a list of datasets                                                                                                                                                  |\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Create new dataset"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-sets","content":[" Use POST /amc/advertiserData/{instanceId}/dataSets to create a data set with columns in it.\n"," If created successfully, the response will return the dataSetId which you can use to later retrieve the dataset.\n","Specify a column as DIMENSION if you expect to perform GROUP BY operations on the column.\n","Specify a column as METRIC if you expect to perform SUM or AVERAGE operations on the column.\n","Columns marked as isMainUserId and isMainUserIdType cannot be defined as a METRIC type.\n","You may define columns flagged as mainUserId and mainUserIdType in any dataset containing external identity. If these columns are not defined, they will be added on your behalf with the names user_id and user_id_type. These columns will be populated by AMC when an identity match is found. Do not upload data that contains values for these two columns, as the values will be overwritten as identity matching is performed.\n"," When selecting a dataSetId:\n","The dataSetId will not accept spaces or uppercase characters; and must comprise only lowercase characters, numbers, with the underscore being the only special character allowed.\n","Ensure all datasets created have unique names. Duplicate dataset names between sources will result in an error.\n","You must use a unique dataSetId for when creating the new datasets. For example, if the datasets created using v1 had \"dataSetId\": \"myfirstdataset\", you must create the new dataset with a different name (for example, \"dataSetId\": \"myfirstdatasetv2\"). Refer to the Migration guide for more information.\n","In case of naming conflicts between advertiser and Amazon-owned datasets, resolution for customer queries are handled in the following order:\n"," When creating a dataset, you can specify the country code at either:\n","The row-level\n","The upload-level\n","The dataset-level\n"," You can set the country code in each row of a dataset. To do this, define a single column in the dataset with the isCountryCode = true setting.\n"," To learn more about setting the country code at the upload-level, refer to Setting the country code at upload-level.\n"," You can specify the country code for a dataset, which will apply the country code to all records uploaded to a dataset (unless there are row-level or upload-level country codes that are in conflict). For more information about country code conflicts and the priority order, refer to Setting country codes.\n"," You can add a new country code column to an existing dataset, or define the column when creating a new dataset. You cannot update an existing column in an existing dataset to be the country code column.\n"," To add the country code at the dataset-level, add the following attribute to the dataset:\n"," AMC has begun accepting consent choices from advertisers (and third-party) uploading or sharing their customer data with Amazon Ads. For more details, see Consent Management in AMC.\n"," For records belonging to the EEA and UK regions, uploaded datasets must include at least one column defined with a consentType.\n"," The consentType can be one of three options, each requiring your payload structure to include columns as listed below:\n","| consentType | Number of columns to add | Value                                     |\n","\\| ----------- \\| ------------------------ \\| ----------------------------------------- \\|\n","| TCF         | 1                        | tcf_string                               |\n","| GPP_String | 1                        | gpp_string                               |\n","| ACS         | 1 or 2                   | amzn_user_data and/or amzn_ad_storage |\n"," Example dataset request\n"," The following sample request payload creates a dataset with Id my-dataset-with-consent with consentType = TCF.\n"," Sample request payload\n"," Example dataset request\n"," The above example creates a dataset with dataSetId as my-dataset-with-consent. In our example, the columns: email, record_date, and tcf_string will be the columns that form the table. The corresponding input .csv file is depicted below:\n","| email               | record_date | tcf_string                                                                                                                                                                                                                                                                                             |\n","\\| ------------------- \\| ------------ \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| example1@gmail.com | 6/15/2024    | CQB4ySFQB4ySFBlAAAENCZCAAAAAAAAAAAAAAAAAAAAA\\\\.I7Nd_X\\_\\_bX9n-\\_7_6ft0eY1f9_r37uQzDhfNs-8F3L_W_LwX32E7NF36tq4KmR4ku1bBIQNtHMnUDUmxaolVrzHsak2cpyNKJ_JkknsZe2dYGF9Pn9lD-YKZ7_5_9_f52T_9_9\\_-39z3_9f\\_\\_\\_dv\\_-\\_\\_-vjf_599n_v9fV_78_Kf9\\_\\_\\_\\_\\_\\_-\\_\\_\\_\\_\\_\\_\\_\\_\\_\\_\\_\\_8A |\n"," Sample construct for GPP format\n"," Sample construct for ACS format\n"," After the dataset is created, you can upload data to the new dataset using the Uploads API, specifically POST /amc/advertiserData/{instanceId}/uploads/list.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Retrieve a specific dataset"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-sets","content":[" To view the details of a specific dataset, use the following endpoint passing the dataSetId as the path parameter.\n"," Sample response\n"," For the example dataset created above, the response would return the following:\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Delete a specific dataset"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-sets","content":[" To delete a specific dataset, use the following endpoint with the dataSetId as the path parameter.\n"," A successful response will return the dataSetId of the dataset that was deleted along with instanceId that contained the dataset. Once deleted, you will not be able to query the dataset.\n"," Sample response\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Update the description of a dataset"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-sets","content":[" After a dataset is created, you can only modify the description of the dataset. Pass the instanceId and the dataSetId as path parameters and specify the updated values as the request body payload.\n"," Sample request body\n"," A successful response returns the details of the updated dataset with the updated description.\n"," Sample response\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Retrieve a list of datasets"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-sets","content":[" To list all the datasets defined in an instance, use the following endpoint, with the instanceId as a path parameter.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-sets","content":[" After the dataset is created, you can upload data to the new dataset using the Uploads API.\n"],"documentType":"guide"},{"title":"Data uploads","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-upload","content":[" The Upload API is used to manage the transfer of data to the dataset.\n"," Before you begin uploading data, thoroughly read through Prepare data to understand guidelines and requirements for the files and data you will upload.\n","| TILES WARNING                                                                                                                                                                                   |\n","\\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| Data that was uploaded using ADU 1.0 can no longer be queried. To continue querying datasets that you had uploaded in ADU 1.0, delete the previously uploaded data, and re-upload using ADU 2.0. |\n"],"documentType":"guide"},{"title":"Data uploads","sectionHeader":{"type":2,"text":"Upload size recommendations"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-upload","content":[" When uploading data to AMC, follow these size recommendations for optimal performance:\n","| Upload Type | Recommended Maximum |\n","\\|-------------\\|---------------------\\|\n","| Individual file size | 1 GB |\n","| Total upload size | 50 GB |\n"],"documentType":"guide"},{"title":"Data uploads","sectionHeader":{"type":3,"text":"Uploading large datasets"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-upload","content":[" For large datasets, split your data into multiple files (each no larger than 1 GB) and use either sourceManifestS3Key or sourceS3Prefix to upload them in a single API call (up to 50 GB per upload). For datasets exceeding 50 GB, split across multiple uploads as shown in the example below.\n"," Choosing the right approach based on data size:\n"," Example: Uploading 60 GB of data\n","| IMAGE                                                                                                                                                                                                                                                                                   |                                                                                       |\n","\\| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| ------------------------------------------------------------------------------------- \\|\n","| ✅ Right approach:Split your 60 GB into files (≤1 GB each), then group them into uploads of ~20 GB each. This results in only 3 API calls instead of 60.When splitting into multiple uploads:1. To replace existing data:   - First upload: FULL_REPLACE   - Remaining uploads: ADDITIVE2. To add to existing data:   - All uploads: ADDITIVE | Right approach |\n","| IMAGE                                                                                                                                                                                                                                                                                   |                                                                                       |\n","\\| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| ------------------------------------------------------------------------------------- \\|\n","| ❌ Wrong approach:Do not create a separate API call for each file. If you have 60 GB of data split into 60 files (1 GB each), making 60 separate API calls is inefficient and not recommended.This approach creates unnecessary overhead and may hit rate limits. | Wrong approach |\n"],"documentType":"guide"},{"title":"Data uploads","sectionHeader":{"type":3,"text":"What to avoid"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-upload","content":["Uploading a single file larger than 1 GB - Creating many separate API calls for a single dataset - Exceeding 50 GB in a single upload\n"],"documentType":"guide"},{"title":"Data uploads","sectionHeader":{"type":3,"text":"Supported Methods"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-upload","content":["| Method                                                            | Endpoint                                                                                                                  | Description                                          |\n","\\| ----------------------------------------------------------------- \\| ------------------------------------------------------------------------------------------------------------------------- \\| ---------------------------------------------------- \\|\n","| POST | /amc/advertiserData/{instanceId}/uploads/{dataSetId}         | Create new upload                                    |\n","| POST  | /amc/advertiserData/{instanceId}/uploads/list                 | Retrieve a paginated list of uploads for an instance |\n","| GET     | /amc/advertiserData/{instanceId}/uploads/{dataSetId}/{uploadId} | View status and other details of an upload operation |\n"],"documentType":"guide"},{"title":"Data uploads","sectionHeader":{"type":3,"text":"Creating an upload"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-upload","content":[" After you have created a dataset, upload data to the dataset using the following endpoint with the dataSetId in the path, as well as the request body.\n"," Sample request body\n"," A successful call will return the status of the upload and an uploadId.\n"," Sample response\n"," This Create Upload API call requires you to specify where the data is stored to be uploaded.\n","First, you will specify the sourceS3Bucket. This is the S3 bucket name. 2. Then you will specify which files or objects to upload. Your options include:\n"," Manifest file format\n"," The following is the format of a manifest file.\n"," The updateStrategy parameter allows you to specify how the new data will be merged with existing data in the dataset. The valid options are:\n","ADDITIVE - FULL_REPLACE - OVERLAP_REPLACE - OVERLAP_KEEP\n","| IMAGE                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |                                                                                       |\n","\\| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| ------------------------------------------------------------------------------------- \\|\n","| ADDITIVEFor fact datasets: This strategy adds new records to records that may already be present in each time-based partition of the table. If the table already contains records, then the (new) record set being uploaded may overlap with the existing records. These overlaps are partition overlaps. For example, if the table contains time-based data that is partitioned on month, and the table already holds data for the months January, February, March, then when a new upload containing data for March, April, May is performed with the ADDITIVE strategy, then records that will fall within the March partition will overlap with a partition where data already exists. | Additive strategy for fact |\n","| IMAGE                                                                                                                                                                                                                   |                                                                                            |\n","\\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| ------------------------------------------------------------------------------------------ \\|\n","| ADDITIVEFor dimension datasets: Dimension datasets are a single partition of records. This strategy, when used with a dimension dataset, will add the uploaded records to the existing records. | Additive strategy for fact |\n","| IMAGE                                                                                                                         |                                                                                              |\n","\\| ------------------------------------------------------------------------------------------------------------------------------- \\| -------------------------------------------------------------------------------------------- \\|\n","| FULL_REPLACEFor fact datasets: The uploaded data replaces all records previously saved in the tables. | Full replace strategy for fact |\n","| IMAGE                                                                                                                                                                                                                 |                                                                                                   |\n","\\| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| ------------------------------------------------------------------------------------------------- \\|\n","| FULL_REPLACEFor dimension datasets: Dimension datasets have a single partition of records. This strategy will replace all existing records in that partition with the records to be uploaded. | Full replace strategy for fact |\n","| IMAGE                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                                                                                    |\n","\\| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| -------------------------------------------------------------------------------------------------- \\|\n","| OVERLAP_REPLACEThis strategy applies for uploads to fact datasets only. When a data upload is performed with OVERLAP_REPLACE as the strategy, then new data will be added to table partitions. Any overlapping partitions will be removed and replaced with new content. For example, previously uploaded monthly data contains records in the February, March, and April partitions. Data being uploaded should fall into April and May. With this option, any prior events in April will be removed, and replaced with the data for April from the new upload, and May will be added directly, as there is no overlap with existing data. | Overlap replace strategy for fact |\n","| IMAGE                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |                                                                                                 |\n","\\| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| ----------------------------------------------------------------------------------------------- \\|\n","| OVERLAP_KEEPThis strategy applies for uploads to fact datasets only. All new data for non-overlapping partitions will be added to the table. Any overlapping partitions will retain their original data. When the upload overlaps with any partitions that already have data, the original data of the overlapping partition(s) is RETAINED, and those in the upload are ignored. For example, if the dataset has previously uploaded monthly data, in the February, March, and April partitions. A new upload containing data for April and May is performed. When uploaded with OVERLAP_KEEP as the upload strategy, any existing data for April will be retained, and those corresponding to April in the new upload will be ignored. Data for May will be added directly, as there is no overlap with the existing data. | Overlap replace strategy for fact |\n"," You can specify the country code for an upload.\n"," Add the following attribute to the upload creation:\n"],"documentType":"guide"},{"title":"Data uploads","sectionHeader":{"type":3,"text":"View all uploads"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-upload","content":[" Returns a list of all uploads, as well as the upload details.\n"," Sample response\n"],"documentType":"guide"},{"title":"Data uploads","sectionHeader":{"type":3,"text":"View a specific upload"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-upload","content":[" To get details about a specific upload, use the following operation:\n"," Sample response\n"],"documentType":"guide"},{"title":"Data uploads","sectionHeader":{"type":2,"text":"Viewing and using the uploaded dataset in the AMC UI"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-upload","content":["| IMAGE                                                                                                                                                                                                                                                                                                                                                                                |                                                                                                 |\n","\\| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| ----------------------------------------------------------------------------------------------- \\|\n","| Once the upload status is returned as COMPLETED, you will be able to see the uploaded data in the Advertiser uploaded section of the Schema explorer.You will also be able to run SQL queries using the dataset both in the Query Editor in the AMC UI and using the Workflow management service APIs. | Advertiser uploaded data AMC UI |\n"],"documentType":"guide"},{"title":"Data uploads","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-upload","content":[],"documentType":"guide"},{"title":"Dataset columns","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-column","content":[],"documentType":"guide"},{"title":"Dataset columns","sectionHeader":{"type":3,"text":"Supported Methods"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-column","content":["| Methods       |   Endpoint                                              | Description   |\n","\\| ------------- \\|  ------------------------------------------------------ \\| ---------------\\|\n","| POST | /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns              | Add a new column to a dataset      |\n","| PUT | /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns/{columnName} | Update the column name or description |\n","| DELETE | /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns/{columnName} | Delete a column in a dataset          |\n"],"documentType":"guide"},{"title":"Dataset columns","sectionHeader":{"type":3,"text":"Adding a new column to a dataset"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-column","content":[" To define a new column and add it to an existing dataset, use the POST operation of the /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns resource. Pass the instanceId and dataSetId as path parameters.\n"," In the example below, we create a column titled firstcolumn.\n"," Sample request body\n"],"documentType":"guide"},{"title":"Dataset columns","sectionHeader":{"type":3,"text":"Update a column name or description in a dataset"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-column","content":[" To update a column name or description in an existing dataset, use the PUT /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns/{columnName} API call. Pass the instanceId, dataSetId, and the {columnName} to be updated as path parameters.\n"," In the example below, we create a column titled firstcolumn.\n"," Sample request body\n"],"documentType":"guide"},{"title":"Dataset columns","sectionHeader":{"type":3,"text":"Delete a column from a dataset"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-column","content":[" To delete a column from an existing dataset, use the DELETE /amc/advertiserData/{instanceId}/dataSets/{dataSetId}/columns/{columnName} API call. Pass the instanceId, dataSetId, and the {columnName} to be deleted as path parameters.\n"],"documentType":"guide"},{"title":"Dataset columns","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-column","content":[],"documentType":"guide"},{"title":"Data deletion","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-identity-deletion","content":[" This set of resources allows you to create a request for user deletion of a set of hashed target identity fields and values in all datasets. You can also retrieve the deletion requests and get the status of your request. \n"],"documentType":"guide"},{"title":"Data deletion","sectionHeader":{"type":3,"text":"Supported Methods"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/advertiser-data-identity-deletion","content":["| Methods    |   Endpoint                                                                    | Description   |\n","\\| ----------- \\|  ---------------------------------------------------------------------- \\| ---------------\\|\n","| POST | /amc/advertiserData/{instanceId}/userDeletionRequest                            | Creates a request for user deletion of a set of hashed target identity fields and values in all data sets.|\n","| POST | /amc/advertiserData/{instanceId}/userDeletionRequest/list                        | Gets a paginated list of all user deletion requests.|\n","| GET | /amc/advertiserData/{instanceId}/userDeletionRequest/{userDeletionRequestId}     | Gets status and metadata for a previously initiated identity deletion.|\n"],"documentType":"guide"},{"title":"Advertiser Data Upload - examples","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/adu-examples","content":[],"documentType":"guide"},{"title":"Advertiser Data Upload - examples","sectionHeader":{"type":2,"text":"Examples"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/adu-examples","content":[],"documentType":"guide"},{"title":"Advertiser Data Upload - examples","sectionHeader":{"type":3,"text":"Create Time-based (Fact) Dataset with Hashed Identifiers (Email)"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/adu-examples","content":[" Below is an example to create a time-based, or fact, dataset using an EMAIL hashed identifier.\n"," You can define the user_id and user_id_type columns in a dataset containing external identity (including hashed identifiers). Providing these columns is optional; they will be automatically added to the dataset by default if they are not provided. These columns will be populated by AMC when a match is found with a hashed record in the uploaded data. Do not include these columns in the uploaded data file(s). For more information, refer to ID resolution and supported identifiers.\n"," Any combination of hashed identifier columns can be included on the datasets. For each hashed identifier column, the hashedPii should correspond with the type of identifier for the column. See Hashed Identifier Column Options for all supported identifier types.\n"," The following example creates a dataset for the instance ID, amc12345678.\n"," Some things to note about this dataset definition:\n","The hashed_email column will contain the hashed PII (email) indicated by:\n","The purchase_time column will contain \"isMainEventTime\": true, which indicates that this is a fact dataset.\n"," API Endpoint\n"," Request body\n"," Next, create a new upload by specifying in the path the instance ID, amc12345678, and dataSetId to which you want to upload.\n"," API Endpoint\n"," Request body\n"," Response\n"," The response will include an upload ID:\n"," The uploadId can be used to check the status.\n"," API endpoint\n"," Response\n"],"documentType":"guide"},{"title":"Advertiser Data Upload - examples","sectionHeader":{"type":3,"text":"List all uploads for an instance"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/adu-examples","content":[" The following API request can be used to list all uploads associated with an instance. Note that you can filter the list on other parameters such as status and creation timestamp. Refer to the API specification for more information.\n"," API endpoint\n"," Response\n"],"documentType":"guide"},{"title":"Advertiser Data Upload - examples","sectionHeader":{"type":3,"text":"Uploading multiple files "},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/adu-examples","content":[" AMC supports reading of multiple files for a single upload. \n"," Multiple files can be uploaded by specifying an S3 prefix key. All files under the given prefix will be uploaded. Alternatively, the system accepts the key of a manifest, containing newline separated S3 paths, all of which will be uploaded. For more information, refer to S3 bucket source.\n"," The following example uses an S3 prefix key.\n"," Sample request payload\n"],"documentType":"guide"},{"title":"Advertiser Data Upload - examples","sectionHeader":{"type":2,"text":"FAQs"},"path":"/en-us/guides/amazon-marketing-cloud/advertiser-data-upload/adu-examples","content":[" Can the S3 bucket used for data upload be the same bucket linked to the AMC instance? (Bucket where aggregate reports are stored.)\n"," Yes, the S3 bucket for data upload can be in the Connected AWS Account linked to the AMC instance. This AWS account is displayed in the Instance info page in the AMC console. We recommend, however, that you use a bucket separate from one created for AMC API report storage.\n"," Can files stored in the S3 bucket be deleted after an upload is performed?\n"," Yes, once the upload is complete, data files can be removed from S3 without any impact on the ability to query the data in AMC.\n"," Despite uploading data successfully, all my queries over the uploaded data are returning empty results?\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" AMC sandbox provides functionalities identical to what is available in AMC advertiser instances, and contains only synthetic signals generated to mimic the structure and statistical properties of AMC signals, which include Amazon ads signals, and paid features signals from Amazon and third-parties.\n"," In addition, sandbox is also integrated with other AMC features, such as:\n","Template analytics (link only available for AMC UI users) - Custom parameters (link only available for AMC UI users) - Instructional query library (IQL) (link only available for AMC UI users) - Data upload and more\n"," You can now simulate using AMC for various activities using AMC sandbox, without affecting your live advertiser instances.\n"," AMC sandbox can help you with the following use cases:\n","Hands-on learning: Use AMC sandbox along with other AMC trainings to experiment features and use cases, without the risk of causing disruptions to live executions. - Signal investigation: Query with Aggregation Controls turned off and inspect non-aggregated reporting in details to inform query understanding and optimization. - Query iteration: Test and optimize queries constructed in sandbox using synthetic datasets that are lesser in volume, and then validate queries developed in sandbox instance in advertiser instances. - Paid features exploration: Explore the schema and potential use cases of AMC paid features (beta) outside of the 30-day trial period. - Software development: Enable software and tool developers with or without existing access to advertiser instances to start building on AMC.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":3,"text":"Limitations of working in a sandbox instance"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" AMC sandbox is designed to provide datasets that would work for most use cases, but there are some use cases where sandbox will not prove to be an optimal environment for query testing when compared to the advertiser instances. Some examples include: \n","Queries that call a specific campaign or ASIN identifier or other custom parameters. - Queries that attempt to retrieve extremely granular conditions as their output. Such details may not exist in the synthetic signals of a sandbox instance. - Queries that detect highly varied distribution, or outliers that are not built into the sandbox data set. - Queries that test to see if the compute will fail on a query with a certain time window.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":3,"text":"Signals available in AMC sandbox"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" We offer a synthetic version of the same signals from an AMC advertiser instance in the sandbox. We are onboarding new signals to sandbox on an ongoing basis and will update this table to reflect the additions. Both Amazon Ads and Subscription signals are readily available in sandbox for you to explore. There is 13 months of backfilled signals available in sandbox and new data will be added on a rolling time window. Sandbox has both Amazon Ads and Paid features available. \n","| Data sets                                                           | Available in advertiser instances | Available in sandbox now (Synthetic version) |\n","\\| ------------------------------------------------------------------- \\| --------------------------------- \\| --------------------------------------------- \\|\n","| dsp_impressions                                                    | Yes                               | Yes                                           |\n","| dsp_clicks                                                         | Yes                               | Yes                                           |\n","| amazon_attributed_events_by_conversion_time                    | Yes                               | Yes                                           |\n","| amazon_attributed_events_by_traffic_time                       | Yes                               | Yes                                           |\n","| sponsored_ads_traffic                                             | Yes                               | Yes                                           |\n","| dsp_impressions_by_matched_segments                             | Yes                               | Yes                                           |\n","| dsp_views                                                          | Yes                               | Yes                                           |\n","| dsp_impressions_by_user_segments                                | Yes                               | Yes                                           |\n","| conversions                                                         | Yes                               | Yes                                           |\n","| conversions_with_relevance                                        | Yes                               | Yes                                           |\n","| adserver_conversions                                               | Yes                               | No                                            |\n","| adserver_conversions_with_brands                                 | Yes                               | No                                            |\n","| adserver_traffic                                                   | Yes                               | No                                            |\n","| adserver_traffic_by_user_segments                               | Yes                               | No                                            |\n","| conversions_all (Amazon Flexible Shopping Insights)              | Yes(free trial or subscription) | Yes                                           |\n","| experian_vehicle_purchases (Experian vehicle purchase insights) | Yes(free trial or subscription) | Yes                                           |\n","| foursquare_visits (Foursquare Store Visit Insights)              | Yes(free trial or subscription) | Yes                                           |\n","| audience_segments\\_\\* (Audience Segments Insights)               | Yes(free trial or subscription) | No                                            |\n"," For more information regarding these tables, refer to AMC Data sources\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":2,"text":"Differences between AMC sandbox signals and AMC advertiser signals"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" AMC sandbox signals are synthetic, programmatically generated to mimic the structure and statistical properties of AMC signals. Sandbox signals and results may look realistic since they are generated based on the business logic of Amazon Ads data. For example, it has the same logical inter-field and cross-table relationship. It also includes a variety of ad product types, supply sources and devices. However, AMC sandbox data is not tied to any advertiser campaign, customer identifier, or ASIN product.\n"," As such, you should not use the results of sandbox signals to inform media strategy or implementation. You could use it for testing, demonstration, or as an inspiration on the insights you could possibly get from your advertiser signals. \n"," Paid features: This is the AMC premium subscription model, that provides options for deeper analysis of your audiences, campaigns, and outcomes. We have a synthetic version of these datasets readily available in sandbox for you to explore. However, the subscription capability is disabled in the sandbox instance. To subscribe to Paid features offerings, log in to the AMC console and access your advertiser instance, navigate to the Paid features tab and subscribe.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":3,"text":"Aggregation controls"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" In sandbox, aggregation controls are managed by the disableAggregationControls parameter.\n"," You can disable aggregation controls to output event-level information of synthetic signals as part of your query outputs. This helps you to inspect the underlying composition of the reports.\n"," With aggregation control on, you can generate aggregated and anonymous report based on synthetic signals. This simulates the advertiser analytic reporting experience of using AMC.\n"," For detailed information, see Aggregation thresholds.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":2,"text":"Access the AMC sandbox through APIs"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" To access the AMC sandbox programmatically, complete the following steps:\n","Apply for permission to access the API. The application form includes questions about how your business intends to use the Amazon Ads API, as well as information about the Amazon Ads API License Agreement, the Data Protection Policy, and Amazon Marketing Cloud Terms. Visit the Amazon Ads Partner page for information on how to apply for access to the API. - Create a Login with Amazon (LwA) application and submit your application Id (Client identifier) for approval. After approval, the Amazon - Obtain approved access for the Amazon Ads APIs, with the \"Campaign Management\" scope associated with your developer credentials (Client identifier). Amazon Ads Partner Network account. (Or, submit a Jira with your request to approve your access with the Data provider scope). - Set up your environment with the required header parameters required to run the sandbox APIs.\n"," You can now use AMC sandbox programmatically to access synthetic signals, schedule a workflow you created, and execute your workflows to get outputs that you can analyze.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":3,"text":"Parameters to enable access to synthetic data"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" To enable APIs work in the sandbox environment, the following new parameters must be added to resources as described below:\n","The first parameter is named requireSyntheticData, and it must be defined as true for all sandbox queries for the POST operations of Schedule or WorkflowExecutions resource. - The second parameter is disableAggregationControls, is specified when creating a schedule or a workflow execution. This parameter cannot be used on non-synthetic data. The values for disableAggregationControls parameter can be set to true or false.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":2,"text":"Workflows"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" Workflows are queries with associated metadata that use synthetic data sources as input and use them to generate a given output (a \"report\"). Once defined and saved, a workflow on its own will not produce any output data; you will have to either execute it on demand or schedule it to be run at a specified time.\n"," Workflows are created with the following mandatory body parameters:\n","workflowId: This is an alphanumeric string that you will specify. Workflow identifiers can only contain alphanumeric characters, periods, dashes, and underscores, without any spaces. This identifier is used to identify the workflow when scheduling or executing on demand. - sqlQuery: The SQL script to use to construct and output your report. The query must be a single-line query and stripped of tabs and new-line delimiters before added to the JSON object. Semicolons are not required at the end of the query.\n"," When creating workflows, the sqlQuery parameter for advertiser instances accepts only queries that generate aggregated results. However, in your sandbox environment, your sqlQuery accepts non-aggregated queries for execution.\n"," For example, the following query, when executed will return campaign IDs from the dsp_impressions table, sourcing details from the synthetic data sources.\n"," Note that the above query will fail to run in an advertiser instance, mandating you to aggregate the results. For example, aggregate the result set by the IMPRESSIONS column.\n"," Now that we know the difference between constructing a query to run in a sandbox environment versus the advertiser environment, let us use the above example to create the body parameters required for a new workflow.\n"," To pass the above query in the sqlQuery parameter, remove all line breaks so that the query is a single line query that JSON will be able to support.\n"," Provide a unique name for the workflow you are creating, for example, my-sandbox-workflow.\n"," For example,\n"," Now, with the above snippet as the body parameter, use the POST operation of the workflows resource to create a workflow resource with the instanceId as the path parameter.\n"," A successful call returns a HTTP status code: 200 OK. You can use the workflowId to schedule an execution for the workflow or retrieve information on the workflow.\n"," The workflows resource allows you to perform the following operations:\n"," Modify parameters using the PUT operation (along with the unique workflow identifier as the path parameter):\n"," Retrieve details of a specific workflow using the GET operation:\n"," List all workflows defined in your sandbox operation using the GET operation.\n"," Delete a specific workflow using the DELETE operation.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":2,"text":"Schedules"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" The Schedule resource allows you to define when a workflow will run. Creating a schedule for a workflow helps define the specificity of the run by allowing you to set the specific time interval, day of the week, and time of day to execute the workflow.\n"," When the schedule is triggered, it will run the workflow and place the results in the S3 bucket associated with the instance for the given workflow.\n"," Use the POST operation of the schedules resource for creating a schedule for the workflow you created, and include requireSyntheticData to the request body and set the parameter to true to indicate that the schedule is to be created in the sandbox instance. If you want to view event-level data, set disableAggregationControls to true. For details on these parameters, see Parameters to enable access to synthetic data\n"," The defined schedule will trigger a run of the my-sandbox-workflow workflow at an eight-hour offset from midnight in UTC every week on Monday. The interval and amount of data contained within the report are the same, so this would generate a report for the data from the previous Monday at the specified offset from UTC until the current Monday at the same hour offset. The schedule will be applied on synthetic data and with disableAggregationControls set to true, your query will retrieve event-level information.\n"," To determine the correct value of the hour offset, you may use the aggregationHourUtc parameter. Convert your desired start time to Coordinated Universal Time (UTC) and calculate the offset in hours from 12 a.m. midnight UTC. For example, 6 a.m. MST is 12 p.m. UTC, which is 12 hours from midnight UTC. So, to run the SQL query in the\n"," To enable a schedule, set the scheduleEnabled parameter to true. When this value is set to false the workflow will not be queued for execution even with an associated schedule.\n"," A successful call returns a HTTP status code 200 OK and queues the workflow for execution as per the defined schedule.\n"," For more details on working with the Schedules resource, see Manage a workflow schedule\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":2,"text":"Workflow execution"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" The WorkflowExecutions resource allows you to run a previously saved workflow. The resource also allows you to create a workflow and execute it on demand (ad-hoc workflow executions). For both types of workflows, use the POST operation of the WorkflowExecutions resource.\n"," For details, see Manage workflow executions.\n"," For querying synthetic signals, include the following parameters:\n","The first parameter is named requireSyntheticData, and it must be defined as true for all sandbox queries. - The second parameter is disableAggregationControls, and is available exclusively in AMC sandbox.\n"," The response object contains the created workflow execution which represents the status of the execution.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":3,"text":"Sample query for ad hoc workflow execution"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" An ad hoc workflow is an on-demand workflow execution request that allows you to define the SQL query in the request.\n"," Submit the request. A status code of HTTP 200 OK in the response indicates a successful request/response.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":3,"text":"Viewing your query results"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" Results of your workflow executions and scheduled workflows are stored in an Amazon S3 bucket tied to your AMC instance.\n"," You can check the Amazon S3 bucket associated with your sandbox instance by going to the AMC UI, and click on the instance info tab. You may also edit the AWS account and the S3 bucket details in the same tab (AMC account admin access required).\n"," For more details on the S3 bucket and accessing your results, see:\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":3,"text":"Example queries"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" Following are some example queries to test AMC using sandbox data. To help you get acquainted with how AMC works, we have crafted queries for various basic use cases in this section.\n"," To execute any of the queries listed below:\n","Copy the example query you wish to execute. Convert the query to a single-line query and supply it as the input to the sqlQuery parameter to the POST operation of your workflow or workflowExecution resource.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":2,"text":"Basic example queries"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" Example query 1\n"," Example query 2\n"," Example query 3\n"," Example query 4\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":3,"text":"Examples that join multiple data sets"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" Example query 5\n"," Refer to this instructional query (link only available for AMC UI users) to learn more about joining impressions and clicks using UNION ALL. Note that this Instructional Query is only available for users of the AMC UI. If you have an AMC UI account, you must log in to access this Instructional Query.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":2,"text":"Upload advertiser data in sandbox"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" To help you learn about uploading first-party signals, AMC sandbox supports advertiser first-party signals upload to your sandbox instance. You can then use the uploaded signals to create workflows and develop queries on the joined Amazon ads datasets.\n"," This section will outline the unique features of data upload for sandbox. Overall, sandbox data upload leverages the same process as the data upload for the advertiser instances. For detailed information. Refer to AMC data upload to learn more.\n"," Sandbox provides customers the ability to join both fact and dimension datasets to sandbox and match them with the sandbox datasets.\n"," For fact datasets, the uploaded signals are resolved at the user-level with the sandbox records at a pre-set match rate of 80%. For example, if you uploaded a file that contains 100 distinct hashed user records, then 80 of these hashed user records would match with sandbox signals.\n"," Additionally, you have the option to upload files and merge records using sandbox signals based on other dimensions such as ASIN, postal code, campaign name and more. However, sandbox does not automatically resolve these join keys. You will need to include those sandbox values in your data file to successfully join with synthetic datasets. The desired match rate can be achieved by appending the appropriate amount of sandbox data to your data file.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":3,"text":"Fact datasets"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" Example use case: Off-Amazon conversions using email hashed identifier\n"," Refer to this sample file.\n"," This file has 500 distinct hashed emails, when you upload this to sandbox, 400 (80%) hashed emails will be joined with sandbox datasets.\n"," This is an example of the API call to create a fact dataset using the example file.\n"," Sample request body payload\n"," Sample request body payload\n"," Sample response:\n"," The response will include an identifier for the upload (uploadId):\n"," The uploadId (generated in the response of the POST request) can be used to poll the status, as indicated here.\n"," A sample response is shown below:\n"," Once your data is uploaded to sandbox, you may start querying the joined datasets.\n"," There are some limitations of querying advertiser data that can be bypassed by turning the aggregation controls off in sandbox. Refer to AMC data upload to learn more about limitations on querying in the live advertiser instances.\n"],"documentType":"guide"},{"title":"AMC sandbox","sectionHeader":{"type":3,"text":"Dimension datasets"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sandbox","content":[" Dimension datasets can be used to upload a static table, or any information which is not time-bound. Some examples include CRM audience lists, campaign metadata, mapping tables, and product metadata (such as a table mapping ASIN values to external product names, or sensitive cost-of-goods-sold data). When uploading data to a dimension table, each upload is treated as a full replace – AMC queries will also use data from the last file uploaded. Dimension datasets do not require a main event time (mainEventTime) column. AMC will always use the most recent file uploaded (full-replace method of updating data).\n"," In sandbox, the dimension joins are not automatically resolved. You may still upload a dimension file to join with the sandbox datasets by using the following workaround.\n","Get the dimension values from sandbox by running queries like below. 2. Append the sandbox dimension values to your file. You may also adjust the match rate  by using sandbox values for only a part of your file. For example, if you want to test out 50% match rate, append the sandbox values to half of the distinct dimension identifiers.\n"," Example query to identify ASINs from sandbox\n"," Example query to identify postal codes from sandbox\n"," Example use case: ASIN based off-Amazon conversions This example file contains the ASIN values from a sandbox dataset.\n"," Request body payload\n"," The response will include an upload Identifier (uploadId):\n"," The uploadId returned from the POST operation can be used to poll the status using the following operation:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/acr/1_overview","content":[" Amazon Marketing Cloud (AMC) on AWS Clean Rooms enables advertisers (you) to seamlessly collaborate with Amazon Ads exclusive signals, generate enhanced insights, and discover new audiences, all without having to move any underlying data outside of your Amazon Web Services (AWS) environment. AMC on AWS Clean Rooms delivers a comprehensive view of customer interactions and business outcomes that can be activated and optimized in the Amazon DSP.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Intended audience for this guide"},"path":"/en-us/guides/amazon-marketing-cloud/acr/1_overview","content":[" This guide describes how to get started with the Amazon Marketing Cloud (AMC) powered by Amazon Web Services (AWS) Clean Rooms, the setup tasks to get started, and the API endpoints for using AMC-AWS Clean Rooms programmatically.\n"," The tasks described in this guide are intended for the AMC account administrator and the administrator of your organization's AWS account.\n"," Use this guide if you are an AMC administrator and meet the following prerequisites to be able to use the associated AWS service:\n","Possess the AWS access credentials associated with your AMC account - Have access to your organization's AWS S3 account - Can sign in to the AWS Management console - Can access AWS Entity Resolution to create new IAM policies and roles - Can create schema mappings using AWS Entity Resolution - Can use AWS Glue to catalog data - Have set up and can access AWS Clean Rooms to join a collaboration - Have onboarded the AMC APIs\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"How does AMC leverage AWS Clean Rooms and AWS Entity Resolution?"},"path":"/en-us/guides/amazon-marketing-cloud/acr/1_overview","content":[" AMC leverages the \"collaboration\" feature in AWS Clean Rooms.\n"," A collaboration is a secure logical boundary in AWS Clean Rooms in which one member (such as an advertiser) can perform SQL queries on configured tables from other members (such as an advertiser partner or other publisher). AMC and advertiser collaborations in AWS Clean Rooms enable AMC customers to use AWS Clean Rooms to associate advertiser first-party (event and identity) data with the data in AMC, to collaborate with Amazon Ads unique signals including matching audience identifiers enabled by AWS Entity Resolution, and generate differentiated insights to activate more relevant campaigns with Amazon Ads, all without having to share or move your data from your AWS cloud environment.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"What are the benefits of AMC–AWS Clean Rooms?"},"path":"/en-us/guides/amazon-marketing-cloud/acr/1_overview","content":[" The advantages of this integration are:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/acr/2_setup_workflow","content":[" Setting up AMC-AWS Clean Rooms requires you to:\n","Perform set up tasks before uploading 1P data - Accept and join a collaboration - Know the essentials for data upload - Upload event data - Upload identity data\n"," After your data is uploaded, you can leverage AMC to generate insights and discover new audiences using your 1P data. \n"," The following diagram illustrates the steps to set up AMC-AWS Clean Rooms.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/acr/3_setup_requirements","content":[" To work with AMC–AWS Clean Rooms, you must have:\n","Access to AMC - Access to AWS\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Access to AMC"},"path":"/en-us/guides/amazon-marketing-cloud/acr/3_setup_requirements","content":[" You must be eligible to onboard AMC or are a current AMC customer.\n"," The requirements to be eligible to onboard AMC are listed below:\n","An executed Amazon Demand Side Platform (Amazon DSP) Master Service Agreement (MSA), which in the future will be a standalone AMC agreement. - Planned campaigns, or campaigns that were live in the last 28 days. - DSP advertiser IDs and Sponsored Ads IDs (if applicable) to be included in your AMC instance. - SQL-capable resource to pull an insight and work with supported SQL commands as listed in AWS Clean Rooms SQL Reference.\n"," You can also leverage AMC-AWS Clean Rooms if you are an existing AMC customer, with:\n","1P data uploaded into AMC, - or, with available 1P data to upload into AMC, - or, with available 1P identity data that you want to map with your AMC data.\n"," To create ID mapping tables for identity data, and to access AMC–AWS Clean Rooms programmatically (through APIs), you will need authenticated access to the Amazon Ads API. For details, see Amazon Ads API onboarding overview.\n"," For programmatic access to the Amazon Ads API, you will need to perform the following steps:\n","Create a Login with Amazon application. 2. Apply for Amazon Ads API access.\n","Assign API access to a Login with Amazon application\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Access to AWS"},"path":"/en-us/guides/amazon-marketing-cloud/acr/3_setup_requirements","content":[" Since AWS Clean Rooms is an AWS service, when applying for AMC–AWS Clean Rooms, you must:\n","Sign up for AWS to create an AWS account with administrative permissions. - Create an administrator user for AWS Clean Rooms. - Create IAM roles for collaboration members - Set up service roles for AWS Clean Rooms\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Create an AMC collaboration instance"},"path":"/en-us/guides/amazon-marketing-cloud/acr/3_setup_requirements","content":[" If you meet the above prerequisites, the eligibility and usage for AMC, you can programmatically create your own collaboration instance in AMC for AWS Clean Rooms.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/acr/4_setup_collab","content":[" AMC customers can use AWS Clean Rooms for securely associating 1P data to a collaboration and collecting data outputs from queries across their data and AMC data.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Set up AMC-AWS Clean Rooms collaboration"},"path":"/en-us/guides/amazon-marketing-cloud/acr/4_setup_collab","content":[" To set up AMC-AWS Clean Rooms, create an AWS Clean Rooms backed - AMC instance that you will use to create a collaboration with AWS Clean Rooms.\n"," To create a collaboration instance, it is assumed that you have performed the following tasks:\n","Signed up for AWS - Created an AWS administrator user for AWS Clean Rooms\n"," Note: Only users with Admin permissions for both AMC and AWS Clean Rooms can perform the steps listed on this page.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Create an AWS Clean Rooms backed AMC instance"},"path":"/en-us/guides/amazon-marketing-cloud/acr/4_setup_collab","content":[" Use the POST operation of the /amc/instances endpoint to create an instance.\n"," The mandatory header parameters are listed below:\n","| Header                               | Description                                                                                                                                                                          |\n","\\| ------------------------------------ \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \\|\n","| Amazon-Advertising-API-ClientId      | The client ID related to a Login with Amazon application.                                                                                                                            |\n","| Amazon-Advertising-API-MarketplaceId | The marketplace identifier for the advertiser's marketplace. |\n","| Amazon-Advertising-API-AdvertiserId  | The AMC account identifier. See Retrieve accounts.                               |\n","| Authorization                        | Login with Amazon token in the form of Bearer {token}.                                                                                                                               |\n"," In the request body, provide the following mandatory parameters:\n","instanceName: Name of the AMC instance. - awsAccountId: The primary AWS account ID to which this instance will be connected and query results received. - acrBacked: Set to true for AWS Clean Rooms backed instances.\n"," You can optionally pass the name of the advertiser (advertiserName) associated with the instance you are creating. Ensure that the advertiser name can only contain letters (both uppercase and lowercase), numbers, and spaces. Special characters (except spaces) are not allowed in the advertiser name, and the advertiser name cannot start or end with a space.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Sample request"},"path":"/en-us/guides/amazon-marketing-cloud/acr/4_setup_collab","content":[" The following optional parameters can be passed as the request body:\n","advertiserName: Optionally, pass the name of the advertiser (advertiserName) associated with the instance you are creating. Ensure that the advertiser name can only contain letters (both uppercase and lowercase), numbers, and spaces. Special characters (except spaces) are not allowed in the advertiser name, and the advertiser name cannot start or end with a space.\n"," A successful request creates an instance in AMC and a collaboration in AWS Clean Rooms with you as a member.\n"," The name and description of your collaboration instance is listed in the acrCollaboration section of the response. In the sample response below, the collaboration instance created is named: AMC amc11111111.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Sample response:"},"path":"/en-us/guides/amazon-marketing-cloud/acr/4_setup_collab","content":[" In case you want your collaboration instance to access data from more than one AWS account, you can create a multi-party collaboration instance. To do so, you will need to include the additional AWS account IDs (of the parties) to the instance you are creating. The associated AWS accounts can bring their data to the collaboration instance for AMC to be able to perform measurement queries on them and also create audiences. This use case is particularly suited for advertisers or partners that have data stored in more than one AWS account.\n"," The following is a sample request body to create a multi-party collaboration instance:\n"," A successful request creates an instance in AMC and a collaboration in AWS Clean Rooms with the awsAccountId as a member that accepts data from the associated AWS data provider IDs listed under acrCustomerPartners.\n"," NOTE: The query results will be sent to the primary AWS account ID.\n"," The collaboration in AWS Clean Rooms will also house members as listed below:\n","Advertiser: You - Customer partner: Advertiser partners (also known as customer partners) are third-parties who will be added to the collaboration and will bring in data and/or receive results. - Amazon Advertising Data Provider: The AWS account owned by AMC that contains the Amazon data. - Lookalike Audience Generator: The AWS account owned by AMC, used to generate lookalike audiences. - Advertiser Uploaded Data Provider: The AWS account owned by AMC that contains the 3P advertiser data uploaded into AMC. - Third-party Paid Data Provider: The AWS account owned by AMC that contains the subscribed paid feature data. - AMC Results Receiver: The AWS account owned by AMC, used to create audiences in Amazon DSP. - Query Submitter: The AWS account owned by AMC that submits the queries to the AWS Clean Rooms service. - AMC service: The AWS account owned by AMC that facilitates the creation of collaborations.\n"," To complete creating your instance, you will need to accept the collaboration. You can accept the collaboration either by accessing AWS Clean Rooms through your AWS console or by logging into your AMC console. The collaboration instance will be operational once you create a membership in the primary AWS account ID, after which you will be able to run queries.\n"," You will also need permissions to create service roles or to work with an administrator in your organization to create these roles. See Set up service roles for AWS Clean Rooms for more details.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Request permissions"},"path":"/en-us/guides/amazon-marketing-cloud/acr/4_setup_collab","content":[" At this point, you should have:\n","Created IAM roles for collaboration members - Created a service role to read data - Created a service role to receive results (if you are the result receiver)\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Manage collaboration membership"},"path":"/en-us/guides/amazon-marketing-cloud/acr/4_setup_collab","content":[" When the AMC collaboration instance is provisioned, you are notified through either the AWS Clean Rooms Account, under Collaborations Available to join:\n"," Or, through a banner notification that shows up when you log in to the AMC console:\n"," Both options allow you to create a membership for the collaboration instance the AMC team created. A membership is a resource that is created when a member joins a collaboration in AWS Clean Rooms. You can create and manage memberships.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Create membership"},"path":"/en-us/guides/amazon-marketing-cloud/acr/4_setup_collab","content":[" To create a membership using the AWS Clean Rooms console:\n","Access the AWS Clean Rooms console. 2. Click View collaborations and then navigate to the Available to join tab. 3. Click the instance you created (in our example, the instance created is AMC amc11111111) to view the details of the collaboration and then click Create membership. 4. On the Create membership page, review the collaboration Overview details (including your assigned member abilities). 5. In the Query results setting section, specify the Results destination in Amazon S3 by entering the S3 destination or choose Browse S3 to select from a list of available S3 buckets. You can configure an S3 bucket from any of the commercial or opt-in regions supported by AWS S3. For a list of S3-supported regions for both commercial and opt-in, refer to valid values for regions where collaboration query results can be stored. 6. Click Create membership to join the collaboration for the instance. 7. Your membership is created and associated with the AMC collaboration instance.\n"," To create a membership using the AMC console:\n","Access the AMC console. 2. Navigate to the Instances info tab in the AMC console. 3. Click Go to AWS Clean Rooms link to access your AWS Clean Rooms account collaboration. 4. The Create membership page appears in the AWS Clean Rooms console. 5. On the Create membership page, review the collaboration Overview details (including your assigned member abilities) set the destination of your query results (Amazon S3 bucket), the format of query results, specify your service access permissions. 6. Click Create membership to join the collaboration for the instance. 7. Your membership is created and associated with the AMC collaboration instance.\n"," You can go back to the AMC console to view the status of your instance. Once the status of your instance is updated to Active, you can invite users from your organization to join the collaboration instance in AMC. Users can be invited using either the AMC console or by using the user management APIs. Once your users accept your invite, they can start writing queries using Amazon data. The results of your queries will be sent to the Amazon S3 bucket that you configured when creating your membership.\n"," You can now bring your data to your collaboration instance or perform a rule-based matching of signals to integrate your 1P data with your collaboration instance or upload data using the AMC Data Upload.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Adding or removing customer partners from the collaboration"},"path":"/en-us/guides/amazon-marketing-cloud/acr/4_setup_collab","content":[" You can add or remove partners from the collaboration, allowing you to change who can bring in data and/or receive results.\n"," To add customer partners to an existing AMC collaboration, use the POST method of the acrCustomerPartners resource.\n"," To delete customer partners from an existing AMC collaboration, use the DELETE method of the acrCustomerPartners resource.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Leaving a collaboration"},"path":"/en-us/guides/amazon-marketing-cloud/acr/4_setup_collab","content":[" To make any changes to your collaboration profile and membership, you will need to again access the AWS Clean Rooms console to be able to manage your collaboration details.\n"," When you leave a collaboration, you will not be allowed to access your collaboration instance in AMC any further. However, the results of your queries will remain in the Amazon S3 bucket associated with your collaboration instance.\n"," Other members in the collaboration can see the status of your membership through the AWS Clean Rooms console under Collaborations > your collaboration > Members. The Member status is updated as Removed.\n"," In the AMC console, the Instance info tab shows your AWS Clean Rooms collaboration status as Left.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/acr/5_data_prep","content":[" To run measurement and analysis queries in your AMC collaboration instance, you must first bring your data from your source to the collaboration instance.\n"," You can bring data to your collaboration instance in one of the following ways:\n","Bring event data into the collaboration through AWS Clean Rooms - Bring identity data to perform rule-based matching for identity resolution - Upload data using AMC Data Upload\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Prerequisites for data preparation"},"path":"/en-us/guides/amazon-marketing-cloud/acr/5_data_prep","content":[" Before bringing in data (event or identity), to associate with your collaboration instance, ensure your data sets meet the following prerequisites:\n","All datasets created have unique names. Duplicate dataset names will result in an error. - When naming datasets, do not include any spaces, special characters, or uppercase characters. Your dataset name must comprise only lowercase characters, and/or numbers. - Your event tables must not contain PII data. - 3P identifiers should not be hashed.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Consent management essentials"},"path":"/en-us/guides/amazon-marketing-cloud/acr/5_data_prep","content":[" AMC - AWS Clean Rooms have begun accepting consent choices from advertisers (and third-parties) uploading or sharing their customer data with Amazon Ads. For more details, see Consent Management in AMC.\n"," For data brought into AMC - AWS Clean Rooms collaboration instances, advertisers must define the specific columns for consent data using column names as indicated here:\n","| Column name                | Description                                                                        | Data type |\n","\\| -------------------------- \\| ---------------------------------------------------------------------------------- \\| --------- \\|\n","| country                | The column containing consent information formatted as a TCF string.              | String    |\n","| tcf                    | The column containing consent information formatted as a TCF string.              | String    |\n","| gpp                    | The column containing consent information formatted as a GPP string.              | String    |\n","| amz_user_data_consent  | The column containing the user data consent portion of ACS consent information.  | String    |\n","| amz_ad_storage_consent | The column containing the ad storage consent portion of ACS consent information. | String    |\n"," AMC - AWS Clean Rooms will only recognize and process these special columns if they match the specified data type. For instance, a column named tcf_consent must be of string type to be considered valid and processed as consent data.\n"," When processing datasets containing user IDs, the consent is evaluated for each row individually, and any rows that fail to meet the consent requirements will be excluded from the query.\n"," The consent signals will be processed as below:\n","If no consent columns are provided, each row will be considered consented. - If one or more consent columns are provided but all values in these columns are NULL for a given row, that row will be considered consented. - In all cases other than the two above cases, consent will be processed as outlined in the next section (when consent information is mandatory).\n"," Consent will be calculated for each row in the following descending order of priority:\n"," Country code\n","If a country code column is provided, the rows with country codes that do not require consent checks are automatically considered consented. - If no country code column is provided, all rows are treated as if they are from countries that require consent.\n"," Consent type\n","If no consent columns are defined at all, each row is considered not consented. - Consent is evaluated using the highest-priority consent type with non-null values. The priority order will be considered in the descending priority order as below:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Prerequisites to allow creating joins between event and identity"},"path":"/en-us/guides/amazon-marketing-cloud/acr/5_data_prep","content":[" In addition to these prerequisites, ensure that your data sets meet the following additional guidelines to enable joins between your event and identity data:\n","The event tables must have a column titled customer_user_id of datatype string, which is the foreign key that will map with the unique key column in your identity dataset. In the sample tables, the unique key column in your identity dataset is titled customerId.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Considerations"},"path":"/en-us/guides/amazon-marketing-cloud/acr/5_data_prep","content":[" For queries that perform identity joins between your data and Amazon data, to work correctly in a collaboration instance, you should have only one mapping table.\n"," When running queries, note these limitations in addition to considerations listed below.\n","Only one mapping table is allowed. - When your data is associated with your collaboration instance, the customer_user_id and an additional column name user_id will appear in your schema in the AMC UI. - For performing identity joins between advertiser connected data and Amazon data, use the user_id column in your queries as indicated in the following example.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Sample tables for reference"},"path":"/en-us/guides/amazon-marketing-cloud/acr/5_data_prep","content":[" Example sampleidentity data for reference\n","| customerid | firstname | lastname | email | phone | address | city | state | zip | country |\n","\\| ---------- \\| --------- \\| -------- \\| ----- \\| ----- \\| ------- \\| ---- \\| ----- \\| --- \\| ------- \\|\n","| 1          | john      | …       | …    | …    | …      | …   | …    | …  | …      |\n","| 2          | sue       | …       | …    | …    | …      | …   | …    | …  | …      |\n","| 3          | bob       | …       | …    | …    | …      | …   | …    | …  | …      |\n","| 4          | nancy     | …       | …    | …    | …      | …   | …    | …  | …      |\n"," Example sampleevent data for reference\n","| customer_user_id | eventtime | eventtype | productid | productquantity | totalcost |\n","\\| ------------------ \\| --------- \\| --------- \\| --------- \\| --------------- \\| --------- \\|\n","| 1                  | …        | purchase  | 111       | 1               | $10.00   |\n","| 1                  | …        | purchase  | 222       | 3               | $15.65   |\n","| 2                  | …        | purchase  | 333       | 5               | $13.22   |\n","| 3                  | …        | addtocart | 333       | 7               | $11.47   |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/acr/6_upload_event","content":[" After you have created a membership and joined the collaboration in AWS Clean Rooms, you can bring your event data to the collaboration instance from any commercial and opt-in regions that are supported by AWS Glue. For a list of Glue-supported regions for both commercial and opt-in, refer to the regions in the Service Endpoints section.\n"," To bring your event data to the collaboration, perform the following steps:\n","Prepare your data tables for queries. When preparing your data tables, take note of the prerequisites and know that the Amazon S3 bucket cannot be registered with AWS Lake Formation.\n","Create a configured table to be used within a collaboration through your AWS Clean Rooms console or use the CreateConfiguredTable API. 4. Configure analysis rules to your configured tables. (CreateConfiguredTableAnalysisRule).\n","Associate the configured table with the collaboration instance using (CreateConfiguredTableAssociation).\n","Create collaboration analysis rules, depending on your use case. To allow both measurement and audience queries, navigate to your collaboration instance in the AWS Clean Rooms console.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" After you have joined a collaboration, you can use AMC and AWS Entity Resolution to securely integrate your 1P identity data with AMC data natively, within the AWS Clean Rooms environment, without needing to move the data outside of your own AWS cloud environment.\n"," The identity data of your records is matched with Amazon Ads identity data with the help of a mapping table. To allow you to perform the match, AMC-AWS Clean Rooms leverages the multi-key matching rules offered by AWS Entity Resolution without revealing underlying data to one another.\n"," You can then start using your data with AMC data for typical AMC use cases such as measurement analysis, joint analysis, and activation on the combined datasets to run matching queries on your 1P identity data and AMC data.\n"," Before you begin to integrate your 1P data with AMC data, ensure that you have completed the Setup tasks for AWS Entity Resolution.\n"," Also, ensure that you have the following:\n","An Amazon S3 bucket in which your datafiles are stored or will be stored.\n","Access to AWS Glue for cataloging the datafiles. - Access to AWS Entity Resolution for setting up the ID namespaces. - You have also configured IAM roles and permissions for the SOURCE Id namespace pass role.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Setup tasks for AWS Entity Resolution"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" The setup tasks for AWS Entity Resolution require you to create a Create a SOURCE ID namespace pass role.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 1: Create a SOURCE ID namespace pass role"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" To define the roles that will use the collaboration, create an IAM role.\n","Sign in to the IAM console at https://console.aws.amazon.com/iam/ with your administrator account. 2. Create Policy and copy and paste this custom role permissions into the JSON editor. 3. Create an IAM role.\n","Complete the rest of the steps to create your IAM role.\n"," Samples of the trust policy and role permissions for the created role are illustrated below:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 2: Attach trust policy to SOURCE ID namespace pass role"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 3: Assign role permission to the SOURCE ID namespace pass role"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":["| Parameter       | Description                                                                                                                                                                                                                                        |\n","\\| --------------- \\| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| input-buckets   | Amazon S3 buckets that contain the underlying data objects of AWS Glue from where AWS Entity Resolution will read.                                                                                                                                |\n","| region          | AWS region of your resources. Your AWS Glue resources can be in any AWS Glue-supported commercial region. For a list of Glue-supported regions, refer to the regions in the Service endpoints section. Note that the opt-in regions are not supported. |\n","| awsAccountId    | Your AWS account ID.                                                                                                                                                                                                                               |\n","| input-databases | AWS Glue databases from where AWS Entity Resolution will read.                                                                                                                                                                                     |\n","| input-tables    | AWS Glue tables from where AWS Entity Resolution will read.                                                                                                                                                                                        |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Prepare identity data for AWS Entity Resolution"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" After you have joined a collaboration, prepare your 1P identity data to upload to Amazon S3 buckets.\n"," The data preparation process requires you to perform a five-step workflow:\n","Prepare and store identity data in your S3 bucket 2. Catalog data as AWS Glue table 3. Create a schema mapping 4. Create a Source ID namespace in AWS Entity Resolution 5. Associate the Source ID namespace with the AWS Clean Rooms collaboration\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 1: Prepare and store identity data in your S3 bucket"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" Before bringing your data to your S3 bucket, you must prepare your identity records so that they conform to the requirements required for further processing.\n"," Before you store your data in an S3 bucket, ensure that you have prepared your data as described below:\n","AWS Entity Resolution supports identity data stored in CSV and Parquet file formats only.\n","The column names in the Glue tables must be an exact match to the header rows in the corresponding CSV files. All headers and column in the AWS Glue table must exist in the root file (the base table). - All column headers must be in lowercase. - Event table(s) must have a reference that is mapped to a unique key corresponding to every single row in the identity population table. The identity population could be in any of the following:\n","The Experian ID, Merkle ID, LiveRamp ID, Acxiom Real ID and TransUnion ID must be transcoded into Amazon namespace. - AWS Entity Resolution can support up to 25 columns (24 identity columns and a single column containing the unique ID) in a schema mapping. - A schema mapping consists of a subset of columns from the given Glue tables. - If the identity data has more than 25 identity columns with a Glue table, the data must be stored in separate Amazon S3 locations, and a separate Glue table must be created for each S3 location. - If the identity data contains more than 25 rows with the same unique key value, only 25 rows will be considered during the execution of the mapping workflow. Any additional rows with the same unique key values will be ignored. This limitation will result in lower match rates because some relevant data will be excluded from the mapping process. - When you have more than 25 rows for the same individual and want to ensure that all records are considered for the mapping workflow, then you will need to collapse those records into a single row. For example, if there are two rows: - - Row 1 - Unique key1, Address1\n","You can store either raw PII data or hashed PII data.\n","Alternatively, you can utilize the AMCFilePreparationTool to normalize and hash your data. - The column names in the Glue tables must be an exact match with the header rows in the corresponding CSV files. - All column headers must be in lowercase. - Event table(s) must have a reference that is mapped to the unique key in the identity population table.\n"," See sample tables for reference\n"," 1) Sign in to the AWS Management Console and navigate to the Amazon S3 console at https://console.aws.amazon.com/s3/.\n"," 2) Select \"Buckets\" and choose an existing bucket (or create a new bucket) in the us-east-1 region to store your event data table.\n"," 3) Click \"Upload\" and follow the on-screen prompts.\n"," 4) Go to the \"Objects\" tab to view the prefix where your data is stored. Make a note of the folder name.\n"," 5) Select the folder to view the data table.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 2: Catalog data as AWS Glue table"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" Create an AWS Glue table on the S3 data either by setting up a crawler or manually creating the glue table.\n"," After creating the table, verify if it is successfully created by navigating to AWS Athena and performing the following steps:\n","On the left side, navigate to the database, from the table drop down select the newly created table. - Run - Ensure query runs successfully and results line up with expectations\n"," Data is cataloged and ready for use in the next steps.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 3: Create schema mapping corresponding to the AWS Glue Table"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" To define the input data that is to be resolved, you must create a schema mapping. The schema mapping defines the data to be resolved by specifying the input fields and attribute types.\n"," The schema definition supports one mandatory unique ID column, and up to 25 input fields.\n","These input fields are used to map the identity data with Amazon identity data. - Depending on the identity columns available, include or exclude the appropriate fields in the JSON payload. - For each input field, assign an input type to classify the data. - The input type will be used to determine the normalization rules to be applied to the field. - Assign a Match key to each input field to enable field comparison. - If multiple input fields represent the same type of data, assign them the same Match key so they can be compared together. For example, if there are multiple email addresses, the Match key should be set to Email for all those fields. - The input data can be either raw data or hashed data. - If the data is hashed, users should set the hashed attribute to true. - If the data is not hashed (raw), the hashed attribute should be set to false. - If the hashed attribute is not specified, the default value is false.\n"," Use the following template of an API payload to create a schema mapping:\n"," JSON payload\n","| Parameter  | Description                                                                                                                                                                                                                                 |\n","\\| ---------- \\| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \\|\n","| schemaName | Name of the schema mapping.                                                                                                                                                                                                                 |\n","| userid     | Glue column name for the Unique User Id field. Specify the column that can be used to distinctly reference each row of your data. For example: Primary_key, Row_ID, or Record_ID. The event data should have the same value as this column. |\n","| firstname  | Glue column name for first name field.                                                                                                                                                                                                      |\n","| lastname   | Glue column name for last name field.                                                                                                                                                                                                       |\n","| email      | Glue column name for email field.                                                                                                                                                                                                           |\n","| phone      | Glue column name for phone field.                                                                                                                                                                                                           |\n","| address    | Glue column name for address field that has the street number and the street name.                                                                                                                                                          |\n","| city       | Glue column name for city name field.                                                                                                                                                                                                       |\n","| state      | Glue column name for state field.                                                                                                                                                                                                           |\n","| zip        | Glue column name for zip code field.                                                                                                                                                                                                        |\n","| country    | Glue column name for country field.                                                                                                                                                                                                         |\n","| maid       | Glue column name for MAID Id field.                                                                                                                                                                                                         |\n","| liverampid | Glue column name for Liveramp Id field transcoded in Amazon Identity space.                                                                                                                                                                 |\n","| merkleid   | Glue column name for Merkle Id field.                                                                                                                                                                                                       |\n","| experianid | Glue column name for Experian Id field.                                                                                                                                                                                                     |\n","| acxiomid   | Glue column name for Acxiom Real Id field.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t |\n","| transunionid | Glue column name for TransUnion Id field.\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t |\n"," Use the path of this file in the following AWS Entity Resolution CLI command create-schema-mapping to initiate the creation of a schemaMapping from AWS CLI.\n","| Parameter              | Description                                                                    |\n","\\| ---------------------- \\| ------------------------------------------------------------------------------ \\|\n","| apiPayloadJsonFilePath | Path to JSON file create-schema-mapping.json, storing API request parameters |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 4: Create a SOURCE ID namespace wrapping input SOURCE dataset in AWS Glue Table"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" An ID namespace is a resource that contains metadata explaining datasets across multiple AWS accounts and how to use these datasets in an ID mapping workflow.\n"," An ID namespace SOURCE contains configurations for the source data that will be processed in an ID mapping workflow. The ID namespace TARGET contains a configuration of the target data to which all sources will resolve to. To define the input data that you want to resolve across two AWS accounts, create an ID namespace source and an ID namespace target to translate your data from one set (SOURCE) to another (TARGET).\n"," After you and another member create ID namespaces and run an ID mapping workflow, you can join a collaboration in AWS Clean Rooms to run a multi-table join on the ID mapping table, and analyze the data.\n"," To create an ID namespace SOURCE:\n","Use AWS CLI to execute the CreateIDNamespace API, using the sample template of the API payload to create an IdNamespace of type SOURCE.\n"," JSON payload\n"," Up to 20 tables can be associated with a single namespace. In case there are more than 20 tables, we recommend that you consolidate the data without any duplicate rows within the same table. Duplicate values can, however, exist across tables.\n","| Parameter              | Description                                                                                                     |\n","\\| ---------------------- \\| --------------------------------------------------------------------------------------------------------------- \\|\n","| idNamespace            | Name of the SOURCE IdNamespace.                                                                                 |\n","| awsAccount             | AWS Account in which the Glue table was created.                                                                |\n","| databaseName           | The database name in which the Glue table was created.                                                          |\n","| tableName              | The Glue table name                                                                                             |\n","| schemaName             | Name of the schema mapping                    |\n","| idNamespacePassRoleArn | Id Namespace Pass Role Arn |\n","After substituting the user input parameters in the API payload template with values specified by the user, save this updated payload into a file named create-source-id-namespace.json. 3. Use the path of this file in the following AWS Entity Resolution CLI command create-id-namespace to initiate the creation of an IdNamespace.\n","| Parameter              | Description                                                                             |\n","\\| ---------------------- \\| --------------------------------------------------------------------------------------- \\|\n","| apiPayloadJsonFilePath | Path to JSON file create-source-id-namespace.json, storing API request parameters |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 5: Associate the SOURCE ID namespace with the AWS Clean Rooms Collaboration"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" Use AWS CLI to pass the API payload to associate your AWS Entity Resolution ID with your AWS Clean Rooms collaboration.\n"," Use the following template API payload for the create-id-namespace-association command, which associates your AWS Entity Resolution ID namespace to the collaboration and prepares it for collaborative ID mapping.\n","| Parameter                         | Description                                                                    |\n","\\| --------------------------------- \\| ------------------------------------------------------------------------------ \\|\n","| idNamespaceAssociationName        | Name of the association resource to be created in AMC–AWS Clean Rooms.        |\n","| idNamespaceAssociationDescription | Description of the association resource to be created in AMC–AWS Clean Rooms. |\n","| inputReferenceArn                 | ID namespace resource ARN created                                              |\n"," After creating the payload, store it in a file. In this example, we name the file create-source-id-namespace-association.json.\n"," Use the following CLI command to create the ID namespace association in AWS Clean Rooms.\n","| Parameter              | Description                                                                                                                                                                                                           |\n","\\| ---------------------- \\| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| membershipIdentifier   | Your membership identifier in the AWS Clean Rooms collaboration you are associating the resource to. This value can be obtained from the details tab of the collaboration in AWS Clean Rooms through the AWS console. |\n","| apiPayloadJsonFilePath | Path to JSON file create-source-id-namespace-association.json, storing API request parameters.                                                                                                                    |\n"," Your identity data is now associated with your collaboration instance.\n"," After your data is prepared and stored in your S3 bucket, you will need to map your identity data with AMC data. This step is performed through AMC APIs.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Create an ID mapping table for identity data"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" The identity data that you prepared and stored in your S3 bucket must be mapped to AMC data.\n"," The steps in this section are performed through AMC APIs. To execute these steps, you should have already onboarded to AMC API on Amazon Ads.\n"," The ID mapping process requires you to perform a five-step workflow:\n","Identify your AMC account identifier 2. Retrieve your collaboration instance information 3. Retrieve the ID namespaces associated to a collaboration 4. Create an ID mapping table 5. Retrieve the ID mapping job status\n"," Once the job status is complete, the mapping table is ready to be used in your queries.\n"," After you have created the mapping table, if you want to re-populate the mapping table, then call the API to perform a table refresh. The table refresh can be done only once in 14 days and should be triggered only when there is change to the input data. The incremental changes to the input data will automatically be populated in the mapping table (provided the rows with the unique keys are not duplicated).\n"," The delete mapping table endpoint deletes the mapped table.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 1: Identify your AMC account identifier"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" To identify your AMC Identify your AMC account ID (AccountID), follow the steps listed in View AMC account identifier.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 2: Retrieve your collaboration instance information (instanceId)"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" To view collaboration metadata for an AMC instance, use the GET operation of the /amc/instances/{instanceId}/collaboration endpoint.\n"," Listed below is the response schema:\n","| Parameter              | Description                                                                                                                                                                                                                   |\n","\\| ---------------------- \\| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| ID                     | Unique identifier of the collaboration instance.                                                                                                                                                                             |\n","| name                   | The display name of the collaboration.                                                                                                                                                                                            |\n","| description            | Description of the collaboration.                                                                                                                                                                                            |\n","| customerAcceptanceLink | Deep link to the collaboration acceptance page in the AWS account of the customer.                                                                                                                                                |\n","| status                 | The current status of the collaboration. The following table lists available statuses:                                                                                                                                       |\n","|                        | NOT_STARTED: Collaboration setup has not started.                                                                                                                                                                 |\n","|                        | IN_PROGRESS: Collaboration setup is in progress.                                                                                                                                                                  |\n","|                        | PENDING_ACCEPTANCE: Waiting for the AMC–AWS Clean Rooms user to accept collaboration.                                                                                                                            |\n","|                        | ACTIVE: The collaboration was successfully setup and is now active in AWS Clean Rooms.                                                                                                                             |\n","|                        | REJECTED: The AMC–AWS Clean Rooms customer did not accept the collaboration.                                                                                                                                      |\n","|                        | DELETED: The collaboration was deleted and is no longer active in  AWS Clean Rooms.                                                                                                                                |\n","| creator                | Type of collaboration member, in this case, creator. Your collaboration can have creator, query submitter, customer, and AMC data provider types of members. Each type of member has details for the following parameters: |\n","|                        | description: Metadata about a collaboration member.                                                                                                                                                                |\n","|                        | accountId: The AMC–AWS Clean Rooms AWS account ID of the user.                                                                                                                                                        |\n","|                        | membershipId: Unique identifier of the AMC–AWS Clean Rooms membership of the user in the collaboration.                                                                                                               |\n","|                        | displayName: The AMC–AWS Clean Rooms display name of the user/membership abilities.                                                                                                                                   |\n","|                        | status: The status of the member in the collaboration. Valid values are:INVITED; ACTIVE; LEFT; REMOVED                                                                                                             |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 3: Retrieve the ID namespaces associated to a collaboration"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" To retrieve the ID namespaces not associated to a collaboration for the AMC  instance you retrieved in the previous step, use the POST operation of the /amc/instances/{instanceId}/collaboration/idnamespaces/list endpoint.\n"," This operation will return the ID namespaces that are not connected to an ID mapping table in the collaboration in the requested AMC instance.  Select one of the not-connected namespaces returned in the response body to create a mapping table.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 4: Create an ID mapping table"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" To create an ID mapping table in the retrieved/requested AMC instance collaboration and trigger the data population job:\n","Use the POST operation of the /amc/instances/{instanceId}/collaboration/idmappingtables endpoint. 2. Use the following as the request body payload:\n"," Listed below is the response schema:\n","| Parameter              | Description                                                                                        |\n","\\| ---------------------- \\| :------------------------------------------------------------------------------------------------- \\|\n","| idMappingWorkflowJobId | Unique identifier of the job started to populate the id mapping table.                            |\n","| idMappingTable         | The collaboration ID mapping table with the following parameters:                                  |\n","|                        | -description: The description of the table.                                             |\n","|                        | -queryable: Indicates if the table is can be queried.                                   |\n","|                        | -createTime: Time when the table was created.                                           |\n","|                        | -workflowArn: The ARN of the id mapping workflow processing the data backing the table. |\n","|                        | -Name: The name of the table.                                                           |\n","|                        | -updateTime: The time the table was last updated.                                       |\n","|                        | -Id: Unique identifier of the table.                                                    |\n","|                        | -ARN: The ARN of the table.                                                             |\n","| collaborationId        | Unique identifier of the collaboration the ID mapping table is part of.                           |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Step 5: Retrieve the ID mapping job status"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" To retrieve the ID mapping job status for the requested AMC instance, use the GET operation of the /amc/instances/{instanceId}/collaboration/idmappingtables/{idMappingTableId}/jobs/{jobId} endpoint.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":3,"text":"Manage ID mapping tables"},"path":"/en-us/guides/amazon-marketing-cloud/acr/7_upload_identity","content":[" You can use the following AMC API operations to manage ID mapping tables.\n","Update the data in the given ID Mapping Table in the collaboration for the requested AMC instance.\n","Retrieve the ID mapping job metadata for the requested AMC instance.\n","Delete the given ID Mapping Table in the collaboration for the requested AMC instance.\n"," The following operations will not work with collaboration instances:\n","DELETE /amc /advertiserData /{instanceId}/dataSets/{dataSetId} will not delete any data sets from your collaboration instance. However, you can delete data sets uploaded through ADU.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/acr/8_query","content":[" After you have uploaded your data in your collaboration instances, and the data appears under the AMC Console Schema explorer under Advertiser connected of the Query editor page, you can begin to query data.\n"," You can query your data either through the AMC Console or programmatically using AMC APIs.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Query data using the AMC console"},"path":"/en-us/guides/amazon-marketing-cloud/acr/8_query","content":[" Before running queries in the AMC console, review the limitations of the AMC console and specifications on using the date range for handling queries.\n"," To run queries using the AMC console, access the AMC console. Notice that the console:\n","Displays the status of your collaboration instance as Active on the Instance info page. - Displays your uploaded data in the Schema explorer under Advertiser connected on the Query editor page. - Displays the name of the collaboration instance in the Instance drop-down. - Displays a notification above the Query editor indicating that the instance uses AWS Clean Rooms collaboration.\n"," You and users from your organization can write queries in the AMC Query editor using your uploaded data or data in your collaboration instance. After the query runs, the results are available on AWS Clean Rooms console. Access the AWS Clean Rooms console. If you are the result receiver (you have a service role to receive results), you can:\n","View, copy, or download the query results on the Results section of the Queries tab. - View and download the query results from Amazon S3 on the Query results settings defaults of the Queries tab.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":{"type":2,"text":"Query data using AMC APIs"},"path":"/en-us/guides/amazon-marketing-cloud/acr/8_query","content":[" The AMC APIs that are supported for collaboration instances listed below are categorized broadly by the following core functions:\n","Administration resources - Advertiser data upload resources - Workflow management services resources\n"," To make your API calls, you will need to know the following:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - AWS Clean Rooms","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/acr/9_results","content":[" The results of your workflow executions are redirected to the Amazon S3 bucket associated with your collaboration instance.\n"," To access your results, after you successfully execute your workflow using the POST method of the /amc/reporting/{instanceid}/workflowExecutions/ resource, perform the following steps:\n","Use the GET method of the amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId} operation, with the workflowExecutionId as the path parameter. 2. Check if the status of the workflowExecutionId you queried for returned as SUCCEEDED, which means the workflow execution completed successfully and generated results that are ready to download. 3. The results of your queries will live in AWS. Use the AWS APIs to retrieve the results from your connected Amazon S3 bucket.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/acr/limitations","content":[" The following list summarizes AMC-AWS Clean Rooms limitations:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":2,"text":"Query handling"},"path":"/en-us/guides/amazon-marketing-cloud/acr/limitations","content":[" When writing queries using collaboration data, the AMC Query editor - date range options are not supported.\n","For querying over time ranges, make sure your data contains a time stamp column. - Define the date range as part of the query. - To restrict the date range in queries using advertiser connected data, use\n"," Collaboration instances cannot query synthetic data.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":2,"text":"Query results"},"path":"/en-us/guides/amazon-marketing-cloud/acr/limitations","content":[" All results of your queries will go directly to the Amazon S3 bucket associated with your collaboration instance that you specified when creating a membership to join the collaboration. Query results can be retrieved for queries run within the previous 90 days. To access results of queries executed prior to this 90-day period, re-execute those queries.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Account Management","sectionHeader":{"type":2,"text":"APIs"},"path":"/en-us/guides/amazon-marketing-cloud/acr/limitations","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" Data from your Amazon Ads campaign events are ingested into AMC. This data could be from ad activity on Amazon DSP and sponsored ads, and can be referenced through the following tables:\n","Amazon DSP traffic - Amazon Ads conversions - Sponsored ads - Amazon Live traffic - AMC Paid features - AMC audiences tables\n"," All tables have a flat schema consisting of a list of columns that each have a name, a data type, a column type of metric or dimension, and an aggregation threshold. For details, see AMC data aggregation thresholds.\n"," Creating or modifying materialized tables is not supported in AMC SQL. The only supported operations are queries that operate on defined tables within AMC. Tables in AMC can be queried like SQL tables.\n"," In addition, AMC also supports for your subscriptions through Paid Features. You can also upload your own datasets.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Amazon DSP traffic tables"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" The following tables contain inputs from all Amazon DSP campaigns from the DSP advertising accounts that have been added to this instance. Includes records from ad product types such as Display, Online Video, Streaming TV, Audio, etc. \n","Amazon DSP impressions - Amazon DSP clicks - Amazon DSP views - Amazon DSP impressions by segments\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Amazon Ads conversion tables"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" These tables both contain pairs of traffic and conversion events. \"Traffic events\" are impressions and clicks. \"Conversion events\" include purchases, various interactions with Amazon website, such as detailed page views and pixel fires. Each conversion event in the table is attributed to its corresponding traffic event.\n","Conversions - Conversions with relevance - Amazon attributed events by conversion time\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Sponsored ads table"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" This table includes both impressions and clicks for sponsored ads programs.\n","Sponsored ads traffic table\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Amazon Live traffic table"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" This table includes Amazon Live impression, click, and view events, reported at the granularity of the carousel ads that are displayed alongside the Amazon Live broadcast media.\n","Amazon Live traffic table\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"AMC paid features"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" The following tables contain signals associated with AMC paid features. For more information about availability and eligibility, refer to Paid features overview.\n","Conversions all - Amazon audience segment membership - Amazon Your Garage - Amazon Brand Store insights - Amazon Retail Purchase - Amazon Prime Video Channel Insights - Experian vehicle purchases - NC Solutions (NCS) CPG Insights Stream\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Demographic data not available"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" While demographic data (such as age, marital status, and income) is not available in AMC, you have the option to leverage your own first-party demographic data. For more information on uploading first-party data into AMC, refer to Ads data manager.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"AMC Audiences tables"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" AMC Audiences uses a unique set of tables that mirror the data available in AMC for both Amazon Ads tables and Paid features tables.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Amazon Ads audience tables"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":["amazon_attributed_events_by_conversion_time_for_audiences  amazon_attributed_events_by_traffic_time_for_audiences  conversions_for_audiences  conversions_with_relevance_for_audiences  dsp_clicks_for_audiences  dsp_impressions_by_matched_segments_for_audiences  dsp_impressions_by_user_segments_for_audiences  dsp_impressions_for_audiences  dsp_views_for_audiences  dsp_video_events_feed_for_audiences  sponsored_ads_traffic_for_audiences \\* amazon_live_traffic_for_audiences\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Paid features audience tables"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" If the Paid feature is available in your region or marketplace and your instance is eligible, the audience table will be automatically available in your instance. For more information, refer to Paid features overview.\n","conversions_all_for_audiences  audience_segments\\_\\[amer|apac|eu]\\_inmarket_for_audiences  audience_segments\\_\\[amer|apac|eu]\\_inmarket_snapshot_for_audiences  audience_segments\\_\\[amer|apac|eu]\\_lifestyle_for_audiences  audience_segments\\_\\[amer|apac|eu]\\_lifestyle_snapshot_for_audiences  segment_metadata_for_audiences  amazon_your_garage_for_audiences  amazon_brand_store_page_views(\\_non_endemic)\\_for_audiences  amazon_brand_store_engagement_events(\\_non_endemic)\\_for_audiences  amazon_retail_purchases_for_audiences  amazon_pvc_enrollments_for_audiences \\* amazon_pvc_streaming_events_feed_for_audiences\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Amazon Ad Server tables"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Important notes for querying data sets"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Time Zones"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" AMC queries are based on UTC time by default, but the advertising console provides reports based on advertiser time zone (for example, America/Los_Angeles).\n"," When working with AMC APIs, to match AMC to the advertiser time zone, the timeWindowTimeZone parameter of the CreateWorkflowExecution request can be used to specify the time zone.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Arbitrary Attribution Intervals"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" In the API, there are four intervals metrics can be viewed at: \\_1d, \\_7d, \\_14d, \\_30d, but in AMC, a user can aggregate results for any interval up to the attribution window, which is 14d. For example, to get conversions that occurred within \\_9d of the traffic time, use the following SQL:\n"," Alternatively, fitting the same concept into a single expression:\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Conversion vs Traffic Time"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" As products and in the advertising console, Sponsored Products and Sponsored Display uses amazon_attributed_events_by_traffic_time and Sponsored Brands uses amazon_attributed_events_by_conversion_time.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Sponsored Products Conversions and Traffic"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/overview","content":[" The following example shows how to union conversions with Sponsored Products. Notice that we filter specifically for the ad product we care about here as seen by:\n"," This ensures that we do not include display conversions, which currently has a null value for ad_product_type.\n"],"documentType":"guide"},{"title":"Amazon DSP impressions table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/dsp_impressions","content":[" Analytics table: \n","dsp_impressions\n"," Audience table: \n","dsp_impressions_for_audiences\n"," This table records of all impressions delivered to viewers. This table contains the most granular record of every impression delivered, allowing you to query the all viewers reached through an Amazon DSP campaign.\n","| Name                                       | Data type      | Metric/dimension | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Aggregation threshold |\n","\\|--------------------------------------------\\|----------------\\|------------------\\|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|-----------------------\\|\n","| ad_slot_size | STRING | DIMENSION        | Ad slot size in which the Amazon DSP ad was served, expressed as width x height in pixels. The dimensions indicate the space allocated for the ad on the page or app where the impression was served. Example values: '300x250', '728x90', '320x50'.                                                                                                                                                                                                                                                                                                                                                                                                 | LOW |\n","| advertiser | STRING | DIMENSION        | Name of the business entity running advertising campaigns on Amazon DSP. Example value: 'Widgets Inc'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW |\n","| advertiser_account_frequency_group_ids | Array\\[LONG] | DIMENSION        | An array of the advertiser-account-level frequency group IDs that were applicable for this impression event. Frequency groups created at the advertiser account level may operate across 1 or more campaigns within that advertiser account. Note that a single impression may be subject to multiple frequency groups.                                                                                                                                                                                                                                                                                                                              | LOW |\n","| advertiser_id | LONG | DIMENSION        | ID of the Amazon DSP advertiser associated with the impression event. Example value: '123456789012345'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW |\n","| advertiser_timezone | STRING | DIMENSION        | Advertiser timezone. This setting aligns with the advertiser timezone configuration in the connected Amazon DSP account. Example value: 'America/New_York'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW |\n","| app_bundle | STRING | DIMENSION        | The app bundle ID associated with the Amazon DSP impression. App bundles follow different formatting conventions depending on the app store.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW |\n","| audience_fee | LONG | METRIC           | The fee (in microcents) that Amazon DSP charges to customers to utilize Amazon audiences. Audience fees are typically charged on a cost-per-thousand impressions (CPM) basis when using audience segments for campaign targeting. To convert to dollars/your currency, divide by 100,000,000 (for example, 100,000,000 microcents = $1.00). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '25000'.                                                                                                                                                                                               | NONE |\n","| bid_price | LONG | METRIC           | The bid price (in microcents) for the Amazon DSP impression. To convert to dollars/your currency, divide by 100,000,000 (for example, 500,000 microcents = $0.005). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '500000'.                                                                                                                                                                                                                                                                                                                                                                      | MEDIUM |\n","| browser_family | STRING | DIMENSION        | Browser family used when viewing the Amazon DSP ad. Browser family represents a high-level grouping of web browsers and app contexts through which ads can be served, such as mobile browsers, desktop browsers, and application environments. Example values include: 'Chrome', 'Safari', 'Mobile Safari', 'Android App', 'iOS WebView', and 'Roku App'.                                                                                                                                                                                                                                                                                            | LOW |\n","| campaign | STRING | DIMENSION        | Name of the Amazon DSP campaign responsible for the impression event. A campaign is a container that groups related advertising efforts with shared objectives, budget, and flight dates. Example value: 'Widgets_Q1_2024_Awareness_Display_US'.                                                                                                                                                                                                                                                                                                                                                                                                | LOW |\n","| campaign_budget_amount | LONG | DIMENSION        | The total budget allocated to the Amazon DSP campaign, stored in millicents. To convert to dollars/local currency, divide by 100,000 (for example, 100,000 millicents = $1.00). Refer to the currency_name field for the budget currency. Example value: 100000000.                                                                                                                                                                                                                                                                                                                                                                                        | LOW |\n","| campaign_country | STRING | DIMENSION        | Country of the Amazon DSP campaign. This value is based on the country setting configured at campaign level. Example value: 'US'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | LOW |\n","| campaign_end_date | TIMESTAMP | DIMENSION        | End date and time of the Amazon DSP campaign in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW |\n","| campaign_end_date_utc | TIMESTAMP | DIMENSION        | End date of the Amazon DSP campaign in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW |\n","| campaign_flight_budget_amount | LONG | METRIC | The total budget allocated to the flight, stored in millicents. To convert to dollars/local currency, divide by 100,000 (for example, 100,000 millicents = $1.00). Refer to the currency_name field for the campaign budget currency. Example value: 100000000. | LOW |\n","| campaign_flight_end_date_utc | TIMESTAMP | DIMENSION | End date and time of the flight in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_flight_id | LONG | DIMENSION | ID of the Amazon DSP flight responsible for the traffic event. A flight is a scheduled period of time when a campaign is active. Campaigns can include multiple flights to support different budget and optimization settings. Example value: '123456789012345'. | LOW |\n","| campaign_flight_name | STRING | DIMENSION | Name of the flight responsible for the traffic event. A flight is a scheduled period of time when a campaign is active. Campaigns can include multiple flights to support different budget and optimization settings. Example value: 'Widgets_Q1_2024_Keywords_US'. | LOW |\n","| campaign_flight_start_date_utc | TIMESTAMP | DIMENSION | Start date and time of the flight in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_id | LONG | DIMENSION        | The ID of the Amazon DSP campaign responsible for the impression event. In this table, campaign_id and campaign_id_string fields will show the same value for a given event. Example value: '571234567890123456'.                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW |\n","| campaign_id_string | STRING | DIMENSION        | The ID of the Amazon DSP campaign responsible for the impression event. In this table, campaign_id and campaign_id_string fields will show the same value for a given event. Example value: '571234567890123456'.                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW |\n","| campaign_insertion_order_id | STRING | DIMENSION        | ID of the insertion order associated with the Amazon DSP impression event. An insertion order is a contractual agreement between an advertiser and Amazon Ads that outlines the specific details of a programmatic advertising campaign. Example value: '123456789'.                                                                                                                                                                                                                                                                                                                                                                                 | LOW |\n","| campaign_primary_goal | STRING | DIMENSION        | Primary goal set for campaign optimization in Amazon DSP. Campaign goals determine how Amazon DSP optimizes delivery and measures success of the campaign. The goal selected during campaign setup influences bidding strategy and campaign optimization. Possible values include: ROAS, TOTAL_ROAS, REACH, CPVC, COMPLETION_RATE, CTR, CPC, DPVR, PAGE_VISIT, CPDPV, CPA OTHER, and NONE.                                                                                                                                                                                                                              | LOW |\n","| campaign_sales_type | STRING | DIMENSION        | Billing classification of the Amazon DSP campaign, which distinguishes billable and non-billable campaigns. Possible values include: BILLABLE and BONUS.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW |\n","| campaign_source | STRING | DIMENSION        | Campaign source.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW |\n","| campaign_start_date | TIMESTAMP | DIMENSION        | Start date and time of the Amazon DSP campaign in advertiser timezone. The campaign start date determines when a campaign begins serving impressions. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW |\n","| campaign_start_date_utc | TIMESTAMP | DIMENSION        | Start date and time of the Amazon DSP campaign in Coordinated Universal Time (UTC). The campaign start date determines when a campaign begins serving impressions. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW |\n","| campaign_status | STRING | DIMENSION        | Current status of the Amazon DSP campaign. Campaign status indicates whether a campaign is actively delivering ads, has completed its flight dates, or has been paused by the advertiser. Possible values include: ENDED, RUNNING, ENABLED, PAUSED, and ADS_NOT_RUNNING.                                                                                                                                                                                                                                                                                                                                                                 | LOW |\n","| city_name | STRING | DIMENSION        | City name where the Amazon DSP impression event occurred, determined by signal available in the auction event. Example value: 'New York'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | HIGH |\n","| creative | STRING | DIMENSION        | Name of the Amazon DSP creative/ad. A creative represents the actual advertisement shown to customers. Example value: '2025_US_Widgets_Spring_Mobile_320x50'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW |\n","| creative_category | STRING | DIMENSION        | Category of the Amazon DSP creative/ad. This field categorizes Amazon DSP ads into broad creative format types like display ads and video ads. Possible values include: 'Display', 'Video', and NULL.                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW |\n","| creative_duration | LONG | DIMENSION        | Duration in seconds of the Amazon DSP creative asset, primarily used for video format ads. This field specifies the length of video creative assets delivered through Amazon DSP campaigns. For non-video creative formats like display ads, this field will be NULL. Example values include: '15', '30', '60', representing video durations in seconds.                                                                                                                                                                                                                                                                                             | LOW |\n","| creative_id | LONG | DIMENSION        | Unique identifier for the Amazon DSP creative/ad. A ad represents the actual advertisement shown to customers, which could be an image, video, or other ad format. Example value: '591234567890123456'.                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW |\n","| creative_is_link_in | STRING | DIMENSION        | Boolean field indicating whether the Amazon DSP creative/ad directs to an Amazon destination (link in) versus an external destination (link out). A link in creative directs users to an Amazon destination like a product detail page, while a link out creative directs users to an external destination like the website of the advertiser. Possible values for this field are: 'Y' (creative is link in), 'N' (creative is link out).                                                                                                                                                                                                                  | LOW |\n","| creative_size | STRING | DIMENSION        | Dimensions of the Amazon DSP creative/ad (width x height in pixels, or responsive format). Example values: '300x250', '320x50', 'Responsive'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW |\n","| creative_type | STRING | DIMENSION        | Type of ad. Example values: 'Streaming TV Video', 'Standard Display', 'Audio', 'Responsive eCommerce', 'Digital Signage'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW |\n","| currency_iso_code | STRING | DIMENSION        | Currency ISO code associated with the monetary values in the table. The three-letter currency code follows the ISO 4217 standard format and is determined by the currency setting in the connected Amazon DSP account. Example value: 'USD'.                                                                                                                                                                                                                                                                                                                                                                                                         | LOW |\n","| currency_name | STRING | DIMENSION        | Currency name associated with the monetary values in the table. Currency is determined by the currency setting in the connected Amazon DSP account. Example value: 'Dollar (USA)'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW |\n","| deal_id | STRING | DIMENSION        | ID of the deal between the publisher and advertiser, for Amazon DSP impressions purchased via private deal (for example, Private Marketplace or Programmatic Guaranteed deals). Deals represent agreements for access to specific ad inventory with pre-negotiated terms. This field will be NULL for traffic events purchased via open auction. Example value: 'DEAL123456'.                                                                                                                                                                                                                                                                                | LOW |\n","| deal_name | STRING | DIMENSION        | Name of the deal between the publisher and advertiser, for Amazon DSP impressions purchased via private deal (for example, Private Marketplace or Programmatic Guaranteed deals). Deals represent agreements for access to specific ad inventory with pre-negotiated terms. This field will be NULL for traffic events purchased via open auction. Example value: 'Widgets_Premium_Video_Deal'.                                                                                                                                                                                                                                                           | LOW |\n","| demand_channel | STRING | DIMENSION        | Demand channel name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW |\n","| demand_channel_owner | STRING | DIMENSION        | Demand channel owner.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW |\n","| device_id | STRING | DIMENSION        | Pseudonymous ID representing the device associated with the Amazon DSP impression event.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | VERY_HIGH |\n","| device_make | STRING | DIMENSION        | Manufacturer or brand name of the device associated with the Amazon DSP impression event, derived from user-agent in the auction. Values may appear in different formats or capitalizations for the same manufacturer. Example values: 'Apple', 'APPLE', 'Samsung', 'SAMSUNG', 'ROKU', 'Generic', 'UNKNOWN'.                                                                                                                                                                                                                                                                                                                                         | LOW |\n","| device_model | STRING | DIMENSION        | Model of the device associated with the Amazon DSP impression event, derived from user-agent in the auction. Values may appear in different formats or capitalizations for the same manufacturer. Example values: 'iPhone', 'GALAXY'.                                                                                                                                                                                                                                                                                                                                                                                                                | LOW |\n","| device_type | STRING | DIMENSION        | Type of the device associated with the Amazon DSP impression event. Possible values include: 'Tablet', 'Phone', 'TV', 'PC', 'ConnectedDevice', 'Unknown', and NULL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW |\n","| dma_code | STRING | DIMENSION        | Designated Market Area (DMA) code where the Amazon DSP impression event occurred. DMA codes are geographic regions defined by Nielsen that identify specific broadcast TV markets in the United States. The field uses a standardized format combining \"US-DMA\" prefix with a numeric market identifier. Example value: 'US-DMA518'.                                                                                                                                                                                                                                                                                                                 | LOW |\n","| entity_id | STRING | DIMENSION        | ID of the Amazon DSP entity (also known as seat) associated with the impression. An entity represents an Amazon DSP account, within which media is further organized by advertiser and by campaign. Example value: 'ENTITYABC123XYZ789'.                                                                                                                                                                                                                                                                                                                                                                                                             | LOW |\n","| environment_type | STRING | DIMENSION        | Environment where the Amazon DSP impression event occurred. This field distinguishes between web-based environments like desktop or mobile browsers, and app-based environments like mobile apps. If the environment type cannot be determined, this field will be NULL. Possible values include: 'Web', 'App', and NULL.                                                                                                                                                                                                                                                                                                                            | LOW |\n","| household_id | STRING | DIMENSION        | Pseudonymous household ID for the user at the time of the traffic event. The same user may have different IDs across events if the user moves households. NULL when Amazon Ads cannot resolve the user or household. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT household_id). Data is available from April 10, 2026 onward, with household ID coverage varying by region. | VERY_HIGH |\n","| household_size | STRING | DIMENSION        | Size of the household. Possible values for this field are: NULL, '1', '2', '3', and '4+'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | HIGH |\n","| impression_cost | LONG | METRIC           | The cost of the Amazon DSP impression event in millicents (where 100,000 millicents = $1.00). To convert to dollars/your currency, divide by 100,000. Refer to the currency_name field for the currency in which the impression was purchased. Example value: 300 (equivalent to $0.003).                                                                                                                                                                                                                                                                                                                                                           | NONE |\n","| impression_date | DATE | DIMENSION        | Date of the Amazon DSP impression event in advertiser timezone. Example value: '2025-01-01'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW |\n","| impression_date_utc | DATE | DIMENSION        | Date of the Amazon DSP impression event in Coordinated Universal Time (UTC). Example value: '2025-01-01'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | LOW |\n","| impression_day | INTEGER | DIMENSION        | Day of month when the Amazon DSP impression event occurred in advertiser timezone. Example value: '1'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW |\n","| impression_day_utc | INTEGER | DIMENSION        | Day of month when the Amazon DSP impression event occurred in Coordinated Universal Time (UTC). Example value: '1'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW |\n","| impression_dt | TIMESTAMP | DIMENSION        | Timestamp of the Amazon DSP impression event in advertiser timezone. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | MEDIUM |\n","| impression_dt_hour | TIMESTAMP | DIMENSION        | Timestamp of the Amazon DSP impression event in advertiser timezone, truncated to hour. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW |\n","| impression_dt_hour_utc | TIMESTAMP | DIMENSION        | Timestamp of the Amazon DSP impression event in Coordinated Universal Time (UTC), truncated to hour. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW |\n","| impression_dt_utc | TIMESTAMP | DIMENSION        | Timestamp of the Amazon DSP impression event in Coordinated Universal Time (UTC). Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | MEDIUM |\n","| impression_hour | INTEGER | DIMENSION        | Hour of day when the Amazon DSP impression event occurred, in advertiser timezone. Values range from 0-23 representing 24-hour time. Example value: '14' (represents 2:00 PM in 24-hour time).                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW |\n","| impression_hour_utc | INTEGER | DIMENSION        | Hour of day when the Amazon DSP impression event occurred, in Coordinated Universal Time (UTC). Values range from 0-23 representing 24-hour time. Example value: '14' (represents 2:00 PM in 24-hour time).                                                                                                                                                                                                                                                                                                                                                                                                                                          | LOW |\n","| impressions | LONG | METRIC           | Count of Amazon DSP impressions. When querying this table, remember that each record represents one Amazon DSP impression, so you can use this field to calculate accurate impression totals. Since this table only includes impression events, this field will always have a value of '1' (the event was an impression event).                                                                                                                                                                                                                                                                                                                      | NONE |\n","| ip_address | STRING | DIMENSION | Pseudonymous identifier that represents the IP address received for an ad event. The field can contain either IPv4 or IPv6 values. NULL values appear when Amazon Ads does not receive an IP address for the event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes such as COUNT(DISTINCT ip_address). | VERY_HIGH |\n","| is_amazon_owned | BOOLEAN | DIMENSION        | Boolean value indicating whether or not the Amazon DSP impression appeared on Amazon-owned inventory. Amazon-owned inventory includes media such as Prime Video, IMDb, and Twitch. Possible values for this field are: 'true', 'false'.                                                                                                                                                                                                                                                                                                                                                                                                              | LOW |\n","| iso_country_code | STRING | DIMENSION        | ISO 3166 Alpha-2 country code where the Amazon DSP impression event occurred, based on the IP address of the user. Example value: 'US'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW |\n","| iso_state_province_code | STRING | DIMENSION        | ISO state/province code where the Amazon DSP impression event occurred. The code follows the ISO 3166-2 standard format which combines the country code and state/province subdivision (for example, 'US-CA' for California, United States). Example value: 'US-CA'.                                                                                                                                                                                                                                                                                                                                                                                        | LOW |\n","| line_item | STRING | DIMENSION        | Name of the Amazon DSP line item responsible for the impression event. Attributes like ad format and targeting are defined at line item level within a campaign. Example value: 'Widgets - DISPLAY - O&O - RETARGETING'.                                                                                                                                                                                                                                                                                                                                                                                                                             | LOW |\n","| line_item_budget_amount | LONG | DIMENSION        | The total budget allocated to the Amazon DSP line item, stored in millicents. To convert to dollars/local currency, divide by 100,000 (for example, 100,000 millicents = $1.00). Refer to the currency_name field for the budget currency. Example value: '100000000'.                                                                                                                                                                                                                                                                                                                                                                                     | LOW |\n","| line_item_end_date | TIMESTAMP | DIMENSION        | End date and time of the Amazon DSP line item in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW |\n","| line_item_end_date_utc | TIMESTAMP | DIMENSION        | End date and time of the Amazon DSP line item in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW |\n","| line_item_id | LONG | DIMENSION        | ID of the Amazon DSP line item responsible for the impression event. Attributes like ad format and targeting are defined at line item level within a campaign. Example value: '5812345678901234'.                                                                                                                                                                                                                                                                                                                                                                                                                                                    | LOW |\n","| line_item_price_type | STRING | DIMENSION        | Pricing model used for the Amazon DSP line item. Line items can use different pricing models to determine how costs are calculated, with Cost Per Mille (CPM) being a common model where advertisers pay per thousand impressions. Example value: 'CPM'.                                                                                                                                                                                                                                                                                                                                                                                             | LOW |\n","| line_item_start_date | TIMESTAMP | DIMENSION        | Start date and time of the Amazon DSP line item in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW |\n","| line_item_start_date_utc | TIMESTAMP | DIMENSION        | Start date and time of the Amazon DSP line item in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW |\n","| line_item_status | STRING | DIMENSION        | Status of the Amazon DSP line item. The status indicates whether the line item is actively delivering ads, has been paused, or has completed its flight. Possible values include: ENDED, ENABLED, RUNNING, PAUSED_BY_USER, and SUSPENDED.                                                                                                                                                                                                                                                                                                                                                                                                | LOW |\n","| line_item_type | STRING | DIMENSION        | Type of Amazon DSP line item. Line item types indicate how ads are delivered and optimized. Example values include: AAP, AAP_DISPLAY, AAP_MOBILE, AAP_VIDEO_CPM.                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW |\n","| managed_service_fee | LONG | METRIC           | The fee (in microcents) that Amazon DSP charges to customers for campaign management services provided by the Amazon in-house service team. The managed service fee is calculated as a percentage of the supply cost. To convert from microcents to dollars/your currency, divide by 100,000,000 (for example, 5,000,000 microcents = $0.05). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '5000000'.                                                                                                                                                                                             | NONE |\n","| manager_account_frequency_group_ids | Array\\[LONG] | DIMENSION        | An array of the manager-account-level frequency group IDs that were applicable for this impression event. Frequency groups created at the manager account level may operate across 1 or more advertisers within that manager account. Note that a single impression may be subject to multiple frequency groups.                                                                                                                                                                                                                                                                                                                                     | LOW |\n","| matched_behavior_segment_ids | Array\\[INTEGER] | DIMENSION        | Array of behavior segment IDs that were both targeted by the Amazon DSP line item and matched to the user at the time of impression. Each ID in the array corresponds to a distinct audience segment. Example value: '123456, 234567, 345678'.                                                                                                                                                                                                                                                                                                                                                                                                     | LOW |\n","| merchant_id | LONG | DIMENSION        | Merchant ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION        | Boolean value indicating whether the event can be used for audience creation that is third-party tracking enabled (i.e. whether you can serve creative with third-party tracking when running media against the audience). Third-party tracking refers to measurement tags and pixels from external vendors that can be used to measure ad performance. Possible values for this field are: 'true', 'false'.                                                                                                                                                                                                                                         | NONE |\n","| ocm_fee | LONG | METRIC           | The fee (in microcents) that Amazon DSP charges for the use of omnichannel measurement studies. The omnichannel metrics fee is calculated as a percentage of the supply cost. To convert to dollars, divide by 100,000,000 (for example, 500,000 microcents = $0.005). Refer to the currency_name field for the currency in which the impression was purchased. Example value: 500000.                                                                                                                                                                                                                                                                     | LOW |\n","| operating_system | STRING | DIMENSION        | Operating system of the device where the Amazon DSP impression event occurred. Example values: 'iOS', 'Android', 'Windows', 'macOS', 'Roku OS'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW |\n","| os_version | STRING | DIMENSION        | Operating system version of the device where the Amazon DSP impression event occurred. The version format varies by operating system type. Example value: '17.5.1'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW |\n","| page_type | STRING | DIMENSION        | Type of page where the Amazon DSP impression event occurred. This grain of detail is primarily relevant to impressions served on Amazon sites. Example values: 'Search', 'Detail', 'CustomerReviews'.                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW |\n","| placement_is_view_aware | BOOLEAN | DIMENSION        | Boolean value indicating whether or not the Amazon DSP impression occurred in a placement that supports viewability measurement. Possible values for this field are: 'true', 'false'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW |\n","| placement_view_rate | DECIMAL | DIMENSION        | The view rate of the placement, expressed as a decimal between 0.0 and 1.0. Viewability is measured according to Media Rating Council (MRC) standards, which require 50% of pixels to be in view for at least 1 second for display ads and 2 seconds for video ads. Example value: '0.75'.                                                                                                                                                                                                                                                                                                                                                           | LOW |\n","| platform_fee | LONG | METRIC           | The fee (in microcents) that Amazon DSP charges to customers to access and use Amazon DSP. The platform fee (also known as the technology fee or console fee in other contexts) is calculated as a percentage of the supply cost. To convert to dollars/your currency, divide by 100,000,000 (for example, 100,000,000 microcents = $1.00). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '25000'.                                                                                                                                                                                               | NONE |\n","| postal_code | STRING | DIMENSION        | Postal code in which the Amazon DSP impression event occurred, based on the IP address of the user. Postal code is also referred to as \"zip code\" in the US. The postal code is prepended with the iso_country_code value (for example, 'US'). If the country is known, but the postal code is unknown, only the country code will be populated in postal_code. Example value: 'US-12345'.                                                                                                                                                                                                                                                                     | HIGH |\n","| product_line | STRING | DIMENSION        | Campaign product line.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW |\n","| publisher_name | STRING | DIMENSION | Name of the publisher on which the impression event was shown. | LOW |\n","| request_tag | STRING | DIMENSION        | ID that connects related impression, view, click, and conversion events. For example, if an impression served has a request_tag value of 'X', related conversion events will have an impression_id value of 'X'. While this occurs infrequently, there are sometimes duplicate request_tag values. As a result, it is not recommended to use request_tag as a JOIN key without first grouping by it. Rather, it is a best practice to first consider using UNION ALL in a query instead of joining based on the request_tag to combine data sources. For insights that involve user-level ad exposure across tables, use user_id instead. | VERY_HIGH |\n","| segment_marketplace_id | INTEGER | DIMENSION        | ID of the marketplace associated with an audience segment. A marketplace represents a specific region where advertising can be delivered.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW |\n","| seller_id | STRING | DIMENSION | ID of the seller from which the impression event originated. In OpenRTB, this corresponds to publisher.id. Format will vary. | LOW |\n","| seller_name | STRING | DIMENSION | Name of the seller from which the impression event originated.                                                               | LOW |\n","| site | STRING | DIMENSION        | The site descriptor where the Amazon DSP impression event occurred. A site can be any digital property where ads are served, including websites, mobile apps, and streaming platforms. Note that different types of environments may have different formatting. For example, 'widgets.com' for a web property, 'Widgets iOS (ID: 1234567890)' for an app property.                                                                                                                                                                                                                                                                                   | LOW |\n","| slot_position | STRING | DIMENSION        | Position of the ad on the page relative to the initial viewport. Above the fold (ATF) refers to the portion of the webpage visible without scrolling, while below the fold (BTF) refers to the portion that requires scrolling to view. This dimension helps measure where ad impressions were served on the page. Possible values include: ATF, BTF, and UNKNOWN.                                                                                                                                                                                                                                                                             | LOW |\n","| supply_cost | LONG | METRIC           | The cost (in microcents) that Amazon DSP pays a publisher or publisher ad tech platform (such as an SSP or exchange) for an impression. To convert supply_cost to dollars/your local currency, divide by 100,000,000 (for example, 100,000,000 microcents = $1.00). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '5000'.                                                                                                                                                                                                                                                                       | NONE |\n","| supply_source | STRING | DIMENSION        | Supply source from which the Amazon DSP impression was purchased. Supply sources can include Amazon-owned properties (like Amazon.com and Twitch), Amazon Publisher Services inventory, and third-party partners. Example values: 'AMAZON.COM', 'TWITCH WEB VIDEO', 'PUBMATIC WEB DISPLAY'.                                                                                                                                                                                                                                                                                                                                                          | LOW |\n","| supply_source_id | LONG | DIMENSION        | ID of the supply source from which the Amazon DSP impression was purchased. Supply sources can include Amazon-owned properties (like Amazon.com and Twitch), Amazon Publisher Services inventory, and third-party partners.                                                                                                                                                                                                                                                                                                                                                                                                                          | LOW |\n","| supply_source_is_view_aware | BOOLEAN | DIMENSION        | Boolean value indicating whether or not the supply source can measure viewability. Possible values for this field are: 'true', 'false'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW |\n","| supply_source_view_rate | DECIMAL | DIMENSION        | The view rate of the supply source, expressed as a decimal between 0.0 and 1.0. View rate represents the percentage of impressions that met viewability standards, which require at least 50% of the pixels of the ad to be visible for a minimum of one second for display ads or two seconds for video ads. Example value: '0.75'.                                                                                                                                                                                                                                                                                                                      | LOW |\n","| third_party_fees | LONG | METRIC           | The sum of all third-party fees charged for the impression (in microcents). Third-party fees represent charges from external data and technology providers used in the delivery and measurement of the impression. Since this field is in microcents, divide by 100,000,000 to convert to dollars/your local currency (for example, 500,000,000 microcents = $5.00). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '25000'.                                                                                                                                                                      | NONE |\n","| total_cost | DOUBLE | METRIC           | The total cost of the Amazon DSP impression in millicents, inclusive of all applicable fees (supply cost, audience fees, platform fees, and third-party fees). Since this field is in millicents, divide by 100,000 to convert to dollars/your local currency (for example, 100,000 millicents = $1.00). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '300'.                                                                                                                                                                                                                                    | NONE |\n","| user_behavior_segment_ids | Array\\[INTEGER] | DIMENSION        | Array of behavior segment IDs that the user belonged to at the time of impression. Each ID in the array corresponds to a distinct audience segment. Example value: '123456, 234567, 345678'.                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW |\n","| user_id | STRING | DIMENSION        | Pseudonymous identifier that connects user activity across different events. The field can contain ad user IDs (representing Amazon accounts), device IDs, or browser IDs. NULL values appear when Amazon Ads is unable to resolve an identifier for an event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT user_id).                                                                                                                                                             | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION        | Type of user ID value. AMC includes different types of user ID values, depending on whether the value represents a resolved Amazon account, a device, or a browser cookie. If Amazon Ads is unable to determine or provide an ID of any kind for an impression event, the user_id and user_id_type values for that record will be NULL. Possible values include: adUserId, sisDeviceId, adBrowserId, and NULL.                                                                                                                                                                                                                          | LOW |\n"],"documentType":"guide"},{"title":"Amazon DSP clicks table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/dsp_clicks","content":[" Analytics table: \n","dsp_clicks\n"," Audience table: \n","dsp_clicks_for_audiences\n"," The dsp_clicks table is a subset of the dsp_impressions information that captures the impressions that were clicked and the associated click related information. \n","| Name | Data type | Metric/dimension | Description | Aggregation threshold |\n","\\|------\\|-----------\\|------------------\\|-------------\\|-----------------------\\|\n","| ad_slot_size | STRING | DIMENSION | Ad slot size in which the Amazon DSP ad was served, expressed as width x height in pixels. The dimensions indicate the space allocated for the ad on the page or app where the impression was served. Example values: '300x250', '728x90', '320x50'. | LOW |\n","| advertiser | STRING | DIMENSION | Name of the business entity running advertising campaigns on Amazon DSP. Example value: 'Widgets Inc'. | LOW |\n","| advertiser_account_frequency_group_ids | Array\\[LONG] | DIMENSION | An array of the advertiser-account-level frequency group IDs that were applicable for this impression event. Frequency groups created at the advertiser account level may operate across 1 or more campaigns within that advertiser account. Note that a single impression may be subject to multiple frequency groups. | LOW |\n","| advertiser_id | LONG | DIMENSION | ID of the Amazon DSP advertiser associated with the click event. Example value: '123456789012345'. | LOW |\n","| advertiser_timezone | STRING | DIMENSION | Advertiser timezone. This setting aligns with the advertiser timezone configuration in the connected Amazon DSP account. Example value: 'America/New_York'. | LOW |\n","| app_bundle | STRING | DIMENSION | The app bundle ID associated with the Amazon DSP click event. App bundles follow different formatting conventions depending on the app store. | LOW |\n","| audience_fee | LONG | METRIC | The fee (in microcents) that Amazon DSP charges to customers to utilize Amazon audiences. Audience fees are typically charged on a cost-per-thousand impressions (CPM) basis when using audience segments for campaign targeting. To convert to dollars/your currency, divide by 100,000,000 (for example, 100,000,000 microcents = $1.00). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '25000'. | NONE |\n","| bid_price | LONG | METRIC | The bid price (in microcents) for the Amazon DSP impression. To convert to dollars/your currency, divide by 100,000,000 (for example, 500,000 microcents = $0.005). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '500000'. | MEDIUM |\n","| browser_family | STRING | DIMENSION | Browser family used when viewing the Amazon DSP ad. Browser family represents a high-level grouping of web browsers and app contexts through which ads can be served, such as mobile browsers, desktop browsers, and application environments. Example values include: 'Chrome', 'Safari', 'Mobile Safari', 'Android App', 'iOS WebView', and 'Roku App'. | LOW |\n","| campaign | STRING | DIMENSION | Name of the Amazon DSP campaign responsible for the click event. A campaign is a container that groups related advertising efforts with shared objectives, budget, and flight dates. Example value: 'Widgets_Q1_2024_Awareness_Display_US'. | LOW |\n","| campaign_budget_amount | LONG | DIMENSION | The total budget allocated to the Amazon DSP campaign, stored in millicents. To convert to dollars/local currency, divide by 100,000 (for example, 100,000 millicents = $1.00). Refer to the currency_name field for the budget currency. Example value: 100000000. | LOW |\n","| campaign_country | STRING | DIMENSION | Country of the Amazon DSP campaign. This value is based on the country setting configured at campaign level. Example value: 'US'. | LOW |\n","| campaign_end_date | TIMESTAMP | DIMENSION | End date and time of the Amazon DSP campaign in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_end_date_utc | TIMESTAMP | DIMENSION | End date of the Amazon DSP campaign in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_flight_budget_amount | LONG | METRIC | The total budget allocated to the flight, stored in millicents. To convert to dollars/local currency, divide by 100,000 (for example, 100,000 millicents = $1.00). Refer to the currency_name field for the campaign budget currency. Example value: 100000000. | LOW |\n","| campaign_flight_end_date_utc | TIMESTAMP | DIMENSION | End date and time of the flight in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_flight_id | LONG | DIMENSION | ID of the Amazon DSP flight responsible for the traffic event. A flight is a scheduled period of time when a campaign is active. Campaigns can include multiple flights to support different budget and optimization settings. Example value: '123456789012345'. | LOW |\n","| campaign_flight_name | STRING | DIMENSION | Name of the flight responsible for the traffic event. A flight is a scheduled period of time when a campaign is active. Campaigns can include multiple flights to support different budget and optimization settings. Example value: 'Widgets_Q1_2024_Keywords_US'. | LOW |\n","| campaign_flight_start_date_utc | TIMESTAMP | DIMENSION | Start date and time of the flight in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_id | LONG | DIMENSION | The ID of the Amazon DSP campaign responsible for the click event. In this table, campaign_id and campaign_id_string fields will show the same value for a given event. Example value: '571234567890123456'. | LOW |\n","| campaign_id_string | STRING | DIMENSION | The ID of the Amazon DSP campaign responsible for the click event. In this table, campaign_id and campaign_id_string fields will show the same value for a given event. Example value: '571234567890123456'. | LOW |\n","| campaign_insertion_order_id | STRING | DIMENSION | ID of the insertion order associated with the Amazon DSP click event. An insertion order is a contractual agreement between an advertiser and Amazon Ads that outlines the specific details of a programmatic advertising campaign. Example value: '123456789'. | LOW |\n","| campaign_primary_goal | STRING | DIMENSION | Primary goal set for campaign optimization in Amazon DSP. Campaign goals determine how Amazon DSP optimizes delivery and measures success of the campaign. The goal selected during campaign setup influences bidding strategy and campaign optimization. Possible values include: ROAS, TOTAL_ROAS, REACH, CPVC, COMPLETION_RATE, CTR, CPC, DPVR, PAGE_VISIT, CPDPV, CPA, OTHER, and NONE. | LOW |\n","| campaign_sales_type | STRING | DIMENSION | Billing classification of the Amazon DSP campaign, which distinguishes billable and non-billable campaigns. Possible values include: BILLABLE and BONUS. | LOW |\n","| campaign_source | STRING | DIMENSION | Campaign source. | LOW |\n","| campaign_start_date | TIMESTAMP | DIMENSION | Start date and time of the Amazon DSP campaign in advertiser timezone. The campaign start date determines when a campaign begins serving impressions. Example value: '2025-01-01T00:00:00.000Z'. | LOW |\n","| campaign_start_date_utc | TIMESTAMP | DIMENSION | Start date and time of the Amazon DSP campaign in Coordinated Universal Time (UTC). The campaign start date determines when a campaign begins serving impressions. Example value: '2025-01-01T00:00:00.000Z'. | LOW |\n","| campaign_status | STRING | DIMENSION | Current status of the Amazon DSP campaign. Campaign status indicates whether a campaign is actively delivering ads, has completed its flight dates, or has been paused by the advertiser. Possible values include: ENDED, RUNNING, ENABLED, PAUSED, and ADS_NOT_RUNNING. | LOW |\n","| city_name | STRING | DIMENSION | City name where the Amazon DSP click event occurred, determined by signal available in the auction event. Example value: 'New York'. | HIGH |\n","| click_cost | LONG | METRIC | Click Cost (Millicents) | MEDIUM |\n","| click_date | DATE | DIMENSION | Date of the Amazon DSP click event in advertiser timezone. Example value: '2025-01-01'. | LOW |\n","| click_date_utc | DATE | DIMENSION | Date of the Amazon DSP click event in Coordinated Universal Time (UTC). Example value: '2025-01-01' | LOW |\n","| click_day | INTEGER | DIMENSION | Day of month when the Amazon DSP click event occurred in advertiser timezone. Example value: '1'. | LOW |\n","| click_day_utc | INTEGER | DIMENSION | Day of month when the Amazon DSP click event occurred in Coordinated Universal Time (UTC). Example value: '1'. | LOW |\n","| click_dt | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP click event in advertiser timezone. Example value: '2025-01-01T12:00:00.000Z'. | MEDIUM |\n","| click_dt_hour | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP click event in advertiser timezone, truncated to hour. Example value: '2025-01-01T12:00:00.000Z'. | LOW |\n","| click_dt_hour_utc | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP click event in Coordinated Universal Time (UTC), truncated to hour. Example value: '2025-01-01T12:00:00.000Z'. | LOW |\n","| click_dt_utc | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP click event in Coordinated Universal Time (UTC). Example value: '2025-01-01T00:00:00.000Z'. | MEDIUM |\n","| click_hour | INTEGER | DIMENSION | Hour of day when the Amazon DSP click event occurred, in advertiser timezone. Values range from 0-23 representing 24-hour time. Example value: '14' (represents 2:00 PM in 24-hour time). | LOW |\n","| click_hour_utc | INTEGER | DIMENSION | Hour of day when the Amazon DSP click event occurred, in Coordinated Universal Time (UTC). Values range from 0-23 representing 24-hour time. Example value: '14' (represents 2:00 PM in 24-hour time). | LOW |\n","| clicks | LONG | METRIC | Count of Amazon DSP clicks. When querying this table, remember that each record represents one Amazon DSP click, so you can use this field to calculate accurate click totals. Since this table only includes click events, this field will always have a value of '1' (the event was a click event). | NONE |\n","| creative | STRING | DIMENSION | Name of the Amazon DSP creative/ad. A creative represents the actual advertisement shown to customers. Example value: '2025_US_Widgets_Spring_Mobile_320x50'. | LOW |\n","| creative_category | STRING | DIMENSION | Category of the Amazon DSP creative/ad. This field categorizes Amazon DSP ads into broad creative format types like display ads and video ads. Possible values include: 'Display', 'Video', and NULL. | LOW |\n","| creative_duration | LONG | DIMENSION | Duration in seconds of the Amazon DSP creative asset, primarily used for video format ads. This field specifies the length of video creative assets delivered through Amazon DSP campaigns. For non-video creative formats like display ads, this field will be NULL. Example values include: '15', '30', '60', representing video durations in seconds. | LOW |\n","| creative_id | LONG | DIMENSION | Unique identifier for the Amazon DSP creative/ad. An ad represents the actual advertisement shown to customers, which could be an image, video, or other ad format. Example value: '591234567890123456'. | LOW |\n","| creative_is_link_in | STRING | DIMENSION | Boolean field indicating whether the Amazon DSP creative/ad directs to an Amazon destination (link in) versus an external destination (link out). A link in creative directs users to an Amazon destination like a product detail page, while a link out creative directs users to an external destination like the website of the advertiser. Possible values for this field are: 'Y' (creative is link in), 'N' (creative is link out). | LOW |\n","| creative_size | STRING | DIMENSION | Dimensions of the Amazon DSP creative/ad (width x height in pixels, or responsive format). Example values: '300x250', '320x50', 'Responsive'. | LOW |\n","| creative_type | STRING | DIMENSION | Type of ad. Example values: 'Streaming TV Video', 'Standard Display', 'Audio', 'Responsive eCommerce', 'Digital Signage'. | LOW |\n","| currency_iso_code | STRING | DIMENSION | Currency ISO code associated with the monetary values in the table. The three-letter currency code follows the ISO 4217 standard format and is determined by the currency setting in the connected Amazon DSP account. Example value: 'USD'. | LOW |\n","| currency_name | STRING | DIMENSION | Currency name associated with the monetary values in the table. Currency is determined by the currency setting in the connected Amazon DSP account. Example value: 'Dollar (USA)'. | LOW |\n","| deal_id | STRING | DIMENSION | ID of the deal between the publisher and advertiser, for Amazon DSP impressions purchased via private deal (for example, Private Marketplace or Programmatic Guaranteed deals). Deals represent agreements for access to specific ad inventory with pre-negotiated terms. This field will be NULL for traffic events purchased via open auction. Example value: 'DEAL123456'. | LOW |\n","| deal_name | STRING | DIMENSION | Name of the deal between the publisher and advertiser, for Amazon DSP impressions purchased via private deal (for example, Private Marketplace or Programmatic Guaranteed deals). Deals represent agreements for access to specific ad inventory with pre-negotiated terms. This field will be NULL for traffic events purchased via open auction. Example value: 'Widgets_Premium_Video_Deal'. | LOW |\n","| demand_channel | STRING | DIMENSION | Demand channel name. | LOW |\n","| demand_channel_owner | STRING | DIMENSION | Demand channel owner. | LOW |\n","| device_id | STRING | DIMENSION | Pseudonymous ID representing the device associated with the Amazon DSP impression event. | VERY_HIGH |\n","| device_make | STRING | DIMENSION | Manufacturer or brand name of the device associated with the Amazon DSP click event, derived from user-agent in the auction. Values may appear in different formats or capitalizations for the same manufacturer. Example values: 'Apple', 'APPLE', 'Samsung', 'SAMSUNG', 'ROKU', 'Generic', 'UNKNOWN'. | LOW |\n","| device_model | STRING | DIMENSION | Model of the device associated with the Amazon DSP click event, derived from user-agent in the auction. Values may appear in different formats or capitalizations for the same manufacturer. Example values: 'iPhone', 'GALAXY'. | LOW |\n","| device_type | STRING | DIMENSION | Type of the device associated with the Amazon DSP click event. Possible values include: 'Tablet', 'Phone', 'TV', 'PC', 'ConnectedDevice', 'Unknown', and NULL. | LOW |\n","| dma_code | STRING | DIMENSION | Designated Market Area (DMA) code where the Amazon DSP click event occurred. DMA codes are geographic regions defined by Nielsen that identify specific broadcast TV markets in the United States. The field uses a standardized format combining \"US-DMA\" prefix with a numeric market identifier. Example value: 'US-DMA518'. | LOW |\n","| entity_id | STRING | DIMENSION | ID of the Amazon DSP entity (also known as seat) associated with the click. An entity represents an Amazon DSP account, within which media is further organized by advertiser and by campaign. Example value: 'ENTITYABC123XYZ789'. | LOW |\n","| environment_type | STRING | DIMENSION | Environment where the Amazon DSP click event occurred. This field distinguishes between web-based environments like desktop or mobile browsers, and app-based environments like mobile apps. If the environment type cannot be determined, this field will be NULL. Possible values include: 'Web', 'App', and NULL. | LOW |\n","| household_id | STRING | DIMENSION | Pseudonymous household ID for the user at the time of the traffic event. The same user may have different IDs across events if the user moves households. NULL when Amazon Ads cannot resolve the user or household. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT household_id). Data is available from April 10, 2026 onward, with household ID coverage varying by region. | VERY_HIGH |\n","| household_size | STRING | DIMENSION | Size of the household. Possible values for this field are: NULL, '1', '2', '3', and '4+'. | HIGH |\n","| impression_date | DATE | DIMENSION | Date of the Amazon DSP impression event in advertiser timezone. Example value: '2025-01-01'. | LOW |\n","| impression_date_utc | DATE | DIMENSION | Date of the Amazon DSP impression event in Coordinated Universal Time (UTC). Example value: '2025-01-01' | LOW |\n","| impression_day | INTEGER | DIMENSION | Day of month when the Amazon DSP impression event occurred in advertiser timezone. Example value: '1'. | LOW |\n","| impression_day_utc | INTEGER | DIMENSION | Day of month when the Amazon DSP impression event occurred in Coordinated Universal Time (UTC). Example value: '1'. | LOW |\n","| impression_dt | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP impression event in advertiser timezone. Example value: '2025-01-01T12:00:00.000Z'. | MEDIUM |\n","| impression_dt_hour | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP impression event in advertiser timezone, truncated to hour. Example value: '2025-01-01T12:00:00.000Z'. | LOW |\n","| impression_dt_hour_utc | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP impression event in Coordinated Universal Time (UTC), truncated to hour. Example value: '2025-01-01T12:00:00.000Z'. | LOW |\n","| impression_dt_utc | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP impression event in Coordinated Universal Time (UTC). Example value: '2025-01-01T00:00:00.000Z'. | MEDIUM |\n","| impression_hour | INTEGER | DIMENSION | Hour of day when the Amazon DSP impression event occurred, in advertiser timezone. Values range from 0-23 representing 24-hour time. Example value: '14' (represents 2:00 PM in 24-hour time). | LOW |\n","| impression_hour_utc | INTEGER | DIMENSION | Hour of day when the Amazon DSP impression event occurred, in Coordinated Universal Time (UTC). Values range from 0-23 representing 24-hour time. Example value: '14' (represents 2:00 PM in 24-hour time). | LOW |\n","| ip_address | STRING | DIMENSION | Pseudonymous identifier that represents the IP address received for an ad event. The field can contain either IPv4 or IPv6 values. NULL values appear when Amazon Ads does not receive an IP address for the event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes such as COUNT(DISTINCT ip_address). | VERY_HIGH |\n","| is_amazon_owned | BOOLEAN | DIMENSION | Boolean value indicating whether or not the Amazon DSP click occurred on Amazon-owned inventory. Amazon-owned inventory includes media such as Prime Video, IMDb, and Twitch. Possible values for this field are: 'true', 'false'. | LOW |\n","| iso_country_code | STRING | DIMENSION | ISO 3166 Alpha-2 country code where the Amazon DSP click event occurred, based on the IP address of the user. Example value: 'US'. | LOW |\n","| iso_state_province_code | STRING | DIMENSION | ISO state/province code where the Amazon DSP click event occurred. The code follows the ISO 3166-2 standard format which combines the country code and state/province subdivision (for example, 'US-CA' for California, United States). Example value: 'US-CA'. | LOW |\n","| line_item | STRING | DIMENSION | Name of the Amazon DSP line item responsible for the click event. Attributes like ad format and targeting are defined at line item level within a campaign. Example value: 'Widgets - DISPLAY - O&O - RETARGETING'. | LOW |\n","| line_item_budget_amount | LONG | DIMENSION | The total budget allocated to the Amazon DSP line item, stored in millicents. To convert to dollars/local currency, divide by 100,000 (for example, 100,000 millicents = $1.00). Refer to the currency_name field for the budget currency. Example value: '100000000'. | LOW |\n","| line_item_end_date | TIMESTAMP | DIMENSION | End date and time of the Amazon DSP line item in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_end_date_utc | TIMESTAMP | DIMENSION | End date and time of the line item in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_id | LONG | DIMENSION | ID of the Amazon DSP line item responsible for the click event. Attributes like ad format and targeting are defined at line item level within a campaign. Example value: '5812345678901234'. | LOW |\n","| line_item_price_type | STRING | DIMENSION | Pricing model used for the Amazon DSP line item. Line items can use different pricing models to determine how costs are calculated, with Cost Per Mille (CPM) being a common model where advertisers pay per thousand impressions. Example value: 'CPM'. | LOW |\n","| line_item_start_date | TIMESTAMP | DIMENSION | Start date and time of the Amazon DSP line item in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_start_date_utc | TIMESTAMP | DIMENSION | Start date and time of the Amazon DSP line item in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_status | STRING | DIMENSION | Status of the Amazon DSP line item. The status indicates whether the line item is actively delivering ads, has been paused, or has completed its flight. Possible values include: ENDED, ENABLED, RUNNING, PAUSED_BY_USER, and SUSPENDED. | LOW |\n","| line_item_type | STRING | DIMENSION | Type of Amazon DSP line item. Line item types indicate how ads are delivered and optimized. Example values include: AAP, AAP_DISPLAY, AAP_MOBILE, AAP_VIDEO_CPM. | LOW |\n","| manager_account_frequency_group_ids | Array\\[LONG] | DIMENSION | An array of the manager-account-level frequency group IDs that were applicable for this impression event. Frequency groups created at the manager account level may operate across 1 or more advertisers within that manager account. Note that a single impression may be subject to multiple frequency groups. | LOW |\n","| merchant_id | LONG | DIMENSION | Merchant ID. | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Boolean value indicating whether the event can be used for audience creation that is third-party tracking enabled (i.e. whether you can serve creative with third-party tracking when running media against the audience). Third-party tracking refers to measurement tags and pixels from external vendors that can be used to measure ad performance. Possible values for this field are: 'true', 'false'. | NONE |\n","| operating_system | STRING | DIMENSION | Operating system of the device where the Amazon DSP click event occurred. Example values: 'iOS', 'Android', 'Windows', 'macOS', 'Roku OS'. | LOW |\n","| os_version | STRING | DIMENSION | Operating system version of the device where the Amazon DSP click event occurred. The version format varies by operating system type. Example value: '17.5.1'. | LOW |\n","| page_type | STRING | DIMENSION | Type of page where the Amazon DSP click event occurred. This grain of detail is primarily relevant to impressions served on Amazon sites. Example values: 'Search', 'Detail', 'CustomerReviews'. | LOW |\n","| platform_fee | LONG | METRIC | The fee (in microcents) that Amazon DSP charges to customers to access and use Amazon DSP. The platform fee (also known as the technology fee or console fee in other contexts) is calculated as a percentage of the supply cost. To convert to dollars/your currency, divide by 100,000,000 (for example, 100,000,000 microcents = $1.00). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '25000'. | NONE |\n","| postal_code | STRING | DIMENSION | Postal code in which the Amazon DSP click event occurred, based on the IP address of the user. Postal code is also referred to as \"zip code\" in the US. The postal code is prepended with the iso_country_code value (for example, 'US'). If the country is known, but the postal code is unknown, only the country code will be populated in postal_code. Example value: 'US-12345'. | HIGH |\n","| product_line | STRING | DIMENSION | Campaign product line. | LOW |\n","| publisher_name | STRING | DIMENSION | Name of the publisher on which the impression event was shown. | LOW |\n","| request_tag | STRING | DIMENSION | ID that connects related impression, view, click, and conversion events. For example, if an impression served has a request_tag value of 'X', related conversion events will have an impression_id value of 'X'. While this occurs infrequently, there are sometimes duplicate request_tag values. As a result, it is not recommended to use request_tag as a JOIN key without first grouping by it. Rather, it is a best practice to first consider using UNION ALL in a query instead of joining based on the request_tag to combine data sources. For insights that involve user-level ad exposure across tables, use user_id instead. | VERY_HIGH |\n","| seller_id | STRING | DIMENSION | ID of the seller from which the impression event originated. In OpenRTB, this corresponds to publisher.id. Format will vary. | LOW |\n","| seller_name | STRING | DIMENSION | Name of the seller from which the impression event originated. | LOW |\n","| site | STRING | DIMENSION | The site descriptor where the Amazon DSP impression event occurred. A site can be any digital property where ads are served, including websites, mobile apps, and streaming platforms. Note that different types of environments may have different formatting. For example, 'widgets.com' for a web property, 'Widgets iOS (ID: 1234567890)' for an app property. | LOW |\n","| slot_position | STRING | DIMENSION | Position of the ad on the page relative to the initial viewport. Above the fold (ATF) refers to the portion of the webpage visible without scrolling, while below the fold (BTF) refers to the portion that requires scrolling to view. This dimension helps measure where ad impressions were served on the page. Possible values include: ATF, BTF, and UNKNOWN. | LOW |\n","| supply_cost | LONG | METRIC | The cost (in microcents) that Amazon DSP pays a publisher or publisher ad tech platform (such as an SSP or exchange) for an impression. To convert supply_cost to dollars/your local currency, divide by 100,000,000 (for example, 100,000,000 microcents = $1.00). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '5000'. | NONE |\n","| supply_source | STRING | DIMENSION | Supply source from which the Amazon DSP impression was purchased. Supply sources can include Amazon-owned properties (like Amazon.com and Twitch), Amazon Publisher Services inventory, and third-party partners. Example values: 'AMAZON.COM', 'TWITCH WEB VIDEO', 'PUBMATIC WEB DISPLAY'. | LOW |\n","| supply_source_id | LONG | DIMENSION | ID of the supply source from which the Amazon DSP impression was purchased. Supply sources can include Amazon-owned properties (like Amazon.com and Twitch), Amazon Publisher Services inventory, and third-party partners. | LOW |\n","| user_id | STRING | DIMENSION | Pseudonymous identifier that connects user activity across different events. The field can contain ad user IDs (representing Amazon accounts), device IDs, or browser IDs. NULL values appear when Amazon Ads is unable to resolve an identifier for an event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT user_id). | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID value. AMC includes different types of user ID values, depending on whether the value represents a resolved Amazon account, a device, or a browser cookie. If Amazon Ads is unable to determine or provide an ID of any kind for a click event, the user_id and user_id_type values for that record will be NULL. Possible values include: adUserId, sisDeviceId, adBrowserId, and NULL. | LOW |\n"],"documentType":"guide"},{"title":"Amazon DSP views table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/dsp_views","content":[" Analytics table: \n","dsp_views\n"," Audience table: \n","dsp_views_for_audiences\n"," This table represents all view events and all measurable events. Measurable events are from impression that were able to be measured. Viewable events represent events that met a viewable standard. The metric viewable_impressions is the count of viewable impressions using the IAB standard (50% of the pixels of the impression were on screen for at least 1 second). Note the dsp_views table records a single impression more than one time if it is both measurable and viewable according to IAB standards. An impression that is both measurable and viewable according to IAB standards is recorded in one row as a measurable event and in another row as a viewable event. Note that while all impression events from dsp_views are recorded in dsp_impressions, not all impression events from dsp_impressions are recorded in dsp_views because not all impression events can be categorized as viewable, measurable or unmeasurable.\n","| Name | Data type | Metric/dimension | Description | Aggregation threshold |\n","\\|--------------------------------------------\\|-------------\\|------------------\\|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|-----------------------\\|\n","| ad_slot_size | STRING | DIMENSION | Ad slot size in which the Amazon DSP ad was served, expressed as width x height in pixels. The dimensions indicate the space allocated for the ad on the page or app where the impression was served. Example values: '300x250', '728x90', '320x50'. | LOW |\n","| advertiser | STRING | DIMENSION | Name of the business entity running advertising campaigns on Amazon DSP. Example value: 'Widgets Inc'. | LOW |\n","| advertiser_account_frequency_group_ids | ArrayLONG | DIMENSION | An array of the advertiser-account-level frequency group IDs that were applicable for this impression event. Frequency groups created at the advertiser account level may operate across 1 or more campaigns within that advertiser account. Note that a single impression may be subject to multiple frequency groups. | LOW |\n","| advertiser_id | LONG | DIMENSION | ID of the Amazon DSP advertiser associated with the view event. Example value: '123456789012345'. | LOW |\n","| advertiser_timezone | STRING | DIMENSION | Advertiser timezone. This setting aligns with the advertiser timezone configuration in the connected Amazon DSP account. Example value: 'America/New_York'. | LOW |\n","| app_bundle | STRING | DIMENSION | The app bundle ID associated with the Amazon DSP view event. App bundles follow different formatting conventions depending on the app store. | LOW |\n","| campaign | STRING | DIMENSION | Name of the Amazon DSP campaign responsible for the view event. A campaign is a container that groups related advertising efforts with shared objectives, budget, and flight dates. Example value: 'Widgets_Q1_2024_Awareness_Display_US'. | LOW |\n","| campaign_country | STRING | DIMENSION | Country of the Amazon DSP campaign. This value is based on the country setting configured at campaign level. Example value: 'US'. | LOW |\n","| campaign_end_dt | TIMESTAMP | DIMENSION | End date and time of the Amazon DSP campaign in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_end_dt_utc | TIMESTAMP | DIMENSION | End date of the Amazon DSP campaign in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_flight_budget_amount | LONG | METRIC | The total budget allocated to the flight, stored in millicents. To convert to dollars/local currency, divide by 100,000 (e.g., 100,000 millicents = $1.00). Refer to the currency_name field for the campaign budget currency. Example value: 100000000. | LOW |\n","| campaign_flight_end_date_utc | TIMESTAMP | DIMENSION | End date and time of the flight in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_flight_id | LONG | DIMENSION | ID of the Amazon DSP flight responsible for the traffic event. A flight is a scheduled period of time when a campaign is active. Campaigns can include multiple flights to support different budget and optimization settings. Example value: '123456789012345'. | LOW |\n","| campaign_flight_name | STRING | DIMENSION | Name of the flight responsible for the traffic event. A flight is a scheduled period of time when a campaign is active. Campaigns can include multiple flights to support different budget and optimization settings. Example value: 'Widgets_Q1_2024_Keywords_US'. | LOW |\n","| campaign_flight_start_date_utc | TIMESTAMP | DIMENSION | Start date and time of the flight in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_id | LONG | DIMENSION | The ID of the Amazon DSP campaign responsible for the view event. In this table, campaign_id and campaign_id_string fields will show the same value for a given event. Example value: '571234567890123456'. | LOW |\n","| campaign_id_string | STRING | DIMENSION | The ID of the Amazon DSP campaign responsible for the view event. In this table, campaign_id and campaign_id_string fields will show the same value for a given event. Example value: '571234567890123456'. | LOW |\n","| campaign_insertion_order_id | STRING | DIMENSION | ID of the insertion order associated with the Amazon DSP view event. An insertion order is a contractual agreement between an advertiser and Amazon Ads that outlines the specific details of a programmatic advertising campaign. Example value: '123456789'. | LOW |\n","| campaign_primary_goal | STRING | DIMENSION | Primary goal set for campaign optimization in Amazon DSP. Campaign goals determine how Amazon DSP optimizes delivery and measures success of the campaign. The goal selected during campaign setup influences bidding strategy and campaign optimization. Possible values include: ROAS, TOTAL_ROAS, REACH, CPVC, COMPLETION_RATE, CTR, CPC, DPVR, PAGE_VISIT, CPDPV, CPA, OTHER, and NONE. | LOW |\n","| campaign_sales_type | STRING | DIMENSION | Billing classification of the Amazon DSP campaign, which distinguishes billable and non-billable campaigns. Possible values include: BILLABLE and BONUS. | LOW |\n","| campaign_source | STRING | DIMENSION | Campaign source. | LOW |\n","| campaign_start_dt | TIMESTAMP | DIMENSION | Start date and time of the Amazon DSP campaign in advertiser timezone. The campaign start date determines when a campaign begins serving impressions. Example value: '2025-01-01T00:00:00.000Z'. | LOW |\n","| campaign_start_dt_utc | TIMESTAMP | DIMENSION | Start date and time of the Amazon DSP campaign in Coordinated Universal Time (UTC). The campaign start date determines when a campaign begins serving impressions. Example value: '2025-01-01T00:00:00.000Z'. | LOW |\n","| campaign_status | STRING | DIMENSION | Current status of the Amazon DSP campaign. Campaign status indicates whether a campaign is actively delivering ads, has completed its flight dates, or has been paused by the advertiser. Possible values include: ENDED, RUNNING, ENABLED, PAUSED, and ADS_NOT_RUNNING. | LOW |\n","| city_name | STRING | DIMENSION | City name where the Amazon DSP view event occurred, determined by signal available in the auction event. Example value: 'New York'. | HIGH |\n","| creative | STRING | DIMENSION | Name of the Amazon DSP creative/ad. A creative represents the actual advertisement shown to customers. Example value: '2025_US_Widgets_Spring_Mobile_320x50'. | LOW |\n","| creative_category | STRING | DIMENSION | Category of the Amazon DSP creative/ad. This field categorizes Amazon DSP ads into broad creative format types like display ads and video ads. Possible values include: Display, Video, and NULL. | LOW |\n","| creative_duration | LONG | DIMENSION | Duration in seconds of the Amazon DSP creative asset, primarily used for video format ads. This field specifies the length of video creative assets delivered through Amazon DSP campaigns. For non-video creative formats like display ads, this field will be NULL. Example values include: '15', '30', '60', representing video durations in seconds. | LOW |\n","| creative_id | LONG | DIMENSION | Unique identifier for the Amazon DSP creative/ad. An ad represents the actual advertisement shown to customers, which could be an image, video, or other ad format. Example value: '591234567890123456'. | LOW |\n","| creative_is_link_in | STRING | DIMENSION | Boolean field indicating whether the Amazon DSP creative/ad directs to an Amazon destination (link in) versus an external destination (link out). A link in creative directs users to an Amazon destination like a product detail page, while a link out creative directs users to an external destination like the website of the advertiser. Possible values for this field are: Y (creative is link in), N (creative is link out). | LOW |\n","| creative_size | STRING | DIMENSION | Dimensions of the Amazon DSP creative/ad (width x height in pixels, or responsive format). Example values: '300x250', '320x50', 'Responsive'. | LOW |\n","| creative_type | STRING | DIMENSION | Type of ad. Example values: 'Streaming TV Video', 'Standard Display', 'Audio', 'Responsive eCommerce', 'Digital Signage'. | LOW |\n","| demand_channel_owner | STRING | DIMENSION | Demand channel owner. | LOW |\n","| device_make | STRING | DIMENSION | Manufacturer or brand name of the device associated with the Amazon DSP view event, derived from user-agent in the impression auction. Values may appear in different formats or capitalizations for the same manufacturer. Example values: 'Apple', 'APPLE', 'Samsung', 'SAMSUNG', 'ROKU', 'Generic', 'UNKNOWN'. | LOW |\n","| device_model | STRING | DIMENSION | Model of the device associated with the Amazon DSP view event, derived from user-agent in the impression auction. Values may appear in different formats or capitalizations for the same manufacturer. Example values: 'iPhone', 'GALAXY'. | LOW |\n","| entity_id | STRING | DIMENSION | ID of the Amazon DSP entity (also known as seat) associated with the view event. An entity represents an Amazon DSP account, within which media is further organized by advertiser and by campaign. Example value: 'ENTITYABC123XYZ789'. | LOW |\n","| environment_type | STRING | DIMENSION | Environment where the Amazon DSP view event occurred. This field distinguishes between web-based environments like desktop or mobile browsers, and app-based environments like mobile apps. If the environment type cannot be determined, this field will be NULL. Possible values include: Web, App, and NULL. | LOW |\n","| household_id | STRING | DIMENSION | Pseudonymous household ID for the user at the time of the traffic event. The same user may have different IDs across events if the user moves households. NULL when Amazon Ads cannot resolve the user or household. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT household_id). Data is available from April 10, 2026 onward, with household ID coverage varying by region. | VERY_HIGH |\n","| household_size | STRING | DIMENSION | Size of the household. Possible values for this field are: NULL, '1', '2', '3', and '4+'. | HIGH |\n","| event_date | DATE | DIMENSION | Date of the Amazon DSP view event in advertiser timezone. This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01'. | LOW |\n","| event_date_utc | DATE | DIMENSION | Date of the Amazon DSP view event in Coordinated Universal Time (UTC). This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01' | LOW |\n","| event_dt | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP view event in advertiser timezone. This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01T12:00:00.000Z'. | MEDIUM |\n","| event_dt_hour | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP view event in advertiser timezone, truncated to hour. This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01T12:00:00.000Z'. | LOW |\n","| event_dt_hour_utc | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP view event in Coordinated Universal Time (UTC), truncated to hour. This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01T12:00:00.000Z'. | LOW |\n","| event_dt_utc | TIMESTAMP | DIMENSION | Timestamp of the Amazon DSP view event in Coordinated Universal Time (UTC). This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01T00:00:00.000Z'. | MEDIUM |\n","| event_type | STRING | DIMENSION | Type of view event. There are four types of view events in AMC. Measurable impression events indicate that the Amazon Ads impression was able to be measured for viewability; these events can be summed using the measurable_impressions metric. Viewable impression events indicate Amazon Ads determined the impression met MRC viewability standards; these events can be summed using the viewable_impressions metric. Unmeasurable viewable and synthetic viewable impression events are estimated to be viewable; these events can be summed using the unmeasurable_viewable_impressions metric. Possible values include: MEASURABLE_IMP (measurable impression), VIEW (viewable impression), UNMEASURABLE_IMP (unmeasurable viewable impression), and SYNTHETIC_VIEW (synthetic view impression). | LOW |\n","| events | LONG | METRIC | Count of Amazon DSP view events. When querying this table, remember that each record represents one Amazon DSP view event, and a single impression may have more than one view event. Therefore, this field will not represent the exact count of impressions served by your campaigns. Since this table only includes views events, this field will always have a value of '1' (the event was a view event). | NONE |\n","| impression_id | STRING | DIMENSION | ID that connects related impression, view, click, and conversion events. For example, if an impression served has a request_tag value of 'X', related view events will have an impression_id value of 'X'. All view events for a single impression will share a common impression_id value. While this occurs infrequently, there are sometimes duplicate request_tag values. As a result, it is not recommended to use request_tag as a JOIN key without first grouping by it. Rather, it is a best practice to first consider using UNION ALL in a query instead of joining based on the request_tag to combine data sources. For insights that involve user-level ad exposure across tables, use user_id instead. | VERY_HIGH |\n","| ip_address | STRING | DIMENSION | Pseudonymous identifier that represents the IP address received for an ad event. The field can contain either IPv4 or IPv6 values. NULL values appear when Amazon Ads does not receive an IP address for the event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes such as COUNT(DISTINCT ip_address). | VERY_HIGH |\n","| line_item | STRING | DIMENSION | Name of the Amazon DSP line item responsible for the view event. Attributes like ad format and targeting are defined at line item level within a campaign. Example value: 'Widgets - DISPLAY - O&O - RETARGETING'. | LOW |\n","| line_item_end_dt | TIMESTAMP | DIMENSION | End date and time of the Amazon DSP line item in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_end_dt_utc | TIMESTAMP | DIMENSION | End date and time of the Amazon DSP line item in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_id | LONG | DIMENSION | ID of the Amazon DSP line item responsible for the view event. Attributes like ad format and targeting are defined at line item level within a campaign. Example value: '5812345678901234'. | LOW |\n","| line_item_price_type | STRING | DIMENSION | Pricing model used for the Amazon DSP line item. Line items can use different pricing models to determine how costs are calculated, with Cost Per Mille (CPM) being a common model where advertisers pay per thousand impressions. Example value: 'CPM'. | LOW |\n","| line_item_start_dt | TIMESTAMP | DIMENSION | Start date and time of the Amazon DSP line item in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_start_dt_utc | TIMESTAMP | DIMENSION | Start date and time of the Amazon DSP line item in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_status | STRING | DIMENSION | Status of the Amazon DSP line item. The status indicates whether the line item is actively delivering ads, has been paused, or has completed its flight. Possible values include: ENDED, ENABLED, RUNNING, PAUSED_BY_USER, and SUSPENDED. | LOW |\n","| line_item_type | STRING | DIMENSION | Type of Amazon DSP line item. Line item types indicate how ads are delivered and optimized. Example values include: AAP, AAP_DISPLAY, AAP_MOBILE, AAP_VIDEO_CPM. | LOW |\n","| manager_account_frequency_group_ids | ArrayLONG | DIMENSION | An array of the manager-account-level frequency group IDs that were applicable for this impression event. Frequency groups created at the manager account level may operate across 1 or more advertisers within that manager account. Note that a single impression may be subject to multiple frequency groups. | LOW |\n","| measurable_impressions | LONG | METRIC | Count of impressions that could be measured for viewability. Measurable impression events indicate that the Amazon Ads impression was able to be measured for viewability. A single impression that is measurable could also be viewable, but not all measurable impressions are viewable. If an impression is both measurable and viewable, each event for the single impression is listed as a separate row. Possible values for this field are: '1' (if the record represents a measurable impression) or '0' (if the record does not represent a measurable impression). | NONE |\n","| merchant_id | LONG | DIMENSION | Merchant ID. | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Boolean value indicating whether the event can be used for audience creation that is third-party tracking enabled (i.e. whether you can serve creative with third-party tracking when running media against the audience). Third-party tracking refers to measurement tags and pixels from external vendors that can be used to measure ad performance. Possible values for this field are: 'true', 'false'. | NONE |\n","| operating_system | STRING | DIMENSION | Operating system of the device where the Amazon DSP view event occurred. Example values: 'iOS', 'Android', 'Windows', 'macOS', 'Roku OS'. | LOW |\n","| os_version | STRING | DIMENSION | Operating system version of the device where the Amazon DSP view event occurred. The version format varies by operating system type. Example value: '17.5.1'. | LOW |\n","| page_type | STRING | DIMENSION | Type of page where the Amazon DSP view event occurred. This grain of detail is primarily relevant to impressions served on Amazon sites. Example values: 'Search', 'Detail', 'CustomerReviews'. | LOW |\n","| publisher_name | STRING | DIMENSION | Name of the publisher on which the impression event was shown. | LOW |\n","| seller_id | STRING | DIMENSION | ID of the seller from which the impression event originated. In OpenRTB, this corresponds to publisher.id. Format will vary. | LOW |\n","| seller_name | STRING | DIMENSION | Name of the seller from which the impression event originated. | LOW |\n","| site | STRING | DIMENSION | The site descriptor where the Amazon DSP impression event occurred. A site can be any digital property where ads are served, including websites, mobile apps, and streaming platforms. Note that different types of environments may have different formatting. For example, 'widgets.com' for a web property, 'Widgets iOS (ID: 1234567890)' for an app property. | LOW |\n","| slot_position | STRING | DIMENSION | Position of the ad on the page relative to the initial viewport. Above the fold (ATF) refers to the portion of the webpage visible without scrolling, while below the fold (BTF) refers to the portion that requires scrolling to view. This dimension helps measure where ad impressions were served on the page. Possible values include: ATF, BTF, and UNKNOWN. | LOW |\n","| supply_source_id | LONG | DIMENSION | ID of the supply source from which the Amazon DSP impression was purchased. Supply sources can include Amazon-owned properties (like Amazon.com and Twitch), Amazon Publisher Services inventory, and third-party partners. | LOW |\n","| unmeasurable_viewable_impressions | LONG | METRIC | Count of unmeasurable viewable/synthetic view events. Unmeasurable viewable and synthetic viewable events are estimated to be viewable, but could not be measured for viewability. Possible values for this field are: '1' (if the record represents an unmeasurable viewable/synthetic view event) or '0' (if the record does not represent an unmeasurable viewable/synthetic view event). | NONE |\n","| user_id | STRING | DIMENSION | Pseudonymous identifier that connects user activity across different events. The field can contain ad user IDs (representing Amazon accounts), device IDs, or browser IDs. NULL values appear when Amazon Ads is unable to resolve an identifier for an event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT user_id). | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID value. AMC includes different types of user ID values, depending on whether the value represents a resolved Amazon account, a device, or a browser cookie. If Amazon Ads is unable to determine or provide an ID of any kind for a view event, the user_id and user_id_type values for that record will be NULL. Possible values include: adUserId, sisDeviceId, adBrowserId, and NULL. | LOW |\n","| view_definition | STRING | DIMENSION | Type of viewability measurement definition used to classify the view event. This field will only be populated for viewable impressions (event_type = VIEW). | LOW |\n","| viewable_impressions | LONG | METRIC | The count of impressions that were considered viewable. An impression is considered viewable when at least 50% of the pixels of the ad are in view for at least one continuous second for display ads, or two continuous seconds for video ads. This is the Media Rating Council (MRC) definition of viewability. Note that a single impression that is viewable has two events: a viewable impression and a measurable impression. Each event for the single impression is listed as a separate row. Possible values for this field are: '1' (if the record represents a viewable impression) or '0' (if the record does not represent a viewable impression). | NONE |\n"],"documentType":"guide"},{"title":"Amazon DSP impressions by segments table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/dsp_impressions_by_segments","content":[" Analytics table: \n","dsp_impressions_by_matched_segments\n","dsp_impressions_by_user_segments\n"," Audience table: \n","dsp_impressions_by_matched_segments_for_audiences\n","dsp_impressions_by_user_segments_for_audiences\n"," These two tables have exactly the same basic structure as the dsp_impressions table but in addition to that they provide segment level information for each of the segments that was either targeted by the ad or included the user that received the impression. This means that each impression appears multiple times in these tables. dsp_impressions_by_matched_segments shows only the segments that included the user and were targeted by the ad at the time of the impression. dsp_impressions_by_user_segments shows all segments that include the user, behavior_segment_matched is set to 1 if the segment was targeted by the ad.\n"," The following table shows columns in addition to the ones listed for dsp_impressions.\n"," The reference here shows only columns in addition to the ones listed for dsp_impressions.\n"],"documentType":"guide"},{"title":"Amazon DSP impressions by segments table","sectionHeader":{"type":2,"text":"dsp\\_impressions\\_by\\_matched\\_segments"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/dsp_impressions_by_segments","content":["| Name | Data type | Metric/dimension | Description | Aggregation threshold |\n","\\|--------------------------------\\|-----------\\|------------------\\|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|-----------------------\\|\n","| behavior_segment_description | STRING | DIMENSION | Description of the audience segment, for segments both targeted by the Amazon DSP line item and matched to the user at the time of impression. This field contains explanations of the characteristics that define each segment, such as shopping behaviors, demographics, and interests. | LOW |\n","| behavior_segment_id | INTEGER | DIMENSION | Unique identifier for the audience segment, for segments both targeted by the Amazon DSP line item and matched to the user at the time of impression. Example value: 123456. | LOW |\n","| behavior_segment_matched | LONG | METRIC | Indicator of whether the behavior segment was targeted by the Amazon DSP line item and matched to the user at the time of impression. Since this table includes matched segments only, this field will always have a value of 1 (the segment was targeted and matched to the user). | NONE |\n","| behavior_segment_name | STRING | DIMENSION | Name of the audience segment, for segments both targeted by the Amazon DSP line item and matched to the user at the time of impression. | LOW |\n"],"documentType":"guide"},{"title":"Amazon DSP impressions by segments table","sectionHeader":{"type":2,"text":"dsp\\_impressions\\_by\\_user\\_segments"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/dsp_impressions_by_segments","content":["| Name | Data type | Metric/dimension | Description | Aggregation threshold |\n","\\|--------------------------------\\|-----------\\|------------------\\|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|-----------------------\\|\n","| behavior_segment_description | STRING | DIMENSION | Description of the audience segment, for segments that the user belonged to at the time of impression. This field contains explanations of the characteristics that define each segment, such as shopping behaviors, demographics, and interests. | LOW |\n","| behavior_segment_id | INTEGER | DIMENSION | Unique identifier for the audience segment, for segments that the user belonged to at the time of impression. Example value: 123456. | LOW |\n","| behavior_segment_matched | LONG | METRIC | Indicator of whether the behavior segment was targeted by the Amazon DSP line item and matched to the user at the time of impression. Possible values for this field are: 1 (the segment was targeted and matched to the user) or 0 (the user belonged to the segment, but the segment was not targeted). | NONE |\n","| behavior_segment_name | STRING | DIMENSION | Name of the audience segment, for segments that the user belonged to at the time of impression. | LOW |\n"],"documentType":"guide"},{"title":"Amazon DSP video events table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/dsp_video_events_feed","content":[" Analytics table: \n","dsp_video_events_feed\n"," Audience table: \n","dsp_video_events_feed_for_audiences\n"," This table has the exact same basic structure as dsp_impressions table but in addition to that, the table provides video metrics for each of the video creative events triggered by the video player and associated with the impression event.\n"," The following table shows columns in addition to the ones listed for dsp_impressions.\n","| Field                | Data type | Metric / dimension | Definition                                                                                                                                                                                                                                                                                                                               | Aggregation threshold |\n","\\| -------------------- \\| --------- \\| ------------------ \\| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| --------------------- \\|\n","| video_click          | LONG      | Metric             | The number of Amazon DSP video clicks. Possible values for this field are: 1 (if the video was viewed to completion) or 0 (if the video was not viewed to completion). This field will always be 0 for non-video impressions.                                                                                                      | NONE                  |\n","| video_complete       | LONG      | Metric             | The number of Amazon DSP video impressions where the video was viewed to completion (100%). Possible values for this field are: 1 (if the video was viewed to completion) or 0 (if the video was not viewed to completion). This field will always be 0 for non-video impressions.                                                 | NONE                  |\n","| video_creative_view  | LONG      | Metric             | The number of Amazon DSP video impressions where an additional ad element, such as the video companion ad or VPAID overlay, was viewed. Possible values for this field are: 1 (if the additional ad element was viewed) or 0 (if the additional ad element was not viewed). This field will always be 0 for non-video impressions. | NONE                  |\n","| video_first_quartile | LONG      | Metric             | The number of Amazon DSP video impressions where the video was viewed to the first quartile (at least 25% completion). Possible values for this field are: 1 (if the video was viewed to at least 25% completion) or 0 (if the video was not viewed to 25% completion). This field will always be 0 for non-video impressions.     | NONE                  |\n","| video_impression     | LONG      | Metric             | The number of Amazon DSP video impressions where the first frame of the ad was shown. Possible values for this field are: 1 (if the first frame of the video was shown) or 0 (if the first frame of the video was not shown). This field will always be 0 for non-video impressions.                                               | NONE                  |\n","| video_midpoint       | LONG      | Metric             | The number of Amazon DSP video impressions where the video was viewed to the midpoint (at least 50% completion). Possible values for this field are: 1 (if the video was viewed to at least 50% completion) or 0 (if the video was not viewed to 50% completion). This field will always be 0 for non-video impressions.           | NONE                  |\n","| video_mute           | LONG      | Metric             | The number of Amazon DSP video mutes. Possible values for this field are: 1 (if the user muted the video) or 0 (if the user did not mute the video). This field will always be 0 for non-video impressions.                                                                                                                        | NONE                  |\n","| video_pause          | LONG      | Metric             | The number of Amazon DSP video pauses. Possible values for this field are: 1 (if the user paused the video) or 0 (if the user did not pause the video). This field will always be 0 for non-video impressions.                                                                                                                     | NONE                  |\n","| video_replay         | LONG      | Metric             | The number of Amazon DSP video impressions where the ad was replayed again after it completed. Possible values for this field are: 1 (if the user replayed the video after completion) or 0 (if the video was not replayed after completion). This field will always be 0 for non-video impressions.                                   | NONE                  |\n","| video_resume         | LONG      | Metric             | The number of Amazon DSP video impressions where the video was resumed after a pause. Possible values for this field are: 1 (if the video was resumed after a pause) or 0 (if the video was not resumed after a pause). This field will always be 0 for non-video impressions.                                                         | NONE                  |\n","| video_skip_backward  | LONG      | Metric             | The number of Amazon DSP video impressions that had backward skips. Possible values for this field are: 1 (if the user skipped the video backward) or 0 (if the user did not skip the video backward). This field will always be 0 for non-video impressions.                                                                      | NONE                  |\n","| video_skip_forward   | LONG      | Metric             | The number of Amazon DSP video impressions that had forward skips. Possible values for this field are: 1 (if the user skipped the video forward) or 0 (if the user did not skip the video forward). This field will always be 0 for non-video impressions.                                                                         | NONE                  |\n","| video_start          | LONG      | Metric             | The number of Amazon DSP video impression starts. Possible values for this field are: 1 (if the user started the video) or 0 (if the user did not start the video). This field will always be 0 for non-video impressions.                                                                                                         | NONE                  |\n","| video_third_quartile | LONG      | Metric             | The number of Amazon DSP video impressions where the video was viewed to the third quartile (at least 75% completion). Possible values for this field are: 1 (if the video was viewed to at least 75% completion) or 0 (if the video was not viewed to 75% completion). This field will always be 0 for non-video impressions.     | NONE                  |\n","| video_unmute         | LONG      | Metric             | The number of Amazon DSP video unmutes. Possible values for this field are: 1 (if the video was unmuted) or 0 (if the video was not unmuted). This field will always be 0 for non-video impressions.                                                                                                                               | NONE                  \n"],"documentType":"guide"},{"title":"Conversions table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/conversions","content":[" Analytics table: \n","conversions\n"," Audience table: \n","conversions_for_audiences\n"," The conversions table contains AMC conversion events. Ad-attributed conversions for ASINs tracked to an Amazon DSP or sponsored ads campaigns and pixel conversions are included. Conversions are ad-attributed if a user was served a traffic event within the 28-day period prior to the conversion event.\n","| Name | Data type | Metric/dimension | Description | Aggregation threshold |\n","\\|------\\|-----------\\|-----------------\\|-------------\\|---------------------\\|\n","| combined_sales | DECIMAL(38,4) | METRIC | Sum of total_product_sales + off_Amazon_product_sales | NONE |\n","| conversion_event_name | STRING | DIMENSION | The name of the conversion definition of the advertiser. | LOW |\n","| conversion_event_source_name | STRING | DIMENSION | The source of the advertiser-provided conversion data. | LOW |\n","| conversion_id | STRING | DIMENSION | Unique identifier of the conversion event. In the conversions table, each row has a unique conversion_id value. | VERY_HIGH |\n","| conversions | LONG | METRIC | The count of conversion events. This field always contains a value of 1, allowing you to calculate conversion totals for the records selected in your query. Conversion events can include on-Amazon activities like purchases and detail page views, as well as off-Amazon events measured through Events Manager. Possible values for this field are: 1 (the record represents a conversion event). | NONE |\n","| event_category | STRING | DIMENSION | High-level category of the conversion event. For ASIN conversions, this categorizes whether the event was a purchase or website browsing interaction. Website events include activities like detail page views, add to wishlist actions, and first Subscribe and Save orders. For conversions measured through Events Manager, this field is always off-Amazon. Possible values include: purchase, website, and off-Amazon. | LOW |\n","| event_date_utc | DATE | DIMENSION | Date of the conversion event in Coordinated Universal Time (UTC) timezone. Example value: 2025-01-01. | LOW |\n","| event_day_utc | INTEGER | DIMENSION | Day of month when the conversion event occurred in Coordinated Universal Time (UTC). Example value: 1. | LOW |\n","| event_dt_hour_utc | TIMESTAMP | DIMENSION | Timestamp of the conversion event in Coordinated Universal Time (UTC) truncated to hour. Example value: 2025-01-01T00:00:00.000Z. | LOW |\n","| event_dt_utc | TIMESTAMP | DIMENSION | Timestamp of the conversion event in Coordinated Universal Time (UTC). Example value: 2025-01-01T00:00:00.000Z. | MEDIUM |\n","| event_hour_utc | INTEGER | DIMENSION | Hour of the day (0-23) when the conversion event occurred in Coordinated Universal Time (UTC) timezone. Example value: 0. | LOW |\n","| event_subtype | STRING | DIMENSION | Subtype of the conversion event. This field provides additional detail about the subtype of conversion event that occurred, such as whether it represents viewing a product detail page on Amazon.com or completing a purchase on an advertiser website. For on-Amazon conversion events, this field contains human-readable values, while off-Amazon events measured via Events Manager are represented by numeric values. Possible values include: detailPageView, shoppingCart, order, searchConversion, brandStorePageView, wishList, babyRegistry, weddingRegistry, customerReview for on-Amazon events, and numeric values like 134, 140, 141 for off-Amazon events. For more information on off-Amazon conversion event subtypes, refer to the \"Introduction to Events Manager\" entry in the IQL. | LOW |\n","| event_type | STRING | DIMENSION | Type of conversion event. Conversion events in AMC can include both on-Amazon events (like purchases and detail page views) and off-Amazon events (like website visits and app installs measured through Events Manager). This field will always have a value of CONVERSION. | LOW |\n","| event_type_class | STRING | DIMENSION | Classification of conversion events based on customer behavior. This field categorizes conversion events into consideration events (like detail page views) versus actual conversion events (like purchases). Possible values include: consideration, conversion, and NULL. | LOW |\n","| event_type_description | STRING | DIMENSION | Human-readable description of the conversion event type. Conversion events can occur on Amazon (like product purchases or detail page views) or off Amazon (like brand site page views or in-store transactions measured via Events Manager). Example values: 'Product purchased', 'Add to Shopping Cart', 'Product detail page viewed'. | LOW |\n","| ip_address | STRING | DIMENSION | Pseudonymous identifier that represents the IP address received for an ad event. The field can contain either IPv4 or IPv6 values. NULL values appear when Amazon Ads does not receive an IP address for the event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes such as COUNT(DISTINCT ip_address). | VERY_HIGH |\n","| marketplace_name | STRING | DIMENSION | Name of the marketplace where the conversion event occurred. A marketplace can be an online shopping site (like Amazon.com) or a physical retail location (like Amazon Fresh stores). This field helps distinguish between conversions that happen on different Amazon online marketplaces versus those that occur in Amazon physical retail locations. Example values include: AMAZON.COM, AMAZON.CO.UK, WHOLE_FOODS_MARKET_US, and AMAZON_FRESH_STORES_US. | LOW |\n","| new_to_brand | BOOLEAN | DIMENSION | Boolean value indicating whether the customer associated with a purchase event is new-to-brand. A customer is considered new-to-brand if they have not purchased from the brand in the previous 12 months. This field is only applicable for purchase events. Possible values for this field are: true, false. | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Boolean value indicating whether the event can be used for audience creation that is third-party tracking enabled (i.e. whether you can serve creative with third-party tracking when running media against the audience). Third-party tracking refers to measurement tags and pixels from external vendors that can be used to measure ad performance. Possible values for this field are: true, false. | NONE |\n","| off_amazon_conversion_value | DECIMAL(38,4) | METRIC | Non monetary \"value\" of conversion for non-purchase conversions | NONE |\n","| off_amazon_product_sales | DECIMAL(38,4) | METRIC | \"Value\" of purchase conversions provided via Conversion Builder | NONE |\n","| purchase_currency | STRING | DIMENSION | ISO currency code of the purchase. Currency codes follow the ISO 4217 standard for representing currencies (for example USD for US Dollar). Example value: USD. | LOW |\n","| purchase_retail_program | STRING | DIMENSION | Retail program through which the on-Amazon purchase event occurred, including online and in-store purchases through Amazon.com, Whole Foods Market, and Amazon Fresh. Possible values include: Amazon.com, Amazon Fresh, and Whole Foods Market. | LOW |\n","| purchase_unit_price | DECIMAL(38,4) | METRIC | The unit price of the product sold for on-Amazon purchase events, in local currency. This field represents the price per individual unit, not the total purchase price which may include multiple units. Example value: 29.99. | NONE |\n","| total_product_sales | DECIMAL(38,4) | METRIC | Product sales (in local currency) for on-Amazon purchase events. Example value: 12.99. | NONE |\n","| total_units_sold | LONG | METRIC | Units sold for on-Amazon purchase events. Example value: 3. | NONE |\n","| tracked_asin | STRING | DIMENSION | The ASIN of the conversion event. An ASIN (Amazon Standard Identification Number) is a unique 10-character identifier assigned to products sold on Amazon. ASINs that appear in this field were either directly promoted by the campaign or are products from the same brand as the promoted ASINs. This field will only be for on-Amazon purchases (event_category = purchase); for other conversion types, this field will be NULL. When this field is populated, tracked_item will have the same value. Example value: B01234ABCD. | LOW |\n","| tracked_item | STRING | DIMENSION | Identifier for the conversion event item. The value in this field depends on the subtype of the conversion event. For ASIN-related conversions on Amazon such as purchases, detail page views, add to cart events, this field will contain the ASIN of the product. For brand store events, this field will contain the brand store ID. For branded search conversions on Amazon, this field will contain the ad-attributed branded search keyword. For off-Amazon conversions, this field will contain the ID of the conversion definition. Note that when tracked_asin is populated, the same value will appear in tracked_item. | LOW |\n","| user_id | STRING | DIMENSION | Pseudonymous identifier that connects user activity across different events. The field can contain ad user IDs (representing Amazon accounts), device IDs, or browser IDs. NULL values appear when Amazon Ads is unable to resolve an identifier for an event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT user_id). | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID value. AMC includes different types of user ID values, depending on whether the value represents a resolved Amazon account, a device, or a browser cookie. If Amazon Ads is unable to determine or provide an ID of any kind for a conversion event, the user_id and user_id_type values for that record will be NULL. Possible values include: adUserId, sisDeviceId, adBrowserId, and NULL. | LOW |\n"],"documentType":"guide"},{"title":"Conversions with relevance table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/conversions_with_relevance","content":[" Analytics table: \n","conversions_with_relevance\n"," Audience table: \n","conversions_with_relevance_for_audiences\n"," The data sources conversions and conversions_with_relevance are used to create custom attribution models both for ASIN conversions (purchases) and pixel conversions.\n"," To improve advertiser experience and simplify the query process, conversions and conversions_with_relevance tables are updated to contain signals related to ad-attributed and pixel conversions only, saving advertisers time and efforts to build dedicated queries to achieve the same outcome by removing non-ad attributed conversions from the tables.\n","| Name | Data type | Metric/dimension | Description | Aggregation threshold |\n","\\|------\\|-----------\\|-----------------\\|-------------\\|----------------------\\|\n","| advertiser | STRING | DIMENSION | Advertiser name | LOW |\n","| advertiser_id | LONG | DIMENSION | Advertiser ID | LOW |\n","| advertiser_timezone | STRING | DIMENSION | Time zone of the advertiser | LOW |\n","| campaign | STRING | DIMENSION | Campaign name | LOW |\n","| campaign_budget_amount | LONG | DIMENSION | Campaign budget amount (millicents) | LOW |\n","| campaign_end_date | DATE | DIMENSION | Campaign end date in the advertiser time zone. | LOW |\n","| campaign_end_date_utc | DATE | DIMENSION | Campaign end date in UTC | LOW |\n","| campaign_end_dt | TIMESTAMP | DIMENSION | Campaign end timestamp in the advertiser time zone. | LOW |\n","| campaign_end_dt_utc | TIMESTAMP | DIMENSION | Campaign end timestamp in UTC | LOW |\n","| campaign_id | LONG | DIMENSION | The campaign ID for Amazon DSP campaigns. For Sponsored Ads campaign IDs, refer to campaign_id_string. Amazon DSP campaign IDs can also be found in campaign_id_string. | LOW |\n","| campaign_id_string | STRING | DIMENSION | The campaign IDs for Amazon DSP and Sponsored Ads campaigns (Recommended over campaign_id column) | LOW |\n","| campaign_sales_type | STRING | DIMENSION | Campaign sales type | LOW |\n","| campaign_source | STRING | DIMENSION | Campaign source | LOW |\n","| campaign_start_date | DATE | DIMENSION | Campaign start date in the advertiser time zone. | LOW |\n","| campaign_start_date_utc | DATE | DIMENSION | Campaign start date in UTC. | LOW |\n","| campaign_start_dt | TIMESTAMP | DIMENSION | Campaign start timestamp in the advertiser time zone. | LOW |\n","| campaign_start_dt_utc | TIMESTAMP | DIMENSION | Campaign start timestamp in UTC. | LOW |\n","| combined_sales | DECIMAL(38,4) | METRIC | Sum of total_product_sales + off_Amazon_product_sales | NONE |\n","| conversion_event_name | STRING | DIMENSION | The name of the conversion definition of the advertiser | LOW |\n","| conversion_event_source_name | STRING | DIMENSION | The source of the advertiser-provided conversion data. | LOW |\n","| conversion_id | STRING | DIMENSION | Unique identifier of the conversion event. In the data set conversions, each row has a unique conversion_id. In the data set conversions_with_relevance, the same conversion event will appear multiple times if a conversion is determined to be relevant to multiple campaigns, engagement scopes, or brand halo types. | VERY_HIGH |\n","| conversions | LONG | METRIC | Conversion count | NONE |\n","| engagement_scope | STRING | DIMENSION | The engagement scope between the campaign setup and the conversion. Possible values for this column are PROMOTED, BRAND_HALO, and NULL. See also the definition for halo_code. The engagement_scope will always be PROMOTED for pixel conversions (when event_category = pixel). | LOW |\n","| event_category | STRING | DIMENSION | For ASIN conversions, the event_category is the high level category of the conversion event, either purchase or website. Examples of ASIN conversions when event_category = website include: detail page views, add to wishlist, or the first Subscribe and Save order. For search conversions (when event_subtype = searchConversion), the event_category is always website. For pixel conversions, this field is always pixel. | LOW |\n","| event_date | DATE | DIMENSION | Date of the conversion event in the advertiser time zone. | LOW |\n","| event_date_utc | DATE | DIMENSION | Date of the conversion event in UTC. | LOW |\n","| event_day | INTEGER | DIMENSION | Day of the month of the conversion event in the advertiser time zone. | LOW |\n","| event_day_utc | INTEGER | DIMENSION | Day of the month of the conversion event in UTC. | LOW |\n","| event_dt | TIMESTAMP | DIMENSION | Timestamp of the conversion event in the advertiser time zone. | MEDIUM |\n","| event_dt_hour | TIMESTAMP | DIMENSION | Timestamp of the conversion event in the advertiser time zone truncated to the hour. | LOW |\n","| event_dt_hour_utc | TIMESTAMP | DIMENSION | Timestamp of the conversion event in UTC truncated to the hour. | LOW |\n","| event_dt_utc | TIMESTAMP | DIMENSION | Timestamp of the conversion event in UTC. | MEDIUM |\n","| event_hour | INTEGER | DIMENSION | Hour of the day of the conversion event in the advertiser time zone. | LOW |\n","| event_hour_utc | INTEGER | DIMENSION | Hour of the day of the conversion event in UTC. | LOW |\n","| event_subtype | STRING | DIMENSION | Subtype of the conversion event. This field provides additional detail about the subtype of conversion event that occurred, such as whether it represents viewing a product detail page on Amazon.com or completing a purchase on an advertiser website. For on-Amazon conversion events, this field contains human-readable values, while off-Amazon events measured via Events Manager are represented by numeric values. Possible values include: detailPageView, shoppingCart, order, searchConversion, brandStorePageView, wishList, babyRegistry, weddingRegistry, customerReview for on-Amazon events, and numeric values like '134', '140', '141' for off-Amazon events. For more information on off-Amazon conversion event subtypes, refer to the \"Introduction to Events Manager\" entry in the IQL. | LOW |\n","| event_type | STRING | DIMENSION | Always CONVERSION in the data sources conversions and conversions_with_relevance. | LOW |\n","| event_type_class | STRING | DIMENSION | For ASIN conversions, the event_type_class is the high level classification of the event type, for example consideration, conversion, etc. This field will be blank for pixel conversions (when event_category = pixel) and search conversions (when event_subtype = searchConversion). | LOW |\n","| event_type_description | STRING | DIMENSION | Human-readable description of the conversion event. For ASIN conversions, examples include: 'add to baby registry', 'Add to Shopping Cart', 'add to wedding registry', 'add to wishlist', 'Customer Reviews Page', 'New SnS Subscription', 'Product detail page viewed', 'Product purchased'. This field will be blank for search conversions (when event_subtype = searchConversion). For pixel conversions (when event_category = pixel), the event_type_description will include additional information about the pixel based on information provided as part of the campaign setup, such as 'Homepage visit', 'Add to Shopping Cart' or 'Brand store engagement 2'. Before using these fields to evaluate pixel conversions, we recommend that you consult with the team that set up the campaign of the advertiser to determine how the event_type_description values for pixel conversions should be interpreted. | LOW |\n","| halo_code | STRING | DIMENSION | The halo code between the campaign and conversion. Possible values for this column are TRACKED_ASIN, VARIATIONAL_ASIN, BRAND_KEYWORD, CATEGORY_KEYWORD, BRAND_MARKETPLACE, BRAND_GL_PRODUCT, BRAND_CATEGORY, BRAND_SUBCATEGORY, and NULL. See also the definition for engagement_scope. The halo_code will be NULL for pixel conversions (when event_category = pixel). | LOW |\n","| ip_address | STRING | DIMENSION | Pseudonymous identifier that represents the IP address received for an ad event. The field can contain either IPv4 or IPv6 values. NULL values appear when Amazon Ads does not receive an IP address for the event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes such as COUNT(DISTINCT ip_address). | VERY_HIGH |\n","| marketplace_name | STRING | DIMENSION | Name of the marketplace where the conversion event occurred. Example values are online marketplaces such as AMAZON.COM, AMAZON.CO.UK. Or in-store marketplaces, such as WHOLE_FOODS_MARKET_US or AMAZON_FRESH_STORES_US. Also, refer to the column purchase_retail_program and search the AMC Instructional Query Library for In Store, Fresh, or Whole Foods to find related queries | LOW |\n","| new_to_brand | BOOLEAN | DIMENSION | True if the user was new to the brand. | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Is this item not allowed to use 3P tracking | NONE |\n","| off_amazon_conversion_value | DECIMAL(38,4) | METRIC | Non monetary \"value\" of conversion for non-purchase conversions | NONE |\n","| off_amazon_product_sales | DECIMAL(38,4) | METRIC | \"Value\" of purchase conversions provided via Conversion Builder | NONE |\n","| purchase_currency | STRING | DIMENSION | ISO currency code of the purchase order. | LOW |\n","| purchase_unit_price | DECIMAL(38,4) | METRIC | Unit price of the product sold. | NONE |\n","| total_product_sales | DECIMAL(38,4) | METRIC | Total sales (in local currency) of promoted ASINs and ASINs from the same brands as promoted ASINs purchased by customers on Amazon. | NONE |\n","| total_units_sold | LONG | METRIC | Total quantity of promoted products and products from the same brand as promoted products purchased by customers on Amazon. A campaign can have multiple units sold in a single purchase event. | NONE |\n","| tracked_asin | STRING | DIMENSION | The dimension tracked_asin is the tracked Amazon Standard Identification Number, which is either the promoted or brand halo ASIN. When the tracked_item results in a purchase conversion, the tracked_asin will be populated in this column, in addition to being tracked in the tracked_item column with the same ASIN value. The tracked_asin is populated only if the event_category = purchase. For the first SnS order and non-purchase conversions, such as detail page views, the ASIN is populated under tracked_item. See also tracked_item. | LOW |\n","| tracked_item | STRING | DIMENSION | Identifier for the conversion event item. The value in this field depends on the subtype of the conversion event. For ASIN-related conversions on Amazon such as purchases, detail page views, add to cart events, this field will contain the ASIN of the product. For brand store events, this field will contain the brand store ID. For branded search conversions on Amazon, this field will contain the ad-attributed branded search keyword. For off-Amazon conversions, this field will contain the ID of the conversion definition. Note that when tracked_asin is populated, the same value will appear in tracked_item. | LOW |\n","| user_id | STRING | DIMENSION | User ID | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID | LOW |\n"],"documentType":"guide"},{"title":"Amazon attributed events by conversion time table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/amazon_attributed_events_by_conversion_time","content":[" Analytics table:\n","amazon_attributed_events_by_conversion_time\n","amazon_attributed_events_by_traffic_time\n"," Audiences table:\n","amazon_attributed_events_by_conversion_time_for_audiences\n","amazon_attributed_events_by_traffic_time_for_audiences\n"," These tables both contain pairs of traffic and conversion events.\n","\"Traffic events\" are impressions and clicks.\n","\"Conversion events\" include purchases, various interactions with Amazon website, such as detailed page views and pixel fires.\n"," Each conversion event in the table is attributed to its corresponding traffic event.\n"," In the amazon_attributed_events_by_conversion_time table, the conversion events all happened within the time window the query is run over, while the traffic events the conversions were attributed to may happen up to 14 days before the time period for the query.\n"," Below are some key elements of the logic that underpins Amazon demand-side platform (Amazon DSP) reporting. Note that this matches the business logic used to assemble the events for the amazon_attributed_events_by_conversion_time table.\n","Amazon DSP reports from the event perspective of the conversion event. The report date range corresponds to the time of conversion event, not time of impression event. Recommendation is to use:amazon_attributed_events_by_conversion_time.\n","Amazon DSP will report out based on advertiser timezone, while AMC lets you customize the time zone that your query date range is applied in (defaults to UTC).\n"," The amazon_attributed_events_by_traffic_time table has the opposite behavior: the traffic events to which the conversion events are attributed all happened within the time window for the query, while the conversion events may have occurred up to 30 days after the time window.\n"," When using the traffic time table, in order to correctly present conversion event details the time range for conversion events is automatically extended by 30 days after the end of the reporting window or the latest time for which conversion events data is available. This means that the output of a workflow that uses this table may change over time.\n"," Note that these windows are not the same thing as an attribution window, as the attribution window is decided based on the campaign and cannot be changed in AMC.\n"," These tables include data from multiple sources if your instance includes advertisers from multiple sources. For example, if you have Display, Sponsored Products, or Sponsored Brands advertisers in the instance, then conversions for both will appear in these tables. Currently, the column ad_product_typeis the main way to filter these conversions, with a value of sponsored_products indicating sponsored products, sponsored_display indicating sponsored display, sponsored_brands indicating sponsored brands, and NULL indicating display. Filtering by campaign is also a viable option because campaigns will likely be unique to a table.\n"," The following keywords and search terms are available to query from the instance creation date (approximately\\*) or 13 months ago, whichever is sooner:\n","Sponsored Products keywords and search terms from sponsored_ads_traffic\n","Sponsored Brands and Sponsored Products keywords and search terms from amazon_attributed_events_by_traffic_timeand amazon_attributed_events_by_conversion_time\n"," Please note that the exact dates will vary, depending on when the backfill period begins. Most instances that were created less than 13 months ago have data from 0-28 days before the instance creation date.\n"," Modeled conversion events in the attributed conversion data sets are available through the above tables. Reporting grains below the ad line level are available for modeled conversion events, and instead reported as NULL. To exclude modeled conversions from insights, join attributed conversion data sets to user identifiers, traffic identifiers, or any dimension below the ad line level.\n","| Name                                                               | Data type     | Metric/Dimension | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Aggregation threshold |\n","\\|--------------------------------------------------------------------\\|---------------\\|------------------\\|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|-----------------------\\|\n","| ad_product_type                                                  | STRING        | DIMENSION        | Type of Amazon Ads ad product responsible for the traffic event to which the conversion is attributed. This field helps distinguish between individual sponsored ads products and Amazon DSP. Possible values include: sponsored_products, sponsored_brands, sponsored_display, sponsored_television, and NULL (which represents Amazon DSP events).                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | LOW                   |\n","| ad_slot_size                                                     | STRING        | DIMENSION        | Ad slot size in which the Amazon DSP ad was served, expressed as width x height in pixels. The dimensions indicate the space allocated for the ad on the page or app where the impression was served. Example values: '300x250', '728x90', '320x50'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| add_to_cart                                                      | LONG          | METRIC           | The number of times a promoted ASIN was added to a customer's cart on Amazon, attributed to an ad view or click. Possible values for this field are: 1 (if the record represents an add to cart conversion) or 0 (if the record does not represent an add to cart conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| add_to_cart_clicks                                              | LONG          | METRIC           | The number of times a promoted ASIN was added to a customer's cart on Amazon, attributed to an ad click. Possible values for this field are: 1 (if the record represents a click-attributed add to cart) or 0 (if the record does not represent a click-attributed add to cart).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| add_to_cart_views                                               | LONG          | METRIC           | The number of times a promoted ASIN was added to a customer's cart on Amazon, attributed to an ad view. Possible values for this field are: 1 (if the record represents a view-attributed add to cart) or 0 (if the record does not represent a view-attributed add to cart).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| advertiser                                                         | STRING        | DIMENSION        | Name of the business entity running advertising campaigns on Amazon Ads. Example value: 'Widgets Inc'. LOW                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                       |\n","| advertiser_id                                                     | LONG          | DIMENSION        | ID of the advertiser associated with the conversion event. Note that this value will only be populated fro Amazon DSP events. Example value: '123456789012345'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| advertiser_timezone                                               | STRING        | DIMENSION        | Advertiser timezone. This setting aligns with the advertiser timezone configuration in the connected Amazon DSP or sponsored ads account. Example value: 'America/New_York'.                                                                                                                             | LOW                   |\n","| appstore_first_opens                   | INTEGER       | METRIC | The number of first time app opens attributed to an ad interaction. Possible values for this field are: 1 (if the record represents an appstore first open) or 0 (if the record does not represent an appstore first open).                                                          | NONE |\n","| appstore_first_opens_clicks           | INTEGER       | METRIC | The number of first time app opens attributed to an ad click. Possible values for this field are: 1 (if the record represents a click-attributed appstore first open) or 0 (if the record does not represent a click-attributed appstore first open).                                | NONE |\n","| appstore_first_opens_views            | INTEGER       | METRIC | The number of first time app opens attributed to an ad view. Possible values for this field are: 1 (if the record represents a view-attributed appstore first open) or 0 (if the record does not represent a view-attributed appstore first open).                                   | NONE |\n","| appstore_first_session_hours          | DECIMAL(38,2) | METRIC | The total hours shoppers spent using an app during first time app sessions, attributed to an ad interaction. Example value: '2'.                                                                                                                                                         | NONE |\n","| appstore_first_session_hours_clicks  | DECIMAL(38,2) | METRIC | The total hours shoppers spent using an app during first time app sessions, attributed to an ad click. Example value: '2'.                                                                                                                                                               | NONE |\n","| appstore_first_session_hours_views   | DECIMAL(38,2) | METRIC | The total hours shoppers spent using an app during first time app sessions, attributed to an ad view. Example value: '2'.                                                                                                                                                                | NONE |\n","| appstore_opens                          | INTEGER       | METRIC | The number of times shoppers opened an app, including first time and reopens, attributed to an ad interaction. Possible values for this field are: 1 (if the record represents an appstore open) or 0 (if the record does not represent an appstore open).                           | NONE |\n","| appstore_opens_clicks                  | INTEGER       | METRIC | The number of times shoppers opened an app, including first time and reopens, attributed to an ad click. Possible values for this field are: 1 (if the record represents a click-attributed appstore open) or 0 (if the record does not represent a click-attributed appstore open). | NONE |\n","| appstore_opens_views                   | INTEGER       | METRIC | The number of times shoppers opened an app, including first time and reopens, attributed to an ad view. Possible values for this field are: 1 (if the record represents a view-attributed appstore open) or 0 (if the record does not represent a view-attributed appstore open).    | NONE |\n","| appstore_repeat_opens                  | INTEGER       | METRIC | The number of repeat app opens attributed to an ad interaction. Possible values for this field are: 1 (if the record represents an appstore repeat open) or 0 (if the record does not represent an appstore repeat open).                                                            | NONE |\n","| appstore_repeat_opens_clicks          | INTEGER       | METRIC | The number of repeat app opens attributed to an ad click. Possible values for this field are: 1 (if the record represents a click-attributed appstore repeat open) or 0 (if the record does not represent a click-attributed appstore repeat open).                                  | NONE |\n","| appstore_repeat_opens_views           | INTEGER       | METRIC | The number of repeat app opens attributed to an ad view. Possible values for this field are: 1 (if the record represents a view-attributed appstore repeat open) or 0 (if the record does not represent a view-attributed repeat first open).                                        | NONE |\n","| appstore_repeat_session_hours         | DECIMAL(38,2) | METRIC | The total hours shoppers spent using an app during repeat app sessions, attributed to an ad interaction. Example value: '2'.                                                                                                                                                             | NONE |\n","| appstore_repeat_session_hours_clicks | DECIMAL(38,2) | METRIC | The total hours shoppers spent using an app during repeat app sessions, attributed to an ad click. Example value: '2'.                                                                                                                                                                   | NONE |\n","| appstore_repeat_session_hours_views  | DECIMAL(38,2) | METRIC | The total hours shoppers spent using an app during repeat app sessions, attributed to an ad view. Example value: '2'.                                                                                                                                                                    | NONE |\n","| appstore_usage_hours                   | DECIMAL(38,2) | METRIC | The total hours spent using an app during first-time and repeat sessions, attributed to an ad interaction. Example value: '2'.                                                                                                                                                           | NONE |\n","| appstore_usage_hours_clicks           | DECIMAL(38,2) | METRIC | The total hours spent using an app the first time and during repeat sessions, attributed to an ad click. Example value: '2'.                                                                                                                                                             | NONE |\n","| appstore_usage_hours_views            | DECIMAL(38,2) | METRIC | The total hours spent using an app the first time and during repeat sessions, attributed to an ad view. Example value: '2'.                                                                                                                                                              | NONE |\n","| audience_fee                                                      | LONG          | METRIC           | The fee (in microcents) that Amazon DSP charges to customers to utilize Amazon audiences. Audience fees are typically charged on a cost-per-thousand impressions (CPM) basis when using audience segments for campaign targeting. To convert to dollars/your currency, divide by 100,000,000 (e.g., 100,000,000 microcents = $1.00). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '25000'.                                                                                                                                                                                                                                                                                                                                                                                   | NONE                  |\n","| bid_price                                                         | LONG          | METRIC           | The bid price (in microcents) for the impression. To convert to dollars/your currency, divide by 100,000,000 (e.g., 500,000 microcents = $0.005). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '500000'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | MEDIUM                |\n","| brand_halo_add_to_cart                                         | LONG          | METRIC           | The number of times Add to Cart was clicked for brand halo ASINs on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a brand halo add to cart conversion) or 0 (if the record does not represent a brand halo add to cart conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| brand_halo_add_to_cart_clicks                                 | LONG          | METRIC           | The number of times Add to Cart was clicked for brand halo ASINs on Amazon, attributed to an ad click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a click-attributed brand halo add to cart) or 0 (if the record does not represent a click-attributed brand halo add to cart).                                                                                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| brand_halo_add_to_cart_views                                  | LONG          | METRIC           | The number of times Add to Cart was clicked for brand halo ASINs on Amazon, attributed to an ad view. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a view-attributed add to cart event for a brand halo product) or 0 (if the record does not represent a view-attributed add to cart event for a brand halo product).                                                                                                                                                                                                                                                                                                                                                                                                   | NONE                  |\n","| brand_halo_detail_page_view                                    | LONG          | METRIC           | The number of detail page views on brand halo ASINs on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a detail page view conversion for a brand halo product) or 0 (if the record does not represent a detail page view conversion for a brand halo product).                                                                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| brand_halo_detail_page_view_clicks                            | LONG          | METRIC           | The number of detail page views on brand halo ASINs on Amazon, attributed to an ad click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a click-attributed detail page view for a brand halo product) or 0 (if the record does not represent a click-attributed detail page view for a brand halo product).                                                                                                                                                                                                                                                                                                                                                                                                               | NONE                  |\n","| brand_halo_detail_page_view_views                             | LONG          | METRIC           | The number of detail page views on brand halo ASINs on Amazon, attributed to an ad view. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a view-attributed detail page view for a brand halo product) or 0 (if the record does not represent a view-attributed detail page view for a brand halo product).                                                                                                                                                                                                                                                                                                                                                                                                                  | NONE                  |\n","| brand_halo_product_sales                                        | DECIMAL(38,4) | METRIC           | The sales (in local currency) of brand halo ASINs purchased on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | NONE                  |\n","| brand_halo_product_sales_clicks                                | DECIMAL(38,4) | METRIC           | The sales (in local currency) of brand halo ASINs purchased on Amazon, attributed to an ad click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| brand_halo_product_sales_views                                 | DECIMAL(38,4) | METRIC           | The sales (in local currency) of brand halo ASINs purchased on Amazon, attributed to an ad view. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| brand_halo_purchases                                             | LONG          | METRIC           | The number of purchases of brand halo ASINs on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a purchase of a brand halo product) or 0 (if the record does not represent a purchase of a brand halo ASIN).                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| brand_halo_purchases_clicks                                     | LONG          | METRIC           | The number of purchases of brand halo ASINs on Amazon, attributed to an ad click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a click-attributed purchase of a brand halo product) or 0 (if the record does not represent a click-attributed purchase of a brand halo ASIN).                                                                                                                                                                                                                                                                                                                                                                                                                                            | NONE                  |\n","| brand_halo_purchases_views                                      | LONG          | METRIC           | The number of purchases of brand halo ASINs on Amazon, attributed to an ad view. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a view-attributed purchase of a brand halo product) or 0 (if the record does not represent a view-attributed purchase of a brand halo ASIN).                                                                                                                                                                                                                                                                                                                                                                                                                                               | NONE                  |\n","| brand_halo_units_sold                                           | LONG          | METRIC           | The quantity of brand halo ASINs purchased on Amazon on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | NONE                  |\n","| brand_halo_units_sold_clicks                                   | LONG          | METRIC           | The quantity of brand halo ASINs purchased on Amazon, attributed to an ad click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| brand_halo_units_sold_views                                    | LONG          | METRIC           | The quantity of brand halo ASINs purchased on Amazon, attributed to an ad view. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | NONE                  |\n","| browser_family                                                    | STRING        | DIMENSION        | Browser family used when viewing the ad. Browser family represents a high-level grouping of web browsers and app contexts through which ads can be served, such as mobile browsers, desktop browsers, and application environments. When this field appears in conversion-related tables, it represents the browser family used during the impression event, not the conversion event. Example values include: 'Chrome', 'Safari', 'Mobile Safari', 'Android App', 'iOS WebView', and 'Roku App'.                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| campaign                                                           | STRING        | DIMENSION        | Name of the sponsored ads campaign responsible for the traffic event. A campaign is a container that groups related advertising efforts with shared objectives, budget, and flight dates. Example value: 'Widgets_Q1_2024_Keywords_US'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW                   |\n","| campaign_budget_amount                                           | LONG          | DIMENSION        | The total budget allocated to the campaign, stored in millicents. To convert to dollars/local currency, divide by 100,000 (e.g., 100,000 millicents = $1.00). Refer to the currency_name field for the campaign budget currency. Example value: 100000000.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW                   |\n","| campaign_end_date                                                | TIMESTAMP     | DIMENSION        | End date and time of the campaign in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| campaign_end_date_utc                                           | TIMESTAMP     | DIMENSION        | End date of the campaign in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| campaign_end_dt                                                  | TIMESTAMP     | DIMENSION        | End date and time of the campaign in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| campaign_end_dt_utc                                             | TIMESTAMP     | DIMENSION        | End date and time of the campaign in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| campaign_flight_budget_amount | LONG | METRIC | The total budget allocated to the flight, stored in millicents. To convert to dollars/local currency, divide by 100,000 (e.g., 100,000 millicents = $1.00). Refer to the currency_name field for the campaign budget currency. Example value: 100000000. | LOW |\n","| campaign_flight_end_date_utc | TIMESTAMP | DIMENSION | End date and time of the flight in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_flight_id | LONG | DIMENSION | ID of the Amazon DSP flight responsible for the traffic event. A flight is a scheduled period of time when a campaign is active. Campaigns can include multiple flights to support different budget and optimization settings. Example value: '123456789012345'. | LOW |\n","| campaign_flight_name | STRING | DIMENSION | Name of the flight responsible for the traffic event. A flight is a scheduled period of time when a campaign is active. Campaigns can include multiple flights to support different budget and optimization settings. Example value: 'Widgets_Q1_2024_Keywords_US'. | LOW |\n","| campaign_flight_start_date_utc | TIMESTAMP | DIMENSION | Start date and time of the flight in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_id                                                       | LONG          | DIMENSION        | The ID of the Amazon Ads campaign associated with the conversion event. Note that for Amazon DSP campaigns, campaign_id and campaign_id_string will show the same value for a given conversion event. For sponsored ads campaigns, campaign_id will contain the sponsored ads campaign ID that can be leveraged on the Ads API; this is different from the campaign ID that is present in the ads console.                                                                                                                                                                   | LOW                   |\n","| campaign_id_string                                               | STRING        | DIMENSION        | The ID of the Amazon Ads campaign associated with the conversion event. Note that for Amazon DSP campaigns, campaign_id and campaign_id_string will show the same value for a given conversion event. For sponsored ads campaigns, campaign_id_string will contain the campaign ID that is present in the ads console; this is different from the sponsored ads campaign ID that can be leveraged on the Ads API.                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| campaign_insertion_order_id                                     | STRING        | DIMENSION        | ID of the insertion order associated with the impression event. An insertion order is a contractual agreement between an advertiser and Amazon Ads that outlines the specific details of a programmatic advertising campaign. Example value: '123456789'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| campaign_primary_goal                                            | STRING        | DIMENSION        | Primary goal set for campaign optimization in Amazon DSP. Campaign goals determine how Amazon DSP optimizes delivery and measures success of the campaign. The goal selected during campaign setup influences bidding strategy and campaign optimization. Possible values include: ROAS, TOTAL_ROAS, REACH, CPVC, COMPLETION_RATE, CTR, CPC, DPVR, PAGE_VISIT, CPDPV, CPA OTHER, and NONE.                                                                                                                                                                                                                                                                                                                                                                                                                    | LOW                   |\n","| campaign_start_date                                              | TIMESTAMP     | DIMENSION        | Start date and time of the campaign in advertiser timezone. The campaign start date determines when a campaign begins serving impressions. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | LOW                   |\n","| campaign_start_date_utc                                         | TIMESTAMP     | DIMENSION        | Start date and time of the campaign in Coordinated Universal Time (UTC). The campaign start date determines when a campaign begins serving impressions. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| campaign_status                                                   | STRING        | DIMENSION        | Current status of the campaign. Campaign status indicates whether a campaign is actively delivering ads, has completed its flight dates, or has been paused by the advertiser. Possible values include: ENDED, RUNNING, ENABLED, PAUSED, and ADS_NOT_RUNNING.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| city_name                                                         | STRING        | DIMENSION        | City name where the impression event occurred, determined by signal available in the auction event. This attribute is only available for Amazon DSP events. Example value: 'New York'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | HIGH                  |\n","| click_cost                                                        | LONG          | METRIC           | Click cost (in millicents). To convert to dollars/local currency, divide by 100,000 (e.g., 100,000 millicents = $1.00). Refer to the currency_name field for the currency in which the click cost is reported. Example value: 300 (equivalent to $0.003).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | MEDIUM                |\n","| click_date                                                        | DATE          | DIMENSION        | Date of the click event in advertiser timezone. This field will be populated for conversion events that are attributed to an ad click. Example value: '2025-01-01'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| click_date_utc                                                   | DATE          | DIMENSION        | Date of the click event in Coordinated Universal Time (UTC). This field will be populated for conversion events that are attributed to an ad click. Example value: '2025-01-01'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW                   |\n","| click_day                                                         | INTEGER       | DIMENSION        | Day of month when the click event occurred in advertiser timezone. This field will be populated for conversion events that are attributed to an ad click. Example value: '1'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| click_day_utc                                                    | INTEGER       | DIMENSION        | Day of month when the click event occurred in Coordinated Universal Time (UTC). This field will be populated for conversion events that are attributed to an ad click. Example value: '1'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| click_dt                                                          | TIMESTAMP     | DIMENSION        | Timestamp of the click event in advertiser timezone. This field will be populated for conversion events that are attributed to an ad click. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | MEDIUM                |\n","| click_dt_hour                                                    | TIMESTAMP     | DIMENSION        | Timestamp of the click event in advertiser timezone, truncated to hour. This field will be populated for conversion events that are attributed to an ad click. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW                   |\n","| click_dt_hour_utc                                               | TIMESTAMP     | DIMENSION        | Timestamp of the click event in Coordinated Universal Time (UTC), truncated to hour. This field will be populated for conversion events that are attributed to an ad click. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| click_dt_utc                                                     | TIMESTAMP     | DIMENSION        | Timestamp of the click event in Coordinated Universal Time (UTC). This field will be populated for conversion events that are attributed to an ad click. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | MEDIUM                |\n","| click_hour                                                        | INTEGER       | DIMENSION        | Hour of day when the click event occurred, in advertiser timezone. Values range from 0-23 representing 24-hour time. This field will be populated for conversion events that are attributed to an ad click. Example value: '14' (represents 2:00 PM in 24-hour time).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| click_hour_utc                                                   | INTEGER       | DIMENSION        | Hour of day when the click event occurred, in Coordinated Universal Time (UTC). Values range from 0-23 representing 24-hour time. This field will be populated for conversion events that are attributed to an ad click. Example value: '14' (represents 2:00 PM in 24-hour time)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| clicks                                                             | LONG          | METRIC           | Count of clicks. For each conversion record, this field indicates whether the conversion was attributed to an ad click. When querying this table, remember that each record represents a single conversion event that has been attributed to an ad view or click traffic event (and therefore this field will not represent the entirety of clicks generated by your campaigns). Possible values for this field are: 1 (if the conversion was attributed to an ad click event) or 0 (if the conversion was not attributed to ad click event).                                                                                                                                                                                                                                                                                          | NONE                  |\n","| combined_sales                                                    | DECIMAL(38,4) | METRIC           | The total sales amount (in local currency) combining both on-Amazon product sales and off-Amazon product sales, attributed to an ad view or click. This metric helps measure the total sales impact across both Amazon and non-Amazon purchase channels: combined_sales = total_product_sales + off_amazon_product_sales. Example value: '149.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| conversion_event_category                                        | STRING        | DIMENSION        | High-level category of the conversion event. This field categorizes where the conversion event occurred. Possible values include: website (browsing event on Amazon), purchase (purchase event on Amazon), and off-Amazon.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW                   |\n","| conversion_event_date                                            | DATE          | DIMENSION        | Date of the conversion event in advertiser timezone. Example value: '2025-01-01'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| conversion_event_date_utc                                       | DATE          | DIMENSION        | Date of the conversion event in Coordinated Universal Time (UTC) timezone. Example value: '2025-01-01'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| conversion_event_dt                                              | TIMESTAMP     | DIMENSION        | Timestamp of the conversion event in advertiser timezone. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | MEDIUM                |\n","| conversion_event_dt_hour                                        | TIMESTAMP     | DIMENSION        | Timestamp of the conversion event in advertiser timezone, truncated to the hour. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| conversion_event_dt_hour_utc                                   | TIMESTAMP     | DIMENSION        | Timestamp of the conversion event in Coordinated Universal Time (UTC) truncated to hour. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| conversion_event_dt_utc                                         | TIMESTAMP     | DIMENSION        | Timestamp of the conversion event in Coordinated Universal Time (UTC). Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | MEDIUM                |\n","| conversion_event_hour                                            | INTEGER       | DIMENSION        | Hour of the day when the conversion event occurred in advertiser timezone. Values are in 24-hour format (0-23). Example value: '0'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| conversion_event_hour_utc                                       | INTEGER       | DIMENSION        | Hour of the day (0-23) when the conversion event occurred in Coordinated Universal Time (UTC) timezone. Example value: '0'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| conversion_event_marketplace_name                               | STRING        | DIMENSION        | Name of the marketplace where the conversion event occurred. A marketplace can be an online shopping site (like Amazon.com) or a physical retail location (like Amazon Fresh stores). This field helps distinguish between conversions that happen on different Amazon online marketplaces versus those that occur in Amazon physical retail locations. Example values include: 'AMAZON.COM', 'AMAZON.CO.UK', 'WHOLE_FOODS_MARKET_US', and 'AMAZON_FRESH_STORES_US'.                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| conversion_event_name                                            | STRING        | DIMENSION        | Name of the conversion definition as defined by the advertiser in Events Manager. A conversion definition specifies what type of event (like a page view or purchase) should be measured as a conversion when setting up measurement in Events Manager. For example, an advertiser could define a conversion definition as: 'Homepage_Visit'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | LOW                   |\n","| conversion_event_source_name                                    | STRING        | DIMENSION        | Source of the advertiser-provided conversion event. This field helps distinguish between on-Amazon conversion events (such as purchases on Amazon.com) and off-Amazon conversion events measured through Events Manager solutions like Amazon Ad tag. When the conversion event occurs on Amazon, this field will be NULL. Possible values include: NULL (for on-Amazon events), 'Amazon Ad Tag', 'Conversions API', and 'Mobile Measurement Partner'.                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| conversion_event_subtype                                         | STRING        | DIMENSION        | Subtype of the conversion event. This field provides additional detail about the subtype of conversion event that occurred, such as whether it represents viewing a product's detail page on Amazon.com or completing a purchase on an advertiser's website. For on-Amazon conversion events, this field contains human-readable values, while off-Amazon events measured via Events Manager are represented by numeric values. Possible values include: detailPageView, shoppingCart, order, searchConversion, brandStorePageView, wishList, babyRegistry, weddingRegistry, customerReview for on-Amazon events, and numeric values like 134, 140, 141 for off-Amazon events. For more information on off-Amazon conversion event subtypes, refer to the \"Introduction to Events Manager\" entry in the IQL. | LOW                   |\n","| conversion_event_type                                            | STRING        | DIMENSION        | Type of the conversion event.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| conversion_event_type_class                                     | STRING        | DIMENSION        | Classification of conversion events based on customer behavior. This field categorizes conversion events into consideration events (like detail page views) versus actual conversion events (like purchases). Possible values include: consideration, conversion, and NULL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| conversion_event_type_description                               | STRING        | DIMENSION        | Human-readable description of the conversion event type. Conversion events can occur on Amazon (like product purchases or detail page views) or off Amazon (like brand site page views or in-store transactions measured via Events Manager). Example values: 'Product purchased', 'Add to Shopping Cart', 'Product detail page viewed'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| conversions                                                        | LONG          | METRIC           | The count of conversion events. This field always contains a value of 1, allowing you to calculate conversion totals for the records selected in your query. Conversion events can include on-Amazon activities like purchases and detail page views, as well as off-Amazon events measured through Events Manager. Possible values for this field are: 1 (the record represents a conversion event).                                                                                                                                                                                                                                                                                                                                                                                                                                  | NONE                  |\n","| creative                                                           | STRING        | DIMENSION        | Name of the Amazon DSP ad. A creative represents the actual advertisement shown to customers. Example value: '2025_US_Widgets_Spring_Mobile_320x50'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| creative_category                                                 | STRING        | DIMENSION        | Category of the Amazon DSP ad. This field categorizes Amazon DSP ads into broad creative format types like display ads and video ads. Possible values include: Display, Video, and NULL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| creative_duration                                                 | LONG          | DIMENSION        | Duration in seconds of the Amazon DSP creative asset, primarily used for video format ads. This field specifies the length of video creative assets delivered through Amazon DSP campaigns. For non-video creative formats like display ads, this field will be NULL. Example values include: '15', '30', '60', representing video durations in seconds.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| creative_id                                                       | LONG          | DIMENSION        | Unique identifier for the ad. A ad represents the actual advertisement shown to customers, which could be an image, video, or other ad format. Example value: '591234567890123456'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| creative_is_link_in                                             | STRING        | DIMENSION        | Boolean field indicating whether the Amazon DSP ad directs to an Amazon destination (link in) versus an external destination (link out). A link in creative directs users to an Amazon destination like a product detail page, while a link out creative directs users to an external destination like an advertiser's website. Possible values for this field are: Y (creative is link in), N (creative is link out).                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| creative_size                                                     | STRING        | DIMENSION        | Dimensions of the Amazon DSP ad (width x height in pixels, or responsive format). Example values: '300x250', '320x50', 'Responsive'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| creative_type                                                     | STRING        | DIMENSION        | Type of ad.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW                   |\n","| customer_search_term                                             | STRING        | DIMENSION        | Search term entered by a shopper on Amazon that led to the traffic event. Search terms represent the actual text that shoppers type into the Amazon search bar, as opposed to advertiser-defined keywords. Example value: 'blue widgets 3 pack'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| deal_id                                                           | STRING        | DIMENSION        | ID of the deal between the publisher and advertiser, for Amazon DSP impressions purchased via private deal (e.g. Private Marketplace or Programmatic Guaranteed deals). Deals represent agreements for access to specific ad inventory with pre-negotiated terms. This field will be NULL for traffic events purchased via open auction. Example value: 'DEAL123456'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| deal_name                                                         | STRING        | METRIC           | Name of the deal between the publisher and advertiser, for Amazon DSP impressions purchased via private deal e.g. Private Marketplace or Programmatic Guaranteed deals). Deals represent agreements for access to specific ad inventory with pre-negotiated terms. This field will be NULL for traffic events purchased via open auction. Example value: 'Widgets_Premium_Video_Deal'.                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| detail_page_view                                                 | LONG          | METRIC           | The number of detail page views on advertised ASINs, attributed to an ad view or click. Possible values for this field are: 1 (if the record represents a detail page view conversion for an advertised product) or 0 (if the record does not represent a detail page view conversion for an advertised product).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| detail_page_view_clicks                                         | LONG          | METRIC           | The number of detail page views on advertised ASINs, attributed to an ad click. Possible values for this field are: 1 (if the record represents a click-attributed detail page view for an advertised product) or 0 (if the record does not represent a click-attributed detail page view for an advertised product).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| detail_page_view_views                                          | LONG          | METRIC           | The number of detail page views on advertised ASINs, attributed to an ad view. Possible values for this field are: 1 (if the record represents a view-attributed detail page view for an advertised product) or 0 (if the record does not represent a view-attributed detail page view for an advertised product).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | NONE                  |\n","| device_make                                                       | STRING        | DIMENSION        | Manufacturer or brand name of the device associated with the traffic event, derived from user-agent in the auction. Values may appear in different formats or capitalizations for the same manufacturer. Example values: 'Apple', 'APPLE', 'Samsung', 'SAMSUNG', 'ROKU', 'Generic', 'UNKNOWN'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| device_model                                                      | STRING        | DIMENSION        | Model of the device associated with the traffic event, derived from user-agent in the auction. Values may appear in different formats or capitalizations for the same manufacturer. Example values: 'iPhone', 'GALAXY'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| device_type                                                       | STRING        | DIMENSION        | Type of the device associated with the traffic event. Possible values include: Tablet, Phone, TV, PC, ConnectedDevice, Unknown, and NULL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| digital_app_subscription_signup_purchases                      | LONG          | METRIC           | The number of free trial and paid app subscriptions associated with an ad view or click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents an app subscription conversion) or 0 (if the record does not represent an app subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| digital_app_subscription_signup_purchases_clicks              | LONG          | METRIC           | The number of free trial and paid app subscriptions associated with an ad click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a click-attributed app subscription conversion) or 0 (if the record does not represent a click-attributed app subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| digital_app_subscription_signup_purchases_views               | LONG          | METRIC           | The number of free trial and paid app subscriptions associated with an ad view. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a view-attributed app subscription conversion) or 0 (if the record does not represent a view-attributed app subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                   | NONE                  |\n","| digital_free_trial_app_subscription_signup_purchases         | LONG          | METRIC           | The number of free trial app subscriptions associated with an ad view or click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a free trial app subscription conversion) or 0 (if the record does not represent a free trial app subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                               | NONE                  |\n","| digital_free_trial_app_subscription_signup_purchases_clicks | LONG          | METRIC           | The number of free trial app subscriptions associated with an ad click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a click-attributed free trial app subscription conversion) or 0 (if the record does not represent a click-attributed free trial app subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                   | NONE                  |\n","| digital_free_trial_app_subscription_signup_purchases_views  | LONG          | METRIC           | The number of free trial app subscriptions associated with an ad view. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a view-attributed free trial app subscription conversion) or 0 (if the record does not represent a view-attributed free trial app subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| digital_free_trial_subscription_signup_purchases              | LONG          | METRIC           | The number of free trial digital subscriptions associated with an ad view or click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a free trial digital subscription conversion) or 0 (if the record does not represent a free trial digital subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                   | NONE                  |\n","| digital_free_trial_subscription_signup_purchases_clicks      | LONG          | METRIC           | The number of free trial digital subscriptions associated with an ad click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a click-attributed free trial digital subscription conversion) or 0 (if the record does not represent a click-attributed free trial digital subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                       | NONE                  |\n","| digital_free_trial_subscription_signup_purchases_views       | LONG          | METRIC           | The number of free trial digital subscriptions associated with an ad view. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a view-attributed free trial digital subscription conversion) or 0 (if the record does not represent a view-attributed free trial digital subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| digital_paid_app_subscription_signup_purchases                | LONG          | METRIC           | The number of paid app subscriptions associated with an ad view or click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a paid app subscription conversion) or 0 (if the record does not represent a paid app subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | NONE                  |\n","| digital_paid_app_subscription_signup_purchases_clicks        | LONG          | METRIC           | The number of paid app subscriptions associated with an ad click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a click-attributed paid app subscription conversion) or 0 (if the record does not represent a click-attributed paid app subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| digital_paid_app_subscription_signup_purchases_views         | LONG          | METRIC           | The number of paid app subscriptions associated with an ad view. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a view-attributed paid app subscription conversion) or 0 (if the record does not represent a view-attributed paid app subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| digital_paid_subscription_signup_purchases                     | LONG          | METRIC           | The number of paid digital subscriptions associated with an ad view or click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a paid digital subscription conversion) or 0 (if the record does not represent a paid digital subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| digital_paid_subscription_signup_purchases_clicks             | LONG          | METRIC           | The number of paid digital subscriptions associated with an ad click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a click-attributed paid digital subscription conversion) or 0 (if the record does not represent a click-attributed paid digital subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| digital_paid_subscription_signup_purchases_views              | LONG          | METRIC           | The number of paid digital subscriptions associated with an ad view. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a view-attributed paid digital subscription conversion) or 0 (if the record does not represent a view-attributed paid digital subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                            | NONE                  |\n","| digital_subscription_signup_purchases                           | LONG          | METRIC           | The number of free trial and paid digital subscriptions associated with an ad view or click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a digital subscription conversion) or 0 (if the record does not represent a digital subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| digital_subscription_signup_purchases_clicks                   | LONG          | METRIC           | The number of free trial and paid digital subscriptions associated with an ad click. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a click-attributed digital subscription conversion) or 0 (if the record does not represent a click-attributed digital subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                    | NONE                  |\n","| digital_subscription_signup_purchases_views                    | LONG          | METRIC           | The number of free trial and paid digital subscriptions associated with an ad view. For more information, refer to the \"Query digital subscriptions, purchases, and downloads\" entry on the IQL. Possible values for this field are: 1 (if the record represents a view-attributed digital subscription conversion) or 0 (if the record does not represent a view-attributed digital subscription conversion).                                                                                                                                                                                                                                                                                                                                                                                                                       | NONE                  |\n","| dma_code                                                          | STRING        | DIMENSION        | Designated Market Area (DMA) code where the impression event occurred. DMA codes are geographic regions defined by Nielsen that identify specific broadcast TV markets in the United States. The field uses a standardized format combining \"US-DMA\" prefix with a numeric market identifier. Example value: 'US-DMA518'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW                   |\n","| entity_id                                                         | STRING        | DIMENSION        | ID of the Amazon Ads entity (also known as seat) associated with the conversion event. An entity represents a sponsored ads or Amazon DSP account, within which media is further organized by advertiser and by campaign. Example value: 'ENTITYABC123XYZ789'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | LOW                   |\n","| environment_type                                                  | STRING        | DIMENSION        | Environment where the impression event occurred. This field distinguishes between web-based environments like desktop or mobile browsers, and app-based environments like mobile apps. If the environment type cannot be determined, this field will be NULL. Possible values include: Web, App, and NULL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | LOW                   |\n","| impression_date                                                   | DATE          | DIMENSION        | Date of the impression event in advertiser timezone. This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| impression_date_utc                                              | DATE          | DIMENSION        | Date of the impression event in Coordinated Universal Time (UTC). This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| impression_day                                                    | INTEGER       | DIMENSION        | Day of month when the impression event occurred in advertiser timezone. This field will be populated for conversion events that are attributed to an ad view. Example value: '1' (represents first day of the month).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| impression_day_utc                                               | INTEGER       | DIMENSION        | Day of month when the impression event occurred in Coordinated Universal Time (UTC). This field will be populated for conversion events that are attributed to an ad view. Example value: '1' (represents first day of the month).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW                   |\n","| impression_dt                                                     | TIMESTAMP     | DIMENSION        | Timestamp of the impression event in advertiser timezone. This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | MEDIUM                |\n","| impression_dt_hour                                               | TIMESTAMP     | DIMENSION        | Timestamp of the impression event in advertiser timezone, truncated to hour. This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| impression_dt_hour_utc                                          | TIMESTAMP     | DIMENSION        | Timestamp of the impression event in Coordinated Universal Time (UTC), truncated to hour. This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| impression_dt_utc                                                | TIMESTAMP     | DIMENSION        | Timestamp of the impression event in Coordinated Universal Time (UTC). This field will be populated for conversion events that are attributed to an ad view. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | MEDIUM                |\n","| impression_hour                                                   | INTEGER       | DIMENSION        | Hour of day when the impression event occurred, in advertiser timezone. Values range from 0-23 representing 24-hour time. This field will be populated for conversion events that are attributed to an ad view. Example value: '14' (represents 2:00 PM in 24-hour time).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| impression_hour_utc                                              | INTEGER       | DIMENSION        | Hour of day when the impression event occurred, in Coordinated Universal Time (UTC). Values range from 0-23 representing 24-hour time. This field will be populated for conversion events that are attributed to an ad view. Example value: '14' (represents 2:00 PM in 24-hour time).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| impressions                                                        | LONG          | METRIC           | Count of impressions. For each conversion record, this field indicates whether the conversion was attributed to an ad view. When querying this table, remember that each record represents a single conversion event that has been attributed to an ad view or click (and therefore this field will not represent the entirety of impressions served by your campaigns). Possible values for this field are: 1 (if the conversion was attributed to an ad view event) or 0 (if the conversion was not attributed to ad view event).                                                                                                                                                                                                                                                                                                    | NONE                  |\n","| is_amazon_business | BOOLEAN | DIMENSION | Boolean value indicating whether the event occurred on the Amazon Business retail site. This field is supported for Sponsored Products and Sponsored Brands, and will be NULL for all other ad products. Possible values for this field are: true (appeared on the Amazon Business retail site), false (did not appear on the Amazon Business retail site/appeared elsewhere), and NULL (unknown). | LOW |\n","| iso_country_code                                                 | STRING        | DIMENSION        | ISO 3166 Alpha-2 country code where the impression event occurred, based on the user's IP address. Example value: 'US'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| iso_state_province_code                                         | STRING        | DIMENSION        | ISO state/province code where the impression event occurred. The code follows the ISO 3166-2 standard format which combines the country code and state/province subdivision (e.g., 'US-CA' for California, United States). Example value: 'US-CA'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| line_item                                                         | STRING        | DIMENSION        | Name of the line item to which the conversion is attributed. Attributes like ad format and targeting are defined at line item level within a campaign. Note that this value will reflect ad group name for sponsored ads campaigns. Example value: 'Widgets - DISPLAY - O&O - RETARGETING'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW                   |\n","| line_item_budget_amount                                         | LONG          | DIMENSION        | The total budget allocated to the line item, stored in millicents. To convert to dollars/local currency, divide by 100,000 (e.g., 100,000 millicents = $1.00). Example value: '100000000'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| line_item_end_date                                              | TIMESTAMP     | DIMENSION        | End date and time of the line item in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | LOW                   |\n","| line_item_end_date_utc                                         | TIMESTAMP     | DIMENSION        | End date and time of the line item in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| line_item_id                                                     | LONG          | DIMENSION        | ID of the line item to which the conversion is attributed. Attributes like ad format and targeting are defined at line item level within a campaign. Note that this value will be NULL for sponsored ads events. Example value: '5812345678901234'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| line_item_start_date                                            | TIMESTAMP     | DIMENSION        | Start date and time of the line item in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| line_item_start_date_utc                                       | TIMESTAMP     | DIMENSION        | Start date and time of the line item in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| line_item_status                                                 | STRING        | DIMENSION        | Status of the line item. The status indicates whether the line item is actively delivering ads, has been paused, or has completed its flight. Possible values include: ENDED, ENABLED, RUNNING, PAUSED_BY_USER, and SUSPENDED.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| line_item_type                                                   | STRING        | DIMENSION        | Type of line item. Line item types indicate how ads are delivered and optimized. Possible values include: AAP, AAP_MOBILE, AAP_VIDEO_CPM, CLASS_I_WEB, KEYWORD_BIDDING, CLASS_I_MOBILE_WEB, AAP_DISPLAY, CLASS_I_MOBILE_APP.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| match_type                                                        | STRING        | DIMENSION        | Type of match between targeting keyword and customer search term that resulted in the sponsored ads impression. Match types determine how closely a customer's search term needs to match your targeted keyword for your ad to be eligible to display. Possible values include: BROAD (matches if search term contains all keyword terms in any order, including plural forms and related queries and variations), PHRASE (search term must contain the exact phrase or sequence of words, or its plural form), EXACT (search term must exactly match the keyword or its plural form), and NULL (for media that is not keyword-targeted).                                                                                                                                                                                           | LOW                   |\n","| new_to_brand                                                     | BOOLEAN       | DIMENSION        | Boolean value indicating whether the customer associated with a purchase event is new-to-brand. A customer is considered new-to-brand if they have not purchased from the brand in the previous 12 months. This field is only applicable for purchase events. Possible values for this field are: true, false.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| new_to_brand_brand_halo_product_sales                        | DECIMAL(38,4) | METRIC           | The sales (in local currency) of brand halo ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view or click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| new_to_brand_brand_halo_product_sales_clicks                | DECIMAL(38,4) | METRIC           | The sales (in local currency) of brand halo ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | NONE                  |\n","| new_to_brand_brand_halo_product_sales_views                 | DECIMAL(38,4) | METRIC           | The sales (in local currency) of brand halo ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| new_to_brand_brand_halo_purchases                             | LONG          | METRIC           | The number of purchases of brand halo ASINs by new-to-brand (NTB) customers on Amazon, attributed to an ad view or click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a NTB purchase of a brand halo product) or 0 (if the record does not represent a purchase of a brand halo product).                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| new_to_brand_brand_halo_purchases_clicks                     | LONG          | METRIC           | The number of purchases of brand halo ASINs by new-to-brand (NTB) customers on Amazon, attributed to an ad click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a click-attributed NTB purchase of a brand halo product) or 0 (if the record does not represent a click-attributed NTB purchase of a brand halo product).                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| new_to_brand_brand_halo_purchases_views                      | LONG          | METRIC           | The number of purchases of brand halo ASINs by new-to-brand (NTB) customers on Amazon, attributed to an ad view. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a view-attributed NTB purchase of a brand halo product) or 0 (if the record does not represent a view-attributed NTB purchase of a brand halo product).                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| new_to_brand_brand_halo_units_sold                           | LONG          | METRIC           | The quantity of brand halo ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view or click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| new_to_brand_brand_halo_units_sold_clicks                   | LONG          | METRIC           | The quantity of brand halo ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | NONE                  |\n","| new_to_brand_brand_halo_units_sold_views                    | LONG          | METRIC           | The quantity of brand halo ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | NONE                  |\n","| new_to_brand_product_sales                                     | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view or click. NTB customers are those who have not purchased from your brand in the previous 12 months. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| new_to_brand_product_sales_clicks                             | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad click. NTB customers are those who have not purchased from your brand in the previous 12 months. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| new_to_brand_product_sales_views                              | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view. NTB customers are those who have not purchased from your brand in the previous 12 months. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| new_to_brand_purchases                                          | LONG          | METRIC           | The number of purchases of promoted ASINs by new-to-brand (NTB) customers on Amazon, attributed to an ad view or click. NTB customers are those who have not purchased from your brand in the previous 12 months. Possible values for this field are: 1 (if the record represents a NTB purchase of a promoted product) or 0 (if the record does not represent a NTB purchase of a promoted product).                                                                                                                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| new_to_brand_purchases_clicks                                  | LONG          | METRIC           | The number of purchases of promoted ASINs by new-to-brand (NTB) customers on Amazon, attributed to an ad click. NTB customers are those who have not purchased from your brand in the previous 12 months. Possible values for this field are: 1 (if the record represents a click-attributed NTB purchase of a promoted product) or 0 (if the record does not represent a click-attributed NTB purchase of a promoted product).                                                                                                                                                                                                                                                                                                                                                                                                    | NONE                  |\n","| new_to_brand_purchases_views                                   | LONG          | METRIC           | The number of purchases of promoted ASINs by new-to-brand (NTB) customers on Amazon, attributed to an ad view. NTB customers are those who have not purchased from your brand in the previous 12 months. Possible values for this field are: 1 (if the record represents a view-attributed NTB purchase of a promoted product) or 0 (if the record does not represent a view-attributed NTB purchase of a promoted product).                                                                                                                                                                                                                                                                                                                                                                                                       | NONE                  |\n","| new_to_brand_total_product_sales                              | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted and brand halo ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. NTB customers are those who have not purchased from your brand in the previous 12 months. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| new_to_brand_total_product_sales_clicks                      | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted and brand halo ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| new_to_brand_total_product_sales_views                       | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted and brand halo ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | NONE                  |\n","| new_to_brand_total_purchases                                   | LONG          | METRIC           | The number of purchases of promoted and brand halo ASINs by new-to-brand (NTB) customers on Amazon, attributed to an ad view or click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a NTB purchase of a promoted or brand halo product) or 0 (if the record does not represent a NTB purchase of a promoted or brand halo product).                                                                                                                                                                                                                                                                                            | NONE                  |\n","| new_to_brand_total_purchases_clicks                           | LONG          | METRIC           | The number of purchases of promoted and brand halo ASINs by new-to-brand (NTB) customers, attributed to an ad click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a click-attributed NTB purchase of a promoted or brand halo product) or 0 (if the record does not represent a click-attributed NTB purchase of a promoted or brand halo product).                                                                                                                                                                                                                                                                          | NONE                  |\n","| new_to_brand_total_purchases_views                            | LONG          | METRIC           | The number of purchases of promoted and brand halo ASINs by new-to-brand (NTB) customers on Amazon, attributed to an ad view. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Possible values for this field are: 1 (if the record represents a view-attributed NTB purchase of a promoted or brand halo product) or 0 (if the record does not represent a view-attributed NTB purchase of a promoted or brand halo product).                                                                                                                                                                                                                                                                   | NONE                  |\n","| new_to_brand_total_units_sold                                 | LONG          | METRIC           | The quantity of promoted and brand halo products purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view or click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '2'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| new_to_brand_total_units_sold_clicks                         | LONG          | METRIC           | The quantity of promoted and brand halo products purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad click. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '2'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | NONE                  |\n","| new_to_brand_total_units_sold_views                          | LONG          | METRIC           | The quantity of promoted and brand halo products purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view. NTB customers are those who have not purchased from your brand in the previous 12 months. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Example value: '2'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | NONE                  |\n","| new_to_brand_units_sold                                        | LONG          | METRIC           | The quantity of promoted ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view or click. NTB customers are those who have not purchased from your brand in the previous 12 months. Example value: '2'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| new_to_brand_units_sold_clicks                                | LONG          | METRIC           | The quantity of promoted ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad click. NTB customers are those who have not purchased from your brand in the previous 12 months. Example value: '2'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | NONE                  |\n","| new_to_brand_units_sold_views                                 | LONG          | METRIC           | The quantity of promoted ASINs purchased by new-to-brand (NTB) customers on Amazon, attributed to an ad view. NTB customers are those who have not purchased from your brand in the previous 12 months. Example value: '2'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| no_3p_trackers                                                   | BOOLEAN       | DIMENSION        | Boolean value indicating whether the event can be used for audience creation that is third-party tracking enabled (i.e. whether you can serve creative with third-party tracking when running media against the audience). Third-party tracking refers to measurement tags and pixels from external vendors that can be used to measure ad performance. Possible values for this field are: true, false.                                                                                                                                                                                                                                                                                                                                                                                                                            | NONE                  |\n","| off_amazon_conversion_value                                     | DECIMAL(38,4) | METRIC           | The non-monetary value assigned to non-purchase conversion events that occur off Amazon, such as website visits, app installs, or form submissions. When setting up conversion events in Events Manager, advertisers can define custom values to measure the relative importance of different types of conversion events. This helps quantify the impact of different conversion types when they do not have a direct monetary value. Example value: '25'.                                                                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| off_amazon_product_sales                                        | DECIMAL(38,4) | METRIC           | Product sales amount associated with the off-Amazon conversion event. This attribute is configured during implementation of an Amazon Ads measurement solution (e.g. Amazon Ad Tag). This allows advertisers to include additional metadata when measuring off-Amazon conversions via Events Manager.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | NONE                  |\n","| operating_system                                                  | STRING        | DIMENSION        | Operating system of the device where the impression event occurred. Example values: 'iOS', 'Android', 'Windows', 'macOS', 'Roku OS'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| os_version                                                        | STRING        | DIMENSION        | Operating system version of the device where the impression event occurred. The version format varies by operating system type. Example value: '17.5.1'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| page_type                                                         | STRING        | DIMENSION        | Type of page where the impression event occurred. This grain of detail is primarily relevant to impressions served on Amazon sites. Example values: 'Search', 'Detail', 'CustomerReviews'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| placement_type                                                    | STRING        | DIMENSION        | Location where the ad appeared, primarily relevant for impressions on Amazon properties. Example values include: 'Top of Search on-Amazon', 'Detail Page on-Amazon', 'Homepage on-Amazon', Off Amazon'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| platform_fee                                                      | LONG          | METRIC           | The fee (in microcents) that Amazon DSP charges customers to access and use Amazon DSP. The platform fee (also known as the technology fee or console fee in other contexts) is calculated as a percentage of the supply cost. To convert to dollars, divide by 100,000,000 (e.g., 100,000,000 microcents = $1.00). Example value: '1000000'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| postal_code                                                       | STRING        | DIMENSION        | Postal code in which the impression event occurred, based on the user's IP address. Postal code is also referred to as \"zip code\" in the US. The postal code is prepended with the iso_country_code value (e.g. 'US'). If the country is known, but the postal code is unknown, only the country code will be populated in postal_code. Example value: 'US-12345'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | HIGH                  |\n","| product_line                                                      | STRING        | DIMENSION        | Campaign product line. Product lines provide a standardized way to categorize products across different parts of the Amazon catalog. The field may contain NULL values for records where a product line classification is not applicable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | LOW                   |\n","| product_sales                                                     | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted ASINs purchased on Amazon, attributed to an ad view or click. Example value: '12.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | NONE                  |\n","| product_sales_clicks                                             | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted ASINs purchased on Amazon, attributed to an ad click. Example value: '12.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | NONE                  |\n","| product_sales_views                                              | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted ASINs purchased on Amazon, attributed to an ad view. Example value: '12.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| purchase_currency                                                 | STRING        | DIMENSION        | ISO currency code of the purchase. Currency codes follow the ISO 4217 standard for representing currencies (e.g., USD for US Dollar). Example value: 'USD'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW                   |\n","| purchase_retail_program                                          | STRING        | DIMENSION        | Retail program through which the on-Amazon purchase event occurred, including online and in-store purchases through Amazon.com, Whole Foods Market, and Amazon Fresh. Possible values include: 'Amazon.com', 'Amazon Fresh', and 'Whole Foods Market'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| purchase_unit_price                                              | DECIMAL       | METRIC           | The unit price of the product sold for on-Amazon purchase events, in local currency. This field represents the price per individual unit, not the total purchase price which may include multiple units. Example value: '29.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| purchases                                                          | LONG          | METRIC           | The number of purchases of promoted ASINs on Amazon, attributed to an ad view or click. Possible values for this field are: 1 (if the record represents a purchase of a promoted ASIN) or 0 (if the record does not represent a purchase of a promoted ASIN).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| purchases_clicks                                                  | LONG          | METRIC           | The number of purchases of promoted ASINs on Amazon, attributed to an ad click. Possible values for this field are: 1 (if the record represents a click-attributed purchase of a promoted ASIN) or 0 (if the record does not represent a click-attributed purchase of a promoted ASIN).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| purchases_views                                                   | LONG          | METRIC           | The number of purchases of promoted ASINs on Amazon, attributed to an ad view. Possible values for this field are: 1 (if the record represents a view-attributed purchase of a promoted ASIN) or 0 (if the record does not represent a view-attributed purchase of a promoted ASIN).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | NONE                  |\n","| request_tag                                                       | STRING        | DIMENSION        | ID that connects related impression, view, click, and conversion events. For example, if an impression served has a request_tag value of 'X', related conversion events will have have an impression_id value of 'X'. While this occurs infrequently, there are sometimes duplicate request_tag values. As a result, it is not recommended to use request_tag as a JOIN key without first grouping by it. Rather, it is a best practice to first consider using UNION ALL in a query instead of joining based on the request_tag to combine data sources. For insights that involve user-level ad exposure across tables, use user_id instead.                                                                                                                                                                                      | VERY_HIGH            |\n","| site                                                               | STRING        | DIMENSION        | The site descriptor where the Amazon DSP impression event occurred. A site can be any digital property where ads are served, including websites, mobile apps, and streaming platforms. Note that different types of environments may have different formatting. For example, 'widgets.com' for a web property, 'Widgets iOS (ID: 1234567890)' for an app property.                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW                   |\n","| supply_cost                                                       | LONG          | METRIC           | The cost (in microcents) that Amazon DSP pays a publisher or publisher ad tech platform (such as an SSP or exchange) for an impression. To convert supply_cost to dollars/your local currency, divide by 100,000,000 (e.g., 100,000,000 microcents = $1.00). Example value: '5000'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | NONE                  |\n","| supply_source                                                     | STRING        | DIMENSION        | Supply source from which the Amazon DSP impression was purchased. Supply sources can include Amazon-owned properties (like Amazon.com and Twitch), Amazon Publisher Services inventory, and third-party partners. Example values: 'AMAZON.COM', 'TWITCH WEB VIDEO', 'PUBMATIC WEB DISPLAY'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| targeting                                                          | STRING        | DIMENSION        | Keyword used by the advertiser for targeting on sponsored ads campaigns. Example value: 'premium widgets'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| total_add_to_cart                                               | LONG          | METRIC           | The number of times Add to Cart was clicked for promoted and brand halo ASINs on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_add_to_cart = add_to_cart + brand_halo_add_to_cart. Possible values for this field are: 1 (if the record represents an add to cart conversion) or 0 (if the record does not represent an add to cart conversion).                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| total_add_to_cart_clicks                                       | LONG          | METRIC           | The number of times Add to Cart was clicked for promoted and brand halo ASINs on Amazon, attributed to an ad click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_add_to_cart_clicks = add_to_cart_clicks + brand_halo_add_to_cart_clicks. Possible values for this field are: 1 (if the record represents a click-attributed add to cart conversion) or 0 (if the record does not represent a click-attributed add to cart conversion).                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| total_add_to_cart_views                                        | LONG          | METRIC           | The number of times Add to Cart was clicked for promoted and brand halo ASINs on Amazon, attributed to an ad view. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_add_to_cart_views = add_to_cart_views + brand_halo_add_to_cart_views. Possible values for this field are: 1 (if the record represents a view-attributed add to cart conversion) or 0 (if the record does not represent a view-attributed add to cart conversion).                                                                                                                                                                                                                                                                                                                            | NONE                  |\n","| total_detail_page_view                                          | LONG          | METRIC           | The number of detail page views for promoted and brand halo ASINs on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_detail_page_view = detail_page_view + brand_halo_detail_page_view. Possible values for this field are: 1 (if the record represents a detail page view conversion) or 0 (if the record does not represent a detail page view conversion).                                                                                                                                                                                                                                                                                                                                                             | NONE                  |\n","| total_detail_page_view_clicks                                  | LONG          | METRIC           | The number of detail page views for promoted and brand halo ASINs on Amazon, attributed to an ad click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_detail_page_view_clicks = detail_page_view_clicks + brand_halo_detail_page_view_clicks. Possible values for this field are: 1 (if the record represents a click-attributed detail page view conversion) or 0 (if the record does not represent a click-attributed detail page view conversion).                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| total_detail_page_view_views                                   | LONG          | METRIC           | The number of detail page views for promoted and brand halo ASINs on Amazon, attributed to an ad view. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_detail_page_view_views = detail_page_view_views + brand_halo_detail_page_view_views. Possible values for this field are: 1 (if the record represents a view-attributed detail page view conversion) or 0 (if the record does not represent a view-attributed detail page view conversion).                                                                                                                                                                                                                                                                                                               | NONE                  |\n","| total_product_sales                                              | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted and brand halo ASINs purchased on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_product_sales = product_sales + brand_halo_product_sales. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | NONE                  |\n","| total_product_sales_clicks                                      | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted and brand halo ASINs purchased on Amazon, attributed to an ad click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_product_sales_clicks = product_sales_clicks + brand_halo_product_sales_clicks. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | NONE                  |\n","| total_product_sales_views                                       | DECIMAL(38,4) | METRIC           | The sales (in local currency) of promoted and brand halo ASINs purchased on Amazon, attributed to an ad view. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_product_sales_views = product_sales_views + brand_halo_product_sales_views. Example value: '64.99'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| total_purchases                                                   | LONG          | METRIC           | The number of purchases of promoted and brand halo ASINs on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_purchases = purchases + brand_halo_purchases. Possible values for this field are: 1 (if the record represents a purchase of a promoted or brand halo ASIN) or 0 (if the record does not represent a purchase of a promoted or brand halo ASIN).                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| total_purchases_clicks                                           | LONG          | METRIC           | The number of purchases of promoted and brand halo ASINs on Amazon, attributed to an ad click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_purchases_clicks = purchases_clicks + brand_halo_purchases_clicks. Possible values for this field are: 1 (if the record represents a click-attributed purchase of a brand halo product) or 0 (if the record does not represent a click-attributed purchase of a promoted or brand halo ASIN).                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| total_purchases_views                                            | LONG          | METRIC           | The number of purchases of promoted and brand halo ASINs on Amazon, attributed to an ad view. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_purchases_views = purchases_views + brand_halo_purchases_views. Possible values for this field are: 1 (if the record represents a view-attributed purchase of a brand halo product) or 0 (if the record does not represent a view-attributed purchase of a promoted or brand halo ASIN).                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| total_units_sold                                                 | LONG          | METRIC           | The quantity of promoted and brand halo ASINs purchased on Amazon, attributed to an ad view or click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_units_sold = units_sold + brand_halo_units_sold. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | NONE                  |\n","| total_units_sold_clicks                                         | LONG          | METRIC           | The quantity of promoted and brand halo ASINs purchased on Amazon, attributed to an ad click. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_units_sold_clicks = units_sold_clicks + brand_halo_units_sold_clicks. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | NONE                  |\n","| total_units_sold_views                                          | LONG          | METRIC           | The quantity of promoted and brand halo ASINs purchased on Amazon, attributed to an ad view. Brand halo ASINs are products from the same brand as the ASINs promoted by the campaign. Note that total_units_sold_views = units_sold_views + brand_halo_units_sold_views. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| tracked_asin                                                      | STRING        | DIMENSION        | The ASIN of the conversion event. An ASIN (Amazon Standard Identification Number) is a unique 10-character identifier assigned to products sold on Amazon. ASINs that appear in this field were either directly promoted by the campaign or are products from the same brand as the promoted ASINs. This field will only be populated for on-Amazon purchases (event_category = purchase); for other conversion types, this field will be NULL. When this field is populated, tracked_item will have the same value. Example value: 'B01234ABCD'.                                                                                                                                                                                                                                                                                    | LOW                   |\n","| tracked_item                                                      | STRING        | DIMENSION        | Identifier for the conversion event item. The value in this field depends on the subtype of the conversion event. For ASIN-related conversions on Amazon such as purchases, detail page views, add to cart events, this field will contain the ASIN of the product. For brand store events, this field will contain the brand store ID. For branded search conversions on Amazon, this field will contain the ad-attributed branded search keyword. For off-Amazon conversions, this field will contain the ID of the conversion definition. Note that when tracked_asin is populated, the same value will appear in tracked_item.                                                                                                                                                                                                    | LOW                   |\n","| traffic_event_date                                               | DATE          | DIMENSION        | Date of the traffic event in advertiser timezone. Traffic events are events (such as ad view or click events) that can be given credit for a conversion event. Example value: '2025-01-01'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| traffic_event_date_utc                                          | DATE          | DIMENSION        | Date of the traffic event in Coordinated Universal Time (UTC). Traffic events are events (such as ad view or click events) that can be given credit for a conversion event. Example value: '2025-01-01'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| traffic_event_dt                                                 | TIMESTAMP     | DIMENSION        | Timestamp of the traffic event in advertiser timezone. Traffic events are events (such as ad view or click events) that can be given credit for a conversion event. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | MEDIUM                |\n","| traffic_event_dt_hour                                           | TIMESTAMP     | DIMENSION        | Timestamp of the traffic event in advertiser timezone, truncated to hour. Traffic events are events (such as ad view or click events) that can be given credit for a conversion event. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| traffic_event_dt_hour_utc                                      | TIMESTAMP     | DIMENSION        | Timestamp of the traffic event in Coordinated Universal Time (UTC), truncated to hour. Traffic events are events (such as ad view or click events) that can be given credit for a conversion event. Example value: '2025-01-01T12:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | LOW                   |\n","| traffic_event_dt_utc                                            | TIMESTAMP     | DIMENSION        | Timestamp of the traffic event in Coordinated Universal Time (UTC). Traffic events are events (such as ad view or click events) that can be given credit for a conversion event. Example value: '2025-01-01T00:00:00.000Z'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | MEDIUM                |\n","| traffic_event_hour                                               | INTEGER       | DIMENSION        | Hour of day when the traffic event occurred, in advertiser timezone. Values range from 0-23 representing 24-hour time. Traffic events are events (such as ad view or click events) that can be given credit for a conversion event. Example value: '14' (represents 2:00 PM in 24-hour time).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | LOW                   |\n","| traffic_event_hour_utc                                          | INTEGER       | DIMENSION        | Hour of day when the traffic event occurred, in Coordinated Universal Time (UTC). Values range from 0-23 representing 24-hour time. Traffic events are events (such as ad view or click events) that can be given credit for a conversion event. Example value: '14' (represents 2:00 PM in 24-hour time).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| traffic_event_id                                                 | STRING        | DIMENSION        | Internal event ID that uniquely identifies sponsored ads traffic events. This ID represents a traffic event from a sponsored ads campaign. To join sponsored ads traffic to attributed events, join traffic_event_id in this table to event_id in sponsored_ads_traffic.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | VERY_HIGH            |\n","| traffic_event_marketplace_name                                  | STRING        | DIMENSION        | Name of the marketplace where the traffic event occurred. A marketplace represents a regional Amazon storefront where customers can make purchases. Example values: 'AMAZON.COM', 'AMAZON_CA'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| traffic_event_subtype                                            | STRING        | DIMENSION        | Type of traffic event that led to the conversion. Traffic events represent interactions with ads, such as when an ad is displayed to a user or when a user clicks on an ad. Possible values include: AD_IMP (ad view event) and AD_CLICK (ad click event).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | LOW                   |\n","| traffic_event_type                                               | STRING        | DIMENSION        | Type of traffic event that led to the attributed conversion. Traffic events represent the ad view or click events from Amazon Ads campaigns that can be credited with driving conversion events. Possible values include: TRAFFIC.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| units_sold                                                        | LONG          | METRIC           | The quantity of promoted ASINs purchased on Amazon, attributed to an ad view or click. A campaign can have multiple units sold in a single purchase event. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | NONE                  |\n","| units_sold_clicks                                                | LONG          | METRIC           | The quantity of promoted ASINs purchased on Amazon, attributed to an ad click. A campaign can have multiple units sold in a single purchase event. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| units_sold_views                                                 | LONG          | METRIC           | The quantity of promoted ASINs purchased on Amazon, attributed to an ad view. A campaign can have multiple units sold in a single purchase event. Example value: '3'.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| user_id                                                           | STRING        | DIMENSION        | Pseudonymous identifier that connects user activity across different events. The field can contain ad user IDs (representing Amazon accounts), device IDs, or browser IDs. NULL values appear when Amazon Ads is unable to resolve an identifier for an event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT user_id).                                                                                                                                                                                                                                                                                                                                                   | VERY_HIGH            |\n","| user_id_type                                                     | STRING        | DIMENSION        | Type of user ID value. AMC includes different types of user ID values, depending on whether the value represents a resolved Amazon account, a device, or a browser cookie. If Amazon Ads is unable to determine or provide an ID of any kind for a conversion event, the user_id and user_id_type values for that record will be NULL. Possible values include: adUserId, sisDeviceId, adBrowserId, and NULL.                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n"],"documentType":"guide"},{"title":"Sponsored ads traffic","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/sponsored_ads_traffic","content":[" Analytics table: \n","sponsored_ads_traffic\n"," Audience table: \n","sponsored_ads_traffic_for_audiences\n"," This table contains impression events, click events, and video creative messages from Sponsored Products, Sponsored Brands, Sponsored Display, and Sponsored TV campaigns. There will be 1 record per sponsored ads impression event and 1 record per click event originated from a sponsored ads campaign.\n"," You may use the ad_product_type field to filter these traffic events to the specific ad product they originated from. For example, records where ad_product_type has a value of sponsored_products are representative of Sponsored Products traffic events.\n","| Name | Data type | Metric/dimension | Description | Aggregation threshold |\n","\\| --------------------------------- \\| --------- \\| ---------------- \\| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| --------------------- \\|\n","| ad_group | STRING | DIMENSION | Name of the sponsored ads ad group. Ad groups are a way to organize and manage ads within a campaign, allowing you to group your ads by elements like brand, product, category, price range, or other classifications. Values in the ad_group field will match values in the line_item field. Example value: 'SP_Widgets_Spring_2025'. | LOW |\n","| ad_group_end_dt | TIMESTAMP | DIMENSION | End date and time of the sponsored ads ad group in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| ad_group_end_dt_utc | TIMESTAMP | DIMENSION | End date and time of the sponsored ads ad group in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| ad_group_start_dt | TIMESTAMP | DIMENSION | Start date and time of the sponsored ads ad group in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| ad_group_start_dt_utc | TIMESTAMP | DIMENSION | Start date and time of the sponsored ads ad group in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| ad_group_status | STRING | DIMENSION | Status of the sponsored ads ad group. The status indicates whether the ad group is currently active and eligible to serve ads, temporarily paused, or permanently archived. Possible values include: ENABLED, PAUSED, and ARCHIVED. | LOW |\n","| ad_group_type | STRING | DIMENSION | Type of sponsored ads ad group. | LOW |\n","| ad_product_type | STRING | DIMENSION | Type of sponsored ads campaign that generated the traffic event. Sponsored ads includes several ad products with distinct features and ad formats. Possible values include: sponsored_products, sponsored_brands, sponsored_display, and sponsored_television. | LOW |\n","| advertiser | STRING | DIMENSION | Name of the business entity running advertising campaigns on sponsored ads. Example value: 'Widgets Inc'. | LOW |\n","| advertiser_timezone | STRING | DIMENSION | Advertiser timezone. This setting aligns with the advertiser timezone configuration in the connected sponsored ads account. Example value: 'America/New_York'. | LOW |\n","| campaign | STRING | DIMENSION | Name of the sponsored ads campaign responsible for the traffic event. A campaign is a container that groups related advertising efforts with shared objectives, budget, and flight dates. Example value: 'Widgets_Q1_2024_Keywords_US'. | LOW |\n","| campaign_budget_type | STRING | DIMENSION | Type of budget allocation for a sponsored ads campaign. Campaign budgets can be set to either spend up to a maximum amount per day or spread a total budget across the lifetime of the campaign. Possible values include: DAILY_BUDGET and LIFETIME_BUDGET. | LOW |\n","| campaign_end_date | DATE | DIMENSION | End date of the sponsored ads campaign in advertiser timezone. Example value: '2025-01-01'. | LOW |\n","| campaign_end_date_utc | DATE | DIMENSION | End date of the sponsored ads campaign in Coordinated Universal Time (UTC). Example value: '2025-01-01'. | LOW |\n","| campaign_end_dt | TIMESTAMP | DIMENSION | End date and time of the sponsored ads campaign in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_end_dt_utc | TIMESTAMP | DIMENSION | End date of the sponsored ads campaign in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| campaign_id | LONG | DIMENSION | The ID of the sponsored ads campaign associated with the traffic event. This campaign ID can be used in the Ads API, and may differ from the campaign ID shown in the ads console (found in campaign_id_string). Example value: '123456789012345'. | LOW |\n","| campaign_id_string | STRING | DIMENSION | The ID of the sponsored ads campaign associated with the traffic event. This is the campaign ID shown in the ads console, and may differ from the campaign ID used in the Ads API (found in campaign_id). Example value: 'A087654321ABC2Y3WXYZ'. | LOW |\n","| campaign_start_date | DATE | DIMENSION | Start date of the sponsored ads campaign in advertiser timezone. Example value: '2025-01-01'. | LOW |\n","| campaign_start_date_utc | DATE | DIMENSION | Start date of the sponsored ads campaign in Coordinated Universal Time (UTC). Example value: '2025-01-01'. | LOW |\n","| campaign_start_dt | TIMESTAMP | DIMENSION | Start date and time of the sponsored ads campaign in advertiser timezone. The campaign start date determines when a campaign begins serving impressions. Example value: '2025-01-01T00:00:00.000Z'. | LOW |\n","| campaign_start_dt_utc | TIMESTAMP | DIMENSION | Start date and time of the sponsored ads campaign in Coordinated Universal Time (UTC). The campaign start date determines when a campaign begins serving impressions. Example value: '2025-01-01T00:00:00.000Z'. | LOW |\n","| clicks | LONG | METRIC | Count of sponsored ads clicks. Possible values for this field are: 1 (if the record represents a click event) or 0 (if the record does not represent a click event). | NONE |\n","| creative | STRING | DIMENSION | Name of the sponsored ads creative/ad. A creative represents the actual advertisement shown to customers. Example value: '2025_US_Widgets_B01234ABC'. | LOW |\n","| creative_asin | STRING | DIMENSION | The ASIN that appears in the ad. This may differ from the conversion event ASIN (i.e. tracked_asin value) for attributed conversions. Note that this field is only populated for a subset of Sponsored Products and Sponsored Display events. For other ad products, creative_asin will be NULL. | LOW |\n","| creative_type | STRING | DIMENSION | Type of creative/ad. Creative types help categorize different ad formats and content types used in sponsored ads campaigns. Possible values include: static_image, video, third_party_creative. | LOW |\n","| currency_iso_code | STRING | DIMENSION | Currency ISO code associated with the monetary values in the table. The three-letter currency code follows the ISO 4217 standard format and is determined by the currency setting in the connected sponsored ads account. Example value: 'USD'. | LOW |\n","| currency_name | STRING | DIMENSION | Currency name associated with the monetary values in the table. Currency is determined by the currency setting in the connected sponsored ads account. Example value: 'Dollar (USA)'. | LOW |\n","| customer_search_term | STRING | DIMENSION | Search term entered by a shopper on Amazon that led to the traffic event. Search terms represent the actual text that shoppers type into the Amazon search bar, as opposed to advertiser-defined keywords. Example value: 'blue widgets 3 pack'. | LOW |\n","| entity_id | STRING | DIMENSION | ID of the Amazon Ads entity (also known as seat) associated with the traffic event. An entity represents a sponsored ads account within which media is further organized by advertiser and by campaign. Example value: 'ENTITYABC123XYZ789'. | LOW |\n","| event_date | DATE | DIMENSION | Date of the sponsored ads traffic event in advertiser timezone. Example value: '2025-01-01'. | LOW |\n","| event_date_utc | DATE | DIMENSION | Date of the sponsored ads traffic event in Coordinated Universal Time (UTC). Example value: '2025-01-01' | LOW |\n","| event_day | INTEGER | DIMENSION | Day of month when the sponsored ads traffic event occurred, in advertiser timezone. Values range from 0-23 representing 24-hour time. Example value: '1' (represents first day of the month). | LOW |\n","| event_day_utc | INTEGER | DIMENSION | Day of month when the sponsored ads traffic occurred, in Coordinated Universal Time (UTC). Values range from 0-23 representing 24-hour time. Example value: '1' (represents first day of the month). | LOW |\n","| event_dt | TIMESTAMP | DIMENSION | Timestamp of the sponsored ads traffic event in advertiser timezone. Example value: '2025-01-01T12:00:00.000Z'. | MEDIUM |\n","| event_dt_hour | TIMESTAMP | DIMENSION | Timestamp of the sponsored ads traffic event in advertiser timezone, truncated to hour. Example value: '2025-01-01T12:00:00.000Z'. | LOW |\n","| event_dt_hour_utc | TIMESTAMP | DIMENSION | Timestamp of the sponsored ads traffic event in Coordinated Universal Time (UTC), truncated to hour. Example value: '2025-01-01T12:00:00.000Z'. | LOW |\n","| event_dt_utc | TIMESTAMP | DIMENSION | Timestamp of the sponsored ads traffic event in Coordinated Universal Time (UTC). Example value: '2025-01-01T00:00:00.000Z'. | MEDIUM |\n","| event_hour | INTEGER | DIMENSION | Hour of day when the sponsored ads traffic event occurred, in advertiser timezone. Values range from 0-23 representing 24-hour time. Example value: '14' (represents 2:00 PM in 24-hour time). | LOW |\n","| event_hour_utc | INTEGER | DIMENSION | Hour of day when the sponsored ads traffic occurred, in Coordinated Universal Time (UTC). Values range from 0-23 representing 24-hour time. Example value: '14' (represents 2:00 PM in 24-hour time). | LOW |\n","| event_id | STRING | DIMENSION | Internal event ID that uniquely identifies sponsored ads traffic events. This ID represents either a traffic event from a sponsored ads campaign. To join sponsored ads traffic to attributed events, join event_id in this table to traffic_event_id in the amazon_attributed\\_\\* tables. | VERY_HIGH |\n","| five_sec_views | LONG | METRIC | The count of sponsored ads video impressions where the video was viewed for at least five seconds. Possible values for this field are: 1 (if the impression represents a qualifying video view) or 0 (if the impression does not represent a qualifying video view). Note that for video impressions where the video length is less than five seconds, this field will always be 1. | NONE |\n","| household_id | STRING | DIMENSION | Pseudonymous household ID for the user at the time of the traffic event. The same user may have different IDs across events if the user moves households. NULL when Amazon Ads cannot resolve the user or household. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT household_id). Data is available from April 10, 2026 onward, with household ID coverage varying by region. | VERY_HIGH |\n","| household_size | STRING | DIMENSION | Size of the household. Possible values for this field are: NULL, '1', '2', '3', and '4+'. | HIGH |\n","| impressions | LONG | METRIC | Count of sponsored ads impressions. Possible values for this field are: 1 (if the record represents a sponsored ads impression) or 0 (if the record does not represent a sponsored ads impression). | NONE |\n","| ip_address | STRING | DIMENSION | Pseudonymous identifier that represents the IP address received for an ad event. The field can contain either IPv4 or IPv6 values. NULL values appear when Amazon Ads does not receive an IP address for the event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes such as COUNT(DISTINCT ip_address). | VERY_HIGH |\n","| is_amazon_business | BOOLEAN | DIMENSION | Boolean value indicating whether the event occurred on the Amazon Business retail site. This field is supported for Sponsored Products and Sponsored Brands, and will be NULL for all other ad products. Possible values for this field are: true (appeared on the Amazon Business retail site), false (did not appear on the Amazon Business retail site/appeared elsewhere), and NULL (unknown). | LOW |\n","| line_item | STRING | DIMENSION | Name of the sponsored ads ad group. Values in the line_item field will match values in the ad_group field. Ad groups are a way to organize and manage ads within a campaign, allowing you to group your ads by elements like brand, product, category, price range, or other classifications. Example value: 'SP_Widgets_Spring_2025'. | LOW |\n","| line_item_end_date | TIMESTAMP | DIMENSION | End date and time of the line item in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_end_date_utc | TIMESTAMP | DIMENSION | End date and time of the line item in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_id | LONG | DIMENSION | ID of the Amazon DSP line item responsible for the impression event. Attributes like ad format and targeting are defined at line item level within a campaign. Example value: '5812345678901234'. | LOW |\n","| line_item_price_type | STRING | DIMENSION | Pricing model used for the line item. Line items can use different pricing models to determine how costs are calculated, with Cost Per Mille (CPM) being a common model where advertisers pay per thousand impressions. Example value: 'CPM'. | LOW |\n","| line_item_start_date | TIMESTAMP | DIMENSION | Start date and time of the line item in advertiser timezone. Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_start_date_utc | TIMESTAMP | DIMENSION | Start date and time of the line item in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | LOW |\n","| line_item_status | STRING | DIMENSION | Status of the sponsored ads ad group. Values in the line_item_status field will match values in the ad_group_status field. The status indicates whether the ad group is currently active and eligible to serve ads, temporarily paused, or permanently archived. Possible values include: ENABLED, PAUSED, and ARCHIVED. | LOW |\n","| line_item_type | STRING | DIMENSION | Type of line item. | LOW |\n","| marketplace_name | STRING | DIMENSION | Marketplace Name | LOW |\n","| match_type | STRING | DIMENSION | Type of match between targeting keyword and customer search term that resulted in the sponsored ads impression. Match types determine how closely a customer search term needs to match your targeted keyword for your ad to be eligible to display. Possible values include: BROAD (matches if search term contains all keyword terms in any order, including plural forms and related queries and variations), PHRASE (search term must contain the exact phrase or sequence of words, or its plural form), EXACT (search term must exactly match the keyword or its plural form), and NULL (for media that is not keyword-targeted). | LOW |\n","| matched_behavior_segment_ids | STRING | DIMENSION | For those sponsored ads impressions that were subject to an audience bid multiplier, the segment ID for the matched audience. This may include first-party segments or Amazon-created segments. | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Boolean value indicating whether the event can be used for audience creation that is third-party tracking enabled (i.e. whether you can serve creative with third-party tracking when running media against the audience). Third-party tracking refers to measurement tags and pixels from external vendors that can be used to measure ad performance. Possible values for this field are: true, false. | NONE |\n","| operating_system | STRING | DIMENSION | Operating system of the device where the sponsored ads traffic event occurred. Example values: 'iOS', 'Android', 'Windows', 'macOS', 'Roku OS'. | LOW |\n","| os_version | STRING | DIMENSION | Operating system version of the device where the sponsored ads traffic event occurred. The version format varies by operating system type. Example value: '17.5.1'. | LOW |\n","| placement_type | STRING | DIMENSION | Location where the sponsored ad appeared, primarily relevant for impressions on Amazon properties. Example values include: 'Top of Search on-Amazon', 'Detail Page on-Amazon', 'Homepage on-Amazon', 'Off Amazon'. | LOW |\n","| portfolio_id | LONG | DIMENSION | The ID of the portfolio that the campaign belongs to. Portfolios are groups of campaigns that you can organize to meet your advertising needs, such as grouping campaigns by brand, product category, or season. | LOW |\n","| portfolio_name | STRING | DIMENSION | The name of the portfolio that the campaign belongs to. Portfolios are groups of campaigns that you can organize to meet your advertising needs, such as grouping campaigns by brand, product category, or season. | LOW |\n","| spend | LONG | METRIC | The total advertising cost in microcents for the sponsored ads traffic event. Note that some ad products, such as Sponsored Products, only incur costs for click events. Since this field is in microcents, divide by 100,000,000 to convert to dollars/your local currency (e.g., 100,000,000 microcents = $1.00). Refer to the currency_name field for the currency in which the impression was purchased. Example value: '325000'. | NONE |\n","| targeting | STRING | DIMENSION | Keyword used by the advertiser for targeting. Example value: 'premium widgets'. | LOW |\n","| unmeasurable_viewable_impressions | LONG | METRIC | Count of unmeasurable viewable/synthetic view events. Unmeasurable viewable and synthetic viewable events are estimated to be viewable, but could not be measured for viewability. Possible values for this field are: '1' (if the record represents an unmeasurable viewable/synthetic view event) or '0' (if the record does not represent an unmeasurable viewable/synthetic view event). | NONE |\n","| user_id | STRING | DIMENSION | Pseudonymous identifier that connects user activity across different events. The field can contain ad user IDs (representing Amazon accounts), device IDs, or browser IDs. NULL values appear when Amazon Ads is unable to resolve an identifier for an event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT user_id). | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID value. AMC includes different types of user ID values, depending on whether the value represents a resolved Amazon account, a device, or a browser cookie. If Amazon Ads is unable to determine or provide an ID of any kind for a traffic event, the user_id and user_id_type values for that record will be NULL. Possible values include: adUserId, sisDeviceId, adBrowserId, and NULL. | LOW |\n","| video_complete_views | LONG | METRIC | The number of sponsored ads video impressions where the video was viewed to completion (100%). Possible values for this field are: '1' (if the video was viewed to completion) or '0' (if the video was not viewed to completion). | NONE |\n","| video_first_quartile_views | LONG | METRIC | The number of sponsored ads video impressions where the video was viewed to the first quartile (at least 25% completion). Possible values for this field are: '1' (if the video was viewed to at least 25% completion) or '0' (if the video was not viewed to 25% completion). | NONE |\n","| video_midpoint_views | LONG | METRIC | The number of sponsored ads video impressions where the video was viewed to the midpoint (at least 50% completion). Possible values for this field are: '1' (if the video was viewed to at least 50% completion) or '0' (if the video was not viewed to 50% completion). | NONE |\n","| video_third_quartile_views | LONG | METRIC | The number of sponsored ads video impressions where the video was viewed to the third quartile (at least 75% completion). Possible values for this field are: 1 (if the video was viewed to at least 75% completion) or 0 (if the video was not viewed to 75% completion). | NONE |\n","| video_unmutes | LONG | METRIC | The count of sponsored ads video impressions where a shopper unmuted the video. Possible values for this field are: '1' (if the video was unmuted) or '0' (if the video was not unmuted). | NONE |\n","| view_definition | STRING | DIMENSION | Type of viewability measurement definition used to classify the view event. This field will be NULL for non-view events. | LOW |\n","| viewable_impressions | LONG | METRIC | The count of sponsored ads impressions that were considered viewable. An impression is considered viewable when at least 50% of the pixels of the ad are in view for at least one continuous second for display ads, or two continuous seconds for video ads. This is the Media Rating Council (MRC) definition of viewability. Possible values for this field are: '1' (if the record represents a viewable impression) or '0' (if the record does not represent a viewable impression). | NONE |\n"],"documentType":"guide"},{"title":"Amazon Live Traffic table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/amazon_live_traffic","content":[" Analytics table:\n","amazon_live_traffic\n"," Audiences table:\n","amazon_live_traffic_for_audiences\n"," The amazon_live_traffic table includes Amazon Live impression, click, and view events, at the granularity of the product carousel ads that run alongside Amazon Live broadcasts. Use this table to generate insights about your Amazon Live media.\n"," Amazon Live impression, click, and view events, captured at the granularity of product carousel ads that run alongside Amazon Live broadcasts. Each row represents a single event type (impression, click, or view) for a product carousel ad, enabling detailed performance analysis of your shoppable live content. Use this table to understand customer engagement with your Amazon Live media, create remarketing audiences, and analyze performance alongside other advertising channels.\n"," Events are available for managed-service Amazon Live media in the US market from May 1, 2025 onwards. Note that broadcast_id is available after May 9, 2025, and creative_asin is available after July 15, 2025. Join with amazon_attributed_events\\_\\* tables (where ad_product_type = amazon_live) to analyze conversion impact. Your Amazon Live media may also include Amazon DSP activity, which can be found in your dsp\\_\\* tables (as long as the associated Amazon DSP advertiser is connected to your instance). \n"," To ensure your Amazon Live signals are available for querying in your AMC instance, please work with your Amazon Ads representative to set up this connection.\n"],"documentType":"guide"},{"title":"Amazon Live Traffic table","sectionHeader":{"type":2,"text":"`amazon_live_traffic`"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/amazon_live_traffic","content":["| Name | Data type | Metric/Dimension | Description | Aggregation threshold |\n","\\|------\\|-----------\\|-------------------\\|-------------\\|-----------------------\\|\n","| ad_product_type | STRING | DIMENSION | Type of Amazon Ads ad product responsible for the traffic event. In this table, this field will always display the value amazon_live. | LOW |\n","| advertiser | STRING | DIMENSION | Amazon Live advertiser name. Example value: 'Widgets Inc'. | LOW |\n","| broadcast_date_utc | DATE | DIMENSION | Initial broadcast date in Coordinated Universal Time (UTC). Example value: '2025-01-01'. | LOW |\n","| broadcast_id | STRING | DIMENSION | The ID of the Amazon Live broadcast, which can be found in the URL of the Amazon Live broadcast page: https&#x3A;//www.amazon.com/live/broadcast/\\[broadcast_id]. This ID will be consistent across livestream and playback/on-demand events of the same Amazon Live video. Note that this field is only available for broadcasts with a broadcast date of 2025-05-09 or later. Example value: 'a1a1a1a1-b2b2-c3c3-d4d4-e5e5e5e5e5e5'. | LOW |\n","| broadcast_name | STRING | DIMENSION | The name of the Amazon Live broadcast. Note that this field is only available for broadcasts with a broadcast date after 2025-05-01. Example value: 'Widgets Inc Back to School 2025'. | LOW |\n","| clicks | LONG | METRIC | Count of Amazon Live product carousel ad clicks. Possible values for this field are: 1 (if the record represents a click event) or 0 (if the record does not represent a click event). | NONE |\n","| creative_asin | STRING | DIMENSION | The ASIN promoted by the ad within the Amazon Live product carousel. Note that this field is only available for broadcasts with a broadcast date of 2025-07-15 or later. Example value: 'B01234ABCD'. | LOW |\n","| creative_id | LONG | DIMENSION | ID of the Amazon Live product carousel ad. A product carousel ad appears alongside the Amazon Live broadcast and highlights an ASIN featured in the video. | LOW |\n","| event_date_utc | DATE | DIMENSION | Date of the Amazon Live event in Coordinated Universal Time (UTC). Example value: '2025-01-01'. | LOW |\n","| event_day_utc | INTEGER | DIMENSION | Day of month when the Amazon Live event occurred in Coordinated Universal Time (UTC). Example value: '1'. | LOW |\n","| event_dt_hour_utc | TIMESTAMP | DIMENSION | Timestamp of the Amazon Live event in Coordinated Universal Time (UTC), truncated to hour. Example value: '2025-01-01T12:00:00.000Z'. | LOW |\n","| event_dt_utc | TIMESTAMP | DIMENSION | Timestamp of the Amazon Live event in Coordinated Universal Time (UTC). Example value: '2025-01-01T23:59:59.000Z'. | MEDIUM |\n","| event_hour_utc | INTEGER | DIMENSION | Hour of the Amazon Live event in Coordinated Universal Time (UTC). Example value: '14' (represents 2:00 PM in 24-hour time). | LOW |\n","| event_id | STRING | DIMENSION | Internal event ID for the Amazon Live traffic event, where the event could be an Amazon Live product carousel ad impression, click, or view. To join Amazon Live traffic to attributed events, join event_id in this table to traffic_event_id in the amazon_attributed\\_\\* tables. | VERY_HIGH |\n","| household_id | STRING | DIMENSION | Pseudonymous household ID for the user at the time of the traffic event. The same user may have different IDs across events if the user moves households. NULL when Amazon Ads cannot resolve the user or household. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT household_id). Data is available from April 10, 2026 onward, with household ID coverage varying by region. | VERY_HIGH |\n","| household_size | STRING | DIMENSION | Size of the household. Possible values for this field are: NULL, 1, 2, 3, and 4+. | HIGH |\n","| impressions | LONG | METRIC | Count of Amazon Live product carousel ad impressions. Possible values for this field are: 1 (if the record represents an Amazon Live impression) or 0 (if the record does not represent an Amazon Live impression). | NONE |\n","| site | STRING | DIMENSION | The retail domain where the Amazon Live product carousel ad was displayed (for example, amazon.us, amazon.in). This can help you determine in which marketplace your media was run. | LOW |\n","| slot_name | STRING | DIMENSION | The environment in which the Amazon Live product carousel ad was displayed. Possible values include: carousel-desktop-web, carousel-mobile-web, carousel-mobile-app, and carousel-shoptv-app. | LOW |\n","| user_id | STRING | DIMENSION | Pseudonymous identifier that connects user activity across different events. The field can contain ad user IDs (representing Amazon accounts), device IDs, or browser IDs. NULL values appear when Amazon Ads is unable to resolve an identifier for an event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT user_id). | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID value. AMC includes different types of user ID values, depending on whether the value represents a resolved Amazon account, a device, or a browser cookie. If Amazon Ads is unable to determine or provide an ID of any kind for a click event, the user_id and user_id_type values for that record will be NULL. Possible values include: adUserId, sisDeviceId, adBrowserId, and NULL. | LOW |\n","| views | LONG | METRIC | Count of Amazon Live product carousel ad views (how many times the product carousel ad was at least 50% in-view for at least 1 second). Possible values for this field are: 1 (if the record represents an ad view event) or 0 (if the record does not represent an ad view event). | NONE |\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"What are AMC Paid features?"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" AMC Paid Features are a set of enhanced datasets that provide more expanded insights into customer behavior and advertising campaign performance than the standard AMC features. For analytics queries, these features require a monthly subscription and unlock access to a variety of signals, allowing for more granular analysis and targeted campaigns. Depending on availability and eligibility, you can leverage many of the associated paid features audience tables without a subscription.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"Amazon 1P signals available at no cost"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Starting June 1, 2026, all Amazon 1P signals covered under AMC Paid Features—Amazon Insights, Amazon Retail Purchases, Prime Video Insights, Prime Video Channel Insights, Amazon Your Garage, and Brand Store Insights—will be available to query at no cost through December 31, 2026 in all regions where AMC Paid Features are available.\n"," Eligible advertisers can subscribe through the AMC Paid Features page and run queries utilizing these signals at no additional cost, unlocking advanced measurement use cases. If you already have an active subscription, no action is needed — your subscription will automatically convert to zero dollars.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"Paid features availability and eligibility"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Which Paid features datasets that are available to you depend on:\n","The availability of the feature in certain regions and marketplaces. Availability varies per feature. For the full list of supported markets, refer to each dataset's availability details below. \\* The eligibility requirements of each paid feature (for example, Prime Video Channel insights is only available for Amazon advertisers that operate Prime Video Channels).\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":3,"text":"Analytics"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" For analytics datasets, before you can enroll in a paid features subscription or free trial, the paid feature must be available for the region or marketplace associated with your account and your instance must meet certain eligibility requirements. \n"," If the paid feature is not available for your region or marketplace, you will not see it on the Paid feature tab. If it is available, but you are not eligible, you will not be able to click Subscribe on the Paid features tab.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":3,"text":"Audiences"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" For audience datasets, if the Paid feature is available in your region or marketplace and your instance is eligible, the audience table will be automatically available in your instance. In this case, you do not have to subscribe to the Paid feature to start generating audiences.\n"," If it is not available or you are not eligible, you will not see the audience table in your instance and you will not be able to subscribe to that paid feature.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":3,"text":"Signal availability"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" The signals included in the paid features dataset may vary based on region or marketplace. For example, audiences created with the Amazon Retail Purchases (ARP) dataset will not include signals from the EU region or UK marketplace. These signals, however, are available for measurement queries using ARP. \n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":3,"text":"AMC paid features billing"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" AMC Paid feature subscription enrollments are facilitated through the eligible billing account types listed below. The billing accounts are inferred based on the advertiser resources that are associated with the AMC instance object.\n","Sponsored Ads entity billing accounts - DSP Self-Service entity billing accounts - Amazon Advertising Incentive Center Measurement Funds\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":3,"text":"How to subscribe to AMC Paid features"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" To subscribe to an AMC Paid feature:\n","Log into the Amazon advertising console and open the AMC user interface. 2. Go to the Paid features tab to view a listing of all paid features that are available to you. 3. If you are eligible to subscribe, click See options to view additional details, such as price, and to select a billing account. 4. Read the Amazon Marketing Cloud terms and conditions and click the checkbox to accept the terms and conditions. 5. When you are ready, click Subscribe. All users associated with this instance will now have access to the subscribed paid feature.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"Flexible Shopping Insights (FSI) as a part of Amazon Insights"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Availability:  AMC accounts associated with US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces\n"," Eligibility: Any AMC advertisers who are brand owners or sellers\n"," Contains signals from: All available marketplaces\n"," Flexible Shopping Insights (FSI) is a part of Amazon Insights subscription, and enables advertisers to generate combined, aggregated, and anonymized advertising and shopping insights for brands and products advertised through Amazon Ads\n","conversions_all\n"," For eligible advertisers and instances, the associated audience table can be used for AMC audience creation without a Paid feature subscription:\n","conversions_all_for_audiences\n"," Refer to conversions_all.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"Audience Segment Insights (ASI) as a part of Amazon Insights"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Availability:  AMC accounts associated with the US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces\n"," Eligibility: Any AMC advertisers\n"," Contains signals from: All available marketplaces\n"," Amazon Audience Segment Insights enable advertisers to conduct user-to-segment analysis within Amazon Marketing Cloud (AMC) for all Amazon Ads customers across all datasets published into AMC as well as segment-level analysis for advertiser uploaded datasets.\n"," Amazon Audience Segment Insights is a part of the Amazon Insights subscription for advertisers that sell on Amazon (endemic). Alternatively, Amazon Audience Segment Insights is available for advertisers that do not sell on Amazon (non-endemic) via a la carte subscription.\n","audience_segments\\_\\[amer|apac|eu]\\_inmarket  audience_segments\\_\\[amer|apac|eu]\\_inmarket_snapshot  audience_segments\\_\\[amer|apac|eu]\\_lifestyle  audience_segments\\_\\[amer|apac|eu]\\_lifestyle_snapshot  segment_metadata\n"," For eligible advertisers and instances, the associated audience tables can be used for AMC audience creation without a Paid feature subscription:\n","audience_segments\\_\\[amer|apac|eu]\\_inmarket_for_audiences  audience_segments\\_\\[amer|apac|eu]\\_inmarket_snapshot_for_audiences  audience_segments\\_\\[amer|apac|eu]\\_lifestyle_for_audiences  audience_segments\\_\\[amer|apac|eu]\\_lifestyle_snapshot_for_audiences  segment_metadata_for_audiences\n"," Refer to Amazon Audience Segment Insights.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"Amazon your garage"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Availability:  US, JP, CA, AU, UK, DE, FR, IT, ES marketplaces\n"," Eligibility: Any AMC advertisers\n"," Contains signals from: US, CA, UK, DE, FR, IT, ES, NL, PL, SE, JP, and AU Amazon websites\n"," Additionally, the Amazon Your Garage paid feature provides user-to-vehicle association details that describe vehicle type, the make and model of the vehicle, as well as detailed vehicle configuration attributes expressed in the context of an AMC user_id.\n","amazon_your_garage_all\n"," For eligible advertisers and instances, the associated audience table can be used for AMC audience creation without a Paid feature subscription:\n","amazon_your_garage_all_for_audiences\n"," Refer to Amazon your garage.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"Amazon Brand Store insights (BSI)"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Availability:  AMC accounts associated with US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces\n"," Eligibility: Advertisers with at least one active brand store\n"," Contains signals from: US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces\n"," Amazon Brand Store Insights (BSI) is an AMC paid feature that allows advertisers to tap into page visit, dwell time, and interaction signals from Amazon Brand Stores. \n","amazon_brand_store_page_views \\* amazon_brand_store_engagement_events\n"," For eligible advertisers and instances, the associated audience table can be used for AMC audience creation without a Paid feature subscription:\n","amazon_brand_store_page_views(\\_non_endemic)\\_for_audiences \\* amazon_brand_store_engagement_events(\\_non_endemic)\\_for_audiences\n"," Refer to Amazon brand store insights.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"Amazon retail purchases (ARP)"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Availability: AMC accounts/instances associated with US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces\n"," Eligibility:  Must sell their products in the Amazon Store and have associated their selling partner accounts (Vendor Central or Seller Central) with one or more of their Amazon Ads account that are associated with your AMC instance configuration.\n"," Contains signals from: US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces for measurement. Audiences are available in all marketplaces, but data from the United Kingdom and European Union (EU) is excluded from the audiences table.\n","For Vendor Central accounts, the scope of data will match what is shown in Vendor Central \"Reports > Retail Analytics > Sales > Distributor View = Manufacturing\".  \\*  For Seller Central accounts, the data scope should match what appears in Seller Central \"Reports > Business Reports > By ASIN Detail\" report.\n"," Amazon Retail Purchases is a paid feature dataset available in AMC that contains up to five years (60 months) of historical Amazon store purchase data.\n","amazon_retail_purchases\n"," For eligible advertisers and instances, the associated audience table can be used for AMC audience creation without a Paid feature subscription (excluding data from the United Kingdom and European Union):\n","amazon_retail_purchases_for_audiences\n"," Refer to Amazon retail purchases.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"Amazon Prime Video Insights (PVI)"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Availability: AMC accounts/instances associated with the US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces\n"," Eligibility: All AMC advertisers and instances within the eligible marketplaces above. Data coverage is limited to users an advertiser has reached through an upstream data join with ad traffic tables.\n"," Contains signals from: US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces\n"," Amazon Prime Video Insights helps advertisers better understand the entertainment preferences of their customers and how these intersect with other customer behaviors, enabling custom attribution for subscriptions, re-engagement campaigns, and audience overlap analysis. The PVI lookback window is 13 months.\n","pv_streaming_events_feed\n"," For eligible advertisers and instances, the associated audience table can be used for AMC audience creation without a Paid feature subscription:\n","pv_streaming_events_feed_for_audiences\n"," Refer to Amazon Prime Video Insights for full documentation.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"Amazon Prime Video Channel insights (PVCI)"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Availability: AMC accounts/instances associated with the US/CA/JP/AU/FR/IT/ES/UK/DE marketplaces\n"," Eligibility:  Only Amazon advertisers that operate Prime Video Channels\n"," Contains signals from: US/CA/JP/AU/FR/IT/ES/UK/DE marketplaces\n"," Amazon Prime Video Channel Insights is a collection of two AMC data views that represent Prime Video Channel subscriptions and streaming signals. (See Amazon Prime Video Insights above for the separate PVI dataset.)\n","amazon_pvc_enrollments \\* amazon_pvc_streaming_events_feed\n"," For eligible advertisers and instances, the associated audience table can be used for AMC audience creation without a Paid feature subscription:\n","amazon_pvc_enrollments_for_audiences \\* amazon_pvc_streaming_events_feed_for_audiences\n"," Refer to Amazon Prime Video Channel insights.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"NCS CPG Insights Stream"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Availability: AMC accounts/instances associated with the US AMC account marketplace\n"," Eligibility: Any advertiser\n"," Contains signals from: US marketplace\n"," The NCS CPG Insights Stream data source provides modeled offline transaction signals for all US households.\n","ncs_cpg_insights_stream\n"," For eligible advertisers and instances, the associated audience table can be used for AMC audience creation without a Paid feature subscription:\n","ncs_cpg_insights_stream_for_audiences\n"," Refer to NCS CPG Insights Stream.\n"],"documentType":"guide"},{"title":"Paid features overview","sectionHeader":{"type":2,"text":"Experian vehicle purchases insights"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/paid_features_overview","content":[" Availability:  AMC accounts associated with the US marketplace\n"," Eligibility: Any advertiser\n"," Contains signals from: US marketplace\n"," Experian Vehicle Purchase Insights allows you to measure the impact of their advertising on actual vehicle purchases, better understand path to purchase, and learn about how they can reach new audiences.\n","experian_vehicle_purchases\n"," There is no associated audience table.\n"],"documentType":"guide"},{"title":"Conversions all table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/conversions_all_paid","content":[" Analytics table: \n","conversions_all\n"," Audience table: \n","conversions_all_for_audiences\n"," Contains both ad-exposed and non-ad-exposed conversions for tracked ASINs. Conversions are ad-exposed if a user was served a traffic event within the 28-day period prior to the conversion event.\n","| Field Category  | Name                           | Data Type       | Metric / Dimension | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Aggregation Threshold |\n","\\| --------------- \\| ------------------------------ \\| --------------- \\| ------------------ \\| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| --------------------- \\|\n","| Conversion Info | conversion_id                 | STRING          | DIMENSION          | Unique identifier of the conversion event. In the dataset conversions, each row has a unique conversion_id. In the dataset conversions_with_relevance, the same conversion event will appear multiple times if a conversion is determined to be relevant to multiple campaigns, engagement scopes, or brand halo types.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | VERY_HIGH            |\n","| Conversion Info | conversions                    | LONG            | METRIC             | Conversion count.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| Conversion Info | event_category                | STRING          | DIMENSION          | For ASIN conversions, the event_category is the high level category of the conversion event, either purchase or website. Examples of ASIN conversions when event_category = website include: detail page views, add to wishlist, or the first Subscribe and Save order. For search conversions (when event_subtype = searchConversion), the event_category is always website. For pixel conversions, this field is always pixel.                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| Conversion Info | event_date_utc               | DATE            | DIMENSION          | Date of the conversion event in UTC.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| Conversion Info | event_day_utc                | INTEGER         | DIMENSION          | Day of the month of the conversion event in UTC.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| Conversion Info | event_dt_hour_utc           | TIMESTAMP       | DIMENSION          | Timestamp of the conversion event in UTC truncated to the hour.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| Conversion Info | event_dt_utc                 | TIMESTAMP       | DIMENSION          | Timestamp of the conversion event in UTC.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | MEDIUM                |\n","| Conversion Info | event_hour_utc               | INTEGER         | DIMENSION          | Hour of the day of the conversion event in UTC.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| Conversion Info | event_subtype                 | STRING          | DIMENSION          | Subtype of the conversion event. For ASIN conversions, the examples of event_subtype include: alexaSkillEnable, babyRegistry, customerReview, detailPageView, order, shoppingCart, snsSubscription, weddingRegistry, wishList. For search conversions, event_subtype is always searchConversion. For pixel conversions, the numeric ID of the event_subtype is provided. For additional information on the interpretation of this numeric identifier for pixel conversions, refer to event_type_description.                                                                                                                                                                                                                                                                                                                                                                                             | LOW                   |\n","| Conversion Info | event_type                    | STRING          | DIMENSION          | Type of the conversion event.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | LOW                   |\n","| Conversion Info | event_type_class             | STRING          | DIMENSION          | For ASIN conversions, the event_type_class is the high level classification of the event type, for example consideration, conversion, etc. This field will be blank for pixel conversions (when event_category = pixel) and search conversions (when event_subtype = searchConversion).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| Conversion Info | event_type_description       | STRING          | DIMENSION          | Human-readable description of the conversion event. For ASIN conversions, examples include: \"add to baby registry\", \"Add to Shopping Cart\", \"add to wedding registry\", \"add to wishlist\", \"Customer Reviews Page\", \"New SnS Subscription\", \"Product detail page viewed\", \"Product purchased\". This field will be blank for search conversions (when event_subtype = searchConversion). For pixel conversions (when event_category = pixel), the event_type_description will include additional information about the pixel based on information provided as part of the campaign setup, such as \"Homepage visit\", \"Add to Shopping Cart\" or \"Brand store engagement 2\". Before using these fields to evaluate pixel conversions, we recommend that you consult with the team that set up the campaign of the advertiser to determine how the event_type_description values for pixel conversions should be interpreted. | LOW                   |\n","| Conversion Info | exposure_type                 | STRING          | DIMENSION          | Attribution of the conversion. For website and purchase conversions, conversion is ad-exposed if conversion happened within 28-days after a traffic event, else non-ad-exposed. For pixel conversions, this field is always pixel.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW                   |\n","| Conversion Info | ip_address                 | STRING          | DIMENSION          | Pseudonymous identifier that represents the IP address received for an ad event. The field can contain either IPv4 or IPv6 values. NULL values appear when Amazon Ads does not receive an IP address for the event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes such as COUNT(DISTINCT ip_address).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | VERY_HIGH                  |\n","| Conversion Info | marketplace_id                | INTEGER         | Dimension          | Marketplace ID of where the conversion event occurred.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | INTERNAL              |\n","| Conversion Info | marketplace_name              | STRING          | Dimension          | Name of the marketplace where the conversion event occurred. Example values are online marketplaces such as AMAZON.COM, AMAZON.CO.UK. Or in-store marketplaces, such as WHOLE_FOODS_MARKET_US or AMAZON_FRESH_STORES_US.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| Conversion Info | new_to_brand                 | BOOLEAN         | DIMENSION          | True if the user was new to the brand.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| Conversion Info | purchase_currency             | STRING          | DIMENSION          | ISO currency code of the purchase order.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| Conversion Info | purchase_unit_price          | DecimalDataType | METRIC             | Unit price of the product sold.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| Conversion Info | sns_subscription_id          | STRING          | DIMENSION          | Subscribe-and-save subscription id.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | INTERNAL              |\n","| Conversion Info | total_product_sales          | DecimalDataType | METRIC             | Total sales (in local currency) of promoted ASINs and ASINs from the same brands as promoted ASINs purchased by customers on Amazon.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| Conversion Info | total_units_sold             | LONG            | METRIC             | Total quantity of promoted products and products from the same brand as promoted products purchased by customers on Amazon. A campaign can have multiple units sold in a single purchase event.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | NONE                  |\n","| Conversion Info | tracked_asin                  | STRING          | DIMENSION          | The dimension tracked_asin is the tracked Amazon Standard Identification Number, which is either the promoted or brand halo ASIN. When the tracked_item results in a purchase conversion, the tracked_asin will be populated in this column, in addition to being tracked in the tracked_item column with the same ASIN value. The tracked_asin is populated only if the event_category = purchase. For the first SnS order and non-purchase conversions, such as detail page views, the ASIN is populated under tracked_item. See also tracked_item.                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| Conversion Info | tracked_item                  | STRING          | DIMENSION          | Each campaign can track zero or more items. Depending on the type of campaign, these items might be ASINs, pixel IDs, DSP ad-attributed branded search keywords or apps. The tracked items for a campaign are the basis for which we determine which conversion events are sent to each AMC instance. In the custom attribution dataset, the tracked_item is the identifier of an item of interest for the campaign, such as the ASIN tracked to the campaign, the brand halo ASIN, or the ad-attributed branded keyword. Attribution algorithms match traffic and conversion event by the user identity and tracked item. Matching rules for tracked items may include expansion algorithms such as brand halo when the conversions_with_relevance dataset is used. If tracked_asin has a value populated, the same value for tracked_item will match tracked_asin. See also tracked_asin.                          | LOW                   |\n","| Conversion Info | user_id                       | STRING          | DIMENSION          | User ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | VERY_HIGH            |\n","| Conversion Info | conversion_event_source      | STRING          | Dimension          | Source through which the conversion event was sent to Amazon DSP                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| Conversion Info | conversion_event_name        | STRING          | Dimension          | Advertiser defined name for the conversion event                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| Purchase Info   | off_amazon_product_sales   | LONG            | METRIC             | Sales amount for off-Amazon purchase conversions                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| Conversion Info | off_amazon_conversion_value | LONG            | METRIC             | Value of off Amazon non-purchase conversions. Value is unitless and advertiser defined.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | NONE                  |\n","| Purchase Info   | combined_sales                | LONG            | METRIC             | Sum of total_product_sales (Amazon product sales) and off_amazon_product_sales                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | NONE                  |\n"],"documentType":"guide"},{"title":"Amazon audience segment membership","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/audience_segment_membership_paid","content":[" Analytics tables:\n","audience_segments_amer_inmarket\n","audience_segments_amer_lifestyle\n","audience_segments_apac_inmarket\n","audience_segments_apac_lifestyle\n","audience_segments_eu_inmarket\n","audience_segments_eu_lifestyle\n","segment_metadata\n","audience_segments_amer_inmarket_snapshot\n","audience_segments_amer_lifestyle_snapshot\n","audience_segments_apac_inmarket_snapshot\n","audience_segments_apac_lifestyle_snapshot\n","audience_segments_eu_inmarket_snapshot\n","audience_segments_eu_lifestyle_snapshot\n"," Audiences tables:\n","There are associated audiences tables for each of the tables above.\n"," Amazon audience segment membership is presented across multiple data views. The default data views are DIMENSION dataset type, whereas the historical snapshots are FACT dataset type. Based on this implementation detail, the default data view presents the most recent user-to-segment associations, whereas the historical snapshots present the user-to-segment associations as records on the first Thursday of each calendar month.\n"," Audience segment membership is broken out by region (AMER/EU/APAC) and Amazon audience subcategory (Lifestyle, Life event, In-market and Interests).\n"],"documentType":"guide"},{"title":"Amazon audience segment membership","sectionHeader":{"type":2,"text":"audience\\_segments\\_\\<region>\\_\\<category\\>"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/audience_segment_membership_paid","content":[" Records of all active user-to-segment associations. This table presents each user-to-segment association as a distinct row. The segment_id value is not globally unique, however the segment_id is unique per segment_marketplace_id.\n"," AMC defined best practices and recommendations for querying the audience segment membership tables are listed below:\n","Never query more than one audience_segments\\_&lt;region>\\_&lt;category> table within a single SQL query.\n","Never query audience segment membership tables from multiple regions (AMER/EU/APAC) within a single SQL query.\n","Include SQL filtering using segment_marketplace_id for all queries.\n","Include SQL filtering using segment_id whenever the scope of analysis can be proactively refined to a subset of all segment_id values.\n","When querying the historical snapshot data views, limit your analysis date-range and segment-scope through SQL filtering. This proactive filtering should increase query processing speed and query success rate.\n","When querying the historical snapshot data views, ensure that the query date range includes the first Thursday of the calendar month associated with your analysis.\n","When querying the historical snapshot data views and joining against traffic or conversion datasets, please restrict the analysis to one historical snapshot per SQL analysis. Workflows that use these tables will time out when run over extended periods of time.\n","| Field category              | Name                     | Data type   | Metric / dimension | Description                                                                      | Aggregation threshold |\n","\\| --------------------------- \\| ------------------------ \\| ----------- \\| ------------------ \\| -------------------------------------------------------------------------------- \\| --------------------- \\|\n","| Audience Segment Membership | no_3p_trackers         | BOOLEAN   | Dimension          | Is this item not allowed to use 3P tracking?                                     | NONE                  |\n","| Audience Segment Membership | segment_id             | INTEGER   | Dimension          | Identification code for the segment.                                             | LOW                   |\n","| Audience Segment Membership | segment_marketplace_id | LONG      | Dimension          | Marketplace the segment belongs to; segments can belong to multiple marketplaces. | LOW                   |\n","| Audience Segment Membership | segment_name           | STRING    | Dimension          | Name of the segment the user_id is tagged to.                                  | LOW                   |\n","| Audience Segment Membership | user_id                | STRING    | Dimension          | User ID of the customer.                                                         | VERY_HIGH            |\n","| Audience Segment Membership | user_id_type           | STRING    | Dimension          | Type of user ID.                                                                 | LOW                   |\n","| Audience Segment Membership | snapshot_datetime      | DATE      | Dimension          | The date of when the snapshot was taken.                                         | LOW                   |\n"],"documentType":"guide"},{"title":"Amazon audience segment membership","sectionHeader":{"type":2,"text":"segment\\_metadata"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/audience_segment_membership_paid","content":[" Metadata that describes the segment_id and segment_marketplace_id from the audience_segments\\_&lt;region>\\_&lt;category> tables.\n"," Recommendation: When joining the segment_metadata table with audience_segments\\_&lt;region>\\_&lt;category> tables, use a SQL double join on segment_id and segment_marketplace_id.\n","| Field Category              | Name                     | Data Type   | Metric / Dimension | Description                                                                           | Aggregation Threshold |\n","\\| --------------------------- \\| ------------------------ \\| ----------- \\| ------------------ \\| ------------------------------------------------------------------------------------- \\| --------------------- \\|\n","| Audience Segment Membership | category_level_1       | STRING    | Dimension          | Top level of the audience segment taxonomy.                                           | LOW                   |\n","| Audience Segment Membership | category_level_2       | STRING    | Dimension          | Second level of the audience segment taxonomy.                                        | LOW                   |\n","| Audience Segment Membership | category_path          | STRING    | Dimension          | Full path of the audience segment taxonomy.                                           | LOW                   |\n","| Audience Segment Membership | no_3p_trackers         | BOOLEAN   | Dimension          | Is this item not allowed to use 3P tracking?                                          | NONE                  |\n","| Audience Segment Membership | segment_description    | STRING    | Dimension          | Description of the segment.                                                           | LOW                   |\n","| Audience Segment Membership | segment_id             | INTEGER   | Dimension          | Identification code for the segment.                                                  | LOW                   |\n","| Audience Segment Membership | segment_marketplace_id | LONG      | Dimension          | The marketplace the segment belongs to; segments can belong to multiple marketplaces. | LOW                   |\n","| Audience Segment Membership | segment_name           | STRING    | Dimension          | Name of the segment.                                                                  | LOW                   |\n"],"documentType":"guide"},{"title":"Amazon your garage","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/amazon_your_garage_paid","content":[" Analytics table:\n","amazon_your_garage_all\n"," Audiences table:\n","amazon_your_garage_all_for_audiences\n"," Amazon Your Garage is a virtual vehicle repository which allows customers to add their vehicle make and model and quickly locate parts and accessories that fit their saved vehicles. The AMC Amazon Your Garage (AYG) dataset allows you to tap into those user-to-vehicle association signals. When you enroll in Amazon Your Garage, you will have access to the amazon_your_garage_all dataset containing signals such as vehicle type, make, or engine type, which are updated daily with the most recent user-to-vehicle associations.\n"," The data \"snapshot\" will be the most-recent available user-to-vehicle association, refreshed and published into AMC daily. Advertisers can use Amazon Your Garage signals alongside Amazon DSP traffic events, sponsored ads event-level signals, Paid feature subscriptions, and advertiser uploaded signals in order to conduct saved vehicle segment analysis for planning, measurement, and activation purposes.\n"," Prior to 10/17/2025, the AMC Amazon Your Garage dataset (amazon_your_garage) was available in the NA region only. After 10/17/2025, the Amazon Your Garage dataset was expanded to also include EU and FE regions. The expanded tables are titled amazon_your_garage_all and amazon_your_garage_all_for_audiences. For more information about eligibility and availability, refer to Paid features overview.\n","| Column name | Data type | Metric/dimension | Description | Aggregation threshold |\n","\\|----------------------------\\|-----------\\|------------------\\|-----------------------------------------------------------------------------------------------------------------\\|-----------------------\\|\n","| creation_date | DATE | DIMENSION | Creation date of the record | LOW |\n","| garage_bodystyle | STRING | DIMENSION | Vehicle body style attribute | LOW |\n","| garage_brakes | STRING | DIMENSION | Vehicle brakes attribute | LOW |\n","| garage_drivetype | STRING | DIMENSION | Vehicle drive type attribute | LOW |\n","| garage_engine | STRING | DIMENSION | Vehicle engine attribute | LOW |\n","| garage_engine_output_hp | FLOAT | DIMENSION | Engine output in horsepower | LOW |\n","| garage_engine_output_kw | FLOAT | DIMENSION | Engine output in kilowatts | LOW |\n","| garage_make | STRING | DIMENSION | Vehicle make attribute | LOW |\n","| garage_model | STRING | DIMENSION | Vehicle model attribute | LOW |\n","| garage_springtypes | STRING | DIMENSION | Spring type attribute | LOW |\n","| garage_submodel | LONG | DIMENSION | Vehicle submodel identifier | LOW |\n","| garage_transmission | STRING | DIMENSION | Vehicle transmission attribute | LOW |\n","| garage_variant | STRING | DIMENSION | Vehicle variant name attribute | LOW |\n","| garage_year | DATE | DIMENSION | Vehicle year attribute | LOW |\n","| garage_year_range | DATE | DIMENSION | Vehicle model year range | LOW |\n","| last_accessed_date | DATE | DIMENSION | Last accessed date for a customer invoked interaction with Amazon Garage record | LOW |\n","| marketplace_name | STRING | DIMENSION | This is the marketplace associated with the Amazon Garage record (Note: not the AMC Paid Feature marketplace). | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Is this item not allowed to use 3P tracking | NONE |\n","| region | STRING | DIMENSION | Region associated with the Amazon marketplace. | LOW |\n","| status | STRING | DIMENSION | Status of record | LOW |\n","| update_date | DATE | DIMENSION | Update date for the most recent garage record edit | LOW |\n","| user_id | STRING | DIMENSION | User ID of the customer | VERY_HIGH |\n","| vehicle_type | STRING | DIMENSION | Vehicle type attribute | LOW |\n"],"documentType":"guide"},{"title":"Brand store insights","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/brand_store_insights_paid","content":[" Analytics tables:\n","amazon_brand_store_page_views(\\_non_endemic) \\* amazon_brand_store_engagement_events(\\_non_endemic)\n"," Audiences tables:\n","amazon_brand_store_page_views_for_audiences(\\_non_endemic) \\* amazon_brand_store_engagement_events_for_audiences(\\_non_endemic)\n"," Amazon Brand Store insights is a collection of two AMC datasets that represent Brand Store page renders and interactions. Amazon Brand Store insights is a standalone AMC Paid Features resource that is available for trial and subscription enrollments within the AMC Paid Features suite of insight expansion options, powered by Amazon Ads.\n"," The Amazon Brand Store insights resource is available to both endemic and non-endemic advertisers that operate AMC instances within the supported AMC Paid Features account marketplaces (US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN).\n"],"documentType":"guide"},{"title":"Brand store insights","sectionHeader":{"type":2,"text":"amazon\\_brand\\_store\\_page\\_views (\\_non\\_endemic)"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/brand_store_insights_paid","content":[" Brand Store page view events, including dwell time. Events are at the Store page-level. The visit_id or session_id columns can be converted to metrics via COUNT() or COUNT(distinct ) SQL aggregate functions.\n","| Field Category       | Name             | Data Type   | Metric / Dimension | Description                                                                                                                                                                                                           | Aggregation Threshold |\n","\\| -------------------- \\| ---------------- \\| ----------- \\| ------------------ \\| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| --------------------- \\|\n","| Brand Store insights | advertiser_id  | LONG      | Dimension          | Advertiser ID.                                                                                                                                                                                                        | LOW                   |\n","| Brand Store insights | channel        | STRING    | Dimension          | Channel tag ID, referenced as query string name.                                                                                                                                                                      | LOW                   |\n","| Brand Store insights | device_type    | STRING    | Dimension          | Device type that viewed the store.                                                                                                                                                                                    | MEDIUM                |\n","| Brand Store insights | dwell_time     | DECIMAL   | Dimension          | Dwell time of page view (in seconds).                                                                                                                                                                                 | LOW                   |\n","| Brand Store insights | event_date_utc | DATE      | Dimension          | Date of event in UTC.                                                                                                                                                                                                 | LOW                   |\n","| Brand Store insights | event_dt_utc   | TIMESTAMP | Dimension          | Timestamp of event in UTC.                                                                                                                                                                                            | LOW                   |\n","| Brand Store insights | ingress_type   | STRING    | Dimension          | Enumerated list of store traffic source:0 - uncategorized / default1 - search2 - detail page byline4 - ads6 - store recommendations7 through 11 - experimentation | MEDIUM                |\n","| Brand Store insights | marketplace_id | INTEGER   | Dimension          | Marketplace ID of the store.                                                                                                                                                                                          | INTERNAL              |\n","| Brand Store insights | page_id        | STRING    | Dimension          | Store page ID.                                                                                                                                                                                                        | LOW                   |\n","| Brand Store insights | page_title     | STRING    | Dimension          | Title of the page.                                                                                                                                                                                                    | LOW                   |\n","| Brand Store insights | reference_id   | STRING    | Dimension          | Identifier for the ad campaign that is associated with the Brand Store page visit, associated with ingress_type = 4.                                                                                                | LOW                   |\n","| Brand Store insights | referrer_domain| STRING    | Dimension          | HTML referrer domain from which user arrived at page from, for example google.com (external) or amazon.com (internal).                                                                                                | LOW                   |\n","| Brand Store insights | session_id     | STRING    | Dimension          | Store session ID.                                                                                                                                                                                                     | VERY HIGH             |\n","| Brand Store insights | store_name     | STRING    | Dimension          | Name of the store set by the store owner.                                                                                                                                                                             | LOW                   |\n","| Brand Store insights | user_id        | STRING    | Dimension          | User ID that performed the event.                                                                                                                                                                                     | VERY HIGH             |\n","| Brand Store insights | user_id_type   | STRING    | Dimension          | Type of User ID.                                                                                                                                                                                                      | LOW                   |\n","| Brand Store insights | visit_id       | STRING    | Dimension          | Store visit ID.                                                                                                                                                                                                       | VERY HIGH             |\n","| Brand Store insights | no_3p_trackers | BOOLEAN   | Dimension          | Indicates whether this item is not allowed to use 3P tracking.                                                                                                                                                        | NONE                  |\n"],"documentType":"guide"},{"title":"Brand store insights","sectionHeader":{"type":2,"text":"amazon\\_brand\\_store\\_engagement\\_events (\\_non\\_endemic)"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/brand_store_insights_paid","content":[" Brand Store engagement events. Provides Brand Store web engagement metrics including page views and clicks. Events are interaction based and presented at the Store widget-level. The visit_id or session_id columns can be converted to metrics via COUNT() or COUNT(distinct ) SQL aggregate functions.\n","| Field Category       | Name              | Data Type   | Metric / Dimension | Description                                                                                                                                                                                                   | Aggregation Threshold |\n","\\| -------------------- \\| ----------------- \\| ----------- \\| ------------------ \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| --------------------- \\|\n","| Brand Store insights | advertiser_id   | LONG      | Dimension          | Advertiser ID.                                                                                                                                                                                                | LOW                   |\n","| Brand Store insights | asin            | STRING    | Dimension          | Amazon Standard Identification Number (ASIN).                                                                                                                                                               | LOW                   |\n","| Brand Store insights | channel         | STRING    | Dimension          | Channel tag ID, referenced as query string name.                                                                                                                                                              | LOW                   |\n","| Brand Store insights | device_type     | STRING    | Dimension          | Device type that viewed the store.                                                                                                                                                                            | MEDIUM                |\n","| Brand Store insights | event_date_utc  | DATE      | Dimension          | Date of event in UTC.                                                                                                                                                                                         | LOW                   |\n","| Brand Store insights | event_dt_utc    | TIMESTAMP | Dimension          | Timestamp of event in UTC.                                                                                                                                                                                    | LOW                   |\n","| Brand Store insights | event_sub_type  | STRING    | Dimension          | Sub-type of event - refer to schema for values.                                                                                                                                                               | LOW                   |\n","| Brand Store insights | event_type      | STRING    | Dimension          | Type of event - refer to schema for values.                                                                                                                                                                   | LOW                   |\n","| Brand Store insights | ingress_type    | STRING    | Dimension          | Enumerated list of store traffic source:0 - uncategorized / default1 - search2 - detail page byline4 - ads6 - store recommendations7 through 11 - experimentation |                       |\n","| Brand Store insights | marketplace_id  | INTEGER   | Dimension          | Marketplace ID of the store.                                                                                                                                                                                  | INTERNAL              |\n","| Brand Store insights | page_id         | STRING    | Dimension          | Store page ID.                                                                                                                                                                                                | LOW                   |\n","| Brand Store insights | page_title      | STRING    | Dimension          | Title of the page.                                                                                                                                                                                            | LOW                   |\n","| Brand Store insights | reference_id    | STRING    | Dimension          | Identifier for the ad campaign that is associated with the Brand Store page visit, associated with ingress_type = 4.                                                                                        | LOW                   |\n","| Brand Store insights | referrer_domain | STRING    | Dimension          | HTML referrer domain from which user arrived at page from, for example google.com (external) or amazon.com (internal).                                                                                        | LOW                   |\n","| Brand Store insights | session_id      | STRING    | Dimension          | Store session ID.                                                                                                                                                                                             | VERY HIGH             |\n","| Brand Store insights | store_name      | STRING    | Dimension          | Name of the store set by the store owner.                                                                                                                                                                     | LOW                   |\n","| Brand Store insights | user_id         | STRING    | Dimension          | User ID that performed the event.                                                                                                                                                                             | VERY HIGH             |\n","| Brand Store insights | user_id_type    | STRING    | Dimension          | Type of User ID.                                                                                                                                                                                              | LOW                   |\n","| Brand Store insights | widget_sub_type | STRING    | Dimension          | Sub-type of widget - refer to schema for values.                                                                                                                                                              | LOW                   |\n","| Brand Store insights | widget_type     | STRING    | Dimension          | Type of widget - refer to schema for values.                                                                                                                                                                  | LOW                   |\n","| Brand Store insights | no_3p_trackers  | BOOLEAN   | Dimension          | Indicates whether this item is not allowed to use 3P tracking.                                                                                                                                                | NONE                  |\n"],"documentType":"guide"},{"title":"Amazon retail purchase","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/amazon_retail_purchase_paid","content":[" Analytics table:\n","amazon_retail_purchases\n"," Audiences table:\n","amazon_retail_purchase_for_audiences\n"," The Amazon Retail Purchases (ARP) dataset (amazon_retail_purchases) enables advertisers to analyze long-term (up to 60 months) customer purchase behavior and create more comprehensive insights.\n"],"documentType":"guide"},{"title":"Amazon retail purchase","sectionHeader":{"type":3,"text":"Availability "},"path":"/en-us/guides/amazon-marketing-cloud/datasources/amazon_retail_purchase_paid","content":[" This data source is available for measurement queries through a Paid features subscription in the US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces. \n"," Data from the United Kingdom and European Union (EU) regions will be excluded from audience creation.\n"],"documentType":"guide"},{"title":"Amazon retail purchase","sectionHeader":{"type":3,"text":"Subscription and access requirements"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/amazon_retail_purchase_paid","content":["This dataset is available through subscription. You can opt into a 60-day free trial, after which a subscription is necessary to access the dataset.\n","Check the Sponsored Ads accounts configured to your AMC instance configuration to ensure the correct Vendor/Seller Central accounts are associated. You can verify the associations in Ads Console > Administration (gear icon) > Account access & settings > Selling account.\n"],"documentType":"guide"},{"title":"Amazon retail purchase","sectionHeader":{"type":3,"text":"Conversion datasets"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/amazon_retail_purchase_paid","content":[" While the AMC conversions and conversions_all (referred to as CONV) datasets may appear similar, they are different in the following ways:\n","| Aspect | CONV | ARP |\n","\\|---------\\|------\\|-----\\|\n","| Scope of conversion types | Various conversion event types (purchases, considerations, pixel-based conversions). | Amazon store purchase conversion events only. |\n","| Scope of events | Advertising-centric (can include promoted, brand-halo, and brand-owned ASIN items). | Entire purchase activity in Amazon store, regardless of advertising. |\n","| Data pipelines and restatements | Sourced from advertising data pipelines; subject to restatements and advertising augmentation. | Sourced from retail data pipeline including restatements, and more closely matched data found in other Amazon reporting surfaces like Vendor Central. |\n"," The AMC dataset associated with ARP is amazon_retail_purchases.\n"],"documentType":"guide"},{"title":"Amazon retail purchase","sectionHeader":{"type":2,"text":"amazon\\_retail\\_purchases"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/amazon_retail_purchase_paid","content":["| Field name | Data type | Description | Aggregation Threshold |\n","\\|---\\|---\\|---\\|---\\|\n","| asin | STRING | ASIN is the abbreviation for Amazon Standard Identification Number. This represents the item associated with the retail event. A unique block of letters and/or numbers that identify all products sold on Amazon. | LOW |\n","| asin_brand | STRING | ASIN item merchant brand name. | LOW |\n","| asin_name | STRING | ASIN item name. | LOW |\n","| asin_parent | STRING | The Amazon Standard Identification Number (ASIN) that is the parent of this ASIN for the retail event. | LOW |\n","| currency_code | STRING | ISO currency code of the retail event. | LOW |\n","| event_id | STRING | Unique identifier of the retail event record. In the data set, each row has a unique event_id. This event_id can have a many-to-one relationship with purchase_id. | VERY_HIGH |\n","| is_business_flag | BOOLEAN | Indicates whether the retail event is associated with \"Amazon Business\" program. | LOW |\n","| is_gift_flag | BOOLEAN | Indicates whether the retail event is associated with \"send an order as a gift\". | LOW |\n","| marketplace_id | INTEGER | Marketplace ID of where the retail event occurred. | INTERNAL |\n","| marketplace_name | STRING | Name of the marketplace where the retail event occurred. Example values include AMAZON.COM, AMAZON.CO.UK, etc. | LOW |\n","| no_3p_trackers | BOOLEAN | Is this item not allowed to use 3P tracking. | NONE |\n","| origin_session_id | STRING | Describes the session when the retail item was added to cart. | VERY_HIGH |\n","| purchase_date_utc | DATE | Date of the retail event in UTC. | LOW |\n","| purchase_day_utc | INTEGER | Day of the month of the retail event in UTC. | LOW |\n","| purchase_dt_hour_utc | TIMESTAMP | Timestamp of the retail event in UTC truncated to the hour. | LOW |\n","| purchase_dt_utc | TIMESTAMP | Timestamp of the retail event in UTC. | MEDIUM |\n","| purchase_hour_utc | INTEGER | Hour of the day of the retail event in UTC. | LOW |\n","| purchase_id | STRING | Unique identifier of the retail purchase record. This purchase_id can have a one-to-many relationship with event_id. | VERY_HIGH |\n","| purchase_month_utc | INTEGER | Month of the conversion event in UTC. | LOW |\n","| purchase_order_method | STRING | Enumerated descriptor of how the shopper purchased the item. S = Shopping Cart. B = Buy Now. 1 = 1-Click Buy. | LOW |\n","| purchase_program_name | STRING | Indicates the purchase program associated with the retail event. | LOW |\n","| purchase_session_id | STRING | Describes the session when the retail item was purchased. | VERY_HIGH |\n","| purchase_units_sold | LONG | Total quantity of retail items associated with the retail event. A record can have multiple units sold of a single retail item. | NONE |\n","| unit_price | DECIMAL | Per unit price of the product sold. | NONE |\n","| user_id | STRING | User ID associated with the retail event (the user ID of the shopper that purchased the item). | VERY_HIGH |\n","| user_id_type | STRING | Type of user ID. The only value for this data set is adUserId. | LOW |\n"],"documentType":"guide"},{"title":"Amazon Prime Video Channel Insights","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/prime_video_channel_insights_paid","content":[" Analytics tables: \n","amazon_pvc_enrollments\n","amazon_pvc_streaming_events_feed\n"," Audience tables: \n","amazon_pvc_enrollments_for_audiences\n","amazon_pvc_streaming_events_feed_for_audiences\n"," Amazon Prime Video Channel Insights is a collection of two AMC data views that represent Prime Video Channel subscriptions and streaming signals. Amazon Prime Video Channel Insights is a standalone AMC Paid Features resource that is available for trial and subscription enrollments within the AMC Paid Features suite of insight expansion options, powered by Amazon Ads. This resource is available to Amazon Advertisers that operate Prime Video Channels within the supported AMC Paid Features account marketplaces (US/CA/JP/AU/FR/IT/ES/UK/DE).\n"],"documentType":"guide"},{"title":"Amazon Prime Video Channel Insights","sectionHeader":{"type":2,"text":"amazon\\_pvc\\_enrollments"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/prime_video_channel_insights_paid","content":[" Amazon Prime Video Channels enrollment records presented per benefit id. The pv_subscription_id column can be converted to metrics via COUNT() or COUNT(DISTINCT) SQL aggregate functions.\n","| Name | Data Type | Metric/Dimension | Description | Aggregation Threshold |\n","\\|----------------------------\\|-----------\\|------------------\\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|-----------------------\\|\n","| marketplace_id | LONG | DIMENSION | ID of the marketplace where the Amazon Prime Video Channel enrollment event occurred | INTERNAL |\n","| marketplace_name | STRING | DIMENSION | This is the marketplace associated with the Amazon Prime Video Channel record | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Boolean value indicating whether the event can be used for audience creation that is third-party tracking enabled (i.e. whether you can serve creative with third-party tracking when running media against the audience). Third-party tracking refers to measurement tags and pixels from external vendors that can be used to measure ad performance. Possible values for this field are: true, false. | LOW |\n","| pv_benefit_id | STRING | DIMENSION | Amazon Prime Video subscription benefit identifier | INTERNAL |\n","| pv_benefit_name | STRING | DIMENSION | Amazon Prime Video subscription benefit name | LOW |\n","| pv_billing_type | STRING | DIMENSION | Amazon Prime Video billing type for the enrollment record | MEDIUM |\n","| pv_currency_code | STRING | DIMENSION | Currency code for the PVC enrollment plan | LOW |\n","| pv_duration_days | INTEGER | DIMENSION | Duration in days for the PVC enrollment plan | LOW |\n","| pv_duration_length | DECIMAL(38,18) | DIMENSION | Duration length for the PVC enrollment plan | LOW |\n","| pv_duration_units | STRING | DIMENSION | Duration units for the PVC enrollment plan (e.g., MONTH, YEAR) | LOW |\n","| pv_end_date | DATE | DIMENSION | Interval-specific end date associated with the PVC enrollment record | LOW |\n","| pv_enrollment_status | STRING | DIMENSION | Status for the PVC enrollment record | LOW |\n","| pv_is_latest_record | BOOLEAN | DIMENSION | Indicator of whether the PVC enrollment record is the most recent record within the table | INTERNAL |\n","| pv_is_plan_conversion | BOOLEAN | DIMENSION | Indicates whether the PVC enrollment record has converted from Free Trial to a subscription. This is often associated with a change in the billing type for the PVC subscription | LOW |\n","| pv_is_plan_start | BOOLEAN | DIMENSION | Indicates whether the PVC enrollment record is the start of an enrollment. This is often the opening of a free trial or the first subscription record for the PV subscription ID | LOW |\n","| pv_is_promo | BOOLEAN | DIMENSION | Indicator of whether the PVC enrollment record is associated with a promotional offer | LOW |\n","| pv_offer_name | STRING | DIMENSION | Amazon Prime Video subscription offer name | HIGH |\n","| pv_plan_type_id | STRING | DIMENSION | Amazon Prime Video plan type identifier | INTERNAL |\n","| pv_start_date | DATE | DIMENSION | Interval-specific start date associated with the PVC enrollment record | LOW |\n","| pv_sub_event_primary_key | STRING | DIMENSION | Unique identifier for the PVC enrollment event | INTERNAL |\n","| pv_subscription_id | STRING | DIMENSION | Amazon Prime Video subscription id | INTERNAL |\n","| pv_subscription_name | STRING | DIMENSION | Amazon Prime Video subscription name | LOW |\n","| pv_subscription_product_id | STRING | DIMENSION | Amazon Prime Video subscription product identifier | INTERNAL |\n","| pv_unit_price | DECIMAL | DIMENSION | Unit price for the PVC enrollment record | NONE |\n","| user_id | STRING | DIMENSION | Pseudonymous identifier that connects user activity across different events. The field can contain ad user IDs (representing Amazon accounts), device IDs, or browser IDs. NULL values appear when Amazon Ads is unable to resolve an identifier for an event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT user_id). | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID value. AMC includes different types of user ID values, depending on whether the value represents a resolved Amazon account, a device, or a browser cookie. If Amazon Ads is unable to determine or provide an ID of any kind for an impression event, the user_id and user_id_type values for that record will be NULL. Possible values include: adUserId, sisDeviceId, adBrowserId, and NULL. | LOW |\n"],"documentType":"guide"},{"title":"Amazon Prime Video Channel Insights","sectionHeader":{"type":2,"text":"amazon\\_pvc\\_streaming\\_events\\_feed"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/prime_video_channel_insights_paid","content":[" Amazon Prime Video Channel Streaming and engagement events. Provides Amazon Prime Video Channel engagement metrics including content metadata, request context and duration. Events are session based and presented at the PVC benefit-level. The pv_session_id columns can be converted to metrics via COUNT() or COUNT(DISTINCT) SQL aggregate functions.\n","| Name | Data Type | Metric/Dimension | Description | Aggregation Threshold |\n","\\|-----------------------------\\|-----------\\|------------------\\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|-----------------------\\|\n","| marketplace_id | LONG | DIMENSION | Marketplace id of the event | INTERNAL |\n","| marketplace_name | STRING | DIMENSION | Marketplace name of the event | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Boolean value indicating whether the event can be used for audience creation that is third-party tracking enabled (i.e. whether you can serve creative with third-party tracking when running media against the audience). Third-party tracking refers to measurement tags and pixels from external vendors that can be used to measure ad performance. Possible values for this field are: true, false. | LOW |\n","| pv_access_type | STRING | DIMENSION | Content access type e.g. free, prime subscription, rental, purchase | LOW |\n","| pv_gti_cast | ARRAY | DIMENSION | Content cast members | LOW |\n","| pv_content_details | STRING | DIMENSION | Additional detail on content | LOW |\n","| pv_gti_content_entity_type | STRING | DIMENSION | Content entity (sub) type e.g. Short Film, Educational | LOW |\n","| pv_gti_content_rating | STRING | DIMENSION | Content rating | LOW |\n","| pv_gti_content_type | STRING | DIMENSION | Content type e.g. TV Episode, Movie, Promotion | LOW |\n","| pv_gti_director | ARRAY | DIMENSION | Content directors | LOW |\n","| pv_gti_episode | STRING | DIMENSION | Series episode | LOW |\n","| pv_gti_event_context | STRING | DIMENSION | Content event context | LOW |\n","| pv_gti_event_item | STRING | DIMENSION | Content event item | LOW |\n","| pv_gti_event_league | STRING | DIMENSION | Content event league | LOW |\n","| pv_gti_event_name | STRING | DIMENSION | Content event name | LOW |\n","| pv_gti_event_sport | STRING | DIMENSION | Content event sport | LOW |\n","| pv_gti_genre | ARRAY | DIMENSION | Content genre | LOW |\n","| pv_gti_is_live | BOOLEAN | DIMENSION | Content is live boolean | LOW |\n","| pv_gti_release_date | DATE | DIMENSION | Content release date | LOW |\n","| pv_gti_season | STRING | DIMENSION | Series season | LOW |\n","| pv_gti_series_or_movie_name | STRING | DIMENSION | Series or movie name | LOW |\n","| pv_gti_studio | STRING | DIMENSION | Content studio | LOW |\n","| pv_gti_title_name | STRING | DIMENSION | Content title e.g. episode name | LOW |\n","| pv_is_adfree | BOOLEAN | DIMENSION | Is the content ad free | LOW |\n","| pv_is_avod | BOOLEAN | DIMENSION | Is advertiser-supported VOD boolean | LOW |\n","| pv_is_channels | BOOLEAN | DIMENSION | Is channel boolean | LOW |\n","| pv_is_svod | BOOLEAN | DIMENSION | Is subscription VOD boolean | LOW |\n","| pv_is_user_initiated | BOOLEAN | DIMENSION | User-initiated content or auto-play content | LOW |\n","| pv_material_type | STRING | DIMENSION | Video material type e.g. full, live, promo, trailer | LOW |\n","| pv_offer_group | STRING | DIMENSION | Content offer group e.g. free, prime, rental, purchase | LOW |\n","| pv_profile_type | STRING | DIMENSION | Type of profile associated with the content | LOW |\n","| pv_playback_date_utc | DATE | DIMENSION | Date of the event | LOW |\n","| pv_playback_dt_utc | TIMESTAMP | DIMENSION | Timestamp of the event | MEDIUM |\n","| pv_seconds_viewed | DECIMAL | METRIC | The seconds of view time associated with a streaming event | MEDIUM |\n","| pv_session_id | STRING | DIMENSION | Session ID of the event | VERY_HIGH |\n","| pv_stream_type | STRING | DIMENSION | Type of stream content e.g. linear tv, live_event, VOD | LOW |\n","| pv_streaming_asin | STRING | DIMENSION | Amazon Standard Identification Number (ASIN) | LOW |\n","| pv_streaming_geo_dma | STRING | DIMENSION | DMA code | LOW |\n","| pv_streaming_geo_country | STRING | DIMENSION | Country accessing the event | LOW |\n","| pv_streaming_geo_city | STRING | DIMENSION | City accessing the event | LOW |\n","| pv_streaming_gti | STRING | DIMENSION | Global title information | LOW |\n","| pv_streaming_language | STRING | DIMENSION | Language of the event | LOW |\n","| user_id | STRING | DIMENSION | Pseudonymous identifier that connects user activity across different events. The field can contain ad user IDs (representing Amazon accounts), device IDs, or browser IDs. NULL values appear when Amazon Ads is unable to resolve an identifier for an event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT user_id). | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID value. AMC includes different types of user ID values, depending on whether the value represents a resolved Amazon account, a device, or a browser cookie. If Amazon Ads is unable to determine or provide an ID of any kind for an impression event, the user_id and user_id_type values for that record will be NULL. Possible values include: adUserId, sisDeviceId, adBrowserId, and NULL. | LOW |\n"],"documentType":"guide"},{"title":"Amazon Prime Video Insights","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/prime-video-insights-paid","content":[" Analytics table:\n","pv_streaming_events_feed\n"," Audience table:\n","pv_streaming_events_feed_for_audiences\n"],"documentType":"guide"},{"title":"Amazon Prime Video Insights","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/prime-video-insights-paid","content":[" Amazon Prime Video is a subscription-based video on demand streaming and rental service that Amazon bundles within the Amazon Prime subscription. The service features a comprehensive content library including ad-supported and ad-free content, Live TV, Sports on Prime, and both first and third-party content available for rental or subscription. This dataset allows advertisers to analyze content engagement patterns across Prime Video for their customers.\n"," Amazon Prime Video Insights (PVI) helps advertisers better understand the entertainment preferences of their customers and how these intersect with other customer behaviors. By combining Prime Video viewership insights with other AMC signals, advertisers can develop better campaign strategies to reach the right audience, measure the relationship between viewing behavior and purchase patterns, and create more relevant audience segments. Additionally, these signals allow advertisers to understand the overlap between their customer base and Prime Video viewers, providing valuable insight into new audiences on Prime Video, especially for non-endemic advertisers who don't sell on Amazon. Advertisers can use PVI alongside Amazon DSP traffic events, sponsored ads event-level signals, conversion events, and advertiser-uploaded signals to conduct custom attribution for subscriptions, re-engagement campaigns, and audience overlap analysis.\n"],"documentType":"guide"},{"title":"Amazon Prime Video Insights","sectionHeader":{"type":2,"text":"Basic information"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/prime-video-insights-paid","content":[" Lookback: The PVI lookback window is 13 months.\n"," Availability: AMC accounts/instances associated with the US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces\n"," Eligibility: All AMC advertisers and instances within the eligible marketplaces above. Data coverage is limited to users an advertiser has reached through an upstream data join with ad traffic tables.\n"," Contains signals from: US, CA, JP, AU, FR, IT, ES, UK, DE, MX, BR, NL, SE, PL, BE, AE, SA, TR, EG, IE, ZA, NG, SG, IN marketplaces\n"," For eligible advertisers and instances, the associated audience table can be used for AMC audience creation without a Paid Feature subscription:\n","pv_streaming_events_feed_for_audiences\n"],"documentType":"guide"},{"title":"Amazon Prime Video Insights","sectionHeader":{"type":2,"text":"`pv_streaming_events_feed`"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/prime-video-insights-paid","content":["| Name | Data Type | Metric/Dimension | Description | Aggregation Threshold |\n","\\|----------------------------\\|-----------\\|-------------------\\|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|-----------------------\\|\n","| marketplace_id | LONG | DIMENSION | Marketplace ID of the event | INTERNAL |\n","| marketplace_name | STRING | DIMENSION | Marketplace name of the event | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Boolean value indicating whether the event can be used for audience creation that is third-party tracking enabled (i.e. whether you can serve creative with third-party tracking when running media against the audience). Third-party tracking refers to measurement tags and pixels from external vendors that can be used to measure ad performance. Possible values for this field are: true, false. | LOW |\n","| pv_access_type | STRING | DIMENSION | Content access type e.g. free, Prime subscription, rental, purchase | LOW |\n","| pv_content_details | STRING | DIMENSION | Additional detail on content | LOW |\n","| pv_gti_cast | ARRAY | DIMENSION | Content cast members | LOW |\n","| pv_gti_content_entity_type | STRING | DIMENSION | Content entity (sub) type e.g. Short Film, Educational | LOW |\n","| pv_gti_content_rating | STRING | DIMENSION | Content rating | LOW |\n","| pv_gti_content_type | STRING | DIMENSION | Content type e.g. TV Episode, Movie, Promotion | LOW |\n","| pv_gti_director | ARRAY | DIMENSION | Content directors | LOW |\n","| pv_gti_episode | STRING | DIMENSION | Series episode | LOW |\n","| pv_gti_event_context | STRING | DIMENSION | Content event context | LOW |\n","| pv_gti_event_item | STRING | DIMENSION | Content event item | LOW |\n","| pv_gti_event_league | STRING | DIMENSION | Content event league | LOW |\n","| pv_gti_event_name | STRING | DIMENSION | Content event name | LOW |\n","| pv_gti_event_sport | STRING | DIMENSION | Content event sport | LOW |\n","| pv_gti_genre | ARRAY | DIMENSION | Content genre | LOW |\n","| pv_gti_is_live | BOOLEAN | DIMENSION | Content is live boolean | LOW |\n","| pv_gti_release_date | DATE | DIMENSION | Content release date | LOW |\n","| pv_gti_season | STRING | DIMENSION | Series season | LOW |\n","| pv_gti_series_or_movie_name | STRING | DIMENSION | Series or movie name | LOW |\n","| pv_gti_studio | STRING | DIMENSION | Content studio | LOW |\n","| pv_gti_title_name | STRING | DIMENSION | Content title e.g. episode name | LOW |\n","| pv_is_adfree | BOOLEAN | DIMENSION | Ad free content boolean | LOW |\n","| pv_is_avod | BOOLEAN | DIMENSION | Is advertiser-supported VOD boolean | LOW |\n","| pv_is_channels | BOOLEAN | DIMENSION | Is channel boolean | LOW |\n","| pv_is_svod | BOOLEAN | DIMENSION | Is subscription VOD boolean | LOW |\n","| pv_is_user_initiated | BOOLEAN | DIMENSION | User-initiated content or auto-play content | LOW |\n","| pv_material_type | STRING | DIMENSION | Video material type e.g. full, live, promo, trailer | LOW |\n","| pv_offer_group | STRING | DIMENSION | Content offer group e.g. free, prime, rental, purchase | LOW |\n","| pv_playback_date_utc | DATE | DIMENSION | Date of the event | LOW |\n","| pv_profile_type | STRING | DIMENSION | Type of profile associated with the content | LOW |\n","| pv_playback_dt_utc | TIMESTAMP | DIMENSION | Timestamp of the event | MEDIUM |\n","| pv_seconds_viewed | DECIMAL | METRIC | The seconds of view time associated with a streaming event | MEDIUM |\n","| pv_session_id | STRING | DIMENSION | Session ID of the event | VERY_HIGH |\n","| pv_stream_type | STRING | DIMENSION | Type of stream content e.g. linear tv, live_event, VOD | LOW |\n","| pv_streaming_asin | STRING | DIMENSION | Amazon Standard Identification Number (ASIN) | LOW |\n","| pv_streaming_geo_city | STRING | DIMENSION | City accessing the event | LOW |\n","| pv_streaming_geo_country | STRING | DIMENSION | Country accessing the event | LOW |\n","| pv_streaming_geo_dma | STRING | DIMENSION | DMA code | LOW |\n","| pv_streaming_gti | STRING | DIMENSION | Global title information | LOW |\n","| pv_streaming_language | STRING | DIMENSION | Language of the event | LOW |\n","| user_id | STRING | DIMENSION | Pseudonymous identifier that connects user activity across different events. The field can contain ad user IDs (representing Amazon accounts), device IDs, or browser IDs. NULL values appear when Amazon Ads is unable to resolve an identifier for an event. The field has a VERY_HIGH aggregation threshold, meaning it cannot be included in final SELECT statements but can be used within Common Table Expressions (CTEs) for aggregation purposes like COUNT(DISTINCT user_id). | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID value. AMC includes different types of user ID values, depending on whether the value represents a resolved Amazon account, a device, or a browser cookie. If Amazon Ads is unable to determine or provide an ID of any kind for an impression event, the user_id and user_id_type values for that record will be NULL. Possible values include: adUserId, sisDeviceId, adBrowserId, and NULL. | LOW |\n"],"documentType":"guide"},{"title":"NCS table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/cpg_insights_stream_paid","content":[" Analytics table: \n","ncs_cpg_insights_stream\n"," Audience table: \n","ncs_cpg_insights_stream_for_audiences\n"," NC Solutions (NCS) CPG Insights Stream provides offline modeled transactions at the household level, representing the total US population of 127MM+ households. This data is derived by NCS by applying advanced machine learning models that utilize seed dataset comprising over 2.7 trillion observed transaction records representing 98 million+ US households. These records are collected from over 20+ major national and regional CPG retailers across 56K+ retail locations, and are combined with robust household-level information from Nielsen to identify shopping patterns and similarities across households.\n"," With NCS CPG Insights Stream, you can bring granular offline retail sales data into AMC. It allows you to holistically measure the impact of your online media, not just on driving online purchases but also on driving offline purchases. You can then use these insights to inform campaign and channel optimization strategies.\n","| Column Name | Data Type | Column Type | Column Description | Aggregation thresholds |\n","\\|------------\\|------------\\|--------------\\|-------------------\\|---------------------\\|\n","| brand | STRING | DIMENSION | NCS syndicated brand name | LOW |\n","| category | STRING | DIMENSION | NCS syndicated product category name | LOW |\n","| department | STRING | DIMENSION | NCS syndicated department name | LOW |\n","| household_purchase_id | STRING | DIMENSION | Unique ID for the household purchase event, can be used to count distinct household purchases. | VERY_HIGH |\n","| ncs_household_id | STRING | DIMENSION | NCS household ID | VERY_HIGH |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Is this item not allowed to use 3P tracking.| NONE |\n","| product_category | STRING | DIMENSION | NCS syndicated subscription resource object; associated with the department, super_category and category attributes | LOW |\n","| purchase_dollar_amount | DecimalDataType(precision=38, scale=2) | METRIC | US Dollar amount of products purchased | LOW |\n","| purchase_quantity | INTEGER | METRIC | Quantity of products purchased | LOW |\n","| sub_brand | STRING | DIMENSION | NCS syndicated sub brand name | LOW |\n","| super_category | STRING | DIMENSION | NCS syndicated super product category name | LOW |\n","| user_id | STRING | DIMENSION | User ID | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID | LOW |\n","| week_end_dt | DATE | DIMENSION | Week end date. Datestamp of last day included in the weekly transaction file. Datestamps will always be the Saturday of each week and represents purchases over the last 7 full days; Sunday-Saturday. | LOW |\n"],"documentType":"guide"},{"title":"Experian table","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/experian_paid","content":[" Analytics table: \n","experian_vehicle_purchases\n"," Audience table: \n","There is no associated audience table.\n"," Through their partnership with the Department of Motor Vehicles (DMV), Experian enables automotive advertisers to measure the impact of Amazon DSP campaigns against vehicle purchases. For vehicle purchases, there is a two month delay (lag) and data is refreshed at the end of each month. This means the current and prior calendar month do not have a complete view of vehicle purchases. You may need to wait X days (where X = length of attribution window) after the campaign ends to receive complete results. For example, if using a 60 day attribution window, and the campaign end date plus 60 days falls into the current or prior month, you will not receive a complete view of attributed vehicle purchases.\n"," The experian_vehicle_purchases table includes 12.5 months of historical vehicle purchases for the selected vehicle makes. Vehicle purchases added to the instance are not ad-attributed. The current and prior calendar month of vehicle purchases are always incomplete.\n"],"documentType":"guide"},{"title":"Experian table","sectionHeader":{"type":2,"text":"`experian_vehicle_purchases`"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/experian_paid","content":["| Column_Name | Data Type | Column Type | Column Description | Aggregation thresholds |\n","\\|------------\\|-----------\\|-------------\\|-------------------\\|---------------------\\|\n","| new_or_used | STRING | DIMENSION | Indicates whether the vehicle was purchased new or used. Column will contain N for new, and U for used. | LOW |\n","| no_3p_trackers | BOOLEAN | DIMENSION | Is this item not allowed to use 3P tracking | NONE |\n","| purchase_date | DATE | DIMENSION | Purchase date of vehicle | LOW |\n","| reported_dealership | STRING | DIMENSION | The name of the dealership which sold the vehicle, as reported by the DMV (Department of Motor Vehicles). | MEDIUM |\n","| user_id | STRING | DIMENSION | Resolved User ID (or null) | VERY_HIGH |\n","| user_id_type | STRING | DIMENSION | Type of user ID | LOW |\n","| vehicle_class | STRING | DIMENSION | The vehicle class, for example, \"Luxury\" | LOW |\n","| vehicle_fuel_type | STRING | DIMENSION | The fuel type (i.e., gas, electric) of the purchased vehicle | LOW |\n","| vehicle_make | STRING | DIMENSION | The make (brand) of the vehicle purchased. | LOW |\n","| vehicle_model | STRING | DIMENSION | The model name of the vehicle purchased. | MEDIUM |\n","| vehicle_model_year | INTEGER | DIMENSION | Model year of vehicle purchased | LOW |\n","| vehicle_registered_state | STRING | DIMENSION | The state where the purchased vehicle was registered. | LOW |\n","| vehicle_type | STRING | DIMENSION | The type/segment (i.e., SUV) of the purchased vehicle | LOW |\n"],"documentType":"guide"},{"title":"Overview of SQL in Amazon Marketing Cloud","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/overview","content":[" AMC supports most of the basic query operations Structured Query Language (SQL) offers. The SQL used in AMC is referred to as AMC SQL. This topic provides a basic overview of most commonly used AMC SQL functionalities.\n"],"documentType":"guide"},{"title":"Overview of SQL in Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"Aggregation Threshold"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/overview","content":[" Some common SQL commands may not work with AMC. Or, at times you may not find granular data you are looking for in your report. This is because you can only access aggregated, pseudonymized outputs from AMC.  All information in your AMC instance is handled in strict accordance with Amazon privacy policies, and your own signals cannot be exported or accessed by Amazon. The privacy safeguards prevent you from exporting information at a grain that would violate the privacy safeguards. AMC maintains all privacy policies through the application of aggregation thresholds.\n"," Event-level data refers to individual events like an impression or click from a single user. Aggregated data refers to grouped data. For example: count of all unique users that were served an impression by a campaign.\n"," AMC has configured thresholds for aggregated data.\n"," Each column in an AMC table is classified into a category based on the combination of the aggregation threshold level and the filtering restrictions. For simplicity, this classification is referred to as the aggregation threshold. The aggregation threshold of a column determines the restrictions that are enforced to ensure customer privacy safeguards are not violated if a column is used in a workflow.\n"," You can extract aggregated data, provided that it meets the AMC aggregation thresholds. AMC checks if the thresholds are met and ensures\n"," data is pulled in a privacy safe way. For example, AMC does not support SELECT \\* for any of the tables.\n"],"documentType":"guide"},{"title":"Overview of SQL in Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"AMC SQL conventions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/overview","content":[" This section explains the conventions that are used to write the syntax for the SQL expressions, commands, and functions described in the SQL reference section.\n"," This section explains the conventions that are used to write the syntax for the SQL expressions, commands, and functions described in the SQL reference section.\n","| Character | Description   |\n","\\| :---------: \\|: ---------: \\|\n","| \\[ ]     | Brackets denote optional arguments. Multiple arguments in brackets indicate that you can choose any number of the arguments. In addition, arguments in brackets on separate lines indicate that the parser expects the arguments to be in the order that they are listed in the syntax. For an example, see SELECT. |\n","| { }     | Braces indicate that you are required to choose one of the arguments inside the braces.                          |\n","| pipechar          | Pipes indicate that you can choose between the arguments.          |\n","| '         | Words in single quotation marks indicate that you must type the quotes.  |\n","| …        | An ellipsis indicates that you can repeat the preceding element.         |\n"],"documentType":"guide"},{"title":"Overview of SQL in Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"Data types"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/overview","content":[" Supported data types for casting columns or expressions to.\n","| Data Type                   | Description                                                                                |\n","\\| --------------------------- \\| ------------------------------------------------------------------------------------------ \\|\n","| BOOLEAN                     | Logical values                                                                             |\n","| TINYINT                     | 1 byte signed integer                                                                      |\n","| SMALLINT                    | 2 byte signed integer                                                                      |\n","| INTEGER                     | 4 byte signed integer                                                                      |\n","| BIGINT                      | 8 byte signed integer                                                                      |\n","| DECIMAL(precision, scale) | Fixed point decimal                                                                        |\n","| FLOAT - REAL                | 4 byte floating point number                                                               |\n","| DOUBLE                      | 8 byte floating point number                                                               |\n","| DATE                        | Date such as '2020-02-14'                                                                |\n","| TIMESTAMP                   | Date and time such as '2020-02-14 12:00:00'                                              |\n","| CHAR - SYMBOL               | String                                                                                     |\n","| BINARY                      | Binary string                                                                              |\n","| ARRAY                       | Ordered collection of same type elements                                                   |\n","| STRUCT                      | Ordered collection of named elements. Each element may be of a different data type. |\n","| NULL                        | Null value                                                                                 |\n"],"documentType":"guide"},{"title":"Overview of SQL in Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"Logical operators"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/overview","content":[" Logical operators will produce a Boolean result and will either operate\n"," on one or two values or expressions.\n","| Operator      | Description                  | Arity  | Example                   |\n","\\| ------------- \\| ---------------------------- \\| ------ \\| ------------------------- \\|\n","| AND           | Logical and                  | binary | expression AND expression |\n","| OR            | Logical or                   | binary | expression OR expression  |\n","| IS \\[NOT] NULL | Test if value is null or not | unary  | value IS \\[NOT] NULL       |\n","| NOT           | Logical not                  | unary  | NOT expression            |\n","| =            | Equals                       | binary | expression = expression   |\n","| !=            | Not Equals                   | binary | expression != expression  |\n","| >            | Greater than                 | binary | expression > expression   |\n","| >=           | Greater than or equal        | binary | expression >= expression  |\n","| &lt;             | Less than                    | binary | expression &lt; expression   |\n","| &lt;=            | Less than or equal           | binary | expression &lt;= expression  |\n"],"documentType":"guide"},{"title":"Overview of SQL in Amazon Marketing Cloud","sectionHeader":{"type":2,"text":"AMC SQL grammar"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/overview","content":[" AMC SQL queries use the following grammar:\n","| {\n","|  tableAlias . \\*\n","| dataSourceExpression  LEFT | FULL OUTER  JOIN dataSourceExpression joinCondition \n","| EXTEND_TIME_WINDOW( 'dataSourceReference', iso8601DurationString, iso8601DurationString ) \n","|dsp_clicks\n","|sponsored_ads_traffic \n","|amazon_attributed_events_by_conversion_time \n","|amazon_attributed_events_by_traffic_time\n","| windowSpec\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"SELECT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" The SELECT statement is used to select records from a table.\n","\\\\&lt;column1>, \\\\&lt;column2> refer to the field names in the table  \\* \\\\&lt;table1> refers to the table name that you want to select data from\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"DISTINCT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" The SELECT DISTINCT statement is used to return only distinct (unique) values from a column in a database.\n","\\\\&lt;column1>, \\\\&lt;column2> refer to the field names in the table  \\* \\\\&lt;table1> refers to the table name that you want to select data from\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"FROM"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" The FROM statement is used to specify the table to select the data from.\n","\\\\&lt;column1>, \\\\&lt;column2> refer to the field names in the table  \\* \\\\&lt;table1> refers to the table name that you want to select data from\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"LIMIT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" The LIMIT clause restricts the number of rows returned by a SQL query. It is commonly used for sampling data or retrieving top results.\n","LIMIT specifies the maximum number of rows to return  Always applied after filtering (WHERE)  Returns the first N rows from the result set\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"JOIN"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" AMC supports the JOIN clause which combines rows from two or more tables, based on a matching column between them.\n","\\\\&lt;table1> refers to the first table  \\\\&lt;column1> refers to a column in the first table  \\\\&lt;table2> refers to the second table  \\\\&lt;column2> refers to a column in the second table  \\\\&lt;matching_column1> refers to a column in table1 that should be used to match with a column in table2 \\* \\\\&lt;matching_column2> refers to a column in table 2 that should be used to match with a column in table1\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"Supported JOIN clauses"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" The types of JOIN clauses that AMC supports are:\n","Inner Join / Join\n"," This JOIN returns only the matching rows from both the tables in the JOIN.\n","Left Join/ Left Outer Join\n"," This JOIN returns all the rows of the table on the left side of the join and matching rows for the table on the right side of the join. For the rows that do not match, it will return NULL as the matched values.\n","Full Outer Join\n"," This JOIN returns all the matched and unmatched rows from both the tables. For the rows that do not match, it will return NULL as the matched values.\n","Cross Join\n"," A CROSS JOIN returns the cartesian product of the rows from the tables that are joined.\n","Non-Equi Join\n"," A Non-Equi JOIN retrieves data from multiple tables by matching column values between them based on an inequality operator like >, \\\\&lt;, != etc.\n"," Syntax\n","\\\\&lt;table1> refers to the first table  \\\\&lt;column1> refers to a column in the first table  \\\\&lt;table2> refers to the second table  \\\\&lt;column2> refers to a column in the second table  \\\\&lt;matching_column1> refers to a column in table1 that should be used to match with a column in table2 \\* \\\\&lt;matching_column2> refers to a column in table 2 that should be used to match with a column in table1\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":" JOIN vs UNION"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":3,"text":"Differences between `JOIN` and `UNION` clause"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":["|      JOIN                                                                                                                                                                                                                                                                                                                                                                           |      UNION                                                                                                                                                                                                                                                                                                                |\n","\\|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|\n","|     Combines rows from two or more tables, based on a   matched column between them                                                                                                                                                                                                                                                                                                 |     Combines results of two or more queries or SELECT   statements                                                                                                                                                                                                                                                        |\n","|     The two or more tables used in the JOIN may have   different columns, with one or more foreign keys for JOINing to each other   that are based on defined conditions.                                                                                                                                                                                                           |     The two or more SELECT statements used in the UNION   should have the same number and data type of columns                                                                                                                                                                                                            |\n","|     The result set may have more columns as the JOIN tries   to match and retrieve data from the JOINed table. If a row from the first   table has keys that match multiple rows in the second table, there will be a   row in the Example Query Results table for each combination. The result set   may or may not have the same number of rows as the tables used in the JOIN    |     A UNION will have all the rows from the first data   source + all the rows from the second. Hence, the result set will have more   rows, but the same set of columns, as the UNION consolidates the data in a   single set. UNION keeps unique records. UNION ALL keeps all records,   including duplicate records    |                  \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"WHERE"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" The WHERE clause is used to filter the query results based on a condition.\n","\\\\\\\\, \\\\\\\\ refer to the field names in the table that you want to select data from  \\\\&lt;table1> refers to the table name  \\\\&lt;condition> refers to the condition that should be true to filter down the query results\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"GROUP BY"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" The GROUP BY statement is used with aggregate functions MIN(), MAX(),\n","\\\\&lt;column1>, \\\\&lt;column2> refer to the field names in the table that you want to select data from\n","\\\\&lt;table1> refers to the table name\n","\\\\&lt;FUNC> refers to an aggregated function like MIN(), MAX() etc.\n","\\\\&lt;condition1> refers to the condition that should be true to filter down the query results\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"HAVING"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" The HAVING clause is similar to the WHERE clause as it helps filter the data based on specific conditions. HAVING clause can be used with aggregate functions, but a WHERE clause cannot be used.\n","\\\\&lt;column1>, \\\\&lt;column2> refer to the field names in the table that you want to select data from\n","\\\\&lt;table1> refers to the table name\n","\\\\&lt;FUNC> refers to an aggregated function like MIN(), MAX() etc.\n","\\\\&lt;condition1> and \\\\&lt;condition2> refer to the condition that should be true to filter down the query results\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"ALIASES"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" Aliases are used to give a table, or a column, a temporary name.\n","\\\\&lt;column1>, \\\\&lt;column2> refer to the field names in the table that you want to select data from\n","\\\\&lt;table1> refers to the table name\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"VALUES"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" The VALUES command specifies the values to include in a common table expression. Use Common Table Expressions to define values to filter the queries.\n","\\\\&lt;column1> refers to the field names in the table\n","\\\\&lt;table1> refers to the temporary table name\n","\\\\&lt;value1>, \\\\&lt;value2> etc. refers to the values that will be included in the table\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"REGEX"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" Regex or Regular Expressions, is a sequence of characters that are used to construct search strings or patterns that can be used for filtering data. A Regex can be a combination of integers, special characters etc.\n","|     Pattern    |     Usage                  |     Example                   |     Explanation                                                           |\n","\\|----------------\\|----------------------------\\|-------------------------------\\|---------------------------------------------------------------------------\\|\n","|     ^          |     Begins with            |     ^Toast                    |     Begins with toast. Example: toaster                                   |\n","|     (?!)       |     Case Insensitive       |     (?!)consideration         |     This will match with Consideration, CONSIDERATION,   conSIDerATION    |\n","|     ‘          |     Escape single quote    |     men''s electric shaver    |     This will match men’s electric shaver                                 |\n","|     \"          |     Escape double quote    |     red 48'''' rod            |     This will match red 48\" rod                                           |                           \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL basics","sectionHeader":{"type":2,"text":"COMMON TABLE EXPRESSION"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/basics","content":[" A Common Table Expression or a CTE is a temporary result set derived using a query, which can then be referenced in a SELECT statement as a table. Note that there is a comma separating multiple CTE definitions and no comma prior to the terminal query.\n","\\\\&lt;cte_name> refers to the name of the temporary table\n","\\\\&lt;query> refers to the query used to derive the result set\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"String functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"CHARINDEX\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Searches for a substring within a string and returns its starting position, with optional start position parameter for refined searches.\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"CONCAT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The CONCAT function concatenates multiple strings and returns the result as a single string. All inputs will be cast to string data type for joining.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"FORMAT\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Formats a value according to a specified pattern, allowing custom string representation of numbers, dates, and other types\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"INSTR"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Finds the first occurrence position of a substring within a string, returning 0 if not found. Similar to POSITION, but with a different syntax.\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LEFT\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Extracts a specified number of characters from the left side of a string\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LENGTH\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Calculates the number of characters in a string, including spaces and special characters\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LIKE"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" AMC supports the LIKE operator which matches a column name to a string value specified by the user. LIKE does not require regex syntax and works with wildcards.\n","column1 specifies the column that is in the WHERE clause that needs to be checked for a condition. - expression refers to the expression or value that the column needs to be compared to.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LOCATE\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Alias of CHARINDEX.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LOWER\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Converts all characters in a string to lowercase, useful for case-insensitive comparisons\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LPAD"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The LPAD function pads a string on the left side to a specified total length. If the string is already longer than the specified length, it is truncated to fit.\n","string the input string to pad - length the desired total length of the resulting string - pad_string (optional) the characters to use for padding. Default is a space character.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LTRIM\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Removes leading whitespace characters from the beginning of a string\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"POSITION\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Finds the first occurrence position of a substring within a string, returning 0 if not found\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"REGEXP_REPLACE\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Replaces text matching a regular expression pattern with specified replacement text\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"REGEXP_SUBSTR\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Extracts substring matching a regular expression pattern from a string\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"REGEXP_SPLIT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The REGEXP_SPLIT function splits an input string into a collection of substrings, using a regular expression pattern occurrence to split the string.\n","&lt;string> The input string that will be split into a collection of substrings \\* &lt;pattern> The regular expression pattern that is matched to split the string.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"REPEAT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The REPEAT function repeats a string a specified number of times and returns the concatenated result.\n","string the input string to repeat - count the number of times to repeat the string. If 0 or negative, returns an empty string.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"REPLACE\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Substitutes all occurrences of a search string with a replacement string within text\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"RIGHT\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Extracts a specified number of characters from the right side of a string, useful for suffix extraction\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"RPAD"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The RPAD function pads a string on the right side to a specified total length. If the string is already longer than the specified length, it is truncated to fit.\n","string the input string to pad - length the desired total length of the resulting string - pad_string (optional) the characters to use for padding. Default is a space character.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"RTRIM\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Removes trailing whitespace characters from the end of a string, complementing LTRIM\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"SIMILAR TO"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The SIMILAR TO expression evaluates to true only if the value matches the provided regular expression. The regular expression should follow Java regular expression syntax. Both inputs must be strings. The results returned are in a Boolean value.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"STRPOS\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns the position of a substring within a string, similar to INSTR but with different syntax.\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"STR_TO_MAP\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Converts a delimited string into a key-value map structure using specified delimiters\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"SUBSTRING\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Extracts a portion of a string based on starting position and optional length\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"TRIM"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The TRIM() function removes the space character or other specified characters from the start or end of a string. This function is useful when working with strings like advertiser or campaign names.\n"," To remove the leading and trailing space characters from str:\n"," To remove the leading and trailing trimStr characters from str:\n"," To remove the leading trimStr characters from str:\n"," To remove the trailing trimStr characters from str:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"UPPER\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Converts all characters in a string to uppercase, useful for case normalization\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"Math functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ABS\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns the absolute value of a numeric expression, converting negative numbers to positive while keeping positive numbers unchanged\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"CEIL\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Rounds a number up to the nearest integer, returning the smallest integer greater than or equal to the input\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"E()\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns the mathematical constant e (approximately 2.71828), used in exponential and natural logarithm calculations\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"EXP\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Calculates e raised to the power of the input value, the inverse of the natural logarithm function\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"FLOOR\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Rounds a number down to the nearest integer, returning the largest integer less than or equal to the input value\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LN\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Calculates the natural logarithm (base e) of a number, the inverse of the EXP function.\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LOG\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Calculates the logarithm of a number with a specified base, generalizing logarithmic calculations\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LOG10\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Calculates the base-10 logarithm of a number, commonly used for decimal scale calculations\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"POWER\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Raises a number to the specified power, enabling exponential calculations\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"RANDOM\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Generates a pseudo-random decimal number between 0 (inclusive) and 1 (exclusive)\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ROUND"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The ROUND function rounds numeric values to the specified decimal point. The result of input expression must be a numeric data type. If no rounding is specified, the result will default to 0.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"SIGN"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The SIGN function returns the sign of a numeric expression as -1, 0, or 1, indicating whether the number is negative, zero, or positive respectively.\n","numeric_expression a numeric value (integer, decimal, or floating-point)\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"SQRT\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Calculates the square root of a non-negative number, returning NULL for negative inputs\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"TRUNC\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Truncates a number to specified decimal places without rounding\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"Aggregate functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"APPROX\\_COUNT\\_DISTINCT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The APPROX_COUNT_DISTINCT function returns an approximate count of distinct non-null values in a column. It provides faster performance than COUNT(DISTINCT) for large data sets, with a small margin of error.\n","column_name refers to the column in the table that the function will operate on and return the approximate count of distinct values.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"AVG"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns the average of values (arithmetic mean) in columns. This function works with numeric data type as input and ignores null values. If all input values are null, the function returns a NULL result.\n","\\\\&lt;column_name> refers to the column in the table that the function will operate on and return the arithmetic mean of the values.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"COUNT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Total number of values in column. ALL is the default. When DISTINCT is specified, it eliminates all duplicate values. However, DISTINCT cannot be specified to get the total number of non-null values.\n"," or\n","\\\\&lt;column_name> refers to the column in the table that the function will operate on.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"COLLECT\\_SORTED"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The COLLECT_SORTED function creates a sorted array of all non-null input values. Unlike COLLECT followed by ARRAY_SORT, this function performs collection and sorting in a single step.\n","column_name refers to the column in the table that the function will operate on and return a sorted array of values.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"MIN"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The MIN function returns the minimum value in a set of rows. Null values will not be considered. The result will be null if all input values are null.\n","\\\\&lt;column_name> refers to the column in the table that the function will operate on and return the minimum value.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"MAX"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The MAX function returns the maximum value of all inputs. Null values will not be considered. The result will be null if all input values are null.\n","\\\\&lt;column_name> refers to the column in the table that the function will operate on and return the maximum value.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"SUM"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns the sum of all values in the column (or expression). This function works with numeric data type and ignores null values. If all input values are null, SUM() returns null.\n","\\\\&lt;column_name> refers to the column in the table that the function will operate on and return the sum of the values in it.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"Date/Time functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"CONVERT\\_TIME\\_ZONE"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The CONVERT_TIME_ZONE function converts a timestamp from one time zone to another. Unlike CONVERT_TIME_ZONE_FROM_UTC which assumes the input is in UTC, this function allows specifying both the source and destination time zones.\n","inputTime refers to the timestamp to convert - sourceTimeZone the time zone of the input timestamp (tz database name format) - destinationTimeZone the target time zone for the output (tz database name format)\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"CONVERT TIME ZONE FROM UTC"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Given a time data type, this function converts UTC timestamp to the timestamp of the specified time zone. The input can either be a\n","\\\\&lt;inputTime> refers to the timestamp in UTC \\* \\\\&lt;timezone> The time zone for the new timestamp.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"CURRENT_DATE\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns the current date in UTC, commonly used for date-based comparisons and calculations\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"CURRENT_TIMESTAMP\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns the current date and time in UTC, providing precise temporal information\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"DATE\\_TRUNC"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The DATE_TRUNC function truncates the input timestamp to a specified level of granularity. Granularity must be single quoted and valid formats can be SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.\n","\\\\&lt;granularity> refers to the date part to which to truncate the timestamp value \\* \\\\&lt;inputTime> refers to the timestamp to truncate\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"DAYOFMONTH\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns the day of the month as a number between 1 and 31\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"DAYOFWEEK\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns a number representing the day of the week (1-7, where 1 is Sunday), useful for weekday-based logic\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"EPOCH TO UTC TIMESTAMP"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" This function returns the timestamp value with epoch as input time. The input can result in seconds or milliseconds and the result will assume one or the other based on the magnitude. \n","\\\\&lt;expression> refers to the arguments passed to the function.\n"," The function will produce a timestamp value from the input time\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"EXTEND\\_TIME\\_WINDOW"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The EXTEND_TIME_WINDOW function allows for the time period of the input tables to be extended beyond the reporting time window.\n","\\\\&lt;table_name> refers to the table that needs to be extended beyond the current timeframe of the query  \\\\&lt;Number_of_Days_Retro> refers to the Number of Days to extend the table retroactively to pull data from  \\\\&lt;Number_of_Days_Future> refers to the Number of Days to extend the table in the future, beyond the current timeframe of the query\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"EXTRACT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The EXTRACT function extracts one time unit from a DATE or TIMESTAMP value. The time unit can be one of SECOND, MINUTE, HOUR, DAY, DOW, WEEK, MONTH, YEAR.\n","\\\\&lt;timeUnit> refers to the specific date part in the column or expression of data type of TIMESTAMP\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"HOUR\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Extracts the hour component (0-23) from a timestamp, useful for time-based analysis\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"MINUTE\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Extracts the minute component (0-59) from a timestamp value\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"MONTH\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Extracts the month number (1-12) from a date value\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"SECOND\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Extracts the seconds component (0-59) from a timestamp value\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"WEEK\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns the week number (1-53) of a given date\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"YEAR\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Extracts the year component from a date value\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"SECONDS BETWEEN"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The SECONDS_BETWEEN function calculates the time difference in seconds between two datetime values. It returns the number of seconds from firstInputTime to secondInputTime, computed as secondInputTimeminus firstInputTime.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"Conditional functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"CASE"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The CASE expression is a conditional expression that returns the expression from the first condition that evaluates to true.\n"," In the above example, each CASE expression is compared and evaluated to the booleanExpression and returns the first matching condition. If a match is not found, the ELSE clause is returned.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"COALESCE"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The COALESCE function takes a list of expressions (all of which must be of the same type) and returns the first non-null argument from the list of inputs. If all of the expressions are null, COALESCE returns null.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"IF"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The IF expression evaluates the input boolean value to be true or false based on the supplied expressions values. In the sample syntax below, the expression evaluates and returns trueExpression if the booleanExpression is true, otherwise returns the falseExpression.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"IFNULL\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Alias of COALESCE.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"IN"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" AMC supports the IN() function to specify multiple values in a WHERE clause.\n","\\\\&lt;value1>, \\\\&lt;value2>, \\\\&lt;valueN> are the list of values that the column will be specified in the WHERE clause will be compared to. If any of the values match the field, then the IN condition will be true.\n"," The IN() function can also be used with the NOT conditional operator to exclude values\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"NULLIF\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns NULL if two expressions are equal, otherwise returns the first expression.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"NVL\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Alias of COALESCE.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"NVL2\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Provides three-way NULL logic, returning expr2 if expr1 is not null, else returns expr3.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"Array functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ARRAY\\_CAT\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Concatenates two arrays into a single array, preserving the order of elements from both input arrays.\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ARRAY\\_CONTAINS"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The ARRAY_CONTAINS function returns true if the value is contained in the array. It returns false, if the value is not contained in the array.\n","\\\\&lt;array1> The source array. \\* \\\\&lt;value_to_check> specifies the value that the Array &lt;array1> should be checked for\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ARRAY\\_COMPLEMENT\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Returns an array containing all elements from the first array that do not exist in the second array.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ARRAY\\_DISTINCT\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Removes duplicate elements from an array while maintaining the order of first occurrence of each element\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ARRAY\\_INTERSECT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Creates a new array containing only the elements that exist in both input arrays, effectively finding common elements\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ARRAY\\_REMOVE\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Creates a new array with all occurrences of the specified element removed, maintaining the original order of remaining elements\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ARRAY\\_SORT"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Use the ARRAY_SORT() function to sort the collected values in sequence.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ARRAY\\_TO\\_STRING"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The function ARRAY_TO_STRING  converts an input array into a string, by concatenating all the elements of the array separated by the separator pattern.\n","&lt;array> The input array that will be concatenated into a single string \\* &lt;separator_pattern> The pattern that is placed between each element of array in the concatenated string\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ARRAY_UNION\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Combines elements from both arrays while removing duplicates, resulting in an array of unique elements from both sources\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"CARDINALITY\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Counts and returns the total number of elements in an array, useful for array size determination\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"COLLECT( \\[ALL \\| DISTINCT\\] column name )"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The COLLECT function creates a list of all non-unique input values by default. If DISTINCT is specified, the output will only contain unique values. Null values are considered in both cases.\n"," or\n","\\\\&lt;column_name> refers to the column in the table that the function will operate on and return the list of values.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"EXPLODE\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Transforms an array into multiple rows, creating a new row for each element in the input array\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"FLATTEN\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Converts a nested array structure into a single-level array, simplifying complex array hierarchies\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"Window functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Window functions perform calculations over a large set of data, creating windows as columns in aggregate expressions with the following supported operations.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"DENSE\\_RANK"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Similar to RANK, but if multiple rows have the same value, they will be assigned the same rank and the following row will have the next consecutive value. RANK would instead assign a non-consecutive value to rows following ties.\n"," The function takes no argument but requires an empty parenthesis along with the OVER clause.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LAG"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The LAG function accesses data from a previous row in the result set without using a self-join. It returns the value of an expression from a row that is a specified number of rows before the current row within a partition.\n","expression refers to the column or expression to return from the previous row - offset (optional) the number of rows back from the current row. Default is 1. - default (optional) the value returned when the offset goes beyond the partition boundary. Default is NULL.\n"," The function requires an OVER clause with an ORDER BY specification.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LEAD"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The LEAD function accesses data from a subsequent row in the result set without using a self-join. It returns the value of an expression from a row that is a specified number of rows after the current row within a partition.\n","expression refers to the column or expression to return from the subsequent row - offset (optional) the number of rows forward from the current row. Default is 1. - default (optional) the value returned when the offset goes beyond the partition boundary. Default is NULL.\n"," The function requires an OVER clause with an ORDER BY specification.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"PARTITION BY"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" AMC supports the PARTITION BY clause which divides the result set into partitions based on the specified column. PARTITION BY is generally used with window functions like SUM(), MAX(), RANK() etc. which perform the computation on the windows specified by the PARTITION BY clause.\n","\\\\&lt;window_function> specifies the operation that should be performed on the sets of rows within a partition  \\\\&lt;column2> specifies the field that should be used to partition the rows ORDER BY is the optional clause that can be used within the PARTITION BY clause to sort the rows in a specific order  \\\\&lt;column3> specifies the field that should be used for sorting the rows\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"RANK"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Evaluates and returns the rank of a row of values, if all rows in the tables were to be ordered by the elements specified in the ORDER BY clause.\n"," The function takes no argument but requires an empty parenthesis along with the OVER clause.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"ROW_NUMBER"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Evaluates to the row number based on the ordering of rows specified in the ORDER BY clause\n"," The function takes no argument but requires an empty parenthesis along with the OVER clause.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"Comparison functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"GREATEST"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The GREATEST function returns the largest evaluated expression from a collection of expressions. All expressions must evaluate to numerical data types.\n"," Null will be considered. Result will be null if any input columns value is null.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"LEAST"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The LEAST function returns the lowest evaluated expression from a collection of expressions. All expressions must evaluate to numerical data types. Null will be considered. Result will be null if any input columns value is null.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"Hash functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"HASH64\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Generates a 64-bit hash value for the input\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"MD5\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Generates a 128-bit MD5 hash value for a string\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"SHA1\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Generates a 160-bit SHA-1 hash value for a string\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"SHA2"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The SHA2 function generates a SHA-256 hash value for a string, providing stronger security than SHA1 or MD5.\n","string the input value to hash\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"VARBINARY functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"FROM_VARBINARY\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Converts a binary expression into its string representation, useful for working with binary-encoded data. Supported encoding types: hex, base64, and utf-8.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"TO_VARBINARY\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Converts a string to its binary representation, useful for binary data handling. Supported encoding types: hex, base64, and utf-8.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"JSON functions\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"JSON_EXTRACT\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Retrieves a specific value from a JSON string using a path expression, enabling JSON data manipulation\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"JSON_SERIALIZE\t"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" Converts a JSON value into its string representation, useful for storing or transmitting JSON data\t\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"Advanced functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"CAST"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"NAMED ROW"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" AMC supports the NAMED_ROW() function which helps group multiple columns under a single name.\n","\\\\&lt;label1> and \\\\&lt;label2> refer to labels to reference column1 and column2\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":2,"text":"Statistical functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"Standard deviation and variance"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" AMC provides support for several statistical functions that calculate the standard deviation and variance of either a population or of a sample set of data.\n"," The functions STDDEV_POP() and VAR_POP() calculate the standard deviation and variance of the population, respectively. Use STDDEV_POP() and VAR_POP() when the values represent the entire population, and are not a sample.\n"," The functions STDDEV_SAMP() and STDDEV() are synonyms for the same function. These functions can be used interchangeably because they calculate the standard deviation of a sample set of data, and provide the same results.\n"," Similarly, the functions VAR_SAMP() and VARIANCE() are synonyms for the same function, and calculate the variance of a sample set of data. Use these functions when the values are a sample, and not for the entire population.\n","| Functions                     | Calculates         | Population or Sample? |\n","\\| ----------------------------- \\| ------------------ \\| --------------------- \\|\n","| STDDEV_POP()               | Standard deviation | Population            |\n","| VAR_POP()                  | Variance           | Population            |\n","| STDDEV_SAMP() / STDDEV() | Standard deviation | Sample                |\n","| VAR_SAMP() / VARIANCE()  | Variance           | Sample                |\n","\\\\&lt;values>  A set of numeric values (integer, decimal, or floating-point)\n"," The query below calculates the standard deviation and variation of the clicks from the population of all clicks from cost-per-click (CPC) sponsored ads campaigns.\n","| ad_product_type   | stddev_pop_click_cost | var_pop_click_cost |\n","\\| ------------------- \\| ------------------------ \\| --------------------- \\|\n","| sponsored_brands   | 1.55863                  | 2.42933               |\n","| sponsored_products | 1.15449                  | 1.33286               |\n","\\\\&lt;values>  A set of numeric values (integer, decimal, or floating-point)\n"," The query below calculates the standard deviation and variance from a random sample of values for illustrative purpose.\n","| stddev_sample_stardard_deviation | variance_sample_variance |\n","\\| ----------------------------------- \\| -------------------------- \\|\n","| 21.45261                            | 460.2142                   |\n","\\\\&lt;values>  A set of numeric values (integer, decimal, or floating-point)\n"," The query below calculates the standard deviation and variance from a random sample of clicks from cost-per-click (CPC) sponsored ads campaigns. Taking a random sample has the potential to result in better query performance, with statistically similar (but not exact) results from the population.\n"," Note that the sample standard deviation and variance results are slightly different from the population in the previous section.\n","| ad_product_type   | stddev_samp_click_cost | var_samp_click_cost |\n","\\| ------------------- \\| ------------------------- \\| ---------------------- \\|\n","| sponsored_brands   | 1.55965                  | 2.43012               |\n","| sponsored_products | 1.15518                  | 1.33995               |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"SKEWNESS ()"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The SKEWNESS function returns the estimate of the skewness of a set of numeric values (integer, decimal, or floating point). Skewness is a measure of the asymmetry of the distribution. The function will return one value per dimension.\n"," Skewed to the right: A positive skewness value above 0.5 indicates that the skew is positive, also known as ‘skewed to the right’ or ‘right tailed’; this means that most of the distribution is concentrated on the left, and the right tail is longer.\n"," Skewed to the left: A negative skewness value below -0.5 indicates that the skew is negative, also known as ‘skewed to the left’ or ‘left tailed’; this means that most of the distribution is concentrated on the right, and the left tail is longer.\n"," Symmetrical: A skewness value around 0 (between -0.5 - 0.5) indicates that the distribution is nearly symmetrical on the left and the right. For example, a normal distribution has a skewness of zero.\n","\\\\&lt;values>  A set of numeric values (integer, decimal, or floating-point)\n"," The example results below for illustrative purposes show that both Sponsored Brands and Sponsored Products clicks are skewed to the right, or positively skewed. Sponsored Brands has a longer right tail, since its skewness value is about 35% larger than the value for Sponsored Products.\n","| ad_product_type   | skewness_click_cost |\n","\\| ------------------- \\| --------------------- \\|\n","| sponsored_brands   | 3.23764              |\n","| sponsored_products | 2.39026              |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL functions","sectionHeader":{"type":3,"text":"Percentile and Median"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/functions","content":[" The function PERCENTILE() calculates the value at a given percentile of a distribution of values. APPROX_PERCENTILE() calculates the approximate percentile of a distribution of values.\n","\\\\&lt;values>  A set of numeric values (integer, decimal, or floating-point) \\* \\\\&lt;percentile> The percentile of the distribution to be found. Value must be between 0 and 1.\n"," The MEDIAN() function calculates the middle value of a set of numbers.\n","\\\\&lt;values>  A set of numeric values (integer, decimal, or floating-point)\n","| ad_product_type   | percentile10_click_cost | percentile90_click_cost | approx_percentile10_click_cost | approx_percentile90_click_cost | median_click_cost |\n","\\| ------------------- \\| ------------------------- \\| ------------------------- \\| --------------------------------- \\| --------------------------------- \\| ------------------- \\|\n","| sponsored_products | 0.18                     | 2.57                     | 0.18                             | 2.57                             | 0.81               |\n","| sponsored_brands   | 0.37                     | 3.258                    | 0.37                             | 3.27                             | 1.09               |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL expressions","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/expressions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL expressions","sectionHeader":{"type":2,"text":"CONTAINED IN"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/expressions","content":[" The CONTAINED IN function returns true if the result of the input expression is equal to any of the expressions that follow the input expressions. If no match is found, the function returns FALSE.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL expressions","sectionHeader":{"type":2,"text":"BUILT-IN PARAMETER"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/expressions","content":[" This function returns a built-in parameter by name.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL expressions","sectionHeader":{"type":2,"text":"CUSTOM PARAMETER"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/expressions","content":[" Return input parameter value by name set at the workflow definition level.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL expressions","sectionHeader":{"type":2,"text":"UUID"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/expressions","content":[" Return random universally unique identifier (UUID) string.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL limitations","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/limitations","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL limitations","sectionHeader":{"type":2,"text":"Unsupported functions"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/limitations","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL limitations","sectionHeader":{"type":3,"text":"RIGHT JOIN"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/limitations","content":[" AMC does not support RIGHT JOIN. However, you may use LEFT JOIN and reverse the side of the table.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL limitations","sectionHeader":{"type":3,"text":"GETDATE()"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/limitations","content":[" AMC does not support the GETDATE() function, which returns the current database system date and time. However, you may use the following as a workaround:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL limitations","sectionHeader":{"type":3,"text":"ORDER BY"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/limitations","content":[" AMC does not support ORDER BY clause in a query. However, you may use it within a PARTITION BY clause.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud SQL limitations","sectionHeader":{"type":2,"text":"Limitations"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/limitations","content":["Aggregation queries must contain at least one aggregation method on a column. This is by design and is subject to change. Aggregation\n","RANK does not operate correctly when referencing as an alias in a HAVING clause. Instead, the RANK expression can be wrapped in a\n","Raw data cannot be exported from AMC. For example, the following is not permitted: SELECT \\* FROM DSP_IMPRESSIONS.\n"],"documentType":"guide"},{"title":"AMC SQL examples","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/examples","content":[" Rounded cost as GROUP BY\n"," In this case we want to bucket all impressions and the sum of supply costs into finer detail by adding a new dimension which is the supply cost rounded down to the cent.\n"," Impressions aggregated on the hour\n"," Simple example of creating a column based on the date to add an additional bucket to group on for impressions.\n"," Impression user frequency counting\n"," To find the number of impressions viewed per user, first aggregate all impressions by user and then aggregate against the result with a generated STRING frequency column.\n"," Aggregation by Brand\n"," The following query partitions impressions into two buckets, one being a specific brand and the other being any other brands in the data set. This example could be extended to bucket by additional brands using chains of IF statements or more simply with a CASE statement. Note that\n"," Joining two data sets\n"," Simple join between the clicks and impressions data set to calculate the sum total of clicks and impressions at the campaign level.\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" AMC supports use cases of varying complexity, and each AMC instance contains up to 13 months of your advertising records. When you run complex queries or queries that span long date ranges, you may experience longer-than-expected run times or post-execution errors. In many cases, these issues can be mitigated by optimizing the SQL code of your query.\n"," SQL optimization is the process of improving the performance of a query by adjusting query elements to reduce execution time and resource usage while still producing accurate results. Queries can often be optimized for simplicity and efficiency by:\n","More efficiently filtering records earlier in the query  Eliminating redundant sub-queries  Optimizing JOIN conditions \\* Optimizing the order of operations of the query\n"," This guide provides AMC SQL best practices, query examples, and steps for SQL troubleshooting and optimization.\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":2,"text":"Understanding query execution order"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" When optimizing SQL, it is beneficial to first have an understanding of the different parts of a SQL query and the order in which they are executed. Every AMC query has the following parts:\n","Sources (FROM): Tables and views to which your query is applied  Filters (WHERE): Clauses that are used to define the records relevant to your analysis  Joins (e.g. INNER JOIN): Means of combining one or more sources together  Aggregations (GROUP BY): Used with aggregate functions to create summary records with common dimension values  Final conditions (HAVING): Additional logic, similar to WHERE, but applied atop aggregated results\n"," When an AMC query is executed, it will follow the order as listed below:\n","The sources are chosen and read 2. The specified WHERE filters are applied atop the sources 3. Joins and/or aggregations are performed (the exact order depends on the query structure) 4. HAVING conditions are applied to the final result set\n"," Below is an example query that demonstrates this order:\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":2,"text":"Best practice summary"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" Below are some query best practices to note as you work in AMC.\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":3,"text":"Filter data early and properly"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" Sources and any filters applied atop them ultimately dictate the amount of records that your query is executing across. The primary optimization mechanism is to ensure that your query is leveraging the correct sources, and that you are applying filters as specifically as possible. Optimizing sources and filters has compounding benefits on the joins and aggregations later in the query by reducing cached record volume.\n"," For example, assume you want to gather conversion events for one specific campaign and one specific event type. If your instance contains 50 advertisers in it, all of whom are associated with a variety of campaigns and event types, it would be wasteful for the query to search records across all advertisers, campaigns, and event types, and/or output more records than are necessary for your needs. \n"," Illustrated on the below-left is a query that allows you to get the information you want (but you have to filter the results after you get them to your specific campaign and event type). On the right is a query that allows you to achieve the same result (conversion event by campaign, limited to one event type) - faster, as it provides specific guidance on the exact records of interest. Filtering to just the relevant records, as early on in the query as possible, will improve the performance of the query.\n"," It is also preferable to use Search ARGument ABLE (Sargable) filters where possible. Sargable filters allow your query to more efficiently narrow down to the relevant records because they avoid using functions within WHERE filters. Whereas non-sargable filters force the query engine to read all of the records and apply the function to determine whether a record is relevant or not. Below is an example of a non-sargable query, using ARRAY_CONTAINS to check if the value of a column is in the list of in-scope values. While the query is functionally correct, this results in the query engine having to evaluate the result of ARRAY_CONTAINS (a function) which would then prevent the query from reading unnecessary segments of data from the table.\n"," The above query can be optimized and made sargable by using either CTE + INNER JOIN, or CTE + IN clause. An example of optimizing the query using CTE + INNER JOIN is given below:\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":3,"text":"Leverage `UNION ALL` instead of `JOIN` when possible"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" When row-by-row matching between tables is not required, it is more appropriate to use a UNION ALL operation instead of a JOIN. UNION ALL is used to stack data vertically, without any matching logic, whereas JOIN is used to combine datasets horizontally, based on a matching condition. The example below illustrates a scenario where UNION ALL can be used in place of a JOIN.\n"," In this example, you could use UNION ALL to combine the tables by stacking them on top of each other, without the need for any matching criteria between the rows. This would achieve the same result in a more efficient way.\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":3,"text":"Optimize join order"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" Joining two or more sources can increase or decrease the volume of data that the query is operating across. An improper join condition can result in a cartesian join (matching multiple rows from the first table with multiple rows from the second table). This can significantly increase the number of records your query is operating across. Some things to note:\n","Is a JOIN necessary, or would UNION/UNION ALL suffice?  Can you use EQUI-JOIN operations (indicated with an equal sign such as t1.col_a = t2.col_b)?  Does your JOIN include an ON clause at the proper level of granularity? (e.g. is it necessary to join on user_id, or would it be possible to join on campaign_id_string and user_id?)\n"," The order in which tables/CTEs are joined can also impact query performance. To maximize performance, you should join tables/CTEs in the order where the next operation will work on the smallest amount of records as possible. As an example, assume that you have the following three tables and each of them can be joined with each other:\n","t1: 10,000,000 records  t2: 1,000,000 records  t3: 100 records\n"," The most efficient approach would be to join both t1 and t2 with t3, as t3 is small enough that a query engine could load the whole table into memory. For example:\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":3,"text":"Avoid logical errors and hidden cartesian (cross) joins"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" It is crucial to avoid logical errors in queries, as these can significantly impact both accuracy and runtime. Logical errors, in addition to generating incorrect results, can often cause unintentional or hidden cartesian (cross) joins that lead to exponential growth in the amount of data processed. This means that in addition to the end result being incorrect, it can take a long time for the query to run. Carefully reviewing your query logic can help identify and address such errors.\n"," The example query below analyzes the cost, purchase, and new-to-brand (NTB) purchases for a group of campaigns. However, it accidentally inflates the data through some logical errors, resulting in cartesian joins.\n"," In example above, the conversions_purchase and impressions_spend CTEs are aggregated at the user_id level (a missed aggregation opportunity) and joined together in the final SELECT on the campaign_id_string and user_id. This approach is incorrect because a single campaign can serve multiple impressions to the same user_id, and will result in duplicative metrics. For example, if a user_id was served 10 impressions from the same campaign and made two purchases, the query logic (hidden cross join) would incorrectly show 10 x 2 = 20 conversions and 20 impressions.\n"," To address this logical error, the query conversions_purchase and impressions_spend CTEs should be revised to aggregate data at the campaign level, rather than the user_id level. In the final SELECT statement, the CTEs can then be joined at the campaign_id_string level. This ensures that the metrics are correctly calculated. Review these modifications in the query below.\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":3,"text":"Eliminate or reduce calculations"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" Another technique for reducing the amount of computation is delaying the use of aggregation functions/calculations in the query. When implemented in a query, aggregation functions require the processing of records and take up system memory, increasing the amount of work that needs to be done. As a general rule, you want to apply such functions to the smallest amount of data as possible - this usually means applying them at the very end of the query.\n"," Queries may also sometimes contain calculated fields in order to help you easily interpret the results. In AMC, for instance, you can create calculated fields for cost-per-mille (or CPM, the cost in your currency for one thousand impressions) or purchase rate (percentage of users reached by your campaign that go on to purchase). These types of calculations can be implemented within the query, or performed manually after your query has run. In cases where query performance is an issue, it may be beneficial to adjust the query such that the output contains those fields needed for the calculation, which is then performed manually outside of AMC. For instance, instead of including a purchase_rate calculated field in your query, you can:\n","Include fields for unique_reach (COUNT of distinct user_id values associated with impression events) and unique_purchasers (COUNT of distinct user_id values associated with purchase events) in the final SELECT statement of your query. 2. Within the resulting output, calculate purchase_rate by dividing unique_purchasers by unique_reach.\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":2,"text":"Optimization handbook"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" This section dives deep into a single query, reviewing how to apply best practices to improve the performance of the query.\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":3,"text":"User-defined JOINs"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" Some JOIN choices within user-defined query syntax can force the query planner to expend significant amounts of compute resources in order to arrive at the same result set that would have been returned with a more efficient JOIN type.\n"," Things to look for:\n","Excessive usage of LEFT JOIN keywords  Usage of FULL OUTER JOIN keywords  OUTER JOIN operations, without NULL value handling \\* Hidden cartesian/CROSS joins (e.g. JOIN table_a ON 1 &lt; 2 or JOIN table_a ON 1 = 1)\n","Use UNION/UNION ALL instead of a join, where possible. In some cases, uniting fields from two tables with UNION is faster than doing so with JOIN operations since UNION does not need to match values. However, note that these cannot be used in your query logic interchangeably - see Introduction to AMC SQL for more guidance on using each function. 2. Use a more restrictive join type. For example, it may be possible to use INNER JOIN instead of LEFT JOIN in some cases. 3. Remove cartesian/CROSS joins where possible. 4. Utilize EXISTS operators where columns from a joined table are used only for filtering purposes. In cases where a column from a joined table is used only for filtering purposes, utilizing an EXISTS clause can be more efficient, since EXISTS returns a Boolean value (TRUE or FALSE) based on the evaluation of condition, as opposed to returning an entire string or numeric column. 5. Eliminating unnecessary JOIN conditions. Certain JOIN conditions can be removed if an existing column within current table or selection can be used to achieve the same result. The example in below query shows how to replace filter condition using a column in the existing table, thus eliminating an additional join that is only required for a filter condition.\n"," Assume an AMC user defined two groups of campaigns: “Display” and “Streaming TV”. The query is trying to assess the overlap of those exposed to both the display campaigns and streaming TV campaigns, and calculate overall impressions and clicks for this group.\n"," The original query is shown below. Note two elements that decrease the efficiency of this query.\n","LEFT JOIN is used in imp & click CTEs to filter campaign_id_string. When you only care about the values that the tables have in common (i.e. the campaigns that are found in both impression and click tables, in this instance) a more efficient alternative would be using a more restrictive join type (INNER JOIN). 2. INNER and LEFT joins are also used to combine the imp, click, and combined_user CTEs in the final SELECT statement. A more efficient alternative would be using UNION ALL instead.\n"," Below is the optimized version of the above query, now leveraging INNER JOIN and UNION ALL:\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":3,"text":"Missed aggregation opportunities"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" The result sets returned by queries (or subqueries/CTEs) should be aggregated/reduced to the smallest possible size to reduce computational complexity and increase query efficiency. For CTEs, an unaggregated returned result set can have significant impacts on JOIN or CASE statements performed by subsequent subqueries or other operations. A CTE that returns a result set with duplicate rows should be de-duplicated prior to JOIN operations with other tables/result sets.\n","CTEs that could include an aggregation function (such as SUM) due to subsequent aggregation by later operations  Non-aggregated CTEs that select a subset of the fields of a table but lack a GROUP BY clause  CTEs that select fields which are not utilized later in the query\n","Add aggregation functions to CTEs where applicable. Aggregation is a means of reducing the number of records, as much as possible, that are going into the next operation. The lower the number of records, the faster the execution. 2. Add GROUP BY clauses to non-aggregated CTEs that could return duplicate rows. 3. Use GROUP BY instead of DISTINCT to remove duplicates. DISTINCT returns all rows then de-duplicates them, whereas GROUP BY de-deduplicates rows as the algorithm reads them one by one. In some cases, you can use GROUP BY to group metrics along common dimension values, thereby removing duplicate rows (in place of using DISTINCT). 4. Do not SELECT columns within CTEs if you will not be using them later in your query.\n"," Continue optimizing the same query used in the previous section, where you adjusted the JOIN operations for more efficiency. Now look for some additional means of optimization.\n","The imp and click CTEs produce intermediary result sets with one record per user_id, per campaign_id_string, per campaign_category to work towards determining which users were exposed to more than both campaign groups (display and streaming TV). A more efficient alternative would be to apply an aggregation function on the campaign_category dimension in the relevant CTEs, and use campaign_id_string only in the ON clause. The new intermediary result sets produce only one record per user_id value, reducing the amount of records the query is operating over. 2. In the section from display_user to combined_user, the only purpose is to filter user_id. This can be done more efficiently via a single CTE.\n"," Below is the optimized version of the above query, now leveraging better aggregation practices and consolidating CTEs used to filter to the relevant user_id values.\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":3,"text":"Non-restrictive predicates"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" Filtering within the predicates of a query (WHERE, HAVING, and JOIN conditions) reduces result set row counts and can significantly improve query performance when utilized. CTEs should be filtered using predicate clauses to only the relevant records before they are related to other result sets.\n","Queries/CTEs that lack a WHERE clause  WHERE clauses that do not effectively filter rows (e.g. WHERE campaign is NOT NULL).  JOIN conditions which are always TRUE (e.g. ON 1=1) \\* HAVING conditions that do not reference an aggregate\n","Determine whether a WHERE clause can be added to the query/CTE. A WHERE clause will reduce the size of its result set by filtering to only the relevant records.  Adjust ineffective/inefficient predicate clauses. Use the most restrictive filters possible to meaningfully limit the size of the result set to only the relevant records.  Predicates should be added at the earliest possible stage of the query. Optimizing filters has compounding benefits on the joins and aggregations later in the query by reducing cached record volume.\n"," Continuing on with the same query as used in the previous examples, now consider how you can reduce the record volume as early as possible in the query. Additional areas for optimization in the code are depicted below.\n"," The combined_user CTE filters to the relevant user_id values, and the pre CTE gathers metrics; metrics are then limited to relevant user_id values with an INNER JOIN. While this is more efficient than previous versions of the query, you can still do more to reduce the cached record volume at earliest possible opportunity in the query. A more efficient option would be to combine the combined_user and pre CTEs, gathering relevant user_id values and associated metrics in a single step.\n"," Below is the final optimized version of the query, which gathers relevant user_id values and associated metrics in a single CTE, rather than using multiple CTEs.\n"],"documentType":"guide"},{"title":"Optimize AMC SQL queries","sectionHeader":{"type":2,"text":"Getting more help"},"path":"/en-us/guides/amazon-marketing-cloud/amc-sql/how-to-opt-amc-sql-queries","content":[" Are your queries still timing out?\n","Have you tried optimizing the query using techniques listed above?\n","If so, have you shortened the time window the query is running for? Try reducing it from monthly to 2 weeks, and then 1 week if needed.\n","If you have optimized and reduced the date range but the query is still timing out, submit a support ticket with your instance ID, the SQL ID, screenshots of the error, and the query itself.\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[" Advertisers use AMC to perform analytics easily across multiple, pseudonymized data sets to generate aggregated reports. To protect the privacy of shoppers exposed to ads, privacy safeguards are in place that are apparent when you query the data. The privacy safeguards prevent AMC users from exporting data at a grain that would violate the privacy safeguards. The aggregation threshold of a column determines the restrictions that are enforced to ensure customer privacy safeguards are not violated if a column is used in a workflow.\n"," Before reviewing the various aggregation threshold levels, it will be helpful to highlight a practical example of the column user_id, which has an aggregation threshold of \"very high\" and is used in many AMC queries. In practice, an aggregation threshold level of \"very high\" means that you will never be able to select the column in the final SELECT statement of a SQL query because this statement would expose the values of the column in the final output. In this example, selecting the actual user_id in the final SELECT statement would expose a single user's data, thus violating the privacy safeguards. Even with these restrictions in place, there are many permitted uses of user_id that do not expose the actual user_id.\n"," Below are just a few examples of insights that advertisers derive using the column user_id, even though it is highly sensitive:\n","First, many advertisers use the user_id to count the number of unique users reached by campaign. - Second, the optimal ad frequency insight, which was reviewed in the previous section, uses the user_id. - Third, other advertisers leverage the user_id in queries to measure the customer journey across various ad products, such as Display + OTT or Display + Sponsored Products.\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":2,"text":"Column Classifications"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[" Each column is classified into one of the categories below based on the combination of the aggregation threshold level and the filtering restrictions. All categories can be found in the data sources under the column 'aggregation threshold'. The classifications are also in the schema explorer.\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":3,"text":"None"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[" Values from the column can be included in the output of workflows without any special restrictions being enforced. This classification is generally used for metric columns, such as impressions and clicks. The aggregation threshold is 1 and there are no filtering restrictions.\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":3,"text":"Low"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[" Values from this column can only be included in the output of workflows if the row contains at least two distinct users. This classification is generally used for columns that contain dimensions that describe campaigns such as campaign_id and ad_group. The aggregation threshold is 2 and there are no filtering restrictions.\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":3,"text":"Medium"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[" Values from the column can only be included in the output of workflows if the row contains at least one hundred distinct users. Examples: bid_price and click_cost. The aggregation threshold is 100 and there are no filtering restrictions.\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":3,"text":"High"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[" Values from the column can only be included in the output of workflows if the row contains at least one hundred distinct users. The aggregation threshold is 100 and there are filtering restrictions. Filters using literal (static) values cannot be applied to the column. For example, postal_code falls into this category and this filter is not allowed: WHERE postal_code in (10001, 10011).\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":3,"text":"Very high"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[" Values from the column can never be included in workflow output, though they may be used for intermediate purposes in workflows as long as they are dropped or aggregated with COUNT or COUNT DISTINCT. There is no aggregation threshold that will reveal columns with the classification \"very high\" because doing so would expose events from a single user. There are also filter restrictions. Filters using literal (static) values cannot be applied to the column. For example, user_id falls into this category and this filter is not allowed: WHERE user_id in (111, 222). If a query compares literal values to high or very high sensitivity columns (or those derived from them), the query will be rejected. Both direct literal values and values that were influenced by literal values are considered. Literal values can originate from literal or parameter expressions in order to prevent indirect ways of producing a value. This protection is in place for all query constructs that could potentially compare multiple values, such as:\n","Expressions that compare values such as Equals, RegexMatches, Min, etc. - Join keys in join operations - Group-by keys in aggregate operations\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":3,"text":"Internal"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[" Values from the column can never be included in workflow output, though they may be used for intermediate purposes in workflows as long as they are dropped or aggregated with COUNT or DISTINCT COUNT. Examples for this type of column include marketplace_id and sns_subscription_id.\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":2,"text":"Postal code restriction example"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":3,"text":"Scenario"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[" A query to evaluate purchases by postal, a field with the aggregation threshold of high, returns many NULL (i.e. blank) rows.\n"," Due to the privacy safeguards, NULL rows were returned. The data returned includes 95 rows, of which 91 include the postal code and the purchases. 4 rows include the purchases, but exclude the postal code. A sum of the purchases from the file = 12,000. For brevity, the entire dataset is not shown here, but the head and tail of the csv is shown.\n"," Examples of the first four of the 91 complete rows that include both the postal code and purchases are below. The data returned is NOT NULL because there were at least 100 users for each postal code.\n","| postal code | purchases |\n","\\| ----------- \\| --------- \\|\n","| 10001       | 752       |\n","| 10023       | 610       |\n","| 10007       | 425       |\n","| 10012       | 323       |\n"," The 4 rows without a postal code, but with purchases are below. The postal code was omitted from the output because there were fewer than 100 users in the postal codes.\n","| postal code  | purchases |\n","\\|:------------:\\|:---------:\\|\n","|      -       | 75        |\n","|      -       | 52        |\n","|      -       | 41        |\n","|      -       | 15        |\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":2,"text":"How should the `NULL` rows be managed?"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":[" First, consider discarding the NULL rows. In the example above, you can evaluate the percentage of purchases that are missing a postal code. There were over 12,000 purchases and only 183 did not have a zip code match. Only 4 postal codes representing 1.5% of all purchases were missing a postal code. It is likely in your best interest to focus on the insights from 95 rows that include the zip code.\n"," Alternatively, try the tips below to include more users.\n","Extend the time window of the query. - Make any filters less restrictive to include more campaigns, line items, ASINs, etc.\n"],"documentType":"guide"},{"title":"Aggregation threshold","sectionHeader":{"type":2,"text":"Steps to follow when your query output has `NULL` rows"},"path":"/en-us/guides/amazon-marketing-cloud/aggregation-threshold","content":["Step 1: For every key metric, what percentage of this metric is represented by a NULL vs non-NULL dimensions? In the example above, 1.5% of postal codes had a NULL value. A pivot table in Excel will help you to answer this question. - Step 2: If a low percentage of your key metrics are from NULL dimensions, it is likely in your best interest to delete them from the file. You decide what your threshold for \"low\" is. - Step 3: If you have too many metrics with NULL dimensions (based on step 1), you will need to make your data less granular to get meaningful insights. Try the following:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Playbooks Overview","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/playbooks/playbooks_overview","content":[" Playbooks are intended to accelerate specific marketing use cases leveraging Amazon Marketing Cloud (AMC) data. The examples provided in the playbooks are based on a real-life use case, but are illustrative in nature. Each playbook lists the strategical and tactical perspective to achieve desired results.\n"," These playbooks include a combination of adtech strategy, code (SQL & Python), and data visualizations to intimately describe how and why each use case creates value-generating actions from AMC.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Playbooks Overview","sectionHeader":{"type":3,"text":"Intended audience"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/playbooks_overview","content":["Data analyst: You are experienced in SQL and use SQL to build and customize queries for specific advertiser needs. - Data engineer: You can build data flow pipelines that run the automation of segment measurement into activation. - Data scientist: You have an understanding of the scientific methodologies and assumptions required to conduct and apply the test results listed here.\n"," Get started with the following playbooks:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" Through this playbook, you will learn how to extract and group your campaigns, campaign categories, or brands within the funnel (through phases such as awareness, consideration, retargeting and so on). You will then process these insights to output visually as a Sankey diagram. \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":2,"text":"What is customer journey analytics?"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" Customer journey analytics is the process of identifying the interactions of a customer with an ad prior to an outcome. Outcomes include, but are not limited to, adding to cart, making a purchase, or even cart abandonment. \n"," For a campaign or a brand, this process helps you identify the series of events in each stage of your funnel that finally led to a particular outcome.  While the Path-to-Purchase or Path-to-Conversion analysis deliver powerful insights with the chronological sequence of interactions, those insights are challenging to visualize. \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Benefits "},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" Through the guidance in this playbook, you will:\n","represent the customer journey and subsequently the complicated paths across purchase using an effective visual diagram. -\tmanage to identify the campaigns that influenced the buyer in his journey of purchase. -\tmanage to identify different conversion event subtypes like add to cart, customer review, add to wish list, and so on. -\tmanage to identify different ad product types like Amazon DSP or Sponsored Ads campaigns that influenced the path to purchase of a customer\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Prerequisites "},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" To effectively use this playbook, we recommend you understand the following concepts:\n","AMC concepts: Specifically concepts such as data aggregation thresholds, privacy limitations, and other restrictions listed in the AMC documentation. -\tKnowledge of AMC SQL: The process outlined here relies on altering SQL code to match your purposes. -\tBasic Python: This playbook is built using Python, and may require some scripting to adapt it to your use case.  -\tAmazon QuickSight: You will need to know how to ingest data in Amazon QuickSight to output the required visualizations. -\tData-driven decision-making: A penchant for turning insights into action with media activations from AMC performance measures. \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Assumptions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":["Access to AMC instance -\tAt least 7 days of backfilled data  -\tMinimum 4 active campaigns\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Playbook steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":["Run queries. Run the Path to conversion by campaign and Path to conversion by campaign groups queries on an AMC instance with a desired timeframe.  2.\tTransform data to input for a Sankey diagram visualization. 3.\tVisualize and interpret results. \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":2,"text":"Run queries"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Query to generate path to conversion by campaign group "},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" The query will return the brand, path and relevant KPIs associated with each path. Understanding the buying journey of your customers can help you improve your campaign performance. To better understand the customer journey, you will need to look at the conversion paths your customers took.  This instructional query will enable you to identify the most popular paths your customers took before purchasing your products on Amazon. The query considers all touch points and their order in the path column of the final output. However, please note that paths in the final output are based on the timing of the first impression of the campaign group for simplicity. (see illustration below)\n","dsp_impressions  sponsored_ads_traffic  amazon_attributed_events_by_traffic_time\n"," The queries below are leveraged from the AMC IQ Library (Path to conversion by campaign group). \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Sample output "},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" \\---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Query to generate path to conversion by campaign category "},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" This query is the same as the above query but there is an additional campaign category added based on the goal of the campaign. This is dependent per advertiser and the campaign categories have to be modified depending on campaign goals and settings.\n","dsp_impressions  sponsored_ads_traffic  amazon_attributed_events_by_traffic_time\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Sample output"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" \\---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":2,"text":"Transform data to input for a Sankey diagram visualization"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" After you run the above queries, download the query results to process it to a format that can be consumed by Amazon QuickSight to visualize it on a Sankey diagram. Sankey diagram is a visual type within Amazon QuickSight and requires a one dimension in source and one dimension in destination. This visual type is available within other BI tools and the data transformation can be modified accordingly.\n"," See Preparing data for Sankey diagrams to learn how to process your query results before you upload it to Amazon QuickSight. \n"," Below is an example of how the data is prepared by exploding the path into a series of Source-Destination steps with each step in a new row. \n"," For example, a single-row 4-element path that looks like campaign-X, campaign-Z, Campaign-Q, campaign-Y\n"," \\---\\|---\\|---\\|---\n"," will “explode into” 3 separate steps/rows:\n"," \\---\\|---\\|---\\|---\\|---\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Parse the path to source and destination. "},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" The script below will update the path and explode it into a file consumable by the Sankey diagram visual type within Amazon QuickSight. This Python script takes the output file from the Query path to conversion by campaign categories as an input, uses regex to clean and transform the data and custom function explode the data into source and destination columns. Usually, for a Sankey a source and destination is required and this python script can be modified accordingly depending on what other BI platforms require.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":2,"text":"Visualize and interpret results"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Sample Sankey diagram"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Customer journey analytics","sectionHeader":{"type":3,"text":"Interpret results "},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CJA","content":[" The above Sankey diagram showcases the top 20 paths by purchase. Based on the visual you can identify that high number of purchasers were usually exposed to loyalty and consideration campaign categories. Also, overlap of users who were exposed to Awareness campaigns with other campaign categories is comparatively lower.\n"," With this, advertisers can identify different attributes per campaign category like impression frequency, cost , other line item details for loyalty and consideration campaigns and use similar attributes to design campaigns for brand building ,conversion or other categories. Additionally, based on the product category advertisers can target audiences similar to those that have had a high overlap in this case loyalty and consideration.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" Customer long-term value or customer lifetime value (CLTV) assesses customer value over the course of the brand relationship.\n"," The granular datasets that made calculating CLTV straightforward are disappearing as privacy takes the forefront of the discussion around consumer data. With AMC, advertisers can still measure advertising activity paired with conversions at a broader scale while maintaining a privacy safe environment.\n"," The metric aims to couple all costs to acquire and retain with customer revenue from purchases. Offsetting cost and revenue reveals the estimated net profit a customer will bring to a company over time. With this metric, CLTV can be used as a north star for a number of actionable outcomes.\n"," Use the formula below to calculate CLTV in the most basic form:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"Benefits of CLTV over Return on Ad spend"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" Return on ad spend (ROAS) and CLTV are both important metrics to tell a comprehensive story of digital media performance, but ultimately serve different purposes. ROAS is more focused on measuring the performance of a specific tactic in driving revenue. CLTV focuses on the holistic revenue generated from a customer over the lifetime of a company.\n"," Below are some reasons to consider CLTV as a preferred metric over ROAS for measuring digital media performance.\n","| CLTV                                                         | ROAS                                                         |\n","\\| ------------------------------------------------------------ \\| ------------------------------------------------------------ \\|\n","| Focuses on the long-term value of a customer and hence  provides a comprehensive view to the company over time. | Measures the short-term impact of a specific advertising  campaign. |\n","| Considers both ad-attributed conversions and  non-ad-attributed conversions for a full picture of the user journey. | Only considers revenue and conversions that were  ad-attributed. |\n","| Considers the customers’ repeat purchase and  potential to purchase additional products around the brand halo. | Only considers revenue generated from initial sale.          |\n","| Provides a more accurate measure of profitability,  taking into account the cost to acquire a customer, cost to re retain a  customer, and fixed costs to consider like production fees and shipping,  which can spread over a long period of time. | Does not factor the cost of acquisition, which can lead to  inaccurate profitability calculations. |\n"," CLTV allows for more targeted advertising strategies that focus on customer retention and loyalty, which can lead to a more profitable business model over time.\n"," This playbook will answer the following questions:\n","How to define cost and revenue inputs that factor into CLTV? - How to analyze customer base using CLTV? - How to segment audiences based on CLTV measure? - How to activate upon audience segmentation with Audience activation in Amazon demand-side platform (Amazon DSP)?\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" It is recommended you understand the following concepts to get the most out of the playbook:\n","AMC concepts: Specifically, concepts such as data aggregation thresholds, privacy limitations, and other restrictions listed in the AMC documentation. - Knowledge of AMC SQL:  You can also access the SQL Guide on AMC UI.\n","Basic Python: This playbook is built using Python, and may require some scripting to adapt it to your use case. - Basic AWS knowledge: Amazon SageMaker, and Amazon Athena in specific. You will need to know how to set up an Amazon SageMaker Notebook in accordance with the standards of your company. - Basic Amazon DSP knowledge: To activate upon CLTV Audience Segmentation in the advertising market, you will need to know how to query audiences to activate upon in Amazon DSP.\n"," For this playbook, we assume the following:\n","Long-term: Since AMC only allows the maximum long-term window of one year, for the purposes of this playbook, the term \"long-term\" shall be defined as a one-year timeframe. Some customer relationships will be abbreviated by this window length. However, see CLTV audience segmentation - year-over-year for a predictive approach to CLTV. - Revenue/costs inputs: It is up to your discretion to define both the revenue and cost models.\n"," Incorporating Paid features shopping insights for a complete revenue measurement adds conversions that were not driven by advertising, including Subscribe and Save (SnS) purchases for applicable brands. While CLTV can be calculated and activated upon as a rules-based audience without requiring a subscription to Paid Features, measuring CLTV on only advertising-attributed revenue streams does not tell a full story.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"Playbook steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" The playbook is structured in the following order:\n","Identify inputs to calculate CLTV 2.  Query data from AMC for CLTV 3.  Analyze audience value and activate audiences in ADSP\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":2,"text":"Identify inputs to calculate CLTV"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" The section below outlines a general approach to defining the inputs to calculate CLTV across advertisers and their sub-brands at the user_id level\n","Cost/revenue inputs - Duration of relationship - Overall long-term value distribution - Audience segment structure\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"Revenue and cost inputs"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" Within CLTV inputs, leverage a series of value levers from cost and revenue value drivers. For each lever, identify a KPI and method for measurement and optimization within each to inspire use cases and analyses coming from CLTV. The levers and KPIs are outlined below:\n","Revenue - Cost\n"," Shopping insights signals should be included at the revenue level to provide a comprehensive picture of revenue garnered from each customer. This data differentiates organic customers from \"near-customers\" who are not in the market yet.\n"," The inputs above give a clear view of how long a customer has had a relationship with the brand, the average revenue garnered from all purchases, and the frequency with which the purchases take place. This is just one approach, however, as there are many different ways to calculate CLTV based on the definition of value for a brand. See below for a way to measure and define CLTV, and common use cases.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"Duration of relationship"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" The final input for calculating CLTV is the period of time used to account for revenue and costs. Currently, AMC supports CLTV queries of up to a year, which provides context to how customers return and interact with a brand over a year. Determining this input is based on the time frame in which you run the forthcoming SQL queries.\n"," Visually, the inputs of revenue and costs combine to create an ongoing story of the current and future ad spend and usage behavior.\n"," The figure above is a representative example of how customer value (represented by the black curve in the illustration above) changes over time for a customer. Initially, advertising is spent to generate awareness and consideration of the customer, until the customer makes their first purchase. Over time, the customer purchases additional products adding to the revenue streams, with advertising costs going down to focus on retargeting and acquisition, causing the customer to become high-value.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"Audience segmentation structure"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" As you determine your revenue and cost inputs to calculate CLTV, you will also need to define a criterion to segment customers over their relative value. This, using the long-term profitability CLTV approach, will bucket audiences into groups of related revenue/cost potential to query and activate upon in the Amazon DSP.\n"," A simple way to do so is to first calculate the average cost and revenue generated from each audience. Then label each audience member based on their corresponding location in the grid above, with high-revenue/low-cost customers having the highest value.\n"," Below is an outline of each segment, their definition, and strategy to approach each (in this case, High = Above Average):\n","Low-value customers (high-cost/low-revenue): Low in revenue and high-cost audiences being exposed to a higher value of media spend offset with the value of revenue they generate. This set of audience is considered “low value.” - Growth potential customers (low-cost/low-revenue): Low in revenue and low in cost audiences are under-reached with a below average revenue. This set of audience is considered “low-value”, but they have some growth potential if promoted with the right product. - Revenue potential customers (high-cost/high-revenue): High in cost and high in revenue audiences being served an above average amount in advertising spend while also generating an above average amount of revenue compared to the entire customer base. - High-value customers (low-cost/high-revenue): Customers who are high-revenue and low-cost are considered the highest value customers to the brand.\n"," CLTV is something that can be customized on a per-advertiser basis using the inputs that are important to the advertisers when defining customer value. Even the audience labels can utilize medians, percentiles and standard deviations to define audience segments based on their overall distribution.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":2,"text":"Query data from AMC for CLTV"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" To calculate CLTV, you will need to make some decisions on revenue and cost inputs at the user-level. These decisions will depend on the analysis objectives as well as the individual definition of value for a brand.\n"," At a high level, the SQL script below will:\n","Pull ad data from the following source tables in AMC: Amazon DSP, Sponsored Display and Sponsored Product. For this case, the default level of aggregation will be set to the user. - Pull conversion data and metrics from tables in AMC: Conversions and the paid features data set conversions_non_ad_attributed for Shopping insights. - Combine data at a user-level for a fully-aggregated descriptive statistics and audience segmentation.\n","| customer_audience_segment         | num_users | total_sales | total_spend | cltv    |\n","\\|-----------------------------------\\|-----------\\|-------------\\|-------------\\|---------\\|\n","| Higher Revenue Potential Customer | 14,514    | $18.57     | $5.41      | $13.16 |\n","| High Growth Potential Customer    | 14,180    | $9.53      | $5.64      | $3.89  |\n","| Low Value Customer                | 607,585   | $9.30      | $4.11      | $5.18  |\n","| High Value Customer               | 3,133,429 | $14.21     | $2.76      | $11.45 |\n"," The table above gives an example of the expected output from running an audience segmentation query across multiple months for a brand, with the number of audiences for each segment, total sales, total spend in advertising, and average CLTV.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"A simplified version of the data flow diagram is:"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" Reference this instructional query for more details about assessing customer value based on groups of advertising exposure vs unexposed advertising: AMC Instructional Query:Customer Value - Average Spending by Exposure Group(link only available for AMC UI users).\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"User input and decisions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":["Level of aggregation: CLTV is aggregated at different levels to build a narrative around which products, sub brands and campaigns drive customer value over time. For Audience segmentation, the level of aggregation will be each of the four segments for each audience. -  Duration of CLTV: It is recommended to ensure the query includes a year’s worth of data. The entire duration must be included in one query, or you will not be able to match customers who purchased in January 2022 with customers who purchased in December 2022. -  Relevant revenue and cost metrics  In the example below, we will use: total_product_sales, total_units_sold, spend, total_cost, sns_purchase, and new_to_brand.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"How to execute the SQL scripts?"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" The script can be executed in two ways:\n","Run manually in the AMC UI(link only available for AMC UI users). - Run via AMC API - More advanced solution, recommended when building an automated data pipeline.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"AMC query for aggregated CLTV and audience segmentation"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" The query requires that you combine all the spend and revenue inputs and then calculate CLTV within the query, then you define an audience segmentation method at the user level. The output of this SQL statement will be a .csv that illustrates the impact of new-to-brand and subscription purchase flags to revenue, cost, and CLTV.\n"," Listed below are the formulas used in the query.\n","tracked_asin = The purchase ASIN number for the product associated with the CLTV figure - avg_purchase_frequency_ratio = The average purchase frequency of the customer on this particular ASIN/the total average purchase frequency of all ASINs - avg_purchase_quantity_ratio = The average purchase quantity of the customer for this particular ASIN/the average purchase quantity across all ASINs - avg_user_lifetime_ratio = The average purchase lifetime of the customer for this particular ASIN/the average purchase lifetime across all ASINs - total_sales = Total revenue generated from sales - total_units_sold = Total units sold from the sales - dsp_spend = Advertising spend associated with Amazon DSP advertising - sponsored_spend = Total spend associated with sponsored products advertising - total_spend = Combination of Amazon DSP spend and sponsored spend - avg_value_score = Net return value generated from total sales - total cost as a function of overall cost. - Avg_lifetime_score = Product of the purchase quantity ratio, purchase frequency ratio, and user lifetime ratio that denotes the overall relationship flags that users can input into the query. - CLTV = Net return value generated from total sales - total cost\n"," Lifetime\\*Value CLTV SQL export script:\n"," Based on our framework of table inputs, we can calculate CLTV using the logic below. Note that within the CLTV calculation, we will be incorporating purchase quantity, purchase frequency, and user lifetime per user as the ratio of all users to provide a weight to the overall profitability measure. This factors in the overall customer loyalty to the brand into the measure of overall customer value.\n"," The query to generate this can be found below:\n"," The output for the above query is below:\n"," \\---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\n"," The above is an output that uses the Lifetime Value approach for measuring CLTV among users that purchase specific ASINs. This is an example of a use case to define which ASIN are associated with customer value over time, and provide detail over whether they tend to be purchased in large quantities fewer times vs more frequently.\n"," After defining the audience segmentation conditions and generating the CLTV using the query above, use the SQL snippet below gives user ids an audience label some descriptive statistics to measure the overall revenue and spend makeup of each.\n"," This is done by adding a temp table that uses case statements to define the segmentation labels for each user ID, and then aggregating all the audience segment labels. The case below uses the lifetime\\*value approach to calculating CLTV.\n"," CLTV =  Lifetime \\* Value\n"," The SQL query below looks at CLTV by ASIN over the span of the past year. It focuses on users who made a new_to_brand purchase during the window:\n"," The output for the above query is shown below:\n"," \\---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\n"," Note that ASIN110 is associated with the largest customer long-term value among customers who purchased it as their new-to-brand purchase. This is followed by ASIN102, ASIN107, ASIN109, and ASIN104,  all with CLTV values of over 491.\n"," To incorporate audience labeling, you can add the following to the last case statement:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":2,"text":"Analyze audience value"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" After creating the query, the output now classifies user_ids based on their relative revenue and cost configuration into a segment that is based on their overall value to the brand. Before activating the audience, performing an exploratory data analysis in Python will help provide guidance on trends associated with these customer segments.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"Audience label descriptive statistics"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" The first case to explore is the descriptive statistics of each audience segment as they relate to ASINs and the purchases that are new-to-brand. This is done by adding tracked_asin and a flag for new-to-brand in the initial query, and cascading it through the rest of the temp tables.\n"," Given below is the output for the above query:\n"," \\---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"Audience label analysis"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" Comparing different audience segments, the code block below compares audience performance. The code outputs a graph in Python that groups all the data by the top CLTV customers and High Loyalty customers based on the sum of the lifetime and value scores to calculate CLTV.\n"," If you look at the CLTV grouped by tracked ASIN and audience segment, note that ASIN109, ASIN102 and ASIN104 show the highest overall CLTV while ASIN12, ASIN20, and ASIN15 show a higher CLTV among High Loyalty Customers. Since this is exclusively focused on new-to-brand customers, we could focus on the following ASINs to attract High CLTV new-to-brand customers.\n","ASIN 109 - ASIN 102 - ASIN 104\n"," Here, we can see some trends emerging where the high-loyalty customers and low-CLTV customers are showing a higher spend per user, and the high-revenue potential customer and high CLTV customer are showing a general lower spend per user and shows a higher rate of sales.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"Audience segment performance"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" Targeting specifically by audience segment can pay dividends for immediate campaign activation. As you can see below, the high-value customer segment shows a higher conversion rate across campaigns when compared to the low-value customer segment. The query will calculate conversion rate on audience and allow for an analysis in MS Excel.\n"," Below is the expected output (data is synthetic)\n"," \\---\\|---\\|---\\|---\\|---\n"," Here, you can see the relative value garnered if you target high-value customers specifically over other customer types.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"Activate audiences"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" To create and activate the queried list of user_id use the POST method of the AMC rule-based Audience API.\n"," If a customer wants to activate against high-value customers, the SQL query below will pull a list of user_ids that meet the high value criterion.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - customer long-term value","sectionHeader":{"type":3,"text":"CLTV Audience segmentation (year-over-year)"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/CLTV","content":[" While AMC has constraints to allow users to query events within 13 months or less, you can use a data lake and audience segment labels to measure how the distribution of your CLTV audience segments have a changing user count over time. This will allow you to measure the overall health of your business and how successful your tactics to move low value customers into being high value customers are. In order to do so, you would just need apply a time stamp component to the table within the workflow manager service on your audience segmentation queries. Then, you can schedule your queries to recalculate CLTV over a regular cadence into the future. A dashboard can be created to visualize your customer base over time.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Through this playbook, you will learn how to quickly and easily create multiple similar custom AMC audiences, monitor the refresh cadence, and measure the performance of your ad spend for these audiences.\n"," Creating many AMC audiences instead of one large audience offers the advantage of precise measurement of line item performance. For instance, if a custom AMC audience is created with ASINs of shoppers that “added to cart but did not check out”, it allows for clear measurement of the effectiveness of each audience. Larger audiences containing many ASINs can make it more complex to measure.\n"," The playbook will cover audience creation, measurement, optimization, and analysis using custom AMC audiences and the Amazon Demand Side Platform (Amazon DSP).\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"What is programmatic audience framework?"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Programmatic audience framework offers automation for the time-consuming and tedious aspects of the audience creation process when done at scale, with a goal of helping you identify the most effective audiences for continued media activation. See table below for a breakdown by steps in the process:\n","| Step          | Description                                                                  | Business question                                                | Painpoint                                                         | Action/solution                                                                                                                                                  |\n","\\| --------------- \\| ------------------------------------------------------------------------------ \\| ------------------------------------------------------------------ \\| ------------------------------------------------------------------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ \\|\n","| Pre Campaign  | Create and monitor audience creation                                         | How do I quickly create custom AMC audiences?                    | Manual and repetitive API calls and monitoring                    | Create custom AMC audiences for activation in the Amazon DSP. Formulate programmatic audience creation via custom audiences API.                                 |\n","|               |                                                                              | How do I monitor which audiences are ready for activation?       |                                                                   |                                                                                                                                                                  |\n","|               |                                                                              | What should the logic of the audiences be?                       |                                                                   |                                                                                                                                                                  |\n","| Mid Campaign  | Refresh audiences over time and establish workflows to monitor performance   | How do I monitor my audiences during the course of the campaign? | Monitoring audience refreshes measuring many audiences            | Adjust spend based on audience performance and refresh cadence cadence. Perform refreshes every 30 days that update audience sizes based on successful refreshes |\n","| Post Campaign | Measure overall performance over advertising campaign generated by audiences | Which audience were most effective?                              | Non-templatized reports with little context to the bigger picture | Deploy dashboards that display overall performance volume and ROAS.                                                                                              |\n","|               |                                                                              | Which audiences should I continue to use?                        |                                                                   |                                                                                                                                                                  |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"Benefits"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" The instructions in the playbook allows for custom creation of large AMC audiences that can be monitored for activation through the course of the campaign.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":["Technical\n","Marketing\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"Assumptions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" We assume that you have an understanding of the process to create multiple audiences by submitting multiple API calls and track the audience creation manually, which is described in the Rule based audience creation.\n"," Costs associated with implementing this playbook\n","Sagemaker 2. Submitting an audience to be created is not charged. There is no cost until the audience is activated.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"Playbook steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" The playbook is structured in the following order:\n","Introduces the concept of audience optimization and  approaches to measure audiences during pre, mid, and post campaign  reporting. 2. Defines the theory behind an ongoing audience optimization framework, and contexts in which it applies. 3. Outlines the prerequisites needed to build  optimization framework. 4. Provides a solution architecture build for a  pre-campaign audience build, mid-campaign audience optimization, and post  campaign audience reporting. 5. Outlines the next steps and provides more sophisticated measurement approaches.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"Pre-campaign - formulate and identify"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" The pre-campaign section will cover how to create custom audiences via API, how to formulate the audience to be created, how to check which audiences are likely to be viable. The section will include guidance on how to formulate a question, a sample use-case, and both SQL and Python code.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Formulate business question or hypothesis and create an audience"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" The following steps will guide you on how to select ASINs, create custom AMC audiences and measure performance. The first step, however, is to formulate a business question that you want to address. The playbook will use a sample business question of “Users who added-to-cart but never checked out, which ASIN is most valuable to target about that product”. Based on the business question you select, you will then need to convert it to an SQL query.\n"," Other potential business questions or hypothesis:\n","Endemic: - Endemic and non-endemic - Non-endemic\n"," The difference between a rule-based lookalike audience and a normal rule-based audience is that the lookalike audience will find users who are similar to the users sent in. This opens up new use cases as listed below:\n","| Use Case                                         | Description                                                                    | Metrics to focus on                                                                                | Best for                                                                 |\n","\\| -------------------------------------------------- \\| -------------------------------------------------------------------------------- \\| ---------------------------------------------------------------------------------------------------- \\| -------------------------------------------------------------------------- \\|\n","| High long-term value customers                  | Customers who contributed substantial sales to your brand                      | Total amount spend                                                                                 | All types of campaigns                                                   |\n","| Frequent buyers / Subscribe-and-Save customers | Customers who frequently purchased from your brand                             | Total number of purchases, total units of purchases                                                | All types of campaigns                                                   |\n","| New-to-brand (NTB) buyers                      | Customers who purchased recently for the very first time                       | NTB metrics                                                                                        | All types of campaigns                                                   |\n","| Brand loyalists                                  | Customers who made purchases across products or/and categories from your brand | Number of unique ASINs purchased                                                                   | Promoting new products, new product lines, and variety packs             |\n","| Bulk buyers                                      | Customers who purchased in bulk from you in the past                           | Number of units / order                                                                            | Promoting bundles, value packs, wholesale, etc                           |\n","| Seasonal shoppers                                | Customers who purchased during seasonal events previously                      | Dollars spent, number of purchases, or/and number of units purchased within particular time window | Seasonal campaigns                                                       |\n","| Offline buyers                                   | Customers who prefer to purchase from brick-and-mortar locations             | Offline conversion events                                                                          | Campaigns with mentions on offline presence or offline call-to-actions |\n","| High return-on-investment (ROI) customers    | Customers with measured high return on investment                              | Return on ad-spend (ROAS), acquisition cost                                                     | Marketing executions with clear budget constraints                       |\n"," Rule-based audiences are a better fit for situations where specific user actions are being selected. For example: “Users that added to cart but never checked out”. This is a strong fit for rule-based audiences as those specific users could potentially be the audience.\n"," To create a lookalike audience instead of a rule-based audience, the only change is a different API endpoint with one additional parameter (lookalikeAudienceExpectedReach). For details, see Rule-based lookalike audience . The monitoring endpoints remain the rule-based audience endpoints. The playbook supports both audiences via the parameter is_lookalike.\n"," One powerful source of input is incorporating the Flexible shopping insights (FSI) data for a complete view of conversions by adding those that were not driven by advertising, including complete SnS purchases for applicable brands. While ROAS can be calculated and activated upon as a rules-based audience without requiring a subscription to the AMC Paid features, utilizing FSI can help tell a more complete story of the audience behavior.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Identify `ASIN`s"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" This first step is exploratory and aims to identify high-value ASINs while minimizing audiences that may not perform well. This initial query will mirror the Amazon DSP audience creation query and the time range for the following steps. The starter query below returns ASINs with users who added items to their shopping cart but did not make a purchase.\n"," Run the following query in your AMC instance:\n"," With a sample output of:\n","| tracked_item | distinct_users |\n","\\| --------------- \\| ----------------- \\|\n","| ASIN1         | 10,000          |\n","| ASIN7         | 8,000           |\n","| ASIN52        | 6,000           |\n"," This list of ASINs shows that ASIN1 has 10,000 users that “added to cart but never checked out”. A custom AMC audience could be created to reach these 10,000 users with an ad for ASIN1.\n"," Other Options for ASINs\n"," Groups of ASIN can be used instead of individual ASINs. Some examples of ASIN groupings are:\n","Top sellers  Gateway ASINs  Loyalty ASINs  Worst-selling ASINs  Seasonal ASINs  Strategic ASINs  Prime Day ASINs\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Data engineering"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Reference architecture\n"," See the image below for a reference architecture to help with the deployment. The architecture assumes that the Amazon Ads API authentication based on OAuth 2.0 is being used. The code samples provided in the following segments are designed for prototyping and to be referenced for a production deployment.\n"," For this approach, you will need to use your clientId, ClientSecret and refreshToken to generate an access token and pass values via headers.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Configurations"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" region = boto3.session.Session().region_name\n"," audienceNamingFormat = \"PlaybookAsinAudiences\\_\"\n"," AsinList = 'ASIN15', 'Asin4', 'Asin5'\n"," instance_id = 'amcaaaaaaaa'\n"," advertiserId = '11111111111'\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"URL for Rule Based Audience - US Check documentation depending on region"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" endpointRBA = 'amc/audiences/query'\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Rule Based Lookalike URL - US Check documentation depending on region"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" endpointLaL = 'amc/audiences/lookalike'\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Lookalike audience Flag - True = This will be a lookalike audience. False = Rule based audience"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" is_lookalike = False\n"," url = 'https&#x3A;//advertising-api.amazon.com/'\n"," EntityID = 'ENTITYAAAAAA' secrets_name = 'secrets_name_here'\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Pull API Gateway Credentials from secure storage - AWS Secrets manager in this scenario"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" api_gateway_credentials = pull_apigateway_secrets(secrets_name = secrets_name, region = region) api_gateway_credentials'EntityID' = EntityID\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Assumed Dictionary for api_gateway_credentials:"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" apigw_headers = generate_headers(api_gateway_credentials, url, instance_id)\n"," params = {\n"," params_to_save = params.copy()  # Create a copy of the params dictionary params_to_save.pop('apigw_headers')  # Remove sensitive data (API Gateway headers) with open(f'configurations/{audienceNamingFormat}\\_params.json', 'w') as f:\n"," body = {} body'url' = url  # URL for API requests body'region' = region  # AWS region body'instance_id' = instance_id  # ID of the instance body'advertiserId' = advertiserId  # ID of the advertiser body'audienceNamingFormat' = audienceNamingFormat  # Naming format for audiences body'timeWindowStart' = \"2023-10-01T00:00:00Z\"  # Start time of the time window body'timeWindowEnd' = \"2023-10-31T00:00:00Z\"  # End time of the time window body'refreshRateDays' = 7  # Refresh rate for the audience data (in days) body'timeWindowRelative' = \"True\"  # Indication of whether the time window is relative\n"," body'lookalikeAudienceExpectedReach' = 'BALANCED'  # Expected reach for the lookalike audience\n"," with open(f'configurations/{audienceNamingFormat}\\_configuration.json', 'w') as f:\n"," audience_list = \\[]  # Initialize an empty list to store created audiences\n"," for Asin in AsinList: print(f\"Number of audiences submitted for creation: {len(audience_list)}\")  # Print the number of audiences submitted for creation\n"," existing_audience_name_list = pd.DataFrame(amc_audience(method = 'GET', params = params)'executionMetadata')'audienceName'.to_list() duplicated_audience_failsafe(existing_audience_name_list = existing_audience_name_list, AsinList = AsinList, audienceNamingFormat = audienceNamingFormat)\n"," monitor_list = \\[] for audience in audience_list: df_monitor = pd.DataFrame(columns = 'advertiserId', 'audienceDescription', 'audienceExecutionId', 'audienceName', 'createTime', 'instanceId', 'query', 'refreshRateDays', 'status', 'statusReason', 'timeWindowEnd', 'timeWindowRelative', 'timeWindowStar', 'audienceCount', 'dspAudienceId', 'dspCanonicalId')  df_monitor = pd.concat(df_monitor, pd.DataFrame(monitor_list))\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"High level overview of instance creation status"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" fig = px.histogram(df_monitor, x = 'status', title = 'Number of audiences by Status') fig.update_layout(yaxis_title = 'Number of instances') fig.show()\n"," display(df_monitor\\['audienceName', 'createTime', 'status', 'statusReason', 'audienceCount', 'dspAudienceId'])\n","| audienceName                | createTime                  | status    | statusReason                                                        | audienceCount | dspAudienceId |\n","\\| ----------------------------- \\| ----------------------------- \\| ----------- \\| --------------------------------------------------------------------- \\| --------------- \\| --------------- \\|\n","| AMC MyAsinAudiences_Asin1  | 2023-07-06T16:32:00.328Z | FAILED    | The audience did not meet the minimum required size in Amazon DSP. | N/A           | N/A           |\n","| AMC MyAsinAudiences_Asin7  | 2023-07-06T16:32:00.827Z | SUCCEEDED | N/A                                                                 | 140000        | 222222        |\n","| AMC MyAsinAudiences_Asin52 | 2023-07-06T16:32:01.172Z | SUCCEEDED | N/A                                                                 | 30000         | 1111111       |\n","| AMC MyAsinAudiences_Asin56 | 2023-07-06T16:32:01.172Z | RUNNING   | N/A                                                                 | N/A           | N/A           |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Save the audiences to .csv for future reference"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Insights and visualization"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" After the audiences have completed, the next step will be to visualize the state of the audiences.\n"," If needed, investigate failure codes\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Drill into specifics:"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" df_monitor\\[df_monitor'status'=='FAILED']\n"," fig = px.histogram(df_monitor\\[df_monitor'status'=='SUCCEEDED'], x = 'audienceCount', nbins=10, title = 'Distribution of audience size') fig\n"," fig = px.bar(df_monitor\\[df_monitor'status'=='SUCCEEDED'].sort_values(by='audienceCount', ascending=False), x = 'audienceName', y='audienceCount', title = 'Top Audiences by audience size') fig\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Data persistence"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Data will be persisted between stages from pre-campaign through to post-campaign using a .csv stored in your Sagemaker instance. This will primarily be used to track audienceExecutionId for monitoring of refresh cadence to ensure all audiences successfully update with new user_ids.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Data overlap"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Before deploying your audiences, it’s recommended you measure the overlap they have with existing audience segments available in Amazon DSP. These can be found by measuring the overlap percentage of created audiences with existing audiences in the conversions_all table. This is recommended to avoid users being included twice as members of separate audience groups, which will extend reach. This can be done at the launch of the campaign, as well as set up as a mechanism during the mid-campaign audience refreshes to ensure that the refreshed audience groups don’t have a high overlap with another audience deployed in market.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Monitor audiences in DSP"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Once an audience creation status is returned as “successful” in the AMC API, it can take between 24 and 36 hours to be “active” and ready for use in Amazon DSP.\n"," To track when they are available the code below will pull the list of audiences from the Amazon DSP API.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"DSP specific parameter"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Note this value can be pulled from this endpoint: \"/v2/profiles\""},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"https://advertising.amazon.com/API/docs/en-us/reference/2/profiles"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" AdvertisingAPIScope = '0000000000000'\n"," apigw_headers'Amazon-Advertising-API-Scope' = AdvertisingAPIScope\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"The following call will list all DSP Audiences under the category of \"Custom-built\""},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" body = {\"adType\": \"DSP\", \n"," r = requests.post(f\"https&#x3A;//advertising-api.amazon.com/audiences/list?advertiserId={advertiserId}&maxResults=250\", headers = apigw_headers , data = json.dumps(body)) print(r)\n"," if r.ok:\n"," else:\n","| audienceId          | audienceName                     | description                                          | category      | subCategory | createDate                  | updateDate                  | status | forecasts                      | fees                                                   | providerId      |\n","\\| --------------------- \\| ---------------------------------- \\| ------------------------------------------------------ \\| --------------- \\| ------------- \\| ----------------------------- \\| ----------------------------- \\| -------- \\| -------------------------------- \\| -------------------------------------------------------- \\| ----------------- \\|\n","| 1111111111111111111 | AMC PlaybookAsinAudiences_ASIN1 | Rule based Audience generated via the audience... | Custom-built | AMC         | 2023-11-15T22:34:22.698Z | 2023-11-16T16:52:51.896Z | Active | {'inventoryForecasts': {}} | \\[{'amount': 150000, 'currency': 'USD', 'scale'... | 222222222222222 |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Action"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" The next step is to go to the DSP web console and create campaigns and line items on these custom rule-based audiences. The following sections of this playbook will cover how to monitor performance and data refresh of these campaigns during and post campaign. There are API endpoints for creating line items, you can automate creation of line items with your team, but that will not be done in this playbook.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"Mid campaign - monitor and adjust"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Audiences once created successfully will attempt to update on the schedule defined in the API call, which could be between 1 and 30 days. Every defined number of days, the list of users in the audience will update. The update could potentially cause a lower number of audiences being created as compared to the audiences that was created at the first instance, which could also mean that the number drops below the required user threshold when future scheduled updates are performed. For example: Users who added to cart but never checked out might have 5,000 users on audience creation date; but after 4 weeks only the number could be 1,000 users; which is below the threshold for a rule-based audience.\n"," Since the API does not directly report which audiences that created successfully but are now below the user threshold, we will use the instructions in this section to derive and monitor the audiences and accordingly adjust. Once an audience out-of-date for more than 30 days, it will get deactivated in the DSP.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Step 1: Pull in the audiences IDs and configs from the data store"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Import data from data store "},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" params = json.load(open(\"configurations/PlaybookAsinAudiences\\_.json\")) audienceNamingFormat = params'audienceNamingFormat'\n"," df = pd.read_csv(f\"configurations/{audienceNamingFormat}\\_records.csv\")\n"," configs = json.load(open(f\"configurations/{audienceNamingFormat}\\_configuration.json\"))\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Step 2: Monitor audiences to build query"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Sample output:\n"," Check to see if the number of days since the last refresh is greater than the refresh cadence. Note that there is a one-day buffer built into the sample code. This code will output all audiences that have not refreshed on cadence. While more investigation could be required to understand why a set of audience has not refreshed, it is most likely the audience size has dropped below 2,000 unique users.\n"," Sample output:\n","| audienceName                     | createTime               | instanceId  | query                                                | refreshRateDays | status    | audienceCount | dspAudienceId | lastRefreshedTime        | TimeSinceLastRefresh | TimeSinceLastRefreshInt | AudienceOutOfDate |\n","\\| ---------------------------------- \\| -------------------------- \\| ------------- \\| ------------------------------------------------------ \\| ----------------- \\| ----------- \\| --------------- \\| --------------- \\| -------------------------- \\| ---------------------- \\| ------------------------- \\| ------------------- \\|\n","| AMC PlaybookAsinAudiences_ASIN1 | 2023-07-07T16:55:05.183Z | amc11111111 | SELECT user_id from conversions_for_audiences ... | 5               | SUCCEEDED | 10000         | 2415475       | 2023-07-07T18:52:07.823Z | 8 days               | 8                       | TRUE              |\n"," Failed audience action\n"," If an audience has failed to refresh for several refresh states, it is recommended to decrease or stop spending on that as the line item as it will be continuing to target the same audience even after it has moved down the funnel. This would likely impact the rate of lower funnel conversions coming from that targeted audience.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Step 3: Query campaign performance from AMC"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Campaign and line item:\n"," After the custom AMC audience has been tagged to a campaign and has had sufficient time to run, the following steps will build a workflow to monitor and optimize the query. To see preliminary results, a minimum of one week is the recommended time for the campaign.\n"," Audience optimization query:\n"," Within WFM via AMC Insights on an AWS deployed notebook, create a new workflow using the query below. The query is designed to output measurement insights from the data into the data lake on a schedule for updated insights. The query used is an audience overlap percentage query that assesses the incremental reach and conversion percentage of different audience segments.\n"," The first step will be to build a query within AMC that will provide audience performance data. This audience can run directly in the AMC UI over a time period within 13 months and it will output a finding to confirm the query is valid.\n"," WFM create workflow:\n"," This step will set up a performance feed of data from AMC into an S3 bucket of your AWS account. This will involve creating a workflow based on a SQL query and executing the workflow over a specified time frame to output the data into a data lake.\n"," Define a workflow ID and add a single line query of the audience optimization workflow from AMC to output into the data lake.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"Note: If you would like to automatically update the workflow within this method, you can change the Boolean value below to True"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" amc_response = wfm.create_workflow(workflowDefinition, False, )\n"," print(f\"Request succeeded: {amc_response.success}\")\n"," for key in amc_response.response:\n"," Request succeeded: True responseReceivedTime: 2023-07-24T19:24:38\n"," responseStatus: CREATED\n"," execution_request =  {\n"," create_workfow_amc_response = wfm.create_workflow_execution(execution_request)\n"," workflow_execution_id = create_workfow_amc_response.response.get('workflowExecutionId','')\n"," print(f\"Request succeeded: {create_workfow_amc_response.success}\")\n"," for key in create_workfow_amc_response.response:\n"," Request succeeded: True responseReceivedTime: 2023-07-24T19:54:35\n"," responseStatus: PENDING\n"," amcVersionHash: 6141361052+c1938760-aeb7-4c6d-8788-173e72353ac5\n"," availableTimeBeforeWindowSecs: 2505600\n"," createTime: 2023-07-24T19:54:11Z\n"," dataGaps:\n"," create_schedule_request =  {\n"," create_schedule_amc_response = wfm.create_schedules(create_schedule_request) print(create_schedule_amc_response)\n"," print(f\"Request succeeded: {create_schedule_amc_response.success}\")\n"," for key in create_schedule_amc_response.response:\n"," Request succeeded: True responseReceivedTime: 2023-07-24T19:36:16\n"," responseStatus: 200\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Step 4: Pull the data from the data lake into a notebook"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Once the data is accessible in the AWS data lake, it is available for querying in your Sagemaker instance. The following steps will provide guidance to query data in your Sagemaker instance and to generate visuals out of the data to derive context on mid-campaign performance. The AMC query was designed to target a single audience per line item grouped by advertiser_id, campaign_name, campaign_id, and event date.\n"," Query AMC To get line item performance\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Generate Query using Audience names from data store"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"Query = WITH traffic AS ( SELECT advertiser, advertiser_id, campaign, campaign_id, behavior_segment_name, user_id, impression_dt_utc as event_dt_utc, impressions FROM TABLE( EXTEND_TIME_WINDOW('dsp_impressions_by_matched_segments', 'P14D', 'P0D') ) WHERE ( impressions = 1 ) ), matched_and_ranked AS ( SELECT t.advertiser, t.advertiser_id, t.campaign, t.campaign_id, c.user_id, t.behavior_segment_name, t.event_dt_utc, c.conversion_id, c.event_subtype, c.event_category, CASE WHEN c.event_subtype = 'detailPageView' THEN c.conversions ELSE 0 END AS DPV, CASE WHEN c.event_subtype = 'shoppingCart' THEN c.conversions ELSE 0 END AS ATC, CASE WHEN c.event_category = 'purchase' THEN c.conversions ELSE 0 END AS Purchases, ROW_NUMBER() OVER( PARTITION BY conversion_id, behavior_segment_name ORDER BY SECONDS_BETWEEN(t.event_dt_utc, c.event_dt_utc) asc ) AS match_rank, impressions FROM conversions c INNER JOIN traffic t ON c.user_id = t.user_id WHERE SECONDS_BETWEEN(t.event_dt_utc, c.event_dt_utc) BETWEEN 0 AND 14 * 24 * 60 * 60 AND ( event_subtype = 'detailPageView' OR event_subtype = 'shoppingCart' OR event_category = 'purchase' ) ), attributed_conversions AS ( SELECT advertiser, advertiser_id, campaign, campaign_id, behavior_segment_name, SUM(DPV) AS DPV, SUM( CASE WHEN DPV = 1 AND impressions = 1 THEN DPV ELSE 0 END ) AS DPV_views, SUM(ATC) AS ATC, SUM( CASE WHEN ATC = 1 AND impressions = 1 THEN ATC ELSE 0 END ) AS ATC_views, SUM(Purchases) AS Purchases, SUM( CASE WHEN Purchases = 1 AND impressions = 1 THEN Purchases ELSE 0 END ) AS Purchases_views FROM matched_and_ranked r WHERE match_rank = 1 GROUP BY 1, 2, 3, 4, 5 ), relevant_traffic AS ( SELECT advertiser, advertiser_id, campaign, campaign_id, behavior_segment_name, SUM(impressions) AS impressions FROM traffic WHERE event_dt_utc >= BUILT_IN_PARAMETER('TIME_WINDOW_START') AND event_dt_utc < BUILT_IN_PARAMETER('TIME_WINDOW_END') GROUP BY 1, 2, 3, 4, 5 ) SELECT t.advertiser AS advertiser_name, t.advertiser_id AS advertiser_id, t.campaign AS campaign_name, t.campaign_id AS campaign_id, t.behavior_segment_name AS segment, SUM(COALESCE(t.impressions, 0)) AS impressions, SUM(COALESCE(ac.DPV, 0)) AS Total_DPV, SUM(COALESCE(ac.DPV_views, 0)) AS Total_DPV_views, SUM(COALESCE(ac.ATC, 0)) AS Total_ATC, SUM(COALESCE(ac.ATC_views, 0)) AS Total_ATC_views, SUM(COALESCE(ac.Purchases, 0)) AS Total_Purchases, SUM(COALESCE(ac.Purchases_views, 0)) AS Total_Purchases_views FROM relevant_traffic t INNER JOIN attributed_conversions ac on ac.behavior_segment_name = t.behavior_segment_name GROUP BY 1, 2, 3, 4, 5 HAVING impressions > 1000 OR Total_DPV > 0 OR Total_ATC > 0 OR Total_Purchases > 0"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" df_analysis = pd.read_csv(\"audience_optimization_test.csv\") df_analysis\n","| advertiser_name | advertiser_id | campaign_name | campaign_id | event_dt_utc | segment                         | total_spend | impressions | total_dpv | total_atc | total_purchases | total_sales | export_month | file_last_modified |\n","\\| ------------------ \\| ---------------- \\| ---------------- \\| -------------- \\| ---------------- \\| --------------------------------- \\| -------------- \\| ------------- \\| ------------ \\| ------------ \\| ------------------ \\| -------------- \\| --------------- \\| ---------------------- \\|\n","| Brand1           | 12345          | campaign_1     | 1111111      | 7/26/2023      | AMC PlaybookAsinAudiences-ASIN1 | 2343         | 10828       | 224        | 94         | 67               | 23234        | 7             | 2023-07-24T21-27-02  |\n","| Brand1           | 12345          | campaign_2     | 1111111      | 7/25/2023      | AMC PlaybookAsinAudiences-ASIN1 | 4323         | 10798       | 224        | 94         | 67               | 34342        | 7             | 2023-07-24T21-27-02  |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Step 5: Create visualizations of ongoing audience performance through the campaign"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" ROAS performance by audience:\n"," \\*\\*ROAS by campaign name and audience segment\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Action"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Based on the results of the analysis and the monitored refresh rate, spend can be adjusted mid-campaign to move funding from low-performing, non-updating segments to higher-performing audiences.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"Post campaign"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Measure overall campaign performance and gather insights"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Following the campaign, dashboards will be deployed to measure overall performance volume and ROAS from the generated audiences to help understand which groups did the most work to drive the performance goals. This will be done through a similar process as mid-campaign where a workflow will be defined to manage data flow from AMC to the data lake. The metrics will be focused on a pure ROAS of the audiences and the total volume.\n"," You can utilize the same audience optimization query as before, since each row is broken out by the campaign level and is scheduled to update on a weekly cadence. Following the campaign, users will need to wait for the attribution window to complete post campaign before they can calculate ROAS.\n"," The view below provides a list of the top-performing audience by metric in terms of total sales and total spend and ROAS.\n"," Top performing audience by metric\n"," The action this can inspire is to use ROAS as the KPI to understand the efficiency of an audience in activating a campaign.\n"," Overall volume of performance of each campaign\n"," Next, we will look at the overall volume of performance of each campaign with a line item at the bottom with the average performance of all audiences.\n"," Here, we can see that the “AMC PlaybookAsinAudience-ASIN5” had the highest volume of sales while “AMC PlaybookAsinAudiences-ASIN2” did not drive as high of a volume of sales, despite having more purchases, Add to Carts and detail page views than any other audience.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":3,"text":"Action"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Based on the results of the above analysis, the ASIN 4 and 5 audiences could be prioritized, with an additional rate of spend; while ASIN 1 audience showing the lowest rate of ROAS could be deprioritized . Additionally, ASIN 2 showing a higher rate of detail page views and add to cart, an action step for them would be to explore more lower funnel messaging or target them with another ASIN to see if they maintain the same level of engagement while driving downstream purchases.\n"," This playbook can be replicated to maintain a constant stream of measuring audience performance that can create a feedback loop of audience optimizations for ongoing campaigns.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Programmatic Audience Framework Playbooks","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/programmatic_audience_framework","content":[" Some options for next steps after the completion of post campaign are:\n","To continue to run campaigns on high-performing custom AMC audiences.  To experiment again for a different use case.Some example of use cases could be:  Run experiment with different ASINs\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" Off-Amazon event conversions from first-party data (1P data) upload, Conversion API (CAPI), Amazon Ad Tags (AAT), or third-party data sets, such as Experian or Foursquare provide for precise measurement for off-Amazon conversions. \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":2,"text":"What are off-Amazon conversions?"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" Off-Amazon conversions in the context of this playbook include: sales, website visits, booking an appointment, visiting a physical store location, signing up for a mailing list, and many others. When this data is available in AMC, it allows for tracking the performance of campaigns across many KPIs and unlocks several use cases, such as Multi-Touch Attribution (MTA) and customer long term value (CLTV). Dimensional data is also supported, opening up use cases such as ASIN groupings, margin, etc., or user-level segmentation using off-Amazon segmentation.\n"," This playbook provides several AMC Instructional Queries (IQs) originally designed for on-Amazon conversions, but modified for off-Amazon conversions. There are caveats to using off-Amazon data; the code samples used in here have been adjusted for successful implementation. Both event-level and non-event data are supported.\n"," This playbook is mainly focused around off-Amazon conversions, but in the SQL logic, data from both the off-Amazon conversion table and on-Amazon conversions could be UNION-ed together to create one larger success table.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":2,"text":"Use cases covered in this playbook"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" This playbook contains four \"swim lanes\" each with one or more use cases that answer specific questions and have direct actions. Each use case should be treated as a starting point; the SQL code requires customization to fit the particular off-Amazon data available and the specific problems trying to be solved. \n"," There are use cases for both fact and dimensional data; sample schema for uploaded data is provided in Schema assumptions. The fact data schema is assumed to have user information, timestamp, and conversion type. While the dimension data will have categorical data about ASINs or users. \n","| Swim lane                                   | Answers questions like:                                                   |\n","\\|---------------------------------------------\\|---------------------------------------------------------------------------\\|\n","| #1: Amazon DSP Customer Segment Finder      | What are the demographics and shopping habits of my off-Amazon customers? |\n","|                                             | What are Amazon DSP audience that I should use?                           |\n","| #2: Measure and optimize existing campaigns | How can I use off-Amazon data with existing campaigns?                    |\n","|                                             | How are my campaigns performing?                                          |\n","|                                             | How can I optimize my campaign?                                           |\n","| #3: Create audiences                      | How can I activate using my off-Amazon data?                              |\n","| #4: Analyze segments                            | What can be done with categorical data?                                   |\n","|                                             | Which product categories are performing well?                             |\n","|                                             | Which of my off-Amazon user segments are performing the best?             |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Example visual"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" Using off-Amazon data, you can calculate the conversion rate by campaign and device type. An example visual that can come from this playbook is:\n"," In the visual above, it is clear that the campaign “Jack & Jill test campaign” has a strong device type component. A possible action would be to modify the Amazon DSP campaign to focus on Phone vs PC. See the Use case: Device analysis for more details. \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Technical"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":["AMC concepts, specifically data aggregation thresholds, privacy limitations, and other restrictions listed in the AMC documentation. - Knowledge of AMC SQL (link only available for AMC UI users). The processes outlined here relies on altering SQL code to match your purposes. - AMC Data Upload Knowledge Understand data upload to AMC, user resolution, and how to query uploaded data. - Basic knowledge of Amazon DSP to activate upon audience segmentation in the advertising market based on performance. You will need to know how to query audiences to activate in Amazon DSP.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Data"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":["Off-Amazon Data Conversions not tracked by Amazon, multiple off-Amazon data sets can be UNION-ed together, or combined with on-Amazon conversions to create a holistic dataset.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Marketing"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":["Attribution Time Window Knowledge of the appropriate lookback window for customer journeys as it relates to your specific use case. The default is 14 days in AMC.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Related Playbooks"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":["Programmatic audience framework - Provides an API framework for creating, monitoring, and measuring audience performance.  - Customer long-term value - Allows you to assesses customer value over the course of the brand relationship. Also, you can refer to Use case: Customer long-term value in this playbook.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":2,"text":"Assumptions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" We assume that you have an understanding of the process to create multiple audiences by submitting multiple API calls and track the audience creation manually, which is described in the Rule based audience creation.\n"," Costs associated with implementing this playbook\n","Submitting an audience to be created is not charged. There is no cost until the audience is activated in Amazon DSP.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":2,"text":"Playbook steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":["Upload data 2. Learn how to use 1P data in queries 3. Pre-swim lanes: First-party data overview 4. Use cases and actions:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":2,"text":"1. Upload data"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" To upload off-Amazon data to AMC, you must first upload a file containing the data to an AWS S3 bucket and then, using AMC Advertiser data upload APIs or an Amazon Marketing Cloud Uploader from AWS, upload the data in the file to an AMC instance. The following section will run through the process and options. \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Fact vs dimension"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" There are two types of data that can be loaded into AMC: fact and dimension. \n","Fact: In AMC, fact data is defined as any dataset that has an event timestamp. Fact data is generally transactional data; examples include sales, store visits, website visits, etc., with an exact timestamp for the event.  - Dimension: In AMC dimensional data is any dataset without a timestamp. Some examples of dimensional data are: ASIN metadata, user segmentation etc. Any dataset where time is not an element. \n"," Most use cases are built around fact data, where the timestamp can be used to determine where in the touchpoint chain an event occurred, which will be used for attribution.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Data preparation"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" To resolve a user to an Amazon user_id, user identifiers must be standardized, hashed, and uploaded. There are two tools to help with the data preparation process:\n","File preparation tool  - Amazon Marketing Cloud Uploader from AWS \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Supported user identifiers"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" ID resolution is the process of matching the identifiers in the uploaded file to a corresponding Amazon user record. This allows you to join your uploaded data with Amazon data at the user level. Refer to the Data preparation page for a list of supported identifiers. \n"," LiveRamp requirements\n","| Provider | Identifier type   | Encoding               | Example                                      |\n","\\|----------\\|-------------------\\|------------------------\\|----------------------------------------------\\|\n","| LiveRamp | LiveRamp (RampID) | Must be Amazon-encoded | XY1975TDDOTfZgJdgiYmO2F1XzdrmpoyIEb7ezpCqsui |\n"," When a dataset is defined with a LiveRamp column, AMC will attempt to resolve those IDs to an Amazon ID. The Amazon ID will be used to join with existing datasets. 1. At this time, AMC does not have direct integration with LiveRamp. Customers must work directly with LiveRamp to generate offline files. 2. AMC can only resolve Amazon-encoded RampIDs. Please work with your LiveRamp representative to ensure your data is properly encoded before uploading to AMC. 3. LiveRamp is uploaded using the AMC data upload APIs.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Data upload steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" There are two ways to upload data to AMC: AMC Advertiser data upload (ADU) APIs or the Amazon Marketing Cloud Uploader from AWS. The uploader is built on AMC ADU APIs but provides automation and UI elements. The table below offers a comparison between the options: \n","|   Step #      |      Step Description                                |   API - Work Type              |   API - Coding Required?                     |       AMC Uploader from AWS - Work Type                            |  AMC Uploader from AWS - Coding Required?                                        |\n","\\|--------\\|--------------------------------------\\|-----------------\\|------------------------\\|-----------------------------------\\|------------------------------------------\\|\n","| 1      | Create S3 Bucket                     | Manual process  | No                     | Manual process                    | No                                       |\n","| 2      | Apply proper S3 Bucket Policy        | Manual process  | No                     | Manual process                    | No                                       |\n","| 3      | Upload data to S3                    | Manual process  | No                     | Manual process                    | No                                       |\n","| 4      | Prepare data                         | -               | -                      | -                                 | -                                        |\n","| 4.1    | Hash Data                            | Manual process  | Yes                    | Automated                         | No                                       |\n","| 4.2    | Standardize                          | Manual process  | Yes                    | Automated                         | No                                       |\n","| 5      | Create \"data set\" (schema of data)   | Manual process  | Yes                    | User interface                    | No                                       |\n","| 6      | Trigger Upload                       | Manual process  | Yes                    | User interface                    | No                                       |\n","| 7      | Select update strategy               | Manual process  | Yes                    | User interface                    | No                                       |\n","| 8      | Monitor upload                       | Manual process  | Yes                    | User interface                    | No                                       |\n","| 9      | Event-driven architecture (Optional) | Manual process  | Yes                    | Automated                         | No                                       |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Expected match rate"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" There is no expected match rate when uploading user data. Match rates can be as low as 10%, or upwards of 90%, it depends on whether Amazon can resolve the information to a user. There is not much that can be done to troubleshoot, or diagnose match rates that are unexpected. Proper preparation of data can help. Refer to Prepare data for the complete steps. If the AMC Uploader from AWS was used, these steps have been handled automatically.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Updating data"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" A common approach for keeping the data in AMC fresh is to use an “event-driven architecture”. With this approach, when a new file is placed in a specific location or follows a specific naming convention, a pipeline is automatically initiated. In this scenario, when you place a new file in the S3 bucket, it will be automatically uploaded to the correct AMC table. The Amazon Marketing Cloud Uploader from AWS supports this method, otherwise it will need to be built out to meet the specific use case required. \n"," If event-driven is not used, data can be updated using ad-hoc uploads or any other framework. \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Update strategies"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" The updateStrategy parameter allows you to specify how the new data will be merged with existing data in the dataset. The best approach will depend on the data uploaded, how it is generated, intended functionality and many other factors. The best update strategy will depend fully on the situation.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":2,"text":"2. Learn how to use 1P data in queries"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" Once 1P data is loaded into AMC, it can be treated just like any other AMC table. You can use JOINs, aggregations, SELECT statements, GROUP BY statements, etc. on any fields to build a data model. The same aggregation and output restrictions apply. The table is available in the UI under the Advertiser uploaded section of the Schema explorer in the AMC UI.\n"," See a simplified data model of the Geography use case as an example of how data from AMC can be combined with 1P data to create an analysis:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Schema assumptions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" The challenge with 1P data is that every situation will be different. Each situation will have different dimensions, metrics, aggregation levels and use cases. The following section provides important call-outs for 1P data that should be known up front, as well as a baseline of what 1P data is expected. All use cases and queries are built assuming the schema below; this will likely not exactly match the 1P data you are using. Queries should be updated and modified to match each specific situation. \n","All 1P data is treated with sensitivity of “high”, which means the aggregation threshold is 100 distinct users. Going down to too granular of level can cause redaction. - Depending on the use case, AMC dimensions, and number of resolved users, some dimensions will be potentially problematic with redaction. Some examples are:\n","Not all off-Amazon users will resolve to an Amazon user_id. Use Pre-swim lane: First-party data overview to gain insight into identity resolution rates.  - Experian and Foursquare are currently not able to be used in custom audiences (rule-based audiences and lookalike audiences).  - This playbook will not cover Amazon DSP integrations. Automated integration could be built using Amazon DSP APIs or by using the Amazon DSP UI to modify campaigns.  - Events Manager data - AAT and CAPI are both attributed in the amazonattributed_events_by\\* tables. If there is no 1P data uploaded to AMC, some of these use cases can be adjusted to use Amazon attribution tables to simplify the SQL code. \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"First-party data schema"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" Uploaded in a format similar to:\n","| hashed_email | hashed_first_name | hashed_last_name | other_hashed_user_information | conversion_name | ConversionTimeStamp | Sale price - Optional |\n","\\|--------------\\|-------------------\\|------------------\\|-------------------------------\\|-----------------\\|---------------------\\|-----------------------\\|\n","| ----------   | ----------        | ----------       | ----------                    | Store Visit     | YYYY-MM-DD HH:MM:SS |                       |\n","| ----------   | ----------        | ----------       | ----------                    | Purchase        | YYYY-MM-DD HH:MM:SS | 25.99                 |\n","| ----------   | ----------        | ----------       | ----------                    | Website Visit   | YYYY-MM-DD HH:MM:SS |\n"," Uploaded in a format similar to:\n","| campaign_id   | Campaign Category | Campaign Owner | Vertical | PromotedAsin   | ... |\n","\\|---------------\\|-------------------\\|----------------\\|----------\\|----------------\\|-----\\|\n","| 1316262122567 | Evergreen         | 123@123.com    | Kitchen  | ASIN1          | ... |\n","| 4077043708656 | Evergreen         | 123@123.com    | Kitchen  | ASIN2          | ... |\n","| 7826615377607 | Prime Day         | 123@123.com    | Sports   | ASIN3,ASIN4  | ... |\n","| 4832407182165 | Prime Day         | 123@123.com    | Sports   | ASIN1, ASIN2 | ... |\n"," Can be queried from AMC in a format:\n","| conversion_dt_utc        | conversion_event_source_name | conversion_event_name | event_type_description | user_id | off_amazon_conversion_value | off_amazon_product_sales |\n","\\|--------------------------\\|------------------------------\\|-----------------------\\|------------------------\\|---------\\|-----------------------------\\|--------------------------\\|\n","| 2024-02-21T23:59:59.959Z | Conversions API              | AddToCart             | Add to Shopping Cart   | xxxx    | 10.99                       |                          |\n","| 2024-02-21T23:59:59.959Z | Amazon Ad Tag                | Off-AmazonPurchases   | Product Purchased      | xxxx    |                             | 10.99                    |\n","| 2024-02-21T23:59:59.959Z | Amazon Ad Tag                | Off-AmazonPurchases   | Product Purchased      | xxxx    |                             | 15                       |\n","| 2024-02-21T23:59:59.959Z | Conversions API              | AddToCart             | Add to Shopping Cart   | xxxx    | 15                          |\n"," Can be queried from AMC once signed up. \n"," Experian\n","| purchase_date | user_id | conversion_name |\n","\\|---------------\\|---------\\|-----------------\\|\n","| 1/25/2024     | xxxxx   | New             |\n","| 1/25/2024     | xxxxx   | Used            |\n"," Foursquare\n","| visit_time | user_id | conversion_name |\n","\\|------------\\|---------\\|-----------------\\|\n","| 1/25/2024  | xxxxx   | chain_id123     |\n","| 1/25/2024  | xxxxx   | chain_id456     |\n","| Source        | conversion_dt_utc | off_amazon_product_sales | conversion_name | user_id |\n","\\|---------------\\|-------------------\\|--------------------------\\|-----------------\\|---------\\|\n","| Events Manager | 1/25/2024         | 0                        | Website Visit   | xxxxx   |\n","| Events Manager | 1/25/2024         | 25.99                    | Purchase        | xxxxx   |\n","| Events Manager | 1/15/2024         | 0                        | add to cart     | xxxxx   |\n","| Data Upload   | 1/15/2024         | 0                        | Store Visit     | xxxxx   |\n","| Data Upload   | 1/15/2024         | 13                       | Purchase        | xxxxx   |\n","| Data Upload   | 1/15/2024         | 0                        | Website Visit   | xxxxx   |\n","| Foursquare    | 1/25/2024         | 0                        | Walmart         | xxxxx   |\n","| Foursquare    | 1/25/2024         | 0                        | Walmart         | xxxxx   |\n","| Experian      | 1/25/2024         | 0                        | New             | xxxxx   |\n","| Experian      | 1/25/2024         | 0                        | Used            | xxxxx   |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":2,"text":"3. Pre-swim lanes: First-party data overview"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" Overview:\n"," Provide insight into the off-Amazon data by conversion name and user resolution to Amazon user_ids. This information is valuable as a minimum threshold is required to make rule-based audiences and lookalike audiences. Along with audiences, data that is sparse will face redaction issues with other use cases. First-party data overview is pre-swim lanes as it is relevant to all future use cases. \n"," Questions Answered:\n","What does my off-Amazon data look like? - How many users resolved for each conversion type? - Do I have enough users for custom audiences? \n"," Actions:\n","Create lookalike or rule-based audiences using one or many conversion types - Select use cases and dimensions that are likely to succeed given the resolved user density \n"," Integrations:\n","Lookalike and rule-based audiences (RBA) API integration\n"," Example:\n","| Source      | conversion_name | Total Records | Resolved IDs | Unique Resolved IDs | % Resolved | SufficientForRBA | SufficientForLAL_min | SufficientForLAL_max |\n","\\|-------------\\|-----------------\\|---------------\\|--------------\\|---------------------\\|------------\\|-----------------\\|---------------------\\|---------------------\\|\n","| Data Upload | Store Visit     | 10,000        | 2,000        | 1,900               | 20.00%     | N               | Y                   | Y                   |\n","| Data Upload | Purchase        | 20,000        | 9,000        | 8,000               | 45.00%     | Y               | Y                   | Y                   |\n","| Data Upload | Website Visit   | 50,000        | 25,000       | 19,000              | 50.00%     | Y               | Y                   | Y                   |\n"," SQL\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":2,"text":"4. Use cases and actions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Swim Lane #1: Find Amazon DSP customer segment"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" Overview:\n"," Provides insight into off-Amazon data around user demographics and behaviors, allowing for insight into existing customer base. This use case also provides insight into which Amazon DSP audiences are most likely to be high-value or expand reach. \n"," There are two options for pulling data: \n","Using Persona builder API - AMC Overlap using paid data set Audience Segments Insights (ASI)\n"," Questions Answered:\n","Who are my customers? - What do my customer purchase? - How do I identify high potential audiences?\n"," Suggested user counts:\n","Greater than 2,000 unique users to create a rule-based audience\n"," Actions:\n","Identify which existing Amazon DSP audiences are high potential.  - Activate in Amazon DSP using newly identified audiences, then measure and repeat.  - For advertisers new to AMC:\n"," Integrations:\n","Persona builder API - Optional\n"," Overview\n"," Reference documentation\n","Persona builder API documentation\n"," First-party data overview \n"," 1P data terms to know:\n","Affinity: Affinity is a measure of how likely customers in the persona are to belong to this audience. An affinity of 5 indicates that customers in the persona are 5 times as likely to belong to this audience than the average of customers on Amazon. - Percentage: Percentage of customers in the persona who belong to this audience. For example, a value of 5 means 5% of customers in the persona belong to the specified audience.\n"," The following tables provide example Persona builder API results.\n"," Top Overlapping Audiences - example results\n","| category     | id      | name                        | Affinity | Overlap Percentage |\n","\\|--------------\\|---------\\|-----------------------------\\|---------\\|--------------------\\|\n","| Custom-built | 111111  | AMC RBA123345               | 4170.61 | 80                 |\n","| Custom-built | 222222  | AMC LAL - ABCDE             | 81.62   | 18                 |\n","| Lifestyle    | 333333  | LS - Toothbrush             | 6.18    | 31                 |\n","| In-market    | 4444444 | IM - Ginger Ale Soft Drinks | 6.15    | 17                 |\n"," Demographics - example results\n","| percentage | affinity | attribute | key               |\n","\\|------------\\|----------\\|-----------\\|-------------------\\|\n","| 20         | 3        | 18-24     | age               |\n","| 7          | 0        | 25-34     | age               |\n","| 13         | 3        | 45-54     | age               |\n","| 41         | 1        | 55-64     | age               |\n","| 21         | 1        | 35-44     | age               |\n","| 41         | 1        | Owning    | propertyOwnership |\n","| 36         | 0        | Renting   | propertyOwnership |\n","| 12         | 0        | Male      | gender            |\n","| 45         | 3        | Female    | gender            |\n","| 29         | 1        | Couple    | relationship      |\n","| 3          | 3        | Single    | relationship      |\n","| 18         | 2        | 100,000−149,999    | Income   |\n"," Retail Categories (Top Categories Purchased) - - example results\n","| percentage | affinity | id     | path                                              | name                |\n","\\|------------\\|----------\\|--------\\|---------------------------------------------------\\|---------------------\\|\n","| 42         | 7.99     | 11111  | \\[Health & Household, Products, Oral Care, Toot... | Manual Toothbrushes |\n","| 12         | 4.44     | 222222 | \\[Beauty & Personal Care, Products, Tools & Acc... | Cotton Swabs        |\n","| 10         | 4.22     | 333333 | \\[Beauty & Personal Care, Products, Shave & Hai... | Disposable Razors   |\n","| 11         | 3.7      | 44444  | \\[Health & Household, Products, Household Suppl... | Dryer Sheets        |\n"," Prime Video Insights Results from this endpoint are split into categories: actors, directors, genres, movies, series.\n"," Example values: Actors\n","| Actor              | Affinity | OverlapPercentage |\n","\\|--------------------\\|----------\\|-------------------\\|\n","| Christopher Briney | 1.61     | 13                |\n","| Terry Crews        | 1.59     | 18                |\n","| Christine Baranski | 1.59     | 16                |\n","| Lola Tung          | 1.59     | 15                |\n","| Jackie Chung       | 1.58     | 15                |\n","| Adam Devine        | 1.58     | 14                |\n"," Genres\n","| Genre                           | Affinity | OverlapPercentage |\n","\\|---------------------------------\\|----------\\|-------------------\\|\n","| Sci-Fi/Fantasy > Sci-fi - Alien | 29.94    | 0                 |\n","| Faith and Spirituality - Islam  | 29.79    | 0                 |\n","| Horror > Thriller               | 28.17    | 0                 |\n","| Sport > Water Sports            | 15.41    | 0                 |\n"," Overview\n"," To use the overlap report using Audience Segment Insights (ASI), an active FSI subscription is required. The ASI based analysis will provide overlap between 1P data table and Amazon DSP segments. \n"," Reference IQs - Introduction to Audience Segment Insights (link only available for AMC UI users) - Audience Overlap Analysis (link only available for AMC UI users)\n","| conversion_name | segment_name                          | totalAdExposedUsersPerSegment | distinctusers | totalconversions | totalimpressions | totalclicks | totalcost | costperclick | conversionrate | costperconversion |\n","\\|-----------------\\|---------------------------------------\\|-------------------------------\\|---------------\\|------------------\\|------------------\\|-------------\\|-----------\\|--------------\\|----------------\\|-------------------\\|\n","| Purchase        | IM - Toothpaste                       | 1,000,000                     | 100,000       | 30,000           | 1,500,000        | 12,000      | $45,000   | $3.75        | 10%            | $1.50             |\n","| Store Visit     | IM - Manual Toothbrushes              | 400,000                       | 40,000        | 100,000          | 450,000          | 15,000      | $10,000   | $0.67        | 10%            | $0.10             |\n","| Purchase        | IM - Children's Dental Care Products  | 300,000                       | 30,000        | 85,000           | 310,000          | 11,000      | $1,000    | $0.09        | 10%            | $0.01             |\n","| Store Visit     | IM - Children's Electric Toothbrushes | 10,000                        | 800           | 25,000           | 100,000          | 1,000       | $3,500    | $3.50        | 8%             | $0.14             |\n"," SQL\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Swim Lane #2: Measure and optimize existing campaigns"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" Overview:\n"," Measure advertising performance using off-Amazon data to calculate KPIs. Off-Amazon conversions unlocks new KPI’s, depending on what data is available, like: conversion rate, ROAS, revenue, and more. \n"," Reference IQs\n","Measure Ad-Attributed Vehicle Purchases from Experian Auto (link only available for AMC UI users) - Measure ad-attributed off-Amazon conversions from first-party data (link only available for AMC UI users)\n"," Questions Answered:\n","How are my campaigns performing?  - Which audiences are performing well? - Which campaigns/line items/audiences are under-performing? \n"," Suggested user counts:\n","Low if aggregating to campaign  - Medium if aggregating to line-item\n"," Actions:\n","Budget allocation - Campaign optimization - Audience optimization\n"," Example:\n"," Notes: \n","You must embed “Conversion Name” into the SQL code as a “conversion” condition in the CTE “fpd_conversions” (AND \\[conversion_name] IN ('Purchase', 'Store Visit')). If you add “Conversion Name” into the SELECT statement, this will introduce duplication.  - The query is first/last touch with \"Clicks\" always getting attribution before impressions. If there are multiple clicks then it will select the first/last based on attribution of choice. This can be modified in the SQL code to be true first/last touch if needed.\n","| attribution_model | campaign                         | impressions | clicks | total_spend | unique_reach | unique_purchasing_users | number_of_conversions | conversion_click_event | conversion_impression_event | conversions_rate | spend_per_conversion |\n","\\|-------------------\\|----------------------------------\\|-------------\\|--------\\|-------------\\|--------------\\|-------------------------\\|-----------------------\\|------------------------\\|-----------------------------\\|------------------\\|----------------------\\|\n","| Last Touch        | Iris_test_campaign_804549        | 2049        | 587    | $5,980      | 1960         | 130                     | 796                   | 714                    | 82                          | 6.63%            | $7.51                |\n","| Last Touch        | Iris_test_campaign_919915        | 2163        | 653    | $6,920      | 2240         | 186                     | 2081                  | 1822                   | 259                         | 8.30%            | $3.33                |\n","| Last Touch        | Organique_test_campaign_292498   | 924         | 299    | $2,090      | 1650         | 146                     | 1394                  | 1202                   | 192                         | 8.85%            | $1.50                |\n","| Last Touch        | Jack & Jill_test_campaign_740213 | 1826        | 548    | $5,770      | 1890         | 132                     | 829                   | 758                    | 71                          | 6.98%            | $6.96                |\n"," If revenue is uploaded:\n","| attribution_model | Revenue | ROAS |\n","\\|-------------------\\|---------\\|------\\|\n","| Last Touch        | $7,000  | $1   |\n","| Last Touch        | $80     | $0   |\n","| Last Touch        | $90,000 | $16  |\n","| Last Touch        | $1,500  | $2   |\n"," SQL\n"," Overview:\n"," For advertisers who might not know where users are coming from and would like to narrow down the scope of DSP marketing to specific market. For example, if a national brand has a newsletter sign-up, that advertiser might not know any information about where the users geographically. Combined with the First-party data overview can provide additional information on demographics and purchase behavior. \n"," Questions Answered:\n","Where are my off-Amazon users?  - Which geographical areas are most active and have the highest potential?  - Which geographical areas are underserved? \n"," Actions:\n","Localized marketing in Amazon DSP for both high potential or underserved areas. Location can be set at the line-item level at the city, state, country, DMA, or postal code level. \n"," Suggested user counts:\n","Medium if aggregating to DMA - Very high for postal_code  - Low for State\n"," The query below selects the one location per user_id that is most common for that user.\n"," Example:\n","| conversion_name | dma_code  | postal_code | totalconversions | distinctusers |\n","\\|-----------------\\|-----------\\|-------------\\|------------------\\|---------------\\|\n","| Purchase        | US-DMA627 | US-73501    | 109              | 109           |\n","| Purchase        | US-DMA602 | US-60106    | 250              | 223           |\n","| Newsletter      | US-DMA813 | US-97527    | 213              | 211           |\n","|                 |           |             | 50               | 50            |\n"," SQL\n"," Overview:\n"," Identify the frequency of impressions before conversion using off-Amazon conversions as the metric. The output can be used to set frequency caps at either the line-item or campaign level. The result is to increase efficiency by increasing reach or increasing frequency with the same budget.\n"," Reference IQ\n","DSP Impression Frequency and Conversions (link only available for AMC UI users) Questions Answered:\n","How many impressions are my customer getting? - What is a reasonable frequency cap? \n"," Suggested user counts:\n","High - when splitting out by frequency bucket user numbers can reduce quickly\n"," Actions:\n","Modify frequency cap to increase performance. Frequency caps can be set at the line-item or campaign. \n"," Example:\n","| advertiser_n | frequency_buckets | unique_user_count | conversion_count | conversion_rate |\n","\\|--------------\\|-------------------\\|-------------------\\|------------------\\|-----------------\\|\n","| Campaign_A   | 1                 | 4744              | 296              | 6.24%           |\n","| Campaign_A   | 2                 | 3043              | 360              | 11.83%          |\n","| Campaign_A   | 3                 | 2289              | 429              | 18.74%          |\n","| Campaign_A   | 4                 | 1874              | 325              | 17.34%          |\n","| Campaign_A   | 5                 | 1576              | 408              | 25.89%          |\n","| Campaign_A   | 6                 | 1341              | 431              | 32.14%          |\n","| Campaign_A   | 7                 | 1144              | 394              | 34.44%          |\n","| Campaign_A   | 8                 | 1018              | 306              | 30.06%          |\n","| Campaign_A   | 9                 | 902               | 219              | 24.28%          |\n","| Campaign_A   | 10                | 795               | 315              | 39.62%          |\n"," SQL\n"," Here, you can gather that the maximum frequency cap for this campaign would be at around 11 where the overall line passes zero. \n"," Overview:\n"," Measure which devices are most effective with each campaign. Different campaigns with different goals might have more success on certain devices. For example, new-to-brand campaigns might be more successful on PC vs mobile. \n"," Reference IQ\n","Measure Ad-Attributed Vehicle Purchases from Experian Auto (link only available for AMC UI users)\n"," Questions Answered:\n","Which devices are most effective with different campaign goals?\n"," Suggested user counts:\n","Low if aggregating to campaign  - Medium if aggregating to line-item\n"," Actions:\n","Modify device types in the Amazon DSP for line items. Device can be set to be: “Desktop and mobile”, “Desktop”, “Mobile”, “Connected TV” depending on the line item type. \n"," Notes: \n","This SQL code is very similar to Campaign measurement, with device propagated through to the end SELECT. This will increase redaction as there will be more records without sufficient distinct users. - Embed “Conversion Name” into the SQL code as a “conversion” condition. See SQL code below in CTE “fpd_conversions” for reference. Adding “Conversion Name” into the select statement will introduce duplication.  - The query is first/last touch with \"Clicks\" always getting attribution before impressions. If there are multiple clicks then it will select the first/last based on attribution of choice. This can be modified in the SQL code to be true first/last touch if needed.\n"," Example:\n","| attribution_model | campaign_id | campaign                                | device_type | impressions | clicks | total_spend | unique_reach | unique_purchasing_users | number_of_conversions | conversion_click_event | conversion_impression_event | conversions_rate | spend_per_conversion |\n","\\|-------------------\\|-------------\\|-----------------------------------------\\|-------------\\|-------------\\|--------\\|-------------\\|--------------\\|-------------------------\\|-----------------------\\|------------------------\\|-----------------------------\\|------------------\\|----------------------\\|\n","| Last Touch        | 11111       | Jack & Jill_test_campaign_4832407182165 | PC          | 19664       | 4570   | 214.68464   | 3555         | 540                     | 1776                  | 1727                   | 49                          | 0.1519           | 0.12088              |\n","| Last Touch        | 1111        | Jack & Jill_test_campaign_4832407182165 | TV          | 19712       | 4708   | 213.66262   | 3559         | 540                     | 1776                  | 1727                   | 49                          | 0.15173          | 0.12031              |\n"," A sample output visual from this analysis is:\n"," In the visual above, it is clear that the campaign “Jack & Jill test campaign” has a strong device type component. A possible action would be to modify the DSP campaign to focus on Phone and not include PC. \n"," SQL\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Swim Lane #3: Create audiences"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" Overview:\n"," Assess customer value over the course of a brand relationship. Allow for segmenting of users into high value, high potential and low value. CLTV allows for more targeted advertising strategies that focus on customer retention and loyalty, which can lead to a more profitable business model over time. The custom audiences that can be created from this use case allow for higher performing campaigns through marketing to valuable audiences and excluding low value audiences.\n"," Reference Playbook\n","Customer long-term value\n"," Questions Answered:\n","Who are my loyal and high value customers? How can I market to those users? - Who are my under-served and do they have potential? How can I market to those users?  - How can I exclude low long-term value customers?\n"," Actions:\n","Create rule-based audiences of high-value and high potential users - Create rule-based audiences of low value users to exclude - Lookalike audiences based on high value customers - Activate or exclude custom audiences in Amazon DSP\n"," Notes:\n","If off-Amazon conversions do not contain spend values. Each off-Amazon conversions type could be hardcoded with a value in order to make the analysis proxy long-term value. For example, store visits could be assigned a value of $10 if it is determined that a store visit equates to $10 in value for the brand. The result would be the output metrics should be disregarded are they are proxies, but the resulting segmentation of users into categories can still be used. - The audiences created can be used with the Persona API in Swim Lane #1 to get insights into high value or low value user segments. \n"," Example:\n","| customer_audience_segment         | num_users | total_sales | total_spend | cltv   |\n","\\|-----------------------------------\\|-----------\\|-------------\\|-------------\\|--------\\|\n","| Higher Revenue Potential Customer | 14,514    | $18.57      | $5.41       | $13.16 |\n","| High Growth Potential Customer    | 14,180    | $9.53       | $5.64       | $3.89  |\n","| Low Value Customer                | 607,585   | $9.30       | $4.11       | $5.18  |\n","| High Value Customer               | 3,133,429 | $14.21      | $2.76       | $11.45 |\n"," Overview:\n"," All Events Manager events that can resolve to Amazon user_ids are available in AMC. Both ad-exposed and non-ad-exposed users are available, which opens the door for specific analysis on non-ad-exposed users. Users who had a non-ad-exposed conversion event are likely candidates for marketing, as they are interested in the brand without Amazon DSP advertising.\n"," Reference IQ\n","Introduction to Events Manager IQ (link only available for AMC UI users)\n"," Questions Answered:\n","How many Events Manager events are ad driven? - What can I do with my non-ad-exposed users?  - Are non-ad-exposed users with off-Amazon conversions high potential?\n"," Actions:\n","Create a rule-based audience on users who off-Amazon added to cart but did not off-Amazon convert. - Create a rule-based audience of users who had a conversion event but are not ad-exposed. A potentially under served user group. - Create a rule-based audience of users who non-ad-exposed bought A to be re-marketed B\n"," Example:\n","| conversion_event_source_name | conversion_name     | event_type_description                                                | ad_exposure    | off_amazon_conversion_value | off_amazon_product_sales | number_of_events | distinct_users |\n","\\|------------------------------\\|---------------------\\|-----------------------------------------------------------------------\\|----------------\\|-----------------------------\\|--------------------------\\|------------------\\|----------------\\|\n","| Amazon Ad Tag                | AddToCart           | Add to Shopping Cart                                                  | ad-exposed     | 10,000                      |                          | 400              | 150            |\n","| Amazon Ad Tag                | AddToCart           | Add to Shopping Cart                                                  | non-ad-exposed | 45,000                      |                          | 1,500            | 500            |\n","| Amazon Ad Tag                | Off-AmazonPurchases | Product purchased                                                     | ad-exposed     |                             | 3,000                    | 100              | 60             |\n","| Amazon Ad Tag                | Off-AmazonPurchases | Product purchased                                                     | non-ad-exposed |                             | 9,000                    | 300              | 200            |\n","| Amazon Ad Tag                | Off-AmazonPurchases | Kitchen_Conversion_tracking_Off-Amazon Purchases_SpoonsPurchases_2023 | ad-exposed     |                             | 1,000                    | 30               | 30             |\n","| Amazon Ad Tag                | Off-AmazonPurchases | Kitchen_Conversion_tracking_Off-Amazon Purchases_SpoonsPurchases_2023 | non-ad-exposed |                             | 12,000                   | 250              | 195            |\n"," Which can be pivoted outside of AMC:\n","| -                            | -                   | -                      | Sum of off_amazon_conversion_value | Sum of off_amazon_conversion_value | Sum of off_amazon_conversion_value | Sum of off_amazon_product_sales | Sum of off_amazon_product_sales | Sum of off_amazon_product_sales | Sum of number_of_events | Sum of number_of_events | Sum of number_of_events | Sum of distinct_users | Sum of distinct_users | Sum of distinct_users |\n","\\|------------------------------\\|---------------------\\|------------------------\\|------------------------------------\\|------------------------------------\\|------------------------------------\\|---------------------------------\\|---------------------------------\\|---------------------------------\\|-------------------------\\|-------------------------\\|-------------------------\\|-----------------------\\|-----------------------\\|-----------------------\\|\n","| conversion_event_source_name | conversion_name     | event_type_description | ad-exposed                         | non-ad-exposed                     | % Ad Exposed                       | ad-exposed                      | non-ad-exposed                  | % Ad Exposed                    | ad-exposed              | non-ad-exposed          | ad-exposed              | ad-exposed            | non-ad-exposed        | ad-exposed            |\n","| Amazon Ad Tag                | AddToCart           | Add to Shopping Cart   | 10,000                             | 45,000                             | 18%                                | -                               | -                               | -                               | 400                     | 1500                    | 21%                     | 150                   | 500                   | 30%                   |\n","| Amazon Ad Tag                | Off-AmazonPurchases | Product purchased      | -                                  | -                                  | -                                  | 3,000                           | 9,000                           | 25%                             | 100                     | 300                     | 25%                     | 80                    | 200                   | 40%                   |\n"," SQL\n"," Overview:\n"," Create valuable custom DSP audiences using both rule-based audiences (RBA) or lookalike (LAL) audiences using a combination of off-Amazon data and Amazon advertising signals. The combination of data sets allows for specific high value audiences to be created. The Programmatic audience playbook can be used to provide a framework for creating and monitoring these custom audiences. \n"," Reference Documentation - Amazon Ads Advanced Tools Center\n"," Questions Answered:\n","How can I activate my data? - How can I activate 1P data with AMC data?  - Can I remarket to user who had one conversion and not another? - What use cases are there to use with my existing data?\n"," Actions:\n","Create a rule-based audience - Create a lookalike \n"," Integrations:\n","Lookalike and rule-based audience API integration\n"," Use Cases:\n","CLTV high value audiences - CLTV low value audiences - for exclusion - Rule-based audience and lookalike audience based off of off-Amazon conversions user_id lists - Users who clicked DSP ad/added to cart/viewed detail page but never converted using off-Amazon conversions - Events Manager only: - User who converted X amount of time ago and are in time frame to re-convert - User who converted on X remarketed for Y - Users who purchased at the last seasonal event. Ex: Christmas, Prime Day, Halloween.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Swim Lane #4: Analyze segments"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" Overview:\n"," This use case is designed to be used along with 1P data or by hybrid advertisers who sell both on and off Amazon. The output of this use case is campaigns aggregated up to their goals or campaign types. For example, Black Friday campaigns, evergreen campaigns, Prime Day, etc. By joining in campaign metadata, analytics can be run at an aggregate level. \n"," There is an additional hybrid advertiser use case in the appendix. \n"," Questions Answered:\n","How are my different campaign types performing? \n"," Actions:\n","Adjust budget to campaign types that are performing strongly. - Adjust spend of campaigns to reduce overlap. - Create more campaigns in a high performing category. \n"," Example:\n","| campaign_type | impressions | total_cost | clicks  | costperclick | clickthroughrate | distinctusers | subCampaigns |\n","\\|---------------\\|-------------\\|------------\\|---------\\|--------------\\|------------------\\|---------------\\|--------------\\|\n","| evergreen     | 313,112     | $3,393     | 114,519 | $0.03        | 0.36574          | 6,825         | 3            |\n","| PrimeDay      | 381,503     | $4,202     | 99,228  | $0.04        | 0.2601           | 6,839         | 6            |\n"," SQL\n"," Overview:\n"," If users are segmented on off Amazon platforms such as a CDP or any other data warehouse solution. Those segments can be loaded into AMC, there two methods to load CDP data:\n","AMC direct upload covered in section #1.  - CDP direct integration with Amazon Ads. Check with your CDP provider to see if an AMC integration is supported.\n"," Questions Answered:\n","How do my off-Amazon user segments perform? - How can I use my off-Amazon user segments? - How do my off-Amazon segments perform with DSP spend?\n"," Actions:\n","Create audiences based on off-Amazon segments - Exclude users from off-Amazon segments - Assuming 1P sales data is available - create an audience around users who are in off-Amazon segment A but did not purchase ASIN 1. Create an audience to remarket those users for ASIN 1. \n"," Example:\n","| campaign_id | campaign                                | external_audience_segment_name | impressions | total_cost | clicks | costperclick | clickthroughrate | distinctUsers |\n","\\|-------------\\|-----------------------------------------\\|--------------------------------\\|-------------\\|------------\\|--------\\|--------------\\|------------------\\|---------------\\|\n","| 1111        | Jack & Jill_test_campaign_4832407182165 | Segment1                       | 38,535      | $419.86    | 9,044  | $0.05        | 0.23             | 488           |\n","| 2222        | Iris_test_campaign_8784040388124        | Segment1                       | 37,695      | $410.57    | 8,681  | $0.05        | 0.23             | 481           |\n","| 1111        | Jack & Jill_test_campaign_4832407182165 | Segment2                       | 22,489      | $244.49    | 5,346  | $0.05        | 0.24             | 357           |\n","| 2222        | Iris_test_campaign_8784040388124        | Segment2                       | 19,655      | $214.24    | 4,553  | $0.05        | 0.23             | 377           |\n"," SQL\n"," This will only reflect the cost/impressions/clicks of matched users. It will most likely reflect a small subset of the total cost and impressions.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":2,"text":"Appendix"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Off-Amazon conversions","sectionHeader":{"type":3,"text":"Hybrid use case: `ASIN` category reporting"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/off-amazon-conversions","content":[" This use case is designed for hybrid sellers who might sell both on and off of Amazon. This use case will allow advertisers to join their internal product metadata with the ASINs in AMC to be able to measure performance among specific product categories or verticals that may exist within an AMC instance. Examples include: ASIN subcategory, ASIN category, ASIN profit margin, etc. This data opens up reporting by the aggregate levels. \n"," Questions Answered:\n","How are my product lines performing?  - Considering a fixed cost per product, how many sales are needed to turn a profit on them? - How can I compare advertising cost to my product margin?\n"," Actions:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" Within Amazon Marketing Cloud, advertisers have a unique opportunity to measure and attribute conversions to the frequency of impressions served to individual users over the course of a historical time window. This playbook will dive deeper into the concept of frequency to gain clear optimization insights and direct actions within Amazon Ads to optimize frequency analysis.\n"," To do so, we will be assessing the holistic business value with increasing or decreasing the desired frequency with an advertising activation. This will include identifying:\n","identifying the budget spend on over-exposure and reinvesting to reach new audiences. - determining where conversions are lost when audiences are not being properly retargeted. - identifying the point where the diminishing returns of increased frequency takes effect to accordingly plan marketing efforts.\n"," Without optimizing frequency, an advertiser is subject to overexposing their audience and creating “ad-fatigue” and in turn wasted ad spend that could have been reinvested to reaching new audience members. An underexposed audience is one where the audience has seen too few ads over the course of a time period, and is likely to forget about the brand or product when finally making the purchase decision.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":3,"text":"Benefits"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" Through the guidance in this playbook, you will get answers to the following questions:\n","How to measure frequency within a user-base based on your use case? - How to find the optimal frequency point algorithmically? - How to find the under-served frequency algorithmically? - How find the over-exposure point with frequency algorithmically?\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":3,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" To derive results based on the guidance in this playbook, we assume that you fulfill the following criteria:\n","Access to AMC instance - At least 7 days of backfilled data - Minimum 4 active campaigns\n"," To effectively use this playbook, we recommend you understand the following concepts:\n","AMC concepts: Specifically concepts such as data aggregation thresholds, privacy limitations, and other restrictions listed in the AMC documentation. - Knowledge of AMC SQL: The process outlined here relies on altering SQL code to match your purposes. - Basic Python: This playbook is built using Python, and may require some scripting to adapt it to your use case. - Amazon QuickSight: You will need to know how to ingest data in Amazon QuickSight to output the required visualizations. - Data-driven decision-making: A penchant for turning insights into action with media activations from AMC performance measures.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":3,"text":"Assumptions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":["While the queries in this playbook are broken out by campaign ID, they can be broken out by any tactical dimensions available within AMC such as advertiser, audience segment, or entity. - The queries listed here look into measuring the frequency cap on a daily basis. The attributed conversions towards these daily impressions follow the same attribution logic of the amazon_attributed_events\\_\\* table. - The queries used in this playbook would be measured over the span of the most recent 90 days and will use aggregates to get the daily measure used for the insights.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":3,"text":"Playbook steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" The playbook is structured to perform the following steps:\n","Determine and set frequency caps 2. Identify under-served audiences 3. Determine optimal frequency point 4. Identify actions from analysis\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":3,"text":"Concepts and definitions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" To help you understand this playbook better, the following section describes key concepts and defines relevant terminology:\n"," Advertising frequency refers to the number of times a particular advertisement is exposed to a target audience within a given period, typically within a campaign duration. Through this metric, you must aim to strike a balance between creating brand awareness and avoiding audience fatigue.\n"," An Optimal frequency ensures that the ad or message is seen or heard enough times to make an impact without becoming intrusive or irritating to the audience and being wasteful to the advertising budget. The optimal frequency finding can be utilized in media flights by audience creation, bid optimization, and frequency capping.\n"," Frequency capping allows you (the advertiser) to specify a maximum number of impressions/views a user can see an ad or a cluster of ads over a specific time period. For example, if an advertiser specifies a frequency cap of 3 over the course of the day, the ad publisher will measure the number of impressions served to a user over the course of the day in real time, and once they have been served an impression thrice, they will then be excluded from any further advertising for the rest of the day. Finding a cap where the increased frequency is causing diminishing returns in brand value (or an ad fatigue) will help reduce media spend waste.\n"," Frequency buckets, in the context of this playbook, is an accumulation of spend and return value.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":2,"text":"Frequency by ad format"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" The frequency approach demonstrated in this playbook will aim to factor in each ad format available in AMC to generate a holistic analysis across all advertising touch points that a user can experience within a campaign. This will include anything available within Amazon demand-side platform (Amazon DSP) and Sponsored ads tables within AMC.\n"," The following is a baseline query that measures some aggregate metrics across all the ad types. We will then build upon this frequency measure to collect some of the advanced insights that will address our major use cases.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":3,"text":"Sample output"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" And the output is below is up to a frequency bucket of 15:\n","| frequency_bucket | clicks | purchases | units_sold | product_sales | add_to_cart | detail_page_view | users_in_bucket | impressions_in_bucket | new_to_brand_product_sales | new_to_brand_purchases | new_to_brand_units_sold | pixel_conversions | off_amazon_conversions | off_amazon_conversion_value | off_amazon_product_sales | total_purchases | total_units_sold | total_product_sales | total_add_to_cart | new_to_brand_total_product_sales | new_to_brand_total_purchases | new_to_brand_total_units_sold | total_detail_page_view | cost       |\n","\\| ----------------- \\| ------ \\| --------- \\| ---------- \\| -------------- \\| ------------- \\| ------------------ \\| ----------------- \\| ----------------------- \\| ------------------------------ \\| ------------------------- \\| --------------------------- \\| ------------------ \\| ------------------------ \\| ------------------------------ \\| --------------------------- \\| ---------------- \\| ------------------ \\| --------------------- \\| -------------------- \\| ------------------------------------- \\| -------------------------------- \\| ---------------------------------- \\| ------------------------- \\| ---------- \\|\n","| 0                 | 1884   | 1500      | 1802       | 24312.07       | 1428          | 292839             | 215105            | 0                       | 16584.95                       | 1041                      | 1220                        | 158938             | 158938                   | 0                              | 0                           | 2741             | 3791               | 46291.19              | 6309                 | 26652.98                              | 1848                             | 2265                               | 463770                    | 3819.37141 |\n","| 1                 | 30699  | 957       | 1116       | 13245.27       | 2031          | 69402              | 58916153          | 58916153                | 8928.14                        | 679                       | 779                         | 47632              | 47632                    | 0                              | 0                           | 2242             | 2811               | 33192.3               | 10017                | 18786.01                              | 1394                             | 1675                               | 125607                    | 92775.6655 |\n","| 2                 | 28280  | 1499      | 1756       | 19177.65       | 2418          | 57546              | 24092003          | 48184006                | 13450.05                       | 1067                      | 1261                        | 39856              | 39856                    | 0                              | 0                           | 3177             | 3812               | 42254.6               | 11334                | 23992.77                              | 1929                             | 2281                               | 100233                    | 77132.9198 |\n","| 3                 | 24714  | 1781      | 1974       | 22980.08       | 2046          | 50352              | 14284874          | 42854622                | 16020.34                       | 1270                      | 1393                        | 33927              | 33927                    | 0                              | 0                           | 3545             | 4071               | 46208.59              | 11031                | 27708.16                              | 2198                             | 2445                               | 83145                     | 68634.9905 |\n","| 4                 | 27232  | 2080      | 2318       | 27568.68       | 2235          | 49800              | 12228028          | 48912112                | 18957.93                       | 1464                      | 1612                        | 33664              | 33664                    | 0                              | 0                           | 4085             | 4773               | 54272.39              | 11478                | 30997.63                              | 2504                             | 2826                               | 82263                     | 65181.5909 |\n","| 5                 | 24084  | 2349      | 2589       | 30960.55       | 2334          | 45288              | 7816056           | 39080280                | 21770.99                       | 1700                      | 1829                        | 30862              | 30862                    | 0                              | 0                           | 4446             | 5244               | 59551.41              | 11742                | 35634.56                              | 2804                             | 3126                               | 73875                     | 60435.2568 |\n","| 6                 | 23967  | 2674      | 2927       | 35280.42       | 2514          | 43920              | 6182858           | 37097148                | 24835.31                       | 1931                      | 2076                        | 30631              | 30631                    | 0                              | 0                           | 4831             | 5526               | 64061.69              | 12261                | 38310.46                              | 3068                             | 3399                               | 72549                     | 57939.5659 |\n","| 7                 | 22393  | 3131      | 3399       | 40744.29       | 2634          | 42780              | 4636208           | 32453456                | 28898.51                       | 2246                      | 2379                        | 29545              | 29545                    | 0                              | 0                           | 5315             | 5972               | 68412.17              | 12669                | 42181.89                              | 3453                             | 3746                               | 69162                     | 55052.6733 |\n","| 8                 | 22432  | 3201      | 3481       | 43197.35       | 2625          | 42972              | 3977962           | 31823696                | 31201.47                       | 2328                      | 2504                        | 29297              | 29297                    | 0                              | 0                           | 5497             | 6208               | 72026.56              | 12483                | 44293.31                              | 3566                             | 3914                               | 68511                     | 53717.3385 |\n","| 9                 | 21794  | 3363      | 3663       | 45258.55       | 2775          | 41712              | 3279764           | 29517876                | 31515.67                       | 2368                      | 2538                        | 28933              | 28933                    | 0                              | 0                           | 5649             | 6307               | 73523.3               | 12975                | 45417.81                              | 3669                             | 3998                               | 66786                     | 52389.5323 |\n","| 10                | 21745  | 3677      | 3980       | 48629.88       | 2814          | 43872              | 2795657           | 27956570                | 33816.4                        | 2588                      | 2738                        | 29867              | 29867                    | 0                              | 0                           | 6147             | 6909               | 79453.13              | 13338                | 48780                                 | 3931                             | 4272                               | 69276                     | 51352.588  |\n","| 11                | 21218  | 3943      | 4241       | 52537.46       | 3129          | 43287              | 2392244           | 26314684                | 37435.51                       | 2794                      | 2965                        | 29009              | 29009                    | 0                              | 0                           | 6453             | 7231               | 83781.86              | 13821                | 52583.48                              | 4185                             | 4560                               | 66471                     | 49892.6796 |\n","| 12                | 21437  | 4080      | 4359       | 53821.38       | 3168          | 44106              | 2175011           | 26100132                | 36785.31                       | 2810                      | 2962                        | 30119              | 30119                    | 0                              | 0                           | 6724             | 7356               | 86045.66              | 14472                | 52201.11                              | 4268                             | 4562                               | 68772                     | 49278.2075 |\n","| 13                | 21171  | 4180      | 4503       | 56641.58       | 3132          | 43494              | 1918969           | 24946597                | 39371.88                       | 2902                      | 3074                        | 29257              | 29257                    | 0                              | 0                           | 6906             | 7747               | 89610.81              | 13995                | 55780.96                              | 4424                             | 4864                               | 66975                     | 48026.0431 |\n","| 14                | 21293  | 4330      | 4666       | 58319.51       | 3237          | 44859              | 1711221           | 23957094                | 39659.71                       | 2982                      | 3158                        | 30181              | 30181                    | 0                              | 0                           | 7007             | 7748               | 90303.39              | 14064                | 55397.23                              | 4464                             | 4831                               | 68871                     | 47923.8989 |\n","| 15                | 20705  | 4355      | 4666       | 58367.99       | 3207          | 44499              | 1533020           | 22995300                | 39948.23                       | 2975                      | 3143                        | 29822              | 29822                    | 0                              | 0                           | 7180             | 7938               | 92461.17              | 14355                | 56917.08                              | 4552                             | 4901                               | 67470                     | 47167.0883 |\n"," The query will group users by the number of impressions they were served during the time window (in this case 90 days), and measure the total number of clicks, purchases, units_sold, attributed to those impressions.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":3,"text":"Frequency analysis for first-party datasets"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" Depending on the first-party (1P) data uploaded, it is possible to incorporate frequency analysis queries into 1P data structures. The data uploaded must include revenue data with time stamps of conversions attached to a user_id that can match to the AMC data, it is possible to tie advertising frequency to non-endemic attribution. To do so, you would just need to UNION the off-Amazon conversion tables with the on-Amazon conversions in the Common Table Expression (CTE) to implement in the model.\n"," Additionally, this playbook use case can be applied for advertisers who wish to upload log files from another ad server to create additional off-Amazon impressions. This will ensure that your entire advertising ecosystem is accounted for to measure the optimal frequency for action. To do so, you would want to ensure your uploaded impressions can be matched to the ad placement level to that which can be found in AMC.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":2,"text":"Solution methodology"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" The section below outlines a general approach to defining the inputs to calculate:\n","Minimal frequency - Optimal frequency - Maximum frequency bucket caps across campaigns\n"," The goal of this section is to provide a potential use case and a walkthrough on how to use a frequency measurement approach to solve for it.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":3,"text":"Set frequency caps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" This approach will measure if the accumulated investment after a certain point (cut-off) is outweighing the accumulating returns at an additional frequency bucket. To do so, measure cumulative cost and cumulative return KPI relationship across the frequency buckets and measure each bucket compared to the bucket prior.\n"," To derive frequency buckets, we introduce a measure called the cumulative sum for both cost and return (such as total sales and purchases). These will allow us to measure the relative change in spend and return value with the increased frequency in the market. Before you get to calculating frequency caps, familiarize yourself with the following definitions and equations:\n","Cumulative cost: The total cost of each frequency bucket along with all the frequency buckets before it. - Cumulative return KPI: The total return KPI of each frequency bucket along with all the frequency buckets before it. - Cumulative cost percentage: The percentage value of the cumulative cost at each frequency bucket / the total cumulative cost of all the frequency buckets. - Cumulative return percentage: The percentage value of the cumulative return kpi at each frequency bucket / the total cumulative return KPI of all the frequency buckets. - Percent difference: The difference (subtract) of the cumulative cost percentage from the cumulative return percentage to measure the differences in cumulative investment and return from a cost and return standpoint. - Percent change: Using the percent difference column, you will subtract the percent difference of each row from the previous frequency bucket to measure the relative change in the ratio of cumulative cost and return at each frequency bucket. This metric will be used to identify the recommended frequency cap.\n"," First, calculate cumulative percentages and then use the percent change to determine the frequency cap.\n"," To do so, we take the cumulative cost and cumulative KPI volume at each frequency bucket and then measure the cumulative percentage of each based on their overall volume of conversions. This is because frequency buckets do not exist in a vacuum and that a total investment has to increase to increase the frequency bucket. Hence the need to consider the cost of all the users prior who had a frequency at a given bucket and below.\n"," To calculate the cumulative return percentage, see the example (below), if the conversions at frequency bucket 1 are 9,203 and the conversions at frequency bucket 2 are 6,532, then the cumulative frequency at bucket 2 is 15,735 (9,203+5,532). If the total cumulative conversions (for all frequency buckets) is 48,795, then the cumulative conversion percentage at frequency bucket 2 is 15,735 / 48,795 = 32%.\n"," Repeat this step with the cost column at each of the frequency buckets to get both the cumulative conversions percentage and the cumulative cost percentage. With these two columns, you will then subtract the cumulative cost percentage from the cumulative conversions percentage to get the values for the Percent difference column.\n"," And finally, subtract the percent difference at each row and the percent difference from the previous row to get the percentage change column. For example, if your percent difference in row two is 14.18% and your percent difference in row one is 9.90%, then the percentage change in row 2 is 4.28%.\n"," The percentage change column approaches zero as the frequency bucket increases. At the point where the percent change passes the zero threshold, the growth rate of the additional cost exceeds the growth rate of the additional return value. It is at this point when the percentage change passes zero (in our example, it passes zero at frequency bucket = 4) that you should set for your frequency cap.\n"," An example of how this could look is depicted below:\n","| Frequency bucket | Conversions | Cumulative conversions | Cost  | Cumulative cost | Cumulative conversions % | Cumulative cost percentage | Percent difference | Percentage change |\n","\\| ---------------- \\| ----------- \\| ---------------------- \\| ----- \\| --------------- \\| ------------------------ \\| -------------------------- \\| ------------------ \\| ----------------- \\|\n","| 1                | 9,203       | 9,203                  | 7,801 | $7,801.20       | 19%                      | 9%                         | 9.90%              |                   |\n","| 2                | 6,532       | 15,735                 | 7,933 | $15,733.90      | 32%                      | 18%                        | 14.18%             | 4.28%             |\n","| 3                | 5,024       | 20,759                 | 7,492 | $23,225.80      | 43%                      | 27%                        | 15.87%             | 1.69%             |\n","| 4                | 4,157       | 24,916                 | 7,060 | $30,286.20      | 51%                      | 35%                        | 16.28%             | 0.41%             |\n","| 5                | 3,569       | 28,485                 | 6,621 | $36,907.20      | 58%                      | 42%                        | 15.99%             | -0.29%            |\n","| 6                | 3,213       | 31,698                 | 6,217 | $43,123.70      | 65%                      | 50%                        | 15.43%             | -0.55%            |\n","| 7                | 2,564       | 34,262                 | 5,884 | $49,007.40      | 70%                      | 56%                        | 13.93%             | -1.50%            |\n","| 8                | 2,554       | 36,816                 | 5,598 | $54,605.70      | 75%                      | 63%                        | 12.74%             | -1.20%            |\n","| 9                | 2,276       | 39,092                 | 5,324 | $59,930         | 80%                      | 69%                        | 11.29%             | -1.45%            |\n","| 10               | 1,985       | 41,077                 | 5,036 | $64,965.80      | 84%                      | 75%                        | 9.57%              | -1.72%            |\n","| 11               | 1,773       | 42,850                 | 4,811 | $69,776.50      | 88%                      | 80%                        | 7.68%              | -1.89%            |\n","| 12               | 1,794       | 44,644                 | 4,609 | $74,385         | 91%                      | 85%                        | 6.06%              | -1.62%            |\n","| 13               | 1,485       | 46,129                 | 4,376 | $78,760.60      | 95%                      | 90%                        | 4.08%              | -1.98%            |\n","| 14               | 1,376       | 47,505                 | 4,217 | $82,977.40      | 97%                      | 95%                        | 2.06%              | -2.02%            |\n","| 15               | 1,290       | 48,795                 | 4,093 | $87,070         | 100%                     | 100%                       | 0%                 | -2.06%            |\n"," This query accounts for multiple days of performance and averages the frequency buckets and performance by date to account for any variance that may take place over a long period of time. The method for analyzing is by applying an average aggregate on the date flag that will be used to normalize the total cost and total conversions. Using this approach, we are looking for the point in which the percentage change column goes below zero, and the recommended frequency cap would be the last percentage change value above zero. In this case, we would set our daily frequency cap to 4.\n"," This query can be used to measure the frequency cap of any of the KPIs tracked within AMC using the cumulative cost and return methodology above. In the query below, we will demonstrate this use case across the following KPIs:\n","clicks - Use when focused on building your frequency around maximizing upper funnel engagement and site traffic. Could also use Views.  add_to_cart / detail_page_view - Use when focused on building your frequency around mid funnel engagement, and want to reinvest towards a rules based audience to re-target cart abandoners.  purchases / units_sold / product_sales - Use when optimizing your frequency around maximizing lower funnel attribution, as well as when to reinvest towards reaching new audiences \\* new_to_brand_product_sales - Use when optimizing your frequency around acquiring net new customers.\n"," All aggregated on a daily basis. This query can be adjusted to account for any time frame in which you are interested in measuring frequency, as well as any conversion metric you want to build frequency caps around.\n","| frequency_bucket | clicks_percent_change | purchases_percent_change | unts_sold_percent_change | sales_percent_change | atc_percent_change | dpv_percent_change | impressions_percent_change | new_to_brand_product_sales_percent_change |\n","\\| ----------------- \\| ----------------------- \\| -------------------------- \\| --------------------------- \\| ---------------------- \\| -------------------- \\| -------------------- \\| ---------------------------- \\| ----------------------------------------------- \\|\n","| 0                 | -0.02239              | 0.09392                   | 0.10236                    | 0.09469               | 0.10263             | 0.05155             | 0.04808                     | 0.06211                                        |\n","| 1                 | -0.00982              | 0.04336                   | 0.04356                    | 0.04565               | 0.04371             | 0.02806             | 0.04448                     | 0.02813                                        |\n","| 2                 | -0.00654              | 0.03660                   | 0.03629                    | 0.03849               | 0.03606             | 0.01647             | 0.03535                     | 0.01889                                        |\n","| 3                 | 0.00587                | 0.02391                   | 0.02320                    | 0.02539               | 0.02407             | 0.01310             | 0.07588                     | 0.00905                                        |\n","| 4                 | -0.00412              | 0.02170                   | 0.02053                    | 0.02175               | 0.01688             | 0.00741             | 0.02669                     | 0.00841                                        |\n","| 5                 | -0.00516              | 0.01206                   | 0.01235                    | 0.01205               | 0.00947             | 0.00344             | 0.01285                     | 0.00484                                        |\n","| 6                 | -0.00412              | 0.00476                   | 0.00532                    | 0.00606               | 0.00408             | -0.00016           | 0.00608                     | 0.00162                                        |\n","| 7                 | -0.00360              | 0.00052                   | -0.00011                  | 0.00168               | 0.00166             | -0.00358           | 0.00585                     | -0.00101                                      |\n","| 8                 | -0.00294              | 0.00071                   | -0.00041                  | -0.00115             | -0.00030           | -0.00283           | 0.00300                     | -0.00156                                      |\n","| 9                 | -0.00201              | -0.00153                 | -0.00087                  | -0.00161             | -0.00191           | -0.00421           | 0.00207                     | -0.00172                                      |\n","| 10                | -0.00084              | -0.00162                 | -0.00190                  | -0.00226             | -0.00247           | -0.00362           | 0.00098                     | -0.00260                                      |\n","| 11                | 0.00037                | -0.00206                 | -0.00159                  | -0.00148             | -0.00212           | -0.00308           | 0.00144                     | -0.00162                                      |\n","| 12                | 0.00055                | -0.00293                 | -0.00286                  | -0.00337             | -0.00301           | -0.00376           | -0.00001                   | -0.00017                                      |\n","| 13                | 0.00113                | -0.00192                 | -0.00201                  | -0.00297             | -0.00326           | -0.00337           | 0.00038                     | -0.00110                                      |\n","| 14                | 0.00058                | -0.00194                 | -0.00231                  | -0.00208             | -0.00278           | -0.00317           | -0.00043                   | 0.00010                                        |\n","| 15                | 0.00051                | -0.00209                 | -0.00216                  | -0.00196             | -0.00315           | -0.00285           | -0.00064                   | 0.00124                                        |\n"," Using the methodology above, we can plot the change in percent difference over time to get an aggregated report of the frequency capping point.\n"," The visualization is for multiple conversion metrics\n"," Here, we can see that the percent change hovers at around zero until around the frequency bucket of 8 to which it then drops down to 9 and stays significantly below. Using this guidance, we can use 8 as our frequency cap and invest any additional budgets to reach new audiences.\n"," In looking at the daily frequency rate we can see that the percent change dips below 0 at the frequency bucket of around 8. So If we were to use this as a guide for setting a frequency cap at the daily level we could go with 8 for the down funnel conversions (purchases, sales, add to cart, detailed page views).\n"," For the upper funnel engagement metrics (clicks), we can see that the profitability in driving engagement increase towards the frequency bucket of 3, and then starts to approach zero at the frequency bucket of 5 and crosses at 6. So, if we were to be focused on driving reach and clicks, we would want to try to set our frequency minimum at 2 and our maximum at 5.\n"," Consider the following example with metrics illustrated below. If we were to optimize frequency towards total sales over the span of a month across a single line_item, our model would recommend we set the frequency cap at 5.\n","| frequency_bucket | cost      | cumulativecost | product_sales | cumulativeproduct_sales | sales_percent_change | cumulative roas |\n","\\| ----------------- \\| --------- \\| -------------- \\| -------------- \\| ------------------------ \\| ---------------------- \\| --------------- \\|\n","| 0                 | 0.000    | 0.000         | 6100.140      | 6100.140                | 0.254                 | \\\\ -        |\n","| 1                 | 8875.213 | 8875.213      | 15399.200     | 21499.340               | 0.085                 | 2.422          |\n","| 2                 | 7230.394 | 16105.608     | 6643.590      | 28142.930               | 0.031                 | 1.747          |\n","| 3                 | 4811.318 | 20916.926     | 3185.340      | 31328.270               | 0.024                 | 1.498          |\n","| 4                 | 6313.664 | 27230.589     | 3392.810      | 34721.080               | 0.006                 | 1.275          |\n","| 5                 | 3595.224 | 30825.813     | 1538.020      | 36259.100               | 0.004                 | 1.176          |\n","| 6                 | 3108.070 | 33933.883     | 1285.560      | 37544.660               | 0.000                 | 1.106          |\n","| 7                 | 2559.675 | 36493.557     | 875.980       | 38420.640               | -0.002               | 1.053          |\n","| 8                 | 2884.820 | 39378.377     | 933.110       | 39353.750               | -0.005               | 0.999          |\n","| 9                 | 2420.816 | 41799.193     | 620.630       | 39974.380               | -0.006               | 0.956          |\n","| 10                | 2208.339 | 44007.532     | 504.590       | 40478.970               | -0.004               | 0.920          |\n"," In doing so, you would leave with a cumulative ROAS (cumulatve sales / cumulative costs) of $1.17. If you were to choose a more conservative frequency cap of, say 9 over a span of a month, your cumulative ROAS would drop 20% to $0.95, which would mean your overall spend was greater than your overall sales. So, optimizing your frequency has a significant impact on campaign performance.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":3,"text":"Identify under-served audiences"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" This approach finds the point in which the advertising return KPI compared to costs will start to increase to a positive with an increased advertising investment towards a higher frequency. This approach here can help users define the right value threshold for identifying audiences that are considered under-served from a frequency standpoint.\n"," In cases like the above example with clicks, you get a pretty clear direction on what should serve as the frequency minimum and frequency cap, but with some of the lower funnel metrics, there are ways to determine the point in which the cumulative cost and KPI relationship is more lucrative by increasing the frequency. To do this, we can utilize python to measure the derivatives of the cumulative percentage to find a point in which the values increase above zero.\n"," To demonstrate, we will look at measuring the cumulative ROAS (cumulative sales / cumulative costs) at each frequency bucket and see if we can plot a curve that helps to identify the frequency minimums.\n"," An example starting point will use some dummy data below:\n","| frequency_bucket | purchases | product_sales | cost     | roas    | cumulative_sales | cumulative_cost | cum_sales_perc | cum_cost_perc | percent_diff | percentage_change |\n","\\| ----------------- \\| --------- \\| -------------- \\| -------- \\| ------- \\| ----------------- \\| ---------------- \\| ---------------- \\| --------------- \\| ------------- \\| ------------------ \\|\n","| 1                 | 895       | 11754.29      | 1468.15 | 8.0062 | 11754.29         | 1468.15         | 32.36968        | 21.15466       | 11.20        | NaN                |\n","| 2                 | 408       | 5818.44       | 818.37  | 7.1098 | 17572.73         | 2286.52         | 48.39286        | 32.94659       | 15.40        | 37.72828          |\n","| 3                 | 237       | 3188.28       | 563.93  | 5.6537 | 20761.01         | 2850.45         | 57.17294        | 41.07229       | 16.10        | 4.23651           |\n","| 4                 | 151       | 2023.61       | 415.52  | 4.8701 | 22784.62         | 3265.97         | 62.74568        | 47.05954       | 15.70        | -2.57449         |\n","| 5                 | 121       | 1692.25       | 331.79  | 5.1003 | 24476.87         | 3597.76         | 67.4059         | 51.84033       | 15.60        | -0.76857         |\n","| 6                 | 85        | 1479.59       | 280.26  | 5.2794 | 25956.46         | 3878.02         | 71.48049        | 55.87861       | 15.60        | 0.23323           |\n","| 7                 | 68        | 1082.16       | 234.24  | 4.62   | 27038.62         | 4112.26         | 74.46061        | 59.25378       | 15.20        | -2.53212         |\n","| 8                 | 70        | 1129.79       | 203.06  | 5.5639 | 28168.41         | 4315.32         | 77.57189        | 62.17969       | 15.40        | 1.21907           |\n","| 9                 | 47        | 626.7         | 183.31  | 3.4188 | 28795.11         | 4498.63         | 79.29774        | 64.82101       | 14.50        | -5.94768         |\n","| 10                | 65        | 1030.47       | 472.08  | 2.1828 | 29825.58         | 4970.71         | 82.13551        | 71.62324       | 10.50        | -27.38503        |\n","| 11                | 53        | 1020.28       | 276.46  | 3.6906 | 30845.86         | 5247.17         | 84.94522        | 75.60677       | 9.34         | -11.16617        |\n","| 12                | 49        | 696.6         | 183.34  | 3.7995 | 31542.46         | 5430.51         | 86.86356        | 78.24852       | 8.62         | -7.74664         |\n","| 13                | 27        | 453.66        | 146.5   | 3.0966 | 31996.12         | 5577.01         | 88.11288        | 80.35945       | 7.75         | -10.00123        |\n"," Plotting the frequency cap curve using percent change in Python, we get the following:\n"," Here, we can see that the percent change hovers at around zero until around the frequency bucket of 8 to which it then drops down to 9 and stays significantly below. Using this guidance, we can use 8 as our frequency cap and invest any additional budgets to reach new audiences.\n"," Plotting ROAS, we can use the same Python function below using ROAS in place of percent change.\n"," To make a recommendation of minimum frequency using diminishing returns, we would need to look into using derivatives to smoothen the line and be able to build a bell curve of optimal frequency.\n"," To do so, we will be fitting a non-linear model on a set of data using python. We will use the curve_fit function within scipy.optimize in which will take into account the uncertainties on the response that is Y.\n"," The function code will utilize the model below:\n"," Where X is the frequency bucket, the Y represents the cumulative sales / cumulative cost at each frequency bucket, and A and C will represent the uncertainty principle at each frequency bucket.\n"," Now, we will perform the fit with the curve_fit algorithm using the f_model() function we created and give an initial guess for the parameters (3,2). The curve fit model will follow a least-square approach to minimize the function below:\n"," For the ydata, you will be measuring cumulative ROAS by way of taking the cumulative sales / cumulative costs.\n"," Once you collect the a_opt uncertainties, you will then take the first derivative of Y and X and using the np.gradient() function and then the second derivative of that using the same gradient function to get a bell curve shaped curve for the frequency distribution.\n"," And the output is below:\n"," Using this function, we would look at the first point that the second derivative of percent diff crosses the 0 line as the minimum frequency. In this case, we would want to look at using a minimum frequency of 6, along with using the other analysis that would show a maximum frequency of 8.\n"," As an action coming out of this minimum frequency value, we can create audiences who have less than a frequency of 6 and target them more aggressively with advertising. The AMC query below shows you how to create these audiences to activate against.\n"," From here, you can adjust your bids strategy in Amazon DSP for these audience members to reach them to get them above the minimum.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":3,"text":"Determine optimal frequency point"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" Now that we have the framework for minimum frequency and maximum frequency that we can action upon, the next option would be to see if we can fully plot the frequency bell curve across each bucket to identify the optimal frequency point.\n"," Using a similar approach as before, we will be using derivatives on the percent diff column to create a curve that will help us identify the optimal frequency with respect to the cumulative sales and costs at each bucket.\n"," For this case, we will follow the guide below:\n"," And then plot the results using the following code:\n"," Here, we can see that the optimal frequency level crosses the zero threshold at around the 6 bucket to 8 bucket with the apex being at around 7. This would be the point in which the cumulative sales are peaking against the cumulative costs.\n"," The action from this result would be to aim to adjust bidding so that you are trying to get as many people as possible to a frequency of 7, reinvesting budget to reach new audiences instead of serving these users additional messaging.\n"," The query above will create audiences within Amazon DSP within that time window that can be activated upon to maintain an optimal frequency of 7 for the campaign.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Optimal Frequency Analysis","sectionHeader":{"type":2,"text":"Automation architecture"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/optimal-frequency-analysis","content":[" The automation component of the playbook will live as an Amazon Quicksight dashboard showing the cumulative totals, percentages, percent differences, and percent changes that can further filtered by campaign and measured over a specified time period.\n"," To get started, you will need to define a workflow that can be utilized to visualize the frequency caps to apply to your specific campaign.\n"," To do so, you would need to:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" Promotional or tentpole events like Prime Day and Black Friday offer significant opportunities for customer acquisition and revenue generation, potentially accounting for 20-30% of annual revenue for some brands. Advertisers can target ad-exposed users through rule-based audiences, but only have in-market or lifestyle audiences for non-ad exposed users. This subset of audiences may miss out on people looking to make their first purchase, or a gift for someone else. AMC Lookalike Audiences address these gaps by identifying potential customers who have not been exposed to a brand, using signals from existing customers.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" This playbook guides you through analyzing previous tentpole events, creating AMC lookalike audiences for upcoming events, querying data from AMC, analyzing the results of the previous promotional event, identifying high value audience segments, creating an AMC lookalike audience, and evaluating the created audience.\n"," The playbook is designed for an illustrative use case. Further customization for your use cases will lead to a better outcome.\n"," This playbook will answer the following questions:\n","Which ASINs and campaigns were used in previous promotional events?\n","When to target audiences for promotional events (lead-in and lead-out phases)?\n","How to build an AMC Lookalike Audience for a promotional event?\n","How to target a lookalike audience: keywords, frequency, and ad format?\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":3,"text":"What is a promotional event?"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" A promotional or tentpole event is a significant and highly anticipated promotional activity or campaign that serves as a central focus around which other marketing efforts are organized. Promotional events are usually characterized in the data by large spikes in spend or impressions signifying a large influx of traffic.\n"," These events are typically planned well in advance and can be tied to various occasions, such as product launches, holidays, special sales events (Prime Day, Black Friday, Cyber Monday etc.), or significant cultural moments. The primary goal of a promotional event is to drive consumer engagement, boost brand visibility, and ultimately increase sales or conversions.\n"," Promotional events are effective marketing strategies as they provide a focal point for the efforts of a brand, generate peak consumer interest, and can result in increased brand exposure, customer engagement, and revenue. The Tentpole Phase Overlap Instructional Query (link only available for AMC UI users) provides a similar analysis and is referenced heavily in this playbook.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":3,"text":"What are AMC lookalike audiences?"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" AMC lookalike audiences allow advertisers to find users in the Amazon demand-side platform (Amazon DSP) with similar characteristics as the audiences they custom built in AMC. These audiences can then be activated in Amazon DSP campaigns, allowing advertisers to expand campaign reach to new audiences who share similar characteristics to an existing customer subset.\n"," For information on how to use AMC lookalike audiences please view the following resources:\n","AMC rule-based audience lookalike audiences\n","Introduction to AMC Lookalike Audiences IQ (link only available for AMC UI users).\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":3,"text":"Why use AMC lookalike audiences for promotional events?"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" A good portion of potential purchasers can be targeted using traditional retargeting audiences built in AMC, but these do not help find high-value, new-to-brand customers. An even more difficult segment to target is impulse shoppers, or individuals who see ads and buy within a short time window (less than 1 week). Using your existing customers, AMC lookalike audiences allow you to target impulse shoppers who are either new to your brand or have been exposed to an ad before.\n"," You can use AMC lookalike audiences to build an audience based on previous fast-moving purchasers to get your ad in front of potential new-to-brand or repeat customers before they make their purchase. In this case, our seed audience would be \"customers who converted quickly after an impression.\" Advertisers use the model to build an audience with similar signals to those \"customers who converted quickly after an impression,\" and then seamlessly target them in the Amazon demand-side platform (Amazon DSP).\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" This playbook is for AMC users who have:\n","Completed onboarding for the AMC APIs.\n","Possess an Amazon DSP account.\n","Have historical data for a promotional event (preferably the same one being planned for).\n","Knowledge of AMC Lookalike Audiences\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":3,"text":"Required knowledge"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" The concepts presented in this playbook require knowledge of SQL and working with DSP campaigns.\n"," While there are elements that can be used by all, this playbook will be most valuable to partners with the following characteristics:\n","DSP advertisers\n","Endemic advertisers\n","AMC analysts\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":3,"text":"Assumptions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":["The advertiser has access to historical data from any promotional event in their AMC instance, preferably a similar promotional event to the one they are planning for. If they do not have this data, we recommend utilizing the AMC Lookalike Audiences IQ(link only available for AMC UI users).\n","Price promotions for the ASINs in question will not change (If a product was 50% off last year vs 10% this year the buyer subset may change as the group last year may have been more price sensitive). If the model is trained on a group of individuals who purchased during a big sale, it will create lookalike audiences who are likely to make a purchase during a big sale.\n","Actions of customers who converted during the previous promotional event can be used to identify users who are similar to them. The model relies on the signals (clicks, page views, etc.) from the seed audience to identify users who are similar to that seed audience and thus likely to convert.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":2,"text":"Playbook steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" The playbook is structured in the following steps:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":3,"text":"Step 1: ASIN identification"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" For this playbook, we will adjust an audience for a promotional event. The seed audience for a promotional event will be narrowed down to a subset of customers from that event. In this case, building a seed around a specific ASIN or product category (group of ASINs) will instruct the model to create audiences similar to that subset of customers rather than the whole customer base.\n"," We recommend coming with a pre-selected product category or ASIN(s) that will be promoted during the promotional event (option 1).\n"," If you do not have a pre-selected ASIN and campaigns there are additional queries below that can be used to find ASINs (option 2).\n"," If you are bringing in predetermined ASINs for your upcoming promotional event there are a few limitations as lookalikes rely on historical data.\n"," A more advanced option for this would be to leverage the Audience programmatic framework playbook to identify the highest performing audiences or strategies during a previous event. This playbook provides context on measurement strategies for audiences after a campaign has finished.\n"," The IQ: Identify high value customer segments (link only available for AMC UI users) also provides an avenue to identify high performing audience segments during a previous promotional event.\n"," You will need the following information to proceed to Step 2:\n","DSP campaign ID\n","Sponsored ads campaign name\n","Optional: campaign effective cost per mille (ecpm)\n"," If you are unsure about the ASINs that were the best-performing ones during a previous promotional event, this section will walk you through the steps to figure out which ASINs you might want to use for your current/next promotional event.\n"," To figure out which ASINs to use in our tentpole event, or to even leverage pre-determined ASINs, we need to identify the campaigns that were running during the previous event. These campaigns will be used throughout the playbook to build and analyze a lookalike seed audience.\n"," If campaigns have not already been identified from a previous promotional event, utilize the query below to find campaigns running through a specific date period around a previous promotional event you would like to mirror. In this example we are looking for campaigns that were running during Prime Day.\n"," For the query set the time window with a healthy buffer, in our case for 7/11 and 7/12, we set a window of 6/01 → 08/31.\n","| campaign_id    | campaign                    | campaign_start_date       | campaign_end_date         | unique_reach |\n","\\| --------------- \\| --------------------------- \\| --------------------------- \\| --------------------------- \\| ------------- \\|\n","| SA- Campaign 1 | 2023-07-06T17:00:00.000Z |                             | 57937                       |               |\n","| SA- Campaign 2 | 2023-07-06T17:00:00.000Z |                             | 37817                       |               |\n","| SA- Campaign 3 | 2023-07-06T17:00:00.000Z |                             | 26717                       |               |\n","| SA- Campaign 4 | 2022-06-19T17:00:00.000Z |                             | 23678                       |               |\n","| SA- Campaign 5 | 2023-07-06T17:00:00.000Z |                             | 19991                       |               |\n","| SA- Campaign 6 | 2023-07-06T17:00:00.000Z |                             | 17874                       |               |\n","| SA- Campaign 7 | 2022-06-19T17:00:00.000Z |                             | 17317                       |               |\n","| SA- Campaign 8 | 2023-07-06T17:00:00.000Z |                             | 16028                       |               |\n","| 1234567         | DSP- Campaign 1            | 2023-07-10T20:00:00.000Z | 2023-07-12T20:00:00.000Z | 11708         |\n","| 2234567         | DSP- Campaign 2            | 2023-07-06T20:00:00.000Z | 2023-07-12T20:00:00.000Z | 11382         |\n","| 3234567         | DSP- Campaign 3            | 2023-07-06T20:00:00.000Z | 2023-07-12T20:00:00.000Z | 10852         |\n","| 4234567         | DSP- Campaign 4            | 2023-07-10T20:00:00.000Z | 2023-07-12T20:00:00.000Z | 10103         |\n","| 5234567         | DSP- Campaign 5            | 2023-07-06T20:00:00.000Z | 2023-07-12T20:00:00.000Z | 8428          |\n","| 6234567         | DSP- Campaign 6            | 2023-07-10T20:00:00.000Z | 2023-07-12T20:00:00.000Z | 8208          |\n","| 7234567         | DSP- Campaign 7            | 2023-07-06T20:00:00.000Z | 2023-07-12T20:00:00.000Z | 8064          |\n","| 8234567         | DSP- Campaign 8            | 2023-07-06T20:00:00.000Z | 2023-07-12T20:00:00.000Z | 8063          |\n"," For the following analyses, we suggest incorporating data from all active campaigns. However, you can select specific campaigns at your discretion as you prefer.\n"," Optional: If you have already chosen your ASINs you can skip this section\n"," Once the campaigns have been identified, we can use them in a query to identify ASINs for the previous promotional event. This will allow us to build our seed audience around a specific set of campaigns and ASINs.\n","| tracked_asin | conversions_by_asin |\n","\\| ------------- \\| --------------------- \\|\n","| B0014C2NBC    | 470                   |\n","| B0014C5S7S    | 411                   |\n","| B0014BYHJE    | 354                   |\n","| B0014C0LSY    | 320                   |\n","| B001526RFO    | 318                   |\n","| B01H70LSHE    | 303                   |\n","| B0961NR8KN    | 300                   |\n","| B0831R88S6    | 297                   |\n","| B0014BYHGC    | 296                   |\n","| B01H70LTW8    | 278                   |\n","| B000ZPDDW2    | 272                   |\n"," Based on the ASINs here we would recommend two primary approaches:\n"," Specific product category to target: If you have an internal mapping available, start by grouping ASINs together that are in a similar product category. This will allow for the AMC lookalike audience model to find the ideal customer for that specific category of ASINs. We recommend this approach for advertisers that have multiple product categories or target audiences.\n"," Specific list of ASINs to target: Choose the ASINs you want to target for the promotional event. This may result in a broader target group, but will still yield positive results based on your products. We would recommend this approach for advertisers that sell a specific category of products; example - baby products, makeup, etc.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":3,"text":"Step 2: Seed audience creation"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" For information on how to create a seed audience and lookalike audience best practices see IQ: Introduction to AMC Lookalike Audiences (link only available for AMC UI users) and Rule-based lookalike audiences.\n"," Now that the ASINs and campaigns have been identified, we can leverage that information to create a seed audience. A seed audience is a group of user IDs that have been selected via an AMC query. The seed audience follows the same logic as a standard rule-based audience.\n"," This section will help identify an appropriate seed for your promotional event lookalike audience based on what subset of users performed best during a previous promotional event.\n"," Determining how long it takes from first impression to conversion is crucial for choosing our seed audience. For this example, our goal is to target impulse buyers, or those who buy shortly after being exposed to an ad. To target those individuals we need to build a seed audience of customers who converted shortly after being exposed to an ad.\n"," The query below splits the time to conversion relative to the conversion that occurred during the window specified:\n","First reached 1 day ago\n","First reached 2-7 days ago\n","First reached 1-2 weeks ago (7-14 days)\n","First reached 2-3 weeks ago (14-21 days)\n","First reached 3-4 weeks ago (21-28 days)\n","First reached 5+ weeks ago (greater than 28 days)\n"," The parameters below will be used in a number of queries to follow and define the campaigns that were running during the previous promotional event and/or define the ASINs utilized to create your lookalike audience. For the query below fill in each line by campaign in the following format:\n","DISPLAY_campaign_id: Default for this is -1, fill in the value for your campaign\n","sa_campaign_name: Default for this is ‘’, fill in campaign name if you wish to include\n","ecpm (effective cost per mille): Default for this is -1, if you wish to include a value you may\n","include_brand_halo: 1 to include as default (-1 to exclude)\n"," Update the following query on lines where AND tracked_item in (‘ASIN1’, ‘ASIN2’, ... ‘ASIN_N’)\n","| conversion_event_date | time_to_conversion         | sales     | Percentage |\n","\\| ----------------------- \\| ---------------------------- \\| --------- \\| ---------- \\|\n","| 7/7/2023                | FIRST REACHED 2-7 DAYS AGO  | 187.14   | 0.05%     |\n","| 7/7/2023                | FIRST REACHED 1 DAY AGO      | 469.54   | 0.12%     |\n","| 7/7/2023                | FIRST REACHED 2-3 WEEKS AGO | 243.71   | 0.06%     |\n","| 7/7/2023                | FIRST REACHED 1-2 WEEKS AGO | 95.36    | 0.02%     |\n","| 7/7/2023                | FIRST REACHED 5+ WEEKS AGO  | 149.94   | 0.04%     |\n","| 7/7/2023                | FIRST REACHED 3-4 WEEKS AGO | 416.98   | 0.11%     |\n","| 7/8/2023                | FIRST REACHED 1-2 WEEKS AGO | 244.62   | 0.06%     |\n","| 7/8/2023                | FIRST REACHED 2-3 WEEKS AGO | 417.78   | 0.11%     |\n","| 7/8/2023                | FIRST REACHED 2-7 DAYS AGO  | 557.74   | 0.15%     |\n","| 7/8/2023                | FIRST REACHED 3-4 WEEKS AGO | 408.26   | 0.11%     |\n","| 7/8/2023                | FIRST REACHED 5+ WEEKS AGO  | 116.17   | 0.03%     |\n","| 7/8/2023                | FIRST REACHED 1 DAY AGO      | 464.16   | 0.12%     |\n","| 7/9/2023                | FIRST REACHED 5+ WEEKS AGO  | 202.95   | 0.05%     |\n","| 7/9/2023                | FIRST REACHED 1-2 WEEKS AGO | 269.07   | 0.07%     |\n","| 7/9/2023                | FIRST REACHED 2-7 DAYS AGO  | 435.33   | 0.11%     |\n","| 7/9/2023                | FIRST REACHED 2-3 WEEKS AGO | 484.9    | 0.13%     |\n","| 7/9/2023                | FIRST REACHED 3-4 WEEKS AGO | 636.62   | 0.17%     |\n","| 7/9/2023                | FIRST REACHED 1 DAY AGO      | 373.93   | 0.10%     |\n","| 7/10/2023               | FIRST REACHED 2-3 WEEKS AGO | 399.57   | 0.10%     |\n","| 7/10/2023               | FIRST REACHED 3-4 WEEKS AGO | 842.96   | 0.22%     |\n","| 7/10/2023               | FIRST REACHED 1 DAY AGO      | 598.25   | 0.16%     |\n","| 7/10/2023               | FIRST REACHED 1-2 WEEKS AGO | 385.83   | 0.10%     |\n","| 7/10/2023               | FIRST REACHED 2-7 DAYS AGO  | 670.19   | 0.17%     |\n","| 7/10/2023               | FIRST REACHED 5+ WEEKS AGO  | 739.36   | 0.19%     |\n","| 7/11/2023               | FIRST REACHED 1 DAY AGO      | 65887.29 | 17.17%    |\n","| 7/12/2023               | FIRST REACHED 1 DAY AGO      | 60162.25 | 15.68%    |\n","| 7/11/2023               | FIRST REACHED 1-2 WEEKS AGO | 19074.74 | 4.97%     |\n","| 7/12/2023               | FIRST REACHED 1-2 WEEKS AGO | 16479.47 | 4.29%     |\n","| 7/11/2023               | FIRST REACHED 2-3 WEEKS AGO | 21976.76 | 5.73%     |\n","| 7/12/2023               | FIRST REACHED 2-3 WEEKS AGO | 19041     | 4.96%     |\n","| 7/12/2023               | FIRST REACHED 2-7 DAYS AGO  | 37923.03 | 9.88%     |\n","| 7/11/2023               | FIRST REACHED 2-7 DAYS AGO  | 26148     | 6.81%     |\n","| 7/11/2023               | FIRST REACHED 3-4 WEEKS AGO | 24186.83 | 6.30%     |\n","| 7/12/2023               | FIRST REACHED 3-4 WEEKS AGO | 22979.54 | 5.99%     |\n","| 7/12/2023               | FIRST REACHED 5+ WEEKS AGO  | 30252.83 | 7.88%     |\n","| 7/11/2023               | FIRST REACHED 5+ WEEKS AGO  | 25623.51 | 6.68%     |\n","| 7/13/2023               | FIRST REACHED 2-3 WEEKS AGO | 1307.39  | 0.34%     |\n","| 7/13/2023               | FIRST REACHED 1 DAY AGO      | 923.23   | 0.24%     |\n","| 7/13/2023               | FIRST REACHED 3-4 WEEKS AGO | 2011.64  | 0.52%     |\n"," From the visual we can see the majority of purchases occurred during the promotional event on 7/11 and 7/12. A large percentage of the conversions were from consumers who were first reach less than 1 week before the promotional event.\n"," The table below is grouped on time to conversion across the dates of the promotional event. For this it was 7/11/2023 and 7/12/2023.\n","| time_to_conversion         | Conversions | Percentage |\n","\\| ---------------------------- \\| ----------- \\| ---------- \\|\n","| FIRST REACHED 1 DAY AGO      | 126,050     | 34.09%    |\n","| FIRST REACHED 2-7 DAYS AGO  | 64,071      | 17.33%    |\n","| FIRST REACHED 1-2 WEEKS AGO | 35,554      | 9.62%     |\n","| FIRST REACHED 2-3 WEEKS AGO | 41,018      | 11.09%    |\n","| FIRST REACHED 3-4 WEEKS AGO | 47,166      | 12.76%    |\n","| FIRST REACHED 5+ WEEKS AGO  | 55,876      | 15.11%    |\n"," This table can help you determine how to build your seed audience. Our seed limit is between 500 and 500,000 users as defined by the lookalike documentation. Since we are looking at historical data and our time window will not change, we do not have to leave a buffer and can select any audience size between that limit.\n"," Our use case is to target a subset of conversions from the previous promotional event. In this case, we would like to build our seed audience of users whose time to conversion was less than a day. If we did not have 500 users in that bucket we might consider including other date ranges in this audience.\n"," The time from first impression to purchase with a time of less than 1 week was over 50%. Almost 80% of purchases fell into the “1 day to 7 days” bracket, or the “3 weeks to 5 weeks bracket”.\n"," Rule based audiences would be highly effective in targeting the individuals who were reached in the weeks leading up to the promotional event. Given the minimum refresh time of 1 day, rule based audiences would not be able to reach the large number of fast converting customers: particularly those who saw an ad a day before or on the promotional event itself.\n"," Given the fast time to purchase for the 1 day to 7 day group, a more proactive approach can be used to identify individuals with similar habits to those who purchased in the previous tentpole with a lower time from first impression to purchase.\n"," AMC lookalike audiences are perfect for this situation, the model can use an existing audience of fast buying customers from the previous event, and generate new audiences that show similar signals to that previous group of customers. This allows an advertiser to target NTB impulse shoppers before they even see an ad from the advertiser.\n"," To address the problem of not being able to target users who purchase immediately, we will look to train an AMC lookalike model on the users from last year who converted quickly. The model will utilize those users to identify behavioral signals that led up to their decision to purchase. It will then identify a new subset of users for you to target for the upcoming promotional event. This allows you to get your message in front of prospective buyers before they begin to interact with your brand.\n"," To create your seed utilize the following query and parameters. The only section that will change is the bottom portion of the query\n"," The following API payload should be sent following the documentation here: Rule-Based Lookalike Audiences\n"," The following parameters should be set as follows:\n"," For more information on other parameters like “expected reach” please view the IQ here: Introduction to AMC Lookalike Audiences (link only available for AMC UI users).\n"," The query from above should be flattened and placed into this JSON payload to be submitted to the API\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":3,"text":"Step 3: Event phase analysis"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" Once we have created our lookalike audience, we can perform an analysis to determine how we should target the audience through sponsored ads and the Amazon DSP. The goal of this section is to provide three date ranges to utilize for future queries.\n"," The following section should be done utilizing the ASINs above for a more precise approach, or can be done ASIN-less for more generalized insights.\n"," This is the initial stage of a promotional event timeline, where the focus is on creating awareness and capturing the attention of potential customers. This phase is about introducing your brand, product, or service to a wider audience and piquing their interest. The length of this phase can vary widely by product and budget, with the steps below lined up.\n"," For an AMC lookalike audience in a promotional event, our lead-in period is the number of days before conversion that users saw the ad. Refer to step 2.1 Flight-Time to solve this problem.\n"," Per chart 2.2, and the decision to build a seed on the 1-7 day conversion audience, we would look to have a minimum of 7 days of lead time for this audience. Additional time in the DSP will allow for optimization of your audience, so if the budget exists, having a longer lead-in time than 7 days would be beneficial.\n"," This is the core part of your promotional event where you will make the vast majority of your sales. Usually this phase is accompanied by deals or incentives to get customers to purchase. The timeline for this phase generally revolves around a pre-set time window where the promotional event will occur (Prime Day, Black Friday, etc.). For our example in this playbook, the date was Prime Day 2023 - July 11th & 12th.\n"," Here awareness has been established and potential customers have shown interest in your offerings. At this point you are targeting customers who did not purchase when provided with an incentive, so this phase is about nurturing the relationships you built and guiding potential customers towards making a future purchase.\n"," Recommendation: Target your audiences here using rule based audiences on individuals who have been exposed to an ad, had a detailed page view, added to cart but did not purchase, or other lower funnel rule based audience strategies. This can be paired with the AMC lookalike audience to focus on the high value customers identified by the model.\n"," The goal of the lead out period is to capture as many additional sales as possible, nurture relationships that were built, and ultimately guide customers towards making a future purchase. For the lead out portion of your campaign we do not recommend utilizing AMC lookalike audiences as the high percentage of new to brand customers would not be a good fit for this.\n"," Instead we recommend utilizing AMC rule based audiences to target these individuals who decided not to purchase during the promotional event. Some examples of these audiences can be found in the AMC Instructional Query Library (link only available for AMC UI users).\n","| conversion_event_date | impressions_by_date | conversions_by_date |\n","\\| ----------------------- \\| --------------------- \\| --------------------- \\|\n","| 7/7/2023                | 15967                 | 22576                 |\n","| 7/8/2023                | 10691                 | 17255                 |\n","| 7/9/2023                | 15933                 | 24170                 |\n","| 7/10/2023               | 18476                 | 32134                 |\n","| 7/11/2023               | 68107                 | 399402                |\n","| 7/12/2023               | 157379                | 418294                |\n","| 7/13/2023               | 44581                 | 70348                 |\n","| 7/14/2023               | 29698                 | 47734                 |\n","| 7/15/2023               | 27513                 | 44719                 |\n","| 7/16/2023               | 29759                 | 47615                 |\n","| 7/17/2023               | 24662                 | 39640                 |\n","| 7/18/2023               | 24303                 | 38433                 |\n","| 7/19/2023               | 23844                 | 37246                 |\n","| 7/20/2023               | 22398                 | 34809                 |\n","| 7/21/2023               | 18887                 | 30051                 |\n","| 7/22/2023               | 17560                 | 27807                 |\n","| 7/23/2023               | 17711                 | 28161                 |\n","| 7/24/2023               | 16191                 | 27458                 |\n","| 7/25/2023               | 12645                 | 21527                 |\n","| 7/26/2023               | 4979                  | 11580                 |\n","| 7/27/2023               |                       | 4708                  |\n","| 7/28/2023               |                       | 4968                  |\n","| 7/29/2023               |                       | 5563                  |\n","| 7/30/2023               |                       | 5410                  |\n","| 7/31/2023               |                       | 5867                  |\n","| 8/1/2023                |                       | 5575                  |\n","| 8/2/2023                |                       | 5922                  |\n","| 8/3/2023                |                       | 4972                  |\n","| 8/4/2023                |                       | 4909                  |\n","| 8/5/2023                |                       | 5469                  |\n","| 8/6/2023                |                       | 4213                  |\n","| 8/7/2023                |                       | 5263                  |\n","| 8/8/2023                |                       | 5548                  |\n","| 8/9/2023                |                       | 5495                  |\n","| 8/10/2023               |                       | 5373                  |\n","| 8/11/2023               |                       | 5109                  |\n","| 8/12/2023               |                       | 5051                  |\n"," The following visual is based off the results table.\n"," Based on the table above, we can see that conversions tail off on 7/27, returning back to their normal baseline. For this we would recommend a leadout phase of 14 days. This leadout phase would be focused primarily around lower funnel strategies with a unique combination of rule based audiences.\n","Broad targeting strategy: Utilize traditional retargeting tactics over these 14 days such as detailed page views or add-to-cart did not purchase.\n","Specific targeting strategy: Utilize the retargeting tactics from above, and limit by users in your AMC lookalike audience. This is a more high value targeting strategy\n"," Based on the analysis above the final dates were decided for each of the phases:\n","Lead-in: 7/4 to 7/10: minimum of 7 days before depending on funding\n","Promotional event:  7/11 to 7/12:  Duration of event\n","Lead-out: 7/13 to 7/26:  Day before conversions trailed off for previous tentpole event\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":3,"text":"Step 4: Seed audience activation analysis"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" The following section will guide you through a series of analyses that help answer questions for all 3 phases (Lead in, promotional event, lead out,) on:\n","Frequency analysis\n","Ad format analysis (DSP vs. sponsored ads)\n","Keyword analysis\n"," How often you reach your potential customers during a promotional event can help you get a competitive edge on the rest of the market, particularly in busy periods surrounding holidays and major promotional events. This section will help you determine a frequency strategy for each stage of a promotional event to maximize ad coverage while still seeing a positive return on ad-spend.\n"," We assume that the ASINs you chose were utilized in a previous promotional event or ASINs chosen are similar to the ASINs of the upcoming event.\n"," The following process will be based on the lead-in, event, and lead out dates. The query and corresponding interpretation should be done for all 3 phases to determine the optimal targeting amount for your chosen audience.\n"," For ease of use, restrict your query each time using the date range as the limiting factor. Below are the three dates that were used for this example and the two following analyses.\n","Date range 1: June 26, 2023 - July 10, 2023\n","Date range 2: July 11, 2023 - July 12, 2023\n","Date range 3: July 13, 2023 - July 27, 2023\n"," Update the following query on lines where AND tracked_item in (‘ASIN1’, ‘ASIN2’, ... ‘ASIN_N’)\n"," There will be 3 results tables returned from the 3 queries that were run. The resulting tables should look like the one below. They can then be used to create a visual to see the results.\n","| frequency_bucket | unique_reach | unique_purchasers | impressions | sales     | ad_spend | roas      |\n","\\| ----------------- \\| ------------- \\| ------------------ \\| ----------- \\| --------- \\| --------- \\| --------- \\|\n","| frequency_1      | 547432        | 92                 | 547432      | 3360.35  | 321.2    | 10.46186 |\n","| frequency_2      | 404328        | 199                | 808656      | 7641.4   | 997.58   | 7.65994  |\n","| frequency_3      | 179868        | 253                | 539604      | 9391.64  | 1116.92  | 8.40852  |\n","| frequency_4      | 149442        | 356                | 597768      | 13313.69 | 1347.55  | 9.87992  |\n","| frequency_5      | 98769         | 308                | 493845      | 11902.61 | 1294.27  | 9.19639  |\n","| frequency_6      | 85983         | 362                | 515898      | 12927.74 | 1389.61  | 9.30314  |\n","| frequency_7      | 65987         | 334                | 461909      | 13083.58 | 1279.35  | 10.22674 |\n","| frequency_8      | 57625         | 364                | 461000      | 13936.87 | 1263.73  | 11.02836 |\n","| frequency_9      | 47824         | 324                | 430416      | 11990.94 | 1166.47  | 10.27968 |\n","| frequency_10     | 42548         | 331                | 425480      | 12840.51 | 1189.84  | 10.7918  |\n","| frequency_11     | 36063         | 314                | 396693      | 12032.29 | 1115.15  | 10.78984 |\n","| frequency_12     | 32448         | 288                | 389376      | 11685.7  | 1106.55  | 10.56048 |\n"," This visual is representative and there should be 3 visuals total for each stage: Lead-in, Promotional Event, Lead-out.\n"," The following 3 visuals are illustrative in nature. Number of touchpoints is highly dependent on campaign budget, and cumulative reach goals.\n"," Interpretation: 5 ads, 80% coverage, would provide the most coverage with a positive ROAS.\n"," Due to the granular nature of this data, there might be outliers skewing 7 touchpoints. Here we have a ROAS of 2.42 and 91% cumulative reach with 4 touchpoints.\n"," Interpretation, at 88% cumulative reach and 1.69 ROAS, 4 touchpoints per day would be a good choice as there is a steep drop in ROAS between 4 and 5 touchpoints.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Promotional events","sectionHeader":{"type":3,"text":"Ad Format Analysis (DSP vs. Sponsored Ads)"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/promotional_events","content":[" When working within the Amazon ecosystem, ad placement has the potential to play a huge role in converting potential customers to your clients. The section below outlines how different marketing strategies ultimately impact the likelihood that a customer makes a purchase.\n"," The following process will be based on the lead-in, event, and lead out dates. The query and corresponding interpretation should be done for all 3 phases to determine the optimal targeting amount for your chosen audience.\n"," Follow the instructions laid out in section 4.1 to adjust dates accordingly for the three phases.\n"," This table is an output of the query above and was run for the days of the promotional event. For a full picture run this query for lead-in, lead-out and promotional event dates, as shown above in the “instructions” section.\n","| exposure_group    | unique_reach | unique_purchasers | impressions | sales      | ad_spend   | roas     |\n","\\| ------------------ \\| ------------- \\| ------------------ \\| ----------- \\| ---------- \\| ----------- \\| -------- \\|\n","| NONE               | 1720          | 9                  | 56          | 114.58    | 3339.46    | 0.03431 |\n","| SPONSORED ADS ONLY | 6215456       | 8518               | 26341261    | 140862.18 | 128056.527 | 1.1     |\n","| DSP                | 6588383       | 8688               | 35033877    | 106348     | 115596      | 0.92    |\n","| Both               | 11068484      | 15378              | 57105220    | 173498.23 | 62634.7401 | 2.77    |\n"," The three tables can then be combined to create a chart seen below. This is optional and just provides a visualization of the numbers.\n"," Based on the ROAS we see during our event, while DSP impressions alone do not have a high ROAS, we see that when combined with sponsored ads there is a much higher ROAS. Thus for the promotional event phase we would focus on both DSP and Sponsored Ads to see an optimal return on our investment.\n"," Similar to ad types and placements, keywords play an important role on your promotional event strategy. Below we will determine which keywords were most impactful by promotional event phase (lead in, event period, lead out). This is designed to be directional in nature and to guide which keywords to bid on during each phase.\n"," The keywords chosen here are specific to the seed and will help identify which keywords were most effective for your seed audience. Since AMC lookalike audiences are similar to the seed, the derived keywords should also be effective with your new lookalike audience.\n"," The following process will be based on the lead-in, event, and lead out dates. The query and corresponding interpretation should be done for all 3 phases to determine the optimal targeting amount for your chosen audience.\n"," Follow the instructions laid out in section 4.1 to adjust dates accordingly for the three phases.\n","| customer_search_term | unique_reach | impressions | clicks | click_through_rate |\n","\\| ---------------------- \\| ------------- \\| ----------- \\| ------ \\| -------------------- \\|\n","| keyword1               | 294332        | 542287      | 282    | 0.000520            |\n","| keyword2               | 289488        | 963182      | 18461  | 0.019167            |\n","| keyword3               | 275896        | 501267      | 1122   | 0.002238            |\n","| keyword4               | 163614        | 260707      | 222    | 0.000852            |\n","| keyword5               | 140682        | 203074      | 138    | 0.000680            |\n","| keyword6               | 114658        | 206002      | 620    | 0.003010            |\n","| keyword7               | 109404        | 358602      | 8523   | 0.023767            |\n","| keyword8               | 105720        | 215435      | 494    | 0.002293            |\n","| keyword9               | 105046        | 320369      | 3314   | 0.010344            |\n","| keyword10              | 99937         | 145612      | 73     | 0.000501            |\n","| keyword11              | 72579         | 108656      | 69     | 0.000635            |\n","| keyword12              | 66384         | 105827      | 363    | 0.003430            |\n"," We see that there are a number of categories with a low unique reach but high CTR. Specifically keywords 2, 7, and 9. These keywords would probably be good targets for the upcoming promotional event during the “lead-up” phase.\n"," This analysis should be done for all 3 phases so you know which keywords to bid on throughout the promotional event. The visual below highlights how keywords might change from phase to phase and how the keywords for the lead-in might differ from the keywords for the promotional event.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" Amazon Marketing Cloud (AMC) allows users the unique opportunity to compile media spend and performance inputs at each funnel level to track the diminishing rate of returns at greater media spends.\n"," This approach gives advertisers the novel opportunity to take direct action on their media budget by using a holistic view of their advertising attribution down to the purchase data.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" This playbook guides you through optimizing ad spend distribution by maximizing a specified KPI. It uses historical performance data to create diminishing returns curves, which project expected outcomes at various budget levels allowing you to visualize performance expectations and identify the point where additional investment yields diminishing returns.\n"," The playbook is designed for an illustrative use case. Further customization for your use cases will lead to a better outcome.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":2,"text":"What is media performance optimization?"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" Media performance optimization (MPO) is a toolkit that helps advertisers make informed decisions about the budget levers in Amazon Ads by using historical advertising performance to project an expected Return on Ad Spend (ROAS) given a custom spend distribution. The tool also helps in this process by calculating the optimal distribution of spend using a specified KPI that the advertiser wishes to maximize.\n"," This tool does so by using historical advertiser performance data to build diminishing returns curves of performance at historical budget levels. These curves can be leveraged to project expected performance at custom budget levels, establishing expectations for performance using the same campaigns that ran historically. Advertisers can visualize the point at which the benefits gained from an investment begin to decrease compared to the amount of resources invested.\n"," The formation of these curves uses a non-linear least squares curve fitting model, analyzing at least six months of historical data with an emphasis on recent data to be relevant to the current market condition. The model produces a series of coefficients that can be used to draw a custom curve for each unique combination of media tactics.\n"," The budget optimizer uses Constrained Non-linear Optimization to recommend budget distribution across multiple inputs, satisfying a system of inequalities and equalities based on ABC coefficients and fixed budgets.\n"," The playbook will answer the following questions:\n","How to analyze historical data to identify the overall cost and key performance indicator (KPI) relationship and how it changes at different cost levels.\n","How to use these cost/KPI relationships to create diminishing returns curves that represent the trend of the data.\n","How to project custom spend levels across historical tactics to estimate expected return on investment (ROI) at different KPI levels.\n","How to determine the optimal distribution of spend to maximize returns for a given KPI.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" To maximize success with the Media Performance Optimizer tool, it is recommended that you understand the following concepts:\n","Ability to define dimensional inputs that would be a lever within the media planning / buying process.\n","Ability to define clear media goals and objectives (e.g., increasing revenue by x% or achieving minimum sales of y$.\n","Mapping of categorical variables to clusters to reduce the overall dimensionality of the curves.\n","Defining KPIs to build your optimization model around.\n","Data driven decision making ability regarding the timing of historical data and determining the time decay component.\n","Python - A large portion of the work takes place in Python, so proficiency is essential.\n","Curve Fitting Metrics - Understanding metrics such as Adjusted R² and Mean Absolute Percentage Error (MAPE) is helpful for assessing the quality of diminishing returns curves\n","AMC concepts, specifically data aggregation thresholds, privacy limitations, and other restrictions listed in the AMC documentation.\n","AMC SQL knowledge (link only available for AMC UI users). The processes outlined here relies on altering SQL code to match your purposes.\n","Basic AWS Knowledge of Amazon SageMaker. You will need to know how to set up an Amazon SageMaker Notebook in accordance with the standards of your company.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Costs"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":["Cost assumptions are based on standard pricing for S3, Lambda, and Sagemaker.\n","Monthly costs per advertiser have been reported at less than $1, but may vary depending on data load, architecture, frequency, etc.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Recommendations"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" It is recommended to have \"Amazon Marketing Cloud Insights on AWS\"  or a similar custom solution deployed. The AMC insights on AWS provides several solutions:\n","Workflow manager: service to create and schedule AMC query executions\n","Data Lake: service to transform signals from the source bucket into parquet and catalog in Athena. This allows for signals to pulled via Athena.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Assumptions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" The data-driven component of MPO uses historical data within the past year to project the cost / return ratio at various spend levels. A time decay component is included to weight the curves 10% more heavily towards more recent data. The 10% figure was chosen as a starting point to emphasize recent data without over-indexing, and can be adjusted by the user.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Key differentiators: Performance projection model vs predictive forecast model"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" The table below outlines the key differentiators between the performance projection model (covered in this playbook) and a traditional predictive forecast model.\n","| -                            | Performance Projection                                                                                                                                                                           | Forecast                                                                                                                         | Applicability to AMC                                                                                                                                                                                                                                                                               |\n","\\| ---------------------------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \\| -------------------------------------------------------------------------------------------------------------------------------- \\| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| Curve Fitting Model Function | Assumes a specific function to fit the data. User-performed \"curve fitting exercise\" outside the time-decay model is preferred.                                                              | Leverages an ensemble approach of various machine learning methodologies to minimize error between predicted and actual values. | Specific function allows faster processing for hundreds of curves simultaneously, offering parameter tuning to maximize curve fit.                                                                                                                                                                |\n","| Historical Data Lookback     | Requires at least 6 months to capture enough weekly data to build a curve                                                                                                                        | Requires at least 2 years to capture trend and seasonality of time data component                                                | AMC policy limits queries 13.5 months, making 2-year historical lookback unfeasible without a data lake.                                                                                                                                                                                        |\n","| Model Validity               | Utilizes R2 and MAPE to assess the overall fit quality of the curves to the data.  (note, a specific LMfit function was chosen for curve fitting, advertisers can adjust to find the best fit.) | Uses training and testing data within a time series point, measuring difference between forecasted and actual trends.           | When using R2 and MAPE, it is important to set a threshold for when return distribution variance that does not reflect the overall shape of the curve.                                                                                                                                            |\n","| Time Series Forecasting      | Assumes seasonality will not significantly impact return on spend                                                                                                                                  | Assumes stationarity with the data to account for changing trends and seasonality                                                | When using the performance optimizer, it is important to consider that seasonality will be difficult to reflect with less than a year of data. When building a data lake, incorporate data from the same time a year ago and adjust the time decay to weight towards the same timeframe from the prior year. |\n","| Compute Power                | Relatively low since it is a curve fit on existing data rather than requesting new data                                                                                                           | Gets higher with the quality of forecast model you want to run                                                                   | Considering MPO needs to build a model for every combination of media tactic and KPI, minimizing compute capacity is crucial as the model will run dozens of times for each combination.                                                                                                          |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Playbook steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" The playbook is structured in the following order:\n","Data preparation\n","Diminishing returns model execution\n","Optimization model execution\n","Budget planning and visualization\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":2,"text":"Data preparation"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" When configuring your optimizer tool, the most important step is selecting the inputs and dimensions you want to build your performance optimizer around. Preparing your data properly will help ensure you have the best-shaped curve to plan against.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Defining model dimensions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" The script below requires you to make several decisions regarding the dimensional breakdown for building curves. These decisions will be based on:\n","the overall number of unique categorical variables in these dimensions\n","the customization in these inputs in informing a media plan.\n"," At a high-level view, we will use an example script that focuses on the following dimensions:\n","Ad product type\n","Advertiser\n","Campaign\n"," The query above searches the amazon_attributed_events_traffic_time, sponsored_ads and dsp_impressions tables to compile all campaign activity that took place each week over the past 6 months. Additionally, the query pulls the following impression and engagement metrics:\n","Impressions\n","Clicks\n","Purchases\n","Units sold\n","Product sales\n","Add to cart\n","Detail page view\n","Cost\n"," For each engagement metric, the diminishing returns curves will plot the overall volume of each on a 2-dimensional plane with the corresponding cost. Then, it will use a least squares model to draw the actual curve across each individual combination of ad product type, advertiser, and campaign on each engagement metric. This can include both endemic and non-endemic engagement metrics, as long as they can be directly attributed to advertising activity available on AMC.\n"," Customers can decide which dimensions to apply to the diminishing returns model. Consider the following caveats:\n","Having enough data to draw a useful curve.\n","Customers can expand their plane of reference for engagement metrics to include items tracked within AMC such as new to brand purchases and brand halo purchases. Consider the following caveats:\n"," The media performance optimizer tool allows customers to incorporate their own event level data into the model as a response variable to incorporate into the model. Considering the degrees of separation from on-Amazon advertising activity, it will create for an interesting analysis to measure the correlation between spend and customer response over time.\n"," Structurally, the SQL queries are relatively simple. They typically do not require complex calculations or functions, but focus on collecting Amazon DSP and sponsored ads impression and conversion events. The query referenced above will provide an output similar to the table below:\n","| week | dim_date  | advertiser            | ad_product_type   | campaign                                             | impressions | clicks | purchases | units_sold | product_sales | add_to_cart | detail_page_view | winning_bid_cost | cost       |\n","\\| ---- \\| ---------- \\| --------------------- \\| ------------------- \\| ---------------------------------------------------- \\| ----------- \\| ------ \\| --------- \\| ----------- \\| -------------- \\| ------------- \\| ------------------ \\| ------------------ \\| ---------- \\|\n","| 45   | 11/6/2023  | Iris                  | sponsored_display  | Iris_test_campaign_2311016356135                  | 2418        | 460    | 48        | 36          | 1151.79       | 53            | 361                | 0                  | 205.2189  |\n","| 45   | 11/6/2023  | Kitchen Smart         | sponsored_brands   | Kitchen Smart_test_campaign_8434558048617         | 1695        | 362    | 34        | 47          | 1181.76       | 0             | 270                | 0                  | 174.11777 |\n","| 2    | 1/8/2024   | Gordon's Chocolatier  | sponsored_products | Gordon's Chocolatier_test_campaign_2444732030837  | 1441        | 309    | 33        | 40          | 1028.31       | 30            | 272                | 0                  | 168.67568 |\n","| 2    | 1/8/2024   | Jack & Jill           | sponsored_products | Jack & Jill_test_campaign_7153248131222           | 2510        | 518    | 76        | 76          | 2410.19       | 47            | 445                | 0                  | 258.54335 |\n","| 44   | 10/31/2023 | Gordon's Chocolatier  | sponsored_brands   | Gordon's Chocolatier_test_campaign_8863355878171  | 4068        | 805    | 96        | 98          | 2571.91       | 0             | 671                | 0                  | 454.43633 |\n","| 2    | 1/8/2024   | Organique             | sponsored_display  | Organique_test_campaign_8666755074267             | 901         | 191    | 20        | 28          | 891.25        | 21            | 161                | 0                  | 93.7971   |\n","| 45   | 11/6/2023  | Iris                  | sponsored_products | Iris_test_campaign_2311016356135                  | 2403        | 494    | 46        | 51          | 1338.11       | 43            | 393                | 0                  | 181.51358 |\n","| 48   | 11/27/2023 | Super Power Batteries | dsp                 | Super Power Batteries_test_campaign_4121845860043 | 10560       | 0      | 101       | 124         | 3358.32       | 137           | 1203               | 9.12039           | 114.2731  |\n","| 51   | 12/18/2023 | Super Power Batteries | sponsored_display  | Super Power Batteries_test_campaign_7718354250855 | 1563        | 312    | 30        | 29          | 729.36        | 18            | 267                | 0                  | 129.85538 |\n","| 4    | 1/22/2024  | Kitchen Smart         | dsp                 | Kitchen Smart_test_campaign_6405607844188         | 40745       | 0      | 568       | 580         | 16486.61      | 536           | 4746               | 9.01744           | 436.89874 |\n","| 51   | 12/18/2023 | Super Power Batteries | dsp                 | Super Power Batteries_test_campaign_3860452757180 | 38419       | 0      | 580       | 571         | 15666.07      | 504           | 4556               | 9.02667           | 413.15565 |\n"," Here, you see that the data output includes the week number, and media date along with the advertiser, ad product, and campaigns that will serve as the dimensions in our diminishing returns model. Each line item will function as a point in our larger output, used to generate curves for the model.\n"," From here, you can set up a scheduled workflow to continuously query data on this cadence so that your interface always captures the latest data. Reference Workflow Management Service  for guidance on establishing a scheduled workflow to regularly query your data and append it to a data lake table.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Feature engineering"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" In the event that you want to start including dimensions into your diminishing returns model that do not exist as their own column, but are inputs in the line items, you will need to run some code logic to extract values from the line_item column into their own columns. The best practice for doing so would be to create a specialized data prep notebook that queries the data directly from the data lake and performs the regex extraction functions to compile the new line items and save them in a database that can be referenced in the diminishing returns model.\n"," The specific steps to extract the dimensions from the line_item columns will depend on the specific dimensions you are interested in measuring and the overall line item structure. Some sample code below will give an example on extracting some values from a campaign column.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Data Cleaning"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" raw'camp_delimiter' = raw'campaign'.str.extract(r'(||- |\\_)')\n"," raw'camp_delimiter' = raw'camp_delimiter'.fillna(' ')\n"," raw'ad_delimiter' = raw'ad_name'.str.extract(r'(||- |\\_)')\n"," raw'ad_delimiter' = raw'ad_delimiter'.fillna(' ')\n"," raw'campaign' = raw'campaign'.str.replace('Q3.Q4.2021','2021_Q3Q4', regex=True)\n"," raw'campaign' = raw'campaign'.str.replace('GR 11.22.21','GR_GR 11.22.21', regex=True)\n"," raw'campaign' = np.where((raw'advertiser' == 'Super Power Batteries'),raw'campaign'.str.replace(' - ','\\_', regex=True),raw'campaign')\n"," raw'campaign' = np.where((raw'advertiser' == 'Super Power Batteries'),raw'campaign'.str.replace('AO','Always On', regex=True),raw'campaign')\n"," raw'campaign' = np.where((raw'advertiser' == 'Super Power Batteries'),raw'campaign'.str.replace('2021_Iris','2021\\_\\_Iris', regex=True),raw'campaign')\n"," raw'campaign' = np.where((raw'advertiser' == 'Orangique'),raw'campaign'.str.replace(' - ','\\_', regex=True),raw'campaign')\n"," raw'campaign' = np.where((raw'advertiser' == 'Orangique'),raw'campaign'.str.replace('ROAS','ROAS\\_', regex=True),raw'campaign')\n"," raw'campaign' = np.where((raw'advertiser' == 'Orangique'),raw'campaign'.str.replace('ROAS\\_\\_US_Loyalty_Summer','ROAS_Loyalty_US_Summer', regex=True),raw'campaign')\n"," raw'campaign' = raw'campaign'.str.replace(' -B0',' - B0', regex=True)\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":2,"text":"Diminishing returns curves model"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Model formula"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" The diminishing returns model uses cleaned data to run an LMfit model using the ABC function below to calculate curves for each unique pairing of dimensions and target variable (referred here as combinations) over time. The LMfit Python library provides tools for non-linear least-squared minimization and curve fitting.\n"," The variables in this formula are represented as follows (moving forward it will be referred to as the ABC model). The coefficients reflect the actual data for each input value.\n","return: The result or output value (could be thought of as the \"return\").\n","x: The input or the variable upon which the return depends.\n","A: Maximum Value (Asymptote) - Represents the maximum possible value that rrr can approach. As x increases indefinitely, r will approach a. Essentially, a defines the ceiling or upper bound of the diminishing returns curve.\n","B: Rate of Decay (Diminishing Factor) - The parameter b controls the rate at which the returns diminish as x increases. A larger value of b will make the returns diminish more slowly (flatter curve), while a smaller value of b will cause returns to diminish more rapidly (steeper curve). In simple terms, b dictates how quickly the curve bends downward.\n","C: Steepness or Shape Factor - The parameter c affects the steepness and the shape of the curve. When c is large, the curve becomes steeper, meaning that the returns decrease more rapidly after a certain point. When c is small, the curve becomes flatter, implying that returns diminish more gradually.\n"," The return function uses these 3 coefficients to generate an expected return for the spend value of X. The goal of the formula is to ensure that the function of spend (x) and maximum value (b) are within respect of the overall convex of the curve (c) while parsed by the midpoint (a). This function has shown previously to have the most consistent results when fitting a curve to a scatter plot to reflect a diminishing returns shape.\n"," The Marginal Rate of Return is a return function that uses the same A, B, and C coefficient outputs from the Diminishing Returns model to identify the cost to acquire an additional target KPI value (such as click or 1000 impressions). This metric provides some insight into the overall placement on the curve that your spend value is located and whether it is profitable to continue spending with that specific tactic.\n"," Used to weight the curves more heavily towards specified variables as it relates to a curve model.\n"," Input variable:\n","x: This represents the input to the time decay function, which is typically time. The function calculates a decay value based on this time input. The term (x + 0.0001) ensures that the calculation avoids issues with x=0, preventing division by zero or logarithmic issues.\n"," Parameters:\n","a: This represents an amplitude or scaling factor for the decay function. It sets the base level of decay.\n","b: Scaling parameter that adjusts how fast the decay occurs over time.\n","c: Controls the shape or steepness of the decay curve. It influences how sharply the decay happens as time progresses.\n","d: This is a multiplicative factor applied to the amplitude a at the beginning of the formula. It influences the initial value of the decay before the diminishing returns effect is applied.\n","Threshold:  Determines when time decay starts. When set at 6, the time decay will start at the most recent 6 periods of data and continue to the most recent 6 weeks of data\n"," Decay equation\n","First Term: (a×d) represents an initial value for the decay before any adjustments for time xxx are applied. This is the starting point or baseline from which the decay will be subtracted.\n","Second Term: introduces a diminishing effect over time. As x increases (representing the passage of time), this term reduces the overall decay.\n"," Impact of parameters\n","a: Determines the overall magnitude of the decay. Larger values of a will increase the decay effect.\n","d: Modifies the starting level of the decay. If d is greater than 1, it amplifies the initial decay. If it is less than 1, it reduces the initial decay.\n","b: Controls how quickly the decay effect kicks in. Larger values of b will make the decay more gradual, while smaller values will make the decay happen more quickly.\n","c: Adjusts the shape of the decay curve. Larger values of c result in a steeper drop-off, meaning the decay happens more rapidly as x increases. Smaller values of c lead to a more gradual decay.\n"," Interpretation\n"," The time_decay_func calculates a decay value based on time (or another input variable) x. The function essentially subtracts a diminishing return from an initial level of decay (a×d).\n","Initially, the decay is influenced by the product a×d.\n","As x increases, the diminishing effect kicks in due to the second term, which reduces the overall decay value over time.\n","The parameters a, b, c, and d control the magnitude, rate, and shape of this decay curve.\n"," In practical terms, this function could be used to model a situation where the effectiveness of an event (like an advertisement or some intervention) decreases over time, with the decay following a curve shaped by the specified parameters.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Curve functions"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" Least-squares minimization is commonly used for curve fitting, minimizing residuals on a curve with respect to a weight. The Python code below incorporates a time decay component as the weight, along with the ABC function and abc_model, which calls the lmfit model to be used in the diminishing returns curves. The LMfit Model class wraps a model function that represents the model (without the data or weights). Parameters are then automatically identified from the named arguments of the model function. In addition, simple model functions can be readily combined and reused, and several common model functions are included in lmfit. The compute time of the lmfit model is also a major benefit with its capability of calculating hundreds of curves within minutes.\n","| Parameter | Values                                                                               | Impact                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |\n","\\| --------- \\| ------------------------------------------------------------------------------------ \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\|\n","| a         | - Initial Value: 10 &lt;br>- Minimum Value: 5                                       | - a represents the maximum value(asymptote) of the curve. This means that as x (cost) becomes very large, the curve will approach a value close to a.&lt;br> - By setting a to 10 and restricting it to a minimum of 5, you are ensuring that the curve will not exceed 10, and will not flatten out below 5.&lt;br>-Adjusting a will change the height of the curve. A larger aaa will stretch the curve upwards, while a smaller aaa will pull it downwards.                                                                                                                                                                                                                                                                               |\n","| b         | - Initial Value: 10 &lt;br> - Minimum Value: 1 &lt;br> - Maximum Value: 10,000,000 | - b controls how quickly the returns diminish as x increases.&lt;br>- A smaller b will result in a curve that bends more sharply (more rapid diminishing returns). A larger b will result in a flatter curve, where the returns diminish more slowly.&lt;br>- Adjusting b affects the rate of decay. If you increase b, the curve will flatten, meaning the returns diminish more gradually. If you decrease b, the returns will diminish more quickly.                                                                                                                                                                                                                                                                                       |\n","| c         | - Initial Value:-100 &lt;br> - Minimum Value: -150 &lt;br> - Maximum Value: -50 | - c affects the steepness or sharpness of the curve. The negative values indicate an inverse relationship, which means the curve will have a certain concavity.&lt;br>- With a larger negative value (e.g., c=−50c = -50c=−50), the curve will be less steep, and the transition from increasing returns to diminishing returns will be more gradual.&lt;br> - With a smaller negative value (e.g., c=−150c = -150c=−150), the curve will be steeper, and the returns will diminish more quickly after a certain point.&lt;br> - Adjusting c changes the sharpness of the curve. A larger negative ccc (closer to 0) will make the curve less steep, and a smaller negative ccc (more negative) will make the curve steeper. |\n"," Then the code block below takes a for loop and runs an LMfit function across every id or in this case, combinations of advertisers, product type and campaign and every target variable (or KPI in this case). It will generate a unique curve for each combination with a week of data serving as an individual point on a scatter plot.\n"," It will save each individual curve into a folder in your Sagemaker notebook and display them below with their respective R2 and MAPE scores.\n","Increasing a stretches the curve upward, raising the maximum possible return.\n","Decreasing a pulls the curve downward, lowering the maximum possible return.\n","Increasing b flattens the curve, causing returns to diminish more slowly.\n","Decreasing b makes the curve steeper, causing returns to diminish more quickly.\n","Increasing c (less negative) makes the curve less steep, meaning the returns transition more smoothly from increasing to diminishing.\n","Decreasing c (more negative) makes the curve sharper, with a faster transition to diminishing returns.\n"," Then the code block below takes a for loop and runs an LMfit function across every id or in this case, combinations of advertisers, product type and campaign and every target variable (or KPI in this case). It will generate a unique curve for each combination with a week of data serving as an individual point on a scatter plot.\n"," It will save each individual curve into a folder in your Sagemaker notebook and display them below with their respective R2 and MAPE scores.\n"," The code above will iterate through each unique ID and KPI and will output a unique curve and evaluation metrics for each, as well as the corresponding A, B, C.\n"," The code block above also includes a model amplitude guess based on the scale of the individual KPIs with the block below.\n"," Within the for loop of the model, we determine an amplitude guess that helps with the initial guesses for the bounds of the parameters a, b, and c in the context of fitting the curve to some data. Below is an interpretation of what that means.\n"," 1\\. Setting amplitude guess for parameter a:\n"," Interpretation:\n","Amplitude Guess: The term \"amplitude\" here refers to the maximum value of the curve (the asymptote).\n","Initial Guess: The initial guess for a is set to 1.5×max of KPI. This means that the model assumes the maximum value of the curve will be 1.5 times the highest value in the KPI (key performance indicator) column of the regression_df DataFrame.\n","Bounds: The minimum value for a is set to 1.25×max of KPI, and the maximum value is set to 2.5×max of KPI. This constrains the fitting process to look for a maximum value within this range.\n","Impact: By setting these bounds, you guide the model to consider the KPI data when estimating the maximum value of the curve. The bounds also help the model avoid unrealistic results (e.g., an amplitude too small or too large compared to the observed KPI values).\n"," 2\\. Setting initial guess for parameter b:\n","Interpretation: The initial guess for b is set to 0.75×max of total_cost_media. This means the model assumes that the rate of diminishing returns (controlled by b) should start around 75% of the highest value in the total_cost_media column of the regression_df DataFrame.\n","Impact: The parameter b controls how quickly the returns diminish. By setting it to 75% of the maximum media spend, you guide the model to start with a reasonable assumption about the diminishing effect of media costs. This guess will influence the rate at which returns diminish as media costs increase.\n"," 3\\. Setting bounds for parameter c:\n"," Interpretation: This sets a lower bound of -150 for the parameter ccc, which controls the steepness or shape of the curve.\n","Impact: By setting a minimum value of -150 for c, you allow the curve to potentially have a sharp transition to diminishing returns, but not sharper than what a value of -150 would allow. This helps in constraining the steepness of the curve.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Curve evaluations"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" With each combination, the model generates a curve graph that will visualize the overall distribution of return values of your KPIs (y axis) offset with each weekly total cost (x axis), similar to the visual below. With each curve, an adjusted R^2 value and MAPE value is provided to give a scoring metric on the overall model fit.\n"," In the output above, each dot represents a week of activity, showing the overall number of clicks versus cost from the SQL query. The curve represents the statistical center of all the points in the graph, emphasizing recent data (green circles around blue dots) through a time decay component. The plus sign indicates the mean cost and clicks for the curve. The reporting metrics with R2 at 0.75, indicates that the curve is a good fit compared to the data, and the MAPE was 3.4 which is relatively low.\n"," On top of the curve values, the model will also output a table that includes each combination value and a column for A, B, and C representing the coefficient values generated from the model. If you plug these coefficients into the ABC function above along with a desired spend, to yield expected returns value for that combination with respect to the diminishing returns found in historical data.\n"," The output shows a line item for each combination of campaigns, tactics, and ad types, along with the target KPI variable. The model generates unique A, B, and C coefficients for each combination. The Adjusted R2 and the MAPE values for the curve showing the overall quality of the curve fit to the data distribution.\n"," This output can be incorporated to build internal user interface tool such as a dashboard or an Excel spreadsheet. Using the coefficient values and an Excel version of the ABC projection formula which will calculate in a field that can be referenced in a table that will display the projected output at a budget level.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":2,"text":"Optimization model"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" Once the curves are generated and you have the coefficients, you now have the backend MVP to start playing with various spend distribution across a proposed list of media tactic combinations to aide in media budget planning. If you are interested in seeing what will be the best distribution of spends across your tactics in pursuit of maximizing your return variable, you can incorporate an optimization model into your curve coefficients based on a specified budget and target variable.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Optimization model constraint"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" The optimization model uses a common open source Python package, scipy.optimize, that focuses on maximizing the return on an ABC model with the constraints that the sum of all the X values is less than a specified budget amount.\n"," In this case, y is the KPI value that we want to maximize given the A, B, and C constants of each combination, and the sum total of X which will represent the spend distribution, being equal to or below a certain budget threshold.\n"," The minimization function model can be implemented as a separate Python notebook in which you can specify a target variable and budget utilizing the A, B and C outputs of the diminishing returns model as the constants. The best performing function uses Sequential Least Squares Programming to find the inverse minimum of a function of variables with any combination of bounds and inequality constraints.\n"," The open-source SciPy.Optimize package is used for this purpose. In this implementation, our ABC function serves as the objective function and iterating through each A, B, and C constant to find the maximum return (or in this case, the inverse of the minimum) with respect to the budget constraint and secondary constraint.\n"," The following code provides an example to maximize the clicks across a bunch of tactics with a budget of $20,000 while spending no more than $20,000 on Super Power Batteries Brand.\n"," The output is a simple list of the tactics you want to model against and the recommended spend for each, as well as the calculated return.\n"," The output from this optimization process can be utilized in two primary ways:\n","Direct UI integration: It can be incorporated into a user interface to visualize budget distributions across different tactics.\n","Budget planner tool input: The results can inform upcoming media spend decisions for campaigns.\n"," As you can see, at around the 2nd iteration step, a significant increase in the maximum value as the minimization step is finding the optimal allocations. Around step 20, you can see it hits the max point.\n"," An alternative means for objective maximization is a Basin hopping function within the Scipy.Optimize package. Basin-hopping is a two phase method that combines a global stepping algorithm with local minimization at each step. It iterates through our media tactic combinations and through various allocation starting points to find the universal maximum. It can improve upon the minimization function that works by selecting a starting point and minimizing from there.\n"," The Basin Hopping model can use the same objective function and budget constraint function as the minimization model. The only difference is that when you call the basin hopping model you do not required defining an initial allocation or bounds.\n"," And the output is below. You can see that the maximum return value is slightly higher than the optimization method.\n"," As with the Minimization model, the output will be the combination of campaigns, ad product types and campaign types along with the optimal allocation.\n"," To give a point of comparison, we wanted to demonstrate how the optimizer model would compare to a media allocation baseline that an advertiser may employ with their planning. We looked at the number of views garnered at each budget level if you were to evenly distribute your budget across tactics in your media flight. So, if we have 13 unique media tactics to plan across and a budget of $20,000, the Even Allocation approach assumes an even distribution of $1538.46 across each tactic.\n","| Even Allocation      | Scipy Minimize       | Basin Hopping        |\n","\\| -------------------- \\| -------------------- \\| -------------------- \\|\n","| 417,275 weekly views | 512,114 weekly views | 512,258 weekly Views |\n"," The comparison indicated that the optimization model is generating 100K more views at a 20K spend compared to the even distribution method. This is a 25% increase in projected views by employing the optimization model to help inform the media spend.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Visualization"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" As the scipy package can feel like a black box that produces an output without context, it is important to build trust in the model to confirm that the media tactics favored by the optimization model are the same media tactics with the higher return (Y axis) for the same spend (X axis).\n"," In this case, desktop and mobile im_ls tactics show the highest return value for clicks relative to spend, which is reflected in the optimized budget distribution allocating them the majority of the budget. This demonstrates that the model prioritizes the steepness (verticality) of the return curves when allocating budget across tactics.\n"," Additionally, if you are interested in learning more about how much total budget to distribute across your tactics (i.e. what should your budget be), you can set up your optimization function as a for loop to iterate across different budget levels to find the point in which you are maximizing your weekly return with your weekly spend.\n"," The Python code below will perform the iteration and plot the results:\n"," And the plot output is below:\n"," Here we can see how the curve is shaping out across all the variants of media types to show the maximum return on views that can be gained on the varying budget levels ranging from 0 to 30,000. At a budget of $20,000, our optimization model is outputting a maximum number of just over 500,000 views.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":2,"text":"Budget planning and visualization"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" To demonstrate the steps, we will be taking a detailed walk-through a sample use case to answer a series of business questions to help inform a media planning budget and the specific constraints to optimize for. This visualization will take on the following steps:\n","Generate the diminishing returns curves to project a return on a range of budget values\n","Calculate the optimal spend considering a total all-in budget amount and additional constraints\n","Output the results into a media dashboard\n"," For this case, we will reference 6 months of historical sandbox data to optimize $100k of weekly budget towards media tactics with a max spend towards Desktop as $20k. We will build a diminishing returns curve off of the following media combinations:\n","Inventory\n","Device (which will house the Desktop dimension that we will include in the constraint)\n","Ad Type\n","Channel\n","Funnel\n","Tactic\n","Audience\n"," In this particular case, we will start with a query that will compile each of these dimensions along with the following target variables:\n","Impressions\n","Clicks\n","Views\n","Impression Conversions\n","Click Conversions\n","Spend\n"," With respect to the applicability to project out into the future, these projection curves are able to align a projection into the future as far as the user would like. The major caveat with this is that these curves are a mathematical projection of the cost/return ratio using historical data, and not a predictive forecast model. So, with that in mind, the projection model has had the most value when planning media 1 week to 3 months into the future.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Diminishing returns and optimization outputs"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" The query will have a timeline of the previous 6 months, and is recommended to query via workflow that will output the result into a data lake which can be queried directly within your Sagemaker notebooks or pipeline. The query below will compile the needed inputs and outputs to inform the diminishing returns tool.\n"," The sample output will look like the below (which will include some of the inputs generated from a data lake):\n","| week | dim_date  | advertiser           | ad_product_type   | campaign                                            | line_item                                          | impressions | clicks | purchases | units_sold | product_sales | add_to_cart | detail_page_view | winning_bid_cost | cost       | customer_hash | export_year | export_month | file_last_modified    | row_num |\n","\\| ---- \\| ---------- \\| -------------------- \\| ------------------- \\| --------------------------------------------------- \\| --------------------------------------------------- \\| ----------- \\| ------ \\| --------- \\| ----------- \\| -------------- \\| ------------- \\| ------------------ \\| ------------------ \\| ---------- \\| -------------- \\| ------------ \\| ------------- \\| ----------------------- \\| -------- \\|\n","| 45   | 11/6/2023  | Iris                 | sponsored_display  | Iris_test_campaign_2311016356135                 | Iris_test_campaign_2311016356135                 | 2418        | 460    | 48        | 36          | 1151.79       | 53            | 361                | 0                  | 205.2189  | sndbx          | 2023         | 12            | 2023-12-31T20-01-17 | 1        |\n","| 45   | 11/6/2023  | Kitchen Smart        | sponsored_brands   | Kitchen Smart_test_campaign_8434558048617        | Kitchen Smart_test_campaign_8434558048617        | 1695        | 362    | 34        | 47          | 1181.76       | 0             | 270                | 0                  | 174.11777 | sndbx          | 2023         | 12            | 2023-12-31T20-01-17 | 1        |\n","| 2    | 1/8/2024   | Gordon's Chocolatier | sponsored_products | Gordon's Chocolatier_test_campaign_2444732030837 | Gordon's Chocolatier_test_campaign_2444732030837 | 1441        | 309    | 33        | 40          | 1028.31       | 30            | 272                | 0                  | 168.67568 | sndbx          | 2023         | 12            | 2023-12-31T20-01-17 | 1        |\n","| 2    | 1/8/2024   | Jack & Jill          | sponsored_products | Jack & Jill_test_campaign_7153248131222          | Jack & Jill_test_campaign_7153248131222          | 2510        | 518    | 76        | 76          | 2410.19       | 47            | 445                | 0                  | 258.54335 | sndbx          | 2023         | 12            | 2023-12-31T20-01-17 | 1        |\n","| 44   | 10/31/2023 | Gordon's Chocolatier | sponsored_brands   | Gordon's Chocolatier_test_campaign_8863355878171 | Gordon's Chocolatier_test_campaign_8863355878171 | 4068        | 805    | 96        | 98          | 2571.91       | 0             | 671                | 0                  | 454.43633 | sndbx          | 2023         | 12            | 2023-12-31T20-01-17 | 1        |\n"," After cleaning the data to extract inventory, device, ad type, channel, funnel, tactic, audience, and applying target curve models and optimization steps, you obtain the following coefficients data and optimization output.\n"," Model coefficients:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Optimization outputs"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Microsoft Excel model"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" With the model coefficients (A, B, and C), you are now about to build a tool that would allow you to project your volume of returns and marginal returns at a given spend level. This can be done within a UI tool that allows for user input fields and calculations that would support the ABC model mentioned above. For this use case, we can use a simple solution as Microsoft Excel.\n"," The first step would be to create a table that would house all of your coefficient columns like the below:\n"," With this you can input a spend column as well as a projection column and marginal projection column with the following formulas.\n"," The projection cells will use the following formula:\n"," And the marginal cost cell will use the following formula:\n"," This will allow you to input a weekly spend figure into the spend column cell which would represent the spend value towards a specific tactic, it would generate the marginal cost per return and the projected volume based on historical data.\n"," From here, you can reference these cells in another tab by laying out a proposed media mix and test different weekly budget combinations and see the change in the weekly return.\n"," To do this, you can reference the spend cell in the previous table and input the indexing match formula below:\n"," Which will match the spend with the corresponding ID combinations in the same row. Then you can do the same thing with the projected impressions, clicks, views, impression_conversions, and so on to take the corresponding projection and input it into your table.\n"," Then you could take the corresponding spend and volume to create your cost per kpis:\n"," Then use the index matching function above to reference the marginal rate of return:\n"," As a result, you will be able to not just play with various budget amounts across your media distribution and see how the projected totals can change to impact your larger campaign goals. If you are looking to allocate some additional budget on top of your existing budget, then the marginal projections table will help to determine the relative investment to purchase one additional KPI value.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - media performance optimization","sectionHeader":{"type":3,"text":"Action"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/media_performance_optimization","content":[" After selecting your preferred budget allocation, input the cost data into the Amazon Ads media planning tool for market activation. You can establish a regular schedule for data updates and adjust model parameters to create custom curves using the most recent data. This approach ensures your media planning remains dynamic and data-driven.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" This playbook combines the powerful capabilities of Amazon Marketing Cloud (AMC) with the persona builder API to deliver comprehensive audience insights. This integration allows marketers to leverage a wide array of data sources and analytical tools for more effective audience targeting and campaign optimization.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" The persona builder and AMC currently function independently, each utilizing its own distinct API set. This playbook will guide you through the process of integrating insights from both APIs to create a comprehensive and scalable solution.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":3,"text":"What is audience overlap?"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" Audience overlap analysis is a powerful tool that helps advertisers understand how their target audiences intersect and relate to one another. Including an affinity score to the “intersected” or overlapped audiences adds an additional level of depth to analyzing the overlapped segments. Identifying audience overlap with the scoring methodology will help you in strategizing your audience targeting, optimizing ad spend, improve targeting accuracy, and avoids audience saturation.\n"," Leverage AMC and the persona builder API for enhanced targeting\n"," You can perform measurement and analytics using AMC to identify audiences and leverage the persona builder API to identify additional audience attributes across top retail categories, top overlapping audiences, estimated size , top demographics and Prime Video insights. All the results are accompanied with an affinity score that refers to the likelihood and a percentage score that refers to the percentage of the customers on the above categories.\n"," For instance, consider a top audience category with an affinity of 5 and a percentage of 5:\n","Affinity of 5: This means that customers in the persona are five times more likely to belong to this audience compared to the average Amazon customer.\n","Percentage of 5: This indicates that 5% of the customers within the persona belong to this specific audience.\n"," This interpretation helps quantify both the relative strength of the audience association (affinity) and its prevalence within the persona (percentage). Such data can be valuable for targeted marketing strategies and understanding customer segments more effectively.\n"," These additional insights like overlapping audiences, overlapping retail categories, estimated size of the audiences, Prime Video insights, overlapping demographics information for your audiences combined with AMC results will help you build a holistic approach of audience performance for an advertiser and provide inputs for strategic media planning and optimize audience targeting groups for new campaigns or improve existing campaigns. This analysis adds added value by identifying the key audience groups and their behavioral characteristics that might fall under either a lookalike audience or a rule-based audience group.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":3,"text":"Benefits"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" AMC has audience analytics features where you can build rule-based audiences, lookalike audiences, use the Audience segment insights for identifying the segments for organic users. In addition to details from AMC, you can discover and explore the best performing audience by understanding audience behavior powered with actual purchase and streaming behaviors, with data based on consumer panels and research surveys from Amazon using the Amazon persona builder APIs.\n"," This playbook will answer the following questions:\n","How to use the different endpoints of the persona builder API with AMC results\n","How to analyze the affinity and percentage for AMC audiences that overlap with persona builder API categories?\n","How to identify additional demographics attributes for existing AMC Audiences?\n","What are the various use cases where information from the persona builder API and the AMC API can be combined effectively?\n","How to use affinity and percentage metrics to inform audience targeting strategies?\n","What do affinity and percentage scores mean for overlapping audiences?\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":3,"text":"Intended audience"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" This playbook is designed for data-driven professionals adept at converting AMC performance insights into effective media activations. It targets the following personas:\n","Media/AdTech analyst: Possesses media knowledge and experience managing DSP campaigns.\n","Data analyst: Proficient in SQL, capable of customizing queries to meet specific advertiser needs.\n","Data engineer: Skilled in constructing automated data flow pipelines for segment measurement and activation.\n","Data scientist: Well-versed in scientific methodologies and assumptions necessary for conducting and applying test results.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":3,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" It is recommended you understand the following concepts to get the most out of the playbook:\n","AMC concepts: Specifically, concepts such as data aggregation thresholds, privacy limitations, and other restrictions listed in the AMC documentation.\n","Knowledge of AMC SQL. The process outlined here relies on altering SQL code to match your purposes.\n","Basic Python: This playbook is built using Python, and may require some scripting to adapt it to your use case.\n","Basic Amazon DSP knowledge: You will need to know how to query audiences to activate upon in Amazon DSP. \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":3,"text":"Playbook steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" We will explore several use cases to demonstrate the implementation and practical application of enhanced scoring for overlapping audiences. Each use case will follow a structured approach outlined in the steps below.\n","Step 1: Begin with an exploratory query using AMC or use a custom query to suit your use case. This initial step involves analyzing historical campaign performance, either by leveraging the Instructional Query Library or writing a custom query tailored to your specific use case. This helps analyze the historical performance of your campaign and identify an audience that warrant further attention and optimization . To help you get started, we have illustrated the implementation of overlapping audiences through a set of use cases.\n","Step 2: After executing step 1, use the results from AMC, to identify potential audience segments to obtain more detailed scoring, which will help to fine-tune your marketing strategy by understanding the nuances of each segment, ultimately leading to more effective and efficient campaign performance.\n","Step 3: With the audiences identified in step 2, utilize the audience discovery API to extract canonical IDs for these segments.\n","Step 4: Use the persona builder API to gain deeper insights into your audiences. By querying the API with the canonical IDs (from step 3), you can dive deeper into overlapping audiences, demographic details, retail category interests, Prime Video streaming interests, and estimated audience sizes.\n","Step 5: Transform and utilize the data from step 4 to output for use in your existing platforms, or normalize to create visualizations to understand the insights. For example, create files per category of audience such as overlapped audience , demographic details , estimated size, retail categories etc. Remove all null values to ensure data integrity and standardize data types within each file for consistency.\n","Step 6: Analyze your transformed data (step 5) to identify audiences using affinity scores and percentages to classify those as high or low value. Use the classified audiences to:\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":2,"text":"Use cases"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":["Identify the top 3 overlapping audiences with your AMC audience\n","Analyze additional audience attributes on audiences built using the AMC rule-based audience\n","Leverage the Audience Segment Insights dataset to identify non ad-exposed users and their demographic audiences\n","Gain audience insights from Prime Video data to enhance targeting strategies\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":3,"text":"Identify the top 3 overlapping audiences with your AMC audience"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" To get you started, we will identify the top 3 performing audiences of the advertiser using AMC, create a generic persona using the persona builder API. The process then extends to exploring alternative audiences, evaluating them based on their affinity score and percentage .This comprehensive analysis will provide insights into additional attributes of existing high-value segments and identify potential new targeting opportunities, ultimately refining the audience strategy of the advertiser and improving campaign performance.\n","What are the overlapping audiences with my top-performing audiences that are not a part of your campaign strategy?\n","Can I build a dashboard of demographic details of my top 3 performing audiences?\n","Identify alternate audiences with high affinity to make a purchase and use them in targeting your campaign.\n","Build knowledge on existing audiences and analyze the audiences within top retail categories, demographics and lookalike audiences.\n","Use the audiences to perform targeting on Amazon DSP/Sponsored display to obtain wider reach.\n"," Analyze the segments to identify top 3 audiences that you want to analyze the overlapping audiences for with additional demographic information and affinity scores. Use these set of audiences as an input to the persona API.\n"," The use cases can be expanded to multiple use cases where you want to identify audience segments. You can use the following IQs to identify audiences:\n","New to brand customers\n","Users with high purchase rate\n","Users purchasing during tent pole events\n","Users that take least time to convert\n"," Illustrated below is an example query that was modified using the IQL identify audience segments for high-value customers\n"," Sample output\n"," Identify top 3 audiences based on total product sales, reach, and percentile from the exploratory query results.\n"," With the audiences identified, utilize the audience discovery API (from the persona_builder.ipynb) to extract canonical IDs for these segments.\n"," Then run code snippets from the persona_builder.ipynb to get data on:\n","Overlapping audiences\n","Demographic audiences\n","Retail categories\n","Estimated audience size\n","Normalize the affinity and percentage scores to a common scale, such as 0-1 or 0-100%, to facilitate comparison.\n","Address any outliers or skewed distributions at this stage to prevent them from distorting your results.\n","Create visualizations to understand the output. Create scatter plots to illustrate the relationship between affinity and percentage scores or use stacked bar charts to compare percentage scores of multiple audiences.\n"," Choose clusters of high-performing audiences (high-affinity, high-percentage audiences). Interpret these results within the context of your campaign objectives, draw actionable insights for more effective targeting in your Amazon DSP campaigns.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":3,"text":"Analyze additional audience attributes on audiences built using the AMC rule-based audience"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" Use the AMC rule-based audience feature to construct custom audience tailored to your campaign objectives. After you establish your audience, use the persona API to build personas. With these personas, you can then explore overlapping audiences to determine their affinity and percentage scores. You can expand this use case to build any custom audience leveraging the existing IQLs and building a custom rule-based audiences example leverage the Introduction to Events Manager IQ and build an audience for users who perform off-Amazon conversions and perform the steps below to identify additional audience attributes.\n","Can refining audience lists eliminate spend waste in campaigns?\n","What is the persona detail of my cart-abandoner audience?\n","Can affinity and percentage overlap help expand seed audiences for lookalikes?\n","Use high affinity and percentage overlaps to find similar to custom audiences you created (e.g., cart abandoners).\n","Analyze demographic details of custom audiences (e.g., top purchasers).\n","Identify similar audiences with high affinity and percentage to negatively target those audiences (e.g., users who have seen the ad multiple times but have not made a purchase).\n"," Navigate to the Instructional queries tab of the AMC console filter through Audiences IQs to find a use case that aligns with your specific requirements.\n"," For more details, see Create a rule-based audience.\n"," With the audiences identified, utilize the audience discovery API (from the persona_builder.ipynb) to extract canonical IDs for these segments.\n"," Then run code snippets from the persona_builder.ipynb to get data on:\n","Overlapping audiences\n","Retail categories\n","Demographics\n","Prime Video\n","Normalize affinity and percentage scores to a common scale (e.g., 0-100) if necessary and addressing any outliers or anomalies in the data.\n","Create visual representations to illustrate the relationships and overlaps between audiences.\n"," This transformation will help to understand the affinity scores and analyze percentage scores to quantify the overlap between audiences.\n"," The image below is a representation of a rule-based audience of AMC Repurchases - Cross Brand overlapped with Amazon Demographic audiences.\n"," Select high-affinity, high-percentage audiences for DSP targeting. Incorporate top-converting audiences while also including broader, high-affinity audiences to expand campaign visibility.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":3,"text":"Leverage the Audience Segment Insights dataset to identify non ad-exposed users and their demographic audiences"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" Identify non ad-exposed users from the Audience Segment Insights (ASI) dataset. Create a persona for this group using the persona API to determine their demographics. Analyze the affinity and percentage scores targeting opportunities for these previously unreached audiences.\n","Can I measure demographic details of the lookalike audiences I created?\n","Can I increase the affinity of an audience over time?\n","Identify high-affinity, high-percentage alternative audiences for non-ad-exposed and untargeted groups.\n","Use Persona API to identify demographics, overlapping audiences, and retail categories for these groups.\n","Leverage affinity and percentage data to target audiences based on campaign strategy, especially for creating wider reach, awareness, and consideration.\n","Adjust Amazon DSP retail category targeting based on these insights.\n"," Audience Segment Insights (ASI) consists of datasets that provide information on public Amazon standard catalog audiences, which include Amazon audience segments across in-market, lifestyle, interests, and life events categories.\n"," Refer to the Introduction to Audience Segment Insights IQ to get started.\n"," Use the query in the IQ to identify audiences to include in your campaigns.\n"," With the audiences identified, utilize the audience discovery API (from the persona_builder.ipynb) to extract canonical IDs for these segments.\n"," Then run code snippets from the persona_builder.ipynb to get data on:\n","Demographics\n","Overlapping audiences\n","Retail categories\n","Normalize affinity and percentage scores to a common scale (e.g., 0-100) if necessary and addressing any outliers or anomalies in the data.\n","Create visual representations to illustrate the relationships and overlaps between audiences.\n"," This transformation will help to understand the affinity scores and analyze percentage scores to quantify the overlap between audiences.\n"," Sample output : Retail categories\n"," Choose high-affinity, high-percentage audiences for more effective targeting in your DSP campaigns.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Enhanced scoring for overlapping AMC audiences","sectionHeader":{"type":3,"text":"Gain audience insights from Prime Video data to enhance targeting strategies"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/enhanced_scoring_for_overlapping_audiences","content":[" To enhance targeting strategies using Prime Video data, begin by constructing exploratory queries to analyze Prime Video campaigns and their reached audiences. Analyze these audiences to gather detailed viewership signals for these audiences, including their preferences for specific actors, directors, genres, movies, and series.\n"," For each audience, evaluate the affinity and percentage scores associated with these viewership signals. Use this analysis to understand audience preferences and behaviors, and refine your targeting strategies for more effective campaign performance.\n"," You can leverage signals in AMC to understand the performance of your existing audience reached by Prime Video ad campaigns. Enhance targeting by analyzing the overlapping performance across stars, series, movies, and genres.\n","What kind of Prime Video insights are available using the persona API?\n","How can I apply these insights to enhance my existing Prime Video campaigns?\n"," Refer to the instructional query on Prime Video ads. Below is a sample to build a lookalike audience reached through Prime Video campaigns and identifying the viewership details for that audience.\n"," Use this query below to create a lookalike audience for users reached by Prime Video ads and analyze their attributes to target those audiences in the new or existing campaigns.\n"," Sample Output:\n"," Include preferences for:\n","Actors\n","Directors\n","Genres\n","Movies\n","Series\n"," With the audiences identified, utilize the  audience discovery API (from the persona_builder.ipynb) to extract canonical IDs for these segments.\n"," Then run code snippets from the persona_builder.ipynb to get data on:\n"," Audience preferences for specific actors, directors, genres, movies, and series.\n"," Transform data focusing on affinity and percentage scores.\n","Analyze the dataset\n","Identify any null values\n","Clean and sort the dataset\n","Eliminate any audiences with over-indexing or under-indexing affinity and percentage scores.\n"," Analyze these audiences based on affinity scoring and percentage classify the audiences as high value or low value\n"," Evaluate affinity and percentage scores for each viewership signal per audience and realign your targeting.\n"," After you have finalized on audiences, use the POST operation of the /amc/audiences/query resource to create the audience. After your audience is created and activated, you can view and use your audience in Amazon DSP or in your sponsored ads accounts.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" This playbook provides a comprehensive, step-by-step guide for advertisers to leverage AMC data and optimize their Amazon advertising campaigns through strategic keyword clustering and analysis.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":2,"text":"What is keyword clustering?"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" Keyword clustering is a strategic approach that groups similar search terms together based on the products (ASINs) they drive traffic and sales to. By leveraging customer purchase data from Amazon Marketing Cloud (AMC), advertisers can identify which keywords are associated with the highest-revenue products, enabling more precise targeting and efficient budget allocation.\n"," Keyword clustering operates on the fact that certain search terms consistently lead to the purchase of specific products. By organizing keywords into cohesive groups, advertisers can simplify the management of large, complex keyword portfolios, improve the relevance of their campaigns, and enhance the overall effectiveness of their Amazon advertising efforts.\n"," The strategy of the playbook combines proven SEO methodologies, such as keyword relevance, content clustering, and continuous optimization, with customer purchase data from AMC. This data-driven approach allows advertisers to identify the most effective ASINs for each keyword and prioritize them based on revenue potential. By clustering keywords that consistently drive revenue to the same ASINs, the strategy ensures a strategic alignment between search terms and high-performing products, optimizing ad spend and improving campaign effectiveness.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":2,"text":"Benefits"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" Key benefits of keyword clustering include:\n","Targeted advertising for better results: By grouping similar keywords into clusters, this playbook enables you to create highly targeted campaigns. Each cluster is aligned with specific products (ASINs) that have a proven track record of driving sales, ensuring your ads reach the right audience.\n","Efficient budget utilization: The playbook guides you in allocating your advertising budget to the most impactful keyword clusters, minimizing wasteful spending and maximizing your return on ad spend (ROAS).\n","Streamlined campaign management: This playbook simplifies the process by organizing keywords into manageable clusters, reducing the complexity of campaign management.\n","Data-driven decision making: Integrating AMC data, the playbook empowers you with insights based on actual customer purchase behavior, helping you make informed decisions and optimize bids.\n","Enhanced visibility and brand growth: For advertisers using Sponsored Products and Sponsored Brands, this playbook offers strategies to increase product visibility and brand awareness, driving both immediate sales and long-term brand loyalty.\n","Versatility across campaign types: Whether your focus is on Sponsored Products or Sponsored Brands, the principles outlined in this playbook can be adapted to your specific campaign type, providing a versatile approach to keyword targeting and optimization.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" To get the most out of the playbook, it is recommended you have the following technical skills and knowledge:\n","AMC concepts, specifically data aggregation thresholds, privacy limitations, and other restrictions listed in the AMC documentation.\n","Knowledge of AMC SQL (link only available for AMC UI users). The processes outlined here rely on altering SQL code to match your purposes.\n","Basic AWS knowledge of Amazon SageMaker in specific. You will need to know how to set up an Amazon SageMaker Notebook in accordance with the standards of your company.\n","Proficient with Python: A large portion of the solution described here takes place on Python, so a proficiency with Python is a must.\n","Clustering concepts: Requires a basic understanding of how clustering algorithms, such as K-means, hierarchical clustering, etc. work.\n","Data-driven decision-making and performance measurement and a penchant for turning insights into action with media activations from AMC performance measures.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Recommended Architecture"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" We also recommend that you deploy Amazon Marketing Cloud Insights on AWS or a similar custom solution. The AMC insights on AWS provides several solutions like:\n","Workflow manager: Service to create and schedule AMC query executions.\n","Data Lake: Service to take signals from the source bucket, transform into parquet and catalogue in Athena. This allows for signals to pulled via Athena. This is a standard offering with AWS insights product.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Costs associated with implementing this playbook"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":["The costs associating with the implementation outlined here assume the standard pricing for Amazon S3, AWS Lambda, and Amazon SageMaker.\n","Costs to run per advertiser on a monthly basis have been reported at less than $1 a month but will vary depending on data load, architecture, frequency, and so on.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":2,"text":"Playbook steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" The playbook is structured in the following order:\n"," Step 1: Data collection from AMC: Retrieve essential data from conversion tables in AMC,  with the help of the workflow manager, to gather information on user interactions and conversions.\n"," Step 2: Keyword clustering: Leverage Amazon SageMaker to process the collected data and generate cluster IDs based on defined parameters; group relevant keywords for specific Amazon Standard Identification Numbers (ASINs) for data manipulation and grouping; and organize data around search terms and products.\n"," Step 3: Analysis: Utilize scatter plots to visually analyze clusters, apply the 80-20 rule; filter out less relevant clusters.\n"," Step 4: Upload and action the generated insights: Upload the enriched data and action those for further insights and optimization.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":2,"text":"Data collection from AMC"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" The following AMC query aggregates performance KPIs based on what shoppers search for (customer_search_term) and the products (tracked_item) they finally buy, with dimensions such as marketplace (marketplace_name). The query also derives the traffic and sales that each search term brings. This data helps derive the relationship between search behavior and product selection.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Load query results into Python"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" We need to read the data that has been retrieved by the above query from Amazon Athena.\n"," Or, read the data manually from a local .csv file downloaded from AMC\n"," \\---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\n"," The output of this query provides a comprehensive analysis of Amazon advertising performance metrics by organizing data around customer search terms and tracked products (ASINs) within a specified time frame. It identifies the marketplace, aggregates user engagement metrics such as detail page views, add-to-cart actions, and purchases, and distinguishes between regular and new-to-brand customers. Additionally, the query highlights key performance indicators like total sales and revenue, helping to pinpoint high-performing keywords and products.\n"," This detailed data serves as the foundational step for keyword clustering, enabling strategic alignment of search terms with successful products to optimize advertising campaigns effectively. By aggregating metrics such as user engagement, purchases, and revenue for each search term and associated product, the data allows for the identification of high-performing keywords. These keywords can then be grouped together based on their effectiveness in driving traffic and sales to specific products. This clustering helps in creating targeted advertising campaigns that are aligned with proven customer search behavior, optimizing budget allocation and enhancing overall campaign effectiveness.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Refine data and rank product"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" This phase filters the data based on the Amazon criteria, with a particular focus on user counts. Additionally, a ranking system is implemented, prioritizing products with the highest sales volume. To simplify the analysis, only the top 10 results per search term are considered. This ensures that the focus remains on the most impactful products in terms of sales, offering a streamlined approach to studying their performance.\n"," \\---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":2,"text":"Keyword clustering"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" The process involves inputting data into a user defined function to cluster keywords based on overlapping ASINs. This function generates cluster IDs based on parameters and groups keywords relevant to specific ASINs. The iteration is driven by sorting data by key performance indicators (KPIs) like total new to brand customers, page views, revenue. The function starts with the most relevant keyword, extracts ASINs, and groups similar keywords based on the overlap threshold. This process continues, creating clusters with decreasing relevance. The final step transforms the dataset for further analysis. The function reports the number of keywords grouped in each cluster and the associated ASINs. This process efficiently organizes keywords into clusters, highlighting commonalities and helping to identify patterns among them. It simplifies complex data, enabling a clearer understanding of relevant keyword groups and their impact on ASINs or outcomes.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Strategic analysis"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" The strategy adopted in this playbook analyzes the journey consumers take when searching and ultimately purchasing products on Amazon.In this mapping:\n","Search Phrases: Represented by bubbles at the top (e.g., \"Smartphone\").\n","Product Purchases: Represented by smaller circles connected by arrows, indicating the products consumers end up buying.\n"," The diagram illustrates the process of keyword clustering in action. Each bubble at the top represents a search term (e.g., \"smartphone\"), and the smaller circles below represent products that consumers end up purchasing after using that search term. The lines connecting them show how multiple search terms can lead to overlapping product outcomes, which is the essence of keyword clustering. In this mapping:\n","Cluster 1 groups search terms like \"smartphone with large screen,\" \"high-performance smartphone,\" and \"latest smartphone model\" that lead to similar products. These terms cluster together because they generate clicks or purchases of overlapping ASINs, making them part of the same high-performing product group.\n","Cluster 2 includes search terms like \"budget smartphone,\" \"affordable mobile phone,\" and \"basic smartphone model,\" which similarly lead to a different set of products but follow the same logic.\n","New Cluster is created if a search term does not align with existing clusters, meaning it does not match already identified products.\n"," By analyzing these clusters, advertisers can gain insights into the relationship between search behavior and product purchases. This understanding allows them to optimize campaigns by focusing on high-performing keywords and aligning them with product groups that drive the most engagement or sales. In turn, this strategy enables more efficient campaign management, helping advertisers uncover new keyword opportunities and prioritize keywords that yield the highest return.\n"," The search term query involves extracting conversion tables from AMC and aggregating data around search terms and products.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Clustering considerations and best practices"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":["| Component                             | Explanation                                                                                                                                                                                                                                                                               | Best practice                                                                                                                                                                                                                                        |\n","\\| --------------------------------------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \\|\n","| Challenges with K-Means              | Traditional K-Means clustering poses challenges in defining the right number of clusters. Too few clusters lead to broad groupings, while too many result in thin, less meaningful clusters. Additionally, the K-Means random starting point causes inconsistency in cluster formation. | Refine the starting point by selecting the most relevant keyword for sales volume. This ensures that clusters are aligned with high-impact keywords from the outset. Balance the number of clusters by starting small and adjusting iteratively. |\n","| Starting point                        | The starting point(or \"seed\") is critical in determining how clusters are formed. Randomly selected starting points in K-Means lead to inconsistent and unrepeatable clusters.                                                                                                       | Begin with the most relevant keyword for sales volume to ensure a structured and repeatable process, leading to more controlled and consistent clusters.                                                                                            |\n","| Reproducibility and tailored Focus    | Ensuring reproducibility in the clustering process is essential for consistency. A random starting point introduces variability, leading to different outcomes in each run.                                                                                                             | Use a consistent starting point based on sales volume, ensuring reproducibility and alignment with strategic goals. This approach helps focus efforts on high-priority areas.                                                                     |\n","| Long-tail approach                    | To avoid overwhelming the media team with too many clusters, focus on a manageable number of keyword groups that provide the highest impact.                                                                                                                                             | Aim for 15-20 clusters, ensuring the media team can focus on specific areas, optimizing both time and budget allocation.                                                                                                                           |\n","| Customer experience                   | Ensuring alignment between keywords and products is key to enhancing customer experience, as it affects relevance and engagement.                                                                                                                                                        | Group keywords based on purchase behavior and ASIN relevance to enhance customer satisfaction and the overall ad campaign experience.                                                                                                               |\n","| Ranking criteria                      | Keywords are ranked based on their contribution to total revenue. However, it is important to balance this with visibility and volume potential.                                                                                                                                         | Rank keywords based on a combination of revenue contribution, visibility, and potential growth opportunities for a balanced strategy.                                                                                                               |\n","| Balancing sales volume and visibility | While high sales volume indicates efficient keywords, it is important to also capture those with visibility potential for future growth.                                                                                                                                                 | Ensure clusters include both high-sales and high-visibility keywords for a more balanced and growth-oriented approach.                                                                                                                           |\n","| Different views of clustering         | Clustering can focus on different objectives, such as increasing volume, conversion rates, or customer lifetime value, depending on the marketing strategy.                                                                                                                              | Align the clustering strategy with the specific marketing goals, whether the goal is maximizing volume, improving conversions, or focusing on customer retention.                                                                                          |\n","| Purchase behavior                     | Keywords that consistently lead to the same product purchases should be grouped together to reflect consistent customer journeys.                                                                                                                                                        | Use purchase behavior patterns to form clusters that align with how customers search and purchase, improving the effectiveness of the ad targeting.                                                                                                 |\n","| New cluster formation                 | If a search term does not fit into an existing cluster, it forms a new group. This ensures flexibility and adaptability to new trends.                                                                                                                                                   | Allow flexibility to create new clusters when search terms do not fit into existing ones, ensuring adaptability to evolving customer behavior.                                                                                                      |\n","| Influencing KPIs                      | The clustering process considers key performance indicators(KPIs) such as incrementality, visibility, and efficiency to guide optimization.                                                                                                                                            | Customize clusters based on KPIs that align with business goals, such as new-to-brand metrics, click-through rates, and return on ad spend (ROAS).                                                                                             |\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Analysis steps"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" The following steps outline the process for clustering keywords based on their associated ASINs. This method ensures that keywords are grouped efficiently to optimize your Amazon ad campaigns.\n","Input data: The function takes a dataframe sorted by a specific KPI.\n","Initial keyword selection: Begins with the most relevant keyword, extracting its ASINs.\n","Cluster formation: Keywords with ASINs overlapping beyond a set threshold are grouped together, forming clusters.\n","Iteration: Continues with decreasing relevance, creating additional clusters until all keywords are grouped.\n","Final transformation: The dataset is transformed for further analysis, providing a report of the number of keywords in each cluster and their associated ASINs.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Function overview"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":["Purpose: To cluster keywords by examining the overlap of ASINs associated with those keywords.\n","Sorting: Starts with the most relevant keyword, based on the chosen KPI, and extracts the associated ASINs.\n","Grouping: Groups similar keywords based on an overlap threshold, which determines how much overlap in ASINs is needed to group keywords together.\n","Method: Can use a soft grouping method (considering overlap between any two keywords) or a hard grouping method (considering overlap within the current cluster).\n"," This parameter represents the minimum ratio of overlap required between two sets of ASINs for their corresponding keywords to be considered part of the same cluster.\n"," Value Range: It is a floating-point number between 0 and 1.\n"," Purpose: It sets the sensitivity of the clustering. A higher threshold means that only keywords with a high proportion of shared ASINs will be clustered together, while a lower threshold allows for more loosely related keywords to be grouped.\n"," This parameter determines how the function handles the clustering process, particularly how it incorporates new keywords into existing clusters.\n"," Purpose: It defines the criteria for adding keywords to clusters and thus affects the final clustering results.\n"," \\---\\|---\\|---\\|---\\|---\\|---\n"," Example scenarios\n"," Scenario 1: overlap_threshold = 0.4 and group_method = soft\n"," Threshold: 40% overlap required.\n"," Behavior: Keywords will be grouped together if they share at least 40% of ASINs with any keyword in the cluster.\n"," Result: More inclusive clusters where the connection can be indirect.\n"," Scenario 2: overlap_threshold = 0.4 and group_method = hard\n"," Threshold: 40% overlap required.\n"," Behavior: Keywords will only be added to a cluster if they share at least 40% of ASINs with the intersection of ASINs of all keywords currently in the cluster.\n"," Result: Smaller clusters with stronger connections.\n"," The soft group method:\n","Allows broader, more inclusive clusters by only requiring keywords to overlap with any cluster member, not the entire set.\n","Accommodates indirect keyword relationships through intermediate terms.\n","Lowers the barrier for keywords to be grouped, beneficial for capturing many related terms.\n","Handles noisy real-world data better, leading to more robust clusters.\n","Effective for markets with related but not identical products.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Joining back to initial data sets"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" The following code will merge the clustered data with the original dataset. The aggregated data, grouped by cluster ID, includes:\n","Traffic volume\n","Sales volume\n","ASIN count\n","Keyword count\n"," The results display cluster-level insights such as:\n","Cluster IDs\n","Page views\n","Product sales\n","Keyword and ASIN counts\n","Sales-to-traffic ratio\n"," This provides visibility into the efficiency and performance of each keyword cluster and aligns with expectations for a multi-brand advertising account.\n"," Run the following code in Amazon SageMaker\n"," \\---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\n"," \\---\\|---\\|---\\|---\\|---\\|---\\|---\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":2,"text":"Analysis"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" This post processing phase  involves conducting descriptive analyses for each cluster, evaluating factors like revenue, traffic, and conversion rates.\n"," The data analysis uses a scatter plot to visualize clusters in terms of traffic and sales. \n"," The plot reveals significant clusters in the top right, indicating a positive correlation between traffic and sales, as expected in similar categories, however, the issue lies with smaller clusters in the bottom left which shows which keywords that are not performing well in terms of traffic and sales prompting the application of keyword optimization and keyword strategies. By analyzing and optimizing the keywords associated with these low-performing clusters, you can improve their visibility and relevance, driving more traffic and potentially increasing sales.\n"," The ranges of both axes are adjusted to focus on most of the data while excluding extreme outliers. This is done using the 99.9th percentile of the data, ensuring the plot is not skewed by very extreme values.\n"," What the plot shows:\n","Correlation insight: The scatter plot helps to identify if there is a correlation between the amount of traffic a webpage receives and the sales it generates. For instance, if most points are moving in an upward trend from left to right, it suggests that more traffic tends to result in more sales.\n","Clusters: If the points form clusters, it can indicate specific patterns or groups within the data. For example, certain keywords might be driving traffic and sales more effectively.\n","Outliers: Points that are far from the rest may represent outliers, which can be crucial for further analysis. These could be cases with unusually high traffic but low sales or vice versa.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Applying the 80/20 rule"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" In the context of sales data analysis, the 80/20 rule (Pareto principle) helps identify which clusters of keywords are most impactful in terms of revenue generation. The visualization of sales distribution across different clusters enables better understanding of where to focus optimization efforts.\n"," The bar chart shows the distribution of revenue and the number of clusters contributing to the top 80% and bottom 20% of sales:\n","Top 80% revenue:\n","Top 80% clusters: Show the number of clusters that make up the top 80% of sales. It highlights the relatively small number of clusters that are driving the majority of the revenue.\n","Bottom 20% revenue: This bar represents the total revenue generated by the remaining clusters, which make up the bottom 20% of sales, providing insight into areas that may need improvement or reevaluation.\n","Bottom 20% clusters: This bar shows the number of clusters that contribute to the bottom 20% of sales. It illustrates the larger number of clusters that have a smaller impact on sales.\n"," Focusing on the clusters that generate the most revenue (the top 80%) allows for prioritized optimization of these high-impact areas. Conversely, analysis of the bottom 20% of clusters reveals opportunities for improvement, such as refined keyword strategies, enhanced product pages, or reallocated marketing resources.\n"," The above information in a boxplot can help in understanding the distribution of the data, identifying outliers, and seeing how concentrated or spread out the data is.\n"," Interpreting for 80/20 rule:\n"," Top 20% clusters: The top part of the box plot are likely the clusters that contribute the most to the total sales.\n"," Bottom 80% clusters: The bottom part of the box plot represents the clusters that contribute less.\n"," By analyzing the box plot, you can see if a small number of clusters (top 20%) are indeed contributing to the majority (80%) of sales. This can help in validating the 80/20 rule visually and understanding the distribution of your data more comprehensively.\n"," A scatter plot will help visualize the relationship between webpage traffic and product sales. Data is filtered to focus on the clusters that generate the top 80% of revenue. Additionally, the sales_to_traffic_ratio will highlight clusters that are highly efficient in converting traffic into sales.\n"," The above scatter plot illustrates the 17 remaining clusters, providing details such as cluster ID, associated ASINs, and keyword count. The bubble size corresponds to the sales-to-traffic ratio, offering insights into the conversion efficiency of each cluster. Notably, bigger cluster stands out with a higher sales-to-traffic ratio, suggesting it may involve premium or high-sales products. This cluster could be a priority for increasing top-line revenue, especially if scaling traffic is part of the strategy. On the contrary, clusters with less favorable sales-to-traffic ratios, despite their size, may not be the optimal focus for optimizing neutral brand revenue. This analysis guides strategic decisions by pinpointing clusters with the potential for impactful revenue optimization.\n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":2,"text":"Upload and action insights"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Export Insights"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" The analysis involves three datasets: Description, Search term mapping, and Product mapping dataset. These datasets are uploaded to AMC using the 1p data upload process. The 1p data upload connects user searches and product purchases with clusters. When users search for specific keywords or buy certain products, these actions are identified and mapped to relevant clusters. 'Relevant clusters' refers to predefined groups of related keywords and products that are significant for revenue generation and strategic marketing insights.\n"," The enriched 1p data becomes the foundation for comprehensive queries, empowering the dashboard with insights like top scorecards, funnel performance, keyword details, audience insights, and more. This information is vital for executing successful Amazon campaigns and refining strategies based on real user interactions. The data reveals the right ASINs, optimal keywords, and many other deep data insights to define budget & forecast business outcomes. These insights provide everything teams need to structure, scale, and optimize their campaigns.\n"," Description dataset\n","\n","Relevance: Helps identify which clusters and keywords are most critical for revenue generation (indicating how important each keyword/cluster is in driving sales).\n"," Search term mapping dataset\n","Maps clusters to specific search terms.\n","Relevance: Enables understanding of which search terms are associated with each cluster, helping to align search behavior with cluster strategy.\n","| -   | cluster_id | customer_search_term      |\n","\\|------\\|-------------\\|-----------------------------\\|\n","| 0    | 1           | B3RDIJD                     |\n","| 1    | 1           | B00GVDDFSH                  |\n","| 2    | 1           | B00NE8DH8P4                 |\n","| 3    | 1           | B3-2JKMLCRU                |\n","| 4    | 1           | B0JW9DJHR                   |\n","| 1671 | 17          | smartphone                  |\n","| 1672 | 17          | high performance smartphone |\n","| 1673 | 17          | large smarphone             |\n","| 1674 | 17          | large screen smartphone     |\n","| 1675 | 17          | latest smartphone model     |\n"," Product mapping dataset\n","Maps clusters to specific products.\n","Relevance: Connects products to clusters, facilitating analysis of product performance within each cluster and aiding in product-specific marketing strategies.\n","| -    | cluster_id | tracked_item | is_hard_match |\n","\\|-------\\|-------------\\|---------------\\|-----------------\\|\n","| 0     | 1           | BSJHE43S3W    | TRUE            |\n","| 1     | 1           | B04O3JFSFHI   | FALSE           |\n","| 2     | 1           | B04KCNY6FG    | TRUE            |\n","| 3     | 1           | B059ENOCB7    | FALSE           |\n","| 4     | 1           | B04NFJCPL21   | TRUE            |\n","| 1456  | 17          | B08DHJDJBF5   | FALSE           |\n","| 1528  | 17          | B0FJFZ2P9G    | FALSE           |\n","| 1632  | 17          | B0884NFRL     | TRUE            |\n","| 5283  | 17          | B085IDND5M    | FALSE           |\n","| 6584  | 17          | B09KFJIRK6R   | FALSE           |  \n"],"documentType":"guide"},{"title":"Amazon Marketing Cloud - Keyword clustering","sectionHeader":{"type":3,"text":"Action the insights"},"path":"/en-us/guides/amazon-marketing-cloud/playbooks/keyword-clustering","content":[" We can derive several actionable insights that can enhance the effectiveness of Amazon ad campaigns. Here are some action items advertisers can take:\n","ASIN clustering for enhanced product categorization:\n","Keyword clustering for strategic campaign planning:\n","Optimized budget allocation:\n","Under performing keyword reallocation:\n","Product-specific marketing strategies:\n","Inventory management:\n","Improved ad copy and creative development:\n","Cross-selling and upselling opportunities:\n","Enhanced customer insights:\n"],"documentType":"guide"},{"title":"FAQs","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/faqs","content":[],"documentType":"guide"},{"title":"FAQs","sectionHeader":{"type":2,"text":"AMC APIs overview"},"path":"/en-us/guides/amazon-marketing-cloud/faqs","content":[" What are AMC APIs?\n"," Amazon Marketing Cloud APIs (AMC APIs) are a suite of REST interfaces for developers to programmatically access AMC features. AMC APIs are often used to automate or schedule query workflows, create custom audiences, facilitate scaled operations, upload first-party signals, and enable integrations between AMC and other systems.\n"," What were AMC APIs like in the past?\n"," The previous version of the AMC APIs were configured to be accessed at the instance-level of the advertiser. With these instance-level APIs, each AMC instance has its own unique endpoint as detailed in the Instance info page of the AMC UI. The instance-level APIs were not completely aligned with regular Amazon Ads API practices.\n"," What are Amazon Ads APIs?\n"," Amazon Ads APIs are a suite of REST interfaces for developers to programmatically access Amazon Ads features. Major Amazon Ads solutions are available via Amazon Ads APIs, including sponsored ads, Amazon DSP, Amazon Marketing Cloud (AMC), Amazon Marketing Stream, etc.\n"," What are the benefits?\n"," The AMC APIs align with the standards that the rest of the Amazon Ads APIs follow. The AMC APIs offer further enhanced security, usability, and performance, allowing developers to easily utilize, manage, and build with these APIs.\n"," Specifically:\n","Authorization: Developers can authorize and authenticate AMC APIs the same way as the rest of the Amazon Ads APIs; which is via client applications administered by Login with Amazon.  Multi-client access: Multiple users and partner organizations can now access one AMC instance at the same time.  Standard URL pathway: Developers can now find AMC APIs grouped by functional categories, and following a standard endpoint naming convention composed of a base URL, the API path, and resources. \\* Easy access: Developers can access detailed descriptions and instructions in the Advanced tools center\n"," What AMC APIs are available today as part of Amazon Ads API? For what purpose should each be used?\n","|Category\t|API\t|Description\t|\n","|---\t|---\t|---\t|\n","|Administration\t|Account / instance management \t|Manage AMC instances\t|\n","|Reporting\t|Workflow execution\t|Query data sources and generate reporting on demand\t|\n","|Reporting\t|Workflow scheduling\t|Query data sources and generate reporting per schedule\t|\n","|Audience management\t|Rule-based audiences\t|Create ruled-based audiences ready for Amazon DSP campaign activation \t|\n","|Audience management\t|Lookalike audiences\t|Create lookalike audiences ready for Amazon DSP campaign activation\t|\n","|Audience management\t|Advertiser audiences\t|Stream pseudonymized audience records into Amazon Ads \t|\n","|Advertiser data upload\t|Advertiser data upload\t|Upload pseudonymized advertiser first-party signals to Amazon Ads\t|\n"," Do AMC APIs support versioning?\n"," API versioning is the practice of managing changes to an API and ensuring that these changes are made without disrupting customers. We support versioning for AMC APIs. If we introduce any breaking changes in the future, these changes will be rolled out through new versions.\n"," Do AMC APIs have a rate limit or throttling?\n"," Rate limits, or throttling, are restrictions placed on the number of API requests a user or an application can make within a specified time frame. Such restrictions help prevent abuse and ensure fair usage of the APIs. AMC employs rate limiting for APIs.\n"," Rate limits per API differ and are subject to change. Surpassing the rate limit will return a 429 error. These rate limits employ token bucket and should be handled by industry standard methods such as token bucket algorithm, exponential back off, and jitter. There are resources online to help, including information here. AMC recommends employing these industry-standard methods and not coding to specific rate limits.\n"," How do I deepen my AMC knowledge?\n"," You can explore the AMC education resources available on Amazon Ads learning console.\n"],"documentType":"guide"},{"title":"FAQs","sectionHeader":{"type":3,"text":"Reporting APIs"},"path":"/en-us/guides/amazon-marketing-cloud/faqs","content":[" Where can I find the results of the reporting workflow execution?\n"," There are two ways for you to access workflow results\n","You can find the results in your output S3 bucket. The details of your S3 bucket can be located in the Instance info page of the AMC UI. Note that after migration, you must modify the IAM policy of your S3 bucket to continue receiving query execution results. 2. Alternatively, you can download reports through a pre-signed URL, which is generated by calling GET /workflowExecutions/{workflowExecutionId}/downloadUrls. Detailed instructions are here.\n"," Are there any quotas on workflow executions?\n"," AMC has limits on the concurrency of workflow executions. Currently, the following limits are applied:\n","10 workflow executions can run in parallel at the instance level for API  10 workflow executions can run in parallel at the instance level for UI  200 workflow executions can run in parallel at the account level for API \\* 50 workflow executions can run in parallel at the account level for UI\n"," Note that, at the account level, there is no limit to the number of workflow executions queued. For example, at any given point, an account can run a maximum of 200 workflow executions running concurrently from the multiple instances associated with it, and have any number of workflow executions from instances queued for processing.\n"," How do I handle \"data gaps\" in my query date ranges?\n"," AMC has introduced a new Data Availability Service Level Agreement (SLA) of 48 hours. This SLA guarantees that for all AMC instances, data will be available within 48 hours of its creation or update in the origin system, making the previous \"Ignore data gaps\" option redundant.\n"],"documentType":"guide"},{"title":"FAQs","sectionHeader":{"type":3,"text":"Audiences APIs"},"path":"/en-us/guides/amazon-marketing-cloud/faqs","content":[" What is advertiser audiences API?\n"," The advertiser audiences API allows users to stream advertiser first-party audience lists to AMC and Amazon DSP. Using rule-based audiences and lookalike audiences, you can create custom audiences using signals in AMC.\n"," How is the advertiser audience API different from the advertiser data upload API?\n"," Compared to the existing advertiser data upload API, this new API provides pre-defined audience schema tailored to audience retargeting or audience insight use cases.\n"," Key benefits of using the new API for audiences:\n","Follows industry-standard conventions for creating first-party audiences, similar to the method used by other publishers.  Allows users the option to send hashed records to both AMC and Amazon DSP.  Allows ingression of signals from any destination, without having to go through S3 buckets. \\* Supports incremental refresh (add / move members) instead of full refresh; this helps to reduce processing latency as a result.\n"," Who should / when should I choose to use the advertiser audience API?\n"," Advertiser audience API is best for SaaS providers like CDPs, as well as agencies, or consultancies that would like to build \"always on\" advertiser data upload integrations. Direct advertisers who are willing to build and maintain an API integration with Amazon Ads can use this API as well.\n"," However, if you expect to bring in first-party signals on sales, conversions, or other topic not related to audience, or only plan to upload data on an ad hoc basis, we recommend that you use advertiser data upload API instead.\n"],"documentType":"guide"},{"title":"FAQs","sectionHeader":{"type":3,"text":"Advertiser data upload API"},"path":"/en-us/guides/amazon-marketing-cloud/faqs","content":[" How is advertiser data upload API different from other data onboarding mechanisms of Amazon ad tech?\n"," Detailed comparison across different onboarding mechanisms listed in the table below. The \"Best for\" row summarizes the scenario each onboarding option is suitable for.\n"," How is advertiser provided data handled in AMC?\n"," AMC is the Amazon Ads clean room product. Each AMC user is provided with one or more AMC instances within an account for them to access. Each instance has isolated data from one another, meaning dataSets within each instance are independent and may have different rows from another instance. This applies both to the Advertiser Data loaded through the AMC Advertiser Data Upload (ADU) APIs, as well as the standard dataSets made available in your AMC instance from Amazon Ads.\n"," AMC supports AWS Key Management Service (KMS) encryption to further secure the data you would like to upload. The benefit of using a customer generated encryption key is the ability to revoke access of AMC to previously uploaded data at any point. In addition, customers can monitor encryption key access via AWS CloudTrail event logs. Details on how to create an encryption key with AWS KMS can be found here.\n"," How does AMC identity resolution work?\n"," AMC supports three types of identifiers for resolution:\n","Hashed PII (with 8 fields for resolution) 2. Mobile Ad IDs (IDFA and AAID) 3. External IDs provided by our identity onboarding partners.\n"," We do not support cookie-based or IP address-based resolution. When using Hashed PII or Mobile Ad ID based resolution, we perform a deterministic resolution process. This means that we only create a record with a resolved user_id when we find an exact pairing between the advertiser data provided and the Amazon identity data. Once resolved, we drop all hashed PII or MAID values from the advertiser uploaded data and retain only a reference to the resolved Amazon rows.\n"," How do I improve my match rates?\n"," Amazon Ads uses a waterfall match which resolves uploaded records to Amazon Ads users by evaluating against most precise rules to least precise. Including as many supported matching keys (Hashed PII fields, MAID, or ExternalId) in a given upload request will result in higher match rates (Individual APIs may support fewer IDs than our overall supported IDs).\n"," Some best practices include:\n","Provide multiple supported match key types / fields.  If one match type has multiple values, load them as one array vs. individual records.  Make sure you normalize and hash the key in correct format as recommended by Amazon. \\* If you use any 3rd party identity resolution services such as Acxiom and LiveRamp, use these services to augment the match.\n"," Specifically:\n","Advertisers using instance-level ADU API (ADU 1.0) need to specify countryCode at upload-level.  Advertisers using updated gateway ADU API (ADU 2.0) need to specify countryCode at row-level, upload-level, or dataset-level.  Advertisers using Advertiser Audience API need to specify countryCode at row-level or dataset-level.\n"," Starting 2/29, for data uploaded to AMC without countryCode info specified, the countryCode field will be left blank by default, signaling the system to not utilize the records during identity resolution. This will negatively impact record resolution rate, and lower the usability of the data you uploaded. The countryCode specification requirements will not impact data uploaded prior to 2/29. We strongly encourage all advertisers using ADU or Advertiser Audience API to start specifying countryCode as soon as possible in all uploads from now on to prevent experiencing negative outcomes described above.\n"," How do I delete data based on my compliance or business needs?\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/overview","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"What is Amazon Marketing Stream Version 2?"},"path":"/en-us/guides/amazon-marketing-stream/v2/overview","content":[" Amazon Marketing Stream Version 2 (Stream v2) is the primary programmatic reporting surface for Amazon Ads customers, including tool providers, agencies, and direct advertisers. It delivers the metrics and dimensions the Reporting API exposes, unified across all Amazon Ads products, so you consolidate your reporting onto a single surface instead of running a pipeline per product. Stream v2 writes the data to an Amazon S3 bucket you own as Apache Parquet files, with an SQS notification as each file lands, so you query it in place with your own AWS tools and build workflows on it as soon as it lands. Each record carries the total value for its time window, not a change since the last delivery, and a restated record is re-delivered with its new total. A new subscription starts with your entire historical data for the dataset's restatement period.\n"," Version 2 is the recommended choice for new integrations. When you are ready to set up your first subscription, see Get started. If you already use Version 1, see Migrate from Version 1.\n"," Jump to How it works | Key features | What's new compared with Version 1 | Is Amazon Marketing Stream right for me? | Geographic availability\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"How it works"},"path":"/en-us/guides/amazon-marketing-stream/v2/overview","content":[" Stream v2 delivers each batch of your data as Apache Parquet files to an S3 bucket you own, and sends one or more SQS notifications naming the files as they land. Read those files with any Parquet engine, inside or outside AWS. To build a current view, process the files each notification lists, keep the highest streamBatch.version per record in a staging layer, and reduce to your reporting grain. See Process your data for the full consumer model.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Key features"},"path":"/en-us/guides/amazon-marketing-stream/v2/overview","content":["Reporting API coverage — Stream v2 delivers the base metrics and dimensions the Reporting API exposes. - Unified across all Ads products — One integration spans every Amazon Ads product on a single data model — no per-product pipelines, no manual consolidation. - Fresh data — Stream v2 delivers updated data on a recurring basis. The delivery cadence varies by dataset; see your dataset guide for its cadence. - Historical data — When you create a subscription, Stream v2 delivers your entire historical data for the dataset's restatement period, within about a day of activation. - Total values — Each record carries the total value for its time window, not a change since the last delivery. Stream v2 delivers only the records that changed; when a record is restated, you receive it again with its new total. - No infrastructure to run — Data lands directly in your Amazon S3 bucket. There is no streaming pipeline to provision, scale, or maintain, and no intermediate service to move data into storage. - One destination for every dataset — A single S3 bucket and SQS queue receives every dataset you subscribe to, so you manage one set of permissions instead of one per dataset.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"What's new compared with Version 1"},"path":"/en-us/guides/amazon-marketing-stream/v2/overview","content":["| Aspect | Version 1 (deprecated) | Version 2 |\n","\\|---\\|---\\|---\\|\n","| Delivery destination | Amazon Data Firehose stream or SQS queue | Amazon S3 bucket with an SQS notification queue |\n","| Data format | JSON | Apache Parquet files |\n","| Delivery model | Delta values per time window (incremental changes). You apply each delta to a prior value, so history is hard to reconstruct without a baseline | Total values per time window. Each record is the complete current value, so you need no baseline, and Stream v2 delivers only the records that changed (Data delivery) |\n","| Deduplication | Client dedupes on idempotency_id | Client deduplicates at the record level, keeping the highest streamBatch.version per record key (Data delivery) |\n","| Permissions | A separate IAM policy per dataset and Region on the destination | One set of destination permissions covers all datasets |\n","| Delivery frequency | Hourly | As frequently as every 15 minutes |\n","| Status workflow | PROVISIONING → PENDING_CONFIRMATION → ACTIVE → SUSPENDED or ARCHIVED for SQS destinations.Firehose destinations skip confirmation: PROVISIONING → ACTIVE → SUSPENDED or ARCHIVED. | ACTIVE on creation, then SUSPENDED or ARCHIVED — no provisioning or confirmation step |\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Is Amazon Marketing Stream right for me?"},"path":"/en-us/guides/amazon-marketing-stream/v2/overview","content":["| Use case | I want to... | Recommended solution |\n","\\|---\\|---\\|---\\|\n","| Build responsive applications | Access raw, low-grain data to store in my own systems to power dashboards, analytics, or machine learning models | Use Stream v2. |\n","| Intraday optimization | Adjust bids, budgets, or campaigns throughout the day using fresh performance data | Use Stream v2. |\n","| Real-time dashboards | Keep internal systems and dashboards aligned with Amazon Ads metrics throughout the day | Use Stream v2. |\n","| Large-scale reports | Manage data across multiple brands or thousands of accounts without throttling or delays | Use Stream v2. |\n","| AI and predictive modeling | Use ads performance data for modeling, forecasting, or anomaly detection | Use Stream v2. |\n","| Simplify infrastructure | Consolidate reporting pipelines into one surface with consistent datasets and metrics | Use Stream v2. |\n","| Predefined stakeholder-ready reports | Generate specific reports with predefined metrics and dimensions ready for stakeholder use, without additional transformation | Use the reporting API v1. |\n","| Periodic or scheduled reporting | Refresh performance summaries daily, weekly, or monthly to track trends over time | Use the reporting API v1. |\n","| Interactive data exploration | Browse, filter, and visualize reports directly within the Ads Console | Use Ads Console Reports. |\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Geographic availability"},"path":"/en-us/guides/amazon-marketing-stream/v2/overview","content":[" Stream v2 is available worldwide and delivers your global account data regardless of Region — Region applies only to where you call the API and create your destination, not to the data you receive.\n","API endpoint — the Amazon Ads API host you send requests to. - AWS Region (destination) — the Region where you create your destination (the S3 bucket and notification SQS queue). This is not the API endpoint. The S3 bucket and SQS queue must be in the same Region. EU and FE support more than one destination Region; choose one.\n","| Region | API endpoint | AWS Region (destination) |\n","\\|---\\|---\\|---\\|\n","| NA | https&#x3A;//advertising-api.amazon.com | us-east-1 |\n","| EU | https&#x3A;//advertising-api-eu.amazon.com | eu-west-1, eu-west-2, eu-south-2 |\n","| FE | https&#x3A;//advertising-api-fe.amazon.com | us-west-2, ap-southeast-1 |\n"," Destination region rules and setup steps are on Set up your destination.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/overview","content":[],"documentType":"guide"},{"title":"Migrate from Version 1","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/migrate-from-v1","content":[" This guide moves an existing Amazon Marketing Stream Version 1 (Stream v1) integration to Amazon Marketing Stream Version 2 (Stream v2). It maps your Stream v1 datasets to their Stream v2 equivalents and orders the steps; each step links to the page that documents it in full. For what changed between the versions, see the comparison in the Stream v2 overview.\n"],"documentType":"guide"},{"title":"Migrate from Version 1","sectionHeader":{"type":2,"text":"Before you start"},"path":"/en-us/guides/amazon-marketing-stream/v2/migrate-from-v1","content":["A working Stream v1 integration, and a list of the Stream v1 datasets you subscribe to today. - Amazon Ads API access for the advertiser accounts you want to migrate.\n"],"documentType":"guide"},{"title":"Migrate from Version 1","sectionHeader":{"type":2,"text":"Map your datasets"},"path":"/en-us/guides/amazon-marketing-stream/v2/migrate-from-v1","content":[" Stream v2 consolidates the ad-product-specific Stream v1 datasets into standardized reporting datasets. Use this mapping to decide which Stream v2 datasets to subscribe to.\n","| Stream v1 dataset | Stream v2 dataset | Notes |\n","\\|---\\|---\\|---\\|\n","| Amazon DSP performance | ads-performance-v1 | The rows where adProduct.value = 'Amazon DSP'. |\n","| Sponsored Products performance | ads-performance-v1 | The rows where adProduct.value = 'Sponsored Products'. |\n","| Sponsored Display performance | ads-performance-v1 | The rows where adProduct.value = 'Sponsored Display'. |\n","| Sponsored Brands performance | ads-performance-v1 | The rows where adProduct.value = 'Sponsored Brands'. |\n"," One Stream v2 dataset, ads-performance-v1, replaces all four Stream v1 performance datasets. Subscribe once and filter on adProduct.value for the ad product you want, instead of maintaining a subscription per ad product.\n"],"documentType":"guide"},{"title":"Migrate from Version 1","sectionHeader":{"type":2,"text":"Migration steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/migrate-from-v1","content":[" Run Stream v2 alongside your Stream v1 integration and validate before you retire anything, so there is no gap in your data.\n","Set up a Stream v2 destination. Create the S3 bucket and SQS queue and grant Stream access. See Set up your destination. 2. Create a Stream v2 subscription for ads-performance-v1. See Create a subscription. 3. Integrate the Stream v2 delivery model. Read the Parquet files and process the notifications, keeping the highest streamBatch.version per record. See Data delivery and Process your data. 4. Build a resilient consumer. Breaking changes ship as a new dataset version and non-breaking additions land in the current version, so follow the consumer rules to keep your integration working as datasets evolve. See Build a resilient consumer. 5. Validate against Stream v1. With both integrations running in parallel, confirm your Stream v2 totals reconcile with what Stream v1 reports for the same time windows. 6. Retire your Stream v1 subscriptions. Once you validate your Stream v2 data, archive the Stream v1 subscriptions for Amazon DSP, Sponsored Products, Sponsored Display, and Sponsored Brands performance. Keep Stream v1 running until then.\n"],"documentType":"guide"},{"title":"Migrate from Version 1","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/migrate-from-v1","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"What are the Version 2 datasets?"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":[" Amazon Marketing Stream Version 2 delivers reporting datasets — standardized advertising data that follows the same metric and dimension naming as the Amazon Ads reporting API. For the data-semantics changes this naming brings, see What has changed in the new reporting API. Each dataset consolidates data across ad products rather than splitting it by ad product, so a single dataset covers Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, and Amazon DSP. Each dataset carries a version in its identifier, such as ads-performance-v1, and you subscribe to the datasets whose content matches your need.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Reporting datasets"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":["| Dataset ID | Grain | NA | EU | FE | Documentation | Subscription endpoint |\n","\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|\n","| ads-performance-v1 | Hourly | x | x | x | Ads performance | POST /adsApi/v1/create/streamSubscriptions |\n","| ads-converted-product-v1 | Daily | x | x | x | Ads converted product | POST /adsApi/v1/create/streamSubscriptions |\n"," The region columns show where each dataset is available. A subscription itself is global — see Geographic availability.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"How the datasets work"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":[" Every Version 2 dataset shares the same delivery model, so the behavior below applies to all of them. Each dataset page states only what is specific to that dataset — its grain, its schema, and which of its dimensions are subject to reporting thresholds.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Records and versioning"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":[" Records are keyed by their dimension fields: the set of dimension values in a record identifies it. Each record carries a streamBatch.version, and the current state of a record is the row with the highest version for that key. Stream delivers only the records that changed since the last delivery, so a delivery is a set of inserts and updates, not a full snapshot. Use the dimension fields as your upsert key and keep the highest-version row per key.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Restatement"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":[" Records can be restated after first delivery as attribution data matures. A restated record arrives as a new version of the same key. Each dataset defines a restatement window — the period during which a record can still change — in its dataset specifications. Treat a record as final only after its window has passed.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Reporting thresholds"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":[" To protect customer privacy, Amazon Ads applies reporting thresholds to high-cardinality dimensions. When activity for a dimension value does not meet the minimum threshold, that value is not reported on its own; its metrics are grouped into a row with value (Other) for that dimension field at that grain. Thresholds are evaluated at the exact level of detail in your data, so the same value can be reported on its own at one aggregation level and grouped into (Other) at a more granular level. Totals stay complete: the sum of all rows at a grain, including (Other), matches the totals at coarser grains. Each dataset page lists which of its dimensions are subject to thresholds.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Aggregating to a coarser grain"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":[" Because a record is keyed by its dimensions and any fine-grain record can be restated, a single update changes the aggregate at every coarser grain. To report at a grain coarser than the delivered record key, maintain a record-level staging layer: an intermediate store holding the latest version of every fine-grain record, kept current by upserting each delivered record on its key and keeping the highest streamBatch.version. Aggregate from the staging layer to your grain.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Data types"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":[" Each field declares one of four data types, delivered in the Parquet physical types below. If you register the data in AWS Glue and query it with Amazon Athena, the Glue column shows the type each one maps to.\n","| Data type | Parquet physical type | AWS Glue type (Athena) |\n","\\|---\\|---\\|---\\|\n","| STRING | BYTE_ARRAY (logical: String) | string |\n","| LONG | INT64 (no logical annotation) | bigint |\n","| DECIMAL | INT64 (logical: Decimal, precision=18, scale=8) | decimal(18,8) |\n","| CURRENCY | INT64 (logical: Decimal, precision=18, scale=8) | decimal(18,8) |\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Dataset changes"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":[" Each dataset carries a version in its identifier. When a change would break an existing integration, Stream introduces it as a new dataset version rather than changing the existing one, so you can adopt the new version on your own schedule. Non-breaking additions can appear in the current version. Changes are announced in the release notes. To handle these changes without breaking your integration, follow the rules in Build a resilient consumer.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/overview","content":[],"documentType":"guide"},{"title":"Ads performance","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":[" The Ads performance dataset (ads-performance-v1) delivers advertising campaign performance across Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, and Amazon DSP in one dataset. It reports traffic delivery (impressions, clicks, viewability), engagement (video and audio ad interactions), costs and fees, and attributed conversions (on-Amazon retail, off-Amazon, device, and video). It consolidates the performance data that Version 1 delivered as separate ad-product datasets, so you subscribe once instead of maintaining a subscription per ad product.\n"," The dataset consolidates the data previously spread across the Version 3 report types — campaign, ad group, ad, advertised product, search term, targeting, placement, inventory, geography, and technology — into one schema. Its metrics and dimensions follow the naming used by the Amazon Ads reporting API and downloadable reports.\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":2,"text":"Use this dataset to"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":["Monitor campaign performance across the full customer journey, from ad delivery through engagement to conversion. - Analyze performance at granular dimensions, including supply source, placement, geography, technology, targeting, and conversion source. - Reconcile cross-product performance — Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored TV, and Amazon DSP — in one view. - Work with hourly data for intra-day optimization.\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":2,"text":"What you can measure"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":[" The dataset covers three categories of data.\n","Traffic — delivery of ads. The activity ads generate, such as impressions, clicks, and views, along with advertiser spend and fees. Traffic shows how often ads are served and interacted with, not the depth of the interaction or whether the shopper took further action. - Engagement — interest in the ad. How shoppers interact with an ad: media controls (pausing, replaying, or completing a video), enabling features (unmuting), and interactive extensions (scanning a QR code or responding through Alexa). Engagement shows how shoppers interacted with the ad, not whether they converted. - Attributed conversions — outcomes from ads. Conversions credited to one or more ads a shopper interacted with before completing the action — purchases, subscriptions, and app installs, and events on the path to those outcomes. With traffic and engagement, conversions show whether advertising led to the outcome.\n"," The dataset does not include calculated metrics such as ROAS or CTR. Compute those from the base metric fields in the dataset after aggregating the data to your desired grain.\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":2,"text":"Dataset specifications"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":["| Property | Value |\n","\\|---\\|---\\|\n","| Stream dataset ID | ads-performance-v1 |\n","| Grain | Hourly |\n","| Supported account types | Global Account, Amazon DSP (ADSP) Regional Account |\n","| Accounts per subscription | One |\n","| Restatement window | 70 days |\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":2,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":[" The dataset delivers the following metadata, dimension, and metric fields. Data types are STRING, LONG, DECIMAL, or CURRENCY. Read each field at its declared type or wider, and tolerate fields you do not recognize — see Build a resilient consumer.\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":3,"text":"Metadata fields"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":["| Field name | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Stream batch | streamBatch.version | LONG | Tracks updates to a record; the highest value is the most recent. |\n","| Stream dataset | streamDataset.id | STRING | The unique ID associated with the Stream dataset. |\n","| Stream subscription | streamSubscription.id | STRING | The unique ID associated with the Stream subscription. |\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":3,"text":"Dimension fields"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":[" Dimension fields form the record key. Use every dimension field marked in your subscription's schema as the upsert key when you write records.\n","| Category | Dimension | Field ID | Data type | Applicable ad product(s) | Description |\n","\\|---\\|---\\|---\\|---\\|---\\|---\\|\n","| Currency | Budget currency | budgetCurrency.value | STRING | ADSP, SB, SD, SP, ST | The currency in which the advertising spend was made. |\n","| Time | Date | date.value | STRING | ADSP, SB, SD, SP, ST | The date included in the report. |\n","| Time | Hour | hour.value | LONG | ADSP, SB, SD, SP, ST | The hour of the day associated with the report. |\n","| Level of detail | Advertiser account | advertiserAccount.id | STRING | ADSP, SB, SD, SP, ST | The unique ID associated with the advertiser account. |\n","| Level of detail | Advertiser account alternate profile id | advertiserAccountAlternateProfileId.value | STRING | SB, SD, SP, ST | The Profile ID that represents the advertiser account in legacy Amazon Ads APIs. |\n","| Level of detail | Advertiser account alternate dsp advertiser id | advertiserAccountAlternateDspAdvertiserId.value | STRING | ADSP | The DSP Advertiser ID that represents the advertiser account in legacy Amazon Ads APIs. |\n","| Level of detail | Ad product | adProduct.value | STRING | ADSP, SB, SD, SP, ST | The Amazon ad product like Sponsored Products, Sponsored Brands, or Amazon DSP |\n","| Level of detail | Insertion order | insertionOrder.id | STRING |  | The ID associated with the insertion order. An insertion order is a contractual agreement between an advertiser and Amazon Ads. |\n","| Level of detail | Campaign | campaign.id | STRING | ADSP, SB, SD, SP, ST | The unique ID associated with the campaign. |\n","| Level of detail | Flight | flight.id | STRING | ADSP | The unique ID associated with a specific campaign flight to track and manage campaign delivery. |\n","| Level of detail | Ad group | adGroup.id | STRING | ADSP, SB, SD, SP, ST | The unique ID associated with the ad group. |\n","| Level of detail | Ad | ad.id | STRING | ADSP, SB, SD, SP, ST | The unique ID associated with the ad. |\n","| Product | Advertised product | advertisedProduct.id | STRING | SB, SD, SP, ST | The unique identifier of the product featured in the ad. |\n","| Product | Advertised product marketplace | advertisedProductMarketplace.value | STRING | ADSP, SD, SP | The marketplace where the advertised product is sold. |\n","| Product | Advertised product sku | advertisedProductSku.value | STRING | ADSP, SD, SP | The SKU (stock keeping unit) assigned to the product featured in the ad. |\n","| Supply | Supply source | supplySource.name | STRING | ADSP | The inventory the campaign ran on like real-time bidding exchanges or Amazon-owned sites. |\n","| Supply | Site app | siteApp.value | STRING | ADSP, SP | The app or websites where the campaign was run. |\n","| Supply | Placement | placement.name | STRING | ADSP | The name of the placement on which the campaign was run. |\n","| Supply | Placement size | placementSize.value | STRING | ADSP | The dimensions of the placement in pixels. |\n","| Supply | Placement classification | placementClassification.value | STRING | SB, SD, SP, ST | The classification of ad placements into categories like top of search, gateway page, etc. |\n","| Supply | Deal | deal.id | STRING | ADSP | The unique ID associated with the deal. |\n","| Supply | Content genre | contentGenre.value | STRING | ADSP | The genre of the video or audio. |\n","| Supply | Content rating | contentRating.value | STRING | ADSP | The rating of the video or audio like content suitable for teens and older audiences. |\n","| Supply | Content type | contentType.value | STRING | ADSP | The type of the video or audio like movie, tv show, game, etc. |\n","| Supply | Content title | contentTitle.value | STRING | ADSP | The name of the video or audio. |\n","| Supply | Content creator | contentCreator.name | STRING | ADSP | The name of content creator on whose channel an ad is shown. |\n","| Supply | Live event property | liveEventProperty.value | STRING | ADSP | The rights package, league, or content property associated with the live event inventory. |\n","| Supply | Live event | liveEvent.id | STRING | ADSP | The identifier for the live event or program against which the ad was delivered. |\n","| Supply | Live event | liveEvent.name | STRING | ADSP | The name of the live event or program against which the ad was delivered. |\n","| Supply | Live event inventory type | liveEventInventoryType.value | STRING | ADSP | The type or segment code of the ad break within the live event. |\n","| Supply | Live event ad break | liveEventAdBreak.order | STRING | ADSP | The order of the ad break within the live event schedule. |\n","| Supply | Live event ad slot | liveEventAdSlot.order | STRING | ADSP | The order of the ad slot within the live event ad break. |\n","| Supply | Live event ad slot | liveEventAdSlot.type | STRING | ADSP | The sales model for the live-event ad slot. |\n","| Supply | Ad break position | adBreakPosition.value | STRING | ADSP | The location where the ad was shown like beginning (pre-roll), middle (mid-roll), or end (post-roll). |\n","| Supply | Video placement type | videoPlacementType.value | STRING | ADSP | The type of the video placement like in-stream, accompanying content, interstitial, or out-stream (no content/standalone). |\n","| Supply | Video player size | videoPlayerSize.value | STRING | ADSP | The size of the video player like small, medium, large, or unknown. |\n","| Technology | Operating system | operatingSystem.value | STRING | ADSP | The operating system used by the customer to view the ad. |\n","| Technology | Browser name | browserName.value | STRING | ADSP | The browser used by the customer to view the ad. |\n","| Technology | Browser version | browserVersion.value | STRING | ADSP | The version of the browser used by the customer to view the ad. |\n","| Technology | Device type | deviceType.value | STRING | ADSP | The device used by the customer to view the ad. |\n","| Technology | Environment | environment.value | STRING | ADSP | The environment used by the customer to view the ad like web or app. |\n","| Geography | Country | country.name | STRING | ADSP | The country where the ad was displayed. |\n","| Geography | Country | country.code | STRING | ADSP | The ISO code of the country where the ad was displayed. |\n","| Geography | Region | region.name | STRING | ADSP | The state or region where the ad was displayed. |\n","| Geography | Dma | dma.id | STRING | ADSP | The unique ID assigned to a DMA®. |\n","| Geography | Dma | dma.name | STRING | ADSP | The DMA® where the ad was displayed. DMA® regions are created and defined by Nielsen. |\n","| Geography | City | city.name | STRING | ADSP | The city where the ad was displayed. |\n","| Geography | Postal code | postalCode.value | STRING | ADSP | The postal code where the ad was displayed. |\n","| Targeting | Ad group target | adGroupTarget.id | STRING | SB, SD, SP, ST | The identifier of the target. |\n","| Targeting | Search term | searchTerm.value | STRING | SB, SP | The search term used by the customer. |\n","| Targeting | Matched target | matchedTarget.value | STRING | SD | The product page where the ad appeared |\n","| Conversion | Conversion source | conversionSource.name | STRING | ADSP, SB, SD, SP, ST | The system or integration that reported conversions to Amazon Ads. |\n","| Conversion | Conversion source | conversionSource.owner | STRING | ADSP, SB, SD, SP, ST | The entity that oversees how conversions from this source are collected and reported. |\n","| Conversion | Conversion source | conversionSource.scaled | STRING | ADSP, SB, SD, SP, ST | This indicates whether the conversion was scaled by the source to represent a larger population. |\n","| Conversion | Conversion source environment | conversionSourceEnvironment.value | STRING | ADSP, SB, SD, SP, ST | The environment used by the shopper to view the ad like web or app. |\n","| Conversion | Conversion source attribution type | conversionSourceAttributionType.value | STRING | ADSP, SB, SD, SP, ST | The organization whose attribution logic is applied to the conversions. |\n","| Delivery | Time zone | timeZone.value | STRING | ADSP, SB, SD, SP, ST | The time zone used by the advertiser for reporting and ad serving purposes. |\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":3,"text":"Metric fields"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":[" Delivery\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Impressions | metric.impressions | LONG | The number of times the ad was displayed. This excludes impressions that were deemed invalid by traffic quality filters. Impressions = gross impressions - invalid impressions |\n","| Impressions | metric.invalidImpressions | LONG | The number of impressions that were removed because they were deemed invalid by traffic quality filters. |\n","| Impressions | metric.mainImdbAdImpressions | LONG | The number of times the main IMDb ad was displayed. |\n","| Clicks | metric.clicks | LONG | The number of times the ad was clicked. This excludes clicks that were deemed invalid by traffic quality filters. Clicks = gross clicks - invalid clicks |\n","| Clicks | metric.grossClicks | LONG | The total number of times the ad was clicked. This can include valid as well as invalid clicks. |\n","| Clicks | metric.invalidClicks | LONG | The number of clicks that were removed because they were deemed invalid by traffic quality filters. |\n","| Clicks | metric.mainImdbAdClicks | LONG | The number of times clicking on the main IMDb ad directed a user outside of the creative. |\n","| Viewability | metric.measurableImpressions | LONG | The number of impressions that could be measured for viewability. |\n","| Viewability | metric.viewableImpressions | LONG | The number of times the ad was viewed. This excludes impressions that were deemed invalid by traffic quality filters. An ad is counted as viewed when at least 50% of the ad shows on screen for at least 1 second for display ads and 2 seconds or longer for video ads. |\n"," Costs and fees\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Costs | metric.supplyCost | CURRENCY | The total amount spent on media supply. |\n","| Costs | metric.totalCost | CURRENCY | The total amount spent on running the campaign. This excludes the third-party fees paid by the agency. |\n","| Costs | metric.rewardGrants | LONG | The number of rewards granted to shoppers who completed a high-value action after engaging with a reward-enabled ad. |\n","| Costs | metric.rewardCost | CURRENCY | The total cost of rewards granted to shoppers who engaged with a reward-enabled ad. |\n","| Fees | metric.agencyFees | CURRENCY | The percentage or flat fees deducted from the total budget to compensate the agency that is managing the media buy. |\n","| Fees | metric.amazonAudienceFees | CURRENCY | The fees that Amazon DSP charges customers to utilize Amazon-enabled targeting. The Amazon audience fee is calculated as a cost per thousand impressions. |\n","| Fees | metric.amazonConsoleFees | CURRENCY | The technology fees that Amazon charges customers to access and use Amazon DSP. This fee is applied to the media supply costs. |\n","| Fees | metric.customFeeBundle | CURRENCY | A single fee charged for the use of multiple Amazon Ads products and services. |\n","| Fees | metric.demandSideFees | CURRENCY | The sum of any billable fees an advertiser pays to use Amazon Ads products. This includes Amazon DSP tech fees, Amazon audience fees, and any third-party fees applied to campaigns. |\n","| Fees | metric.managedServiceFees | CURRENCY | The percentage-based fee applied to the supply cost for Amazon campaign management services. |\n","| Fees | metric.omnichannelMetricFees | CURRENCY | This fee is calculated based on a percentage of the supply cost. |\n","| Fees | metric.totalFees | CURRENCY | The total fees an advertiser pays for their campaigns. This includes the supply cost, third-party fees, and any demand-side fees. |\n","| Third party fees | metric.thirdPartyFeesComscore | CURRENCY | The third party fees for using ComScore. |\n","| Third party fees | metric.thirdPartyFeesComscoreAbsorbed | CURRENCY | The CPM fees for using Comscore. This cost is itemized in reports but absorbed by the user and excluded from total costs. |\n","| Third party fees | metric.thirdPartyFeesCpm1 | CURRENCY | A third-party technology fee. |\n","| Third party fees | metric.thirdPartyFeesCpm1Absorbed | CURRENCY | The CPM fees for using a third-party technology. This cost is itemized in reports but absorbed by the user and excluded from total costs. |\n","| Third party fees | metric.thirdPartyFeesCpm2 | CURRENCY | A third-party technology fee. |\n","| Third party fees | metric.thirdPartyFeesCpm2Absorbed | CURRENCY | The CPM fees for using all third-party technology. This cost is itemized in reports but absorbed by the user and excluded from total costs. |\n","| Third party fees | metric.thirdPartyFeesCpm3 | CURRENCY | The fees for using a third-party data provider. |\n","| Third party fees | metric.thirdPartyFeesCpm3Absorbed | CURRENCY | The CPM fees for using a third-party technology. This cost is itemized in reports but absorbed by the user and excluded from total costs. |\n","| Third party fees | metric.thirdPartyFeesCm360 | CURRENCY | The third-party fees for using Campaign Manager 360 (CM360). |\n","| Third party fees | metric.thirdPartyFeesCm360Absorbed | CURRENCY | The CPM fees for using Campaign Manager 360. This cost is itemized in reports but absorbed by the user and excluded from total costs |\n","| Third party fees | metric.thirdPartyFeesDoubleVerify | CURRENCY | The third-party fees for using DoubleVerify. |\n","| Third party fees | metric.thirdPartyFeesDoubleVerifyAbsorbed | CURRENCY | The CPM fees for using DoubleVerify. This cost is itemized in reports but absorbed by the user and excluded from total costs. |\n","| Third party fees | metric.thirdPartyFeesIas | CURRENCY | The third-party fees for using Integral Ad Science (IAS). |\n","| Third party fees | metric.thirdPartyFeesIasAbsorbed | CURRENCY | The CPM fees for using Integral Ad Science (IAS). This cost is itemized in reports but absorbed by the user and excluded from total costs. |\n","| Third party fees | metric.thirdPartyFees | CURRENCY | The total CPM fees for using third-party data providers. |\n","| Third party fees | metric.thirdPartyPrebidFees | CURRENCY | The fees for using third party pre-bid targeting in Amazon DSP. |\n","| Third party fees | metric.thirdPartyPrebidFeesIas | CURRENCY | The third-party prebid fees for using Integral Ad Science (IAS). |\n","| Third party fees | metric.thirdPartyPrebidFeesOracleDataCloud | CURRENCY | The third-party prebid fees for using OracleDataCloud. |\n","| Third party fees | metric.thirdPartyPrebidFeesDoubleVerify | CURRENCY | The third-party prebid fees for using DoubleVerify. |\n","| Third party fees | metric.thirdPartyPrebidFeesNewsGuard | CURRENCY | The third-party prebid fees for using NewsGuard. |\n","| Third party fees | metric.thirdPartyPrebidFeesPeer39 | CURRENCY | The third-party prebid fees for using Peer39. |\n","| Third party fees | metric.thirdPartyPrebidFeesPixalate | CURRENCY | The third-party prebid fees for using Pixalate. |\n","| Third party fees | metric.thirdPartyPrebidFeesScope3 | CURRENCY | The third-party prebid fees for using Scope3. |\n"," Engagement\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Interaction | metric.interactiveImpressions | LONG | The unique number of impressions from an interactive creative. This can include interactive videos, interactive audios, interactive display creatives, etc. |\n","| Interaction | metric.notificationOpens | LONG | The number of times emails or push notifications were opened per impression. Pre-rendered emails can be counted as opening a notification. |\n","| Interaction | metric.notificationClicks | LONG | The unique number of clicks from an email or push notification per impression. |\n","| Attention video ad | metric.startsVideoAd | LONG | The number of times a video ad was played. |\n","| Attention video ad | metric.firstQuartileVideoAd | LONG | The number of times at least 25% of a video ad was played. If the ad was rewound, we use the total percentage of unduplicated video that was viewed to calculate the completion rate. |\n","| Attention video ad | metric.midpointVideoAd | LONG | The number of times at least 50% of a video ad was played. If the ad was rewound, we use the total percentage of unduplicated video that was viewed to calculate the completion rate. |\n","| Attention video ad | metric.thirdQuartileVideoAd | LONG | The number of times at least 75% of a video ad was played. If the ad was rewound, we use the total percentage of unduplicated video that was viewed to calculate the completion rate. |\n","| Attention video ad | metric.completeViewsVideoAd | LONG | The number of times a video ad was played till the end. If the ad was rewound, we use the total percentage of unduplicated video that was viewed to calculate the completion rate. |\n","| Attention video ad | metric.pausesVideoAd | LONG | The number of times a user paused a video ad. |\n","| Attention video ad | metric.resumesVideoAd | LONG | The number of times a user resumed playing a video ad. |\n","| Attention video ad | metric.mutesVideoAd | LONG | The number of times a user muted a video ad. |\n","| Attention audio ad | metric.startsAudioAd | LONG | The number of times an audio ad was played. |\n","| Attention video ad | metric.unmutesVideoAd | LONG | The number of times a user unmuted a video ad. |\n","| Attention audio ad | metric.firstQuartileAudioAd | LONG | The number of times at least 25% of an audio ad was played. |\n","| Attention video ad | metric.replaysVideoAd | LONG | The number of times a user replayed a video ad. |\n","| Attention audio ad | metric.midpointAudioAd | LONG | The number of times at least 50% of an audio ad was played. |\n","| Attention video ad | metric.skipsBackVideoAd | LONG | The number of times a user skipped back a video ad. |\n","| Attention video ad | metric.skipsForwardVideoAd | LONG | The number of times a user skipped forward a video ad. |\n","| Attention audio ad | metric.thirdQuartileAudioAd | LONG | The number of times at least 75% of an audio ad was played. |\n","| Attention audio ad | metric.completeListensAudioAd | LONG | The number of times an audio ad was played till the end. |\n","| Attention video ad | metric.impressionsVideoAd | LONG | The number of times a video ad was displayed. |\n","| Attention video ad | metric.5secondViewsVideoAd | LONG | The number of times a user watched at least 5 seconds of a video ad or the entire ad if it was shorter than 5 seconds. This is only available for Sponsored Brands video ads. |\n","| Attention audio ad | metric.pausesAudioAd | LONG | The number of times a user paused an audio ad. |\n","| Attention audio ad | metric.resumesAudioAd | LONG | The number of times a user resumed playing an audio ad. |\n","| Attention audio ad | metric.mutesAudioAd | LONG | The number of times a user muted an audio ad. |\n","| Attention audio ad | metric.unmutesAudioAd | LONG | The number of times a user unmuted an audio ad. |\n","| Attention audio ad | metric.rewindsAudioAd | LONG | The number of times a user rewound an audio ad. |\n","| Attention audio ad | metric.skipsAudioAd | LONG | The number of times a user skipped an audio ad. |\n","| Attention audio ad | metric.impressionsAudioAd | LONG | The number of times an audio ad was served. |\n","| Attention audio ad | metric.playsAudioAd | LONG | The number of times an audio ad was played for 2 seconds or longer. |\n","| Attention audio ad | metric.progressAudioAd | LONG | The number of times an audio ad was played until the time marker assigned by the publisher. |\n"," Amazon retail conversions\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Purchases | metric.purchases | LONG | The number of purchases attributed to an ad interaction. |\n","| Purchases | metric.multiTouchPurchases | DECIMAL | The number of purchases attributed to an ad interaction. This is measured using multi-touch attribution. |\n","| Purchases | metric.sales | CURRENCY | The sales from purchases attributed to an ad interaction. |\n","| Purchases | metric.multiTouchSales | CURRENCY | The sales from purchases attributed to an ad interaction. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSold | LONG | The number of product units in purchases attributed to an ad interaction. A single purchase event can include multiple units of the same product. |\n","| Purchases | metric.multiTouchUnitsSold | DECIMAL | The number of product units in purchases attributed to an ad interaction. A single purchase event can include multiple units of the same product. This is measured using multi-touch attribution. |\n","| Purchases | metric.purchasesFromClicks | LONG | The number of purchases attributed to an ad click. |\n","| Purchases | metric.multiTouchPurchasesFromClicks | DECIMAL | The number of purchases attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesFromClicks | CURRENCY | Sales from purchases attributed to an ad click. |\n","| Purchases | metric.multiTouchSalesFromClicks | CURRENCY | Sales from purchases attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSoldFromClicks | LONG | The number of product units in purchases attributed to an ad click. A single purchase event can include multiple units of the same product. |\n","| Purchases | metric.multiTouchUnitsSoldFromClicks | DECIMAL | The number of product units in purchases attributed to an ad click. A single purchase event can include multiple units of the same product. This is measured using multi-touch attribution. |\n","| Purchases | metric.purchasesFromViews | LONG | The number of purchases attributed to an ad view. |\n","| Purchases | metric.multiTouchPurchasesFromViews | DECIMAL | The number of purchases attributed to an ad view. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesFromViews | CURRENCY | The sales from purchases attributed to an ad view. |\n","| Purchases | metric.multiTouchSalesFromViews | CURRENCY | The sales from purchases attributed to an ad view. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSoldFromViews | LONG | The number of product units in purchases attributed to an ad view. A single purchase event can include multiple units of the same product. |\n","| Purchases | metric.multiTouchUnitsSoldFromViews | DECIMAL | The number of product units in purchases attributed to an ad view. A single purchase event can include multiple units of the same product. This is measured using multi-touch attribution. |\n","| Purchases | metric.purchasesPromoted | LONG | The number of purchases for products that were directly promoted in the campaign. |\n","| Purchases | metric.multiTouchPurchasesPromoted | DECIMAL | The number of purchases for products that were directly promoted in the campaign. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesPromoted | CURRENCY | The sales from products that were directly promoted in the campaign. |\n","| Purchases | metric.multiTouchSalesPromoted | CURRENCY | The sales from products that were directly promoted in the campaign. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSoldPromoted | LONG | The number of units sold for products that were directly promoted in the campaign. A single purchase can include multiple units of the same product. |\n","| Purchases | metric.multiTouchUnitsSoldPromoted | DECIMAL | The number of units sold for products that were directly promoted in the campaign. A single purchase can include multiple units of the same product. This is measured using multi-touch attribution. |\n","| Purchases | metric.purchasesFromClicksPromoted | LONG | The number of purchases for products that were directly promoted in the campaign, attributed to an ad click. |\n","| Purchases | metric.multiTouchPurchasesFromClicksPromoted | DECIMAL | The number of purchases for products that were directly promoted in the campaign, attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesFromClicksPromoted | CURRENCY | The sales from products that were directly promoted in the campaign, attributed to an ad click. |\n","| Purchases | metric.multiTouchSalesFromClicksPromoted | CURRENCY | Sales from purchases for products that were directly promoted in the campaign, attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSoldFromClicksPromoted | LONG | The number of units sold for products that were directly promoted in the campaign, attributed to an ad click. |\n","| Purchases | metric.multiTouchUnitsSoldFromClicksPromoted | DECIMAL | The number of units in purchases for products that were directly promoted in the campaign, attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases | metric.purchasesFromViewsPromoted | LONG | The number of purchases for products that were directly promoted in the campaign, attributed to an ad view. |\n","| Purchases | metric.multiTouchPurchasesFromViewsPromoted | DECIMAL | The number of purchases for products that were directly promoted in the campaign, attributed to an ad view. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesFromViewsPromoted | CURRENCY | The sales from products that were directly promoted in the campaign, attributed to an ad view. |\n","| Purchases | metric.multiTouchSalesFromViewsPromoted | CURRENCY | Sales from purchases for products that were directly promoted in the campaign, attributed to an ad view. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSoldFromViewsPromoted | LONG | The number of units in purchases for products that were directly promoted in the campaign, attributed to an ad view. A single purchase can include multiple units of the same product. |\n","| Purchases | metric.multiTouchUnitsSoldFromViewsPromoted | DECIMAL | The number of units in purchases for products that were directly promoted in the campaign, attributed to an ad view. A single purchase can include multiple units of the same product. This is measured using multi-touch attribution. |\n","| Purchases | metric.purchasesHalo | LONG | The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Purchases | metric.multiTouchPurchasesHalo | DECIMAL | The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesHalo | CURRENCY | The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Purchases | metric.multiTouchSalesHalo | CURRENCY | The sales from purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSoldHalo | LONG | The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Purchases | metric.multiTouchUnitsSoldHalo | DECIMAL | The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. This is measured using multi-touch attribution. |\n","| Purchases | metric.purchasesFromClicksHalo | LONG | The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Purchases | metric.multiTouchPurchasesFromClicksHalo | DECIMAL | The number of purchases for highly relevant products that were not directly promoted, attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesFromClicksHalo | CURRENCY | The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Purchases | metric.multiTouchSalesFromClicksHalo | CURRENCY | The sales from purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases new to brand | metric.newToBrandPurchases | LONG | The number of purchases by shoppers who had not purchased a product from the brand in the last 12 months. |\n","| Purchases new to brand | metric.newToBrandSales | CURRENCY | The sales from shoppers who had not purchased a product from the brand in the last 12 months. |\n","| Purchases | metric.unitsSoldFromClicksHalo | LONG | The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Purchases | metric.multiTouchUnitsSoldFromClicksHalo | DECIMAL | The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases new to brand | metric.newToBrandUnitsSold | LONG | The number of product units purchased by shoppers who had not purchased from the brand in the last 12 months. |\n","| Purchases | metric.purchasesFromViewsHalo | LONG | The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Purchases | metric.multiTouchPurchasesFromViewsHalo | DECIMAL | The number of purchases from highly relevant products that were not directly promoted in the campaign, attributed to an ad view. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesFromViewsHalo | CURRENCY | The sales from purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Purchases | metric.multiTouchSalesFromViewsHalo | CURRENCY | The sales from purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSoldFromViewsHalo | LONG | The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad view . |\n","| Purchases | metric.multiTouchUnitsSoldFromViewsHalo | DECIMAL | The number of units in purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. This is measured using multi-touch attribution. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromClicks | LONG | The number of purchases by shoppers who had not purchased a product from the brand in the last 12 months, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandSalesFromClicks | CURRENCY | The sales from shoppers who had not purchased from the brand in the last 12 months, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandUnitsSoldFromClicks | LONG | The number of product units purchased by shoppers who had not purchased from the brand in the last 12 months, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromViews | LONG | The number of purchases by shoppers who had not purchased a product from the brand in the last 12 months, attributed to an ad view. |\n","| Purchases new to brand | metric.newToBrandUnitsSoldFromViews | LONG | The number of product units purchased by shoppers who had not purchased from the brand in the last 12 months, attributed to an ad view. |\n","| Purchases new to brand | metric.newToBrandSalesFromViews | CURRENCY | Sales by shoppers who had not purchased from the brand in the last 12 months, attributed to an ad view. |\n","| Purchases new to brand | metric.newToBrandPurchasesPromoted | LONG | The number of purchases from new-to-brand shoppers for products directly promoted in the campaign. |\n","| Purchases new to brand | metric.newToBrandSalesPromoted | CURRENCY | The sales from products that were directly promoted in the campaign by new-to-brand shoppers. |\n","| Purchases new to brand | metric.newToBrandUnitsSoldPromoted | LONG | The number of units sold to new-to-brand shoppers for products that were directly promoted in the campaign. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromClicksPromoted | LONG | The number of purchases from new-to-brand shoppers for products directly promoted in the campaign, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandSalesFromClicksPromoted | CURRENCY | The sales from products that were directly promoted in the campaign by new-to-brand shoppers, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandUnitsSoldFromClicksPromoted | LONG | The number of units sold for promoted products to new-to-brand shoppers, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromViewsPromoted | LONG | The number of purchases from new-to-brand shoppers for products directly promoted in the campaign, attributed to an ad view. |\n","| Purchases new to brand | metric.newToBrandSalesFromViewsPromoted | CURRENCY | The sales from products that were directly promoted in the campaign by new-to-brand shoppers, attributed to an ad view. |\n","| Purchases new to brand | metric.newToBrandUnitsSoldFromViewsPromoted | LONG | The number of units sold for promoted products to new-to-brand shoppers, attributed to an ad view. |\n","| Purchases new to brand | metric.newToBrandPurchasesHalo | LONG | The number of times new-to-brand shoppers purchased a highly relevant product that was not directly promoted in the campaign. |\n","| Purchases new to brand | metric.newToBrandSalesHalo | CURRENCY | The sales from highly relevant products that were not directly promoted in the campaign by new-to-brand shoppers. |\n","| Purchases new to brand | metric.newToBrandUnitsSoldHalo | LONG | The number of units sold for highly relevant products that were not directly promoted in the campaign to new-to-brand shoppers. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromClicksHalo | LONG | The number of highly relevant product purchases that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandSalesFromClicksHalo | CURRENCY | The sales from highly relevant products that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandUnitsSoldFromClicksHalo | LONG | The number of units sold for highly relevant products that were not directly promoted in the campaign to new-to-brand shoppers, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromViewsHalo | LONG | The number of highly relevant product purchases that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad view. |\n","| Purchases new to brand | metric.newToBrandSalesFromViewsHalo | CURRENCY | The sales from highly relevant products that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad view. |\n","| Purchases new to brand | metric.newToBrandUnitsSoldFromViewsHalo | LONG | The number of units sold for highly relevant products that were not directly promoted in the campaign to new-to-brand shoppers, attributed to an ad view. |\n","| Detail page views | metric.detailPageViews | LONG | The number of detail page views attributed to an ad interaction. |\n","| Detail page views | metric.detailPageViewsFromClicks | LONG | The number of detail page views attributed to an ad click. |\n","| Detail page views | metric.detailPageViewsFromViews | LONG | The number of detail page views attributed to an ad view. |\n","| Detail page views | metric.detailPageViewsPromoted | LONG | The number of detail page views for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Detail page views | metric.detailPageViewsFromClicksPromoted | LONG | The number of detail page views for products directly promoted in the campaign, attributed to an ad click. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViews | LONG | The number of detail page views by shoppers who had not viewed a product from the brand in the last 12 months, attributed to an ad interaction. |\n","| Detail page views | metric.detailPageViewsFromViewsPromoted | LONG | The number of view-attributed detail page views for products directly promoted in the campaign, attributed to an ad view. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsFromClicks | LONG | The number of detail page views by shoppers who had not viewed a product from the brand in the last 12 months, attributed to an ad click. |\n","| Detail page views | metric.detailPageViewsHalo | LONG | The number of detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsFromViews | LONG | The number of detail page views by shoppers who had not viewed a product from the brand in the last 12 months, attributed to an ad view. |\n","| Detail page views | metric.detailPageViewsFromClicksHalo | LONG | The number of detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsPromoted | LONG | The number of new-to-brand detail page views for products that were directly promoted in the campaign, attributed to an ad interaction. |\n","| Detail page views | metric.detailPageViewsFromViewsHalo | LONG | The number of detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsFromClicksPromoted | LONG | The number of new-to-brand detail page views for products that were directly promoted in the campaign, attributed to an ad click. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsFromViewsPromoted | LONG | The number of new-to-brand detail page views for products that were directly promoted in the campaign, attributed to an ad view. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsHalo | LONG | The number of new-to-brand detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsFromClicksHalo | LONG | The number of new-to-brand detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsFromViewsHalo | LONG | The number of new-to-brand detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Add to cart | metric.addToCart | LONG | The number of times a shopper added a product to their cart, attributed to an ad interaction. |\n","| Add to cart | metric.addToCartFromClicks | LONG | The number of times a shopper added a product to their cart, attributed to an ad click. |\n","| Add to cart | metric.addToCartFromViews | LONG | The number of times a shopper added a product to their cart, attributed to an ad view. |\n","| Add to cart | metric.addToCartPromoted | LONG | The number of add-to-cart events for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Add to cart | metric.addToCartFromClicksPromoted | LONG | The number of add-to-cart events for products directly promoted in the campaign, attributed to an ad click. |\n","| Add to cart | metric.addToCartFromViewsPromoted | LONG | The number of add-to-cart events for products directly promoted in the campaign, attributed to an ad view. |\n","| Add to cart | metric.addToCartHalo | LONG | The number of add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Add to cart new to brand | metric.newToBrandAddToCart | LONG | The number of add-to-cart events by shoppers who had not added a product from the brand to their cart in the last 12 months, attributed to an ad interaction. |\n","| Add to cart | metric.addToCartFromClicksHalo | LONG | The number of add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Add to cart | metric.addToCartFromViewsHalo | LONG | The number of add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Add to cart new to brand | metric.newToBrandAddToCartFromClicks | LONG | The number of add-to-cart events by shoppers who had not added a product from the brand to their cart in the last 12 months, attributed to an ad click. |\n","| Add to cart new to brand | metric.newToBrandAddToCartFromViews | LONG | The number of add-to-cart events by shoppers who had not added a product from the brand to their cart in the last 12 months, attributed to an ad view. |\n","| Add to cart new to brand | metric.newToBrandAddToCartPromoted | LONG | The number of new-to-brand add-to-cart events for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Add to cart new to brand | metric.newToBrandAddToCartFromClicksPromoted | LONG | The number of new-to-brand, add-to-cart events for products directly promoted in the campaign, attributed to an ad click. |\n","| Add to cart new to brand | metric.newToBrandAddToCartFromViewsPromoted | LONG | The number of new-to-brand, add-to-cart events for products directly promoted in the campaign, attributed to an ad view. |\n","| Add to cart new to brand | metric.newToBrandAddToCartHalo | LONG | The number of new-to-brand, add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Add to cart new to brand | metric.newToBrandAddToCartFromClicksHalo | LONG | The number of new-to-brand, add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Add to cart new to brand | metric.newToBrandAddToCartFromViewsHalo | LONG | The number of new-to-brand, add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Branded searches | metric.brandedSearches | LONG | The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad interaction. |\n","| Branded searches | metric.brandedSearchesFromClicks | LONG | The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad click. |\n","| Branded searches | metric.brandedSearchesFromViews | LONG | The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad view. |\n","| Brand store page views | metric.brandStorePageViews | LONG | The number of times shoppers viewed a brand-store page, attributed to an ad interaction. |\n","| Brand store page views | metric.brandStorePageViewsFromClicks | LONG | The number of times shoppers viewed a brand-store page, attributed to an ad click. |\n","| Brand store page views | metric.brandStorePageViewsFromViews | LONG | The number of times shoppers viewed a brand-store page, attributed to an ad view. |\n","| Add to list | metric.addToList | LONG | The number of times a shopper added a product to their wish list, gift list, or registry, attributed to an ad interaction. |\n","| Add to list | metric.addToListFromClicks | LONG | The number of times a shopper added a product to their wish list, gift list, or registry, attributed to an ad click. |\n","| Add to list | metric.addToListFromViews | LONG | The number of times a shopper added a product to their wish list, gift list, or registry, attributed to an ad view. |\n","| Add to list | metric.addToListPromoted | LONG | The number of add-to-list events for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Add to list | metric.addToListFromClicksPromoted | LONG | The number of add-to-list events for products directly promoted in the campaign, attributed to an ad click. |\n","| Add to list | metric.addToListFromViewsPromoted | LONG | The number of add-to-list events for products directly promoted in the campaign, attributed to an ad view. |\n","| Add to list | metric.addToListHalo | LONG | The number of add-to-list events for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Add to list | metric.addToListFromClicksHalo | LONG | The number of add-to-list events for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Add to list | metric.addToListFromViewsHalo | LONG | The number of add-to-list events for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Product review page visits | metric.productReviewPageVisits | LONG | The number of times a shopper visited an Amazon product review page, attributed to an ad interaction. |\n","| Product review page visits | metric.productReviewPageVisitsFromClicks | LONG | The number Amazon product review page visits attributed to an ad click. |\n","| Product review page visits | metric.productReviewPageVisitsFromViews | LONG | The number of Amazon product review page visits attributed to an ad view. |\n","| Product review page visits | metric.productReviewPageVisitsPromoted | LONG | The number of Amazon product review page visits for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Product review page visits | metric.productReviewPageVisitsFromClicksPromoted | LONG | The number of Amazon product review page visits for products directly promoted in the campaign, attributed to an ad click. |\n","| Product review page visits | metric.productReviewPageVisitsFromViewsPromoted | LONG | The number of Amazon product review page visits directly promoted in the campaign, attributed to an ad view. |\n","| Product review page visits | metric.productReviewPageVisitsHalo | LONG | The number of Amazon product review page visits for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Product review page visits | metric.productReviewPageVisitsFromClicksHalo | LONG | The number of Amazon product review page visits for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Product review page visits | metric.productReviewPageVisitsFromViewsHalo | LONG | The number of Amazon product review page visits for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptions | LONG | The number of Subscribe & Save subscriptions attributed to an ad interaction. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromClicks | LONG | The number Subscribe & Save subscriptions attributed to an ad click. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromViews | LONG | The number of Subscribe & Save subscriptions attributed to an ad view. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsPromoted | LONG | The number of Subscribe & Save subscriptions for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromClicksPromoted | LONG | The number of Subscribe & Save subscriptions for products directly promoted in the campaign, attributed to an ad click. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromViewsPromoted | LONG | The number of Subscribe & Save subscriptions directly promoted in the campaign, attributed to an ad view. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsHalo | LONG | The number of Subscribe & Save subscriptions for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromClicksHalo | LONG | The number of Subscribe & Save subscriptions for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromViewsHalo | LONG | The number of Subscribe & Save subscriptions for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Long term sales | metric.longTermSales | CURRENCY | Attributed sales plus the estimated 365-day value of new-to-brand shopper engagements attributed to the campaign, based on the brand's historical shopping patterns. |\n","| Long term sales | metric.longTermSalesNewToBrandBrandedSearches | CURRENCY | Estimated sales for the next 12 months based on first-time branded searches attributed to an ad. This estimate reflects historical 12-month purchase patterns from shoppers who searched for the brand for the first time. Branded searches are one of several conversion events that contribute to overall long-term sales. |\n","| Long term sales | metric.longTermSalesNewToBrandDetailPageViews | CURRENCY | Estimated sales for the next 12 months based on first-time detail page views attributed to an ad. This estimate reflects historical 12-month purchase patterns from shoppers who viewed a detail page for the first time. Detail page views are one of several conversion events that contribute to overall long-term sales. |\n","| Long term sales | metric.longTermSalesNewToBrandAddToCart | CURRENCY | Estimated sales for the next 12 months based on first-time add-to-cart events attributed to an ad. This estimate reflects historical 12-month purchase patterns from shoppers who added a product to cart for the first time. Add-to-cart events are one of several conversion events that contribute to overall long-term sales. |\n","| Long term sales | metric.longTermSalesNewToBrandRepeatPurchases | CURRENCY | Estimated sales for the next 12 months based on repeat purchases by new-to-brand customers whose initial purchase was attributed to an ad. This estimate reflects historical 12-month repeat purchase patterns from shoppers who purchased from the brand for the first time. Repeat purchases are one of several conversion events that contribute to overall long-term sales. |\n"," Amazon device conversions\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Subscription sign ups | metric.subscriptionSignUps | LONG | The number of times a shopper signed up for a paid or free trial digital subscription for a product directly promoted in the campaign, attributed to an ad interaction. |\n","| Subscription sign ups | metric.subscriptionSignUpsFromClicks | LONG | The number subscription sign-ups for a promoted product attributed to an ad click. |\n","| Subscription sign ups | metric.subscriptionSignUpsFromViews | LONG | The number of subscription sign-ups for a promoted product attributed to an ad view. |\n","| Paid subscription sign ups | metric.paidSubscriptionSignUps | LONG | The number of times a shopper signed up for a paid digital subscription for a product directly promoted in the campaign, attributed to an ad interaction. |\n","| Paid subscription sign ups | metric.paidSubscriptionSignUpsFromClicks | LONG | The number of paid subscription sign-ups for a promoted product attributed to an ad click. |\n","| Paid subscription sign ups | metric.paidSubscriptionSignUpsFromViews | LONG | The number of paid subscription sign-ups for a promoted product attributed to an ad view. |\n","| Free trial subscription sign ups | metric.freeTrialSubscriptionSignUps | LONG | The number of times a shopper signed up for a free trial digital subscription for a product directly promoted in the campaign, attributed to an ad interaction. |\n","| Free trial subscription sign ups | metric.freeTrialSubscriptionSignUpsFromClicks | LONG | The number of free trial subscription sign-ups for a promoted product attributed to an ad click. |\n","| Free trial subscription sign ups | metric.freeTrialSubscriptionSignUpsFromViews | LONG | The number of free trial subscription sign-ups for a promoted product attributed to an ad view. |\n","| App subscription sign ups | metric.appSubscriptionSignUps | LONG | The number of paid and free trial app subscription sign-ups attributed to an ad interaction. |\n","| App subscription sign ups | metric.appSubscriptionSignUpsFromClicks | LONG | The number of paid and free trial app subscription sign-ups attributed to an ad click. |\n","| App subscription sign ups | metric.appSubscriptionSignUpsFromViews | LONG | The number of app subscription sign-ups (paid and free-trial) attributed to an ad view. |\n","| Paid app subscription sign ups | metric.paidAppSubscriptionSignUps | LONG | The number of paid app subscription sign-ups attributed to an ad interaction. |\n","| Paid app subscription sign ups | metric.paidAppSubscriptionSignUpsFromClicks | LONG | The number of paid app subscription sign-ups attributed to an ad click. |\n","| Paid app subscription sign ups | metric.paidAppSubscriptionSignUpsFromViews | LONG | The number of paid app subscription sign-ups attributed to an ad view. |\n","| Free trial app subscription sign ups | metric.freeTrialAppSubscriptionSignUps | LONG | The number of free trial app subscription sign-ups attributed to an ad interaction. |\n","| Free trial app subscription sign ups | metric.freeTrialAppSubscriptionSignUpsFromClicks | LONG | The number of free trial app subscription sign-ups attributed to an ad click. |\n","| Free trial app subscription sign ups | metric.freeTrialAppSubscriptionSignUpsFromViews | LONG | The number of free trial app subscription sign-ups attributed to an ad view. |\n","| Appstore opens | metric.appstoreOpens | LONG | The number of times shoppers opened an app, including first time and reopens, attributed to an ad interaction. |\n","| Appstore opens | metric.appstoreOpensFromClicks | LONG | The number of times shoppers opened an app, including first time and reopens attributed to an ad click. |\n","| Appstore opens | metric.appstoreOpensFromViews | LONG | The number of times shoppers opened an app, including first time and reopens attributed to an ad view. |\n","| Appstore opens | metric.appstoreUsageHours | DECIMAL | The total hours spent using an app during first-time and repeat sessions attributed to an ad interaction. |\n","| Appstore opens | metric.appstoreUsageHoursFromClicks | DECIMAL | The total hours spent using an app the first time and during repeat sessions, attributed to an ad click. |\n","| Appstore opens | metric.appstoreUsageHoursFromViews | DECIMAL | The total hours spent using an app the first time and during repeat sessions, attributed to an ad view. |\n","| Appstore first opens | metric.appstoreFirstOpens | LONG | The number of first time app opens attributed to an ad interaction. |\n","| Appstore first opens | metric.appstoreFirstOpensFromClicks | LONG | The number of first time app opens attributed to an ad click. |\n","| Appstore first opens | metric.appstoreFirstOpensFromViews | LONG | The number of first time app opens attributed to an ad view. |\n","| Appstore first opens | metric.appstoreFirstSessionHours | DECIMAL | The total hours shoppers spent using an app during first time app sessions attributed to an ad interaction. |\n","| Appstore first opens | metric.appstoreFirstSessionHoursFromClicks | DECIMAL | The total hours shoppers spent using an app during first time app sessions attributed to an ad click. |\n","| Appstore first opens | metric.appstoreFirstSessionHoursFromViews | DECIMAL | The total hours shoppers spent using an app during first time app sessions attributed to an ad view. |\n","| Appstore repeat opens | metric.appstoreRepeatOpens | LONG | The number of repeat app opens attributed to an ad interaction. |\n","| Appstore repeat opens | metric.appstoreRepeatOpensFromClicks | LONG | The number of repeat app opens attributed to an ad click. |\n","| Appstore repeat opens | metric.appstoreRepeatOpensFromViews | LONG | The number of repeat app opens attributed to an ad view. |\n","| Appstore repeat opens | metric.appstoreRepeatSessionHours | DECIMAL | The total hours shoppers spent using an app during repeat sessions attributed to an ad interaction. This excludes the first session. |\n","| Appstore repeat opens | metric.appstoreRepeatSessionHoursFromClicks | DECIMAL | The total hours shoppers spent using an app during repeat sessions attributed to an ad click. This excludes the first session. |\n","| Appstore repeat opens | metric.appstoreRepeatSessionHoursFromViews | DECIMAL | The total hours shoppers spent using an app during repeat sessions attributed to an ad view. This excludes the first session. |\n","| Alexa skill enable | metric.alexaSkillEnable | LONG | The number of times a shopper enabled an Alexa skill, attributed to an ad interaction. |\n","| Alexa skill enable | metric.alexaSkillEnableFromClicks | LONG | The number of times a shopper enabled an Alexa skill, attributed to an ad click. |\n","| Alexa skill enable | metric.alexaSkillEnableFromViews | LONG | The number of times a shopper enabled an Alexa skill, attributed to an ad view. |\n","| Alexa skill invocations | metric.alexaSkillInvocations | LONG | The number of times shoppers launched a promoted Alexa skill, attributed to an ad interaction. This can include tap, touch, and voice invocations. |\n","| Alexa skill invocations | metric.alexaSkillInvocationsFromClicks | LONG | The number of times shoppers launched a promoted Alexa skill, attributed to an ad click. This can include tap, touch, and voice invocations. |\n","| Alexa skill invocations | metric.alexaSkillInvocationsFromViews | LONG | The number of times shoppers launched a promoted Alexa skill, attributed to an ad view. |\n","| Kindle edition normalized pages read | metric.kindleEditionNormalizedPagesRead | LONG | The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program, attributed to an ad interaction. |\n","| Kindle edition normalized pages read | metric.kindleEditionNormalizedPagesReadFromClicks | LONG | The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program, attributed to an ad click. |\n","| Kindle edition normalized pages read | metric.kindleEditionNormalizedPagesReadFromViews | LONG | The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program, attributed to an ad view. |\n","| Kindle edition normalized pages read | metric.kindleEditionNormalizedPagesReadPromoted | LONG | The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for books directly promoted in the campaign, attributed to an ad interaction. |\n","| Kindle edition normalized pages read | metric.kindleEditionNormalizedPagesReadFromClicksPromoted | LONG | The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for books directly promoted in the campaign, attributed to an ad click. |\n","| Kindle edition normalized pages read | metric.kindleEditionNormalizedPagesReadFromViewsPromoted | LONG | The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for books directly promoted in the campaign, attributed to an ad view. |\n","| Kindle edition normalized pages read | metric.kindleEditionNormalizedPagesReadHalo | LONG | The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for highly relevant books that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Kindle edition normalized pages read | metric.kindleEditionNormalizedPagesReadFromClicksHalo | LONG | The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for highly relevant books that were not directly promoted in the campaign, attributed to an ad click. |\n","| Kindle edition normalized pages read | metric.kindleEditionNormalizedPagesReadFromViewsHalo | LONG | The number of Kindle Edition Normalized Pages (KENP) read from the Kindle Unlimited program for highly relevant books that were not directly promoted in the campaign, attributed to an ad view. |\n","| Kindle unlimited qualified borrows | metric.kindleUnlimitedQualifiedBorrows | LONG | The number of times a Kindle Unlimited user downloaded a book and read enough pages to qualify for a royalty payment, attributed to an ad interaction. |\n","| Kindle unlimited qualified borrows | metric.estimatedKindleUnlimitedRoyalties | CURRENCY | Estimated Kindle Unlimited royalties for qualified borrows attributed to an ad interaction. |\n","| Kindle unlimited qualified borrows | metric.kindleUnlimitedQualifiedBorrowsFromClicks | LONG | The number of times a Kindle Unlimited user downloaded a book and read enough pages to qualify for a royalty payment, attributed to an ad click. |\n","| Kindle unlimited qualified borrows | metric.estimatedKindleUnlimitedRoyaltiesFromClicks | CURRENCY | Estimated Kindle Unlimited royalties for qualified borrows attributed to an ad click. |\n","| Kindle unlimited qualified borrows | metric.kindleUnlimitedQualifiedBorrowsFromViews | LONG | The number of times a Kindle Unlimited user downloaded a book and read enough pages to qualify for a royalty payment, attributed to an ad view. |\n","| Kindle unlimited qualified borrows | metric.estimatedKindleUnlimitedRoyaltiesFromViews | CURRENCY | Estimated Kindle Unlimited royalties for qualified borrows attributed to an ad view. |\n","| Kindle unlimited qualified borrows | metric.kindleUnlimitedQualifiedBorrowsPromoted | LONG | The number of times a Kindle Unlimited user downloaded a book that was directly promoted in the campaign and met the page-read threshold for a royalty, attributed to an ad interaction. |\n","| Kindle unlimited qualified borrows | metric.estimatedKindleUnlimitedRoyaltiesPromoted | CURRENCY | Estimated Kindle Unlimited royalties for qualified borrows of books that were directly promoted in the campaign, attributed to an ad interaction. |\n","| Kindle unlimited qualified borrows | metric.kindleUnlimitedQualifiedBorrowsFromClicksPromoted | LONG | The number of times a Kindle Unlimited user downloaded a book that was directly promoted in the campaign and met the page-read threshold for a royalty, attributed to an ad click. |\n","| Kindle unlimited qualified borrows | metric.estimatedKindleUnlimitedRoyaltiesFromClicksPromoted | CURRENCY | Estimated Kindle Unlimited royalties for qualified borrows of books that were directly promoted in the campaign, attributed to an ad click. |\n","| Kindle unlimited qualified borrows | metric.kindleUnlimitedQualifiedBorrowsFromViewsPromoted | LONG | The number of times a Kindle Unlimited user downloaded a book that was directly promoted in the campaign and met the page-read threshold for a royalty, attributed to an ad view. |\n","| Kindle unlimited qualified borrows | metric.estimatedKindleUnlimitedRoyaltiesFromViewsPromoted | CURRENCY | Estimated Kindle Unlimited royalties for qualified borrows of books that were directly promoted in the campaign, attributed to an ad view. |\n","| Kindle unlimited qualified borrows | metric.kindleUnlimitedQualifiedBorrowsHalo | LONG | The number of Kindle Unlimited downloads for highly relevant books not directly promoted in the campaign that met the page-read threshold for a royalty, attributed to an ad interaction. |\n","| Kindle unlimited qualified borrows | metric.estimatedKindleUnlimitedRoyaltiesHalo | CURRENCY | Estimated Kindle Unlimited royalties for qualified borrows of highly relevant books that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Kindle unlimited qualified borrows | metric.kindleUnlimitedQualifiedBorrowsFromClicksHalo | LONG | The number of Kindle Unlimited downloads for highly relevant books not directly promoted in the campaign that met the page-read threshold for a royalty, attributed to an ad click. |\n","| Kindle unlimited qualified borrows | metric.estimatedKindleUnlimitedRoyaltiesFromClicksHalo | CURRENCY | Estimated Kindle Unlimited royalties for qualified borrows of highly relevant books that were not directly promoted in the campaign, attributed to an ad click. |\n","| Kindle unlimited qualified borrows | metric.kindleUnlimitedQualifiedBorrowsFromViewsHalo | LONG | The number of Kindle Unlimited downloads for highly relevant books not directly promoted in the campaign that met the page-read threshold for a royalty, attributed to an ad view. |\n","| Kindle unlimited qualified borrows | metric.estimatedKindleUnlimitedRoyaltiesFromViewsHalo | CURRENCY | Estimated Kindle Unlimited royalties for qualified borrows of highly relevant books that were not directly promoted in the campaign, attributed to an ad view. |\n"," Amazon video conversions\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Add to watchlist | metric.addToWatchlist | LONG | The number of times a shopper added a product to their watchlist attributed to an ad interaction. |\n","| Add to watchlist | metric.addToWatchlistFromClicks | LONG | The number of times a shopper added a product to their watchlist, attributed to an ad click. |\n","| Add to watchlist | metric.addToWatchlistFromViews | LONG | The number of times a shopper added a product to their watchlist, attributed to an ad view. |\n","| Downloaded video plays | metric.downloadedVideoPlays | LONG | The number of times a shopper downloaded and played a video product attributed to an ad interaction. |\n","| Downloaded video plays | metric.downloadedVideoPlaysFromClicks | LONG | The number of times a shopper downloaded and played a video product, attributed to an ad click. |\n","| Downloaded video plays | metric.downloadedVideoPlaysFromViews | LONG | The number of times a shopper downloaded and played a video product, attributed to an ad view. |\n","| Rentals | metric.rentals | LONG | The number of times a shopper rented a video attributed to an ad interaction. |\n","| Rentals | metric.rentalsFromClicks | LONG | The number of times a shopper rented a video, attributed to an ad click. |\n","| Rentals | metric.rentalsFromViews | LONG | The number of times a shopper rented a video, attributed to an ad view. |\n","| Trailer plays | metric.trailerPlays | LONG | The number of times a shopper played a video trailer attributed to an ad interaction. |\n","| Trailer plays | metric.trailerPlaysFromClicks | LONG | The number of times a shopper played a video trailer, attributed to an ad click. |\n","| Trailer plays | metric.trailerPlaysFromViews | LONG | The number of times a shopper played a video trailer, attributed to an ad view. |\n","| Video stream plays | metric.videoStreamPlays | LONG | The number of times a shopper streamed a video, attributed to an ad interaction. |\n","| Video stream plays | metric.videoStreamPlaysFromClicks | LONG | The number of times a shopper streamed a video, attributed to an ad click. |\n","| Video stream plays | metric.videoStreamPlaysFromViews | LONG | The number of times a shopper streamed a video, attributed to an ad view. |\n"," Off amazon conversions\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Conversions off amazon | metric.offAmazonConversions | LONG | The number of conversions that occurred off-Amazon attributed to an ad interaction. This includes all off-Amazon conversion types. |\n","| Conversions off amazon | metric.offAmazonConversionsFromClicks | LONG | The number of off-Amazon conversions attributed to an ad click. This includes all off-Amazon conversion types. |\n","| Conversions off amazon | metric.offAmazonConversionsFromViews | LONG | The number of off-Amazon conversions attributed to an ad view. This includes all off-Amazon conversion types. |\n","| Purchases off amazon | metric.offAmazonPurchases | LONG | The number of off-Amazon purchases attributed to an ad interaction. |\n","| Purchases off amazon | metric.offAmazonSales | CURRENCY | The sales from off-Amazon purchases attributed to an ad interaction. |\n","| Purchases off amazon | metric.offAmazonUnitsSold | LONG | The number of product units in off-Amazon purchases, attributed to an ad interaction. A single purchase event can include multiple units of the same product. |\n","| Purchases off amazon | metric.offAmazonPurchasesFromClicks | LONG | The number of off-Amazon purchases attributed to an ad click. |\n","| Purchases off amazon | metric.offAmazonSalesFromClicks | CURRENCY | The sales from off-Amazon purchases attributed to an ad click. |\n","| Purchases off amazon | metric.offAmazonPurchasesFromViews | LONG | The number of off-Amazon purchases attributed to an ad view. |\n","| Purchases off amazon | metric.offAmazonSalesFromViews | CURRENCY | The sales from off-Amazon purchases attributed to an ad view. |\n","| Purchases off amazon | metric.offAmazonUnitsSoldFromClicks | LONG | The number of product units in off-Amazon purchases, attributed to an ad click. A single purchase event can include multiple units of the same product. |\n","| Purchases off amazon | metric.offAmazonUnitsSoldFromViews | LONG | The number of product units in off-Amazon purchases, attributed to an ad view. A single purchase event may include multiple units of the same product. |\n","| Add to shopping cart off amazon | metric.offAmazonAddToShoppingCart | LONG | The number of off-Amazon add to shopping cart conversions attributed to an ad interaction. |\n","| Add to shopping cart off amazon | metric.offAmazonAddToShoppingCartFromClicks | LONG | The number of off-Amazon add to shopping cart conversions attributed to an ad click. |\n","| Add to shopping cart off amazon | metric.offAmazonAddToShoppingCartFromViews | LONG | The number of off-Amazon add to shopping cart conversions attributed to an ad view. |\n","| Add to shopping cart off amazon | metric.offAmazonAddToShoppingCartValueSum | DECIMAL | The sum of values associated with off-Amazon add to shopping cart conversions. |\n","| Applications off amazon | metric.offAmazonApplications | LONG | The number of applications that occurred off Amazon attributed to an ad interaction. |\n","| Applications off amazon | metric.offAmazonApplicationsFromClicks | LONG | The number of applications that occurred off Amazon attributed to an ad click. |\n","| Applications off amazon | metric.offAmazonApplicationsFromViews | LONG | The number of applications that occurred off Amazon attributed to an ad view. |\n","| Applications off amazon | metric.offAmazonApplicationsValueSum | DECIMAL | The sum of values associated with off-Amazon applications. |\n","| Checkouts off amazon | metric.offAmazonCheckouts | LONG | The number of off-Amazon checkouts attributed to an ad interaction. |\n","| Checkouts off amazon | metric.offAmazonCheckoutsFromClicks | LONG | The number of off-Amazon checkouts attributed to an ad click. |\n","| Checkouts off amazon | metric.offAmazonCheckoutsFromViews | LONG | The number of off-Amazon checkouts attributed to an ad view. |\n","| Checkouts off amazon | metric.offAmazonCheckoutsValueSum | DECIMAL | The sum of values associated with off-Amazon checkouts. |\n","| Contacts off amazon | metric.offAmazonContacts | LONG | The number of off-Amazon contacts attributed to an ad interaction. |\n","| Contacts off amazon | metric.offAmazonContactsFromClicks | LONG | The number of off-Amazon contacts attributed to an ad click. |\n","| Contacts off amazon | metric.offAmazonContactsFromViews | LONG | The number of off-Amazon contacts attributed to an ad view. |\n","| Contacts off amazon | metric.offAmazonContactsValueSum | DECIMAL | The sum of values associated with off-Amazon contacts. |\n","| Leads off amazon | metric.offAmazonLeads | LONG | The number of off-Amazon leads attributed to an ad interaction. |\n","| Leads off amazon | metric.offAmazonLeadsFromClicks | LONG | The number of off-Amazon leads attributed to an ad click. |\n","| Leads off amazon | metric.offAmazonLeadsFromViews | LONG | The number of off-Amazon leads attributed to an ad view. |\n","| Leads off amazon | metric.offAmazonLeadsValueSum | DECIMAL | The sum of values associated with off-Amazon leads. |\n","| Installs off amazon | metric.offAmazonInstalls | LONG | The number of off-Amazon installs attributed to an ad interaction. |\n","| Installs off amazon | metric.offAmazonInstallsFromClicks | LONG | The number of off-Amazon installs attributed to an ad click. |\n","| Installs off amazon | metric.offAmazonInstallsFromViews | LONG | The number of off-Amazon installs attributed to an ad view. |\n","| Installs off amazon | metric.offAmazonInstallsValueSum | DECIMAL | The sum of values associated with off-Amazon installs. |\n","| Other off amazon | metric.offAmazonOther | LONG | The number of advertiser-defined \"other\" conversions (not covered by other standard metrics) that occurred off Amazon, attributed to an ad interaction. |\n","| Other off amazon | metric.offAmazonOtherFromClicks | LONG | The number of advertiser-defined \"other\" conversions attributed to an ad click. |\n","| Other off amazon | metric.offAmazonOtherFromViews | LONG | The number of advertiser-defined \"other\" conversions attributed to an ad view. |\n","| Other off amazon | metric.offAmazonOtherValueSum | DECIMAL | The sum of values associated with an advertiser-defined \"other\" conversion off Amazon. |\n","| Page views off amazon | metric.offAmazonPageViews | LONG | The number of off-Amazon page views attributed to an ad interaction. |\n","| Page views off amazon | metric.offAmazonPageViewsFromClicks | LONG | The number of off-Amazon page views attributed to an ad click. |\n","| Page views off amazon | metric.offAmazonPageViewsFromViews | LONG | The number of off-Amazon page views attributed to an ad view. |\n","| Page views off amazon | metric.offAmazonPageViewsValueSum | DECIMAL | The sum of values associated with off-Amazon page views. |\n","| Searches off amazon | metric.offAmazonSearches | LONG | The number of off-Amazon searches attributed to an ad interaction. |\n","| Searches off amazon | metric.offAmazonSearchesFromClicks | LONG | The number of off-Amazon searches attributed to an ad click. |\n","| Searches off amazon | metric.offAmazonSearchesFromViews | LONG | The number of off-Amazon searches attributed to an ad view. |\n","| Searches off amazon | metric.offAmazonSearchesValueSum | DECIMAL | The sum of values associated with off-Amazon searches |\n","| Sign ups off amazon | metric.offAmazonSignUps | LONG | The number of off-Amazon sign-ups attributed to an ad interaction. |\n","| Sign ups off amazon | metric.offAmazonSignUpsFromClicks | LONG | The number of off-Amazon sign-ups attributed to an ad click. |\n","| Sign ups off amazon | metric.offAmazonSignUpsFromViews | LONG | The number of off-Amazon sign-ups, attributed to an ad view. |\n","| Sign ups off amazon | metric.offAmazonSignUpsValueSum | DECIMAL | The sum of values associated with off-Amazon sign-ups. |\n","| Subscribe off amazon | metric.offAmazonSubscribe | LONG | The number of off-Amazon subscribe conversions, attributed to an ad interaction. |\n","| Subscribe off amazon | metric.offAmazonSubscribeFromClicks | LONG | The number of off-Amazon subscribe conversions attributed to an ad click. |\n","| Subscribe off amazon | metric.offAmazonSubscribeFromViews | LONG | The number of off-Amazon subscribe conversions attributed to an ad view. |\n","| Subscribe off amazon | metric.offAmazonSubscribeValueSum | DECIMAL | The sum of values associated with off-Amazon subscribe conversions. |\n"," Combined conversions\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Purchases combined | metric.combinedPurchases | LONG | The number of purchases on and off Amazon attributed to an ad interaction. |\n","| Purchases combined | metric.combinedSales | CURRENCY | The sales from purchases on and off Amazon attributed to an ad interaction. |\n","| Purchases combined | metric.combinedUnitsSold | LONG | The number of product units in purchases on and off Amazon, attributed to an ad interaction. A single purchase event may include multiple units of the same product. |\n","| Purchases combined | metric.combinedPurchasesFromClicks | LONG | The number of purchases on and off Amazon, attributed to an ad click. |\n","| Purchases combined | metric.combinedSalesFromClicks | CURRENCY | The sales from purchases on and off Amazon, attributed to an ad click. |\n","| Purchases combined | metric.combinedUnitsSoldFromClicks | LONG | The number of product units in purchases on and off Amazon, attributed to an ad click. A single purchase may include multiple units of the same product. |\n","| Purchases combined | metric.combinedPurchasesFromViews | LONG | The number of purchases on and off Amazon, attributed to an ad view. |\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":2,"text":"Reporting thresholds"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":[" Amazon Ads applies reporting thresholds to high-cardinality dimensions, grouping values that do not meet the threshold into an (Other) row — see How the datasets work.\n"," In this dataset, searchTerm.value is subject to reporting thresholds. If you see fewer search terms than you expect, some did not meet the threshold at the dataset's granularity.\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":2,"text":"Disjoint rows"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":[" Some dimension and metric combinations in this dataset are not compatible. When such a combination is present, the data for one entity at one grain is split across more than one row. For example, for one campaign on one date, traffic metrics are not compatible with the conversionSource.name dimension, so you receive:\n","One row where traffic metrics have values and conversion metrics are zero. - One row where conversion metrics have values and traffic metrics are zero.\n"," To aggregate to your grain, sum every metric across the rows that share the same entity key. Non-applicable metrics are zero, so summing produces the correct totals. When you compute a derived metric such as ROAS (sales ÷ total cost), aggregate the numerator and the denominator across all rows at your grain before dividing, because the components can sit on different rows.\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":2,"text":"Maintain a staging layer"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":[" To report at a grain coarser than the delivered record key, maintain a record-level staging layer, keeping the highest streamBatch.version per key — see How the datasets work.\n"," To maintain a daily view of this hourly dataset, aggregate each new hourly record with the other hours of that day. Once the staging layer is current, aggregate from it to your grain:\n"],"documentType":"guide"},{"title":"Ads performance","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-performance","content":[],"documentType":"guide"},{"title":"Ads converted product","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-converted-product","content":[" The Ads converted product dataset (ads-converted-product-v1) delivers conversion data at the individual product (ASIN) level. It reports which products converted from your campaigns — both products you promoted directly and related products that converted through a halo effect. Use it to measure the influence of your ads on specific products, including products the ad did not feature.\n"," This dataset covers the data previously available only through the Version 3 report types spPurchasedProduct, sbPurchasedProduct, sdPurchasedProduct, and dspProduct. Its metrics and dimensions follow the naming used by the Amazon Ads reporting API and downloadable reports.\n"],"documentType":"guide"},{"title":"Ads converted product","sectionHeader":{"type":2,"text":"What you can measure"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-converted-product","content":[" Conversion metrics attributed to your campaigns at the converted-product level — purchases, sales, units sold, detail page views, add to cart, and related events — split by whether the product was promoted directly or attributed through relevance to a promoted product (halo). The dataset does not include calculated metrics such as percent of purchases that are new-to-brand. Compute those from the metric fields in the dataset.\n"," This dataset gives the ASIN-level detail for conversion metrics that the Ads performance dataset reports in aggregate. Use Ads converted product when you need per-product conversions; use Ads performance for campaign-level traffic, engagement, and aggregate conversions. The converted-product dimensions — convertedProduct.id, convertedProductMarketplace.value, and productRelevance.value — identify the product that converted and whether it was promoted directly or attributed through halo.\n"],"documentType":"guide"},{"title":"Ads converted product","sectionHeader":{"type":2,"text":"Dataset specifications"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-converted-product","content":["| Property | Value |\n","\\|---\\|---\\|\n","| Stream dataset ID | ads-converted-product-v1 |\n","| Grain | Daily |\n","| Supported account types | Global Account, Amazon DSP (ADSP) Regional Account |\n","| Accounts per subscription | One |\n","| Restatement window | 70 days |\n"],"documentType":"guide"},{"title":"Ads converted product","sectionHeader":{"type":2,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-converted-product","content":[" The dataset delivers the following metadata, dimension, and metric fields. Data types are STRING, LONG, DECIMAL, or CURRENCY. Read each field at its declared type or wider, and tolerate fields you do not recognize — see Build a resilient consumer.\n"],"documentType":"guide"},{"title":"Ads converted product","sectionHeader":{"type":3,"text":"Metadata fields"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-converted-product","content":["| Field name | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Stream batch | streamBatch.version | LONG | Tracks updates to a record; the highest value is the most recent. |\n","| Stream dataset | streamDataset.id | STRING | The unique ID associated with the Stream dataset. |\n","| Stream subscription | streamSubscription.id | STRING | The unique ID associated with the Stream subscription. |\n"],"documentType":"guide"},{"title":"Ads converted product","sectionHeader":{"type":3,"text":"Dimension fields"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-converted-product","content":[" Dimension fields form the record key. Use every dimension field marked in your subscription's schema as the upsert key when you write records.\n","| Category | Dimension | Field ID | Data type | Applicable ad product(s) | Description |\n","\\|---\\|---\\|---\\|---\\|---\\|---\\|\n","| Currency | Budget currency | budgetCurrency.value | STRING | ADSP, SB, SD, SP, ST | The currency in which the advertising spend was made. |\n","| Time | Date | date.value | STRING | ADSP, SB, SD, SP, ST | The date included in the report. |\n","| Level of detail | Advertiser account | advertiserAccount.id | STRING | ADSP, SB, SD, SP, ST | The unique ID associated with the advertiser account. |\n","| Level of detail | Advertiser account alternate profile id | advertiserAccountAlternateProfileId.value | STRING | SB, SD, SP, ST | The Profile ID that represents the advertiser account in legacy Amazon Ads APIs. |\n","| Level of detail | Advertiser account alternate dsp advertiser id | advertiserAccountAlternateDspAdvertiserId.value | STRING | ADSP | The DSP Advertiser ID that represents the advertiser account in legacy Amazon Ads APIs. |\n","| Level of detail | Ad product | adProduct.value | STRING | ADSP, SB, SD, SP, ST | The Amazon ad product like Sponsored Products, Sponsored Brands, or Amazon DSP |\n","| Level of detail | Insertion order | insertionOrder.id | STRING |  | The ID associated with the insertion order. An insertion order is a contractual agreement between an advertiser and Amazon Ads. |\n","| Level of detail | Campaign | campaign.id | STRING | ADSP, SB, SD, SP, ST | The unique ID associated with the campaign. |\n","| Level of detail | Ad group | adGroup.id | STRING | ADSP, SB, SD, SP, ST | The unique ID associated with the ad group. |\n","| Level of detail | Ad | ad.id | STRING | ADSP, SB, SD, SP, ST | The unique ID associated with the ad. |\n","| Product | Advertised product | advertisedProduct.id | STRING | SB, SD, SP, ST | The unique identifier of the product featured in the ad. |\n","| Product | Advertised product marketplace | advertisedProductMarketplace.value | STRING | ADSP, SD, SP | The marketplace where the advertised product is sold. |\n","| Product | Advertised product sku | advertisedProductSku.value | STRING | ADSP, SD, SP | The SKU (stock keeping unit) assigned to the product featured in the ad. |\n","| Product | Converted product | convertedProduct.id | STRING | ADSP, SB, SD, SP, ST | The unique identifier of the product attributed to the ad. |\n","| Product | Converted product marketplace | convertedProductMarketplace.value | STRING | ADSP, SB, SD, SP, ST | The marketplace where the conversion event for the attributed product occurred. |\n","| Product | Product relevance | productRelevance.value | STRING | ADSP, SB, SD, SP, ST | Indicates whether the product was directly promoted in the campaign or attributed based on relevance to promoted products (halo). |\n","| Delivery | Time zone | timeZone.value | STRING | ADSP, SB, SD, SP, ST | The time zone used by the advertiser for reporting and ad serving purposes. |\n"],"documentType":"guide"},{"title":"Ads converted product","sectionHeader":{"type":3,"text":"Metric fields"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-converted-product","content":[" Amazon retail conversions\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Purchases | metric.purchases | LONG | The number of purchases attributed to an ad interaction. |\n","| Purchases | metric.multiTouchPurchases | DECIMAL | The number of purchases attributed to an ad interaction. This is measured using multi-touch attribution. |\n","| Purchases | metric.sales | CURRENCY | The sales from purchases attributed to an ad interaction. |\n","| Purchases | metric.multiTouchSales | CURRENCY | The sales from purchases attributed to an ad interaction. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSold | LONG | The number of product units in purchases attributed to an ad interaction. A single purchase event can include multiple units of the same product. |\n","| Purchases | metric.multiTouchUnitsSold | DECIMAL | The number of product units in purchases attributed to an ad interaction. A single purchase event can include multiple units of the same product. This is measured using multi-touch attribution. |\n","| Purchases | metric.purchasesFromClicks | LONG | The number of purchases attributed to an ad click. |\n","| Purchases | metric.multiTouchPurchasesFromClicks | DECIMAL | The number of purchases attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesFromClicks | CURRENCY | Sales from purchases attributed to an ad click. |\n","| Purchases | metric.unitsSoldFromClicks | LONG | The number of product units in purchases attributed to an ad click. A single purchase event can include multiple units of the same product. |\n","| Purchases | metric.purchasesFromViews | LONG | The number of purchases attributed to an ad view. |\n","| Purchases | metric.multiTouchPurchasesFromViews | DECIMAL | The number of purchases attributed to an ad view. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesFromViews | CURRENCY | The sales from purchases attributed to an ad view. |\n","| Purchases | metric.unitsSoldFromViews | LONG | The number of product units in purchases attributed to an ad view. A single purchase event can include multiple units of the same product. |\n","| Purchases | metric.purchasesPromoted | LONG | The number of purchases for products that were directly promoted in the campaign. |\n","| Purchases | metric.multiTouchPurchasesPromoted | DECIMAL | The number of purchases for products that were directly promoted in the campaign. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesPromoted | CURRENCY | The sales from products that were directly promoted in the campaign. |\n","| Purchases | metric.multiTouchSalesPromoted | CURRENCY | The sales from products that were directly promoted in the campaign. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSoldPromoted | LONG | The number of units sold for products that were directly promoted in the campaign. A single purchase can include multiple units of the same product. |\n","| Purchases | metric.multiTouchUnitsSoldPromoted | DECIMAL | The number of units sold for products that were directly promoted in the campaign. A single purchase can include multiple units of the same product. This is measured using multi-touch attribution. |\n","| Purchases | metric.purchasesFromClicksPromoted | LONG | The number of purchases for products that were directly promoted in the campaign, attributed to an ad click. |\n","| Purchases | metric.multiTouchPurchasesFromClicksPromoted | DECIMAL | The number of purchases for products that were directly promoted in the campaign, attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesFromClicksPromoted | CURRENCY | The sales from products that were directly promoted in the campaign, attributed to an ad click. |\n","| Purchases | metric.unitsSoldFromClicksPromoted | LONG | The number of units sold for products that were directly promoted in the campaign, attributed to an ad click. |\n","| Purchases | metric.purchasesFromViewsPromoted | LONG | The number of purchases for products that were directly promoted in the campaign, attributed to an ad view. |\n","| Purchases | metric.multiTouchPurchasesFromViewsPromoted | DECIMAL | The number of purchases for products that were directly promoted in the campaign, attributed to an ad view. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesFromViewsPromoted | CURRENCY | The sales from products that were directly promoted in the campaign, attributed to an ad view. |\n","| Purchases | metric.unitsSoldFromViewsPromoted | LONG | The number of units in purchases for products that were directly promoted in the campaign, attributed to an ad view. A single purchase can include multiple units of the same product. |\n","| Purchases | metric.purchasesHalo | LONG | The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Purchases | metric.multiTouchPurchasesHalo | DECIMAL | The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. This is measured using multi-touch attribution. |\n","| Purchases | metric.salesHalo | CURRENCY | The sales from highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Purchases | metric.multiTouchSalesHalo | CURRENCY | The sales from purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. This is measured using multi-touch attribution. |\n","| Purchases | metric.unitsSoldHalo | LONG | The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Purchases | metric.multiTouchUnitsSoldHalo | DECIMAL | The number of units sold for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. This is measured using multi-touch attribution. |\n","| Purchases | metric.purchasesFromClicksHalo | LONG | The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Purchases | metric.multiTouchPurchasesFromClicksHalo | DECIMAL | The number of purchases for highly relevant products that were not directly promoted, attributed to an ad click. This is measured using multi-touch attribution. |\n","| Purchases new to brand | metric.newToBrandPurchases | LONG | The number of purchases by shoppers who had not purchased a product from the brand in the last 12 months. |\n","| Purchases new to brand | metric.newToBrandSales | CURRENCY | The sales from shoppers who had not purchased a product from the brand in the last 12 months. |\n","| Purchases new to brand | metric.newToBrandUnitsSold | LONG | The number of product units purchased by shoppers who had not purchased from the brand in the last 12 months. |\n","| Purchases | metric.purchasesFromViewsHalo | LONG | The number of purchases for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Purchases | metric.multiTouchPurchasesFromViewsHalo | DECIMAL | The number of purchases from highly relevant products that were not directly promoted in the campaign, attributed to an ad view. This is measured using multi-touch attribution. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromClicks | LONG | The number of purchases by shoppers who had not purchased a product from the brand in the last 12 months, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromViews | LONG | The number of purchases by shoppers who had not purchased a product from the brand in the last 12 months, attributed to an ad view. |\n","| Purchases new to brand | metric.newToBrandPurchasesPromoted | LONG | The number of purchases from new-to-brand shoppers for products directly promoted in the campaign. |\n","| Purchases new to brand | metric.newToBrandSalesPromoted | CURRENCY | The sales from products that were directly promoted in the campaign by new-to-brand shoppers. |\n","| Purchases new to brand | metric.newToBrandUnitsSoldPromoted | LONG | The number of units sold to new-to-brand shoppers for products that were directly promoted in the campaign. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromClicksPromoted | LONG | The number of purchases from new-to-brand shoppers for products directly promoted in the campaign, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromViewsPromoted | LONG | The number of purchases from new-to-brand shoppers for products directly promoted in the campaign, attributed to an ad view. |\n","| Purchases new to brand | metric.newToBrandPurchasesHalo | LONG | The number of times new-to-brand shoppers purchased a highly relevant product that was not directly promoted in the campaign. |\n","| Purchases new to brand | metric.newToBrandSalesHalo | CURRENCY | The sales from highly relevant products that were not directly promoted in the campaign by new-to-brand shoppers. |\n","| Purchases new to brand | metric.newToBrandUnitsSoldHalo | LONG | The number of units sold for highly relevant products that were not directly promoted in the campaign to new-to-brand shoppers. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromClicksHalo | LONG | The number of highly relevant product purchases that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad click. |\n","| Purchases new to brand | metric.newToBrandPurchasesFromViewsHalo | LONG | The number of highly relevant product purchases that were not directly promoted in the campaign by new-to-brand shoppers, attributed to an ad view. |\n","| Detail page views | metric.detailPageViews | LONG | The number of detail page views attributed to an ad interaction. |\n","| Detail page views | metric.detailPageViewsFromClicks | LONG | The number of detail page views attributed to an ad click. |\n","| Detail page views | metric.detailPageViewsFromViews | LONG | The number of detail page views attributed to an ad view. |\n","| Detail page views | metric.detailPageViewsPromoted | LONG | The number of detail page views for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Detail page views | metric.detailPageViewsFromClicksPromoted | LONG | The number of detail page views for products directly promoted in the campaign, attributed to an ad click. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViews | LONG | The number of detail page views by shoppers who had not viewed a product from the brand in the last 12 months, attributed to an ad interaction. |\n","| Detail page views | metric.detailPageViewsFromViewsPromoted | LONG | The number of view-attributed detail page views for products directly promoted in the campaign, attributed to an ad view. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsFromClicks | LONG | The number of detail page views by shoppers who had not viewed a product from the brand in the last 12 months, attributed to an ad click. |\n","| Detail page views | metric.detailPageViewsHalo | LONG | The number of detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsFromViews | LONG | The number of detail page views by shoppers who had not viewed a product from the brand in the last 12 months, attributed to an ad view. |\n","| Detail page views | metric.detailPageViewsFromClicksHalo | LONG | The number of detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsPromoted | LONG | The number of new-to-brand detail page views for products that were directly promoted in the campaign, attributed to an ad interaction. |\n","| Detail page views | metric.detailPageViewsFromViewsHalo | LONG | The number of detail page views for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsFromClicksPromoted | LONG | The number of new-to-brand detail page views for products that were directly promoted in the campaign, attributed to an ad click. |\n","| Detail page views new to brand | metric.newToBrandDetailPageViewsFromViewsPromoted | LONG | The number of new-to-brand detail page views for products that were directly promoted in the campaign, attributed to an ad view. |\n","| Add to cart | metric.addToCart | LONG | The number of times a shopper added a product to their cart, attributed to an ad interaction. |\n","| Add to cart | metric.addToCartFromClicks | LONG | The number of times a shopper added a product to their cart, attributed to an ad click. |\n","| Add to cart | metric.addToCartFromViews | LONG | The number of times a shopper added a product to their cart, attributed to an ad view. |\n","| Add to cart | metric.addToCartPromoted | LONG | The number of add-to-cart events for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Add to cart | metric.addToCartFromClicksPromoted | LONG | The number of add-to-cart events for products directly promoted in the campaign, attributed to an ad click. |\n","| Add to cart | metric.addToCartFromViewsPromoted | LONG | The number of add-to-cart events for products directly promoted in the campaign, attributed to an ad view. |\n","| Add to cart | metric.addToCartHalo | LONG | The number of add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Add to cart | metric.addToCartFromClicksHalo | LONG | The number of add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Add to cart | metric.addToCartFromViewsHalo | LONG | The number of add-to-cart events for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Branded searches | metric.brandedSearches | LONG | The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad interaction. |\n","| Branded searches | metric.brandedSearchesFromClicks | LONG | The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad click. |\n","| Branded searches | metric.brandedSearchesFromViews | LONG | The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad view. |\n","| Add to list | metric.addToList | LONG | The number of times a shopper added a product to their wish list, gift list, or registry, attributed to an ad interaction. |\n","| Add to list | metric.addToListFromClicks | LONG | The number of times a shopper added a product to their wish list, gift list, or registry, attributed to an ad click. |\n","| Add to list | metric.addToListFromViews | LONG | The number of times a shopper added a product to their wish list, gift list, or registry, attributed to an ad view. |\n","| Add to list | metric.addToListPromoted | LONG | The number of add-to-list events for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Add to list | metric.addToListFromClicksPromoted | LONG | The number of add-to-list events for products directly promoted in the campaign, attributed to an ad click. |\n","| Add to list | metric.addToListFromViewsPromoted | LONG | The number of add-to-list events for products directly promoted in the campaign, attributed to an ad view. |\n","| Add to list | metric.addToListHalo | LONG | The number of add-to-list events for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Add to list | metric.addToListFromClicksHalo | LONG | The number of add-to-list events for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Add to list | metric.addToListFromViewsHalo | LONG | The number of add-to-list events for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Product review page visits | metric.productReviewPageVisits | LONG | The number of times a shopper visited an Amazon product review page, attributed to an ad interaction. |\n","| Product review page visits | metric.productReviewPageVisitsFromClicks | LONG | The number Amazon product review page visits attributed to an ad click. |\n","| Product review page visits | metric.productReviewPageVisitsFromViews | LONG | The number of Amazon product review page visits attributed to an ad view. |\n","| Product review page visits | metric.productReviewPageVisitsPromoted | LONG | The number of Amazon product review page visits for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Product review page visits | metric.productReviewPageVisitsFromClicksPromoted | LONG | The number of Amazon product review page visits for products directly promoted in the campaign, attributed to an ad click. |\n","| Product review page visits | metric.productReviewPageVisitsFromViewsPromoted | LONG | The number of Amazon product review page visits directly promoted in the campaign, attributed to an ad view. |\n","| Product review page visits | metric.productReviewPageVisitsFromClicksHalo | LONG | The number of Amazon product review page visits for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Product review page visits | metric.productReviewPageVisitsFromViewsHalo | LONG | The number of Amazon product review page visits for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptions | LONG | The number of Subscribe & Save subscriptions attributed to an ad interaction. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromClicks | LONG | The number Subscribe & Save subscriptions attributed to an ad click. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromViews | LONG | The number of Subscribe & Save subscriptions attributed to an ad view. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsPromoted | LONG | The number of Subscribe & Save subscriptions for products directly promoted in the campaign, attributed to an ad interaction. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromClicksPromoted | LONG | The number of Subscribe & Save subscriptions for products directly promoted in the campaign, attributed to an ad click. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromViewsPromoted | LONG | The number of Subscribe & Save subscriptions directly promoted in the campaign, attributed to an ad view. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsHalo | LONG | The number of Subscribe & Save subscriptions for highly relevant products that were not directly promoted in the campaign, attributed to an ad interaction. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromClicksHalo | LONG | The number of Subscribe & Save subscriptions for highly relevant products that were not directly promoted in the campaign, attributed to an ad click. |\n","| Subscribe save subscriptions | metric.subscribeAndSaveSubscriptionsFromViewsHalo | LONG | The number of Subscribe & Save subscriptions for highly relevant products that were not directly promoted in the campaign, attributed to an ad view. |\n","| Long term sales | metric.longTermSales | CURRENCY | Attributed sales plus the estimated 365-day value of new-to-brand shopper engagements attributed to the campaign, based on the brand's historical shopping patterns. |\n"," Amazon device conversions\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Subscription sign ups | metric.subscriptionSignUps | LONG | The number of times a shopper signed up for a paid or free trial digital subscription for a product directly promoted in the campaign, attributed to an ad interaction. |\n","| Subscription sign ups | metric.subscriptionSignUpsFromClicks | LONG | The number subscription sign-ups for a promoted product attributed to an ad click. |\n","| Subscription sign ups | metric.subscriptionSignUpsFromViews | LONG | The number of subscription sign-ups for a promoted product attributed to an ad view. |\n","| Paid subscription sign ups | metric.paidSubscriptionSignUps | LONG | The number of times a shopper signed up for a paid digital subscription for a product directly promoted in the campaign, attributed to an ad interaction. |\n","| Paid subscription sign ups | metric.paidSubscriptionSignUpsFromClicks | LONG | The number of paid subscription sign-ups for a promoted product attributed to an ad click. |\n","| Paid subscription sign ups | metric.paidSubscriptionSignUpsFromViews | LONG | The number of paid subscription sign-ups for a promoted product attributed to an ad view. |\n","| Free trial subscription sign ups | metric.freeTrialSubscriptionSignUps | LONG | The number of times a shopper signed up for a free trial digital subscription for a product directly promoted in the campaign, attributed to an ad interaction. |\n","| Free trial subscription sign ups | metric.freeTrialSubscriptionSignUpsFromClicks | LONG | The number of free trial subscription sign-ups for a promoted product attributed to an ad click. |\n","| Free trial subscription sign ups | metric.freeTrialSubscriptionSignUpsFromViews | LONG | The number of free trial subscription sign-ups for a promoted product attributed to an ad view. |\n","| App subscription sign ups | metric.appSubscriptionSignUps | LONG | The number of paid and free trial app subscription sign-ups attributed to an ad interaction. |\n","| App subscription sign ups | metric.appSubscriptionSignUpsFromClicks | LONG | The number of paid and free trial app subscription sign-ups attributed to an ad click. |\n","| App subscription sign ups | metric.appSubscriptionSignUpsFromViews | LONG | The number of app subscription sign-ups (paid and free-trial) attributed to an ad view. |\n","| Paid app subscription sign ups | metric.paidAppSubscriptionSignUps | LONG | The number of paid app subscription sign-ups attributed to an ad interaction. |\n","| Paid app subscription sign ups | metric.paidAppSubscriptionSignUpsFromClicks | LONG | The number of paid app subscription sign-ups attributed to an ad click. |\n","| Paid app subscription sign ups | metric.paidAppSubscriptionSignUpsFromViews | LONG | The number of paid app subscription sign-ups attributed to an ad view. |\n","| Free trial app subscription sign ups | metric.freeTrialAppSubscriptionSignUps | LONG | The number of free trial app subscription sign-ups attributed to an ad interaction. |\n","| Free trial app subscription sign ups | metric.freeTrialAppSubscriptionSignUpsFromClicks | LONG | The number of free trial app subscription sign-ups attributed to an ad click. |\n","| Free trial app subscription sign ups | metric.freeTrialAppSubscriptionSignUpsFromViews | LONG | The number of free trial app subscription sign-ups attributed to an ad view. |\n","| Appstore opens | metric.appstoreOpens | LONG | The number of times shoppers opened an app, including first time and reopens, attributed to an ad interaction. |\n","| Appstore opens | metric.appstoreOpensFromClicks | LONG | The number of times shoppers opened an app, including first time and reopens attributed to an ad click. |\n","| Appstore opens | metric.appstoreOpensFromViews | LONG | The number of times shoppers opened an app, including first time and reopens attributed to an ad view. |\n","| Appstore opens | metric.appstoreUsageHours | DECIMAL | The total hours spent using an app during first-time and repeat sessions attributed to an ad interaction. |\n","| Appstore opens | metric.appstoreUsageHoursFromClicks | DECIMAL | The total hours spent using an app the first time and during repeat sessions, attributed to an ad click. |\n","| Appstore opens | metric.appstoreUsageHoursFromViews | DECIMAL | The total hours spent using an app the first time and during repeat sessions, attributed to an ad view. |\n","| Appstore first opens | metric.appstoreFirstOpens | LONG | The number of first time app opens attributed to an ad interaction. |\n","| Appstore first opens | metric.appstoreFirstOpensFromClicks | LONG | The number of first time app opens attributed to an ad click. |\n","| Appstore first opens | metric.appstoreFirstOpensFromViews | LONG | The number of first time app opens attributed to an ad view. |\n","| Appstore first opens | metric.appstoreFirstSessionHours | DECIMAL | The total hours shoppers spent using an app during first time app sessions attributed to an ad interaction. |\n","| Appstore first opens | metric.appstoreFirstSessionHoursFromClicks | DECIMAL | The total hours shoppers spent using an app during first time app sessions attributed to an ad click. |\n","| Appstore first opens | metric.appstoreFirstSessionHoursFromViews | DECIMAL | The total hours shoppers spent using an app during first time app sessions attributed to an ad view. |\n","| Appstore repeat opens | metric.appstoreRepeatOpens | LONG | The number of repeat app opens attributed to an ad interaction. |\n","| Appstore repeat opens | metric.appstoreRepeatOpensFromClicks | LONG | The number of repeat app opens attributed to an ad click. |\n","| Appstore repeat opens | metric.appstoreRepeatOpensFromViews | LONG | The number of repeat app opens attributed to an ad view. |\n","| Appstore repeat opens | metric.appstoreRepeatSessionHours | DECIMAL | The total hours shoppers spent using an app during repeat sessions attributed to an ad interaction. This excludes the first session. |\n","| Appstore repeat opens | metric.appstoreRepeatSessionHoursFromClicks | DECIMAL | The total hours shoppers spent using an app during repeat sessions attributed to an ad click. This excludes the first session. |\n","| Appstore repeat opens | metric.appstoreRepeatSessionHoursFromViews | DECIMAL | The total hours shoppers spent using an app during repeat sessions attributed to an ad view. This excludes the first session. |\n","| Alexa skill enable | metric.alexaSkillEnable | LONG | The number of times a shopper enabled an Alexa skill, attributed to an ad interaction. |\n","| Alexa skill enable | metric.alexaSkillEnableFromClicks | LONG | The number of times a shopper enabled an Alexa skill, attributed to an ad click. |\n","| Alexa skill enable | metric.alexaSkillEnableFromViews | LONG | The number of times a shopper enabled an Alexa skill, attributed to an ad view. |\n","| Alexa skill invocations | metric.alexaSkillInvocations | LONG | The number of times shoppers launched a promoted Alexa skill, attributed to an ad interaction. This can include tap, touch, and voice invocations. |\n","| Alexa skill invocations | metric.alexaSkillInvocationsFromClicks | LONG | The number of times shoppers launched a promoted Alexa skill, attributed to an ad click. This can include tap, touch, and voice invocations. |\n","| Alexa skill invocations | metric.alexaSkillInvocationsFromViews | LONG | The number of times shoppers launched a promoted Alexa skill, attributed to an ad view. |\n"," Amazon video conversions\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Add to watchlist | metric.addToWatchlist | LONG | The number of times a shopper added a product to their watchlist attributed to an ad interaction. |\n","| Add to watchlist | metric.addToWatchlistFromClicks | LONG | The number of times a shopper added a product to their watchlist, attributed to an ad click. |\n","| Add to watchlist | metric.addToWatchlistFromViews | LONG | The number of times a shopper added a product to their watchlist, attributed to an ad view. |\n","| Downloaded video plays | metric.downloadedVideoPlays | LONG | The number of times a shopper downloaded and played a video product attributed to an ad interaction. |\n","| Downloaded video plays | metric.downloadedVideoPlaysFromClicks | LONG | The number of times a shopper downloaded and played a video product, attributed to an ad click. |\n","| Downloaded video plays | metric.downloadedVideoPlaysFromViews | LONG | The number of times a shopper downloaded and played a video product, attributed to an ad view. |\n","| Rentals | metric.rentals | LONG | The number of times a shopper rented a video attributed to an ad interaction. |\n","| Rentals | metric.rentalsFromClicks | LONG | The number of times a shopper rented a video, attributed to an ad click. |\n","| Rentals | metric.rentalsFromViews | LONG | The number of times a shopper rented a video, attributed to an ad view. |\n","| Trailer plays | metric.trailerPlays | LONG | The number of times a shopper played a video trailer attributed to an ad interaction. |\n","| Trailer plays | metric.trailerPlaysFromClicks | LONG | The number of times a shopper played a video trailer, attributed to an ad click. |\n","| Trailer plays | metric.trailerPlaysFromViews | LONG | The number of times a shopper played a video trailer, attributed to an ad view. |\n","| Video stream plays | metric.videoStreamPlays | LONG | The number of times a shopper streamed a video, attributed to an ad interaction. |\n","| Video stream plays | metric.videoStreamPlaysFromClicks | LONG | The number of times a shopper streamed a video, attributed to an ad click. |\n","| Video stream plays | metric.videoStreamPlaysFromViews | LONG | The number of times a shopper streamed a video, attributed to an ad view. |\n"," Combined conversions\n","| Metric family | Field ID | Data type | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| Purchases combined | metric.combinedPurchases | LONG | The number of purchases on and off Amazon attributed to an ad interaction. |\n","| Purchases combined | metric.combinedSales | CURRENCY | The sales from purchases on and off Amazon attributed to an ad interaction. |\n","| Purchases combined | metric.combinedUnitsSold | LONG | The number of product units in purchases on and off Amazon, attributed to an ad interaction. A single purchase event may include multiple units of the same product. |\n","| Purchases combined | metric.combinedPurchasesFromClicks | LONG | The number of purchases on and off Amazon, attributed to an ad click. |\n","| Purchases combined | metric.combinedPurchasesFromViews | LONG | The number of purchases on and off Amazon, attributed to an ad view. |\n"],"documentType":"guide"},{"title":"Ads converted product","sectionHeader":{"type":2,"text":"Reporting thresholds"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-converted-product","content":[" Amazon Ads applies reporting thresholds to high-cardinality dimensions, grouping values that do not meet the threshold into an (Other) row — see How the datasets work.\n"," In this dataset, convertedProduct.id is subject to reporting thresholds. An ASIN that does not meet the threshold at a grain has its metrics grouped into a single (Other) row for that grain. If you see fewer products than you expect, some ASINs did not meet the threshold at the dataset's granularity.\n"],"documentType":"guide"},{"title":"Ads converted product","sectionHeader":{"type":2,"text":"Maintain a staging layer"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-converted-product","content":[" To report at a grain coarser than the delivered record key, maintain a record-level staging layer, keeping the highest streamBatch.version per key — see How the datasets work.\n"," To maintain a weekly view of this daily dataset, aggregate each new daily record with the other days of that week. Once the staging layer is current, aggregate from it to your grain:\n"],"documentType":"guide"},{"title":"Ads converted product","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/datasets/ads-converted-product","content":[],"documentType":"guide"},{"title":"Get started","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/get-started","content":[" Set up an Amazon Marketing Stream Version 2 (Stream v2) subscription that delivers a dataset to your Amazon S3 bucket as Apache Parquet files. You begin with Amazon Ads API credentials and end with an ACTIVE subscription and your first delivery.\n"],"documentType":"guide"},{"title":"Get started","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/amazon-marketing-stream/v2/get-started","content":["Amazon Ads API access. Complete the Amazon Ads API Onboarding and Getting started processes and be approved for access, so you have a client ID and an access token with access to the advertiser account you want to subscribe. - An AWS account. You deliver data to resources in your own AWS account. If you do not have one, see Create and activate an AWS account. - Know which dataset you want. Review the available Datasets and choose the one whose schema, granularity, and delivery cadence match your need.\n"," Each step below links to a page that lists any further prerequisites it needs, so you can set them up as you go.\n"],"documentType":"guide"},{"title":"Get started","sectionHeader":{"type":2,"text":"Authentication"},"path":"/en-us/guides/amazon-marketing-stream/v2/get-started","content":[" All requests require the following headers:\n","| Header | Description |\n","\\|---\\|---\\|\n","| Amazon-Advertising-API-ClientId | Your Login with Amazon (LWA) client ID. |\n","| Authorization | Bearer followed by your LWA access token. |\n"," The advertiser account is supplied in the request body through accessRequestedAccounts, not through a scope header. Each subscription is for a single advertiser account, provided as advertiserAccountId (an Amazon DSP (ADSP) Regional Account or a Global Account (SGA)).\n"],"documentType":"guide"},{"title":"Get started","sectionHeader":{"type":2,"text":"Steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/get-started","content":[],"documentType":"guide"},{"title":"Get started","sectionHeader":{"type":3,"text":"1. Set up your destination"},"path":"/en-us/guides/amazon-marketing-stream/v2/get-started","content":[" Create the S3 bucket and SQS notification queue and grant Stream access.\n"," Choose one of:\n","Set up destination with CloudFormation (recommended). Deploy one stack that creates the bucket, queue, and all required policies. See Set up with CloudFormation. - Set up destination manually. Create the bucket and queue and attach the policies yourself. See Set up manually. - V2 reference application (coming soon). A sample application that provisions your destination and subscription programmatically.\n"],"documentType":"guide"},{"title":"Get started","sectionHeader":{"type":3,"text":"2. Create a subscription"},"path":"/en-us/guides/amazon-marketing-stream/v2/get-started","content":[],"documentType":"guide"},{"title":"Get started","sectionHeader":{"type":3,"text":"3. Receive your data"},"path":"/en-us/guides/amazon-marketing-stream/v2/get-started","content":[" Your first delivery includes historical data for the dataset's restatement period, so you begin with populated data. See Data delivery.\n"],"documentType":"guide"},{"title":"Get started","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/get-started","content":[],"documentType":"guide"},{"title":"Set up your destination","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/set-up-your-destination","content":[" Create an Amazon S3 bucket for the Parquet files and an Amazon SQS queue for the delivery notifications, then grant Amazon Marketing Stream Version 2 (Stream v2) access to both. Stream v2 treats the two as one destination, identified by their Amazon Resource Names (ARNs).\n"," You can reuse one destination across subscriptions. Stream v2 writes each dataset under its own streamDatasetId= prefix, so subscriptions that share a destination never overwrite each other. You can also use separate destinations, up to the limit.\n"],"documentType":"guide"},{"title":"Set up your destination","sectionHeader":{"type":2,"text":"Before you start"},"path":"/en-us/guides/amazon-marketing-stream/v2/set-up-your-destination","content":["You need an AWS account to create your destination in, and permission to attach a bucket policy to an S3 bucket and an access policy to an SQS queue. If you do not have an account, see Create and activate an AWS account. - Dedicate the S3 bucket to Stream. Stream controls the full key path, so an application writing its own objects to the same bucket can collide with delivered data. - Create the bucket and the queue in the same AWS Region, in a Region allowed for your geo (see Supported Regions). A cross-Region pair fails destination validation when you create the subscription. - Use a separate bucket and queue for each client application. A destination belongs to the application that first uses it, so a second application cannot register the same bucket and queue.\n"],"documentType":"guide"},{"title":"Set up your destination","sectionHeader":{"type":2,"text":"Set up destination with CloudFormation (recommended)"},"path":"/en-us/guides/amazon-marketing-stream/v2/set-up-your-destination","content":[" Use the CloudFormation template to create your destination. One stack creates the S3 bucket, the SQS notification queue and dead-letter queue, customer-managed KMS keys, S3 access logging, and every resource policy Stream requires — so you can skip the manual steps below and go straight to Create a subscription.\n"," To import and deploy the template, follow the CloudFormation walkthrough in Creating queues with CloudFormation. The console flow is the same; the parameters and outputs differ for Stream v2:\n","Parameters — enter a Destination name (lowercase, 3–24 characters; use a different name per client application) and your advertiser geographic realm (NA, EU, or FE). Deploy the stack in a Region allowed for that realm (see Supported Regions); the template rejects an unsupported Region. - Outputs — after the stack reaches CREATE_COMPLETE, open the Outputs tab and use StreamDataBucketArn and StreamDestinationQueueArn (or StreamDestinationConfiguration, which formats both for the create-subscription request body).\n"],"documentType":"guide"},{"title":"Set up your destination","sectionHeader":{"type":2,"text":"Set up destination manually"},"path":"/en-us/guides/amazon-marketing-stream/v2/set-up-your-destination","content":[" If you do not use CloudFormation, create the bucket and queue and attach the policies yourself.\n"],"documentType":"guide"},{"title":"Set up your destination","sectionHeader":{"type":3,"text":"Step 1: Create the S3 bucket and SQS queue"},"path":"/en-us/guides/amazon-marketing-stream/v2/set-up-your-destination","content":["Create an Amazon S3 bucket in an allowed Region for your geo. Stream delivers the Parquet files here. 2. Create a standard Amazon SQS queue in the same Region as the bucket. Stream sends a delivery notification here for each set of files it writes. Use a standard queue, not a FIFO queue — Stream does not require ordered delivery, and you determine record order from the data itself (see Process your data).\n"],"documentType":"guide"},{"title":"Set up your destination","sectionHeader":{"type":3,"text":"Step 2: Grant Stream access"},"path":"/en-us/guides/amazon-marketing-stream/v2/set-up-your-destination","content":[" Stream delivers and validates from two roles in account 926844853897. Grant each role only the permissions it uses:\n","PublisherRole writes the Parquet files and sends the notifications. Grant it s3:PutObject and sqs:SendMessage. It cannot read, list, or delete your objects. - ReviewerRole confirms your destination exists and is reachable when you create a subscription. Grant it s3:ListBucket (restricted by an s3:prefix condition so it cannot enumerate your objects) and sqs:GetQueueAttributes.\n"," Add the following policies. Each grants access to Stream's roles through a resource-based policy — an S3 bucket policy on your bucket and an SQS access policy on your queue. Each role is identified by its Amazon Resource Name (ARN).\n"," S3 bucket policy — replace {YOUR_BUCKET_NAME} with your bucket name.\n"," SQS queue policy — replace {YOUR_QUEUE_NAME}, {YOUR_ACCOUNT_ID}, and {REGION}.\n"],"documentType":"guide"},{"title":"Set up your destination","sectionHeader":{"type":3,"text":"Step 3 (optional): Grant access to a customer-managed KMS key"},"path":"/en-us/guides/amazon-marketing-stream/v2/set-up-your-destination","content":[" If your S3 bucket or SQS queue is encrypted with a customer-managed AWS KMS key, add the following statement to the key policy. If you use the default S3 server-side encryption (SSE-S3, AES-256) or the default SQS server-side encryption (SSE-SQS), you do not need this step.\n"],"documentType":"guide"},{"title":"Set up your destination","sectionHeader":{"type":2,"text":"Supported Regions"},"path":"/en-us/guides/amazon-marketing-stream/v2/set-up-your-destination","content":[" Create your bucket and queue in one of the Regions allowed for your geo. Both resources must be in the same Region.\n","| Geo | Allowed Regions |\n","\\|---\\|---\\|\n","| North America (NA) | us-east-1 |\n","| Europe (EU) | eu-west-1, eu-west-2, eu-south-2 |\n","| Far East (FE) | us-west-2, ap-southeast-1 |\n"],"documentType":"guide"},{"title":"Set up your destination","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/set-up-your-destination","content":[],"documentType":"guide"},{"title":"Create a subscription","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/create-a-subscription","content":[" Subscribe an advertiser account to a dataset so Amazon Marketing Stream Version 2 (Stream v2) begins delivering that dataset to your destination. A subscription pairs one dataset with one advertiser account and one destination. It becomes ACTIVE on creation, and your first delivery includes historical data for the dataset's restatement period.\n"],"documentType":"guide"},{"title":"Create a subscription","sectionHeader":{"type":2,"text":"Before you start"},"path":"/en-us/guides/amazon-marketing-stream/v2/create-a-subscription","content":["A destination that has Stream access — an S3 bucket and SQS queue with the required policies. See Set up your destination. - The advertiser account ID you want to subscribe (an Amazon DSP (ADSP) Regional Account or a Global Account). - The dataset ID you want to receive. See Datasets.\n"," To create a subscription, call the create endpoint with the advertiser account, the dataset, and your destination.\n"," POST /adsApi/v1/create/streamSubscriptions\n"," The request requires these headers:\n","| Header | Description |\n","\\|---\\|---\\|\n","| Amazon-Advertising-API-ClientId | Your Login with Amazon (LWA) client ID. |\n","| Authorization | Bearer followed by your LWA access token. |\n","| Content-Type | application/json |\n"," And these body fields:\n","| Field | Required | Description |\n","\\|---\\|---\\|---\\|\n","| accessRequestedAccounts\\[].advertiserAccountId | Yes | The advertiser account the subscription delivers data for (an Amazon DSP (ADSP) Regional Account or a Global Account (SGA)). |\n","| streamSubscriptions\\[].configuration.dataset.datasetId | Yes | The dataset this subscription delivers. See Datasets. |\n","| streamSubscriptions\\[].destination.s3Destination.bucketArn | Yes | The ARN of the S3 bucket that receives the Parquet files. |\n","| streamSubscriptions\\[].destination.s3Destination.notification.queueArn | Yes | The ARN of the SQS queue that receives a notification for each delivery. |\n"," Example request\n"," These endpoints return a Multi-Status (207) response. Each request creates a single subscription: you supply one entry in the streamSubscriptions array and receive one result. The result appears in the success array if it succeeded or the errors array if it failed, at index 0. Read the outcome from those arrays, not the top-level HTTP status.\n"," A successful subscription is returned under success with status set to ACTIVE:\n"," A failed subscription is returned under errors with a code and message:\n"," The subscription is ACTIVE on creation. Your first delivery includes historical data for the dataset's restatement period. See Data delivery.\n"],"documentType":"guide"},{"title":"Create a subscription","sectionHeader":{"type":2,"text":"Error handling"},"path":"/en-us/guides/amazon-marketing-stream/v2/create-a-subscription","content":["| code | HTTP status | Description |\n","\\|---\\|---\\|---\\|\n","| BAD_REQUEST | 207 (per item) | Invalid parameters, a duplicate subscription, an invalid destination, or a destination in an unsupported Region. |\n","| FORBIDDEN | 207 (per item) | The caller is not authorized for the requested advertiser account, or for the destination. |\n","| UNAUTHORIZED | 401 | The access token is invalid or expired. |\n","| TOO_MANY_REQUESTS | 429 | The request was rate limited. |\n","| INTERNAL_ERROR | 500 | An internal error occurred. Retry the request. |\n"],"documentType":"guide"},{"title":"Create a subscription","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/create-a-subscription","content":[],"documentType":"guide"},{"title":"Data delivery","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/data-delivery","content":[" Once your subscription is ACTIVE, Stream v2 writes Apache Parquet files to your S3 bucket and sends a notification to your SQS queue for each delivery.\n"],"documentType":"guide"},{"title":"Data delivery","sectionHeader":{"type":2,"text":"Before you start"},"path":"/en-us/guides/amazon-marketing-stream/v2/data-delivery","content":["An ACTIVE subscription. Delivery begins once your subscription is active. See Create a subscription.\n"],"documentType":"guide"},{"title":"Data delivery","sectionHeader":{"type":2,"text":"How delivery works"},"path":"/en-us/guides/amazon-marketing-stream/v2/data-delivery","content":[" Stream v2 delivers your data to the destination you configured — an S3 bucket paired with an SQS queue — in two steps for each batch:\n","The data is written to your S3 bucket as one or more Apache Parquet files. The files stay in your bucket for you to read and re-read. 2. One or more notifications are sent to your SQS queue, together listing the S3 URIs of the files that were written. A batch can span multiple delivery notifications (see Delivery guarantees).\n"," You consume the data by reading each notification and then reading the S3 URIs it lists — rather than listing the bucket — so you process each file as soon as it is ready.\n"],"documentType":"guide"},{"title":"Data delivery","sectionHeader":{"type":2,"text":"The delivery notification"},"path":"/en-us/guides/amazon-marketing-stream/v2/data-delivery","content":[" The notification names the dataset, the batch, and the exact S3 files to read for each delivery. Read notifications to process each delivery rather than listing the S3 bucket. The files are always present in S3 as well, but the notification names exactly which files to read and how to interpret them.\n","| Field | Description |\n","\\|---\\|---\\|\n","| streamDeliveryId | A unique ID for this delivery attempt. Use it when contacting support. A redelivery of the same data can carry a different streamDeliveryId, so do not use it to deduplicate (see Delivery guarantees). |\n","| streamDataset.streamDatasetId | The dataset identifier, including its version, such as ads-performance-v1. |\n","| streamDataset.name / streamDataset.version | The dataset name and version as separate fields. |\n","| streamBatch.startDateTime / endDateTime | The time window the batch covers, in ISO 8601 UTC (YYYY-MM-DDTHH:mm:ssZ), as a half-open interval \\[startDateTime, endDateTime). startDateTime is inclusive and endDateTime is exclusive, so a record timestamped exactly at endDateTime belongs to the next batch. Consecutive batches do not overlap — one batch's endDateTime equals the next batch's startDateTime — so you can combine them without double-counting boundary records. |\n","| streamBatch.version | An opaque, increasing version number (for example, 179025460429837662), not a timestamp. The same value appears in the Parquet records and in the streamBatchVersion= segment of the S3 key. This value can exceed the safe integer range of a 64-bit floating-point number, so read it as a 64-bit integer, string, or big-integer type and never parse it into a floating-point number, which would silently lose precision and break version comparison. Use streamBatch.version to determine a record's latest state (see Interpreting the data). |\n","| s3Uris | The S3 files to read for this delivery, one or more files. |\n"],"documentType":"guide"},{"title":"Data delivery","sectionHeader":{"type":2,"text":"Your first delivery"},"path":"/en-us/guides/amazon-marketing-stream/v2/data-delivery","content":[" Your first delivery includes historical data. When you create a subscription, Stream v2 delivers your entire historical data for the dataset's restatement period, within about a day of activation. These are the dataset's records for time windows before you created the subscription — the same records, in the same format, that you receive going forward. Stream v2 then delivers new records as they become available. How far back the history reaches depends on the dataset. See your dataset guide for the window.\n"," Each record carries the time window it covers, in the streamBatch.startDateTime and streamBatch.endDateTime fields of its notification, so you can tell historical records from new ones.\n"," This history arrives the same way as ongoing deliveries, as Parquet files and SQS notifications. Because early deliveries can carry more data, process each delivery as its notification arrives rather than waiting for the history to finish.\n"],"documentType":"guide"},{"title":"Data delivery","sectionHeader":{"type":2,"text":"Delivery guarantees"},"path":"/en-us/guides/amazon-marketing-stream/v2/data-delivery","content":[" Design your consumer for the following behavior.\n","At-least-once delivery. You can receive the same data more than once, and the same records can arrive under different S3 object keys — so you cannot deduplicate at the file level. Read every delivered object and reconcile at the record level: upsert each record on its full key (all dimension fields), keeping the highest streamBatch.version. No file-level identifier is unique per batch, so do not skip files by S3 object key or streamDeliveryId (see Interpreting the data). - No ordering guarantee. Notifications and deliveries can arrive out of order. Never treat arrival order as the event time or version order — use streamBatch.version to determine the latest state of a record. - A file can contain data for more than one subscription. When several subscriptions deliver the same dataset to one destination, Stream v2 can write their records into the same Parquet file. The files are separated only by streamDatasetId= prefix, not by subscription, so do not assume a file holds data for a single subscription — filter the records on the dimensions you need (for example, advertiserAccount.id) to select the rows you want. - A batch can span multiple delivery notifications. The files for one time-window batch can arrive across several SQS notifications rather than one. Each notification names the dataset, the batch, and a subset of the batch's files. This needs no special handling: process the files from each notification as it arrives. Because you keep the highest streamBatch.version per record, the result is independent of how the batch's files are grouped across notifications or the order in which they arrive.\n"," For the full set of rules that keep your integration resilient as datasets evolve, see Build a resilient consumer.\n"],"documentType":"guide"},{"title":"Data delivery","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/data-delivery","content":[],"documentType":"guide"},{"title":"Process your data","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[" Stream v2 delivers Parquet files under a partitioned key path in your S3 bucket. This page shows how to read those files, query them in place, interpret the records, and reduce them to a current view.\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":2,"text":"Before you start"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":["Delivered Parquet files in your S3 bucket. Stream begins delivering once your subscription is ACTIVE. See Data delivery.\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":2,"text":"The S3 key path"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[" Stream v2 writes each file under a key that encodes the dataset, granularity, event-time date, and batch version:\n"," Daily-granularity datasets omit the hour= segment:\n"," Each path segment is a partition: streamDatasetId, granularity, year, month, day, hour (hourly datasets only), and streamBatchVersion. Every file is namespaced under its dataset version, so multiple subscriptions can share one bucket without colliding.\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":2,"text":"Query the data in place"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[" Because the key path is Hive-style partitioned, you can register the data as a table in AWS Glue and query it with Amazon Athena without moving the files. Point the table at the dataset prefix, and Athena reads the partition columns from the key path:\n"," Filter on the partition columns (year, month, day, and hour for hourly datasets) so Athena scans only the files for that time window. These partition columns come from the S3 key path, not from the dataset schema — Athena derives them when you register the partitioned table. Each row's data columns match the field IDs in your dataset schema, such as campaign.id and metric.clicks.\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":2,"text":"Interpreting the data"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[" A record is one row of a dataset, identified by its dimension fields. Each record represents the complete state of one row, not an incremental change. The following rules describe how to combine deliveries into a current view.\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":3,"text":"Metrics are totals"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[" A metric in a record is the total value, not a change to add. If a record shows clicks = 7, the row has 7 total clicks — not 7 to add to a running count.\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":3,"text":"Latest version"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[" For example, two deliveries carry the same record (campaign.id=C-1) with different versions:\n","| streamBatch.version | campaign.id | metric.clicks | metric.impressions | Result |\n","\\|---\\|---\\|---\\|---\\|---\\|\n","| 1000 | C-1 | 5 | 1000 | Superseded |\n","| 2000 | C-1 | 7 | 1500 | Current state |\n"," The higher version (2000) wins, so the current state of C-1 is metric.clicks=7, metric.impressions=1500. Because deliveries can arrive out of order, always keep the record with the highest version per key, not the most recently received record.\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":3,"text":"Deleted records"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[" A delete arrives as a record whose metric columns are all null while its key and dimension columns stay populated. Upsert every record — apply an insert-or-update keyed on the record's key. A record with all-null metrics means the row is deleted. For the same record C-1:\n","| streamBatch.version | campaign.id | metric.clicks | metric.impressions | Result |\n","\\|---\\|---\\|---\\|---\\|---\\|\n","| 3000 | C-1 | null | null | Deleted — remove C-1 |\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":3,"text":"Changed dimensions"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[" When a mutable dimension changes, such as a placement name, you receive two records: a delete of the old dimension value (metrics nulled) and a create with the new dimension value and current metrics. Both carry a higher streamBatch.version than the original, so the highest-version rule resolves them in order.\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":2,"text":"Build a resilient consumer"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[" Datasets evolve — columns are added, types are widened, and enum values are introduced — and most of these changes arrive without a new dataset version. Build your consumer to the following rules so these changes land without breaking your integration. A change that breaks only a consumer that does not follow these rules is not treated as a breaking change.\n","Select columns by name, not by position. Read campaign.id, not \"the third column.\" Column order in the Parquet files is not part of the contract and can change in any delivery. - Ignore columns you do not recognize. Your load must succeed when a column you have not seen before appears. Stream adds columns without a version change. - Treat every column as nullable. Do not impose your own not-null constraints. A null is routine — a delete arrives as a record with all metric columns null. - Accommodate type widening. Read each column at the type the schema declares, and build your pipeline to tolerate that type later widening — for example, an integer column that becomes a decimal. Do not impose a tighter type, length, or range than the schema declares. You do not need to read every column as the widest possible type; type changes are announced in the release notes so you can adjust before they take effect. - Route unrecognized enum values to a default branch. Never fail on a value you do not recognize. Enum domains grow without a version change; adopt a new value when you are ready to use it. - Key your staging layer on all dimension fields. A record's key is all of its dimension fields together — do not add metric columns to your key or omit a dimension field (see Interpreting the data). - Do not depend on delivery mechanics. File count, file size, record order, and how records are grouped into files can change in any delivery. Only the published schema is part of the contract (see Data delivery). - Ingest incrementally from the notifications. Process only the files each SQS notification lists, and merge them into a staging layer where you reconcile record versions. A changed or widened record can land in any event-date partition, so rescanning the whole bucket on each run reprocesses far more data than the update requires — the notifications name exactly which files changed. - Read one dataset version's prefix at a time. Each dataset version delivers under its own S3 prefix that never moves. Do not combine two versions in one Glue table — during a migration both carry the same time periods, and combining them double-counts.\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":2,"text":"Reduce to a current view"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[" A dataset can contain more than one record for the same key across batches, because Stream delivers each update as a new record. To get the current state, keep the record with the highest streamBatch.version per key, and drop records whose metrics are all null (a delete). For the rules behind this, see Interpreting the data.\n"," The following query keeps the highest-version record per key for a daily dataset. Replace the key columns with all dimension fields of your dataset schema.\n"],"documentType":"guide"},{"title":"Process your data","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/process-your-data","content":[],"documentType":"guide"},{"title":"Manage subscriptions","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions","content":[" Retrieve a subscription's status, query all subscriptions for an advertiser account, and delete a subscription. Each Amazon Marketing Stream Version 2 (Stream v2) call carries the same accessRequestedAccounts.advertiserAccountId you used to create the subscription, and returns only subscriptions your own application created for that account.\n"],"documentType":"guide"},{"title":"Manage subscriptions","sectionHeader":{"type":2,"text":"Before you start"},"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions","content":["At least one subscription created for your advertiser account. See Create a subscription.\n"],"documentType":"guide"},{"title":"Manage subscriptions","sectionHeader":{"type":2,"text":"Subscription status"},"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions","content":[" A subscription is in one of the following states.\n","| Status | Description | Terminal |\n","\\|---\\|---\\|---\\|\n","| ACTIVE | The subscription is delivering data. This is the status set on creation. | No |\n","| SUSPENDED | The subscription stopped delivering because Stream could no longer reach your destination. | Yes |\n","| ARCHIVED | The subscription was deleted by your application and delivers no further data. | Yes |\n"," Stream periodically re-validates that your destination exists and is reachable. If you delete the S3 bucket or SQS queue, or remove the permission Stream uses to confirm it, the subscription moves to SUSPENDED. Keep your S3 bucket, SQS queue, and their policies in place for the life of the subscription.\n"],"documentType":"guide"},{"title":"Manage subscriptions","sectionHeader":{"type":2,"text":"Retrieve a subscription"},"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions","content":[" To retrieve a subscription by ID, call the retrieve endpoint with the same advertiser account you used to create it.\n"," POST /adsApi/v1/retrieve/streamSubscriptions\n"," The request takes these body fields:\n","| Field | Required | Description |\n","\\|---\\|---\\|---\\|\n","| accessRequestedAccounts\\[].advertiserAccountId | Yes | The advertiser account that owns the subscription. |\n","| streamSubscriptionIds | Yes | The subscription ID to retrieve. Each request operates on a single subscription, so pass exactly one ID. |\n"," Example request\n"," The subscription is returned under success, including its status, destination, and configuration:\n"],"documentType":"guide"},{"title":"Manage subscriptions","sectionHeader":{"type":2,"text":"Query subscriptions"},"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions","content":[" To return every subscription for an advertiser account, call the query endpoint. Query returns subscriptions in every status, including ARCHIVED.\n"," POST /adsApi/v1/query/streamSubscriptions\n"," The request takes these body fields:\n","| Field | Required | Description |\n","\\|---\\|---\\|---\\|\n","| accessRequestedAccounts\\[].advertiserAccountId | Yes | The advertiser account whose subscriptions you want to return. |\n","| maxResults | No | The number of subscriptions returned per page (1–5000). |\n","| nextToken | No | The pagination token from a previous response. Omit it on the first call. |\n"," Example request\n"," The response lists the subscriptions and, when more results remain, a nextToken:\n"," Identify each subscription by its configuration.dataset.datasetId. Do not depend on result ordering, which is not guaranteed between calls. When the response includes a nextToken, pass it as nextToken on the next call to page through the results.\n"],"documentType":"guide"},{"title":"Manage subscriptions","sectionHeader":{"type":2,"text":"Delete a subscription"},"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions","content":[" To stop delivery, call the delete endpoint. Deleting sets the subscription's status to ARCHIVED and delivery stops — no further Parquet files or notifications are sent. Files already delivered to your S3 bucket stay in place.\n"," POST /adsApi/v1/delete/streamSubscriptions\n"," The request takes these body fields:\n","| Field | Required | Description |\n","\\|---\\|---\\|---\\|\n","| accessRequestedAccounts\\[].advertiserAccountId | Yes | The advertiser account that owns the subscription. |\n","| streamSubscriptionIds | Yes | The subscription ID to delete. Each request operates on a single subscription, so pass exactly one ID. |\n"," Example request\n"," The deleted subscription is returned under success with status set to ARCHIVED:\n"],"documentType":"guide"},{"title":"Manage subscriptions","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions","content":[],"documentType":"guide"},{"title":"Limits","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions/limits","content":[" Amazon Marketing Stream Version 2 (Stream v2) enforces the following limits.\n"],"documentType":"guide"},{"title":"Limits","sectionHeader":{"type":2,"text":"Subscription limits"},"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions/limits","content":["| Limit | Value | Description |\n","\\|---\\|---\\|---\\|\n","| Unique subscription | 1 | You cannot create two subscriptions that deliver the same dataset to the same destination for the same advertiser account. |\n","| Destinations per client application | 5 | The total distinct (S3 bucket + SQS queue) destinations your application can register across all datasets. You can register more than one, up to this limit. |\n"," Exceeding the unique-subscription limit returns BAD_REQUEST with the message \"A subscription already exists for this dataset, destination, and account combination.\"\n"],"documentType":"guide"},{"title":"Limits","sectionHeader":{"type":2,"text":"API request limits"},"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions/limits","content":["| Limit | Value | Description |\n","\\|---\\|---\\|---\\|\n","| Subscriptions per create, retrieve, or delete request | 1 | Each call operates on a single subscription. |\n","| Accounts per accessRequestedAccounts | 1 | Each subscription is scoped to a single advertiser account. |\n","| maxResults for Query | 1–5000 | The number of subscriptions returned per Query page. |\n"],"documentType":"guide"},{"title":"Limits","sectionHeader":{"type":2,"text":"Delivery limits"},"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions/limits","content":["| Limit | Value | Description |\n","\\|---\\|---\\|---\\|\n","| Parquet file size | ~256 MB (target) | Stream v2 targets a file size of about 256 MB, but a file can be larger. A single delivery contains one or more files. Size your consumer to read files of varying size rather than assuming a fixed maximum. |\n"],"documentType":"guide"},{"title":"Limits","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/manage-subscriptions/limits","content":[],"documentType":"guide"},{"title":"FAQ","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Answers to common questions about Amazon Marketing Stream Version 2 (Stream v2).\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":2,"text":"General"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Is there a cost associated with using Amazon Marketing Stream?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Amazon does not charge advertisers a fee to use Amazon Marketing Stream. You might incur costs associated with using AWS, depending on the scope of your data. See AWS pricing for current rates.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Who can use Amazon Marketing Stream?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Amazon Marketing Stream is available to agencies, tool providers, and direct advertisers who are integrated with the Amazon Ads API in the supported locales.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Do I need new credentials for Amazon Marketing Stream, or can I use my existing API authentication?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" If you already have Amazon Ads API credentials, you do not need additional authentication. Use your existing credentials to call the Amazon Marketing Stream API.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"What data storage do I need to use Stream v2?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" You need an Amazon SQS queue and an Amazon S3 bucket (together, your destination) to receive data from Amazon Marketing Stream.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"How does Amazon keep my data secure?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Stream v2 delivers data only to the destinations authorized for the advertiser account the subscription covers.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"How do I get started?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" The Get started guide walks through getting API access, setting up your destination in AWS, and creating a subscription.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":2,"text":"Destinations and limits"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"What drives my AWS cost with Stream v2?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Amazon Marketing Stream Version 2 (Stream v2) does not charge a fee (see the General section). With Stream v2 you pay AWS for the resources your destination uses: S3 storage for the Parquet files you retain (which grows with how much historical data you keep), SQS for the delivery notifications, and any Amazon Athena or AWS Glue charges when you query the data in place. If you encrypt with a customer-managed KMS key, KMS usage applies too. See AWS pricing for current rates.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Can I use one destination for all my subscriptions and datasets?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Yes, and it is recommended. Each dataset is written under its own streamDatasetId= prefix in the S3 key path, so multiple datasets delivered to one destination stay separated without any extra configuration. Using a single destination keeps you well under the 5-destination limit per application.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Do my S3 bucket and SQS queue have to be in the same Region?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Yes. Stream v2 enforces co-location: the S3 bucket and notification SQS queue must be in the same AWS Region, and that Region must be in the allowed set for your geo. A mismatch is rejected at subscription creation. See Set up your destination → Supported Regions.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Can two applications share the same destination?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" No. A destination belongs to the client application that first uses it. If a different application tries to use the same S3 bucket and SQS queue pair, the request is rejected.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Why do I get \"bucket is not accessible\" when the bucket exists?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Your S3 bucket policy must grant access to Stream v2's validation role (ReviewerRole from account 926844853897). Stream v2 checks reachability by calling HeadBucket with that role. A missing grant returns 403, which Stream v2 reports as \"not accessible\" even though the bucket exists. Apply the policy in Set up your destination → Step 2.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"How soon does Stream v2 detect a fixed destination policy?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Destination validation results are cached. A failed check is cached for approximately 5 minutes. After you correct a bucket or queue policy, allow up to 5 minutes before creating or recreating a subscription against that destination.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Which API endpoint do I call to create a subscription?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Call the endpoint for the same geo as your destination. If you create a subscription against the North America endpoint but your S3 bucket and SQS queue are in a European Region, the request is rejected as an invalid destination even when your policies are correct. Match the endpoint to your destination's Region. See Set up your destination → Supported Regions.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"How large are the delivered Parquet files?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Stream v2 targets a file size of about 256 MB, but a file can be larger. Size your consumer to read files of varying size rather than assuming a fixed maximum.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":2,"text":"Subscriptions"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Can I create a second subscription for the same dataset, destination, and account?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" No. That combination must be unique. If a subscription for the same dataset, destination, and advertiser account already exists, the create request returns an error. Delete the existing subscription first if you need to recreate it.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Can I change a subscription's destination after creating it?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" No. A subscription's destination is fixed at creation. To change the destination, delete the subscription and create a new one pointing to the new destination.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"My subscription moved to SUSPENDED. Can I reactivate it?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" No. SUSPENDED is a terminal status. Stream v2 periodically validates that your destination still exists and is reachable. If the S3 bucket or SQS queue is deleted, or the policy Stream v2 uses to confirm access is removed, the subscription moves to SUSPENDED. Fix the destination, then delete the suspended subscription and create a new one. See Manage subscriptions → Subscription status.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Which account types can I subscribe, and can I use a manager account?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Subscribe one advertiser account per request: an Amazon DSP (ADSP) Regional Account or a Global Account. Manager accounts are not supported: pass an individual advertiser account ID, not a manager account ID. Submitting more than one account in a single request, or a manager account, returns an authorization error.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Can I choose the granularity or filter the data when I create a subscription?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" No. The subscription request has no granularity or filter parameter. Each dataset delivers at its own fixed granularity, and you aggregate or filter the delivered records yourself when you query them. See Process your data.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":2,"text":"Receiving data"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Why did one batch arrive as multiple SQS notifications?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Stream v2 splits a notification when the list of S3 file URIs would otherwise exceed the SQS message size limit (256 KiB). Each resulting message carries the same streamDeliveryId, streamDataset, and streamBatch but a different subset of the s3Uris. Process each notification as it arrives. No reassembly is needed, because keeping the highest streamBatch.version per record already produces the correct result regardless of how the files are grouped.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"How do I deduplicate the data I receive?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Deduplicate at the record level, not the file level. The same data can arrive under different S3 object keys, so you cannot skip a file by its key, by streamDeliveryId (which can differ across redeliveries), or by treating streamDatasetId and time window plus version as a unique batch identity — none of these identifies a batch uniquely. Read every delivered object, and upsert each record keyed on all of its dimension fields, keeping the highest streamBatch.version per key. See Process your data → Interpreting the data.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Why do I see more than one record for the same key?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Each record carries the total value for its time window, not a change since the last delivery. Stream v2 delivers only the records that changed; when a record is restated, you receive it again with its new total, carrying the same key columns and a higher streamBatch.version. Keep the record with the highest version per key to get the current state. See Process your data → Interpreting the data.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Can one Parquet file contain data for more than one subscription?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Yes. When several subscriptions deliver the same dataset to one destination, a single file can hold records for more than one of them. Do not assume a file belongs to a single subscription. Filter the records on the dimensions you need, such as advertiserAccount.id. See Data delivery → Delivery guarantees.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Should I treat a null as a zero?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" No. A null means the value is unavailable or does not apply to that record, which is not the same as a measured 0. Metrics that were measured as zero arrive as 0; a null means Stream v2 does not collect or aggregate that value for the record. A delete arrives as a record whose metric columns are all null.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"If Stream v2 delivers on a frequent cadence, is my data broken into smaller time intervals?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" No. Delivery cadence and data grain are independent. Stream v2 sends a new batch on a recurring cadence that varies by dataset, but the grain of the data inside that batch is hourly or daily depending on the dataset. A more frequent cadence just means you see updates to that hourly or daily grain sooner, not that the data itself is sliced more finely.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Why does the S3 path include a version identifier like `streamBatchVersion=`?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" So you can compare across deliveries, either by tracking new file arrivals or comparing rows directly, without reprocessing the whole dataset. If you query the data in place with Athena or Glue, filtering to the highest streamBatchVersion per key is how you resolve to the current, correctly restated state of a record.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Do I need the SQS queue, or can I just read files from S3?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Yes. The SQS queue is required to create a subscription (creation blocks without a valid queue and policy), and it is how you consume the data correctly. One delivery is composed of multiple part Parquet files that must be read together to form the complete data, and each SQS notification lists exactly the files that belong together. S3 event notifications fire per object and do not tell you which files make up a delivery, so they cannot reconstruct a complete delivery on their own. Read the SQS notifications to know when a delivery has landed and which files to process. Changing the queue's policy after creation can suspend the subscription (see Destinations and limits).\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":2,"text":"Datasets and schema"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"What datasets are available, and what is coming next?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" See the tool center documentation for the current list of Stream v2 datasets and their release status. Datasets and metrics continue to be added, so check there for what is live rather than relying on a point-in-time list.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"What is the time grain of Stream v2 data, and can I get anything finer than hourly?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Grain is set per dataset, and each dataset is either hourly or daily. There is no minute-level grain. Where a dataset is hourly, the hour is included as a field in the data itself rather than something you infer from the S3 path or delivery time. Historical data for a dataset may arrive at a coarser grain (for example, daily) even when current deliveries for that dataset are hourly.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"What metrics does Stream v2 deliver?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Stream v2 delivers the base metrics and dimensions the Reporting API exposes. You compute derived values such as ratios and cost-per-X metrics (for example, ROAS) from these base fields at query time. Dataset coverage will expand over time; see the tool center documentation for what each dataset delivers today.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Why are mutable fields like campaign name not included in every dataset?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Attributes like campaign name can change over time and are not unique to the rows they are attached to. Including them everywhere would increase data size through duplication, add upstream processing delay, and mean that renaming a campaign could trigger reprocessing and restatement of a large window of that campaign's historical data. Where an attribute is not otherwise available through a public API (for example, technology and geography dimensions), Stream v2 includes it directly. For most mutable attributes, pull them from the campaign-management APIs and treat Stream v2 datasets as fact-level data.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":2,"text":"Historical data"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"How much historical data do I get when I create a subscription?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" When you create a subscription, Stream v2 automatically delivers historical data for the dataset's restatement period to your S3 bucket, with no action needed, and it arrives at the same cadence (hourly or daily) as the dataset itself.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"Can the dataset's restatement period be shortened or skipped?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" No. The restatement period is a fixed Amazon standard, set per dataset. A shorter period would risk discrepancies against the Ads Console, since Console reporting and the historical data Stream v2 delivers reflect the same underlying history.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":2,"text":"Why total-value delivery instead of real-time delta messages"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"How does Stream v2's storage cost compare to delta messaging?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Delta messaging costs can extend beyond the per-message ingestion fee to include compute for parsing and deduplication, storage for verbose uncompressed JSON, custom ETL to reshape the data, dead-letter-queue monitoring, and ongoing pipeline maintenance. Stream v2 delivers columnar Parquet, which can reduce storage footprint, arrives schema- and partition-ready without custom ETL, and lands with an SQS notification that lists each delivery's files. This can reduce compute and engineering overhead in addition to storage cost, though actual savings depend on your existing pipeline and usage.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"What if Stream v2's delivery cadence does not match our reporting cadence?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Each delivery is a complete dataset carrying total values, so you can query it immediately on arrival, compare consecutive deliveries to derive your own deltas if needed, and filter using Parquet and S3 partitioning (by date, campaign, marketplace) for fast queries. Downstream jobs can be triggered from the SQS delivery notification, which lists the files that make up each delivery. This decouples your reporting cadence from Stream v2's delivery cadence: you consume data on your own timeline.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":3,"text":"How do I know the data Stream v2 delivers is accurate and complete?"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[" Delta-model completeness depends on zero message loss, perfect ordering, and your pipeline correctly handling duplicates and retries, each a potential point of failure. Stream v2's data is generated server-side from the source of truth, so what you receive is exactly what the system knows for that time window: validated, consistent, and complete, with no client-side reconstruction. If a record's value changes afterward, you receive a restated record carrying the new total, not a partial update you have to merge yourself.\n"],"documentType":"guide"},{"title":"FAQ","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/v2/faq","content":[],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" This article provides a high-level overview of Amazon Marketing Stream, which is available for integrated partners and other advertisers. This overview covers key features, limitations, FAQs, common use cases, and a sample query. When you are ready to get started with Amazon Marketing Stream, check out the Onboarding guide.\n"," Jump to Key features | Destinations | Datasets  | Limitations | Geographic availability | General FAQ | Sample query |\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Amazon Marketing Stream is a data-streaming service that partners or advertisers can use to subscribe to advertising data sets. Amazon Marketing Stream delivers the data to partner or advertiser-owned AWS destinations in near real-time, without needing to call the API repeatedly throughout the day. With Amazon Marketing Stream, partners and advertisers can use AWS services natively to receive and process advertising data. Amazon Marketing Stream can help improve data integration patterns and operational efficiency by reducing the number of API calls that are typically required for intra-day campaign optimization. \n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Key features "},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Amazon Marketing Stream offers new capabilities compared with an API-based reporting approach:\n","Improved data granularity: Traffic and conversion data is summarized hourly, compared with a daily granularity if you are using the reporting API. The data is streamed automatically to your AWS account, which you provide when you subscribe to the Amazon Marketing Stream data set.   No throttling: With Amazon Marketing Stream data streaming, you no longer need to make frequent API calls for intra-day updates. This helps to prevent throttling while also increasing data accuracy.  Near real-time messaging: Get notified about budget consumption, such as when campaigns are running out of budget.   More reporting dimensions: While API-based reports can show performance at the placement or the ad level, Amazon Marketing Stream can show all dimensions available in a single dataset. While API-based reports can show performance at the target ID, placement or the ad level, Amazon Marketing Stream can show data for these dimensions all together. This allows you to see granular data such as keyword performance for a given placement that is not available without Amazon Marketing Stream. This gives you more insights to help you improve campaign efficiency.   Insights on deltas instead of aggregates: Amazon Marketing Stream allows you to better understand how campaigns are performing by pushing the delta values instead of aggregates. This helps you see how campaign performance is changing over time. The sample query below demonstrates what this might look like using Amazon Marketing Stream.  \\* Simplified workflow: With Amazon Marketing Stream, you can access all of your advertising data from your AWS account natively. Additionally, Amazon Marketing Stream pushes changes to your data instead of snapshots. This simplifies the extract, transform, and load (ETL) process by showing you exactly what has changed when new data arrives. Without Amazon Marketing Stream, you need to pull a snapshot report, and then compare it with your native data store to know what changed—a process that is less efficient.\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Supported destinations"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Amazon Marketing Stream currently supports two destinations: Amazon Data Firehose and AWS Simple Queue Service (SQS).\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Amazon Data Firehose"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Firehose supports a number of data outputs (including S3, Amazon Redshift, Snowflake, Splunk, OpenSearch Service) for increased data storage flexibility. \n","Firehose overview - Getting started guide: Firehose and Amazon Marketing Stream - AWS documentation\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":3,"text":"SQS"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":["Getting started guide: SQS and Amazon Marketing Stream - AWS documentation - Benefits of SQS\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Amazon Marketing Stream datasets"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Currently, Amazon Marketing Stream includes two categories of data: reporting and messaging. For a full description of all data available through Amazon Marketing Stream, see the Amazon Marketing Stream data guide.\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Reporting data"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Amazon Marketing Stream reporting includes the processed (non-raw, summarized) performance data of the advertiser, including traffic and conversions sent hourly, along with data dimensions necessary for analytics. \n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Messaging data"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Amazon Marketing Stream messaging sends notifications on entity state changes and other events in near real time. Currently, this messaging includes campaign, ad group, ad, and targeting entity changes, as well as budget consumption updates, which notify you whenever your budget allotment changes by 5% or more. In the future, we plan to expand the messaging to include notifications about product eligibility, bid recommendations, and other events. \n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Recommendations "},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Amazon Marketing Stream recommendations include suggestions for optimizing existing ad campaigns or creating new ad campaigns to improve the performance of your sponsored ads portfolio.\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Dataset changes"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Amazon Marketing Stream datasets may expand over time to add new fields or supported values. You should plan for potential additions to dataset schema as part of your integration. Any changes to datasets will be communicated through the release notes.\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Limitations"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Current high-level limitations include: \n","Data type: Available for advertising data only. Retail data is not available in Amazon Marketing Stream.  \\* Queues: Amazon Marketing Stream only allows simple SQS queues. FIFO queues are not supported. \n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Migrate to Version 2"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Amazon Marketing Stream v1 will be shut off on June 30, 2027, after which it no longer delivers data. Version 2 delivers complete reporting datasets as Apache Parquet files to an Amazon S3 bucket you own, with total values per time window (not deltas), one destination for all datasets, and no streaming pipeline to run.\n"," See the Migrate from Version 1 guide for step-by-step instructions covering dataset mapping, the delta-to-total-values change, and destination setup.\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Geographic availability"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Amazon Marketing Stream is available for advertisers worldwide. The marketplace of the advertiser determines which AWS region you should use when creating queues and subscribing to datasets. Use the table below to understand what countries are supported, and which API endpoint and AWS region to use for each. \n","| Marketplace | Region | API endpoint | AWS region|\n","\\|-------\\|------\\|------\\|------\\|\n","| United Arab Emirates (AE), Germany (DE), Egypt (EG), Spain (ES), France (FR), Belgium (BE), United Kingdom (UK), India (IN), Italy (IT), Netherlands (NL), Poland (PL), Saudi Arabia (SA), Sweden (SE), Turkey (TR) | EU | https&#x3A;//advertising-api-eu.amazon.com | eu-west-1 |\n","| Brazil (BR), United States (US), Canada (CA), Mexico (MX) | NA | https&#x3A;//advertising-api.amazon.com | us-east-1|\n","| Singapore (SG), Australia (AU), Japan (JP) | FE | https&#x3A;//advertising-api-fe.amazon.com | us-west-2 |\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"General FAQ"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" Maybe. Amazon will not charge advertisers any fees to use Amazon Marketing Stream or to store your data in an Amazon-managed service. However, you might incur costs associated with using AWS, depending on the scope of your data. Learn more about AWS pricing  Yes. You can request access to Amazon Marketing Stream whether you are an integrated partner, agency, or a self-service advertiser. Learn more about requesting access in the Amazon Marketing Stream Onboarding Guide.  If you have API credentials, you do not need additional authentication. You can use your existing credentials to call the Amazon Marketing Stream API.  Yes—at least initially, you will need a developer resource to establish the Amazon Marketing Stream Subscription API connection. Amazon Marketing Stream data is streamed to a partner or advertiser-owned SQS queue. Your developers will use the Subscription API to create, confirm, and manage subscriptions. Once authenticated, you will receive a URL to access the data, and API calls are no longer required.   Amazon Marketing Stream ensures that data is delivered only to the subscriptions which are authorized to have access to advertiser data. When you are ready to get started, the Amazon Marketing Stream Onboarding Guide walks through the process of getting API access, integrating with AWS, and subscribing to datasets using the Amazon Marketing Stream API.  For additional FAQ on querying your data, see the Amazon Marketing Stream querying FAQ.\n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Use cases"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" The main use cases for Amazon Marketing Stream involve the ability to have intra-day insights on performance data over time. This data can help you understand how to adjust bids and budgets throughout the day for better campaign optimization. You can also use Amazon Marketing Stream to leverage near real-time performance data during high traffic events such as Prime Day, so you can change bids and budgets accordingly:\n","Adjust bids: Based on historical hourly traffic data, you can place bids by the hour of the day instead of once daily. For example, if you see that a particular keyword has high traffic on a certain day and time window, you can place bids more aggressively during that time. \\* Adjust budgets: Based on ad spend, you can adjust campaign budgets to avoid running out of budget. Conversely, you can be more aggressive with your bids if ad spend has been too low compared with your budget allocation. In addition, Amazon Marketing Stream can help you identify the times of day that are critical hours for your business—for example, when conversions are high and CPC is low. These granular insights can help you ensure that campaigns stay in budget.  \n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Sample query"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" After you subscribe and store Amazon Marketing Stream data in your database, you can run queries based on the data parameters you want to see. Below is an example of what these queries might look like if you want to pull traffic data for a specific time window for a specific keyword. For additional examples and to learn more, see Querying data with Amazon Marketing Stream. \n"],"documentType":"guide"},{"title":"Overview - Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Pull traffic data for keywords"},"path":"/en-us/guides/amazon-marketing-stream/overview","content":[" This query shows the delta of the performance of a keyword during the 08:00 hour.\n"," The snippet below shows the tabular data that the query might return. Based on this query, you can understand placements (Column I), or where the related product ad was shown during the selected time window. In this example, we have filtered to show \"Detail Page on-Amazon.\" If you look at the metrics fields (Columns N - P), you can see the delta, or how the data is changing as the traffic is validated and corrected:\n"],"documentType":"guide"},{"title":"Introduction to Amazon Data Firehose","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/overview","content":[" Amazon Data Firehose is a fully managed service for delivering real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, Coralogix, and Elastic. With Amazon Data Firehose, you do not need to write applications or manage resources. You configure your data producers to send data to Amazon Data Firehose, and it automatically delivers the data to the destination that you specified. \n"," With Amazon Data Firehose, you can subscribe to Amazon Marketing Stream datasets and have them delivered to a location of your choice, including third-party data outputs. Without Firehose, your Stream datasets can only be delivered to Amazon SQS, so Firehose provides more flexibility if you prefer a different data output.\n"," By integrating Amazon Data Firehose as a delivery option, customers can streamline their data ingestion process and minimize operational costs. As a fully managed service, it automatically scales to accommodate data volume, and eliminates the need for ongoing administration. Additionally, Firehose can batch, compress, and encrypt data before delivery, reducing storage consumption at the destination and enhancing security. To learn more about Amazon Data Firehose, refer to the official AWS Amazon Data Firehose developer guide.\n"],"documentType":"guide"},{"title":"Introduction to Amazon Data Firehose","sectionHeader":{"type":2,"text":"Component architecture "},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/overview","content":[" This component architecture depicts the data flow path of the Amazon Marketing Stream Data Firehose architecture. The following section describes the key components:\n","Stream (Input): This represents the source of data, which originates from the Amazon Marketing Stream itself.   Stream SNS Topic (Ingestion): Data is ingested into the customer’s system via a Simple Notification Service (SNS) topic. SNS is a service that facilitates coordinated message delivery across multiple AWS services.  Amazon Data Firehose (Data delivery): Firehose is a service designed for near real-time data delivery to various destinations. Firehose excels at efficient and reliable data delivery.  Optional data transformation (AWS Lambda): This step allows you to optionally transform the data using AWS Lambda. Lambda is a serverless compute service that empowers you to run code without provisioning or managing servers.  Data Outputs: Processed or raw data can be delivered to various applications based on your specific needs. Some popular choices include:\n"],"documentType":"guide"},{"title":"Introduction to Amazon Data Firehose","sectionHeader":{"type":2,"text":"Choosing your data output"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/overview","content":[" The chosen data output location depends on your specific needs and tech stack. You may want the data readily available in S3 for further processing, analyze it in a data warehouse like Redshift or Snowflake, or integrate it with other services like Splunk or OpenSearch.\n"],"documentType":"guide"},{"title":"Introduction to Amazon Data Firehose","sectionHeader":{"type":2,"text":"Next steps for getting started"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/overview","content":[],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/get-started","content":[],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/get-started","content":[" To complete this tutorial, you will need:\n","Access to the Amazon Ads API  A valid Ads API access token  Your Ads API profile ID  An AWS account with appropriate access. Learn more about prerequisites for subscribing to the Firehose stream  An understanding of your company's cloud infrastructure and the final data output for Stream data  The ability to make basic cURL requests using a tool like Terminal or Postman  An understanding of the Amazon Marketing Stream datasets\n"],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":{"type":2,"text":"Get started with Amazon Data Firehose"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/get-started","content":[" Note that you must be logged into AWS in the correct region before you can get started. Use the table to select the correct region based on the location of the advertiser you are creating a subscription for:\n","|Advertiser region\t|AWS region\t|\n","|---\t|---\t|\n","|NA\t|us-east-1\t|\n","|EU\t|eu-west-1\t|\n","|FE\t|us-west-2\t|\n"," For full details on the countries that have access to Amazon Marketing Stream, see geographic availability.\n"],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Manual set up instructions"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/get-started","content":[" The manual set up instructions walk through creating a Firehose stream and IAM roles manually in the AWS console. If you prefer to review the steps manually or use a data output other than S3, see Manual steps. Otherwise, we recommend using the CloudFormation template for faster setup. \n"],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"CloudFormation template set up instructions"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/get-started","content":[" Important! Use of the CloudFormation template will automatically provision the following AWS resources:\n","An S3 bucket 2. An Amazon Data Firehose stream 3. Three (3) IAM roles \n"," The following steps assume that you are logged in to your AWS account in the appropriate region as described above. \n","Go to GitHub and download a copy of Stream-Firehose-S3-CF-Template.yaml.  2. From the AWS console, search for \"CloudFormation\". 3. From the CloudFormation page, go to Create Stack > With new resources (standard). 4. Under Prerequisite - prepare template, make sure Choose an existing template is selected. 5. Under Specify template, select Upload a template file, then choose the CloudFormation template you downloaded in step 1. Click Next. 6. Enter a name for your stack.  7. Under S3Storage, enter a name for the S3 bucket to be created. 8. Choose a Stream dataset ID that you want to be associated with this Firehose. 9. Enter a name for the StreamDestinationFirehose. 10. Under StreamRealm, choose a region associated to the subscription. Make sure this is the same as the AWS region you are signed in to.  11. After you have completed all fields, click Next. An example of the fields to select if subscribing to the sp-traffic dataset in North America is shown below:\n","Review the Configure stack options page, then click Next. 13. On the Review and create page, review your inputs. At the bottom, check the box that says \"I acknowledge that AWS CloudFormation might create IAM resources with custom names,\" then click Submit. 14. You are taken to a status page where you can review the progress of your stack.  15. Once your stack is complete, you can move on to the next step: Subscribing to Stream datasets.\n"],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Subscribing to Stream datasets"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/get-started","content":[" After creating your AWS resources, you need to subscribe to Amazon Marketing Stream datasets using the Amazon Ads API. For more information, see Subscribing to datasets.\n"],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":{"type":2,"text":"Video demo"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/get-started","content":[" The video embedded below provides a comprehensive walkthrough and demo of Amazon Data Firehose, including how to set up IAM roles and create subscriptions. High-level timestamps are below in case you want to skip to a specific topic:\n","|Timestamp\t|Topic\t|\n","|---\t|---\t|\n","|0:00\t|Intro and refresher on Amazon Marketing Stream\t|\n","|2:12\t|Pain points when using only SQS\t|\n","|3:25\t|Difference between SQS and Firehose\t|\n","|7:45\t|Benefits of Firehose\t|\n","|9:15\t|Firehose demo: Data ingestion and analysis\t|\n","|9:45\t|Firehose demo: Setting up the delivery stream and IAM roles\t|\n","|17:55\t|Firehose demo: Creating subscriptions\t|\n","|27:05\t|Resources for getting started\t|\n"],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":[" Once you have created your AWS Firehose stream and IAM roles, you can subscribe to datasets using the Amazon Ads API. If you are subscribing to data for multiple profiles, you must make a separate call for each. Learn more about profiles.\n"," Note that DSP and sponsored ads datasets use different APIs for dataset subscription. Refer to the Datasets overview to see the endpoint for each dataset.\n"],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":{"type":2,"text":"Endpoints"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":["| Ad product | Endpoint |\n","\\|-----\\|-----\\|\n","| Sponsored ads datasets | POST /streams/subscriptions |\n","| Amazon DSP datasets | POST dsp/streams/subscriptions endpoint |\n"],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":{"type":2,"text":"Headers"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":[],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":{"type":3,"text":"Sponsored ads"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":[" For sponsored ads datasets, use the following headers in your request to POST /streams/subscriptions:\n","| Parameter | Description |\n","\\|--- \\|--- \\|\n","| Amazon-Advertising-API-ClientId | The client ID associated with your Login with Amazon application. |\n","| Amazon-Advertising-API-Scope | Your profile ID. |\n","| Authorization | Your access token. |\n","| Content-Type | application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json |\n"],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":{"type":3,"text":"Amazon DSP"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":[" For Amazon DSP datasets, use the following headers in your request to POST dsp/streams/subscriptions:\n","| Parameter | Description |\n","\\|-----------\\|-------------\\|\n","| Amazon-Advertising-API-ClientId | The client ID associated with your Login with Amazon application. |\n","| Amazon-Advertising-API-Account-ID | The Amazon DSP advertiser ID that you want to receive data for via Stream. You can view the advertiser IDs associated with your profile using GET /dsp/advertisers. |\n","| Authorization | Your access token. |\n","| Content-Type | application/vnd.MarketingStreamSubscriptions.DspStreamSubscriptionResource.v1.0+json |\n"],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":{"type":2,"text":"Parameters"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":[" Both Amazon DSP and sponsored ads APIs take the same parameters:\n","| Parameter | | | Required | Description |\n","\\|--- \\|--- \\|--- \\|--- \\|--- \\|\n","| dataSetId | | | Yes | To view available datasets, see the data guide. |\n","| clientRequestToken | | | Yes | Unique value supplied by the caller used to track identical API requests. If the request must be retried, the caller should supply the same value. We recommend using a GUID. |\n","| notes | | | No | Additional details which can be used to identify the destination. |\n","| destination | firehoseDestination | deliveryStreamArn | Yes | The ARN of the Amazon Data Firehose where you want to receive data. This ARN value is found in the main account where you created the initial Firehose stream. In the AWS console, go to Amazon Data Firehose > Firehose streams > YOUR_STREAM to locate it. |\n","| destination | firehoseDestination | subscriptionRoleArn | Yes | The ARN of the FIREHOSE_SUBSCRIPTION_ROLE. In the AWS console, go to IAM > Roles and locate the subscription role from the list. Click into the role to find the ARN. |\n","| destination | firehoseDestination | subscriberRoleArn | Yes | The ARN of the FIREHOSE_SUBSCRIBER_ROLE. In the AWS console, go to IAM > Roles and locate the subscriber role from the list. Click into the role to find the ARN. |\n"],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":{"type":3,"text":"Retrieving ARNs"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":[" To subscribe to datasets with a destination of Amazon Data Firehose, you will need to retrieve the ARNs associated with Firehose and IAM roles.\n","In the AWS console search, enter “Firehose” and select Amazon Data Firehose. 2. Select the Firehose stream created by CloudFormation. 3. Copy the ARN. This is your deliveryStreamArn.\n","In the AWS console search, enter “IAM” and select IAM. 2. From the IAM dashboard, select Roles. You should see three newly created Roles related to Firehose.  3. Select the role with the -FirehoseSubscriberRole suffix and copy the ARN. This is your subscriberRoleArn. 4. Return to the Roles dashboard and select the Role with the -FirehoseSubscriptionRole suffix. This is your subscriptionRoleArn.\n"],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":{"type":2,"text":"Example requests"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":[],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":{"type":3,"text":"Sponsored ads sp-traffic dataset"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":[" Make sure to replace Amazon-Advertising-API-ClientId, Amazon-Advertising-API-Scope, Authorization, and firehoseDestination with the values specific to your account. The clientRequestToken can be any idempotency token that could be used to identify the request if needed.\n"," A successful request results in a response that includes a subscriptionId.\n"],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":{"type":3,"text":"Amazon DSP adsp-campaigns dataset"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":[" Make sure to replace Amazon-Advertising-API-Account-ID, Amazon-Advertising-API-ClientId, Authorization, and destinationArn with the values specific to your account. The clientRequestToken can be any idempotency token that could be used to identify the request if needed.\n"," Response\n"," A successful request results in a response that includes a subscriptionId. \n"],"documentType":"guide"},{"title":"Subscribing to Amazon Marketing Stream datasets","sectionHeader":{"type":2,"text":"Checking subscription status"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/subscribing-to-datasets","content":[],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/manual-steps","content":[" This guide outlines the manual steps for creating a Data Firehose stream, subscribing to the stream, and delivering data to an S3 bucket. While this example focuses on S3 as the data output location, the same principles can be applied to other destinations like Redshift and Snowflake and others, so you can customize the data delivery according to your specific needs.\n"," Make sure to review the Getting started guide for prerequisites and next steps to subscribe to Amazon Marketing Stream.\n"," The following steps assume that you are logged in to your AWS account in the appropriate region. \n"," To configure Amazon Data Firehose manually, you will complete these three main steps—more details about each step are below:\n"," 1 - Create Amazon Data Firehose delivery stream  2 - Create FIREHOSE_SUBSCRIPTION_ROLE 3 - Create FIREHOSE_SUBSCRIBER_ROLE \n"],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Step 1. Create Amazon Data Firehose delivery stream "},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/manual-steps","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","\\|\n"," 1 - From the AWS console, search for \"Amazon Data Firehose\" > click Create Firehose stream 2 - In the \"Source\" dropdown, select Direct PUT 3 - In the \"Destination\" dropdown, select whichever option you prefer from the list. For this example, we will select Amazon S3 4 - In the \"Firehose stream name\" field, enter a name (or leave the default). For this example, we will name our stream \"Firehose-test-stream\"  You can skip the Transform and convert records section, and jump to Destination settings.| Create Firehose stream |\n"," The next steps to create the Firehose delivery stream will involve configuring the destination settings for your Firehose stream. Since we chose S3 as the destination for this example, we will specify the settings for an S3 bucket. For S3, you can either browse your computer for an existing bucket, enter the URL of an existing bucket, or click Create to create a new bucket. For this example, we will create a new bucket. \n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","\\|\n"," 5 - Under Destination settings, click Create. This will open a new page titled Create bucket →  6 - Be sure the correct region is displayed. Our example uses US East (N. Virginia) us-east-1 7 - For the \"Bucket type,\" the recommended option is General purpose 8 - Enter a name for your bucket using lowercase letters. In this example, the bucket name is amazon-data-firehose-test-bucket |Create S3 bucket |\n"," You can skip the Object ownership and other remaining sections to leave the default settings.\n"," 9  - Scroll down, and click Create bucket\n"," 10 - Navigate back to the window that contains the Destination settings page\n"," 11 - Under Destination settings, click Browse to select the bucket you created:\n"," You can skip the Dynamic partitioning and other remaining sections to leave the default settings. \n"," 12 - Scroll down, and click Create Firehose stream. \n"],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Step 2. Create Firehose subscription role "},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/manual-steps","content":[" The Firehose subscription role has the necessary permissions for an SNS topic to deliver data to the Firehose delivery stream. Follow the steps below to create this role:\n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","\\|\n"," 4 - Replace the \"Custom trust policy\" with the following code:\n"," 5 - Scroll down and click Next. You will arrive on the \"Add permissions\" page, but we will skip this step for now.\n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","\\|\n"," After you create the role, you will land on the \"Roles\" page, where you can see the Firehose subscription role that you just created. \n"," 10 - Click FIREHOSE_SUBSCRIPTION_ROLE.\n"," 11 - Under Permissions policies, from the \"Add permissions\" dropdown, select \"Create inline policy\" as shown below:\n"," This will take you to the \"Specify permissions\" page. \n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","\\|\n"," 12 - Toggle to the JSON  editor →  13 - In the \"Policy editor\" section, replace the default statement code with the code shown below. Be sure to replace the \"Resource\" line with your own arn and region from the subscription account you created. |Specify permissions |\n"," Paste the following code into the \"Policy editor\" section. Note the region as well as the arn numeric value—these must be replaced with your own information:\n"," 14 - Click Next.  15 - Provide a name for your policy—for example, Firehose_SubscriptionRole_Policy.  16 - Click Create policy.\n"," Next, you will create the FIREHOSE_SUBSCRIBER_ROLE. \n"],"documentType":"guide"},{"title":"Get started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Step 3. Create Firehose subscriber role"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/manual-steps","content":[" The Firehose subscriber role will allow Amazon Marketing Stream to create an SNS subscription on behalf of customers. The following steps assume that you are logged in to your AWS account in the appropriate region. \n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","\\|\n"," 4 - Replace the \"Custom trust policy\" with the following code:\n"," 5 - Scroll down and click Next. You will arrive on the \"Add permissions\" page, but we will skip this step for now.\n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","\\|\n"," After you create the role, you will land on the \"Roles\" page, where you can see the subscriber role that you just created.\n"," 10 - Click FIREHOSE_SUBSCRIBER_ROLE.\n"," 11 - Under Permissions policies, from the \"Add permissions\" dropdown, select \"Create inline policy\" as shown below:\n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","\\|\n"," 12 - Toggle to the JSON  editor →  13 - In the \"Policy editor\" section, replace the default statement code with the code shown below. Be sure to replace the \"Resource\" line with your own arn and region from the subscription account you created. |Specify permissions | \n","|Dataset|NA|EU|FE|\n","\\|--\\|--\\|--\\|--\\|\n","|sp-traffic|arn:aws:sns:us-east-1:906013806264:|arn:aws:sns:eu-west-1:668473351658:|arn:aws:sns:us-west-2:074266271188:\\*|\n","|sp-conversion|arn:aws:sns:us-east-1:802324068763:|arn:aws:sns:eu-west-1:562877083794:|arn:aws:sns:us-west-2:622939981599:\\*|\n","|sd-traffic|arn:aws:sns:us-east-1:370941301809:|arn:aws:sns:eu-west-1:947153514089:|arn:aws:sns:us-west-2:310605068565:\\*|\n","|sd-conversion|arn:aws:sns:us-east-1:877712924581:|arn:aws:sns:eu-west-1:664093967423:|arn:aws:sns:us-west-2:818973306977:\\*|\n","|sb-traffic|arn:aws:sns:us-east-1:709476672186:|arn:aws:sns:eu-west-1:623198756881:|arn:aws:sns:us-west-2:485899199471:\\*|\n","|sb-conversion|arn:aws:sns:us-east-1:154357381721:|arn:aws:sns:eu-west-1:195770945541:|arn:aws:sns:us-west-2:112347756703:\\*|\n","|sb-clickstream|arn:aws:sns:us-east-1:091028706140:|arn:aws:sns:eu-west-1:219513501272:|arn:aws:sns:us-west-2:632322331982:\\*|\n","|sb-rich-media|arn:aws:sns:us-east-1:010312603579:|arn:aws:sns:eu-west-1:662188760626:|arn:aws:sns:us-west-2:618223300352:\\*|\n","|budget-usage|arn:aws:sns:us-east-1:055588217351:|arn:aws:sns:eu-west-1:675750596317:|arn:aws:sns:us-west-2:100899330244:\\*|\n","|sponsored-ads-campaign-recommendations|arn:aws:sns:us-east-1:084590724871:|arn:aws:sns:eu-west-1:059061853903:|arn:aws:sns:us-west-2:489995134625:\\*|\n","|campaigns|arn:aws:sns:us-east-1:570159413969:|arn:aws:sns:eu-west-1:834862128520:|arn:aws:sns:us-west-2:527383333093:\\*|\n","|adgroups|arn:aws:sns:us-east-1:118846437111:|arn:aws:sns:eu-west-1:130948361130:|arn:aws:sns:us-west-2:668585072850:\\*|\n","|ads|arn:aws:sns:us-east-1:305370293182:|arn:aws:sns:eu-west-1:648558082147:|arn:aws:sns:us-west-2:802070757281:\\*|\n","|targets|arn:aws:sns:us-east-1:644124924521:|arn:aws:sns:eu-west-1:503759481754:|arn:aws:sns:us-west-2:248074939493:\\*|\n","|adsp-campaigns|arn:aws:sns:us-east-1:153247821255:|arn:aws:sns:eu-west-1:599052634802:|arn:aws:sns:us-west-2:216875695489:\\*|\n","|adsp-campaign-flights|arn:aws:sns:us-east-1:700228448367:|arn:aws:sns:eu-west-1:633559263003:|arn:aws:sns:us-west-2:451213518288:\\*|\n","|adsp-adgroups|arn:aws:sns:us-east-1:222778752755:|arn:aws:sns:eu-west-1:682324742468:|arn:aws:sns:us-west-2:360850786875:\\*|\n","|adsp-adgroup-targets|arn:aws:sns:us-east-1:419834811630:|arn:aws:sns:eu-west-1:764057072099:|arn:aws:sns:us-west-2:178122609971:\\*|\n","|sp-budget-recommendations|arn:aws:sns:us-east-1:678715897637:|arn:aws:sns:eu-west-1:158915609581:|arn:aws:sns:us-west-2:007292432803:\\*|\n"," 15 - Click Next.\n"," 16 - Provide a name for your policy—for example, Firehose_SubscriberRole_Policy.\n"," 17 - Click Create policy.\n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":2,"text":"SQS vs. Firehose"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Does Amazon Marketing Stream delivery to Firehose differ from SQS? "},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" Data is still delivered at least once, with potential duplicates. There is no guarantee of ordering in either Firehose or SQS.\n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Is the format of Amazon Marketing Stream data different in Firehose versus SQS? "},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" There is no change in data format. Both Firehose and SQS receive JSON from Amazon Marketing Stream.\n"," However, Firehose supports parquet/orc conversion by default when you write your data to Amazon S3. Firehose also integrates with Lambda, so you can write your own transformation code. Additionally, Firehose has built-in support for extracting the key data fields from records that are in JSON format. Firehose also supports the JQ parsing language to enable transformations on those partition keys. \n"," To learn more, see the AWS Firehose developer guide.\n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"What is the behavior of `idempotency_id` if I am using both Firehose and SQS?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" The data from SQS subscriptions is identical to that from Firehose. Firehose serves as another destination option for added flexibility. Each message still carries a unique idempotency_id. If you create a new subscription to Firehose in addition to SQS, the unique idempotency_id will remain identical across both platforms.\n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"We are currently using SQS to receive data. What is the recommended strategy for migrating subscriptions to Firehose?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" A potential approach could be:\n","Run both SQS and Data Firehose together temporarily. Use an idempotency_id in your application to deduplicate messages. 2. (Optional) For a controlled switch, migrate new subscriptions to Firehose first, then existing ones. 3. Monitor both services and verify data consistency throughout. 4. Once confident, stop processing messages from SQS. Consider keeping SQS as a backup for a short while before removing it.\n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"What is the cost difference between Firehose and SQS?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" As every integration and volume of messages is different, we recommend using the AWS cost calculator to get an estimate based on your business.\n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Is there any plan to deprecate the SQS integration?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" No, we are not moving from SQS. We are adding a new destination to provide more flexibility for customers. The built-in support of Firehose for data transformation and integration with various tools like S3, Redshift, Snowflake, and Elasticsearch empowers customers to streamline their data pipelines.\n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":2,"text":"Onboarding"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Should I use a CloudFormation template to set up Firehose, or should I configure my Firehose stream manually?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" If you plan to use S3 as your data output, we strongly recommend using the CloudFormation template. This method avoids the manual set-up, and helps ensure that your region and subscription details are done correctly. \n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Where can I find the Amazon Data Firehose ARN values needed for subscriptions?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" To subscribe to a dataset and deliver to Data Firehose, you will need three ARN values, as shown below. All ARN values can be found in the AWS console. \n","Delivery Firehose stream ARN: This ARN value is found in the main account where you created the initial Firehose stream. Go to Amazon Data Firehose > Firehose streams > YOUR_STREAM to locate it. 2. Subscription role ARN: Go to IAM > Roles and locate the subscription role from the list. Click into the role to find the ARN.   3. Subscriber role ARN: Go to IAM > Roles and locate the subscriber role from the list. Click into the role to find the ARN. \n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"Does Firehose support backfilling?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" Backfilling of data is not currently supported in Amazon Marketing Stream. \n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":2,"text":"Firehose management"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"How do I unsubscribe from a dataset delivering to Firehose?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" Get a subscriptionId of the subscription you want to delete using GET /streams/subscriptions (sponsored ads datasets) or GET /dsp/streams/subscriptions (Amazon DSP datasets).\n"," Subscriptions delivering to Firehose will contain a firehoseDestination object. \n"," Once you have the subscriptionId, use PUT /streams/subscriptions/{subscriptionId} (sponsored ads datasets) or PUT /dsp/streams/subscriptions/{subscriptionId} (Amazon DSP datasets) to set the status of the subscription to ARCHIVED.\n"," For more information, see Managing subscriptions.\n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"We noticed that Firehose delivers data to S3 with a file extension that cannot be configured. Can we change this format without using a Lambda?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" You can set a file extension for objects delivered to the Amazon S3 destination bucket by enabling the S3 file extension format feature. \n"," In the AWS console, go to Firehose. Under Buffer hints, compression, file extension and encryption settings, set the file extension to .txt, enter \".txt\" (including the period) in the S3 file extension format field. Firehose will override the default file extensions appended by Data Format Conversion or S3 compression features. Learn more.\n"],"documentType":"guide"},{"title":"FAQ related to getting started with Amazon Data Firehose","sectionHeader":{"type":3,"text":"I have noticed Firehose adds a timestamp as a prefix to my file name in S3. Can I remove this?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/firehose/faq","content":[" Yes, you can configure Data Firehose to not add a timestamp prefix to files when storing them in Amazon S3. To achieve this, you need to customize the S3 prefix in the delivery stream configuration.\n","Open the Firehose console. 2. Select your delivery stream. 3. In the S3 destination section, click Edit. 4. In the S3 prefix field, remove the default timestamp prefix or modify it according to your requirements. 5. Click Save changes to apply the modifications.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" Follow the steps in this tutorial to connect your AWS application to Amazon Marketing Stream datasets. At the end of the tutorial, you should start receiving performance and campaign data in your SQS queue. \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":2,"text":"Before you begin "},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" To complete this tutorial, you will need:\n","Access to the Amazon Ads API  A valid Ads API access token  Your Ads API profile ID   An AWS account  The ability to make basic cURL requests using a tool like Terminal or Postman \\* An understanding of the Amazon Marketing Stream datasets\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":2,"text":"Step 1: Create an SQS queue"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" To receive data using Amazon Marketing Stream, you must first set up a queue using AWS Simple Queue Service (SQS). We recommend your AWS set up be completed by someone familiar with AWS.\n"," You can create a queue by logging in to your AWS account and using the SQS console or by using an AWS CloudFormation template. \n"," When using AWS (both SQS and CloudFormation), it is important to make sure that you are logged in to the correct region. Use this table to select the correct region based on the location of the advertiser you are creating a subscription for.\n","| Advertiser region | AWS region |\n","\\|---------\\|----------\\|\n","| NA | us-east-1 |\n","| EU  | eu-west-1 |\n","| FE | us-west-2 |\n"," You can select a region using the dropdown in the top right corner of the AWS console.\n"," For full details on what countries are supported, see the Geographic availability. \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"CloudFormation"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" To use a CloudFormation template, follow the instructions in Onboarding with CloudFormation. \n"," Our CloudFormation template automatically adds a valid resource-based IAM policy, so if you are using CloudFormation, you can skip step 2 in this guide and move directly to step 3.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"SQS Console"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" You can also create SQS queues manually using the SQS console. Follow the instructions in the AWS documentation. \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":2,"text":"Step 2: Add a resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" Each combination of dataset and region has a distinct IAM policy. For example, the sp-traffic dataset has different IAM policies for NA, EU, and FE. Make sure you are applying the correct IAM policy based on the dataset and region that you want to subscribe to. To view resource-based IAM policies for all available datasets and regions, see the Amazon Marketing Stream data guide. \n"," You can add an access policy during queue creation, or edit an existing queue.  \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":2,"text":"Step 3: Subscribe to Amazon Marketing Stream datasets"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" After setting up a queue and adding an IAM policy, you can subscribe to advertiser data using the Amazon Marketing Stream subscription APIs. You need to make a separate request for each dataset you want to subscribe to.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"Subscribing to sponsored ads datasets"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" To subscribe to sponsored ads datasets, use the POST /streams/subscriptions endpoint.\n"," If you are subscribing to data for multiple profiles, you must make a separate call for each. \n"," Headers\n","| Parameter | Description |\n","\\|-----------\\|-------------\\|\n","| Amazon-Advertising-API-ClientId | The client ID associated with your Login with Amazon application. |\n","| Amazon-Advertising-API-Scope | Your profile ID. |\n","| Authorization | Your access token. |\n","| Content-Type | application/vnd.MarketingStreamSubscriptions.StreamSubscriptionResource.v1.0+json |\n"," Parameters\n","| Parameter | Required | Description |\n","\\|-----------\\|-------------\\|-------------\\|\n","| dataSetId | Yes | To view available datasets, see the data guide.  |\n","| destinationArn | Yes | The ARN of the SQS queue where you want to receive data. |\n","| clientRequestToken | Yes | Unique value supplied by the caller used to track identical API requests. Should the request be retried, the caller should supply the same value. We recommend using a GUID. |\n","| notes | No | Additional details which can be used to identify the destination. |\n"," Example\n"," Make sure to replace Amazon-Advertising-API-ClientId, Amazon-Advertising-API-Scope, Authorization, and destinationArn with the values specific to your account. The clientRequestToken can be any idempotency token that could be used to identify the request if needed. \n"," Response\n"," A successful request results in a response that includes a subscriptionId. \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"Subscribing to Amazon DSP datasets"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" To subscribe to Amazon DSP datasets, use the POST /dsp/streams/subscriptions endpoint.\n"," If you are subscribing to data for multiple Amazon DSP advertiser IDs, you must make a separate call for each. \n"," Headers\n","| Parameter | Description |\n","\\|-----------\\|-------------\\|\n","| Amazon-Advertising-API-ClientId | The client ID associated with your Login with Amazon application. |\n","| Amazon-Advertising-API-Account-ID | The Amazon DSP advertiser ID that you want to receive data for via Stream. You can view the advertiser IDs associated with your profile using GET /dsp/advertisers. |\n","| Authorization | Your access token. |\n","| Content-Type | application/vnd.MarketingStreamSubscriptions.DspStreamSubscriptionResource.v1.0+json |\n"," Parameters\n","| Parameter | Required | Description |\n","\\|-----------\\|-------------\\|-------------\\|\n","| dataSetId | Yes | To view available datasets, see the data guide.  |\n","| destinationArn | Yes | The ARN of the SQS queue where you want to receive data. |\n","| clientRequestToken | Yes | Unique value supplied by the caller used to track identical API requests. Should the request be retried, the caller should supply the same value. We recommend using a GUID. |\n","| notes | No | Additional details which can be used to identify the destination. |\n"," Example\n"," Make sure to replace Amazon-Advertising-API-Account-ID, Amazon-Advertising-API-ClientId, Authorization, and destinationArn with the values specific to your account. The clientRequestToken can be any idempotency token that could be used to identify the request if needed. \n"," Response\n"," A successful request results in a response that includes a subscriptionId. \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":2,"text":"Step 4: Confirm your subscription in SQS"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" Once you have successfully subscribed to Amazon Marketing Stream using the API, you need to confirm the subscription in SQS to start receiving data. \n"," You should see a message in your SQS queue resembling:\n"," To start receiving data in your queue, you must confirm the subscription in one of the following ways: \n","Make a GET request to the SubscribeURL value returned in the SQS queue confirmation message. This call should return a message saying that subscription has been confirmed and the queue should start receiving messages.\n","Use the AWS SDK to call ConfirmSubscription using the Token and TopicArn values returned in the SQS queue confirmation message.\n"," You can identify subscription messages versus data events using logic similar to:\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":2,"text":"Subscription status flow"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" You can view the status flow for Stream subscriptions in the following diagram.\n"," Learn more about the possible statuses for subscriptions in Managing subscriptions.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" Once you have confirmed your subscriptions and started receiving data, you can move on to:\n","Aggregating data - Querying data - Managing subscriptions - AWS best practices - AWS serverless application repository - SQS poller\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":2,"text":"AWS Workshop"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" This Workshop provides an example of a serverless data analytics and managed machine learning platform built using Amazon Marketing Stream and AWS technology. Developers, data analysts, and architects can use the Workshop to get a practical idea of how Stream might be implemented to help your business. \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":2,"text":"Troubleshooting FAQ"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"Why am I seeing negative values for the first couple of days of data?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" The negatives are corrections that are happening retroactively based on the Amazon click and conversion validation process. You may have negative aggregated values for the first day or two that we enabled the connection as you did not receive original traffic on those days, just corrections. The recommendation is to ignore negative values in the first one to two days. \n"," After the first two days, you should start receiving positive values; if you do not see aggregate positive values after two days, contact support. \n"," You will continue to see negative deltas as corrections happen due to click invalidation, but they should always aggregate to positive values.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"Why am I receiving null records?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" You can disregard these rows. This is expected and these rows are not an issue and will cause no issues with data as they aggregate to 0.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"I have created a queue and while I am trying to subscribe using POST /streams/subscriptions I am getting error code 400 that my region is not supported."},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" In the current state, Amazon Marketing Stream supports only three regions: us-east-1 (NA), eu-west-1 (EU), and us-west-2 (FE). When creating your SQS queue, make sure you are only using a supported region. To avoid this error, we recommend using the provided CloudFormation template to create your queue.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"My subscription status is `PENDING_CONFIRMATION`, but I never received a confirmation message in SQS."},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" You may have applied the wrong IAM policy to your queue. Make sure that the IAM policy you are using in your queue matches the region of the advertiser profile and the dataset that you are trying to subscribe to. \n"," If you applied the wrong IAM policy to your queue, you should create a new queue, apply the correct policy, and subscribe to the dataset again using the new queue ARN.  \n"," If you are sure that you applied the correct IAM policy, but have been stuck in PENDING_CONFIRMATION, submit a ticket and our support team can manually resend the confirmation message.  \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"My subscription is stuck in `PENDING_CONFIRMATION` and will not move to `FAILED_CONFIRMATION`."},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" If you do not confirm a subscription within three days, the status should automatically move to FAILED_CONFIRMATION. Once the status has moved to FAILED_CONFIRMATION, you can send another request to subscribe to the dataset. In rare cases, the status may not switch to FAILED_CONFIRMATION automatically, and you should submit a ticket to our support team.\n"," Alternatively, you can create a new queue, apply the relevant IAM policy, and try to subscribe to the dataset again using the new queue ARN. \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"I have successfully confirmed my subscription in SQS, but I am not receiving any messages in my SQS destination queue."},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" Since Amazon Marketing Stream delivers data in near real time, an event related to the advertiser and their campaign in the subscribed dataset and marketplace must occur for anything to be sent. In the absence of these events, there will be no data. In other words, data is only sent if there is performance for that campaign within the hour.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"It looks like I am receiving duplicate data."},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" If it looks like you are receiving duplicate records, be sure to inspect your data first. There are a couple of scenarios where the data you are receiving might resemble duplicates, but is actually valid.\n"," First, it is possible that your data for two different hours could be very similar. For example, consider a keyword that receives ten impressions and three clicks on a given date in hour one. In hour two, they again receive ten impressions and three clicks. Stream would send similar records for that keyword in both hours, differentiated only by the hour the data is related to. For keywords without many impressions, it is likely you might see only one impression and no clicks for many hours throughout the day.      \n"," Second, Amazon Marketing Stream sends an hourly delta for your campaigns, so restatements can result in records that appear almost identical. This could lead to two records with the same click and impression data for the same keyword and same hour, however one is the original delta and the second is a restatement. This is not a duplicate and can be checked by examining the idempotency_id of the two records. If the idempotency IDs are different, then they are not duplicates and are two distinct records for that keyword and hour.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"How do I cancel a subscription? "},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" There is not currently a way to delete or cancel a subscription. To stop receiving data for a subscription, you should set the subscriptionStatus to ARCHIVED. For more information, see Managing subscriptions.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"What is the time zone associated with Amazon Marketing Stream data?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[" For hourly data, datasets contain a time_window_start field that represents the start timestamp of the activity within the time zone of the advertiser. You can check the time zone associated with an advertiser profile by calling GET /v2/profiles.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream onboarding guide","sectionHeader":{"type":3,"text":"How do I ensure that I am receiving all Amazon Marketing Stream data?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/get-started","content":[],"documentType":"guide"},{"title":"Creating SQS queues with CloudFormation","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/cloud-formation","content":[" To subscribe to an Amazon Marketing Stream dataset, you first need to set up an SQS queue and apply the relevant resource-based IAM policy. This guide shows how to use a tool called AWS CloudFormation to programmatically set up queues and apply IAM policies. CloudFormation allows you to use an Infrastructure as Code (IaC) approach to managing your queues and policies. An IaC approach can result in consistency in configuration, minimal human error, and increased efficiency in infrastructure setup for Amazon Marketing Stream.\n"," You can also complete this process manually by following steps 1 and 2 of the Onboarding guide.\n"],"documentType":"guide"},{"title":"Creating SQS queues with CloudFormation","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/cloud-formation","content":[" To complete this process, you must have an AWS account with permission to:\n","Access Amazon Simple Queue Service (SQS), including permission to create, update, and delete a queue and its messages. 2. Apply policy permissions on SQS queues. An SQS policy is a document that defines who is allowed to perform what actions on the queue. 3. Upload AWS CloudFormation templates.\n"],"documentType":"guide"},{"title":"Creating SQS queues with CloudFormation","sectionHeader":{"type":2,"text":"Procedure"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/cloud-formation","content":["Download the CloudFormation template from GitHub. You will use this to complete your setup with CloudFormation.  2. Log in to the AWS console.  3. In the search bar, enter CloudFormation. 4. From the CloudFormation homepage, click Create stack. 5. Keep the default selections in the form. Under Template source, select Upload a template file and choose the CloudFormation template you downloaded in step 1.  6. Click Next. 7. Enter the relevant parameters based on the template. \n","Click Next. 9. On the Configure stack options page, keep the default settings and move on to the next page.  10. Review the configuration and click Create stack. If you see a warning stating The template has changed, select the checkbox to continue creating your stack.  11. Go to the SQS homepage. You should see your new queue listed.\n","Click on your queue and go to the Access policy tab. You should see an access policy listed. \n"],"documentType":"guide"},{"title":"Creating SQS queues with CloudFormation","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/sqs/cloud-formation","content":[],"documentType":"guide"},{"title":"Amazon Marketing Stream reference implementation using AWS CDK and Python","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/onboarding/reference-implementation","content":[" The reference implementation is a Python-based application built using the AWS CDK. It is available for all developers in GitHub.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream reference implementation using AWS CDK and Python","sectionHeader":{"type":2,"text":"What is the purpose of the reference implementation?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/reference-implementation","content":[" This reference implementation programmatically performs steps 1, 2, and 4 in the Onboarding guide. The package also supports the ability to subscribe to Stream datasets (step 3), using a CLI.\n"," If you are not familiar with a CLI or Python, you can also use the AWS SQS UI or CloudFormation template to complete the onboarding process.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream reference implementation using AWS CDK and Python","sectionHeader":{"type":2,"text":"Who should use this reference implementation?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/reference-implementation","content":[" Developers familiar with AWS can use the reference implementation as a basis for their Stream integration.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream reference implementation using AWS CDK and Python","sectionHeader":{"type":2,"text":"Does use of the reference application incur any additional cost?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/reference-implementation","content":[" The reference application provisions a number of AWS resources for use with Stream. You are responsible for all AWS costs associated with a Stream integration. For more information on optimizing based on cost, see SQS best practices. \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream reference implementation using AWS CDK and Python","sectionHeader":{"type":2,"text":"Architecture "},"path":"/en-us/guides/amazon-marketing-stream/onboarding/reference-implementation","content":[" This application is developed using Python and AWS Cloud Development Kit (CDK).\n"," The application provisions the following AWS infrastructure components for each dataset and region combination:\n","An SQS queue (StreamIngressQueue) that receives initial messages from Stream. - A Lambda function (StreamFanoutLambda) that identifies whether a message contains subscription details or data. - A second SQS queue (SubscriptionConfirmationQueue) that forwards subscription confirmation messages to a second Lambda function (SubscriptionConfirmationLambda) that confirms the subscription. - An SNS topic (StreamFanoutDataTopic) that forwards data through a Kinesis Data Firehose (StreamStorageFirehose) to an S3 bucket (StreamStorageBucket) where the data is stored.\n"," Note: The provisioning of each SQS queue also includes an associated dead-letter queue.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream reference implementation using AWS CDK and Python","sectionHeader":{"type":2,"text":"How do I get started with the reference application?"},"path":"/en-us/guides/amazon-marketing-stream/onboarding/reference-implementation","content":[" For prerequisites and installation details, see the README in GitHub.\n"," Follow along with a video demo of the reference application.\n"," 0:00-5:16 - Intro \n"," 5:16-8:15 - Demo: overview \n"," 8:15-9:00 - Demo: venv & pip install  \n"," 9:00-10:50 - Demo: cdk synth & infrastructure deep dive \n"," 10:50-11:56 - Demo: cdk out\n"," 11:56-13:18 - Demo: cdk bootstrap \n"," 13:18-14:31 - Demo: cdk commands and credentials\n"," 14:31-18:45 - Demo: cdk deploy na-sp-traffic \n"," 18:45-20:41 - Demo: subscribe \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream data guide","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/data-guide","content":[" Amazon Marketing Stream supports datasets that advertisers can subscribe to. Each dataset supports different performance metrics or campaign metadata. \n"," For each dataset you subscribe to, make sure you use the correct subscription endpoint and confirm the subscription in SQS. \n"],"documentType":"guide"},{"title":"Amazon Marketing Stream data guide","sectionHeader":{"type":2,"text":"Amazon DSP performance"},"path":"/en-us/guides/amazon-marketing-stream/data-guide","content":["|Dataset ID\t|NA\t|EU\t|FE\t|Documentation\t|Subscription endpoint\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|adsp-traffic\t|x\t|x\t|x\t|Link\t|POST /dsp/streams/subscriptions\t|\n","|adsp-conversion\t|x\t|x\t|x\t|Link\t|POST /dsp/streams/subscriptions\t|\n","|adsp-clickstream\t|x\t|x\t|x\t|Link\t|POST /dsp/streams/subscriptions\t|\n","|adsp-rich-media\t|x\t|x\t|x\t|Link\t|POST /dsp/streams/subscriptions\t|\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream data guide","sectionHeader":{"type":2,"text":"Sponsored Products performance"},"path":"/en-us/guides/amazon-marketing-stream/data-guide","content":["| Dataset ID | NA | EU | FE | Documentation | Subscription endpoint |\n","\\|-----\\|-------\\|----\\|---\\|-----\\|----\\|\n","| sp-traffic | x | x | x | Link | POST /streams/subscriptions|\n","| sp-conversion | x | x | x | Link | POST /streams/subscriptions|\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream data guide","sectionHeader":{"type":2,"text":"Sponsored Display performance"},"path":"/en-us/guides/amazon-marketing-stream/data-guide","content":["| Dataset ID | NA | EU | FE | Documentation | Subscription endpoint |\n","\\|-----\\|-------\\|----\\|---\\|-----\\|----\\|\n","| sd-traffic | x | x | x | Link| POST /streams/subscriptions|\n","| sd-conversion | x | x | x | Link| POST /streams/subscriptions|\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream data guide","sectionHeader":{"type":2,"text":"Sponsored Brands performance"},"path":"/en-us/guides/amazon-marketing-stream/data-guide","content":["| Dataset ID | NA | EU | FE | Documentation | Subscription endpoint |\n","\\|-----\\|-------\\|----\\|---\\|-----\\|----\\|\n","| sb-traffic | x | x | x | Link| POST /streams/subscriptions|\n","| sb-conversion | x | x | x | Link| POST /streams/subscriptions|\n","| sb-clickstream | x | x | x | Link| POST /streams/subscriptions|\n","| sb-rich-media | x | x | x | Link| POST /streams/subscriptions|\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream data guide","sectionHeader":{"type":2,"text":"Sponsored ads budget usage"},"path":"/en-us/guides/amazon-marketing-stream/data-guide","content":["| Dataset ID | NA | EU | FE | Documentation | Subscription endpoint |\n","\\|-----\\|-------\\|----\\|---\\|-----\\|----\\|\n","| budget-usage |  x | x | x | Link| POST /streams/subscriptions|\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream data guide","sectionHeader":{"type":2,"text":"Sponsored ads recommendations"},"path":"/en-us/guides/amazon-marketing-stream/data-guide","content":["| Dataset ID | NA | EU | FE | Documentation | Subscription endpoint |\n","\\|-----\\|-------\\|----\\|---\\|-----\\|----\\|\n","| sponsored-ads-campaign-diagnostics-recommendations |  x | x | x | Link| POST /streams/subscriptions|\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream data guide","sectionHeader":{"type":2,"text":"Sponsored Products budget recommendations and missed opportunities"},"path":"/en-us/guides/amazon-marketing-stream/data-guide","content":["| Dataset ID | NA | EU | FE | Documentation | Subscription endpoint |\n","\\|-----\\|-------\\|----\\|---\\|-----\\|----\\|\n","| sp-budget-recommendations |  x | x | x | Link| POST /streams/subscriptions|\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream data guide","sectionHeader":{"type":2,"text":"Campaign management"},"path":"/en-us/guides/amazon-marketing-stream/data-guide","content":["| Dataset ID | NA | EU | FE | Documentation | Subscription endpoint |\n","\\|-----\\|-------\\|----\\|---\\|-----\\|----\\|\n","| ads-campaign-management-campaigns | x | x | x | Link| POST /streams/subscriptions|\n","| ads-campaign-management-adgroups | x | x | x | Link| POST /streams/subscriptions|\n","| ads-campaign-management-ads | x | x | x | Link| POST /streams/subscriptions|\n","| ads-campaign-management-targets | x | x | x | Link| POST /streams/subscriptions|\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream data guide","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/amazon-marketing-stream/data-guide","content":[],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" The Amazon DSP performance datasets provide details about traffic, conversions, clickstream, and rich media for Amazon DSP campaigns.\n"," To subscribe or manage subscriptions to these datasets, use the /dsp/streams/subscriptions endpoints.\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":2,"text":"Amazon DSP traffic dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" The adsp-traffic dataset contains click, impression, and cost data related to Amazon DSP campaigns.\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" To subscribe to this dataset, use the ID adsp-traffic.\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" This dataset supports the following fields and metrics:\n","|Field name\t|API name\t|Type\t|Type\t|Description\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|dataset_id\t|\tN/A|String\t|Dimension\t|An identifier used to identify the dataset\t|\n","|idempotency_id\t|N/A\t|String\t|Dimension\t|An identifier that can be used to de-duplicate records\t|\n","|time_window_start\t|N/A\t|String\t|Dimension\t|The start of the hour at which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated in the advertiser profile.\t|\n","|adgroup_id\t|lineItemId\t|String\t|Dimension\t|A unique identifier assigned to a line item or ad group\t|\n","|advertiser_country\t|advertiserCountry\t|String\t|Dimension\t|The country assigned to the advertiser\t Note: This field can be null if the advertiser is not tied to a specific country|\n","|advertiser_id\t|advertiserId\t|String\t|Dimension\t|The unique identifier for the advertiser\t|\n","|advertiser_name\t|advertiserName\t|String\t|Dimension\t|The customer that has an advertising relationship with Amazon\t|\n","|advertiser_timezone\t|advertiserTimezone\t|String\t|Dimension\t|The time zone the advertiser uses for reporting and ad serving purposes\t|\n","|country\t|country\t|String\t|Dimension\t|Country or locale\t|\n","|creative_id\t|creativeId\t|String\t|Dimension\t|A unique identifier assigned to a creative. When this is different from creativeAdId, creativeId cannot be used in the /dsp/creatives endpoints\t|\n","|creative_language\t|creativeLanguage\t|String\t|Dimension\t|The primary language in the creative\t|\n","|creative_name\t|creativeName\t|String\t|Dimension\t|Creative name\t|\n","|creative_size\t|creativeSize\t|String\t|Dimension\t|The dimensions of the creative in pixels\t|\n","|creative_type\t|creativeType\t|String\t|Dimension\t|The type of creative (for example static image, third party, or video)\t|\n","|deal\t|deal\t|String\t|Dimension\t|The name of a deal\t|\n","|deal_id\t|dealID\t|String\t|Dimension\t|The unique identifier for the deal\t|\n","|deal_type\t|dealType\t|String\t|Dimension\t|The type of deal\t|\n","|device\t|device\t|String\t|Dimension\t|The devices the customers used to view the ad\t|\n","|dsp_entity_id\t|entityId\t|String\t|Dimension\t|Entity (seat) ID\t|\n","|placement_name\t|placementName\t|String\t|Dimension\t|The name of the placement where the campaign ran\t|\n","|proposal_id\t|proposalId\t|String\t|Dimension\t|A unique identifier for an order imported from the Amazon Order Management System (OMS)\t|\n","|region\t|region\t|String\t|Dimension\t|State or region\t|\n","|site\t|siteName\t|String\t|Dimension\t|The site or group of sites the campaign ran on\t|\n","|supply_source_name\t|supplySourceName\t|String\t|Dimension\t|The inventory the campaign ran on, for example real-time bidding exchanges or Amazon-owned sites\t|\n","|marketplace_id\t|N/A\t|String\t|Dimension\t|The marketplace of the advertiser|\n","|campaign_id\t|orderId\t|String\t|Dimension\t|The ID associated with a campaign\t|\n","|flight_id\t|N/A\t|String\t|Dimension\t|Unique identifier of the campaign flight\t|\n","|agency_fee\t|agencyFee\t|Currency\t|Metric\t|A percentage or flat fee removed from the total budget to compensate the agency that is managing the media buy\t|\n","|amazon_dsp_audience_fee\t|amazonAudienceFee\t|Currency\t|Metric\t|CPM charge applied to impressions that leverage the Amazon behavioral targeting\t|\n","|amazon_dsp_console_fee\t|amazonPlatformFee\t|Currency\t|Metric\t|The technology fee applied to the media supply costs\t|\n","|supply_cost\t|supplyCost\t|Currency\t|Metric\t|The total amount of money spent on media supply\t|\n","|total_cost\t|totalCost\t|Currency\t|Metric\t|The total amount of money spent on running the campaign not including third-party fees paid by the agency\t|\n","|gross_impressions\t|grossImpressions\t|Integer\t|Metric\t|The total number of times the ad was displayed. This includes valid and invalid impressions, such as potentially fraudulent, non-human, and other illegitimate impressions.\t|\n","|impressions\t|impressions\t|Integer\t|Metric\t|Total number of ad impressions\t|\n","|invalid_impressions\t|invalidImpressions\t|Integer\t|Metric\t|The number of impressions removed by a traffic quality filter. This includes potentially fraudulent, non-human, and other illegitimate traffic\t|\n","|measurable_impressions\t|measurableImpressions\t|Integer\t|Metric\t|Number of impressions that were measured for viewability\t|\n","|viewable_impressions\t|viewableImpressions\t|Integer\t|Metric\t|Number of impressions that met the Media Ratings Council (MRC) viewability standard\t|\n","|clicks\t|clickThroughs\t|Integer\t|Metric\t|Total number of clicks on an ad\t|\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Sample Payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":2,"text":"Amazon DSP conversion dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" The adsp-conversion dataset contains conversion data attributed to Amazon DSP campaigns.\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" To subscribe to this dataset, use the ID adsp-conversion.\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" This dataset supports the following fields and metrics:\n","|Field name\t|API name\t|Type\t|Type\t|Description\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|dataset_id\t|N/A\t|String\t|Dimension\t|An identifier used to identify the dataset\t|\n","|idempotency_id\t|N/A\t|String\t|Dimension\t|An identifier that can be used to de-duplicate records\t|\n","|time_window_start\t|N/A\t|String\t|Dimension\t|The start of the hour at which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated in the advertiser profile.\t|\n","|adgroup_id\t|lineItemId\t|String\t|Dimension\t|A unique identifier assigned to a line item or ad group\t|\n","|advertiser_country\t|advertiserCountry\t|String\t|Dimension\t|The country assigned to the advertiser\t Note: This field can be null if the advertiser is not tied to a specific country|\n","|advertiser_id\t|advertiserId\t|String\t|Dimension\t|The unique identifier for the advertiser\t|\n","|advertiser_name\t|advertiserName\t|String\t|Dimension\t|The customer that has an advertising relationship with Amazon\t|\n","|advertiser_timezone\t|advertiserTimezone\t|String\t|Dimension\t|The time zone the advertiser uses for reporting and ad serving purposes\t|\n","|country\t|country\t|String\t|Dimension\t|Country or locale\t|\n","|creative_id\t|creativeId\t|String\t|Dimension\t|A unique identifier assigned to a creative. When this is different from creativeAdId, creativeId cannot be used in the /dsp/creatives endpoints.\t|\n","|creative_language\t|creativeLanguage\t|String\t|Dimension\t|The primary language in the creative\t|\n","|creative_name\t|creativeName\t|String\t|Dimension\t|Creative name\t|\n","|creative_size\t|creativeSize\t|String\t|Dimension\t|The dimensions of the creative in pixels\t|\n","|creative_type\t|creativeType\t|String\t|Dimension\t|The type of creative (for example static image, third party, or video)\t|\n","|deal\t|deal\t|String\t|Dimension\t|The name of a deal\t|\n","|deal_id\t|dealID\t|String\t|Dimension\t|The unique identifier for the deal\t|\n","|deal_type\t|dealType\t|String\t|Dimension\t|The type of deal\t|\n","|device\t|device\t|String\t|Dimension\t|The devices the customers used to view the ad\t|\n","|dsp_entity_id\t|entityId\t|String\t|Dimension\t|Entity (seat) ID\t|\n","|placement_name\t|placementName\t|String\t|Dimension\t|The name of the placement where the campaign ran\t|\n","|proposal_id\t|proposalId\t|String\t|Dimension\t|A unique identifier for an order imported from the Amazon Order Management System (OMS)\t|\n","|region\t|region\t|String\t|Dimension\t|State or region\t|\n","|site\t|siteName\t|String\t|Dimension\t|The site or group of sites the campaign ran on\t|\n","|supply_source_name\t|supplySourceName\t|String\t|Dimension\t|The inventory the campaign ran on--for example real-time bidding exchanges or Amazon-owned sites\t|\n","|marketplace_id\t|N/A\t|String\t|Dimension\t|The marketplace of the advertiser.|\n","|campaign_id\t|orderId\t|String\t|Dimension\t|The ID associated with a campaign\t|\n","|units_sold\t|unitsSold\t|Integer\t|Metric\t|Number of attributed units sold within 14 days of an ad click or view\t|\n","|new_to_brand_units_sold\t|newToBrandUnitsSold\t|Integer\t|Metric\t|Total number of attributed units ordered as part of new-to-brand sales occurring within 14 days of an ad click or view. Not available for book vendors\t|\n","|total_units_sold\t|totalUnitsSold\t|Integer\t|Metric\t|The total quantity of promoted products and products from the same brand as promoted products purchased by customers on Amazon after delivering an ad. A campaign can have multiple units sold in a single purchase event.\t|\n","|total_new_to_brand_units_sold\t|totalNewToBrandUnitsSold\t|Integer\t|Metric\t|The total quantity of promoted products and products from the same brand as promoted products purchased by customers on Amazon after delivering an ad. A campaign can have multiple units sold in a single purchase event.\t|\n","|sales\t|sales\t|Currency\t|Metric\t|The total sales (in local currency) of promoted ASINs purchased by customers on Amazon after delivering an ad.\t|\n","|new_to_brand_product_sales\t|newToBrandProductSales\t|Currency\t|Metric\t|Sales (in local currency) of products promoted to new-to-brand shoppers, attributed to an ad view or click. Use total_new_to_brand_product_sales to see all conversions for the products of the brand.\t|\n","|total_sales\t|totalSales\t|Currency\t|Metric\t|Sales (in local currency) of the products of the brand, attributed to an ad view or click.\t|\n","|total_new_to_brand_product_sales\t|totalNewToBrandSales\t|Currency\t|Metric\t|Sales (in local currency) of the products of the brands purchased by new-to-brand shoppers, attributed to an ad view or click. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days.\t|\n","|purchases\t|purchases\t|Integer\t|Metric\t|Number of attributed conversion events occurring within 14 days of an ad click or view.\t|\n","|purchases_views\t|purchasesViews\t|Integer\t|Metric\t|Number of attributed conversion events occurring within 14 days of an ad view.\t|\n","|purchases_clicks\t|purchasesClicks\t|Integer\t|Metric\t|Number of attributed conversion events occurring within 14 days of an ad click.\t|\n","|new_to_brand_purchases\t|newToBrandPurchases\t|Integer\t|Metric\t|The number of first-time orders for brand products over a one-year lookback window resulting from an ad click or view. Not available for book vendors.\t|\n","|new_to_brand_purchases_views\t|newToBrandPurchasesViews\t|Integer\t|Metric\t|The number of new to branch purchases attributed to an ad view.\t|\n","|new_to_brand_purchases_clicks\t|newToBrandPurchasesClicks\t|Integer\t|Metric\t|The number of first-time orders for brand products over a one-year lookback window resulting from an ad click. Not available for book vendors.\t|\n","|total_purchases\t|totalPurchases\t|Integer\t|Metric\t|Number of times any quantity of a brand product was included in a purchase event, attributed to an ad view or click. Purchase events include new Subscribe & Save subscriptions and video rentals.\t|\n","|total_purchases_views\t|totalPurchasesViews\t|Integer\t|Metric\t|Number of times any quantity of a brand product was included in a purchase event, attributed to an ad view. Purchase events include new Subscribe & Save subscriptions and video rentals.\t|\n","|total_purchases_clicks\t|totalPurchasesClicks\t|Integer\t|Metric\t|Number of times any quantity of a brand product was included in a purchase event, attributed to an ad click. Purchase events include new Subscribe & Save subscriptions and video rentals.\t|\n","|total_new_to_brand_purchases\t|totalNewToBrandPurchases\t|Integer\t|Metric\t|Number of new-to-brand purchases for the products of the brands, attributed to an ad view or click. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days.\t|\n","|total_new_to_brand_purchases_views\t|totalNewToBrandPurchasesViews\t|Integer\t|Metric\t|Number of new-to-brand purchases for the products of the brands, attributed to an ad view. Shoppers are \"new-to-brand\" if they have not purchased from the brand in the last 365 days.\t|\n","|total_new_to_brand_purchases_clicks\t|totalNewToBrandPurchasesClicks\t|Integer\t|Metric\t|Number of new-to-brand purchases for the products of the brands, attributed to an ad click. Shoppers are \"new-to-brand\" if they have not purchased from the brand in the last 365 days.\t|\n","|app_subscription_sign_up_free_trial_clicks\t|appSubscriptionSignUpFreeTrialClicks\t|Integer\t|Metric\t|The number of free trial app subscriptions associated with a click on your ad.\t|\n","|app_subscription_sign_up_free_trial\t|appSubscriptionSignUpFreeTrial\t|Integer\t|Metric\t|The number of free trial app subscriptions associated with a click or view on your ad.\t|\n","|app_subscription_sign_up_free_trial_views\t|appSubscriptionSignUpFreeTrialViews\t|Integer\t|Metric\t|The number of free trial app subscriptions associated with ad impressions.\t|\n","|new_to_brand_purchases_brand_halo_clicks\t|newToBrandPurchasesBrandHaloClicks\t|Integer\t|Metric\t|Number of new-to-brand purchases for brand halo products, attributed to an ad click. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days. Use total_new_to_brand_purchases_clicks to see all conversions for the products of the brands.\t|\n","|new_to_brand_purchases_brand_halo\t|newToBrandPurchasesBrandHalo\t|Integer\t|Metric\t|Number of new-to-brand purchases for brand halo products, attributed to an ad view or click. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days. Use total_new_to_brand_purchases to see all conversions for the products of the brands.\t|\n","|new_to_brand_purchases_brand_halo_views\t|newToBrandPurchasesBrandHaloViews\t|Integer\t|Metric\t|Number of new-to-brand purchases for brand halo products, attributed to an ad view. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days. Use total_new_to_brand_purchases_views to see all conversions for the products of the brands.\t|\n","|app_subscription_sign_up_paid_clicks\t|appSubscriptionSignUpPaidClicks\t|Integer\t|Metric\t|The number of paid app subscriptions associated with a click on your ad.\t|\n","|app_subscription_sign_up_paid\t|appSubscriptionSignUpPaid\t|Integer\t|Metric\t|The number of paid app subscriptions associated with a click or view on your ad.\t|\n","|app_subscription_sign_up_paid_views\t|appSubscriptionSignUpPaidViews\t|Integer\t|Metric\t|The number of paid app subscriptions associated with ad impressions.\t|\n","|purchases_brand_halo_clicks\t|purchasesBrandHaloClicks\t|Integer\t|Metric\t|Number of times any quantity of a brand halo product was included in a purchase event, attributed to an ad click. Purchase events include new Subscribe & Save subscriptions and video rentals. Use total_purchases_clicks to see all conversions for the products of the brands.\t|\n","|purchases_brand_halo\t|purchasesBrandHalo\t|Integer\t|Metric\t|Number of times any quantity of a brand halo product was included in a purchase event, attributed to an ad view or click. Purchase events include new Subscribe & Save subscriptions and video rentals. Use total_purchases to see all conversions for the products of the brands.\t|\n","|purchases_brand_halo_views\t|purchasesBrandHaloViews\t|Integer\t|Metric\t|Number of times any quantity of a brand halo product was included in a purchase event, attributed to an ad view. Purchase events include new Subscribe & Save subscriptions and video rentals. Use total_purchases_views to see all conversions for the products of the brands.\t|\n","|app_subscription_sign_up_clicks\t|appSubscriptionSignUpClicks\t|Integer\t|Metric\t|The number of free trial and paid app subscriptions associated with a click on your ad.\t|\n","|app_subscription_sign_up\t|appSubscriptionSignUp\t|Integer\t|Metric\t|The number of free trial and paid app subscriptions associated with a click or view on your ad.\t|\n","|app_subscription_sign_up_views\t|appSubscriptionSignUpViews\t|Integer\t|Metric\t|The number of free trial and paid app subscriptions associated with ad impressions.\t|\n","|sales_clicks\t|salesClicks\t|Currency\t|Metric\t|Total value of sales occurring within 14 days of an ad click.\t|\n","|units_sold_clicks\t|unitsSoldClicks\t|Integer\t|Metric\t|Number of attributed units sold within 14 days of an ad click.\t|\n","|units_sold_promoted_clicks\t|unitsSoldPromotedClicks\t|Integer\t|Metric\t|Units of promoted products purchased, attributed to an ad click. A single click-attributed purchase event can include multiple sold units.\t|\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Sample payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":2,"text":"Amazon DSP clickstream dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" The adsp-clickstream dataset contains detail page views and add-to-cart metrics related to Amazon DSP campaigns.\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" To subscribe to this dataset, use the ID adsp-clickstream.\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" This dataset supports the following fields and metrics:\n","|Field name\t|API name\t|Type\t|Type\t|Description\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|dataset_id\t|N/A\t|String\t|Dimension\t|An identifier used to identify the dataset\t|\n","|idempotency_id\t|N/A\t|String\t|Dimension\t|An identifier that can be used to de-duplicate records\t|\n","|time_window_start\t|\t|String\t|Dimension\t|The start of the hour at which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated in the advertiser profile\t|\n","|adgroup_id\t|lineItemId\t|String\t|Dimension\t|A unique identifier assigned to a line item or ad group\t|\n","|advertiser_country\t|advertiserCountry\t|String\t|Dimension\t|The country assigned to the advertiser\t Note: This field can be null if the advertiser is not tied to a specific country|\n","|advertiser_id\t|advertiserId\t|String\t|Dimension\t|The unique identifier for the advertiser\t|\n","|advertiser_name\t|advertiserName\t|String\t|Dimension\t|The customer that has an advertising relationship with Amazon\t|\n","|advertiser_timezone\t|advertiserTimezone\t|String\t|Dimension\t|The time zone the advertiser uses for reporting and ad serving purposes\t|\n","|country\t|country\t|String\t|Dimension\t|Country or locale\t|\n","|creative_id\t|creativeId\t|String\t|Dimension\t|A unique identifier assigned to a creative. When this is different from creativeAdId, creativeId cannot be used in the /dsp/creatives endpoints.\t|\n","|creative_language\t|creativeLanguage\t|String\t|Dimension\t|The primary language in the creative\t|\n","|creative_name\t|creativeName\t|String\t|Dimension\t|Creative name\t|\n","|creative_size\t|creativeSize\t|String\t|Dimension\t|The dimensions of the creative in pixels\t|\n","|creative_type\t|creativeType\t|String\t|Dimension\t|The type of creative (for example static image, third party, or video)\t|\n","|deal\t|deal\t|String\t|Dimension\t|The name of a deal\t|\n","|deal_id\t|dealID\t|String\t|Dimension\t|The unique identifier for the deal\t|\n","|deal_type\t|dealType\t|String\t|Dimension\t|The type of deal\t|\n","|device\t|device\t|String\t|Dimension\t|The devices the customers used to view the ad\t|\n","|dsp_entity_id\t|entityId\t|String\t|Dimension\t|Entity (seat) ID\t|\n","|placement_name\t|placementName\t|String\t|Dimension\t|The name of the placement where the campaign ran\t|\n","|proposal_id\t|proposalId\t|String\t|Dimension\t|A unique identifier for an order imported from the Amazon Order Management System (OMS)\t|\n","|region\t|region\t|String\t|Dimension\t|State or region\t|\n","|site\t|siteName\t|String\t|Dimension\t|The site or group of sites the campaign ran on\t|\n","|supply_source_name\t|supplySourceName\t|String\t|Dimension\t|The inventory the campaign ran on, for example real-time bidding exchanges or Amazon-owned sites\t|\n","|marketplace_id\t|N/A\t|String\t|Dimension\t|The marketplace of the advertiser.|\n","|campaign_id\t|orderId\t|String\t|Dimension\t|The ID associated with a campaign\t|\n","|add_to_cart\t|addToCart\t|Integer\t|Metric\t|Number of times shoppers added the products of a brand to their cart, attributed to an ad view or click\t|\n","|add_to_cart_clicks\t|addToCartClicks\t|Integer\t|Metric\t|Number of times shoppers added the products of a brand to their cart, attributed to an ad click\t|\n","|add_to_cart_views\t|addToCartViews\t|Integer\t|Metric\t|Number of times shoppers added the products of the brand to their cart, attributed to an ad view\t|\n","|add_to_list\t|addToList\t|Integer\t|Metric\t|Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad view or click. Use total_add_to_list to see all conversions for the products of the brand.\t|\n","|add_to_list_clicks\t|addToListClicks\t|Integer\t|Metric\t|Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad click. Use total_add_to_list clicks to see all conversions for the products of the brand.\t|\n","|add_to_list_views\t|addToListViews\t|Integer\t|Metric\t|Number of times shoppers added a promoted product to a wish list, gift list, or registry, attributed to an ad view. Use total_add_to_list views to see all conversions for the products of the brand.\t|\n","|detail_page_views\t|detailPageViews\t|Integer\t|Metric\t|Number of detail page views occurring within 14 days of an ad click or view\t|\n","|detail_page_view_clicks\t|detailPageViewClicks\t|Integer\t|Metric\t|Number of detail page views occurring within 14 days of an ad click\t|\n","|detail_page_view_views\t|detailPageViewViews\t|Integer\t|Metric\t|The number of times a product detail page was viewed attributed to an ad view\t|\n","|subscribe_and_save\t|newSubscribeAndSave\t|Integer\t|Metric\t|Number of new Subscribe & Save subscriptions for all products, attributed to an ad view or click. This does not include replenishment subscription orders. Use total_subscribe_and_save to see all conversions for the products of the brand.\t|\n","|subscribe_and_save_clicks\t|newSubscribeAndSaveClicks\t|Integer\t|Metric\t|Number of new Subscribe & Save subscriptions for all products, attributed to ad clicks. This does not include replenishment subscription orders. Use total_subscribe_and_save to see all conversions for the products of the brand.\t|\n","|subscribe_and_save_views\t|newSubscribeAndSaveViews\t|Integer\t|Metric\t|Number of new Subscribe & Save subscriptions for all products, attributed to ad views. This does not include replenishment subscription orders. Use total_subscribe_and_save to see all conversions for the products of the brand.\t|\n","|total_add_to_cart\t|totalAddToCart\t|Integer\t|Metric\t|Number of times shoppers added the products of the brand to their cart, attributed to an ad view or click\t|\n","|total_add_to_cart_clicks\t|totalAddToCartClicks\t|Integer\t|Metric\t|Number of times shoppers added the products of the brand to their cart, attributed to an ad click\t|\n","|total_add_to_cart_views\t|totalAddToCartViews\t|Integer\t|Metric\t|Number of times shoppers added the products of the brand to their cart, attributed to an ad view\t|\n","|total_add_to_list\t|totalAddToList\t|Integer\t|Metric\t|Number of times shoppers added the products of the brand to a wish list, gift list, or registry, attributed to an ad view or click\t|\n","|total_add_to_list_clicks\t|totalAddToListClicks\t|Integer\t|Metric\t|Number of times shoppers added the products of the brand to a wish list, gift list, or registry, attributed to an ad click\t|\n","|total_add_to_list_views\t|totalAddToListViews\t|Integer\t|Metric\t|Number of times shoppers added the products of the brand to a wish list, gift list or registry, attributed to an ad view\t|\n","|total_detail_page_view_clicks\t|totalDetailPageViewClicks\t|Integer\t|Metric\t|Number of detail page views for all the brands and products attributed to an ad click\t|\n","|total_detail_page_views\t|totalDetailPageView\t|Integer\t|Metric\t|Number of detail page views for all the brands and products attributed to an ad view or click\t|\n","|total_detail_page_view_views\t|totalDetailPageViewViews\t|Integer\t|Metric\t|Number of detail page views for all the products of the brand, attributed to an ad view\t|\n","|total_subscribe_and_save_clicks\t|totalSubscribeAndSaveClicks\t|Integer\t|Metric\t|Number of new Subscribe & Save subscriptions for the brands and products, attributed to an ad click. This does not include replenishment subscription orders.\t|\n","|total_subscribe_and_save\t|totalSubscribeAndSave\t|Integer\t|Metric\t|Number of new Subscribe & Save subscriptions for the brands and products, attributed to an ad view or click. This does not include replenishment subscription orders.\t|\n","|total_subscribe_and_save_views\t|totalSubscribeAndSaveViews\t|Integer\t|Metric\t|Number of new Subscribe & Save subscriptions for the brands and products, attributed to an ad view. This does not include replenishment subscription orders.\t|\n","|add_to_watchlist_clicks\t|addToWatchlistClicks\t|Integer\t|Metric\t|The number of Add to Watchlist clicks attributed to ad click-throughs.\t|\n","|add_to_watchlist\t|addToWatchlist\t|Integer\t|Metric\t|The number of times Add to Watchlist was clicked on a featured product.\t|\n","|add_to_watchlist_views\t|addToWatchlistViews\t|Integer\t|Metric\t|The number of Add to Watchlist clicks attributed to ad impressions.\t|\n","|video_downloads_clicks\t|videoDownloadsClicks\t|Integer\t|Metric\t|The number of video downloads attributed to ad click-throughs.\t|\n","|video_downloads\t|videoDownloads\t|Integer\t|Metric\t|The number of times a video was downloaded for the featured product.\t|\n","|video_downloads_views\t|videoDownloadsViews\t|Integer\t|Metric\t|The number of video downloads attributed to ad impressions.\t|\n","|downloaded_video_plays_clicks\t|downloadedVideoPlaysClicks\t|Integer\t|Metric\t|The number of downloaded video plays attributed to ad click-throughs.\t|\n","|downloaded_video_plays\t|downloadedVideoPlays\t|Integer\t|Metric\t|The number of times a video was downloaded then played for the featured product.\t|\n","|downloaded_video_plays_views\t|downloadedVideoPlaysViews\t|Integer\t|Metric\t|The number of downloaded video plays attributed to ad impressions.\t|\n","|play_trailers_clicks\t|playTrailersClicks\t|Integer\t|Metric\t|The number of video trailer plays attributed to ad click-throughs.\t|\n","|play_trailers\t|playTrailers\t|Integer\t|Metric\t|The number of times a video trailer was played for the featured product.\t|\n","|play_trailers_views\t|playTrailersViews\t|Integer\t|Metric\t|The number of video trailer players attributed to ad impressions.\t|\n","|video_streams_clicks\t|videoStreamsClicks\t|Integer\t|Metric\t|The number of video streams attributed to ad click-throughs.\t|\n","|video_streams\t|videoStreams\t|Integer\t|Metric\t|The number of times a video was streamed (played without downloading).\t|\n","|video_streams_views\t|videoStreamsViews\t|Integer\t|Metric\t|The number of video streams attributed to ad impressions.\t|\n","|rentals_clicks\t|rentalsClicks\t|Integer\t|Metric\t|The number of video rentals attributed to ad click-throughs.\t|\n","|rentals\t|rentals\t|Integer\t|Metric\t|The number of times a video was rented for the featured product.\t|\n","|rentals_views\t|rentalsViews\t|Integer\t|Metric\t|The number of video rentals attributed to ad impressions.\t|\n","|skill_invocation_clicks\t|skillInvocationClicks\t|Integer\t|Metric\t|The number of times shoppers launched a promoted Alexa skill, attributed to an ad click. This can include tap, touch, and voice invocations.\t|\n","|skill_invocation\t|skillInvocation\t|Integer\t|Metric\t|The number of times shoppers launched a promoted Alexa skill, attributed to an ad view or click. This can include tap, touch, and voice invocations.\t|\n","|skill_invocation_views\t|skillInvocationViews\t|Integer\t|Metric\t|The number of times shoppers launched a promoted Alexa skill, attributed to an ad view. This can include tap, touch, and voice invocations.\t|\n","|total_new_to_brand_dpv_clicks\t|totalNewToBrandDPVClicks\t|Integer\t|Metric\t|Number of new-to-brand detail page views for all the products of the brands, attributed to an ad click.\t|\n","|total_new_to_brand_dpvs\t|totalNewToBrandDPVs\t|Integer\t|Metric\t|Number of new-to-brand detail page views for all the products of the brands, attributed to an ad view or click.\t|\n","|total_new_to_brand_dpv_views\t|totalNewToBrandDPVViews\t|Integer\t|Metric\t|Number of new-to-brand detail page views for all the products of the brands, attributed to an ad view.\t|\n","|total_product_review_page_visits_clicks\t|totalProductReviewPageVisitsClicks\t|Integer\t|Metric\t|Number of times shoppers visited a product review page for the products of the brands, attributed to an ad click.\t|\n","|total_product_review_page_visits\t|totalProductReviewPageVisits\t|Integer\t|Metric\t|Number of times shoppers visited a product review page for the products of the brands, attributed to an ad view or click.\t|\n","|total_product_review_page_visits_views\t|totalProductReviewPageVisitsViews\t|Integer\t|Metric\t|Number of times shoppers visited a product review page for the products of the brands, attributed to an ad view.\t|\n","|brand_searches_clicks\t|brandSearchesClicks\t|Integer\t|Metric\t|The number of branded search conversions attributed to ad click-throughs.\t|\n","|brand_searches\t|brandSearches\t|Integer\t|Metric\t|The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad interaction.\t|\n","|brand_searches_views\t|brandSearchesViews\t|Integer\t|Metric\t|The number of branded search conversions attributed to ad impressions.\t|\n","|click_to_apply_clicks\t|clickToApplyClicks\t|Integer\t|Metric\t|The number of click to apply conversions attributed to ad click-throughs.\t|\n","|click_to_apply\t|clickToApply\t|Integer\t|Metric\t|The number of time Click to apply was clicked for a featured product.\t|\n","|click_to_apply_views\t|clickToApplyViews\t|Integer\t|Metric\t|The number of Click to apply conversions attributed to ad impressions.\t|\n","|off_amazon_other_clicks\t|otherClicks\t|Integer\t|Metric\t|The number of Other conversions attributed to an ad click.\t|\n","|off_amazon_other\t|other\t|Integer\t|Metric\t|The number of Other conversions.\t|\n","|off_amazon_other_views\t|otherViews\t|Integer\t|Metric\t|The number of Other conversions attributed to an ad view.\t|\n","|off_amazon_page_view_clicks\t|pageViewClicks\t|Integer\t|Metric\t|The number of Page view conversions attributed to an ad click.\t|\n","|off_amazon_page_views\t|pageViews\t|Integer\t|Metric\t|The number of Page view conversions.\t|\n","|off_amazon_page_view_views\t|pageViewViews\t|Integer\t|Metric\t|The number of Page view conversions attributed to an ad view.\t|\n","|off_amazon_search_clicks\t|searchClicks\t|Integer\t|Metric\t|The number of Search conversions attributed to an ad click.\t|\n","|off_amazon_search\t|search\t|Integer\t|Metric\t|The number of Search conversions.\t|\n","|off_amazon_search_views\t|searchViews\t|Integer\t|Metric\t|The number of Search conversions attributed to an ad view.\t|\n","|off_amazon_contact_clicks\t|contactClicks\t|Integer\t|Metric\t|The number of Contact conversions attributed to an ad click.\t|\n","|off_amazon_contact\t|contact\t|Integer\t|Metric\t|The number of Contact conversions.\t|\n","|off_amazon_contact_views\t|contactViews\t|Integer\t|Metric\t|The number of Contact conversions attributed to an ad view.\t|\n","|off_amazon_checkout_clicks\t|checkoutClicks\t|Integer\t|Metric\t|The number of Checkout conversions attributed to an ad click.\t|\n","|off_amazon_checkout\t|checkout\t|Integer\t|Metric\t|The number of Checkout conversions.\t|\n","|off_amazon_checkout_views\t|checkoutViews\t|Integer\t|Metric\t|The number of Checkout conversions attributed to an ad view.\t|\n","|off_amazon_lead_clicks\t|leadClicks\t|Integer\t|Metric\t|The number of Lead conversions attributed to an ad click.\t|\n","|off_amazon_lead\t|lead\t|Integer\t|Metric\t|The number of Lead conversions.\t|\n","|off_amazon_lead_views\t|leadViews\t|Integer\t|Metric\t|The number of Lead conversions attributed to an ad view.\t|\n","|off_amazon_signup_views\t|signUpViews\t|Integer\t|Metric\t|Number of Sign-up conversions occurring off Amazon, attributed to an ad view.\t|\n","|off_amazon_mobile_app_first_start_clicks\t|mobileAppFirstStartClicks\t|Integer\t|Metric\t|The number of Mobile app first start conversions attributed to ad click-throughs.\t|\n","|off_amazon_mobile_app_starts\t|mobileAppFirstStarts\t|Integer\t|Metric\t|The number of times an app for the featured product was first started.\t|\n","|off_amazon_mobile_app_first_start_views\t|mobileAppFirstStartViews\t|Integer\t|Metric\t|The number of Mobile app first start conversions attributed to ad impressions.\t|\n","|off_amazon_subscribe_clicks\t|subscribeClicks\t|Integer\t|Metric\t|Number of Subscribe conversions occurring off Amazon, attributed to an ad click.\t|\n","|off_amazon_subscribe\t|subscribe\t|Integer\t|Metric\t|Number of Subscribe conversions occurring off Amazon, attributed to an ad view or click.\t|\n","|off_amazon_subscribe_views\t|subscribeViews\t|Integer\t|Metric\t|Number of Subscribe conversions occurring off Amazon, attributed to an ad view.\t|\n","|off_amazon_add_to_shopping_cart_clicks\t|addToShoppingCartClicks\t|Integer\t|Metric\t|The number of Add to shopping cart conversions attributed to an ad click.\t|\n","|off_amazon_add_to_shopping_cart\t|addToShoppingCart\t|Integer\t|Metric\t|The number of Add to shopping cart conversions.\t|\n","|off_amazon_add_to_shopping_cart_views\t|addToShoppingCartViews\t|Integer\t|Metric\t|The number of Add to shopping cart conversions attributed to an ad view.\t|\n","|off_amazon_purchases_clicks\t|offAmazonPurchasesClicks\t|Integer\t|Metric\t|Number of off-Amazon purchase events attributed to an ad click.\t|\n","|off_amazon_purchases\t|offAmazonPurchases\t|Integer\t|Metric\t|Off Amazon Purchases\t|\n","|off_amazon_product_sales\t|offAmazonProductSales\t|Currency\t|Metric\t|Sales (in local currency) of promoted products to off Amazon shoppers, attributed to an ad view or click.\t|\n","|off_amazon_purchases_views\t|offAmazonPurchasesViews\t|Integer\t|Metric\t|Number of off-Amazon purchase events attributed to an ad view.\t|\n","|off_amazon_application_clicks\t|applicationClicks\t|Integer\t|Metric\t|The number of Application conversions attributed to an ad click.\t|\n","|off_amazon_application\t|application\t|Integer\t|Metric\t|The number of Application conversions.\t|\n","|off_amazon_application_views\t|applicationViews\t|Integer\t|Metric\t|The number of Application conversions attributed to an ad view.\t|\n","|off_amazon_clicks\t|offAmazonClicks\t|Integer\t|Metric\t|Number of conversions that occurred off Amazon attributed to an ad click. This includes all conversion types.\t|\n","|off_amazon_views\t|offAmazonViews\t|Integer\t|Metric\t|Number of conversions that occurred off Amazon attributed to an ad view. This includes all conversion types.\t|\n","|product_review_page_visits_clicks\t|productReviewPageVisitsClicks\t|Integer\t|Metric\t|Number of times shoppers visited the product review page for a promoted product, attributed to an ad click. Use Total PRPV clicks to see all conversions for the products of the brands.\t|\n","|product_review_page_visits\t|productReviewPageVisits\t|Integer\t|Metric\t|Number of times shoppers visited the product review page for a promoted product, attributed to an ad view or click. Use Total PRPV to see all conversions for the products of the brands.\t|\n","|product_review_page_visits_views\t|productReviewPageVisitsViews\t|Integer\t|Metric\t|Number of times shoppers visited the product review page for a promoted product, attributed to an ad view. Use Total PRPV views to see all conversions for the products of the brands.\t|\n","|new_to_brand_detail_page_view_clicks\t|newToBrandDetailPageViewClicks\t|Integer\t|Metric\t|Number of new-to-brand detail page views for all the products of the brands, attributed to an ad click.\t|\n","|new_to_brand_detail_page_views\t|newToBrandDetailPageViews\t|Integer\t|Metric\t|The number of new detail page views from shoppers who have not previously viewed a detail page with an ASIN of the same brand in past 365 days and who either clicked or viewed an ad.\t|\n","|new_to_brand_detail_page_view_views\t|newToBrandDetailPageViewViews\t|Integer\t|Metric\t|Number of new-to-brand detail page views for all the products of the brands, attributed to an ad view\t|\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Sample payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":2,"text":"Amazon DSP rich media dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" The adsp-rich-media dataset contains video data related to Amazon DSP campaigns.\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" To subscribe to this dataset, use the ID adsp-rich-media.\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" This dataset supports the following fields and metrics:\n","|Field name\t|API name\t|Type\t|Type\t|Description\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|dataset_id\t|N/A\t|String\t|Dimension\t|An identifier used to identify the dataset\t|\n","|idempotency_id\t|N/A\t|String\t|Dimension\t|An identifier that can be used to de-duplicate records\t|\n","|time_window_start\t|N/A\t|String\t|Dimension\t|The start of the hour at which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated in the advertiser profile.\t|\n","|adgroup_id\t|lineItemId\t|String\t|Dimension\t|A unique identifier assigned to a line item or ad group\t|\n","|advertiser_country\t|advertiserCountry\t|String\t|Dimension\t|The country assigned to the advertiser\t Note: This field can be null if the advertiser is not tied to a specific country|\n","|advertiser_id\t|advertiserId\t|String\t|Dimension\t|The unique identifier for the advertiser\t|\n","|advertiser_name\t|advertiserName\t|String\t|Dimension\t|The customer that has an advertising relationship with Amazon\t|\n","|advertiser_timezone\t|advertiserTimezone\t|String\t|Dimension\t|The time zone the advertiser uses for reporting and ad serving purposes\t|\n","|country\t|country\t|String\t|Dimension\t|Country or locale\t|\n","|creative_id\t|creativeId\t|String\t|Dimension\t|A unique identifier assigned to a creative. When this is different from creativeAdId, creativeId cannot be used in the /dsp/creatives endpoints.\t|\n","|creative_language\t|creativeLanguage\t|String\t|Dimension\t|The primary language in the creative\t|\n","|creative_name\t|creativeName\t|String\t|Dimension\t|Creative name\t|\n","|creative_size\t|creativeSize\t|String\t|Dimension\t|The dimensions of the creative in pixels\t|\n","|creative_type\t|creativeType\t|String\t|Dimension\t|The type of creative (for example static image, third party, or video)\t|\n","|deal\t|deal\t|String\t|Dimension\t|The name of a deal\t|\n","|deal_id\t|dealID\t|String\t|Dimension\t|The unique identifier for the deal\t|\n","|deal_type\t|dealType\t|String\t|Dimension\t|The type of deal\t|\n","|device\t|device\t|String\t|Dimension\t|The devices the customers used to view the ad\t|\n","|dsp_entity_id\t|entityId\t|String\t|Dimension\t|Entity (seat) ID\t|\n","|placement_name\t|placementName\t|String\t|Dimension\t|The name of the placement where the campaign ran\t|\n","|proposal_id\t|proposalId\t|String\t|Dimension\t|A unique identifier for an order imported from the Amazon Order Management System (OMS).\t|\n","|region\t|region\t|String\t|Dimension\t|State or region.\t|\n","|site\t|siteName\t|String\t|Dimension\t|The site or group of sites the campaign ran on.\t|\n","|supply_source_name\t|supplySourceName\t|String\t|Dimension\t|The inventory the campaign ran on, for example real-time bidding exchanges or Amazon-owned sites.\t|\n","|marketplace_id\t|N/A\t|String\t|Dimension\t|The marketplace of the advertiser.|\n","|campaign_id\t|orderId\t|String\t|Dimension\t|The ID associated with a campaign.\t|\n","|audio_ad_companion_banner_clicks\t|audioAdCompanionBannerClicks\t|Integer\t|Metric\t|Tracks the number of times that the audio ad companion banner was clicked.\t|\n","|audio_ad_companion_banner_views\t|audioAdCompanionBannerViews\t|Integer\t|Metric\t|Tracks the number of times that the audio ad companion banner was displayed.\t|\n","|audio_ad_completions\t|audioAdCompletions\t|Integer\t|Metric\t|Tracks the number of times the audio ad plays to the end.\t|\n","|audio_ad_first_quartile\t|audioAdFirstQuartile\t|Integer\t|Metric\t|Tracks the number of times the audio ad plays to 25% of its length.\t|\n","|audio_ad_midpoint\t|audioAdMidpoint\t|Integer\t|Metric\t|Tracks the number of times the audio ad plays to 50% of its length\t|\n","|audio_ad_mute\t|audioAdMute\t|Integer\t|Metric\t|Tracks the number of times a user mutes the audio ad.\t|\n","|audio_ad_pause\t|audioAdPause\t|Integer\t|Metric\t|The number of times a user pauses the audio ad.\t|\n","|audio_ad_progression\t|audioAdProgression\t|Integer\t|Metric\t|Tracks an optimal audio ad time marker agreed upon with the publisher\t|\n","|audio_ad_resume\t|audioAdResume\t|Integer\t|Metric\t|Tracks the number of times a user resumes playback of the audio ad.\t|\n","|audio_ad_rewind\t|audioAdRewind\t|Integer\t|Metric\t|Tracks the number of times a user rewinds the audio ad.\t|\n","|audio_ad_skip\t|audioAdSkip\t|Integer\t|Metric\t|Tracks the number of times a user skips the audio ad.\t|\n","|audio_ad_start\t|audioAdStart\t|Integer\t|Metric\t|Tracks the number of times audio ad starts playing.\t|\n","|audio_ad_third_quartile\t|audioAdThirdQuartile\t|Integer\t|Metric\t|Tracks the number of times the audio ad plays to 75% of its length.\t|\n","|audio_ad_unmute\t|audioAdUnmute\t|Integer\t|Metric\t|Tracks the number of times a user skips the audio ad.\t|\n","|audio_ad_views\t|audioAdViews\t|Integer\t|Metric\t|Tracks the number of times that some playback of the audio ad has occurred.\t|\n","|video_ad_complete\t|videoComplete\t|Integer\t|Metric\t|The number of times a video ad played to completion. If rewind occurred, completion was calculated on the total percentage of unduplicated video viewed.\t|\n","|video_ad_first_quartile\t|videoFirstQuartile\t|Integer\t|Metric\t|The number of times at least 25% of a video ad played. If rewind occurred, percent complete was calculated on the total percentage of unduplicated video viewed.\t|\n","|video_ad_midpoint\t|videoMidpoint\t|Integer\t|Metric\t|The number of times at least 50% of a video ad played. If rewind occurred, percent complete was calculated on the total percentage of unduplicated video viewed.\t|\n","|video_ad_mute\t|videoMute\t|Integer\t|Metric\t|The number of times a user muted the video ad.\t|\n","|video_ad_pause\t|videoPause\t|Integer\t|Metric\t|The number of times a user paused the video ad.\t|\n","|video_ad_resume\t|videoResume\t|Integer\t|Metric\t|The number of times a user unpaused the video ad.\t|\n","|video_ad_start\t|videoStart\t|Integer\t|Metric\t|The number of times a video ad was started.\t|\n","|video_ad_third_quartile\t|videoThirdQuartile\t|Integer\t|Metric\t|The number of times at least 75% of a video ad played. If rewind occurred, percent complete was calculated on the total percentage of unduplicated video viewed.\t|\n","|video_ad_unmute\t|videoUnmute\t|Integer\t|Metric\t|The number of times a user unmuted the video ad.\t|\n"],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Sample payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[],"documentType":"guide"},{"title":"Amazon DSP performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/adsp-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":[" The Sponsored Products performance datasets provide details about traffic and conversions for Sponsored Products campaigns. \n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":{"type":2,"text":"Sponsored Products traffic dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":[" The sp-traffic dataset contains click, impression, and cost data related to Sponsored Products campaigns. \n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":[" To subscribe to this dataset, use the ID sp-traffic.\n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":[" This dataset supports the following fields and metrics:\n","| Field name | Type | Description |\n","\\|------------\\|------\\|------------\\|\n","| idempotency_id | String | An identifier that can be used to de-duplicate records. |\n","| dataset_id | String | An identifier used to identify the dataset (in this case, sp-traffic). |\n","| marketplace_id | String | The marketplace identifier associated with the account. |\n","| currency | String | The currency used for all monetary values for entities under the profile. |\n","| advertiser_id | String | ID associated with the advertiser. You can retrieve this ID using the GET v2/profiles endpoint. This value is not unique and may be the same across marketplaces. Note: For non-seller accounts, this advertiser_id is set to the entity ID. |\n","| campaign_id | String | Unique numerical ID for a campaign. |\n","| ad_group_id | String | Unique numerical ID for an ad group. |\n","| ad_id | String | Unique numerical ID for the ad. |\n","| keyword_id | String | ID of the keyword used for a bid. |\n","| keyword_text | String | Text of the keyword or phrase used for a bid. |\n","| match_type | String | Type of matching for the keyword or phrase used in a bid. |\n","| placement | String | The page location where an ad appeared. |\n","| time_window_start | String | The start of the hour to which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated on the advertiser profile. |\n","| clicks | Long | Total ad clicks. |\n","| impressions | Long | Total ad impressions. |\n","| cost | Double | Total cost of all clicks. Expressed in local currency. |\n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":[" Initial click data is available within 12 hours of the ad click. As part of the traffic validation process, clicks can be invalidated during the following 72 hours post the initial report. Amazon Marketing Stream will automatically deliver any adjustments to your queue. Data will be delivered to your queue in a burst every hour. It is not necessarily at the top of the hour, but it is once per hour.\n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":{"type":2,"text":"Sponsored Products conversions dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":[" The sp-conversion dataset contains conversion data attributed to Sponsored Products campaigns. \n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":[" To subscribe to this dataset, use the ID sp-conversion.\n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":["| Field name | Field type | Description |\n","\\|-----------\\|-----------\\|------------\\|\n","| idempotency_id | String | An identifier that can be used to de-duplicate records. |\n","| dataset_id | String | An identifier used to identify the dataset (in this case, sp-conversion). |\n","| marketplace_id | String | The marketplace identifier associated with the account. |\n","| currency | String | The currency used for all monetary values for entities under the profile. |\n","| advertiser_id | String | ID associated with the advertiser. You can retrieve this ID using the GET v2/profiles endpoint. This value is not unique and may be the same across marketplaces. Note: For non-seller accounts, this advertiser_id is set to the entity ID. |\n","| campaign_id | String | Unique numerical ID for a campaign. |\n","| ad_group_id | String | Unique numerical ID for an ad group. |\n","| ad_id | String | Unique numerical ID for the ad. |\n","| keyword_id | String | ID of the keyword used for a bid. |\n","| placement | String | The page location where an ad appeared. |\n","| time_window_start | String | The start of the hour to which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated on the advertiser profile. |\n","| attributed_conversions_1d | Long | Number of attributed conversion events occurring within 24 hours of ad click. |\n","| attributed_conversions_7d | Long | Number of attributed conversion events occurring within 7 days of an ad click. |\n","| attributed_conversions_14d | Long | Number of attributed conversion events occurring within 14 days of an ad click. |\n","| attributed_conversions_30d | Long | Number of attributed conversion events occurring within 30 days of an ad click. |\n","| attributed_conversions_1d_same_sku | Long | Number of attributed conversion events occurring within 24 hours of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_conversions_7d_same_sku | Long | Number of attributed conversion events occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_conversions_14d_same_sku | Long | Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_conversions_30d_same_sku | Long | Number of attributed conversion events occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_sales_1d | Double | Total value of sales occurring within 24 hours of an ad click. |\n","| attributed_sales_7d | Double | Total value of sales occurring within 7 days of an ad click. |\n","| attributed_sales_14d | Double | Total value of sales occurring within 14 days of an ad click. |\n","| attributed_sales_30d | Double | Total value of sales occurring within 30 days of an ad click. |\n","| attributed_sales_1d_same_sku | Double | Total value of sales occurring within 24 hours of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_sales_7d_same_sku | Double | Total value of sales occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_sales_14d_same_sku | Double | Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_sales_30d_same_sku | Double | Total value of sales occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_units_ordered_1d | Long | Total number of units ordered within 24 hours of an ad click. |\n","| attributed_units_ordered_7d | Long | Total number of units ordered within 7 days of an ad click. |\n","| attributed_units_ordered_14d | Long | Total number of units ordered within 14 days of an ad click. |\n","| attributed_units_ordered_30d | Long | Total number of units ordered within 30 days of an ad click. |\n","| attributed_units_ordered_1d_same_sku | Long | Total number of units ordered within 24 hours of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_units_ordered_7d_same_sku | Long | Total number of units ordered within 7 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_units_ordered_14d_same_sku | Long | Total number of units ordered within 14 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_units_ordered_30d_same_sku | Long | Total number of units ordered within 30 days of ad click where the purchased SKU was the same as the SKU advertised. |\n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored Products performance datasets","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sp-performance","content":[],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":[" These datasets contain click and conversion data related to Sponsored Display campaigns.\n"],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":{"type":2,"text":"Sponsored Display traffic dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":[" The sd-traffic dataset contains click, impression, and cost data related to Sponsored Display campaigns. \n"],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":[" To subscribe to this dataset, use the ID sd-traffic.\n"],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":["| Field name | Type | Description |\n","\\|---\\|---\\|---\\|\n","| idempotency_id | String | An identifier that can be used to de-duplicate records. |\n","| dataset_id | String | An identifier used to identify the dataset (in this case, sd-traffic). |\n","| marketplace_id | String | The marketplace identifier associated with the account. |\n","| currency | String | The currency used for all monetary values for entities under the profile. |\n","| advertiser_id | String | ID associated with the advertiser. You can retrieve this ID using the GET v2/profiles endpoint. This value is not unique and may be the same across marketplaces. Note: For non-seller accounts, this advertiser_id is set to the entity ID. |\n","| campaign_id | String | Unique numerical ID for a campaign. |\n","| ad_group_id | String | Unique numerical ID for an ad group. |\n","| ad_id | String | Unique numerical ID for the ad. |\n","| target_id | String | The identifier of the targeting expression. |\n","| targeting_text | String | The text used in the targeting expression. |\n","| time_window_start | String | The start of the hour to which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated on the advertiser profile. |\n","| clicks | Long | Total ad clicks. |\n","| impressions | Long | Total ad impressions. |\n","| view_impressions | Long | Total ad viewable impressions (for vCPM campaigns only). |\n","| cost | Double | Total cost of all clicks (CPC) or click or view (vCPM). Expressed in local currency. |\n"],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":[" Initial click data is available within 12 hours of the ad click. As part of the traffic validation process, clicks can be invalidated during the following 72 hours post the initial report. Amazon Marketing Stream will automatically deliver any adjustments to your queue.\n"],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":{"type":2,"text":"Sponsored Display conversions dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":[" The sd-conversion dataset contains conversion data attributed to Sponsored Display campaigns. \n"],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":[" To subscribe to this dataset, use the sd-conversion ID.\n"],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":["| Field name | Type | Description |\n","\\|---\\|---\\|---\\|\n","| idempotency_id | String | An identifier that can be used to de-duplicate records. |\n","| dataset_id | String | An identifier used to identify the dataset (in this case, sd-conversion). |\n","| marketplace_id | String | The marketplace identifier associated with the account. |\n","| currency | String | The currency used for all monetary values for entities under the profile. |\n","| advertiser_id | String | ID associated with the advertiser. You can retrieve this ID using the GET v2/profiles endpoint. This value is not unique and may be the same across marketplaces. Note: For non-seller accounts, this advertiser_id is set to the entity ID. |\n","| campaign_id | String | Unique numerical ID for a campaign. |\n","| ad_group_id | String | Unique numerical ID for an ad group. |\n","| ad_id | String | Unique numerical ID for the ad. |\n","| target_id | String | The identifier of the targeting expression. |\n","| time_window_start | String | The start of the hour to which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated on the advertiser profile. |\n","| attributed_conversions_1d | Long | Number of attributed conversion events occurring within 24 hours of ad click. |\n","| attributed_conversions_7d | Long | Number of attributed conversion events occurring within 7 days of an ad click. |\n","| attributed_conversions_14d | Long | Number of attributed conversion events occurring within 14 days of an ad click. |\n","| view_attributed_conversions_14d | Long | Number of attributed conversion events occurring within 14 days of an ad click or view (for vCPM campaigns only). |\n","| attributed_conversions_30d | Long | Number of attributed conversion events occurring within 30 days of an ad click. |\n","| attributed_conversions_1d_same_sku | Long | Number of attributed conversion events occurring within 24 hours of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_conversions_7d_same_sku | Long | Number of attributed conversion events occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_conversions_14d_same_sku | Long | Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_conversions_30d_same_sku | Long | Number of attributed conversion events occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_sales_1d | Double | Total value of sales occurring within 24 hours of an ad click. |\n","| attributed_sales_7d | Double | Total value of sales occurring within 7 days of an ad click. |\n","| attributed_sales_14d | Double | Total value of sales occurring within 14 days of an ad click. |\n","| view_attributed_sales_14d | Double | Total value of sales occurring within 14 days of an ad click or view (for vCPM campaigns only). |\n","| attributed_sales_30d | Double | Total value of sales occurring within 30 days of an ad click. |\n","| attributed_sales_1d_same_sku | Double | Total value of sales occurring within 24 hours of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_sales_7d_same_sku | Double | Total value of sales occurring within 7 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_sales_14d_same_sku | Double | Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_sales_30d_same_sku | Double | Total value of sales occurring within 30 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| attributed_units_ordered_1d | Long | Total number of units ordered within 24 hours of an ad click. |\n","| attributed_units_ordered_7d | Long | Total number of units ordered within 7 days of an ad click. |\n","| attributed_units_ordered_14d | Long | Total number of units ordered within 14 days of an ad click. |\n","| view_attributed_units_ordered_14d | Long | Total number of units ordered within 14 days of an ad click or view (for vCPM campaigns only). |\n","| attributed_units_ordered_30d | Long | Total number of units ordered within 30 days of an ad click. |\n","| attributed_orders_new_to_brand_14d | Long | Total number of orders within 14 days of an ad click. |\n","| attributed_sales_new_to_brand_14d | Double | Total value of new to brand sales within 14 days of an ad click. |\n","| attributed_units_ordered_new_to_brand_14d | Long | Total number of new to brand units ordered within 14 days of an ad click. |\n","| view_attributed_orders_new_to_brand_14d | Long | Total number of orders within 14 days of an ad click or view (for vCPM campaigns only). |\n","| view_attributed_sales_new_to_brand_14d | Double | Total value of new to brand sales within 14 days of an ad click or view (for vCPM campaigns only). |\n","| view_attributed_units_ordered_new_to_brand_14d | Long | Total number of new to brand units ordered within 14 days of an ad click or view (for vCPM campaigns only). |\n"],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored Display performance datasets","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sd-performance","content":[],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" These datasets contain click and conversion data related to Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":2,"text":"Sponsored Brands traffic dataset (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" The sb-traffic dataset contains click, impression, and cost data related to Sponsored Brands campaigns. \n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" To subscribe to this dataset, use the ID sb-traffic.\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":["| Field name | Type | Description |\n","\\|--------\\|------\\|--------\\|\n","| idempotency_id | String | An identifier that can be used to de-duplicate records. |\n","| dataset_id | String | An identifier used to identify the dataset (in this case, sb-traffic). |\n","| marketplace_id | String | The marketplace identifier associated with the account. |\n","| time_window_start | String | The start of the hour to which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated on the advertiser profile. |\n","| campaign_id | String | Unique numerical ID for a campaign. |\n","| ad_id | String | Unique numerical ID for the ad. |\n","| ad_group_id | String | Unique numerical ID for an ad group. |\n","| advertiser_id | String | ID associated with the advertiser. You can retrieve this ID using the GET v2/profiles endpoint. This value is not unique and may be the same across marketplaces. Note: For non-seller accounts, this advertiser_id is set to the entity ID. |\n","| keyword_id | String | ID of the keyword used for a bid. |\n","| keyword_text | String | Text of the keyword or phrase used for a bid. |\n","| keyword_type | String | The type of targeting used in the expression. |\n","| placement_type | String | The page location where an ad appeared. Possible values: Detail Page on-Amazon, Other on-Amazon, Top of Search on-Amazon. |\n","| currency | String | The currency used for all monetary values for entities under the profile. |\n","| clicks | Long | Total ad clicks. |\n","| cost | Double | Total cost of all clicks. Expressed in local currency. |\n","| impressions | Long | Total ad impressions. |\n","| viewable_impressions | Long | Number of impressions that met the Media Ratings Council (MRC) viewability standard (50 percent of the ad viewable with two seconds playback completed) |\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" Initial click data is available within 12 hours of the ad click. As part of the traffic validation process, clicks can be invalidated during the following 72 hours post the initial report. Amazon Marketing Stream will automatically deliver any adjustments to your queue.\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":2,"text":"Sponsored Brands conversion dataset (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" The sb-conversion dataset contains conversion and new-to-brand data related to Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" To subscribe to this dataset, use the ID sb-conversion.\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":["| Field name | Type | Description |\n","\\|-------\\|------\\|-----------\\|\n","| idempotency_id | String | An identifier that can be used to de-duplicate records. |\n","| dataset_id | String | An identifier used to identify the dataset (in this case, sb-conversion). |\n","| marketplace_id | String | The marketplace identifier associated with the account. |\n","| time_window_start | String | The start of the hour to which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated on the advertiser profile. |\n","| campaign_id | String | Unique numerical ID for a campaign. |\n","| ad_id | String | Unique numerical ID for the ad. |\n","| ad_group_id | String | Unique numerical ID for an ad group. |\n","| advertiser_id | String | ID associated with the advertiser. You can retrieve this ID using the GET v2/profiles endpoint. This value is not unique and may be the same across marketplaces. Note: For non-seller accounts, this advertiser_id is set to the entity ID. |\n","| keyword_id | String | ID of the keyword used for a bid. |\n","| keyword_text | String | Text of the keyword or phrase used for a bid. |\n","| keyword_type | String | The type of targeting used in the expression. |\n","| placement_type | String | The page location where an ad appeared. Possible values: Detail Page on-Amazon, Other on-Amazon, Top of Search on-Amazon. |\n","| currency | String | The currency used for all monetary values for entities under the profile. |\n","| view_attributed_conversions_14d | Long | Number of attributed conversion events occurring within 14 days of an ad view or click. |\n","| attributed_conversions_14d_same_sku | Long | Number of attributed conversion events occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| view_attributed_orders_new_to_brand_14d | Long | Total number of orders within 14 days of an ad view or click. |\n","| view_attributed_sales_14d | Double | Total value of sales occurring within 14 days of an ad view or click. |\n","| view_attributed_units_ordered_14d | Long | Total number of units ordered within 14 days of an ad view or click. |\n","| attributed_sales_14d_same_sku | Double | Total value of sales occurring within 14 days of ad click where the purchased SKU was the same as the SKU advertised. |\n","| view_attributed_sales_new_to_brand_14d | Double | Total value of new to brand sales within 14 days of an ad view or click. |\n","| view_attributed_units_ordered_new_to_brand_14d | Long | Total number of new to brand units ordered within 14 days of an ad view or click. |\n","| attributed_conversions_14d | Long | Number of attributed conversion events occurring within 14 days of an ad click. |\n","| attributed_orders_new_to_brand_14d | Long | Total number of new to brand units ordered within 14 days of a click. |\n","| attributed_sales_14d | Double | Total value of sales occurring within 14 days of an ad click. |\n","| attributed_sales_new_to_brand_14d | Double | Total value of new to brand sales within 14 days of an ad click. |\n","| attributed_units_ordered_new_to_brand_14d | Long | Total number of new to brand units ordered within 14 days of an ad click. |\n","| attributed_units_ordered_14d | Long | Total number of units ordered within 14 days of an ad click. |\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" Conversions for Sponsored Brands campaigns are reported based on the hour when the click they are attributed to occurred. Conversion data is reported daily, weekly, and monthly, and you should expect to receive revisions to conversion data up to sixty days after the initial click. \n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":2,"text":"Sponsored Brands clickstream dataset (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" The sb-clickstream dataset contains detail page views and branded searches data related to Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" To subscribe to this dataset, use the sb-clickstream ID.\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":["| Field name | Type | Description |\n","\\|------\\|------\\|-------\\|\n","| idempotency_id | String | An identifier that can be used to de-duplicate records. |\n","| dataset_id | String | An identifier used to identify the dataset (in this case, sb-clickstream). |\n","| marketplace_id | String | The marketplace identifier associated with the account. |\n","| time_window_start | String | The start of the hour to which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated on the advertiser profile. |\n","| campaign_id | String | Unique numerical ID for a campaign. |\n","| ad_id | String | Unique numerical ID for the ad. |\n","| ad_group_id | String | Unique numerical ID for an ad group. |\n","| advertiser_id | String | ID associated with the advertiser. You can retrieve this ID using the GET v2/profiles endpoint. This value is not unique and may be the same across marketplaces. Note: For non-seller accounts, this advertiser_id is set to the entity ID. |\n","| keyword_id | String | ID of the keyword used for a bid. |\n","| keyword_text | String | Text of the keyword or phrase used for a bid. |\n","| keyword_type | String | The type of targeting used in the expression. |\n","| placement_type | String | The page location where an ad appeared. Possible values: Detail Page on-Amazon, Other on-Amazon, Top of Search on-Amazon. |\n","| view_attributed_branded_searches_14d | Long | Total number of branded searches within 14 days of an ad view or click. |\n","| attributed_branded_searches_14d | Long | Total number of branded searches within 14 days of an ad click. |\n","| view_attributed_detail_page_views_14d | Long | Total number of detail page views within 14 days of an ad view or click. |\n","| attributed_detail_page_views_14d | Long | Total number of detail page views within 14 days of an ad click. |\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" Note that it could take up to 12 hours for performance data to populate after an event (detail page view, branded search) occurs. Performance data is reported hourly, and you should expect to receive revisions to performance data up to 60 days after the initial event. \n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":2,"text":"Sponsored Brands rich media dataset (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" The sb-rich-media dataset contains video data related to Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" To subscribe to this dataset, use the sb-rich-media ID.\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":["| Field name | Type | Description |\n","\\|------\\|------\\|----------\\|\n","| idempotency_id | String | An identifier that can be used to de-duplicate records. |\n","| dataset_id | String | An identifier used to identify the dataset (in this case, sb-rich-media). |\n","| marketplace_id | String | The marketplace identifier associated with the account. |\n","| time_window_start | String | The start of the hour to which the performance data is attributed (ISO 8601 date time). Time zone for each advertiser is indicated on the advertiser profile. |\n","| campaign_id | String | Unique numerical ID for a campaign. |\n","| ad_id | String | Unique numerical ID for the ad. |\n","| ad_group_id | String | Unique numerical ID for an ad group. |\n","| advertiser_id | String | ID associated with the advertiser. You can retrieve this ID using the GET v2/profiles endpoint. This value is not unique and may be the same across marketplaces. Note: For non-seller accounts, this advertiser_id is set to the entity ID. |\n","| keyword_id | String | ID of the keyword used for a bid. |\n","| keyword_text | String | Text of the keyword or phrase used for a bid. |\n","| keyword_type | String | The type of targeting used in the expression. |\n","| placement_type | String | The page location where an ad appeared. Possible values: Detail Page on-Amazon, Other on-Amazon, Top of Search on-Amazon. |\n","| video_5_second_views | Long | The number of impressions where the customer watched the complete video or 5 seconds (whichever is shorter). |\n","| video_complete_views | Long | The number of impressions where the video was viewed to 100%. |\n","| video_first_quartile_views | Long | The number of impressions where the video was viewed to 25%. |\n","| video_midpoint_views | Long | The number of impressions where the video was viewed to 50%. |\n","| video_third_quartile_views | Long | The number of impressions where the video was viewed to 75%. |\n","| video_unmutes | Long | The number of impressions where a customer unmuted the video. |\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored Brands performance datasets","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sb-performance","content":[],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[" This is the latest dimensional marketing stream covering all ad products (Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored Television, and Amazon DSP) whose message format reflects the read operation data model of the public API for the new Campaign Management APIs, to standardize experience and make for an easier implementation. \n"," Similar to the current process, you can use the Amazon Marketing Stream Subscription API to create, confirm, and manage subscriptions. Once authenticated, Amazon Marketing Stream will deliver all Ads campaign data (Amazon sponsored ads and Amazon DSP) to a single SQS endpoint.\n"],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Campaigns dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[" To subscribe to this dataset, use the ID ads-campaign-management-campaigns.\n"],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":["| Field | Type | Description |\n","\\|-------\\|------\\|-------------\\|\n","| campaign\\\\\\_id | string | A unique identifier for a campaign. |\n","| global\\\\\\_campaign\\\\\\_id | string | The global campaign identifier that manages this marketplace campaign. |\n","| portfolio\\\\\\_id | string | The ID of the portfolio |\n","| ad\\\\\\_product | enum | The ad product associated with the campaign. |\n","| auto\\\\\\_scale\\\\\\_global\\\\\\_campaign | enum | Setting for auto scaling campaigns. Values: AUTO, MANUAL |\n","| marketplace\\\\\\_scope | enum | The field indicating whether the campaign is global or single marketplace campaign. |\n","| marketplaces | enum\\[] | The list of country codes representing amazon marketplaces in which the global campaign is applicable |\n","| countries | enum\\[] | This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de. Values: AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW, ZZ, OTHER_EEA, OTHER |\n","| state | enum | The user set state of the campaign. For ADSP, a campaign can only be created in the PAUSED state. Values: PROPOSED, ENABLED, PAUSED, ARCHIVED |\n","| name | string | The name of the campaign. |\n","| skan\\\\\\_app\\\\\\_id | string | StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated. |\n","| start\\\\\\_date | string (DATE) | The start date of the campaign. |\n","| end\\\\\\_date | string (DATE) | The end date of the campaign. |\n","| start\\\\\\_date\\\\\\_time | string (DATETIME) | The start date time for the campaign. |\n","| end\\\\\\_date\\\\\\_time | string (DATETIME) | The end date time for the campaign. |\n","| creation\\\\\\_date\\\\\\_time | string (DATETIME) | The date time that the campaign was created. |\n","| last\\\\\\_updated\\\\\\_date\\\\\\_time | string (DATETIME) | The date time that the campaign was last updated. |\n","| targets\\\\\\_amazon\\\\\\_deal | boolean | If the campaign is targeting an Amazon deal, the value will be true, and the campaign and ad group(s) will be read-only. |\n","| targeted\\\\\\_pg\\\\\\_deal\\\\\\_id | string | DealId associated with the campaign. |\n","| status.delivery\\\\\\_status | enum | The overall status depicting if delivering or not. Values: DELIVERING, NOT_DELIVERING, UNAVAILABLE, LIMITED |\n","| status.delivery\\\\\\_reasons | enum\\[] | This is the list of reasons behind the delivery status. Can have up to 50 reasons. Values include: CAMPAIGN_INCOMPLETE, CAMPAIGN_PAUSED, CAMPAIGN_ARCHIVED, CAMPAIGN_END_DATE_REACHED, CAMPAIGN_PENDING_START_DATE, CAMPAIGN_OUT_OF_BUDGET, CAMPAIGN_PENDING_REVIEW, CAMPAIGN_REJECTED, CAMPAIGN_POLICING_SUSPENDED, AD_GROUPS_NOT_RUNNING, ADVERTISER_PAYMENT_FAILURE, ADVERTISER_OUT_OF_PREPAY_BALANCE, PORTFOLIO_PAUSED, PORTFOLIO_ARCHIVED, PORTFOLIO_END_DATE_REACHED, PORTFOLIO_PENDING_START_DATE, PORTFOLIO_OUT_OF_BUDGET, STATUS_UNAVAILABLE |\n","| status.marketplace\\\\\\_settings | array | An array of marketplace-specific status settings. Each element contains the fields below. |\n","| status.marketplace\\\\\\_settings.marketplace | enum | The marketplace to which the status settings value is applied |\n","| status.marketplace\\\\\\_settings.delivery\\\\\\_status | enum | The marketplace-specific overall status depicting if delivering or not. Values: DELIVERING, NOT_DELIVERING, UNAVAILABLE, LIMITED |\n","| status.marketplace\\\\\\_settings.delivery\\\\\\_reasons | enum\\[] | The marketplace-specific list of reasons behind the delivery status. Can have up to 50 reasons. Same values as status.delivery_reasons. |\n","| brand\\\\\\_id | string (16 chars) | The unique identifier for the brand. |\n","| product\\\\\\_category\\\\\\_id | string | This is the ID of the product category that the campaign is associated with. |\n","| tags.key | string | Open ended labels with a key value pair applied to the campaign |\n","| tags.value | string | Open ended labels with a key value pair applied to the campaign |\n","| budgets.recurrence\\\\\\_time\\\\\\_period | enum | The recurrence time period that the budget cap is associated with. Values: DAILY, MONTHLY, LIFETIME |\n","| budgets.budget\\\\\\_type | enum | The type of budget. Values: MONETARY, IMPRESSION |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value | object | The monetary budget value container (when budgetType is MONETARY). Contains the fields below. |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.currency\\\\\\_code | enum | The currency code associated with the monetary budget (when budgetType is MONETARY) |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.value | double | The monetary amount of the budget cap in the given currency |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.rule\\\\\\_value | double | The monetary amount of the budget when a budget rule is applied |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.marketplace\\\\\\_settings.marketplace | enum | The marketplace to which the MonetaryBudget is applied |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.marketplace\\\\\\_settings.monetary\\\\\\_budget.currency\\\\\\_code | enum | The currency code for the marketplace-specific budget |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.marketplace\\\\\\_settings.monetary\\\\\\_budget.value | double | The monetary amount for the marketplace-specific budget |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.marketplace\\\\\\_settings.monetary\\\\\\_budget.rule\\\\\\_value | double | The rule-based monetary amount for the marketplace-specific budget |\n","| frequencies.frequency\\\\\\_type | enum | The type of frequency cap. Values: CAPPED, UNCAPPED |\n","| frequencies.time\\\\\\_unit | enum | The unit of time associated with this frequency cap. Values: DAYS, HOURS |\n","| frequencies.time\\\\\\_count | int | The value associated with the time and unit of time for this frequency cap. |\n","| frequencies.event\\\\\\_max\\\\\\_count | int | The maximum number of times an EventType is served per user. Required when frequencyType = CAPPED. |\n","| frequencies.frequency\\\\\\_targeting\\\\\\_setting | enum | Whether caps apply to USER or HOUSEHOLD. Defaults to USER if not set. Values: USER (control frequency per person), HOUSEHOLD (control frequency across people within same household) |\n","| cost\\\\\\_type | enum | The way the campaign bids and is charged. Values: CPC (Cost per click), VCPM (Cost per thousand views), FIXED_PRICE (Sale price for a specific ad placement regardless of auction performance) |\n","| site\\\\\\_restrictions | enum\\[] | Restrict the ad to a particular site Values: AMAZON_BUSINESS, AMAZON_HAUL |\n","| sales\\\\\\_channel | enum | The location where products advertised as part of the campaign are sold. Values: AMAZON (A product sold on Amazon-owned sites), OFF_AMAZON (A product sold on a site not owned by Amazon) |\n","| auto\\\\\\_creation\\\\\\_settings.auto\\\\\\_create\\\\\\_targets | boolean | Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised. |\n","| auto\\\\\\_creation\\\\\\_settings.auto\\\\\\_manage\\\\\\_campaign | boolean | Flag that allows Amazon to manage the lifecycle of your Campaign. |\n","| auto\\\\\\_creation\\\\\\_settings.auto\\\\\\_create\\\\\\_dynamic\\\\\\_audience\\\\\\_targets | boolean | Gives Amazon permission to automatically create dynamically optimized targets that reaches customers relevant to my business. |\n","| optimizations.primary\\\\\\_inventory\\\\\\_types | enum | Primary inventory type of the campaign for filtering KPIs and recommending tactics. Values: DISPLAY, VIDEO_OLV, VIDEO_STV, AUDIO, COMPLETE_TV, LIVE_EVENTS |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_strategy | enum | The auto bidding strategy applied to the campaign. |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.placement\\\\\\_bid\\\\\\_adjustments.percentage | int | The selection of the percentage change associated with a given placement and bid adjustment settings. |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.placement\\\\\\_bid\\\\\\_adjustments.placement | enum | The selection of the placement associated with bid adjustment settings. Values: HOME_PAGE, PRODUCT_PAGE, TOP_OF_SEARCH, SITE_AMAZON_BUSINESS, REST_OF_SEARCH. |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.shopper\\\\\\_cohort\\\\\\_bid\\\\\\_adjustments.percentage | int | The selection of the percentage change associated with a given shopper cohort and bid adjustment settings. |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.shopper\\\\\\_cohort\\\\\\_bid\\\\\\_adjustments.shopper\\\\\\_cohort\\\\\\_type | enum | The shopper cohort type required to specify the type of shopper cohort used to apply bid adjustments. Example, an Audience Segment. Values: AUDIENCE_SEGMENT, HIGH_VALUE_SHOPPERS |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.shopper\\\\\\_cohort\\\\\\_bid\\\\\\_adjustments.audience\\\\\\_segments.audience\\\\\\_id | string | This is an Audience identifier vended by Audience Discovery. |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.shopper\\\\\\_cohort\\\\\\_bid\\\\\\_adjustments.audience\\\\\\_segments.audience\\\\\\_segment\\\\\\_type | enum | The audience segmenet type is required to specify the type of audience being used to apply bid adjustments. Values: DSP_AMC, SPONSORED_ADS_AMC |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.audience\\\\\\_bid\\\\\\_adjustments.percentage | int | The selection of the percentage change associated with a given audience and bid adjustment settings. |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.audience\\\\\\_bid\\\\\\_adjustments.audience\\\\\\_id | string | The unique identifier of the Audience to apply bid adjustment. |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.shopper\\\\\\_segment\\\\\\_bid\\\\\\_adjustments.percentage | int | The selection of the percentage change associated with a given shopper segment and bid adjustment settings. |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.shopper\\\\\\_segment\\\\\\_bid\\\\\\_adjustments.shopper\\\\\\_segment | enum | The selection of the shopper segment associated with bid adjustment settings. Values: NEW_TO_BRAND |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.creative\\\\\\_bid\\\\\\_adjustments.percentage | int | The selection of the percentage change associated with the creative type and bid adjustment settings. |\n","| optimizations.bid\\\\\\_settings.bid\\\\\\_adjustments.creative\\\\\\_bid\\\\\\_adjustments.creative\\\\\\_type | enum | The creative type that the ad is being rendered as. Values: SPOTLIGHT |\n","| optimizations.goal\\\\\\_settings.goal | enum |  |\n","| optimizations.goal\\\\\\_settings.kpi | enum | The KPI that the campaign goal is working to optimize. |\n","| optimizations.goal\\\\\\_settings.kpi\\\\\\_value | double | The value of the KPI that the campaign is working to optimize. |\n","| optimizations.goal\\\\\\_settings.currency\\\\\\_code | enum | The currency of the given KPI value for monetary based KPIs. |\n","| optimizations.budget\\\\\\_settings.budget\\\\\\_allocation | enum | Determines if the budget need to be automatically allocated based on the selected goal KPI. |\n","| optimizations.budget\\\\\\_settings.off\\\\\\_amazon\\\\\\_budget\\\\\\_control\\\\\\_strategy | enum | The strategy for off Amazon budget control. Values: MAXIMIZE_REACH, MINIMIZE_SPEND |\n","| optimizations.budget\\\\\\_settings.marketplace\\\\\\_budget\\\\\\_allocation | enum | Setting for auto distributing global budget. Values: AUTO, MANUAL |\n","| optimizations.budget\\\\\\_settings.flight\\\\\\_budget\\\\\\_rollover\\\\\\_strategy | enum | Strategy to apply for rolling over un-used flight budget. There are 3 options: Do not change flight budgets, Roll prior flight unused budget, Roll cumulative unused budget. Values: NO_ROLLOVER, PRIOR_BUDGET_ROLLOVER, CUMULATIVE_BUDGET_ROLLOVER |\n","| optimizations.conversion\\\\\\_settings.view\\\\\\_weight | decimal | Weight applied to view-based conversions for optimization. This setting currently accepts 0 and 1 values and is available only when Cost Per Conversions Off Amazon goal KPI is selected. |\n","| fee.fee\\\\\\_type | enum | The type of fee. |\n","| fee.add\\\\\\_to\\\\\\_budget\\\\\\_spent\\\\\\_amount | boolean | Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports. |\n","| fee.fees\\\\\\_third\\\\\\_party\\\\\\_provider | enum | Applicable to THIRD_PARTY_APPLIED_FEE and THIRD_PARTY_TARGETING_FEE. Provider represents the data provider to whom the fee is paid. |\n","| fee.fee\\\\\\_value\\\\\\_type | enum | The type of value associated with this fee |\n","| fee.currency\\\\\\_code | enum | ISO 4217 standard currency code for all currency-related attributes. Applicable when feeValueType is FIXED_CPM. |\n","| flights.flight\\\\\\_id | string | The unique identifier of the flight. |\n","| flights.start\\\\\\_date\\\\\\_time | string (DATETIME) | The start date of the flight. |\n","| flights.end\\\\\\_date\\\\\\_time | string (DATETIME) | The end date of the flight. |\n","| flights.name | string | The name of the flight. |\n","| flights.budget.recurrence\\\\\\_time\\\\\\_period | enum | The recurrence time period that the budget cap is associated with. Values: DAILY, MONTHLY, LIFETIME |\n","| flights.budget.budget\\\\\\_type | enum | The type of budget. Values: MONETARY, IMPRESSION |\n","| flights.budget.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.currency\\\\\\_code | enum | The currency code associated with the monetary budget (when budgetType is MONETARY) |\n","| flights.budget.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.value | double | The monetary amount of the budget cap in the given currency |\n","| flights.budget.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.rule\\\\\\_value | double | The monetary amount of the budget when a budget rule is applied |\n","| flights.budget.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.marketplace\\\\\\_settings.marketplace | enum | The marketplace to which the MonetaryBudget is applied |\n","| flights.budget.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.marketplace\\\\\\_settings.marketplace\\\\\\_settings.monetary\\\\\\_budget.value | double | The monetary amount for the marketplace-specific budget |\n","| flights.budget.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.marketplace\\\\\\_settings.marketplace\\\\\\_settings.monetary\\\\\\_budget.rule\\\\\\_value | double | The rule-based monetary amount for the marketplace-specific budget |\n","| is\\\\\\_multi\\\\\\_ad\\\\\\_groups\\\\\\_enabled | boolean | A read-only field that indicates whether a campaign supports multiple adGroups. |\n","| purchase\\\\\\_order\\\\\\_number | string | The purchase order number associated with the campaign. |\n","| marketplace\\\\\\_configurations.marketplace | enum | The marketplace to which the configurations apply Values: AE, AU, BE, BR, CA, CL, CO, DE, EG, ES, FR, GB, IE, IN, IT, JP, MX, NG, NL, PL, SA, SE, SG, TR, US, ZA |\n","| marketplace\\\\\\_configurations.campaign\\\\\\_id | string | Represents marketplace campaign id (Ex: campaignId-US) associated to global campaign (Ex: campaignId-Global) |\n","| marketplace\\\\\\_configurations.overrides.state | enum | The state of the campaign Values: PROPOSED, ENABLED, PAUSED, ARCHIVED |\n","| marketplace\\\\\\_configurations.overrides.name | string | The name of the campaign |\n","| marketplace\\\\\\_configurations.overrides.start\\\\\\_date\\\\\\_time | string (DATETIME) | The start date time for the campaign |\n","| marketplace\\\\\\_configurations.overrides.end\\\\\\_date\\\\\\_time | string (DATETIME) | The end date time for the campaign |\n"],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":2,"text":"AdGroups dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[" To subscribe to this dataset, use the ID ads-campaign-management-adgroups.\n"],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":["| Field | Type | Description |\n","\\|-------\\|------\\|-------------\\|\n","| ad\\\\\\_group\\\\\\_id | string | The unique identifier of the ad group. |\n","| global\\\\\\_ad\\\\\\_group\\\\\\_id | string | The global adGroup identifier that manages this marketplace adGroup. |\n","| campaign\\\\\\_id | string | The unique identifier of the campaign the ad group belongs to. |\n","| ad\\\\\\_product | enum | The ad product associated with the ad group. |\n","| marketplace\\\\\\_scope | enum | The field indicating whether the ad group is single marketplace or global ad group. This is readonly field with value same as the parent campaign |\n","| marketplaces | enum\\[] | The list of country codes representing amazon marketplaces in which the global ad group is applicable. The marketplaces included should either be same as or subset of parent campaign |\n","| state | enum | The user set state of the ad group. For ADSP, an ad group can only be created in the PAUSED state. Values: ENABLED, PAUSED, ARCHIVED, PROPOSED |\n","| name | string | The name of the ad group. |\n","| creation\\\\\\_date\\\\\\_time | string (DATETIME) | The date time that the ad group was created. |\n","| last\\\\\\_updated\\\\\\_date\\\\\\_time | string (DATETIME) | The date time that the ad group was last updated. |\n","| start\\\\\\_date\\\\\\_time | string (DATETIME) | The start date time for the ad group. |\n","| end\\\\\\_date\\\\\\_time | string (DATETIME) | The end date time for the ad group. |\n","| status.delivery\\\\\\_status | enum | The overall status depicting if delivering or not. Values: DELIVERING, NOT_DELIVERING, UNAVAILABLE, LIMITED |\n","| status.delivery\\\\\\_reasons | enum\\[] | This is the list of reasons behind the delivery status. Can have up to 50 reasons. Values include: AD_GROUP_INCOMPLETE, AD_GROUP_PAUSED, AD_GROUP_ARCHIVED, AD_GROUP_ENDED, AD_GROUP_PENDING_START_DATE, AD_GROUP_LOW_BID, AD_GROUP_POLICING_PENDING_REVIEW, AD_GROUP_POLICING_SUSPENDED, AD_CREATIVES_NOT_RUNNING, CREATIVE_REJECTED, ADVERTISER_PAYMENT_FAILURE, ADVERTISER_OUT_OF_PREPAY_BALANCE, STATUS_UNAVAILABLE |\n","| status.marketplace\\\\\\_settings | array | An array of marketplace-specific status settings. Each element contains the fields below. |\n","| status.marketplace\\\\\\_settings.marketplace | enum | The marketplace to which the status settings value is applied |\n","| status.marketplace\\\\\\_settings.delivery\\\\\\_status | enum | The marketplace-specific overall status depicting if delivering or not. Values: DELIVERING, NOT_DELIVERING, UNAVAILABLE, LIMITED |\n","| status.marketplace\\\\\\_settings.delivery\\\\\\_reasons | enum\\[] | The marketplace-specific list of reasons behind the delivery status. Can have up to 50 reasons. Same values as status.delivery_reasons. |\n","| inventory\\\\\\_type | enum | The inventory type that this ad groups ads can appear on. |\n","| creative\\\\\\_type | enum | The type of creatives that the ad group contains. Values: IMAGE, VIDEO, FTV_DEVICE_NATIVE |\n","| creative\\\\\\_rotation\\\\\\_type | enum | The strategy for rotating creatives within the ad group. Values: RANDOM, WEIGHTED |\n","| bid.bid.default\\\\\\_bid | double | The default maximum bid for ads and targets in the ad group. |\n","| bid.bid.base\\\\\\_bid | double | The lower bound bid used for the ads in the ad group. |\n","| bid.bid.currency\\\\\\_code | enum | The currency code the bid is expressed in. |\n","| bid.bid.max\\\\\\_average\\\\\\_bid | double | The max average bid that will be targeted on the ad group across all of the bids. |\n","| bid.marketplace\\\\\\_settings.marketplace | enum | The marketplace at which the bid value is applied at |\n","| bid.marketplace\\\\\\_settings.bid.default\\\\\\_bid | double | The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction. |\n","| bid.marketplace\\\\\\_settings.bid.base\\\\\\_bid | double | The lower bound bid used for the ads in the ad group. |\n","| bid.marketplace\\\\\\_settings.bid.currency\\\\\\_code | enum | The currency code the bid is expressed in. |\n","| bid.marketplace\\\\\\_settings.bid.max\\\\\\_average\\\\\\_bid | double | The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number). |\n","| optimization.bid\\\\\\_strategy | enum | The auto bidding strategy applied to to the ad group. |\n","| optimization.budget\\\\\\_settings.budget\\\\\\_allocation | enum | Determines if budgets need to be automatically allocated to better performing ad groups based on the selected goal KPI. |\n","| optimization.budget\\\\\\_settings.daily\\\\\\_min\\\\\\_spend\\\\\\_value | double | Denotes the daily minimum spend on the ad group in local currency. |\n","| optimization.goal\\\\\\_settings.kpi | enum | The KPI that the ad group goal is working to optimize. |\n","| budgets.recurrence\\\\\\_time\\\\\\_period | enum | The recurrence time period that the budget cap is associated with. Values: DAILY, MONTHLY, LIFETIME |\n","| budgets.budget\\\\\\_type | enum | The type of budget. Values: MONETARY, IMPRESSION |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.currency\\\\\\_code | enum | The currency code associated with the monetary budget (when budgetType is MONETARY) |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.value | double | The monetary amount of the budget cap in the given currency |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.monetary\\\\\\_budget.rule\\\\\\_value | double | The monetary amount of the budget when a budget rule is applied |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.marketplace\\\\\\_settings.marketplace | enum | The marketplace to which the MonetaryBudget is applied |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.marketplace\\\\\\_settings.monetary\\\\\\_budget.currency\\\\\\_code | enum | The currency code for the marketplace-specific budget |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.marketplace\\\\\\_settings.monetary\\\\\\_budget.value | double | The monetary amount for the marketplace-specific budget |\n","| budgets.budget\\\\\\_value.monetary\\\\\\_budget\\\\\\_value.marketplace\\\\\\_settings.monetary\\\\\\_budget.rule\\\\\\_value | double | The rule-based monetary amount for the marketplace-specific budget |\n","| pacing.delivery\\\\\\_profile | enum | DeliveryProfile determines how the system will spend budget and deliver impressions. Values: EVEN (consistent spending), PACE_AHEAD (25% more than daily Even pace), ASAP (immediate spending) |\n","| frequencies.frequency\\\\\\_type | enum | The type of frequency cap. Values: CAPPED, UNCAPPED |\n","| frequencies.time\\\\\\_unit | enum | The unit of time associated with this frequency cap. Values: DAYS, HOURS |\n","| frequencies.time\\\\\\_count | int | The value associated with the time and unit of time for this frequency cap. |\n","| frequencies.event\\\\\\_max\\\\\\_count | int | The maximum number of times an EventType is served per user. Required when frequencyType = CAPPED. |\n","| frequencies.frequency\\\\\\_targeting\\\\\\_setting | enum | Whether caps apply to USER or HOUSEHOLD. Defaults to USER if not set. Values: USER (control frequency per person), HOUSEHOLD (control frequency across people within same household) |\n","| targeting\\\\\\_settings.site\\\\\\_language | enum | The ISO 639-1 language code. Values: AR, BN, CS, DA, DE, EN, ES, FI, FR, GU, HI, IT, JA, KN, ML, MR, NL, NO, PL, PT, PA, SV, TA, TE, TR, ZH, OTHER |\n","| targeting\\\\\\_settings.enable\\\\\\_language\\\\\\_targeting | boolean | If true, creatives will only target supply where the content language matches the creative language. |\n","| targeting\\\\\\_settings.amazon\\\\\\_viewability.viewability\\\\\\_tier | enum | The targeted viewability tier. Values: ALL_TIERS, LESS_THAN_40_PERCENT, GREATER_THAN_40_PERCENT, GREATER_THAN_50_PERCENT, GREATER_THAN_60_PERCENT, GREATER_THAN_70_PERCENT |\n","| targeting\\\\\\_settings.amazon\\\\\\_viewability.include\\\\\\_unmeasurable\\\\\\_impressions | boolean | Must be false if viewabilityTier is ALL_TIERS. |\n","| targeting\\\\\\_settings.user\\\\\\_location\\\\\\_signal | enum | The type of signal used to determine a users location. Values: CURRENT, MULTIPLE_SIGNALS |\n","| targeting\\\\\\_settings.time\\\\\\_zone\\\\\\_type | enum | The time zone associated with ad group delivery. Values: VIEWER, ADVERTISER_REGION |\n","| targeting\\\\\\_settings.default\\\\\\_audience\\\\\\_targeting\\\\\\_match\\\\\\_type | enum | Match type for audience targeting inclusion groups. Values: SIMILAR, EXACT |\n","| targeting\\\\\\_settings.video\\\\\\_completion\\\\\\_tier | enum | Video completion tier selection. Values: ALL_TIERS, GREATER_THAN_10_PERCENT through GREATER_THAN_90_PERCENT |\n","| targeting\\\\\\_settings.targeted\\\\\\_pg\\\\\\_deal\\\\\\_id | string | DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here. |\n","| targeting\\\\\\_settings.inherit\\\\\\_targeting\\\\\\_settings\\\\\\_from\\\\\\_parent | boolean | If set to true, inherit targeting settings from advertiser/entity. If there is any conflict, the values from the adGroup targetingSettings will override the inherited targeting settings from advertiser/entity. |\n","| targeting\\\\\\_settings.tactics\\\\\\_converters\\\\\\_exclusion\\\\\\_type | enum | Defines the state of exclusion for the tactics ad lines. Values: NO_EXCLUSION, RECENT_CONVERTERS |\n","| tags.key | string | Open ended labels with a key value pair applied to the ad group |\n","| tags.value | string | Open ended labels with a key value pair applied to the ad group |\n","| purchase\\\\\\_order\\\\\\_number | string | The purchase order number associated with the ad group. |\n","| advertised\\\\\\_product\\\\\\_category\\\\\\_ids | string\\[] | The array of identifiers of product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed |\n","| fees.fee\\\\\\_type | string | The type of fee associated to adGroup |\n","| fees.add\\\\\\_to\\\\\\_budget\\\\\\_spent\\\\\\_amount | boolean | Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports. |\n","| fees.third\\\\\\_party\\\\\\_provider | string | Applicable to THIRD_PARTY_APPLIED_FEE and THIRD_PARTY_TARGETING_FEE. Provider represents the data provider to whom the fee is paid. |\n","| fees.fee\\\\\\_value\\\\\\_type | string | The type of value associated with this fee |\n","| fees.fee\\\\\\_value | double | The fee amount expressed as the feeValueType. AMAZON_AUDIENCE_FEE AND THIRD_PARTY_AUDIENCE_FEE is in the currency of the marketplace. All other CPM based fees are in the currency of the advertiser. For percentages, 100 represents 100%. |\n","| fees.currency\\\\\\_code | string | ISO 4217 standard currency code for all currency-related attributes. Applicable when feeValueType is FIXED_CPM. |\n","| marketplace\\\\\\_configurations.marketplace | enum | The marketplace to which the configurations apply |\n","| marketplace\\\\\\_configurations.ad\\\\\\_group\\\\\\_id | string | Represents marketplace adGroup id (Ex: adGroupId-US) associated to global adGroup (Ex: adGroupId-Global) |\n","| marketplace\\\\\\_configurations.overrides.state | enum | The state of the ad group for this marketplace |\n","| marketplace\\\\\\_configurations.overrides.name | string | The name of the ad group for this marketplace |\n","| marketplace\\\\\\_configurations.overrides.tags.key | string | Marketplace specific tags for the ad group |\n","| marketplace\\\\\\_configurations.overrides.tags.value | string | Marketplace specific tags for the ad group |\n"],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Ads dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[" To subscribe to this dataset, use the ID ads-campaign-management-ads.\n"],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":["| Field | Type | Description |\n","\\|-------\\|------\\|-------------\\|\n","| ad\\\\\\_id | string | The identifier of the ad. |\n","| global\\\\\\_ad\\\\\\_id | string | The global ad identifier that manages this marketplace ad. |\n","| ad\\\\\\_group\\\\\\_id | string | The ad group associated with the ad. |\n","| campaign\\\\\\_id | string | The campaign associated with the ad. This is a read-only field. |\n","| ad\\\\\\_product | enum | The ad product associated with the ad. Enum: \"SPONSORED_PRODUCTS\" \"SPONSORED_BRANDS\" \"AMAZON_DSP\" |\n","| marketplace\\\\\\_scope | enum | The field indicating whether the ad is global or single marketplace ad. This is readonly field with value same as the parent ad group |\n","| marketplaces | enum\\[] | The list of country codes representing amazon marketplaces in which the global ad is applicable. The marketplaces included should either be same as or subset of parent ad group. |\n","| state | enum | The state of the ad. Values: ENABLED, PAUSED, ARCHIVED, PROPOSED |\n","| name | string | The name of the ad. |\n","| creation\\\\\\_date\\\\\\_time | string (DATETIME) | The date time that the ad was created. |\n","| last\\\\\\_updated\\\\\\_date\\\\\\_time | string (DATETIME) | The date time that the ad was last updated. |\n","| status.delivery\\\\\\_status | enum | The overall status depicting if delivering or not. Values: DELIVERING, NOT_DELIVERING, UNAVAILABLE, LIMITED |\n","| status.delivery\\\\\\_reasons | enum\\[] | This is the list of reasons behind the delivery status. Can have up to 50 reasons. Values include: AD_PAUSED, AD_ARCHIVED, AD_POLICING_PENDING_REVIEW, AD_POLICING_SUSPENDED, AD_MISSING_DECORATION, AD_MISSING_IMAGE, ADVERTISER_PAYMENT_FAILURE, ADVERTISER_OUT_OF_PREPAY_BALANCE, STATUS_UNAVAILABLE |\n","| status.marketplace\\\\\\_settings | array | An array of marketplace-specific status settings. Each element contains the fields below. |\n","| status.marketplace\\\\\\_settings.marketplace | enum | The marketplace to which the status settings value is applied |\n","| status.marketplace\\\\\\_settings.delivery\\\\\\_status | enum | The marketplace-specific overall status depicting if delivering or not. Values: DELIVERING, NOT_DELIVERING, UNAVAILABLE, LIMITED |\n","| status.marketplace\\\\\\_settings.delivery\\\\\\_reasons | enum\\[] | The marketplace-specific list of reasons behind the delivery status. Can have up to 50 reasons. Same values as status.delivery_reasons. |\n","| creative.product\\\\\\_creative.product\\\\\\_creative\\\\\\_settings.advertised\\\\\\_product.product\\\\\\_id\\\\\\_type | enum | Enum: ASIN SKU |\n","| creative.product\\\\\\_creative.product\\\\\\_creative\\\\\\_settings.advertised\\\\\\_product.product\\\\\\_id | string | The identifier of the advertised product |\n","| creative.product\\\\\\_creative.product\\\\\\_creative\\\\\\_settings.advertised\\\\\\_product.resolved\\\\\\_product\\\\\\_id\\\\\\_type | enum | Enum: ASIN SKU |\n","| creative.product\\\\\\_creative.product\\\\\\_creative\\\\\\_settings.advertised\\\\\\_product.resolved\\\\\\_product\\\\\\_id | string | The identifier of product associated with the advertised product. This is a read-only field. |\n","| creative.product\\\\\\_creative.product\\\\\\_creative\\\\\\_settings.advertised\\\\\\_product.marketplace\\\\\\_settings.marketplace | enum | The marketplace to which the below state value is applied |\n","| creative.product\\\\\\_creative.product\\\\\\_creative\\\\\\_settings.advertised\\\\\\_product.marketplace\\\\\\_settings.product\\\\\\_id | string | The identifier of the product advertised. |\n","| creative.product\\\\\\_creative.product\\\\\\_creative\\\\\\_settings.advertised\\\\\\_product.marketplace\\\\\\_settings.resolved\\\\\\_product\\\\\\_id | string | The identifier of product associated with the advertised product. This is a read-only field. |\n","| creative.product\\\\\\_creative.product\\\\\\_creative\\\\\\_settings.headline | string | The headline/custom text associated with the ad creative. |\n","| creative.product\\\\\\_creative.product\\\\\\_creative\\\\\\_settings.global\\\\\\_store\\\\\\_settings | object |  |\n","| ad\\\\\\_type | enum | The type of the ad. Values: DISPLAY, VIDEO, AUDIO, PODCAST, THIRD_PARTY, COMPONENT, PRODUCT_AD |\n","| tags.key | string | Open ended labels with a key value pair applied to the ad |\n","| tags.value | string | Open ended labels with a key value pair applied to the ad |\n","| marketplace\\\\\\_configurations.marketplace | enum | The marketplace to which the overrides apply |\n","| marketplace\\\\\\_configurations.ad\\\\\\_id | string | Represents marketplace ad id (Ex: adId-US) associated to global ad (Ex: adId-Global) |\n","| marketplace\\\\\\_configurations.overrides.state | enum | The state of the ad |\n","| marketplace\\\\\\_configurations.overrides.tags.key | string | Open ended labels with a key value pair applied to the ad |\n","| marketplace\\\\\\_configurations.overrides.tags.value | string | Open ended labels with a key value pair applied to the ad |\n"],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Targets dataset"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[" To subscribe to this dataset, use the ID ads-campaign-management-targets.\n"],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":["| Field | Type | Description |\n","\\|-------\\|------\\|-------------\\|\n","| target\\\\\\_id | string | A unique identifier for the target. |\n","| global\\\\\\_target\\\\\\_id | string | The global target identifier that manages this marketplace target. |\n","| ad\\\\\\_group\\\\\\_id | string | A unique identifier for the ad group associated with the target. Only used for ad-group level targets. |\n","| campaign\\\\\\_id | string | A unique identifier for the campaign associated with the target. Only used for campaign-level targets. |\n","| ad\\\\\\_product | enum | The ad product associated with the target. |\n","| marketplace\\\\\\_scope | enum | The field indicating whether the target is single marketplace or global. |\n","| marketplaces | enum\\[] | The list of marketplace in which the global target is applicable. The marketplaces included should either be same as or subset of parent campaign/ad group |\n","| state | enum | The state of the target. Values: ENABLED, PAUSED, ARCHIVED, PROPOSED |\n","| negative | boolean | Indicates whether the target is negative or not. |\n","| target\\\\\\_level | enum | Indicates whether the target is at the campaign or ad group level. Values: CAMPAIGN, AD_GROUP |\n","| creation\\\\\\_date\\\\\\_time | string (DATETIME) | The date time the target was created. |\n","| last\\\\\\_updated\\\\\\_date\\\\\\_time | string (DATETIME) | The date time the target was last updated. |\n","| status.delivery\\\\\\_status | enum | The overall status depicting if delivering or not. Values: DELIVERING, NOT_DELIVERING, UNAVAILABLE, LIMITED |\n","| status.delivery\\\\\\_reasons | enum\\[] | This is the list of reasons behind the delivery status. Can have up to 50 reasons. Values include: TARGET_PAUSED, TARGET_ARCHIVED, TARGET_POLICING_SUSPENDED, TARGET_BLOCKED, ADVERTISER_PAYMENT_FAILURE, ADVERTISER_OUT_OF_PREPAY_BALANCE, STATUS_UNAVAILABLE |\n","| status.marketplace\\\\\\_settings | array | An array of marketplace-specific status settings. Each element contains the fields below. |\n","| status.marketplace\\\\\\_settings.marketplace | enum | The marketplace to which the status settings value is applied |\n","| status.marketplace\\\\\\_settings.delivery\\\\\\_status | enum | The marketplace-specific overall status depicting if delivering or not. Values: DELIVERING, NOT_DELIVERING, UNAVAILABLE, LIMITED |\n","| status.marketplace\\\\\\_settings.delivery\\\\\\_reasons | enum\\[] | The marketplace-specific list of reasons behind the delivery status. Can have up to 50 reasons. Same values as status.delivery_reasons. |\n","| target\\\\\\_type | enum | The type of target. Values: KEYWORD, PRODUCT, PRODUCT_CATEGORY, PRODUCT_CATEGORY_AUDIENCE, PRODUCT_AUDIENCE, AUDIENCE, LOCATION, DOMAIN, APP, DEVICE, DAYPART, CONTENT_CATEGORY, CONTENT_GENRE, CONTENT_RATING, BRAND_SAFETY_TIER, BRAND_SAFETY_CATEGORY, INVENTORY_SOURCE, PHYSICAL_STORE, AD_INITIATION, AD_PLAYER_SIZE, VIDEO_AD_FORMAT, THIRD_PARTY, THEME, CONTENT_INSTREAM_POSITION, CONTENT_OUTSTREAM_POSITION, VIDEO_CONTENT_DURATION, FOLD_POSITION, NATIVE_CONTENT_POSITION, PLACEMENT_TYPE, ADS_IMPRESSION_RETARGETING, TECHNOLOGY |\n","| bid.bid.bid | double | The maximum bid for a target. |\n","| bid.bid.currency\\\\\\_code | enum | The currency code the bid is expressed in. |\n","| bid.marketplace\\\\\\_settings.marketplace | enum | The marketplace at which the bid value is applied |\n","| bid.marketplace\\\\\\_settings.bid.bid | double | The maximum bid for a target. |\n","| bid.marketplace\\\\\\_settings.bid.currency\\\\\\_code | enum | The currency code the bid is expressed in. |\n","| target\\\\\\_details.keyword\\\\\\_target.match\\\\\\_type | enum | The match type associated to the target. The selections control how Amazon will semantically expand, that is, determine how closely the target needs to match with the intent of the user for ad delivery. Values: EXACT, PHRASE, BROAD, MULTISIGNAL_BROAD |\n","| target\\\\\\_details.keyword\\\\\\_target.keyword | string | The customer search term or text to target |\n","| target\\\\\\_details.keyword\\\\\\_target.native\\\\\\_language\\\\\\_keyword | string | The unlocalized keyword text in the preferred locale of the advertiser. |\n","| target\\\\\\_details.keyword\\\\\\_target.native\\\\\\_language\\\\\\_locale | enum | The locale preference of the advertiser. |\n","| tags.key | string | Open ended labels with a key value pair applied to the target |\n","| tags.value | string | Open ended labels with a key value pair applied to the target |\n","| marketplace\\\\\\_configurations.marketplace | enum | The marketplace to which the configurations apply |\n","| marketplace\\\\\\_configurations.target\\\\\\_id | string | Represents marketplace target id (Ex: targetId-US) associated to global target (Ex: targetId-Global) |\n","| marketplace\\\\\\_configurations.overrides.state | enum | The state of the target |\n","| marketplace\\\\\\_configurations.overrides.tags.key | string | Open ended labels with a key value pair applied to the target |\n","| marketplace\\\\\\_configurations.overrides.tags.value | string | Open ended labels with a key value pair applied to the target |\n"],"documentType":"guide"},{"title":"Campaign management datasets for Amazon Marketing Stream","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/campaign-management","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"],"documentType":"guide"},{"title":"Sponsored ads budget usage dataset","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/datasets/budget-usage","content":[" The budget-usage dataset provides the budget status (spend compared to budget) for sponsored ads (Sponsored Products, Sponsored Display, or Sponsored Brands) campaigns and portfolios. Advertisers receive notifications at every 5% interval of budget consumption. \n"],"documentType":"guide"},{"title":"Sponsored ads budget usage dataset","sectionHeader":{"type":2,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/budget-usage","content":[" To subscribe to this dataset, use the ID budget-usage.\n"],"documentType":"guide"},{"title":"Sponsored ads budget usage dataset","sectionHeader":{"type":2,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/budget-usage","content":[" This dataset supports the following fields and metrics:\n","| Field name\t| Field type | Field description |\n","|---\t|---\t|---\t|\n","| advertiser_id\t| String\t| ID associated with the advertiser. You can retrieve this ID using the GET v2/profiles endpoint. This value is not unique and may be the same across marketplaces. Note: For non-seller accounts, this advertiser_id is set to the entity ID.\t|\n","| marketplace_id\t| String\t| The identifier of the marketplace to which the account is associated.\t|\n","| dataset_id\t| String\t| An identifier used to uniquely identify a specific dataset.\t|\n","| budget_scope_id\t| String\t| The unique identifier of the campaign or portfolio for which budget usage percentage is provided.\t|\n","| budget_scope_type\t| String\t| The type of budget scope. Currently supported values: CAMPAIGN or PORTFOLIO.\t|\n","| advertising_product_type\t| String\t| Advertising product type sp (Sponsored Products), sb (Sponsored Brands), or sd (Sponsored Display).\t|\n","| budget\t| Double\t| Value of budget for budget_scope_id. It will be the rule-based budget if any budget rule is winning. Otherwise it will be the budget set by the advertiser.\t|\n","| budget_usage_percentage\t| Double\t| Budget usage percentage (Spend divided by budget).\t|\n","| usage_updated_timestamp\t| String\t| Last evaluation time for budget usage.\t|\n"],"documentType":"guide"},{"title":"Sponsored ads budget usage dataset","sectionHeader":{"type":2,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/budget-usage","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored ads budget usage dataset","sectionHeader":{"type":2,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/budget-usage","content":[],"documentType":"guide"},{"title":"Sponsored ads campaign recommendations","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-diagnostics-recommendations","content":[" This dataset contains recommendations to optimize existing ad campaigns or create new ad campaigns to improve performance of your sponsored ads portfolio. The types of recommendations delivered by the dataset can be found in the table below.\n"],"documentType":"guide"},{"title":"Sponsored ads campaign recommendations","sectionHeader":{"type":2,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-diagnostics-recommendations","content":[" To subscribe to this dataset, use the ID sponsored-ads-campaign-diagnostics-recommendations.\n"],"documentType":"guide"},{"title":"Sponsored ads campaign recommendations","sectionHeader":{"type":2,"text":"Recommendation types"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-diagnostics-recommendations","content":[" The following table details the types of recommendations available by ad type as part of this dataset. \n","|Ad product\t|Description\t|\n","|---\t|---\t|\n","|Sponsored Brands, Sponsored Products\t|Campaign with over 50% budget utilization, which will be impacted by an upcoming special event. Budget rules help prevent campaigns from going out of budget during peak traffic periods. Apply the recommended budget.\t|\n","|Sponsored Brands\t|Low-performing Sponsored Brands campaign with at least one impression in the last 14 days and ROAS less than or equal to 3. Apply the recommended bid to improve performance.\t|\n","|Sponsored Display\t|Low-performing Sponsored Display campaign with spend in the top 50% of the campaigns of the advertiser. Apply the recommended bid to improve performance.\t|\n","|Sponsored Display\t|Advertiser is not actively using Sponsored Display audiences. Create a Sponsored Display campaign to reengage audiences and help secure missed sales opportunities or further cultivate brand loyalty.\t|\n","|Sponsored Display\t|The advertiser is active on Sponsored Display CPC campaigns, but not using reach bid-optimization, which can increase product awareness on and off Amazon. Create a Sponsored Display campaign optimized for reach to increase awareness.\t|\n","|Sponsored Display\t|Advertiser is not actively using Sponsored Display contextual targeting. Create a Sponsored Display campaign to target specific products and categories of detail pages on Amazon to help drive consideration and sales.\t|\n","|Sponsored Display\t|These ASINs are forecasted to have high sales in next 90 days, but are not advertised. Create Sponsored Display contextual campaign for high performing ASINs.\t|\n","|Sponsored Display\t|Enabled Sponsored Display campaigns have zero ad spend or clicks. Campaigns that do not generate clicks, also do not generate attributed orders. Recommend adding new ad groups in these campaigns with suggested ASINs, targets, and bids to improve performance.\t|\n","|Sponsored Products\t|Campaigns have ROAS greater than 5. Recommend advertiser to optimize bids to drive impressions and sales.\t|\n","|Sponsored Products\t|High-performing campaign with ROAS greater than 3 and last week's budget utilization greater than 80%. We have estimated this is a missed opportunity in sales and clicks. Apply the recommended budget.\t|\n","|Sponsored Products\t|The advertiser has ad-ready ASINs that they are not advertising. Ad-ready ASINs are 16 times more likely to be clicked on if advertised. Create campaigns with ad-ready ASINs to increase clicks.\t|\n","|Sponsored Products\t|The advertiser has unadvertised ASINs with deals starting in the next 7-14 days. Advertise ASINs with deals to increase impressions and clicks.\t|\n","|Sponsored Products\t|These ASINs are forecasted to have high sales in next 90 days, but are not advertised. Create a Sponsored Product manual campaign to advertise the high performing ASINs.\t|\n","|Sponsored Products\t|Enabled Sponsored Products auto-targeting campaigns with zero ad spend. Campaigns that do not generate clicks do not generate attributed orders. Recommend creating new ad groups in these campaigns with suggested ASINs, targets, and bids to improve performance.\t|\n","|Sponsored Products\t|Enabled Sponsored Products manual-targeting campaigns have zero ad spend or clicks. Campaigns that do not generate clicks, do not generate attributed orders. Recommend adding new ad groups in these campaigns with suggested ASINs, targets, and bids to improve performance.\t|\n","|Sponsored Products\t|Low-performing Sponsored Products campaign with at least one impression in the last 14 days and ROAS less than or equal to 3. Apply the recommended bid to improve performance.\t|\n","| Sponsored Products | Ad groups either did not receive any impressions or clicks, or had 50% decline in impressions or clicks compared in last 14 days. Consider adding new keywords. |\n","| Sponsored Brands | Campaigns have less than 200 impressions or zero clicks in last 14 days. Add new keywords to help improve performance. |\n","| Sponsored Display | Top performing cost per click Sponsored Display campaigns of the advertiser with spend in the bottom 50%. Add new targets to drive sales. |\n","| Sponsored Display | These ASINs have upcoming deals in 7-14 days. Promoting deal ASINs in detail pages of relevant products and categories can increase reach and sales. |\n","| Sponsored Products | Campaigns have lower click through and conversion compared to other similar campaigns. Recommend adding new keywords to drive performance. |\n","| Sponsored Brands | Sponsored Brands campaigns with ROAS above 3 that have used more than 80% of their budget. Running out of budget could result in missed impressions and clicks. Recommend the advertiser increase budget. |\n","| Sponsored Products | Newly launched ASINs that are yet to be advertised. Creating new campaigns for these ASINs could help drive incremental clicks and conversions. |\n"],"documentType":"guide"},{"title":"Sponsored ads campaign recommendations","sectionHeader":{"type":2,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-diagnostics-recommendations","content":["|Field name\t| Type\t| Description\t|\n","|---\t|---\t|---\t|\n","|recommendation_id\t|String\t|A unique identifier for every recommendation in this dataset.\t|\n","|advertiser_id\t|String\t| ID associated with the advertiser. You can retrieve this ID using the GET v2/profiles endpoint. This value is not unique and may be the same across marketplaces. Note: For non-seller accounts, this advertiser_id is set to the entity ID.\t|\n","|marketplace_id\t|String\t|The marketplace identifier associated with the account.\t|\n","|dataset_id\t|String\t|An identifier used to identify the dataset (in this case, sponsored-ads-campaign-diagnostics-recommendations).\t|\n","|group_id\t|String\t|Identifier to suggest grouping of recommendations in case multiple recommendations are suggested against same advertiser_id / marketplace_id / campaign_id combination.\t|\n","|apply_endpoint\t|String\t|API endpoint to apply this recommendation in one call. Users can call this API and provide the recommendation_id in the API request body to adopt this recommendation. API reference.\t|\n","|type\t|String\t|Type of recommendation. Currently supported values: CAMPAIGN_BUDGET, KEYWORD_BID, NEW_CAMPAIGN, CAMPAIGN_BUDGET_RULE, NEW_CAMPAIGN_BUDGET_RULE, PRODUCT_TARGETING_BID, AUDIENCE_TARGETING_BID\t|\n","|published_date\t|String\t|Date when this recommendation was published.\t|\n","|expiry_date\t|String\t|Date after which this recommendation would expire.\t|\n","|explanation\t|Object\t|Object containing the reasons for recommending this campaign change. See the Explanation object for more details.\t|\n","|campaign_name\t|String\t|Name of the campaign for which recommendations are being made.\t|\n","|campaign_id\t|String\t|Unique numerical ID for a campaign.\t|\n","|ad_product\t|String\t|Ad product of the campaign. (One of: SP, SB, SD).\t|\n","|current_campaign_settings\t|Object\t|The settings currently used for your campaign. See CampaignSettings object for details.\t|\n","|recommended_campaign_settings\t|Object\t|The recommended settings for your campaign. See CampaignSettings object for details.\t|\n"],"documentType":"guide"},{"title":"Sponsored ads campaign recommendations","sectionHeader":{"type":3,"text":"Explanation object"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-diagnostics-recommendations","content":["|Field name\t| Type\t| Description\t|\n","|---\t|---\t|---\t|\n","|description\t|String\t|Provides the user readable reason for suggesting this change.\t|\n","|missed_opportunities\t|Object\t| Object containing the estimated additional impressions, clicks, and sales the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual impressions, clicks, and sales.\t|\n","|missed_opportunities.impressions\t|Object\t| Object containing the estimated additional impressions the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual impressions.\t|\n","|missed_opportunities.impressions.upper_bound\t|Integer\t|Upper bound value for the missed opportunity impressions.\t|\n","|missed_opportunities.impressions.lower_bound\t|Integer\t|Lower bound value for the missed opportunity impressions.\t|\n","|missed_opportunities.clicks\t|Object\t| Object containing the estimated additional clicks the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual clicks.\t|\n","|missed_opportunities.clicks.upper_bound\t|Integer\t|Upper bound value for the missed opportunity clicks.\t|\n","|missed_opportunities.clicks.lower_bound\t|Integer\t|Lower bound value for the missed opportunity clicks.\t|\n","|missed_opportunities.conversions\t|Object\t| Object containing the estimated additional sales the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual sales.\t|\n","|missed_opportunities.conversions.upper_bound\t|Integer\t|Upper bound value for the missed opportunity conversions.\t|\n","|missed_opportunities.conversions.lower_bound\t|Integer\t|Lower bound value for the missed opportunity conversions.\t|\n","|missed_opportunities.time_period\t|String\t|Time period used for calculating missed_opportunities.\t|\n"],"documentType":"guide"},{"title":"Sponsored ads campaign recommendations","sectionHeader":{"type":3,"text":"CampaignSettings object"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-diagnostics-recommendations","content":["|Field name\t| Type\t| Description\t|\n","|---\t|---\t|---\t|\n","|campaign_targeting\t|String\t|Targeting type for the campaign (One of: MANUAL, AUTO).\t|\n","|bidding_strategy\t|String\t|Bidding strategy for the campaign (One of: LEGACY_FOR_SALES, AUTO_FOR_SALES, MANUAL).\t|\n","|start_date\t|String\t|Start date of the campaign.\t|\n","|end_date\t|String\t|End date for the campaign.\t|\n","|ad_groups | Array | Array that contains the ad groups associated with a campaign. |\n","|ad_groups.adgroup_id | String | ID of the ad group. |\n","|ad_groups.adgroup_name | String | Name of the ad group. |\n","|ad_groups.asins | Array | ASINs associated to the ad group. |\n","|ad_groups.bid | Decimal | Bid associated to the ad group. |\n","|ad_groups.bid_optimization | String | Bid optimization strategy for the ad group. |\n","|ad_groups.target_type | String | Targeting type associated with the ad group. |\n","|ad_groups.targets | Array | An array containing targets associated with the ad group. |\n","|ad_groups.targets.bid | Decimal | Bid associated with a target. |\n","|ad_groups.targets.text | String | The keyword text. |\n","|ad_groups.targets.match_type | String | The match type for a keyword target. |\n","|ad_groups.targets.targeting | String | The targeting for the bid. |\n","|ad_groups.targets.category | Object | Category associated with the targeting expression. |\n","|ad_groups.targets.category.id | Integer | ID of the category. |\n","|ad_groups.targets.category.name | String | Name of the category. |\n","|ad_groups.targets.category.path | String | Path of the category. |\n","|ad_groups.targets.expressions | Array | Array of targeting expressions. |\n","|ad_groups.targets.expressions.type | String | The type of the targeting expressions. |\n","|ad_groups.targets.expressions.value | String | The value of the targeting expressions. |\n","|ad_groups.targets.audience_target_type | String | For audience targeting, the type of target. |\n","|budget | Object | Object that contains budget details for the campaign. |\n","|budget.budget_rules | Array | An array of budget rules associated with the campaign. |\n","|budget.budget_rules.rule_name | String | Name associated with the rule. |\n","|budget.budget_rules.type | String | Type of budget rule. |\n","|budget.budget_rules.start_date | String | Start date of budget rule. |\n","|budget.budget_rules.end_date | String | End date of budget rule. |\n","|budget.budget_rules.event_id | String | Event ID associated with the budget rule. |\n","|budget.budget_rules.event_name | String | Event name associated with the budget rule. |\n","|budget.budget_rules.increase_by | String | Amount to increase the budget by. |\n","|budget.budget_rules.performance_measure_condition | Object | Condition where the budget rule should take effect. |\n","|budget.budget_rules.performance_measure_condition.metric_name | String | Metric used in the condition. |\n","|budget.budget_rules.performance_measure_condition.comparison_operator | String | Comparison operator for the condition. |\n","|budget.budget_rules.performance_measure_condition.threshold | Decimal | Value to be used in the condition. |\n","|budget.budget_rules.recurrence | Object | Recurrence settings for the budget rule. |\n","|budget.budget_rules.recurrence.recurrence_type | String | Type of recurrence. |\n","|budget.budget_rules.recurrence.days_of_week | Array | Days of the week where the budget rule should be active. |\n"],"documentType":"guide"},{"title":"Sponsored ads campaign recommendations","sectionHeader":{"type":2,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-diagnostics-recommendations","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored ads campaign recommendations","sectionHeader":{"type":2,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-diagnostics-recommendations","content":[" We diagnose the advertiser campaigns and suggest recommendations every week, though it is not guaranteed that every campaign will have an associated recommendation each week. Additionally, we have built feedback loops where we learn from the engagement of advertisers and course correct our future recommendations based on adoption and performance attribution of existing recommendations. \n"],"documentType":"guide"},{"title":"Sponsored ads campaign recommendations","sectionHeader":{"type":2,"text":"Applying recommendations"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-diagnostics-recommendations","content":[],"documentType":"guide"},{"title":"Sponsored Products budget recommendations and missed opportunities","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/datasets/budget-recs-missed-opportunities","content":[" This dataset provides an unmodified view of the Sponsored Products budget recommendations and missed opportunities insights from campaigns that have been recently out of budget. Missed opportunities of an out-of-budget campaign are the additional clicks, impressions, and sales between the start date and end date that the campaign could have received had it stayed in budget for the hours it was out of budget.\n"],"documentType":"guide"},{"title":"Sponsored Products budget recommendations and missed opportunities","sectionHeader":{"type":2,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/budget-recs-missed-opportunities","content":[" To subscribe to this dataset, use the ID sp-budget-recommendations.\n"],"documentType":"guide"},{"title":"Sponsored Products budget recommendations and missed opportunities","sectionHeader":{"type":2,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/budget-recs-missed-opportunities","content":[" This dataset supports the following fields and metrics:\n","|Field\t|Type\t|Description\t|\n","\\|-----\\|-----\\|------\\|\n","|dataset_id\t|String\t|An identifier used to identify the dataset (in this case, sp-budget-recommendations).\t|\n","|marketplace_id\t|String\t|The marketplace identifier associated with the account.\t|\n","|advertiser_id\t|String\t|The unique identifier of the advertiser.\t|\n","|recommendation_time\t|String (ISO Format)\t|The date and time of the recommendation.\t|\n","|campaign_id\t|String\t|The unique numerical ID for a campaign.\t|\n","|suggested_budget\t|Double\t|Estimated daily budget needed to keep the campaign in budget for the full 24-hour period in a day. Consider adopting this daily budget to minimize the chances of your campaign running out of budget. Expressed in local currency.\t|\n","|reason_for_suggestion | String | The reason for the budget recommendation. |\n","|estimated_missed_sales_lower\t|Double\t|This is the estimated lower bound of additional sales the campaign might have generated between the start and end date had it been in budget 100% of the time. These are estimates based on historical traffic and the past performance of the campaign (e.g., impressions and clicks generated) but not guaranteed.\t|\n","|estimated_missed_sales_upper\t|Double\t|This is the estimated upper bound of additional sales the campaign might have generated between the start and end date had it been in budget 100% of the time. These are estimates based on historical traffic and the past performance of the campaign (e.g., impressions and clicks generated) but not guaranteed.\t|\n","|estimated_missed_clicks_lower\t|Double\t|This is the estimated lower bound of additional clicks the campaign might have generated between the start and end date had it been in budget 100% of the time. These are estimates based on historical traffic and the past performance of the campaign (e.g., impressions and clicks generated) but not guaranteed.\t|\n","|estimated_missed_clicks_upper\t|Double\t|This is the estimated upper bound of additional clicks the campaign might have generated between the start and end date had it been in budget 100% of the time. These are estimates based on historical traffic and the past performance of the campaign (e.g., impressions and clicks generated) but not guaranteed.\t|\n","|estimated_missed_impressions_lower\t|Double\t|This is the estimated lower bound of additional impressions the campaign might have generated between the start and end date had it been in budget 100% of the time. These are estimates based on historical traffic and the past performance of the campaign (e.g., impressions and clicks generated) but not guaranteed.\t|\n","|estimated_missed_impressions_upper\t|Double\t|This is the estimated upper bound of additional impressions the campaign might have generated between the start and end date had it been in budget 100% of the time. These are estimates based on historical traffic and the past performance of the campaign (e.g., impressions and clicks generated) but not guaranteed.\t|\n","|start_date\t|String\t|Start day of missed opportunity estimation range. (end_date - start_date = 7)\t|\n","|end_date\t|String\t|End day of missed opportunity estimation range. (end_date - start_date = 7)\t|\n","|percent_time_in_budget\t|Double\t|Actual average percentage of time the campaign was in budget between the start and end date. Note: value -1 means there is not enough information to compute the percent time in budget for the campaign. 1.0 means it is in budget all the time.\t|\n"],"documentType":"guide"},{"title":"Sponsored Products budget recommendations and missed opportunities","sectionHeader":{"type":2,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/budget-recs-missed-opportunities","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored Products budget recommendations and missed opportunities","sectionHeader":{"type":2,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/budget-recs-missed-opportunities","content":[],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" These datasets help advertisers understand changes that have been made to sponsored ads campaigns, ad groups, ads, and targets.\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":2,"text":"Campaigns dataset (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" The campaigns dataset provides a snapshot of all your campaign objects--including Sponsored Products, Sponsored Brands, and Sponsored Display. \n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" To subscribe to this dataset, use the ID campaigns.\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":["|Field\t|Type\t|Description\t|\n","\\|-----\\|----\\|-------\n","|dataset_id\t|string\t|An identifier used to identify the dataset (in this case, campaigns).\t|\n","|advertiser_id\t|string\t|Unique identifier of the advertiser (standard in Stream datasets).\t|\n","|marketplace_id\t|string\t|The marketplace of the advertiser.\t|\n","|campaignId\t|string\t|Unique identifier of campaign.\t|\n","|accountId\t|string\t|Unique identifier of advertiser. Also referred to as profileId in the API. |\n","|portfolioId\t|string\t|Unique identifier of portfolio, if the campaign belongs to one.\t|\n","|adProduct\t|string\t|Product/program type of campaign. One of: SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_DISPLAY.\t|\n","|productLocation\t|string\t|The product location of the campaign. One of: SOLD_ON_AMAZON (For products sold on Amazon websites), NOT_SOLD_ON_AMAZON (For products not sold on Amazon websites), SOLD_ON_DTC (Deprecated - For products sold on DTC websites).\t|\n","|version | long | This numeric value is incremented when changes are made to the object, representing a chronological history of changes. For example, the creation event would be the lowest version, while a subsequent update would be greater. | \n","|name\t|string\t|Name of the campaign (must be unique for an account).\t|\n","|startDateTime\t|datetime\t|Effective from date time of campaign.\t|\n","|endDateTime\t|datetime\t|Effective through date time of campaign.\t|\n","|state\t|string\t|The advertiser defined state falling into one of these values:  Sponsored Products: ENABLED, PAUSED, ARCHIVED, USER_DELETED, ENABLING, OTHER Sponsored Brands/Sponsored Display: ENABLED, PAUSED, ARCHIVED\t|\n","|tags\t|map&lt;string, string>\t|User defined key value pairs.\t|\n","|targetingSettings\t|string\t|Targeting type of the campaign, today is used to indicate auto or manual.\t|\n","|budget.budgetCap.monetaryBudget.amount\t|double\t|The budget in amount allocated to this budgetCap.\t|\n","|budget.budgetCap.monetaryBudget.currencyCode\t|string\t|ISO 4217 currency code.\t|\n","|budget.budgetCap.recurrence.recurrenceType\t|string\t|Whether the budget renews weekly, monthly, or lifetime e.g., DAILY, LIFETIME.\t|\n","|bidSetting.bidStrategy\t|string\t|Bid strategy options. For Sponsored Products, one of: LEGACY_FOR_SALES, AUTO_FOR_SALES, MANUAL, RULE_BASED\t|\n","|bidSetting.placementBidAdjustment |array |The bid adjustments for placements.  |\n","|bidSetting.placementBidAdjustment.placement\t|string\t|Bid strategy placement modifier Sponsored Brands: HOME, DETAIL_PAGE, OTHERSponsored Products: PLACEMENT_TOP, PLACEMENT_PRODUCT_PAGE, PLACEMENT_REST_OF_SEARCH, SITE_AMAZON_BUSINESS\t|\n","|bidSetting.placementBidAdjustment.percentage\t|double\t|Percentage of bid adjustment.  |\n","|bidSetting.shopperCohortBidAdjustment |array |The bid adjustments for shopper cohorts.  |\n","|bidSetting.shopperCohortBidAdjustment.percentage |double\t|The selection of the percentage change associated with a given shopper cohort and bid adjustment settings.\t|\n","|bidSetting.shopperCohortBidAdjustment.shopperCohortType |string | The shopper cohort type required to specify the type of shopper cohort used to apply bid adjustments. Example, an Audience Segment. AUDIENCE_SEGMENT|\n","|bidSetting.shopperCohortBidAdjustment.audienceSegments |array  |The audience segments associated with a bid adjustment for a given shopper cohort. |\n","|bidSetting.shopperCohortBidAdjustment.audienceSegments.audienceSegmentId |string\t|This is an Audience identifier vended by Audience Discovery. |\n","|bidSetting.shopperCohortBidAdjustment.audienceSegments.audienceSegmentType |string\t|The AudienceSegmentType field is optional as the type is automatically determined from the Audience path using the ListTargetableEntities API. Audience IDs are guaranteed to be unique across all audience types, enabling this inference. Supported types: DSP_AMC (Deprecated), SPONSORED_ADS_AMC (AMC Audiences), BEHAVIOR_DYNAMIC (Amazon Built Audiences for SP and SB) |\n","|audit.creationDateTime\t|datetime\t|Creation time stamp in ISO8601 format.\t|\n","|audit.lastUpdatedDateTime\t|datetime\t|Last time record was updated timestamp in ISO8601 format.\t|\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Sample payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" You will receive a notification in near real time for every change in the configuration of your campaign.\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":2,"text":"Ad groups dataset (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" The ad groups dataset provides a snapshot of all your ad group objects--including those related to Sponsored Products, Sponsored Brands, and Sponsored Display campaigns. \n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Dataset ID "},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" To subscribe to this dataset, use the ID adgroups.\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":["|Field\t|Type\t|Description\t|\n","\\|----\\|----\\|----\\|\n","|dataset_id\t|string\t|An identifier used to identify the dataset (in this case, adgroups).\t|\n","|advertiser_id\t|string\t|Unique identifier of the advertiser (standard in Stream datasets).\t|\n","|marketplace_id\t|string\t|The marketplace of the advertiser.\t|\n","|adGroupId\t|string\t|Unique identifier of ad group.\t|\n","|name\t|string\t|Name of the ad group.\t|\n","|version | long | This numeric value is incremented when changes are made to the object, representing a chronological history of changes. For example, the creation event would be the lowest version, while a subsequent update would be greater. | \n","|accountId\t|string\t|Unique identifier of advertiser. Also referred to as profileId in the API. |\n","|campaignId\t|string\t|Unique identifier of parent campaign object.\t|\n","|adProduct\t|string\t|Product/program type of campaign. One of: SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_DISPLAY\t|\n","|bidValue.defaultBid.value\t|double\t|Value of the bid in the currency specified.\t|\n","|bidValue.defaultBid.currencyCode\t|string\t|ISO4217 currency code.\t|\n","|state\t|string\t|The advertiser defined state falling into one of these values: Sponsored Products: ENABLED, PAUSED, ARCHIVED, USER_DELETED, ENABLING, OTHERSponsored Brands/Sponsored Display: ENABLED, PAUSED, ARCHIVED\t|\n","|audit.creationDateTime\t|datetime\t|Creation time stamp in ISO8601 format.\t|\n","|audit.lastUpdatedDateTime\t|datetime\t|Last time record was updated timestamp in ISO8601 format.\t|\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Sample payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" You will receive a notification in near real time for every change in the configuration of an ad group.\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":2,"text":"Ads dataset (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" The ads dataset provides a snapshot of all your ad objects--including those related to Sponsored Products, Sponsored Brands, and Sponsored Display campaigns. \n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" To subscribe to this dataset, use ads as the ID.\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":["|Field\t|Type\t|Description\t|\n","\\|----\\|----\\|----\\|\n","|dataset_id\t|string\t|An identifier used to identify the dataset (in this case, ads).\t|\n","|advertiser_id\t|string\t|Unique identifier of the advertiser (standard in Stream datasets).\t|\n","|marketplace_id\t|string\t|The marketplace of the advertiser.\t|\n","|adId\t|string\t|Unique identifier of ad.\t|\n","|name\t|string\t|Name of ad, advertiser description.\t|\n","|version | long | This numeric value is incremented when changes are made to the object, representing a chronological history of changes. For example, the creation event would be the lowest version, while a subsequent update would be greater. | \n","|accountId\t|string\t|Unique identifier of advertiser. Also referred to as profileId in the API. |\n","|adGroupId\t|string\t|Unique identifier of parent record (ad group ID).\t|\n","|campaignId\t|string\t|Unique identifier of campaign.\t|\n","|adProduct\t|string\t|Product/program type of campaign. One of: SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_DISPLAY\t|\n","|customText\t|string\t|Custom text for KDP accounts. Sponsored Products only.\t|\n","|asin\t|string\t|The ASIN of the product advertised by the product ad. Relevant for Sponsored Products and Sponsored Display vendors and KDP. \t|\n","|sku\t|string\t|The SKU of the product advertised by the product ad. Relevant only for sellers using Sponsored Products and Sponsored Display.\t|\n","|landingPage.url\t|string\t|Landing page URL for Sponsored Brands and Sponsored Display campaigns.\t|\n","|landingPage.type\t|string\t|Type of landing page. Sponsored Brands: PRODUCT_LIST, STORE, CUSTOM_URL, DETAIL_PAGESponsored Display: STORE, MOMENT, OFF_AMAZON_LINK\t|\n","|state\t|string\t|The advertiser defined state.Sponsored Products: ENABLED, PAUSED, ARCHIVED, USER_DELETED, ENABLING, OTHERSponsored Brands/Sponsored Display: ENABLED, PAUSED, ARCHIVED\t|\n","|audit.creationDateTime\t|datetime\t|Creation time stamp in ISO8601 format.\t|\n","|audit.lastUpdatedDateTime\t|datetime\t|Last time record was updated timestamp in ISO8601 format.\t|\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Sample payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" You will receive a notification in near real time for every change in the configuration of an ad.\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":2,"text":"Targets dataset (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" The targets dataset provides a snapshot of all your targeting and keyword objects--including those related to Sponsored Products, Sponsored Brands, and Sponsored Display campaigns. \n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" To subscribe to this dataset, use the targets ID.\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":["|Field\t|Type\t|Description\t|\n","\\|---\\|---\\|---\\|\n","|dataset_id\t|string\t|An identifier used to identify the dataset (in this case targets).\t|\n","|advertiser_id\t|string\t|Unique identifier of the advertiser (standard in Stream datasets).\t|\n","|marketplace_id\t|string\t|The marketplace of the advertiser.\t|\n","|targetId\t|string\t|Unique identifier of target.\t|\n","|accountId\t|string\t|Unique identifier of advertiser. Also referred to as profileId in the API.  |\n","|adGroupId\t|string\t|Unique identifier of the ad group.\t|\n","|campaignId\t|string\t|Unique identifier of the campaign.\t|\n","|version | long | This numeric value is incremented when changes are made to the object, representing a chronological history of changes. For example, the creation event would be the lowest version, while a subsequent update would be greater. | \n","|adProduct\t|string\t|Product/program type of campaign. One of: SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_DISPLAY\t|\n","|state\t|string\t|The advertiser defined state falling into one of these values:Sponsored Products: ENABLED, PAUSED, ARCHIVED, USER_DELETED, ENABLING, OTHERSponsored Brands/Sponsored Display: ENABLED, PAUSED, ARCHIVED\t|\n","|targetType\t|string\t|The type of targeting e.g. KEYWORD, AUDIENCE, EXPRESSION, AUTO (EXPRESSION_PREDEFINED), WEBSITE, APP, ASIN_EXPAND\t|\n","|negative\t|boolean\t|Negative or positive targeting on the expression.\t|\n","|bid\t|double\t|The bid used for auction. A null bid is valid, and means the target is inheriting from the ad group default bid.\t|\n","|currencyCode\t|string\t|ISO4217 currency code.\t|\n","|{targetType}.matchType\t|string\t|Matching type depending on target type.For keywords: EXACT, PHRASE, BROAD (positive only)For expressions: ASIN, CATEGORY, BRAND (negative only), DYNAMIC_SEGMENTS (Sponsored Display only).For audiences: VIEWS_REMARKETING, PURCHASE_REMARKETING, AMAZON_AUDIENCES\t|\n","|{targetType}.targetingClause\t|string\t|Targeting expression string.\t|\n","|keywordTarget.keyword\t|string\t|Keyword value to be used for targeting.\t|\n","|keywordTarget.nativeLanguageKeyword\t|string\t|Keyword value language.\t|\n","|keywordTarget.nativeLanguageLocale\t|string\t|Locale of language for keyword.\t|\n","|audit.creationDateTime\t|datetime\t|Creation time stamp in ISO8601 format.\t|\n","|audit.lastUpdatedDateTime\t|datetime\t|Last time record was updated timestamp in ISO8601 format.\t|\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Sample payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Sponsored ads campaign management","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/sponsored-ads-campaign-management","content":[],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" These datasets contain information about Amazon DSP campaigns, flights, ad groups, and targets.\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":2,"text":"Amazon DSP campaigns (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" The Amazon DSP campaigns dataset provides a snapshot of all your campaign objects.\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" For this dataset, the ID is adsp-campaigns. \n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":["|Field\t|Type\t|Description\t|\n","|---\t|---\t|---\t|\n","|dataset\\\\\\_id\t|string\t|An identifier used to identify the dataset (in this case, adsp-campaigns.)\t|\n","|advertiser\\\\\\_id\t|string\t|Unique identifier of the advertiser (standard in Stream datasets).\t|\n","|marketplace\\\\\\_id\t|string\t|The marketplace of the advertiser.\t|\n","|dspEntityId\t|string\t|DSP EntityId of the advertiser.\t|\n","|campaignId\t|string\t|Unique identifier of the campaign.\t|\n","|name\t|string\t|The name for the campaign.\t|\n","|version | long | This numeric value is incremented when changes are made to the object, representing a chronological history of changes. For example, the creation event would be the lowest version, while a subsequent update would be greater. | \n","|creationDateTime\t|string\t|The campaign creation date.\t|\n","|lastUpdatedDateTime\t|string\t|The last updated date of the campaign.\t|\n","|currencyCode\t|enum\t|ISO 4217 standard currency code for all currency-related campaign attributes (bid, budget)\t|\n","|state\t|enum\t|The user-defined activation status, falling into one of the following two values: ACTIVE, INACTIVE\t|\n","|optimization.bidStrategy\t|enum\t|A bid strategy specifies how we determine bids on your behalf. Examples include:  SPEND_BUDGET_IN_FULL, MAXIMIZE_PERFORMANCE, OTHER \t|\n","|optimization.bidOptimization\t|boolean\t|TRUE will automatically adjust bids for impressions that are more likely to improve your selected goal KPI.\t|\n","|optimization.budgetOptimization\t|boolean\t|TRUE will automatically adjust budgets towards better performing ad groups based on your selected goal KPI.\t|\n","|optimization.goalSettings.goalType\t|enum\t|This is the primary goal that you are trying to achieve with campaign and ad groups. Examples include:  AWARENESS, ENGAGEMENT_WITH_MY_AD, CONSIDERATIONS_ON_AMAZON, CONVERSIONS_OFF_AMAZON, PURCHASES_ON_AMAZON, PURCHASES_ON_OFF_AMAZON, MOBILE_APP_INSTALLS, OTHER \t|\n","|optimization.goalSettings.goalKpi\t|enum\t|The goal KPI is the key performance metric that will be used to measure success of your campaign. Examples include:  VIDEO_COMPLETION_RATE, CLICK_THROUGH_RATE, COST_PER_CLICK, COST_PER_ACTION, COST_PER_DOWNLOAD, COST_PER_INSTALL, DETAIL_PAGE_VIEW_RATE, COST_PER_DETAIL_PAGE_VIEW, RETURN_ON_AD_SPEND, TOTAL_RETURN_ON_AD_SPEND, COMBINED_RETURN_ON_AD_SPEND, COST_PER_VIDEO_COMPLETION, NONE, OTHER, REACH \t|\n","|optimization.goalSettings.targetKpi\t|double\t|The target value of the goalKpi. Depending on the goalKpi selected, this will be either currency based, percentage based, or an integer (for example REACH).\t|\n","|optimization.goalSettings.currencyCode\t|enum\t|The currency code of the campaign.\t|\n","|fees.agencyFeePercentage\t|double\t|A service fee that is subtracted from budget.\t|\n","|frequencies\t|array\t|The maximum number of times this campaign serves an impression to a user.\t|\n","|frequencies.type\t|enum\t|The type of advertising frequency. If UNCAPPED, no other fields are used. Example values  UNCAPPED, CUSTOM \t|\n","|frequencies.timeUnit\t|enum\t|The time unit. Example values:  DAYS, HOURS, OTHER \t|\n","|frequencies.timeCount\t|integer\t|The count of time units.\t|\n","|frequencies.maxImpressions\t|integer\t|The maximum number of times an impression is served per user.\t|\n","|budgetCaps\t|array\t|A limit on how much gets spent per day and/or month to more carefully control budget. This refers to calendar day or month, so applying this mid-day or month will assume the cap is for the rest of the day or month. Setting budget caps will affect pacing and may cause delivery spikes depending on how and when they are set. \t|\n","|budgetCaps.monetaryBudget.amount\t|double\t| The budget cap amount. |\n","|budgetCaps.monetaryBudget.currencyCode\t|enum\t| The currency code of the budget cap. |\n","|budgetCaps.recurrenceTimePeriod\t|enum\t| Examples of recurrenceTimePeriod:  DAILY, MONTHLY, OTHER . |\n","|tags.comments\t|string\t|Comments are only visible inside of the tool. Use this field to track variations in targeting, optimization notes, etc.\t|\n","|tags.purchaseOrderNumber\t|string\t|External purchase order ID, set by advertiser. It will be available in all dashboards and downloadable reports.\t|\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Sample payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Resource-based IAM policy "},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" You will receive a notification in near real time for every change in the configuration of your campaign.\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":2,"text":"Amazon DSP campaign flights (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" The Amazon DSP campaigns dataset provides a snapshot of all your campaign flight objects.\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" For this dataset, the ID is adsp-campaign-flights. \n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":["|Field\t|Type\t|Description\t|\n","|---\t|---\t|---\t|\n","|dataset\\\\\\_id\t|string\t|An identifier used to identify the dataset (in this case, adsp-campaign-flights.)\t|\n","|advertiser\\\\\\_id\t|string\t|Unique identifier of the advertiser (standard in Stream datasets).\t|\n","|marketplace\\\\\\_id\t|string\t|The marketplace of the advertiser.\t|\n","|version | long | This numeric value is incremented when changes are made to the object, representing a chronological history of changes. For example, the creation event would be the lowest version, while a subsequent update would be greater. | \n","|dspEntityId\t|string\t|DSP EntityId of the advertiser.\t|\n","|campaignId\t|string\t|Unique identifier of the campaign this flight applies to.\t|\n","|flightId\t|string\t|Unique identifier of this campaign-flight.\t|\n","|creationDateTime\t|string\t|The campaign-flight creation date.\t|\n","|lastUpdatedDateTime\t|string\t|The campaign-flight last updated date.\t|\n","|startDateTime\t|string\t|Start date of flight.\t|\n","|endDateTime\t|string\t|End date of flight.\t|\n","|budgetAmount\t|double\t|The numerical value of the budget.\t|\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Sample payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Resource-based IAM policy "},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" You will receive a notification in near real time for every change in the configuration of your campaign flight.\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":2,"text":"Amazon DSP ad groups (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" The Amazon DSP campaigns dataset provides a snapshot of all your ad group objects.\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" For this dataset, the ID is adsp-adgroups. \n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":["|Field\t|Type\t|Description\t|\n","|---\t|---\t|---\t|\n","|dataset\\\\\\_id\t|string\t|An identifier used to identify the dataset (in this case, adsp-campaign-flights.)\t|\n","|advertiser\\\\\\_id\t|string\t|Unique identifier of the advertiser (standard in Stream datasets).\t|\n","|marketplace\\\\\\_id\t|string\t|The marketplace of the advertiser.\t|\n","|dspEntityId\t|string\t|DSP EntityId of the advertiser.\t|\n","|campaignId\t|string\t|Unique identifier of the campaign this flight applies to.\t|\n","|adgroupId\t|string\t|Unique identified of this ad group. \t|\n","|name\t|string\t|The name of the ad group.\t|\n","|version | long | This numeric value is incremented when changes are made to the object, representing a chronological history of changes. For example, the creation event would be the lowest version, while a subsequent update would be greater. | \n","|startDateTime\t|string\t|Start date of this adGroup, in ISO format.\t|\n","|endDateTime\t|string\t|End date of this adGroup, in ISO format.\t|\n","|state\t|enum\t|The user-defined activation status, falling into one of the following two values: ACTIVE, INACTIVE\t|\n","|inventoryType\t|string\t|The ad group type.\t|\n","|creativeRotationType\t|enum\t|The creative rotation type. Examples include:  RANDOM, WEIGHTED, OTHER \t|\n","|tags.comments\t|string\t|Comments are only visible inside of the tool. Use this field to track variations in targeting, optimization notes, etc.\t|\n","|tags.purchaseOrderNumber\t|string\t|External purchase order ID, set by advertiser. It will be available in all dashboards and downloadable reports.\t|\n","|frequencies\t|array\t|A list of frequency information about this ad group.\t|\n","|frequencies.type\t|enum\t|The type of advertising frequency. If UNCAPPED, no other fields are used. Example values:  UNCAPPED, CUSTOM \t|\n","|frequencies.timeUnit\t|enum\t|The time unit. Example values:  DAYS, HOURS, OTHER \t|\n","|frequencies.timeCount\t|integer\t|The count of time units.\t|\n","|frequencies.maxImpressions\t|integer\t|The maximum number of times an impression is served per user.\t|\n","|advertisedProductCategoryIds\t|string array\t|The array of identifiers of product categories associated with the ad group.\t|\n","|budgetCaps\t|array\t|The per day or per month spending limit.\t|\n","|budgetCaps.recurrenceTimePeriod\t|enum\t|The type of recurrence for the spending limit. Examples include:  DAILY, MONTHLY, OTHER \t|\n","|budgetCaps.monetaryBudget.amount\t|double\t|The spending limit expressed in the currency of the ad group.\t|\n","|budgetCaps.monetaryBudget.currencyCode\t|enum\t|The currency set on the ad group level.\t|\n","|pacing.deliveryProfile\t|enum\t|Determines how the system will spend budget and deliver impressions over the flight of the ad group. The following options are available: EVENLY: Distributes the delivery evenly across the duration of the ad groups. FRONT_LOADED: Increases delivery during the first half of the campaign (up to 25%), then up to 5% during the second half. ASAP: Makes your entire budget available to spend immediately. This is ideal for ad groups with limited inventory or when there is no requirement to spend throughout the length of the campaign. Warning: Selecting ASAP may result in your entire budget being spent immediately. OTHER: Returned by GET operations as a substitute for values that are incompatible with the requested GET API version.\t|\n","|bid.currencyCode\t|enum\t|The currency set on the ad group level.\t|\n","|bid.baseBid\t|double\t|This is the ideal amount you want to pay (per thousand impressions) for your ad inventory expressed in the currency of the campaign. This price is not guaranteed, but we optimize the bidding strategy to try to meet this goal.\t|\n","|bid.maxAverageCpm\t|double\t|The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars.\t|\n","|optimization.budgetOptimization\t|boolean\t|Set to true to enable budget optimization for the ad group.\t|\n","|optimization.bidStrategy\t|enum\t|A bid strategy specifies how we determine bids on your behalf for each opportunity to serve an impression. SPEND_BUDGET_IN_FULL: Our algorithm will focus on spending the full budget. Performance will be the second priority. MAXIMIZE_PERFORMANCE: Our algorithm will focus on performance. For the best performance and budget delivery, you will need to monitor and adjust your bid amounts. USE_CAMPAIGN_STRATEGY: The ad group will inherit the campaigns bid strategy. \t|\n","|targetingSettings.siteLanguage\t|array\t|The site language targeting type, in ISO 639-1 language code. format. Language Targeting enables targeting supply content language. When enabled, the ad group will automatically target supply language based on the creative language selected. If this is set, the ad group will not bid on placements with unrecognized language.  Only applicable and required when inventoryType is STANDARD_DISPLAY or VIDEO.\t|\n","|targetingSettings.amazonViewability.viewablitiyTier\t|enum\t|The targeted viewability tier. These are predictions based on machine learning and are not guaranteed. Selecting a higher percentage limits overall reach. Examples:  ALL_TIERS, GREATER_THAN_70_PERCENT, GREATER_THAN_60_PERCENT, GREATER_THAN_50_PERCENT, GREATER_THAN_40_PERCENT, LESS_THAN_40_PERCENT, OTHER \t|\n","|targetingSettings.amazonViewability.includeUnmeasurableImpressions\t|boolean\t|If set to true to include impressions where impressions cannot be measured.\t|\n","|targetingSettings.timeZoneType\t|enum\t|The time zone associated with ad group delivery when daypart targeting is applied. VIEWER is the time zone of the person viewing the ad. ADVERTISER_REGION refers to one of these three options based on the region of the advertiser: - US/Eastern: The time zone of the US East Coast which can be EST (UTC-5) or EDT (UTC-4). - Europe/London: The time zone of London which can be GMT (UTC) or BST (UTC+1). - Asia/Japan: Japan Standard Time (UTC+9).\t|\n","|targetingSettings.userLocation\t|enum\t|The geographical location type of users targeted. Examples include:  EVERYWHERE, NON_US, AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, PL, SA, SE, SG, TR, UK, US, OTHER \t|\n","|targetingSettings.userLocationSignal\t|enum\t|The type of signal used to determine the location of a user when geo location targeting is applied. CURRENT: Includes people who are currently in this location. MULTIPLE_SIGNALS: Multiple location signals are used, including current and home location. Examples include:  CURRENT, MULTIPLE_SIGNALS, OTHER \t|\n","|creationDateTime\t|string\t|The adGroup creation date.\t|\n","|lastUpdatedDateTime\t|string\t|The adGroup last updated date.\t|\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Sample payload"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Resource-based IAM policy"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" You will receive a notification in near real time for every change in the configuration of your ad group.\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":2,"text":"Amazon DSP ad group targets (beta)"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" The Amazon DSP campaigns dataset provides a snapshot of all your target objects. \n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Dataset ID"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" For this dataset, the ID is adsp-adgroup-targets. \n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Schema"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" The ad group targets dataset currently contains the following target types: audience, geolocation, day parting, devices, application, and third party, all of which have both common and unique fields. The first object in the list below contains the core fields that will be included in every adsp-adgroup-target document, which will be extended for each type. The objects listed after are the fields unique to each type of the target types.\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Common fields"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":["|Field\t|Type\t|Description\t|\n","|---\t|---\t|---\t|\n","|dataset\\\\\\_id\t|string\t|An identifier used to identify the dataset (in this case, adsp-campaign-flights.)\t|\n","|advertiser\\\\\\_id\t|string\t|Unique identifier of the advertiser (standard in Stream datasets).\t|\n","|marketplace\\\\\\_id\t|string\t|The marketplace of the advertiser.\t|\n","|dspEntityId\t|string\t|DSP EntityId of the advertiser.\t|\n","|campaignId\t|string\t|Unique identifier of the campaign this target applies to.\t|\n","|adgroupId\t|string\t|Unique identified of the ad group this target applies to.\t|\n","|version | long | This numeric value is incremented when changes are made to the object, representing a chronological history of changes. For example, the creation event would be the lowest version, while a subsequent update would be greater. | \n","|creationDateTime\t|string\t|Creation time of the ad group the target belongs to, in ISO format.\t|\n","|lastUpdatedDateTime\t|string\t|Last modified time of the ad group the target belongs to, in ISO format.\t|\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Geolocation targets"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" Geolocation targeting entries contain the following fields.\n","|Field\t|Type\t|Description\t|\n","|---\t|---\t|---\t|\n","|geoLocationTargets\t|array\t|Contains the list of GeoLocationTargets for this AdGroup\t|\n","|geoLocationTargets.negative\t|boolean\t|Whether to include (false) or exclude (true) users who match the given target\t|\n","|geoLocationTargets.geoLocationId\t|string\t|The unique identifier for the location\t|\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Daypart targets"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" Daypart targets contain the following fields.\n","|Field\t|Type\t|Description\t|\n","|---\t|---\t|---\t|\n","|daypartTargets\t|array\t|Contains the list of DaypartTargets for this AdGroup\t|\n","|daypartTargets.dayOfWeek\t|string\t|Day of the week for this target. ex: \"SUNDAY\"\t|\n","|daypartTargets.hourSlot\t|integer\t|Hour of day for this target. ex: 0 for midnight, 15 for 3pm, etc\t|\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Device targets"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" Device targets contain the following fields.\n","|Field\t|Type\t|Description\t|\n","|---\t|---\t|---\t|\n","|deviceTargets\t|array\t|Contains the list of DeviceTargets for this AdGroup\t|\n","|deviceTargets.deviceType\t|enum\t|Type of device being targeted. Must be one of DESKTOP, MOBILE\t|\n","|deviceTargets.mobileEnvironment\t|enum\t|This field is only set if deviceType is MOBILE.  If set, must be one of WEB, APP\t|\n","|deviceTargets.mobileDevice\t|enum\t|This field is only set if mobileEnvironment is APP. If set, must be one of IPHONE, IPAD, ANDROID, KINDLE_FIRE, KINDLE_FIRE_HD\t|\n","|deviceTargets.deviceOrientation\t|enum\t|This field is only set if mobileEnvironment is APP. If set, must be one of PORTRAIT, LANDSCAPE\t|\n","|deviceTargets.mobileOS\t|enum\t|This field is only set if mobileEnvironment is WEB. If set, must be one of IOS, ANDROID\t|\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Audience targets"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" Audience targets contain the following fields.\n","|Field\t|Type\t|Description\t|\n","|---\t|---\t|---\t|\n","|audienceTargets\t|array\t|Contains the list of DeviceTargets for this AdGroup\t|\n","|audienceTargets.negative\t|boolean\t|Whether to include (false) or exclude (true) users who match the given target when serving an ad.\t|\n","|audienceTargets.inGroupOperator\t|enum\t|The interoperator used among audiences within the same audience group. This is a legacy field that is no longer supported, and will only return a non-null value on legacy ad groups. Values:  ANY, ALL \t|\n","|audienceTargets.acrossGroupOperator\t|enum\t|The intraoperator used among audiences between audience groups. This is a legacy field that is no longer supported, and will only return a non-null value on legacy ad groups. Values:  ANY, ALL \t|\n","|audienceTargets.groupId\t|string\t|A unique ID for the audience group.\t|\n","|audienceTargets.audienceId\t|string\t|The unique identifier for the audience. Use the audiences discovery resourceto look up audience identifiers.\t|\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"App targets"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" App targets contain the following fields.\n","|Field\t|Type\t|Description\t|\n","|---\t|---\t|---\t|\n","|appTargets\t|array\t|Contains the list of App Targets for this AdGroup\t|\n","|appTargets.negative\t|boolean\t|Whether to include (false) or exclude (true) apps. All apps within the same ad group must be either included or excluded. If appType is STV, this is set to to true.\t|\n","|appTargets.appType\t|enum\t|The type of app being targeted. Only one type can be used per ad group. Values: MOBILE, STV\t|\n","|appTargets.appId\t|string\t|The unique identifier for the app.\t|\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Third-party targets"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":["|Field\t|Type\t|Description\t|\n","|---\t|---\t|---\t|\n","|thirdPartyTargets\t|array\t|List of third-party targeting settings applied on given ad group id\t|\n","|thirdPartyTargets.doubleVerifyFraudInvalidTraffic\t|struct\t|List of third-party targeting settings applied on given ad group id. |\n","|thirdPartyTargets.doubleVerifyFraudInvalidTraffic.excludeImpressions\t|boolean\t|If set to true, will exclude impressions delivered to devices identified to be fraudulent or invalid.\t|\n","|thirdPartyTargets.doubleVerifyFraudInvalidTraffic.excludeAppsAndSites\t|enum\t|Supported  ALLOW_ALL, FRAUD_TRAFFIC_LEVEL_GTE_100, FRAUD_TRAFFIC_LEVEL_GTE_50, FRAUD_TRAFFIC_LEVEL_GTE_25, FRAUD_TRAFFIC_LEVEL_GTE_10, FRAUD_TRAFFIC_LEVEL_GTE_08, FRAUD_TRAFFIC_LEVEL_GTE_06, FRAUD_TRAFFIC_LEVEL_GTE_04, FRAUD_TRAFFIC_LEVEL_GTE_02 \t|\n","|thirdPartyTargets.doubleVerifyFraudInvalidTraffic.blockAppAndSites\t|boolean\t|True will block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen.\t|\n","|thirdPartyTargets.integralAdScienceFraudInvalidTraffic\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'MOBILE_DISPLAY', AAP_MOBILE_APP', 'VIDEO'.\t|\n","|thirdPartyTargets.integralAdScienceFraudInvalidTraffic.targetSetting\t|enum\t|The type of fraud invalid traffic.  ALLOW_ALL, FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK, FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK\t|\n","|thirdPartyTargets.oracleDataCloudFraudInvalidTraffic\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'AAP_MOBILE_APP', 'VIDEO'.\t|\n","|thirdPartyTargets.oracleDataCloudFraudInvalidTraffic.targetSetting\t|enum\t|The fraud invalid traffic type.  ALLOW_ALL, FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION, FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION \t|\n","|thirdPartyTargets.pixalateFraudInvalidTraffic\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'MOBILE_DISPLAY', AAP_MOBILE_APP', 'VIDEO'.\t|\n","|thirdPartyTargets.pixalateFraudInvalidTraffic.excludeIpAddressAndUserAgents\t|boolean\t|If set to true, exclude traffic from IPV4 and IPV6 addresses and user agents identified to be fraudulent or invalid.\t|\n","|thirdPartyTargets.pixalateFraudInvalidTraffic.excludeOttAndMobileDevices\t|boolean\t|If set to true, exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid.\t|\n","|thirdPartyTargets.pixalateFraudInvalidTraffic.excludeRemovedAppsFromAppStores\t|boolean\t|If set to true, exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months.\t|\n","|thirdPartyTargets.pixalateFraudInvalidTraffic.excludeAppsAndDomains\t|boolean\t|If set to true, exclude traffic from Apps and Domains identified to be fraudulent or invalid.\t|\n","|thirdPartyTargets.doubleVerifyStandardDisplayBrandSafety\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY'.\t|\n","|thirdPartyTargets.doubleVerifyStandardDisplayBrandSafety.contentCategories\t|array\t|A list of content categories to exclude from targeting.  AD_SERVER, CELEBRITY_GOSSIP, CULTS_SURVIVALISM, GAMBLING, INCENTIVIZED_MALWARE_CLUTTER, INFLAMMATORY_POLITICS_NEWS, NEGATIVE_NEWS_FINANCIAL, NEGATIVE_NEWS_PHARMACEUTICAL, NON_STANDARD_CONTENT_NON_ENGLISH, NON_STANDARD_CONTENT_PARKING_PAGE, OCCULT, PIRACY_COPYRIGHT_INFRINGEMENT, UNMODERATED_UGC_FORUMS_IMAGES_VIDEO, EXTREME_GRAPHIC \t|\n","|thirdPartyTargets.doubleVerifyStandardDisplayBrandSafety.contentCategoriesWithRisk\t|map\t|The Double Verify brand suitability risk level.  ALLOW_ALL, HIGH, HIGH_MEDIUM, HIGH_MEDIUM_LOW \t|\n","|thirdPartyTargets.doubleVerifyStandardDisplayBrandSafety.unknownContent\t|boolean\t|If set to true, exclude unknown content.\t|\n","|thirdPartyTargets.doubleVerifyBrandSafety\t|struct\t|Supported InventoryTypes'AAP_MOBILE_APP', 'VIDEO'.\t|\n","|thirdPartyTargets.doubleVerifyBrandSafety.appStarRating\t|enum\t|App star rating to be used for excluding apps.  ALLOW_ALL, APP_STAR_RATING_LT_1_POINT_5_STARS, APP_STAR_RATING_LT_2_STARS, APP_STAR_RATING_LT_2_POINT_5_STARS, APP_STAR_RATING_LT_3_STARS, APP_STAR_RATING_LT_3_POINT_5_STARS, APP_STAR_RATING_LT_4_STARS, APP_STAR_RATING_LT_4_POINT_5_STARS \t|\n","|thirdPartyTargets.doubleVerifyBrandSafety.contentCategories\t|array\t|A list of content categories to exclude from targeting.  AD_SERVER, CELEBRITY_GOSSIP, CULTS_SURVIVALISM, GAMBLING, INCENTIVIZED_MALWARE_CLUTTER, INFLAMMATORY_POLITICS_NEWS, NEGATIVE_NEWS_FINANCIAL, NEGATIVE_NEWS_PHARMACEUTICAL, NON_STANDARD_CONTENT_NON_ENGLISH, NON_STANDARD_CONTENT_PARKING_PAGE, OCCULT, PIRACY_COPYRIGHT_INFRINGEMENT, UNMODERATED_UGC_FORUMS_IMAGES_VIDEO, EXTREME_GRAPHIC \t|\n","|thirdPartyTargets.doubleVerifyBrandSafety.appAgeRating\t|array\t|A list of app age ratings to be used for excluding apps. For example, TEENS_12_PLUS will only exclude apps with content rated for everyone ages 12 and over. UNKNOWN will exclude apps with content unrated or unknown to Double Verify.  EVERYONE_4_PLUS, TWEENS_9_PLUS, TEENS_12_PLUS, MATURE_17_PLUS, ADULTS_ONLY_18_PLUS, UNKNOWN \t|\n","|thirdPartyTargets.doubleVerifyBrandSafety.excludeAppsWithInsufficientRating\t|boolean\t|If set to true, exclude unofficial apps or apps with insufficient user ratings (&lt;100 lifetime).\t|\n","|thirdPartyTargets.doubleVerifyBrandSafety.contentCategoriesWithRisk\t|map\t|A map from content categories to risk level to exclude from targeting. Available keys are: ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC.|\n","|thirdPartyTargets.doubleVerifyBrandSafety.unknownContent\t|boolean\t|Set to true to exclude unknown content.\t|\n","|thirdPartyTargets.integralAdScienceBrandSafety\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'AAP_MOBILE_APP', 'VIDEO'\t|\n","|thirdPartyTargets.integralAdScienceBrandSafety.iasBrandSafetyOffensiveLanguage\t|enum\t|The IAS brand safety risk level.  ALLOW_ALL, BRAND_SAFETY_EXCLUDE_HIGH_RISK, BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK \t|\n","|thirdPartyTargets.integralAdScienceBrandSafety.excludeContent\t|boolean\t|If set to true, exclude content that Integral Ad Science is not able to rate.\t|\n","|thirdPartyTargets.integralAdScienceBrandSafety.iasBrandSafetyAlcohol\t|enum\t|The IAS brand safety risk level.  ALLOW_ALL, BRAND_SAFETY_EXCLUDE_HIGH_RISK, BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK \t|\n","|thirdPartyTargets.integralAdScienceBrandSafety.iasBrandSafetyIllegalDownloads\t|enum\t|The IAS brand safety risk level.  ALLOW_ALL, BRAND_SAFETY_EXCLUDE_HIGH_RISK, BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK \t|\n","|thirdPartyTargets.integralAdScienceBrandSafety.iasBrandSafetyHateSpeech\t|enum\t|The IAS brand safety risk level.  ALLOW_ALL, BRAND_SAFETY_EXCLUDE_HIGH_RISK, BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK \t|\n","|thirdPartyTargets.integralAdScienceBrandSafety.iasBrandSafetyIllegalDrugs\t|enum\t|The IAS brand safety risk level.  ALLOW_ALL, BRAND_SAFETY_EXCLUDE_HIGH_RISK, BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK \t|\n","|thirdPartyTargets.integralAdScienceBrandSafety.iasBrandSafetyAdult\t|enum\t|The IAS brand safety risk level.  ALLOW_ALL, BRAND_SAFETY_EXCLUDE_HIGH_RISK, BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK \t|\n","|thirdPartyTargets.integralAdScienceBrandSafety.iasBrandSafetyViolence\t|enum\t|The IAS brand safety risk level.  ALLOW_ALL, BRAND_SAFETY_EXCLUDE_HIGH_RISK, BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK \t|\n","|thirdPartyTargets.integralAdScienceBrandSafety.iasBrandSafetyGambling\t|enum\t|The IAS brand safety risk level.  ALLOW_ALL, BRAND_SAFETY_EXCLUDE_HIGH_RISK, BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK \t|\n","|thirdPartyTargets.oracleDataCloudBrandSafety\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'AAP_MOBILE_APP', 'VIDEO'. The oracle data cloud brand safety.\t|\n","|thirdPartyTargets.oracleDataCloudBrandSafety.essentialProtection\t|enum\t| ADULT, ARMS, CRIME, INJURY, PIRACY, DRUGS, HATE_SPEECH, MILITARY, OBSCENITY, TERRORISM, TOBACCO \t|\n","|thirdPartyTargets.oracleDataCloudBrandSafety.targetingOption\t|enum\t| NO_BRAND_SAFETY, MAXIMUM_PROTECTION, ESSENTIAL_PROTECTION \t|\n","|thirdPartyTargets.doubleVerifyViewability\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'AAP_MOBILE_APP', 'VIDEO'.\t|\n","|thirdPartyTargets.doubleVerifyViewability.averageCompletionAndFullyViewableRateTargeting\t|enum\t|The type of average completion and fully viewable rate targeting.  ALLOW_ALL, AVG_COMPLETION_FULLY_VIEWABLE_GTE_10, AVG_COMPLETION_FULLY_VIEWABLE_GTE_20, AVG_COMPLETION_FULLY_VIEWABLE_GTE_25, AVG_COMPLETION_FULLY_VIEWABLE_GTE_30, AVG_COMPLETION_FULLY_VIEWABLE_GTE_35, AVG_COMPLETION_FULLY_VIEWABLE_GTE_40 \t|\n","|thirdPartyTargets.doubleVerifyViewability.brandExposureViewabilityTargeting\t|enum\t|The type of brand exposure viewability targeting.  ALLOW_ALL, BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION, BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION, BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION \t|\n","|thirdPartyTargets.doubleVerifyViewability.mrcViewabilityTargeting\t|enum\t|The type of MRC viewability targeting.  ALLOW_ALL, MRC_VIEWABILITY_GTE_80, MRC_VIEWABILITY_GTE_75, MRC_VIEWABILITY_GTE_70, MRC_VIEWABILITY_GTE_65, MRC_VIEWABILITY_GTE_60, MRC_VIEWABILITY_GTE_55, MRC_VIEWABILITY_GTE_50, MRC_VIEWABILITY_GTE_40, MRC_VIEWABILITY_GTE_30 \t|\n","|thirdPartyTargets.doubleVerifyViewability.includeUnmeasurableImpressions\t|boolean\t|If set to true, include impressions where impressions cannot be measured.\t|\n","|thirdPartyTargets.integralAdScienceViewability\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'VIDEO'. The IAS viewability standard.\t|\n","|thirdPartyTargets.integralAdScienceViewability.standard\t|enum\t|The viewability standard.  NONE, MRC, GROUPM, PUBLICIS \t|\n","|thirdPartyTargets.integralAdScienceViewability.viewabilityTargeting\t|enum\t|The type of viewability tier.  ALLOW_ALL, VIEWABILITY_TIER_GT_70, VIEWABILITY_TIER_GT_60, VIEWABILITY_TIER_GT_50, VIEWABILITY_TIER_GT_40, VIEWABILITY_TIER_LT_40 \t|\n","|thirdPartyTargets.oracleDataCloudViewability\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'AAP_MOBILE_APP', 'VIDEO'. The ODC viewability standard.\t|\n","|thirdPartyTargets.oracleDataCloudViewability.standard\t|enum\t|The viewability standard.  NONE, MRC \t|\n","|thirdPartyTargets.oracleDataCloudViewability.viewabilityTargeting\t|enum\t|The type of ODC MRC viewability tier.  VIEWABILITY_TIER_GT_80, VIEWABILITY_TIER_GT_70, VIEWABILITY_TIER_GT_60, VIEWABILITY_TIER_GT_50, VIEWABILITY_TIER_GT_40, VIEWABILITY_TIER_GT_30, VIEWABILITY_TIER_GT_20 \t|\n","|thirdPartyTargets.doubleVerifyAuthenticBrandSafety\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'AAP_MOBILE_APP', 'VIDEO'.\t|\n","|thirdPartyTargets.doubleVerifyAuthenticBrandSafety.doubleVerifySegmentId\t|string\t|The segment identifier. Pattern: \\`1^510-9{6}$1\\`\t|\n","|thirdPartyTargets.doubleVerifyCustomContextualSegmentId\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'AAP_MOBILE_APP', 'VIDEO'.\t|\n","|thirdPartyTargets.doubleVerifyCustomContextualSegmentId.segmentId\t|string\t|The custom segment identifier. Pattern: \\`1^520-9{6}$1\\`\t|\n","|thirdPartyTargets.oracleDataCloudCustomSegmentId\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'AAP_MOBILE_APP', 'VIDEO'.\t|\n","|thirdPartyTargets.oracleDataCloudCustomSegmentId.segmentId\t|string\t|The custom segment identifier. Pattern: ^(255257)\\[0-9]{5}$\t|\n","|thirdPartyTargets.oracleDataCloudContextualPredictsSegmentId\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'AAP_MOBILE_APP', 'VIDEO'.\t|\n","|thirdPartyTargets.oracleDataCloudContextualPredictsSegmentId.segmentId\t|string\t|The custom segment predict identifier. Pattern: \\`^2590-9{5}$\\`|\n","|thirdPartyTargets.oracleDataCloudStandardPredictsSegmentIds\t|struct\t|Supported InventoryTypes'STANDARD_DISPLAY', 'AAP_MOBILE_APP', 'VIDEO'.\t|\n","|thirdPartyTargets.oracleDataCloudStandardPredictsSegmentIds.segmentIds\t|array\t|The standard predict segment identifiers. \t|\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Resource-based IAM policy "},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[" To subscribe to this dataset, ensure the correct IAM policy is added to the SQS queue based on the marketplace.\n"," NA\n"," EU\n"," FE\n"],"documentType":"guide"},{"title":"Amazon DSP campaign management","sectionHeader":{"type":3,"text":"Data freshness"},"path":"/en-us/guides/amazon-marketing-stream/datasets/dsp-campaign-management","content":[],"documentType":"guide"},{"title":"Querying Amazon Marketing Stream Data","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/querying-data","content":[" Amazon Marketing Stream sends data aggregated at the hourly level directly to your AWS account. Any changes to your data as a result of the click or conversion invalidation process are sent separately as deltas. \n"," Depending on how your AWS administrator has designed your solution, you can query Amazon Marketing Stream like you would any other database. \n"," Once you have set up your SQS queues and subscribed to Amazon Marketing Stream datasets, you can use the sample SQL queries in this document as a starting point for your data analysis.\n"],"documentType":"guide"},{"title":"Querying Amazon Marketing Stream Data","sectionHeader":{"type":2,"text":"Sample queries"},"path":"/en-us/guides/amazon-marketing-stream/querying-data","content":[" Below are examples of queries that you can use to query Amazon Marketing Stream data.\n"],"documentType":"guide"},{"title":"Querying Amazon Marketing Stream Data","sectionHeader":{"type":3,"text":"Pull traffic data for targets"},"path":"/en-us/guides/amazon-marketing-stream/querying-data","content":[" This query is for pulling traffic data for all targets on a certain date.\n"],"documentType":"guide"},{"title":"Querying Amazon Marketing Stream Data","sectionHeader":{"type":3,"text":"Pull traffic data for keywords"},"path":"/en-us/guides/amazon-marketing-stream/querying-data","content":[" This query pulls traffic data for all keywords on a given date.\n"],"documentType":"guide"},{"title":"Querying Amazon Marketing Stream Data","sectionHeader":{"type":3,"text":"Pull traffic data for a specific keyword and hour"},"path":"/en-us/guides/amazon-marketing-stream/querying-data","content":[" This query returns traffic data (impressions, clicks, and views) for a specific keyword in a given hour.\n"],"documentType":"guide"},{"title":"Querying Amazon Marketing Stream Data","sectionHeader":{"type":2,"text":"FAQ"},"path":"/en-us/guides/amazon-marketing-stream/querying-data","content":[],"documentType":"guide"},{"title":"Querying Amazon Marketing Stream Data","sectionHeader":{"type":3,"text":"How do I get data for targets versus keywords?"},"path":"/en-us/guides/amazon-marketing-stream/querying-data","content":[" Currently, both target_id and keyword_id values are passed within the keyword_id field. You can use the match_type column to differentiate between target and keyword.\n"," For targets, match_type is set to either TARGETING_EXPRESSION (for manual targeted campaigns) or TARGETING_EXPRESSION_PREDEFINED (for auto targeted campaigns).\n","Example values of keyword_text where match_type is TARGETING_EXPRESSION \\* Example values of keyword_text where match_type is TARGETING_EXPRESSION_PREDEFINED\n"," For keywords, match_type is set to either BROAD, PHRASE, or EXACT. The keyword_text field contains information on the exact keyword.\n"],"documentType":"guide"},{"title":"Querying Amazon Marketing Stream Data","sectionHeader":{"type":3,"text":"Why am I seeing conversion data with no related clicks?"},"path":"/en-us/guides/amazon-marketing-stream/querying-data","content":[],"documentType":"guide"},{"title":"Aggregating and joining traffic and conversion records delivered by Amazon Marketing Stream","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/aggregating-data","content":[" Since Amazon Marketing Stream guarantees at least once delivery of messages, some messages can be sent more than once. For this reason, the traffic and conversion datasets use a field called idempotency_id. To ensure accurate summation of the delta records in these datasets, the duplicate records must be removed prior to aggregation. \n"],"documentType":"guide"},{"title":"Aggregating and joining traffic and conversion records delivered by Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Order of operations"},"path":"/en-us/guides/amazon-marketing-stream/aggregating-data","content":[" For the most accurate results, you must complete the steps in this order:\n","Identify duplicates using the idempotency_id key. 2. Aggregate and remove duplicates from the traffic table. 3. Aggregate and remove duplicates from the conversion table. 3. Join the traffic and conversion tables.\n"],"documentType":"guide"},{"title":"Aggregating and joining traffic and conversion records delivered by Amazon Marketing Stream","sectionHeader":{"type":2,"text":"Example implementation"},"path":"/en-us/guides/amazon-marketing-stream/aggregating-data","content":[" The following code sample shows how to perform this order of operations on the sp-traffic and sp-conversion datasets. Note that traffic and conversion datasets from other ad programs may have slightly different schemas. Refer to the Data guide to see the schema for each available dataset.  \n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[" Once you have completed the initial Amazon Marketing Stream setup, you can use the following operations to manage your view, add, update, and archive subscriptions. \n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":2,"text":"View all subscriptions"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[" To see all dataset subscriptions associated with an advertising profile, use the GET /streams/subscriptions endpoint.\n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":3,"text":"Request"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[" This resource returns subscriptions created for the profile ID passed in Amazon-Advertising-API-Scope. You can control the number of results returned per page using the maxResults query parameter. \n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[" If there are more pages of results, you can pass the nextToken value in the startingToken query parameter of your next call.\n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":2,"text":"Add a subscription"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[" If you need to subscribe to a new dataset or advertiser, use the POST /streams/subscriptions endpoint.\n"," Make sure that you have added the relevant IAM policy for the dataset to your SQS queue before adding the subscription. To complete your subscription and start receiving data, you will need to confirm your subscription in SQS.\n"," You can see what datasets are currently supported in the Data guide. \n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":3,"text":"Request"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[" For destinationArn make sure to include an SQS ARN that has an IAM policy applied matching the dataSetId you are requesting.\n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[" A successful call returns a response indicating the subscriptionID that you can use to check the subscription status.\n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":3,"text":"Troubleshooting"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[" When subscribing to endpoints, you may encounter the following errors. \n"," A single Login with Amazon client application cannot support more than one subscription per advertiser (profile), dataSetId, and destination ARN combination. A single destination ARN cannot be used to receive data for the same advertiser or profile ID.\n"," A single Login With Amazon client application cannot support more than two subscriptions for the same advertiser and dataset ID. \n"," By default, each Login With Amazon client application can support up to 25000 subscriptions per dataset. If you would like to increase your subscription limit, contact our support team.\n"," Each Login With Amazon client application cannot have more than 1500 subscriptions in PENDING_CONFIRMATION state. Make sure to confirm all pending subscriptions. \n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":2,"text":"Check subscription status"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[" Once you have created and confirmed a subscription, you can see status information for the subscription using the GET /streams/subscriptions/{subscriptionId} endpoint.\n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":3,"text":"Possible statuses"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":["|Status\t|Description\t|\n","|---\t|---\t|\n","|PROVISIONING\t|Subscription has been created and is being provisioned on the Amazon side. Once finished provisioning, the subscription will move into PENDING_CONFIRMATION status.\t|\n","|PENDING_CONFIRMATION\t|Subscription was created and provisioned, and is awaiting confirmation in the SQS queue.\t|\n","|FAILED_CONFIRMATION\t|The subscription was not confirmed in SQS within 3 days. If this occurs, please create a new subscription and confirm the subscription within the 3-day expiration window.\t|\n","|ACTIVE\t|The subscription is active and delivering data.\t|\n","|ARCHIVED\t|The subscription has been archived. \t|\n","|SUSPENDED\t|The subscription has been suspended. This happens if the account that created the subscription loses access to the advertiser in the advertising console.\t|\n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":3,"text":"Request"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":2,"text":"Archive a subscription"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[" Currently there is no way to delete Amazon Marketing Stream subscriptions. Instead you can archive a subscription using the PUT /streams/subscriptions/{subscriptionId} endpoint and setting the status to ARCHIVED. Setting the status as archived stops all data delivery for the advertiser account and dataset associated with the subscription.\n"],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":3,"text":"Request"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[],"documentType":"guide"},{"title":"Managing Amazon Marketing Stream Subscriptions","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/amazon-marketing-stream/managing-subscriptions","content":[],"documentType":"guide"},{"title":"SQS best practices","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-lambda","content":[" A successful implementation of Amazon Marketing Stream relies on a strong understanding of AWS infrastructure, including AWS SQS and AWS Lambda. This document provides some suggestions and best practices to optimize your AWS costs as you scale Amazon Marketing Stream. \n"],"documentType":"guide"},{"title":"SQS best practices","sectionHeader":{"type":2,"text":"AWS SQS"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-lambda","content":[],"documentType":"guide"},{"title":"SQS best practices","sectionHeader":{"type":3,"text":"Understanding SQS pricing"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-lambda","content":[" As part of the Stream onboarding process, you set up a queue and subscribe that queue to Stream datasets. Stream then sends records containing campaign data and events to your SQS queue.\n"," There is a cost associated to each action you take on your queue. All of the actions described in the SQS API operations reference incur a cost. For example, once messages are in your queue, you need to send a request to SQS to receive messages (either through the SQS console or programmatically using the ReceiveMessage request in the SQS API). \n"," As part of the AWS SQS Free Tier, you can make one million free requests per month. Each additional set of a million requests incurs a charge based on your region (refer to the SQS cost calculator for the most up-to-date pricing). \n"," Data transferred between SQS and EC2 or Lambda in different regions also incurs a charge. Refer to the cost calculator for details. \n"],"documentType":"guide"},{"title":"SQS best practices","sectionHeader":{"type":3,"text":"Best practices"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-lambda","content":[" To optimize your SQS costs, implement long polling and batching as suggested by AWS. \n"," To reduce the likelihood of being charged for empty messages, configure long polling in your SQS queues. \n"," SQS offers two options for receiving messages from a queue: short and long polling. By default, queues use short polling, which means ReceiveMessage requests result in an immediate response, even if no messages are found in the queue. With long polling, you only receive a message if there is one found during polling, or if the polling wait time expires. For example, if you send a ReceiveMessage request, but there are no Stream messages in your queue, you will get an empty response. The empty response will still count as an action that incurs a cost in SQS. You can validate the performance by reviewing the NumberOfEmptyReceives CloudWatch metric.\n"," More information:\n","Understanding short vs. long polling \\* Setting up long polling\n"," SQS pricing is based on the number of requests you send. If you reduce your number of requests, you can reduce costs. Batching requests is one way to reduce the number of requests made. \n"," Consider the following example: Amazon Ads sends five new messages to your queue. You could send five separate ReceiveMessage requests to SQS to retrieve the messages, and be charged five separate times. However, each of these messages is relatively small--in this example, assume 10 KB each for a total of 50 KB. AWS allows you to batch messages together, and as long as the batch does not exceed 65 KB, you will only be charged once. In this example, you could batch all five messages together for a total payload size of 50 KB, thus reducing the total number of messages you are charged for from five messages to one. \n"," AWS allows you to batch up to ten messages together. Messages sent from Stream should always be less than 6 KB; therefore, you should be able to set batching to the maximum allowable value of ten and be safely under the 64 KB payload threshold. \n"," More information:\n","Send and receive batches of messages with SQS using an AWS SDK  Python wrapper to send and receive messages  SQS batch operations reference\n"," If you need to transfer data, only send data within the same region. Transferring data out to a different region results in increased costs. \n"],"documentType":"guide"},{"title":"SQS best practices","sectionHeader":{"type":2,"text":"AWS Lambda"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-lambda","content":[" You can also use AWS Lambda to run recurring processes on messages received in SQS. \n"," If you are using AWS Lambda, you may want to consider the following blog posts from AWS on managing Lambda costs:\n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":[" The Amazon Marketing Stream push-based messaging system provides near real-time updates in the form of JSON messages to the SQS queues of partners (tool providers, agencies, or direct advertisers) for each of their advertisers. Partners process these messages using Lambda functions, EC2 instances, containers, or on-premises applications. However, monitoring the SQS queue is essential to guarantee that all messages are received and processed.\n"," This guide aims to assist Amazon Marketing Stream partners in setting up comprehensive monitoring for their Amazon SQS queues. This will ensure all messages are received and processed, with no messages missed. Additionally, it will facilitate early detection of potential application issues that could be contributing factors to data inconsistencies.\n"," A CloudFormation template is also provided that helps with the setup of CloudWatch dashboards and alarms. This guide will help you acquire a fundamental understanding of queue monitoring. Then you can adjust the threshold values in the CloudFormation template to tailor it to your needs.\n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":{"type":2,"text":"Understanding SQS monitoring metrics"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":[" To begin, understanding and monitoring the right set of Amazon CloudWatch metrics is crucial:\n","NumberOfMessagesSent: The number of messages being added to your queue by Amazon Marketing Stream.  NumberOfMessagesReceived: The number of messages your application is successfully receiving from the queue for processing.  NumberOfMessagesDeleted: This indicates the count of messages that your application processed successfully and deleted from the queue.  ApproximateNumberOfMessagesVisible: The number of Amazon Marketing Stream messages in the queue that your app still needs to receive and process.  ApproximateAgeOfOldestMessage: This age (in seconds) shows if any Amazon Marketing Stream messages are stuck in the queue for too long before being received by your app.\n"," Resource: For a detailed explanation of all SQS metrics, refer to the official AWS documentation.\n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":{"type":2,"text":"Setting up CloudWatch dashboards for SQS"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":[" A CloudWatch Dashboard offers a centralized view of your metrics, allowing for real-time monitoring and quick assessments. To create a sample dashboard:\n","Log in to your AWS Management Console and navigate to CloudWatch. 2. Click Dashboards > Create dashboard. 3. Give your dashboard a descriptive name, such as \"Amazon Marketing Stream {dataset name} SQS Monitoring\" 4. Click Add widget > SQS. 5. Add Metrics Widgets: For each key metric mentioned in Understanding SQS monitoring metrics above, add a widget. Choose the graph style that best suits your monitoring needs (for example, line graphs for trends or number widgets for current statuses).  6. Customize the appearance and timeframe of the widget as needed. 7. Arrange the widgets on your dashboard for clarity. 8. Click Save dashboard.\n"," These dashboards will provide a quick visual overview of the health of your queue, allowing you to identify potential mismatches between received and processed messages. For detailed instructions on creating and customizing CloudWatch dashboards, refer to the AWS documentation on Using Amazon CloudWatch Dashboards.\n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":{"type":2,"text":"Setting up alarms"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":[" To ensure you are notified if any issues arise with your Amazon Marketing Stream SQS queues, set up alarms based on the metrics you are monitoring. \n"," To set up alarms, follow these steps: \n","Go to the CloudWatch console and navigate to the Alarms section. 2. Click on Create Alarm and select the appropriate metric for the alert you want to set up. Setting alarms for the following key metrics is highly recommended:  3. Configure the alarm conditions, such as the threshold value and the evaluation period. 4. Specify the appropriate actions to be taken when the alarm is triggered, such as sending a notification to an Amazon SNS topic or invoking an AWS Lambda function. 5. Review and create the alarm.\n"," For detailed instructions on Creating CloudWatch alarms for Amazon SQS metrics please refer to the AWS documentation.\n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":{"type":2,"text":"Ensuring all Stream messages are processed"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":[" To make sure all Stream messages are processed, you need to compare the number of messages sent versus received versus deleted.\n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":{"type":3,"text":"Checking messages are received"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":[" Track and compare NumberOfMessagesSent versus NumberOfMessagesReceived. Ideally, the values should be equal.\n"," A lower NumberOfMessagesReceived value might indicate messages are not being retrieved for processing.\n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":{"type":3,"text":"Checking messages are processed"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":[" To confirm that all messages are processed correctly, look at NumberOfMessagesReceived versus NumberOfMessagesDeleted. While NumberOfMessagesReceived and NumberOfMessagesDeleted should be close, meaning all sent messages are processed and removed, there can be differences depending on your queue configuration. Specifically, a high max retries setting can lead to a larger NumberOfMessagesReceived count. Imagine a message failing processing nine times with retries, resulting in nine receives before a single successful deletion on the 10th attempt. Hence, it is recommended not to set alarms based on this metric difference until these nuances are addressed.\n"," A lower NumberOfMessagesDeleted value suggests messages are received but not processed successfully (for example, errors).\n"," You can set up an alarm to check for differences in NumberOfMessagesReceived versus NumberOfMessagesDeleted. You should create alarms for significant discrepancies between these metrics, such as a growing gap between NumberOfMessagesSent and NumberOfMessagesDeleted, which can alert you to processing delays or failures. You can leverage metric math to accomplish this task. \n","Navigate to the CloudWatch console. 2. Select \"All Metrics\" and then navigate to SQS to find and select the metrics mentioned above. 3. Once you have chosen the metrics, click on \"Graphed metrics.\" 4. In the graphed metrics view, select \"Math expression\" and start with an empty expression. This action will create a new line for the expression. 5. Define the expression as follows:\n","After defining the expression, you can create an alarm based on this new metric. Set the alarm to trigger whenever the value is equal to 1, indicating a discrepancy between the two metrics.\n"," For detailed instructions on metric math in CloudWatch, refer to the AWS documentation.\n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":{"type":2,"text":"Monitoring best practices"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":["Regular Audits: Periodically review these metrics to identify any long-term trends or recurring issues in your message processing pipeline, allowing you to implement optimizations or capacity adjustments.  Error Handling and Retry Logic: Implement robust error handling in your message processing logic, including retries for temporary issues and dead-letter queues for messages that cannot be processed after several attempts. This helps reduce the discrepancy between received and deleted messages.  While SQS offers visibility into Amazon Marketing Stream message delivery, it cannot directly monitor your processing application. Implementing application-specific monitoring solutions is crucial for ensuring successful message processing beyond SQS delivery.  \n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":{"type":2,"text":"Note on AWS CloudWatch pricing"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":[" Amazon CloudWatch offers a free tier with basic usage, however it is worth knowing a few key points:\n","For dashboards, you can have up to 3 custom dashboards referencing up to 50 metrics each per month for free in the AWS Free Tier. Beyond that, there is a charge of $3 per custom dashboard per month.  For alarms, you can have 10 alarm metrics for free in the AWS Free Tier if the alarms list metrics directly (not using a Metrics Insights query). Beyond 10 alarms, standard resolution alarms cost $0.10 per metric per month if listing metrics directly, or $0.10 per alarm-metric analyzed if using a Metrics Insights query.  If you enable Amazon CloudWatch Anomaly Detection on 10 standard resolution metrics per month and only want to alarm on 5 of those metrics, you will create 5 standard resolution anomaly detection alarms.  One standard resolution anomaly detection alarm costs $0.10  3 standard resolution metrics per alarm = $0.30 per month. So for the example of 5 standard resolution anomaly detection alarms, the monthly cost would be: 5 alarms  $0.30 per alarm = $1.50 per month  Anomaly Detection is available only with standard resolution alarms, not high resolution alarms.\n"," See the official pricing details for the latest information.\n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":{"type":2,"text":"Deploying the CloudFormation template"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":[" A CloudFormation template is provided to help you quickly set up the CloudWatch dashboards and alerts that you need to monitor your Stream integration.\n"," Deploying the template will create:\n","A CloudWatch dashboard  An SNS topic for notifications  Several alarms to monitor key SQS metrics\n"],"documentType":"guide"},{"title":"Ensuring message delivery and processing with SQS","sectionHeader":{"type":3,"text":"Steps"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/sqs-cloudwatch","content":[],"documentType":"guide"},{"title":"Amazon Marketing Stream Cross Region Data Transfer","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/best-practices/data-transfer","content":[],"documentType":"guide"},{"title":"Amazon Marketing Stream Cross Region Data Transfer","sectionHeader":{"type":2,"text":"Background"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/data-transfer","content":[" Customers using Amazon Marketing Stream to receive near real-time advertising performance data may store and process the dataset in a region different from the API endpoint and AWS region. Some customers or partners may not use AWS as their cloud infrastructure. This guide provides best practices for customers and partners transferring Amazon Marketing Stream data across different regions.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream Cross Region Data Transfer","sectionHeader":{"type":2,"text":"Technical Challenge"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/data-transfer","content":[" The major technical challenges in transferring Amazon Marketing Stream data across regions include unstable network performance across geographies, resulting in high latency across the open internet and data loss due to network packet loss. The diagram below illustrates a scenario where a customer pulls the Amazon Marketing Stream dataset from the US region and transfers it to APAC for processing on a different infrastructure platform.\n"," As shown in the diagram, a customer has established their computing and data analytics infrastructure in the APAC region, using Aliyun (also known as Alibaba Cloud) as an example. To register and retrieve the Amazon Marketing Stream dataset from the NA region, the customer has configured an Amazon SQS in NA to subscribe to the dataset, enabling Amazon Marketing Stream to publish data events to SQS. The customer runs a program on a cloud server in APAC to pull the dataset from Amazon SQS and store the data in a database/storage system within the same region.\n"," The main issue with this architecture is that communication between SQS and the cloud server, which crosses geographic regions, experiences high latency over the public Internet and unstable network performance, resulting in long transmission times and data loss. An optimized solution is presented below.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream Cross Region Data Transfer","sectionHeader":{"type":2,"text":"Best Practice"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/data-transfer","content":[" To improve the reliability of Amazon Marketing Stream dataset transmission across geographic regions, the following guidelines are recommended:\n","The system pulling the dataset from SQS should be in the same region as the SQS and Amazon Marketing Stream endpoint to minimize data transit time, and should store the dataset in storage services located in the same region, using either Amazon Data Firehose or SQS with pulling code.\n","For customers using AWS as their sole cloud infrastructure, use Amazon Data Firehose to stream the dataset to Amazon S3, then replicate it to the destination region using Amazon S3 cross-region replication.\n","Use data replication with a stable network (for example, a dedicated line or similar technology) to synchronize the offline dataset to the destination in batches, ensuring efficient data transmission with low error rates.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream Cross Region Data Transfer","sectionHeader":{"type":2,"text":"Cost Analysis"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/data-transfer","content":[" The cost of the solution primarily comes from cloud infrastructure. Using the example above, the service costs are listed below. As a reference, serving 200 customers will cost approximately $550 for the cloud infrastructure, including both AWS and Aliyun.\n"," Amazon SQS (US-EAST-1) latest pricing can be found here\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream Cross Region Data Transfer","sectionHeader":{"type":3,"text":"Aliyun OSS (Singapore)"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/data-transfer","content":[" Latest pricing can be found here\n"," Locally Redundant Storage\n","| Standard unit cost ($)/month | |\n","\\|---------------------------\\|--------\\|\n","| 0-5G | Free |\n","| Above 5G | 0.02/GB |\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream Cross Region Data Transfer","sectionHeader":{"type":3,"text":"Aliyun ECS (Singapore)"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/data-transfer","content":[" Latest pricing can be found here\n","| Instance Type | vCPU | Mem(G) | Monthly cost ($) |\n","\\|--------------\\|------\\|---------\\|------------------\\|\n","| ecs.u1-c1m4.large | 2 | 8 | 45.8 |\n","| ecs.u1-c1m8.large | 2 | 16 | 56.36 |\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream Cross Region Data Transfer","sectionHeader":{"type":3,"text":"Aliyun Global Accelerator"},"path":"/en-us/guides/amazon-marketing-stream/best-practices/data-transfer","content":[" Latest pricing can be found here\n","| Processing data volume/Month | Monthly cost ($) |\n","\\|-----------------------------\\|------------------\\|\n","| 200G | 338.2 |\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":2,"text":"Subscription Management"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: My subscription is stuck in `PENDING_CONFIRMATION` status for more than 1 day. What should I do?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: When your Amazon Marketing Stream subscription with an SQS destination remains in PENDING_CONFIRMATION status for an extended period, it indicates that the AWS SNS subscription confirmation process has not completed successfully.\n"," The root cause typically stems from the AWS SNS confirmation workflow. When you create a Marketing Stream subscription, Amazon Marketing Stream automatically creates an SNS topic and attempts to subscribe your specified destination SQS queue. SNS then sends a confirmation message that must be acknowledged within 2 days. If this confirmation is not processed correctly, the subscription remains in a pending state for 2 days. After this period, if the confirmation is still not processed, the subscription will move to a FAILED_CONFIRMATION state.\n"," Common underlying issues include:\n","Missing or misconfigured IAM permissions that block SNS from delivering messages. - The message processing logic of your application does not properly handle SNS confirmation messages. - SQS queue policies that do not allow cross-account message delivery.\n"," Solution Steps:\n","Check your SQS queue for unprocessed confirmation messages. 2. Verify your endpoint is accessible and responding correctly to SNS confirmation requests. 3. Ensure your IAM policies allow SNS to deliver messages from the Amazon Marketing Stream account for your specific dataset and region to your SQS queue. Refer to the documentation for the correct account ID for your dataset and region. 4. Always use CloudFormation templates (IaC) to ensure consistent infrastructure deployment and eliminate manual configuration errors. 5. Contact Amazon Ads API support to resend the confirmation message if a subscription is urgently needed and must use same destination. Alternatively, create a new destination queue with proper IAM permissions and recreate subscriptions. Unconfirmed subscriptions move to FAILED_CONFIRMATION after 2 days.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: My subscription shows `FAILED_PROVISIONING` status when I try to create it. How do I fix this?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: FAILED_PROVISIONING status occurs when Amazon Marketing Stream cannot properly set up the Firehose infrastructure needed to deliver data to your specified Firehose destination.\n"," Common causes include:\n","Insufficient IAM permissions on your Firehose destination resource - Missing or incorrect resource policies on the destination - Cross-account access issues when resources are in different AWS accounts - Destination resource does not exist or has been deleted - Firehose delivery stream configuration errors\n"," Solution Steps:\n","Verify your Firehose destination resource exists and is accessible. 2. Check IAM policies allow Amazon Marketing Stream to send messages to your Firehose destination. 3. Ensure resource policies permit cross-account access if applicable. 4. Verify the delivery stream configuration is correct. 5. Test permissions by manually sending a test message to your destination. 6. Review AWS CloudTrail logs for specific permission denial errors.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: I cannot see my subscriptions when I call `GET /streams/subscriptions`, but I know I have active subscriptions. What is wrong?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: An empty response from GET /streams/subscriptions despite having active subscriptions can occur due to several reasons, primarily related to authentication and the refresh token being used. \n"," Authentication and Authorization Issues:\n","Using a refresh token generated with a different email address - Missing marketplace-specific permissions - Outdated or revoked refresh tokens - Account permissions changed after subscription creation\n"," Refresh Token Association:\n"," Stream subscriptions are strictly associated with the refresh token (generated using a specific email address) and your client application. If you are using a new refresh token generated with new email (even for the same advertiser), you will not be able to see subscriptions created with a previous refresh token with a different email address.\n"," Detached Stream Subscriptions:\n"," These are subscriptions created with a refresh token that was generated using an email address that is no longer associated with the advertiser account.\n"," Common scenarios include:\n","The email address used to generate the refresh token is no longer accessible. - The person associated with that email has left the company.\n"," Solution Steps:\n","Verify your current authentication: 2. If using a new refresh token: 3. For detached subscriptions: 4. General troubleshooting:\n"," Important Notes:\n","Changing the email association for historical subscriptions is not supported due to security reasons. - It is important to securely store refresh tokens to maintain access to your subscriptions. - If you continue to experience issues after following these steps, contact Amazon Ads API support for further assistance. They can help verify your account status and provide guidance on managing your subscriptions effectively.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: How do I increase my subscription limits? I am getting \"subscription limit exceeded\" errors."},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Amazon Marketing Stream has default limits on the number of subscriptions per client to ensure system stability and fair resource allocation.\n"," Subscription limits are enforced at the client ID level and vary by dataset type. When you reach these limits, you will receive errors preventing new subscription creation. Limits exist to prevent resource exhaustion and ensure reliable service for all users.\n"," Solution Steps:\n","Review your current subscription usage across all datasets. 2. Archive unused or inactive subscriptions to free up quota. 3. Consolidate multiple subscriptions where possible. 4. Contact Amazon Ads API support with your business justification for higher limits. 5. Provide details about your use case and expected volume. 6. Consider using fewer, more comprehensive subscriptions instead of many specific ones.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":2,"text":"Data Delivery and Quality"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: I am not receiving any data from my active subscriptions. What should I check?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: When active subscriptions are not delivering data, the issue typically lies in the message delivery pipeline or your data processing setup. This can occur due to several factors in the data flow from Amazon Marketing Stream to your destination (SQS queue or Kinesis Firehose). \n"," Even though your subscription shows as ACTIVE, various components in the delivery chain might be preventing data from reaching your destination.\n"," Common causes include:\n","SNS subscription was accidentally deleted or unsubscribed. - SQS queue permissions changed after subscription creation. - Dead letter queue is capturing failed messages. - Your application is not polling the queue correctly. - Messages are being processed but not logged/stored properly. - If using Kinesis Firehose as destination, delivery stream has configuration/permission issues.\n"," Solution Steps:\n","Check your SQS queue for unprocessed messages. 2. Verify SNS subscription is still active and confirmed. 3. Review dead letter queue for failed message deliveries. 4. Test your message processing logic with sample data. 5. Check CloudWatch metrics for your SQS queue activity. 6. If using Kinesis Firehose as destination, verify the delivery stream status and verify whether delivery stream has any configuration/permission issues.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: I am seeing data discrepancies between Marketing Stream and the Ads Console. Which should I trust?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Data discrepancies between Marketing Stream and Ads Console can occur due to timing differences, data processing delays, or different aggregation methods.\n"," Marketing Stream provides near real-time data as events occur, while the Ads Console may show data that has been processed through different aggregation pipelines. Small discrepancies are normal, but significant differences usually indicate a specific issue.\n"," Common causes of discrepancies include:\n","Different attribution windows between systems - Time zone differences in data aggregation - Delayed data processing in one system - Different filtering or aggregation logic - Upstream data source issues affecting one system\n"," Solution Steps:\n","Compare data over longer time periods to identify patterns. 2. Check if discrepancies are consistent or sporadic. 3. Verify time zone settings in both systems. 4. Review attribution window settings for conversion data. 5. Check for any known upstream data issues during the time period. 6. Contact support if discrepancies exceed consistently. 7. Document clear examples with timestamps, advertiser IDs, marketplace and values..\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: I am receiving duplicate messages in my SQS queue. How do I handle this?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Duplicate messages in SQS queues can occur due to the distributed nature of the Amazon Marketing Stream delivery system and the at-least-once delivery guarantee of SQS.\n"," This is a normal characteristic of distributed messaging systems. SQS does not guarantee exactly-once delivery, so your application should be designed to handle duplicate messages gracefully through idempotent processing.\n"," Common causes include:\n","Network issues during message delete operations - SQS visibility timeout expiration - Multiple consumers processing the same message - System failover scenarios - Message redelivery after processing failures - SNS-SQS integration (SNS also has at-least-once delivery semantics)\n"," Solution Steps:\n","Implement idempotent message processing in your application. 2. Use message deduplication based on idempotencyId in the data. 3. Store processed messages to detect and skip duplicates. 4. Configure appropriate SQS visibility timeouts. 5. Use distinct idempotencyId in your queries when analyzing data.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: Amazon Marketing Stream data contains \"Placeholder keyword\" values. What does this mean?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: \"Placeholder keyword\" appears in Amazon Marketing Stream data when the upstream advertising system has not yet populated actual dimension values for certain fields.\n"," This occurs when the advertising system is still processing campaign data or when certain dimensions are temporarily unavailable. It is a temporary state that typically resolves as the system completes data processing.\n","Newly created campaigns still being processed - System maintenance affecting dimension data - Upstream data pipeline delays - Keyword matching still in progress - Campaign optimization processes running\n"," Solution Steps:\n","Filter out records with \"Placeholder keyword\" in your data processing. 2. Monitor for resolution of placeholder values over time. 3. Contact support if placeholders persist for more than 24 hours. 4. Consider these records as incomplete data in your analytics. 5. Set up alerts for unusual increases in placeholder values.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: I am seeing negative values for impressions, clicks, or spend in my data. Is this normal?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Negative values in Marketing Stream data typically represent corrections or adjustments to previously reported metrics.\n"," These corrections occur when the advertising system identifies and corrects invalid traffic, billing adjustments, or data quality issues. Negative values help maintain data accuracy by offsetting previously reported incorrect positive values.\n"," Solution Steps:\n","Include negative values in your data aggregation to get accurate totals. 2. Do not filter out negative values as they are legitimate corrections. 3. Monitor for unusual patterns in negative value frequency. 4. Aggregate data over longer periods to see net effects. 5. Contact support if negative values seem disproportionately large. 6. Implement proper data validation that accounts for corrections.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":2,"text":"Technical Integration"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: What IAM permissions do I need to receive Marketing Stream data in my SQS queue?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Your SQS queue needs specific IAM permissions to allow Amazon Marketing Stream to deliver messages successfully. \n"," The permissions must allow the Amazon Marketing Stream service accounts (which vary by dataset and region) to send messages to your queue. For more information, see AMS: Data Guide.\n"," Required permissions include:\n","SQS:SendMessage for the Marketing Stream service accounts - SQS:GetQueueAttributes for queue validation - Cross-account access if resources are in different accounts - SNS subscription confirmation permissions\n"," Solution Steps:\n","Create an SQS queue policy allowing Marketing Stream service account access. 2. Ensure your IAM user/role has permissions to create subscriptions. 3. Configure cross-account permissions if using different AWS accounts. 4. Use AWS Policy Simulator to validate permission configurations. 5. Review CloudTrail logs for permission-related errors.\n"," Example SQS Queue Policy:\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: How do I handle Marketing Stream data with Data Firehose?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Data Firehose provides a managed way to deliver Marketing Stream data directly to S3, Redshift, or other destinations without managing SQS queues.\n"," Firehose automatically handles batching, compression, and delivery of your Marketing Stream data. However, it requires proper configuration and permissions to work correctly with the Marketing Stream service.\n"," Key configuration requirements include:\n","Proper IAM roles for Firehose delivery - Destination configuration (S3 bucket, Redshift cluster, etc.) - Error handling and backup configurations - Data transformation settings if needed - Delivery stream naming and buffering settings\n"," Solution Steps:\n","Create a Kinesis Data Firehose delivery stream. 2. Configure IAM roles with necessary permissions. 3. Set up your destination (S3 bucket, etc.) with proper permissions. 4. Configure error handling and backup destinations. 5. Test the delivery stream with sample data. 6. Create Marketing Stream subscription using Firehose ARN. 7. Monitor delivery metrics in CloudWatch.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: My subscription worked before but now shows `SUSPENDED` status. What happened?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: SUSPENDED status typically occurs when Amazon Marketing Stream detects issues with data delivery to your destination or changes in account permissions.\n"," Amazon Marketing Stream avoids sending data when there are consistent delivery failures or unauthorized subscriptions, which helps prevent unnecessary resource consumption and ensures data is only sent when proper access and access to advertiser data are confirmed.\n"," Common causes include:\n","SQS queue was deleted or permissions changed - SNS subscription was manually unsubscribed - Ads account permissions were revoked - Destination resource became inaccessible - Repeated delivery failures exceeded retry limits - User lost access to advertiser data\n"," Solution Steps:\n","Check if your destination resource still exists and is accessible. 2. Verify SNS subscription is still active and confirmed. 3. Review IAM permissions for any recent changes. 4. Check CloudWatch logs for delivery failure patterns. 5. Test connectivity to your destination manually. 6. Consider creating a new subscription.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":2,"text":"Troubleshooting and Monitoring"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: How can I monitor the health of my Marketing Stream integration (SQS)?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Effective monitoring of your Amazon Marketing Stream integration requires tracking multiple metrics across the entire data pipeline.\n"," Monitoring should cover subscription status, message delivery, data processing, and business metrics to ensure your integration remains healthy and provides reliable data for your applications. Set up alerts for data gaps rather than continuously polling subscription status.\n"," Key monitoring areas include:\n","Subscription status and health checks - SQS queue metrics (message count, age, processing rate) - Data processing success/failure rates - Data freshness and completeness - Error rates and types - Business metric validation\n"," Solution Steps:\n","Set up CloudWatch alarms for SQS queue metrics. 2. Configure alerts for unexpected gaps in data reception. 3. Track data processing success rates in your application. 4. Implement data freshness checks. 5. Set up alerts for unusual data patterns or volumes. 6. Create dashboards for key integration metrics. 7. Establish baseline metrics for comparison.\n"," Recommended CloudWatch Metrics:\n","ApproximateNumberOfMessages - ApproximateAgeOfOldestMessage - NumberOfMessagesSent - NumberOfMessagesReceived - NumberOfMessagesDeleted\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: What should I do if I suspect I am missing data from my stream (SQS)?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Missing data can occur due to various issues in the delivery pipeline, processing logic, or upstream data sources.\n"," Data gaps can be difficult to detect without proper monitoring, so it is important to have systematic approaches for identifying and addressing missing data scenarios.\n"," Common causes of missing data include:\n","Message processing failures in your application - SQS message visibility timeout issues - Dead letter queue capturing failed messages - Application downtime during data delivery\n"," Solution Steps:\n","Check your SQS dead letter queue for failed messages. 2. Review application logs for processing errors during the suspected time period. 3. Compare data volumes with historical patterns. 4. Verify SQS queue metrics in CloudWatch for message delivery. 5. Check for application downtime or deployment issues. 6. Contact support with specific time ranges and missing data details. 7. Implement data completeness monitoring for early detection.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: How do I handle time zones correctly in Marketing Stream data?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Amazon Marketing Stream data includes timestamp fields that need proper time zone handling for accurate reporting and analysis.\n"," The time_window_start field in Amazon Marketing Stream data represents the beginning of the reporting period and is provided in ISO 8601 format. Your application needs to handle time zone conversions appropriately for your business requirements.\n"," Key considerations include:\n","All timestamps are in ISO 8601 format - Convert to local time zones for reporting - Handle daylight saving time transitions - Maintain consistency across different data sources - Account for marketplace-specific time zones\n"," Solution Steps:\n","Parse timestamps from ISO 8601 format to your desired time zone. 2. Use proper date/time libraries that handle time zone conversions. 3. Test time zone handling around daylight saving time transitions. 4. Document your time zone handling approach for consistency. 5. Validate time zone conversions with known data points.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":2,"text":"Account and Access Management"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: I am getting `401` Unauthorized errors when trying to access Marketing Stream APIs. How do I fix this?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: 401 Unauthorized errors indicate authentication issues with your Ads API credentials or token configuration.\n"," This typically occurs when your access tokens are expired, invalid, or do not have the necessary scopes for Marketing Stream access. The error can also happen if you are using credentials for the wrong marketplace or advertiser profile.\n"," Common causes include:\n","Expired access tokens - Invalid or revoked refresh tokens - Missing required API scopes - Using credentials for wrong marketplace - Incorrect advertiser profile ID - Ads API credentials not properly configured\n"," Solution Steps:\n","Refresh your access tokens using your refresh token. 2. Verify your Ads API credentials have access to Ads API. 3. Check that you are using the correct Ads API endpoint. 4. Confirm your advertiser profile ID is correct. 5. Test authentication with a simple Ads API call first. 6. Review API documentation for required scopes and permissions.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: Can I use one SQS queue to receive data from multiple Marketing Stream subscriptions?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Yes, you can configure multiple Marketing Stream subscriptions to deliver data to the same SQS queue, but this requires careful message handling in your application.\n"," Using a single queue for multiple subscriptions can simplify infrastructure management but requires your application to differentiate between different data types and sources when processing messages.\n"," Considerations include:\n","Message identification and routing logic - Different data schemas for different datasets - Processing order and priority handling - Error handling for different message types - Queue capacity and throughput planning - Dead letter queue configuration\n"," Solution Steps:\n","Design message processing logic to handle multiple dataset types. 2. Implement proper error handling for each subscription type. 3. Configure appropriate SQS queue settings for expected volume. 4. Set up monitoring for the combined message flow. 5. Test thoroughly with multiple subscription types. 6. Document message routing and processing logic.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":3,"text":"Q: How do I properly archive or cancel subscriptions I no longer need?"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" A: Properly managing subscription lifecycle helps maintain clean account state and avoid unnecessary resource usage and associated costs.\n"," Unused subscriptions should be properly archived rather than just ignored, as they continue to consume system resources and count against your subscription limits even if you are not processing the data.\n"," Best practices include:\n","Archive subscriptions through the API rather than just deleting the destination - Clean up associated AWS resources (SQS queues, SNS subscriptions) after subscription archival - Document subscription lifecycle for team knowledge - Regular audit of active subscriptions - Proper cleanup procedures for development/testing subscriptions\n"," Solution Steps:\n","Use the UPDATE /streams/subscriptions/{subscriptionId} API call. 2. Clean up associated SQS queues and SNS subscriptions after subscription archival.  3. Remove any IAM policies specific to the subscription. 4. Update monitoring and alerting configurations. 5. Document the archival in your change management system. 6. Verify the subscription no longer appears in your ACTIVE subscription list. 7. Monitor for any residual message delivery.\n"],"documentType":"guide"},{"title":"Amazon Marketing Stream FAQ","sectionHeader":{"type":2,"text":"Contact Support"},"path":"/en-us/guides/amazon-marketing-stream/amazon-marketing-stream-faq","content":[" If your question is not answered in this FAQ or you need additional assistance, contact Amazon Ads API Support through the following channels:\n","Amazon Ads API Support: Submit a support case through the Amazon Ads API Support Portal - Community Forums: Check the Amazon Ads API Github community forums for similar issues\n"," When contacting support, please provide:\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager overview","sectionHeader":null,"path":"/en-us/guides/ads-data-manager/overview","content":[],"documentType":"guide"},{"title":"Amazon Ads Data Manager overview","sectionHeader":{"type":2,"text":"What is Amazon Ads Data Manager?"},"path":"/en-us/guides/ads-data-manager/overview","content":[" Ads data manager is an Amazon Ads offering with options that enable advertisers to securely upload their first-party (1P) data to Amazon Ads using either an intuitive user interface (Ads data manager console) or Ads data manager APIs. The uploaded data can be mapped to the required inputs needed to activate their data across Amazon Ads products and then shared for planning and measurement use cases to gain insights and help you optimize campaigns and create audiences.  Upload once, activate everywhere. Connect your data source, create a dataset, and share it to any destination — no re-uploading.  Privacy-safe by design. End-to-end encryption, isolated data environments for each account, and user-level access controls for data onboarding vs. data access. \\* No-code and developer paths. Use the Console UI and the source connector library for no-code setup, or the API for developer workflows.\n"," Designed for data stewards, data owners, marketers, or programmatic teams that have access to use their 1P data; Ads data manager is designed to facilitate data owners use their data within Amazon Ads, and to hand-off to campaign managers who may not access their 1P party data directly but are required to include this data in campaign setup for attribution or targeting purposes.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager overview","sectionHeader":{"type":3,"text":"Supported data sources"},"path":"/en-us/guides/ads-data-manager/overview","content":["|Method|Best for|Path|\n","\\|-\\|-\\|-\\|\n","|Amazon Ad Tag (JavaScript)|Website conversion events|Developer|\n","|Events API|Server-side events, offline conversions|Developer|\n","|Console UI file upload|Batch/offline data (CRM, transaction logs)|No-code|\n","|Mobile Measurement Partner Integration|Mobile app events (Adjust, AppsFlyer, etc.)|Partner|\n","|Customer Data Platform Connectors|CRM/audience streaming (Salesforce, Tealium, etc.)|Partner|\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager overview","sectionHeader":{"type":3,"text":"Availability"},"path":"/en-us/guides/ads-data-manager/overview","content":["|Region|Countries|\n","\\|-\\|-\\|\n","|North America|US, CA, MX|\n","|South America|BR|\n","|Europe|DE, ES, FR, IT, NL, PL, SE, TR, UK|\n","|Middle East|UAE|\n","|Asia-Pacific|AU, CN, IN, JP|\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager overview","sectionHeader":{"type":3,"text":"Access"},"path":"/en-us/guides/ads-data-manager/overview","content":["Console: advertising.amazon.com → Ads Data Manager  API: Amazon Ads API  Eligibility: Any Amazon Ads customer with manager account access.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager overview","sectionHeader":{"type":2,"text":"Getting started guide"},"path":"/en-us/guides/ads-data-manager/overview","content":[],"documentType":"guide"},{"title":"Amazon Ads Data Manager overview","sectionHeader":{"type":3,"text":"Choose your path"},"path":"/en-us/guides/ads-data-manager/overview","content":["|I am a...|I want to...|Start here|\n","\\|-\\|-\\|-\\|\n","|Advertiser|Track website conversions and activate audiences|Data sources and connections → install AAT or set up Events API|\n","|Partner (CDP/Mobile Measurement Partner)|Integrate with Amazon Ads data manager on behalf of advertisers|Data sources and connections → Partner Connectors|\n","|Agency|Manage data for clients|Same as Advertiser + Cross-account data sharing|\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager overview","sectionHeader":{"type":3,"text":"No-code vs. developer"},"path":"/en-us/guides/ads-data-manager/overview","content":["|If you...|Use...|Docs|\n","\\|-\\|-\\|-\\|\n","|Don't have developer access|Connector Library, Console UI|Data sources → No-code paths|\n","|Have a developer or tag manager|AAT JavaScript, GTM, Events API|Data sources → Developer paths|\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager overview","sectionHeader":{"type":3,"text":"Quick start guide"},"path":"/en-us/guides/ads-data-manager/overview","content":[],"documentType":"guide"},{"title":"Get started with Amazon Ads Data Manager","sectionHeader":null,"path":"/en-us/guides/ads-data-manager/get-started","content":[" This guide walks you through your first end-to-end setup in Amazon Ads data manager — from connecting a data source to activating your data for campaign targeting and measurement.\n"],"documentType":"guide"},{"title":"Get started with Amazon Ads Data Manager","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/ads-data-manager/get-started","content":["An Amazon Ads account with Manager Account access.  Ads data manager Terms of Service accepted (prompted on first access).  A data source ready to connect (website with AAT, server-side endpoint for Events API, or Mobile Measurement Partner integration).\n"],"documentType":"guide"},{"title":"Get started with Amazon Ads Data Manager","sectionHeader":{"type":2,"text":"Steps"},"path":"/en-us/guides/ads-data-manager/get-started","content":[],"documentType":"guide"},{"title":"Get started with Amazon Ads Data Manager","sectionHeader":{"type":3,"text":"1. Sign in to Amazon Ads data manager"},"path":"/en-us/guides/ads-data-manager/get-started","content":[" Navigate to advertising.amazon.com and select Ads Data Manager from the navigation menu.\n"],"documentType":"guide"},{"title":"Get started with Amazon Ads Data Manager","sectionHeader":{"type":3,"text":"2. Connect a data source"},"path":"/en-us/guides/ads-data-manager/get-started","content":[" Choose the method that matches your setup:\n","|If you have...|Do this|\n","\\|-\\|-\\|\n","|A website|Install the Amazon Ad Tag (AAT) snippet in your &lt;head> tag|\n","|A server-side application|Set up Events API credentials and integrate the endpoint|\n","|A mobile app with a Mobile Measurement Partner|Register your app under Mobile Measurement Partner App Integration|\n","|A Customer Data Platform or CRM|Browse the connector catalog and authenticate a connection|\n"," See Data sources and connections for detailed instructions on each method.\n"],"documentType":"guide"},{"title":"Get started with Amazon Ads Data Manager","sectionHeader":{"type":3,"text":"3. Create a dataset"},"path":"/en-us/guides/ads-data-manager/get-started","content":[" Depending on the path you selected, a dataset may be created automatically:\n","Amazon Ad Tag and Mobile Measurement Partner integrations auto-create an EVENT dataset when configured.  Events API creates a dataset automatically when you send your first event with a new dataset name.  Console UI file upload and Customer Data Platform connectors prompt you to create or select a dataset during setup.\n"," For manual dataset creation:\n","Navigate to Ads data manager > Datasets > Upload dataset. 2. Select the dataset type (AUDIENCE or EVENT). 3. Enter a name, choose a schema, and set the Country Code. 4. Review and create.\n"," See Datasets for schema details and API creation options.\n"],"documentType":"guide"},{"title":"Get started with Amazon Ads Data Manager","sectionHeader":{"type":3,"text":"4. Create a destination"},"path":"/en-us/guides/ads-data-manager/get-started","content":["Select your dataset and click Create Destination. 2. Choose the application: DSP, AMC, or Off Amazon attribution. 3. Configure destination-specific settings and activate.\n"," See Destinations and data sharing for full configuration guidance.\n"],"documentType":"guide"},{"title":"Get started with Amazon Ads Data Manager","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/ads-data-manager/get-started","content":[],"documentType":"guide"},{"title":"Account setup","sectionHeader":null,"path":"/en-us/guides/ads-data-manager/account-setup","content":[" This guide explains the Manager Account and Advertiser Account hierarchy in Amazon Ads, including how account structure enables centralized data onboarding and cross-account sharing in Amazon Ads data manager.\n"],"documentType":"guide"},{"title":"Account setup","sectionHeader":{"type":2,"text":"Manager Account (MA)"},"path":"/en-us/guides/ads-data-manager/account-setup","content":[" The Manager Account is the top-level entity in Amazon Ads, and a grouping mechanism for large advertisers, agencies, agency holdcos, or stand-alone accounts to centralize data onboarding. It may own and manage one or more Advertiser Accounts and also provides centralized control over billing, user management, and reporting roll ups. Using a Manager Account with Ads data manager allows uploading to a central account and sharing data access with children advertiser accounts or linked accounts set up through the Manager Account hierarchy. Agencies and large organizations typically operate through an MA to manage campaigns and data on behalf of multiple brands.\n"],"documentType":"guide"},{"title":"Account setup","sectionHeader":{"type":3,"text":"Account hierarchy (MA → AA)"},"path":"/en-us/guides/ads-data-manager/account-setup","content":["A Manager Account can own multiple Advertiser Accounts.  Destinations can share datasets across Advertiser Accounts under the same Manager Account.  This structure enables brand-agency workflows: an agency (MA) manages data and campaigns for multiple brands (AAs), while each brand retains control over its own datasets and sharing permissions. \\* Advertiser accounts have a primary manager account, but can be linked for secondary access with data_sharing permissions with another Manager Account to receive shared datasets.\n"," For Account hierarchies with multiple manager accounts in a parent-child relationship, data sharing links do not cascade and are not inherited. Data sharing links will only provide data access when a manager account is directly linked to an advertiser account with the data sharing permission through Account access and settings > Manager accounts > Account permission.\n"],"documentType":"guide"},{"title":"Account setup","sectionHeader":{"type":3,"text":"User permissions and access controls"},"path":"/en-us/guides/ads-data-manager/account-setup","content":[" Users at any account require Admin, Edit, or View permissions to access Amazon Ads Data Manager. Each account serves as an isolated boundary for data access for users with the appropriate permissions.\n","Isolated data environments — Create separate environments for different use cases, teams, or clients.  End-to-end encryption — Data is encrypted in transit and at rest.  Role-based access — Assign users to specific Advertiser Accounts with defined permissions.\n"],"documentType":"guide"},{"title":"Account setup","sectionHeader":{"type":2,"text":"Advertiser Account (AA)"},"path":"/en-us/guides/ads-data-manager/account-setup","content":[],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":null,"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" This guide covers all supported methods for bringing your first-party data into Amazon Ads Data Manager, including Amazon Ad Tag, Events API, Mobile Measurement Partner integrations, Audience API, and partner connectors.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" Before connecting a data source, ensure you have:\n","An Amazon Ads Account (create one)\n","Ads data manager Terms of Service accepted (prompted on first login)\n","For AAT: a website where you can edit the &lt;head> tag\n","For Events API: a server-side application that can make HTTPS POST requests\n","For Mobile Measurement Partner: a mobile app integrated with a supported mobile measurement partner\n","For Out-of-the-box integrations : account with one of the supported Customer Data Platforms (CDPs), Data Providers, Tag Managers etc.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":2,"text":"Supported data sources"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"No-code vs. developer"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":["|Path|Tools|Best for|\n","\\|-\\|-\\|-\\|\n","|No-code|Out-of-the-box connectors acorss CDPs, Data providers, Tag Managers, Console UI file upload |Marketers without developer access|\n","|Developer| AAT JavaScript, Google Tag Manager templates, Events API, Audience API and Ads data manager APIs|Engineers and technical teams|\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":2,"text":"Amazon Ad Tag (AAT)"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" The Amazon Ad Tag (AAT) is a JavaScript pixel that captures website events and streams them to Amazon Ads Data Manager. When you create an AdTag, Ads data manager automatically provisions an EVENT dataset to receive the tag's data.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Amazon Ad Tag properties"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":["|Field|Description|\n","\\|-\\|-\\|\n","|tagId|System-generated unique identifier|\n","|dataSetName|The EVENT dataset auto-created for this tag|\n","|tagCode|The JavaScript snippet to embed on your website|\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Tag installation"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" Add the AAT snippet to the &lt;head> tag of every page where you want to track events. The snippet is available in the Amazon Ads Console under Ads data manager > Data Ingestion > ADTags.\n"," Place the tag as high in the &lt;head> as possible to ensure it loads before user interactions occur.\n"," What the base code does:\n","Loads the amzn.js library asynchronously\n","Creates a placeholder function that queues calls made before the library finishes loading\n","Registers the advertiser Tag ID\n","Fires the initial PageView event on every page load\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Measurement token (click attribution)"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" When a user clicks an Amazon ad, a measurement token is appended to the clickthrough URL as the aref query parameter. This token enables deterministic click-to-conversion attribution without relying on third-party cookies.\n"," How it works:\n","User clicks an Amazon ad. The clickthrough URL includes an aref parameter (e.g., www.yoursite.com?aref=9zgYAalEPJ). 2. AAT detects the aref parameter on page load and stores the token in a first-party cookie (amznAref). 3. The cookie persists for 30 days. All subsequent AAT events include the stored token(s). 4. Amazon Ads uses the token to attribute conversions back to the originating ad click.\n"," What the token contains:\n"," The measurement token is a 10-character alphanumeric identifier associated with the ad group, creative, and ad server source. It is not a user identifier and does not contain personal information.\n"," Key details:\n","Cookie name: amznAref - Cookie duration: 30 days - Multiple tokens: If a user clicks multiple ads within 30 days, all tokens are stored and sent with events. The most recent tokens are prioritized. - No setup required: If AAT is installed on your landing pages, measurement token capture works automatically. - Privacy: The token does not contain or transmit personal data. It works independently of third-party cookies.\n"," Requirements:\n","AAT must be installed on the landing page linked from the ad creative. - AAT must fire at least one event on the landing page to capture the token. - If you use server-side AAT (via GTM server container), you must forward the aref parameter from the client-side URL to the server-side tag.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Event tracking"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" AAT captures events using the amzn(\"trackEvent\", EVENT_NAME, ATTRIBUTES) function. Use the standard event names below to trigger automatic Conversion Definition creation — no manual setup required.\n"," Amazon Ad Tag events allow you to capture actions users take on your website in a privacy-safe manner. Amazon DSP organizes this information as events (e.g. purchases), attributes (e.g. purchase value), and event timestamps, and makes this aggregated information available for optimization, attribution and reporting, and audience creation.\n","|#|Event name|Code|Fires when|\n","\\|-\\|-\\|-\\|-\\|\n","|1|PageView|amzn(\"trackEvent\", \"PageView\")|Automatically on every page load|\n","|2|Off-AmazonPurchases|amzn(\"trackEvent\", \"Off-AmazonPurchases\", {value, currencyCode, unitsSold})|Transaction completed|\n","|3|AddToShoppingCart|amzn(\"trackEvent\", \"AddToShoppingCart\", {value, currencyCode})|Item added to cart|\n","|4|Checkout|amzn(\"trackEvent\", \"Checkout\", {value, currencyCode})|Checkout initiated|\n","|5|Lead|amzn(\"trackEvent\", \"Lead\", {lead_source})|Lead form submitted|\n","|6|Signup|amzn(\"trackEvent\", \"Signup\")|User account created|\n","|7|Subscribe|amzn(\"trackEvent\", \"Subscribe\", {value, currencyCode})|Subscription initiated|\n","|8|Contact|amzn(\"trackEvent\", \"Contact\")|Contact form submitted|\n","|9|Search|amzn(\"trackEvent\", \"Search\", {attr1: searchTerm})|Site search performed|\n","|10|Application|amzn(\"trackEvent\", \"Application\")|Application submitted|\n"," With attribute-based reporting, you can send up to 13 optional attributes along with your events via AAT to access comprehensive attribute-level reporting and audience creation in Amazon Marketing Cloud (AMC). Sending attributes with AAT unlocks granular reporting, audience creation, and enhanced insights into campaign performance.\n"," See below for a list of accepted attribute values:\n","|Attribute|Data type|Description|Format|Example|\n","\\|-\\|-\\|-\\|-\\|-\\|\n","|brand|string|Brand of the advertiser or product|Minimum length: 1; Maximum length: 256; No special characters allowed|\"TechNova\"|\n","|category|string|Category of the page or product|Minimum length: 1; Maximum length: 256; No special characters allowed|\"Electronics\"|\n","|productId|string|Product IDs associated with the event, such as SKUs|Minimum length: 1; Maximum length: 256; No special characters allowed|\"TN-SP5000-BLK\"|\n","|attr1 - attr10|string|10 sequentially numbered attributes that can be used to provide additional context for the tracking tag|Minimum length: 1; Maximum length: 256; No special characters allowed|attr1: \"Smartphone\" attr2: \"5G\" attr3: \"Black\"|\n","|value|double|The value of the event|Minimum: 0; Maximum: 9999999999999; Up to 2 decimal points; Must be a multiple of 0.01|99.99|\n","|unitsSold|integer|The number of items purchased|Minimum: 1; Maximum: 9999999999999|2|\n","|currencyCode|string|The currency code associated with the 'value' of the event in ISO-4217 format|Must be a valid ISO-4217 currency code|\"USD\"|\n"," Additional considerations:\n","For the value attribute:- When used with the OFF_AMAZON_PURCHASES conversion type, it represents a monetary value.\n","The unitsSold attribute is only applicable for OFF_AMAZON_PURCHASES conversion type. If not provided, a default of 1 will be applied.\n","The currencyCode attribute is applicable only for OFF_AMAZON_PURCHASES conversion type. If not provided, the currencyCode setting on the conversion definition will be used.\n","For all string attributes (brand, category, productId, attr1-attr10), ensure that no special characters are in use and that the length is within the specified range.\n"," Method 1 — Page load events (confirmation pages):\n"," Method 2 — Inline (simple interactions):\n"," Method 3 — Event listeners (button clicks, dynamic data):\n","Use standard events for common actions — they are recognized across platforms and simplify partner data sharing.\n","Use consistent naming conventions (site name, page path, or descriptive conversion name) for custom events and attributes.\n","For purchase events, pass value and unitsSold to enable ROAS reporting.\n","Track events at multiple funnel stages (add to cart, checkout, purchase) to build audiences, enable optimization, and improve attribution at each step.\n","Limit attributes per event. More than 20 attributes on a single event indicates over-instrumentation.\n","Event and attribute names: max 256 characters. Do not use special characters: ! @ # $ % ^ & \\* | + = ( ) { } \\[ ] &lt; > ? \\\\ / ~ ;\n"," Amazon Ad Tag supports the use of your customers' hashed email address and/or phone number as an alternative ad-identifier to the standard browser cookie.\n"," Direct implementation:\n"," With the tag base code added to the page, include hashed email as an alternative ad-identifier using the amzn(\"setUserData\", ...) method. Add it in the &lt;head> if you have access to customer emails at page load, or inline if emails are collected on the page.\n","When sending from an EU or UK region, GDPR information is mandatory.\n","Token TTL must not exceed 7 days (604800 seconds).\n","Phone numbers: include country code, no text, symbols, spaces, or leading/trailing spaces.\n","Email addresses: lowercase, no leading or trailing spaces.\n"," To delete the token:\n"," The setUserData method stores hashed emails in a cookie named aatToken. To remove it:\n"," Via Google Tag Manager:\n","In GTM, open the Amazon Advertising Tag template (see GTM integration above).\n","Enable the Advanced Matching for User Data checkbox.\n","Input email and phone number in hashed (SHA-256) or raw format.\n","If a raw identifier is passed, the tag automatically hashes before sending to Amazon.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"GTM integration"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" If you use Google Tag Manager (GTM), you can deploy AAT using the official template:\n","In GTM, go to Templates > Tag Templates > Search Gallery.\n","Search for \"Amazon Advertising Tag\" and add the template by amzn.\n","In your workspace, create a new tag using the Amazon Advertising Tag template.\n","Configure your Tag ID, region, events, and attributes per the template fields.\n","Set triggers (e.g., All Pages for PageView, custom triggers for conversion events).\n","Preview in GTM debug mode, then publish.\n"," Once configured, the Amazon Ad Tag Helper Chrome Extension will display your GTM container ID alongside fired events for validation.\n"," GTM consent pass-through:\n"," To send Country Code and Consent Signal via GTM, activate the Amazon Consent section within the AAT template. The flow:\n","Your website CMP (e.g., OneTrust, Cookiebot) collects user consent.\n","The CMP pushes the consent decision to the GTM Data Layer.\n","In GTM Web Container, create a Data Layer Variable named \"consent\" that captures this value.\n","Map a  {{consent}} variable to both Amazon Ad Storage and Amazon User Data in the Amazon Ad Tag configuration.\n"," To find a feature overview and implementation guide for Amazon Ad Tag via Google Tag Manager, refer to the official AAT GTM GitHub repository.\n"," Server-side GTM:\n"," A separate template — \"Amazon Advertising Tag - Server Side\" — routes events through a GTM Server Container before forwarding to Amazon. This gives more control over data and resilience against ad blockers. No javascript implementation is needed for server-side implementation. Amazon's server-side templates in GTM also support Country Code and Consent Signal pass-through.\n"," To find a feature overview and implementation guide on how to implement Server-Side Amazon Ad Tag via Google Tag Manager, refer to the Server-Side AAT GTM GitHub repository.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Other tag managers"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":["Tealium: Use the Amazon Ad tag template within the Tealium library. See Tealium documentation.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Country code and consent requirements"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" Country code is mandatory for all AAT signals regardless of user location. Include a countryCode field in the AAT payload as a two-letter ISO 3166 code in uppercase (e.g., US, GB, FR, JP). Data sent without a country code will not be processed.\n"," Consent signal is additionally required for the EEA and UK. Provide one of:\n","TCF (IAB Transparency and Consent Framework) — recommended\n","GPP (Global Privacy Platform)\n","ACS (Amazon Consent Signal)\n"," If multiple signals are provided, Amazon Ads uses TCF and ignores ACS.\n"," Load the Amazon Consent library (amzn-consent.js) before the AAT script (amzn.js):\n"," When the consent script loads, all settings default to DENIED until the user interacts with the CMP and consent is updated via amznConsent.\n"," Example 1 — US (no consent signal required):\n"," Resulting payload:\n"," Example 2 — Canada (ACS provided):\n"," Resulting payload:\n"," Example 3 — France (TCF from CMP):\n"," Resulting payload:\n"," Example 4 — UK (GPP from CMP):\n"," Resulting payload:\n"," Example 5 — UK (ACS without CMP):\n"," Resulting payload:\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Verifying your implementation"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" Use the Amazon Ad Tag Helper Chrome extension to confirm your installation is correct and events are firing.\n","Install the extension from the Chrome Web Store.\n","Navigate to your website.\n","Open the extension panel — it displays:\n","Tag ID and loading status\n","Each event as it fires (name + attributes)\n","GTM container ID (if deployed via GTM)\n","Confirms measurement token capture\n","|Symptom|Cause|Fix|\n","\\|-\\|-\\|-\\|\n","|No activity in panel|Tag not loading|Verify snippet is in &lt;head> and not blocked by ad blockers|\n","|Events not firing|amzn(\"trackEvent\", ...) not called|Check event code placement and trigger timing|\n","|Attributes empty|Values undefined at call time|Ensure data is populated before the tracking call|\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Verify your first event"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" After installing the tag:\n","Load your website page with the AAT snippet.\n","Open the AAT Helper Chrome extension.\n","Confirm PageView appears in the extension panel.\n","Click through your site to trigger additional events (e.g., add to cart) and confirm they appear.\n"," If no events appear: verify the snippet is in &lt;head>, check for ad blockers, and confirm amzn.js is not blocked by your Content Security Policy.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Monitoring AAT events"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" After your first event fires, the Amazon Ad tag events tab displays the following metrics:\n","|Column|Description|\n","\\|-\\|-\\|\n","|Status|Active if receiving traffic; Inactive if no recent traffic (inactive events are not deleted)|\n","|Event|The event name being tracked (e.g., \"AddToCart\", \"Purchase\"). Up to 300 events shown, sorted by last activity|\n","|Event count|Number of times the event fired within the selected timeframe (not deduped per user)|\n","|Last activity|Date of the most recent event captured|\n"," You can filter metrics by day, week, month, custom timeframe, or all time. Event traffic data and reporting dates are shown in UTC.\n"," Available actions from the events table:\n","Create audience — Build an audience from AAT event data, based on events, attributes, and a look-back window. After creation, add the audience to your campaign ad group using the audience picker. Activate audiences when the privacy threshold of minimum unique users is met.\n","Create conversion — Create a Conversion Definition for tracking and reporting in Amazon DSP and Amazon Marketing Cloud.\n"," Monitor event health proactively — look for low event firing rates or discrepancies, which could indicate changes in campaign activity, incomplete setup, or implementation issues. Change date windows to check traffic trends.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":2,"text":"Events API "},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" The Events API lets you send conversion events from your server directly to Amazon Ads. Use it for offline conversions, server-side event processing, or as a redundant signal alongside AAT.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"How Events API events are processed"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" When you send events via the Events API (POST /adsApi/v1/create/events), Amazon Ads processes them and creates Conversion Definitions automatically based on the eventDescription fields. Events may take up to two hours to appear in your account. You can verify delivery in the Amazon Ads Console under Off Amazon attribution > Conversions.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Why use Events API "},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":["No client-side dependency: No JavaScript required. Works when cookies are blocked or ad blockers are active.\n","Reduced data loss: Server-side data is not subject to browser-based signal loss (page unloads, network drops).\n","Offline conversions: Send events that occur outside the browser — call center purchases, in-store transactions, subscription renewals.\n","Custom user attributes: Send server-side information such as lifetime value (LTV), loyalty tier, or subscription status.\n","Richer identity signals: Events API accepts hashed email, phone, address, postal code, and customer IDs, which improve match rates over cookies alone.\n","More Consistent Attribution: By sharing events from the server, advertisers can improve attribution consistency across devices, sessions, and platforms. This helps Amazon better connect customer actions to ad interactions, especially when users switch devices or interact with a brand through multiple channels.\n","Reduced Exposure to Certain Tracking Manipulation Risks: Because server-side events are sent from the advertiser’s server or trusted backend systems, they can be less vulnerable to some forms of client-side manipulation or tracking disruption. This can improve the integrity of conversion signals used for reporting and optimization.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"When to use Events API vs. ADTags"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":["|Scenario|Recommended method|\n","\\|-\\|-\\|\n","|Standard website conversion tracking|ADTags|\n","|Server-side event processing|Events API|\n","|Offline or in-store conversions|Events API|\n","|Ad-blocker-heavy traffic|Events API|\n","|Redundant backup for browser events|ADTags + Events API together|\n","|Quick setup without backend development|ADTags|\n"," You can use ADTags and Events API simultaneously.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Event de-duplication"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" Use event deduplication to prevent double-counting when you send the same conversion through both Amazon Ad Tag (AAT) and the Events API.\n"," When you run AAT and Events API together, both can report the same user action — for example, a purchase tracked by the tag in the browser and by your server through the API. By default, Amazon counts these as two separate conversions.\n"," To tell Amazon these are the same event, pass a unique identifier called clientDedupeId in both your AAT tag and eventId in your Events API request. Amazon matches the values and counts only one conversion.\n"," Use clientDedupeId (AAT) / eventId (Events API) when:\n","You send the same event types through both AAT and Events API.\n","You want accurate conversion totals and ROAS in your reports for conversions with currency values.\n","You use Events API as a backup for events that AAT may miss due to browser restrictions.\n"," You do not need clientDedupeId / eventId if you are tracking actions that are not prone to duplicate firing (e.g., detail page views triggered once per load).\n"," Amazon Ads deduplicates off-Amazon conversions in 3 ways:\n","Timestamp filtering. When multiple events from the same user for the same conversion (including event attributes) arrive within a 200ms window, only the first event is retained.\n","Deduplication filtering. When Amazon detects two conversions sharing the same clientDedupeId / eventId, the first (by publication timestamp) is retained. If timestamps match, tie-breaking order is:\n","Events API\n","Amazon Ad Tag\n","Mobile Measurement Partner\n","Count method filtering. If a conversion's count method is set to \"FIRST\", only 1 conversion from the same user within a 24-hour period is counted. Subsequent events are dropped.\n"," Add clientDedupeId as a parameter when firing an event:\n"," Pass the same value to your server so it can be included in the corresponding Events API request.\n"," In the Events API payload, use the eventId field with the same value:\n"," Currently, eventId serves as the deduplication ID across sources.\n","Maximum length: 256 characters.\n","Unique per event: Each distinct user action must have its own clientDedupeId or eventId Do not share one ID across multiple events.\n","90-day window: Once Amazon receives an event with a given clientDedupeId or eventId, it will reject any subsequent event with the same ID for 90 days.\n","Match exactly: The value in your AAT tag must exactly match the eventId value in your Events API request.\n"," If you use GTM with the Amazon Advertising Tag template:\n","Create a Custom JavaScript variable that returns your deduplication ID.\n","In your Amazon Advertising Tag trigger, add clientDedupeId as a custom parameter.\n","Set its value to your Custom JavaScript variable.\n","Go to Off Amazon attribution → Conversions in Amazon DSP.\n","Check the Excluded events column.\n","Events excluded due to deduplication confirm that duplicate signals are being correctly discarded.\n"," If you see no excluded events after implementing, the IDs are not matching. Verify the same value is reaching both your AAT tag and your Events API request.\n"," What happens if I don't pass a deduplication ID? Amazon assigns a random ID to each event automatically. Events sent through AAT and Events API will have different IDs and will both be counted.\n"," Can I use the same deduplication ID I pass to other platforms? Yes. If you already generate a deduplication ID for other ad platforms (e.g., event_id for Meta), you can pass the same value as clientDedupeId. No format conversion is needed.\n"," Is clientDedupeId the same as the uuid field in the tag? No. The uuid field is auto-generated by the Amazon Ad Tag for internal purposes. It is not advertiser-controlled and does not perform cross-source deduplication.\n"," Does deduplication work across event types? The deduplication ID is matched regardless of event type. A clientDedupeId used on a PageView event will block any other event with the same ID. Always use a unique ID per individual event.\n"," For full details, see Deduplication of off-Amazon conversions.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Events API  event payload reference"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" Each Events API request contains 1–500 events. Required fields:\n","|Field|Type|Description|Required|\n","\\|-\\|-\\|-\\|-\\|\n","|eventDescription.name|String|Event name (e.g., \"Purchase_Complete\")|Yes|\n","|eventDescription.conversionType|String|Standard type (e.g., OFF_AMAZON_PURCHASES)|Yes|\n","|eventDescription.eventSource|String|WEBSITE, ANDROID, IOS, FIRE_TV, OFFLINE, MEASUREMENT_ATTRIBUTION_PARTNER|Yes|\n","|eventDescription.eventIngestionMethod|String|Set to SERVER_TO_SERVER|Yes|\n","|eventDescription.dataSetName|String|Target EVENT dataset name|No|\n","|eventTime|String|ISO-8601 timestamp. Max 21 days before send; older data is not processed|Yes|\n","|matchKeys|Array|User identifiers (EMAIL, PHONE, MAID, etc.). Must be SHA-256 hashed except MAID, RAMP_ID, MATCH_ID|Yes|\n","|countryCode|String|ISO 3166-1 alpha-2 (e.g., US, GB). Required for all events|Yes|\n","|value|Number|Event value. For OFF_AMAZON_PURCHASES: monetary. For others: non-monetary scale. Max 2 decimal points|No|\n","|currencyCode|String|ISO 4217 (e.g., USD, EUR). Only for OFF_AMAZON_PURCHASES|No|\n","|unitsSold|Integer|Items purchased. Only for OFF_AMAZON_PURCHASES. Defaults to 1|No|\n","|eventId|String|Deduplication ID. Max 256 chars|No|\n","|consent|Object|TCF string or ACS signals. Required for UK/EEA users|Conditional|\n","|customData|Array|Custom attributes (name, dataType, value)|No|\n"," For the full API specification, see the Events API documentation.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":2,"text":"Mobile Measurement Partner app integration"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":[" The AppRegistration is a core concept in Ads data manager. When you register a mobile app with a Mobile Measurement Partner, Ads data manager automatically provisions an EVENT dataset to receive events. Events arrive via server-to-server integration from the Mobile Measurement Partner.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Mobile Measurement Partner registration properties"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":["|Field|Description|\n","\\|-\\|-\\|\n","|mmpAppId|System-generated unique identifier|\n","|dataSetName|The EVENT dataset auto-created for this registration|\n","|mmpName|Partner: ADJUST, AIRBRIDGE, APPSFLYER, BRANCH, KOCHAVA, SINGULAR, or TENJIN|\n","|appName|Display name of the mobile app|\n","|bundleId|App store bundle identifier (e.g., com.example.myapp)|\n","|platform|ANDROID, IOS, or FIRE_OS|\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"How it works"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":["Your mobile app sends events to the Mobile Measurement Partner SDK as usual.\n","The Mobile Measurement Partner forwards event data to Ads data manager as Records — structured payloads containing event name, timestamp, mobile advertising IDs (ADID/IDFA/Fire ADID), and custom attributes.\n","Each batch is tracked by an Ingestion entity with its own ingressId for status monitoring.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Supported MMPs"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":["Adjust\n","Airbridge\n","AppsFlyer\n","Branch\n","Kochava\n","Singular\n","Tenjin\n"," Contact your Amazon Ads account team if your Mobile Measurement Partner is not listed.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Setup"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":["In the Amazon Ads Console, go to Ads data manager > Data Ingestion > Mobile Measurement Partner App Integration.\n","Select your Mobile Measurement Partner from the list.\n","Follow the Mobile Measurement Partner-specific configuration steps to authorize data sharing with Ads data manager.\n","Map Mobile Measurement Partner event names to Ads data manager event names.\n","Verify data flow using the ingestion monitor.\n"],"documentType":"guide"},{"title":"Data sources and connections","sectionHeader":{"type":3,"text":"Migration from legacy Mobile Measurement Partner integration"},"path":"/en-us/guides/ads-data-manager/data-sources-and-connections","content":["Audit existing events. Document all events and attributes currently flowing through the legacy integration.\n","Create the corresponding dataset in Ads data manager (see Datasets).\n","Configure the new Mobile Measurement Partner integration in Ads data manager.\n","Run both integrations in parallel for a validation period to confirm data parity.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":null,"path":"/en-us/guides/ads-data-manager/datasets","content":[" This guide explains how datasets work in Amazon Ads data manager — including dataset types, schemas, creation methods, and lifecycle management.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":2,"text":"What are datasets?"},"path":"/en-us/guides/ads-data-manager/datasets","content":[" A Dataset is a core concept in Amazon Ads data manager — a dataset is a container for data and used to represent all of the records (customers, events, or uploaded rows) from a given data onboarding source. Each dataset represents your first-party data with a defined schema, source, and country code used for consent purposes.\n"," Once created, a dataset can be activated to one or multiple Amazon Ads products via Destinations (see Destinations and data sharing). Activating a dataset to a destination requires the dataset to have the correct type, or schema attributes. You ingest data into a dataset, share access or delete datasets, and activate datasets.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Dataset properties"},"path":"/en-us/guides/ads-data-manager/datasets","content":["|Field|Description|\n","\\|-\\|-\\|\n","|dataSetName|Unique dataset identifier (human-readable, 5-100 characters)|\n","|dataSetType|AUDIENCE or EVENT|\n","|dataSetSource|How it was created: API, AD_TAG, MOBILE_MEASUREMENT_PARTNER, EVENTS_API, CONNECTOR|\n","|countryCode|ISO 3166-1 alpha-2 (e.g., US, GB, DE) — required, immutable after creation|\n","|schema|Column definitions (1-100 DataSetColumn entries)|\n","|ttl|Time-to-live in seconds (0 to 13 months). If unset, retained indefinitely within max period|\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":2,"text":"Dataset schemas"},"path":"/en-us/guides/ads-data-manager/datasets","content":[],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Standard schemas"},"path":"/en-us/guides/ads-data-manager/datasets","content":[" Ads data manager provides pre-defined schema templates for common data types.\n"," AUDIENCE schema identifiers:\n","Hashed email (EMAIL, SHA-256)  Hashed phone (PHONE, SHA-256, E.164 format)  Hashed first and last name (FIRST_NAME LAST_NAME, SHA-256)  Hashed address (ADDRESS CITY STATE POSTAL, SHA-256, Address normalized based on local standards, e.g. USPS)  Device identifiers (MAID, Mobile Advertising ID)  Identity onboarders (EXPERIAN_ID, REAL_ID, TRANSUNION_ID, RAMP_ID, etc.)  Other identifiers (MATCH_ID)\n"," EVENT schema identifiers:\n","Hashed email (EMAIL, SHA-256)  Hashed phone (PHONE, SHA-256, E.164 format)  Hashed first and last name (FIRST_NAME, LAST_NAME, SHA-256)  Hashed address (ADDRESS, CITY, STATE, POSTAL, SHA-256)  Device identifiers (MAID, Mobile Advertising ID)  External identifiers (RAMP_ID, REAL_ID, MERKLE_ID, KANTAR_ID)  Other identifiers (MATCH_ID)\n"," Standard schemas also allow for custom attributes to be appended (up to 50 custom columns).\n","|Type|Description|Examples|Schema|\n","\\|-\\|-\\|-\\|-\\|\n","|AUDIENCE|Customer lists for remarketing, suppression, or as look-a-like audience seeds|CRM lists, website visitors, loyalty members|Pre-defined audience schema (hashed PII + custom attributes)|\n","|EVENT|Conversion events for measurement|Purchases, sign-ups, leads, page views|Pre-defined event schema (conversionType, eventTime, identity, eventData)|\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"AUDIENCE datasets"},"path":"/en-us/guides/ads-data-manager/datasets","content":[" Use the pre-defined audience schema with standard properties (hashed email, phone, device IDs) and up to 50 custom attribute columns. Create via the Audience API shortcut or the generic DataSet API. The audience schema supports a CREATE or DELETE action field to control audience membership on incremental uploads. The action field appends a record to a dataset. If action is omitted, records are treated as additive (CREATE by default).\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"EVENT datasets"},"path":"/en-us/guides/ads-data-manager/datasets","content":[" Auto-created by AdTag or AppRegistration entities, or created automatically when using the Events API (/events) ingestion. Each event record includes conversionType, eventTime, userIdentity, and optional eventData (value, currency, unitsSold).\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Country code (CC)"},"path":"/en-us/guides/ads-data-manager/datasets","content":[" Every dataset requires a Country Code indicating the geographic region in which the data was collected for use in local privacy logic and evaluating consent basis for the data. This field is required for privacy compliance and determines which regional data processing rules apply. Set during dataset creation. Setting countryCode at the individual record level overrides this setting. For global datasets, use a Country Code value of ZZ for unknown.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":2,"text":"Creating datasets"},"path":"/en-us/guides/ads-data-manager/datasets","content":[],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Via the Amazon Ads Console"},"path":"/en-us/guides/ads-data-manager/datasets","content":["Navigate to Data manager > Datasets > Upload dataset. 2. Select the dataset type (AUDIENCE or EVENT). 3. Enter a dataset name and description. 4. Choose a schema — select a standard template. 5. Set the Country Code. 6. Review and create.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Via the DataSet API"},"path":"/en-us/guides/ads-data-manager/datasets","content":[" You can also create datasets programmatically via the DataSet API. Specify the dataset name, type, country code, and schema fields in your request.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Via the Audience API"},"path":"/en-us/guides/ads-data-manager/datasets","content":[" You can directly create an audience dataset using Audiences API. This creates a audience-type datasets with the standard audience schema pre-applied. You only need to specify the dataset name, country code, and any custom attribute columns — the schema automatically includes all standard identity columns (hashed email, phone, first/last name, address, device IDs, and third-party identifiers listed in the AUDIENCE schema above).\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":2,"text":"Managing datasets"},"path":"/en-us/guides/ads-data-manager/datasets","content":["Upload status & statistics — View upload history, record counts, and timestamps from the dataset detail page.  Dataset metrics — Monitor total records, records matched, records accepted or rejected.  Match rate — Calculated as Records Resolved / Total Records. This is row-based, not distinct users. If the same user appears in multiple rows, each row is counted independently.  Processing time — 100,000 records are processed, stored, and distributed within 6 hours.  Lifecycle — Active datasets are available for ingestion and sharing. Stale datasets (no new data for an extended period) may be flagged for review. Data within datasets will expire after 13 months (maximum storage limit in data manager). Refresh audience datasets regularly (daily or weekly) for targeting accuracy.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":3,"text":"Deleting dataset members"},"path":"/en-us/guides/ads-data-manager/datasets","content":[" Remove a member from an audience dataset: Upload a record with action: DELETE and the same identity fields (hashed email, phone, etc.) used when the member was added. The member is removed from the audience on the next processing cycle.\n"," Delete user data for GDPR compliance (right to erasure): Use the Identity Deletion API. This removes the user's data across all datasets in the account. Available via API only (not the UI).\n"," Delete an entire dataset: Permanent and irreversible. All records, upload history, and destinations are removed. Available via the UI or API. After initiating dataset deletion - the dataset will be immediately unavailable and all underlying data stored within the dataset will be purged within 30 days.\n"],"documentType":"guide"},{"title":"Datasets","sectionHeader":{"type":2,"text":"Improving match rates"},"path":"/en-us/guides/ads-data-manager/datasets","content":[" Include as many hashed identifiers as possible per record to improve match rates. Supported identifiers:\n","Hashed email (SHA-256, normalized lowercase)  Hashed phone (SHA-256, E.164 format)  Hashed first name + last name  Hashed address + city + state + postal code  Device IDs (MAID — IDFA, GAID, Fire ADID) \\* External identity providers (RAMP_ID, EXPERIAN_ID, TRANSUNION_ID, MATCH_ID)\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":null,"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" This guide explains how to configure destinations to activate your datasets across Amazon Ads use-cases, manage cross-account data sharing, build audiences, set up conversion measurement, and integrate with Amazon Marketing Cloud.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":2,"text":"Destination sharing"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"What are destinations?"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" A destination (also called a sharing rule in the API) is a configuration in Amazon Ads data manager that defines where a dataset's data is accessible for use within Amazon Ads. Activating a dataset within a destination use-case does not allow record-grained access to that dataset, but rather allows the destination application to utilize your dataset for the intended purpose. Destinations determine both the application that can use the data, and if using within a Manager Account, the data sharing flows to make a dataset available in a child or linked Advertiser Account. Without a destination, your data stays in Ads data manager but isn't eligible for activation or measurement analysis anywhere.\n"," Multiple destinations can reference the same dataset — upload once, activate across multiple use-cases.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Activation SLAs"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":["|Destination|Time to activate|\n","\\|-\\|-\\|\n","|DSP Audiences|36 hours after upload (initial sync); incremental records within 1 hour|\n","|Events attribution (Off Amazon attribution)|Within 4 hours in conversion statistics; reports available 1 week after event timestamp|\n","|AMC|Within 2 hours of upload (immediate if upload was processed before sharing)|\n"," Minimum audience size: DSP requires at least 2,000 matched audience members before an audience becomes active for campaign use.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Destination properties"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":["|Field|Description|\n","\\|-\\|-\\|\n","|destinationId|System-generated unique ID|\n","|dataSetName|The source dataset|\n","|destinationAccountId|The DSP Advertiser Account or AMC Instance receiving the data|\n","|marketplaceId|Regional data routing identifier (See full list of Marketplace IDs here)|\n","|application|DSP_AUDIENCES, EVENTS_MANAGER, or AMC|\n","|status|PENDING → ACTIVE → REVOKED|\n","|revocationReason|USER, DATASET_DELETED, or SHARING_GRANT_REVOKED (when revoked)|\n","|metadata|Application-specific config (union — see below)|\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Configuring destinations"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" Each destination specifies an application and application-specific metadata:\n","|Application|Metadata|What it creates downstream|\n","\\|-\\|-\\|-\\|\n","|DSP_AUDIENCES|AudienceMetadata (audienceId, audienceName)|Creates an Audience segment in Amazon DSP|\n","|EVENTS_MANAGER|EventsMetadata (conversionDefinitionId, name)|References a ConversionDefinition for measurement|\n","|AMC|AmcMetadata (amcInstanceId, amcInstanceName)|Creates a queryable dataset in AMC|\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Destination lifecycle"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":["PENDING — created, awaiting activation  ACTIVE — data is being delivered  REVOKED — delivery stopped (by user, dataset deletion, or account link broken)\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Step-by-step"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":["Select a dataset — Navigate to Ads data manager > Datasets and choose the dataset. 2. Click \"Create Destination\" — Open the destination configuration panel. 3. Choose application — Select DSP_AUDIENCES, EVENTS_MANAGER, or AMC. 4. Configure destination-specific settings — Set audience parameters, messaging version, or AMC query access as applicable. 5. Review and activate — Confirm the configuration and activate the destination.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":2,"text":"Application destinations"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Audiences"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" Share datasets for programmatic remarketing, suppression, or look-a-like audience creation across display, video, and audio campaigns. This destination requires the dataset to have identity match fields.\n","What gets shared: Audience segments built from your dataset's matched users. \\* How it's used: Select Ads data manager audiences in DSP campaign targeting. Use for prospecting, retargeting, or suppression.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Amazon Marketing Cloud (AMC)"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" Share data for custom analytics queries within the Amazon Marketing Cloud clean room that combine your first-party data with Amazon's pseudonymized event-level data. This application can accept any schema.\n","What gets shared: Dataset records made available within your AMC instance. \\* How it's used: Write SQL queries in AMC that join your data with Amazon Ads signals for cross-channel attribution, path-to-conversion analysis, and audience insights.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Off Amazon Attribution"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" Share data for use in measurement and attribution, which will appear in standard reporting. This application also enables campaign level optimizations based on attributed event data. This destination requires a conversionType, eventName, eventSource, and identity match fields.\n","What gets shared: Events shared will be converted to Conversions that can be selected when creating Campaigns.  How it's used: Events within these Conversions are eligible for attribution and reporting.  Optimization: Datasets shared to Off-Amazon attribution with sufficient event volume and identity signals enable advanced bidding strategies (ROAS, value-based optimization).\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":2,"text":"Cross-account data sharing"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Brand ↔ Agency handoff"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" the Amazon Ads account hierarchy (Manager Account → Advertiser Account) enables seamless data sharing between brands and their agency partners. When using Amazon Ads data manager from a Manager Account, sharing is enabled to all linked accounts with the data_sharing permission, as well as with all child Advertiser Accounts created natively under the Manager Account. The data sharing feature is not available at the Advertiser Account level.\n"," How it works:\n","The brand (MA) creates datasets and uploads data in their Manager Account. 2. The agency (AA) has visibility into the brand's datasets through the Manager Account linking relationship (must include data_sharing permission). 3. The brand creates a destination that grants the agency's account access to specific datasets for a specific destination application. 4. The agency can then activate the shared data in campaigns they manage on behalf of the brand.\n"," Account sharing model:\n","|Account type|Can create datasets|Can share data|Can create destinations|Can view shared data|Can activate in campaigns|\n","\\|-\\|-\\|-\\|-\\|-\\|-\\|\n","|Manager Account|✓|✓|✓|—|—|\n","|Advertiser Account|✓|—|✓|✓|✓|\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Multi-account management (MA → AA)"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" Share datasets across multiple Advertiser Accounts under the same Manager Account:\n","A single dataset can be shared with multiple AAs via separate destinations.  Each AA sees only the data shared with it — no cross-visibility between AAs unless explicitly configured.  Useful for holding companies or agencies managing multiple brands.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":2,"text":"Audiences"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"How audiences are built"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" When you create a destination that targets Amazon DSP, Ads data manager builds an Audience from your dataset. The process:\n","Ads data manager reads the identity signals in your dataset (hashed email, phone, device IDs). 2. These signals are matched against the Amazon identity graph. 3. Matched records become Members of the audience. 4. The audience is made available in Amazon DSP for campaign targeting.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Members"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" Members are individual records within an audience that have been successfully matched to the Amazon identity graph. Key metrics:\n","Total records — number of records in your dataset.  Resolved Records — records that resolved to an Amazon identity.  Match rate — resolved records / total records (higher is better).\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Audience targeting"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" Once a destination activates an audience in DSP:\n","Open Amazon DSP and navigate to your campaign. 2. In audience targeting, Ads data manager-shared audiences appear as available segments. 3. Select the audience and apply to campaign line items. 4. Use for prospecting, retargeting, or suppression.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":2,"text":"Conversion measurement"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Conversion Definitions"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" A Conversion Definition maps a free-form event name to one of 12 standard conversion types recognized by Amazon Ads.\n"," How Conversion Definitions are created:\n","Events API and Mobile Measurement Partner: Conversion Definitions are created automatically when events arrive with a new event name + conversion type combination. No manual setup is required. \\* Amazon Ad Tag: Conversion Definitions are created manually from the auto-created Amazon Ad Tag dataset.\n"," You can view and manage all existing Conversion Definitions in Off Amazon attribution > Conversion Definitions.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Conversion events"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" A Conversion Event is an actual conversion occurrence. It is composed from:\n","Event Details — the raw event data (timestamp, identifiers, attributes). \\* Conversion Definition — the classification that determines how the event is interpreted.\n"," Conversion Events are used by Amazon DSP for attribution, optimization, and reporting.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Event details"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" Each event captured by Amazon Ad Tag or Events API includes:\n","|Field|Description|Example|\n","\\|-\\|-\\|-\\|\n","|Event name|Free-form name defined by advertiser|purchase_complete|\n","|Timestamp|When the event occurred|2026-04-26T18:30:00Z|\n","|Identity signals|Hashed email, phone, device IDs|sha256(user@example.com)|\n","|Custom attributes|Event-specific data|value: 49.99, currency: USD|\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":2,"text":"Amazon Marketing Cloud (AMC)"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"AMC details and configuration"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" When you create a destination targeting AMC, your dataset records become available as queryable tables within your AMC instance.\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Running queries with first-party data"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" Write SQL queries in AMC that join your first-party data with Amazon's pseudonymized event-level data.\n"," In the example below, we run a custom attribution analysis joining advertiser-uploaded data with DSP impression data:\n"],"documentType":"guide"},{"title":"Destinations and data sharing","sectionHeader":{"type":3,"text":"Cross-channel analytics"},"path":"/en-us/guides/ads-data-manager/destinations-and-data-sharing","content":[" Use AMC with your first-party data for:\n"],"documentType":"guide"},{"title":"API and events reference","sectionHeader":null,"path":"/en-us/guides/ads-data-manager/api-and-events-reference","content":[" This guide covers the Amazon Ads Data Manager APIs for datasets, audiences, destinations, and ingestion, as well as Conversion Definitions and the 12 standard conversion event types.\n"],"documentType":"guide"},{"title":"API and events reference","sectionHeader":{"type":2,"text":"Authentication and authorization"},"path":"/en-us/guides/ads-data-manager/api-and-events-reference","content":[" Ads data manager APIs use OAuth 2.0 for authentication. You must obtain an access token and include it as a Bearer token in all API requests.\n"," For authentication setup, scopes, and token management, refer to the Amazon Ads API authentication guide.\n"],"documentType":"guide"},{"title":"API and events reference","sectionHeader":{"type":2,"text":"DataSet APIs"},"path":"/en-us/guides/ads-data-manager/api-and-events-reference","content":[" The DataSet APIs allow you to create, list, retrieve metrics, and delete datasets programmatically. You can also upload records to existing datasets via the Audience API.\n"," All onboarding methods (Audience API and Events API) create a dataset. You need to explicitly create a dataset using Audience API whereas Events API will automatically create a dataset when you send events. The Dataset object is the central object in Amazon Ads Data Manager to view grouped data. The DataSet APIs work across datasets created from any source.\n"," Capabilities:\n","Create datasets with a defined schema, type, and country code  List and retrieve datasets by type (AUDIENCE, EVENT)  Update dataset metadata (name, description) — schema and country code are immutable after creation  Delete datasets (permanent and irreversible)  Upload records to a dataset\n"],"documentType":"guide"},{"title":"API and events reference","sectionHeader":{"type":2,"text":"Audience APIs"},"path":"/en-us/guides/ads-data-manager/api-and-events-reference","content":[" The Audience API enables you to create a audience-type dataset with the standard audience schema pre-applied. Once the audience dataset is created advertisers can upload and create targetable audience segments without manually defining schema fields.\n"," Capabilities:\n","Create audience datasets with standard identity fields (hashed email, phone, device IDs) + custom attributes \\* List and retrieve audiences\n"],"documentType":"guide"},{"title":"API and events reference","sectionHeader":{"type":2,"text":"Destinations APIs"},"path":"/en-us/guides/ads-data-manager/api-and-events-reference","content":[" The Destinations APIs (called Sharing Rules in the public API reference) let you manage data sharing programmatically — controlling where datasets are activated within Amazon Ads.\n"," When sharing from a Manager Account, destinations allow you to specify a linked Advertiser Account to share data into.\n"," Capabilities:\n","Create destinations to share a dataset with DSP, AMC, or Off-Amazon attribution  List, retrieve, update, and delete destinations  Stop data activation by deleting a destination (does not delete the underlying dataset)\n"],"documentType":"guide"},{"title":"API and events reference","sectionHeader":{"type":2,"text":"Ingestion APIs"},"path":"/en-us/guides/ads-data-manager/api-and-events-reference","content":[" The Ingestion APIs support programmatic data upload via Events API event streaming and bulk uploads.\n"," Capabilities:\n","Events API: Events API : Stream or bulk upload conversion events server-side with identity signals and custom attributes.\n"],"documentType":"guide"},{"title":"API and events reference","sectionHeader":{"type":2,"text":"Conversion Definitions"},"path":"/en-us/guides/ads-data-manager/api-and-events-reference","content":[],"documentType":"guide"},{"title":"API and events reference","sectionHeader":{"type":3,"text":"What is a CD?"},"path":"/en-us/guides/ads-data-manager/api-and-events-reference","content":[" A Conversion Definition (CD) is a logical grouping of events from a dataset. It is used to measure campaign performance and tells Amazon Ads which events are relevant to a specific campaign. It also tells the type of conversion event, how to count occurrences, and which source the event came from. A single conversion is created for events with the same Event name ('Product Added to Cart'), Conversion Type ('Add to cart') , Event Source ('WEBSITE'), Event Ingestion Method ('Website', 'Server to Server') and Dataset.\n"," Where CDs are created: A Conversion Definition is automatically created for data sent through Events API and through Mobile Measurement Partner.  For events sent through Amazon Ad Tag :  Where CDs are associated: In Amazon DSP at the Order Settings page you can associate one or more conversion definitions to an order in the \"Conversion Tracking\" widget.\n"," How CDs are used: DSP uses associated CDs for conversion attribution (reporting) and bid optimization (the bid model trains on the associated conversion events).\n"],"documentType":"guide"},{"title":"API and events reference","sectionHeader":{"type":3,"text":"Conversion Definition properties"},"path":"/en-us/guides/ads-data-manager/api-and-events-reference","content":["|Field|Description|\n","\\|-\\|-\\|\n","|conversionDefinitionId|System-generated unique ID|\n","|dataSetName|The EVENT dataset this CD filters|\n","|name|Customer-defined name (e.g., \"Website Purchases\")|\n","|conversionType|OFF_AMAZON_PURCHASES, ADD_TO_SHOPPING_CART, CHECKOUT, SEARCH, SUBSCRIBE, SIGN_UP, LEAD, CONTACT, APPLICATION, PAGE_VIEW, MOBILE_APP_FIRST_START, OTHER|\n","|source|WEBSITE, ANDROID, IOS, FIRE_TV, FIRE_TABLET, OFFLINE|\n","|sourceType|SERVER_TO_SERVER (Events API), AMAZON_AD_TAG (pixel), MOBILE_MEASUREMENT_PARTNER|\n","|countingMethod|EVERY (all events per user in the last 24h) or FIRST (first event per user in the last 24h)|\n","|value|A fixed numeric value representing the worth of a single conversion, used as a fallback when no event-level value is provided|\n"," The CD reflects the grouping of events within Amazon Ads.\n"],"documentType":"guide"},{"title":"API and events reference","sectionHeader":{"type":2,"text":"Conversion types"},"path":"/en-us/guides/ads-data-manager/api-and-events-reference","content":["|#|Conversion type|Description|Value Attribute|\n","\\|-\\| -\\|-\\|-\\|\n","|1.| Add to shopping cart|When customers add a product to their shopping cart|non-monetary|\n","|2.| Application|When customers submit an application|non-monetary|\n","|3.| Checkout|When customers go to the checkout page|non-monetary|\n","|4.| Contact|When customers provide contact information, such as email, phone number, etc.|non-monetary|\n","|5.| Lead|When customers perform an action that initiates a sales lead|non-monetary|\n","|6.| Mobile app first start|When customers launch the downloaded app for the first time|non-monetary|\n","|7.| Off-Amazon purchase|When customers make a purchase for a service or product|monetary (e.g. $4.99)|\n","|8.| Other|Customer actions that don't fit the definition of the standard conversion types|non-monetary|\n","|9.| Page View|When customers visit a page on your website|non-monetary|\n","|10.| Search|When customers perform a search for a product|non-monetary|\n","|11.| Sign-up|When customers sign up for a product or service|non-monetary|\n","|12.| Subscribe|When customers sign up for your service|non-monetary|\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":null,"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[" This section covers privacy requirements, consent implementation across all ingestion methods, data security controls, regional compliance, and identity resolution in Amazon Ads data manager. All users must accept terms of service before using Amazon Ads data manager. Furthermore, Amazon Ads data manager records user-level consent at the record level when onboarding data containing user-level details.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":2,"text":"Terms of Service and acceptance"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[" Each user must accept the Amazon Ads data manager Terms and Conditions before using Amazon Ads data manager. Acceptance is recorded once per user, not per account. If another user on the same account has accepted, you are still prompted to review and accept the first time you open Amazon Ads data manager. After you accept, you are not prompted again, including when you open Amazon Ads data manager from other accounts.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":2,"text":"User Consent"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":3,"text":"Consent overview"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[" If you transmit or make available to Amazon Ads any personal information within an in-scope marketplace, you must share a valid consent signal and the country code in which the customer granted consent. This applies to all data flowing through Amazon Ads — regardless of ingestion method.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":3,"text":"Supported consent frameworks"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[" Amazon Ads supports three consent frameworks for communicating user privacy choices:\n","|Framework|Full name|Scope|Use case|\n","\\|-\\|-\\|-\\|-\\|\n","|TCF|IAB Transparency & Consent Framework|EU/EEA, UK|Standard IAB consent string for European privacy compliance|\n","|GPP|Global Privacy Platform|US state laws, UK, EEA|IAB framework for privacy regulations (CCPA, GDPR, etc.)|\n","|ACS|Amazon Consent Signal|UK, EEA|the proprietary consent mode from Amazon with granular controls for consent type|\n"," You must use at least one of TCF, GPP, or ACS to communicate UK and EEA users' privacy choices to Amazon Ads.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":3,"text":"Amazon Consent Signal (ACS)"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[" Amazon Consent Signal (ACS) is an easy-to-use consent sharing format developed by Amazon for advertisers or 3Ps to share consent choices when uploading or sharing their customer data with Amazon Ads. ACS encompasses two distinct signals:\n","|Signal|Description|Values|\n","\\|-\\|-\\|-\\|\n","|amzn_user_data|This parameter sets consent to use personal data for advertising purposes. It accepts values to indicate consent for Amazon to use the personal data of the customer for advertising. |Pass GRANTED or DENIED for Events API; Pass true or false for AAT|\n","|amzn_ad_storage|This is an optional signal to set consent for cookies. It accepts values that signify the consent collected by the advertiser (or a third-party) for Amazon to read and/or write Amazon cookies within the browser of the customer.|Pass GRANTED or DENIED for Events API; Pass true or false for AAT|\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":3,"text":"How consent flows through Ads data manager"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":3,"text":"Consent by ingestion method"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[" When AAT runs in the browser, it can read consent signals directly from the user's Consent Management Platform (CMP).\n"," TCF (EU/EEA):\n","AAT reads the TCF consent string from the CMP via the IAB TCF API (\\_\\_tcfapi).\n","Amazon Ads is a registered vendor on the IAB Europe TCF.\n","AAT checks for the required TCF purposes before firing. If consent is denied for required purposes, AAT will not fire or will fire in a limited mode.\n"," GPP (US):\n","AAT reads the GPP string from the CMP via the IAB GPP API.\n","GPP sections relevant to the user's state (e.g., California CCPA section) are evaluated.\n","If the user has opted out under applicable state law, AAT respects the opt-out signal.\n"," ACS:\n","AAT reads amzn_user_data and amzn_ad_storage signals.\n","If amzn_ad_storage = false, AAT will not set or read advertising cookies.\n","If amzn_user_data = false, AAT will not process personal data for advertising.\n","ACS signals can be set by the CMP or directly in the AAT configuration.\n"," Records must include consent signals in the API payload.\n"," Required consent fields in API requests:\n","|Field|Description|Required when|\n","\\|-\\|-\\|-\\|\n","|consent.tcf|IAB TCF consent string|UK/EEA users (if using TCF)|\n","|consent.amazonConsent.amznAdStorage|GRANTED or DENIED — user consent for ad cookies|UK/EEA users (if using ACS)|\n","|consent.amazonConsent.amznUserData|GRANTED or DENIED — user consent for data processing|UK/EEA users (if using ACS)|\n","|countryCode|ISO 3166-1 alpha-2 country code (e.g., DE, GB)|Always|\n"," Do not send multiple signals. If both TCF and ACS are provided, Amazon Ads uses TCF and ignores ACS.\n"," Example Events API payload with ACS consent:\n"," What happens when consent is missing or invalid:\n","Events without consent signals from UK/EEA users are rejected.\n","Events with DENIED consent are accepted but not used for personalized advertising or measurement.\n"," Mobile consent is collected via the Mobile Measurement Partner SDK and forwarded to Ads data manager with event records.\n","ATT (App Tracking Transparency) — iOS: IDFA is only available if the user granted ATT permission. Mobile Measurement Partner passes ATT status to Ads data manager.\n","TCF Mobile — For EU/EEA mobile users, the CMP in the app collects TCF consent. Mobile Measurement Partner forwards the TCF string.\n","ACS — Mobile Measurement Partner can include amzn_user_data and amzn_ad_storage in event records.\n","Device ID availability — If consent is denied, device IDs (IDFA/GAID) may not be available. Ads data manager falls back to other identity signals (hashed email, phone) when device IDs are absent.\n"," CDPs must map their consent fields to Ads data manager's consent schema when streaming data.\n","Map the CDP's consent status field to Ads data manager's consent_type + consent_value fields.\n","Ensure consent travels with the data — consent collected at the point of interaction must be preserved through the CDP pipeline and forwarded to Ads data manager.\n","If the CDP does not capture consent, the advertiser must enrich records with consent status before streaming to Ads data manager.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":3,"text":"Consent at the dataset level"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[" Every dataset requires a Country Code (CC) field that indicates the geographic scope and consent basis for the data.\n","Set during dataset creation; cannot be changed afterward.\n","Determines which regional data processing rules apply.\n","Used by Ads data manager to enforce consent requirements at the destination and activation layers.\n"," Values for a countryCode can be supplied at the record-level or at the dataSet level. Ads data manager determines the countryCode to use through a priority sequence. At the highest priority is the record-level countryCode. If this is provided, it will be used regardless of other sources. In the absence of a record-level countryCode, Ads data manager will attempt to resolve the country from the provided ipAddress. If the ipAddress is unavailable, then the countryCode specified at the dataSet level is considered. If none of these sources yield a valid countryCode, the system defaults to UNKNOWN, which may impact match rates or complete omission of the records as it may fail consent requirements.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":2,"text":"Data security and encryption"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[" Ads data manager provides multiple layers of security to protect advertiser data throughout its lifecycle.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":3,"text":"Isolated data environments"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":["Each advertiser's data is stored in a logically isolated environment.\n","No cross-advertiser data access is possible unless explicitly configured via cross-account sharing.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":3,"text":"End-to-end encryption"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":["In transit: All data transmitted to and from Ads data manager is encrypted using TLS 1.2+.\n","At rest: All stored data is encrypted using AES-256 encryption.\n","Hashing: All PII must be pseudonymized hashed before transmission. Ads data manager does not accept or store raw PII.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":3,"text":"User-level access controls"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":["Role-based access control (RBAC) determines who can create, view, and manage datasets and destinations.\n","API access is scoped via OAuth 2.0 with granular permission scopes.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":3,"text":"Data retention and deletion"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":["Maximum data retention period is 13 months. Data is automatically purged after this limit.\n","Advertisers can delete datasets at any time — deletion is permanent and irreversible.\n","When a dataset is deleted, all associated destinations are revoked and downstream activation stops immediately.\n"],"documentType":"guide"},{"title":"Privacy and security","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/ads-data-manager/privacy-and-security","content":[],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":null,"path":"/en-us/guides/ads-data-manager/faq","content":[],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":2,"text":"Getting started"},"path":"/en-us/guides/ads-data-manager/faq","content":[],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"Who can use Ads data manager?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Any Amazon Ads customer with Manager Account access. Create a Manager Account at advertising.amazon.com.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"What data formats are supported for file uploads?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" CSV (via UI or API), Parquet (via API), and JSON (newline-delimited via API).\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"Do I need to hash identifiers before uploading?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Yes. All personally identifiable information (email, phone, name, address, zip, etc.) must be SHA-256 hashed before upload. Normalize values (lowercase, trim whitespace, E.164 for phones) before hashing. See here for normalization instructions from Amazon.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"How often should I refresh my data?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" For audience datasets used in active campaigns, refresh daily or weekly to maintain targeting accuracy. For geographic location data, refresh whenever coverage changes.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"Can my agency access my data?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Yes. Through cross-account sharing via the Manager Account → Advertiser Account hierarchy. Create a destination that grants your agency's linked account access to specific datasets. See Destinations and data sharing.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"What identity signals does Ads data manager support?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Hashed email (SHA-256), hashed phone (SHA-256, E.164), first name, last name, address, device IDs (IDFA, GAID), and third-party identifiers (RAMP_ID, EXPERIAN_ID, TRANSUNION_ID, MATCH_ID).\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"Is my data secure in Ads data manager?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Yes. End-to-end encryption (TLS 1.2+ in transit, AES-256 at rest), isolated data environments per account, and role-based access controls. Amazon does not store raw personally identifiable information.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"Can I use Ads data manager without Amazon DSP?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Yes. Ads data manager operates at the Manager Account level. You can upload data and share to AMC for analytics without running DSP campaigns. However, audience activation and conversion attribution require DSP.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"How long is data retained?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Maximum 13 months. Data automatically expires after this period. You can set a shorter TTL per dataset.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":2,"text":"Troubleshooting"},"path":"/en-us/guides/ads-data-manager/faq","content":[],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"My events aren't showing in the dashboard?"},"path":"/en-us/guides/ads-data-manager/faq","content":["Open the AAT Helper extension and confirm events fire in the browser. 2. If events fire in AAT Helper but not the dashboard, check that your countryCode is set via ConsentJS — events without country code are rejected server-side. 3. Allow up to 24 hours for events to appear in the dashboard.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"My match rate is lower than expected?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Include as many hashed identifiers as possible per record. Email alone yields lower match rates than email + phone + address combined. Ensure normalization before hashing (lowercase emails, E.164 phones, trimmed whitespace).\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"My audience size is below 2,000 and not activating?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Amazon DSP requires a minimum of 2,000 matched audience members before an audience becomes active for campaign use. Upload more records or include additional identity signals to increase matches.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"Events are showing as \"Inactive\"?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" An event is marked Inactive if it hasn't received traffic recently. This does not delete the event. Resume firing the event and it will return to Active status.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"How do I delete user data for GDPR compliance?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" User-level deletion is available via the API only (not the UI). Dataset-level deletion (removing the entire table) is available via both the UI and API.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"How long until my audience is active in DSP?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Allow 36 hours after upload for the audience to appear and become targetable in Amazon DSP.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"My Events API requests are being rejected?"},"path":"/en-us/guides/ads-data-manager/faq","content":[" Check that: (1) countryCode is included in every event, (2) eventTime is within the last 21 days, (3) matchKeys are SHA-256 hashed (except MAID), (4) consent signals are included for UK/EEA users.\n"],"documentType":"guide"},{"title":"Amazon Ads Data Manager FAQ","sectionHeader":{"type":3,"text":"What is the maximum number of events per tag?"},"path":"/en-us/guides/ads-data-manager/faq","content":[],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":null,"path":"/en-us/guides/ras/getting-started","content":[],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/ras/getting-started","content":[" Amazon Retail Ad Service (RAS) allows advertisers to build campaigns through Amazon Ads that run on other retailer websites and apps. The API follows a similar pattern to Amazon Ads Sponsored Products campaigns. \n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":3,"text":"1.1 Onboarding to the Amazon Ads API"},"path":"/en-us/guides/ras/getting-started","content":[" If this is your first time calling the API, please follow our Onboarding and Getting started guides to request access to the API and set up authentication.\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":3,"text":"1.2 Headers"},"path":"/en-us/guides/ras/getting-started","content":[" Each request described in this guide requires these header parameters: \n","|Parameter\t|Description\t|\n","|---\t|---\t|\n","|Amazon-Advertising-API-ClientId\t|The client ID associated with your Login with Amazon application. Used for authentication.\t|\n","|Authorization\t|Your access token. Used for authentication.\t|\n","|Amazon-Advertising-API-Scope\t|The profile ID associated with an advertising account in a specific marketplace. Make sure you are using the correct base URL for the marketplace associated to the profile.\t|\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":3,"text":"1.3 Auto vs. manual campaigns"},"path":"/en-us/guides/ras/getting-started","content":[" There are two types of RAS campaigns: auto targeting and manual targeting. Both manual and auto campaigns require you to create, at minimum, campaigns, ad groups, and product ads. However, for manual campaigns, the advertiser also has complete control over targets. For auto campaigns, Amazon suggests relevant targeting expressions and keywords based on the products you are advertising. Both auto and manual campaigns also support negative targeting.\n"," Amazon sets initial bids for the created auto targets, but advertisers can update the bids if they choose.\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":3,"text":"1.4 API URLs"},"path":"/en-us/guides/ras/getting-started","content":[" In Amazon Ads the base URL you must use with your API call depends on the region of the profile associated to the advertiser you are making a call on behalf of. At the moment, the RAS API only supports calls to the North America region for Advertisers in United States (US) marketplace.\n"," Use the table below to understand which base URL you should use:\n","|URL\t|Region\t|Marketplaces\t|\n","|---\t|---\t|---\t|\n","|https&#x3A;//advertising-api.amazon.com\t|North America (NA)\t|United States (US)\t|\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":2,"text":"2. Creating campaigns"},"path":"/en-us/guides/ras/getting-started","content":[" Creating an active campaign requires a sequence of API calls to create campaign, ad group, product ad, and targeting resources.\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":3,"text":"2.1 Create a campaign"},"path":"/en-us/guides/ras/getting-started","content":[" The response from the API varies based on the presence of the Prefer header in the request. When the Prefer header is present and its value is return=representation, full entity details will be returned in the response. Otherwise only the entity identifier will be returned. A successful call results in a 207 response with individual response codes for each entity object included in the request.\n"," Make note of your campaignId for use in the next step.\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":3,"text":"2.2 Create an ad group"},"path":"/en-us/guides/ras/getting-started","content":[" Both auto and manual campaigns require at least one ad group. Creation of an ad group requires a campaignId (see step 2.1) and a retailerId. The retailerId represents the product catalog that includes the products you want to advertise.\n"," Resource\n"," Request\n"," You can configure the number of results returned using the maxResults field, which is optional and has a default value of 10. If the number of retailers exceeds maxResults, a nextToken string is returned in the response which can be provided on another API request to fetch the next page of results.\n"," Response\n"," Resource\n"," Request\n"," Response\n"," The response from the API varies based on the presence of the Prefer header in the request. When the Prefer header is present and its value is return=representation, full entity details will be returned in the response. Otherwise only the entity identifier will be returned. A successful call results in a 207 response with individual response codes for each entity object included in the request.\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":3,"text":"2.3 Create a product ad"},"path":"/en-us/guides/ras/getting-started","content":[" To create a product ad, you will need a campaignId (step 2.1), adGroupId (step 2.2), retailerId (step 2.2), and retailerOfferId. The retailerOfferId represents the product or service that you are advertising. Amazon will use offer details like image, name, and rating to build a responsive creative for use in your campaign. You can discover available products per retailer using the product metadata API (see section 3. Product Metadata)\n"," The response from the API varies based on the presence of the Prefer header in the request. When the Prefer header is present and its value is return=representation, full entity details will be returned in the response. Otherwise only the entity identifier will be returned. A successful call results in a 207 response with individual response codes for each entity object included in the request.\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":3,"text":"2.4 Create keyword targets for manual campaigns"},"path":"/en-us/guides/ras/getting-started","content":[" For manual campaigns, advertisers must create their own targets. Each manual campaign must have at least one non-negative target. Currently RAS only supports keyword targets, which are based on customer search terms. \n"," To create a keyword, you will need a campaignId (step 2.1) and adGroupId (step 2.2), as well as the keyword you want to target. \n","Make sure negative is set to false to create an inclusive keyword target. \\* See Keyword match types to learn more about the meaning of each matchType.\n"," The response from the API varies based on the presence of the Prefer header in the request. When the Prefer header is present and its value is return=representation, full entity details will be returned in the response. Otherwise only the entity identifier will be returned. A successful call results in a 207 response with individual response codes for each entity object included in the request.\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":3,"text":"2.5 Update targets for auto campaigns (optional)"},"path":"/en-us/guides/ras/getting-started","content":[" For auto campaigns, advertisers do not create their own targets. Amazon automatically creates targets after you have created an ad group. Amazon will set bids automatically for these automatic targets, but advertisers can manually update the bids if they want. \n"," Resource\n"," Request\n"," You can use the targetTypeFilter to only return targets of type AUTO.\n"," Response\n"," A successful call results in a 200 response with all targeting clauses matching the filters in the request. You should see four auto targeting clauses that have been automatically created for you with matchTypes of PRODUCT_SUBSTITUTES, SEARCH_LOOSE_MATCH, SEARCH_CLOSE_MATCH, PRODUCT_COMPLEMENTS. Learn more about match types for auto targets.\n"," Record the targetId values for use in the next step.\n"," Resource\n"," Request\n"," Use the target IDs retrieved in step 2.5.1 in the PUT request.\n"," Response\n"," A successful PUT request returns a 207 response. You should see the updated bid in the response.\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":3,"text":"2.6 Create negative targets (optional)"},"path":"/en-us/guides/ras/getting-started","content":[" Negative targets help prevent ads from appearing in contexts that do not meet campaign objectives. Both auto and manual targeting campaigns support negative targets. Negative targets can be at either the ad group or campaign level. Campaign level negative targets will impact all ads and ad groups within the campaign. Negative targets are created using the same resource as positive targets. \n"," The response from the API varies based on the presence of the Prefer header in the request. When the Prefer header is present and its value is return=representation, full entity details will be returned in the response. Otherwise only the entity identifier will be returned. A successful call results in a 207 response with individual response codes for each entity object included in the request.\n"," To create a campaign-level negative target, do not input an adGroupId in the request.\n"," The response from the API varies based on the presence of the Prefer header in the request. When the Prefer header is present and its value is return=representation, full entity details will be returned in the response. Otherwise only the entity identifier will be returned. A successful call results in a 207 response with individual response codes for each entity object included in the request.\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":2,"text":"3. Product Metadata"},"path":"/en-us/guides/ras/getting-started","content":[" To retrieve metadata and details for products, you can use the existing /product/metadata API endpoint and include a new retailerInfo element, which contains the retailerType as RMS and the retailerId, for which products are requested: product-metadata/\n"," A successful call results in a 200 response with a list of products for the retailer ID included in the request (and matching the offer IDs or search string if any were provided in the request).\n"],"documentType":"guide"},{"title":"Getting started with the Retail Ad Service API","sectionHeader":{"type":2,"text":"4. Reporting"},"path":"/en-us/guides/ras/getting-started","content":[" To get performance data for RAS campaigns, you can use the existing Sponsored Products report types in reporting version 3.\n"," Available report types:\n","spCampaigns  spTargeting  spSearchTerm  spGrossAndInvalids  spAdvertisedProduct\n"],"documentType":"guide"},{"title":"Traffic events API overview","sectionHeader":null,"path":"/en-us/guides/traffic-events/overview","content":[" The traffic events API is a data clean room-based service that helps advertisers access event-level data for eligible campaigns, such as impressions and clicks. This data can be queried using standard SQL syntax within the body of the traffic events API call. \n"," To call the traffic events API, you must first establish (Login With Amazon) LWA credentials for reporting access to one or more of our ad serving products: Amazon Demand Side Platform, Sponsored Ads, Amazon Ad Server. The traffic events API will return results if the advertiser account ID you include in the API call is associated with any eligible campaigns.\n"],"documentType":"guide"},{"title":"Traffic events API overview","sectionHeader":{"type":3,"text":"Key features"},"path":"/en-us/guides/traffic-events/overview","content":["Improved data granularity. Traffic events data is available at the event level with aggregation levels designed to protect customer privacy. - More reporting dimensions. More reporting dimensions in addition to what is already available in current invalid traffic reporting. - API access. You can integrate our API with your reporting applications for ease of use.\n"],"documentType":"guide"},{"title":"Traffic events API overview","sectionHeader":{"type":2,"text":"Where is the traffic events API available?"},"path":"/en-us/guides/traffic-events/overview","content":["North America: United States, Canada, Mexico - South America: Brazil - Europe: Germany, Spain, France, Italy, Netherlands, United Kingdom, Sweden, Turkey - Middle East: Saudi Arabia, United Arab Emirates - Asia Pacific: Australia, India, Japan\n"],"documentType":"guide"},{"title":"Traffic events API overview","sectionHeader":{"type":2,"text":"How the traffic events API works"},"path":"/en-us/guides/traffic-events/overview","content":[" Pseudonymized inputs from Amazon Ads campaign events -- such as ad impressions, ad clicks, and ad views that span across media including streaming TV, audio, video, display, and sponsored ads -- are uploaded into the traffic events clean room (TCR).\n"," All analysis takes place within the clean room -- across dimensions like time, creative, or campaigns, to name a few -- and results are aggregated to generate anonymous reports that you can export.\n"," TCR prioritizes privacy and security by design by accepting only pseudonymized information. All information in TCR is handled in strict accordance with the Amazon privacy notice, and raw event information cannot be exported.\n"," TCR will receive data within 72 hours of the impression being served. Starting from the time the data reaches TCR, it will be retained for a period of 30 days.\n"],"documentType":"guide"},{"title":"Traffic events API overview","sectionHeader":{"type":2,"text":"Accessing the traffic events API"},"path":"/en-us/guides/traffic-events/overview","content":[" To access the traffic events API, you will use a combination of the Marketplace ID and the Sponsored Ads Entity ID or the Amazon DSP Advertiser ID that you wish to query data from. In order to query data for a specific advertiser, you must have specific permissions on that account. See Advertiser account management for traffic events API access.\n"],"documentType":"guide"},{"title":"Traffic events API overview","sectionHeader":{"type":2,"text":"Rate limits"},"path":"/en-us/guides/traffic-events/overview","content":[" Traffic events sets API rate limits to ensure all clients can use traffic events effectively. API rate limits are defined as a maximum number of calls a client can make to each endpoint within a time period. If your app makes a lot of API requests in a short period of time then it may receive a 429 error response. Traffic events also sets limits at the workflow execution level that will return a 402 status code. An advertiser may have up to 5 concurrent running workflow executions. If you attempt to create a new execution while there are 5 workflow executions already running, you will receive a 402 status code.\n"],"documentType":"guide"},{"title":"Traffic events API overview","sectionHeader":{"type":2,"text":"FAQ"},"path":"/en-us/guides/traffic-events/overview","content":[" If your workflow execution is in a SUCCEEDED status but the results file is empty, this could be due to a number of reasons related to the way you constructed your query.\n","The campaign you queried did not have any traffic in an eligible locale. - The constraints you placed on the query did not align with any traffic data. For example, if the time window of your query was set for a time when your campaign was not actively serving eligible traffic, then it is expected to return no data. Another example could be that you selected a specific ad ID which was actively serving traffic, but selected a creative ID which was not being used during your specified time window. - If your workflow execution is in a status other than SUCCEEDED, you may need to wait for it to complete to fetch the results or see the WorkflowExecutionStatusReason for more information.\n","The data which was queried when you previously ran the workflow execution could have been deleted from our system. Check the time range of your query to ensure the start and end date are within the last 30 days. - If you have altered the query since you last ran it, then see the answer for \"Why did my workflow execution produce an empty result?\"\n"],"documentType":"guide"},{"title":"Traffic events API overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/traffic-events/overview","content":[],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":null,"path":"/en-us/guides/traffic-events/getting-started","content":[],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/traffic-events/getting-started","content":[" To work with traffic events APIs, you need to have:\n","An existing Amazon Ads account. \\* A Login with Amazon account through which you have onboarded the Amazon Ads API.\n"," For information about onboarding to the Amazon Ads API, see Onboarding. For information about generating access tokens, see the general guide to getting started with the Amazon Ads API.\n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":2,"text":"Header parameters"},"path":"/en-us/guides/traffic-events/getting-started","content":[" In addition to the individual API parameters, the following header parameters are required for most of your calls.\n","|Header\t|Description\t|\n","|---\t|---\t|\n","|Amazon-Advertising-API-ClientId\t|The identifier of a client associated with an Amazon Developer account.\t|\n","|Amazon-Advertising-API-MarketplaceId\t|The marketplace identifier for the marketplace in the request. Marketplaces are tied to the country.\t|\n","|Amazon-Advertising-Advertiser-Id\t|The traffic events API account identifier. Include this header when querying Amazon DSP advertisers. This value is the advertiser id found in the Amazon Ads DSP console, or from the /dsp/advertisers API. Do not include this header when querying Sponsored Ads advertisers.\t|\n","|Amazon-Advertising-API-EntityId\t|The traffic events API entity identifier. Include this header when querying Amazon Sponsored Ad advertisers. This value is the entity id found in the Amazon Ads console, or from the /v2/profiles API. Do not include this header when querying DSP advertisers.\t|\n","|Authorization\t|Login with Amazon token in the form of Bearer {{token}}\t|\n","|Content-type\t|application/json\t|\n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":3,"text":"Marketplaces"},"path":"/en-us/guides/traffic-events/getting-started","content":[" The marketplace identifiers called in requests through the Amazon-Advertising-API-MarketplaceId header parameter are tied to a country, as listed in the tables below.\n","|Country\t|Marketplace ID\t|Country code\t|\n","|---\t|---\t|---\t|\n","|Germany\t|A1PA6795UKMFR9\t|DE\t|\n","|Spain\t|A1RKKUPIHCS9HS\t|ES\t|\n","|France\t|A13V1IB3VIYZZH\t|FR\t|\n","|Italy\t|APJ6JRA9NG5V4\t|IT\t|\n","|Netherlands\t|A1805IZSGTT6HS\t|NL\t|\n","|Sweden\t|A2NODRKZP88ZB9\t|SE\t|\n","|Turkey\t|A33AVAJ2PDY3EV\t|TR\t|\n","|United Kingdom\t|A1F83G8C2ARO7P\t|UK\t|\n","|Saudi Arabia\t|A17E79C6D8DWNP\t|SA\t|\n","|United Arab Emirates\t|A2VIGQ35RCS4UG\t|AE\t|\n","|Country\t|Marketplace ID\t|Country code\t|\n","|---\t|---\t|---\t|\n","|Brazil\t|A2Q3Y263D00KWC\t|BR\t|\n","|Canada\t|A2EUQ1WTGCTBG2\t|CA\t|\n","|Mexico\t|A1AM78C64UM0Y8\t|MX\t|\n","|United States of America\t|ATVPDKIKX0DER\t|US\t|\n","|Country\t|Marketplace ID\t|Country code\t|\n","|---\t|---\t|---\t|\n","|Australia\t|A39IBJ37TRP1C6\t|AU\t|\n","|Japan\t|A1VC38T7YXB528\t|JP\t|\n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":2,"text":"Make your first call"},"path":"/en-us/guides/traffic-events/getting-started","content":[" The tutorials in this section walk you through the steps to create, read, and update resources using the traffic events API. \n"," To test your first call, use the POST method of the /avc/workflowexecutions endpoint to create a workflow execution.\n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":3,"text":"Workflow Execution"},"path":"/en-us/guides/traffic-events/getting-started","content":[" A workflow allows you to create and execute a query on demand. You can then download the output of the query.\n"," Before you test out the API by sending your first request, it is important to understand that if any personal information (such as an individual's email address or phone number) is added to a request, the query will not output desired results.\n"," Use the POST method with the /workflowexecutions endpoint path, providing a request body containing a JSON object with the following parameters:\n","sqlQuery: The SQL query must be a single-line query and stripped of tabs and new-line delimiters before added to the JSON object. Semicolons are not required at the end of the query. \\* workflowId: Friendly name to identify the query when you search for it later.\n"," For this example, this section runs a basic SQL query that aggregates total cost, and impressions at the advertiser and campaign level. The query is below:\n"," Here is the query converted to a single line:\n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":3,"text":"Request payload"},"path":"/en-us/guides/traffic-events/getting-started","content":[" We will use the single-line query above as the value to pass for the sqlQuery parameter. The following is an example of the message body:\n"," When executed, this value will run the query for the last 7 days. There are also predefined values for most recent day, current month, previous month, and custom (explicit) time windows.\n"," You can call the POST workflow execution endpoint using one of the following approaches:\n","Using cURL \\* Using Postman\n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":3,"text":"Using cURL"},"path":"/en-us/guides/traffic-events/getting-started","content":[" You can use cURL to create an ad hoc workflow using the North America URL prefix.\n"," Note the workflowExecutionId from the response. This identifier will be used to download a CSV file containing query results.\n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":3,"text":"Using Postman"},"path":"/en-us/guides/traffic-events/getting-started","content":[" In this example, this tutorial uses Postman, an API platform that has an easy-to-use graphical user interface (GUI).\n","Download and install Postman. 2. Complete the setup for the Amazon Ads API Postman collection. Ensure that the user account you use to generate the authorization code has access to the advertising account you want to query. 3. Click Add request within the collection to create a new request. This will inherit the authorization parameters of the collection. 4. Name your request as desired (for example, Execute ad hoc workflow). By default, Postman creates a GET request. Make sure the HTTP method is set to POST. 5. In the request URL field, enter the base traffic events API URL and append the endpoint path for the workflow executions resource (/workflowExecutions). Using the North America URL prefix, your request will look something like the example below, with your unique instance being called as a variable:\n","On the Headers tab, add the mandatory header parameters noted above, with the appropriate values for each. 2. Next, enter the JSON object in the request body as described above. In Postman, on the Body tab, select Raw and enter the JSON object that defines the SQL query (sqlQuery) and the timeWindowType as MOST_RECENT_WEEK. 3. Click Send. If successful, you will receive a response with the HTTP status code 200 OK and the following response parameters:\n"," If you receive a response code other than 200, check that your credentials are authenticated and that your token has not expired.\n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":2,"text":"Get your query results"},"path":"/en-us/guides/traffic-events/getting-started","content":[" In the previous section, we ran an ad hoc workflow which executed a query that aggregates total cost, impressions, and reach at the advertiser and campaign level. Next, we will access the CSV file containing the results of the query. You can retrieve your results by generating a download URL.\n"," You will need to copy the workflowExecutionId from the response of the ad hoc execution that we previously ran. We will use that with the /workflowexecutions/{workflowExecutionId}/downloadUrls endpoint to retrieve a link for the results.\n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":3,"text":"Generate the download URL"},"path":"/en-us/guides/traffic-events/getting-started","content":[" Make a GET request, substituting your workflowExecutionId into the location below, along with the appropriate values for each header.\n"," To create a new request to download the results of the query:\n","Copy the workflowExecutionId from the response returned in the previous section. In the above response example, the workflowExecutionId is: a629552c-027f-4624-b4fb-55d159f9c7d2 2. Create a new request in Postman and select the GET method.\n"," Enter the request URL, inserting the workflowExecutionId from the previous step into the following URL: \n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":3,"text":"Download the CSV file"},"path":"/en-us/guides/traffic-events/getting-started","content":[" This request will return a URL where your report can be directly downloaded. Copy the URL and enter it into a browser to download the resulting CSV file.\n"," It may take some time for the report to generate. Wait until the workflow execution is in a SUCCEEDED status to download your report. If your report is not ready, you will receive an HTTP 404 error stating that the download URL is not found.\n"," If you receive that error, wait until the workflow execution is in SUCCEEDED state. You can check the state of the Workflow Execution by calling the Get Workflow Execution API.\n"," This tutorial ran the first ad hoc query by creating a workflow execution. Then, it created a request to generate a URL to download the CSV file containing the query results.\n"],"documentType":"guide"},{"title":"Getting started with the traffic events API","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/traffic-events/getting-started","content":[" Now that you have made your first call, learn more about:\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":null,"path":"/en-us/guides/traffic-events/data-sources","content":[" Data from your Amazon Ads campaign events are ingested into TCR. This data can be from ad activity on Amazon DSP, any of the Sponsored ads, or a connected Amazon Ads product like the Amazon Ad Server and can be referenced through the following tables:\n","Amazon DSP traffic - Amazon Ad Server - Sponsored ads - Devices traffic\n"," All tables have a flat schema consisting of a list of columns that each have a name, a data type, a column type of metric or dimension, and an aggregation threshold. For details, see TCR data aggregation thresholds.\n"," Creating or modifying materialized tables is not supported in TCR SQL. The only supported operations are queries that operate on defined tables within TCR. Tables in TCR can be queried like SQL tables.\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":2,"text":"Data source tables"},"path":"/en-us/guides/traffic-events/data-sources","content":[],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"Amazon DSP traffic tables"},"path":"/en-us/guides/traffic-events/data-sources","content":[" The following tables contain inputs from all Amazon DSP campaigns from the DSP advertising accounts that you have access to. Includes records from ad product types such as Display, Online Video, Streaming TV, Audio, etc. \n","Amazon DSP impressions - Amazon DSP clicks - Amazon DSP views\n"," The following tables contain invalid traffic for DSP. \n","Amazon DSP invalid impressions  - Amazon DSP invalid clicks \n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"Amazon Ad Server tables"},"path":"/en-us/guides/traffic-events/data-sources","content":[" The following tables contain inputs from Amazon Ad Server data sources.\n","Ad Server traffic\n"," The following tables contain invalid traffic for Ad Server. \n","Ad Server invalid traffic\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"Sponsored ads table"},"path":"/en-us/guides/traffic-events/data-sources","content":[" This table includes both impressions and clicks for sponsored ads programs.\n","Sponsored ads traffic table\n"," The following tables contain invalid traffic for Sponsored Ads. \n","Sponsored ads invalid traffic table\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"Devices traffic table"},"path":"/en-us/guides/traffic-events/data-sources","content":[" This table includes both impressions and clicks for devices traffic. \n","Devices ads traffic table\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":2,"text":"Important notes for querying data sets"},"path":"/en-us/guides/traffic-events/data-sources","content":[],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"Time Zones"},"path":"/en-us/guides/traffic-events/data-sources","content":[" TCR queries are based on UTC time by default, but the advertising console provides reports based on advertiser time zone (e.g. Europe/Zurich). When working with traffic events APIs, to match TCR to the advertiser time zone, the timeWindowTimeZone parameter of the CreateWorkflowExecution request can be used to specify the time zone.\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":2,"text":"Devices Traffic"},"path":"/en-us/guides/traffic-events/data-sources","content":[],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"devices_traffic"},"path":"/en-us/guides/traffic-events/data-sources","content":[" The devices_traffic table captures the details of the traffic event that occurs for a particular campaign on Amazon devices. It also includes other associated information about the advertisement.  \n","|Field Category\t|Name\t|Data Type\t|Metric / Dimension\t|Description\t|Aggregation Threshold\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Advertiser setup\t|advertiser\t|STRING\t|Dimension\t|Amazon Devices traffic advertiser name.\t|LOW\t|\n","|Advertiser setup\t|advertiser_id\t|LONG\t|Dimension\t|Amazon Devices traffic Server advertiser ID.\t|LOW\t|\n","|Ad Product Info\t|ad_product_type\t|STRING\t|Dimension\t|The ad product of the campaign. Example: sponsored_products or sponsored_display.\t|\t|\n","|Ad Product Info\t|ad_product_type_code\t|STRING\t|Dimension\t|The ad product code of the campaign. Example: SP or SB.\t|\t|\n","|Campaign setup\t|campaign\t|STRING\t|Dimension\t|Amazon Devices traffic Campaign Name, as appears in Amazon Devices (for display and search).\t|LOW\t|\n","|Campaign setup\t|campaign_id\t|LONG\t|Dimension\t|Amazon Devices traffic Campaign ID (internal Devices traffic IDs for display and search).\t|LOW\t|\n","|Click delivery info\t|clicks\t|LONG\t|Metric\t|Total clicks served, excluding GIVT. Includes all billable clicks served and tracked by Amazon Ad Server, among them click_sivt, click_ssai and click_noscript.\t|NONE\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_date\t|DATE\t|Dimension\t|Event Date (Amazon Ad Server account time zone).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_date_utc\t|DATE\t|Dimension\t|Event Date (UTC).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_day\t|INTEGER\t|Dimension\t|Event Day of Month (Amazon Devices Traffic account time zone).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_day_utc\t|INTEGER\t|Dimension\t|Event Day of Month (UTC).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_dt\t|TIMESTAMP\t|Dimension\t|Event Timestamp (Amazon Devices Traffic account time zone).\t|MEDIUM\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_dt_hour\t|TIMESTAMP\t|Dimension\t|Event Timestamp (Amazon Devices Traffic account time zone) Truncated to Hour.\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_dt_hour_utc\t|TIMESTAMP\t|Dimension\t|Event Timestamp (UTC) Truncated to Hour.\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_dt_utc\t|TIMESTAMP\t|Dimension\t|Event Timestamp (UTC). Example: 2019-06-18T03:45:55.000\t|MEDIUM\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_hour\t|INTEGER\t|Dimension\t|Event Hour of Day (Amazon Devices Traffic account time zone).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_hour_utc\t|INTEGER\t|Dimension\t|Event Hour of Day (UTC).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_source\t|STRING\t|Dimension\t|Event Source.\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_cost\t|LONG\t|Dimension\t|Event Cost.\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|total_cost\t|double\t|Dimension\t|Total Cost.\t|LOW\t|\n","|Impression delivery info\t|impressions\t|LONG\t|Metric\t|Total impressions served, excluding GIVT. Includes all billable impressions served and tracked by Amazon Devices Traffic, among them impressions_sivt, impressions_ssai and impressions_noscript.\t|NONE\t|\n","|Impression delivery info\t|viewable_impressions\t|LONG\t|Metric\t|Number of viewable impression (IAB standard). Note, viewability signals collected only for campaigns where verification data collection mode was enabled. This metric will be 0 if campaign is not enabled for verification data collection.\t|NONE\t|\n","|Impression Viewability\t|view_definition\t|STRING\t|Dimension\t|For Devices Traffic, view_definition is either NULL or iab. The value is iab when the event was a viewable impression. This field will not contain iab for campaigns that were view aware. Instead, it is only iab when the actual event was a viewable impression. \t|\t|\n","|Line item setup\t|line_item\t|STRING\t|Dimension\t|Name of ad group. The value for line_item matches ad_group.\t|\t|\n","|Line item setup\t|line_item_id\t|LONG\t|Dimension\t|Customer-facing line item ID. For Sponsored Products, the value for line_item_id matches ad_group_id. For Sponsored Display, this value will be NULL. Use ad_group_id.\t|\t|\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":2,"text":"Amazon DSP"},"path":"/en-us/guides/traffic-events/data-sources","content":[],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"dsp_clicks"},"path":"/en-us/guides/traffic-events/data-sources","content":[" The dsp_clicks table is a subset of the dsp_impressions information that captures the details of impressions that were clicked and the associated click related information.\n","|Field Category\t|Name\t|Data Type\t|Metric / Dimension\t|Description\t|Aggregation Threshold\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Advertiser Setup\t|advertiser\t|STRING\t|Dimension\t|Advertiser name. Example: “Example Company”\t|LOW\t|\n","|Advertiser Setup\t|advertiser_id\t|LONG\t|Dimension\t|Customer-facing ID of advertiser. Example: 8443640090301\t|LOW\t|\n","|Campaign Setup\t|campaign\t|STRING\t|Dimension\t|Name of campaign (called “order” in DSP console)\t|LOW\t|\n","|Campaign Setup\t|campaign_id\t|LONG\t|Dimension\t|Customer-facing campaign ID\t|LOW\t|\n","|Click Delivery Info\t|click_date\t|DATE\t|Dimension\t|MM/DD/YYYY (advertiser time zone)\t|LOW\t|\n","|Click Delivery Info\t|click_date_utc\t|DATE\t|Dimension\t|MM/DD/YYYY (UTC)\t|LOW\t|\n","|Click Delivery Info\t|click_day\t|INTEGER\t|Dimension\t|01 - 31 (advertiser time zone)\t|LOW\t|\n","|Click Delivery Info\t|click_day_utc\t|INTEGER\t|Dimension\t|01 - 31 (UTC)\t|LOW\t|\n","|Click Delivery Info\t|click_dt\t|TIMESTAMP\t|Dimension\t|Timestamp of click in advertiser time zone. Example: 2019-06-18T03:45:55.000\t|MEDIUM\t|\n","|Click Delivery Info\t|click_dt_hour\t|TIMESTAMP\t|Dimension\t|Timestamp of click in advertiser time zone truncated to hour. Example: 2019-06-18T03:00:00.000\t|LOW\t|\n","|Click Delivery Info\t|click_dt_hour_utc\t|TIMESTAMP\t|Dimension\t|Timestamp of click in UTC truncated to hour. Example: 2019-06-18T08:00:00.000Z\t|LOW\t|\n","|Click Delivery Info\t|click_dt_utc\t|TIMESTAMP\t|Dimension\t|Timestamp of click in UTC. Example: 2019-06-18T03:45:55.000\t|MEDIUM\t|\n","|Click Delivery Info\t|click_hour\t|INTEGER\t|Dimension\t|00 – 23 (advertiser time zone)\t|LOW\t|\n","|Click Delivery Info\t|click_hour_utc\t|INTEGER\t|Dimension\t|00 – 23 (UTC)\t|LOW\t|\n","|Click Delivery Info\t|clicks\t|LONG\t|Metric\t|Number of clicks\t|LOW\t|\n","|Creative Setup\t|creative\t|STRING\t|Dimension\t|Name of creative. Example: “Example Creative Name”\t|LOW\t|\n","|Creative Setup\t|creative_id\t|LONG\t|Dimension\t|Customer-facing creative ID. Example: 4301568770201\t|LOW\t|\n","|Creative Setup\t|creative_type\t|STRING\t|Dimension\t|Type of creative. Example: “Shazam HTML – AAP”\t|LOW\t|\n","|Advertiser Setup\t|entity_id\t|STRING\t|Dimension\t|Customer-facing ID of entity – can be found in the URL within the DSP console. Example: “ENTITYA6I16E0BHHHY”\t|LOW\t|\n","|Line item setup\t|line_item\t|STRING\t|Dimension\t|Name of line item (ad)\t|LOW\t|\n","|Line item setup\t|line_item_id\t|LONG\t|Dimension\t|Customer-facing line item ID\t|LOW\t|\n","|Supply\t|supply_source\t|STRING\t|Dimension\t|Name of supply source (exchange). Example: “Amazon Publisher Services”\t|LOW\t|\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"dsp\\_invalid\\_clicks"},"path":"/en-us/guides/traffic-events/data-sources","content":[" The dsp_invalid_clicks table records clicks for the impressions that have been marked invalid. This includes potentially fraudulent, non-human, and other illegitimate traffic.\n","|Field Category\t|Name\t|Data Type\t|Metric / Dimension\t|Description\t|Aggregation Threshold\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Advertiser Setup\t|advertiser\t|STRING\t|Dimension\t|Advertiser name. Example: “Example Company”\t|MEDIUM\t|\n","|Advertiser Setup\t|advertiser_id\t|LONG\t|Dimension\t|Customer-facing ID of advertiser. Example: 8443640090301\t|MEDIUM\t|\n","|Campaign Setup\t|campaign\t|STRING\t|Dimension\t|Name of campaign (called “order” in DSP console)\t|MEDIUM\t|\n","|Campaign Setup\t|campaign_id\t|LONG\t|Dimension\t|Customer-facing campaign ID\t|MEDIUM\t|\n","|Click Delivery Info\t|click_date\t|DATE\t|Dimension\t|MM/DD/YYYY (advertiser time zone)\t|MEDIUM\t|\n","|Click Delivery Info\t|click_date_utc\t|DATE\t|Dimension\t|MM/DD/YYYY (UTC)\t|MEDIUM\t|\n","|Click Delivery Info\t|invalid_clicks\t|LONG\t|Metric\t|Number of clicks that were removed by the traffic quality filter. This includes potentially fraudulent, non-human, and other illegitimate traffic.\t|MEDIUM\t|\n","|Advertiser Setup\t|entity_id\t|STRING\t|Dimension\t|Customer-facing ID of entity – can be found in the URL within the DSP console. Example: “ENTITYA6I16E0BHHHY”\t|MEDIUM\t|\n","|Line item setup\t|line_item\t|STRING\t|Dimension\t|Name of line item (ad)\t|MEDIUM\t|\n","|Line item setup\t|line_item_id\t|LONG\t|Dimension\t|Customer-facing line item ID\t|MEDIUM\t|\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"dsp_impressions"},"path":"/en-us/guides/traffic-events/data-sources","content":[" The dsp_impressions table records of all impressions delivered to viewers reached through an Amazon DSP campaign.\n","|Field Category\t|Name\t|Data Type\t|Metric / Dimension\t|Description\t|Aggregation Threshold\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Advertiser Setup\t|advertiser\t|STRING\t|Dimension\t|Advertiser name. Example: “Example Company”\t|LOW\t|\n","|Advertiser Setup\t|advertiser_id\t|LONG\t|Dimension\t|Customer-facing ID of advertiser. Example: 8443640090301\t|LOW\t|\n","|Campaign Setup\t|campaign\t|STRING\t|Dimension\t|Name of campaign (called “order” in DSP console)\t|LOW\t|\n","|Campaign Setup\t|campaign_id\t|LONG\t|Dimension\t|Customer-facing campaign ID\t|LOW\t|\n","|Creative Setup\t|creative\t|STRING\t|Dimension\t|Name of creative. Example: “Example Creative Name”\t|LOW\t|\n","|Creative Setup\t|creative_id\t|LONG\t|Dimension\t|Customer-facing creative ID. Example: 4301568770201\t|LOW\t|\n","|Creative Setup\t|creative_type\t|STRING\t|Dimension\t|Type of creative. Example: “Shazam HTML – AAP”\t|LOW\t|\n","|Advertiser Setup\t|entity_id\t|STRING\t|Dimension\t|Customer-facing ID of entity – can be found in the URL within the DSP console. Example: “ENTITYA6I16E0BHHHY”\t|LOW\t|\n","|Impression Delivery Info\t|impression_cost\t|LONG\t|Metric\t|Impression cost in millicents\t|NONE\t|\n","|Impression Delivery Info\t|impression_date\t|DATE\t|Dimension\t|MM/DD/YYYY (advertiser time zone)\t|LOW\t|\n","|Impression Delivery Info\t|impression_date_utc\t|DATE\t|Dimension\t|MM/DD/YYYY (UTC)\t|LOW\t|\n","|Impression Delivery Info\t|impression_day\t|INTEGER\t|Dimension\t|01 - 31 (advertiser time zone)\t|LOW\t|\n","|Impression Delivery Info\t|impression_day_utc\t|INTEGER\t|Dimension\t|01 - 31 (UTC)\t|LOW\t|\n","|Impression Delivery Info\t|impression_dt\t|TIMESTAMP\t|Dimension\t|Timestamp of impression in advertiser time zone. Example: 2019-06-18T03:45:55.000\t|MEDIUM\t|\n","|Impression Delivery Info\t|impression_dt_hour\t|TIMESTAMP\t|Dimension\t|Timestamp of impression in advertiser time zone truncated to hour. Example: 2019-06-18T03:00:00.000\t|LOW\t|\n","|Impression Delivery Info\t|impression_dt_hour_utc\t|TIMESTAMP\t|Dimension\t|Timestamp of impression in UTC truncated to hour. Example: 2019-06-18T08:00:00.000Z\t|LOW\t|\n","|Impression Delivery Info\t|impression_dt_utc\t|TIMESTAMP\t|Dimension\t|Timestamp of impression in UTC. Example: 2019-06-18T03:45:55.000\t|MEDIUM\t|\n","|Impression Delivery Info\t|impression_hour\t|INTEGER\t|Dimension\t|00 – 23 (advertiser time zone)\t|LOW\t|\n","|Impression Delivery Info\t|impression_hour_utc\t|INTEGER\t|Dimension\t|00 – 23 (UTC)\t|LOW\t|\n","|Impression Delivery Info\t|impressions\t|LONG\t|Metric\t|Count of each impression. For each impression event, this value will be 1, but the value can be summed, averaged, and so on across various dimensions\t|NONE\t|\n","|Line item setup\t|line_item\t|STRING\t|Dimension\t|Name of line item (ad)\t|LOW\t|\n","|Line item setup\t|line_item_id\t|LONG\t|Dimension\t|Customer-facing line item ID\t|LOW\t|\n","|Supply\t|supply_source\t|STRING\t|Dimension\t|Name of supply source (exchange). Example: “Amazon Publisher Services”\t|LOW\t|\n","|Costs\t|total_cost\t|LONG\t|Metric\t|Impression price plus computed agency fee in milli cents\t|LOW\t|\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"dsp\\_invalid\\_impressions"},"path":"/en-us/guides/traffic-events/data-sources","content":[" The dsp_invalid_impressions table records of all invalid impressions delivered to viewers. This includes potentially fraudulent, non-human, and other illegitimate traffic.\n","|Field Category\t|Name\t|Data Type\t|Metric / Dimension\t|Description\t|Aggregation Threshold\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Advertiser Setup\t|advertiser\t|STRING\t|Dimension\t|Advertiser name. Example: “Example Company”\t|MEDIUM\t|\n","|Advertiser Setup\t|advertiser_id\t|LONG\t|Dimension\t|Customer-facing ID of advertiser. Example: 8443640090301\t|MEDIUM\t|\n","|Campaign Setup\t|campaign\t|STRING\t|Dimension\t|Name of campaign (called “order” in DSP console)\t|MEDIUM\t|\n","|Campaign Setup\t|campaign_id\t|LONG\t|Dimension\t|Customer-facing campaign ID\t|MEDIUM\t|\n","|Advertiser Setup\t|entity_id\t|STRING\t|Dimension\t|Customer-facing ID of entity – can be found in the URL within the DSP console. Example: “ENTITYA6I16E0BHHHY”\t|MEDIUM\t|\n","|Impression Delivery Info\t|impression_date\t|DATE\t|Dimension\t|MM/DD/YYYY (advertiser time zone)\t|MEDIUM\t|\n","|Impression Delivery Info\t|impression_date_utc\t|DATE\t|Dimension\t|MM/DD/YYYY (UTC)\t|MEDIUM\t|\n","|Impression Delivery Info\t|invalid_impressions\t|LONG\t|Metric\t|The number of impressions removed by a traffic quality filter. This includes potentially fraudulent, non-human, and other illegitimate traffic\t|MEDIUM\t|\n","|Line item setup\t|line_item\t|STRING\t|Dimension\t|Name of line item (ad)\t|MEDIUM\t|\n","|Line item setup\t|line_item_id\t|LONG\t|Dimension\t|Customer-facing line item ID\t|MEDIUM\t|\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"dsp\\_views"},"path":"/en-us/guides/traffic-events/data-sources","content":[" The dsp_views table shows all view events and all measurable events. Measurable events are from impression that were able to be measured. Viewable events represent events that met a viewable standard. The metric viewable_impressions is the count of viewable impressions using the IAB standard (50% of the pixels of the impression were on screen for at least 1 second). Note the dsp_views table records a single impression more than one time if it is both measurable and viewable according to IAB standards. An impression that is both measurable and viewable according to IAB standards is recorded in one row as a measurable event and in another row as a viewable event. Note that while all impression events from dsp_views are recorded in dsp_impressions, not all impression events from dsp_impressions are recorded in dsp_views because not all impression events can be categorized as viewable, measurable or unmeasurable.\n","|Field Category\t|Name\t|Data Type\t|Metric / Dimension\t|Description\t|Aggregation Threshold\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Advertiser Setup\t|advertiser\t|STRING\t|Dimension\t|Advertiser name. Example: “Example Company”\t|LOW\t|\n","|Advertiser Setup\t|advertiser_id\t|LONG\t|Dimension\t|Customer-facing ID of advertiser. Example: 8443640090301\t|LOW\t|\n","|Campaign Setup\t|campaign\t|STRING\t|Dimension\t|Name of campaign (called “order” in DSP console)\t|LOW\t|\n","|Campaign Setup\t|campaign_id\t|LONG\t|Dimension\t|Customer-facing campaign ID\t|LOW\t|\n","|Creative Setup\t|creative\t|STRING\t|Dimension\t|Name of creative. Example: “Example Creative Name”\t|LOW\t|\n","|Creative Setup\t|creative_id\t|LONG\t|Dimension\t|Customer-facing creative ID. Example: 4301568770201\t|LOW\t|\n","|Creative Setup\t|creative_type\t|STRING\t|Dimension\t|Type of creative. Example: “Shazam HTML – AAP”\t|LOW\t|\n","|Advertiser Setup\t|entity_id\t|STRING\t|Dimension\t|Customer-facing ID of entity – can be found in the URL within the DSP console. Example: “ENTITYA6I16E0BHHHY”\t|LOW\t|\n","|Event Delivery Info\t|event_date\t|DATE\t|Dimension\t|Event Date (Advertiser Timezone)\t|MEDIUM\t|\n","|Event Delivery Info\t|event_date_utc\t|DATE\t|Dimension\t|Event Date (UTC)\t|MEDIUM\t|\n","|Event Delivery Info\t|event_dt\t|TIMESTAMP\t|Dimension\t|Event Timestamp (Advertiser Timezone)\t|MEDIUM\t|\n","|Event Delivery Info\t|event_dt_hour\t|TIMESTAMP\t|Dimension\t|Event Timestamp (Advertiser Timezone) Truncated to Hour\t|LOW\t|\n","|Event Delivery Info\t|event_dt_hour_utc\t|TIMESTAMP\t|Dimension\t|Event Timestamp (UTC) Truncated to Hour\t|LOW\t|\n","|Event Delivery Info\t|event_dt_utc\t|TIMESTAMP\t|Dimension\t|Event Timestamp (UTC). Example: 2019-06- 18T03:45:55.000\t|MEDIUM\t|\n","|Event Delivery Info\t|event_type\t|STRING\t|Dimension\t|Event Type\t|LOW\t|\n","|Event Delivery Info\t|events\t|LONG\t|Metric\t|Event Count\t|NONE\t|\n","|Line item setup\t|line_item\t|STRING\t|Dimension\t|Name of line item (ad)\t|LOW\t|\n","|Line item setup\t|line_item_id\t|LONG\t|Dimension\t|Customer-facing line item ID\t|LOW\t|\n","|Impression Viewability\t|measurable_impressions\t|LONG\t|Metric\t|Measurable impression count. Note that a single impression that is measurable could also be viewable, but not all measurable impressions are viewable. If an impression is both measurable and viewable, each event for the single impression is listed as a separate row.\t|LOW\t|\n","|Impression Viewability\t|unmeasurable_viewable_impressions\t|LONG\t|METRIC\t|Unmeasurable viewable impression count. These represent impressions at a normally view-aware supply source / placement that could not be measured due to special circumstances (such as using an uncommon browser) but were estimated to be viewable based on the usual view rate of the supply source / placement. Note that impressions which are served to a non-view-aware supply source / placement will NOT show up in this data source - use the display_impressions data source to query these impressions.\t|LOW\t|\n","|Impression Viewability\t|view_definition\t|LONG\t|METRIC\t|View Type (For Viewable Impressions)\t|LOW\t|\n","|Impression Viewability\t|viewable_impressions\t|LONG\t|Metric\t|Viewable impression count (IAB standard). Note that a single impression that is viewable has two events: a viewable impression and a measurable impression. Each event for the single impression is listed as a separate row.\t|LOW\t|\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":2,"text":"Ad Server Traffic"},"path":"/en-us/guides/traffic-events/data-sources","content":[],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"adserver_traffic"},"path":"/en-us/guides/traffic-events/data-sources","content":[" The data source adserver_traffic includes impressions, clicks, and interactions (video and view-ability) measured by the Amazon Ad Server. You can query this data source only if you have ad server campaigns.\n","|Field Category\t|Name\t|Data Type\t|Metric / Dimension\t|Description\t|Aggregation Threshold\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Ad setup\t|ad_format\t|STRING\t|Dimension\t|Ad Format (in-banner, in-stream video, rich media, etc.).\t|LOW\t|\n","|Ad setup\t|ad_id\t|LONG\t|Dimension\t|Ad ID, ad that is attached to a placement.\t|LOW\t|\n","|Advertiser setup\t|ad\t|STRING\t|Dimension\t|Amazon Ad Server brand name. A single Amazon Ad Server advertiser can have multiple brands. One campaign can be associated to a single brand.\t|LOW\t|\n","|Advertiser setup\t|advertiser\t|STRING\t|Dimension\t|Amazon Ad Server advertiser name.\t|LOW\t|\n","|Advertiser setup\t|advertiser_id\t|LONG\t|Dimension\t|Amazon Ad Server advertiser ID.\t|LOW\t|\n","|Campaign setup\t|campaign\t|STRING\t|Dimension\t|Amazon Ad Server Campaign Name, as appears in Ad Server (for display and search).\t|LOW\t|\n","|Campaign setup\t|campaign_id\t|LONG\t|Dimension\t|Amazon Ad Server Campaign ID (internal Amazon Ad Server IDs for display and search).\t|LOW\t|\n","|Click delivery info\t|clicks\t|LONG\t|Metric\t|Total clicks served, excluding GIVT. Includes all billable clicks served and tracked by Amazon Ad Server, among them click_sivt, click_ssai and click_noscript.\t|NONE\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_date\t|DATE\t|Dimension\t|Event Date (Amazon Ad Server account time zone).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_date_utc\t|DATE\t|Dimension\t|Event Date (UTC).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_day\t|INTEGER\t|Dimension\t|Event Day of Month (Amazon Ad Server account time zone).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_day_utc\t|INTEGER\t|Dimension\t|Event Day of Month (UTC).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_dt\t|TIMESTAMP\t|Dimension\t|Event Timestamp (Amazon Ad Server account time zone).\t|MEDIUM\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_dt_hour\t|TIMESTAMP\t|Dimension\t|Event Timestamp (Amazon Ad Server account time zone) Truncated to Hour.\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_dt_hour_utc\t|TIMESTAMP\t|Dimension\t|Event Timestamp (UTC) Truncated to Hour.\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_dt_utc\t|TIMESTAMP\t|Dimension\t|Event Timestamp (UTC). Example: 2019-06-18T03:45:55.000\t|MEDIUM\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_hour\t|INTEGER\t|Dimension\t|Event Hour of Day (Amazon Ad Server account time zone).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_hour_utc\t|INTEGER\t|Dimension\t|Event Hour of Day (UTC).\t|LOW\t|\n","|Impression delivery info\t|impressions\t|LONG\t|Metric\t|Total impressions served, excluding GIVT. Includes all billable impressions served and tracked by Amazon Ad Server, among them impressions_sivt, impressions_ssai and impressions_noscript.\t|NONE\t|\n","|Impression delivery info\t|measurable_impressions\t|LONG\t|Metric\t|Number of impressions served in campaigns that were enabled for viewability measurement. Note that only campaigns with verification data collection mode are measured for viewability. This metric will be 0 if campaign is not enabled for verification data collection.\t|NONE\t|\n","|Impression delivery info\t|recordable_impressions\t|LONG\t|Metric\t|Number of impressions (out of measurable_impressions) that were successfully recorded for viewability evaluation. For example, viewability signal cannot be collected for impression served in unfriendly iframe and so such impression will not be recorded for viewability. Note that this metric will be 0 if campaign is not enabled for verification data collection.\t|NONE\t|\n","|Interaction info\t|video_percentage_complete\t|LONG\t|Metric\t|Average % of the video viewed. e.g. on avg video viewed to 47% of its completion.\t|NONE\t|\n","|Interaction info\t|video_played_100pc\t|LONG\t|Metric\t|Number of times when video played to its full completion.\t|NONE\t|\n","|Interaction info\t|video_played_100pc_viewable\t|LONG\t|Metric\t|Number of times when video played to its full completion and impression was viewable.\t|NONE\t|\n","|Interaction info\t|video_played_25pc\t|LONG\t|Metric\t|Number of times when video played only to 25% of its completion.\t|NONE\t|\n","|Interaction info\t|video_played_25pc_viewable\t|LONG\t|Metric\t|Number of times when video played only to 25% of its completion and impression was viewable.\t|NONE\t|\n","|Interaction info\t|video_played_50pc\t|LONG\t|Metric\t|Number of times when video played only to 50% of its completion.\t|NONE\t|\n","|Interaction info\t|video_played_50pc_viewable\t|LONG\t|Metric\t|Number of times when video played only to 50% of its completion and impression was viewable.\t|NONE\t|\n","|Interaction info\t|video_played_75pc\t|LONG\t|Metric\t|Number of times when video played only to 75% of its completion.\t|NONE\t|\n","|Interaction info\t|video_played_75pc_viewable\t|LONG\t|Metric\t|Number of times when video played only to 75% of its completion and impression was viewable.\t|NONE\t|\n","|Impression delivery info\t|viewable_impressions\t|LONG\t|Metric\t|Number of viewable impression (IAB standard). Note, viewability signals collected only for campaigns where verification data collection mode was enabled. This metric will be 0 if campaign is not enabled for verification data collection.\t|\t|\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"invalid\\_adserver\\_traffic"},"path":"/en-us/guides/traffic-events/data-sources","content":["|Field Category\t|Name\t|Data Type\t|Metric / Dimension\t|Description\t|Aggregation Threshold\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Ad setup\t|ad_format\t|STRING\t|Dimension\t|Ad Format (in-banner, in-stream video, rich media, etc.).\t|LOW\t|\n","|Ad setup\t|ad_id\t|LONG\t|Dimension\t|Ad ID, ad that is attached to a placement.\t|LOW\t|\n","|Advertiser setup\t|ad\t|STRING\t|Dimension\t|Amazon Ad Server brand name. A single Amazon Ad Server advertiser can have multiple brands. One campaign can be associated to a single brand.\t|LOW\t|\n","|Advertiser setup\t|advertiser\t|STRING\t|Dimension\t|Amazon Ad Server advertiser name.\t|LOW\t|\n","|Advertiser setup\t|advertiser_id\t|LONG\t|Dimension\t|Amazon Ad Server advertiser ID.\t|LOW\t|\n","|Campaign setup\t|campaign\t|STRING\t|Dimension\t|Amazon Ad Server Campaign Name, as appears in Ad Server (for display and search).\t|LOW\t|\n","|Campaign setup\t|campaign_id\t|LONG\t|Dimension\t|Amazon Ad Server Campaign ID (internal Amazon Ad Server IDs for display and search).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_date\t|DATE\t|Dimension\t|Event Date (Amazon Ad Server account time zone).\t|LOW\t|\n","|Event (impression, Click, Interaction, Conversion) Delivery Info\t|event_date_utc\t|DATE\t|Dimension\t|Event Date (UTC).\t|LOW\t|\n","|Impression delivery info\t|invalid_clicks\t|LONG\t|Metric\t|Total clicks served, excluding GIVT. Includes all billable clicks served and tracked by Amazon Ad Server, among them clicks_sivt, clicks_ssai and clicks_noscript.\t|NONE\t|\n","|Impression delivery info\t|invalid_impressions\t|LONG\t|Metric\t|Total impressions served, excluding GIVT. Includes all billable impressions served and tracked by Amazon Ad Server, among them impressions_sivt, impressions_ssai and impressions_noscript.\t|NONE\t|\n","|Impression delivery info\t|invalid_measurable_impressions\t|LONG\t|Metric\t|Number of impressions served in campaigns that were enabled for viewability measurement. Note that only campaigns with verification data collection mode are measured for viewability. This metric will be 0 if campaign is not enabled for verification data collection.\t|NONE\t|\n","|Impression delivery info\t|invalid_recordable_impressions\t|LONG\t|Metric\t|Number of impressions (out of measurable_impressions) that were successfully recorded for viewability evaluation. For example, viewability signal cannot be collected for impression served in unfriendly iframe and so such impression will not be recorded for viewability. Note that this metric will be 0 if campaign is not enabled for verification data collection.\t|NONE\t|\n","|Interaction info\t|invalid_video_percentage_complete\t|LONG\t|Metric\t|Average % of the video viewed. e.g. on avg video viewed to 47% of its completion.\t|NONE\t|\n","|Interaction info\t|invalid_video_played_100pc\t|LONG\t|Metric\t|Number of times when video played to its full completion.\t|NONE\t|\n","|Interaction info\t|invalid_video_played_100pc_viewable\t|LONG\t|Metric\t|Number of times when video played to its full completion and impression was viewable.\t|NONE\t|\n","|Interaction info\t|invalid_video_played_25pc\t|LONG\t|Metric\t|Number of times when video played only to 25% of its completion.\t|NONE\t|\n","|Interaction info\t|invalid_video_played_25pc_viewable\t|LONG\t|Metric\t|Number of times when video played only to 25% of its completion and impression was viewable.\t|NONE\t|\n","|Interaction info\t|invalid_video_played_50pc\t|LONG\t|Metric\t|Number of times when video played only to 50% of its completion.\t|NONE\t|\n","|Interaction info\t|invalid_video_played_50pc_viewable\t|LONG\t|Metric\t|Number of times when video played only to 50% of its completion and impression was viewable.\t|NONE\t|\n","|Interaction info\t|invalid_video_played_75pc\t|LONG\t|Metric\t|Number of times when video played only to 75% of its completion.\t|NONE\t|\n","|Interaction info\t|invalid_video_played_75pc_viewable\t|LONG\t|Metric\t|Number of times when video played only to 75% of its completion and impression was viewable.\t|NONE\t|\n","|Impression delivery info\t|invalid_viewable_impressions\t|LONG\t|Metric\t|Number of viewable impression (IAB standard). Note, viewability signals collected only for campaigns where verification data collection mode was enabled. This metric will be 0 if campaign is not enabled for verification data collection.\t|NO\t|\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":2,"text":" Sponsored Ads"},"path":"/en-us/guides/traffic-events/data-sources","content":[],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"sponsored\\_ads\\_traffic"},"path":"/en-us/guides/traffic-events/data-sources","content":["|Field Category\t|Name\t|Data Type\t|Metric / Dimension\t|Description\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|Ad Group Setup\t|ad_group\t|STRING\t|Dimension\t|Name of ad group. The value for line_item matches ad_group.\t|\n","|Ad Product Info\t|ad_product_type\t|STRING\t|Dimension\t|The ad product of the campaign. Example: sponsored_products or sponsored_display.\t|\n","|Ad Product Info\t|ad_product_type_code\t|STRING\t|Dimension\t|The ad product code of the campaign. Example: SP or SB.\t|\n","|Advertiser Setup\t|advertiser\t|STRING\t|Dimension\t|Advertiser name. Example: “Example Company”\t|\n","|Advertiser Setup\t|advertiser_id_internal\t|LONG\t|Dimension\t|Internal Advertiser Id. Example: 12345\t|\n","|Campaign Setup\t|campaign\t|STRING\t|Dimension\t|Campaign Name. Example: “My Great Campaign”\t|\n","|Click Delivery Info\t|clicks\t|LONG\t|Metric\t|Count of each click. For each click event, this value will be 1, but the value can be summed, averaged, and so on across various dimensions\t|\n","|Creative Setup\t|creative\t|STRING\t|Dimension\t|Creative Name\t|\n","|Creative Setup\t|creative_type\t|STRING\t|Dimension\t|Type of creative. Example: “Shazam HTML – AAP”\t|\n","|Advertiser Setup\t|entity_id\t|STRING\t|Dimension\t|Customer-facing ID of entity – can be found in the URL within the advertising console. Example: “ENTITYA6I16E0BHHHY”\t|\n","|Event (impression or Click) Delivery Info\t|event_date\t|DATE\t|Dimension\t|Event Date (Advertiser Timezone)\t|\n","|Event (impression or Click) Delivery Info\t|event_date_utc\t|DATE\t|Dimension\t|Event Date (UTC)\t|\n","|Event (impression or Click) Delivery Info\t|event_day\t|INTEGER\t|Dimension\t|Event Day of Month (Advertiser Timezone)\t|\n","|Event (impression or Click) Delivery Info\t|event_day_utc\t|INTEGER\t|Dimension\t|Event Day of Month (UTC)\t|\n","|Event (impression or Click) Delivery Info\t|event_dt\t|TIMESTAMP\t|Dimension\t|Event Timestamp (Advertiser Timezone)\t|\n","|Event (impression or Click) Delivery Info\t|event_dt_hour\t|TIMESTAMP\t|Dimension\t|Event Timestamp (Advertiser Timezone) Truncated to Hour\t|\n","|Event (impression or Click) Delivery Info\t|event_dt_hour_utc\t|TIMESTAMP\t|Dimension\t|Event Timestamp (UTC) Truncated to Hour\t|\n","|Event (impression or Click) Delivery Info\t|event_dt_utc\t|TIMESTAMP\t|Dimension\t|Event Timestamp (UTC). Example: 2019-06- 18T03:45:55.000\t|\n","|Event (impression or Click) Delivery Info\t|event_hour\t|INTEGER\t|Dimension\t|Event Hour of Day (Advertiser Timezone)\t|\n","|Event (impression or Click) Delivery Info\t|event_hour_utc\t|INTEGER\t|Dimension\t|Event Hour of Day (UTC)\t|\n","|Event (impression or Click) Delivery Info\t|event_source\t|STRING\t|Dimension\t|Internal system that generated event.\t|\n","|Impression Delivery Info\t|impressions\t|LONG\t|Metric\t|Count of each impression. For each impression event, this value will be 1, but the value can be summed, averaged, and so on across various dimensions\t|\n","|Line item setup\t|line_item\t|STRING\t|Dimension\t|Name of ad group. The value for line_item matches ad_group.\t|\n","|Line item setup\t|line_item_id\t|LONG\t|Dimension\t|Customer-facing line item ID. For Sponsored Products, the value for line_item_id matches ad_group_id. For Sponsored Display, this value will be NULL. Use ad_group_id.\t|\n","|Line item setup\t|line_item_price_type\t|STRING\t|Dimension\t|The cost structure is identified using line_item_price_type, which has two values for Sponsored Display campaigns: CPC or VCPM. When the value is VCPM, viewability is measured for Sponsored Display. See also viewable_impressions. Sponsored Products has a cost structure of CPC only. (CPC is cost-per-click and vCPM is cost per thousand viewable impressions.)\t|\n","|Advertiser Setup\t|marketplace_id\t|INTEGER\t|Dimension\t|Marketplace Id\t|\n","|Impression Viewability\t|view_definition\t|STRING\t|Dimension\t|For Sponsored Display, view_definition is either NULL or iab. The value is iab when the event was a viewable impression. This field will not contain iab for campaigns that were view aware. Instead, it is only iab when the actual event was a viewable impression. For Sponsored Products, this value is always NULL. See also viewable_impressions, and line_item_price_type for additional information.\t|\n","|Impression Viewability\t|unmeasurable_viewable_impressions\t|LONG\t|Metric\t|Unmeasurable viewable impression count for Sponsored Display only that could not be measured due to special circumstances (such as using an uncommon browser) but were estimated to be viewable based on the usual view rate of the placement. For every unmeasurable viewable impression event, there is a separate viewable impression event. Therefore, unmeasurable_viewable_impressions and viewable_impressions should not be added to avoid double counting viewable impressions. See also viewable_impressions, and line_item_price_type for additional information.\t|\n","|Impression Viewability\t|viewable_impressions\t|LONG\t|Metric\t|The number of impressions shoppers viewed as per the Media Rating Council (MRC) / Interactive Advertising Bureau (IAB) viewability standard. A display ad is viewable if 50% of pixels were viewable for at least 1 second. Viewable impression counts are available when you use optimize for viewable impressions bidding option. When line_item_price_type = VCPM, the campaign was charged on a cost per thousand viewable impressions basis and views were measured. If an event is a viewable impression, there is also a separate impression event recorded under impressions. See the instructional query \"How to query Sponsored Display traffic\" to learn how to calculate viewability rate. Viewable impressions only apply to Sponsored Display. See also view_definition and unmeasurable_viewable_impressions.\t|\n","|Impression Info\t|five_sec_views\t|LONG\t|Metric\t|The number of impressions where the video was viewed for 5 seconds (or 100% if the video length is less than 5 sec).\t|\n","|Impression Delivery Info\t|video_complete_views\t|LONG\t|Metric\t|The number of impressions where the video was viewed to 100%.\t|\n","|Impression Delivery Info\t|video_first_quartile_views\t|LONG\t|Metric\t|The number of impressions where the video was viewed to 25%.\t|\n","|Impression Delivery Info\t|video_midpoint_views\t|LONG\t|Metric\t|The number of impressions where the video was viewed to 50%.\t|\n","|Impression Delivery Info\t|video_third_quartile_views\t|LONG\t|Metric\t|The number of impressions where the video was viewed to 75%.\t|\n","|Impression Delivery Info\t|video_unmutes\t|LONG\t|Metric\t|The number of impressions where a shopper unmuted the video.\t|\n"],"documentType":"guide"},{"title":"Traffic events API data sources","sectionHeader":{"type":3,"text":"sponsored\\_ads\\_invalid\\_traffic"},"path":"/en-us/guides/traffic-events/data-sources","content":[" The number of traffic removed by the traffic quality filter. This includes potentially fraudulent, non-human, and other illegitimate traffic.\n","|Field Category\t|Name\t|Data Type\t|Metric / Dimension\t|Description\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|Ad Group Setup\t|ad_group\t|STRING\t|Dimension\t|Name of ad group. The value for line_item matches ad_group.\t|\n","|Ad Product Info\t|ad_product_type\t|STRING\t|Dimension\t|The ad product of the campaign. Example: sponsored_products or sponsored_display.\t|\n","|Advertiser Setup\t|advertiser\t|STRING\t|Dimension\t|Advertiser name. Example: “Example Company”\t|\n","|Campaign Setup\t|campaign\t|STRING\t|Dimension\t|Campaign Name. Example: “My Great Campaign”\t|\n","|Click Delivery Info\t|invalid_clicks\t|LONG\t|Metric\t|Count of each invalid click. For each invalid click event, this value will be 1, but the value can be summed, averaged, and so on across various dimensions\t|\n","|Advertiser Setup\t|entity_id\t|STRING\t|Dimension\t|Customer-facing ID of entity – can be found in the URL within the advertising console. Example: “ENTITYA6I16E0BHHHY”\t|\n","|Event (impression or Click) Delivery Info\t|event_date\t|DATE\t|Dimension\t|Event Date (Advertiser Timezone)\t|\n","|Event (impression or Click) Delivery Info\t|event_date_utc\t|DATE\t|Dimension\t|Event Date (UTC)\t|\n","|Impression Delivery Info\t|invalid_impressions\t|LONG\t|Metric\t|Count of each invalid impression. For each invalid impression event, this value will be 1, but the value can be summed, averaged, and so on across various dimensions\t|\n","|Line item setup\t|line_item\t|STRING\t|Dimension\t|Name of ad group. The value for line_item matches ad_group.\t|\n","|Line item setup\t|line_item_id\t|LONG\t|Dimension\t|Customer-facing line item ID. For Sponsored Products, the value for line_item_id matches ad_group_id. For Sponsored Display, this value will be NULL. Use ad_group_id.\t|\n"],"documentType":"guide"},{"title":"Querying data in the traffic events API data","sectionHeader":null,"path":"/en-us/guides/traffic-events/querying-data","content":[" Traffic events API provides you with the ability to execute SQL queries, referred to as \"Workflow Executions\".\n"],"documentType":"guide"},{"title":"Querying data in the traffic events API data","sectionHeader":{"type":2,"text":"Workflow executions"},"path":"/en-us/guides/traffic-events/querying-data","content":[" The Workflow is a SQL query that is mapped to an identifier (workflowId) that you provide. This workflowId is defined by you and can include numbers and letters (for example, StreamingTVPerformanceReport2023). A workflow execution is an instance of the workflow that you run to produce the report.\n"],"documentType":"guide"},{"title":"Querying data in the traffic events API data","sectionHeader":{"type":3,"text":"Create a workflow execution"},"path":"/en-us/guides/traffic-events/querying-data","content":[" To execute a workflow, you will need to pass the workflow definition as a mandatory parameter to the Create Workflow Execution API. You can also include some optional parameters as part of the body of the request to further customize the report of your query/workflow outputs.\n"," For this tutorial, to create a workflow execution use the POST operation of the workflowexecutions resource.\n"," The workflow definition that you include in your request has the following mandatory parameters:\n","workflowId: This is an alphanumeric string that you will specify. Workflow identifiers can only contain alphanumeric characters, periods, dashes, and underscores, without any spaces. \\* sqlQuery: The SQL script to use to construct and output your report. The query must be a single-line query and stripped of tabs and new-line delimiters before added to the JSON object. Semicolons are not required at the end of the query.\n"," Assume you want to create a workflow execution with a basic query and include a unique name that you will refer to in order to identify the workflow later. The following SQL query returns the total number of impressions, clicks, and viewable impressions per campaign.\n"," To pass the above query in the sqlQuery parameter, remove all line breaks so that the query is a single line query that JSON will be able to support.\n"," Name this workflow my-first-workflow.\n"," In this example, the optional timeWindow parameter is not included, so the default time window of MOST_RECENT_DAY will be used.\n"," In this example, aggregation threshold columns are appended as additional body parameters.\n"," Sample request\n"," The result of running this workflow will output the columns campaign, impressions, clicks, and viewable_impressions, listing the names of the campaigns with a total impressions, clicks, and viewable impressions for each campaign in the last day.\n"," A successful call returns an HTTP status code: 200 OK. You can use the workflowExecutionId to schedule retrieval of information on the workflow execution and to download the resulting report once the workflow execution has entered a SUCCEEDED state.\n"," Different fields (columns) in the traffic events API have different requirements in terms of minimum user granularity counts contained in the aggregated query results.\n"," After you define your basic SQL query, the workflows resource also accepts parameters to further qualify the output of your query. Column outputs are classified into categories based on the combination of the aggregation threshold level and the filtering restrictions, which we refer to as aggregation threshold. When defining your workflow, you can append these aggregation threshold columns with the help of the filteredMetricsDiscriminatorColumn parameter.\n"," By default, rows that do not meet the minimum distinct user count requirements will be completely filtered out of the workflow output.\n"," If the filteredMetricsDiscriminatorColumn parameter is included when defining a workflow, then rows that do not meet the minimum distinct user count requirements will have values removed and then the output will be re-aggregated with AggregationType.SUM. The value you provide for the filteredMetricsDiscriminatorColumn parameter becomes the heading of the Boolean column that will be added to the workflow output. This Boolean column identifies rows with and without values in columns removed. Unchanged rows will have a value of FALSE for this column, while rows with fields removed will have a value of TRUE.\n"," This field is entered in the workflow definition as a top-level field:\n"," In the above example, the workflow will output a column titled \"filtered\" that will contain Boolean values.\n"," Example: Filtering behavior with and without filteredMetricsDiscriminatorColumn\n"," Example Raw Data\n","|impressions (metric) (NONE)\t|clicks (metric) NONE\t|event_date (dimension) (LOW)\t|impressions distinct user count\t|clicks distinct user count\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|5\t|1\t|10/1/2023\t|5\t|1\t|\n","|10\t|2\t|10/2/2023\t|7\t|2\t|\n","|4\t|2\t|10/3/2023\t|1\t|1\t|\n","|5\t|1\t|10/4/2023\t|1\t|1\t|\n"," After Executing Workflow without filteredMetricsDiscriminatorColumn\n"," The three rows where the distinct user count of either impressions, clicks, or both is less than 2 are omitted from the output.\n","|impressions (metric) (NONE)\t|clicks (metric) NONE\t|event_date (dimension) (LOW)\t|\n","|---\t|---\t|---\t|\n","|10\t|2\t|10/2/2023\t|\n"," After Executing Workflow with filteredMetricsDiscriminatorColumn of \"filtered\"\n"," The three rows where the distinct user count of either impressions, clicks, or both is less than 2 are included in the output. For these rows, columns with an aggregation threshold of less than 2 have values of NULL and the filteredMetricsDiscriminatorColumn, \"filtered\" is set to TRUE. The first, third and fourth rows of the original table are re-aggregated into a single row after the filtering.\n","|impressions (metric) (NONE)\t|clicks (metric) NONE\t|event_date (dimension) (LOW)\t|Filtered (dimension) NONE\t|\n","|---\t|---\t|---\t|---\t|\n","|10\t|2\t|10/2/2023\t|FALSE\t|\n","|14\t|4\t|NULL\t|TRUE\t|\n"," The timeWindow parameter of the workflow execution controls the date range over which you wish to query data. The timeWindow object has the following parameters:\n","type: The time window type. See Time Window Type. - timezone: The timezone for the time window. Default is UTC. The timezone should be in the timezone identifier form, for example America/Los_Angeles. For a full list of supported timezones see List of timezones - start: The start date time for the time window. Only use this when using a timeWindow type of EXPLICIT. - end: The end date time for the time window. Only use this when using a timeWindow type of EXPLICIT.\n"," The type of time window to use for specifying input data for the workflow execution. If not provided, the time window type of MOST_RECENT_DAY will be used.\n","EXPLICIT: The start and end of the time window must be explicitly provided in the request. - MOST_RECENT_HOUR: The time window will be the most recent hour for which the system has data. - MOST_RECENT_24_HOURS: The time window will be the most recent 24 hour period for which the system has data. - MOST_RECENT_DAY: The time window will be the most recent 1-day window for which the instance is likely to have data, aligned to day boundaries. - MOST_RECENT_WEEK: The time window will be the most recent 1-week window for which the instance is likely to have data, aligned to day boundaries. - CURRENT_MONTH: The time window will be the start of the current month up to the most recent time for which the instance is likely to have data. - PREVIOUS_MONTH: The time window will be the entire previous month.\n"," Sample Request \n"," In this sample request, the same workflow definition is used as previously, but now a timeWindow parameter is included to control the date range of the query.\n"," After you run the workflow execution, the traffic events API returns a workflow execution ID (workflowExecutionId) that you will need to retrieve from the results.\n"," Sample response\n"," The traffic events API has a limit of 5 active query executions (that is, query executions with the status of running or pending). Any requests to create an execution over this limit will result in an HTTP 422 Service Limit Exceeded Error. For example, if there are 5 active executions, a request to create the 6th execution will return an HTTP 422 status code with the following error message:\n"],"documentType":"guide"},{"title":"Querying data in the traffic events API data","sectionHeader":{"type":3,"text":"View a workflow execution"},"path":"/en-us/guides/traffic-events/querying-data","content":[" Possible workflow execution statuses\n","|Status Name\t|Description\t|\n","|---\t|---\t|\n","|PENDING\t|The workflow execution has not yet started running. It may be queueing to run, waiting for data to become available, or waiting until a specified time.\t|\n","|RUNNING\t|The workflow execution is running.\t|\n","|SUCCEEDED\t|The workflow execution has finished successfully.\t|\n","|FAILED\t|The workflow execution failed.\t|\n"," For details on the response parameters, see response of POST operation of the workflowExecutions\n"],"documentType":"guide"},{"title":"Querying data in the traffic events API data","sectionHeader":{"type":3,"text":"Download your report"},"path":"/en-us/guides/traffic-events/querying-data","content":[" To retrieve a pre-signed URL for downloading workflow execution results from S3, copy the workflowExecutionId from the response returned in the POST operation of the workflowExecutions resource.\n"," In this example, the workflowExecutionId is: 2b04762b-cbdb-47c7-be39-42a585ecd40e. Now, pass the instance identifier and the workflow execution identifier you retrieved as path parameters in the following request:\n"," This request will return a URL where your report can be directly downloaded. Copy the URL and enter it into a browser to download the resulting CSV file. It may take some time for the report to generate. Wait until the workflow execution is in a SUCCEEDED status to download your report. If your report is not ready, you will receive an HTTP 404 error stating that the download URL is not found.\n"],"documentType":"guide"},{"title":"Querying data in the traffic events API data","sectionHeader":{"type":3,"text":"View workflow executions"},"path":"/en-us/guides/traffic-events/querying-data","content":[" Returns workflow execution details for a specific workflow execution identifier.\n"],"documentType":"guide"},{"title":"Querying data in the traffic events API data","sectionHeader":{"type":3,"text":"View all workflow executions"},"path":"/en-us/guides/traffic-events/querying-data","content":[" In addition to being able to query a single workflow execution to retrieve its status, you can list your previously created workflow executions using the ListWorkflowExecutions API.\n"],"documentType":"guide"},{"title":"invalid traffic vendor","sectionHeader":null,"path":"/en-us/guides/traffic-events/ivt","content":[" Advertisers can run invalid traffic vendor (IVT) queries on ad events served by sponsored ads or Amazon demand-side platform (Amazon DSP) against a third-party vendor data set.\n"," To initiate an IVT query, use the POST /avc/workflowexecutions endpoint with the request body structured as below:\n"," Eligible vendors\n"," Replace VendorName with the appropriate vendor name in the request. Currently, the following vendors are supported:\n","AdLoox \\* IAS (Integral Ad Science)\n"," Supported timeWindow types\n"," The following types of time windows can be used for specifying input data for the IVT workflow execution.\n","EXPLICIT : The start and end date of the time window must be explicitly provided in the request. Note that the start date-time and end date-time must be in the following format 00:00:00\n","MOST_RECENT_WEEK : The time window will be the most recent 1-week window for which the instance is likely to have data, aligned to day boundaries.\n","CURRENT_MONTH : The time window will be the start of the current month up to the most recent time for which the instance is likely to have data.\n"],"documentType":"guide"},{"title":"invalid traffic vendor","sectionHeader":{"type":3,"text":"Sample request body"},"path":"/en-us/guides/traffic-events/ivt","content":[],"documentType":"guide"},{"title":"invalid traffic vendor","sectionHeader":{"type":3,"text":"Sample response"},"path":"/en-us/guides/traffic-events/ivt","content":[],"documentType":"guide"},{"title":"invalid traffic vendor","sectionHeader":{"type":2,"text":"Report eligibility"},"path":"/en-us/guides/traffic-events/ivt","content":[" To be able to run IVT reports, advertisers need to have a relationship with the IVT vendors.\n","To be able to run reports with AdLoox, reach out to amazon@adloox.com. - To be able to run reports with IAS, reach out to AmazonSupport@integralads.com.\n"," If you have further questions on eligibility and vendor selection, please contact us.\n"],"documentType":"guide"},{"title":"invalid traffic vendor","sectionHeader":{"type":2,"text":"Data availability"},"path":"/en-us/guides/traffic-events/ivt","content":[" Data becomes available in TCR within 96 hours after vendors share relevant advertiser IDs with Amazon.\n"],"documentType":"guide"},{"title":"invalid traffic vendor","sectionHeader":{"type":2,"text":"Report outputs"},"path":"/en-us/guides/traffic-events/ivt","content":[],"documentType":"guide"},{"title":"invalid traffic vendor","sectionHeader":{"type":3,"text":"Sponsored ads campaigns"},"path":"/en-us/guides/traffic-events/ivt","content":["| advertiser_name | advertiser_cfid | campaign_name | campaign_cfid | vendor | event_date_utc | gross_impressions | adloox_invalid_impressions | report_run_date | filtered_reason |\n","\\| ------------------- \\| ---------------- \\| ----------------------------------------- \\| -------------- \\| ------ \\| ---------------- \\| ------------------ \\| ---------------------------- \\| ----------------- \\| ---------------- \\|\n","| Accent Athletics SA |                  | Accent Athletics sponsored ads campaign1 |                | AdLoox | 10/1/2024        | 1750               | 2                            | 10/17/2024        |                  |\n","| Accent Athletics SA |                  | Accent Athletics sponsored ads campaign1 |                | AdLoox | 10/2/2024        | 176                | 0                            | 10/17/2024        |                  |\n","| Accent Athletics SA |                  | Accent Athletics sponsored ads campaign2 |                | AdLoox | 10/1/2024        | 12215              | 7                            | 10/17/2024        |                  |\n","| Accent Athletics SA |                  | Accent Athletics sponsored ads campaign2 |                | AdLoox | 10/2/2024        | 12196              | 21                           | 10/17/2024        |                  |\n"],"documentType":"guide"},{"title":"invalid traffic vendor","sectionHeader":{"type":3,"text":"Amazon DSP campaigns"},"path":"/en-us/guides/traffic-events/ivt","content":["| advertiser_name | advertiser_cfid | campaign_name | campaign_cfid | vendor | event_date_utc | gross_impressions | IAS_invalid_impressions | report_run_date | filtered_reason |\n","\\| -------------------- \\| ---------------- \\| ------------------------------------- \\| -------------- \\| ------ \\| ---------------- \\| ------------------ \\| ------------------------- \\| ----------------- \\| ---------------- \\|\n","| Accent Athletics DSP | 123456789        | Accent Athletics DSP campaign name 1 | 987654321      | IAS    | 10/1/2024        | 1750               | 2                         | 10/17/2024        |                  |\n","| Accent Athletics DSP | 123456789        | Accent Athletics DSP campaign name 1  | 987654321      | IAS    | 10/2/2024        | 176                | 0                         | 10/17/2024        |                  |\n","| Accent Athletics DSP | 123456789        | Accent Athletics DSP campaign name 2 | 9876543210     | IAS    | 10/1/2024        | 3132               | 10                        | 10/17/2024        |                  |\n","| Accent Athletics DSP | 123456789        | Accent Athletics DSP campaign name 2  | 9876543210     | IAS    | 10/2/2024        | 9526               | 85                        | 10/17/2024        |                  |\n"],"documentType":"guide"},{"title":"invalid traffic vendor","sectionHeader":{"type":3,"text":"Report column name definitions"},"path":"/en-us/guides/traffic-events/ivt","content":["| Column name | Description |\n","\\| ---------------------------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \\|\n","| advertiser_name | Name of the sponsored ads or Amazon DSP advertiser specified in the report header. |\n","| advertiser_cfid | ID of the Amazon DSP advertiser specified in the report header. |\n","| campaign_name | Name of the sponsored ads or Amazon DSP campaign. |\n","| campaign_cfid | ID of the Amazon DSP campaign. |\n","| vendor | Name of the vendor specified in the report query. |\n","| event_date_utc | Date of the impression events, in Coordinated Universal Time (UTC). |\n","| gross_impressions | Total number of impressions against which the query was run. |\n","| adloox_invalid_impressions | If the vendor specified in the query was AdLoox, this column will show the number of impressions that were classified as invalid according to AdLoox. |\n","| ias_invalid_impressions | If the vendor specified in the query was IAS, this column will show the number of impressions that were classified as invalid according to IAS. |\n","| report_run_date | Date when the report was run. |\n","| filtered_reason | This column will be empty unless the number of events for a particular campaign did not meet the aggregation threshold. |\n"],"documentType":"guide"},{"title":"page url report","sectionHeader":null,"path":"/en-us/guides/traffic-events/page_url","content":[" The page URL report allows Amazon DSP advertisers to view impression data organized by page URL across selected campaigns, and line items during a defined time period.\n"],"documentType":"guide"},{"title":"page url report","sectionHeader":{"type":2,"text":"Querying the page URL report"},"path":"/en-us/guides/traffic-events/page_url","content":[" To initiate the page URL report, use the POST /avc/workflowexecutions endpoint with the request body structured as below:\n"],"documentType":"guide"},{"title":"page url report","sectionHeader":{"type":3,"text":"Supported `timeWindow` types"},"path":"/en-us/guides/traffic-events/page_url","content":[" The following types of time windows can be used for specifying input data for the page URL workflow execution.\n","EXPLICIT : The start and end date of the time window must be explicitly provided in the request. Note that the start date-time and end date-time must be in the following format: 00:00:00.\n","MOST_RECENT_WEEK: The time window will be the most recent 1-week window for which the instance is likely to have data, aligned to day boundaries.\n","CURRENT_MONTH: The time window will be the start of the current month up to the most recent time for which the instance is likely to have data.\n"],"documentType":"guide"},{"title":"page url report","sectionHeader":{"type":3,"text":"Report eligibility"},"path":"/en-us/guides/traffic-events/page_url","content":[" The Page URL report is available to all Amazon DSP advertisers free of cost.\n"],"documentType":"guide"},{"title":"page url report","sectionHeader":{"type":3,"text":"Data availability"},"path":"/en-us/guides/traffic-events/page_url","content":["Data in page URL reports is available starting from November 1, 2025, and cannot be accessed retroactively.\n","Page URL data will be available in this report within 48 hours of serving impressions, though occasional delays may occur.\n","The maximum lookback period of the report is 12 months. Data starts accumulating from November 1st, 2025 to a maximum of 12 months.\n"],"documentType":"guide"},{"title":"page url report","sectionHeader":{"type":3,"text":"Sample report outputs"},"path":"/en-us/guides/traffic-events/page_url","content":["| campaign_id | line_item_id | supply_source | page_url | total_impressions_served | report_run_date |\n","\\|----\\|----\\|----\\|----\\|----\\|----\\| \n","| 111111111111111111 | 1234567891234 | Magnite DV+ | abc.de/123/durh | 543 | 2025-03-24 |\n","| 22222222222222 | 0987654321098 | PubMatic | example.de/iusjgei/ | 2 | 2025-03-24 |\n","| 33333333333 | 567890987654 | Amazon Media | Twitch.com | 65 | 2025-03-24 |\n"],"documentType":"guide"},{"title":"page url report","sectionHeader":{"type":3,"text":"Report column name definitions"},"path":"/en-us/guides/traffic-events/page_url","content":["| Column name | Description |\n","\\|-----\\|------------------\\|\n","| page_url | The full URL of the page on which the ad appeared, as derived from the bid request. Note that the URL may, in some cases, be truncated by supply partners. For Amazon-owned inventory, only the top-level domain is shown. |\n","| campaign_id | Campaign ID for the campaign. |\n","| line_item_id | Line item ID for the campaign. |\n","| total_impressions_served | Total number of impressions served on the page URL. |\n","| supply_source | Consolidated name of the supply source (exchange). Example: Amazon Media. |\n","| report_run_date | Date when the report was run. |\n"],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":null,"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[" Advertisers use the traffic events API to perform analytics easily across multiple, pseudonymized data sets to generate aggregated reports. To protect the privacy of shoppers exposed to ads, privacy safeguards are in place that are apparent when you query the data. The privacy safeguards prevent traffic events API users from exporting data at a grain that would violate the privacy safeguards. The aggregation threshold of a column determines the restrictions that are enforced to ensure customer privacy safeguards are not violated if a column is used in a workflow.\n"," Before reviewing the various aggregation threshold levels, it will be helpful to highlight a practical example of the column user_id, which has an aggregation threshold of \"very high\" and is used in many traffic events API queries. In practice, an aggregation threshold level of \"very high\" means that you will never be able to select the column in the final SELECT statement of a SQL query because this statement would expose the values of the column in the final output. In this example, selecting the actual user_id in the final SELECT statement would expose a single user's data, thus violating the privacy safeguards. Even with these restrictions in place, there are many permitted uses of user_id that do not expose the actual user_id.\n"," Below are a few examples of insights that advertisers derive using the column user_id, even though it is highly sensitive:\n","First, many advertisers use the user_id to count the number of unique users reached by campaign.  Second, the optimal ad frequency insight, which the previous section reviewed, uses the user_id.  Third, other advertisers use the user_id in queries to measure the customer journey across various ad products, such as Display + OTT or Display + Sponsored Products.\n"],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":{"type":2,"text":"Column Classifications"},"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[" Each column is classified into one of the categories below based on the combination of the aggregation threshold level and the filtering restrictions. All categories can be found in the data sources under the column \"aggregation threshold\". The classifications are also in the schema explorer.\n"],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":{"type":3,"text":"**None**"},"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[" Values from the column can be included in the output of workflows without any special restrictions being enforced. This classification is generally used for metric columns, such as impressions and clicks. The aggregation threshold is 1 and there are no filtering restrictions.\n"],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":{"type":3,"text":"Low"},"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[" Values from this column can only be included in the output of workflows if the row contains at least two distinct users. This classification is generally used for columns that contain dimensions that describe campaigns such as campaign_id and ad_id. The aggregation threshold is 2 and there are no filtering restrictions.\n"],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":{"type":3,"text":"Medium"},"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[" Values from the column can only be included in the output of workflows if the row contains at least one hundred distinct users. Examples: event_dt. The aggregation threshold is 100 and there are no filtering restrictions.\n"],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":{"type":3,"text":"High"},"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[" Values from the column can only be included in the output of workflows if the row contains at least one hundred distinct users. The aggregation threshold is 100 and there are filtering restrictions. Filters using literal (static) values cannot be applied to the column. \n"],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":{"type":3,"text":"Very high"},"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[" Values from the column can never be included in workflow output, though they may be used for intermediate purposes in workflows as long as they are dropped or aggregated with COUNT or COUNT DISTINCT. There is no aggregation threshold that will reveal columns with the classification \"very high\" because doing so would expose events from a single user. There are also filter restrictions. Filters using literal (static) values cannot be applied to the column. For example, user_id falls into this category and this filter is not allowed: WHERE user_id in (111, 222). If a query compares literal values to high or very high sensitivity columns (or those derived from them), the query will be rejected. Both direct literal values and values that were influenced by literal values are considered. Literal values can originate from literal or parameter expressions in order to prevent indirect ways of producing a value. This protection is in place for all query constructs that could potentially compare multiple values, such as:\n","Expressions that compare values such as Equals, RegexMatches, Min, etc.  Join keys in join operations  Group-by keys in aggregate operations\n"],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":{"type":2,"text":"Impressions by timestamp example"},"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":{"type":3,"text":"Scenario"},"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[" A query to evaluate impressions by timestamp, a field with the aggregation threshold of high, returns many NULL (i.e. blank) rows.\n"," Due to the privacy safeguards, NULL rows were returned. The data returned includes 95 rows, of which 91 include the timestamp and the impressions. 4 rows include the impressions, but exclude the timestamp. A sum of the impressions from the file = 12,000. For brevity, the entire dataset is not shown here, but the head and tail of the csv is shown. Examples of the first four of the 91 complete rows that include both the timestamp and impressions are below. The data returned is NOT NULL because there were at least 100 users for each timestamp.\n","|event_dt\t|impressions\t|\n","|---\t|---\t|\n","|2023-10-01T00:00:01\t|752\t|\n","|2023-10-01T00:01:01\t|610\t|\n","|2023-10-01T00:02:01\t|425\t|\n","|2023-10-01T00:03:01\t|323\t|\n"," The 4 rows without a timestamp, but with impressions are below. The timestamp was omitted from the output because there were fewer than 100 users in the timestamps.\n","|event_dt\t|impressions\t|\n","|---\t|---\t|\n","|\t|75\t|\n","|\t|52\t|\n","|\t|41\t|\n","|\t|15\t|\n"],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":{"type":2,"text":"How should the `NULL` rows be managed?"},"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[" Consider discarding the NULL rows. Alternatively, try the tips below to include more users.\n","Extend the time window of the query. \\* Make any filters less restrictive to include more campaigns, line items, ASINs, etc.\n"],"documentType":"guide"},{"title":"Data aggregation thresholds in the traffic events API","sectionHeader":{"type":2,"text":"Steps to follow when your query output has `NULL` rows"},"path":"/en-us/guides/traffic-events/data-aggregation-thresholds","content":[],"documentType":"guide"},{"title":"Account management for the traffic events API","sectionHeader":null,"path":"/en-us/guides/traffic-events/account-management","content":[" Access to the traffic events API is tied to the permissions that you have on the Ads accounts you are attempting to query. You need to own or be invited to an existing Sponsored Ads or DSP account with the permissions described below. You do not need any special permissions for the traffic events API specifically.\n"," To manage account permissions, use the \"Account access & settings\" link in the navigation bar.\n"],"documentType":"guide"},{"title":"Account management for the traffic events API","sectionHeader":{"type":3,"text":"Sponsored Ads"},"path":"/en-us/guides/traffic-events/account-management","content":[" Sponsored Ad users must have one of the following permissions to access the traffic events API: advertiser_campaign_view, advertiser_campaign_edit, nemo_report_view, nemo_report_edit\n"],"documentType":"guide"},{"title":"Account management for the traffic events API","sectionHeader":{"type":3,"text":"DSP"},"path":"/en-us/guides/traffic-events/account-management","content":[" DSP users must have the following permission to access the traffic events API: view_performance_dashboard\n"],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":null,"path":"/en-us/guides/posts/managing","content":[],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/posts/managing","content":[" Amazon Posts enable advertisers to nurture new customer connections, keep their brand top of mind, and grow its following through the use of engaging product imagery and effective content.\n"," A Post consists of the following details:\n","Image asset - Caption  - Up to five products\n"],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/posts/managing","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in the tutorial.\n"],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":{"type":2,"text":"Creating Posts"},"path":"/en-us/guides/posts/managing","content":[],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":{"type":3,"text":"Step 1: Identify the brand profile ID"},"path":"/en-us/guides/posts/managing","content":[" To create a Post, you need to identify the brand profile ID using the GET /bp/v2/profiles endpoint.\n"," Sample request\n"," Sample response\n"," You will use the postProfileId in Step 3.\n"],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":{"type":3,"text":"Step 2: Create an asset for use in Posts"},"path":"/en-us/guides/posts/managing","content":[" Posts require all assets to be uploaded using the Creative asset library API.\n"," The general steps to upload an asset are:\n","Generate an asset upload URL. 2. Upload your asset to the provided URL.  3. Register your asset.\n"," For a full tutorial on uploading assets, see Get started with asset library.\n"],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":{"type":3,"text":"Step 3: Create a Post"},"path":"/en-us/guides/posts/managing","content":[" Use the POST /bp/v2/posts endpoint to create a Post.\n"," For the request, use the postProfileId retrieved in step 1 as the profileId in the request body. You can get mediaUrl and mediaId from asset library (step 2).\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":{"type":3,"text":"Step 4: Publish a Post"},"path":"/en-us/guides/posts/managing","content":[" Use the PUT /bp/v2/posts/{postId}/submitForReview endpoint to submit a post for moderation.\n"," Sample request\n"," Sample response\n"," You will see the status change to REVIEW. When the Post has been approved, the status will change to LIVE. \n"],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":{"type":2,"text":"Withdrawing Posts"},"path":"/en-us/guides/posts/managing","content":[" Once a Post is live, you can take it down using the PUT /bp/v2/posts/{postId}/unpublish endpoint.  \n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":{"type":2,"text":"Retrieving Posts"},"path":"/en-us/guides/posts/managing","content":[" You can get details for a specific Post using GET /bp/v2/posts/{postId}.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Get started with Posts","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/posts/managing","content":[],"documentType":"guide"},{"title":"Reporting on Posts","sectionHeader":null,"path":"/en-us/guides/posts/reporting","content":[" The Posts API reporting functionality provides a variety of reports to help you retrieve historical impressions, clicks, and views for your Posts.\n"," To learn more about creating and managing Posts, see Get started with Posts.\n"],"documentType":"guide"},{"title":"Reporting on Posts","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/posts/reporting","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in the tutorial.\n"],"documentType":"guide"},{"title":"Reporting on Posts","sectionHeader":{"type":2,"text":"Brand-level reporting"},"path":"/en-us/guides/posts/reporting","content":[" Use the POST /bp/v2/profiles/{profileId}/metrics endpoint to get analytics at the brand or post profile level. Use your postProfileId as the profileId in the path. \n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Reporting on Posts","sectionHeader":{"type":2,"text":"Post-level reporting"},"path":"/en-us/guides/posts/reporting","content":[" Use the POST /bp/v2/posts/list endpoint to get analytics at the individual post level. \n"," Note that metricsStartDate and metricsEndDate cannot be more than a year apart. \n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Asset library overview","sectionHeader":null,"path":"/en-us/guides/creative-asset/asset-library-overview","content":[" The creative asset library is used to manage creatives across ad programs, helping you organize creatives more efficiently. The library currently supports video and image for Sponsored Brands, Sponsored Display, Amazon DSP, and Stores. \n"," You can also view, manage, and upload assets using the Asset library UI.  \n"],"documentType":"guide"},{"title":"Asset library overview","sectionHeader":{"type":2,"text":"Creative specifications and guidelines"},"path":"/en-us/guides/creative-asset/asset-library-overview","content":[" For creative specifications for each ad program, see:\n","DSP  Sponsored ads (including Sponsored Brands and Sponsored Display)  Stores\n"],"documentType":"guide"},{"title":"Asset library overview","sectionHeader":{"type":2,"text":"Additional resources"},"path":"/en-us/guides/creative-asset/asset-library-overview","content":[" To learn more about the creative assets library, visit the resources below:\n"],"documentType":"guide"},{"title":"Creating assets","sectionHeader":null,"path":"/en-us/guides/creative-asset/creating-assets","content":[" Asset library currently supports video and image creatives. \n"," Regardless of the type of creative, you need to make three calls:\n","Generate an asset upload URL. 2. Upload your asset to the provided URL. 3. Register your asset. \n"],"documentType":"guide"},{"title":"Creating assets","sectionHeader":{"type":2,"text":"Procedure"},"path":"/en-us/guides/creative-asset/creating-assets","content":[],"documentType":"guide"},{"title":"Creating assets","sectionHeader":{"type":3,"text":"Step 1: Create an upload URL"},"path":"/en-us/guides/creative-asset/creating-assets","content":[" Use POST /assets/upload to get an upload URL. Make sure you are using the correct filename and a supported dimension for the asset you want to upload. Using an unsupported extension will not result in error in this step, but you will encounter errors later. \n"," Example: Image\n"," The response contains a custom URL you can use to upload your file in step 2.\n"," Example: Video\n"],"documentType":"guide"},{"title":"Creating assets","sectionHeader":{"type":3,"text":"Step 2: Upload your asset"},"path":"/en-us/guides/creative-asset/creating-assets","content":[" To upload your asset, use PUT on the URL returned in step 1.\n"," Example: Image\n"," Example: Video\n"," If the asset uploads correctly, you receive a 200 response. \n"],"documentType":"guide"},{"title":"Creating assets","sectionHeader":{"type":3,"text":"Step 3:  Register the asset"},"path":"/en-us/guides/creative-asset/creating-assets","content":[" Register the asset using POST /assets/register.  \n","| Parameter | Required? | Description |\n","\\|--- \\|--- \\|--- \\|\n","| url | Yes | The upload URL for the asset generated in step 1. |\n","| name | Yes | The name of the asset. |\n","| asinList | No | An optional list of ASINs associated with the asset to be used for searching and categorization. |\n","| assetType | Yes | The type of asset. Currently accepts IMAGE and VIDEO. |\n","| assetSubTypeList | Yes | The sub type of the asset. |\n","| versionInfo | No | If you are uploading a new version of an existing asset, include the assetId in versionInfo. |\n","| tags | No | An optional parameter to add relevant tags to the asset for searching and categorization. |\n","| registrationContext | Yes, for DSP assets | Only required for assets that you will use in DSP campaigns. If you are using the asset for sponsored ads or stores, you do not need to include this parameter. |\n","| associatedSubEntityList | Yes, for Amazon sellers | Amazon sellers must include their brand entity ID. You can find this using the GET /brands endpoint. For other advertisers, we recommend including brand entity ID, but it is not required. |\n","| skipAssetSubTypesDetection | No | By default, the system attempts to automatically classify your image into sub types. If you do not want the system to do this classification, set this to TRUE. |\n"," Example: Image\n"," The response returns 200 with an assetId that you can use when creating or editing campaigns. \n"," Example: Video\n"," A successful response returns 200 with an assetId that can be used when managing your campaign. The response returns a list of the program types for which the video asset has failed validation checks. \n"," In this example, the registered video asset is not eligible for DSP OLV, DSP OTT, or Stores intro splash. This video is for a Sponsored Brands campaign, and you will see Sponsored Brands is not mentioned in the failedSpecChecks. \n"],"documentType":"guide"},{"title":"Creating assets","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/creative-asset/creating-assets","content":[" After registering your asset, it is set to a PROCESSING status. Once the asset is in ACTIVE status, it can be used in a campaign.\n"],"documentType":"guide"},{"title":"Managing assets","sectionHeader":null,"path":"/en-us/guides/creative-asset/managing-assets","content":[" As you manage campaigns, you may want to create new versions of existing assets. \n"],"documentType":"guide"},{"title":"Managing assets","sectionHeader":{"type":2,"text":"Searching assets"},"path":"/en-us/guides/creative-asset/managing-assets","content":[" You can use GET /assets and POST /assets/search to retrieve previously created assets.\n"],"documentType":"guide"},{"title":"Managing assets","sectionHeader":{"type":3,"text":"GET /assets"},"path":"/en-us/guides/creative-asset/managing-assets","content":[],"documentType":"guide"},{"title":"Managing assets","sectionHeader":{"type":3,"text":"POST /assets/search"},"path":"/en-us/guides/creative-asset/managing-assets","content":[" To view all assets associated to your profile, leave the request body empty.\n"," You can also filter by various criteria. See the API reference for all options.\n"],"documentType":"guide"},{"title":"Managing assets","sectionHeader":{"type":2,"text":"Updating assets"},"path":"/en-us/guides/creative-asset/managing-assets","content":[" Each update to an asset results in a new version of that asset. The updated asset will have the same assetId with a version appended to the end. \n"," The process to create a new version is mostly the same as described in Creating assets. Start by Creating an upload URL, and Uploading the asset. For step three, you will specify the assetId of the asset you want to update under versionInfo.\n"," Example request\n"," Example response\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":null,"path":"/en-us/guides/moderation/pre-moderation","content":[" For advertisers launching sponsored ads campaigns, the unified pre-moderation API offers real-time policy guidance based on the technical, creative, and policy components of an ad. The unified pre-moderation API ensures ad compliance before moderation, enabling alignment with sponsored ads policy guidelines.\n"," This document includes common reasons why a campaign might be rejected during moderation review, example requests to the unified pre-moderation API, and links to relevant ad policies for additional explanation of the guidelines.\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":2,"text":"Pre-moderation rejections"},"path":"/en-us/guides/moderation/pre-moderation","content":[" The most common moderation rejections result from incorrect capitalization or grammar or the use of unsupported languages within a creative headline. However, there are other reasons why a component of an ad can be rejected. The below tables show the possible rejection statuses from the pre-moderation API for each sponsored ads type.\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Sponsored Brands error codes"},"path":"/en-us/guides/moderation/pre-moderation","content":["| Error code | Message |\n","\\|---\\|---\\|\n","| END_DATE | Campaigns with deals or savings must have an end date on or before the date of the earliest-expiring deal or saving. |\n","| SEASONAL_EVENTS_WORD | Campaigns with holiday or seasonal event messaging must include an end date. |\n","| PUNCTUATIONS | Incorrect or excessive punctuation is not allowed. |\n","| ELLIPSIS | We do not permit sentences that begin with an ellipsis or sentences that contain more than 3 sets of ellipses. |\n","| GRAMMAR | Check for grammatical or typographical errors. |\n","| SENTENCE_STRUCTURE | Check for grammatical or typographical errors. |\n","| LISTING_PRICES | Numeric pricing, deals, or savings such as \"$4.99\" or \"Save 50%\" are not allowed. |\n","| CAP_WORDS | All CAPS, CaMeL case, and random capitalization are not allowed. |\n","| PROFANE_WORDS | Profane or vulgar content is not allowed. |\n","| SPECIAL_CHARACTERS | Special characters such as \"#@%\" are not permitted. |\n","| AMAZON_SPECIFIC_TERM | Amazon products or services cannot be referenced. |\n","| ADULT_WORDS | Profanity, obscene language, or inappropriate double meanings are not allowed. |\n","| TYPO | Please check for grammatical errors, misspellings, or typos. |\n","| SPONSOR_NAME_MISMATCH | Brand name must match your registered brand name, or the name of a brand that you own or can legitimately represent. |\n","| UNSUBSTANTIATED_CLAIM_VIOLATION | All claims in ads must be accurate and substantiated on the product packaging or the product detail page. |\n","| CUSTOM_IMAGE_TEXT | Additional text within a custom image such as overlayed or background text is not allowed. |\n","| INVALID_CUSTOM_IMAGE | Custom image may not meet our policy. |\n","| INVALID_BRAND_LOGO | Logo does not meet our policy. |\n","| LANGUAGE_UNSUPPORTED | Headline must be in the language of the Amazon site where your ad will display. |\n","| FATAL_ADULT_WORD | Adult products are not allowed. |\n","| FATAL_PROFANE_WORD | Profane or vulgar content is not allowed. |\n","| FATAL_CRITICAL_EVENTS_WORD | Content related to political groups or policies, that criticize political figures or that encourage civil or political unrest is not allowed. |\n","| FATAL_WORD | Drug paraphernalia or products related to illicit drugs are not allowed. |\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Sponsored Brands Video error codes"},"path":"/en-us/guides/moderation/pre-moderation","content":["| Error code | Message |\n","\\|---\\|---\\|\n","| PILLAR_BOX | Video cannot contain colored bars framing video content on any side. |\n","| LETTER_BOX | Video cannot contain colored bars framing video content on any side. |\n","| GRAMMAR | Check for grammatical or typographical errors. |\n","| SENTENCE_STRUCTURE | Check for grammatical or typographical errors. |\n","| END_DATE | Campaigns with deals or savings must have an end date on or before the date of the earliest-expiring deal or saving. |\n","| SEASONAL_EVENTS_WORD | Campaigns with holiday or seasonal event messaging must include an end date. |\n","| ADULT_WORDS | Profanity, obscene language, or inappropriate double meanings are not allowed. |\n","| PROFANE_WORDS | Profane or vulgar content is not allowed. |\n","| AMAZON_BRANDING | Amazon branded elements are not allowed. |\n","| AMAZON_SPECIFIC_TERM | Amazon products or services cannot be referenced. |\n","| WINDOW_FRAME | Video cannot contain colored bars framing video content on any side. |\n","| TYPO | Typos and spelling errors need to be corrected. |\n","| LANGUAGE_UNSUPPORTED | Audio or subtitles must be in the language of the Amazon site where your ad will display. |\n","| LISTING_PRICES | Numeric pricing, deals, or savings such as \"$4.99\" or \"Save 50%\" are not allowed. |\n","| CAP_WORDS | All CAPS, CaMeL case, and random capitalization are not allowed. |\n","| PUNCTUATIONS | Incorrect or excessive punctuation is not allowed. |\n","| SPECIAL_CHARACTERS | Special characters such as \"#@%\" are not permitted. |\n","| SPONSOR_NAME_MISMATCH | Brand name must match your registered brand name, or the name of a brand that you own or can legitimately represent. |\n","| UNSUBSTANTIATED_CLAIM_VIOLATION | All claims in ads must be accurate and substantiated on the product packaging or the product detail page. |\n","| INVALID_BRAND_LOGO | Logo does not meet our policy. |\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Sponsored Display error codes"},"path":"/en-us/guides/moderation/pre-moderation","content":["| Error code | Message |\n","\\|---\\|---\\|\n","| END_DATE | Campaigns with deals or savings must have an end date on or before the date of the earliest-expiring deal or saving. |\n","| TIME_SENSITIVE_EVENT | Time-sensitive promotions are prohibited unless communicated dynamically. |\n","| SENTENCE_STRUCTURE | Please check for grammatical errors, misspellings, or typos. |\n","| CAP_WORDS | Inconsistent casing is not allowed. |\n","| PUNCTUATIONS | Incorrect or excessive punctuation is not allowed. |\n","| ELLIPSIS | Headlines that start with an ellipsis (\"...\"), or that contain more than 3 instances of ellipses, are not allowed. |\n","| ADULT_WORDS | Profanity, obscene language, or inappropriate double meanings are not allowed. |\n","| PROFANE_WORDS | Profane or vulgar content is not allowed. |\n","| SPECIAL_CHARACTERS | Special characters (unless part of the brand name or slogan) are not allowed. |\n","| LISTING_PRICES | Numeric pricing, deals, or savings such as \"$4.99\" or \"Save 50%\" are not allowed. |\n","| AMAZON_SPECIFIC_TERM | Amazon products or services cannot be referenced. |\n","| SPELL_ERROR | Please check for misspellings or typos. |\n","| UNSUBSTANTIATED_CLAIM_VIOLATION | All claims in ads must be accurate and substantiated on the product packaging or the product detail page. |\n","| GRAMMAR | Please check for grammatical errors. |\n","| LANGUAGE_UNSUPPORTED | Headline must be in the language of the Amazon site where your ad will display. |\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Stores error codes"},"path":"/en-us/guides/moderation/pre-moderation","content":["| Error code | Message |\n","\\|---\\|---\\|\n","| GRAMMAR | Please check for grammatical errors, misspellings, or typos. |\n","| SENTENCE_STRUCTURE | Please check for grammatical errors, misspellings, or typos. |\n","| ELLIPSIS | The sentence starts with an ellipsis (\"...\"), or if it contains more than 3 instances of an ellipsis are not allowed |\n","| PUNCTUATIONS | Incorrect or excessive punctuation is not allowed |\n","| PROFANE_WORDS | Profane or vulgar content is not allowed |\n","| SPELL_ERROR | Please check for grammatical errors, misspellings, or typos. |\n","| CAP_WORDS, CamelCaseAnnotator, CapitalizationAnnotator | All CAPS, CaMeL case and random capitalization are not allowed |\n","| ADULT_WORDS | Adult products are not permitted |\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"DSP error codes"},"path":"/en-us/guides/moderation/pre-moderation","content":["| Error code | Message |\n","\\|---\\|---\\|\n","| PROFANE_WORDS | Profane or vulgar content is not allowed. |\n","| ADULT_WORDS | Profanity, obscene language, or inappropriate double meanings are not allowed. |\n","| SPELL_ERROR | Please check for grammatical errors, misspellings, or typos. |\n","| GRAMMAR | Please check for grammatical errors, misspellings, or typos. |\n","| SENTENCE_STRUCTURE | Please check for grammatical errors, misspellings, or typos. |\n","| UNSUBSTANTIATED_CLAIM_VIOLATION | All claims in ads must be accurate and substantiated on the product packaging or the product detail page. |\n","| ELLIPSIS | Headlines that start with an ellipsis (\"...\"), or that contain more than 3 instances of ellipses, are not allowed. |\n","| LISTING_PRICES | Numerical promotions, pricing, deals, or savings such as \"Save 50%\" are not permitted. |\n","| CAP_WORDS | All CAPS, CaMeL case, and random capitalization are not allowed. |\n","| PUNCTUATIONS | Incorrect or excessive punctuation is not allowed. |\n","| SPECIAL_CHARACTERS | Special characters such as \"#@%\" are not permitted. |\n","| TIME_SENSITIVE_EVENT | Time-sensitive promotions are prohibited. |\n","| AMAZON_SPECIFIC_TERM | Amazon products or services cannot be referenced. |\n","| END_DATE | Campaigns with deals or savings must have an end date on or before the date of the earliest-expiring deal or saving. |\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"DSP image error codes"},"path":"/en-us/guides/moderation/pre-moderation","content":["| Error code | Message |\n","\\|---\\|---\\|\n","| FATAL_ADULT_WORD | This product cannot be advertised because it is prohibited. |\n","| FATAL_POLITICAL_WORD | This product cannot be advertised because it is prohibited. |\n","| FATAL_ILLICIT_DRUGS_WORD | This product cannot be advertised because it is prohibited. |\n","| FATAL_PROFANE_WORD | This product cannot be advertised because it is prohibited. |\n","| FATAL_TOBACCO_WORD | This product cannot be advertised because it is prohibited. |\n","| FATAL_PROHIBITED_WORD | This product cannot be advertised because it is prohibited. |\n","| FATAL_COMPETITIVE_PRODUCTS_WORD | The product advertised is restricted and has required targeting and placement restrictions. |\n","| FATAL_MEDICAL_AND_WEIGHT_LOSS | The product advertised is restricted and has required targeting and placement restrictions. |\n","| FATAL_QUESTIONABLE_AND_DANGEROUS_ACTIVITY_WORD | The product advertised is restricted and has required targeting and placement restrictions. |\n","| RESTRICTED_WORD | The product advertised is restricted and has required targeting and placement restrictions. |\n","| FONT_ILLEGIBLE | Image must meet font requirements. |\n","| IMAGE_FONT_ILLEGIBLE | Image must meet font requirements. |\n","| FATAL_ALCOHOL_WORD | Advertising alcohol requires day-parting on the line items. |\n","| UNSUITABLE_FOR_GENERAL_AUDIENCE_VIOLATION | The product being advertised requires targeting restrictions. |\n","| ANIMATION_MORE_THAN_15_SECONDS | Animation length may not follow guidelines. |\n","| ANIMATION_MORE_THAN_30_SECONDS | Animation length may not follow guidelines. |\n","| LP_AD_PRODUCTS_MISMATCH | Product in image does not match product on the landing page. |\n","| CTA_IN_ALL_CAPS | Call-to-action should not use all caps. |\n","| AD_TEXT_OR_DISCLAIMER_ILLEGIBLE | Text or disclaimer must be legible. |\n","| MISSING_OR_AMBIGUOUS_CTA | Call-to-action may be ambiguous or missing. |\n","| BILLBOARD_CREATIVES_CANNOT_HAVE_CTA_IN_BUTTON_FORM | Call-to-action cannot be a button for billboard size. |\n","| AMBIGUOUS_CTA | Call-to-action cannot be ambiguous. |\n","| AMAZON_LOGO_BLURRY | The Amazon logo is blurry. |\n","| POOR_IMAGE_OR_VIDEO_QUALITY | Low image or video quality. |\n","| LOOPS_MORE_THAN_3_TIMES | Animation repeats more than 3 times. |\n","| IMPROPER_BRAND_ELEMENTS | The Amazon logo is used incorrectly. |\n","| GENERAL_DEAL_DATES | The dates of the deal stated in the creative should be aligned with the line item flight dates. Please ensure the creative is only live during the time of the deal. |\n","| SINGLE_DAY_DEAL_DATES | The event you are promoting qualifies as a Single-Day Event, which means your ad can be flighted up to 8 weeks prior to the start date and must end within 24 hours after the event. |\n","| MULTI_DAY_DEAL_DATES | The event you are promoting qualifies as a Multi-Day Event, which means your ad can be flighted up to 8 weeks prior to the start date and must end no more than 7 days after the event. |\n","| PRICE_OR_SAVINGS_LINKING_TO_PDP | A specific price or savings claim has been detected within this creative. Please remove the claim or use a responsive ecommerce creative (REC) to promote this deal |\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"DSP rec error codes"},"path":"/en-us/guides/moderation/pre-moderation","content":["| Error code | Message |\n","\\|---\\|---\\|\n","| FATAL_ADULT_WORD | Product is prohibited. |\n","| FATAL_POLITICAL_WORD | Product is prohibited. |\n","| FATAL_HATE_AND_INTOLERANCE_WORD | Product is prohibited. |\n","| FATAL_ILLICIT_DRUGS_WORD | Product is prohibited. |\n","| FATAL_PROFANE_WORD | Product is prohibited. |\n","| FATAL_TOBACCO_WORD | Product is prohibited. |\n","| FATAL_PROHIBITED_WORD | Product is prohibited. |\n","| FATAL_COMPETITIVE_PRODUCTS_WORD | The product advertised is restricted and has required targeting and placement restrictions. |\n","| FATAL_MEDICAL_AND_WEIGHT_LOSS | The product advertised is restricted and has required targeting and placement restrictions. |\n","| FATAL_QUESTIONABLE_AND_DANGEROUS_ACTIVITY_WORD | The product advertised is restricted and has required targeting and placement restrictions. |\n","| RESTRICTED_WORD | The product advertised is restricted and has required targeting and placement restrictions. |\n","| FONT_ILLEGIBLE | Image must meet font requirements. |\n","| IMAGE_FONT_ILLEGIBLE | Image must meet font requirements. |\n","| AMBIGUOUS_CTA | Call-to-action cannot be ambiguous. |\n","| CTA_IN_ALL_CAPS | Call-to-action cannot be ambiguous. |\n","| GRAMMAR | There may be grammar issues. |\n","| TYPO | There may be spelling issues. |\n","| PUNCTUATIONS | Custom headline should not use multiple punctuation marks in a row. |\n","| CAP_WORDS | Custom headline should only have the first letter capitalized except brand names. |\n","| UNSUITABLE_FOR_GENERAL_AUDIENCE_VIOLATION | The product being advertised requires targeting restrictions. |\n","| FATAL_ALCOHOL_WORD | Advertising alcohol requires day parting on the line items. |\n","| AD_TEXT_OR_DISCLAIMER_ILLEGIBLE | Text or disclaimer must be legible. |\n","| MISSING_OR_AMBIGUOUS_CTA | Call-to-action may be ambiguous or missing. |\n","| BILLBOARD_CREATIVES_CANNOT_HAVE_CTA_IN_BUTTON_FORM | Call-to-action cannot be a button for billboard size. |\n","| AMAZON_LOGO_BLURRY | The Amazon logo is blurry. |\n","| POOR_IMAGE_OR_VIDEO_QUALITY | Low image or video quality. |\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":2,"text":"Examples for using the pre-moderation API "},"path":"/en-us/guides/moderation/pre-moderation","content":[" Components that get an APPROVED status in pre-moderation are not guaranteed to be approved in moderation. Different component objects that can be specified in the request body depending on what needs to be pre-moderated. For more details on the specifics of each component, see the technical specifications for the /preModeration endpoint..\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Sponsored Brands Video"},"path":"/en-us/guides/moderation/pre-moderation","content":[" Request:\n"," Response:\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Sponsored Brands Spotlight"},"path":"/en-us/guides/moderation/pre-moderation","content":[" Request:\n"," Response:\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/guides/moderation/pre-moderation","content":[" Request:\n"," Response:\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Sponsored Display"},"path":"/en-us/guides/moderation/pre-moderation","content":[" Request:\n"," Response:\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Stores"},"path":"/en-us/guides/moderation/pre-moderation","content":[" Request:\n"," Response:\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"DSP"},"path":"/en-us/guides/moderation/pre-moderation","content":[" Request:\n"," Response:\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":2,"text":"Ad component specifications and moderation guidelines"},"path":"/en-us/guides/moderation/pre-moderation","content":[" A creative must meet certain requirements before it can be approved. Below are specifications for both a brand logo and a custom image.\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Brand Logo specifications"},"path":"/en-us/guides/moderation/pre-moderation","content":["| Specification | Details |\n","\\|---\\|---\\|\n","| Image size | 400 x 400 px or larger |\n","| File size | 1MB or smaller |\n","| File format | PNG or JPG |\n","| Content | Logo must fill the image or have a white or transparent background. For more information, visit Brand Logo Creative Acceptance Policy. |\n"],"documentType":"guide"},{"title":"Get started with unified pre-moderation","sectionHeader":{"type":3,"text":"Custom image specifications"},"path":"/en-us/guides/moderation/pre-moderation","content":["| Specification | Details |\n","\\|---\\|---\\|\n","| Image size | 1200 x 628 px or larger |\n","| File size | 5MB or smaller |\n","| File format | PNG or JPG |\n","| Content | No text, graphics, or logos added to the image. For more information, visit Custom Image Creative Acceptance Policy. |\n"],"documentType":"guide"},{"title":"Get started with Portfolios","sectionHeader":null,"path":"/en-us/guides/portfolios/get-started","content":[],"documentType":"guide"},{"title":"Get started with Portfolios","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/portfolios/get-started","content":[" Portfolios are groups of campaigns that you can organize to meet your advertising needs. For example, you can create portfolios to organize campaigns by brand, product category, or season to provide structure and to manage your advertising activities. Portfolios within your advertising account do not compete against each other to help ensure that best performing campaigns continue to show to the customer. \n"," Portfolios can simplify your day-to-day campaign management in multiple ways:\n","Multibrand management – Group your campaigns by brand, business line or season to reflect your marketing needs.   Budget caps – Define a date range or recurring monthly budget cap and ensure that your campaign spends do not exceed your desired marketing needs.  Share unspent campaign budget – Automatically share unspent campaign budget from previous days in the month with other campaigns in the same portfolio that have already spent their full daily budget.    Track Performance – Review portfolio performance and create reports for campaigns by portfolio.   Streamlined billing – Simplified billing details broken down by aggregated portfolio spend in each billing cycle.\n"," Learn more about Portfolios.\n"],"documentType":"guide"},{"title":"Get started with Portfolios","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/portfolios/get-started","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in the tutorial.\n"],"documentType":"guide"},{"title":"Get started with Portfolios","sectionHeader":{"type":2,"text":"Creating Portfolios"},"path":"/en-us/guides/portfolios/get-started","content":[" To create a portfolio, use POST /portfolios. For budgets, the parameters are as follows:\n","The dateRange policy specifies a budget cap for a specific period of time.  The monthlyRecurring policy specifies a budget that is automatically renewed at the beginning of each month.  The NO_CAP setting allows the campaigns in your portfolio to continue spending until those individual campaign budgets have been used.\n"," Sample request\n"," Sample response\n"," Once you obtain a portfolioId, you can associate campaigns to the portfolio created. \n"],"documentType":"guide"},{"title":"Get started with Portfolios","sectionHeader":{"type":2,"text":"Retrieve a list of Portfolios"},"path":"/en-us/guides/portfolios/get-started","content":[" Use the POST /portfolios/list endpoint to retrieve portfolios. The response includes a set of properties for each portfolio you have created.\n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Get started with Portfolios","sectionHeader":{"type":2,"text":"Budget usage"},"path":"/en-us/guides/portfolios/get-started","content":[" The /portfolios/budget/usage endpoint returns budget usage percentages for the portfolio specified in the request body. This allows you to manage and track your advertising spend across all portfolios you have under your advertiser account. \n"," Sample request\n"," Sample response\n"],"documentType":"guide"},{"title":"Get started with Portfolios","sectionHeader":{"type":2,"text":"Reporting"},"path":"/en-us/guides/portfolios/get-started","content":[" The portfolioId metric in reporting returns all campaigns associated with a specific portfolioId. To view the report types where this metric is available, refer to the Columns section.\n"],"documentType":"guide"},{"title":"Get started with Portfolios","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/portfolios/get-started","content":["Learn about sharing leftover budget across campaigns in a portfolio \\* API reference\n"],"documentType":"guide"},{"title":"Sharing leftover budget in a portfolio","sectionHeader":null,"path":"/en-us/guides/portfolios/sharing-leftover","content":[],"documentType":"guide"},{"title":"Sharing leftover budget in a portfolio","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/portfolios/sharing-leftover","content":[" When the unspent campaign budget feature is turned on inside a portfolio, campaigns that have already spent their full daily budget can automatically use unspent campaign budget from other campaigns from previous days in the month, allowing them to spend up to 100% more than their average daily budget on any given day. This system allows you to benefit from high traffic days. At the end of the month, the campaigns in your portfolio will not spend more in total than the sum of the daily budget for each campaign, multiplied by the number of days in that month. Your invoice will be adjusted for any over-delivery, so that you will not be charged for any amount in excess of your monthly charging limit.\n"," Your campaign will still be able to use its own unspent leftovers from previous days using the average daily budget system. The unspent campaign budget sharing system is offered to help campaigns that still run out of budget, even after spending their own leftovers from previous days. For example, suppose you have 3 campaigns in a portfolio which has the unspent campaign budget sharing feature turned on, and each campaign has a daily budget of $100. Campaign 1 spends $70 on the first day of the month, Campaign 2 spends $50, and Campaign 3 spends $100. There is now a total of $80 in unspent leftovers available which will be available to campaigns in the portfolio if they spend all their budget the next day. The next day, if Campaign 3 exhausts its $100 daily budget, it can still spend the additional $80 of unspent campaign budget to get additional clicks and impressions. This continues through the calendar month, and at the beginning of the next month the leftover amount is reset to 0 and restarts accumulating for the new month.\n"],"documentType":"guide"},{"title":"Sharing leftover budget in a portfolio","sectionHeader":{"type":2,"text":"Getting started"},"path":"/en-us/guides/portfolios/sharing-leftover","content":[],"documentType":"guide"},{"title":"Sharing leftover budget in a portfolio","sectionHeader":{"type":3,"text":"Setting unspent campaign budget sharing "},"path":"/en-us/guides/portfolios/sharing-leftover","content":[" You can set the unspent campaign budget sharing option to on or off. You select your choice at the portfolio level, so all campaigns within the portfolio are eligible to share leftover budget amounts to spend up to 100% over daily budget.\n"," By default, all portfolios created after 6/20/2025 have unspent campaign budget sharing turned on. To turn the feature on or off for a given portfolio, use PUT /portfolios to update your settings and set featureState for campaignUnspentBudgetSharing as DISABLED inside budgetControls.\n"],"documentType":"guide"},{"title":"Sharing leftover budget in a portfolio","sectionHeader":{"type":3,"text":"Re-enabling unspent campaign budget sharing"},"path":"/en-us/guides/portfolios/sharing-leftover","content":[" If you previously turned off unspent campaign budget sharing for your portfolio but now you would like to turn on sharing, use PUT /portfolios to update your settings and set featureState for campaignUnspentBudgetSharing as ENABLED inside budgetControls.\n"],"documentType":"guide"},{"title":"Sharing leftover budget in a portfolio","sectionHeader":{"type":3,"text":"Checking your unspent campaign budget sharing settings"},"path":"/en-us/guides/portfolios/sharing-leftover","content":[" To check your current settings for unspent campaign budget sharing use POST /portfolios/list.\n"],"documentType":"guide"},{"title":"Sharing leftover budget in a portfolio","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/portfolios/sharing-leftover","content":["API reference\n"],"documentType":"guide"},{"title":"Brand Store overview","sectionHeader":null,"path":"/en-us/guides/brand-store/overview","content":[" Brand Stores are customizable storefronts that allow brands to showcase their products and tell their brand story in a more curated and branded environment.\n"],"documentType":"guide"},{"title":"Brand Store overview","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/brand-store/overview","content":["Must have your brand registered \\* Must have an existing Store\n"],"documentType":"guide"},{"title":"Brand Store overview","sectionHeader":{"type":2,"text":"Retrieve Brand Store information"},"path":"/en-us/guides/brand-store/overview","content":[" This endpoint will retrieve Brand Store information for all registered stores under an advertiser. The brandEntityId is required in order to use the Brand Stores metrics APIs. \n"," Endpoint: /v2/stores \n"," Request:\n"," Response: \n"],"documentType":"guide"},{"title":"Brand Store overview","sectionHeader":{"type":2,"text":"Brand Stores metrics"},"path":"/en-us/guides/brand-store/overview","content":[" Metrics like sales, visits, page views, and traffic sources help you better understand how to best serve your shoppers. \n"," Learn more:\n"],"documentType":"guide"},{"title":"Brand Store feature availability by marketplace","sectionHeader":null,"path":"/en-us/guides/brand-store/features","content":[" This document lists descriptions and marketplace availability for all Brand Stores features.\n"],"documentType":"guide"},{"title":"Brand Store feature availability by marketplace","sectionHeader":{"type":2,"text":"Store insights"},"path":"/en-us/guides/brand-store/features","content":[" Store insights provide brands with analytics about the Brand Store performance and customer behavior. For more information, see Brand Store insights metrics.\n"," Relevant resource:\n","/stores/{brandEntityId}/insights\n"," Marketplace availability: All marketplaces.\n"],"documentType":"guide"},{"title":"Brand Store feature availability by marketplace","sectionHeader":{"type":2,"text":"Store `ASIN` metrics"},"path":"/en-us/guides/brand-store/features","content":[" Store ASIN metrics provides information about your store ASIN performance, including rendered impressions, viewed impressions, clicks and sales. For more information, see Brand Store insights metrics.\n"," Relevant resource:\n","/stores/{brandEntityId}/asinMetrics\n"],"documentType":"guide"},{"title":"Brand Store insights metrics","sectionHeader":null,"path":"/en-us/guides/brand-store/insight-metrics","content":[" Brand Store analytic metrics provide brands with analytics about the Brand Store performance and customer behavior. These metrics offer a deeper understanding of how shoppers interact with the Brand Store, helping brands optimize their strategies to drive engagement and sales.\n"],"documentType":"guide"},{"title":"Brand Store insights metrics","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/brand-store/insight-metrics","content":["Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in the tutorial. \\* Have a brandEntityID.\n"],"documentType":"guide"},{"title":"Brand Store insights metrics","sectionHeader":{"type":2,"text":"Available insight metrics"},"path":"/en-us/guides/brand-store/insight-metrics","content":[" Below is a table of all the available insight metrics that can be used to retrieve Brand Store performance:\n","|Insight metric\t|Description\t|\n","|---\t|---\t|\n","|VIEWS\t|Number of page views. The VIEW metric can be aggregated by all dimensions.\t|\n","|ORDERS\t|Estimated total orders placed by Store visitors within 14 days of their visit. Orders contain one or more units sold. The ORDERS metric can be aggregated by all the dimensions.\t|\n","|UNITS\t|Estimated units purchased by Store visitors within 14 days of their last visit. The UNITS metric can be aggregated by all the dimensions.\t|\n","|SALES\t|Estimated total sales generated by Store visitors within 14 days of their last visit. The SALES metric can be aggregated by all the dimensions.\t|\n","|VISITS\t|Total visits to a page within a single day. Each visitor can visit more than one page, and they can visit your Store from more than one traffic source. The VISITS metric can be aggregated by all the dimensions.\t|\n","|VISITORS\t|Total visitors to your Store within the selected date range, calculated based on daily unique users or devices. One visitor can visit more than one page, and they can visit your Store from more than one traffic source. The VISITORS metric currently can only be aggregated by InsightDimension DATE. Users will not be able to get this metric when specifying other dimensions. This is because number of visitors are measured at store level. This also means this metric will not be impacted by the InsightFilter.\t|\n","|SCORE_LEVEL\t|Store Quality rating calculated on various factors defining the quality of a store. It can be HIGH, MEDIUM, or LOW. This metric currently can only be aggregated by the DATE dimension.\t|\n","|RECOMMENDATIONS\t|An array of objects containing two fields: recommendedAction (for example, \"Add a video\") and observedAverageDwellTimeIncrease (the improvement it would bring in the overall store quality).\t|\n","|CONTRIBUTORS\t|An array of recommendations applied by the Store Owner resulting in the improvement of overall store quality. This metric currently can only be aggregated by the DATE dimension.\t|\n","|DWELL\t|Average time a customer spends on the store, specifically for store quality measurement. This metric currently can only be aggregated by the DATE dimension.\t|\n","|PEER_DWELL\t|Average time a customer spends on other similar (peer) stores on average. This metric currently can only be aggregated by the DATE dimension.\t|\n","|DWELL_TIME\t|Average time a customer spends on the store, providing insights into user engagement by calculating the average duration of visits. The DWELL_TIME metric can be aggregated by all the dimensions or at the store level. For aggregation at store level, dimension must be omitted from the request.\t|\n","|BOUNCE_RATE\t|Ratio of total bounce visits (customer who landed on the store and left quickly without engaging) to total landing visits, providing insights into visitor engagement. The BOUNCE_RATE metric can be aggregated by all the dimensions or at the store level. For aggregation at store level, dimension must be omitted from the request.\t|\n","|NEW_TO_STORE\t|Total count of unique visitors who are new to the store, providing valuable insights into the number of first-time shoppers. The NEW_TO_STORE metric currently can only be aggregated by the DATE dimension or at the store level. For aggregation at store level, dimension must be omitted from the request.\t|\n"],"documentType":"guide"},{"title":"Brand Store insights metrics","sectionHeader":{"type":2,"text":"Available `ASIN` metrics"},"path":"/en-us/guides/brand-store/insight-metrics","content":[" Below is a table of all the available ASIN metrics that can be used to retrieve Brand Store performance: \n","|Metric\t|Description\t|\n","|---\t|---\t|\n","|VIEWS\t|Number of times a customer viewed an ASIN. Can happen once per page visit. This metric must be used with the ASIN dimension.\t|\n","|ORDERS\t|Estimated total orders placed by Store visitors on the day of the ASIN view. Orders can have one or more total units. This metric must be used with the ASIN dimension.\t|\n","|UNITS\t|Estimated units purchased by Store visitors during attributed orders for the ASIN. This metric must be used with the ASIN dimension.\t|\n","|ADD_TO_CARTS\t|Total number of times an ASIN was added to cart by a customer on a store page. This metric must be used with the ASIN dimension.\t|\n","|IN_STOCK_VIEWS\t|Total views of an ASIN on a store page while the ASIN was in stock. For ASINs with variations, the customer must have selected a variation which was in stock to be counted. This metric must be used with the ASIN dimension.\t|\n","|AVERAGE_IN_STOCK_PRICE\t|Average price in local currency the ASIN was viewed at by customers while it was in stock. This metric must be used with the ASIN dimension.\t|\n","|IN_STOCK_RATE\t|Rate at which customers viewed an ASIN while it was in stock. This metric must be used with the ASIN dimension.\t|\n","|AVERAGE_SALE_PRICE\t|Average price in local currency for which the ASIN sold for during the order. This metric must be used with the ASIN dimension.\t|\n","|CONVERSION_RATE\t|Rate at which customers ordered a unit of the item over how many times customers clicked the item. This metric must be used with the ASIN dimension.\t|\n","|CLICKS\t|Count of how many times a customer clicked an ASIN related widget on the store page. This metric must be used with the ASIN dimension.\t|\n","|CLICK_RATE\t|Rate at which the ASIN was clicked per view. This ratio can be above one if the widget is interacted with on a widget with engaging features. (Product Showcase, Variation Selection in Product Grid, or Interactive Image). This metric must be used with the ASIN dimension.\t|\n","|RENDERS\t|Number of times the ASIN rendered on a store page. NOTE - this does not guarantee that the customer saw the ASIN. This metric must be used with the ASIN dimension.\t|\n","|TOTAL_VIEWS\t|Total number of times customers viewed ASINs on the store pages. A view can happen once per store page visit.\t|\n","|TOTAL_CLICKS\t|Total count of times a customer clicked an ASIN related widget on the store pages.\t|\n"],"documentType":"guide"},{"title":"Brand Store insights metrics","sectionHeader":{"type":2,"text":"Dimensions"},"path":"/en-us/guides/brand-store/insight-metrics","content":[" Dimensions can be used to aggregate the insight metrics. Below is a table of the supported dimension types for insight metrics:\n","|Dimension\t|Description\t|\n","|---\t|---\t|\n","|DATE\t|Aggregate insight metrics by date.\t|\n","|PAGE\t|Aggregate insight metrics by page.\t|\n","|SOURCE\t|Aggregate insight metrics by source.\t|\n","|TAG\t|Aggregate insight metrics by tag.\t|\n","|STORE\t|Aggregate insight metrics by store. \t|\n"," The only dimension available for the ASIN metrics is ASIN.\n","|Dimension\t|Description\t|\n","|---\t|---\t|\n","|ASIN | Aggregate ASIN metrics by ASIN. |\n"],"documentType":"guide"},{"title":"Brand Store insights metrics","sectionHeader":{"type":2,"text":"Quality and recommendations metrics"},"path":"/en-us/guides/brand-store/insight-metrics","content":[" Brand Store quality and recommendations metrics focus on the average dwell time of a Brand Store, how you compare to your peer groups on Amazon, your Store quality rating, and a list of recommended actions you can take to improve the quality and performance of your Store. \n"," A high rating means that you have taken actions that Amazon believes will increase the duration that shoppers spend on your Store (dwell time). Amazon uses your Store rating to recommend specific actions that may help improve your Store performance and dwell time.\n"," Below is a table of the quality and recommendations metrics: \n","|Metric\t|Description\t|\n","|---\t|---\t|\n","|SCORE_LEVEL\t|Store Quality rating calculated on various factors defining the quality of a store. It can be HIGH, MEDIUM, or LOW. This metric currently can only be aggregated by the DATE dimension.\t|\n","|RECOMMENDATIONS\t|An array of objects containing two fields: recommendedAction (for example, \"Add a video\") and observedAverageDwellTimeIncrease (the improvement it would bring in the overall store quality).\t|\n","|CONTRIBUTORS\t|An array of recommendations applied by the Store Owner resulting in the improvement of overall store quality. This metric currently can only be aggregated by the DATE dimension. \t|\n","|DWELL\t|Average time a customer spends on the store, specifically for store quality measurement. This metric currently can only be aggregated by the DATE dimension. \t|\n","|PEER_DWELL\t|Average time a customer spends on other similar (peer) stores on average. This metric currently can only be aggregated by the DATE dimension. \t|\n"],"documentType":"guide"},{"title":"Brand Store insights metrics","sectionHeader":{"type":2,"text":"Examples"},"path":"/en-us/guides/brand-store/insight-metrics","content":[" Request:\n"," Endpoint: /stores/{brandEntityId}/insights\n"," Response:\n"],"documentType":"guide"},{"title":"Budget Rules overview","sectionHeader":null,"path":"/en-us/guides/rules/budget-rules/overview","content":[" Advertisers using sponsored ads can set campaign budgets in advance using budget rules in the Amazon Ads API. Budget rules help reduce manual effort spent on adjusting budgets. You can set budget rules for specific dates or based on performance goals. \n"," Schedule-based budget rules can be set to increase daily budgets for any date range or recommended events, such as Black Friday or Cyber Monday. During shopping events, recommended budgets based on historical shopping activities will be provided. Performance-based budget rules let you set rules to increase budgets based on campaign performance metrics. With budget rules, advertisers can reduce the likelihood of campaigns running out of budgets, especially during peak days or holiday events. \n"," Benefits of using budget rules:\n","Reduces the likelihood of campaigns going out of budget, preventing missed opportunities.\n","Provides budget recommendations for special events.\n","Gives more control over budget.\n","Reduces manual effort and time spent adjusting budget.\n"," There are two types of rules you can create to increase the daily budget for your campaigns:\n","Schedule-based rules enable you to set a rule to increase daily budget based on scheduled events such as Black Friday or a custom time period. This type of rule temporarily increases campaign budgets by the percentage specified in the rule. The budget is increased for the time range specified as part of the rule.\n","Performance-based rules enable you to set rules to increase campaign budgets when your campaigns meet a certain performance threshold. The thresholds are measured using campaign performance metrics such as ACOS, Click-through Rate (CTR), Conversion Rate (CVR), and Return on Ad Spend (ROAS). These metrics are calculated using data from the previous 7 days for sellers and 14 days for vendors.\n"],"documentType":"guide"},{"title":"Budget Rules overview","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/rules/budget-rules/overview","content":[" Learn about creating schedule-based rules or creating performance-based rules.\n"],"documentType":"guide"},{"title":"Schedule-based rules","sectionHeader":null,"path":"/en-us/guides/rules/budget-rules/schedule-based","content":[" Scheduled-based rules enable you to increase the budget of a campaign by a certain percentage during a date range. This date range can be based on an upcoming event or can be a custom date range.\n"," Schedule-based budget rules are created using the following parameters:\n","Rule type: schedule\n","Date range: choose one of the recommended event identifiers - such as Black Friday - or select a custom date range by specifying the start and end date for the active time period of the rule. Note that the recommended event identifier can be retrieved from the recommendation APIs.\n","Recurrence: choose the rule evaluation frequency.\n","Increase budget by: a percentage amount by which to increase your daily budget. For recommended events, the recommendation is a percentage you can apply to your budget rules.  \n"],"documentType":"guide"},{"title":"Schedule-based rules","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/rules/budget-rules/schedule-based","content":[" You can create performance-based budget rules using the POST /budgetRules endpoints. Note there is a separate endpoint for each ad type.\n","|Ad type| Create budget rule endpoint |\n","\\|----\\|-----\\|\n","| Sponsored Products | POST /sp/budgetRules |\n","| Sponsored Brands | POST /sb/budgetRules |\n","| Sponsored Display | POST /sd/budgetRules |\n"],"documentType":"guide"},{"title":"Schedule-based rules","sectionHeader":{"type":2,"text":"Scenarios"},"path":"/en-us/guides/rules/budget-rules/schedule-based","content":[],"documentType":"guide"},{"title":"Schedule-based rules","sectionHeader":{"type":3,"text":"Increasing budget for a custom date range"},"path":"/en-us/guides/rules/budget-rules/schedule-based","content":[" In this scenario, you want to increase budget for a campaign from November 21st to November 30th by 20% on a daily basis. In this example you are creating a budget rule for a custom date range, which will increase the budget every day by 20%.\n"," To achieve this, call the rule creation API with recurrence set to DAILY and dateRange set to custom with start date set to November 21st and end date set to November 30th. The response includes a rule identifier that you use to call the rule association API.\n","Create a budget rule using POST /sp/budgetRules.\n"," Example request body:\n"," Expected HTTP status code: 207\n"," Response body:\n","Associate the budget rule to a campaign using POST /sp/campaigns/{campaignId}/budgetRules.\n"," Example request body:\n"," Expected HTTP status code: 207\n"," Example response body:\n"],"documentType":"guide"},{"title":"Schedule-based rules","sectionHeader":{"type":3,"text":"Increasing budget for a recommended event"},"path":"/en-us/guides/rules/budget-rules/schedule-based","content":[" Creating rules for recommended events involves three steps:\n","Call the Budget Rules Event Recommendation API to receive list of events (Sponsored Brands endpoint and Sponsored Products endpoint). Include the date range for each event and the percentage by which it is recommended that you increase your budget. For events that are available in the list before the dates are announced, the start and end date are empty during rule creation. Later, these rules are automatically updated when the dates are announced.\n","Create a budget rule.\n","Associate the budget rule created in step 2 with a campaign.\n","Call the budget rules event recommendation API (POST /sb/campaigns/budgetRules/recommendations).\n"," Example request body:\n"," Example response:\n","Create a budget rule using POST /sb/budgetRules.\n"," Example request body:\n"," Expected HTTP status code: 207\n"," Example response body:\n","Associate the budget rule created in step 2 with a campaign using POST /sb/campaigns/{campaignId}/budgetRules.\n"],"documentType":"guide"},{"title":"Schedule-based rules","sectionHeader":{"type":3,"text":"Increasing budgets on Fridays, Saturdays, and Sundays with no end date"},"path":"/en-us/guides/rules/budget-rules/schedule-based","content":[" You can set up this rule by calling the rule creation API with recurrence set to weekly and day of week set to Friday, Saturday, and Sunday. \n","Call POST /sd/budgetRules to set up the rule. \n"," Example request body:\n"," Expected HTTP status code: 207\n"," Example response body:\n","Associate the budget rule created in step 1 with a campaign using POST /sd/campaigns/{campaignId}/budgetRules.\n"],"documentType":"guide"},{"title":"Schedule-based rules","sectionHeader":{"type":3,"text":"Increasing the budget from 5:00PM to 10:00PM on Mondays with an end date"},"path":"/en-us/guides/rules/budget-rules/schedule-based","content":[" Call the rule creation API with recurrence set to WEEKLY, daysOfWeek set to MONDAY, and intraDaySchedule set with start time of 17:00 and end time of 22:00.\n"],"documentType":"guide"},{"title":"Performance-based rules","sectionHeader":null,"path":"/en-us/guides/rules/budget-rules/performance-based","content":[" Performance-based rules enable you to create budget rules that increase your budget when a specified condition is met. For example, you could create a rule to increase your budget when top-of-search impression share (IS) is greater than 50%. \n"],"documentType":"guide"},{"title":"Performance-based rules","sectionHeader":{"type":2,"text":"Available metrics by ad type"},"path":"/en-us/guides/rules/budget-rules/performance-based","content":[" Each ad type supports different metrics that you can use to configure performance-based rules.\n","| Metric | Description | Supported ad types |\n","\\|---------\\|---------\\|\n","| ACOS | The percent of attributed sales spent on advertising within the specified time period for a type of campaign due to clicks on your ads. Calculated by dividing total spend by attributed sales. | Sponsored Products, Sponsored Display |\n","| CTR | The click-through rate for the campaign. Calculated by dividing the number of clicks by the number of impressions in the time period. | Sponsored Products, Sponsored Display |\n","| CVR | The conversion rate. Calculated by dividing the number of conversions attributed to clicks in the time period by the clicks that occurred in the time period. | Sponsored Products, Sponsored Display |\n","| IS | Top-of-search impression share for a campaign. Calculated as the percentage of top-of-search impressions a campaign received out of the total top-of-search impressions it was eligible to serve on. Note: IS is not available as a metric for any campaign that contains a video creative. | Sponsored Brands |\n","| NTB | Percent of sales in local currency derived from new-to-brand customers | Sponsored Brands |\n","| ROAS | Return on ad spend. Amazon ROAS is calculated by dividing ad revenue by ad spend, and it tells you how much money you earn for every dollar you invest in advertising. | Sponsored Brands, Sponsored Products, Sponsored Display |\n"],"documentType":"guide"},{"title":"Performance-based rules","sectionHeader":{"type":2,"text":"Request"},"path":"/en-us/guides/rules/budget-rules/performance-based","content":[" You can create performance-based budget rules using the POST /budgetRules endpoints. Note there is a separate endpoint for each ad type.\n","|Ad type| Create budget rule endpoint |\n","\\|----\\|-----\\|\n","| Sponsored Products | POST /sp/budgetRules |\n","| Sponsored Brands | POST /sb/budgetRules |\n","| Sponsored Display | POST /sd/budgetRules |\n"],"documentType":"guide"},{"title":"Performance-based rules","sectionHeader":{"type":3,"text":"Parameters"},"path":"/en-us/guides/rules/budget-rules/performance-based","content":["Rule type: performance 2. Start date: The start date of the rule. 3. End date: This parameter is optional, but it is the end date of the rule. 4. Recurrence: 5. Performance measure: for performance-based rules, you must specify the following properties:\n","Increase budget by: percentage amount by which to increase daily budget.\n"],"documentType":"guide"},{"title":"Performance-based rules","sectionHeader":{"type":2,"text":"Scenarios"},"path":"/en-us/guides/rules/budget-rules/performance-based","content":[],"documentType":"guide"},{"title":"Performance-based rules","sectionHeader":{"type":3,"text":"Sponsored Brands: Increase the budget by 10% if `ROAS` is less than 20%."},"path":"/en-us/guides/rules/budget-rules/performance-based","content":[" To achieve this outcome, create a rule by specifying ROAS for the metric name and set 10% as threshold for performance measure. Next, associate the rule to a campaign.\n","Create a rule by specifying ROAS for the metric name and set 10% as the threshold using POST /sb/budgetRules.\n"," Example request body:\n"," Expected HTTP Status code: 207\n"," Example response body:\n","Associate the budget rule to a campaign using POST /sb/campaigns/{campaignId}/budgetRules.\n"],"documentType":"guide"},{"title":"Performance-based rules","sectionHeader":{"type":3,"text":"Sponsored Products: Increase the budget by 10% if `ACOS` is less than 20%."},"path":"/en-us/guides/rules/budget-rules/performance-based","content":[" To achieve this outcome, create a rule by specifying ACOS for the metric name and set 10% as threshold for performance measure. Next, associate the rule to a campaign.\n","Create a rule by specifying ACOS for the metric name and set 10% as the threshold using POST /sp/budgetRules.\n"," Example request body:\n"," Expected HTTP Status code: 207\n"," Example response body:\n","Associate the budget rule to a campaign using POST /sp/campaigns/{campaignId}/budgetRules.\n"],"documentType":"guide"},{"title":"Performance-based rules","sectionHeader":{"type":3,"text":"Sponsored Display: Increase the budget by 10% if `ACOS` is less than 20%."},"path":"/en-us/guides/rules/budget-rules/performance-based","content":[" To achieve this outcome, create a rule by specifying ACOS for the metric name and set 10% as threshold for performance measure. Next, associate the rule to a campaign.\n","Create a rule by specifying ACOS for the metric name and set 10% as the threshold using POST /sd/budgetRules.\n"," Example request body:\n"," Expected HTTP Status code: 207\n"," Example response body:\n","Associate the budget rule to a campaign using POST /sd/campaigns/{campaignId}/budgetRules.\n"],"documentType":"guide"},{"title":"Performance-based rules","sectionHeader":{"type":2,"text":"Minimum budgets"},"path":"/en-us/guides/rules/budget-rules/performance-based","content":[],"documentType":"guide"},{"title":"Viewing changes to daily budgets for campaigns with budget rules","sectionHeader":null,"path":"/en-us/guides/rules/budget-rules/campaigns-api","content":[" You can view the budget for campaigns with budget rules by using the list campaign resource for each supported ad type. This process is the same for Sponsored Brands, Sponsored Display, and Sponsored Products Version 2, but differs for Sponsored Products Version 3. \n"],"documentType":"guide"},{"title":"Viewing changes to daily budgets for campaigns with budget rules","sectionHeader":{"type":2,"text":"Sponsored Products Version 3"},"path":"/en-us/guides/rules/budget-rules/campaigns-api","content":[" In version 3, if the budget of a campaign has been impacted by a budget rule, you will see an effectiveBudget field included in the campaign budget object returned by POST /sp/campaigns/list.  \n"," You can use effectiveBudget as an indicator that budget rules have been applied, then retrieve the full budget rules history for that campaign using GET /sp/campaigns/{campaignId}/budgetRules. Budget rules with an ACTIVE status are acting on the campaign.\n"],"documentType":"guide"},{"title":"Viewing changes to daily budgets for campaigns with budget rules","sectionHeader":{"type":2,"text":"Sponsored Brands, Sponsored Display, and Sponsored Products Version 2"},"path":"/en-us/guides/rules/budget-rules/campaigns-api","content":[" You can view the budget for campaigns with budget rules by using the list campaign resource associated to that ad type.\n","| Ad type | List campaigns endpoint |\n","\\|------\\|-------\\|\n","| Sponsored Products (V2) | GET v2/sp/campaigns|\n","| Sponsored Brands | POST /sb/v4/campaigns/list  |\n","| Sponsored Display | GET /sd/campaigns|\n"," The presence of ruleBasedBudget in the response indicates that budget rules have been applied. You can then retrieve the full budget rules history for that campaign using the relevant GET /campaigns/{campaignId}/budgetRules endpoint for that ad type. Budget rules with an ACTIVE status are acting on the campaign. \n","| Ad type | GET budget rules endpoint |\n","\\|------\\|-------\\|\n","| Sponsored Products | GET /sp/campaigns/{campaignId}/budgetRules|\n","| Sponsored Brands | GET /sb/campaigns/{campaignId}/budgetRules  |\n","| Sponsored Display | GET /sd/campaigns/{campaignId}/budgetRules|\n"],"documentType":"guide"},{"title":"Viewing changes to daily budgets for campaigns with budget rules","sectionHeader":{"type":3,"text":"Rule evaluation progress"},"path":"/en-us/guides/rules/budget-rules/campaigns-api","content":[" The ruleBasedBudget object also includes the isProcessing field. If this field is set to true, rule evaluation is in progress. Once evaluation is complete, the rule budget value is updated, and isProcessing is set to false.\n"],"documentType":"guide"},{"title":"Viewing changes to daily budgets for campaigns with budget rules","sectionHeader":{"type":2,"text":"Example "},"path":"/en-us/guides/rules/budget-rules/campaigns-api","content":[" This example is for a Sponsored Brands campaign with budget rules applied. \n"," Scenario 2: While rule evaluation is in progress, the response may resemble: \n"," When rule evaluation is complete, the response may resemble:\n"],"documentType":"guide"},{"title":"Including budget rules values in a snapshot","sectionHeader":null,"path":"/en-us/guides/rules/budget-rules/snapshots","content":[" Snapshots enable you to asynchronously retrieve a record of your campaigns and keywords in bulk. \n"," Use the following table to understand which endpoint to use to request a snapshot based on your ad type:\n","| Ad types | Snapshot request endpoint |\n","\\|------\\|-------\\|\n","| Sponsored Brands | POST /v2/hsa/{recordType}/snapshot |\n","| Sponsored Products |POST /v2/sp/{recordType}/snapshot |\n","| Sponsored Display | POST /v2/sd/{recordType}/snapshot|\n"," If you are already using the Snapshots API to retrieve bulk data, you do not need to make any changes to your request. If you have created a budget rule on a campaign and the rule-based budget is currently applied, the snapshot response will contain the ruleBasedBudget object.\n"," The ruleBasedBudget object contains the following attributes:\n","value: the value of rule based budget\n","applicableRuleId: the identifier of the active rule \n","applicableRuleName: the name of the active rule\n","isProcessing: set to true if rule evaluation is in progress. Set to false when evaluation is complete and the rule budget value is updated.\n"," As of February 2023, you can use the presence of the ruleBasedBudget object as an indicator that budget rules have been applied, then retrieve the full budget rules history for that campaign using GET /sb/campaigns/{campaignId}/budgetRules. Budget rules with an ACTIVE status are acting on the campaign. \n"," For example:\n"," A rule-based budget that is under current enforcement:\n"," A campaign with no rule-based budget under current enforcement, or a campaign with no active budget rule: \n"],"documentType":"guide"},{"title":"Including budget rules values in a report","sectionHeader":null,"path":"/en-us/guides/rules/budget-rules/reports","content":[" To create a report using the API, you specify the fields for the report. Rule-based budget metrics are available for the campaigns report type only. To add rule-based budget metrics to a report, specify the following metrics in your report request:\n","| Metric | Description |\n","\\|--------\\|-------------\\|\n","| campaignRuleBasedBudget | The value of the rule-based budget. |\n","| applicableBudgetRuleId | The identifier of the active rule. |\n","| applicableBudgetRuleName | The name of the active rule. |\n"," Depending on the ad type, you can request reports using the following endpoints:\n","| Ad type | Report request endpoint |\n","\\|----\\|------\\|\n","| Sponsored Products | POST /reporting/reports |\n","| Sponsored Brands | POST /v2/hsa/campaigns/report| \n","| Sponsored Display | POST /sd/{recordType}/report|\n"],"documentType":"guide"},{"title":"Including budget rules values in a report","sectionHeader":{"type":2,"text":"Sample report request: Sponsored Brands"},"path":"/en-us/guides/rules/budget-rules/reports","content":[" To create a report that includes all available rule-based budget metrics:\n"," Use the POST /v2/hsa/campaigns/report operation, passing the following request body:\n"," The response will resemble:\n"],"documentType":"guide"},{"title":"Budget rule evaluation","sectionHeader":null,"path":"/en-us/guides/rules/budget-rules/rule-evaluation","content":[" Budget rules are evaluated on your campaigns at the start of the day to calculate campaign budget for the day. If the rule meets the conditions set, the budget is increased for the day in the percentage configured in the rule. If the rule does not meet the conditions set, the daily budget amount is applied for the campaign.\n"," Each time a new budget rule is created or an existing rule is updated, the budget rule is evaluated immediately to update the budget for that day. Similarly, budget rules for a campaign are evaluated to calculate the budget for that day each time the campaign daily budget is modified.\n"," Daily budget is computed for campaigns that have a set budget rule. If the budget rule criteria is satisfied, the campaign budget is increased by the specified percent. Campaigns will not go out of budget as long as the campaign spend is less than the increased budget. If any rule criteria are not satisfied, then the specified daily budget is used. \n"," Multiple rules can be specified for a campaign to a maximum of 250. As of February 2023, we have updated the logic for budget rules. If more than one budget rule satisfies your set conditions, all budget rules are applied and their increases are added to daily budget independently of other budget rules. \n"," For example, consider a campaign “Running Shoes for Q4,” which has three rules set: \n","Increase budget by 20% with no end date if ROAS is greater than 3 (performance rule), \n","Increase budget by 40% with no end date if ROAS is greater than 3 (performance rule), and \n","Increase budget by 100% on November 27 (Black Friday, schedule rule). \n"," Suppose that ROAS for the campaign is 4. When we evaluate the rules for November 27, the system implements a 140% daily budget increase for that day. This includes 40% increase from the performance rule whose conditions were met, and 100% increase from the scheduled rule. Note that the 20% performance rule was not applied because its condition was not met.\n"," As another example, if the campaign has two rules set: \n","Increase budget by 50% on November 27, and \n","Increase budget by 25% between 5:00PM and 9:00PM with no end date. \n"," When we evaluate the rules for November 27, the system implements a 50% increase from 12:00AM to 5:00PM. From 5:00PM to 9:00PM, the campaign will get an additional 25% from the scheduled rule with hours of day increase for a total of 75% in that period, and at 9:00PM the increase will be back to 50%.\n"],"documentType":"guide"},{"title":"Budget rule evaluation","sectionHeader":{"type":2,"text":"Budget rule status"},"path":"/en-us/guides/rules/budget-rules/rule-evaluation","content":[" Budget rules include status based on conditions specified in the rule, including the date range and performance goal. \n"," Active\n"," The rule is active and budget for the day is increased based on the rule configuration. \n"," On Hold\n"," The budget rule can be “on hold” for any of the following reasons:\n","Performance criteria have not yet been met. \n","Another active rule supersedes the current rule.\n","A recurrence condition has not yet been met.\n"," Paused\n"," The rule is paused and not eligible for evaluation.\n"," Budget threshold not met\n"," The rule is not applicable because the minimum required daily budget threshold required is not met. This is applicable for performance rules only.\n"," Pending Start\n"," The start date of the rule is in the future. On the start date, the rule will be evaluated and will become active if the condition is satisfied.\n"," Expired\n"," The rule has reached the end date specified in the rule configuration.\n"],"documentType":"guide"},{"title":"Sponsored Products Rule-based bidding overview","sectionHeader":null,"path":"/en-us/guides/rules/bidding-rules/overview","content":[" Rule-based bidding eliminates the need to manually adjust bids to achieve your marketing strategy. For any existing campaign running for at least 10 days, you can apply a rule with a guardrail of ROAS and Amazon Ads may then adjust your base bids up and down to increase conversions while maintaining your guardrails. Amazon Ads does not guarantee the ROAS guardrail. However, if your campaign is not meeting the guardrail and the return on ad spend (ROAS) of the campaign for the last 20 days drops to less than 30% of your ROAS over a 20-to-40-day period, we will disable the rule on your behalf and will enable your previous bidding strategy and targeting level bids. \n"," When we disable your rule, you will receive a notification in the bell drawer with a link to the campaign.\n"],"documentType":"guide"},{"title":"Sponsored Products Rule-based bidding overview","sectionHeader":{"type":2,"text":"Eligible campaigns"},"path":"/en-us/guides/rules/bidding-rules/overview","content":[" Rule-based bidding is available for Sponsored Products. Campaigns can use any type of targeting (Automatic, Keyword or Product Targeting). Your campaign must be running for at least 10 days prior to setting a rule and have a minimum of 10 conversions in the last 30 days. Additionally, your campaign must meet the minimum budget requirement in the marketplace listed below.\n"],"documentType":"guide"},{"title":"Sponsored Products Rule-based bidding overview","sectionHeader":{"type":2,"text":"Guardrails"},"path":"/en-us/guides/rules/bidding-rules/overview","content":[" The guardrail is applied at the campaign level and the ROAS guardrail is based on the previous 21 days. \n"," For example if you have a manual targeting campaign with a ROAS guardrail of $2 and two targeting clauses:\n","shoes, BROAD match, and 2. \"Example brand shoes\", EXACT match.\n"," For the previous 21 days, the shoes BROAD match targeting clause may have a ROAS of $1.50 with $1 CPC and the \"Example brand shoes\" EXACT match targeting clause may have a ROAS of $4 with $0.25 CPC. In this example, we may continue to bid $1 for the broad match targeting clause and $0.50 for the exact match targeting clause to increase your conversions and achieve a ROAS of $2 on $125 of ad spend for your campaign.\n"," Note that Amazon Ads does not guarantee that we will meet the guardrail that you set. However, if your campaign is not meeting the guardrail and the return on ad spend (ROAS) of the campaign for the last 20 days drops to less than 30% of your ROAS over a 20-to-40-day period, we will disable the rule on your behalf and will enable your previous bidding strategy and targeting level bids. When we disable your rule, you will receive an additional recommendation from AMR with an updated suggestion for your ROAS guardrail. If you choose to not accept the new recommendation your campaign will use the bidding strategy set prior to applying the rule.\n"," We suggest that you use the provided recommendation to set your ROAS guardrail. This recommendation is based on your historical campaign information and a group of similar advertisers. Additionally, if you set your ROAS guardrails too aggressively, you may see a decrease in the number of conversions compared to your historical performance. We recommend that you provide a ROAS that is in line with your expectations while following closely to our recommendations, then adjust to hit your business goals over time.\n"],"documentType":"guide"},{"title":"Sponsored Products Rule-based bidding overview","sectionHeader":{"type":2,"text":"Reporting"},"path":"/en-us/guides/rules/bidding-rules/overview","content":[" There are no additional steps to generate a bid with rule-based bidding enabled. To report on your ROAS, spend, CPC, and other metrics, use the reports to create either a search term report, campaign performance report, or impression rank report.\n"],"documentType":"guide"},{"title":"Sponsored Products Rule-based bidding overview","sectionHeader":{"type":2,"text":"Minimum budget required for rule-based bidding"},"path":"/en-us/guides/rules/bidding-rules/overview","content":[" Performance rules rely on having clicks and conversions on a campaign. The minimum required budget aims at increasing the likelihood the campaign will have enough traffic for metrics to be evaluated and increase the quality of the recommendations.\n"," The table below lists the minimum daily budget for each supported marketplace:\n","| Marketplace | Minimum daily budget in local currency |\n","\\|-------------\\|----------------------------------------\\|\n","| AE | 10 |\n","| AU | 10 |\n","| CA | 10 |\n","| DE | 10 |\n","| ES | 10 |\n","| FR | 10 |\n","| IN | 300 |\n","| IT | 10 |\n","| JP | 600 |\n","| MX | 50 |\n","| UK | 10 |\n","| US | 10 |\n","| BR| 20|\n","| EG | 50 |\n","| SA | 20 |\n","| SE | 50|\n","| PL | 30 |\n","| TR | 50 |\n","| NL | 10 |\n","| BE | 10 |\n","| SG | 10 | \n"],"documentType":"guide"},{"title":"Sponsored Products Rule-based bidding overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/rules/bidding-rules/overview","content":[" If you do not have access to the Sponsored Products API, follow the steps in Advertising API account setup. \n"],"documentType":"guide"},{"title":"Getting started with the Sponsored Products rule-based bidding API","sectionHeader":null,"path":"/en-us/guides/rules/bidding-rules/getting-started","content":[" Rule-based bids are represented by the campaignOptimization resource in the Sponsored Products API.\n"," The API includes operations to create, read, update, and delete campaignOptimization resources. You can also query the state of a campaignOptimization resource, determine campaign eligibility, and get a ROAS guardrail.\n"],"documentType":"guide"},{"title":"Getting started with the Sponsored Products rule-based bidding API","sectionHeader":{"type":2,"text":"Create a rule"},"path":"/en-us/guides/rules/bidding-rules/getting-started","content":[" You can create a rule by setting the theme to \"increase conversions while maintaining a ROAS guardrail\". You can set the ROAS guardrail in your local currency that can be applied across multiple campaigns. You should then associate the rule to a set of campaigns.\n"," Request body: \n"," Response Body:\n"],"documentType":"guide"},{"title":"Getting started with the Sponsored Products rule-based bidding API","sectionHeader":{"type":2,"text":"Retrieve a Rule"},"path":"/en-us/guides/rules/bidding-rules/getting-started","content":[" To retrieve a rule by identifier, use the GET operation specifying the identifier in the path:\n"," Response Body:\n"],"documentType":"guide"},{"title":"Getting started with the Sponsored Products rule-based bidding API","sectionHeader":{"type":2,"text":"Rule Update"},"path":"/en-us/guides/rules/bidding-rules/getting-started","content":[" To update a rule, use the PUT operation:\n"," Request body:\n"," Response body:\n"],"documentType":"guide"},{"title":"Getting started with the Sponsored Products rule-based bidding API","sectionHeader":{"type":2,"text":"Rule Deletion"},"path":"/en-us/guides/rules/bidding-rules/getting-started","content":[" To delete a rule specified by identifier, use the DELETE operation specifying the identifier in the path:\n"," Response body:\n"],"documentType":"guide"},{"title":"Getting started with the Sponsored Products rule-based bidding API","sectionHeader":{"type":2,"text":"State of the Rule"},"path":"/en-us/guides/rules/bidding-rules/getting-started","content":[" You can query the state of a rule associated with a campaign by specifying a list of campaignIds in the request body of the campaignOptimization/state resource:\n"," Request body:\n"," Response body:\n"],"documentType":"guide"},{"title":"Getting started with the Sponsored Products rule-based bidding API","sectionHeader":{"type":2,"text":"Eligibility"},"path":"/en-us/guides/rules/bidding-rules/getting-started","content":[" To determine whether a campaign is eligible for rule-based bidding or not, use the POST operation to get the campaignOptimization/eligibility resource. If a campaign is eligible, the response includes a ROAS and bid guardrail guidelines for a given campaign identifier. The response data is based on the historical campaign performance of advertisers similar to you. \n"," Request body:\n"," Response body:\n"],"documentType":"guide"},{"title":"Scheduled bid rules","sectionHeader":null,"path":"/en-us/guides/rules/bidding-rules/scheduled-bid-rules","content":[" Schedule bid rules allow advertisers to automatically increase bids at specific times of the day, days of the week, date ranges, or during high-traffic events like Black Friday. To set up a schedule bid rule, advertisers must first create an optimization rule using the POST /sp/rules/optimization endpoint, which defines the conditions and bid adjustment for the rule. After creating the optimization rule, the optimizationRuleId can be used to associate the rule with a specific campaign through the POST /sp/campaigns/{campaignId}/optimizationRules endpoint. The bid is increased according to the configuration of the rule when the defined conditions are met. However, if the conditions are not met, no bid increase is applied.\n"],"documentType":"guide"},{"title":"Scheduled bid rules","sectionHeader":{"type":2,"text":"Create an optimization rule"},"path":"/en-us/guides/rules/bidding-rules/scheduled-bid-rules","content":[" Consider a campaign \"Running Shoes for Q4,\" which has the following rules set: \n","Daily rule - Increase bids by 10% with no end date. 2. Black Friday rule - Increase bids by 20% on Black Friday. 3. 4 hour rule - Increase bids by 20% between 5:00PM and 9:00PM with no end date.\n"," On Black Friday, we will implement a 30% daily bid increase for that day. This includes the 10% increase from the daily rule whose conditions were met, and 20% increase from the Black Friday rule. The campaign will get an additional 20% increase from the 4 hour rule increasing the bid total to 50%. After 9:00PM, the daily bid increase will be back to 30%.\n"," For the example below, the POST /sp/rules/optimization endpoint is called with recurrence set to DAILY and timesOfDay set with start time of 5:00 and end time of 13:00.\n"," A successful response includes the optimizationRuleId, which is used to associate an optimization rule to a campaign. See associate optimization rule to a campaign for more details. \n"],"documentType":"guide"},{"title":"Scheduled bid rules","sectionHeader":{"type":3,"text":"Scenario examples"},"path":"/en-us/guides/rules/bidding-rules/scheduled-bid-rules","content":[" Scenario 1: You want to increase the budget for the whole day, only on weekends, with no end date. \n"," Solution: Call the POST /sp/rules/optimization endpoint with recurrence set to WEEKLY and daysOfWeek set to SATURDAY and SUNDAY, with no filter on times of day.\n"," Scenario 2: You want to increase the budget from 10:00PM to 11:00PM, only on Wednesday, but with the rule ending in a year. \n"," Solution: Call the POST /sp/rules/optimization endpoint with recurrence set to WEEKLY, daysOfWeek set to WEDNESDAY, timesOfDay set with start time of 22:00 and end time of 23:00, and a duration end time of 08/01/2024.\n"," Scenario 3: You want to change the already-created above rule in scenario 3 to only modulate bids by 15% instead of 30%.\n"," Solution: Call the PUT /sp/rules/optimization endpoint with the same fields as the scenario 3 rule, but change action.actionDetails.value to 15.\n"," Scenario 4: You want to create a rule that increases the bid by 20% during the Black Friday event.\n"," Solution: Call the POST /sp/rules/optimization endpoint with the duration field containing the event name and event ID. Event details can be obtained from the POST /sp/v1/events endpoint.\n"],"documentType":"guide"},{"title":"Scheduled bid rules","sectionHeader":{"type":2,"text":"Associate optimization rule to a campaign"},"path":"/en-us/guides/rules/bidding-rules/scheduled-bid-rules","content":[" Using the POST /sp/campaigns/{campaignId}/optimizationRules endpoint, you can associate an optimization rule to a campaign. You must use the optimizationRuleId obtained from creating an optimization rule.\n"," Example request:\n"," A successful response will include a message confirming that the optimization rule was associated with a campaign. \n"],"documentType":"guide"},{"title":"Scheduled bid rules","sectionHeader":{"type":2,"text":"Search and retrieve existing optimization rules"},"path":"/en-us/guides/rules/bidding-rules/scheduled-bid-rules","content":[" Using the POST /sp/rules/optimization/search endpoint, you can search for and retrieve existing optimization rules. This endpoint is useful especially if you are looking for optimization rules to associate to a specific campaign. \n"," Example request:\n"," Response:\n"],"documentType":"guide"},{"title":"Budget usage overview","sectionHeader":null,"path":"/en-us/guides/budgets/usage/overview","content":[" The budget usage API retrieves the budget usage percent for your campaigns and portfolios to provide near real-time information about your budget usage. You can request the budget usage percent which is retrieved in near real-time for any active, paused, or expired campaigns or portfolios.\n"],"documentType":"guide"},{"title":"Budget usage overview","sectionHeader":{"type":3,"text":"Budget usage calculation"},"path":"/en-us/guides/budgets/usage/overview","content":[" Budget usage percent is the current campaign ad spend for the day divided by the specified daily budget. This includes changes in budget due to budget rules and increases from average daily budget calculations. \n"," For example, consider a campaign with daily budget of $100.00, no budget rules, and no average daily budget increases. In this case, if the current daily campaign spend is $80.00, the budget usage percent equals 80% since there was no increase in budget.\n"],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":null,"path":"/en-us/guides/budgets/usage/getting-started","content":[" You can check budget usage at both the individual campaign level and the portfolio level. \n"," Each ad type has its own budget usage endpoint. For example, to check the current budget usage for a Sponsored Products campaign, you would use the POST /sp/campaigns/budget/usage endpoint. \n","|Ad type| Endpoint |\n","\\|-------\\|----------\\|\n","| Sponsored Products |POST /sp/campaigns/budget/usage|\n","| Sponsored Brands | POST /sb/campaigns/budget/usage|\n","| Sponsored Display | POST /sd/campaigns/budget/usage|\n"],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":2,"text":"Retrieving budget usage percentage for one or more campaigns"},"path":"/en-us/guides/budgets/usage/getting-started","content":[" This example shows how to retrieve budget usage for a Sponsored Brands campaign. The pattern is the same for all three ad types.\n"],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":3,"text":"Request body"},"path":"/en-us/guides/budgets/usage/getting-started","content":[" The request object for the usage resource supports a maximum of 100 campaigns per request.\n"],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":3,"text":"Response body"},"path":"/en-us/guides/budgets/usage/getting-started","content":[" A successful response returns a 207 status code as well as a list of budget usage response objects reflecting the same order as the input. The lastUpdatedDate field provides the timestamp at which the budgetUsagePercent was recorded.\n"],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":2,"text":"Other examples"},"path":"/en-us/guides/budgets/usage/getting-started","content":[" The following examples demonstrate several scenarios you can expect when you retrieve the usage resource.\n"," This example demonstrates all requested campaignIds being retrieved successfully. \n"],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":3,"text":"Request body"},"path":"/en-us/guides/budgets/usage/getting-started","content":[],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":3,"text":"Response body"},"path":"/en-us/guides/budgets/usage/getting-started","content":[" In this example, campaign1 was retrieved successfully, but campaign2 and campaign3 received an error.\n"],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":3,"text":"Request body"},"path":"/en-us/guides/budgets/usage/getting-started","content":[],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":3,"text":"Response body"},"path":"/en-us/guides/budgets/usage/getting-started","content":[],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":2,"text":"Retrieving budget usage percentage for a portfolio"},"path":"/en-us/guides/budgets/usage/getting-started","content":[" A portfolio is a group of campaigns that you can organize by brand, product category, or by season. This example demonstrates all requested portfolioIds being retrieved successfully.\n"],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":3,"text":"Request body"},"path":"/en-us/guides/budgets/usage/getting-started","content":[" The request object for the usage resource supports a maximum of 100 portfolios per request.\n"],"documentType":"guide"},{"title":"Getting started with the budget usage API","sectionHeader":{"type":3,"text":"Response body"},"path":"/en-us/guides/budgets/usage/getting-started","content":[],"documentType":"guide"},{"title":"Partner opportunities overview","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/overview","content":[],"documentType":"guide"},{"title":"Partner opportunities overview","sectionHeader":{"type":2,"text":"Key benefits"},"path":"/en-us/guides/recommendations/partner-opportunities/overview","content":[" There are a number of benefits for using the Partner Opportunities API. A few key benefits include:\n","Automated opportunity discovery: Programmatically access automated and personalized recommendations, allowing you to process and evaluate multiple opportunities simultaneously across your entire catalog.  Enhanced client support and decision making: Receive custom, data-driven insights aimed at improving overall campaign performance, helping you prioritize and view all client accounts in a single response. This comprehensive view enables better strategic decision-making, allowing you to identify and act on high-value opportunities that align with the goals of your clients and stay ahead of the competition.  Time and resource optimization: Access insights for all advertising products through a single API, reducing the number of calls required and saving valuable time and resources.\n"],"documentType":"guide"},{"title":"Partner opportunities overview","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/recommendations/partner-opportunities/overview","content":["You are a registered member of the Amazon Ads Partner Network and have been added as a user. 1. You have access to the Amazon Ads API. If you do not already have access, you must complete the API onboarding steps. While pursuing API access, you can still use the Partner Opportunities UI to access opportunities without API integration. 1\\*. You check whether you have Amazon Ads API access in your Partner Network account. 1. You have advertiser accounts linked to your Partner Network account. \n"],"documentType":"guide"},{"title":"Partner opportunities overview","sectionHeader":{"type":2,"text":"Opportunity catalog"},"path":"/en-us/guides/recommendations/partner-opportunities/overview","content":[" A list of opportunities is available through the Partner Opportunities API or UI. Partners can use these opportunities to optimize and improve their advertising campaigns. Review the complete Opportunity Catalog to identify which Partner Opportunities calls best suit your needs.\n"],"documentType":"guide"},{"title":"Partner opportunities overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/recommendations/partner-opportunities/overview","content":[],"documentType":"guide"},{"title":"Partner opportunities catalog","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/catalog/overview","content":[" This table lists the types of opportunities we have available. Select an opportunity type to see a list of individual opportunities for that type.\n","| Opportunity Type    | Description  |\n","\\| --- \\| --- \\|\n","| Unlaunched Asins\t| Recommendations and insights about the high-potential, unadvertised ASINs of your advertising clients. \t|\n","| Share Of Voice Insights\t| Insights about percentage of impressions (or Share of voice, SOV) for each advertiser.\t|\n","| Deals\t| Actionable insights to optimize retail deal performance on the Amazon store.\t|\n","| Category Insights\t| Data-driven category performance insights to guide marketing strategy. \t|\n","| Campaign Optimization\t| Targeted recommendations to create and enhance existing advertising campaigns.\t|\n","| Advertiser Insights\t| Analyses about the advertisers that you manage to refine and launch new strategies.\t|\n","| Click Credits\t| Promotional credits for qualifying advertisers (see Terms and Conditions in each opportunity). \t|\n","| Path To Purchase Insights\t| Customer journey analysis showing how shoppers interact with brands and products.\t|\n","| Amazon Account Team Recommendations\t| Curated advertising suggestions from Amazon Ads account managers for accounts they manage. \t|\n"],"documentType":"guide"},{"title":"Partner opportunities catalog - Amazon Account Team Recommendations","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/catalog/amazon-account-team-recommendations","content":[" Curated advertising suggestions from Amazon Ads account managers for accounts they manage. You can learn more about our account team recommendations in the Partner Opportunities user interface.\n","| Opportunity Title | Description | Opportunity ID |\n","\\| --- \\| --- \\| --- \\|\n","| Optimize bids for Sponsored Display campaigns to help improve performance\t|Your advertisers have low-performing Sponsored Display campaigns with spend in the top 50% of the advertiser's campaigns. Apply the recommended bids to help improve performance.\t|amzn1.ads-partner1.opportunity.2209e375-fc4a-4017-8668-d8f4c4fcd792\t|\n","| Optimize bids for low performing campaigns\t|Your advertisers have low-performing Sponsored Brands campaigns with at least one impression in the last 14 days and ROAS less than or equal to 3. Apply the recommended bids to help improve performance.\t|amzn1.ads-partner1.opportunity.2720f52d-cb78-437d-9ef5-e7c8becd75b1\t|\n","| Create Sponsored Display campaign for ASINs declining clickthrough rate\t|These products saw a clickthrough rate lower than that of similar products. We have set up a ready-to-launch Sponsored Display campaign for these products with presets optimized to help drive traffic.\t|amzn1.ads-partner1.opportunity.2973f744-1678-4a4d-a38c-1722fa91c547\t|\n","| Add new targets to drive sales for high performing Sponsored Display campaigns\t|Advertiser's top performing cost per click Sponsored Display campaigns with spend in the bottom 50%. Recommend adding new targets to drive sales.\t|amzn1.ads-partner1.opportunity.29a058a4-4717-4279-8c47-b85392b1b94e\t|\n","| Add new targets to drive sales\t|Ad groups or campaigns either did not receive any impressions or clicks, or had decline in impressions or clicks in last 14 days. Recommend adding new targets. to drive sales\t|amzn1.ads-partner1.opportunity.2bfca698-cfce-4bd1-8140-f26eceedd048\t|\n","| Increase bids for high performing Sponsored Products campaigns\t|Your advertisers have bid recommendations for Sponsored Products campaigns with high click through rates, compared to similar campaigns. Applying keyword bid recommendations can increase sales.\t|amzn1.ads-partner1.opportunity.3cd77373-e4b7-48a9-86d4-088c959f8773\t|\n","| Create Sponsored Display contextual campaigns for high performing ASINs.\t|These ASINs are forecasted to have high sales in next 90 days, but are not advertised. Recommend creating a Sponsored Display contextual campaign\t|amzn1.ads-partner1.opportunity.427cf699-3abc-43e3-a891-2630bb1646b0\t|\n","| Add event budget rule for Sponsored Brands campaigns with over 50% budget utilization\t|Campaign with over 50% budget utilization, which will be impacted by an upcoming special event. Budget rules help prevent campaigns from going out of budget during peak traffic periods. Recommend adding the budget rule for the upcoming event\t|amzn1.ads-partner1.opportunity.462ff753-3c8e-492f-bacd-3fec00e67bc5\t|\n","| Create a Sponsored Products manual campaigns for high performing ASINs\t|These ASINs are forecasted to have high sales in next 90 days, but are not advertised. Recommend creating a Sponsored Products manual campaign\t|amzn1.ads-partner1.opportunity.4ae3659e-266b-4ac1-854e-30dabcb7d7db\t|\n","| Create Sponsored Display campaign for ASINs with declining conversion rate\t|These products saw a conversion rate lower than that of similar products. We have set up a ready-to-launch Sponsored Display campaign for these products with presets optimized to help drive conversions.\t|amzn1.ads-partner1.opportunity.573eb2fd-d399-413e-bd00-d00392e03b78\t|\n","| Create campaigns with ad-ready ASINs to increase clicks\t|These advertisers have ad-ready ASINs that are not being advertised. Ad-ready ASINs are 16 times more likely to be clicked on if advertised compared to other ASINs. Recommend creating a Sponsored Products campaign with these ad-ready ASINs\t|amzn1.ads-partner1.opportunity.69f12478-541a-42dc-b4b0-4e492a1c4cdb\t|\n","| Optimize Sponsored Products campaigns with low click through and conversion\t|Campaigns have lower click through and conversion compared to other similar campaigns. Recommend adding new targets to improve performance\t|amzn1.ads-partner1.opportunity.7b81e613-ca11-4687-b4f6-40924c1e0f12\t|\n","| Add new keywords to improve performance for Sponsored Brands Campaigns\t|Campaigns have less than 200 impressions or zero clicks in last 14 days. Recommend adding new keywords to improve performance\t|amzn1.ads-partner1.opportunity.83aba934-f0b6-49aa-93c4-1687a6018686\t|\n","| Create Sponsored Brands campaign with video creative to drive page visits\t|The advertiser is a brand owner with a Brand Store. Recommend creating Sponsored Brands keyword targeting campaign with video creative linking to a Brand Store to drive page visits.\t|amzn1.ads-partner1.opportunity.99f92fde-09fa-47a5-bb7d-b9b08c1e3ba9\t|\n","| Increase budget for high performing and high budget utilizing campaigns\t|Campaigns with high ROAS and high budget utilization, compared to similar campaigns. These campaigns may run out of budget resulting in missed impressions and clicks. We have provided performance benchmarks for similar campaigns for comparison. Recommend increasing campaign budget.\t|amzn1.ads-partner1.opportunity.b72317a6-159c-4faf-a6ea-6339b1c4226d\t|\n","| Add event budget rule for Sponsored Products campaigns with over 50% budget utilization\t|Campaign with over 50% budget utilization, which will be impacted by an upcoming special event. Budget rules help prevent campaigns from going out of budget during peak traffic periods. Recommend adding the budget rule for the upcoming event\t|amzn1.ads-partner1.opportunity.bbd72fb6-9ce8-475d-b25b-9592085e2fc6\t|\n","| High-performing campaigns may run out of budget\t|Campaigns with ROAS above 3 have used more than 80% of their budget. Running out of budget could result in missed impressions and clicks. Recommend increasing campaign budget.\t|amzn1.ads-partner1.opportunity.d3e3ca26-f018-46ad-884e-aa59a08085c4\t|\n","| New campaign creation opportunities\t|These new campaigns are curated by Amazon Ads account team member with specific ASIN selection and targeting strategies. Individual recommendations will span Sponsored Brands, Sponsored Products, and Sponsored Display campaigns. Recommend creating new campaigns.\t|amzn1.ads-partner1.opportunity.d4b35c6f-2774-48ae-8938-61365cb10dd1\t|\n","| Create a Sponsored Brands campaign with video creative to grow brand impression share\t|The advertiser is a brand owner with a Brand Store. Recommend creating Sponsored Brands keyword targeting campaign with video creative linking to a Brand Store to grow brand impression share.\t|amzn1.ads-partner1.opportunity.f2e8c70a-9b7b-4feb-a951-489d0a3388df\t|\n"],"documentType":"guide"},{"title":"Partner opportunities catalog - Campaign Optimization","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/catalog/campaign-optimization","content":[" Targeted recommendations to create and enhance existing advertising campaigns. You can learn more about our campaign optimization recommendations in the Partner Opportunities user interface.\n","| Opportunity Title | Description | Opportunity ID |\n","\\| --- \\| --- \\| --- \\|\n","| Sponsored Products Target Promotion Groups Recommendations\t|Recommendations for Automatic Targeting (AT) to Manual Targeting (MT) ad target conversions. We have provided recommended targets for AT to MT conversion, along with the historical clicks, conversions, conversion rate, and ROAS for the recommended target from the past 64 days.\t|amzn1.ads-partner1.opportunity.16ae4f60-c6d4-4b43-a343-48056c1d1147\t|\n","| Reduce risk of Sponsored Brands campaigns exhausting budgets\t|Help your advertisers keep top-performing Sponsored Ads campaigns active throughout the day\t|amzn1.ads-partner1.opportunity.290d8c4c-bdb0-4d2f-bb56-fee09b81f991\t|\n","| Re-engage shoppers who viewed your advertisers' products without purchasing\t|Help your advertisers reach shoppers who show interest in their products.\t|amzn1.ads-partner1.opportunity.4f89ff1b-a253-4357-a22d-355cd618bd45\t|\n","| Drive visibility for ad restricted ASINs through Sponsored Products\t|Help your advertisers drive visibility on high-potential ad restricted ASINs, where the ASINs have sales but no ad impressions over the last 30 days. Create new single ASIN Ad groups in new Sponsored Product campaigns to help increase potential impressions.\t|amzn1.ads-partner1.opportunity.6240edd9-113a-447f-ab93-2ad0188ca43a\t|\n","| Reduce risk of Sponsored Display campaigns exhausting budgets\t|Help your advertisers keep top-performing Sponsored Ads campaigns active throughout the day\t|amzn1.ads-partner1.opportunity.94f5764b-1a14-4288-8039-84f7d8158068\t|\n","| Showcase newly launched high-potential, unadvertised ASINs\t|New, unadvertised ASINs can be featured in Sponsored Product Campaigns. Help your advertisers drive visibility by creating new campaigns.\t|amzn1.ads-partner1.opportunity.9cf2584f-83c1-4a4d-9952-718b3d28476d\t|\n","| Create Sponsored Products campaign with presets\t|Use auto-populated campaign settings based on ASIN scenarios like excess inventory or in-season ASINs to easily launch new campaigns. Advertisers who created a new Sponsored Products campaign using preset recommendations saw 29% more ad-attributed sales on average after one month, compared to similar \\* advertisers who did not create a campaign with preset recommendations.  \\*Amazon internal data, WW, September 2022 – August 2023. Similarity between advertisers is defined using metrics such as level of ad spend before and after the campaign launch, Sponsored Products impressions, clicks, attributed sales and units sold.\t|amzn1.ads-partner1.opportunity.022290b9-7f6d-4257-8e2e-3ed4bb821180\t|\n","| Advertise products with rising ratings\t|These products have either gained higher star ratings over the past 4 weeks, have consistently maintained 4-star ratings or above, or have more than 100 ratings. Advertising these products can help you increase sales.\t|amzn1.ads-partner1.opportunity.74ed8b46-c32d-4178-8f7e-b54a9effa3e8\t|\n","| Sponsored Products budget recommendations and missed opportunities\t|Advertisers with campaigns which are utilizing their full daily budget could still miss out on sales. We have provided estimated additional impressions, clicks and sales the campaign might have generated had it been in budget 100% of the time. These are estimates based on historical website traffic and campaign performance (for example, percent time in budget) - and not a guarantee of actual impressions, clicks and sales. Missed opportunities and budget recommendations are refreshed once per day.\t|amzn1.ads-partner1.opportunity.e3f2c89c-2189-4db6-b0a9-20e2ebf4c5be\t|\n","| Advertise products with upcoming coupons\t|These products have upcoming coupons. Advertising them can help drive sales. These are products that will have a live coupon in the upcoming week.\t|amzn1.ads-partner1.opportunity.f1830672-6aa6-4cbf-848e-7dc50a9bc066\t|\n","| Sponsored Display Out of Budget campaigns: budget recommendations to avoid exhausting budget mid-day and missed opportunities\t|You have advertisers that have campaigns that will likely exhaust their budget mid-day and could miss out on sales. We have provided estimated additional impressions, clicks and sales the campaign might have generated had it been in budget 100% of the time. These are estimates based on historical website traffic and campaign performance (for example, percent time in budget) - and not a guarantee of actual impressions, clicks and sales. Missed opportunities and budget recommendations are refreshed once per day.\t|amzn1.ads-partner1.opportunity.f8b6adab-af38-457f-9f24-7a903e5fd93d\t|\n","| Reduce risk of Sponsored Products campaigns exhausting budgets\t|Help your advertisers keep top-performing Sponsored Ads campaigns active throughout the day\t|amzn1.ads-partner1.opportunity.880a31ad-d5ee-4097-8f23-f89c5e1ffb3f\t|\n"],"documentType":"guide"},{"title":"Partner opportunities catalog - Category Insights","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/catalog/category-insights","content":[" Data-driven category performance insights to guide marketing strategy. You can learn more about our category insight recommendations in the Partner Opportunities user interface.\n","| Opportunity Title | Description | Opportunity ID |\n","\\| --- \\| --- \\| --- \\|\n","| Advertise your top selling products | These products are among the top-selling products in your catalog. These products are in the top 30% of your product catalog based on units sold over the past 60 days. Advertising these products can help you increase impressions and sales. | amzn1.ads-partner1.opportunity.060d18a7-2816-46c3-bf3e-be9a9dce0b6c |\n"],"documentType":"guide"},{"title":"Partner opportunities catalog - Click Credits","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/catalog/click-credits","content":[" Promotional credits for qualifying advertisers (see Terms and Conditions in each opportunity. You can learn more about our click credits recommendations in the Partner Opportunities user interface.\n","| Opportunity Title | Description | Opportunity ID |\n","\\| --- \\| --- \\| --- \\|\n","| Help your advertisers earn click credits when they launch a Sponsored Brands campaign | Your eligible advertisers will be rewarded promotional click credits when they launch a Sponsored Brands campaign on Amazon Ads. Promote this offer to your eligible advertisers to help them earn click credits. Select Sellers invited by Amazon via email to participate in the Sponsored Brands Click Credit Offer Promotion (\"Advertisers\"), and that complete the Qualifying Action (as defined in the applicable Promotion Terms and Conditions included within the promotion email invitation sent from Amazon to Advertisers (the \"T&Cs\")), shall receive a single promotional click amount (as described in the applicable T&Cs) to the Amazon sponsored ads account of the Advertiser, per eligible marketplace, which can be redeemed for sponsored ads, subject to the terms and restrictions of the T&Cs. Please find a list of the eligible Advertisers attached which includes information about the promotion including, without limitation, the respective offer amount of the Advertiser, promo start/end date, Qualifying Action, and other relevant information. A generic example of the promotion Terms and Conditions can be found here (link: https&#x3A;//advertising.amazon.com/legal/terms-conditions/sponsored-brands-launch-promotion ) for reference, provided Advertisers shall be subject to the T&Cs received directly from Amazon in the email invitation. | amzn1.ads-partner1.opportunity.3c2e9389-8504-4e2d-b708-98f5f0747d81 |\n","| Help your advertisers earn click credits when they launch a Sponsored Products campaign | Your eligible advertisers will be rewarded promotional click credits \\* when they launch a Sponsored Products campaign on Amazon Ads and select \"no end date\" for campaign length. Promote this offer to your eligible advertisers to help them earn click credits. Select Sellers invited by Amazon via email to participate in the Sponsored Products Click Credit Offer Promotion (\"Advertisers\"), and that complete the Qualifying Action (as defined in the applicable Promotion Terms and Conditions included within the promotion email invitation sent from Amazon to Advertisers (the \"T&Cs\")), shall receive a single promotional click amount (as described in the applicable T&Cs) to the Amazon sponsored ads account of the Advertiser, per eligible marketplace, which can be redeemed for sponsored ads, subject to the terms and restrictions of the T&Cs. Please find a list of the eligible Advertisers attached which includes information about the promotion including, without limitation, the respective offer amount of the Advertiser, promo start/end date, Qualifying Action, and other relevant information. A generic example of the promotion Terms and Conditions can be found here (link:https&#x3A;//advertising.amazon.com/partner-network/help/GBW5K6Q6KFX2VQ56) for reference, provided Advertisers shall be subject to the T&Cs received directly from Amazon in the email invitation. | amzn1.ads-partner1.opportunity.7482e3a0-aad1-4383-86b8-8c95362a06ff |\n","| Sponsored Products \"Stay Active\" promotion: Help your advertisers earn click credits when they keep their Sponsored Products campaign active for 30 days | Your eligible advertisers will be rewarded promotional click credits \\* if they keep their Sponsored Products campaign active for 30 days. Promote this offer to your eligible advertisers to help them earn click credits. Select Sellers invited by Amazon via email to participate in the Stay Active Click Credit Offer Promotion (\"Advertisers\"), and that complete the Qualifying Action (as defined in the applicable Promotion Terms and Conditions included within the promotion email invitation sent from Amazon to Advertisers (the \"T&Cs\")), shall receive a single promotional click amount (as described in the applicable T&Cs) to the Amazon sponsored ads account of the Advertiser, per eligible marketplace, which can be redeemed for sponsored ads, subject to the terms and restrictions of the T&Cs. Please find a list of the eligible Advertisers attached which includes information about the promotion including, without limitation, the respective offer amount of the Advertiser, promo start/end date, qualifying action, and other relevant information. A generic example of the promotion Terms and Conditions can be found here (link:https&#x3A;//advertising.amazon.com/legal/terms-conditions/terms-and-conditions-of-30-day-stay-active-promotion), eligible advertisers shall be subject to the T&Cs received directly from Amazon in the email invitation. | amzn1.ads-partner1.opportunity.c79466cd-1c70-4a54-b660-d4b9533df540 |\n"],"documentType":"guide"},{"title":"Partner opportunities catalog - Deals","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/catalog/deals","content":[" Actionable insights to optimize retail deal performance on the Amazon store. You can learn more about our deals recommendations in the Partner Opportunities user interface.\n","| Opportunity Title | Description | Opportunity ID |\n","\\| --- \\| --- \\| --- \\|\n","| Help audiences discover your deals | We are providing data for products with deals that may be likely to engage more customers, if advertised. Advertisers that listed products as deals in a Sponsored Products campaign observed an average of 17% increase in retail sales and 39% higher product page views, compared to similar products before the campaign. \\*Source: Amazon Internal Data January 2021 to May 2022: Comparing min. 2 and max. 4 weeks before and after advertisers listed products as deals in a Sponsored Products campaign. Disclaimer: Results do not reflect future performance; retail sales are impacted by a variety of factors and are not solely influenced by a single campaign. | amzn1.ads-partner1.opportunity.db5d6a29-3e7d-4ff5-b7d3-ddf55290d36d |\n","| Help advertisers promote their Deals | List of products with upcoming Deals for partners to increase discovery by creating Sponsored Products campaigns. We define \"upcoming Deals\" as occurring in the next 7-14 days. 56.95% \\*of Amazon shoppers surveyed spend time looking for the best deals \\* Source: GWI Q4 2022 WW Amazon shoppers surveyed (respondents: 90,303) | amzn1.ads-partner1.opportunity.d6dd174c-961a-43f5-9e17-2deb805892f1 |\n"],"documentType":"guide"},{"title":"Partner opportunities catalog - Unlaunched Asins","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/catalog/unlaunched-asins","content":[" These are recommendations and insights about your advertising clients' high-potential, unadvertised ASINs. As a partner, you can unlock these opportunities to identify unique signals to incorporate into your strategies and tools like launching new Sponsored Products campaigns, identify new ASIN targets, or leverage these opportunities as inputs into more complex offerings for advertisers you manage. You can learn more about our unlaunched ASINs recommendations in the Partner Opportunities user interface.\n","| Opportunity Title | Description | Opportunity ID |\n","\\| --- \\| --- \\| --- \\|\n","| Boost your client's sales with Sponsored Products\t|We reviewed your clients' catalogue and have identified which products are most likely to engage customers, if advertised. Suggested products are 46 times more likely to be clicked on if advertised, compared to a product that is not suggested (\\*Amazon internal data, US, 8/1/2022 - 08/26/2022)\t|amzn1.ads-partner1.opportunity.c3ffab5b-ed4d-45c3-b05e-c7e899f33c43\t|\n","| Help your advertisers drive traffic to their product detail pages\t|Clickthrough rate in the past 4 weeks for your advertisers' products is below that of similar products. (1) We recommend to create campaigns/update campaigns with ASINs shared. (1) Amazon Ads looks at the clickthrough rate of each product over a 4-week period, and compares it to the average clickthrough rate of similar products over the same period of time.\t|amzn1.ads-partner1.opportunity.11d095aa-02e7-4c10-9a42-7602f62243f9\t|\n","| Help your advertisers increase impressions\t|Impression growth rate for your advertisers' products is below that of similar products. We recommend to create campaigns/update campaigns with these ASINs. Amazon Ads looked at the impression change for a 4-week over 4-week period and compared it to the average impression change for similar products over the same period.\t|amzn1.ads-partner1.opportunity.33dd5367-23fd-4126-87e7-1beb895be903\t|\n","| Products that you can add on Sponsored Products\t|Your advertisers have unadvertised products that have a high likelihood of clicks from Sponsored Product campaigns. Suggested products are 16 times more likely to be clicked on if advertised, compared to a product that is not suggested.(Footnote: Amazon internal data, US, 06/22/2020 - 07/18/2020)\t|amzn1.ads-partner1.opportunity.37b43715-ce84-4700-b6f2-a56a18b764a8\t|\n","| Excess inventory\t|These products hold excess inventory units. These are products that currently have units that we estimate would be more costly to keep in stock due to storage fees. Advertising these products can help boost sales velocity and reduce excess inventory.\t|amzn1.ads-partner1.opportunity.71d6ac8a-a1c8-473e-bad4-50ad8eb36702\t|\n","| Help your advertisers' products stand out during periods of increased shopper interest.\t|Products in your advertisers' category have recently seen an increase in traffic() or have historically observed an increase in traffic in the upcoming 4 weeks (\\*\\*). We recommend to create campaigns/update campaigns with ASINs shared. () Amazon Ads identifies periods where detail page views for each category is higher than long-term average. (\\*\\*) Amazon Ads looks at product detail page views through a 3-year window to identify periods of increased shopper interest for each category.\t|amzn1.ads-partner1.opportunity.7969c069-0a62-4689-8dcf-62de7567a7fc\t|\n","| Build your brand by advertising these products\t|Shoppers who view or engage with this product are likely to purchase other products in your brand's catalog, visit your store and search for your brand. By advertising these products, you can increase shopper engagement with your brand and grow visibility and sales of the additional products in your catalog.\t|amzn1.ads-partner1.opportunity.bac55dbf-0f45-4844-b70d-5aa04bbb8f96\t|\n","| Help your advertisers increase unit sales\t|Sales growth rate for your advertisers' products is below that of similar products. We recommend to create campaigns/update campaigns with these ASINs. Amazon Ads looked at the unit sales change for a 4-week over 4-week period and compared it to the average sales change for similar products over the same period.\t|amzn1.ads-partner1.opportunity.d34f605a-ffef-42dc-a99b-3b3ad64208e6\t|\n","| Optimize your advertisers' campaigns by adding similar products into Sponsored Products campaigns\t|We use natural language ML models to identify similar products based on the information a shopper can view about your advertisers' products and how they search for these products. When advertising more than one product per ad group in a Sponsored Products campaign, consider including products that are similar to each other. We recommend to create campaigns/update campaigns with these ASINs. Ad Groups containing similar products saw 6% more units sold on average when advertising with Sponsored Products, compared to those with less similar products. Amazon internal data, Jan 22, 2023-Mar 4, 2023.\t|amzn1.ads-partner1.opportunity.f933b3f1-853a-4bf1-8b40-43bca5b6f433\t|\n","| Help your advertisers improve conversion and increase sales\t|Conversion rate in the past 4 weeks for your advertisers' products is below than that of similar products. () We recommend to create campaigns/update campaigns with ASINs shared. () Amazon Ads looks at the conversion rate of each product over a 4-week period, and compares it to the average conversion rate of similar products over the same period of time.\t|amzn1.ads-partner1.opportunity.ff40a0aa-c32a-4c02-b496-2c9576beb622\t|\n"],"documentType":"guide"},{"title":"Partner opportunities catalog - Advertiser Insights","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/catalog/advertiser-insights","content":[" Analyses about the advertisers you manage to refine and launch new strategies. You can learn more about our advertiser insights recommendations in the Partner Opportunities user interface.\n","| Opportunity Title | Description | Opportunity ID |\n","\\| --- \\| --- \\| --- \\|\n","| Help advertisers likely to launch Sponsored Display campaigns\t|Advertisers you manage are likely to launch their first Sponsored Display campaigns in the next 28 days. Our models suggest these advertisers are promising candidates to begin using Sponsored Display.\t|amzn1.ads-partner1.opportunity.08a6486a-216b-46b9-9e8e-f52d3d8fece5\t|\n","| Launch Sponsored Brands campaigns for new advertisers\t|Advertisers you manage are likely to launch their first Sponsored Brands campaigns in the next 28 days. Our models suggest these advertisers are promising candidates to begin using Sponsored Brands.\t|amzn1.ads-partner1.opportunity.2dc77457-4530-436a-927f-1d2ce8c8df39\t|\n","| Identify lapsed Sponsored Display advertisers likely to reactivate campaigns\t|Advertisers you manage have stopped using Sponsored Display but are likely to reactivate campaigns in the next 28 days. Our models suggest these advertisers are promising candidates to start using Sponsored Display again.\t|amzn1.ads-partner1.opportunity.644a4c18-e0da-46fb-847f-17c160a1102d\t|\n","| Launch Sponsored Products campaigns for lapsed advertisers\t|Advertisers you manage have stopped using Sponsored Products but are likely to reactivate campaigns in the next 28 days. Our models suggest these advertisers are promising candidates to start using Sponsored Products again.\t|amzn1.ads-partner1.opportunity.970a979e-3bac-4d8b-b7b9-f0dc87222c51\t|\n","| Help advertisers reactivate Sponsored Brands campaigns\t|Advertisers you manage have stopped using Sponsored Brands but are likely to reactivate campaigns in the next 28 days. Our models suggest these advertisers are promising candidates to start using Sponsored Brands again.\t|amzn1.ads-partner1.opportunity.aac9ee57-eb53-42e5-a59e-9a44c65cf8ce\t|\n","| Discover advertisers likely to launch Sponsored Products campaigns\t|Advertisers you manage are likely to launch their first Sponsored Products campaigns in the next 28 days. Our models suggest these advertisers are promising candidates to begin using Sponsored Products.\t|amzn1.ads-partner1.opportunity.c4bf623d-1b17-4cf2-b3fd-1cfc78ac3f36\t|\n"],"documentType":"guide"},{"title":"Partner opportunities catalog - Path To Purchase Insights","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/catalog/path-to-purchase-insights","content":[" Customer journey analysis showing how shoppers interact with brands and products. You can learn more about our path-to-purchase insights recommendations in the Partner Opportunities user interface.\n","| Opportunity Title | Description | Opportunity ID |\n","\\| --- \\| --- \\| --- \\|\n","| Categories commonly compared\t|These brands are among the most often compared products in their category when shoppers are browsing. Better understand how shoppers engage with the products of your advertisers to adjust advertising strategies. Data is available per brand and category (browse node) combination and refreshed quarterly.\t|amzn1.ads-partner1.opportunity.1b1cac3b-30ff-4ef7-815f-13ad4246910d\t|\n","| Longer time spent on detail page\t|Shoppers browse the detail pages of these brands longer than other brands in the same category. Better understand how shoppers engage with the products of your advertisers to adjust advertising strategies. Data is available per brand and category (browse node) combination and refreshed quarterly.\t|amzn1.ads-partner1.opportunity.b24e528e-d8fc-4f32-af18-6a7c88c4d09e\t|\n","| Long consideration before purchase\t|Shoppers consider these brands for more than seven days before making a purchase. Better understand how shoppers engage with the products of your advertisers to adjust advertising strategies. Data is available per brand and category (browse node) combination and refreshed quarterly.\t|amzn1.ads-partner1.opportunity.8166baf1-fcc4-49db-b62d-fc64fd150b0d\t|\n","| Visits frequently include reviews\t|These brands are likely to have shoppers consider reviews as part of browsing. Better understand how shoppers engage with the products of your advertisers to adjust advertising strategies. Data is available per brand and category (browse node) combination and refreshed quarterly.\t|amzn1.ads-partner1.opportunity.71542c4a-4e29-408b-ac9f-c3a86b39965c\t|\n"],"documentType":"guide"},{"title":"Partner opportunities catalog - Share Of Voice Insights","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/catalog/share-of-voice-insights","content":[" Insights about percentage of impressions (or Share of voice, SOV) for each advertiser. You can learn more about our share of voice insights recommendations in the Partner Opportunities user interface.\n","| Opportunity Title | Description | Opportunity ID |\n","\\| --- \\| --- \\| --- \\|\n","| Spot brands losing visibility in Sponsored Products\t|Use this insight to proactively optimize campaigns and work to retain visibility for your brands seeing a decline in their share of voice for Sponsored Products. Share of voice is the percentage of impressions achieved for a brand and browse node as a result of any keyword compared to total Sponsored Products impressions for the same brand or similar brands.\t|amzn1.ads-partner1.opportunity.174fc332-f5ab-4450-97de-b43a6336fcf9\t|\n","| Act on brands gaining visibility in Sponsored Products ads\t|Use this insight to reinforce winning strategies and help drive strategic upsell opportunities for your brands with rising share of voice for Sponsored Products. Share of voice is the percentage of impressions achieved for a brand and browse node as a result of any keyword compared to total Sponsored Products impressions for the same brand or similar brands.\t|amzn1.ads-partner1.opportunity.23595828-a357-4e78-92f1-281f1bde1d3f\t|\n","| Act on brands gaining visibility in Sponsored Brands ads\t|Identifying brands with increasing Share of Voice last month can help you work to continue to use winning strategies for your brands seeing an increase in their share of voice. Share of voice is the percentage of impressions achieved for a brand and browse node as a result of any keyword compared to total Sponsored Brands impressions for the same brand or similar brands.\t|amzn1.ads-partner1.opportunity.9709af67-f151-46af-bcfa-2f59f3e714b6\t|\n","| Discover brands losing visibility in Sponsored Brands\t|This insight can help you find campaigns to optimize and retain visibility for your brands seeing a decline in their share of voice for Sponsored Brands. Share of voice is the percentage of impressions achieved for a brand and browse node as a result of any keyword compared to total Sponsored Brands impressions for the same brand or similar brands.\t|amzn1.ads-partner1.opportunity.f329fd44-3375-4ac2-8097-8246a1657ea0\t|\n"],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[" The Partner Opportunities API empowers Amazon Ads Partner Network members to receive automated, data-driven recommendations and insights for their linked advertisers. Partner Opportunities curates insights for all the campaigns partners manage within their entire book of business. With the Partner Opportunities API you can simplify your API call process, save time on managing advertising activities, and better support the campaigns of your clients. This guide will walk you through getting started, calling the Partner Opportunity API, and troubleshooting common issues. \n"," See the Partner Opportunities Getting Started guide for more information. \n"],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":2,"text":"Opportunity catalog"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[" The Partner Opportunities API and UI maintains an opportunity catalog. Partners can use these opportunities (such as unlaunched ASINs or available promotional click credits) to optimize and improve their advertising campaigns. Review our complete Opportunity Catalog to identify the Partner Opportunities call(s) best suit your needs.\n"],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":2,"text":"Call the Partner Opportunities API"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":3,"text":"Step 1: Review the opportunity catalog through list opportunities"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[" Get started with the Partner Opportunities API using our Postman collection. We provide the following resources to support you: video walkthrough, Postman guide, and Github repository.\n"," If you are new to the Amazon Ads API or prefer not to use Postman, complete the Amazon Ads API onboarding process first. Start by using the ListOpportunities operation to explore the Partner Opportunities API. \n"," Most opportunities update daily, while some are updated hourly. Before downloading a file, we recommend you verify that opportunities.dataMetadata.rowCount is greater than 0 to ensure matching data exists. If not, you may encounter a 404 Not Found Error.\n"," Example: locale=en_US\n"," For more information, see the technical specification for the partnerOpportunities resource. \n"," This example request uses v1 per the Accept header. The example response also represents v1. For information about other versions, see the technical specification.\n"],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":3,"text":"Step 2: Downloading results"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[" The data fields vary by opportunity type and are defined in the CSV schema of the response.\n"," HTTP/1.1 307 Temporary Redirect location: &lt;S3_DOWNLOAD_URL>\n"],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":2,"text":"Troubleshooting API errors"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":3,"text":"401 Unauthorized"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[" Verify all required headers are included in your API call. Ensure the user account associated with your LwA application matches the account used for access/refresh token generation. \n"," To authenticate: \n","Sign out of all Amazon accounts or use an incognito/private browser window 1. Sign in with the Amazon account associated with your LwA application. To learn more, review the Getting Started with the Partner Opportunities API guide. 1. Generate a new authorization access and tokens, if needed.\n"],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":3,"text":"403 Forbidden"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[" Verify the LwA user has Admin or Custom-Editor permissions in the Partner Network account. Confirm the Amazon-Advertising-API-Manager-Account header contains the correct Partner Network Account ID.\n"],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":3,"text":"404 Not Found"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[" A rowCount of 0 indicates no matching data, corresponding to grayed-out download links in the UI. Most opportunities refresh daily, with some as often as hourly. We recommend verifying from the GET /partnerOpportunities response that opportunities.dataMetadata.rowCount is greater than 0 for the opportunity IDs you are using. \n"," To troubleshoot:\n","Verify partnerOpportunityId is valid. 1. Check partnerOpportunityId in the opportunities list. 1. Use the dataUrl property for the correct identifier value.\n"],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":3,"text":"404 Unsupported Media Type"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[" Verify the Accept header contains a valid value. Review the API specifications Accept section for allowed values. \n"],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":2,"text":"Partner Opportunities and Marketing Stream"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":3,"text":"Integrating Marketing Stream with Partner Opportunities Apply API"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[" When you subscribe to the sponsored-ads-campaign-diagnostics-recommendations dataset, you will receive automatic push notifications containing recommendation IDs that can be used with the Partner Opportunities API to apply the recommendations. \n"," For example, if you receive a Stream notification suggesting a budget increase for a Sponsored Products campaign, you can apply this recommendation using the following process:\n","Use the recommendation_id from the Stream payload. 1. Submit it to the /partnerOpportunities/{partnerOpportunityId}/apply resource. 1. Apply up to 100 recommendation IDs in a single request.\n"," To submit a successful Partner Opportunities Apply API request, use these required attributes from your Amazon Marketing Stream datasets:\n","| PO attribute | Marketing Stream attribute |\n","\\|--------------\\|------------------------\\|\n","| advertiserType | Recommendation.advertiser_type |\n","| encryptedAdvertiserId | advertiserId |\n","| entityId | entityId |\n","| marketplace | Recommendation.marketplace_name |\n","| recommendationIds | recommendationIds |\n"],"documentType":"guide"},{"title":"How to use the Partner Opportunities API","sectionHeader":{"type":3,"text":"Example response"},"path":"/en-us/guides/recommendations/partner-opportunities/how-to","content":[],"documentType":"guide"},{"title":"Partner opportunities CSV data schema","sectionHeader":null,"path":"/en-us/guides/recommendations/partner-opportunities/csv-schema","content":[" The table below details the data fields for CSV files retrieved via the file resource in the partner opportunities API.\n"],"documentType":"guide"},{"title":"Partner opportunities CSV data schema","sectionHeader":{"type":2,"text":"Data fields"},"path":"/en-us/guides/recommendations/partner-opportunities/csv-schema","content":["|Name\t|Definition\t|Example\t|\n","|---\t|---\t|---\t|\n","|adId\t|Unique identifier for the ad.\t|A04135221GSW52LIGFIB6\t|\n","|adProductType\t|Amazon Ad product including Sponsored Products, Sponsored Brands, Sponsored Display.\t|SP, SponsoredProduct\t|\n","|advertiserName\t|The registered name of the advertiser\t|TEST ADVERTISER\t|\n","|advertiserType\t|The type of advertiser account (i.e. Seller, Vendor)\t|SELLER, VENDOR, SELLER_CENTRAL_ENTITY, BRAND\t|\n","|applyApiEndPoint\t|PO API endpoint which could be used to apply the recommendation with one API call.\t|https&#x3A;//advertising-api.amazon.com/partnerOpportunities/{partnerOpportunityId}/apply\t|\n","|asin\t|Amazon Standard Identification Number\t|B00NQ2JLXX\t|\n","|averageTimeInBudget\t|Average time campaign is within set budget (percentage) \t|0.8, 99.69\t|\n","|brand\t|Brand of the ASIN\t|TEST Brand\t|\n","|creditDistributionSla\t|x number of days after completing the qualifying action\t|14\t|\n","|clicks\t|Ad Clicks by customer\t|29\t|\n","|clickThroughRateRatioToAvg\t|4-week clickthrough rate for similar products / 4-week conversion rate for your product\t|1.42983\t|\n","|conversions\t|Number of sales from a given ad\t|3\t|\n","|conversionRate\t|Number of conversions / Number of clicks\t|0.285714286\t|\n","|conversionRateRatioToAvg\t|4-week conversion rate for similar products / 4-week conversion rate for your product\t|1.768709\t|\n","|count\t|inventory units\t|37\t|\n","|currentCampaignSettings\t|Object (JSON-encoded string) containing the settings currently used for your campaign\t|{\"ad_groups\":\\[{\"adgroup_id\":\"530905550061343\",\"target_type\":\"KEYWORD\",\"targets\":{\"bid\":0.42,\"text\":\"test\",\"match_type\":\"EXACT\",\"target_id\":\"459582665159323\",\"targeting\":\"test\"}}]}\t|\n","|dealEndDate\t|End date of the Deal for the product\t|2/12/25\t|\n","|dealStartDate\t|Beginning date of the Deal for the product\t|2/10/25\t|\n","|encryptedAdvertiserId\t|Advertiser ID\t|A236EC8B73O62X\t|\n","|encryptedCampaignId\t|Campaign ID\t|518770093932188, A09873083AWAMDOEN678X\t|\n","|encryptedAdGroupId\t|Ad Group ID\t|A0760865T3OJ0N2GNMGM\t|\n","|endDate\t|Campaign End Date \t|1737417600000000\t|\n","|entityId\t|Unique identifier for vendor advertisers\t|ENTITY1N2EM112O48MJ\t|\n","|expiryDate\t|Date after which this recommendation would expire\t|1738900043000000\t|\n","|explanation\t|Object (JSON-encoded string) containing the reasons this particular Opportunity instance was provided\t|{\"description\":\"Campaigns with high ROAS and high budget use, compared to similar campaigns. Apply these recommendations to optimize sales and keep your campaigns in budget.\",\"missed_opportunities\":{\"impressions\":{\"upper_bound\":\"120720\",\"lower_bound\":\"40225\"},\"clicks\":{\"upper_bound\":\"575\",\"lower_bound\":\"182\"},\"conversions\":{\"upper_bound\":\"2,230.00\",\"lower_bound\":\"730.00\"},\"time_period\":\"Last 7 days\"},\"recommendation_context\":{\"diagnostic_context\":{\"benchmark_context\":{\"roas\":{\"benchmark_value\":4.58,\"period\":7},\"impressions\":{\"benchmark_value\":12815.0,\"period\":7},\"ad_spend\":{\"benchmark_value\":32.41,\"period\":7},\"click_through_rate\":{\"benchmark_value\":0.78,\"period\":7},\"budget_utilization\":{\"benchmark_value\":72.57,\"period\":7}},\"diagnostic_date\":\"2025-01-01T00:00:00.000Z\"},\"grouping_context\":{\"grouping_type\":\"INCREASE_BUDGET_CONTEXTUAL\"}}}\t|\n","|impressionTrendSimilarProducts\t|The trend of impressions of similar ASINs: impressions of similar ASINs in the past 4 weeks divided by unit sales between 4 weeks and 8 weeks ago\t|0.992005\t|\n","|impressionTrendYourProduct\t|The trend of impressions for the asin: impressions of this ASIN in the past 4 weeks divided by unit sales between 4 weeks and 8 weeks ago\t|0.630435\t|\n","|marketplace\t|Represents the marketplace where Amazon is doing business (i.e. US, UK, etc.)\t|US\t|\n","|missedOpportunities_clicks_lowerBound\t|Lower bound of the estimated additional clicks, the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual clicks.\t|15\t|\n","|missedOpportunities_clicks_upperBound\t|Upper bound of the estimated additional clicks, the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual clicks.\t|45\t|\n","|missedOpportunities_impressions_lowerBound\t|Lower bound of the estimated additional impressions, the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual impressions.\t|2198\t|\n","|missedOpportunities_impressions_upperBound\t|Upper bound of the estimated additional impressions, the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual impressions.\t|6594\t|\n","|missedOpportunities_sales_lowerBound\t|Lower bound of the estimated additional sales, the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual sales.\t|8.08, 371\t|\n","|missedOpportunities_sales_upperBound\t|Upper bound of the estimated additional sales, the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual sales.\t|24.24, 1113\t|\n","|missedOpportunities_viewableImpressions_lowerBound\t|Lower bound of the estimated number of times the ad was considered viewable, the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual impressions.\t|760\t|\n","|missedOpportunities_viewableImpressions_upperBound\t|Upper bound of the estimated number of times the ad was considered viewable, the campaign might have generated had it adopted the recommended budget. These are estimates based on previous website traffic and historical campaign performance, not a guarantee of actual impressions.\t|2280\t|\n","|productName\t|Name of Product\t|TEST Men's Dress Shirt, Red, 17\"-17.5\" Neck 34\"-35\" Sleeve\t|\n","|profileId\t|Profiles in the Amazon Ads API represent an advertiser's account in a specific marketplace. Profiles play a crucial role in the Amazon Ads API by determining the management scope for a given call.\t|3228655307457599\t|\n","|promotionAmountCurrency\t|currency code the offer will be awarded in, like USD\t|EUR\t|\n","|promotionAmountLc\t|amount that eligible advertiser will earn\t|250\t|\n","|promotionEndDate\t|date the promotion will end and eligible advertisers cannot have a promotion action after this date to earn click credit offer\t|1736899200000000\t|\n","|promotionId\t|Unique promotion identifier\t|V1252008460\t|\n","|promotionStartDate\t|date the promotion will start and eligible advertisers must have a promotion action no earlier than this date to earn click credit offer\t|1734307200000000\t|\n","|promotionType\t|Type of promotion (i.e. ACQ, REACT, ONB, etc.)\t|REACT\t|\n","|publishedDate\t|Date when the recommendation was published\t|1737826802, 1970-01-01T00:28:57.668088Z\t|\n","|purchasesTrendYourProduct\t|The trend of purchases of the asin: unit sales of this ASIN in the past 4 weeks divided by unit sales between 4 weeks and 8 weeks ago.\t|0.428571|\n","|purchasesTrendSimilarProducts\t|The trend of purchases of similar ASINs: unit sales of similar ASINs in the past 4 weeks divided by unit sales between 4 weeks and 8 weeks ago.\t|0.525625\t|\n","|recommendedBudget\t|Recommended campaign budget setting \t|350, 483.37 |\n","|recommendationGroupId\t|Unique identifier for the recommendation group\t|f861ebe7-8e1a-43e5-a9ca-edab8dc9f082\t|\n","|recommendationId\t|Unique identifier for the recommendation\t|3cee8afe-bc21-4956-a46b-2bbd9b1556d4\t|\n","|recommendationType\t|Type of recommendation\t|CAMPAIGN_BUDGET\t|\n","|recommendedCampaignSettings\t|Object (JSON-encoded string) containing the recommended settings for your campaign.\t|{\"a_groups\":\\[{\"adgrou_id\":\"530905550061343\",\"targe_type\":\"KEYWORD\",\"targets\":{\"bid\":0.82,\"text\":\"test\",\"matc_type\":\"EXACT\",\"targe_id\":\"459582665159323\",\"targeting\":\"test\"}}]}\t|\n","|returnOnAdSpend\t|Also called ROAS; Sales / Ad Spend\t|13.40207685\t|\n","|similarProducts\t|An array of similar ASINs to the asin field\t|B0CWVD1FQS, B08XXFB9AT, B08XXG59V7\t|\n","|startDate\t|Campaign Start Date \t|1736899200000000\t|\n","|target\t|The identifier referred to by this recommendation (if applicable). Type (ASIN, etc.) determined by targetingType.\t|B0PD34WL1T\t|\n","|targetingType\t|The type of identifier provided in target. Could be ASIN, Keyword, etc. Each Opportunity doc should list what the valid types are.\t|ASIN\t|\n"],"documentType":"guide"},{"title":"Partner opportunities CSV data schema","sectionHeader":{"type":2,"text":"Examples "},"path":"/en-us/guides/recommendations/partner-opportunities/csv-schema","content":[],"documentType":"guide"},{"title":"Partner opportunities CSV data schema","sectionHeader":{"type":3,"text":"Explaining `percent_of_peers`, `peer_kpi`, `peer_kpi_difference_percent` for Sponsored Display - Sales opportunity"},"path":"/en-us/guides/recommendations/partner-opportunities/csv-schema","content":[" Brand: TestBrandBrowse node: Gifts & Stationery\n"," 30% of the peers of TestBrand in Gifts & Stationery used Sponsored Display. On average they had 71% higher total sales.\n"],"documentType":"guide"},{"title":"Recommendations API overview","sectionHeader":null,"path":"/en-us/guides/recommendations/recommendations-api/overview","content":[" The Recommendations API provides a single interface for retrieving recommendations across Amazon advertiser campaigns. Developers can query for a list of recommendations with flexible filtering options to help guide campaign optimization decisions.\n"],"documentType":"guide"},{"title":"Recommendations API overview","sectionHeader":{"type":2,"text":"What is the Recommendations API?"},"path":"/en-us/guides/recommendations/recommendations-api/overview","content":[" The Recommendations API is a consolidated interface that returns actionable recommendations conforming to a single, standardized model. Regardless of which ad product a recommendation relates to, consumers learn the contract once and reuse it everywhere.\n"," The API introduces two complementary endpoints that support both simple filtered queries and complex discovery scenarios where systems can evaluate multiple recommendation types and surface the most relevant guidance based on advertiser goals.\n"," Each recommendation includes a unique identifier for tracking, a recommended action, and insights related to why the customer is receiving the recommendation. The API is designed to simplify integration by eliminating the need to work with separate product-specific APIs.\n"],"documentType":"guide"},{"title":"Recommendations API overview","sectionHeader":{"type":2,"text":"Why is it important?"},"path":"/en-us/guides/recommendations/recommendations-api/overview","content":[" The Recommendations API reduces the number of integrations developers need to build and maintain. Instead of connecting to multiple product-specific recommendation endpoints, each with its own contract, developers integrate once and receive recommendations across all supported ad products.\n"," Key benefits for developers:\n","Access to many recommendation types through a single endpoint: One API surface provides recommendations across bid adjustments, keyword suggestions, budget changes, campaign extensions, and more, without calling separate services for each type.  Fewer integrations to maintain: A single API contract replaces multiple product-specific endpoints, reducing development and maintenance effort.  Reduced time-to-market: New recommendation types become available through the same interface without additional integration work. \\* Single contract to learn: One response model applies to all recommendation types, so knowledge transfers across ad products without relearning a new schema.\n"],"documentType":"guide"},{"title":"Recommendations API overview","sectionHeader":{"type":2,"text":"Supported recommendation types"},"path":"/en-us/guides/recommendations/recommendations-api/overview","content":[" See Recommendation types for the full list of available recommendation types, including their supported operations, type-specific request inputs, and response data. That page is updated as new recommendation types launch. Additional recommendation types are added over time and become available through the same endpoints without additional integration work. Design your application to tolerate recommendationType values it does not recognize, for example by ignoring them or rendering a generic display, so new types do not break your existing integration.\n"],"documentType":"guide"},{"title":"Recommendations API overview","sectionHeader":{"type":2,"text":"API endpoints"},"path":"/en-us/guides/recommendations/recommendations-api/overview","content":[" The Recommendations API provides two complementary endpoints for retrieving recommendations:\n"],"documentType":"guide"},{"title":"Recommendations API overview","sectionHeader":{"type":3,"text":"`GET /adsApi/v1/list/recommendations?{filters}`"},"path":"/en-us/guides/recommendations/recommendations-api/overview","content":[" Returns a list of pre-computed recommendations filtered by query parameters including language, adProduct, recommendationType and maxResults. This endpoint is optimized for low-latency, high-volume retrieval when the intent of the caller is well-defined, such as populating a recommendations widget or fetching all active recommendations for a campaign.\n"," The response includes recommendation entities, each with a unique identifier. This operation returns only recommendation types that do not require type-specific input fields.\n"],"documentType":"guide"},{"title":"Recommendations API overview","sectionHeader":{"type":3,"text":"`POST /adsApi/v1/query/recommendations`"},"path":"/en-us/guides/recommendations/recommendations-api/overview","content":[" Returns a list of recommendations matching a structured query specification submitted in the request body. The query spec supports:\n","Required accessRequestedAccounts and marketplacesFilter to identify the account and its marketplace  Universal filters (languageFilter, adProductFilter)  Optional recommendationTypeFilter to narrow results  Optional recommendationTypeDetailsFilter for type-specific scoping  Optional maxResults to reduce payload size\n"," This endpoint operates in two modes:\n"," Discovery mode (no recommendationTypeFilter specified): Returns recommendations across all recommendation types currently eligible for your account, based on the universal filters you provide. This is the primary interface for automated systems that evaluate multiple recommendation types and surface the most relevant guidance.\n"," Scoped mode (with recommendationTypeFilter and optional recommendationTypeDetailsFilter): Narrows results to the specific recommendation types you request. This mode is required for recommendation types that need additional inputs, such as branded keyword recommendations, bid recommendations, or cross-format extension recommendations.\n"," Both operations return the same response shape: recommendation entities with universal fields (recommendationType, recommendationInsight, recommendedObjects, state) on every recommendation, and type-specific data within each RecommendedObject.\n"],"documentType":"guide"},{"title":"Recommendations API overview","sectionHeader":{"type":2,"text":"Use cases"},"path":"/en-us/guides/recommendations/recommendations-api/overview","content":["| Scenario | Endpoint | Mode |\n","\\| --- \\| --- \\| --- \\|\n","| Displaying recommendations in a dashboard or UI | GET /adsApi/v1/list/recommendations or POST (scoped mode) | Scoped |\n","| Building an automated system that evaluates and acts on recommendations programmatically | POST /adsApi/v1/query/recommendations (discovery mode) | Discovery |\n","| Retrieving recommendations that require type-specific inputs (for example, bid or keyword recommendations) | POST /adsApi/v1/query/recommendations (scoped mode) | Scoped |\n"],"documentType":"guide"},{"title":"Recommendations API overview","sectionHeader":{"type":2,"text":"Availability"},"path":"/en-us/guides/recommendations/recommendations-api/overview","content":[" Launch date: August 2026\n"," Locales: Worldwide\n"," Access: Available to all registered Amazon Ads API developers\n"],"documentType":"guide"},{"title":"Recommendations API overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/recommendations/recommendations-api/overview","content":[],"documentType":"guide"},{"title":"How to call the API","sectionHeader":null,"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[" This guide walks you through authentication, required headers, account identification, request construction, and error handling for the Recommendations API.\n"],"documentType":"guide"},{"title":"How to call the API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[" Before calling the Recommendations API, complete the following:\n","Register a Login with Amazon (LwA) application. Follow the API onboarding guide to create your application and obtain a client ID and client secret. 2. Obtain an access token. Use the authorization code grant flow to retrieve an access token. See Retrieve access token for details. 3. Identify your account. What you need depends on the endpoint:\n"," See Understanding advertising accounts for how to retrieve these identifiers.\n"],"documentType":"guide"},{"title":"How to call the API","sectionHeader":{"type":2,"text":"Authentication"},"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[" Requests to the Recommendations API must be authenticated through the Amazon Ads API. Include standard authorization headers as described in the Amazon Ads API authentication guide.\n"],"documentType":"guide"},{"title":"How to call the API","sectionHeader":{"type":2,"text":"Required headers"},"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[" Which headers you send depends on the endpoint:\n","| Header | Required | Description |\n","\\| --- \\| --- \\| --- \\|\n","| Authorization | Yes, both endpoints | Your access token in the format Bearer &lt;access token>. See Retrieve access token. |\n","| Amazon-Ads-ClientId | Yes, both endpoints | Your LwA application client ID. |\n","| Content-Type | Yes, QueryRecommendation | Must be application/json. Not required for ListRecommendation, which sends no request body. |\n","| Amazon-Ads-AccountId | Yes, ListRecommendation | The account to retrieve recommendations for, as either a global account ID or an Amazon DSP account ID. QueryRecommendation identifies the account in the request body instead. See Identifying the account. |\n"],"documentType":"guide"},{"title":"How to call the API","sectionHeader":{"type":3,"text":"Identifying the account"},"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[" How you identify the account depends on the endpoint:\n","QueryRecommendation (POST) takes the account and its marketplace in the accessRequestedAccounts and marketplacesFilter request body fields. \\* ListRecommendation (GET) takes the account in a request header.\n","Exactly one entry. An empty list, or a list with more than one entry, is rejected.  The entry must use the advertiserAccountId key. Other account identifiers are not accepted on this endpoint.  The value must be either a global account ID, which begins with amzn1.ads-account.g., or an Amazon DSP account ID.\n"," A request that omits the Amazon-Ads-AccountId header is rejected at the gateway before reaching the service and returns 401 Unauthorized.\n"],"documentType":"guide"},{"title":"How to call the API","sectionHeader":{"type":2,"text":"Operations"},"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[],"documentType":"guide"},{"title":"How to call the API","sectionHeader":{"type":3,"text":"`QueryRecommendation (POST)`"},"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[" Fetches recommendations for a specific set of recommendation types. Supports per-type detail payloads for variant filtering.\n"," Endpoint: POST /adsApi/v1/query/recommendations\n","| Field | Type | Required | Description |\n","\\| --- \\| --- \\| --- \\| --- \\|\n","| accessRequestedAccounts | object\\[] | Yes | The account to retrieve recommendations for. Exactly one entry, using advertiserAccountId with either a global account ID or an Amazon DSP account ID. See Identifying the account. |\n","| marketplacesFilter.include | string\\[] | Yes | The marketplace for the account in accessRequestedAccounts, for example US. Sent together with accessRequestedAccounts. |\n","| languageFilter.include | string\\[] | No | BCP-47 language tags to filter recommendations by. Omit to receive all languages. |\n","| adProductFilter.include | string\\[] | No | Ad product values to filter by (for example, SPONSORED_PRODUCTS, SPONSORED_BRANDS). Omit to receive all ad products. |\n","| recommendationTypeFilter.include | string\\[] | No | Recommendation type IDs to fetch. Omit for discovery mode (all eligible types returned). |\n","| recommendationTypeDetailsFilter.include | object\\[] | No | Per-type detail payloads keyed by the detail variant key for each recommendation type (see below). Only valid when recommendationTypeFilter.include is also set; detail payloads provided without a type filter are ignored. |\n","| maxResults | integer | No | Maximum recommendations to return. Default: 300. Maximum: 300. Must be a positive integer. Set a lower value to reduce response payload size when you only need a subset of results. |\n"," Some recommendation types require additional inputs, supplied through recommendationTypeDetailsFilter. Each entry in recommendationTypeDetailsFilter.include is keyed by the detail variant key for the recommendation type.\n"," See Recommendation types for the detail variant key and fields for each recommendation type. Requesting a type that requires a detail payload without providing one returns 400 BadRequest with the error code MISSING_REQUIRED_RECOMMENDATION_TYPE_DETAILS.\n","Discovery mode (no recommendationTypeFilter specified): Returns recommendations across all recommendation types currently eligible for your account, based on the filters you provide. Recommendation types that require a detail payload are excluded in this mode. Use discovery mode when you want to evaluate all available recommendation types. \\* Scoped mode (with recommendationTypeFilter and optional recommendationTypeDetailsFilter): Returns recommendations for the specific types you request. Required for recommendation types that need additional inputs (see the detail variants table above).\n","| Field | Type | Description |\n","\\| --- \\| --- \\| --- \\|\n","| recommendationId | string | Unique identifier for the recommendation. |\n","| recommendationType | string | The type of recommendation. See Recommendation types for current values. |\n","| recommendationTypeDetails | object | Type-specific parameters for this recommendation (present when applicable). |\n","| recommendationInsight | object | Contextual information explaining why this recommendation is relevant, as key-value pairs. |\n","| recommendationInsight.insightTexts | object\\[] | Array of key-value pairs. Common keys: overview, tagline, description, legalDisclosure, disclaimer, comparison. |\n","| language | string | BCP-47 language tag for the recommendation (for example, en-US). |\n","| state | string | Current state of the recommendation. Valid values: ACTIVE, INACTIVE, EXPIRED, APPLIED, DEFERRED, DISMISSED. |\n","| advertiserAccount | object | The advertiser account receiving the recommendation. |\n","| advertiserAccount.advertiserAccountId | string | Unique identifier for the advertiser account. |\n","| advertiserAccount.displayName | string | Display name for the advertiser account. |\n","| marketplaces | string\\[] | Marketplaces where the recommendation is exposed (0-30 values). |\n","| adProduct | string | The ad product associated with the recommendation. Valid values: SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_DISPLAY, SPONSORED_TELEVISION, AMAZON_DSP, FULL_FUNNEL. |\n","| potentialImpacts | object\\[] | Estimated benefits if the recommendation is followed (0-100 entries). |\n","| publishedDateTime | string | ISO 8601 datetime when the recommendation was published. |\n","| createdDateTime | string | ISO 8601 datetime when the recommendation was created. |\n","| expiryDateTime | string | ISO 8601 datetime when the recommendation expires (optional). |\n","| deferredUntilDateTime | string | ISO 8601 datetime when a snoozed recommendation will be displayed again (optional). |\n","| recommendedObjects | object\\[] | The target objects of the recommendation (1-1000 entries). |\n","| recommendedObjects\\[].recommendedObjectId | string | Identifier of the target object (for example, campaign ID). |\n","| recommendedObjects\\[].recommendedObjectType | string | Type of the target object. Valid values: CAMPAIGN, ADGROUP, AD, TARGET, BRANDED_KEYWORD, UNBRANDED_KEYWORD, ASIN, OBJECTIVE, BRAND_PRODUCT_SEGMENT, BRAND_PRODUCT_KEYWORD. |\n","| recommendedObjects\\[].displayName | string | Name of the recommended object (optional). |\n","| recommendedObjects\\[].description | string | Short contextual information about the recommended object (optional). |\n","| recommendedObjects\\[].currentObjectSettings | object | Current state of the object at the time the recommendation was published (optional). |\n","| recommendedObjects\\[].recommendedObjectSettings | object | Suggested state for the object. Type-specific data varies by recommendationType (optional). |\n","| recommendedObjects\\[].recommendedAction | object | Suggested action for the customer to apply the recommendation (optional). |\n","| recommendedObjects\\[].recommendedAction.linkText | string | Call-to-action text. |\n","| recommendedObjects\\[].recommendedAction.method | string | HTTP method to use with the URL. Valid values: GET, POST, PATCH, DELETE. |\n","| recommendedObjects\\[].recommendedAction.href | string | URL endpoint where the action can be applied (max 1024 characters). |\n","| recommendedObjects\\[].potentialImpacts | object\\[] | Estimated impact on the recommended object (0-10 entries). |\n","| tags | object\\[] | Open-ended key-value labels applied to the recommendation (0-50 entries). |\n","\n"],"documentType":"guide"},{"title":"How to call the API","sectionHeader":{"type":3,"text":"`ListRecommendation (GET)`"},"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[" Returns available recommendations using query parameters for filtering. Useful for lightweight retrieval or polling.\n"," Endpoint: GET /adsApi/v1/list/recommendations\n","| Parameter | Type | Required | Description |\n","\\| --- \\| --- \\| --- \\| --- \\|\n","| maxResults | integer | No | Maximum recommendations to return. Default: 300. Maximum: 300. Set a lower value to reduce response payload size when you only need a subset of results. |\n","| language | string | No | BCP-47 language tag to filter by (0-1 values accepted). |\n","| adProduct | string | No | Ad product filter (single value). |\n","| recommendationType | string | No | Recommendation type ID (single value). |\n"],"documentType":"guide"},{"title":"How to call the API","sectionHeader":{"type":2,"text":"Request validation"},"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[" Requests are validated before dispatch. All validation errors return 400 BadRequest and fail fast (validation stops at the first error).\n","| Error code | Cause |\n","\\| --- \\| --- \\|\n","| INVALID_LANGUAGE | A value in languageFilter.include is not a recognized BCP-47 language tag. |\n","| INVALID_AD_PRODUCT | The adProduct value is not in the supported set. |\n","| INVALID_MARKETPLACE | The marketplace associated with the request is not recognized. Verify the account ID provided in Amazon-Ads-AccountId (ListRecommendation), or marketplacesFilter and accessRequestedAccounts (QueryRecommendation). |\n","| INVALID_MAX_RESULTS | maxResults is outside the allowed range (must be a positive integer). |\n","| INVALID_RECOMMENDATION_TYPE | A value in recommendationTypeFilter.include is not a recognized recommendation type. |\n","| MISSING_REQUIRED_RECOMMENDATION_TYPE_DETAILS | The requested type requires a detail payload but none was provided in recommendationTypeDetailsFilter. |\n"],"documentType":"guide"},{"title":"How to call the API","sectionHeader":{"type":2,"text":"Error responses"},"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[" All errors use the standard error envelope:\n","| HTTP status | Error type | Meaning | Recommended action |\n","\\| --- \\| --- \\| --- \\| --- \\|\n","| 400 | BadRequest | The request is invalid. | Check the code field against the validation error codes above. |\n","| 401 | Unauthorized | Authentication failed or credentials are missing/expired. | Refresh your access token and retry. |\n","| 403 | Forbidden | The caller does not have permission for the requested operation or recommendation type. | Verify the account provided in Amazon-Ads-AccountId (ListRecommendation) or accessRequestedAccounts (QueryRecommendation) and the account permissions. |\n","| 429 | TooManyRequests | Rate limit exceeded. | Wait and retry with exponential backoff. Respect the Retry-After header if present. |\n","| 500 | InternalServerError | Unexpected service failure. | Retry with exponential backoff. |\n","| 502 | BadGateway | Downstream service error. | Retry after a short delay. |\n","| 503 | ServiceUnavailableError | Service is temporarily unavailable. | Retry after a delay. |\n","| 504 | GatewayTimeout | Downstream call timed out. | Retry after a short delay. |\n"," Empty results vs. errors: If all recommendation types are excluded by eligibility rules (for example, the caller permissions do not match any registered type), the service returns 200 with an empty recommendations array, not an error. This is expected behavior in discovery mode when no types currently match your context. In rare cases, some recommendations may be temporarily unavailable. If an empty result is unexpected, retry the request after a short delay.\n"],"documentType":"guide"},{"title":"How to call the API","sectionHeader":{"type":2,"text":"Rate limits"},"path":"/en-us/guides/recommendations/recommendations-api/how-to","content":[" Rate limits are applied per advertising account across both endpoints: 5 requests per second, with a burst allowance of 10 requests.\n"],"documentType":"guide"},{"title":"Recommendation types","sectionHeader":null,"path":"/en-us/guides/recommendations/recommendations-api/recommendation-types","content":[" This page is the reference for the recommendation types available through the Recommendations API. For each type, it documents the operations that return it, the type-specific request inputs (detail variants), and the type-specific data returned in the response. This page is updated as new recommendation types launch.\n"],"documentType":"guide"},{"title":"Recommendation types","sectionHeader":{"type":2,"text":"Available recommendation types"},"path":"/en-us/guides/recommendations/recommendations-api/recommendation-types","content":["| Recommendation type | Description | Ad products | Supported operations | Detail payload required |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| REMOTE_CAMPAIGN_PAUSED | Indicates that a campaign has been paused by the system rather than by the advertiser | Sponsored Products | GET /adsApi/v1/list/recommendations, POST /adsApi/v1/query/recommendations | No |\n","| AUTOMATIC_GLOBAL_ADS_ENROLLMENT | Surfaces an advertiser's automatic global ads enrollment status and trial performance | Amazon DSP, Full Funnel, Sponsored Display, Sponsored Television, Sponsored Products, Sponsored Brands | GET /adsApi/v1/list/recommendations, POST /adsApi/v1/query/recommendations | No |\n","| BRAND_PRODUCT_SEGMENT | Recommends product groups within a brand that shoppers search for as a distinct need | Sponsored Brands | POST /adsApi/v1/query/recommendations (scoped mode) | Yes |\n","| BRAND_PRODUCT_KEYWORD | Recommends keywords and bids for brand product segments | Sponsored Brands | POST /adsApi/v1/query/recommendations (scoped mode) | Yes |\n"],"documentType":"guide"},{"title":"Recommendation types","sectionHeader":{"type":2,"text":"How detail variants work"},"path":"/en-us/guides/recommendations/recommendations-api/recommendation-types","content":[" Some recommendation types require additional inputs, supplied through recommendationTypeDetailsFilter on POST /adsApi/v1/query/recommendations. Each entry in recommendationTypeDetailsFilter.include is keyed by the detail variant key for the recommendation type, listed in the table above and in each type section below along with its fields. The example filter entries in each section show the exact request shape.\n"," Keep in mind:\n","A detail payload is only honored when the matching type is also present in recommendationTypeFilter.include. Detail payloads provided without a type filter are ignored.  Requesting a type that requires a detail payload without providing one returns 400 BadRequest with the error code MISSING_REQUIRED_RECOMMENDATION_TYPE_DETAILS.  recommendationTypeDetailsFilter is not supported on GET /adsApi/v1/list/recommendations. Types that require a detail payload are only available through POST /adsApi/v1/query/recommendations.\n"],"documentType":"guide"},{"title":"Recommendation types","sectionHeader":{"type":2,"text":"`REMOTE_CAMPAIGN_PAUSED`"},"path":"/en-us/guides/recommendations/recommendations-api/recommendation-types","content":[" Notifies the advertiser that a campaign has been paused by the system rather than by the advertiser, for example in a remote marketplace, so they can reactivate it to regain impressions and sales. A remote marketplace is a marketplace other than the one where the campaign was originally created.\n"," Ad products: Sponsored Products\n"," Request details: None. This type does not accept a detail payload.\n"," Type-specific response data: None.\n"],"documentType":"guide"},{"title":"Recommendation types","sectionHeader":{"type":2,"text":"`AUTOMATIC_GLOBAL_ADS_ENROLLMENT`"},"path":"/en-us/guides/recommendations/recommendations-api/recommendation-types","content":[" Surfaces the advertiser account enrollment status and trial performance for automatic global ads, so the advertiser can decide whether to enroll.\n"," Ad products: Amazon DSP, Full Funnel, Sponsored Display, Sponsored Television, Sponsored Products, Sponsored Brands\n"," Request details: None. This type does not accept a detail payload.\n"," Type-specific response data: Returned in recommendedObjects\\[].recommendedObjectSettings.automaticGlobalAdsEnrollmentSettings:\n","| Field | Type | Description |\n","\\| --- \\| --- \\| --- \\|\n","| enrollmentStatus | string | Current enrollment status. Valid values: ELIGIBLE_FOR_FREE_TRIAL_ENROLLMENT, FREE_TRIAL_STARTED, FREE_TRIAL_EXPIRING, FREE_TRIAL_ENDED, ELIGIBLE_FOR_ENROLLMENT. |\n","| daysRemainingToEnrollInFreeTrial | integer | Days remaining to enroll in the free trial. Absent or 0 when the account is not eligible for free trial enrollment. |\n","| daysLeftInFreeTrial | integer | Days remaining in the trial. Absent or 0 when the trial has ended. |\n","| trialMetrics | object\\[] | Performance metrics observed during the trial, one entry per metric (0-50 entries). |\n","| trialMetrics\\[].metricName | string | The metric this entry reports (for example, ROAS or CTR). |\n","| trialMetrics\\[].metricDescription | string | Text describing the metric, suitable for rendering as a tooltip (optional). |\n","| trialMetrics\\[].value | decimal | The observed value of the metric during the trial. |\n","| trialMetrics\\[].changePercent | decimal | Magnitude of change compared to the baseline, as a percentage (optional). |\n"],"documentType":"guide"},{"title":"Recommendation types","sectionHeader":{"type":2,"text":"`BRAND_PRODUCT_SEGMENT`"},"path":"/en-us/guides/recommendations/recommendations-api/recommendation-types","content":[" Recommends product groups within a brand that shoppers search for as a distinct need. Use these segments to organize Sponsored Brands campaigns around how shoppers actually search.\n"," Ad products: Sponsored Brands\n"," Detail variant key: brandProductSegmentRecommendationTypeDetails (required)\n","| Field | Type | Required | Description |\n","\\| --- \\| --- \\| --- \\| --- \\|\n","| brandId | string | No | The brand identifier to scope segment recommendations. |\n","| brandName | string | No | The brand name to scope segment recommendations. |\n"," Example filter entry:\n"," Type-specific response data: Returned in recommendedObjects\\[].recommendedObjectSettings.brandProductSegmentSettings:\n","| Field | Type | Description |\n","\\| --- \\| --- \\| --- \\|\n","| brandProductSegmentId | string | The identifier of the brand product segment. |\n","| rationale | string | The reason this segment is recommended (optional). |\n","| productCount | integer | The number of products in this segment for the brand. |\n","| previewProductIds | string\\[] | Product identifiers (ASINs) for previewing this segment (0-50 entries). |\n","| isTopPick | boolean | Whether this segment is a featured recommendation (optional). |\n"],"documentType":"guide"},{"title":"Recommendation types","sectionHeader":{"type":2,"text":"`BRAND_PRODUCT_KEYWORD`"},"path":"/en-us/guides/recommendations/recommendations-api/recommendation-types","content":[" Recommends keywords and bids for brand product segments, so the advertiser can target the search terms shoppers use for each segment.\n"," Ad products: Sponsored Brands\n"," Detail variant key: brandProductKeywordRecommendationTypeDetails (required)\n","| Field | Type | Required | Description |\n","\\| --- \\| --- \\| --- \\| --- \\|\n","| brandId | string | No | The brand identifier to scope keyword recommendations. |\n","| brandName | string | No | The brand name to scope keyword recommendations. |\n","| inclusions | object | No | Inclusion criteria for the keyword recommendations. When specified, only matching products are considered. |\n"," Example filter entry:\n"," Type-specific response data: Returned in recommendedObjects\\[].recommendedObjectSettings.brandProductKeywordSettings:\n","| Field | Type | Description |\n","\\| --- \\| --- \\| --- \\|\n","| keywordTarget | object | The recommended keyword and match type. |\n","| recommendedBid | object | The recommended bid range for this keyword. Contains a suggested amount, with optional lower and upper bounds. |\n","| keywordTheme | string | The theme classification of the keyword, for example Generic, Branded, or Seasonal (optional). |\n","| metrics | object | Insight metrics for the recommended keyword (optional). |\n"],"documentType":"guide"},{"title":"Amazon Attribution API overview","sectionHeader":null,"path":"/en-us/guides/amazon-attribution/overview","content":[" Amazon Attribution is a measurement product that enables advertisers to understand the impact of their non-Amazon marketing strategies on driving Amazon shopping activity. Advertising is measured by including attribution tags on non-Amazon media across paid and organic channels including search, social, display, video, email, third-party affiliate marketing, and more.\n"," The Amazon Attribution API enables integrators to easily set up Amazon Attribution tags which can be used to measure media that links to an Amazon store or product detail page. The API also enables programmatic reporting on clicks and click-attributed conversion metrics so users can understand the performance and impact of their tagged media.\n"],"documentType":"guide"},{"title":"Amazon Attribution API overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-attribution/overview","content":[" Learn more about Amazon Attribution by visiting the product page and support center.\n"],"documentType":"guide"},{"title":"Get started with the Amazon Attribution API","sectionHeader":null,"path":"/en-us/guides/amazon-attribution/get-started","content":[" To get started with the Amazon Attribution API, you must first:\n","Set up your Advertising API developer account. 2. Obtain authorization or access for an eligible advertiser's Amazon Ads account. \n"," Here are three ways to obtain permission:\n","Recommended approach: You create an OAuth Login With Amazon application and the advertiser uses it to grant you access to their profile.  Advertiser invites you to their ad console account via the email address associated with your API developer account.  Advertiser invites you to a manager account linked to their ad console account via the email address associated with your API developer account.\n"," Once you have completed the above requirements, you can use the Amazon Attribution API to read the following resources associated with your advertiser:\n","Profiles  Publishers  Attribution tags \\* Reports\n"],"documentType":"guide"},{"title":"Get started with the Amazon Attribution API","sectionHeader":{"type":2,"text":"Notes on Amazon Attribution migration from DSP to advertising console"},"path":"/en-us/guides/amazon-attribution/get-started","content":[" Advertisers eligible for Amazon Attribution can access it through the advertising console alongside other self-service advertising products, including Sponsored Products, Sponsored Brands, Sponsored Display, and Stores. \n"," Legacy Amazon Attribution accounts are no longer accessible through a web browser interface but still function as usual through the API. Advertisers with legacy accounts should have already migrated their data to their ad console accounts. For assistance with account migration, advertisers should reach out to Amazon Ads support using the ad console help center. \n"," To ease migration for API integrators, the Amazon Attribution API uses the same API endpoints for both legacy profiles and advertising profiles. Note that while legacy profiles could contain more than one Amazon Attribution advertiser, this is no longer true for advertising console profiles, which have a one-to-one relationship with advertisers. The Advertisers resource remains functional on either type of profile for full backward compatibility, but advertiserId values will be different on each profile.\n"," An Amazon Attribution legacy profile can be identified by the subType property with value AMAZON_ATTRIBUTION. New integrators should filter out these outdated profiles in their user account onboarding process to prevent confusion.\n"],"documentType":"guide"},{"title":"Get started with the Amazon Attribution API","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-attribution/get-started","content":[],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":null,"path":"/en-us/guides/amazon-attribution/how-to","content":[" Once you have been granted permission to the profile of an advertiser you can use the Amazon Attribution API to read the following resources associated with your advertiser:\n","Profiles\n","Advertisers\n","Publishers \n","Attribution tags \n","Reports\n"],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":{"type":2,"text":"Profile resource"},"path":"/en-us/guides/amazon-attribution/how-to","content":[" A profile represents an advertiser account in a particular market. Each time you make a call to an Amazon Attribution API endpoint you must pass a profile ID as the Amazon-Advertising-Api-Scope header. Retrieve the list of profiles you can access by calling /v2/profiles. \n"],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":{"type":2,"text":"Advertisers resource"},"path":"/en-us/guides/amazon-attribution/how-to","content":[" Get the Advertisers resource to retrieve a list of Amazon Attribution \"advertisers\" associated with a profile. Ad console profiles will only have a single advertiser. DSP-based profiles for vendor advertisers may have multiple Amazon Attribution advertisers, but sellers will always have only one. You may want to pass an advertiserId as an optional parameter to one of the following endpoints.\n"],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":{"type":2,"text":"Publishers resource"},"path":"/en-us/guides/amazon-attribution/how-to","content":[" Get the Publishers resource to retrieve a list of all supported publishers. Each item in the list includes publisher name, publisher ID, and whether or not the tag of the publisher includes macros, also known as dynamic parameters. The Publishers resource is identical for all advertisers. You will pass publisher IDs when calling Attribution tag-retrieval endpoints.\n"," If you do not see a publisher listed, contact the API support team at ads-api-support@amazon.com.\n"],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":{"type":2,"text":"Attribution tags resource"},"path":"/en-us/guides/amazon-attribution/how-to","content":[" Once you have the profileId of your advertiser and the list of publishers, choose which Attribution tags resource you will call to retrieve tags. \n"," Amazon Attribution offers tags that include macros for publishers such as Google Ads, Facebook, Microsoft Ads, and Pinterest. For these publishers, you will call /attribution/tags/macroTag. These tags will only function on the intended publisher and will use campaign ID values provided by that publisher.\n"," For publishers that do not support macro tags, retrieve tags by calling /attribution/tags/nonMacroTemplateTag. Non-macro tags require that you provide unique campaign ID values in the tag parameters.\n"],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":{"type":3,"text":"Macro tags"},"path":"/en-us/guides/amazon-attribution/how-to","content":[" Using a macro tag for a given publisher and advertiser, you can use that same tag across all of the campaigns of the advertiser on that publisher. Macro tags allow the publisher to dynamically insert campaign information into the click-through URL when preparing the ad for display. Each tag contains publisher-specific macros that vary depending on the publisher.\n"," For example, here is a hypothetical macro tag for Google Ads returned from a call to the macroTag endpoint:\n"," Here is an example landing page URL that the campaign will drive to:\n"," After the tag is applied on the campaign in the ad manager of the publisher, when the publisher prepares each ad for display it will dynamically replace the {campaignid}, {adgroupid}, {creative}, {targetid}, {device}, and {feeditemid} macros with the actual campaign values.\n"," In this example, the resulting click-through URL would be:\n"],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":{"type":3,"text":"Non-macro tags"},"path":"/en-us/guides/amazon-attribution/how-to","content":[" You can also use non-macro tags for publishers that do not support dynamic parameters to enable Amazon Attribution measurement on ads that drive to an Amazon Store or Product Detail page. To prepare your non-macro tags for implementation, you first retrieve the non-macro template tag of the advertiser by calling the nonMacroTemplateTag endpoint and then your system can fill in the template values for the aa_campaignid, aa_adgroupid, and aa_creativeid URL parameters each time it needs to create a new tag.\n"," Here is an example non-macro tag template. It will not function unless you replace the template values.\n"],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":{"type":2,"text":"Attribution tag implementation"},"path":"/en-us/guides/amazon-attribution/how-to","content":[" Attribution tags can be implemented in any manner that results in a valid URL that is called when the ad is clicked, as long as the landing page is an Amazon Store or Product Detail Page. Here are some common ways to implement attribution tags.\n"," You may append an attribution tag to the end of a landing page URL and put the resulting URL into the click-through URL field of a publisher. Some publishers also allow for URL parameters to be kept separate from the landing page and will combine them dynamically.\n"," Amazon Attribution tags can be appended to a landing page URL used organically in a blog post or email, just as you would typically create a link to Amazon.\n"," If using a macro tag, it must be placed in a field that supports macro processing. This is publisher-specific, so check the help documentation of your publisher if you are having issues.\n"," For some publishers, you can implement attribution tags as click-trackers that fire upon each ad click. These tracking fields are different for each publisher. Remember that attribution tags will only work when the landing page is an Amazon Store or Product Detail Page.\n"," For Social campaigns, such as Facebook, you can implement the attribution tags of your advertiser within the \"URL parameters\" tracking field.\n"," For Search campaigns, such as Google Ads and Microsoft Ads, implement the attribution tags of your advertiser within the tracking template field, preceded by the {unescapedlpurl} macro for Google or the {lpurl} macro for Microsoft. Here is a Google example:\n"," If no other tracking templates will interfere, you can implement the attribution tag at the campaign level. However, note that if multiple tracking templates are implemented at different levels of a campaign, only the tracking template at the lowest level fires.\n"],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":{"type":2,"text":"Measurement"},"path":"/en-us/guides/amazon-attribution/how-to","content":[" When an Amazon Store or Product Detail Page URL including Amazon Attribution API tag parameters is clicked, this triggers Amazon Attribution to infer the structure of the campaign and measure click-attributed conversion events on Amazon. For a given profile, only links with Amazon Attribution tags from that profile are considered for conversion attribution and the last-clicked tag in the 14-day window gets full credit. Conversions will not be attributed to Amazon ads or any other links not tagged by the given profile.\n"," Amazon Attribution will automatically create an Amazon Attribution campaign, ad group, and creative using the values from the aa_campaignid, aa_adgroupid, and aa_creativeid parameters. After campaigns are created, promoted products will be automatically associated to the campaign to enable measurement of conversion metrics on these products. Clicks to Product Detail pages auto-associate that product and its variations to the campaign. Clicks to Amazon Stores pages auto-associate products listed on the Stores page to the campaign.\n"," Once campaigns, ad groups, and creatives are auto-created and products are auto-associated to the campaign, Amazon Attribution measures and reports clicks, conversions, and sales. Conversions on the associated products will show in reporting as \"promoted\" conversion metrics. \"Total\" and \"brand halo\" conversion metrics will reflect conversions on non-promoted products in the same brand.\n"],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":{"type":2,"text":"Reports resource"},"path":"/en-us/guides/amazon-attribution/how-to","content":[" Once attribution tags have been implemented and shoppers have clicked your links, call the report endpoint to retrieve reporting. Clicks may take up to 24 hours to appear, and conversions may take up to 48 hours. \n"," Two types of reports are available: Performance and Products. You can access each report type by entering the optional reportType request body property with a value of PERFORMANCE (default) or PRODUCTS. Each report type differs in terms of its aggregation level, dimensions, and metrics. For the performance report, you may choose the aggregation level by passing the groupBy request body property with a value of CAMPAIGN, ADGROUP, or CREATIVE (default). The products report is always aggregated at ad group level and is limited to the top 100 products per campaign, as ranked by sales, purchases, and DPVs.\n"," If you do not indicate which metrics you want the report to include, the response will include all available metrics (except brb_bonus_amount). For more efficient reporting you can include a list of desired metrics in your request body. \n"," View the available dimensions and metrics for each report type by visiting the ReportRequestBody documentation.\n","| Report type | Included dimensions | Aggregation level | Metrics | Available reporting dates |\n","\\|--------\\|---------\\|---------\\|--------\\|--------\\|\n","| Performance | aa_campaignid, aa_adgroupid, aa_creativeid, publisher | You can choose to aggregate at the CAMPAIGN, ADGROUP, or CREATIVE level (default: CREATIVE) | Click-throughs and all Promoted and Total conversion metrics. See Report endpoint for a complete list. | Last 13 months |\n","| Products | aa_campaignid, aa_adgroupid, publisher, productName, productGroup, productCategory, productSubcategory, brandName, productAsin, productConversionType | Always aggregated at ad group level | Promoted and Brand halo conversion metrics, Brand Referral Bonus. No click-throughs. See Report endpoint for a complete list. | Last 90 days |\n"," Amazon updates Amazon Attribution reporting at least once per day and performs historical restatements every 1, 7, and 28 days to ensure reporting is updated with the most recent conversions and takes into account returns or refunds. We recommend that you retrieve the last 30 days of reporting each day.\n"],"documentType":"guide"},{"title":"Amazon Attribution API how-to","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-attribution/how-to","content":[" If you encounter problems using the Amazon Attribution API, the troubleshooting guide can help you diagnose and correct issues.\n"],"documentType":"guide"},{"title":"Amazon Attribution API troubleshooting","sectionHeader":null,"path":"/en-us/guides/amazon-attribution/troubleshooting","content":[" This troubleshooting guide is divided into three sections: Account authorization, tag implementation, and reporting. Please read through questions on this page top to bottom, confirming you have implemented tags properly and then confirming expectations around reporting.\n"],"documentType":"guide"},{"title":"Amazon Attribution API troubleshooting","sectionHeader":{"type":2,"text":"Account authorization"},"path":"/en-us/guides/amazon-attribution/troubleshooting","content":[" To use the Amazon Attribution API, your API developer account must have access to the advertising profile of an advertiser. Please refer to Getting Started for authorization methods. Note some aspects of setup (for example, URL domain names) may be different depending upon the geographic region of your advertiser.\n"," Your advertiser must grant you access to their profile, and then the profile should appear in the profiles endpoint response list within two hours. If you are using the API test domain, you should use the production domain instead. Please refer to Getting Started and confirm that you have followed all setup steps.\n"," This advertiser profile may not be eligible for Amazon Attribution. See the overview for eligibility requirements.\n"],"documentType":"guide"},{"title":"Amazon Attribution API troubleshooting","sectionHeader":{"type":2,"text":"Tag Implementation"},"path":"/en-us/guides/amazon-attribution/troubleshooting","content":[" This could be related to the following:\n","You may have applied the tag to an invalid landing page. Tags will only function when applied to an Amazon product detail page or store page.\n","You must call a tag retrieval endpoint with the profile of an advertiser before you can measure campaigns for that advertiser. This is because the endpoint has hidden side-effects which enable measurement. If you skipped that step for that advertiser, retrieve tags and try again.\n","Campaign creation may take up to four hours after the first click. Try waiting four hours and look again.\n","You may have altered the tag in a manner that interfered with its functionality. Ensure all original parameters are included without duplicates and the URL is properly formatted.\n"," This could be related to the following:\n","You may need to wait 24 hours before clicks appear, and up to 48 hours for conversions.\n","Our reporting threshold will mask (as zero) all metrics for data rows with &lt;10 clicks. After the tag has been clicked ten times, metrics should appear within 48 hours.\n"," This may be due to the following reasons:\n","Conversions may take up to 48 hours to populate reporting. Try waiting and looking again.\n","You applied a tag from one marketplace to a landing page in a different marketplace. For example, a tag for a US account applied to a Canadian landing page.\n","You applied a tag from one advertiser profile to a product or store page for products belonging to a different advertiser profile. A tag will only measure conversions for products belonging to the selling account associated with the profile of that tag. \n","Your tag used parameter values which were too long or used illegal characters. Values must be less than 255 characters (after macros are expanded) and must not contain the following characters, even if they are URL-escaped: /, &, =, #, ?, +, ', \", %, $.\n","Your aa_campaign_id value was re-used by a different advertiser or in a different market. Make sure to use a unique campaign id per advertiser per market.\n","You applied a tag to a URL which contains a ref\\_ and/or tag parameter. Because the Attribution tag uses its own ref\\_ and tag parameters, the one(s) in your URL are interfering with the ability of Amazon Attribution to measure your campaign. Delete the ref\\_ or tag parameters from your URL, leaving the ones in the Attribution tag.\n","Your landing page was an Amazon store that did not have any ASINs assigned to it. If your Amazon store page only uses dynamic widgets that choose which ASINs to show in real-time (rather than the same ones every time) then Amazon Attribution may not associate those ASINs with your campaign. To work around this, either add static ASINs to your store page or use a different landing page.\n","You altered the tag in a way that interfered with its functionality, such as removing a parameter or you appended it to a URL without following standard URL formatting rules. A valid URL format will contain (in order): an Amazon domain, a path to a product or stores page, a ? character, and then a list of parameter name=value pairs each separated by an & character.\n"," The phrase in curly brackets is a macro intended for a specific publisher who should replace it with a campaign ID value. If you see curly brackets show up in reporting instead of an actual ID value, that means the publisher could not process the macro. This may be due to the following reasons:\n","The tag may have been intended for a different publisher (for example, a Facebook tag used on a Google campaign).\n","The tag may have been implemented in the wrong field in the ad manager of the publisher, or something else interfered with the processing of the macro by the publisher, such as improper URL escaping in a wrapped tag.\n","If you are using the non-macro tags of Amazon Attribution, your own system must fill in the id parameters when preparing the link.\n"," Each tag may only ever be used on one landing page. If you would like to tag multiple landing pages within the same ad group or move a tag to a new landing page, use a unique creative id for each landing page but use the same ad group id and campaign id.\n"],"documentType":"guide"},{"title":"Amazon Attribution API troubleshooting","sectionHeader":{"type":2,"text":"Reporting"},"path":"/en-us/guides/amazon-attribution/troubleshooting","content":[" Reporting for a given date should be considered partially complete until 48 hours after that date. Generally, clicks are reported within 24 hours. If you implemented your tag correctly, you may simply need to wait and you will see your metrics show up in reporting.\n"," Metrics may be restated up to 28 days later, for example to adjust for product returns. We recommend you occasionally pull the most recent 28 days of reporting and update any data you have stored for that time period.\n"," If your Amazon store page only uses dynamic widgets that choose which ASINs to show in real-time (rather than the same ones every time) then Amazon Attribution may not associate those ASINs with your campaign. To work around this, either add static ASINs to your store page or use a different landing page.\n"," Each report type supports a specific selection of dimensions and metrics and the one you are looking for may not be supported for the report type you have selected. For example, the Products report does not include click metrics or the aa_creativeid dimension, but the Performance report does. View the available dimensions and metrics for each report by visiting the ReportRequestBody parameters and descriptions.\n","| Report type | Included dimensions | Aggregation level | Metrics | Available reporting dates |\n","\\|--------\\|---------\\|---------\\|--------\\|--------\\|\n","| Performance | aa_campaignid, aa_adgroupid, aa_creativeid, publisher | You can choose to aggregate at the CAMPAIGN, ADGROUP, or CREATIVE level (default: CREATIVE) | Click-throughs and all Promoted and Total conversion metrics. See Report endpoint for a complete list. | Last 13 months |\n","| Products | aa_campaignid, aa_adgroupid, publisher, productName, productGroup, productCategory, productSubcategory, brandName, productAsin, productConversionType | Always aggregated at ad group level | Only \"top 100 Products\" Promoted and Brand halo conversion metrics, no click-throughs. (See Report endpoint for a complete list.) Limited to top 100 products. | Last 90 days |\n"," Due to data availability limits, you can only pull a Products report where the startDate is within the last 90 days.\n"," If you have a lot of data, we recommend using pagination to pull reporting in batches. You can include the count parameter to indicate how many records you would like to pull per batch, and use the cursorId parameter to pull subsequent batches. See the report endpoint reference for details.\n"," Amazon Attribution API only attributes conversions to clicks, not impressions.\n"," This may occur if Amazon Attribution tags were added to only some ads within the campaign. Alternatively, if you have implemented the tag as a tracking template, be aware that if multiple tracking templates are implemented at different levels within the same campaign, only the lowest level template will fire – so other tracking templates may be firing instead of your Amazon Attribution tag.\n"," This discrepancy is probably the result of our reporting aggregation threshold. To protect shopper privacy, Amazon Attribution will mask data for any reporting row representing a tag or group of tags with &lt; 10 clicks over its lifetime. For example, reporting aggregated at the ad group level will show all data for ad groups with 10+ clicks, even if some of the tags in the ad group have &lt; 10 clicks. Until the click threshold has been surpassed, masked rows will show metric values as zero. Campaigns with very small budgets or shown to a very small audience may take some time to surpass this threshold.\n"," To display reporting at campaign or ad group level, you should request performance reports at these specific aggregation levels, rather than aggregating the data yourself, to ensure your reporting includes all available data and matches the Amazon Ads console.\n"," Yes, you can modify the tags and add or remove macros to suit your needs. If you would like to do this, we recommend appending them at the end of the aa_creativeid parameter value, using an underscore or dash to separate them from the actual creative id. If you would like to remove any macros you may do so as well, provided you ensure that the final creative id value will be unique.\n"," Please note that our reporting threshold will mask reporting on any data row which represents a tag or a group of tags with &lt;10 clicks, so do not add macros which will cause your tag to become too detailed (for example, several macros in a row) or correspond to small audiences or individuals (for example, a user id or click id) or reporting will not be able to surpass the threshold.\n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":null,"path":"/en-us/guides/account-management/billing/getting-started","content":[" This document walks through the steps needed to set up billing for an Amazon Ads account through public APIs.\n"," This process establishes who is going to pay (the billing profile) for advertising spend on Amazon and what payment method they would like to use (the payment profile). This is required before an advertiser can start creating campaigns and advertise on Amazon.\n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/account-management/billing/getting-started","content":[" This guide assumes that you have already gone through the general Getting started steps for the Amazon Ads API to determine a client ID and access token, and that you can use the account management API to retrieve a global account ID.\n"," The following HTTP headers need to be passed for every request in this guide:\n"," Please replace the &lt;GLOBAL_ACCOUNT_ID>, &lt;ACCESS_TOKEN>, and &lt;CLIENT_ID> with your actual information. This enables the API to identify the account and authenticate as well as authorize the user trying to access the account.\n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":{"type":2,"text":"Billing profile setup"},"path":"/en-us/guides/account-management/billing/getting-started","content":[" A billing profile establishes who is going to pay for advertising and contains information like billing address, tax details, and contact information. The billing profile will be used for tax calculation and generating commercial invoices to the advertiser. This can be linked to one or more countries where you are advertising. \n"," This section walks through how to use the billing profiles APIs to set up billing for an advertising account. \n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":{"type":3,"text":"(Optional) Step 0: Get agreements"},"path":"/en-us/guides/account-management/billing/getting-started","content":[" You may need to provide consent to the BILLING_PROFILE_TAX_AGREEMENT and\n"," This step is only required if:\n","You want to provide a Value Added Tax (VAT) ID, a Goods and Services Tax (GST) number, or the equivalent in your billing profile. 2. You are a non-resident of Canada who wants to advertise in Canada but you do not have a Canadian GST.\n"," After going through the agreement returned from the above call, you can provide your consent while creating the billing profile (in Step 1).\n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":{"type":3,"text":"Step 1: Create a billing profile"},"path":"/en-us/guides/account-management/billing/getting-started","content":[" URL: POST /billingProfiles/\n"," More details on what each request attribute means can be found in the API specifications. The response contains the ID of the billing profile resource if it was successfully created. Some important points to note:\n","If isDefault is set to true, the billing profile will be applied to all countries where no previous billing information is configured. In such cases, your billing setup is complete, and you do not need to perform Step 2. You can still execute Step 2 if you would like to override the billing information for a specific country. 2. Advertisers marketing in EU countries may need to configure their \"Payer Name\" and \"Advertiser Name\" shown to the customers. To ensure accuracy of the information shown on the store, review the \"Advertiser Name\" and \"Payer Name\" in the ad systems and update them if required. For more details on how to configure this information, see Billing profiles: Digital Services Act (EU).\n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":{"type":3,"text":"(Optional) Step 2: Apply billing profile"},"path":"/en-us/guides/account-management/billing/getting-started","content":[" If you chose not to set the billing profile as default, you can use the billing profile usages API to apply a billing profile to specific marketplaces.\n"," The above request successfully associates the billing profile with ID amzn1.ads-billing-profile.dj3becs448uso2toisb6nqb6q to the JP marketplace. The billing information for that profile will be used for billing within JP.\n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":{"type":2,"text":"Payment setup "},"path":"/en-us/guides/account-management/billing/getting-started","content":[" This section walks through how to use the payments APIs to set up a payment agreement and payment profile for an advertising account.\n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":{"type":3,"text":"(Optional) Step 0: Get eligible payment methods"},"path":"/en-us/guides/account-management/billing/getting-started","content":[" This API returns a list of payment methods that are available for registration. \n"," This API should be called with criteriaType set to AUTO_PAY to find what payment methods are eligible for registration when first setting up an advertising account. \n"," The response from this API can be used for payment method registration in the next step. \n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":{"type":3,"text":"Step 1: Create a payment agreement"},"path":"/en-us/guides/account-management/billing/getting-started","content":[" A payment profile is a way to collect payment (that is, payment instructions), represented by a list of payment methods. A payment agreement represents an agreement between a given advertiser (the target) and Amazon Ads on how Amazon can collect money that it is owed (the payment profile). \n"," A payment profile can be created independently using the payment profiles API, or you can create the payment profile and agreement as part of one API call. A user can create a payment profile and associate it to an advertising account using the following request body:\n"," This will set up the payment profile that will be used for collection on invoices that are issued to your advertising account. \n"," To find entities and entity IDs for which your account is eligible to create payment agreements, use the account management API and look for the entityId field in the alternateIds found in the API response corresponding to the country code you would like to edit.\n"," The result of this API call will be the creation of a payment profile with the specified payment methods and a payment agreement, which applies the new payment profile to the account provided in the target attribute. A sample successful response looks as follows: \n"," Additionally, advertisers can mark a created payment profile as a global default by including the defaultFor attribute in the request. When a payment profile is marked as default for a global account, it will be automatically applied to all new marketplaces the global account expands to, as well as to all those marketplaces where the global account does not have a payment agreement setup currently. In other words, a payment agreement will automatically be created in the new marketplace with the new advertising account as the target and the global default payment profile. \n"," This configuration can be specified during payment agreement creation. The following request body outlines what modification needs to be made to the request above in order to specify the payment profile to be the global default. \n"," The entity type attribute is set to GLOBAL_ACCOUNT and the entity ID should be the global account ID. The value of the account ID should match the value provided in the Amazon-Ads-AccountId header of the request, which for global calls should also be the global account ID.\n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":{"type":3,"text":"(Optional) Step 2: Get payment agreements"},"path":"/en-us/guides/account-management/billing/getting-started","content":[" After completing payment method registration, you can also retrieve the payment agreements that have been registered to your accounts. This can be achieved via the payment agreements API.\n"," The API call should be made with query parameter agreementType set to AUTO_PAY. \n"," The following is a sample response for the API: \n"," As shown above, multiple payment agreements are returned, one for each country that the advertising account is active in. These payment agreements all share a common payment profile with ID amzn1.ads-payment-profile.XXX.\n"],"documentType":"guide"},{"title":"Getting started with billing APIs","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/account-management/billing/getting-started","content":[" To learn how to list or modify billing profiles and billing profile usages as needed, see Billing profiles.\n"," To learn more about setting up payments for a billing profile via the API, see Payments.\n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":null,"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" An advertiser needs to configure their billing information (billing address, taxes, email) before they can start creating campaigns to advertise on Amazon. With the launch of the billing profiles public APIs, integrators can configure billing information for sponsored ads vendor accounts without having to interact with the ads console.\n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" To operate on these public APIs you need to have a global sponsored ads account. Refer to the account management guide to find the account ID for your sponsored ads account.\n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":{"type":2,"text":"Billing profile & billing profile usage"},"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" A billing profile establishes who is going to pay for advertising and contains info like billing address, tax details, contact info. The billing profile will be used for tax calculation and generating commercial invoices for advertiser spend. \n"," A billing profile can be linked to one or more countries where you are advertising. The link between the billing profile and a country is called a billing profile usage.\n"," In the example above, the account is configured to advertise in the United States, Japan, the United Kingdom, and Australia. One billing profile has been linked to all four countries. Any update to the billing profile is reflected across all countries.\n"," An advertiser can create multiple billing profiles and link them to different countries, which allows different billing information for different countries:\n"," Advertisers can also mark any billing profile as default, which will link that billing profile to all countries where no billing information is present:\n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":{"type":3,"text":"Digital Services Act (EU)"},"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" In some European Union countries, as per the Digital Services Act, Amazon shows the Advertiser name and the Payer name for an ad to consumers. To ensure accuracy of the information shown on the store, we request that you review the Advertiser name and Payer name in our ad systems and update them if required.\n"," By default, when an advertiser links a billing profile to a country, both Advertiser name and Who paid for this ad will display the billingName provided in the billing profile. If you want to show a different value as Advertiser name, you can link multiple billing profiles for that marketplace. In such cases, the value of billingName in the billing profile with isBillTo set as false will be used to show the Advertiser name, while the value of billingName in the billing profile with isBillTo set as true will be used to show Who paid for this ad. Please note that invoicing, taxation, and other billing workflows will continue to use the billingProfile with isBillTo set as true.\n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":{"type":2,"text":"Billing profile public APIs"},"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" Amazon provides a set of APIs for programmatically managing the billing profiles of an advertiser and their billing profile usages. \n"," Required permissions are listed for each API operation below. Note that the user whose permission levels are checked is the Amazon user account that provided authorization for the access token used in the request. For more information, see Access tokens.\n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":{"type":3,"text":"[POST /billingProfiles](billing#tag/Billing-Profiles/operation/CreateBillingProfiles)"},"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" Creates new billing profile(s) under a sponsored ads account. A billing profile can exist independent of the countries present in the global account.\n"," Permissions\n","The user needs to have Edit access to Payment settings for at least one country in the global account. 2. If the user wants to create a default billing profile, they need to have Edit permission for Payment settings for all countries in the global account.\n"," Sample Request\n"," Notes:\n","If isDefault is set to true, the given billing profile will be auto-linked to all countries where no billing profile is applied. 2. Please note that the values in billingParty and isBillTo once set cannot be changed for that billing profile. However, you can always create a new billing profile with the changed values and apply that to the desired countries. 3. Consent to BILLING_PROFILE_TAX_AGREEMENT is required if you provide Value Added Tax (VAT), Goods and Services Tax (GST) or equivalent number along with your billing address. 4. Consent to BILLING_PROFILE_CANADIAN_NON_RESIDENCY_AGREEMENT is required if you are a non-resident of Canada who wants to advertise in Canada but do not have a Canadian GST. 5. The content of the above agreements can be fetched and viewed by calling the agreements API. 6. If you are advertising in EU countries, please ensure that the advertiser name and payer names are correctly configured. Refer to Digital Services Act (EU).\n"," Sample Response \n"," The response returns all billing profiles that were successfully created. In case of an error, please review the message provided in the error and correct any invalid input present. The index represents the index of the billing profile in the input array corresponding to particular success or error.\n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":{"type":3,"text":"[PUT /billingProfiles](billing#tag/Billing-Profiles/operation/UpdateBillingProfiles)"},"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" Updates one or more billing profiles under a global account. The API does not support partial update requests. On successful update, the updated billing information is automatically reflected across all the countries where the billing profile is associated. \n"," Permissions\n","The user needs to have Edit access to Payment settings for all the countries where the billing profile is linked. 2. To create a \"default\" billing profile, the user must have Edit access to Payment settings for all countries in the global account.\n"," Sample Request\n"," Sample Response \n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":{"type":3,"text":"[POST /billingProfiles/list](billing#tag/Billing-Profiles/operation/GetBillingProfiles)"},"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" Fetches billing profiles present under the global account. You can limit the search results by providing filters like defaultBillingProfileFilter and billingProfileIdFilter, in which case only results matching the filters will be returned. The response is paginated and includes a pagination token (nextToken) if more than 50 results match. You can customize the page size to be less than 50 by providing the maxResults key in request.\n"," Permissions\n","User needs to have View access to Payment settings for at least one country in their global account.\n"," Sample Request\n"," Sample Response\n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":{"type":3,"text":"[POST /billingProfileUsages/list](billing#tag/Billing-Profiles/operation/GetBillingProfileUsages)"},"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" Lists the billing profiles linked to each country of global ads account. You can further narrow down the search by providing the countries you want the billing profiles for.\n"," Permissions\n","The API will only return information for countries where user has View permission for Payment settings.\n"," Sample Request\n","Setting expandBillingProfile to true returns the full billing profile details along with the billing profile ID in the response. 2. Setting expandFallbackBillingProfile to true provides the current billing information being used for invoicing, taxation, etc. The fallback can be different from the billing profile when the status of the billing profile usage is not OK. 3. The filters field allows this API to further narrow down the search. In this case, the result will only return the billing profile usage associated with the JP marketplace.\n"," Sample Response:\n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":{"type":3,"text":"[POST /billingProfileUsages](billing#tag/Billing-Profiles/operation/ApplyBillingProfile)"},"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" Links one or more countries with a billing profile. The billing information of the linked billing profile will be used for invoicing, taxes, and other billing workflows. A single billing profile can be linked to multiple countries.\n"," Permissions\n","The user needs to have Edit access to Payment settings for the marketplace to which the profile will be linked.\n"," Sample Request\n"," Notes\n","The above request will link the billing profile with ID amzn1.ads-billing-profile.6kgxscrphc7adaeer5u8ckpd3 to the JP marketplace for the account. 2. There can be one and only one isBillTo=true billing profile in the billingProfileIds list for a country. 3. There can be no more than one isBillTo=false billing profile in billingProfileIds list for a country.\n"," Sample Response\n"],"documentType":"guide"},{"title":"Billing profiles overview","sectionHeader":{"type":3,"text":"[GET /billingProfileAgreementContents/{billingProfileAgreementContentId}](billing#tag/Billing-Profiles/operation/GetBillingProfileAgreementContent)"},"path":"/en-us/guides/account-management/billing/billing-profiles","content":[" In some cases, the user needs to provide consent to certain agreements before creating a billing profile. This API provides a way for users to access the agreement content.\n"," Permissions\n","User needs to have View access to Payment settings for at least one country in the advertising account.\n"," Sample Request/Response\n"],"documentType":"guide"},{"title":"Payments overview","sectionHeader":null,"path":"/en-us/guides/account-management/billing/payments","content":[],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":2,"text":"Logical Data Model"},"path":"/en-us/guides/account-management/billing/payments","content":[" A single payment method is a payment instrument that can be used to attempt collection. \n"," A payment profile can contain one or many payment methods. \n"," A payment profile can be shared by one or many payment agreements. \n"," A payment agreement contains a single payment profile and a single target which indicates the entity (often an advertising account) to apply this payment profile to. This forms an agreement with the target entity indicating how payment can be collected. \n"],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/account-management/billing/payments","content":[" The payments public APIs are set up to support both globally scoped and non-globally scoped service calls. \n"],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":3,"text":"Headers"},"path":"/en-us/guides/account-management/billing/payments","content":[" This guide assumes that you have already gone through general getting started guide to obtain your client ID and access token. This information will be required as headers in the subsequent calls and would be used to authenticate and authorize the request. The following HTTP headers need to be passed for every request:\n"," Please replace &lt;ACCESS_TOKEN> and &lt;CLIENT_ID> with your actual information. This enables the API to identify the account and authenticate as well as authorize the user trying to access the account.\n"," Additionally, global calls require an additional header:\n"," The &lt;GLOBAL_ACCOUNT_ID> corresponds to your global account ID. You can use the account management API to retrieve a global account ID.\n"],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":2,"text":"APIs"},"path":"/en-us/guides/account-management/billing/payments","content":[],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":3,"text":"[POST /billing/paymentMethods/list](billing#tag/Get-Payment-Methods)"},"path":"/en-us/guides/account-management/billing/payments","content":[" This API returns a list of payment methods that an advertiser is eligible to register, that is, create a profile using. Clients can directly use the payment methods returned from this API to create payment profiles and register these payment methods to advertising accounts.\n"," A sample response of this API is as follows:\n"," Each list includes payment methods that the advertiser currently is eligible to use to create a payment agreement. \n"],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":3,"text":"[POST /billing/paymentAgreements](billing#tag/Create-Payment-Agreement)"},"path":"/en-us/guides/account-management/billing/payments","content":[" This API supports creating payment agreements for a given advertiser. You can use this API to update or create a payment agreement for one or many advertising accounts. \n"," The caller of this API can provide a paymentAgreementId in the request in order to update an existing payment agreement, or leave this field blank to create a new payment agreement. A given target can only have one payment agreement associated to it, so once a target has a payment agreement associated to it, the caller must update that agreement and must not attempt to create a new agreement.\n"," When the caller defines a payment profile as part of their agreement creation request, they can either provide a paymentProfileId which makes it so that the payment agreement being created/updated will point to an existing payment profile; or the caller can leave this field blank and define a new payment profile in the request, which will create a new payment profile and associate this agreement to it. When defining a profile, the caller is able to specify a list of payment methods and allocate priorities to these payment methods for how they want them to be used during payment execution. If one payment method fails, we will attempt payment on the next lowest priority payment method. \n"," A sample request that can be sent to this API is as follows:\n"],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":3,"text":"[POST /billing/paymentAgreements/list](billing#tag/Get-Payment-Agreements)"},"path":"/en-us/guides/account-management/billing/payments","content":[" This API allows clients to retrieve payment agreements that are currently active for a given advertising entity. These payment agreements include the current payment agreement that is being used to automatically try to collect on the advertiser invoices.\n"," A sample response that a customer can expect from this API is as follows:\n"],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":3,"text":"[POST /billing/invoices/pay](billing#tag/Pay-Invoices)"},"path":"/en-us/guides/account-management/billing/payments","content":[" This API allows clients to initiate payments on their currently unpaid or open invoices. The API returns details regarding which invoices it failed to collect payment on, a human-readable reason for the failure, and a list of invoices for which it successfully collected payment. Note that this API does not support globally scoped calls today.\n"," The request body for this API is as follows:\n"," The response includes a list of invoices for which payment was attempted and a reason indicating why a payment may have failed.\n"],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":3,"text":"[POST /billing/paymentProfiles](billing#tag/Create-Payment-Profiles/operation/CreatePaymentProfiles)"},"path":"/en-us/guides/account-management/billing/payments","content":[" This API allows the creation or update of payment profiles.\n"," The caller of this API can provide a paymentProfileId in the request in order to update an existing payment profile. Updating an existing payment profile will affect all payment agreements that are using this payment profile. Alternatively, the client can omit this field to create a new payment profile and use the payment agreement API to then point an existing payment agreement or create a new payment agreement that uses the newly created payment profile.\n"," When defining a profile, the caller can specify a list of payment methods and allocate priorities to these payment methods to specify how these methods should be used during payment execution. If one payment method fails, we will attempt payment on the next lowest priority payment method. \n"," Clients can additionally specify defaultFor when creating a payment profile. Currently, clients can only specify their global advertising account as the defaultFor. Setting a payment profile as the defaultFor for a global advertising account means that all advertising accounts that get created under this global account (as the global account expands to new marketplaces) will use the same payment profile, and payment setup is not needed separately for new marketplaces.\n"," Clients can also specify eligibleEntities for the payment profile. The eligibleEntities field controls which accounts are eligible to use and update a given payment profile. Currently only the global advertising account can be set as an eligible entity, meaning a payment profile can only be used and updated by different advertising accounts belonging to a global advertising account.\n"," A sample request to this API is as follows:\n"],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":2,"text":"Advanced Use-Case Reference"},"path":"/en-us/guides/account-management/billing/payments","content":[],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":3,"text":"Updating Shared Payment Profiles"},"path":"/en-us/guides/account-management/billing/payments","content":[" A payment profile can be shared by multiple payment agreements. The payment profile creation API allows us to update these shared profiles so that all agreements that reference this shared profile will now be using the new version of it.\n"," The following is a sample request body that would update the profile that is being shared by the agreements in the example above.\n"," As shown above, the payment profile ID is provided in the request. When the ID is provided, the API will update an existing payment profile. If the ID is not provided, then the API will create a new payment profile and generate a new ID for it. After this request is made, a subsequent list payment agreements call would return the same set of agreements, except they would be updated to use the PAY_BY_INVOICE payment method due to the update that was made to their shared profile.\n"],"documentType":"guide"},{"title":"Payments overview","sectionHeader":{"type":3,"text":"Updating a payment agreement to use a new payment profile"},"path":"/en-us/guides/account-management/billing/payments","content":[" In addition to updating a payment profile, you can also use the payment profiles API to create a new payment profile. The corresponding request body for this operation would be:\n"," This would create a new payment profile and return a response that indicates whether the creation was successful, and what the corresponding ID of the created payment profile is:\n"," Using this payment profile ID, you are then able to use the payment agreement API to create or update a payment agreement that points to this profile.\n"," This request would update the payment agreement with ID amzn1.ads-payment-agreement.XXX1 to use the payment profile with ID amzn1.ads-payment-profile.XXX123 which corresponds to the PAY_BY_INVOICE payment method.\n"," A subsequent get payment agreements call, based on the example above, would yield the following result:\n"],"documentType":"guide"},{"title":"Billing invoices overview","sectionHeader":null,"path":"/en-us/guides/account-management/billing/invoices","content":[" Use the invoices API to retrieve advertising invoices that include the total amount due, the amount of taxes due, and other billing-related information. To use this API, the user that granted permission for the access token must have the necessary permissions as specified in the Amazon Ads API permissions reference.\n"],"documentType":"guide"},{"title":"Billing invoices overview","sectionHeader":{"type":2,"text":"Retrieving advertising invoices using Amazon Ads API"},"path":"/en-us/guides/account-management/billing/invoices","content":[" Amazon Ads API provides APIs to retrieve the invoices of an advertising account. There are three high-level steps in retrieving your invoices using Amazon Ads API.\n","Retrieve the Profile IDs for your accounts 2.\tRetrieve your invoice summaries 3.\tRetrieve your invoice details\n"," This process requires a client ID, client secret, and a refresh token. If you are not familiar with creating these, please see the getting started guide. \n"],"documentType":"guide"},{"title":"Billing invoices overview","sectionHeader":{"type":2,"text":"Retrieve your profile IDs"},"path":"/en-us/guides/account-management/billing/invoices","content":[" Profiles in the Amazon Ads API represent an advertiser 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. Profiles in the Amazon Ads API correspond to accounts in the Amazon Ads console. A separate account is established for each marketplace. A single user (the advertiser) may manage multiple accounts in the console or through the API with the same Amazon login credentials.\n"," Profile IDs are required to retrieve the list of invoice summaries. The list of profile IDs can be retrieved using a /v2/profiles API call. This call requires the Amazon-Advertising-API-ClientId header parameter. \n"," This call to the profiles API retrieves a list of profiles:\n"],"documentType":"guide"},{"title":"Billing invoices overview","sectionHeader":{"type":2,"text":"Retrieve your invoice summaries"},"path":"/en-us/guides/account-management/billing/invoices","content":[" The /invoices API provides a list of invoice summaries for the given profile ID. The profile ID from the /v2/profiles API call must be used as the Amazon-Advertising-API-Scope header parameter for the invoices API call.\n"],"documentType":"guide"},{"title":"Billing invoices overview","sectionHeader":{"type":2,"text":"Retrieve your invoice details"},"path":"/en-us/guides/account-management/billing/invoices","content":[" The /invoices/{invoiceId} API provides details for the invoice with the given invoiceId. Pass the id field from the invoice summary as the invoiceId.\n"],"documentType":"guide"},{"title":"Billing invoicing report overview","sectionHeader":null,"path":"/en-us/guides/account-management/billing/global-invoicing-report","content":[" Global invoicing report allows sponsored ads and DSP advertisers to easily download a global CSV report containing a summary of all paid and unpaid worldwide invoices with billable amount, taxes, and purchase order among other details. Advertisers can focus on one country at a time or can look at the consolidated global spends to manage worldwide advertising payments.\n"],"documentType":"guide"},{"title":"Billing invoicing report overview","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/account-management/billing/global-invoicing-report","content":["Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in the tutorial.  Understand the concept of global account IDs and have a global account ID to set up billing. For more information, please refer to the account creation and retrieving accounts guides.  Have a global sponsored ads account. Refer to the retrieving accounts guide to find your global account ID for your sponsored ads account. You can also create a new global account by following the creating accounts steps. Downloading invoicing reports requires specific permission (mentioned with the respective API). You can check the permission associated with a user by following the permissions guide.\n"],"documentType":"guide"},{"title":"Billing invoicing report overview","sectionHeader":{"type":2,"text":"Download global invoicing report"},"path":"/en-us/guides/account-management/billing/global-invoicing-report","content":[],"documentType":"guide"},{"title":"Billing invoicing report overview","sectionHeader":{"type":3,"text":"Step 1: Create invoicing report"},"path":"/en-us/guides/account-management/billing/global-invoicing-report","content":[" User sends a request to the POST /billingStatements endpoint.\n"," More details on each attribute on the request can be found in the billing statement API specification. \n"," A user can trigger global invoicing report flow for the countries in which they have nemo_transaction_view/nemo_transaction_edit within a global account. If the permissions are valid, the API returns a response with the following information:\n"],"documentType":"guide"},{"title":"Billing invoicing report overview","sectionHeader":{"type":3,"text":"Step 2: Get invoicing report status and download link"},"path":"/en-us/guides/account-management/billing/global-invoicing-report","content":[" User sends a request to the GET /billingStatements/{billingStatementRequestId} endpoint with the billingStatementRequestId obtained from the response of Step 1.\n"," Sample request\n"," User can download global invoicing report flow for the countries in which they have nemo_transaction_view/nemo_transaction_edit within a global account. If the permissions and the billingStatementRequestId are valid, the client implements a polling mechanism to continuously send GET requests to the API at regular intervals until the report is either a SUCCESS or FAILED status. During this polling process, the client expects to receive intermediate status updates, specifically IN_PROGRESS. A successful call to the API includes a response with the latest status of the invoicing report creation request along with the download link (if the report status is SUCCESS).\n"," Sample response\n"],"documentType":"guide"},{"title":"Average daily budget user guide","sectionHeader":null,"path":"/en-us/guides/account-management/average-daily-budget","content":[],"documentType":"guide"},{"title":"Average daily budget user guide","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/account-management/average-daily-budget","content":[" Daily budget is the amount that you are willing to spend on a campaign each day. The daily budget amount is averaged over the course of a calendar month. On any given day you could spend less than your daily budget. Average daily budget allows you to spend more efficiently and take advantage of high traffic days, so that your campaign can spend unused budget on a subsequent day in a calendar month. \n"," At the end of the month, you will not spend more than the daily budget you have set, multiplied by the number of days in that month. Your invoice will be adjusted for any over-delivery, so that you will not be charged for any amount in excess of your monthly charging limit. For example, if your budget is $100 and you receive $90 worth of clicks on the first day, you could receive up to $110 worth of clicks on the second day. This would bring your total spend over two days to $200, which averages to $100 per day.\n"],"documentType":"guide"},{"title":"Average daily budget user guide","sectionHeader":{"type":2,"text":"Getting started"},"path":"/en-us/guides/account-management/average-daily-budget","content":[],"documentType":"guide"},{"title":"Average daily budget user guide","sectionHeader":{"type":3,"text":"Setting average daily budget"},"path":"/en-us/guides/account-management/average-daily-budget","content":[" You can set the average daily budget increase amount at either 25% or 100% of campaign budget. You select your choice at the profile level, so all sponsored ads campaigns are set at the same amount. \n"," By default, all campaigns have a 100% average daily budget increase amount. To opt-out of 100% increases, and set your average daily budget increase settings to 25% more than daily budget, use the POST /accountBudgets/featureFlags endpoint and set isOptedOutForAverageDailyBudgetIncrease to true.\n"," Sample request body:\n"," Sample response:\n"," If you previously set 25% average daily budget increase amount for all campaigns, but now would like to switch to 100%,  use POST /accountBudgets/featureFlags and set isOptedOutForAverageDailyBudgetIncrease to false.\n"," Sample response:\n"],"documentType":"guide"},{"title":"Average daily budget user guide","sectionHeader":{"type":3,"text":"Checking average daily budget settings"},"path":"/en-us/guides/account-management/average-daily-budget","content":[" To show your current average daily budget increase settings, use GET /accountBudgets/featureFlags.\n"," Sample response if opted in:\n"," Sample response if opted out:\n"],"documentType":"guide"},{"title":"Ad Library overview","sectionHeader":null,"path":"/en-us/guides/ad-library/overview","content":[" The Ad Library API provides users with the ability to query data related to advertisements and affiliate marketing content displayed on Amazon European Union (EU) stores. This API enables users to search and retrieve information about ads and affiliate marketing content shown across various Amazon EU marketplaces.\n"," The Ad Library API is globally accessible through the https&#x3A;//advertising-api-eu.amazon.com endpoint. It contains data for advertisements and affiliate marketing content displayed on Amazon EU stores in the following countries: Germany, Spain, France, Italy, Netherlands, Poland, Sweden, Belgium, and Ireland.\n"],"documentType":"guide"},{"title":"Ad Library overview","sectionHeader":{"type":2,"text":"FAQs"},"path":"/en-us/guides/ad-library/overview","content":["Is there a cost associated with using the Ad Library API?  2. Who can access the Ad Library API?  3. What types of ads can I search via the Ad Library API?  4. How are dates displayed on the API?  5. Is there a limit to the number of results I can obtain? \n"],"documentType":"guide"},{"title":"Ad Library overview","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/ad-library/overview","content":[],"documentType":"guide"},{"title":"Ad Library getting started","sectionHeader":null,"path":"/en-us/guides/ad-library/get-started","content":[" This tutorial outlines how to get access and make your first call using the Ad Library API.\n"],"documentType":"guide"},{"title":"Ad Library getting started","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/ad-library/get-started","content":["Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token. Since the Ad Library is a public API, users only need to follow step 1 of the onboarding process: Create a Login with Amazon application and steps 1 and 2 for the getting started process: Create an authorization grant and Retrieve access and refresh tokens.\n"," Example of the authorization URL:\n"],"documentType":"guide"},{"title":"Ad Library getting started","sectionHeader":{"type":2,"text":"Make your first call"},"path":"/en-us/guides/ad-library/get-started","content":[" To test your first call, use the POST method of the /adRepository/ads/list endpoint to query ads data.\n"],"documentType":"guide"},{"title":"Ad Library getting started","sectionHeader":{"type":3,"text":"Query Parameters"},"path":"/en-us/guides/ad-library/get-started","content":["|Name\t|Description\t|\n","|---\t|---\t|\n","| advertiserName  string\t|The person or entity on whose behalf the ad or affiliate marketing content is presented. This parameter limits results to those matching the requested advertiser or creator name.\t|\n","|advertisementPurpose  string\t|This parameter limits results to those matching the requested advertisement purpose. This includes the name of the product, service, or brand within the ad or affiliate marketing content. \t|\n","|siteName string\t|When specified, limits results based on their delivery to a particular Amazon EU store (for example, amazon.de, amazon.fr).\t|\n","|deliveryBeforeDateUtc  string\t|The specified end date of the delivered ads. The date string is specified in ISO format (YYYY-MM-DD) in UTC timezone. For example: 2020-12-16.\t|\n","|deliveryAfterDateUtc  string\t|The specified start date of the delivered ads. The date string is specified in ISO format (YYYY-MM-DD) in UTC timezone. For example: 2020-12-16\t|\n","|isRestricted boolean\t|Whether the advertisement was paused, removed or suppressed based on alleged illegality or incompatibility with terms and conditions. Limits results based on their restriction status.\t|\n","|nameMatchType  enum  {CONTAINS, EXACT_MATCH}\t|Default behavior performs a substring search (i.e., CONTAINS).\t|\n","|maxResults  integer\t|Defaults to 10, with supported values between 1 and 1,000. If the size of the result set is larger than the limit, callers retrieve additional results through pagination parameters.\t|\n","|nextToken  string\t|Pagination token to retrieve the next set of results. Callers must make use of the token provided in a previous response to use this parameter.\t|\n"],"documentType":"guide"},{"title":"Ad Library getting started","sectionHeader":{"type":3,"text":"Response Schema"},"path":"/en-us/guides/ad-library/get-started","content":["|Name\t|Description\t|\n","|---\t|---\t|\n","|id  string\t|Unique identifier for the ad to support lookups in the Ad Library.\t|\n","|advertisementPurpose  string\t|Name of the product, service or brand within the ad or affiliate marketing content.\t|\n","|type  string\t|Displays content type of the ad (AD or AFFILIATE_MARKETING_CONTENT).\t|\n","|subjectMatterUrl  string\t|URL for the affiliate marketing content. \t|\n","|advertiserName  string\t|The person or entity on whose behalf the ad or affiliate marketing content is presented.\t|\n","|payerName  string\t|The person or entity who paid for the ad.\t|\n","|deliveryBeforeDateUtc  string\t|The specified end date of the delivered ads. The date string is specified in ISO format (YYYY-MM-DD) in UTC timezone. For example: 2020-12-16.\t|\n","|deliveryAfterDateUtc  string\t|The specified start date of the delivered ads. The date string is specified in ISO format (YYYY-MM-DD) in UTC timezone. For example: 2020-12-16\t|\n","|targetingMethods  list of strings\t|This field lists the main parameters used to determine the recipients of the ad (for example, their estimated location).\t|\n","|isRestricted  boolean\t|Whether the ad was paused, removed or suppressed based on alleged illegality or incompatibility with terms and conditions.\t|\n","|restrictionCategory  string\t|Reasons why an ad was paused, removed, or suppressed.\t|\n","|restrictionDetectionAutomated  boolean\t|Describes whether automation was used to identify the restricted ad. \t|\n","|illegalContentReport  boolean\t|Describes whether the ad was removed as a result of an illegal content report. \t|\n","|totalRecipientsRange  map\t|Range of the number of impressions delivered by the ad. \t|\n","|totalRecipientsRangeBySite  map\t|Range of the number of impressions delivered by the ad by Amazon EU store (for example, amazon.de, amazon.fr). The return value is in the form of {siteName: {min: rangeMin, max: rangeMax}}. For example:  \"amazonDe\":  { \"max\": 50000, \"min\": 0 }|\n","|totalResults  number\t|Total number of return results for the query input.\t|\n","|nextToken  string\t|Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the nextToken field is empty, there are no further results.\t|\n"],"documentType":"guide"},{"title":"Ad Library getting started","sectionHeader":{"type":3,"text":"Request payload"},"path":"/en-us/guides/ad-library/get-started","content":[" The following is an example of the message body with the parameters advertiserName and deliveryAfterDateUtc to retrieve Amazon Ads data:\n"," When executed, Ad Library data which was delivered after the desired date will be returned. The default number of results returned in a single request is 10, but you can use the maxResults parameter to specify the desired number of results for each query. The POST ad library endpoint can be called using one of the following approaches:\n","Using cURL \\* Using Postman\n"],"documentType":"guide"},{"title":"Ad Library getting started","sectionHeader":{"type":3,"text":"Using cURL"},"path":"/en-us/guides/ad-library/get-started","content":[" You can use cURL to query the Amazon Ads data using the EU URL prefix.\n"],"documentType":"guide"},{"title":"Ad Library getting started","sectionHeader":{"type":3,"text":"Using Postman"},"path":"/en-us/guides/ad-library/get-started","content":[" In this example, we will be using Postman, an API platform that has an easy-to-use graphical user interface (GUI).\n","Download and install Postman. 2. Complete the setup for the Amazon Ads API Postman collection. Ensure that the user account you use to generate the authorization code has access to the advertising account you want to query. 3. Click Add request within the collection to create a new request. This will inherit the authorization parameters of the collection. 4. Name your request as desired (for example, Execute ad hoc workflow). By default, Postman creates a GET request. Make sure the HTTP method is set to POST. 5. In the request URL field, enter the base Amazon Ads API URL and append the endpoint path for the Ad Library API (/adRepository/ads). Using the EU prefix, your request will look something like the example below, with your unique instance being called as a variable: 6. If successful, you will receive a response with the HTTP status code 200 OK and the following response parameters:\n"],"documentType":"guide"},{"title":"Media plan API overview","sectionHeader":null,"path":"/en-us/guides/media-planning/media-plan/overview","content":[],"documentType":"guide"},{"title":"Media plan API overview","sectionHeader":{"type":2,"text":"What is the media plan API?"},"path":"/en-us/guides/media-planning/media-plan/overview","content":[" The media plan API enables advertisers and integrators to build media plans programmatically — constructing a plan from scratch, submitting it for processing, and reading the outputs including audience sizing, audience insights, performance forecasts, traffic insights, and optimized budget allocations.\n"],"documentType":"guide"},{"title":"Media plan API overview","sectionHeader":{"type":2,"text":"Resource hierarchy"},"path":"/en-us/guides/media-planning/media-plan/overview","content":[" A media plan is the root of every workflow. Everything else is a sub-resource of a single media plan, and each input resource exposes a level field that says where in the tree it sits.\n"," Inputs are created by the caller. Outputs are generated by the platform when you submit the plan for processing.\n"],"documentType":"guide"},{"title":"Media plan API overview","sectionHeader":{"type":2,"text":"Endpoints per resource"},"path":"/en-us/guides/media-planning/media-plan/overview","content":[" There are three classes of endpoints:\n"," Writable resources — mediaPlans, marketingGoals, planningItems, targets, audienceOpportunities, budgetAllocations. Each exposes:\n","| Action | Method & Path | Notes |\n","\\| --- \\| --- \\| --- \\|\n","| Batch create | POST /mediaPlan/v1/{resource} | 207, success\\[] / error\\[] indexed by request order |\n","| Batch update | PUT /mediaPlan/v1/{resource} | Same 207 shape |\n","| Batch delete | POST /mediaPlan/v1/{resource}/delete | Same 207 shape |\n","| Batch list | POST /mediaPlan/v1/{resource}/list | Filterable. Not currently paginated — every matching record is returned in one response |\n","| Read single | GET /mediaPlan/v1/{resource}/{id} | 200 |\n"," Read-only resources — audienceSizes, behavioralInsights, demographicInsights, trafficInsights, performanceForecasts. These only expose:\n","| Action | Method & Path |\n","\\| --- \\| --- \\|\n","| Batch list | POST /mediaPlan/v1/{resource}/list |\n","| Read single | GET /mediaPlan/v1/{resource}/{id} |\n"," Media plan exports — /mediaPlan/v1/exports/mediaPlans is the only synchronous processing API in the surface (the response contains the export result directly, not a resource with a state to poll):\n","| Action | Method & Path |\n","\\| --- \\| --- \\|\n","| Create (sync) | POST /mediaPlan/v1/exports/mediaPlans |\n"],"documentType":"guide"},{"title":"Media plan API overview","sectionHeader":{"type":2,"text":"Authorization scope"},"path":"/en-us/guides/media-planning/media-plan/overview","content":[" Every request runs in the auth scope of the entity ID provided in the request headers. Only resources owned by that entity are returned. Querying with a different scope yields an empty list rather than a 403.\n"],"documentType":"guide"},{"title":"Media plan API overview","sectionHeader":{"type":2,"text":"List filtering"},"path":"/en-us/guides/media-planning/media-plan/overview","content":[" The media plan is the root scoping resource. For every sub-resource list endpoint you must filter by mediaPlanId. There is no global \"list all my targets\" or \"list all my forecasts\" — list operations are always scoped to a single plan.\n"],"documentType":"guide"},{"title":"Media plan API overview","sectionHeader":{"type":2,"text":"State machine"},"path":"/en-us/guides/media-planning/media-plan/overview","content":[" Both the media plan and many sub-resources expose a state field. The values relevant to processing are:\n"],"documentType":"guide"},{"title":"Media plan API overview","sectionHeader":{"type":2,"text":"Re-processing after edits"},"path":"/en-us/guides/media-planning/media-plan/overview","content":[" Editing an input invalidates any output that depended on that input. For example, changing a target on a marketing goal invalidates the audience sizes and insights under any audience opportunity attached to that goal, as well as the performance forecasts of every planning item under it. Affected outputs will move to UPDATED / stale state and will not refresh until you re-submit the plan for processing.\n"," After any edit cycle, set the state of the plan to PENDING, poll for a terminal state, and read the refreshed outputs.\n"],"documentType":"guide"},{"title":"Media plan API overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/media-planning/media-plan/overview","content":[" To build your first media plan, see Get started.\n"],"documentType":"guide"},{"title":"Media plan API overview","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/media-planning/media-plan/overview","content":[],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":null,"path":"/en-us/guides/media-planning/media-plan/get-started","content":[" This guide walks through the canonical end-to-end workflow: building a media plan from scratch, submitting it for processing, polling for the result, and reading the outputs (sizing, audience insights, performance forecasts).\n"," All examples use placeholder IDs in the swagger style (amzn1.ads-planner.media-plan.00000000-...). Real responses return UUIDs — capture them from each response and pass them into subsequent requests.\n"],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":["Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. - Access to the media plan API closed beta. Contact your Amazon Ads account team to request access. - At least one of: a DSP advertiser ID or a Sponsored Ads advertiser ID.\n"],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":2,"text":"Steps"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":[],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":3,"text":"1. Create the media plan"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":[" Response (207):\n"," Capture from the response: mediaPlanId and versionId.\n"," At least one of dspAdvertiserId or sponsoredAdvertiserId is required, and which one depends on the account you are working in: direct access to a Sponsored advertiser account sends only sponsoredAdvertiserId; direct access to a DSP advertiser account sends dspAdvertiserId; manager account access may send either or both. Both are overwritten by every update, so echo the existing value(s) on each update unless you are deliberately changing the advertiser. A media plan is also anchored to a single countryCode. The startDate of the plan must be in the future.\n"],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":3,"text":"2. Create marketing goals"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":[" Marketing goals describe the funnel stage and KPI you are optimizing for. Each marketing goal must use a unique goal value within a media plan. You can create multiple in a single batch.\n"," To receive LINEAR_TV_REACH and INCREMENTAL_REACH_OVER_LINEAR_TV forecasts, send skipLinearTvReach: false and skipIncrementalReachOverLinearTv: false inside processingOptions on the marketing goal. The examples below keep the defaults, which skip both.\n"," Response (207):\n"," Capture: each marketingGoalId, and the new mediaPlanVersionId (2) for the next request.\n"],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":3,"text":"3. Create planning items"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":[" Planning items represent the channels or publishers you intend to run on. Each item belongs to exactly one marketing goal. You can mix item types and parent/child publisher hierarchies in a single batch.\n"," Response (abridged):\n"," Capture: each planningItemId, and the new mediaPlanVersionId (3) for the next request.\n"],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":3,"text":"4. Create audience opportunities"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":[" Audience opportunities are the \"buckets\" the platform sizes and produces insights for. You can attach an opportunity at:\n","audienceOpportunityLevel: MEDIA_PLAN — sized once for the whole plan. - audienceOpportunityLevel: MARKETING_GOAL — sized per goal (use this for funnel reporting).\n"," Each opportunity has an audienceOpportunityType:\n","| Type | What it sizes / produces insights for |\n","\\| --- \\| --- \\|\n","| MARKETING_GOAL | Sized for the linked marketingGoalId using its targets, funnel exclusions, and any baseline opportunities. |\n","| AUDIENCE_BASELINE | Sized using audience targets attached to this opportunity. Constrains the audiences of every marketing goal. |\n","| LOCATION_BASELINE | Sized using location targets attached to this opportunity. Narrows the audience of every marketing goal to a sub-geography of the countryCode of the plan. |\n"," For the funnel use case, create one MARKETING_GOAL opportunity per goal:\n"," Capture: each audienceOpportunityId, and the new mediaPlanVersionId (4) for the next request. You will use the audience opportunity IDs when reading the generated sizing and insights.\n"],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":3,"text":"5. Add targets"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":[" Targets define the funnel. Use:\n","targetLevel: MARKETING_GOAL — defines the audience for that goal. All planning items under the goal inherit it. - targetLevel: PLANNING_ITEM — narrows targeting on a single item. - targetLevel: AUDIENCE_OPPORTUNITY — attaches targets to an AUDIENCE_BASELINE / LOCATION_BASELINE opportunity (see Use cases). - targetLevel: MEDIA_PLAN — applies to traffic insights (see Use cases).\n"," Because this is a batch endpoint you can mix levels in one request. The example below adds:\n","A MARKETING_GOAL audience target on the AWARENESS goal. - A PLANNING_ITEM device exclusion (negative: true) restricting the DSP_PRIME_VIDEO item to non-desktop only.\n"," Every target entry must include mediaPlanId and mediaPlanVersionId, in addition to the level-specific parent ID (marketingGoalId, planningItemId, or audienceOpportunityId).\n"," All targets on a single marketing goal must be of the same targetType.\n"," A target is meaningful at exactly one level. The following table shows which targetType values are valid at each level:\n","| targetLevel | Valid targetTypes | Role |\n","\\| --- \\| --- \\| --- \\|\n","| MEDIA_PLAN | PRODUCT_CATEGORY | Plan-wide constraint (only used by traffic insights). |\n","| AUDIENCE_OPPORTUNITY | AUDIENCE (on AUDIENCE_BASELINE), LOCATION (on LOCATION_BASELINE) | Defines the optional baseline applied to every goal. |\n","| MARKETING_GOAL | AUDIENCE, PRODUCT_CATEGORY, PRODUCT | Defines the funnel stage's audience. |\n","| PLANNING_ITEM | KEYWORD, DEVICE, CONTENT_GENRE, CONTENT_RATING, THEME, INVENTORY_SOURCE | Narrows targeting / inventory selection on a single item. |\n"," The targets of a marketing goal must all be of one targetType, and which types are available depends on the goal:\n","| Marketing goal | Valid targetTypes |\n","\\| --- \\| --- \\|\n","| AWARENESS | AUDIENCE, PRODUCT_CATEGORY |\n","| CONSIDERATION | AUDIENCE, PRODUCT_CATEGORY |\n","| CONVERSIONS | AUDIENCE, PRODUCT |\n","| LOYALTY | PRODUCT |\n"," Combining targets on one goal: Multiple PRODUCT_CATEGORY targets combine with OR. AUDIENCE targets combine with OR within a groupId and with AND across groupIds.\n"," Country scope: Every plan is implicitly scoped to its countryCode. Baselines can narrow within that country; nothing can go outside it.\n"," Baselines (optional): If a plan has any baseline opportunities, their targets are intersected together to produce a single baseline expression that is AND-ed into the audience of every goal. Multiple baselines are intersected; within a single baseline, AUDIENCE targets combine as above.\n"," Funnel-stage subtraction (sizing & insights): For sizing and audience insights, the audience of a MARKETING_GOAL opportunity is built from:\n","The baseline expression (which always at least includes the country scope). 2. The marketing-goal-level targets of this goal, combined as above. Targets with negative: true become exclusions. 3. The union of the marketing-goal targets of every lower funnel stage, subtracted so each stage is mutually exclusive.\n"," Funnel ordering (highest to lowest): AWARENESS -> CONSIDERATION -> CONVERSIONS -> LOYALTY.\n"," You do not need to encode this subtraction yourself — the platform composes the final expression at processing time.\n"," Forecasting & budget optimization (per planning item): Performance forecasts and the optimized budget operate per planning item. The targeting they use is the expression of the goal plus the PLANNING_ITEM-level targets of that planning item.\n"],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":3,"text":"6. Submit the plan for processing"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":[" Send the current versionId. The example below re-sends the mutable fields from the create request, including the advertiser id, and only changes state to PENDING.\n"],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":3,"text":"7. Poll for a terminal state"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":[" Poll the read-by-ID endpoint until state is one of the terminal values:\n","| Terminal state | Meaning |\n","\\| --- \\| --- \\|\n","| SUCCESS | All sub-resources processed cleanly. All outputs available. |\n","| PARTIAL_SUCCESS | Some sub-resources failed. Inspect stateDetails.errors on the sub-resources and on the output resources — the error text may sit on an output such as performanceForecasts. Most outputs will still be readable. |\n","| FAILED | Nothing processed successfully. See stateDetails.errors. |\n","| TIMED_OUT | Processing exceeded the platform timeout. Consider re-submitting. |\n"," Recommended polling cadence: every 10-30 seconds with exponential backoff up to a sensible cap (for example, 5 minutes).\n"," Processing may increment the plan version, without any write from you. Re-read the plan after it reaches a terminal state and use the versionId from that response for any further writes.\n"],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":3,"text":"8. Read the outputs"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":[" Once the plan reaches SUCCESS or PARTIAL_SUCCESS, the platform has populated three broad output groups. Remember that every list call must include a mediaPlanId filter.\n"," For each audienceOpportunityId from step 4, the platform produces audienceSizes, behavioralInsights, and demographicInsights.\n"," The same filter pattern works for POST /mediaPlan/v1/behavioralInsights/list and POST /mediaPlan/v1/demographicInsights/list.\n"," You can also filter by performanceForecastType (for example, REACH, CLICK, VIDEO_COMPLETION, DETAIL_PAGE_VIEW, LINEAR_TV_REACH, INCREMENTAL_REACH_OVER_LINEAR_TV) to fetch a specific variant.\n"],"documentType":"guide"},{"title":"Get started with the media plan API","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/media-planning/media-plan/get-started","content":[],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":null,"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[" This guide covers additional workflows beyond the basic media plan creation flow: traffic insights, plan templates, optimized budget allocations, and audience opportunity baselines.\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":2,"text":"Traffic insights"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[" Traffic insights are produced at media plan level and summarize anticipated shopper traffic across the plan flight period. To generate them, the plan must have:\n","At least one brandIds value set on the media plan. - At least one MEDIA_PLAN-level target of type PRODUCT_CATEGORY.\n"," Set brand IDs on the plan during create or via update:\n"," This example creates a plan. If you adapt it to an update, send every advertiser id the plan already has. An omitted advertiser id is cleared.\n"," Add the media-plan-level product category target:\n"," After processing, list traffic insights filtered by mediaPlanId:\n"," The platform produces results for multiple timeUnit granularities (WEEK, MONTH, QUARTER) and for both RETAIL_PRODUCT_CATEGORIES and MARKETING_GOAL_AUDIENCE targeting types where applicable.\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":2,"text":"Plan templates"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[" The template field on the media plan controls what the plan is allowed to contain and what processing produces.\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":3,"text":"`ALL_MARKETING_GOALS`"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[" The default. All four marketing goals (AWARENESS, CONSIDERATION, CONVERSIONS, LOYALTY) and the full set of planning item types are allowed. This is the flow described in Get started.\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":3,"text":"`AWARENESS_ONLY`"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[" Identical to ALL_MARKETING_GOALS except only the AWARENESS marketing goal can be created on the plan. Attempts to add CONSIDERATION / CONVERSIONS / LOYALTY goals are rejected.\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":3,"text":"`COMPLETE_TV`"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[" Like AWARENESS_ONLY (single AWARENESS goal) plus two additional requirements:\n","A MEDIA_PLAN-level budget allocation is required for processing — see Budget allocations below. - Planning items must use the publisher hierarchy: a PARENT_PUBLISHER planning item with one or more child PUBLISHER planning items, plus INVENTORY_SOURCE targets on the publishers that identify both the parent and its associated child inventory sources.\n"," Example publisher hierarchy flow:\n"," The valid parent-publisher / child-publisher combinations and their inventory source IDs are platform-managed. See Publisher mapping for the exact set of allowed combinations.\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":2,"text":"Budget allocations"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[" Budget allocations come in two budgetAllocationType values:\n","OPTIMIZED_TOTAL_BUDGET — you provide a total allocatedBudget; on processing the platform produces an optimized split across the planning items that fall under the level of the allocation. - SEASONAL_BUDGET_BREAKDOWN — you provide dataPoints describing how a budget spreads across flight periods.\n","budgetAllocationLevel: MEDIA_PLAN — optimization is performed across all planning items in the plan. - budgetAllocationLevel: MARKETING_GOAL — optimization is performed across the planning items under the linked marketingGoalId only.\n"," Send the total as the top-level allocatedBudget. Leave budgetAllocationDetails out of the request; the platform populates it during processing.\n"," Example (media-plan-level optimized budget):\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":3,"text":"Optimized budget allocation flow"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[" The OPTIMIZED_TOTAL_BUDGET flow is two-phase:\n","You create a single parent allocation at MEDIA_PLAN or MARKETING_GOAL level with an allocatedBudget. 2. The platform — when the plan is processed — creates one allocation per planning item that falls under the level of the parent, populating both allocatedBudget (the recommended split from the optimizer) and optimizedBudget (the same value, marking it as system-produced).\n"," Media-plan level (split optimized across every planning item):\n"," Or marketing-goal level (split optimized only across planning items under that goal):\n"," Submit the plan with state: PENDING and poll the read-by-ID endpoint until a terminal state is reached.\n"," Once the plan reaches SUCCESS or PARTIAL_SUCCESS, list budget allocations. You will see your original parent allocation plus one child allocation per planning item under the scope of the parent:\n"," Read the per-item split from the PLANNING_ITEM-level children, where budgetAllocationDetails.optimizedBudgetAllocationDetails.optimizedBudget holds the share for each item.\n"," To set a manual budget on a planning item, send allocatedBudget at the top level and leave budgetAllocationDetails out of the request.\n"," From then on the top-level allocatedBudget holds the manual budget. The allocatedBudget inside budgetAllocationDetails still holds the figure the optimizer chose, and the two are not reconciled.\n"," When you update a budget allocation, send the top-level allocatedBudget you want in force — if you omit it, it is cleared. Leave budgetAllocationDetails out of the request to keep it as it is; naming even one field inside it replaces the whole object.\n"," To produce a new optimized split, delete the parent allocation, create a new one with the total you want, then submit the plan (state: PENDING) and poll again.\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":3,"text":"Manual budgets without optimization"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[" To set the per-planning-item budgets yourself and keep them exactly as sent, create allocations at PLANNING_ITEM level and do not create a parent allocation at MEDIA_PLAN or MARKETING_GOAL level. With no parent allocation the optimizer does not run, so nothing recalculates the values you supply.\n"," Repeat for each planning item you want to fund. optimizedBudget is not set on these allocations, at either level, because no optimizer run produced them.\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":2,"text":"Audience opportunity baselines"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[" Beyond the MARKETING_GOAL opportunities used in the basic workflow, you can attach baseline opportunities to the plan to constrain the funnel:\n","audienceOpportunityType: AUDIENCE_BASELINE — attach AUDIENCE_OPPORTUNITY-level targets of type AUDIENCE to define the baseline audience. - audienceOpportunityType: LOCATION_BASELINE — attach AUDIENCE_OPPORTUNITY-level targets of type LOCATION to define the baseline geography.\n"," When the plan is processed, the per-goal MARKETING_GOAL opportunity audience is defined as baseline AND goal targets minus the lower funnel stages. Sizing, behavioral insights, and demographic insights are produced for both the baseline opportunity itself and each marketing goal opportunity, so you can compare funnel stages against the same baseline.\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":2,"text":"Endpoint quick reference"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":["| Resource | Operations | Read |\n","\\| --- \\| --- \\| --- \\|\n","| Media plans | Create / Update / Delete / List on /mediaPlan/v1/mediaPlans | GET /mediaPlan/v1/mediaPlans/{mediaPlanId} |\n","| Marketing goals | Create / Update / Delete / List on /mediaPlan/v1/marketingGoals | GET /mediaPlan/v1/marketingGoals/{marketingGoalId} |\n","| Planning items | Create / Update / Delete / List on /mediaPlan/v1/planningItems | GET /mediaPlan/v1/planningItems/{planningItemId} |\n","| Audience opportunities | Create / Update / Delete / List on /mediaPlan/v1/audienceOpportunities | GET /mediaPlan/v1/audienceOpportunities/{audienceOpportunityId} |\n","| Targets | Create / Update / Delete / List on /mediaPlan/v1/targets | GET /mediaPlan/v1/targets/{targetId} |\n","| Budget allocations | Create / Update / Delete / List on /mediaPlan/v1/budgetAllocations | GET /mediaPlan/v1/budgetAllocations/{budgetAllocationId} |\n","| Audience sizes | List on /mediaPlan/v1/audienceSizes/list | GET /mediaPlan/v1/audienceSizes/{audienceSizeId} |\n","| Behavioral insights | List on /mediaPlan/v1/behavioralInsights/list | GET /mediaPlan/v1/behavioralInsights/{behavioralInsightId} |\n","| Demographic insights | List on /mediaPlan/v1/demographicInsights/list | GET /mediaPlan/v1/demographicInsights/{demographicInsightId} |\n","| Traffic insights | List on /mediaPlan/v1/trafficInsights/list | GET /mediaPlan/v1/trafficInsights/{trafficInsightId} |\n","| Performance forecasts | List on /mediaPlan/v1/performanceForecasts/list | GET /mediaPlan/v1/performanceForecasts/{performanceForecastId} |\n","| Media plan exports | Create on /mediaPlan/v1/exports/mediaPlans | GET /mediaPlan/v1/exports/mediaPlans/{mediaPlanExportId} |\n"],"documentType":"guide"},{"title":"Media plan API use cases","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/media-planning/media-plan/use-cases","content":[],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":null,"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":[" This reference lists the allowed parent-publisher and child planning item combinations for COMPLETE_TV media plans. Each parent publisher has one or more child planning items that can be created beneath it.\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":2,"text":"Parent publisher inventory source IDs"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":[" Every PARENT_PUBLISHER planning item must have an INVENTORY_SOURCE target with inventorySourceType: \"PARENT_PUBLISHER\". The inventorySourceId is the numeric ID listed below:\n","| Parent publisher | inventorySourceId |\n","\\| --- \\| --- \\|\n","| A+E Networks | 1417 |\n","| AMC Networks | 1886 |\n","| Amazon | 33 |\n","| Disney | 855 |\n","| Fox Corporation | 619 |\n","| NBCUniversal | 1079 |\n","| Paramount | 496 |\n","| Warner Bros. Discovery | 176 |\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":2,"text":"Third-party publishers"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":[" For third-party parent publishers (all except Amazon), child planning items use planningItemType: \"PUBLISHER\" and require an INVENTORY_SOURCE target with inventorySourceType: \"PUBLISHER\". The inventorySourceId for each child is a publisher domain from the tables below.\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":3,"text":"Example: Disney with Hulu child"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":[" In this example, \"855\" is the parent publisher inventorySourceId (from the table above) and \"hulu.com\" is the inventorySourceId of the child (from the Disney table below). You can attach multiple child publishers under the same parent (for example, Hulu and ESPN), each with their own INVENTORY_SOURCE target using the corresponding domain.\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":3,"text":"A+E Networks"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":["| Planning item | Inventory source IDs |\n","\\| --- \\| --- \\|\n","| A+E Run of Network | aetv.com, history.com, mylifetime.com, aecrimecentral.com, fallintome.com, fyi.tv, historychannel.com, lifetimemovieclub.com |\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":3,"text":"AMC Networks"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":["| Planning item | Inventory source IDs |\n","\\| --- \\| --- \\|\n","| AMC Run of Network | amc.com, amctv.com, bbcamerica.com, ifc.com, wetv.com, amcplus.com, bbca.com, sundance.tv, sundancechannel.com, sundancetv.com |\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":3,"text":"Disney"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":["| Planning item | Inventory source IDs |\n","\\| --- \\| --- \\|\n","| Disney Run of Network | abc.com, abcnews.com, go.com, disney.com, freeform.com, fxnetworks.com, natgeo.com, natgeotv.com, nationalgeographic.com |\n","| Disney Plus | disneyplus.com |\n","| ESPN | espn.com |\n","| Hulu | hulu.com |\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":3,"text":"Fox Corporation"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":["| Planning item | Inventory source IDs |\n","\\| --- \\| --- \\|\n","| Fox Run of Network | tmz.com, foxlocal.com, fox.com, foxbusiness.com, foxnews.com, foxsports.com, foxweather.com, newsnowfox.com |\n","| Tubi | tubi.tv, tubitv.com |\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":3,"text":"NBCUniversal"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":["| Planning item | Inventory source IDs |\n","\\| --- \\| --- \\|\n","| NBCU Run of Network | bravotv.com, cnbc.com, eonline.com, golfchannel.com, msnbc.com, nbc.com, nbcnews.com, nbcsports.com, oxygen.com, usanetwork.com, syfy.com |\n","| NBCU Peacock | peacocktv.com |\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":3,"text":"Paramount"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":["| Planning item | Inventory source IDs |\n","\\| --- \\| --- \\|\n","| Paramount EyeQ Run of Network | cbs.com, cbsinteractive.com, cbsnews.com, cbssports.com, etonline.com, insideedition.com, cbslocal.com, comedycentral.com, comedycentral.tv, nick.com, paramount.com, paramountnetwork.com, pluto.tv, smithsonianchannel.com, tvland.com, bet.com, cc.com, mtv.com, vh1.com |\n","| Paramount+ | paramountplus.com |\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":3,"text":"Warner Bros. Discovery"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":["| Planning item | Inventory source IDs |\n","\\| --- \\| --- \\|\n","| Discovery Run of Network | ahctv.com, animalplanet.com, destinationamerica.com, cookingchanneltv.com, discovery.com, diynetwork.com, foodnetwork.com, hgtv.com, investigationdiscovery.com, oprah.com, tlc.com, travelchannel.com, discoverylife.com, motortrend.com, sciencechannel.com |\n","| CNN | cnn.com |\n","| WM ENT Run of Network | tbs.com, tntdrama.com, trutv.com, adultswim.com |\n","| Discovery+ | discoveryplus.com |\n","| HBO Max | hbomax.com, max.com |\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":2,"text":"Amazon"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":[" The available Amazon child planning items and their inventory source IDs are:\n","| Planning item | Inventory source IDs |\n","\\| --- \\| --- \\|\n","| Prime Video | PRIME_VIDEO_VOD, PRIME_VIDEO_FAST_CHANNELS |\n","| Twitch Video | 334013060388967871 |\n"],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":3,"text":"Example: Amazon with Prime Video and Twitch Video children"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":[],"documentType":"guide"},{"title":"Planning item publisher mapping","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/media-planning/media-plan/publisher-mapping","content":[],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":null,"path":"/en-us/guides/media-planning/media-plan/faq","content":[],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Why does the list endpoint return empty results when I know resources exist?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" Every request runs in the auth scope of the entity ID provided in the request headers. If you query with the wrong scope you will see an empty list rather than an authorization error. Verify that the entity ID in your request headers matches the entity that owns the resources.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Are the list endpoints paginated?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" Not currently. Although the list request accepts maxResults and nextToken parameters and the response includes a nextToken field, pagination is not yet implemented — every list call returns all matching records in a single response, and nextToken is never populated. Do not build paging loops that depend on nextToken; pagination is planned for a future release.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Can I list all targets or forecasts across multiple plans?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" No. The mediaPlanId filter is required on every sub-resource list call. There is no global \"list all my targets\" or \"list all my forecasts\" — list operations are intentionally scoped to a single media plan.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Why did my request succeed (2xx) but some resources failed?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" Batch responses return 207, not 200. You must inspect both success\\[] and error\\[] — entries are aligned by index to your request order. A 207 with non-empty error\\[] is still HTTP-successful, so a 2xx status check alone will hide partial failures.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Can I have both media-plan-level and marketing-goal-level optimized budgets?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" No. Pick one optimization scope per processing run: attach the OPTIMIZED_TOTAL_BUDGET allocation at either MEDIA_PLAN or MARKETING_GOAL level, not both. This validation only fires at processing time, not at create time.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Why must `PRODUCT` targets match across `CONVERSIONS` and `LOYALTY` goals?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" When both goals are present, mismatched ASIN targets cause a validation failure at processing time. This is enforced to maintain consistency in the funnel model. The validation only fires at processing time, not at target-create time.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Why are my audience insights empty even though the plan processed successfully?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" Two conditions suppress audience insights (audience sizing, behavioral insights, and demographic insights):\n","userLocationSignal: CURRENT (IP-only): Setting the userLocationSignal of the plan to CURRENT means user location is determined by IP only, which the platform treats as a geo-targeted plan and skips audience insights. Use MULTIPLE_SIGNALS (the default) to avoid this. 2. A LOCATION_BASELINE opportunity is present: Adding any LOCATION_BASELINE opportunity to a plan flips it into geo-targeted mode with the same effect — no audience insights. You will lose audience output in exchange for geographic narrowing.\n"," In both cases, the opportunities still process to a terminal state but the output resources will be empty.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Can I use sponsored ad types with audience-targeted funnel stages?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" Sponsored ad types (SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_BRANDS_VIDEO, SPONSORED_DISPLAY) cannot run against an audience-defined funnel slice. Specifically:\n","If a goal has any AUDIENCE target attached at MARKETING_GOAL level, any sponsored planning items under it will be rejected at processing time. - The same restriction applies upward through funnel subtraction: if LOYALTY has audience targets, the CONVERSIONS stage inherits the restriction; if CONVERSIONS has audience targets, both AWARENESS and CONSIDERATION are restricted. - LOYALTY has no lower stage to subtract, so it is the only stage that can have audience targets and still permit sponsored planning items above it — assuming higher stages do not add audience targets of their own.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Which fields should be provided on an update?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" Send the full object: read the resource, change the fields you need, and send it all back along with its current version. For media plans, dspAdvertiserId and sponsoredAdvertiserId are overwritten by every update, so echo the existing value(s) unless you are deliberately changing the advertiser — an omitted id is cleared.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Why do writes fail with a version conflict or a missing-version error?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" Every write after the initial plan create must include the current mediaPlanVersionId (on the plan update this field is named versionId), and each successful write increments the version of the plan. If you send a stale version you get a conflict; if you omit it you get a validation error. Capture the new version from each response and pass it into the next request.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Can I modify a plan while it is processing?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" No. Mutations against a plan or its sub-resources are rejected while the plan is in PENDING or PROCESSING. Wait for a terminal state (SUCCESS, PARTIAL_SUCCESS, FAILED, or TIMED_OUT) before issuing further writes.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"What happens when I edit an input after processing?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" Editing an input puts dependent outputs into UPDATED state and they will not refresh until you set the plan back to PENDING and process again. There is no \"refresh just this output\" endpoint.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"Are output resources writable?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" No. Sizes, insights, traffic insights, performance forecasts, and reach curves are produced by processing — you read them, you do not write them. They only expose list and read-by-id.\n"],"documentType":"guide"},{"title":"Media plan API FAQ","sectionHeader":{"type":3,"text":"How do exports work differently from other endpoints?"},"path":"/en-us/guides/media-planning/media-plan/faq","content":[" The export endpoint (POST /mediaPlan/v1/exports/mediaPlans) is synchronous and create-only. Unlike the rest of the API, it returns the result inline (no state to poll) and does not surface update or delete operations.\n"],"documentType":"guide"},{"title":"Historic Reach APIs Overview","sectionHeader":null,"path":"/en-us/guides/media-planning/historic-reach/overview","content":[" The Historic Reach APIs provide visibility into the historic reach of Amazon supply sources for media planning purposes. The basic API returns monthly reach curves that Amazon Ads has already aggregated. The advanced API accepts input parameters, such as supply package, audience, demographic and date range, and returns a historic reach curve that matches the input criteria.\n"],"documentType":"guide"},{"title":"Historic Reach APIs Overview","sectionHeader":{"type":2,"text":"Which version should I use?"},"path":"/en-us/guides/media-planning/historic-reach/overview","content":[" The Historic Reach API has two versions. Use the basic API when you want a month of reach data that Amazon Ads has already aggregated, and use the advanced API when you want a curve generated over a date range that you choose.\n","| Feature | Basic | Advanced |\n","\\| --- \\| --- \\| --- \\|\n","| Time period | One calendar month, addressed as M/YYYY or MM/YYYY | A start date and end date that you choose |\n","| Range length | One calendar month | Date ranges longer than 3 months may result in failed curve generation |\n","| Data availability | From April 2025 onward, through the most recent month with data | startDate no earlier than 2024-09-25, and endDate at least 7 days before the current date |\n","| Call pattern | A synchronous request that returns a page of curve data. Follow nextToken to retrieve further pages | A request that creates a report, then status and retrieval requests |\n"," For the advanced API, see Get started.\n"],"documentType":"guide"},{"title":"Historic Reach APIs Overview","sectionHeader":{"type":2,"text":"Currently supported geographies"},"path":"/en-us/guides/media-planning/historic-reach/overview","content":["North America: United States, Canada, Mexico - South America: Brazil - Europe: Great Britain, Germany, France, Italy, Spain, Austria - Asia Pacific: Australia, Japan\n"],"documentType":"guide"},{"title":"Historic Reach APIs Overview","sectionHeader":{"type":2,"text":"FAQ"},"path":"/en-us/guides/media-planning/historic-reach/overview","content":[],"documentType":"guide"},{"title":"Historic Reach APIs Overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/media-planning/historic-reach/overview","content":[],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":null,"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in this tutorial.\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" Before using the Historic Reach API, ensure that you understand the following APIs.\n","| API                                                                                               | Description                                                                                                                                                                                                                                                                                                                                            |\n","\\| ------------------------------------------------------------------------------------------------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \\|\n","| Profiles API                                              | Returns the profile ID list needed to make successful calls. Profile ID in the Amazon Ads API corresponds to accounts in the Amazon Ads console. The retrieved list includes profiles associated with the advertiser whose permission is represented by the access token. This is the value you will use in the Amazon-Advertising-API-Scope header. |\n","| Advertisers API | Returns the list of advertiser IDs that you have access to. This is the value that you will use in the Amazon-Ads-AccountId header.                                                                                                                                                                                                                  |\n","| Audience Discovery API                         | Provides you with a list of audiences your advertiser ID is permissioned to and can be used for reach curve generation. You will use these IDs in the audienceId dimension.                                                                                                                                                                          |\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":2,"text":"Header parameters"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":["| Header                          | Description                                                                                                                                                                                                                                                               | Example                                                |\n","\\| ------------------------------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| ------------------------------------------------------ \\|\n","| Amazon-Advertising-API-ClientId | The identifier of a client associated with a \"Login with Amazon\" account.\t                                                                                                                                                                                                | amzn1.application-oa2-client.abcdef123456ghijkkl7890 |\n","| Amazon-Advertising-API-Scope    |The identifier of a profile associated with the advertiser account. Use the GET method on the Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose the profileId from the response to pass it as input. | 123123123123123                                      |\n","| Amazon-Ads-AccountId            | Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.                                                                                                                                                                                      | 898989898989                                         |\n","| Content-Type                    | The only supported type is application/json.\t                                                                                                                                                                                                                            | application/json                                     |\n","| Accept                          | The only supported type is application/json.                                                                                                                                                                                                                              | application/json                                     |\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":2,"text":"Create Historical Reach Curve"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" This is the endpoint that you will use for instantiating the generation of a reach curve. It accepts various parameters in the request body to allow you to more precisely include your target audience in the curve.\n"," This is a POST request. \n"," The endpoint is /mediaPlan/v2/historicalReachCurves.\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":3,"text":"The Targeting Dimension Object"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" The request body uses a dynamic structure to allow us to provide more functionality without impacting the API schema. We call each targeting attribute a dimension. Below, we will list and define all the different properties of a dimension.\n"," Represented by the dimensionType key. This is a required property.\n"," This property is used to describe the type of the dimension, which can be a single value, an array of values, or an array of dimensions. Each dimension type must be used with its corresponding value property.\n","| Dimension Type | Corresponding Dimension Value Field Name |\n","\\| -------------- \\| ---------------------------------------- \\|\n","| SINGLE       | dimensionValue                         |\n","| MULTIPLE     | dimensionValues                        |\n","| GROUP        | dimensionGroups                        |\n"," Represented by the dimensionName key. This is a required property.\n"," This is the name of the targeting attribute. For example, \"geography\" will be used to specify the geography that you want to use to generate the curve.\n"," The currently available dimension names are:\n","| Dimension Name       | Description                                                                                                                                            | Allowed Dimension Type(s)     | Example(s)                   | Is Required? |\n","\\| -------------------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------ \\| ----------------------------- \\| ---------------------------- \\| ------------ \\|\n","| supplyPackage      | The supply source of the data.                                                                                                                         | SINGLE                      | STV, PRIME_VIDEO         | Yes          |\n","| demographic        | The demographic of the people that viewed the ads. The default demographic used is P2_PLUS.                                                          | SINGLE                      | A18_34, M35_54, F25_49 | No           |\n","| reachType          | Whether the reach is denominated in individuals or households.                                                                                         | SINGLE                      | INDIVIDUALS, HOUSEHOLDS  | Yes          |\n","| audienceId         | The ID(s) of the audience(s) to plan against.                                                                                                          | SINGLE, MULTIPLE, GROUP | 123123123                  | No           |\n","| geography          | The country to plan against. This should be a two-letter representation of the geography.                                                              | SINGLE                      | US, GB, DE             | Yes          |\n","| frequencyThreshold | The minimum number of times that an individual or household was exposed to an ad to be counted as a data point in the curve. The default value is 1. | SINGLE, MULTIPLE          | 1, 2, 3, 4, 5, 6 | No           |\n"," Represented by the dimensionValue key. This is a required property IF the dimensionType is SINGLE, otherwise this should not be used.\n"," This is used to provide a single value for a targeting attribute/dimension. For example, you can use this field to pass the supplyPackage value of STV so that the reach curve is generated using STV data.\n"," Represented by the dimensionValues key. This is a required property IF the dimensionType is MULTIPLE, otherwise this should not be used.\n"," This is similar to the dimensionValue field, except that this is an array of dimension values.\n"," You would typically use this field to pass a list of audience IDs that are to be targeted when generating a reach curve.\n"," Represented by the dimensionGroups key. This is a required property IF the dimensionType is GROUP, otherwise this should not be used.\n"," This field allows you to use nested dimensions. In other words, you can create a complex combination of audiences that you want to target when generating a reach curve.\n"," Represented by the interOperator key. The default value is OR. This is an optional property.\n"," Enum values for this field are AND and OR.\n"," When using a dimensionType of MULTIPLE, this field allows you to determine how each value in the dimensionValues list is compared with each other when generating a reach curve. For example, if you have a dimensionValues list that looks like \\[\"123\", 321\", 343\"] and you set the interOperator value to OR, then, when generating the reach curve, the targeted audiences will be “123 OR 321 OR 343\".\n"," Represented by the intraOperator key. The default value is AND. This is an optional property.\n"," Enum values for this field are AND and OR.\n"," When using a dimensionType of GROUP, then this value is used to determine how the different dimensionValue or dimensionValues of the different dimensions in the group are compared with each other. For example, if you have one dimension with dimensionValue set to \"123\" and another dimension with dimensionValues set to \\[\"222\", \"333\", \"444\"]  and its interOperator set to OR, and you set the intraOperator value to AND, then, when generating the reach curve, the targeted audiences will be “(123) AND (222 OR 333 OR 444)”.\n"," Represented by the isNot key.\n"," This field allows you to negate the dimension that it belongs to. For example, if you want to create a targeting expression that roughly translates to “males-18-to-55 or females-18-to-55, but not males-35-to-45”, you would set this field to true for the dimension that has the dimensionValue of the audience ID of the audience that translates to males-35-to-45.\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":3,"text":"Request Body"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" The request body has the following structure:\n","| Property | Description | Example(s) | Is Required? |\n","\\| ---- \\| ---\\| ---\\| --- \\|\n","| startDate | The start date for which to generate a reach curve.  Must be a historic start date. The earliest valid start date is 2024-09-25. | \"2024-11-01\" | Yes          |\n","| endDate   | The end date for which to generate a reach curve. Must be greater than the start date. Must not be fewer than 7 days before the current date. | \"2024-12-01\"  | Yes|\n","| targeting | A list of the targeting dimension objects that define the targeting to use for generating the curve. | See below | Yes |\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":3,"text":"Examples of the Request Body"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" In this example, we will request to generate a reach curve using a single audience ID and a demographic type.\n"," This request roughly translates to:\n"," In this example, we will request to generate a reach curve using multiple audience IDs and a demographic type.\n"," Notice that the interOperator value is set to OR. This means that each audience ID in the list will be OR’d against each other.\n"," This request roughly translates to:\n"," In this example, we will request to generate a curve using multiple audiences with one negated. While negation is not currently supported, this example does a good job to show how to use the dimensionGroup field.\n"," This request roughly translates to:\n"," Another way of writing the expression in the dimension group is: ((NOT 123123123) AND (321321321 OR 789789789 OR 987987987)).\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" The response of the create request has only three properties:\n","The reportId. This will be used to check the status and to retrieve the reach curve data.  The status. Upon a successful call to the API, the status should be PROCESSING.  The status message. This is just additional verbiage that supports the status. When something goes wrong, this can be helpful in finding out what could have gone wrong.\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":2,"text":"Get Historical Reach Curve Status"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" This is the endpoint you should use to get the status of your requested report/reach curve.\n"," This is a GET request.\n"," The endpoint is /mediaPlan/v2/historicalReachCurves/{reportId}/status where the reportId is the ID of your requested reach curve that you got by calling the Create endpoint.\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":3,"text":"Responses"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" The generation can fail due to a few different reasons, but the most common one is if the targeting you used resulted in an insufficient sample size to generate an accurate curve. The message will let you know when it fails because of an insufficient sample size.\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":2,"text":"Get Historical Reach Curve"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" This is the endpoint that returns the successfully generated reach curve data points.\n"," This is a GET request.\n"," The endpoint is /mediaPlan/v2/historicalReachCurves/{reportId} where the reportId is the ID of the requested reach curve that you got by calling the Create endpoint.\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":3,"text":"Response"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" The response follows the following structure:\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":2,"text":"Accepted Targeting Values"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":3,"text":"Geography"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":["| Country       | Geography Value   | Region |\n","\\| ------------- \\| ----------------- \\| ------ \\|\n","| United States | US              | NA   |\n","| Canada        | CA              | NA   |\n","| Mexico        | MX              | NA   |\n","| Brazil        | BR              | NA   |\n","| Great Britain | GB              | EU   |\n","| Germany       | DE              | EU   |\n","| Austria       | AT              | EU   |\n","| France        | FR              | EU   |\n","| Italy         | IT              | EU   |\n","| Spain         | ES              | EU   |\n","| Australia     | AU              | FE   |\n","| Japan         | JP              | FE   |\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":3,"text":"Supply Package"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":["| Supply Package      | Dimension Value                     |\n","\\| ------------------- \\| ----------------------------------- \\|\n","| Streaming TV Bundle | STV                               |\n","| Prime Video         | PRIME_VIDEO                       |\n","| Devices             | FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY |\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":2,"text":"Reach Type"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" There are only two types of reach types: - INDIVIDUALS - HOUSEHOLDS\n"],"documentType":"guide"},{"title":"Getting started with the Historic Reach APIs.","sectionHeader":{"type":3,"text":"Demographic"},"path":"/en-us/guides/media-planning/historic-reach/get-started","content":[" The following table shows the different demographic values that are supported and the geographies that support them.\n","| Demographic   | US  | CA  | MX  | BR  | GB  | DE  | AT  | FR  | IT  | ES  | AU  | JP  |\n","\\| ------------- \\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| P2_PLUS     | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   |\n","| A18_24      |     |     |     | ✓   |     |     |     |     | ✓   | ✓   |     |     |\n","| A18_34      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| A18_35      |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| A18_49      | ✓   |     |     |     |     |     |     |     |     |     |     |     |\n","| A18_55      |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| A18_PLUS    | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   |     |\n","| A20_24      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| A20_PLUS    |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| A21_34      | ✓   |     |     |     |     |     |     |     |     |     |     |     |\n","| A25_29      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| A25_34      |     |     |     | ✓   |     |     |     |     | ✓   | ✓   |     |     |\n","| A25_49      | ✓   |     |     |     |     |     |     |     |     |     |     |     |\n","| A25_54      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| A25_PLUS    |     |     |     | ✓   |     |     |     |     |     |     |     |     |\n","| A30_34      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| A35_39      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| A35_44      |     |     |     | ✓   |     |     |     |     | ✓   | ✓   |     |     |\n","| A35_49      |     |     |     |     |     |     |     |     |     |     |     |     |\n","| A35_54      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| A35_64      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| A35_PLUS    | ✓   | ✓   | ✓   | ✓   |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| A36_55      |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| A36_PLUS    |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| A40_44      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| A45_49      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| A45_54      |     |     |     |     |     |     |     |     | ✓   | ✓   |     |     |\n","| A45_PLUS    |     |     |     | ✓   |     |     |     |     |     |     |     |     |\n","| A50_54      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| A50_PLUS    | ✓   |     |     |     |     |     |     |     |     |     |     |     |\n","| A55_59      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| A55_64      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   |     |\n","| A55_PLUS    | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| A56_PLUS    |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| F18_24      |     |     |     | ✓   |     |     |     |     | ✓   | ✓   |     |     |\n","| F18_34      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| F18_35      |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| F18_49      | ✓   |     |     |     |     |     |     |     |     |     |     |     |\n","| F18_55      |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| F18_PLUS    | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   |     |\n","| F2_PLUS     |     |     |     | ✓   |     |     |     |     |     |     |     |     |\n","| F20_24      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F20_34      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F20_PLUS    |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F25_29      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F25_34      |     |     |     | ✓   |     |     |     |     | ✓   | ✓   |     |     |\n","| F25_49      | ✓   |     |     |     |     |     |     |     |     |     |     |     |\n","| F25_54      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| F25_PLUS    |     |     |     | ✓   |     |     |     |     |     |     |     |     |\n","| F30_34      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F35_39      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F35_44      |     |     |     | ✓   |     |     |     |     | ✓   | ✓   |     |     |\n","| F35_49      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F35_54      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| F35_PLUS    | ✓   | ✓   | ✓   | ✓   |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| F36_55      |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| F36_PLUS    |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| F40_44      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F45_49      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F45_54      |     |     |     |     |     |     |     |     | ✓   | ✓   |     |     |\n","| F45_PLUS    |     |     |     | ✓   |     |     |     |     |     |     |     |     |\n","| F50_54      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F50_PLUS    | ✓   |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F55_59      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| F55_64      |     |     |     |     |     |     |     |     | ✓   | ✓   |     |     |\n","| F55_PLUS    | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| F56_PLUS    |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| M18_24      |     |     |     | ✓   |     |     |     |     | ✓   | ✓   |     |     |\n","| M18_34      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| M18_35      |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| M18_49      | ✓   |     |     |     |     |     |     |     |     |     |     |     |\n","| M18_55      |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| M18_PLUS    | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   | ✓   |     |\n","| M2_PLUS     |     |     |     | ✓   |     |     |     |     |     |     |     |     |\n","| M20_24      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M20_34      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M20_PLUS    |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M25_29      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M25_34      |     |     |     | ✓   |     |     |     |     | ✓   | ✓   |     |     |\n","| M25_49      | ✓   |     |     |     |     |     |     |     |     |     |     |     |\n","| M25_54      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| M25_PLUS    |     |     |     | ✓   |     |     |     |     |     |     |     |     |\n","| M30_34      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M35_39      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M35_44      |     |     |     | ✓   |     |     |     |     | ✓   | ✓   |     |     |\n","| M35_49      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M35_54      | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| M35_PLUS    | ✓   | ✓   | ✓   | ✓   |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| M36_55      |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| M36_PLUS    |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n","| M40_44      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M45_49      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M45_54      |     |     |     |     |     |     |     |     | ✓   | ✓   |     |     |\n","| M45_PLUS    |     |     |     | ✓   |     |     |     |     |     |     |     |     |\n","| M50_54      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M50_PLUS    | ✓   |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M55_59      |     |     |     |     |     |     |     |     |     |     |     | ✓   |\n","| M55_64      |     |     |     |     |     |     |     |     | ✓   | ✓   |     |     |\n","| M55_PLUS    | ✓   | ✓   | ✓   |     |     | ✓   | ✓   | ✓   |     |     | ✓   |     |\n","| M56_PLUS    |     |     |     |     | ✓   |     |     |     |     |     |     |     |\n"],"documentType":"guide"},{"title":"Reach forecasting API Overview","sectionHeader":null,"path":"/en-us/guides/media-planning/reach-forecasting/overview","content":[" The Reach Forecasting API allows integrators to generate reach forecasts against inventory that is available to buy, while taking into account brand and campaign parameters.\n"],"documentType":"guide"},{"title":"Reach forecasting API Overview","sectionHeader":{"type":2,"text":"Where is the reach forecasting API available?"},"path":"/en-us/guides/media-planning/reach-forecasting/overview","content":["North America: United States, Canada, Mexico - South America: Brazil - Europe: Germany, Spain, France, Italy, Netherlands, United Kingdom, Sweden, Turkey - Middle East: Saudi Arabia, United Arab Emirates - Asia Pacific: Australia, India, Japan\n"],"documentType":"guide"},{"title":"Reach forecasting API Overview","sectionHeader":{"type":2,"text":"FAQ"},"path":"/en-us/guides/media-planning/reach-forecasting/overview","content":[],"documentType":"guide"},{"title":"Reach forecasting API Overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/media-planning/reach-forecasting/overview","content":[],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":null,"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in this tutorial.\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":2,"text":"Endpoints by Regions"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":["| URL                               | Region         | Marketplaces                                                                                                                                                                                                    |\n","\\|---------------------------------------\\|--------------------\\|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|\n","| https&#x3A;//advertising-api.amazon.com    | North America (NA) | United States (US), Canada (CA), Mexico (MX), Brazil (BR)                                                                                                                                                           |\n","| https&#x3A;//advertising-api-eu.amazon.com | Europe (EU)        | United Kingdom (GB), France (FR), Italy (IT), Spain (ES), Germany (DE), Netherlands (NL), United Arab Emirates (AE), Poland (PL), Turkey (TR), Egypt (EG), Saudi Arabia (SA), Sweden (SE), Belgium (BE), India (IN) |\n","| https&#x3A;//advertising-api-fe.amazon.com | Far East (FE)      | Japan (JP), Australia (AU), Singapore (SG)                                                                                                                                                                          |\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" Before using the reach forecasting API, ensure you understand the following APIs:\n","| API | Description | Use case |\n","\\|-----\\|-------------\\|----------\\|\n","| Profiles API | Profile IDs in the Amazon Ads API correspond to accounts in the Amazon Ads console. A separate account is established for each marketplace. Profiles play a crucial role in making successful calls. | Users must provide the profile ID for the request header parameter Amazon-Advertising-API-Scope. |\n","| Advertisers API | Returns the list of advertiser IDs that you have access to. | Users can optionally provide an advertiser ID for the request header parameter Amazon-Ads-AccountId. |\n","| Advertised Product Categories Discovery API | Provides you with a list of advertised product categories to use for generating reach forecasts. | Users are required to call this API to get a list of valid advertised product categories and pass the id values from that list through the advertisedProductCategoryIds list. |\n","| Audiences Discovery API | Provides you with audiences that you can target. | Users are required to call this API to get a list of accessible audiences to pass the audienceId values through AudienceTargetV1 in the targets list. |\n","| GeoLocations API | Returns the list of all targetable locations. | Users are required to call this API to get a list of locations to pass the id values through LocationTargetV1 in the targets list. |\n","| Product-Targeting ASIN Categories API | Returns all targetable categories. This API returns a large JSON string containing a tree of category nodes. Each category node has the fields: category ID, category name, and child categories. | Users are required to call this API to get a list of product category IDs to pass the id values through ProductCategoryTargetV1 in the targets list. |\n","| Product Metadata API | Returns product metadata for the advertiser, which contains ASIN values in the response. | Users are required to call this API to get a list of ASIN strings to pass the ASIN values through ProductTargetV1 in the targets list. |\n","| Deals API | Returns the list of DSP deal IDs that you have access to. | Users are required to call this API to get the deal IDs (internalDealId) for use in InventorySourceTargetV1 in the targets list. |\n","| Publisher Discovery API | Returns the list of publishers. | Users are required to call this API to get available publishers. Pass the rootDomain field value from the Publisher Discovery API response through InventorySourceTargetV1 in the targets list. |\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":2,"text":"Header parameters"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":["| Header                           | Description                                                                                                                                                                                                                                                               | Example                                              |\n","\\|----------------------------------\\|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|------------------------------------------------------\\|\n","| Amazon-Advertising-API-ClientId\\* | The identifier of a client associated with an Amazon Developer account.                                                                                                                                                                                                   | amzn1.application-oa2-client.abcdef123456ghijkkl7890 |\n","| Amazon-Advertising-API-Scope\\*    | The identifier of a profile associated with the advertiser account. Use the GET method on the Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header, and choose the profileId from the response to pass as input. | 123123123123123                                      |\n","| Authorization\\*                   | Login with Amazon token in the form of Bearer {{token}}.                                                                                                                                                                                                                | Bearer AtzaIwEBIIR1q...                              |\n","| Amazon-Ads-AccountId             | The account identifier used to access the DSP. This is your Amazon DSP Advertiser ID.                                                                                                                                                                                     | 898989898989                                         |\n","| Accept                           | application/json                                                                                                                                                                                                                                                          | application/json                                     |\n","| Content-Type                     | application/json                                                                                                                                                                                                                                                          | application/json                                     |\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":2,"text":"Create Reach Forecasts"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" Endpoint: POST /mediaPlan/v1/reachForecasts\n"," The table below outlines the valid input combinations. Please review this table carefully before making API calls to ensure compliance with accepted values.\n","| Supply Package | Delivery Type | Country Code | Device Type | Allowed targeting sets |\n","\\|----------------\\|---------------\\|--------------\\|-------------\\|------------------------\\|\n","| DSP_STREAMING_TV | GUARANTEED | US, GB, DE, CA, MX | CONNECTED_TV, DESKTOP, MOBILE | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_AUDIO | GUARANTEED | US, CA, MX, GB, DE, IT | CONNECTED_TV, DESKTOP, MOBILE | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_PRIME_VIDEO | GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, AU, JP, IN, NL, AT, NZ, SE | CONNECTED_TV, DESKTOP, MOBILE | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_TWITCH_VIDEO | GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | CONNECTED_TV, DESKTOP, MOBILE | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| SPONSORED_PRODUCTS | NON_GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported | 1.LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| SPONSORED_BRANDS | NON_GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported | 1.LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| SPONSORED_BRANDS_VIDEO | NON_GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported | 1.LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| SPONSORED_DISPLAY | NON_GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_OLV | NON_GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | CONNECTED_TV, DESKTOP, MOBILE | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_STREAMING_TV | NON_GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | CONNECTED_TV, DESKTOP, MOBILE | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_PRIME_VIDEO | NON_GUARANTEED | US, CA, MX, BR | CONNECTED_TV, DESKTOP, MOBILE | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_AUDIO | NON_GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | CONNECTED_TV, DESKTOP, MOBILE, CONNECTED_DEVICE | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_DISPLAY | NON_GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_TWITCH_VIDEO | NON_GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | CONNECTED_TV, DESKTOP, MOBILE | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_TWITCH_DISPLAY | NON_GUARANTEED | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n","| DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY | Refer to Support by Country, Supply Package, DeliveryType | Refer to Support by Country, Supply Package, DeliveryType | Not Supported | 1.AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, LocationTargetV1 2.ProductCategoryTargetV1 3.ProductTargetV1 |\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":3,"text":"Request Body"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" All the fields shown below are mandatory for generating a reach forecast. Currently, a maximum of 5 sub-requests is allowed in the reachForecasts list at a time.\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":3,"text":"Parameters"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" The following sections provide in-depth details about each parameter you might need to interact with while calling the API. These explanations are designed to help you understand request structure, functionality, and best practices.\n"," Description: API callers are required to provide a country code for each forecast.\n"," Accepted Values:\n"," Example:\n"," Description: Defines the date range for the forecast.\n"," Requirements:\n","Must be in YYYY-MM-DD format. - Both dates must be in the future. - Start date must be at least tomorrow, with tomorrow calculated based on the UTC time zone. - End date must be after the start date.\n"," Example:\n"," Description: A specific supply package you want to target.\n"," Accepted Values: A list of SupplyV1.\n"," Currently, the API supports supplyPackage with\n","single SupplyV1 - multiple supplies for Guaranteed STV+ (DSP_STREAMING_TV with any combination of DSP_TWITCH_VIDEO, DSP_PRIME_VIDEO) - multiple supplies for connected devices Guaranteed and Non-Guaranteed (any combination of DSP_FIRE_TV, DSP_FIRE_TABLET, DSP_ALEXA_DISPLAY, DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY).\n"," Examples:\n"," Any single supplyPackage with a single supply.\n"," STV+\n"," Connected Devices\n"," Description: Specifies the delivery mode for the reach forecast.\n"," Accepted Values: GUARANTEED, NON_GUARANTEED\n"," Example:\n"," Support for supply package other than Connected Devices:\n","For the NON_GUARANTEED delivery type, all countries and supplies are supported except DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY and DSP_PRIME_VIDEO, which is supported only in \\[\"US\", \"CA\", \"MX\", \"BR\"]. - For DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY, please refer to the table below: Countries/Delivery Types Availability for Connected Devices. - For the GUARANTEED delivery type, support for different supplies varies by country. Below are the supported countries for each supply:\n"," Support for Connected Devices (DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY):\n","| CountryCode |MANAGED_SERVICE  GUARANTEED | MANAGED_SERVICE  NON_GUARANTEED | SELF_SERVICE  GUARANTEED | SELF_SERVICE  NON_GUARANTEED |\n","\\| :--- \\| :----: \\| :----: \\| :----:\\| :----: \\|\n","| US   | ✓ | ✓ |   | ✓ |\n","| CA   | ✓ | ✓ |   | ✓ |\n","| GB   | ✓ | ✓ |   | ✓ |\n","| DE   | ✓ | ✓ |   | ✓ |\n","| FR   | ✓ | ✓ |   | ✓ |\n","| IT   | ✓ | ✓ |   | ✓ |\n","| ES   | ✓ | ✓ |   | ✓ |\n","| JP   | ✓ | ✓ |   | ✓ |\n","| IN   | ✓ | ✓ |   | ✓ |\n","| MX   |   |   |   | ✓ |\n","| BR   |   |   |   | ✓ |\n","| NL   |   |   |   | ✓ |\n","| AU   |   |   |   | ✓ |\n","| TR   |   |   |   |   |\n","| SA   |   |   |   |   |\n","| SE   |   |   |   |   |\n","| AE   |   |   |   |   |\n"," Description: The list of identifiers of the advertised product categories for the forecast.\n"," Accepted Values: Find the advertised product category IDs in the DSP ListAdvertisedProductCategories API.\n"," Requirements:\n"," Example:\n"," Description: The limit of how many times ads appear to the same viewer.\n"," Accepted Values:\n"," Example:\n"," The rule of frequencyCap:\n","Do not pass maxImpressions, timeUnitCount, and timeUnit if type is UNCAPPED. - Frequency cap is not supported for supplies: SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_BRANDS_VIDEO, SPONSORED_DISPLAY.\n"," Description: For targeting specific audiences.\n"," Accepted Values: Find audience IDs at the Audiences Discovery API.\n"," Example:\n"," Rules of combining multiple audience targets:\n","Included groups are joined by an intersection. Users must be in all the groups specified to be included. - Audiences within an inclusion group are joined by OR/ANY logic. Audiences within the exclusion group are joined by AND/ALL logic. This means that users can be in any of the audiences inside a group to be included or excluded. - All audiences within the same group must either be included or excluded. - You can specify up to 10 groups to be included, but only 1 group to be excluded. - Up to 500 audience IDs can be specified per group. - To add audiences to a new group, choose any string not currently being used on this forecast. - To add audiences to an existing group, use the existing groupId from this forecast. You may specify up to 10 include groups and 1 exclude group.\n"," Description: Include/exclude content based on genre.\n"," Accepted Values:\n"," Example:\n"," Description: Exclude content based on available content rating options.\n"," Accepted Values:\n"," Example:\n"," Detailed explanation of each content rating:\n","SUITABLE_FOR_ALL_AUDIENCES: Equivalent to content that is rated G (film), TV-Y (TV), TV-Y7 (TV), TV-G (TV), EC (game), or E (game). - SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE: Equivalent to content that is rated PG (film), TV-PG (TV), or E-10+ (game). - SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES: Equivalent to content that is rated PG-13 (film), TV-14 (TV), or T (game). - SUITABLE_FOR_MATURE_AUDIENCES: Ages 17+. Equivalent to content that is rated R (film), TV-MA (TV), or M (game). - SUITABLE_FOR_ADULTS: Ages 18+. Equivalent to content that is rated NC-17 (film). - RATING_NOT_AVAILABLE: Content where the rating is not available from the publisher.\n"," Description: The type of device being targeted.\n"," Accepted Values:\n"," Example:\n"," Description: For targeting an ASIN category.\n"," Accepted Values: Find the ASIN category ID at the Product-Targeting ASIN Categories API.\n"," Example:\n"," Description: For targeting a specific product ASIN.\n"," Accepted Values:\n"," Example:\n"," Description: For targeting a specific location.\n"," Accepted Values: Find the location ID at the GeoLocations API.\n"," Example:\n"," Description: For targeting an inventory source. Currently, the API supports DSP Deal and 3P Publishers. Forecasting with publisher targeting is scoped to only streaming TV inventory.\n"," Accepted Values:\n"," Choose one of the following inventory source types:\n"," Requirements:\n"," Example (Deal):\n"," Example (Publisher):\n"," Description: For targeting specific keywords related to products.\n"," Accepted Values:\n"," Requirements:\n","Must include target bid information (bid price and currency code) - Must be used with product targeting (ProductTargetV1) - Only supported for supplies: SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_BRANDS_VIDEO\n"," Detailed explanation of Match Type:\n","BROAD: Provides the widest exposure to search queries. Search terms may include keyword terms in any order, and may also include singulars, plurals, variations, synonyms, and related terms. - PHRASE: Search terms must contain the exact phrase or sequence of words. More restrictive than broad match and includes plural forms of the keyword. In some campaign types, it may also include search terms matching the meaning of the keyword. - EXACT: The most restrictive match type where search terms must exactly match the keyword or close variations. The sequence of words must also match exactly.\n"," Example:\n"," Description: For targeting automatically generated keywords related to brands or landing pages.\n"," Accepted Values:\n"," Requirements:\n","Must include target bid information (bid price and currency code) - Must be used with product targeting (ProductTargetV1) - Only supported for supplies: SPONSORED_BRANDS, SPONSORED_BRANDS_VIDEO\n"," Match Type Explanation:\n","KEYWORDS_RELATED_TO_YOUR_BRAND: Targets keywords related to the brand. - KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES: Targets keywords related to the content on the landing pages.\n"," Example:\n"," In this example, the request creates a reach forecast with the following settings.\n","Specifying a frequency cap. - Exclude a list of content rating. - Target a audiences expressions of the form of include ((a1, a2) and (a3, a4)) AND exclude (a5, a6).\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":3,"text":"Response body"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" Details of response body:\n","Because this API is a batch API, all success responses will be grouped in the success array with the index matching the index of request input.  The SUCCESS status indicates that the forecast is generated successfully. The EXPIRED status indicates that the forecasted data is not up-to-date. In this case, generate a new forecast.  The countryCode is the targeted country of this forecast, which is tied to the account/API client ID that you are using for calling the API.  The currencyCode is the currency for all the monetary values in the request and response. For each countryCode, only the default currencyCode in that country/market is supported.  The dataPoints array contains the reach curve.\n"," The key component in the response body is ReachCurveDataPointV1, where the reach number is the forecasted reach assuming a certain number of impressions are delivered.\n"," Sample response\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":3,"text":"SLOs"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" Generating a single reach forecast can take around 8 ~ 30s. The P99 latency for generating a forecast is 25s.\n"," The maximum number of calls supported per account per second is 1.\n","Maximum date range supported: 6 months. \\* Maximum end date supported: 600 days from the date of calling.\n"," Forecasts will be saved for every request, but there is no guarantee on long-term storage for these records. API integrators should not rely on this storage for long-term records.\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":2,"text":"Create Deduplicated Reach Forecasts"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" Endpoint: POST /mediaPlan/v1/deduplicatedReachForecasts\n"," This API is used to create a list of De-duplicated Reach Forecasts.\n"," Each deduplication call must contain at least two Reach Forecast IDs.\n"," Each reachForecastId represents a unique request with deliveryType, supply, and targets.\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":3,"text":"Request Body"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" All the fields shown below are mandatory for creating the de-duplicated reach forecast. Currently, a maximum of 5 sub-requests is allowed in the deduplicatedReachForecasts list at a time. Each sub-request allows a maximum of 100 valid Reach Forecast IDs.\n"," Sample request\n"," The following sections provide in-depth details about each parameter you need to interact with while calling the reach forecasting API. These explanations are designed to help you understand request structure, functionality, and best practices.\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":3,"text":"Parameters"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" Description: The identifier of the Reach Forecast that the specified budget is allocated to.\n"," Accepted Values: The reachForecastId values you provide must be valid IDs obtained from the response of Create reach forecasts.\n"," Example:\n"," Limitations of Reach Forecast IDs in Deduplicated Reach Forecasts API:\n","Targets must be the same between each Reach Forecast ID.\n","If supplies are the same between each reachForecastId, deliveryType must be different.\n","If supplies are different between each reachForecastId, no limitations for deliveryType.\n"," Description: The reach number of the selected data point of the reach forecast.\n"," Accepted Values: Integer number\n"," Example:\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":3,"text":"Response body"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" Details of response body:\n","Since this API is a batch API, all successful responses will be grouped in the success array with the index matching the index of request input.  The deduplicatedReachForecastId is the unique identifier of the Deduplicated Reach Forecast resource.  The deduplicatedReach is the forecasted deduplicated reach.\n"," Sample response\n"],"documentType":"guide"},{"title":"Getting started with the reach forecasting API","sectionHeader":{"type":3,"text":"SLOs"},"path":"/en-us/guides/media-planning/reach-forecasting/get-started","content":[" Generating the de-duplicated reach forecast can take around 5 ~ 20s. The P99 latency for generating a de-duplicated reach forecast is 16s.\n"],"documentType":"guide"},{"title":"Performance forecasting API Overview","sectionHeader":null,"path":"/en-us/guides/media-planning/performance-forecasting/overview","content":[" The Performance Forecasting API allows integrators to generate performance forecasts against inventory that is available to buy, while taking into account brand and campaign parameters.\n"],"documentType":"guide"},{"title":"Performance forecasting API Overview","sectionHeader":{"type":2,"text":"Where is the performance forecasting API available?"},"path":"/en-us/guides/media-planning/performance-forecasting/overview","content":["North America: United States, Canada, Mexico - South America: Brazil - Europe: Germany, Spain, France, Italy, Netherlands, United Kingdom, Sweden, Turkey - Middle East: Saudi Arabia, United Arab Emirates - Asia Pacific: Australia, India, Japan\n"],"documentType":"guide"},{"title":"Performance forecasting API Overview","sectionHeader":{"type":2,"text":"FAQ"},"path":"/en-us/guides/media-planning/performance-forecasting/overview","content":[],"documentType":"guide"},{"title":"Performance forecasting API Overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/media-planning/performance-forecasting/overview","content":[],"documentType":"guide"},{"title":"Getting started with the performance forecasting API","sectionHeader":null,"path":"/en-us/guides/media-planning/performance-forecasting/get-started","content":[],"documentType":"guide"},{"title":"Getting started with the performance forecasting API","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/media-planning/performance-forecasting/get-started","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in this tutorial.\n"],"documentType":"guide"},{"title":"Getting started with the performance forecasting API","sectionHeader":{"type":2,"text":"Endpoints by Regions"},"path":"/en-us/guides/media-planning/performance-forecasting/get-started","content":["| URL                               | Region         | Marketplaces                                                                                                                                                                                                    |\n","\\|---------------------------------------\\|--------------------\\|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|\n","| https&#x3A;//advertising-api.amazon.com    | North America (NA) | United States (US), Canada (CA), Mexico (MX), Brazil (BR)                                                                                                                                                           |\n","| https&#x3A;//advertising-api-eu.amazon.com | Europe (EU)        | United Kingdom (GB), France (FR), Italy (IT), Spain (ES), Germany (DE), Netherlands (NL), United Arab Emirates (AE), Poland (PL), Turkey (TR), Egypt (EG), Saudi Arabia (SA), Sweden (SE), Belgium (BE), India (IN) |\n","| https&#x3A;//advertising-api-fe.amazon.com | Far East (FE)      | Japan (JP), Australia (AU), Singapore (SG)                                                                                                                                                                          |\n"],"documentType":"guide"},{"title":"Getting started with the performance forecasting API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/media-planning/performance-forecasting/get-started","content":[" Before using the performance forecasting API, ensure you understand the following APIs:\n","| API                                                                                                                                  | Description                                                                                                                                                                                        | Use case                                                                                                                                                                        |\n","\\|--------------------------------------------------------------------------------------------------------------------------------------\\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|\n","| Profiles API                                                                                 | The profile ID in the Amazon Ads API corresponds to accounts in the Amazon Ads console. A separate account is established for each marketplace. Profiles play a crucial role in making successful calls.  | Users must provide the profile ID for the request header parameter Amazon-Advertising-API-Scope.                                                                              |\n","| Advertisers API                                    | Returns the list of advertiser IDs that you have access to.                                                                                                                                        | Users can optionally provide an advertiser ID for the request header parameter Amazon-Ads-AccountId.                                                                          |\n","| Advertised Product Categories Discovery API                                           | Provides you with a list of advertised product categories to be used for generating performance forecasts.                                                                                               | Users are required to call this API to get a list of valid advertised product categories and pass the id values from that list through the advertisedProductCategoryIds list.    |\n","| Audiences Discovery API                                                           | Provides you with audiences that you can target.                                                                                                                                                    | Users are required to call this API to get a list of accessible audiences to pass the audienceId values through AudienceTargetV1 in the targets list.     |\n","| GeoLocations API                                                            | Returns the list of all targetable locations.                                                                                                                                                       | Users are required to call this API to get a list of locations to pass the id values through LocationTargetV1 in the targets list.                                  |\n","| Product-Targeting ASIN Categories API | Returns all targetable categories. This API returns a large JSON string containing a tree of category nodes. Each category node has the fields - category ID, category name, and child categories. | Users are required to call this API to get a list of product category IDs in order to pass the id values through ProductCategoryTargetV1 in the targets list.               |\n","| Product Metadata API                                                                                             | Returns product metadata for the advertiser, which contains ASIN values in the response.                                                                                                                 | Users are required to call this API to get a list of ASIN strings to pass the ASIN values through ProductTargetV1 in the targets list.                             |\n"],"documentType":"guide"},{"title":"Getting started with the performance forecasting API","sectionHeader":{"type":2,"text":"Header parameters"},"path":"/en-us/guides/media-planning/performance-forecasting/get-started","content":["| Header                          | Description                                                                                                                                                                                                                                                              | Example                                              |\n","\\|---------------------------------\\|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|------------------------------------------------------\\|\n","| Amazon-Advertising-API-ClientId\\* | The identifier of a client associated with an Amazon Developer account.                                                                                                                                                                                                  | amzn1.application-oa2-client.abcdef123456ghijkkl7890 |\n","| Amazon-Advertising-API-Scope\\*    | The identifier of a profile associated with the advertiser account. Use the GET method on the Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header, and choose the profileId from the response to pass as input. | 123123123123123                                      |\n","| Authorization\\*                   | Login with Amazon token in the form of Bearer {{token}}.                                                                                                                                                                                                                | Bearer AtzaIwEBIIR1q...                              |\n","| Amazon-Ads-AccountId             | The account identifier used to access the DSP. This is your Amazon DSP Advertiser ID.                                                                                                                                                                                    | 898989898989                                         |\n","| Accept                           | application/json                                                                                                                                                                                                                                                         | application/json                                     |\n","| Content-Type                     | application/json                                                                                                                                                                                                                                                         | application/json                                     |\n"],"documentType":"guide"},{"title":"Getting started with the performance forecasting API","sectionHeader":{"type":2,"text":"Generate Performance Forecasts"},"path":"/en-us/guides/media-planning/performance-forecasting/get-started","content":[" Endpoint: POST /mediaPlan/v1/performanceForecasts\n"," The table below outlines the valid input combinations. Please review this table carefully before making API calls to ensure compliance with accepted values.\n","| Supply Package                        | Delivery Type                                       | Country Code                                                       | Device Type                                     | Supported Performance Metrics | Supported Targeting Combinations |\n","\\|---------------------------------------\\|-----------------------------------------------------\\|--------------------------------------------------------------------\\|-------------------------------------------------\\|---------------------\\|-----------------------------------\\|\n","| DSP_STREAMING_TV                      | GUARANTEED                                          | US, GB, DE, CA, MX                                                | CONNECTED_TV, DESKTOP, MOBILE                   | CLICK, VIDEO_COMPLETION, DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| DSP_AUDIO                             | GUARANTEED                                          | US, CA, MX, GB, DE, IT                                             | CONNECTED_TV, DESKTOP, MOBILE                   | DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| DSP_PRIME_VIDEO                       | GUARANTEED                                          | US, CA, MX, BR, GB, DE, FR, IT, ES, AU, JP, IN                    | CONNECTED_TV, DESKTOP, MOBILE                   | CLICK, VIDEO_COMPLETION, DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| DSP_TWITCH_VIDEO                      | GUARANTEED                                          | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | CONNECTED_TV, DESKTOP, MOBILE                   | CLICK, VIDEO_COMPLETION, DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| SPONSORED_PRODUCTS                    | NON_GUARANTEED                                      | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported                                   | CLICK, DETAIL_PAGE_VIEW | 1. LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| SPONSORED_BRANDS                      | NON_GUARANTEED                                      | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported                                   | CLICK, DETAIL_PAGE_VIEW | 1. LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| SPONSORED_BRANDS_VIDEO                | NON_GUARANTEED                                      | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported                                   | CLICK, VIDEO_COMPLETION, DETAIL_PAGE_VIEW | 1. LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| SPONSORED_DISPLAY                     | NON_GUARANTEED                                      | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported                                   | CLICK, DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| DSP_OLV                               | NON_GUARANTEED                                      | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | CONNECTED_TV, DESKTOP, MOBILE                   | CLICK, VIDEO_COMPLETION, DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| DSP_STREAMING_TV                      | NON_GUARANTEED                                      | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | CONNECTED_TV, DESKTOP, MOBILE                   | CLICK, VIDEO_COMPLETION, DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| DSP_AUDIO                             | NON_GUARANTEED                                      | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | CONNECTED_TV, DESKTOP, MOBILE, CONNECTED_DEVICE | DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| DSP_DISPLAY                           | NON_GUARANTEED                                      | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported                                   | CLICK, DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| DSP_TWITCH_VIDEO                      | NON_GUARANTEED                                      | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | CONNECTED_TV, DESKTOP, MOBILE                   | CLICK, VIDEO_COMPLETION, DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, DeviceTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| DSP_TWITCH_DISPLAY                    | NON_GUARANTEED                                      | US, CA, MX, BR, GB, DE, FR, IT, ES, SE, IN, SA, TR, AE, NL, JP, AU | Not Supported                                   | CLICK, DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n","| DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY | Refer to Support by Country, Supply Package, DeliveryType   | Refer to Support by Country, Supply Package, DeliveryType                   | Not Supported                                   | CLICK, DETAIL_PAGE_VIEW | 1. AudienceTargetV1, ContentGenreTargetV1, ContentRatingTargetV1, LocationTargetV12. ProductCategoryTargetV13. ProductTargetV1 |\n"],"documentType":"guide"},{"title":"Getting started with the performance forecasting API","sectionHeader":{"type":3,"text":"Request Body"},"path":"/en-us/guides/media-planning/performance-forecasting/get-started","content":[" All the fields shown below are mandatory for generating a performance forecast. Currently, a maximum of 5 sub-requests is allowed in the performanceForecasts list at a time.\n"],"documentType":"guide"},{"title":"Getting started with the performance forecasting API","sectionHeader":{"type":3,"text":"Parameters"},"path":"/en-us/guides/media-planning/performance-forecasting/get-started","content":[" The following sections provide in-depth details about each parameter you might need to interact with while calling our API. These explanations are designed to help you understand request structure, functionality, and best practices.\n"," Description: API callers are required to provide a country code for each forecast.\n"," Accepted Values:\n"," Example:\n"," Description: Defines the date range for the forecast.\n"," Requirements:\n","Must be in YYYY-MM-DD format. - Both dates must be in the future. - Start date must be at least tomorrow, with tomorrow calculated based on UTC time zone. - End date must be after the start date.\n"," Example:\n"," Description: A specific supply package you want to target.\n"," Accepted Values: A list of SupplyV1.\n"," Currently, we support supplyPackage with\n","single SupplyV1 - multiple supplies for Guaranteed STV+ (DSP_STREAMING_TV with any combination of DSP_TWITCH_VIDEO, DSP_PRIME_VIDEO) - multiple supplies for connected devices Guaranteed and Non-Guaranteed (any combination of DSP_FIRE_TV, DSP_FIRE_TABLET, DSP_ALEXA_DISPLAY, DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY).\n"," Examples:\n"," Any single supplyPackage with a single supply.\n"," STV+\n"," Connected Devices\n"," Description: Specifies the delivery mode for the performance forecast.\n"," Accepted Values: GUARANTEED, NON_GUARANTEED\n"," Example:\n"," Support for supply package other than Connected Devices:\n","For the Non-Guaranteed delivery type, all countries and supplies are supported except DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY. - For DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY, please refer to the table Countries/Delivery Types Availability for Connected Devices below. - For the Guaranteed delivery type, support for different supplies varies by country. Below are the supported countries for each supply:\n"," Support for Connected Devices (DSP_FIRE_TV_FIRE_TABLET_ALEXA_DISPLAY):\n","| CountryCode |MANAGED_SERVICE  GUARANTEED | MANAGED_SERVICE  NON_GUARANTEED | SELF_SERVICE  GUARANTEED | SELF_SERVICE  NON_GUARANTEED |\n","\\| :--- \\| :----: \\| :----: \\| :----:\\| :----: \\|\n","| US   | ✓ | ✓ |   | ✓ |\n","| CA   | ✓ | ✓ |   | ✓ |\n","| GB   | ✓ | ✓ |   | ✓ |\n","| DE   | ✓ | ✓ |   | ✓ |\n","| FR   | ✓ | ✓ |   | ✓ |\n","| IT   | ✓ | ✓ |   | ✓ |\n","| ES   | ✓ | ✓ |   | ✓ |\n","| JP   | ✓ | ✓ |   | ✓ |\n","| IN   | ✓ | ✓ |   | ✓ |\n","| MX   |   |   |   | ✓ |\n","| BR   |   |   |   | ✓ |\n","| NL   |   |   |   | ✓ |\n","| AU   |   |   |   | ✓ |\n","| TR   |   |   |   |   |\n","| SA   |   |   |   |   |\n","| SE   |   |   |   |   |\n","| AE   |   |   |   |   |\n"," Description: A performance metric to provide forecast curve for.\n"," Accepted Values: Any string from the following enum:\n"," Description: The list of identifiers of the advertised product categories for the forecast.\n"," Accepted Values: Find the advertised product category IDs in DSP ListAdvertisedProductCategories API.\n"," Requirements:\n"," Example:\n"," Description: The limit of how many times ads appear to the same viewer.\n"," Accepted Values:\n"," Example:\n"," The rule of frequencyCap:\n","Do not pass maxImpressions, timeUnitCount, and timeUnit if type is UNCAPPED. - Frequency cap is not supported for supplies: SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_BRANDS_VIDEO, SPONSORED_DISPLAY.\n"," Description: The bidding information used for forecasting. This is an optional field and if it is not provided, then default values based on historical measurements will be used. For more accurate forecasts, users should provide the bidding info.\n"," Accepted Values:\n"," Detailed explanation for each field: - maxCpc: The maximum cost per click - maxAvgCpm: The maximum average cost per mille - maxVCpm: The maximum viewable cost per mille\n"," Description: For targeting specific audiences.\n"," Accepted Values: Find audience IDs at Audiences Discovery API.\n"," Example:\n"," Rules of combining multiple audience targets:\n","Included groups are joined by an intersection. Users must be in all the groups specified to be included. - Audiences within an inclusion group are joined by OR/ANY logic. Audiences within the exclusion group are joined by AND/ALL logic. This means that users can be in any of the audiences inside a group to be included or excluded. - All audiences within the same group must either be included or excluded. - You can specify up to 10 groups to be included, but only 1 group to be excluded. - Up to 500 audience IDs can be specified per group. - To add audiences to a new group, choose any string not currently being used on this forecast. - To add audiences to an existing group, use the existing groupId from this forecast. You may specify up to 10 include groups and 1 exclude group.\n"," Description: Include/exclude content based on genre.\n"," Accepted Values:\n"," Example:\n"," Description: Exclude content based on available content rating options.\n"," Accepted Values:\n"," Example:\n"," Detailed explanation of each content rating:\n","SUITABLE_FOR_ALL_AUDIENCES: Equivalent to content that is rated G (film), TV-Y (TV), TV-Y7 (TV), TV-G (TV), EC (game), or E (game). - SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE: Equivalent to content that is rated PG (film), TV-PG (TV), or E-10+ (game). - SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES: Equivalent to content that is rated PG-13 (film), TV-14 (TV), or T (game). - SUITABLE_FOR_MATURE_AUDIENCES: Ages 17+. Equivalent to content that is rated R (film), TV-MA (TV), or M (game). - SUITABLE_FOR_ADULTS: Ages 18+. Equivalent to content that is rated NC-17 (film). - RATING_NOT_AVAILABLE: Content where the rating is not available from the publisher.\n"," Description: The type of device being targeted.\n"," Accepted Values:\n"," Example:\n"," Description: For targeting an ASIN category.\n"," Accepted Values: Find the ASIN category ID at Product-Targeting ASIN Categories API.\n"," Example:\n"," Description: For targeting a specific product ASIN.\n"," Accepted Values:\n"," Example:\n"," Description: For targeting a specific location.\n"," Accepted Values: Find the location id at GeoLocations API.\n"," Example:\n"," Description: For targeting specific keywords related to products.\n"," Accepted Values:\n"," Requirements:\n","Must include target bid information (bid price and currency code) - Must be used with product targeting (ProductTargetV1) - Only supported for supplies: SPONSORED_PRODUCTS, SPONSORED_BRANDS, SPONSORED_BRANDS_VIDEO\n"," Detailed explanation of Match Type:\n","BROAD: Provides the widest exposure to search queries. Search terms may include keyword terms in any order, and may also include singulars, plurals, variations, synonyms, and related terms. - PHRASE: Search terms must contain the exact phrase or sequence of words. More restrictive than broad match and includes plural forms of the keyword. In some campaign types, it may also include search terms matching the meaning of the keyword. - EXACT: The most restrictive match type where search terms must exactly match the keyword or close variations. The sequence of words must also match exactly.\n"," Example:\n"," Description: For targeting automatically generated keywords related to brands or landing pages.\n"," Accepted Values:\n"," Requirements:\n","Must include target bid information (bid price and currency code) - Must be used with product targeting (ProductTargetV1) - Only supported for supplies: SPONSORED_BRANDS, SPONSORED_BRANDS_VIDEO\n"," Match Type Explanation:\n","KEYWORDS_RELATED_TO_YOUR_BRAND: Targets keywords related to the brand. - KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES: Targets keywords related to the content on the landing pages.\n"," Example:\n"," In this example, we will create a performance forecast with the following settings.\n","Specifying a frequency cap. - Exclude a list of content ratings. - Target audience expressions of the form of include ((a1, a2) and (a3, a4)) AND exclude (a5, a6).\n"],"documentType":"guide"},{"title":"Getting started with the performance forecasting API","sectionHeader":{"type":3,"text":"Response body"},"path":"/en-us/guides/media-planning/performance-forecasting/get-started","content":[" Details of response body:\n","Because this API is a batch API, all success responses will be grouped in the success array with the index matching the index of request input.  The countryCode is the targeted country of this forecast, which is tied to the account/API client ID that you are using for calling the API.  The currencyCode is the currency for all the monetary values in the request and response. For each countryCode, we support only the default currencyCode in that country/market.  The performanceMetric is the performance metric that was requested in this request.  The dataPoints array contains the forecasted performance curve.\n"," The key component in the response body is PerformanceCurveDataPointV1 as below, which specifies the spend and prediction for the requested performance metric. Additionally, it includes any other relevant measurements for the requested metric.\n"," Detailed explanation for each entry:\n","spend: The money spent in the provided currency (specified in the response) - prediction: The forecasted count for the requested performance metric - ecpm: Effective cost per mille - cpc: Cost per click - ctr: Click-through rate - cpdpv: Cost per detail page view - cpvc: Cost per video completion  - vcr: Video completion rate\n"," Sample response when performance metric is CLICK:\n"," Sample response when performance metric is VIDEO_COMPLETION:\n"," Sample response when performance metric is DETAIL_PAGE_VIEW:\n"],"documentType":"guide"},{"title":"Getting started with the performance forecasting API","sectionHeader":{"type":3,"text":"SLOs"},"path":"/en-us/guides/media-planning/performance-forecasting/get-started","content":[" Generating a single performance forecast can take around 8 ~ 29s. The P99 latency for generating a forecast is 25s.\n","Maximum date range supported: 18 months. \\* Maximum end date supported: Must fall within 18 months from the current month (inclusive).\n"],"documentType":"guide"},{"title":"Linear TV Incremental Reach API Overview","sectionHeader":null,"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/overview","content":[" The Linear TV Incremental Reach API provides insights to understand how traditional Linear TV campaigns perform and how much incremental reach can be achieved by adding Streaming TV Ads Products.\n"],"documentType":"guide"},{"title":"Linear TV Incremental Reach API Overview","sectionHeader":{"type":2,"text":"Where is the Linear TV Incremental Reach API available?"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/overview","content":["North America: United States, Canada\n"],"documentType":"guide"},{"title":"Linear TV Incremental Reach API Overview","sectionHeader":{"type":2,"text":"FAQ"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/overview","content":[],"documentType":"guide"},{"title":"Linear TV Incremental Reach API Overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/overview","content":[],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":null,"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" This guide walks you through the process of using the Linear TV Incremental Reach API, which helps you forecast and compare the reach of Linear TV advertising with Streaming TV advertising campaigns.\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your access token and profile ID. You will need these to make all the calls referenced in this tutorial.\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":2,"text":"Endpoints by Regions"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":["| URL                               | Region         | Marketplaces                          |\n","\\|---------------------------------------\\|--------------------\\|-------------------------------------------\\|\n","| https&#x3A;//advertising-api.amazon.com    | North America (NA) | United States (US), Canada (CA)           |\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" Before using the Linear TV Incremental Reach API, ensure you understand the following APIs:\n","| API                                                                                                                                  | Description                                                                                                                                                                                        | Use case                                                                                                                                                                        |\n","\\|--------------------------------------------------------------------------------------------------------------------------------------\\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|\n","| Profiles API                                                                                 | Profile ID in the Amazon Ads API correspond to accounts in the Amazon Ads console. A separate account is established for each marketplace. Profiles play a crucial role to make successful calls.  | Users must provide the profile ID for the request header parameter Amazon-Advertising-API-Scope.                                                                              |\n","| Advertisers API                                    | Returns the list of advertiser IDs that you have access to.                                                                                                                                        | Users can optionally provide an advertiser ID for the request header parameter Amazon-Ads-AccountId.                                                                          |\n","| Reach Forecasting API                                    | Generates reach forecast for your media planning with Streaming TV Ads Products. | Pass in the ID of reach forecasts for Streaming TV Ads Product from this API to compare with Linear TV performance.                                 |\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":2,"text":"Header parameters"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":["| Header                          | Description                                                                                                                                                                                                                                                              | Example                                              |\n","\\|---------------------------------\\|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\|------------------------------------------------------\\|\n","| Amazon-Advertising-API-ClientId\\* | The identifier of a client associated with an Amazon Developer account.                                                                                                                                                                                                  | amzn1.application-oa2-client.abcdef123456ghijkkl7890 |\n","| Amazon-Advertising-API-Scope\\*    | The identifier of a profile associated with the advertiser account. Use the GET method on the Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header, and choose the profileId from the response to pass as input. | 123123123123123                                      |\n","| Authorization\\*                   | Login with Amazon token in the form of Bearer {{token}}.                                                                                                                                                                                                                | Bearer AtzaIwEBIIR1q...                              |\n","| Amazon-Ads-AccountId\\*            | The account identifier used to access the DSP. This is your Amazon DSP Advertiser ID.                                                                                                                                                                                    | 898989898989                                         |\n","| Accept                           | application/json                                                                                                                                                                                                                                                         | application/json                                     |\n","| Content-Type                     | application/json                                                                                                                                                                                                                                                         | application/json                                     |\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":2,"text":"Query Linear TV Dayparts"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" Endpoint: POST /adsApi/v1/query/linearTvDayparts\n"," This endpoint allows you to discover available Linear TV daypart IDs that can be used in your Linear TV inventory allocation for Linear TV reach forecast requests.\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":3,"text":"Request Body"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" The example below retrieves a list of dayparts with the default page size of 20 for the marketplace you are advertising in.\n"," You can also use the maxResults and nextToken parameters to control pagination:\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":3,"text":"Response Body"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" A successful response contains a list of supported Linear TV dayparts for the marketplace if specified in the marketplace filter.\n"," To retrieve additional pages of results, include the nextToken value from the response in your next request. When nextToken is null, you have retrieved all available dayparts for your filter criteria.\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":2,"text":"Forecast Linear TV Reach"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" Endpoint: POST /adsApi/v1/create/linearTvReachForecasts\n"," This endpoint provides an estimate of how a Linear TV campaign might perform based on specified settings, such as flight dates and Linear TV daypart allocations.\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":3,"text":"Request Body"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" An example of request body.\n"," The request body accepts a list of forecast inputs (linearTvReachForecasts) and processes them in a batch. For each forecast, you need to specify the following parameters:\n","marketplace: The marketplace you are advertising in. - startDate and endDate: The flight dates of your Linear TV advertising campaign. - reachUnit: The unit of measurement for reach. Currently, only HOUSEHOLD is supported for forecasting household reach. - linearTvInventoryAllocation: The allocation of your Linear TV Ads spending measured by Gross Rating Point (grossRatingPoint).\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":3,"text":"Response Body"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" An example of response body.\n"," The response body is divided into error and success arrays, with indices corresponding to the order in the request body. For each successful forecast, the API returns a linearTvReachForecastId (for reference and debugging purposes) and a linearTvReachPercent indicating the estimated reach percentage.\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":2,"text":"Forecast Incremental Reach"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" Endpoint: POST /adsApi/v1/create/linearTvIncrementalReachForecasts\n"," This endpoint provides advertisers with a forecast of how much additional (incremental) reach their Streaming TV ads can generate beyond what their Linear TV campaign already achieves.\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":3,"text":"Request Body"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" An example of request body.\n"," The request body accepts a list of forecast inputs (linearTvIncrementalReachForecasts) and processes them in a batch. For each forecast, you need to specify the following parameters:\n","marketplace: The marketplace you are advertising in. - startDate and endDate: The flight dates of your Linear TV advertising campaign. - reachUnit: The unit of measurement for reach. Currently, only HOUSEHOLD is supported for forecasting household reach. - linearTvInventoryAllocation: The allocation of your Linear TV Ads spending measured by Gross Rating Points.\n","streamingTvBudgetAllocation: Details about your Streaming TV budget allocation. - linearTvReachPercentOverride: Optional. If you have your own measurement of your Linear TV Ads performance, you can override the system-calculated reach percentage with this value.\n"],"documentType":"guide"},{"title":"Getting started with the Linear TV Incremental Reach API","sectionHeader":{"type":3,"text":"Response Body"},"path":"/en-us/guides/media-planning/linear-tv-incremental-reach/get-started","content":[" An example of response body.\n"," The response body is divided into error and success arrays, with indices corresponding to the order in the request body. Each successful forecast includes a linearTvIncrementalReachForecastId for reference and debugging purposes.\n"," Key response metrics:\n"],"documentType":"guide"},{"title":"3rd Party Ad Servers (3PAS) overview","sectionHeader":null,"path":"/en-us/guides/3pas/overview","content":[],"documentType":"guide"},{"title":"3rd Party Ad Servers (3PAS) overview","sectionHeader":{"type":2,"text":"What is 3rd Party Ad Servers?"},"path":"/en-us/guides/3pas/overview","content":[" Third-Party Ad Servers (3PAS) are owned by external parties and are utilized by advertisers who aim to reach particular audiences and campaign goals with finer control over their creatives to interact with multiple publishers at once. These ad servers provide a crucial function by centralizing campaign management and measurement as ads appear and engage shoppers, streamers, and browsers across publisher sites. \n"," The Amazon Demand-Side Platform (DSP) supports the use of Third-Party Ad Servers (3PAS) to serve and measure third-party creatives for advertisers. This integration allows advertisers greater flexibility and control over their creative assets and performance measurement. This leads to greater efficiency, more precise measurement, and ultimately, improved marketing outcomes.  \\* \\* \n"],"documentType":"guide"},{"title":"3rd Party Ad Servers (3PAS) overview","sectionHeader":{"type":2,"text":"The 3PAS capabilities within Amazon DSP"},"path":"/en-us/guides/3pas/overview","content":[" Creative serving: Advertisers can upload their creative assets to a 3PAS platform, which then takes over the rendering, targeting, and reporting of those \"3P creatives\" across the various DSPs the advertiser is using. This simplifies the creative management process for the advertiser, as the 3PAS handles the technical details of displaying the ads. If an advertiser chooses to use a 3PAS for their creative serving, they will automatically gain access to the measurement functionality as well.\n"," Creative Performance Management: Advertisers can leverage a 1x1 pixel tag, also known as a 3P Impression Pixel, from their 3PAS. They then append this pixel tag to their first-party creatives within Amazon DSP and other DSPs. This allows the advertiser to monitor the performance of the same creative asset across multiple digital channels in an omni-channel approach. The 3P Impression Pixel provides additional measurement and attribution data that supplements the reporting available directly through the DSP.\n"],"documentType":"guide"},{"title":"3rd Party Ad Servers (3PAS) overview","sectionHeader":{"type":2,"text":"Integration Methods with Amazon DSP"},"path":"/en-us/guides/3pas/overview","content":[" Third-party ad servers can integrate with Amazon DSP through multiple methods: \n"," Third-Party Tags\n","Advertisers can use ad serving and tracking tags from certified third-party ad server providers when integrating with Amazon DSP. \\* This allows advertisers to leverage the features of their preferred third-party ad platform when running campaigns on Amazon DSP.\n"," In-Creative Pixels/Ad Tags\n","Advertisers can include impression and click tracking pixels or ad tags directly within their ad creatives. \\* This enables the third-party ad server to measure and report on the performance of those creatives when served through Amazon DSP.\n"],"documentType":"guide"},{"title":"3rd Party Ad Servers (3PAS) overview","sectionHeader":{"type":2,"text":"Use-Cases"},"path":"/en-us/guides/3pas/overview","content":["Server to Server (S2S)  Creative Scanning  Creative Tag Trafficking Automation  \n"],"documentType":"guide"},{"title":"3rd Party Ad Servers (3PAS) overview","sectionHeader":{"type":2,"text":"Supported Inventory"},"path":"/en-us/guides/3pas/overview","content":[" Amazon DSP supports 3P serving across the following broadly defined channels:\n","Amazon DSP desktop and mobile web static display ads   Online video (OLV)  Streaming TV & Prime Video \\* Twitch\n"],"documentType":"guide"},{"title":"3rd Party Ad Servers (3PAS) overview","sectionHeader":{"type":2,"text":"Resources"},"path":"/en-us/guides/3pas/overview","content":[],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":null,"path":"/en-us/guides/3pas/s2s-guide","content":[" Technical guide for integrating third-party ad serving and verification measurement through the Amazon server-to-server (S2S) ad serving proxy.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":2,"text":"Purpose"},"path":"/en-us/guides/3pas/s2s-guide","content":[" This document outlines the technical requirements for implementing server-to-server (S2S) integration with Amazon DSP for ad serving, measurement, and blocking functionalities. Through the proxy service (Skywave), it covers both creative serving and measurement implementations. The intended audience includes technical leaders and engineers responsible for third-party ad serving systems, measurement solutions, and blocking technologies. The specifications are generic and apply to both display and video ad formats.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":2,"text":"High-Level Architecture"},"path":"/en-us/guides/3pas/s2s-guide","content":[" In an Amazon S2S integration, there will be no direct communication between client and third-party partners - all communication between them will be proxied through Amazon proxy systems. Every creative served through the Amazon DSP must access third-party endpoints (both ad servers and measurement vendors) only through the Amazon domain. Any creative attempting to invoke third-party services through non-Amazon URLs will be invalidated. Refer to the diagrams below to understand the communication flow between Amazon and third-party partners (ad servers and measurement providers) before and after S2S integration.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":2,"text":"Amazon S2S Proxy Integration Components"},"path":"/en-us/guides/3pas/s2s-guide","content":[" The Amazon S2S integration infrastructure leverages two key Amazon proxy services to handle different types of ad serving requests. For dynamic requests, including creative fetch and measurement requests, the system utilizes Skywave - the Amazon real-time proxy service that provides request/response functionality while ensuring PII data protection. For static asset requests such as images and videos, the system employs the Amazon Content Delivery Network (CDN) as proxy CDN, which efficiently serves these assets while maintaining the performance benefits of distributed content delivery.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Proxy Service"},"path":"/en-us/guides/3pas/s2s-guide","content":[" Skywave is the Amazon globally distributed proxy service designed for optimal performance and reliability in handling dynamic ad serving requests. The service is deployed across multiple regions worldwide, ensuring low-latency response times and high availability for clients regardless of their geographic location. The Skywave infrastructure utilizes DNS-based latency routing, which automatically directs incoming requests to the nearest available Skywave endpoint. For every request, Skywave executes Amazon privacy policy related checks, cleans data to remove cookies and PII information from the request and augments the request with additional required context (using request headers or query parameters) before proxying the request to third-party endpoints.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Proxy CDN"},"path":"/en-us/guides/3pas/s2s-guide","content":[" The Amazon proxy CDN solution is built on CloudFront infrastructure and serves as an intermediary for static asset delivery in the S2S integration framework. This CDN setup leverages edge caching capabilities while maintaining seamless compatibility with third-party CDN functionalities. Requests for static assets will be served from proxy CDN edge cache if available. In case of a cache miss, proxy CDN will clean the request to remove cookies and PII data before sending the request to the third-party partner CDN and fetching the assets.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Lookup Data Sets Offline Ingestion"},"path":"/en-us/guides/3pas/s2s-guide","content":[" The Proxy service provides two distinct functional approaches for ingesting PII-based lookup datasets, enabling real-time data augmentation within Skywave. Third parties can utilize either approach independently or combine both methods to provide lookup datasets, depending on their specific data augmentation requirements for real-time request processing in Skywave. Refer to Remove Dependency on PII Data for details on how these data ingestion approaches support specific use-cases.\n"," This approach allows third parties to directly upload their lookup datasets to the designated S3 storage location. \n"," This approach implements a clean room architecture where request-level traffic data containing PII is stored securely, allowing third parties to bring their processing capabilities directly to the data. This clean room setup enables dynamic dataset generation within a controlled environment.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Interaction APIs"},"path":"/en-us/guides/3pas/s2s-guide","content":[" The proxy infrastructure provides HTTP based endpoints for handling creative fetch, measurement events and static asset requests.\n","| API | Endpoint |\n","\\|-----\\|----------\\|\n","| Creative fetch | https&#x3A;//vfw.amazon-adsystem.com/&lt;third-party-name>/&lt;third-party-path> |\n","| Measurement events | https&#x3A;//vfw-m.amazon-adsystem.com/&lt;third-party-name>/&lt;third-party-path> |\n","| Static asset requests | https&#x3A;//ts.amazon-adsystem.com/&lt;third-party-name>/&lt;third-party-path> |\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"S2S Tags"},"path":"/en-us/guides/3pas/s2s-guide","content":[" Below are the sample S2S tags that are used with display and video creatives for reference. Exact tags for advertiser usage will be provided after all the required configuration settings are enabled within proxy services for the third-party as part of Onboarding.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Display Tag Example:"},"path":"/en-us/guides/3pas/s2s-guide","content":[],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Video Tag Example:"},"path":"/en-us/guides/3pas/s2s-guide","content":[" During creative setup in Amazon DSP, advertisers must exclusively use the specified S2S tags, as standard third-party partner tags are no longer supported and will trigger creative setup errors. The Amazon validation system automatically verifies that all S2S tags include the required standard context through properly defined macros.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Macros"},"path":"/en-us/guides/3pas/s2s-guide","content":[" The new S2S integration maintains complete compatibility with all existing macros currently supported by the Amazon DSP platform, ensuring seamless transition and functionality preservation. New macros will be supported to pass geo related information. \n","\\[\\[AAX_3P_VENDOR_CONTEXT]] - Used to pass URL-safe encoded context from ad rendering flow\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":2,"text":"Onboarding"},"path":"/en-us/guides/3pas/s2s-guide","content":[],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Requirements"},"path":"/en-us/guides/3pas/s2s-guide","content":[" Skywave proxy operates on a strict allowlist-based functionality for managing third-party service communications. To establish successful S2S (Server-to-Server) integration, third parties must provide comprehensive details of their communication endpoints upfront. This includes endpoint specifications, header configurations, and data requirements that need to be proxied. The pre-configuration of this data is mandatory for the proxy server to correctly route requests and transmit the necessary data to third-party endpoints. Third parties are required to document and share detailed information about each endpoint, including its specific purpose and associated data requirements, as part of the onboarding process.\n"," The third-party will need to share details of all the lookup data sets that are required to be ingested for data augmentation by the proxy server in the real-time flow. This includes list of all the data sets, data format, size of data and update frequency. This information will be used to setup the required data ingestion pipeline configuration for ingesting the lookup datasets within Skywave.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":2,"text":"Work Required by Third-Party"},"path":"/en-us/guides/3pas/s2s-guide","content":[],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Update Creatives to Remove Direct Communication"},"path":"/en-us/guides/3pas/s2s-guide","content":[" Third-party partners must modify their processes to generate server-to-server (S2S) tags specifically for ADSP. Additionally, partners will be required to update their tag implementation to redirect all client-side communications through Amazon proxy systems, rather than allowing direct communication with partner endpoints. This involves updating the endpoint URLs within the creatives and scripts to point to Amazon endpoints.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Creative Variant Details"},"path":"/en-us/guides/3pas/s2s-guide","content":[" When retrieving creative content, Skywave makes HTTP calls to the third party endpoints. For proper tracking and monitoring of creative variants, the third party must include variant information within the HTTP response headers of their creative content responses. This header information enables Skywave to accurately track and record which specific creative variant is being rendered for each request.\n"," Response headers\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Remove Dependency on PII Data"},"path":"/en-us/guides/3pas/s2s-guide","content":[" With S2S integration, the proxy service will strip off all Personally Identifiable Information (PII) before forwarding the request to the third-party and ensure that client PII data is not egressed to the third-party. Skywave will use PII information from the request to lookup within offline ingested datasets and forward the anonymized classifications as Headers when proxying the requests to third-party endpoints.\n"," Application logic will need to be updated on the third-party side to no longer rely on PII and instead consume the signals from query parameters (macros) and the anonymized headers. The User-Agent header will continue to be shared as it is not classified as PII.\n"," Below are the sample headers for reference that will be included as part of the request sent from Skywave to the third-party endpoint. The exact list of headers along with the header names and format of the values are configurable within the proxy service based on the datasets and requirements of the third-party.\n"," The third-party can ingest IVT data sets (list of invalid IP/UA) that are generated on their side using the offline data set ingestion approach for Skywave to do real-time lookup and send categorisation information (IVT/non-IVT) for the PII data in the request based on the datasets provided for lookup. Similarly, if the third-party wants to use their own geo mapping functionality they can ingest offline IP address to geo mapping data sets which will be used by Skywave to do the lookup and augment the request with the geo data from the data set.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Propagate Context from Tag with Each Event"},"path":"/en-us/guides/3pas/s2s-guide","content":[" The client-side impression requests to the proxy service require comprehensive context inclusion through key-value pairs as defined in the initial S2S tag configuration. The implementation of the S2S tag must capture and transmit all specified key-value pairs, including vendor context (vfwctx) and GDPR-related information, with every network call to proxy services. For example, in the tag structure:\n"," During the ad rendering process, the Amazon AdServer automatically replaces the macro placeholders with actual values from the impression request. Consequently, all subsequent requests to the proxy service must include the complete set of parameters (key1, key2, vfwctx, gdpr, gdpr_consent) with their corresponding resolved values from the original S2S tag.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Provide Consent String with Each Measurement Signal"},"path":"/en-us/guides/3pas/s2s-guide","content":[" As a TCF-registered vendor, Amazon Advertising is required to comply with TCFv2 Policy. Under the policy, Amazon must not pass user PII to third party vendors where a consent signal shows that the user has objected to such vendor receiving their data. Below is an extract from section 16(17) of the Policy which supports this:\n"," Vendor can establish legal basis in the GVL through a legitimate interest using Special Purpose 1 (Ensure security, prevent fraud and debug). However, users may withhold consent at a vendor level. Similarly, a Publisher could object to vendor processing data for any/every purpose (including special purposes). In these cases, Amazon could be in breach of TCFv2 Policy if it were to perform the PII based lookups from offline ingested lookup datasets for the purpose of measurement/reporting.\n"," For example, with the below S2S tag:\n"," When Amazon DSP gets an ad request, it also gets the TC string sent by the CMP of the Publisher. If the above macros are present in the winning creative, Amazon DSP will replace them with the corresponding consent information received in the bid request. However, if these macros are absent, the third-party tag will have to rely on the CMP JS API on the publisher site to populate the required consent signal. The vendor measurement script will need to be updated to send gdpr_consent=&lt;actual consent value> with every request made to Skywave.\n"," Example:\n"," Skywave will process the parameters and will perform the necessary dataset lookups only if it evaluates that the vendor has the required GDPR legal basis (Consent/Legitimate interest) to process user data for this request. Otherwise, Skywave will proxy the request to the third-party endpoint without any data from lookup data sets.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Bypass Creative Blocking for ADSP Creative Preview Pages"},"path":"/en-us/guides/3pas/s2s-guide","content":[" Advertisers view their ads on ADSP Creative Preview pages while setting up their campaigns. Creatives configured with vendor blocking tags must always serve on ADSP creative preview pages so that advertisers can always view their ads during campaign set up. Skywave will send the x-purpose:Review header to signal to third-party endpoints that this is a Creative Preview request and the blocking tag functionality needs to be suppressed for this impression.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"Pre-hosting Static Measurement and Blocking Scripts on Amazon CDN"},"path":"/en-us/guides/3pas/s2s-guide","content":[" Amazon employs a controlled process for managing core measurement and blocking functionality scripts in the S2S integration. These scripts are hosted on the Amazon CDN after undergoing mandatory policy compliance checks through an offline validation process. Third-party partners can initiate script updates by uploading their static measurement and blocking scripts to a designated S3 bucket. To facilitate this process, partners must provide their AWS Account ID, after which Amazon creates a dedicated S3 bucket with appropriate upload permissions for the account of the vendor. Once scripts are uploaded, Amazon follows a systematic approach of ingestion, validation, and controlled release to ensure security and functionality.\n"],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":2,"text":"Testing S2S Integration"},"path":"/en-us/guides/3pas/s2s-guide","content":[],"documentType":"guide"},{"title":"3PAS Server-to-Server Integration Guide","sectionHeader":{"type":3,"text":"User Acceptance Testing"},"path":"/en-us/guides/3pas/s2s-guide","content":[],"documentType":"guide"},{"title":"3PAS Creative Scanning Guide","sectionHeader":null,"path":"/en-us/guides/3pas/cvs-guide","content":[" Technical guide for integrating creative variant discovery and scanning with Amazon DSP and third-party ad serving.\n"],"documentType":"guide"},{"title":"3PAS Creative Scanning Guide","sectionHeader":{"type":2,"text":"Purpose"},"path":"/en-us/guides/3pas/cvs-guide","content":[" This document outlines the technical requirements for implementing creative variant discovery when running creative tags with Amazon DSP and third-party ad serving. Creative variant discovery enables Amazon to ensure that creatives meet Amazon Ads quality and technical requirements, a process hereafter referred to as \"scanning\".\n"," The intended audience includes technical leaders and engineers responsible for third-party ad serving systems. The specifications are generic and apply to both display and video ad formats.\n"],"documentType":"guide"},{"title":"3PAS Creative Scanning Guide","sectionHeader":{"type":2,"text":"High-Level Architecture"},"path":"/en-us/guides/3pas/cvs-guide","content":[" There are two parts to the creative scanning integration: variant discovery and variant retrieval. Variant discovery allows Amazon to list all variants of a creative or placement, whilst variant retrieval provides the ad tag (\"markup\") for a variant so that it can be scanned.\n"," Variant discovery allows Amazon to perform ahead-of-time scanning, which means that Amazon Ads is less likely to take-down an in-flight creative if non-compliant variants are found. It also makes possible a separate API (not described in this document) whereby Amazon Ads reports back which variant(s) have failed scanning, making it easier for the advertiser to correct the creative and get it approved.\n"," The creative ID or placement ID used to retrieve variants from this service must be present in the ad tag itself. Amazon will parse the creative tag during scanning to find the creative ID, and then call the Variant Discovery Service.\n"," Amazon requires access to the ad tag markup (either HTML or VAST) to perform scanning, detailed in the Variant Tag Retrieval Override section.\n"," Amazon requires that variant content is immutable after first retrieval for scanning. Variant immutability allows Amazon to perform fewer scans of each variant. The set of variants that can be delivered for a creative does not need to be immutable, only the content of a single creative variant.\n"],"documentType":"guide"},{"title":"3PAS Creative Scanning Guide","sectionHeader":{"type":2,"text":"Variant Discovery Service"},"path":"/en-us/guides/3pas/cvs-guide","content":[" Amazon Ads requires that the third-party ad server create a service for discovering variants. This service must provide an operation to retrieve the variants for a creative or placement, given the corresponding creative or placement ID. This operation is described in the Variant Listing API section below.\n"," The examples given below use a JSON REST format. However, Amazon is flexible in that if an ad server has an existing service using a similar protocol (e.g., RPC, XML), Amazon will be able to implement the required calls to integrate with the existing service.\n"," Note that the specifications in this section use an illustrative IDL, and do not require any specific implementation to be used by the ad server.\n"],"documentType":"guide"},{"title":"3PAS Creative Scanning Guide","sectionHeader":{"type":3,"text":"Variant Listing API"},"path":"/en-us/guides/3pas/cvs-guide","content":[" The variant listing operation takes a creative or placement ID and returns a list of variants. Amazon calls this API when a creative is added to or modified in the DSP, and on an ongoing basis whilst a creative is serving (e.g., once per hour).\n"," Amazon scans landing pages as part of the approval process. This API requires the ad server to return the landing page(s) of each variant. Amazon may use this to reduce the total number of landing page hits, by approving landing pages separately from the variants themselves. If there is no landing page or click-through, then this field can be omitted. Amazon may independently verify this by testing the creative itself.\n"," When making calls to this API, Amazon does not use caching (e.g., via the use of etags), as the calls to the API will be infrequent.\n"," This operation is not expected to be paginated, as Amazon will always pull all variants. However, if pagination is present on an already existing API, then Amazon can work with the ad server to implement the correct calls.\n"," Note that Amazon expects that a placement ID will only return variants that are to serve through Amazon; variants that are not attached to an Amazon placement should not be returned.\n"],"documentType":"guide"},{"title":"3PAS Creative Scanning Guide","sectionHeader":{"type":2,"text":"Variant Tag Retrieval Override"},"path":"/en-us/guides/3pas/cvs-guide","content":[" During normal ad serving (i.e., not during scanning), Amazon delivers markup to an end-user browser, the content of which is just the ad server provided tag. When the browser loads this tag, a call is made to the third-party ad server, which then runs the decisioning logic on which variant to deliver.\n"," To facilitate scanning, Amazon will provide an extra HTTP header (X-Variant-ID), with the value containing the ID of the variant that Amazon wants to scan. Upon receiving this header, the ad server bypasses all decisioning logic and returns markup for the specified variant.\n"," This header will never be sent by an end-user browser, and so the normal serving flow is unaffected. The ad server is allowed to use this header to remove the impression from their accounting (i.e., mark it as invalid). Optionally, to ensure that this header is not used maliciously, Amazon is able to provide a second header with a shared secret, to identify that this scanning comes from Amazon.\n"," Many ad servers return a blank or otherwise erroneous tag when the creative is not in-flight on the ad server, for example returning an HTTP code 204 (no content) or 404 (not found). When the retrieval override is supplied, the ad server must return the content of the tag, regardless of whether or not it is in flight.\n"," An example request made to the ad server by the scanner (note that the scanner may send other headers, these are omitted for brevity):\n"," An example request made to the ad server by an end-user browser (note that the user-agent here is just an example; there will be other headers).\n"],"documentType":"guide"},{"title":"3PAS Creative Scanning Guide","sectionHeader":{"type":2,"text":"Security"},"path":"/en-us/guides/3pas/cvs-guide","content":[" Implementation of authentication and authorization for this API is within the remit of the third-party ad server to define. The authentication token may be used to identify that Amazon is calling the service, pursuant to fulfilling the requirement from the Variant Listing API to only return variants for Amazon placements.\n"," It is also acceptable by Amazon that the API is public and requires no authentication to use, as there is no Amazon customer data within the service.\n"],"documentType":"guide"},{"title":"3PAS Creative Scanning Guide","sectionHeader":{"type":2,"text":"Onboarding and Testing"},"path":"/en-us/guides/3pas/cvs-guide","content":[" During onboarding, Amazon will implement the required API calls and authentication as required. Ad servers should provide a testing environment for the service so that testing calls do not affect the production environment of the ad server. Amazon will use the testing environment to ensure scanning functions correctly in a testing environment. Amazon testers will require access to the testing environment to create creatives, placements and variants in order to fully exercise the system.\n"],"documentType":"guide"},{"title":"Creative Tag Trafficking Automation - 3PAS","sectionHeader":null,"path":"/en-us/guides/3pas/creative-tag-trafficking-automation","content":[],"documentType":"guide"},{"title":"Creative Tag Trafficking Automation - 3PAS","sectionHeader":{"type":2,"text":"Overview "},"path":"/en-us/guides/3pas/creative-tag-trafficking-automation","content":[" 3P ad serving (3PAS) partners along with creative management partners often have insight into the technical 3P tags that need to be leveraged by advertisers in the DSP.\n"," Manual trafficking of 3P tags can be problematic for a number of reasons: \n","These tags often need to be customized for the specific DSP they will be used in to properly implement DSP-specific macros, leverage appropriate encoding profiles, as well as other nuances.    These tags are often configured by one end user in the 3P environment, then handed off and added into the target DSP by a different end user.    End user handling of tags can introduce mistakes whether through copy / paste issues or programs inadvertently changing tags.  \\* Lack of visibility into issues with trafficked tags by the 3P. \n"," By offering an API integration option for 3PAS and Creative Management partners to directly transmit advertiser 3P tags to the DSP, we can remove much of this complexity and eliminate opportunities for mistakes from end users while shifting adherence to unique DSP spec requirements back to technical teams. We also provide a direct feedback loop back to the 3P to allow them to understand why tags are getting rejected, opening the door to monitoring of tag trafficking success rates. \n"," Important: Third Party Audio tags are not yet supported through the API. If you are certified for 3P audio, let your Amazon Ads representative know that you are interested in this feature. \n"],"documentType":"guide"},{"title":"Creative Tag Trafficking Automation - 3PAS","sectionHeader":{"type":2,"text":"Pre-requisites "},"path":"/en-us/guides/3pas/creative-tag-trafficking-automation","content":[" To implement 3P tag trafficking via APIs, the following pre-requisites are required: \n","Access to the Amazon Ads API  \\* A valid Ads API access token \n"],"documentType":"guide"},{"title":"Creative Tag Trafficking Automation - 3PAS","sectionHeader":{"type":3,"text":"Identify the profile "},"path":"/en-us/guides/3pas/creative-tag-trafficking-automation","content":[" To submit 3P tags, you must first know which Amazon Ads Profile you will be calling on behalf of. A profile represents an advertising account within a specific marketplace. For more information about accessing profiles, see the Retrieve a profile ID guide. \n"," If you already know which profile you need to be acting on behalf of, you can skip this step. Otherwise, you should retrieve a list of profiles with an account.type = agency, representative of a DSP account. \n"," If multiple profiles exist, you should prompt the end user to determine which profile should be leveraged. \n"],"documentType":"guide"},{"title":"Creative Tag Trafficking Automation - 3PAS","sectionHeader":{"type":3,"text":"Identify the advertiser "},"path":"/en-us/guides/3pas/creative-tag-trafficking-automation","content":[" To make calls to the ADSP creative management APIs, you will need to know the advertiser ID. If you do not already have this mapped for the existing user, the possible advertiser accounts can be found by calling the GET Advertiser endpoint and passing the target profile ID. If multiple advertiser accounts exist, you should again prompt the end user to select which advertiser account should be leveraged. \n"],"documentType":"guide"},{"title":"Creative Tag Trafficking Automation - 3PAS","sectionHeader":{"type":2,"text":"Creating an ad creative and ad experience "},"path":"/en-us/guides/3pas/creative-tag-trafficking-automation","content":[" With all the pre-requisites satisfied, you can now create an ad creative and ad experience representing the 3P tags. You can do this by following the Amazon DSP creative generation and management guide. \n","When creating the adCreative object, make sure to set the hostedType value to THIRD_PARTY_HOSTED.  \\* When creating the adExperience, make sure to set the adExperience value to THIRD_PARTY_VIDEO or THIRD_PARTY_DISPLAY.\n"," The output from this process is an adCreativeId. This adCreativeId should be stored within your system as the Amazon Ads ID for this creative, and can be used in the optional association steps. \n"," Once the Ad Experience has been set, the 3P tag will be visible within the ADSP advertiser account via the console.\n"],"documentType":"guide"},{"title":"Creative Tag Trafficking Automation - 3PAS","sectionHeader":{"type":2,"text":"Associating a creative to an ad group (optional) "},"path":"/en-us/guides/3pas/creative-tag-trafficking-automation","content":[" Once the creative exists in the advertiser DSP account, it can be associated to an ad group. If you know which ad group the creative should be associated to, you can perform this association by following the Ad Creative Association Creation Workflow as defined within the Amazon DSP creative associations guide. \n"],"documentType":"guide"},{"title":"Creative Tag Trafficking Automation - 3PAS","sectionHeader":{"type":2,"text":"Managing a creative association "},"path":"/en-us/guides/3pas/creative-tag-trafficking-automation","content":[],"documentType":"guide"},{"title":"Amazon DSP Macros","sectionHeader":null,"path":"/en-us/guides/3pas/dsp-macros","content":[" A macro is a placeholder that is replaced with real values when ads are served. This enables third parties to accurately perform certain functions, such as counting impressions and clicks. This guide lists the macros supported by Amazon DSP for use in third-party creatives.\n"],"documentType":"guide"},{"title":"Amazon DSP Macros","sectionHeader":{"type":2,"text":"Creative macros"},"path":"/en-us/guides/3pas/dsp-macros","content":[" The following macros can be used in the user input on the Amazon DSP Creative UI forms and may be passed in via creative APIs.\n","| Name | Macro | Description |\n","\\| --- \\| --- \\| --- \\|\n","| Random Number | {%random} | A comma-separated random number. Example: 1,234,567,890 |\n","|  | {%random_int} | A random number. Example: 1234567890 |\n","| Click Tracker Prefix | {%short_redirect} | The Amazon Click URL. Example: https&#x3A;//aax-us-east.amazon-adsystem.com/x/c/QsduDph0ucwOyS3CtMaORR4AAAFhAVKEbQEAAAH2AcHWNCg/ |\n","|  | {%short_redirect_urlEncode} | The URL-encoded Amazon Click URL. |\n","| Line Item ID | {%ad_cfid} | The line item ID as shown in the Amazon Ads console. |\n","| Order ID | {%campaign_cfid} | The Order ID as shown in the Amazon Ads console. |\n","| Creative ID | {%creative_cfid} | The Creative ID as shown in the Amazon Ads console. |\n","| Bid Request ID | {%request_arid} | The unique bid request ID generated by Amazon. |\n","| Bid Slot Width | {%request_slot_width} | The width of the bid slot in pixels. |\n","| Bid Slot Height | {%request_slot_height} | The height of the bid slot in pixels. |\n","| Bid Slot ID | {%request_bidId} | The unique ID of the bid slot generated by Amazon. |\n","| Nielsen DMA Code | \\[\\[CS_DMA_CODE]] | The Nielsen Designated Marketing Area (DMA) code, representing the location of the TV or radio market of a user. Not safe to use within a tracker URL. |\n","| Mobile App ID | ${appId!} | The Mobile App ID from the bid request. |\n","| Origin URL | ${originUrlDomain!} | The URL of the page where the ad will show up, specified in the bid request. |\n","| Timestamp | ${timestamp} | The timestamp of creative rendering in yyyy-MM-dd'T'HH:mm:ss'Z' format. Example: 2024-01-25T10:26:00Z. |\n"],"documentType":"guide"},{"title":"Amazon DSP Macros","sectionHeader":{"type":2,"text":"GDPR and regulatory macros"},"path":"/en-us/guides/3pas/dsp-macros","content":[" The following macros pass privacy and regulatory consent signals from the bid request into the creative.\n","| Name | Macro | Description |\n","\\| --- \\| --- \\| --- \\|\n","| Google ATP IDs | ${ADDTL_CONSENT} ${addtl_consent} | A string containing a list of user-consented and disclosed Google ATP IDs. |\n","| GDPR Enabled | ${GDPR} ${gdpr} | Whether or not GDPR applies to the bid request. gdpr=0 indicates GDPR does not apply. |\n","| GDPR Personal Data | ${GDPR_PD} ${gdpr_pd} | A flag in the bid request indicating whether or not generic URL parameters contain personal data. gdpr_pd=0 indicates none of them contain personal data. |\n","| GDPR Consent String | ${GDPR_CONSENT_XXXXX} | The GDPR TC string from the bid request, where XXXXX represents the vendor ID for which the consent is checked (e.g., ${GDPR_CONSENT_123} for vendor 123). |\n","| GPP Consent String | ${GPP} ${gpp} | The GPP consent string from the bid request. |\n","| GPP Section IDs | ${GPP_SID} | The list of GPP Section IDs in force for the current bid request. Typically contains a single section ID. |\n","| GPC Enabled | ${GPC} (Display only) | The preference of a user regarding the sharing and/or use of personal data by third parties. |\n"],"documentType":"guide"},{"title":"Amazon DSP Macros","sectionHeader":{"type":2,"text":"Definitions"},"path":"/en-us/guides/3pas/dsp-macros","content":[],"documentType":"guide"},{"title":"Click Tracker / Macro Integration","sectionHeader":null,"path":"/en-us/guides/3pas/click-tracker-macros","content":[" This guide explains the versions of the Amazon Ads click tracker macro and the supported methods for implementing it to redirect to a landing page or a subsequent click tracker.\n"],"documentType":"guide"},{"title":"Click Tracker / Macro Integration","sectionHeader":{"type":2,"text":"Click tracker macro versions"},"path":"/en-us/guides/3pas/click-tracker-macros","content":[" The click tracker macro comes in two versions, a non-encoded plain text version and a URL-encoded version for use in a query string.\n","| Macro Description | Macro | Use Case |\n","\\| --- \\| --- \\| --- \\|\n","| Plain text (non-encoded) | {%short_redirect} | Use this when the value will be placed directly into a click action (e.g., within an A tag). |\n","| URL Encoded | {%short_redirect_urlEncode} | Use this when the value will be added as a query string parameter value, and reserved URL characters need to be escaped. |\n"],"documentType":"guide"},{"title":"Click Tracker / Macro Integration","sectionHeader":{"type":2,"text":"Implementation"},"path":"/en-us/guides/3pas/click-tracker-macros","content":[" There are three ways to implement the Amazon Ads click tracker macro to redirect to a landing page or subsequent click tracker.\n"],"documentType":"guide"},{"title":"Click Tracker / Macro Integration","sectionHeader":{"type":3,"text":"Method 1: Directly pre-pend to URL"},"path":"/en-us/guides/3pas/click-tracker-macros","content":[" With this method, you append the target URL on to the end of the click macro URL without any query string, and without encoding the URL. For example:\n"," Important: Passing an encoded URL via this method will break the click tracker.\n"," The resulting expanded URL will look like:\n"],"documentType":"guide"},{"title":"Click Tracker / Macro Integration","sectionHeader":{"type":3,"text":"Method 2: Append via query string parameter"},"path":"/en-us/guides/3pas/click-tracker-macros","content":[" With this method, you first URL encode the landing page or target URL, then pass it via the r query string parameter. For example:\n"," The result after the click macro expands is:\n"],"documentType":"guide"},{"title":"Click Tracker / Macro Integration","sectionHeader":{"type":3,"text":"Method 3: Passing via query string parameter to another resource"},"path":"/en-us/guides/3pas/click-tracker-macros","content":[" If for some reason the click tracker needs to be passed to another resource, use the URL-encoded version to properly pass the click tracker URL to the next resource.\n"," The expanded value will look like this:\n"],"documentType":"guide"},{"title":"Postman tutorial","sectionHeader":null,"path":"/en-us/guides/postman","content":[" This tutorial describes how to set up the Amazon Ads API Postman collection. \n"],"documentType":"guide"},{"title":"Postman tutorial","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/postman","content":[" Decide what version of Postman you want to use. If you do not have a Postman account, you can download the desktop application. You can also create a free account and use the web application. \n"," This tutorial assumes you have already onboarded to the API and generated access and refresh tokens.\n"],"documentType":"guide"},{"title":"Postman tutorial","sectionHeader":{"type":2,"text":"Tutorial"},"path":"/en-us/guides/postman","content":[" File import and environment setup\n","Download the Postman environment file and collection file from GitHub. 2. Import both files into Postman. 3. From the Environments tab, select the Amazon Ads API Environment.  4. Add your auth credentials to the environment. Enter your credentials into the Current Value column for the following variables:\n","(Optional) Update the URL prefixes. In the downloaded file, api_url is populated with the North America URL. If the advertising account you are working with is located outside North America, update the api_url. See the API overview for available URLs by geography. \n","Save your changes to the environment.\n"," Get a fresh access token\n","From the Postman Collections tab, navigate to the Amazon Ads API collection. 8. Set the active environment to Amazon Ads API. 9. Open the POST Access token from refresh token endpoint. Hover over the {{refresh_token}}, {{client_id}}, and {{client_secret}} values to check that they are pulling in the right values from your environment.  10. Send the request. You should get a 200 OK response code.  11. Navigate back to your Amazon Ads API Environment. You should see a new Current Value for access_token, along with a timestamp in Current Value for token_expires_at. \n"," Get your profile ID\n","To make other calls using the API, you need a profile ID. If you know your profile ID, you can enter it directly into the profileId variable in the Amazon Ads API Environment. \n"," Now that your environment has a valid access token and profile ID, you are ready to make calls to the Amazon Ads API!\n"],"documentType":"guide"},{"title":"Postman tutorial","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/postman","content":[" Explore one of our tutorials: \n","Make your first call  Request a report  Request a snapshot\n"],"documentType":"guide"},{"title":"Postman tutorial","sectionHeader":{"type":2,"text":"Currently supported"},"path":"/en-us/guides/postman","content":[" The Amazon Ads API Postman collection currently supports the following features:\n","Authentication - Sponsored ads reporting - Sponsored ads snapshots  - Test accounts - Account management - Amazon Marketing Stream - Sponsored Products campaign management (version 3) - Product metadata - Sponsored Display (for non-Amazon sellers) - Budget usage - Budget rules - Exports - Partner opportunities\n"],"documentType":"guide"},{"title":"Postman tutorial","sectionHeader":{"type":2,"text":"Environment variable definitions"},"path":"/en-us/guides/postman","content":[" This table contains descriptions for all variables in the environment file. \n","| Variable | Description |\n","\\|----------\\|-------------\\|\n","| client_id | The client ID of an authorized Login with Amazon application. |\n","| client_secret | The client secret of an authorized Login with Amazon application. |\n","| permission_scope | The scope used to determine permissions for your account. For general API use, keep the default value as advertising::campaign_management. |\n","| redirect_uri | Enter the URL included in the Allowed Return URLs configuration of a Login with Amazon application. Set to https&#x3A;//amazon.com by default; enable this URL in Login with Amazon. |\n","| access_token | The access token used to authenticate your API calls. Each token is valid for 60 minutes. |\n","| refresh_token | The token used to refresh your access token. |\n","| token_expires_at | The timestamp at which an access token expires. |\n","| profileId | The profile ID associated with your Amazon Ads account. |\n","| auth_grant_url | The URL prefix used for auth calls. |\n","| token_url | The URL prefix used for token calls. |\n","| api_url | The URL prefix used for general API calls. |\n"],"documentType":"guide"},{"title":"Documentation translations","sectionHeader":null,"path":"/en-us/guides/translations","content":[" Translations of advanced tools center content are available in the following languages:\n","Chinese - Japanese\n"," The current translations reflect the status of documents in the advanced tools center as of July 2023. Some translated documents may not correlate one-to-one with the current documentation structure in the advanced tools center. \n"],"documentType":"guide"},{"title":"introduction","sectionHeader":null,"path":"/en-us/guides/amazon-ads-well-architected-framework/introduction","content":[],"documentType":"guide"},{"title":"introduction","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/guides/amazon-ads-well-architected-framework/introduction","content":[" The Amazon Ads Well-Architected Framework (Amazon Ads WAF) provides guidance on making informed architecture decisions when building advertising solutions that leverage the Amazon Ads API. Centered around six framework components — fundamental, account management, campaign management, reporting and analytics, insights and recommendations, and integration with the Amazon Selling Partner API. This framework defines architectural best practices to help design and operate reliable, secure, efficient, cost-effective, and sustainable solutions that integrate with Amazon Ads API. This document focuses specifically on effectively using the Amazon Ads API. For general architectural guidance, please refer to the AWS Well-Architected Framework. Some of the best practices from the AWS Well-Architected Framework are re-presented in this document to make additional recommendations specific to the Amazon Ads API.\n"," In some cases, these best practices are repeated due to their high importance. By adopting this framework, technology professionals such as chief technology officers (CTOs), architects, product, and engineering team members can unlock the full potential of the Amazon Ads platform and ensure the reliable performance and optimization of the advertising infrastructure.\n"],"documentType":"guide"},{"title":"introduction","sectionHeader":{"type":2,"text":"Framework components"},"path":"/en-us/guides/amazon-ads-well-architected-framework/introduction","content":[" The Amazon Ads API offers a suite of features and capabilities to help advertisers manage, measure, and optimize their advertising efforts. The framework divides the Amazon Ads API into six components, each addressing a distinct aspect of Amazon Ads. This document provides comprehensive architecture guidance and best practices across all these components for integrating with Amazon Ads.\n","The fundamental component establishes core design principles that form the foundation of any Amazon Ads solution. These principles apply across all framework components and guide critical technical decisions.  The account management component helps you give controlled and scalable access to Amazon Ads accounts and their associated resources (campaigns, creatives, etc.) for performing advertising activity with the Amazon Ads API.  The reporting and analytics component enables monitoring of Amazon Ads campaign performance and facilitates data-driven optimizations. This document presents design principles and best practices for building effective Amazon Ads reporting and analytics systems, guiding you in selecting appropriate solutions for your specific needs.  The campaign management component focuses on the best practices for creating and managing campaigns across the diverse range of Amazon Ads products. This includes guidance on campaign setup, activation, and optimization to help advertisers achieve their advertising goals.  The insights and recommendations component examines the best practices for utilizing the insights and recommendations provided by Amazon Ads. This leverages the Amazon Ads machine learning and artificial intelligence expertise to help you achieve better campaign outcomes. \\* The Amazon Selling Partner API component explores the integration of the Amazon Selling Partner API (SP-API) with the Amazon Ads API. This allows you to create more targeted campaigns by accessing specific Amazon retail information: inventory levels, order data, product, and pricing details.\n"],"documentType":"guide"},{"title":"fundamental component","sectionHeader":null,"path":"/en-us/guides/amazon-ads-well-architected-framework/fundamental-component","content":[],"documentType":"guide"},{"title":"fundamental component","sectionHeader":{"type":2,"text":"Fundamental component"},"path":"/en-us/guides/amazon-ads-well-architected-framework/fundamental-component","content":[" The fundamental component of the Amazon Ads Well-Architected Framework serves as the backbone of solution architecture, outlining best practices that span across all or multiple framework components. It ensures consistency and efficiency throughout the entire system. This component covers key areas such as architectural principles, security standards, performance optimization, and data management. By establishing these overarching guidelines, the Fundamental component promotes scalability, modularity, and interoperability.\n"],"documentType":"guide"},{"title":"fundamental component","sectionHeader":{"type":3,"text":"Definitions"},"path":"/en-us/guides/amazon-ads-well-architected-framework/fundamental-component","content":[" The definitions presented here are tailored to the context of Amazon Ads, and may have a narrower scope compared to more general definitions of these concepts.\n","Amazon Ads partner: Amazon Ads partners are companies available to support the needs you may have for a variety of business tasks and strategies. They have a range of expertise across Amazon Ads products and services, and they can act as a resource to help businesses achieve their goals in the Amazon store or beyond.  Amazon advertiser: Advertisers that use Amazon Ads for their advertising activities.  Amazon seller: Sellers sell products directly to Amazon customers.  Amazon vendor: Vendors sell their items directly to Amazon, who then sells them to customers.  Regions: The Amazon Ads API operates in three regions: North America (NA), Europe (EU), and Asia (FE), each with its own endpoint. Data for each region is exclusively accessible through its corresponding endpoint. This structure ensures data locality, optimizes performance, and maintains data sovereignty. Advertisers and developers should connect to the appropriate regional endpoint to access or manipulate their campaign data.  Transactions per second (TPS): TPS measures the rate at which Amazon Ads API endpoints can process requests or transactions.  TPS limit: A Transactions Per Second (TPS) limit is set at the regional level for each API endpoint to manage the load and ensure fair usage across clients. This limit represents the maximum number of transactions that can be performed within a one-second timeframe, with exceeding the limit resulting in request throttling to maintain the overall system performance.\n"],"documentType":"guide"},{"title":"fundamental component","sectionHeader":{"type":3,"text":"Fundamental design principles"},"path":"/en-us/guides/amazon-ads-well-architected-framework/fundamental-component","content":["Customers first: Customers (advertisers) come first, always. The Amazon Ads WAF is an effort to streamline solutions developed by third-parties, ensuring these experiences continue to delight our customers.  Modular design: The system should be designed with a modular/loosely-coupled architecture, where different components encapsulate distinct responsibilities and interactions are well-defined. This modular design promotes maintainability, testability, and flexibility.  Scalability and performance: The solution should be designed to scale efficiently, handling increased workloads and data without significant performance degradation. For example, the solution must be able to handle increased volume during the key shopping events like Amazon Prime Day.  Consider evolutionary architectures: As a business and its context continue to evolve, these initial decisions might hinder the ability of the system to deliver changing business requirements. Build architectures that can evolve with business needs and review your architecture periodically to make sure that it meets the business requirements.  Drive architectures using data: Collecting comprehensive data on the target system, whether by studying a legacy system or using a similar existing system as a proxy, is crucial for defining the system architecture.  Regulatory compliance in advertiser data management: Ensure strict adherence to country-specific data handling regulations when managing advertiser signals to maintain compliance and foster trust in your data governance practices.  Maintain security and controlled access: Encrypt all advertising data, both at rest and in transit, to ensure confidentiality and maintain data integrity throughout your AdTech infrastructure. Implement strong access controls and authentication mechanisms.  Ensure resilience in API interactions: Implement error handling and retry mechanisms to manage API failures and throttling events effectively. Design your systems to handle service disruptions, network issues, and rate limiting.  Infrastructure as Code (IaC): Implement Infrastructure as Code (IaC) to manage multiple AdTech environments consistently. Codify common infrastructure components and configurations across development, testing, production or any other environment using AWS CloudFormation or similar tools. Maintain version control for all codified artifacts to track changes and enable rollbacks.  Architect for mechanical sympathy: Understand the characteristics of Amazon Ads APIs, including rate limits, throughputs, and data freshness requirements. Align your system architecture with these characteristics to optimize performance and enhance user experience.  Batch operations when supported by the API: Use batch operations in Amazon Ads API to improve performance and minimize calls.\n"],"documentType":"guide"},{"title":"fundamental component","sectionHeader":{"type":3,"text":"Fundamental best practices"},"path":"/en-us/guides/amazon-ads-well-architected-framework/fundamental-component","content":["Gather business requirements and define solutions before integration: Engage key stakeholders, including business, product and technology teams, to discuss goals, needs, and priorities of customers. Early engagement of stakeholders will help you define an optimal solution and optimal usage of Amazon Ads API.  Estimate the API call volume accurately: Calculating the expected API call volume based on your business requirements is a crucial step before integrating with any API. This upfront analysis allows you to properly size and provision the necessary infrastructure, optimize costs, manage performance, design for scalability, and set meaningful monitoring thresholds.  Optimize API call payload to reduce the call volume: Optimizing API payloads is essential for minimizing the overall API call volume required by an application. Lowering the API call volume reduces the strain on the infrastructure of the API and your application.  Monitor and manage API call volume: Implement monitoring systems to track API call volumes and set up alerts for approaching thresholds. Regularly review usage patterns and proactively manage quotas to stay ahead of potential issues.  Protect all sensitive data at rest and in transit: Enforce the use of encryption for data at rest and in transit. Encryption maintains the confidentiality of sensitive data in the event of unauthorized access or accidental disclosure.  Define recovery objectives for downtime and data loss: Recovery Time Objective (RTO) is the maximum acceptable delay between the interruption of service and restoration of service. Recovery Point Objective (RPO) is the maximum acceptable time after the last data recovery point. Define RTO and RPO based on the business requirements of your application.  Use defined recovery strategies to meet the recovery objectives: Define a disaster recovery (DR) strategy that meets the recovery objectives of your application. Choose a strategy such as backup and restore, standby (active/passive), or active/active.  Automate your backups: Regular backups to a durable storage service ensure that you have the ability to recover from administrative, logical, or physical error scenarios. Configure backups to be taken automatically based on a periodic schedule, or by changes in the dataset.  Leverage asynchronous processing for long-running or complex operations: Implement asynchronous workflows for bulk campaign creation or updates, using polling or web hook mechanisms to handle completion of these tasks.\n"],"documentType":"guide"},{"title":"fundamental component","sectionHeader":{"type":3,"text":"Implementation guidance"},"path":"/en-us/guides/amazon-ads-well-architected-framework/fundamental-component","content":["Gather business requirements and define solutions before integration: Gathering business requirements and defining solutions before integration is a critical step in ensuring successful implementation of Amazon Ads APIs. This process helps align the technical integration with business goals and user/advertiser needs, reducing the risk of costly rework and improving overall project outcomes.\n","Choose purpose-built API: Amazon Ads provides a comprehensive suite of APIs to help you build advertising solutions, including Campaign Management, Reporting, Recommendations, and Creative APIs. For example, if you need to retrieve metadata in bulk, use the Exports API. Exports and GET operations return similar campaign metadata: use Exports (async) for bulk campaigns, use GET (sync) for single or subset of campaigns. \\* Estimate the API call volume accurately: Calculating the expected API call volume is a crucial step before integrating with any API. This upfront analysis allows you to properly size and provision the necessary infrastructure, optimize costs, manage performance, design for scalability, and set meaningful monitoring thresholds. To accomplish this, start by mapping out your business processes that will interact with the API, estimating the frequency of these interactions, and considering factors like peak usage times and potential growth.\n","Optimize API request and response payloads: Optimizing API payloads is a critical strategy for enhancing the efficiency and performance of applications that integrate with Amazon Ads APIs. This approach focuses on minimizing the overall API call volume, which in turn reduces the strain on both the infrastructure of the API and the application itself.\n","Exponential backoff: When a system encounters a failed or slow request, it can leverage an exponential backoff and retry strategy to handle the issue gracefully. This approach involves the system automatically waiting for an exponentially increasing amount of time before retrying the request. For example, the first retry might happen after 100 milliseconds, the second after 200 milliseconds, the fourth after 400 milliseconds, and so on, doubling the delay with each subsequent retry attempt. You can also add a random jitter value to the delay. The jitter value can be a random number between 0 and the current delay amount. You can find additional information on exponential backoff and retry here. \\* Monitor and manage API call volumes: Most Amazon Ads APIs set API rate limits to ensure all clients can use the API effectively. API rate limits are defined as a maximum number of calls a client can make to each endpoint in each region within a time period. If your app makes a lot of API requests in a short period of time then it may receive a throttling error (429) response which may lead to bad user experience. We recommend following the steps below to effectively manage rate limits.\n"],"documentType":"guide"},{"title":"account management component","sectionHeader":null,"path":"/en-us/guides/amazon-ads-well-architected-framework/account-management-component","content":[" The account management component of the Amazon Ads Well-Architected Framework outlines design principles, best practices, and implementation guidance to provide controlled and scalable access to Amazon Ads accounts and their associated resources (campaigns, creatives, etc.). Along with being a precursor to controlled Amazon Ads API access, all concepts mentioned here apply across any type of Amazon Ads account, such as advertiser account, Amazon Marketing Cloud account, test account, and manager account.\n"],"documentType":"guide"},{"title":"account management component","sectionHeader":{"type":2,"text":"Definitions"},"path":"/en-us/guides/amazon-ads-well-architected-framework/account-management-component","content":[" Amazon user account: This represents the user and uses an email address as its unique identifier. A single Amazon account may have access to various Amazon services such as Amazon.com, Amazon Ads, Amazon Ads Partner Network, Amazon Developer, Amazon Seller Central, Amazon Vendor Central, Amazon Author Central, Amazon Kindle Direct Publishing, Whole Foods Market Supplier Portal, Amazon Merch on Demand, etc. It has an identifier of the format amzn1.account.\\*. Figure 1 illustrates an example Amazon user account with access to multiple Amazon services:\n"," Figure 1: An example Amazon user account with access to Amazon.com, Amazon Ads, Amazon Ads Partner Network, Amazon Developer, Amazon Seller Central, Amazon Vendor Central, Amazon Kindle Direct Publishing, Whole Foods Market Supplier Portal, and Amazon Merch on Demand.\n"," Amazon retail selling account: For advertisers who sell on Amazon, this represents where the products are sold such as Amazon Seller Central for sellers, Amazon Vendor Central for vendors, and Amazon Kindle Direct Publishing for authors. Some advertisers may have multiple accounts, such as cases where they are both a vendor and a seller.\n"," Advertiser account: An advertiser account is a global account construct representing a single advertiser along with (for those who sell on Amazon) their one-to-one relationship with an Amazon retail selling account. It lets an advertiser, or their delegates, manage advertising activity across all eligible marketplaces, and across both Sponsored Ads and Amazon DSP (ADSP). Currently, all Sponsored Ads entities are contained within an advertiser account. The advertiser account has an identifier of the format amzn1.ads-account.g.\\*. \n"," Figure 2 illustrates an example advertiser account with only Sponsored Ads (which are marketplace specific). And Figure 3 illustrates an example advertiser account with both Amazon DSP (which are region specific) and Sponsored Ads.\n"," Figure 2: An example advertiser account with only Sponsored Ads. Note that the total number of countries for Sponsored Ads would at least be one, and the actual count is based on feature availability, selling program and countries chosen.\n"," Figure 3: An example advertiser account with both Sponsored Ads and Amazon DSP. Note that there will always exist three regions for Amazon DSP.\n"," Manager account: A manager account is a global construct that allows you to link, manage and control access to advertiser accounts and other manager accounts. Therefore, it also provides a single place to maintain data separation across different teams under your organization. A manager account has an identifier of the format amzn1.ads1.ma1.\\*.\n"," Figure 4 illustrates an example hierarchy of a manager account MA1 for a global organization with operational separation by geography. \n"," Figure 4: An example manager account MA1 for the worldwide level with nested manager accounts MA2 for their European and MA3 for their Asian operations. Each nested manager account has linked advertiser accounts for that geography. In this case, SA1 and SA3 represent Sponsored Ads entities for UK and IN respectively. And ADSP2 and ADSP4 represent Amazon DSP entities for EMEA and APAC respectively. \n"," An Amazon DSP global seat is a manager account that has Amazon DSP activated. Any advertiser account created within the seat has both Sponsored Ads and Amazon DSP. \n"," Figure 5 illustrates an example Amazon DSP seat containing two advertiser accounts. Figure 6 illustrates an example manager account without Amazon DSP containing two advertiser accounts, which only have Sponsored Ads.\n"," Figure 5: An example Amazon DSP seat containing two advertiser accounts.\n"," Figure 6: An example manager account without Amazon DSP containing two advertiser accounts, which only have Sponsored Ads.\n"," Test account: A type of advertising account dedicated to testing. Test accounts do not serve ads or have active billing. Currently limited to vendor and author account types, test accounts follow the same account structure as advertiser accounts of the same type.\n"," Amazon Marketing Cloud (AMC) account: An AMC account is a top-level account construct that contains an AMC sandbox instance with synthetic signals, and one or more AMC instances (defined later). An AMC account is marketplace specific and has an identifier of the format ENTITY\\*.\n"," Amazon Marketing Cloud instance: An AMC instance contains advertiser signals from one or more Sponsored Ads or Amazon DSP entities, all of which need to be associated with a single brand or company. An AMC instance may have signals from varying locales and has an identifier of the format amc\\*. Note that an AMC instance within an AMC account can contain advertiser signals from advertisers who do not belong to the AMC account. Figure 7 illustrates an example AMC account, and three contained instances along with a sandbox instance, owned by agency A.\n"," Figure 7: An example AMC account, and all 3 contained instances along with a sandbox instance, owned by agency A. Each instance receives advertising signals from a different brand. Instance 1, for brand 1, receives signals from a Sponsored Ads entity. Instance 2, for brand 2, receives signals from both a Sponsored Ads and Amazon DSP entity. Instance 3, for brand 3, receives signals from an Amazon DSP entity.\n"," Permissions: An Amazon user account can be invited with broad roles or custom permissions to advertiser accounts, manager accounts, AMC accounts and AMC instances. A manager account can be linked to other advertiser accounts or manager accounts with broad roles. Some permissions can also be provided at a country grain. Figure 8 illustrates an example of effective permissions including both Amazon user account and manager account linking. \n"," Figure 8: Example of effective permissions including both Amazon user account and manager account linking.\n"," Login with Amazon (LwA) security profile: A Login with Amazon security profile identifies the Amazon Ads API caller, which maps to an application used to perform advertising activity. The security profile is used to request access from and perform Amazon Ads API operations on behalf of an Amazon user account. The security profile has an identifier of the format amzn1.application.\\*. The security profile has an associated client identifier of the format amzn1.application-oa2-client.\\* and an associated client secret.\n"," Onboarding: To access the Amazon Ads API, you need to create an LwA security profile, apply for Amazon Ads API access, and assign the API access to the security profile. Figure 9 depicts the end state of an Amazon user account who has successfully onboarded to access the Amazon Ads API by creating an LwA security profile in Amazon Developer, onboarding to Amazon Ads Partner Network, applying for permission to access the Amazon Ads API and linking the security profile to Partner Network.\n"," Figure 9: End state of an Amazon user account who has successfully onboarded to access the Amazon Ads API.\n"," Authorization grant: The process of an LwA security profile seeking authorization to act on behalf of an Amazon user account within requested scopes. The initial step utilizes the OAuth 2.0 authorization code grant type where the authorization code of the Amazon user account is exchanged by the LwA security profile for a refresh token. The subsequent steps utilize the OAuth 2.0 refresh token grant type where the refresh token is exchanged for a short-lived access token (which are bearer tokens). The access token along with the client identifier are required to call the Amazon Ads API. Figure 10 depicts an authorization grant flow where an Amazon user account authorizes an LwA security profile. Note that the token exchanges happen through the LwA authorization service.\n"," Figure 10: An authorization grant flow for Amazon Ads API.\n"],"documentType":"guide"},{"title":"account management component","sectionHeader":{"type":2,"text":"Account management design principles"},"path":"/en-us/guides/amazon-ads-well-architected-framework/account-management-component","content":["Honour principle of least privilege: Limit permissions provided to an actor, both human and system, to the minimum required to perform the advertising activity. Separate permissions based on the role being performed, and the API actions required to perform them. For example, a user who manages a set of brands should be provided access only to those brands instead of a larger set of brands which the organization of the user manages. Or a user who only works on reporting should only be provided access to reporting capabilities instead of reporting and data sharing capabilities. \\* Map authorization grants to follow chain of delegation: When providing an authorization grant to an onboarded LwA security profile, choose the Amazon user account that maps to the one who would have performed the advertising activity had the activity been performed outside of using the LwA security profile. Consider a scenario where an agency has been delegated to perform reporting activity on behalf of a brand. When providing the authorization grant to an application, the user of the agency should be used instead of the user of the brand.\n"],"documentType":"guide"},{"title":"account management component","sectionHeader":{"type":2,"text":"Account management best practices"},"path":"/en-us/guides/amazon-ads-well-architected-framework/account-management-component","content":["Avoid self-authorization when providing authorization grants: Maintain separate authorization grants for each relevant Amazon user account instead of self-authorizing the Amazon user account which created the LwA security profile. This limits risk from a single token compromise, limits risks of confused deputy attacks and honours the chain of delegation. Figure 11 illustrates an example scenario for transitive delegation where an agency uses an LwA security profile and manages two brands B1 and B2. Different agency users U1 and U2 manage B1 and B2 respectively. In such cases, maintain separate tokens for U1 and U2.\n"," Figure 11: Example scenario for transitive delegation.\n","Invite Amazon user accounts with the minimum required permissions: Leverage user invitations API or console to provide the minimum required permissions, which should be granular permissions where applicable, to an Amazon user account that would perform the advertising activities. And use this invited Amazon user account to provide the authorization grant.\n","Leverage manager accounts to organize accounts: Organize accounts in groups that match your organizational structure such as by role, geography, account cohort, etc. Create a different manager account for each group and link the relevant advertiser accounts to that manager account. Link manager accounts to other manager accounts for hierarchical representations. Wherever feasible basis effective permissions, perform advertising activity using members of the relevant manager account group.\n","Perform test scenarios using test accounts and designated testers: Where available, use test accounts to perform tests. Leverage designated testers and use their authorization grant.\n","Use enterprise email group aliases with limited membership as Amazon user accounts: Use email group aliases which are mapped to a team rather than an individual when creating Amazon user accounts. Ensure that the group has limited membership so that the principle of least privilege is honoured. This ensures that you will have access to the Amazon user account even when a member is on vacation, changes roles or leaves the team. For such email aliases, use an enterprise email domain rather than a public email domain.\n","Record all advertising activities: Maintain a trail of all advertising activities performed using the API, including details such as Amazon user account, advertising account and LwA security profile. Monitor and audit frequently for drifts and anomalies.\n"],"documentType":"guide"},{"title":"account management component","sectionHeader":{"type":2,"text":"Account management implementation guidance"},"path":"/en-us/guides/amazon-ads-well-architected-framework/account-management-component","content":["Onboarding, authorization grant, and API usage using Python: See this Python based implementation guide focused on onboarding and authorization grant for the Amazon Ads API.\n","AMC approvals for advertiser addition: API driven AMC instance management might trigger additional approvals in cases where the AMC account admin does not have direct console access to the advertiser accounts being added to the AMC instance. To understand the prerequisites, read the additional approval section. Figure 12 illustrates an example scenario which triggers additional approvals where the AMC account owned by an agency adds advertiser signals from a brand. The token for the Amazon user account of the brand needs to be used to perform advertising activity before the token for the Amazon user account of the agency is used to add the advertising signals of the brand into the AMC instance of the agency for the brand.\n"],"documentType":"guide"},{"title":"reporting and analytics component","sectionHeader":null,"path":"/en-us/guides/amazon-ads-well-architected-framework/reporting-and-analytics-component","content":[],"documentType":"guide"},{"title":"reporting and analytics component","sectionHeader":{"type":2,"text":"Reporting and analytics component"},"path":"/en-us/guides/amazon-ads-well-architected-framework/reporting-and-analytics-component","content":[" Reporting and analytics systems enable monitoring of Amazon Ads campaign performance and facilitate data-driven optimizations. This document presents design principles and best practices for building effective Amazon Ads reporting and analytics systems, guiding you in selecting appropriate alternatives for your specific needs.\n"," The document applies to all reporting and analytics systems built on Amazon Ads, providing product-specific best practices for reporting API, Amazon Marketing Stream, and Amazon Marketing Cloud. We offer reference implementations, emphasizing the importance of tailoring these to your unique environment and requirements. Access to these reporting and analytics offerings requires approved Amazon Ads API credentials. For Amazon Marketing Stream and Amazon Marketing Cloud implementations, experience with AWS services and SQL knowledge is beneficial.\n"],"documentType":"guide"},{"title":"reporting and analytics component","sectionHeader":{"type":3,"text":"**Reporting and analytics definitions**"},"path":"/en-us/guides/amazon-ads-well-architected-framework/reporting-and-analytics-component","content":["Attribution: Attribution is the measurement of conversion events, or shopper behaviors that occur following an ad interaction. These behaviors measure the success of an ad campaign based on advertiser goals.  Traffic: Traffic is defined as events such as impressions and clicks, which are the user interactions associated with a particular ad campaign.  Conversion: A conversion is an action that your shoppers take, and that number can be defined by you and your business needs. These actions could be clicks on your website, purchases or new customer registrations for email newsletters, for example.  Attribution restatements: The process of running additional attribution calculations to provide the most accurate advertising performance data over time. As new information becomes available, the attribution metrics can be updated and refined.  Pseudonymized signals: Advertising and shopper signals in Amazon Marketing Cloud (AMC) that have been anonymized and de-identified to protect individual privacy.\n"],"documentType":"guide"},{"title":"reporting and analytics component","sectionHeader":{"type":3,"text":"**Reporting and analytics design principles**"},"path":"/en-us/guides/amazon-ads-well-architected-framework/reporting-and-analytics-component","content":["Select purpose-built products for distinct analytics use cases: Amazon Ads offers purpose-built products for different analytics use cases. These products differ based on integration patterns, data granularity, metric aggregation, and customization options. Align your product selection with your specific reporting and analytics needs to maximize operational efficiency.  Ensure data integrity across all layers: Implement data validation and cleansing for advertising data integrity. Establish quality checks at ingestion, validating key metrics. Develop governance policies with lineage tracking and error handling. Regularly audit data pipelines. Prioritize data quality to improve analytics, decision-making, and reporting trust.  Persist advertising data for enhanced insights: Store campaign performance data and metadata in scalable storage solutions like data lakes or data warehouses. Leverage this centralized repository for comprehensive reporting and analysis. This approach enables historical trend analysis, faster query responses, and integration with other business metrics, ultimately enhancing the advertiser experience and driving data-driven decision making.\n"],"documentType":"guide"},{"title":"reporting and analytics component","sectionHeader":{"type":3,"text":"Reporting API"},"path":"/en-us/guides/amazon-ads-well-architected-framework/reporting-and-analytics-component","content":[" The Amazon Ads reporting API offers a solution for accessing comprehensive advertising performance data. This RESTful API enables integrators to efficiently retrieve daily campaign metrics, historical data, and custom reports. Unlike stream-based architectures, the Reporting API does not require continuous data ingestion or processing, making it an optimal choice for daily or scheduled data retrieval with minimal infrastructure overhead. This approach is particularly effective for integrators seeking in-depth advertising performance analysis on an as-needed basis, facilitating data-driven decision-making without the complexity of maintaining real-time data pipelines.\n","Leverage batch data retrieval: The reporting API is designed for batch data retrieval, so frequent intraday requests do not provide significant additional value. For near real-time data needs, utilize Amazon Marketing Stream instead of constantly polling the reporting API.  Maximize API efficiency with date range requests: Utilize the date range capability of the reporting API to retrieve up to 31 days of data in a single request. This approach reduces API calls, minimizes overhead, and streamlines data collection for historical analysis.  Manage reporting life cycle efficiently: Implement systematic tracking of report IDs after initiating requests. Use stored IDs to retrieve reports, avoiding duplicate creation and too early responses (425). Remove pending reports before resubmitting identical requests. This practice reduces API calls, optimizes performance, and ensures efficient data retrieval while adhering to API best practices. \\* Implement exponential backoff and retry-after: Implement retry logic with exponential backoff for report creation, using the Retry-After header to adjust timing. Avoid duplicate requests to prevent 425 errors. If persistent throttling occurs, reevaluate your use case. The reporting API is not designed for high-frequency, real-time data retrieval. For near real-time needs, consider Amazon Marketing Stream.\n","Automated reporting solution for Amazon Sponsored Ads: This serverless architecture leverages AWS services to automate the end-to-end process of creating, retrieving, and storing Sponsored Ads reports. By utilizing AWS Lambda for API interactions, AWS Step Functions for workflow orchestration, and Amazon EventBridge for scheduling, the solution enables advertisers to configure custom reporting schedules and parameters. Reports are securely stored in Amazon S3, providing a scalable and cost-effective method for maintaining up-to-date performance data. This approach minimizes manual effort, enhances data consistency, and facilitates ongoing campaign optimization and analysis.\n"],"documentType":"guide"},{"title":"reporting and analytics component","sectionHeader":{"type":3,"text":"**Amazon Marketing Stream**"},"path":"/en-us/guides/amazon-ads-well-architected-framework/reporting-and-analytics-component","content":["Choose appropriate delivery mechanisms: When using Amazon Marketing Stream, you can choose between Amazon SQS, a reliable queue-based destination, or Amazon Data Firehose, an ingest and transform service. The choice should be guided by the specific requirements of the workload, such as message durability, and integration with downstream analytics tools. For more details please follow the documentation.  Implement deduplication: Amazon Marketing Stream uses Amazon SNS for message delivery, which may result in duplicate notifications. Utilize the idempotency_id parameter provided by Amazon Marketing Stream to implement effective deduplication logic in your data processing workflows.  Aggregate delta messages: Given the near real-time nature of Amazon Marketing Stream, consider aggregating delta messages at a cadence that aligns with your reporting and analysis needs. This approach provides a balanced view of performance trends while optimizing data processing resources.  Manage time zone considerations: When comparing Amazon Marketing Stream data with other reporting sources, consider potential time zone differences, as these can affect the interpretation and analysis of performance metrics.  Monitor operational metrics of the delivery mechanisms: Monitor operational metrics of the SQS or Firehose, the availability of source data, and validate the data quality at destination before making decisions.  Optimize cost: For cost optimization, focus on leveraging a range of cost reduction strategies, such as event source mapping, batching, buffering, partitioning, and data transformation, as detailed in the Amazon Ads documentation.  Ensure access token management: The Amazon Marketing Stream subscription is tied to the customer ID. If the end user who approved the access token leaves, you will lose access to the subscription. Implement mechanisms to securely store the access tokens and gracefully handle any access token transfers or revocations. \\* Maintain data consistency across datasets: When making decisions based on insights derived from multiple Amazon Marketing Stream datasets, ensure that all the relevant datasets are up-to-date and consistent. Design your processing pipelines to handle potential failures or data inconsistencies to maintain the reliability of your analytical outputs.\n","Infrastructure as Code (IaC): Implement Infrastructure as Code to provision and manage Amazon Marketing Stream resources consistently across datasets and regions. This approach automates the setup of SQS queues or Kinesis Data Firehose streams and associated permissions, ensuring scalability, reducing manual errors, and enabling efficient replication of stream infrastructure. \\* Real-time advertising data processing with Amazon Marketing Stream: This reference architecture illustrates the processing of near real-time advertising data via Amazon Marketing Stream. The solution utilizes AWS services to efficiently ingest, process, and analyze streaming data, facilitating near real-time campaign performance monitoring and intraday optimization strategies.\n"],"documentType":"guide"},{"title":"reporting and analytics component","sectionHeader":{"type":3,"text":"Amazon Marketing Cloud"},"path":"/en-us/guides/amazon-ads-well-architected-framework/reporting-and-analytics-component","content":[" Amazon Marketing Cloud (AMC) is a comprehensive, flexible analytics platform that provides unified signals and insights to drive omni-channel advertising strategies. With AMC, advertisers can leverage a suite of audience segmentation, campaign measurement, and custom data integration capabilities to unlock deeper customer insights and optimize their marketing efforts. The AMC APIs are interfaces for developers to programmatically access AMC features. AMC APIs are often used to automate or schedule query workflows, create custom audiences, facilitate scaled operations, upload first-party signals, and enable integrations between AMC and other systems.\n"],"documentType":"guide"},{"title":"campaign management component","sectionHeader":null,"path":"/en-us/guides/amazon-ads-well-architected-framework/campaign-management-component","content":[],"documentType":"guide"},{"title":"campaign management component","sectionHeader":{"type":2,"text":"Campaign management component"},"path":"/en-us/guides/amazon-ads-well-architected-framework/campaign-management-component","content":[" The campaign management component of the Amazon Ads Well-Architected Framework focuses on design principles and best practices for building Campaign Management (CM) solutions using Amazon Ads API. The scope of this component is limited to Sponsored Products, Sponsored Brands, Sponsored Display, and Amazon DSP ad products, which allow you to create campaigns tailored to specific campaign objectives.\n"],"documentType":"guide"},{"title":"campaign management component","sectionHeader":{"type":3,"text":"Definitions"},"path":"/en-us/guides/amazon-ads-well-architected-framework/campaign-management-component","content":[" The definitions presented here are tailored to the context of Amazon advertising platforms and services, and may have a narrower scope compared to more general definitions of these concepts.\n","Campaigns: A top-level container for advertising activities, including ad groups, targeting settings, budget allocation, and campaign goals.  Ad group: A campaign entity that contains specific targeting criteria, keywords, ads, and ad types. Ad groups provide a logical grouping to organize, manage, and track performance metrics within your campaign. Each ad group is associated to a single campaign and can have settings for bids, budgets, creatives.  Keyword: A word or phrase used for targeting and bidding in an ad group. Keywords can have different match types like broad, phrase, and exact. Negative keywords can also be added to exclude certain search terms. Keywords are also referred to as targets.  Audience: An audience refers to a specific group of potential shoppers that advertisers aim to reach with their ads. Audiences can be segmented based on various characteristics, including demographics, interests, shopping behaviors, and purchasing patterns.  Target: A target refers to the specific audiences, keywords or products an advertiser wants to reach with their ads. Targeting can include or exclude these conditions.  Budget: An ad budget refers to the amount of money allocated to an ad campaign.  Bid: The amount an advertiser is willing to pay for a click or impression.  Cost Per Click (CPC): CPC determines how much advertisers pay for the ads they place on websites or social media, based on the number of clicks the ad receives.   Cost Per Mille (CPM): CPM also called cost per thousand impressions; refers to the total ad spend for every 1,000 impressions an ad receives.  Ad products: Amazon ads products include Sponsored Brands, Sponsored Products, Sponsored Display, Sponsored TV, and Amazon DSP. Different ad types have specific creative requirements and specifications for assets like images, videos, and logos.  Creative assets: The visual elements used in an ad, such as logos, images, and videos. These assets must adhere to specific creative specifications for each ad type.  Personas: Personas are detailed profiles of an ideal customer of an advertiser. Advertisers use these personas to create targeted campaigns that speak directly to the needs and behaviors of their target.  Third party (3P) Amazon DSP deals: These are deals that advertisers have negotiated and executed in Amazon DSP (ADSP) so you can use those deals to place ads through the Amazon DSP platform.  Historic reach curve: The historic reach API provides visibility into the historic reach of Amazon supply sources for media planning purposes. It allows you to pass input parameters, such as supply package, audience, demographic and date range and return back a historic reach curve that matches the input criteria.  Forecasting reach curve: The reach forecasting API allows integrators to generate reach forecasts against inventory that is available to buy, while taking into account brand and campaign parameters. \\* First party (1P) signals: 1P signals are information directly collected and owned by an advertiser about their customers.\n"],"documentType":"guide"},{"title":"campaign management component","sectionHeader":{"type":3,"text":"Campaign management design principles"},"path":"/en-us/guides/amazon-ads-well-architected-framework/campaign-management-component","content":["Create campaign components after verifying existence of dependencies: Campaigns follow a hierarchical structure: campaigns contain ad groups, which contain ads. To create a successful campaign, start by creating the campaign first, then add ad groups to the campaign, followed by creating ads within each ad group. For manual campaigns, add targeting options to each ad group. Always verify each successful creation of a component before adding subsequent components.\n"],"documentType":"guide"},{"title":"campaign management component","sectionHeader":{"type":3,"text":"Campaign management best practices"},"path":"/en-us/guides/amazon-ads-well-architected-framework/campaign-management-component","content":["Use pre-moderation to increase moderation approval rate: The unified pre-moderation API offers real-time policy guidance based on the technical, creative, and policy components of an ad. Use it before moderation to reduce punctuation, grammar, spelling errors, capitalization, and spacing errors that may cause your ads to get rejected.  Adhere to marketplace bid thresholds: Implement validation checks to ensure campaign bids align with marketplace-specific thresholds before API submission. For current marketplace limits, refer here.  Track campaign component states and dependencies: Track campaign component states and dependencies during creation through distinct creation states (created, pending, failed) and operational states (enabled, archived, paused). This tracking enables automatic retry of failed operations, process resumption, and sequential component advancement.  Export campaigns metadata: While reports contain performance data, exports provide metadata about your campaigns at the time of the request. Use exports instead of list operations to retrieve metadata in bulk for all configured campaigns, ad groups, targeting expressions, and more. Access metadata infrequently as campaign configuration data generally remains stable.  Use list operations to retrieve entities in bulk: Utilize batch endpoints (for instance list Sponsored Products campaigns, list Sponsored Brands ad groups, etc) when fetching multiple entities instead of retrieving one entity individually. \\* Implement pagination handling: Build an abstraction layer that handles pagination automatically for list operations. Most endpoints use nextToken and maxResults for these.\n"],"documentType":"guide"},{"title":"campaign management component","sectionHeader":{"type":3,"text":"Implementation guidance"},"path":"/en-us/guides/amazon-ads-well-architected-framework/campaign-management-component","content":["Use target exclusion list for brand safety: Amazon Ads has global brand safety policies that take a variety of measures to prevent your ads from appearing on webpages and apps containing sensitive content, products, and services. Use brand safety list for Sponsored Display and domain targeting for Amazon DSP to support brand safety use cases. \\* Select appropriate mechanisms for external audiences: Amazon Ads products like Sponsored Display and Amazon DSP offer prebuilt audience segments called Amazon Audiences to help advertisers reach prospective shoppers, both on and off Amazon. Generate audience insights using persona builder API and reach curve API during the audience planning phase for Amazon DSP and Sponsored Display.\n"],"documentType":"guide"},{"title":"Insights and recommendations component","sectionHeader":null,"path":"/en-us/guides/amazon-ads-well-architected-framework/insights-and-recommendations-component","content":[" The insights and recommendations component of the Amazon Ads Well-Architected Framework provides guidance on leveraging Amazon Ads insights and recommendations capabilities to inform decision-making, optimize campaigns, and discover new growth opportunities.\n"],"documentType":"guide"},{"title":"Insights and recommendations component","sectionHeader":{"type":2,"text":"Definitions"},"path":"/en-us/guides/amazon-ads-well-architected-framework/insights-and-recommendations-component","content":["Insights: Insights are data-driven observations and analyses that help advertisers understand their audiences, campaign performance, and retail trends.  Recommendations: Recommendations deliver specific, actionable optimization suggestions including bid adjustments, budget allocations, targeting improvements, and creative enhancements to help advertisers improve campaign performance.  Budget recommendations: Suggests daily budgets and estimated missed opportunity metrics, including impressions, clicks, and sales for all sponsored ad products.  Bid recommendations: Provides advertisers with suggested bid values for keywords, products, categories, or audiences. These recommendations are tailored to maximize performance metrics such as impressions, clicks, or conversions.  Targeting recommendations: Suggests targeting strategy, including keywords, products, theme-based, category targeting, or audiences to reach more relevant shoppers and improve campaign efficiency.  Creative recommendations: Suggests improvements to ad creatives, such as headlines, to increase engagement and conversion rates.  Consolidated recommendations: Get the top consolidated recommendations across bid, budget, targeting for Sponsored Products campaigns. The recommendations are refreshed every day.  Partner opportunities: A distribution channel for partners to download actionable and relevant insights and recommendations for advertisers they support. These opportunities are available only for partners registered to the Amazon Ads Partner Network (AAPN).  Audience Insights: Helps advertisers explore similar audiences, based on audiences you are already using.  Brand Metrics: Brand Metrics provides a new measurement solution that quantifies opportunities for your brand at each stage of the customer journey on Amazon, and helps brands understand the value of different shopping engagements that impact stages of that journey.  Brand Benchmarks: Serves various inquiries regarding advertiser and brand metrics and surfaces Amazon Brand View Pro reports for 3P callers. \\* Media planning: Media planning services address a range of challenges faced by media planning teams - from understanding your potential audience and forecasting reach, to optimizing your media mix and measuring campaign performance. By tapping into the unique data and signals of Amazon, you can make more informed, strategic decisions to drive better outcomes for your business and your clients. These include the Historic Reach API, Reach Forecasting API, Audiences discovery API, and Persona builder API.\n"],"documentType":"guide"},{"title":"Insights and recommendations component","sectionHeader":{"type":2,"text":"Design Principles"},"path":"/en-us/guides/amazon-ads-well-architected-framework/insights-and-recommendations-component","content":["Select purpose-built insights or recommendations services: Amazon Ads provides purpose-built insights and recommendation services designed to support strategic planning, performance optimization, and growth objectives. Select services that align with your specific goals and campaign lifecycle stage.  Implement holistic campaign optimization: Consider all aspects of campaign performance when generating recommendations such as audience targeting, budget allocation, keyword selection, and creative optimization across all your portfolio. To avoid recommendation overlap, start with services that directly support your primary goals, then expand based on proven results and team capacity.  Enable independent scaling: Separate recommendation ingestion from recommendation implementation for independent scaling. This principle aligns with the fundamental design principles of modularity, scalability, and performance.  Facilitate progressive implementation: Design systems that allow for incremental adoption of recommendation capabilities, starting with high-impact, low-complexity features. This principle aligns with the fundamental design principle of \"Consider evolutionary architectures\".  Define recommendation lifecycle workflow: Consider implementing stages in recommendation workflows such as discover, validate, approve, implement, and measure. These stages provide a logical flow that can be customized and implemented as needed. Since some recommendations come with expiration times, implement expiration tracking to measure effectiveness across various recommendation types. \\* Implement observability: Embed observability into every stage of recommendation processing to proactively detect failures, conflicts, and data staleness.\n"],"documentType":"guide"},{"title":"Insights and recommendations component","sectionHeader":{"type":2,"text":"Best Practices"},"path":"/en-us/guides/amazon-ads-well-architected-framework/insights-and-recommendations-component","content":["Select purpose-built insights and recommendations services: Select purpose-built insights and recommendations that align with your business goals. Your approach should reflect factors like campaign maturity, current performance, budget limitations, and business priorities. New campaigns or seasonal businesses may need different combinations of recommendations compared to established or year-round operations. Examples include:  Unify ad insights and actions: Amazon Ads provides various signals for diverse needs, ranging from bid and budget management to targeting, creative optimization, partner opportunities, audience insights, brand analytics, and consolidated recommendations. Unify these ad insights and actions to prevent contradictory optimizations that could destabilize campaigns. Examples of such contradictions include simultaneous budget cuts and bid increases, budget decreases coupled with creative expansion, and conflicting advice from consolidated recommendations and partner opportunity optimizations.  Adopt time-driven processing: Design different processing approaches based on the time-sensitivity and complexity of the insights and recommendations. For example, Amazon Marketing Stream provides real-time signals that require near real-time action. The budget-usage dataset monitors campaigns nearing their budget limits, while the sp-budget-recommendations dataset uncovers missed opportunities. These signals provide actionable insights and recommendations and do require near real-time implementation. On the other hand, strategic insights and recommendations like Partner Opportunities, media planning, product targeting, and keyword suggestions contribute to your overarching advertising strategy. While valuable, these insights allow flexible implementation at a pace that works best for your process.  Validate with data-driven insights: Use performance data from the services covered in detail in the reporting and analytics component to validate recommendation effectiveness. Implement feedback loops that measure recommendation impact and improve future recommendation selection.  Monitor recommendation relevance: Monitor recommendation relevance by implementing freshness checks for different recommendation types. For example, Partner Opportunities refresh every 24 hours and may include expiration timestamps. Act only on timely information that aligns with your business goals.  Centralize recommendations with Partner Opportunities API: Prioritize the Partner Opportunities API as the primary entry point for obtaining recommendations across all advertisers managed within your partner network account.  Automate easy win opportunities: Partner Opportunities provides confidence and impact score metrics. Use these metrics to automate low-risk/high-reward actions and improve efficiency while maintaining control. For example, filter and auto-apply recommendations where confidence > 0.8 AND impactScore > 7. Other APIs, like Brand Metrics, provide metrics such as newToBrandCustomerRate and customerConversionRate, and Audience Insights API provides affinity scores, which can be used in a similar way.\n","Partner Opportunities API implementation: Partners use the Partner Opportunities API to efficiently discover, download, and apply recommendations at scale, automate campaign actions, track results, and drive better outcomes for all advertisers they manage, without needing to log into each account individually or manually aggregate insights.\n"," Explore these workflows in the Partner Opportunities Integration flow diagram below:\n"],"documentType":"guide"},{"title":"Communications preferences overview","sectionHeader":null,"path":"/en-us/guides/communications-preferences/overview","content":[],"documentType":"guide"},{"title":"Communications preferences overview","sectionHeader":{"type":2,"text":"What is communications preferences?"},"path":"/en-us/guides/communications-preferences/overview","content":[" Communications preferences APIs let you manage how advertisers are contacted by Amazon Ads and what communications they receive. Two resource types make up this API:\n","Communication contacts: addresses advertisers designate for a specific purpose, such as account support, on a given channel (for example, email). - Communication preferences: an advertiser's opt-in or opt-out status for a communication channel, along with category-level subscription settings (for example, campaign recommendations or educational content).\n"," These APIs are for integrators who need to read or update an advertiser's contact information and notification settings on their behalf, keeping them in sync between Amazon Ads and your own systems.\n"],"documentType":"guide"},{"title":"Communications preferences overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/communications-preferences/overview","content":[],"documentType":"guide"},{"title":"Get started with communications preferences","sectionHeader":null,"path":"/en-us/guides/communications-preferences/get-started","content":[" By the end of this guide, you will be able to create a communication contact, query it back, and query and update an advertiser's communication preferences for a channel.\n"],"documentType":"guide"},{"title":"Get started with communications preferences","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/communications-preferences/get-started","content":[" Before you begin, you need:\n","An access token with the appropriate scope for the advertiser account. - The amazon-advertising-api-clientid and amazon-advertising-api-scope headers for your requests.\n"],"documentType":"guide"},{"title":"Get started with communications preferences","sectionHeader":{"type":2,"text":"Steps"},"path":"/en-us/guides/communications-preferences/get-started","content":[],"documentType":"guide"},{"title":"Get started with communications preferences","sectionHeader":{"type":3,"text":"1. Create a communication contact"},"path":"/en-us/guides/communications-preferences/get-started","content":[" Create a contact for a specific channel and purpose. The preferredContact flag marks this contact as the default for its purpose. Create one contact per request: the communicationContacts array accepts a single entry.\n"," A successful response returns the created contact, including its generated communicationContactId:\n"],"documentType":"guide"},{"title":"Get started with communications preferences","sectionHeader":{"type":3,"text":"2. Query communication contacts"},"path":"/en-us/guides/communications-preferences/get-started","content":[" Filter contacts by channel to confirm what was created. Name exactly one channel in channelFilter.include: each query addresses a single channel.\n"],"documentType":"guide"},{"title":"Get started with communications preferences","sectionHeader":{"type":3,"text":"3. Query communication preferences"},"path":"/en-us/guides/communications-preferences/get-started","content":[" Query the advertiser's current preferences for a channel. As with contacts, name exactly one channel in channelFilter.include per request:\n"," The response includes category-level subscription state:\n"],"documentType":"guide"},{"title":"Get started with communications preferences","sectionHeader":{"type":3,"text":"4. Update a communication preference"},"path":"/en-us/guides/communications-preferences/get-started","content":[" Use the communicationPreferenceId from the query response to update a category subscription. When communicationsEnabled is true, you must include at least one entry in categoryPreferences: an enabled channel with an empty category list is rejected, because it would be read as subscribing the advertiser to every category and would erase their existing opt-outs. To disable a channel entirely, send communicationsEnabled: false (the category list is then optional).\n"],"documentType":"guide"},{"title":"Get started with communications preferences","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/communications-preferences/get-started","content":[],"documentType":"guide"},{"title":"Communications preferences FAQ","sectionHeader":null,"path":"/en-us/guides/communications-preferences/faq","content":[],"documentType":"guide"},{"title":"Communications preferences FAQ","sectionHeader":{"type":3,"text":"What is the difference between a communication contact and a communication preference?"},"path":"/en-us/guides/communications-preferences/faq","content":[" A communication contact is an address, such as an email address, designated for a specific purpose like account support. A communication preference is an advertiser's opt-in or opt-out status and category subscriptions for a communication channel. A contact is who to reach; a preference is what to send them and whether they want it.\n"],"documentType":"guide"},{"title":"Communications preferences FAQ","sectionHeader":{"type":3,"text":"Can I create a communication preference?"},"path":"/en-us/guides/communications-preferences/faq","content":[" No. Communication preferences are managed through query and update operations only. A preference already exists for each channel, so there is no create operation; use update to change an advertiser's channel and category settings.\n"],"documentType":"guide"},{"title":"Communications preferences FAQ","sectionHeader":{"type":3,"text":"What happens if I omit `preferredContact` when creating a contact?"},"path":"/en-us/guides/communications-preferences/faq","content":[" The contact is created without being marked as the preferred contact for its purpose. If no preferred contact exists for a purpose and channel, downstream systems may have no default address to use.\n"],"documentType":"guide"},{"title":"Communications preferences FAQ","sectionHeader":{"type":3,"text":"What time zone format does `timeZone` expect?"},"path":"/en-us/guides/communications-preferences/faq","content":[],"documentType":"guide"},{"title":"DSP reporting overview","sectionHeader":null,"path":"/en-us/guides/reporting/dsp/overview","content":[" The DSP reporting API helps advertisers access their DSP campaign data. \n"],"documentType":"guide"},{"title":"DSP reporting overview","sectionHeader":{"type":2,"text":"Report types"},"path":"/en-us/guides/reporting/dsp/overview","content":[" You can request reports with performance data grouped by different report types. \n"," For example, a campaign report includes metrics related to the performance of your campaign for your selected period. A geography report contains data based on the geographical data of your customers. \n"," Learn more about available Report types.\n"],"documentType":"guide"},{"title":"DSP reporting overview","sectionHeader":{"type":2,"text":"Format"},"path":"/en-us/guides/reporting/dsp/overview","content":[" The API generates reports in either CSV or JSON format. Add your preferred format in your request. By default, reports are in JSON format.\n"," For a sample report, see Read your report.\n"],"documentType":"guide"},{"title":"DSP reporting overview","sectionHeader":{"type":2,"text":"Reporting period"},"path":"/en-us/guides/reporting/dsp/overview","content":[" You can specify the time-based aggregation level of your report, timeUnit, as either DAILY or SUMMARY. \n"," Learn more about the timeUnit parameter.\n"],"documentType":"guide"},{"title":"DSP reporting overview","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/reporting/dsp/overview","content":["Get started with DSP reports \\* Metrics\n"],"documentType":"guide"},{"title":"Getting started with DSP reporting","sectionHeader":null,"path":"/en-us/guides/reporting/dsp/get-started","content":[" This tutorial outlines how to asynchronously request and download reports for DSP campaigns.\n"," To generate a report:\n","Retrieve your accountId 2. Request a report 3. Wait for report to generate 4. Download the report\n"],"documentType":"guide"},{"title":"Getting started with DSP reporting","sectionHeader":{"type":2,"text":"Headers"},"path":"/en-us/guides/reporting/dsp/get-started","content":[" Each request described in this tutorial requires four header parameters:\n","| Parameter | Description |\n","\\|--------------------------\\|---------------\\|\n","| Amazon-Advertising-API-ClientId | The client ID associated with your Login with Amazon application. Used for authentication. |\n","| Authorization | Your access token. Used for authentication. |\n","| Accept | Specifies the content we expect in response; depends on the request endpoint. Set to application/vnd.dspcreatereports.v3+json for requesting a report and application/vnd.dspgetreports.v3+json for checking the report status. |\n","| Content-Type | Set to application/json. |\n"," For an introduction to API authentication, see Authorization overview.\n"],"documentType":"guide"},{"title":"Getting started with DSP reporting","sectionHeader":{"type":2,"text":"Retrieve your `accountId`"},"path":"/en-us/guides/reporting/dsp/get-started","content":[" You need your accountId whether you are generating or retrieving reports. accountId is used for  authentication and for determining the scope of your report. \n"," How you retrieve your accountId depends on whether you have a managed or self-service account. For more information, see Reporting by account type. \n"],"documentType":"guide"},{"title":"Getting started with DSP reporting","sectionHeader":{"type":2,"text":"Generate a report"},"path":"/en-us/guides/reporting/dsp/get-started","content":[],"documentType":"guide"},{"title":"Getting started with DSP reporting","sectionHeader":{"type":3,"text":"Request a report"},"path":"/en-us/guides/reporting/dsp/get-started","content":[" DSP reports support a variety of report types and metrics. For more information on what configurations are supported, see Report types.\n"," All reports requests use a single endpoint: POST /accounts/{accountId}/dsp/reports. See the API reference for details on parameters.\n"," Sample request body (timeUnit set to DAILY)\n"," Sample request body (timeUnit set to SUMMARY)\n"," Dimensions determine the aggregation level of your report. Adding a dimension automatically adds the metrics for that dimension in the report. If you add multiple dimensions, the DSP reporting API uses the lowest level dimension for data aggregation and includes the dimensional metrics for every added dimension in your report. For more information, see Dimensions.\n"," Self-service DSP entity owners may use the advertiserIds field to request data from specific advertisers. For more information, see Reporting by account type.\n"," By default, in the POST /accounts/{accountId}/dsp/reports request body:\n","The report type is set to CAMPAIGN - The format is set to JSON - timeUnit is set to SUMMARY and aggregated for the time period specified (startDate to endDate) - The dimension is set to ORDER\n"," You must specify a startDate and endDate in your request.\n"," This sample shows a request for a summary DSP campaign report between December 5th, 2022 and December 19th, 2022 for the advertiser with accountId ID123456789. \n"," A successful request response includes a reportId and a status field. \n"],"documentType":"guide"},{"title":"Getting started with DSP reporting","sectionHeader":{"type":3,"text":"Wait for report to generate"},"path":"/en-us/guides/reporting/dsp/get-started","content":[" Once you have made a successful POST call, report generation can take up to three hours.\n"," You can check the report generation status by using the reportId returned in the initial request to call the GET reports endpoint: GET /accounts/{accountId}/dsp/reports/{report-id}.\n"," Any successful call to the GET status endpoint returns a 200 status code. To check if report generation has completed, check the status parameter in the response body. If the report is still generating, status is set to PENDING or PROCESSING. When your report is ready to download, status returns as SUCCESS, and you will see an address in the location field.\n"],"documentType":"guide"},{"title":"Getting started with DSP reporting","sectionHeader":{"type":3,"text":"Download the report"},"path":"/en-us/guides/reporting/dsp/get-started","content":[" Once your report is ready, the location field of a GET /accounts/{accountId}/dsp/reports/{report-id} contains a link to the S3 bucket where you can download your report. You can make a GET call using cURL or enter the URL in your browser.\n"],"documentType":"guide"},{"title":"Getting started with DSP reporting","sectionHeader":{"type":2,"text":"Read your report"},"path":"/en-us/guides/reporting/dsp/get-started","content":[" View the raw JSON file of your report. Within the report, the aggregation level of your data depends on your specified dimension. A sample JSON, ORDER level report may look like:\n"],"documentType":"guide"},{"title":"Getting started with DSP reporting","sectionHeader":{"type":2,"text":"Learn more"},"path":"/en-us/guides/reporting/dsp/get-started","content":[],"documentType":"guide"},{"title":"DSP reporting by account type","sectionHeader":null,"path":"/en-us/guides/reporting/dsp/reporting-by-account-type","content":[" Amazon DSP currently provides support for both managed and self-service accounts. Self-service accounts manage their own campaigns while managed accounts have their campaigns managed by either Amazon or a third-party agency. Both managed and self-service advertisers can use the Amazon Ads API to retrieve reporting data, however the process differs depending on the type of account.\n"],"documentType":"guide"},{"title":"DSP reporting by account type","sectionHeader":{"type":2,"text":"Self-service accounts "},"path":"/en-us/guides/reporting/dsp/reporting-by-account-type","content":[" Self-service DSP entity owners manage campaigns and may have multiple advertisers connected to their DSP entity. Entity owners may manage campaigns for one or more advertisers, or may be a tool provider. \n"," To call the DSP reporting API:\n","Make sure your Login with Amazon application is authorized by a DSP account that has entity-level access. 2. Retrieve your entity ID using the GET /v2/profiles endpoint.\n","Use your entity ID as the accountId in the URI of the POST /accounts/{accountId}/dsp/reports. \n"],"documentType":"guide"},{"title":"DSP reporting by account type","sectionHeader":{"type":2,"text":"Managed service accounts"},"path":"/en-us/guides/reporting/dsp/reporting-by-account-type","content":[" Managed service advertisers need to use a manager account to call the reporting API. This process enables entity administrators to grant read-only permissions to a manager account for one or more advertisers within that entity.  \n"," To call the DSP reporting API:\n","Access the Manager Accounts UI and click Create Manager account.  2. Enter a Name and choose whether this is an Agency or Advertiser account. 3. From the Link accounts section, go to the Request access tab. 4. Add the DSP advertiser IDs and marketplaces that you want reporting data for. You will need to get the advertiser ID from someone who has access to the DSP entity. 5. When you are finished adding advertiser IDs, select Create Manager account. 6. On the bottom left of the screen, select the gear icon, then Account access & settings. 7. Click Accounts. 8. Copy the approval link associated with the advertisers you just requested, then provide this URL to an administrator of the DSP entity for approval.\n","Once approval has been granted, a user with access to the manager account needs to authorize your Login with Amazon application.  10. Now when calling the API, you can use the DSP advertiser ID (from step 4) as the accountId in the URI of POST /accounts/{accountId}/dsp/reports. \n"," Example call:\n"],"documentType":"guide"},{"title":"DSP reporting by account type","sectionHeader":{"type":3,"text":"Manager account advertiser IDs"},"path":"/en-us/guides/reporting/dsp/reporting-by-account-type","content":[" You can also get any advertiser IDs that your manager account has access to using the GET /managerAccounts endpoint.\n"," Example response:\n"," You can use the dspAdvertiserId (values 12345678 and  98765432 from the example above) as the accountId in the URI of POST /accounts/{accountId}/dsp/reports.\n"],"documentType":"guide"},{"title":"DSP reporting by account type","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/reporting/dsp/reporting-by-account-type","content":[" For more information on requesting reports, see:\n"],"documentType":"guide"},{"title":"DSP report types","sectionHeader":null,"path":"/en-us/guides/reporting/dsp/report-types","content":[" The DSP API supports a number of report types. Each report type allows you to request metrics related to the report type. The aggregation level of the data in your report depends on your requested dimensions. For example, an ORDER dimension report groups data by orders, while a LINE_ITEM dimension report groups data by line items. If you request multiple dimensions, the report groups data by the lowest aggregation level and includes all of the fields from all of the requested dimensions. \n"," See an example report with multiple dimensions.\n"],"documentType":"guide"},{"title":"DSP report types","sectionHeader":{"type":2,"text":"Default metrics"},"path":"/en-us/guides/reporting/dsp/report-types","content":[" All reports, regardless of dimension or report type, include the following metrics by default: \n","date (for timeUnit DAILY)  intervalStart (for timeUnit SUMMARY)  intervalEnd (for timeUnit SUMMARY)  entityId  advertiserName \\* advertiserId\n"," Some report types include default metrics, similar to how dimensions include default metrics. Find default metrics listed under each report type.\n"],"documentType":"guide"},{"title":"DSP report types","sectionHeader":{"type":2,"text":"Report types"},"path":"/en-us/guides/reporting/dsp/report-types","content":[],"documentType":"guide"},{"title":"DSP report types","sectionHeader":{"type":3,"text":"Campaign"},"path":"/en-us/guides/reporting/dsp/report-types","content":[" Campaign reports include performance data for campaigns that have performance activity on your requested dates. For example, to see the creative used in your campaign in addition to the number of times your ad has been viewed, request a campaign report with dimension CREATIVE and the metric viewableImpressions.\n"," Dimensions: ORDER, LINE_ITEM, CREATIVE\n"," Default metrics: none Sample request\n"],"documentType":"guide"},{"title":"DSP report types","sectionHeader":{"type":3,"text":"Inventory"},"path":"/en-us/guides/reporting/dsp/report-types","content":[" Inventory reports contain data based on your inventory, such as deal and supply source information. For example, to get information on the site the campaign was run on, such as the site name and the name of the ad placement, request an inventory report with dimension SITE and metric placementName.\n"," Dimensions : \n","ORDER - LINE_ITEM - SITE - SUPPLY - DEAL \n"," You must include either a SITE or SUPPLY dimension in your inventory report type request.\n","SITE unlocks metrics: placementSize, placementName - DEAL unlocks metrics: dealType\n"," Default metrics: none\n"," Sample request\n"],"documentType":"guide"},{"title":"DSP report types","sectionHeader":{"type":3,"text":"Audience"},"path":"/en-us/guides/reporting/dsp/report-types","content":[" Audience reports contain data based on your audience. For example, to see the targeting method used in your campaign, request an audience report with the metric targetingMethod.\n"," Dimensions: ORDER, LINE_ITEM\n"," Default metrics: segment\n"," Sample request\n"],"documentType":"guide"},{"title":"DSP report types","sectionHeader":{"type":3,"text":"Products"},"path":"/en-us/guides/reporting/dsp/report-types","content":[" Products reports contain data based on the products featured in your campaigns. For example, to see the names of your products as presented in the Amazon retail catalog, request a products report with the metric productName.\n"," Dimensions: ORDER, LINE_ITEM\n"," Default metrics: amazonStandardId, asinConversionType, parentAsin, brandName, reportGranularity, marketplace, featuredAsin\n"," Sample request\n"],"documentType":"guide"},{"title":"DSP report types","sectionHeader":{"type":3,"text":"Technology"},"path":"/en-us/guides/reporting/dsp/report-types","content":[" Technology reports contain data based on the technology of your customers. For example, to see the operating systems your customers were using while viewing your ad, request a technology report with dimension OPERATING_SYSTEM.\n"," Dimensions: ORDER, LINE_ITEM, OPERATING_SYSTEM, BROWSER_TYPE, BROWSER_VERSION, DEVICE_TYPE, ENVIRONMENT_TYPE\n"," Default metrics: none\n"," Sample request\n"],"documentType":"guide"},{"title":"DSP report types","sectionHeader":{"type":3,"text":"Geography"},"path":"/en-us/guides/reporting/dsp/report-types","content":[" Geography reports contain the geographical data of your customers. For example, to see the states or regions your customers were in while viewing your ad, request a geography report with dimension STATE_COUNTY_REGION.\n"," Dimensions: ORDER, LINE_ITEM, COUNTRY, STATE_COUNTY_REGION, CITY, DMA, POSTAL_CODE\n"," Default metrics: none\n"," Sample request\n"],"documentType":"guide"},{"title":"DSP report types","sectionHeader":{"type":3,"text":"Conversion source"},"path":"/en-us/guides/reporting/dsp/report-types","content":[" Conversion source reports contain data based on customer conversions. For example, to see the names of your conversion sources, request a conversion source report. conversionSourceName is included in your conversion source report by default.\n"," Dimensions: ORDER, LINE_ITEM, CREATIVE\n"," Default metrics: conversionSourceName, conversionSourceOwner, conversionSourceAttributionType, conversionSourceScaled, maxExpectedLatencyHours\n"," Sample request\n"],"documentType":"guide"},{"title":"DSP report types","sectionHeader":{"type":2,"text":"Example report"},"path":"/en-us/guides/reporting/dsp/report-types","content":[" Example of an ORDER dimension campaign report:\n"," Example of a LINE_ITEM dimension campaign report for the same accountId, timeUnit, and time period:\n"," Example of a campaign report with both dimensions LINE_ITEM and ORDER for the same accountId, timeUnit, and time period: \n"],"documentType":"guide"},{"title":"DSP reporting metrics","sectionHeader":null,"path":"/en-us/guides/reporting/dsp/metrics","content":[" All metrics available for the DSP Reporting API.\n"],"documentType":"guide"},{"title":"DSP reporting metrics","sectionHeader":{"type":2,"text":"Performance metrics "},"path":"/en-us/guides/reporting/dsp/metrics","content":[" Request performance metrics to get data on your campaigns. The performance metrics available vary based on report type.\n"," Type: Double\n"," Description: A third-party fee applied to automotive data.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: CPM charge applied to impressions to track Automotive segment fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: The third-party fee applied for using ComScore.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: CPM charge applied to impressions to track ComScore technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: A third-party fee applied.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: CPM charge applied to impressions to track general 3P technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: A third-party fee applied.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: CPM charge applied to impressions to track general 3P technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: A third-party fee applied.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: CPM charge applied to impressions to track general 3P technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: The third-party fee applied for using DoubleClick Campaign Manager.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: CPM charge applied to impressions to track Doubleclick Campaign Manager technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: The third-party fee applied for using DoubleVerify.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: CPM charge applied to impressions to track DoubleVerify technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: The third-party fee applied for using Integral Ad Science.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: CPM charge applied to impressions to track Integral Ad Science technology fees. The cost is itemized in reports, but absorbed by the user and excluded from total costs.\n"," Report types: Campaign, Inventory\n"," Type: Double\n"," Description: The total CPM charges applied for using 3P data providers.\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: The number of Accept pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Accept pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire an Accept pixel conversion. (Accept CPA = Total cost / Accept)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Accept pixel conversions relative to the number of ad impressions. (Accept CVR = Accept / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Accept pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Add to shopping cart pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Add to shopping cart pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire an Add to shopping cart pixel conversion. (ATC CPA = Total cost / ATC)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Add to shopping cart pixel conversions relative to the number of ad impressions. (ATSC CVR = ATSC / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Add to shopping cart pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times Add to Watchlist was clicked on a featured product.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Add to Watchlist clicks attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire an Add to Watchlist click. (eCPATW = Total cost / ATW)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Add to Watchlist clicks relative to the number of impressions. (ATWR = ATW / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Add to Watchlist clicks attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: String\n"," Description: The country assigned to the advertiser.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: A unique identifier assigned to an advertiser.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: String\n"," Description: Advertiser name.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: String\n"," Description: The time zone the advertiser uses for reporting and ad serving purposes.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: A percentage or flat fee removed from the total budget to compensate the agency that is managing the media buy.\n"," Report types: Campaign, Inventory, Technology, Geography\n"," Type: Decimal\n"," Description: CPM charge applied to impressions that leverage Amazon behavioral targeting.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The fee calculated based on a percentage of supply cost for impressions measured by Omnichannel Metrics.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The technology fee applied to the media supply costs.\n"," Report types: Campaign, Inventory, Audience\n"," Type: String\n"," Description: A unique block of letters and/or numbers that identify all products sold on Amazon.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of Application pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of application pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Application pixel conversion. (Application CPA = Total cost / Application)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Application pixel conversions relative to the number of ad impressions. (Application CVR = Application / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Application pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: String\n"," Description: The conversion type describes whether the conversion happened on a promoted or a brand halo ASIN.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of times a promoted ASIN is added to a customer cart.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of add to cart conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Percentage\n"," Description: The number of Add to Cart conversions relative to the number of impressions. (ATCR = ATC / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Add to Cart conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of times a promoted ASIN is added to a customer wish list, gift list or registry.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of Add to List conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Percentage\n"," Description: The number of Add to List conversions relative to the number of impressions. (ATLR = ATL / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Add to List conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of Banner interaction pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Banner interaction pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Banner interaction pixel conversions. (Banner interaction CPA = Total cost / Banner interaction)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Banner interaction pixel conversions relative to the number of ad impressions. (Banner interaction CVR = Banner interaction / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Banner interaction pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times Add to Cart was clicked on other products from the same brands as the products tracked in the order, attributed to an ad.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of Add to Cart clicks attributed to ad click-throughs. These include clicks on other products from the same brands as the ASINs tracked in the order.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of Add to Cart clicks attributed to impressions. These include clicks on other products from the same brands as the ASINs tracked in the order.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of times Add to List was clicked on other products from the same brands as the products tracked in the order, attributed to an ad.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of Add to List clicks attributed to ad click-throughs. These include clicks on other products from the same brands as the ASINs tracked in the order.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of Add to List clicks attributed to impressions. These include clicks on other products from the same brands as the ASINs tracked in the order.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of detail page views on other products from the same brands as the products tracked in the order, attributed to an ad.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of detail page views attributed to ad click-throughs. These include views on other products from the same brands as the ASINs tracked in the order.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of detail page views attributed to impressions. These include views on other products from the same brands as the ASINs tracked in the order.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of Subscribe & Save subscriptions on other products from the same brands as the products tracked in the order, attributed to a view or click on an ad. This count does not include further purchases of the ASIN(s) during replenishing subscriptions.\n"," Report types: Products\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for brand halo products, attributed to an ad click. This does not include replenishment subscription orders. Use Total SnSS clicks to see all conversions for the brands' products.\n"," Report types: Products\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for brand halo products, attributed to an ad view. This does not include replenishment subscription orders. Use Total SnSS views to see all conversions for the brands' products.\n"," Report types: Products\n"," Type: Integer\n"," Description: New-to-brand purchases - brand halo.\n"," Report types: Products\n"," Type: Integer\n"," Description: New-to-brand purchases click-through conversions - brand halo.\n"," Report types: Products\n"," Type: Integer\n"," Description: New-to-brand purchases view-through conversions - brand halo.\n"," Report types: Products\n"," Type: Percentage\n"," Description: Percent of purchases new-to-brand - brand halo.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of Product review page views for other products from the same brands as the products tracked in the order, attributed to an ad.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of Product review page views attributed to ad click-throughs. These include views on other products from the same brands as the ASINs tracked in the order.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of Product review page views attributed to impressions. These include views on other products from the same brands as the ASINs tracked in the order.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of purchases on other products from the same brands as the products tracked in the order, attributed to an ad.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of purchases attributed to ad click-throughs. These include purchases on other products from the same brands as the ASINs tracked in the order.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of purchases attributed to impressions. These include purchases on other products from the same brands as the ASINs tracked in the order.\n"," Report types: Products\n"," Type: Decimal\n"," Description: Sales (in local currency) of brand halo products purchased by new-to-brand shoppers, attributed to an ad view or click. Shoppers are \"new to brand\" if they have not purchased from the brand in the last 365 days. Use Total new-to-brand product sales to see all conversions for the brands' products.\n"," Report types: Products\n"," Type: Integer\n"," Description: Units of promoted products purchased by shoppers who were new-to-brand, attributed to an ad view or click. A single new-to-brand purchase event can include multiple sold units. Use Total new-to-brand units sold to see all conversions for the brands' products.\n"," Report types: Products\n"," Type: Decimal\n"," Description: The total sales (in local currency) of brand halo ASINs purchased by customers on Amazon after delivering an ad.\n"," Report types: Products\n"," Type: Integer\n"," Description: The total quantity of brand halo products purchased by customers on Amazon after delivering an ad. A campaign can have multiple units sold in a single purchase event.\n"," Report types: Products\n"," Type: String\n"," Description: The name of the brand the campaign is advertising.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of times shoppers searched for a brand promoted in the campaign, attributed to an ad interaction.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of branded search conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a branded search conversion. (Cost per branded search = Total cost / Branded searches)\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Percentage\n"," Description: The number of branded search conversions relative to the number of ad impressions. (Branded search rate = Branded searches / Impressions)\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of branded search conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 1 pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 1 pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Brand store engagement 1 pixel conversions. (Brand store engagement 1 CPA = Total cost / Brand store engagement 1)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Brand store engagement 1 pixel conversions relative to the number of ad impressions. (Brand store engagement 1 CVR = Brand store engagement 1 / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Brand store engagement 1 pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 2 pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 2 pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Brand store engagement 2 pixel conversions. (Brand store engagement 2 CPA = Total cost / Brand store engagement 2)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Brand store engagement 2 pixel conversions relative to the number of ad impressions. (Brand store engagement 2 CVR = Brand store engagement 2 / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Brand store engagement 2 pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 3 pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 3 pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Brand store engagement 3 pixel conversions. (Brand store engagement 3 CPA = Total cost / Brand store engagement 3)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Brand store engagement 3 pixel conversions relative to the number of ad impressions. (Brand store engagement 3 CVR = Brand store engagement 3 / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Brand store engagement 3 pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 4 pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 4 pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Brand store engagement 4 pixel conversions. (Brand store engagement 4 CPA = Total cost / Brand store engagement 4)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Brand store engagement 4 pixel conversions relative to the number of ad impressions. (Brand store engagement 4 CVR = Brand store engagement 4 / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Brand store engagement 4 pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 5 pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 5 pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Brand store engagement 5 pixel conversions. (Brand store engagement 5 CPA = Total cost / Brand store engagement 5)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Brand store engagement 5 pixel conversions relative to the number of ad impressions. (Brand store engagement 5 CVR = Brand store engagement 5 / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Brand store engagement 5 pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 6 pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 6 pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Brand store engagement 6 pixel conversions. (Brand store engagement 6 CPA = Total cost / Brand store engagement 6)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Brand store engagement 6 pixel conversions relative to the number of ad impressions. (Brand store engagement 6 CVR = Brand store engagement 6 / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Brand store engagement 6 pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 7 pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Brand store engagement 7 pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Brand store engagement 7 pixel conversions. (Brand store engagement 7 CPA = Total cost / Brand store engagement 7)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Brand store engagement 7 pixel conversions relative to the number of ad impressions. (Brand store engagement 7 CVR = Brand store engagement 7 / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Brand store engagement 7 pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Click on redirect pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Click on redirect pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Click on redirect pixel conversion. (Click on redirect CPA = Total cost / Click on redirect)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Click on redirect pixel conversions relative to the number of ad impressions. (Click on redirect CVR = Click on redirect / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Click on redirect pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: A click on an ad that directs the user to a destination outside of the creative.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a purchase conversion on or off Amazon. (Total cost / Combined purchases)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: Effective (average) revenue for sales on and off Amazon generated per thousand impressions. (Combined Sales / (Impressions / 1000))\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: Sales (in local currency) for purchases on and off Amazon, attributed to an ad view or click.\n"," Report types: Campaign, Inventory, Technology, Geography, Conversion source\n"," Type: Percentage\n"," Description: Rate of attributed purchase events on and off Amazon, relative to ad impressions. (Combined purchases / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: Number of purchase events on and off Amazon, attributed to an ad view or click. (Off-Amazon purchases + Total purchases (Amazon))\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source\n"," Type: Integer\n"," Description: Number of purchase events on and off Amazon, attributed to an ad click. (Off-Amazon purchases clicks + Total purchases clicks (Amazon))\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source\n"," Type: Integer\n"," Description: Number of purchase events on and off Amazon, attributed to an ad view. (Off-Amazon purchases views + Total purchases views (Amazon))\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source\n"," Type: Decimal\n"," Description: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined product sales / Total cost)\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: Units of product sold on and off Amazon, attributed to an ad view or click. A single purchase event can include multiple sold units.\n"," Report types: Campaign, Inventory, Technology, Geography, Conversion source\n"," Type: Percentage\n"," Description: The number of click-throughs relative to the number of impressions.\n"," Report types: Campaign, Inventory, Audience\n"," Type: String\n"," Description: Date.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: String\n"," Description: The type of a deal.\n"," Report types: Inventory\n"," Type: Integer\n"," Description: The number of Decline pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Decline pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Decline pixel conversion. (Decline CPA = Total cost / Decline)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Decline pixel conversions relative to the number of ad impressions. (Decline CVR = Decline / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Decline pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Percentage\n"," Description: The number of downloaded video plays relative to the number of impressions. (Downloaded video play rate = Downloaded video plays / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of times a video was downloaded then played for the featured product.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of downloaded video plays attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of downloaded video plays attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of views of the detail pages of the advertised product on Amazon.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of detail page view conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Percentage\n"," Description: The number of detail page view conversions relative to the number of ad impressions. (DVPR = DPV / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of detail page view conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of Drop down selection pixel conversions\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Drop down selection pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Drop down selection pixel conversion. (Drop down selection CPA = Total cost / Drop down selection)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Drop down selection pixel conversions relative to the number of ad impressions. (Drop down selection CVR = Drop down selection / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Drop down selection pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire an Add to Cart conversion. (eCPATC = Total cost / ATC)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire an Add to List conversion for a promoted product. (eCPATL = Total cost / ATL) Use Total eCPATL to see all conversions for the brands' products.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost paid per click-through.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost to acquire a detail page view conversion. (eCPDPV = Total cost / DPV)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost to acquire a downloaded video play (eCPDVP = Total cost / Downloaded video plays)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The total cost per thousand impressions.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost to acquire a Subscribe & Save subscription. (eCPSnSS = Total cost / SnSS)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost to acquire a purchase. (eCPP = Total cost / Purchases)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost to acquire a product review page view conversion. (eCPPRPV = Total cost / PRPV)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost to acquire a video trailer play (eCPPT = Total cost / Play trailers)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost to acquire a rental (eCPR = Total cost / Rentals)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost to acquire a video complete conversion (eCPVC = Total cost / Video complete)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost to acquire a video download (eCPVD = Total cost / Video downloads)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average cost to acquire a video stream. (eCPVS = Total cost / Video streams)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Email interaction pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Email interaction pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire an Email interaction pixel conversion. (Email interaction CPA = Total cost / Email interaction)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Email interaction pixel conversions relative to the number of ad impressions. (Email interaction CVR = Email interaction / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Email interaction pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Email load pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Email load pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire an Email load pixel conversion. (Email load CPA = Total cost / Email load)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Email load pixel conversions relative to the number of ad impressions. (Email load CVR = Email load / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Email load pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: String\n"," Description: Entity (seat) ID.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: Decimal\n"," Description: The average revenue generated per thousand impressions. (eRPM = Sales / (Impressions / 1000))\n"," Report types: Campaign, Inventory\n"," Type: String\n"," Description: The Amazon Standard Identification Number (ASIN) that was set as featured in the campaign.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of Game interaction pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Game interaction pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Game interaction pixel conversions. (Game interaction CPA = Total cost / Game interaction)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Game interaction pixel conversions relative to the number of ad impressions. (Game interaction CVR = Game interaction / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Game interaction pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Game load pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Game load pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Game load pixel conversion. (Game load CPA = Total cost / Game load)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Game load pixel conversions relative to the number of ad impressions. (Game load CVR = Game load / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Game load pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The total number of times the ad was clicked. This includes valid, potentially fraudulent, non-human, and other illegitimate clicks. This metric is available from Jul 1, 2021. Selecting a date range before Jul 1, 2021, will lead to incomplete or inaccurate results.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The total number of times the ad was displayed. This includes valid and invalid impressions such as potentially fraudulent, non-human, and other illegitimate impressions. This metric is available from Jul 1, 2021. Selecting a date range before Jul 1, 2021, will lead to incomplete or inaccurate results.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Homepage visit pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Homepage visit pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Homepage visit pixel conversion. (Homepage visit CPA = Total cost / Homepage visit)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Homepage visit pixel conversions relative to the number of ad impressions. (Homepage visit CVR = Homepage visit / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Homepage visit pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times an ad was displayed.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: End date of report data.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: Integer\n"," Description: Start date of report data.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: Integer\n"," Description: Clicks that were removed by the traffic quality filter. This includes potentially fraudulent, non-human, and other illegitimate traffic. This metric is available from Jul 1, 2021. Selecting a date range before Jul 1, 2021, will lead to incomplete or inaccurate results.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Percentage\n"," Description: The percentage of gross click-throughs that were removed by the traffic quality filter. (Invalid click-throughs rate = invalid click-throughs / gross click-throughs) This metric is available from Jul 1, 2021. Selecting a date range before Jul 1, 2021, will lead to incomplete or inaccurate results.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Percentage\n"," Description: The percentage of gross impressions that were removed by the traffic quality filter. (Invalid impression rate = invalid impressions / gross impressions) This metric is available from Jul 1, 2021. Selecting a date range before Jul 1, 2021, will lead to incomplete or inaccurate results.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of impressions removed by a traffic quality filter. This includes potentially fraudulent, non-human, and other illegitimate traffic. This metric is available from Jul 1, 2021. Selecting a date range before Jul 1, 2021, will lead to incomplete or inaccurate results.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Marketing landing page pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Marketing landing page pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Marketing landing page pixel conversion. (Landing page CPA = Total cost / Landing page)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Marketing landing page pixel conversions relative to the number of ad impressions. (Marketing landing page CVR = Marketing landing page / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Marketing landing page pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup Add to Cart click pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Percentage\n"," Description: The number of Mashup Add to Cart click pixel conversions relative to the number of ad impressions. (Mashup Add to Cart click CVR = Mashup Add to Cart click / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Mashup Add to Cart click pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Mashup Add to Cart click pixel conversion. (Mashup Add to Cart click CPA = Total cost / Ad ATC)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Mashup Add to Cart click pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup Add to Wishlist click conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup Add to Wishlist click pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Mashup Add to Wishlist click conversion. (Mashup Add to Wishlist click CPA = Total cost / Mashup Add to Wishlist click)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Mashup Add to Wishlist click pixel conversions relative to the number of ad impressions. (Mashup Add to Wishlist click CVR = Mashup Add to Wishlist click / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Mashup Add to Wishlist click pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup backup image click pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup backup image click pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Mashup backup image click pixel conversion. (Mashup backup image CPA = Total cost / Mashup backup image)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Mashup backup image click pixel conversions relative to the number of ad impressions. (Mashup backup image CVR = Mashup backup image / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Mashup backup image click pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup click to page pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup click to page pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Mashup click to page pixel conversion. (Ad click CPA = Total cost / Ad click)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Mashup click to page pixel conversions relative to the number of ad impressions. (Mashup click to page CVR = Ad click / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Mashup click to page pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup Clip Coupon click pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup Clip Coupon click pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Mashup Clip Coupon click pixel conversion. (Mashup CC click CPA = Total cost / Coupon)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Mashup Clip Coupon click pixel conversions relative to the number of ad impressions. (Mashup CC click CVR = Coupon / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Mashup Clip Coupon click pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup Shop Now click pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup Shop Now click pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Mashup Shop Now click pixel conversion. (Mashup SN click CPA = Total cost / Mashup SN click)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Mashup Shop Now click pixel conversions relative to the number of ad impressions. (Mashup SN click CVR = Mashup SN click / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Mashup Shop Now click pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup Subscribe and Save click pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup Subscribe and Save click pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mashup Subscribe and Save click pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Mashup Subscribe and Save click pixel conversion. (Mashup SnS click CPA = Total cost / Ad SnS)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Mashup Subscribe and Save click pixel conversions relative to the number of ad impressions. (Mashup SnS click CVR = Ad SnS / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: Number of impressions that were measured for viewability. The viewability metrics are available from October 1, 2019. Selecting a date range prior to October 1, 2019 will result in incomplete or inaccurate metrics.\n"," Report types: Campaign, Inventory\n"," Type: Percentage\n"," Description: Measurable impressions / total impressions. The viewability metrics are available from October 1, 2019. Selecting a date range prior to October 1, 2019 will result in incomplete or inaccurate metrics.\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: The number of Message sent pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Message sent pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Message sent pixel conversion. (Message sent CPA = Total cost / Message send)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Message sent pixel conversions relative to the number of ad impressions. (Message sent CVR = Message sent / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Message sent pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Mobile app first start conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Percentage\n"," Description: The number of Mobile app first start conversions relative to the number of ad impressions. (Mobile app first start CVR = Mobile app first start / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: Mobile app first start view-through conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Mobile app first start conversion. (Mobile app first start CPA = Total cost / Mobile app first starts)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Mobile app first start conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of new Subscribe & Save subscriptions attributed to a view or click on an ad. This count does not include orders of the ASIN(s) from replenishment subscription orders. New subscriptions are also included in the Purchase count.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of Subscribe & Save subscriptions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Percentage\n"," Description: The number of Subscribe & Save subscriptions relative to the number of impressions. (SnSSR = SnSS / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Subscribe & Save subscriptions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a new-to-brand purchase for promoted products (New-to-brand CPP = Total cost / New-to-brand purchases). Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: The average revenue generated per thousand impressions by purchasing a promoted product for the first time over a one-year lookback period. (NTB eRPM BH = NTB Sales BH / (Impressions / 1000)). Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: The total sales (in local currency) of promoted products purchased for the first time over a one-year lookback window by customers on Amazon. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Products, Technology, Geography\n"," Type: Percentage\n"," Description: The number of new-to-brand purchases for promoted products relative to the number of ad impressions. (New-to-brand purchase rate = New-to-brand purchases / Impressions) Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of first-time purchases for promoted products within the brand over a one-year lookback window. Purchases include Subscribe & Save subscriptions and video rentals. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of new-to-brand purchases for promoted products attributed to ad click-throughs. Purchases include Subscribe & Save subscriptions and video rentals. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of new-to-brand purchases for promoted products attributed to ad impressions. Purchases include Subscribe & Save subscriptions and video rentals. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Decimal\n"," Description: Ad-attributed new-to-brand purchases for promoted products per local currency unit of ad spend (New-to-brand ROAS = New-to-brand sales / Total cost). Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: The quantity of promoted products purchased for the first time within the brand over a one-year lookback period after delivering an ad. A campaign can have multiple units sold in a single purchase event. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of conversions that occured off Amazon attributed to an ad click. This includes all conversion types.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire an Off-Amazon conversion. (Off-Amazon CPA = Total cost / Off-Amazon)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Off-Amazon conversions relative to the number of ad impressions. (Off-Amazon CVR = Off-Amazon / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: Effective (average) cost to acquire a purchase conversion for an Off-Amazon purchase event.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Decimal\n"," Description: Effective (average) revenue for sales included in off-Amazon purchases generated per thousand impressions. (Off-Amazon sales / (Impressions / 1000))\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: Sales (in local currency) for off-Amazon purchases, attributed to an ad view or click.\n"," Report types: Campaign, Inventory, Conversion source\n"," Type: Percentage\n"," Description: Rate of ad-attributed purchase events for products included in Off-Amazon purchase events, relative to ad impressions.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: Number of times any quantity of a product was included in an Off-Amazon purchase event, attributed to an ad view or click.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source\n"," Type: Integer\n"," Description: Number of times any quantity of a product was included in an Off-Amazon purchase event, attributed to an ad click.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source\n"," Type: Integer\n"," Description: Number of times any quantity of a product was included in an Off-Amazon purchase event, attributed to an ad view.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source\n"," Type: Decimal\n"," Description: Return on advertising spend for products included in off-Amazon purchase events, measured as ad-attributed sales per local currency unit of ad spend. (Off-Amazon product sales / Total cost)\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: Units of product purchased off Amazon, attributed to an ad view or click. A single purchase event can include multiple sold units.\n"," Report types: Campaign, Inventory, Conversion source\n"," Type: Integer\n"," Description: The number of conversions that occured off Amazon attributed to an ad view. This includes all conversion types.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source\n"," Type: String\n"," Description: The Amazon Standard Identification Number (ASIN) that is the parent of this ASIN.\n"," Report types: Products\n"," Type: Percentage\n"," Description: The percent of purchases that were first-time purchases for promoted products within the brand over a one-year lookback window. Purchases include Subscribe & Save subscriptions and video rentals. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Audience, Products\n"," Type: String\n"," Description: The name of the placement the campaign was run. Only available when \"site\" is a dimension.\n"," Report types: Inventory\n"," Type: String\n"," Description: The dimensions of the placement in pixels.  Only available when \"site\" is a dimension.\n"," Report types: Inventory\n"," Type: Integer\n"," Description: The number of video trailer plays attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Percentage\n"," Description: The number of video trailer plays relative to the number of impressions. (Play trailer rate = Play trailers / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of times a video trailer was played for the featured product.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of video trailer players attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: String\n"," Description: Postal code.\n"," Report types: Geography\n"," Type: String\n"," Description: A classification for the type of product being sold which determines its place in the Amazon retail catalog. Contains subcategories.\n"," Report types: Products\n"," Type: String\n"," Description: A distinct product grouping distinguishing products like books from watches and video games from toys. Contains categories.\n"," Report types: Products\n"," Type: String\n"," Description: The name of the product sold as it appears in the Amazon retail catalog.\n"," Report types: Products\n"," Type: String\n"," Description: A classification for the type of product being sold which determines its place in the Amazon retail catalog.\n"," Report types: Products\n"," Type: Integer\n"," Description: The number of views of the customer review pages of the advertised product on Amazon. This includes views on either the Read All Reviews page or individual review pages.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of Product review page view conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Percentage\n"," Description: The number of product review page views relative to the number of ad impressions. (PRPVR = PRPV / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of product review page view conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of Purchase button pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Purchase button pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Purchase button pixel conversions. (Purchase button CPA = Total cost / Purchase button)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Purchase button pixel conversions relative to the number of ad impressions. (Purchase button CVR = Purchase button / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Purchase button pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Percentage\n"," Description: The number of purchases relative to the number of impressions. (Purchase rate = Purchases / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of times any amount of a promoted product or products are included in a purchase event. Purchase events include video rentals and new Subscribe & Save subscriptions.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of purchases attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of purchases attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of Referral pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Referral pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Referral pixel conversion. (Referral CPA = Total cost / Referral)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Referral pixel conversions relative to the number of ad impressions. (Referral CVR = Referral / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Referral pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Registration confirm page pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Registration confirm page pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Registration confirm page pixel conversion. (registration confirm page CPA = Total cost / Registration confirm page)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Registration confirm page pixel conversions relative to the number of ad impressions. (Registration confirm page CVR = Registration confirm page / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Registration confirm page pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Registration form pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Registration form pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Registration form pixel conversion. (Registration form CPA = Total cost / Registration confirm page)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Registration form pixel conversions relative to the number of ad impressions. (Registration form CVR = Registration form / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Registration form pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Percentage\n"," Description: The number of video rentals relative to the number of impressions. (Rental rate = Rentals / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of times a video was rented for the featured product.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of video rentals attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of video rentals attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: String\n"," Description: Granularity at ASIN or Parent ASIN level.\n"," Report types: Products\n"," Type: Decimal\n"," Description: Ad-attributed product sales per local currency unit of ad spend. (ROAS = Product sales / Total cost)\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: The total sales (in local currency) of promoted ASINs purchased by customers on Amazon after delivering an ad.\n"," Report types: Campaign, Inventory, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of Sign-up conversions\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Sign-up conversions attributed to an ad click.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Sign-up conversion. (Sign-up CPA = Total cost / Sign-up)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Sign-up conversions relative to the number of ad impressions. (Sign-up CVR = Sign-up/ Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Sign-up page conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Sign up page conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Sign up page conversion. (Sign up page CPA = Total cost / Sign up page)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Sign up page conversions relative to the number of ad impressions. (Sign up page CVR = Sign up page / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Sign up page conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Sign-up conversions attributed to an ad view.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Store locator page pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Store locator page pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Store locator page pixel conversion. (Store locator page CPA = Total cost / Store locator page)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Success page pixel conversions relative to the number of ad impressions. (Success page CVR = Success page / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Store locator page pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Submit button pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Submit button pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire Submit button pixel conversions. (Submit button CPA = Total cost / Submit button)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Submit button pixel conversions relative to the number of ad impressions. (Submit button CVR = Submit button / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Submit button pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Subscribe conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Subscribe conversions attributed to an ad click.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Subscribe conversion. (Subscribe CPA = Total cost / Subscribe)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Subscribe conversions relative to the number of ad impressions. (Subscribe CVR = Subscribe / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Subscribe conversions attributed to an ad view.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Subscription button pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Subscription button pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Subscription button pixel conversion. (Subscribe CPA = Total cost / Subscribe)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Subscription button pixel conversions relative to the number of ad impressions. (Subscription button CVR = Subscription button / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Subscription button pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Success page pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Subscription button pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Success page pixel conversions. (Success page CPA = Total cost / Success page)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Success page pixel conversions relative to the number of ad impressions. (Success page CVR = Success page / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Success page pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The total amount of money spent on media supply.\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Survey finish pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Survey finish pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Survey finish pixel conversion. (Survey finish CPA = Total cost / Survey end)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Survey finish pixel conversions relative to the number of ad impressions. (Survey finish CVR = Survey end / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Survey finish pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Survey start pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Survey start pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Survey start pixel conversion. (Survey start CPA = Total cost / Survey start)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Survey start pixel conversions relative to the number of ad impressions. (Survey start CVR = Survey start / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Survey start pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: String\n"," Description: The targeting settings applied to the campaign. Examples include segments, content categories, and untargeted if no settings were applied.\n"," Report types: Audience\n"," Type: Integer\n"," Description: The number of Thank you page pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Thank you page pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Thank you page pixel conversions. (Thank you page CPA = Total cost / Thank you page)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Thank you page pixel conversions relative to the number of ad impressions. (Thank you page CVR = Thank you page / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Thank you page pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times an ASIN is added to a customer cart. This counts adds for promoted products as well as products from the same brands as the products tracked in the order. (Total ATC = ATC + ATC BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Integer\n"," Description: The number of Total Add to Carts attributed to ad click-throughs. This includes adds for promoted products as well as products from the same brands as the products tracked in the order. (Total ATC clicks = ATC clicks + ATC clicks BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Decimal\n"," Description: The average cost to acquire a Total Add to Cart conversion. This includes the cost to acquire a Total Add to Cart conversion for promoted products as well as products from the same brands as the products tracked in the order. (Total eCPATC = Total cost / Total ATC)\n"," Report types: Campaign, Inventory\n"," Type: Percentage\n"," Description: The number of Total Add to Cart conversions relative to the number of ad impressions. (Total ATC = Total ATC / Impressions)\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: The number of Total Add to Carts attributed to impressions. This includes adds for promoted products as well as products from the same brands as the products tracked in the order. (Total ATC views = ATC views + ATC views BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Integer\n"," Description: The number of times a promoted ASIN is added to a customer wish list, gift list or registry. This counts adds for promoted products as well as products from the same brands as the products tracked in the order. (Total ATL = ATL + ATL BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Integer\n"," Description: The number of Total Add to Lists attributed to ad click-throughs. This includes adds for promoted products as well as products from the same brands as the products tracked in the order. (Total ATL clicks = ATL clicks + ATL clicks BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Decimal\n"," Description: The average cost to acquire a Total Add to List conversion. This includes the cost to acquire a Total Add to List conversion for promoted products as well as products from the same brands as the products tracked in the order. (Total eCPATL = Total cost / Total ATL)\n"," Report types: Campaign, Inventory\n"," Type: Percentage\n"," Description: The number of Total Add to List conversions relative to the number of ad impressions. (Total ATL = Total ATL / Impressions)\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: The number of Total Add to Lists attributed to impressions. This includes adds for promoted products as well as products from the same brands as the products tracked in the order. (Total ATL views = ATL views + ATL views BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Decimal\n"," Description: The total amount of money spent on running the campaign not including 3P fees paid by the agency.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Total detail page view conversions attributed to ad click-throughs. This includes click-throughs for promoted products as well as products from the same brands as the products tracked in the order. (Total DPV clicks = DPV clicks + DPV clicks BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Integer\n"," Description: The number of ad-attributed detail page views on Amazon. This includes views for promoted products as well as products from the same brands as the products tracked in the order. (Total DPV = DPV + DPV BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Percentage\n"," Description: The number of Total detail page view conversions relative to the number of ad impressions. (Total DPVR = Total DPV / Impressions)\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: The number of Total detail page view conversions attributed to impressions. This includes views for promoted products as well as products from the same brands as the products tracked in the order. (Total DPV views = DPV views + DPV views BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Decimal\n"," Description: The average cost to acquire a Total detail page view conversion. This includes the cost to acquire a Detail page view conversion for promoted products as well as products from the same brands as the products tracked in the order. (Total eCPDPV = Total cost / Total DPV)\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: The average cost to acquire a Total purchase conversion. This includes the cost to acquire a Total purchase for promoted products as well as products from the same brands as the products tracked in the order. (Total eCPP = Total cost / Total purchases)\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: The average cost to acquire a Total product review page view conversion. This includes the cost to acquire a product review page view conversion for promoted products as well as products from the same brands as the products tracked in the order. (Total eCPPRPV = Total cost / Total PRPV)\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: The average revenue generated per thousand impressions. This includes revenue for promoted products tracked in orders and products from the same brands as the products tracked in orders. (Total eRPM = Total sales / (Impressions / 1000))\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: The sum of all fees.\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: The average cost to acquire a new-to-brand purchase for both promoted and brand halo products (Total new-to-brand eCPP = Total cost / Total new-to-brand purchases). Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: The average revenue generated per thousand impressions by purchasing a promoted or brand halo product for the first time over a one-year lookback period. (Total NTB eRPM = NTB Sales / (Impressions / 1000)). Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: The total sales (in local currency) of promoted and brand halo products purchased for the first time over a one-year lookback window by customers on Amazon. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory\n"," Type: Percentage\n"," Description: The number of new-to-brand purchases for both promoted and brand halo products relative to the number of ad impressions. (Total new-to-brand purchase rate = Total new-to-brand purchases / Impressions). Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: The number of first-time purchases for promoted or brand halo products within the brand over a one-year lookback window. Purchases include Subscribe & Save subscriptions and video rentals. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Products\n"," Type: Integer\n"," Description: The number of new-to-brand purchases for promoted and brand halo products attributed to ad click-throughs. Purchases include Subscribe & Save subscriptions and video rentals. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Products\n"," Type: Integer\n"," Description: The number of new-to-brand purchases for promoted and brand halo products attributed to ad impressions. Purchases include Subscribe & Save subscriptions and video rentals. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Products\n"," Type: Decimal\n"," Description: Ad-attributed new-to-brand purchases per local currency unit of ad spend (Total new-to-brand ROAS = Total new-to-brand sales / Total cost). This includes purchases for both promoted and brand halo products. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: The quantity of promoted and brand halo products purchased for the first time within the brand over a one-year lookback period after delivering an ad. A campaign can have multiple units sold in a single purchase event. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory\n"," Type: Percentage\n"," Description: The percent of purchases that were first-time purchases for promoted and brand halo products within the brand over a one-year lookback window. Purchases include Subscribe & Save subscriptions and video rentals. Note: New-to-brand data is available from November 1st, 2018. Selecting a date range prior to November 1st will result in incomplete or inaccurate new-to-brand reporting.\n"," Report types: Campaign, Inventory, Products\n"," Type: Integer\n"," Description: The number of ad-attributed product review page views on Amazon. This includes views on either the Read All Reviews page or individual review pages. This counts views for promoted products as well as products from the same brands as the products tracked in the order. (Total PRPV = PRPV + PRPV BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Integer\n"," Description: The number of Total product review page view conversions attributed to ad click-throughs. This includes click-throughs for promoted products as well as products from the same brands as the products tracked in the order. (Total PRPV clicks = PRPV clicks + PRPV clicks BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Percentage\n"," Description: Rate of product review page visits for promoted products, relative to the number of ad impressions. (ATCR = ATC / Impressions) Use Total PRPVR to see all conversions for the brands' products.\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: The number of Total product review page view conversions attributed to impressions. This includes views for promoted products as well as products from the same brands as the products tracked in the order. (Total PRPV views = PRPV views + PRPV views BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Percentage\n"," Description: The number of Total purchase conversions relative to the number of ad impressions. (Total purchase rate = Total purchases / Impressions)\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: The number of times any number of products are included in a single purchase event. Purchase events include Subscribe & Save subscriptions and video rentals. This counts purchases for promoted products as well as products from the same brands as the products tracked in the order. (Total purchases = Purchases + Purchases BH)\n"," Report types: Campaign, Inventory, Products, Conversion source\n"," Type: Integer\n"," Description: The number of Total purchases attributed to ad click-throughs. This includes click-throughs for promoted products as well as products from the same brands as the products tracked in the order. (Total purchases clicks = Purchases clicks + Purchases clicks BH)\n"," Report types: Campaign, Inventory, Products, Conversion source\n"," Type: Integer\n"," Description: The number of Total purchases attributed to impressions. This includes purchases for promoted products as well as products from the same brands as the products tracked in the order. (Total purchases views = Purchases views + Purchases views BH)\n"," Report types: Campaign, Inventory, Products, Conversion source\n"," Type: Decimal\n"," Description: Ad-attributed product sales per local currency unit of ad spend. Includes both sales of promoted products tracked in orders and products from the same brands as the products tracked. (Total ROAS = Total Sales / Total cost)\n"," Report types: Campaign, Inventory\n"," Type: Decimal\n"," Description: The total sales (in local currency) of promoted ASINs and ASINs from the same brands as promoted ASINs purchased by customers on Amazon after delivering an ad.\n"," Report types: Campaign, Inventory, Products, Conversion source\n"," Type: Integer\n"," Description: The number of Total Subscribe & Save subscriptions attributed to ad click-throughs. This includes subscriptions for promoted products as well as products from the same brands as the products tracked in the order. (Total SnSS clicks = SnSS clicks + SnSS clicks BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Decimal\n"," Description: The average cost to acquire a Total Subscribe & Save subscriptions conversion. This includes the cost to acquire a Total Subscribe & Save subscriptions for promoted products as well as products from the same brands as the products tracked in the order. (Total eCPSnSS = Total cost / Total SnSS)\n"," Report types: Campaign, Inventory\n"," Type: Percentage\n"," Description: Rate of ad-attributed Subscribe & Save conversions for the brands’ products relative to ad impressions. (Total SnSSR = Total SnSS / Impressions)\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: Number of new Subscribe & Save subscriptions for the brands’ products, attributed to an ad view or click. This does not include replenishment subscription orders.\n"," Report types: Campaign, Inventory, Products\n"," Type: Integer\n"," Description: The number of Total Subscribe & Save subscriptions attributed to impressions. This includes subscriptions for promoted products as well as products from the same brands as the products tracked in the order. (Total SnSS views = SnSS views + SnSS views BH)\n"," Report types: Campaign, Inventory, Products\n"," Type: Integer\n"," Description: The total quantity of promoted products and products from the same brand as promoted products purchased by customers on Amazon after delivering an ad. A campaign can have multiple units sold in a single purchase event.\n"," Report types: Campaign, Inventory, Products, Conversion source\n"," Type: Integer\n"," Description: The total quantity of promoted products purchased by customers on Amazon after delivering an ad. A campaign can have multiple units sold in a single purchase event.\n"," Report types: Campaign, Inventory, Products, Technology, Geography\n"," Type: Integer\n"," Description: The number of times a video ad played to completion. If rewind occurred, completion was calculated on the total percentage of unduplicated video viewed.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of video completed pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Video completed pixel conversion. (Video completed CPA = Total cost / Video completed)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of video completed pixel conversions relative to the number of ad impressions. (Video completed CVR = Video end / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of video completed pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Double\n"," Description: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of video downloads relative to the number of impressions. (Video download rate = Video downloads / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of times a video was downloaded for the featured product.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of video downloads attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of video downloads attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of video completed pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times at least 25% of a video ad played. If rewind occurred, percent complete was calculated on the total percentage of unduplicated video viewed.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times at least 50% of a video ad played. If rewind occurred, percent complete was calculated on the total percentage of unduplicated video viewed.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times a user muted the video ad.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times a user paused the video ad.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times a user unpaused the video ad.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times a video ad was started.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of video started pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of video started pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a video started pixel conversion. (Video started CPA = Total cost / Video started)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of video started pixel conversions relative to the number of ad impressions. (Video started CVR = Video started / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of video started pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times a video was streamed (played without downloading).\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of video streams attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Double\n"," Description: The number of video streams relative to the number of impressions. (Video stream rate = Video streams / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of video streams attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times at least 75% of a video ad played. If rewind occurred, percent complete was calculated on the total percentage of unduplicated video viewed.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of times a user unmuted the video ad.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Percentage\n"," Description: Viewable impressions / measurable impressions. The viewability metrics are available from October 1, 2019. Selecting a date range prior to October 1, 2019 will result in incomplete or inaccurate metrics.\n"," Report types: Campaign, Inventory\n"," Type: Integer\n"," Description: Number of impressions that met the Media Ratings Council (MRC) viewability standard. See viewability details at https&#x3A;//advertising.amazon.com/library/guides/viewability.\n"," Report types: Campaign, Inventory, Technology, Geography\n"," Type: Integer\n"," Description: The number of Widget interaction pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Widget interaction pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Widget interaction pixel conversions. (Widget interaction CPA = Total cost / Widget interaction)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Widget interaction pixel conversions relative to the number of ad impressions. (Widget interaction CVR = Widget interaction / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Widget interaction pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Widget load pixel conversions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Widget load pixel conversions attributed to ad click-throughs.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Decimal\n"," Description: The average cost to acquire a Widget load pixel conversion. (Widget load CPA = Total cost / Widget load)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Percentage\n"," Description: The number of Widget load pixel conversions relative to the number of ad impressions. (Widget load CVR = Widget load / Impressions)\n"," Report types: Campaign, Inventory, Audience\n"," Type: Integer\n"," Description: The number of Widget load pixel conversions attributed to ad impressions.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography\n"," Type: Integer\n"," Description: The number of Checkout conversions.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Checkout conversions attributed to an ad click.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Decimal\n"," Description: The average cost to acquire a Checkout conversion. (Checkout CPA = Total cost / Checkout)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Percentage\n"," Description: The number of Checkout conversions relative to the number of ad impressions. (Checkout CVR = Checkout / Impressions)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Checkout conversions attributed to an ad view.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Contact conversions.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Contact conversions attributed to an ad click.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Decimal\n"," Description: The average cost to acquire a Contact conversion. (Contact CPA = Total cost / Contact)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Percentage\n"," Description: The number of Contact conversions relative to the number of ad impressions. (Contact CVR = Contact / Impressions)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Contact conversions attributed to an ad view.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Lead conversions.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Lead conversions attributed to an ad click.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Decimal\n"," Description: The average cost to acquire a Lead conversion. (Lead CPA = Total cost / Lead)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Percentage\n"," Description: The number of Lead conversions relative to the number of ad impressions. (Lead CVR = Lead / Impressions)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Lead conversions attributed to an ad view.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Other conversions.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Other conversions attributed to an ad click.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Decimal\n"," Description: The average cost to acquire an Other conversion. (Other CPA = Total cost / Other)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Percentage\n"," Description: The number of Other conversions relative to the number of ad impressions. (Other CVR = Other / Impressions)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Other conversions attributed to an ad view.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Page view conversions.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Page view conversions attributed to an ad click.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Decimal\n"," Description: The average cost to acquire a Page view conversion. (Page view CPA = Total cost / Page view)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Percentage\n"," Description: The number of Page view conversions relative to the number of ad impressions. (Page view CVR = Page view / Impressions)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Page view conversions attributed to an ad view.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Search conversions.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Search conversions attributed to an ad click.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Decimal\n"," Description: The average cost to acquire a Search conversion. (Search CPA = Total cost / Search)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Percentage\n"," Description: The number of Search conversions relative to the number of ad impressions. (Search CVR = Search / Impressions)\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"," Type: Integer\n"," Description: The number of Search conversions attributed to an ad view.\n"," Report types: Campaign, Inventory, Audience, Geography, Technology\n"],"documentType":"guide"},{"title":"DSP reporting metrics","sectionHeader":{"type":2,"text":"Dimensional metrics "},"path":"/en-us/guides/reporting/dsp/metrics","content":[" The DSP reporting API includes dimensional metrics automatically based on your selected report type and dimensions. If you include dimensional metrics in your request body, you will receive an error.\n"," Type: String\n"," Description: The web browsers the customers used to view the ad.\n"," Report types: Technology\n"," Type: String\n"," Description: The specific browser versions the customers used to view the ad.\n"," Report types: Technology\n"," Type: String\n"," Description: City.\n"," Report types: Geography\n"," Type: String\n"," Description: Indicates whether the attribution method is owned by Amazon or a third party.\n"," Report types: Conversion source\n"," Type: String\n"," Description: The name of the conversion source (Amazon or a third party).\n"," Report types: Conversion source\n"," Type: String\n"," Description: Indicates whether the conversion source is Amazon or an Amazon partner.\n"," Report types: Conversion source\n"," Type: Boolean\n"," Description: Indicates whether the data has been scaled from a smaller sample to represent a broader market measurement.\n"," Report types: Conversion source\n"," Type: String\n"," Description: Country.\n"," Report types: Geography\n"," Type: Integer\n"," Description: A unique identifier assigned to a creative. When this is different from creativeId, creativeAdId is the value that can be used in our /dsp/creatives endpoints.\n"," Report types: Campaign\n"," Type: Integer\n"," Description: A unique identifier assigned to a creative. When this is different from creativeAdId, creativeId cannot be used in our /dsp/creatives endpoints.\n"," Report types: Campaign\n"," Type: String\n"," Description: Creative name.\n"," Report types: Campaign\n"," Type: String\n"," Description: The dimensions of the creative in pixels.\n"," Report types: Campaign\n"," Type: String\n"," Description: The type of creative (for example static image, third party, or video).\n"," Report types: Campaign\n"," Type: String\n"," Description: The name of a deal.\n"," Report types: Inventory\n"," Type: Integer\n"," Description: The unique identifier for the deal.\n"," Report types: Inventory\n"," Type: String\n"," Description: The Designated Market Areas® (DMA) the customers were in when they viewed the ad. DMA regions are created and defined by Nielsen.\n"," Report types: Geography\n"," Type: String\n"," Description: The Designated Market Areas® (DMA) the customers were in when they viewed the ad. DMA regions are created and defined by Nielsen.\n"," Report types: Geography\n"," Type: String\n"," Description: The devices the customers used to view the ad.\n"," Report types: Technology\n"," Type: String\n"," Description: Break the data down by which environment the bid request came from: web or app. This dimension is connected to web and app inventory, not line item types.\n"," Report types: Technology\n"," Type: Decimal\n"," Description: The total amount of money that be consumed by a line item.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: Integer\n"," Description: The last day a line item is eligible to run.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: String\n"," Description: Line item custom ID optionally entered by user.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: Integer\n"," Description: A unique identifier assigned to a line item.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: String\n"," Description: Line item name.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: Integer\n"," Description: The first day a line item is eligible to run.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: String\n"," Description: The type of line item (for example standard display, Mobile app, or Facebook).\n"," Report types: Audience\n"," Type: Integer\n"," Description: Indicates how many hours after the event the data provider may upload conversion data.\n"," Report types: Conversion source\n"," Type: String\n"," Description: The operating systems the customers used to view the ad.\n"," Report types: Technology\n"," Type: Decimal\n"," Description: The total amount of money that be consumed by an order.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: String\n"," Description: Order currency.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: Integer\n"," Description: The last day a line item within an order is eligible to run.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: Integer\n"," Description: A unique identifier assigned to an order.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: String\n"," Description: A user defined identifier for an order or line item.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: String\n"," Description: Order name.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: Integer\n"," Description: The first day a line item within an order is eligible to run.\n"," Report types: Campaign, Inventory, Audience, Technology, Geography, Conversion source, Products\n"," Type: String\n"," Description: State or region.\n"," Report types: Geography\n"," Type: String\n"," Description: The name of the audience segment.\n"," Report types: Audience\n"," Type: String\n"," Description: The site or group of sites the campaign ran on.\n"," Report types: Inventory\n"," Type: String\n"," Description: The inventory the campaign ran on, for example real-time bidding exchanges or Amazon-owned sites.\n"],"documentType":"guide"},{"title":"DSP reporting dimensions","sectionHeader":null,"path":"/en-us/guides/reporting/dsp/dimensions","content":[" Dimensions determine the aggregation level of your report data. The available dimensions depend on the chosen report type. Each dimension also adds certain metrics to your report automatically. Use the table below to understand which dimensions are available for each report type and which metrics are automatically added.\n"],"documentType":"guide"},{"title":"DSP reporting dimensions","sectionHeader":{"type":3,"text":"Summary table"},"path":"/en-us/guides/reporting/dsp/dimensions","content":["|Dimension\t|Report types\t|Default metrics\t|\n","|---\t|---\t|---\t|\n","|Order\t|All\t|orderNameorderIdorderStartDateorderEndDateorderBudgetorderExternalIdorderCurrency\t|\n","|Line_item\t|All\t|lineItemNamelineItemIdlineItemStartDatelineItemEndDatelineItemBudgetlineItemExternalId\t|\n","|Creative\t|CampaignConversion_source\t|creativeNamecreativeIDcreativeTypecreativeSizecreativeAdId (not available for CONVERSION_SOURCE reports)\t|\n","|Site\t|Inventory\t|siteName\t|\n","|Supply\t|Inventory\t|supplySourceName\t|\n","|Deal\t|Inventory\t|dealdealID\t|\n","|Country\t|Geography\t|country\t|\n","|State_country_region\t|Geography\t|region\t|\n","|City\t|Geography\t|city\t|\n","|DMA\t|Geography\t|designatedMarketAreaCodedesignatedMarketAreaName\t|\n","|Postal_code\t|Geography\t|postalCode\t|\n","|Operating_system\t|Technology\t|operatingSystem\t|\n","|Browser_type\t|Technology\t|browser\t|\n","|Browser_version\t|Technology\t|browserVersion\t|\n","|Device_type\t|Technology\t|device\t|\n","|Environment\t|Technology\t|environmentType\t|\n"],"documentType":"guide"},{"title":"DSP reporting dimensions","sectionHeader":{"type":2,"text":"Default metrics for each dimension"},"path":"/en-us/guides/reporting/dsp/dimensions","content":[" Each dimension automatically includes some default metrics in your report data. If you try to specify these default metrics in the metrics list in your request body, you will receive an error. \n"],"documentType":"guide"},{"title":"DSP reporting dimensions","sectionHeader":{"type":3,"text":"Example error from including default metric in request body "},"path":"/en-us/guides/reporting/dsp/dimensions","content":[" This erroneous request has report type Geography and dimension DMA:\n"," The API returns an error due to including  designatedMarketAreaCode, a default metric for the DMA dimension, in the metrics field:\n"],"documentType":"guide"},{"title":"Reporting in the DSP console vs. API","sectionHeader":null,"path":"/en-us/guides/reporting/dsp/console-vs-api","content":[" The DSP console provides advertisers and agencies with a UI to manually download reporting data. There are a few key differences between the DSP console report center and reports retrieved using the API.\n"],"documentType":"guide"},{"title":"Reporting in the DSP console vs. API","sectionHeader":{"type":2,"text":"Metrics"},"path":"/en-us/guides/reporting/dsp/console-vs-api","content":[" The DSP console supports more metrics compared to the API. The metrics available differ based on whether you have a self-service or managed account. \n","|API field name\t|Console field name\t|\n","|---\t|---\t|\n","|date\t|Date\t|\n","|intervalStart\t|Interval start\t|\n","|intervalEnd\t|Interval end\t|\n","|entityId\t|Entity ID\t|\n","|advertiserName\t|Advertiser name\t|\n","|advertiserId\t|Advertiser Id\t|\n","|orderName\t|Order name\t|\n","|orderId\t|Order ID\t|\n","|orderStartDate\t|Order start date\t|\n","|orderEndDate\t|Order end date\t|\n","|orderBudget\t|Order budget\t|\n","|orderlExternalId\t|PO Number\t|\n","|orderCurrency\t|Order currency\t|\n","|lineItemName\t|Line item name\t|\n","|lineItemId\t|Line item ID\t|\n","|lineItemStartDate\t|Line item start date\t|\n","|lineItemEndDate\t|Line item end date\t|\n","|lineItemBudget\t|Line item budget\t|\n","|lineItemExternalId\t|Line item external ID\t|\n","|lineitemtype\t|Line item type\t|\n","|targetingMethod\t|Targeting method\t|\n","|segment\t|Segment\t|\n","|agencyFee\t|Agency fee\t|\n","|totalFee\t|Total fee\t|\n","|3pFeeAutomotive\t|3P fee - automotive\t|\n","|3pFeeAutomotiveAbsorbed\t|3P fee - automotive (absorbed)\t|\n","|3pFeeComScore\t|3P fee - ComScore\t|\n","|3pFeeComScoreAbsorbed\t|3P fee - ComScore (absorbed)\t|\n","|3pFeeCPM1\t|3P fee - CPM 1\t|\n","|3pFeeCPM1Absorbed\t|3P fee - CPM 1 (absorbed)\t|\n","|3pFeeCPM2\t|3P fee - CPM 2\t|\n","|3pFeeCPM2Absorbed\t|3P fee - CPM 2 (absorbed)\t|\n","|3pFeeCPM3\t|3P fee - CPM 3\t|\n","|3pFeeCPM3Absorbed\t|3P fee - CPM 3 (absorbed)\t|\n","|3pFeeDoubleclickCampaignManager\t|3P fee - DoubleClick Campaign Manager\t|\n","|3pFeeDoubleclickCampaignManagerAbsorbed\t|3P fee - DoubleClick Campaign Manager (absorbed)\t|\n","|3pFeeDoubleVerify\t|3P fee - DoubleVerify\t|\n","|3pFeeDoubleVerifyAbsorbed\t|3P fee - DoubleVerify (absorbed)\t|\n","|3pFeeIntegralAdScience\t|3P fee - Integral Ad Science\t|\n","|3pFeeIntegralAdScienceAbsorbed\t|3P fee - Integral Ad Science (absorbed)\t|\n","|3PFees\t|Third party (3P) fees\t|\n","|unitsSold14d\t|Product units sold\t|\n","|sales14d\t|Product sales\t|\n","|ROAS14d\t|Return on advertising spend\t|\n","|eRPM14d\t|Effective return per thousand impressions (eRPM)\t|\n","|newToBrandUnitsSold14d\t|New-to-brand product units sold\t|\n","|newToBrandProductSales14d\t|New-to-brand product sales\t|\n","|newToBrandROAS14d\t|New-to-brand return on advertising spend\t|\n","|newToBrandERPM14d\t|New-to-brand eRPM\t|\n","|totalPRPV14d\t|Total product review page views (Total PRPV)\t|\n","|totalPRPVViews14d\t|Total product review page views view-through conversions (Total PRPV  views)\t|\n","|totalPRPVClicks14d\t|Total product review page views click-through conversions (Total PRPV  clicks)\t|\n","|totalPRPVr14d\t|Total Product review page view rate (Total PRPVR)\t|\n","|totalECPPRPV14d\t|Total Effective cost per product review page view (Total eCPPRPV)\t|\n","|totalPurchases14d\t|Total purchases\t|\n","|totalPurchasesViews14d\t|Total purchases view-through conversions (Total purchases views)\t|\n","|totalPurchasesClicks14d\t|Total purchases click-through conversions (Total purchases clicks)\t|\n","|totalPurchaseRate14d\t|Total purchases rate\t|\n","|totalECPP14d\t|Total Effective cost per purchase (Total eCPP)\t|\n","|totalNewToBrandPurchases14d\t|Total new-to-brand purchases\t|\n","|totalNewToBrandPurchasesViews14d\t|Total new-to-brand purchases view-through conversions\t|\n","|totalNewToBrandPurchasesClicks14d\t|Total new-to-brand purchases clicks\t|\n","|totalNewToBrandPurchaseRate14d\t|Total new-to-brand purchase rate\t|\n","|totalNewToBrandECPP14d\t|Total new-to-brand effective cost per purchase\t|\n","|totalPercentOfPurchasesNewToBrand14d\t|Total percent of purchases new-to-brand\t|\n","|totalUnitsSold14d\t|Total units sold\t|\n","|totalSales14d\t|Total product sales\t|\n","|totalROAS14d\t|Total return on advertising spend (Total ROAS)\t|\n","|totalERPM14d\t|Total effective return per thousand impressions (Total eRPM)\t|\n","|totalNewToBrandUnitsSold14d\t|Total new-to-brand units sold\t|\n","|totalNewToBrandProductSales14d\t|Total new-to-brand product sales\t|\n","|totalNewToBrandROAS14d\t|Total new-to-brand return on advertising spend (Total new-to-brand ROAS)\t|\n","|totalNewToBrandERPM14d\t|Total new-to-brand effective return per thousand impressions  (New-to-brand total eRPM)\t|\n","|viewableImpressions\t|Viewable impressions\t|\n","|measurableImpressions\t|Measurable impressions\t|\n","|measurableRate\t|Measurable rate\t|\n","|viewabilityRate\t|Viewability rate\t|\n","|totalDetailPageViews14d\t|Total detail page views (Total DPV)\t|\n","|totalDetailPageViewViews14d\t|Total detail page views view-through conversions (Total DPV views)\t|\n","|totalDetailPageClicks14d\t|Total detail page views click-through conversions (Total DPV clicks)\t|\n","|totalDetailPageViewsCVR14d\t|Total detail page view rate (Total DPVR)\t|\n","|totalDetaiPageViewCPA14d\t|Total Effective cost per detail page view (Total eCPDPV)\t|\n","|totalAddToList14d\t|Total Add to Lists (Total ATL)\t|\n","|totalAddToListViews14d\t|Total Add to List view-through conversions (Total ATL views)\t|\n","|totalAddToListClicks14d\t|Total Add to List click-through conversions (Total ATL clicks)\t|\n","|totalAddToListCVR14d\t|Total Add to List rate (Total ATLR)\t|\n","|totalAddToListCPA14d\t|Total Effective cost per Total Add to List (Total eCPATL)\t|\n","|totalAddToCart14d\t|Total Add to Carts (Total ATC)\t|\n","|totalAddToCartViews14d\t|Total Add to Cart view-through conversions (Total ATC views)\t|\n","|totalAddToCartClicks14d\t|Total Add to Cart click-through conversions (Total ATC clicks)\t|\n","|totalAddToCartCVR14d\t|Total Add to Cart rate (Total ATCR)\t|\n","|totalAddToCartCPA14d\t|Total Effective cost per Total Add to Cart (Total eCPATC)\t|\n","|totalSubscribeAndSaveSubscriptions14d\t|Total Subscribe & Save subscriptions (Total SnSS)\t|\n","|totalSubscribeAndSaveSubscriptionViews14d\t|Total Subscribe & Save subscriptions view-through conversions (Total  SnSS views)\t|\n","|totalSubscribeAndSaveSubscriptionClicks14d\t|Total Subscribe & Save subscriptions click-through conversions (Total  SnSS clicks)\t|\n","|totalSubscribeAndSaveSubscriptionCVR14d\t|Total Subscribe & Save subscriptions rate (Total SnSSR)\t|\n","|totalSubscribeAndSaveSubscriptionCPA14d\t|Total Effective cost per Subscribe & Save subscription (Total  eCPSnSS)\t|\n","|creativeName\t|Creative name\t|\n","|creativeID\t|Creative  Id\t|\n","|creativeAdId\t|Creative  id\t|\n","|creativeType\t|Creative type\t|\n","|creativeSize\t|Creative size\t|\n","|totalCost\t|Total cost\t|\n","|supplyCost\t|Supply cost\t|\n","|amazonAudienceFee\t|Amazon DSP audience fee\t|\n","|advertiserTimezone\t|Advertiser timezone\t|\n","|advertiserCountry\t|Advertiser country\t|\n","|amazonPlatformFee\t|Amazon DSP console fee\t|\n","|impressions\t|Impressions\t|\n","|clickThroughs\t|Click-throughs\t|\n","|CTR\t|Click-through rate (CTR)\t|\n","|eCPM\t|Effective cost per thousand (eCPM)\t|\n","|eCPC\t|Effective cost per click-through (eCPC)\t|\n","|dpv14d\t|Detail page views (DPV)\t|\n","|dpvViews14d\t|Detail page views view-through conversions (DPV views)\t|\n","|dpvClicks14d\t|Detail page views click-through conversions (DPV clicks)\t|\n","|dpvr14d\t|Detail page view rate (DPVR)\t|\n","|eCPDPV14d\t|Effective cost per detail page view (eCPDPV)\t|\n","|pRPV14d\t|Product review page views (PRPV)\t|\n","|pRPVViews14d\t|Product review page views view-through conversions (PRPV views)\t|\n","|pRPVClicks14d\t|Product review page views click-through conversions (PRPV clicks)\t|\n","|pRPVr14d\t|Product review page view rate (PRPVR)\t|\n","|eCPPRPV14d\t|Effective cost per product review page view (eCPPRPV)\t|\n","|atl14d\t|Add to List (ATL)\t|\n","|atlViews14d\t|Add to List view-through conversions (ATL views)\t|\n","|atlClicks14d\t|Add to List click-through conversions (ATL clicks)\t|\n","|atlr14d\t|Add to List rate (ATLR)\t|\n","|eCPAtl14d\t|Effective cost per Add to List (eCPATL)\t|\n","|atc14d\t|Add to Cart (ATC)\t|\n","|atcViews14d\t|Add to Cart view-through conversions (ATC views)\t|\n","|atcClicks14d\t|Add to Cart click-through conversions (ATC clicks)\t|\n","|atcr14d\t|Add to Cart rate (ATCR)\t|\n","|eCPAtc14d\t|Effective cost per Add to Cart (eCPATC)\t|\n","|purchases14d\t|Purchases\t|\n","|purchasesViews14d\t|Purchases view-through conversions\t|\n","|purchasesClicks14d\t|Purchases click-through conversions\t|\n","|purchaseRate14d\t|Purchase rate\t|\n","|eCPP14d\t|Effective cost per purchase (eCPP)\t|\n","|newToBrandPurchases14d\t|New-to-brand purchases\t|\n","|newToBrandPurchasesViews14d\t|New-to-brand purchases view-through conversions\t|\n","|newToBrandPurchasesClicks14d\t|New-to-brand purchases clicks\t|\n","|newToBrandPurchaseRate14d\t|New-to-brand purchase rate\t|\n","|newToBrandECPP14d\t|New-to-brand effective cost per purchase\t|\n","|percentOfPurchasesNewToBrand14d\t|Percent of purchases new-to-brand\t|\n","|addToWatchlist14d\t|Add to Watchlist (ATW)\t|\n","|addToWatchlistViews14d\t|Add to Watchlist view-through conversions (ATW views)\t|\n","|addToWatchlistClicks14d\t|Add to Watchlist click-through conversions (ATW clicks)\t|\n","|addToWatchlistCVR14d\t|Add to Watchlist rate (ATWR)\t|\n","|addToWatchlistCPA14d\t|Effective cost per Add to Watchlist (eCPATW)\t|\n","|downloadedVideoPlays14d\t|Downloaded video plays (DVP)\t|\n","|downloadedVideoPlaysViews14d\t|Downloaded video play view-through conversions (DVP views)\t|\n","|downloadedVideoPlaysClicks14d\t|Downloaded video play click-through conversions (DVP clicks)\t|\n","|downloadedVideoPlayRate14d\t|Downloaded video play rate (DVPR)\t|\n","|eCPDVP14d\t|Effective cost per downloaded video play (eCPDVP)\t|\n","|videoStreams14d\t|Video streams\t|\n","|videoStreamsViews14d\t|Video streams view-through conversions\t|\n","|videoStreamsClicks14d\t|Video streams click-through conversions\t|\n","|videoStreamsRate14d\t|Video streams rate\t|\n","|eCPVS14d\t|Effective cost per video stream (eCPVS)\t|\n","|playTrailers14d\t|Play trailers\t|\n","|playTrailersViews14d\t|Play trailers view-through conversions\t|\n","|playerTrailersClicks14d\t|Play trailers click-through conversions\t|\n","|playTrailerRate14d\t|Play trailer rate\t|\n","|eCPPT14d\t|Effective cost per Play trailer (eCPPT)\t|\n","|rentals14d\t|Rentals\t|\n","|rentalsViews14d\t|Rentals view-through conversions\t|\n","|rentalsClicks14d\t|Rentals click-through conversions\t|\n","|rentalRate14d\t|Rental rate\t|\n","|ecpr14d\t|Effective cost per rental (eCPR)\t|\n","|videoDownloads14d\t|Video downloads\t|\n","|videoDownloadsViews14d\t|Video downloads view-through conversions\t|\n","|videoDownloadsClicks14d\t|Video downloads click-through conversions\t|\n","|videoDownloadRate14d\t|Video download rate\t|\n","|ecpvd14d\t|Effective cost per video download (eCPVD)\t|\n","|newSubscribeAndSave14d\t|Subscribe & Save subscriptions (SnSS)\t|\n","|newSubscribeAndSaveViews14d\t|Subscribe & Save subscriptions view-through conversions (SnSS views)\t|\n","|newSubscribeAndSaveClicks14d\t|Subscribe & Save subscriptions click-through conversions (SnSS  clicks)\t|\n","|newSubscribeAndSaveRate14d\t|Subscribe & Save subscription rate (SnSSR)\t|\n","|eCPnewSubscribeAndSave14d\t|Effective cost per Subscribe & Save subscription (eCPSnSS)\t|\n","|offAmazonConversions14d\t|Total pixel conversions\t|\n","|offAmazonViews14d\t|Total pixel view-through conversions\t|\n","|offAmazonClicks14d\t|Total pixel click-through conversions\t|\n","|offAmazonCVR14d\t|Total pixel conversion rate\t|\n","|offAmazonCPA14d\t|Total pixel cost per acquisition\t|\n","|marketingLandingPage14d\t|Marketing landing page\t|\n","|marketingLandingPageViews14d\t|Marketing landing page view-through conversions\t|\n","|marketingLandingPageClicks14d\t|Marketing landing page click-through conversions\t|\n","|marketingLandingPageCVR14d\t|Marketing landing page conversion rate\t|\n","|marketingLandingPageCPA14d\t|Marketing landing page cost per acquisition\t|\n","|subscribe14d\t|Subscription page\t|\n","|subscribeViews14d\t|Subscription page view-through conversions\t|\n","|subscribeClicks14d\t|Subscription page click-through conversions\t|\n","|subscribeCVR14d\t|Subscription page conversion rate\t|\n","|subscribeCPA14d\t|Subscription page cost per acquisition\t|\n","|signUpPage14d\t|Sign up page\t|\n","|signUpPageViews14d\t|Sign up page view-through conversions\t|\n","|signUpPageClicks14d\t|Sign up page click-through conversions\t|\n","|signUpPageCVR14d\t|Sign up page conversion rate\t|\n","|signUpPageCPA14d\t|Sign up page cost per acquisition\t|\n","|application14d\t|Application\t|\n","|applicationViews14d\t|Application view-through conversions\t|\n","|applicationClicks14d\t|Application click-through conversions\t|\n","|applicationCVR14d\t|Application conversion rate\t|\n","|applicationCPA14d\t|Application cost per acquisition\t|\n","|gameLoad14d\t|Game load\t|\n","|gameLoadViews14d\t|Game load view-through conversions\t|\n","|gameLoadClicks14d\t|Game load click-through conversions\t|\n","|gameLoadCVR14d\t|Game load conversion rate\t|\n","|gameLoadCPA14d\t|Game load cost per acquisition\t|\n","|widgetLoad14d\t|Widget load\t|\n","|widgetLoadViews14d\t|Widget load view-through conversions\t|\n","|widgetLoadClicks14d\t|Widget load click-through conversions\t|\n","|widgetLoadCVR14d\t|Widget load conversion rate\t|\n","|widgetLoadCPA14d\t|Widget load cost per acquisition\t|\n","|surveyStart14d\t|Survey start\t|\n","|surveyStartViews14d\t|Survey start view-through conversions\t|\n","|surveyStartClicks14d\t|Survey start click-through conversions\t|\n","|surveyStartCVR14d\t|Survey start conversion rate\t|\n","|surveyStartCPA14d\t|Survey start cost per acquisition\t|\n","|surveyFinish14d\t|Survey finish\t|\n","|surveyFinishViews14d\t|Survey finish view-through conversions\t|\n","|surveyFinishClicks14d\t|Survey finish click-through conversions\t|\n","|surveyFinishCVR14d\t|Survey finish conversion rate\t|\n","|surveyFinishCPA14d\t|Survey finish cost per acquisition\t|\n","|bannerInteraction14d\t|Banner interaction\t|\n","|bannerInteractionViews14d\t|Banner interaction view-through conversions\t|\n","|bannerInteractionClicks14d\t|Banner interaction click-through conversions\t|\n","|bannerInteractionCVR14d\t|Banner interaction conversion rate\t|\n","|bannerInteractionCPA14d\t|Banner interaction cost per acquisition\t|\n","|widgetInteraction14d\t|Widget interaction\t|\n","|widgetInteractionViews14d\t|Widget interaction view-through conversions\t|\n","|widgetInteractionClicks14d\t|Widget interaction click-through conversions\t|\n","|widgetInteractionCVR14d\t|Widget interaction conversion rate\t|\n","|widgetInteractionCPA14d\t|Widget interaction cost per acquisition\t|\n","|gameInteraction14d\t|Game interaction\t|\n","|gameInteractionViews14d\t|Game interaction view-through conversions\t|\n","|gameInteractionClicks14d\t|Game interaction click-through conversions\t|\n","|gameInteractionCVR14d\t|Game interaction conversion rate\t|\n","|gameInteractionCPA14d\t|Game interaction cost per acquisition\t|\n","|emailLoad14d\t|Email load\t|\n","|emailLoadViews14d\t|Email load view-through conversions\t|\n","|emailLoadClicks14d\t|Email load click-through conversions\t|\n","|emailLoadCVR14d\t|Email load conversion rate\t|\n","|emailLoadCPA14d\t|Email load cost per acquisition\t|\n","|emailInteraction14d\t|Email interaction\t|\n","|emailInteractionViews14d\t|Email interaction view-through conversions\t|\n","|emailInteractionClicks14d\t|Email interaction click-through conversions\t|\n","|emailInteractionCVR14d\t|Email interaction conversion rate\t|\n","|emailInteractionCPA14d\t|Email interaction cost per acquisition\t|\n","|submitButton14d\t|Submit button\t|\n","|submitButtonViews14d\t|Submit button view-through conversions\t|\n","|submitButtonClicks14d\t|Submit button click-through conversions\t|\n","|submitButtonCVR14d\t|Submit button pixel conversion rate\t|\n","|submitButtonCPA14d\t|Submit button cost per acquisition\t|\n","|purchaseButton14d\t|Purchase button\t|\n","|purchaseButtonViews14d\t|Purchase button view-through conversions\t|\n","|purchaseButtonClicks14d\t|Purchase button click-through conversions\t|\n","|purchaseButtonCVR14d\t|Purchase button conversion rate\t|\n","|purchaseButtonCPA14d\t|Purchase button cost per acquisition\t|\n","|clickOnRedirect14d\t|Click on redirect\t|\n","|clickOnRedirectViews14d\t|Click on redirect view-through conversions\t|\n","|clickOnRedirectClicks14d\t|Click on redirect click-through conversions\t|\n","|clickOnRedirectCVR14d\t|Click on redirect conversion rate\t|\n","|clickOnRedirectCPA14d\t|Click on redirect cost per acquisition\t|\n","|signUp14d\t|Sign up button\t|\n","|signUpViews14d\t|Sign up button view-through conversions\t|\n","|signUpClicks14d\t|Sign up button click-through conversions\t|\n","|signUpCVR14d\t|Sign up button conversion rate\t|\n","|signUpCPA14d\t|Sign up button cost per acquisition\t|\n","|subscriptionButton14d\t|Subscription button\t|\n","|subscriptionButtonViews14d\t|Subscription button view-through conversions\t|\n","|subscriptionButtonClicks14d\t|Subscription button click-through conversions\t|\n","|subscriptionButtonCVR14d\t|Subscription button conversion rate\t|\n","|subscriptionButtonCPA14d\t|Subscription button cost per acquisition\t|\n","|successPage14d\t|Success page\t|\n","|successPageViews14d\t|Success page view-through conversions\t|\n","|successPageClicks14d\t|Success page click-through conversions\t|\n","|successPageCVR14d\t|Success page conversion rate\t|\n","|successPageCPA14d\t|Success page cost per acquisition\t|\n","|thankYouPage14d\t|Thank you page\t|\n","|thankYouPageViews14d\t|Thank you page view-through conversions\t|\n","|thankYouPageClicks14d\t|Thank you page click-through conversions\t|\n","|thankYouPageCVR14d\t|Thank you page conversion rate\t|\n","|thankYouPageCPA14d\t|Thank you page cost per acquisition\t|\n","|registrationForm14d\t|Registration form\t|\n","|registrationFormViews14d\t|Registration form view-through conversions\t|\n","|registrationFormClicks14d\t|Registration form click-through conversions\t|\n","|registrationFormCVR14d\t|Registration form conversion rate\t|\n","|registrationFormCPA14d\t|Registration form cost per acquisition\t|\n","|registrationConfirmPage14d\t|Registration confirm page\t|\n","|registrationConfirmPageViews14d\t|Registration confirm page view-through conversions\t|\n","|registrationConfirmPageClicks14d\t|Registration confirm page click-through conversions\t|\n","|registrationConfirmPageCVR14d\t|Registration confirm page conversion rate\t|\n","|registrationConfirmPageCPA14d\t|Registration confirm page cost per acquisition\t|\n","|storeLocatorPage14d\t|Store locator page\t|\n","|storeLocatorPageViews14d\t|Store locator page view-through conversions\t|\n","|storeLocatorPageClicks14d\t|Store locator page click-through conversions\t|\n","|storeLocatorPageCVR14d\t|Store locator page conversion rate\t|\n","|storeLocatorPageCPA14d\t|Store locator page cost per acquisition\t|\n","|mobileAppFirstStarts14d\t|Mobile app first starts\t|\n","|mobileAppFirstStartViews14d\t|Mobile app first start view-through conversions\t|\n","|mobileAppFirstStartClicks14d\t|Mobile app first start click-through conversions\t|\n","|mobileAppFirstStartCVR14d\t|Mobile app first start conversion rate\t|\n","|mobileAppFirstStartsCPA14d\t|Mobile app first start cost per acquisition\t|\n","|brandStoreEngagement1\t|Brand store engagement 1\t|\n","|brandStoreEngagement1Views\t|Brand store engagement 1 view-through conversions\t|\n","|brandStoreEngagement1Clicks\t|Brand store engagement 1 click-through conversions\t|\n","|brandStoreEngagement1CVR\t|Brand store engagement 1 conversion rate\t|\n","|brandStoreEngagement1CPA\t|Brand store engagement 1 cost per acquisition\t|\n","|brandStoreEngagement2\t|Brand store engagement 2\t|\n","|brandStoreEngagement2Views\t|Brand store engagement 2 view-through conversions\t|\n","|brandStoreEngagement2Clicks\t|Brand store engagement 2 click-through conversions\t|\n","|brandStoreEngagement2CVR\t|Brand store engagement 2 conversion rate\t|\n","|brandStoreEngagement2CPA\t|Brand store engagement 2 cost per acquisition\t|\n","|brandStoreEngagement3\t|Brand store engagement 3\t|\n","|brandStoreEngagement3Views\t|Brand store engagement 3 view-through conversions\t|\n","|brandStoreEngagement3Clicks\t|Brand store engagement 3 click-through conversions\t|\n","|brandStoreEngagement3CVR\t|Brand store engagement 3 conversion rate\t|\n","|brandStoreEngagement3CPA\t|Brand store engagement 3 cost per acquisition\t|\n","|brandStoreEngagement4\t|Brand store engagement 4\t|\n","|brandStoreEngagement4Views\t|Brand store engagement 4 view-through conversions\t|\n","|brandStoreEngagement4Clicks\t|Brand store engagement 4 click-through conversions\t|\n","|brandStoreEngagement4CVR\t|Brand store engagement 4 conversion rate\t|\n","|brandStoreEngagement4CPA\t|Brand store engagement 4 cost per acquisition\t|\n","|brandStoreEngagement5\t|Brand store engagement 5\t|\n","|brandStoreEngagement5Views\t|Brand store engagement 5 view-through conversions\t|\n","|brandStoreEngagement5Clicks\t|Brand store engagement 5 click-through conversions\t|\n","|brandStoreEngagement5CVR\t|Brand store engagement 5 conversion rate\t|\n","|brandStoreEngagement5CPA\t|Brand store engagement 5 cost per acquisition\t|\n","|brandStoreEngagement6\t|Brand store engagement 6\t|\n","|brandStoreEngagement6Views\t|Brand store engagement 6 view-through conversions\t|\n","|brandStoreEngagement6Clicks\t|Brand store engagement 6 click-through conversions\t|\n","|brandStoreEngagement6CVR\t|Brand store engagement 6 conversion rate\t|\n","|brandStoreEngagement6CPA\t|Brand store engagement 6 cost per acquisition\t|\n","|brandStoreEngagement7\t|Brand store engagement 7\t|\n","|brandStoreEngagement7Views\t|Brand store engagement 7 view-through conversions\t|\n","|brandStoreEngagement7Clicks\t|Brand store engagement 7 click-through conversions\t|\n","|brandStoreEngagement7CVR\t|Brand store engagement 7 conversion rate\t|\n","|brandStoreEngagement7CPA\t|Brand store engagement 7 cost per acquisition\t|\n","|addedToShoppingCart14d\t|Add to shopping cart (ATSC)\t|\n","|addedToShoppingCartViews14d\t|Add to shopping cart view-through conversions\t|\n","|addedToShoppingCartClicks14d\t|Add to shopping cart click-through conversions (ATC clicks)\t|\n","|addedToShoppingCartCVR14d\t|Add to shopping cart conversion rate\t|\n","|addedToShoppingCartCPA14d\t|Add to shopping cart cost per acquisition\t|\n","|offAmazonPurchases14d\t|Product purchased\t|\n","|offAmazonPurchasesViews14d\t|Product purchased view-through conversions\t|\n","|offAmazonPurchasesClicks14d\t|Product purchased click-through conversions\t|\n","|offAmazonPurchaseRate14d\t|Product purchased conversion rate\t|\n","|offAmazonECPP14d\t|Product purchased cost per acquisition\t|\n","|homepageVisit14d\t|Homepage visit\t|\n","|homepageVisitViews14d\t|Homepage visit view-through conversions\t|\n","|homepageVisitClicks14d\t|Homepage visit click-through conversions\t|\n","|homepageVisitCVR14d\t|Homepage visit conversion rate\t|\n","|homepageVisitCPA14d\t|Homepage visit cost per acquisition\t|\n","|videoStarted\t|Video started\t|\n","|videoStartedViews\t|Video started view-through conversions\t|\n","|videoStartedClicks\t|Video started click-through conversions\t|\n","|videoStartedCVR\t|Video started conversion rate\t|\n","|videoStartedCPA\t|Video started cost per acquisition\t|\n","|videoCompleted\t|Video completed\t|\n","|videoCompletedViews\t|Video completed view-through conversions\t|\n","|videoEndClicks\t|Video end click-through conversions\t|\n","|videoCompletedCVR\t|Video completed conversion rate\t|\n","|videoCompletedCPA\t|Video completed cost per acquisition\t|\n","|messageSent14d\t|Message sent\t|\n","|messageSentViews14d\t|Message sent view-through conversions\t|\n","|messageSentClicks14d\t|Message sent click-through conversions\t|\n","|messageSentCVR14d\t|Message sent conversion rate\t|\n","|messageSentCPA14d\t|Message sent cost per acquisition\t|\n","|mashupClickToPage\t|Mashup click to page\t|\n","|mashupClickToPageViews\t|Mashup click to page view-through conversions\t|\n","|mashupClickToPageClicks\t|Mashup click to page click-through conversions\t|\n","|mashupClickToPageCVR\t|Mashup click to page conversion rate\t|\n","|mashupClickToPageCPA\t|Mashup click to page cost per acquisition\t|\n","|mashupBackupImage\t|Mashup backup image\t|\n","|mashupBackupImageViews\t|Mashup backup image click view-through conversions\t|\n","|mashupBackupImageClicks\t|Mashup backup image click-through conversions\t|\n","|mashupBackupImageCVR\t|Mashup backup image conversion rate\t|\n","|mashupBackupImageCPA\t|Mashup backup image cost per acquisition\t|\n","|mashupAddToCart14d\t|Mashup Add to Cart click\t|\n","|mashupAddToCartViews14d\t|Mashup Add to Cart click view-through conversions\t|\n","|mashupAddToCartClicks14d\t|Mashup Add to Cart click-through conversions\t|\n","|mashupAddToCartClickCVR14d\t|Mashup Add to Cart click pixel conversion rate\t|\n","|mashupAddToCartCPA14d\t|Mashup Add to Cart click cost per acquisition\t|\n","|mashupAddToWishlist14d\t|Mashup Add to Wishlist click\t|\n","|mashupAddToWishlistViews14d\t|Mashup Add to Wishlist click view-through conversions\t|\n","|mashupAddToWishlistClicks14d\t|Mashup Add to Wishlist click-through conversions\t|\n","|mashupAddToWishlistCVR14d\t|Mashup Add to Wishlist click conversion rate\t|\n","|mashupAddToWishlistCPA14d\t|Mashup Add to Wishlist click cost per acquisition\t|\n","|mashupSubscribeAndSave14d\t|Mashup Subscribe and Save click\t|\n","|mashupSubscribeAndSaveClickViews14d\t|Mashup Subscribe and Save view-through conversions\t|\n","|mashupSubscribeAndSaveClick14d\t|Mashup Subscribe and Save click click-through conversions\t|\n","|mashupSubscribeAndSaveCVR14d\t|Mashup Subscribe and Save conversion rate\t|\n","|mashupSubscribeAndSaveCPA14d\t|Mashup Subscribe and Save click cost per acquisition\t|\n","|mashupClipCouponClick14d\t|Mashup Clip Coupon click\t|\n","|mashupClipCouponClickViews14d\t|Mashup Clip Coupon view-through conversions\t|\n","|mashupClipCouponClickClicks14d\t|Mashup Clip Coupon click click-through conversions\t|\n","|mashupClipCouponClickCVR14d\t|Mashup Clip Coupon conversion rate\t|\n","|mashupClipCouponClickCPA14d\t|Mashup Clip Coupon cost per acquisition\t|\n","|mashupShopNowClick14d\t|Mashup Shop Now click\t|\n","|mashupShopNowClickViews14d\t|Mashup Shop Now click view-through conversions\t|\n","|mashupShopNowClickClicks14d\t|Mashup Shop Now click click-through conversions\t|\n","|mashupShopNowClickCVR14d\t|Mashup Shop Now click conversion rate\t|\n","|mashupShopNowClickCPA14d\t|Mashup Shop Now click cost per acquisition\t|\n","|referral14d\t|Referral\t|\n","|referralViews14d\t|Referral view-through conversions\t|\n","|referralClicks14d\t|Referral click-through conversions\t|\n","|referralCVR14d\t|Referral conversion rate\t|\n","|referralCPA14d\t|Referral cost per acquisition\t|\n","|accept14d\t|Accept\t|\n","|acceptViews14d\t|Accept view-through conversions\t|\n","|acceptClicks14d\t|Accept click-through conversions\t|\n","|acceptCVR14d\t|Accept conversion rate\t|\n","|acceptCPA14d\t|Accept cost per acquisition\t|\n","|decline14d\t|Decline\t|\n","|declineViews14d\t|Decline view-through conversions\t|\n","|declineClicks14d\t|Decline click-through conversions\t|\n","|declineCVR14d\t|Decline conversion rate\t|\n","|declineCPA14d\t|Decline cost per acquisition\t|\n","|videoStart\t|Video start\t|\n","|videoFirstQuartile\t|Video first quartile\t|\n","|videoMidpoint\t|Video midpoint\t|\n","|videoThirdQuartile\t|Video third quartile\t|\n","|videoComplete\t|Video complete\t|\n","|videoCompletionRate\t|Video completion rate\t|\n","|ecpvc\t|Effective cost per Video complete (eCPVC)\t|\n","|videoPause\t|Video pause\t|\n","|videoResume\t|Video resume\t|\n","|videoMute\t|Video mute\t|\n","|videoUnmute\t|Video unmute\t|\n","|dropDownSelection14d\t|Drop down selection\t|\n","|dropDownSelectionViews14d\t|Drop down selection view-through conversions\t|\n","|dropDownSelectionClicks14d\t|Drop down selection click-through conversions\t|\n","|dropDownSelectionCVR14d\t|Drop down selection conversion rate\t|\n","|dropDownSelectionCPA14d\t|Drop down selection cost per acquisition\t|\n","|brandSearch14d\t|Branded searches\t|\n","|brandSearchViews14d\t|Branded search views\t|\n","|brandSearchClicks14d\t|Branded search clicks\t|\n","|brandSearchRate14d\t|Branded search rate\t|\n","|brandSearchCPA14d\t|Cost per branded search\t|\n","|grossImpressions\t|Gross impressions\t|\n","|grossClickThroughs\t|Gross click-throughs\t|\n","|invalidImpressions\t|Invalid impressions\t|\n","|invalidClickThroughs\t|Invalid click-throughs\t|\n","|invalidImpressionRate\t|Invalid impression rate\t|\n","|invalidClickThroughsRate\t|Invalid click-throughs rate\t|\n","|country\t|Country\t|\n","|region\t|State or region\t|\n","|city\t|City\t|\n","|designatedMarketAreaCode\t|Designated Market Area® code\t|\n","|designatedMarketAreaName\t|Designated Market Area® name\t|\n","|postalCode\t|Postal Code\t|\n","|placementName\t|Placement\t|\n","|placementSize\t|Placement size\t|\n","|dealType\t|Deal type\t|\n","|siteName\t|Site name\t|\n","|supplySourceName\t|Supply source name\t|\n","|deal\t|Deal\t|\n","|dealID\t|Deal ID\t|\n","|reportGranularity\t|Report granularity\t|\n","|amazonStandardId\t|Amazon Standard Identification Number\t|\n","|parentASIN\t|Parent ASIN\t|\n","|marketplace\t|Marketplace\t|\n","|brandName\t|Brand name\t|\n","|asinConversionType\t|ASIN conversion type\t|\n","|featuredASIN\t|Featured ASIN\t|\n","|productName\t|Product name\t|\n","|productGroup\t|Product group\t|\n","|productCategory\t|Product category\t|\n","|productSubcategory\t|Product subcategory\t|\n","|brandHaloDetailPage14d\t|Detail page views - brand halo (DPV BH)\t|\n","|brandHaloDetailPageViews14d\t|Detail page views view-through conversions - brand halo (DPV views BH)\t|\n","|brandHaloDetailPageClicks14d\t|Detail page views click-through conversions - brand halo (DPV clicks BH)\t|\n","|brandHaloProductReviewPage14d\t|Product review page views - brand halo (PRPV BH)\t|\n","|brandHaloProductReviewPageViews14d\t|Product review page views view-through conversions - brand halo (PRPV  views BH)\t|\n","|brandHaloProductReviewPageClicks14d\t|Product review page views click-through conversions - brand halo (PRPV  clicks BH)\t|\n","|brandHaloAddToList14d\t|Add to List - brand halo (ATL BH)\t|\n","|brandHaloAddToListViews14d\t|Add to List view-through conversions - brand halo (ATL views BH)\t|\n","|brandHaloAddToListClicks14d\t|Add to List click-through conversions - brand halo (ATL clicks BH)\t|\n","|brandHaloAddToCart14d\t|Add to Cart - brand halo (ATC BH)\t|\n","|brandHaloAddToCartViews14d\t|Add to Cart view-through conversions - brand halo (ATC views BH)\t|\n","|brandHaloAddToCartClicks14d\t|Add to Cart click-through conversions - brand halo (ATC clicks BH)\t|\n","|brandHaloPurchases14d\t|Purchases - brand halo\t|\n","|brandHaloPurchasesViews14d\t|Purchases view-through conversions - brand halo\t|\n","|brandHaloPurchasesClicks14d\t|Purchases click-through conversions - brand halo\t|\n","|brandHaloNewToBrandPurchases14d\t|New-to-brand purchases - brand halo\t|\n","|brandHaloNewToBrandPurchasesViews14d\t|New-to-brand purchases view-through conversions - brand halo\t|\n","|brandHaloNewToBrandPurchasesClicks14d\t|New-to-brand purchases click-through conversions - brand halo\t|\n","|brandHaloPercentOfPurchasesNewToBrand14d\t|Percent of purchases new-to-brand - brand halo\t|\n","|brandHaloNewSubscribeAndSave14d\t|Subscribe & Save subscriptions - brand halo (SnSS BH)\t|\n","|brandHaloNewSubscribeAndSaveViews14d\t|Subscribe & Save subscriptions view-through conversions - brand halo  (SnSS views BH)\t|\n","|brandHaloNewSubscribeAndSaveClicks14d\t|Subscribe & Save subscriptions click-through conversions - brand halo  (SnSS clicks BH)\t|\n","|brandHaloTotalUnitsSold14d\t|Product units sold - brand halo\t|\n","|brandHaloTotalSales14d\t|Product sales - brand halo\t|\n","|brandHaloTotalNewToBrandSales14d\t|New-to-brand product sales - brand halo\t|\n","|brandHaloTotalNewToBrandUnitsSold14d\t|New-to-brand product units sold - brand halo\t|\n","|operatingSystem\t|Operating system\t|\n","|browser\t|Browser\t|\n","|browserVersion\t|Browser version\t|\n","|device\t|Device\t|\n","|environmentType\t|Environment type\t|\n"],"documentType":"guide"},{"title":"Reporting in the DSP console vs. API","sectionHeader":{"type":3,"text":"Missing metrics"},"path":"/en-us/guides/reporting/dsp/console-vs-api","content":[" Certain metrics that are available in the DSP console report center are not available in the API. \n","|Metric\t|Report types\t|\n","|---\t|---\t|\n","|Line  item comments\t|Campaign,  geography\t|\n","|Cumulative reach\t|Campaign\t|\n","|Average impression frequency\t|Campaign\t|\n","|Off-Amazon conversions\t|Campaign, inventory,  geography, audience, technology\t|\n","|Off-Amazon view-through  conversions\t|Campaign, inventory,  geography, audience, technology\t|\n","|Off-Amazon click-through  conversions\t|Campaign, inventory,  geography, audience, technology\t|\n","|Off-Amazon conversion rate\t|Campaign, inventory,  audience\t|\n","|Off-Amazon cost per  acquisition\t|Campaign, inventory,  audience\t|\n","|Subscribe\t|Campaign, inventory,  geography, audience, technology\t|\n","|Subscribe view-through  conversions\t|Campaign, inventory,  geography, audience, technology\t|\n","|Subscribe click-through  conversions\t|Campaign, inventory,  geography, audience, technology\t|\n","|Subscribe conversion rate\t|Campaign, inventory,  audience\t|\n","|Subscribe cost per acquisition\t|Campaign, inventory,  audience\t|\n","|Sign-up\t|Campaign, inventory,  geography, audience, technology\t|\n","|Sign-up view-through  conversions\t|Campaign, inventory,  geography, audience, technology\t|\n","|Sign-up click-through  conversions\t|Campaign, inventory,  geography, audience, technology\t|\n","|Sign-up conversion rate\t|Campaign, inventory,  audience\t|\n","|Sign-up cost per acquisition\t|Campaign, inventory,  audience\t|\n","|Add to shopping cart  view-through conversions (ATSC views)\t|Campaign, inventory,  geography, audience, technology\t|\n","|Add to shopping cart  click-through conversions (ATSC clicks)\t|Campaign, inventory,  geography, audience, technology\t|\n","|Add to shopping cart  conversion rate (ATSC CVR)\t|Campaign, inventory,  audience\t|\n","|Add to shopping cart cost per  acquisition (ATSC CPA)\t|Campaign, inventory,  audience\t|\n","|Off-Amazon purchases\t|Campaign, inventory,  geography, audience, technology\t|\n","|Off-Amazon purchases  view-through conversions\t|Campaign, inventory,  geography, audience, technology\t|\n","|Off-Amazon purchases  click-through conversions\t|Campaign, inventory,  geography, audience, technology\t|\n","|Off-Amazon purchase rate\t|Campaign, inventory,  audience\t|\n","|Off-Amazon effective cost per  purchase (eCPP)\t|Campaign, inventory,  audience\t|\n","|Subscription sign-up purchases\t|Campaign, inventory,  geography, audience, technology, products\t|\n","|Subscription sign-up purchase  views\t|Campaign, inventory,  geography, audience, technology, products\t|\n","|Subscription sign-up purchase  clicks\t|Campaign, inventory,  geography, audience, technology, products\t|\n","|Subscription sign-up rate\t|Campaign, inventory,  audience\t|\n","|Cost per subscription\t|Campaign, inventory,  audience\t|\n","|Free trial subscription  sign-up purchases\t|Campaign, inventory,  geography, audience, technology, products\t|\n","|Free trial subscription  sign-up purchase views\t|Campaign, inventory,  geography, audience, technology, products\t|\n","|Free trial subscription  sign-up purchase clicks\t|Campaign, inventory,  geography, audience, technology, products\t|\n","|Free trial subscription  sign-up rate\t|Campaign, inventory,  audience\t|\n","|Cost per free trial  subscription\t|Campaign, inventory,  audience\t|\n","|Paid subscription sign-up  purchases\t|Campaign, inventory,  geography, audience, technology, products\t|\n","|Paid subscription sign-up  purchase views\t|Campaign, inventory,  geography, audience, technology, products\t|\n","|Paid subscription sign-up  purchase clicks\t|Campaign, inventory,  geography, audience, technology, products\t|\n","|Paid subscription sign-up rate\t|Campaign, inventory,  audience\t|\n","|Cost per paid subscription\t|Campaign, inventory,  audience\t|\n","|Appstore opens\t|Campaign, products\t|\n","|Appstore opens views\t|Campaign, products\t|\n","|Appstore opens clicks\t|Campaign, products\t|\n","|Appstore open rate\t|Campaign\t|\n","|Cost per appstore opens\t|Campaign\t|\n","|Appstore first opens\t|Campaign, products\t|\n","|Appstore first-open views\t|Campaign, products\t|\n","|Appstore first-open clicks\t|Campaign, products\t|\n","|Appstore first-open rate\t|Campaign\t|\n","|Cost per appstore first open\t|Campaign\t|\n","|Appstore first-session hours\t|Campaign, products\t|\n","|Appstore first-session hours  clicks\t|Campaign, products\t|\n","|Appstore first-session hours  views\t|Campaign, products\t|\n","|Appstore usage hours\t|Campaign, products\t|\n","|Appstore usage hours clicks\t|Campaign, products\t|\n","|Appstore usage hours views\t|Campaign, products\t|\n","|Video impression\t|Campaign, inventory\t|\n","|Video click\t|Campaign, inventory\t|\n","|Video creative view\t|Campaign, inventory\t|\n","|Video end state click\t|Campaign, inventory\t|\n","|Video replay\t|Campaign, inventory\t|\n","|Video skip back\t|Campaign, inventory\t|\n","|Video skip forward\t|Campaign, inventory\t|\n","|Audio view\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio start\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio first quartile\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio midpoint\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio third quartile\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio complete\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio pause\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio resume\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio rewind\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio skip\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio mute\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio unmute\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio progress\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio companion banner view\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio companion banner click\t|Campaign, inventory,  geography, audience, technology\t|\n","|Audio completion rate\t|Campaign, inventory,  audience\t|\n","|Effective cost per audio  complete (eCPAC)\t|Campaign, inventory,  audience\t|\n","|App subscription sign-ups\t|Campaign, inventory,  geography, technology, products\t|\n","|App subscription sign-up views\t|Campaign, inventory,  geography, technology, products\t|\n","|App subscription sign-up  clicks\t|Campaign, inventory,  geography, technology, products\t|\n","|App subscription sign-up rate\t|Campaign, inventory,  geography, technology\t|\n","|Cost per app subscription\t|Campaign, inventory,  geography, technology\t|\n","|Free trial app subscription  sign-ups\t|Campaign, inventory,  geography, technology, products\t|\n","|Free trial app subscription  sign-up views\t|Campaign, inventory,  geography, technology, products\t|\n","|Free trial app subscription  sign-up clicks\t|Campaign, inventory,  geography, technology, products\t|\n","|Free trial app subscription  sign-up rate\t|Campaign, inventory,  geography, technology\t|\n","|Cost per free trial app  subscription\t|Campaign, inventory,  geography, technology\t|\n","|Paid app subscription sign-ups\t|Campaign, inventory,  geography, technology, products\t|\n","|Paid app subscription sign-ups  views\t|Campaign, inventory,  geography, technology, products\t|\n","|Paid app subscription sign-ups  clicks\t|Campaign, inventory,  geography, technology, products\t|\n","|Paid app subscription sign-up  rate\t|Campaign, inventory,  geography, technology\t|\n","|Cost per paid app subscription\t|Campaign, inventory,  geography, technology\t|\n","|Interactive STV impressions\t|Campaign\t|\n","|Interactive STV Buy and Shop  Now invoked\t|Campaign\t|\n","|Interactive STV call to action  engagement\t|Campaign\t|\n","|Interactive STV Add to List  invoked\t|Campaign\t|\n","|Interactive STV Add to Cart  invoked\t|Campaign\t|\n","|Interactive STV Send email  invoked\t|Campaign\t|\n","|Interactive STV Learn More  invoked\t|Campaign\t|\n","|Interactive STV Send Me More  invoked\t|Campaign\t|\n","|Interactive STV Shopping Shop  Now invoked\t|Campaign\t|\n","|Interactive STV Quick Look  invoked\t|Campaign\t|\n","|Interactive STV Shopping Add  To Cart Quick Look invoked\t|Campaign\t|\n","|Interactive STV call to action  engagement rate\t|Campaign\t|\n","|Creative\t|Inventory\t|\n","|Creative ID\t|Inventory\t|\n","|Targeting status\t|Audience\t|\n","|PO number\t|Industry Standard\t|\n","|Order budget\t|Industry Standard\t|\n","|Order start date\t|Industry Standard\t|\n","|Order end date\t|Industry Standard\t|\n","|Line item external ID\t|Industry Standard\t|\n","|Line item budget\t|Industry Standard\t|\n","|Line item start date\t|Industry Standard\t|\n","|Line item end date\t|Industry Standard\t|\n","|Impressions\t|Industry Standard\t|\n","|Gross impressions\t|Industry Standard\t|\n","|Click-throughs\t|Industry Standard\t|\n","|Gross click-throughs\t|Industry Standard\t|\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":null,"path":"/en-us/guides/reporting/dsp/faq","content":[],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"Will my integration cover all regions or are there any regional considerations I must understand?"},"path":"/en-us/guides/reporting/dsp/faq","content":[" The Amazon DSP Reporting API is available in the following regions: NA (US and CA), EU (UK, DE, FR, IT, ES, SE, DK, FI, NO, and AE) and FE (JP and AU). The endpoints for each region are as follows:\n","NA: https&#x3A;//advertising-api.amazon.com  EU: https&#x3A;//advertising-api-eu.amazon.com  FE: https&#x3A;//advertising-api-fe.amazon.com\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"How often is data updated via the Amazon DSP Reporting API?"},"path":"/en-us/guides/reporting/dsp/faq","content":[" Data is updated several times a day. Data retention and update schedules can be found here.\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"How often should I pull a report?"},"path":"/en-us/guides/reporting/dsp/faq","content":[" We currently recommend 1-2 report requests, per advertiser, per day, for each report type. This is based on data refresh rates.\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"Why is my report empty?"},"path":"/en-us/guides/reporting/dsp/faq","content":[" If there is no performance data available for any campaigns on the requested dates, your report may contain no data or an empty JSON array (\\[]).\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"My account has over 100 advertisers. How do I get reports for all of them?"},"path":"/en-us/guides/reporting/dsp/faq","content":[" You must pull multiple reports, each for 100 advertisers at a time.\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"How do I avoid a “Report size too large” error?"},"path":"/en-us/guides/reporting/dsp/faq","content":[" DSP reports support a maximum of 250,000 rows. Try reducing the date range, the number of dimensions, and the number of metrics included in your request. Filter by specific order IDs whenever possible. \n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"I am receiving a “Not Acceptable” error when using the API."},"path":"/en-us/guides/reporting/dsp/faq","content":[" This is due to using the wrong version in the Accept header. Find the correct version in our API documentation.\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"How does reporting differ between the DSP console and the API?"},"path":"/en-us/guides/reporting/dsp/faq","content":[" Some reporting functionality is only available in the DSP console. Additionally, some API fields have different names in the DSP console. \n"," Learn more about DSP console and the API.\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"I am using a manager account to call the DSP reporting API. Can I get access at the advertiser level to edit orders and line items?"},"path":"/en-us/guides/reporting/dsp/faq","content":[" No. For DSP, manager accounts can only be assigned read-only permission. You cannot use a manager account with read-only access to call DSP campaign management endpoints.\n"," Learn more about manager accounts.\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"I am receiving a 401 Unauthorized error when calling the API. "},"path":"/en-us/guides/reporting/dsp/faq","content":[" This can be caused by several things:\n","Ensure you are using the correct entity or advertiser ID in your URL. Remember entity IDs must be in all caps.  Ensure the API authorizing user is a user on the Manager Account.  Ensure the advertiser is correctly linked to the Manager Account.\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"I am receiving a 429 “Too Many Requests” error when trying to request my report."},"path":"/en-us/guides/reporting/dsp/faq","content":[" Request reports less often or decrease the size of your requested reports. For best practices, learn more about rate limiting in the Ads API.\n"," If you use the DSP reporting API regularly, you may notice higher than normal throttles during periods of high demand. This is a known issue.\n"],"documentType":"guide"},{"title":"DSP reporting FAQ","sectionHeader":{"type":2,"text":"How often should I pull a report? "},"path":"/en-us/guides/reporting/dsp/faq","content":[" Based on DSP data refresh rates, we recommend 1-2 report requests per advertiser per day for each report type.\n"],"documentType":"guide"},{"title":"How to add Creatives to and remove Creatives from Line Items","sectionHeader":null,"path":"/en-us/guides/dsp/tutorials/add-remove-creatives","content":[],"documentType":"guide"},{"title":"How to add Creatives to and remove Creatives from Line Items","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/dsp/tutorials/add-remove-creatives","content":[" For this tutorial, you require:\n","Your Amazon Ads API client identifier.  Your Amazon Ads API scope.  An authorization token. \\* Your Advertiser identifier.\n"],"documentType":"guide"},{"title":"How to add Creatives to and remove Creatives from Line Items","sectionHeader":{"type":2,"text":"Associating a Creative to a Line Item"},"path":"/en-us/guides/dsp/tutorials/add-remove-creatives","content":[" Before you can associate a Creative to a Line Item, you require values for the following fields:\n"," Line Item identifier\n"," Use the GET operation of the Line Item resource to retrieve the Line Item identifier. \n"," Creative identifier\n"," Before you can work with Creatives in the Amazon DSP API, you must have created the Creative using the Amazon DSP User Interface. Once the Creative has been created, use the GET operation of the Creative resource to retrieve the Creative identifier.\n"," Once you have values for these fields, use the POST operation of the Line Item Creative Associations resource to associate the Creative and the Line Item. The following fields are required:\n","advertiserId: The advertiser identifier you retrieved in the prerequisites section. \\* operation: For associating a Creative to a Line Item, this value is always CREATE.\n"," Note that the POST operation supports associating a single Creative to a Line Item only. To attach multiple Creatives to a Line Item, you must first retrieve the list of Creatives using the GET operation of the Creative resource. Then, loop through the list of Creatives and use the POST operation of the Line Item Creative Associations resource as described above on each one.\n"],"documentType":"guide"},{"title":"How to add Creatives to and remove Creatives from Line Items","sectionHeader":{"type":2,"text":"Updating the attributes for a Creative associated with a Line Item"},"path":"/en-us/guides/dsp/tutorials/add-remove-creatives","content":[" Before you can update the attributes for a Creative that is associated with a Line Item, you require values for the following fields:\n"," LineItemCreativeAssociation\n"," Use the GET operation of the Line Item Creative Association resource to retrieve the list of LineItemCreativeAssociation objects using the identifier of the desired Line Item. Review each object in the list to find which ones have attributes you would like to update.\n"," Next, the following fields can be updated in each of the objects:\n","startDate and endDate  weight: You must specify a value for this field if you set the creativeRotationType field to WEIGHTED in the Line Item to which you are associating this Creative.  The object retrieved in the GET operation above.\n"," Finally, use the PUT operation of the Line Item Creative Association resource, including the updated objects in the request body to update the attributes. \n"," Note that the PUT operation supports updating the attributes of a single Creative only. To update the attributes of multiple Creatives, you must first retrieve the list of Line Item Creative Associations using the GET operation of the Line Item Creative Association resource. Then, loop through the list of Creatives and use the PUT operation of the Line Item Creative Association resource as described above.\n"],"documentType":"guide"},{"title":"How to add Creatives to and remove Creatives from Line Items","sectionHeader":{"type":2,"text":"Removing a Creative association from a Line Item"},"path":"/en-us/guides/dsp/tutorials/add-remove-creatives","content":[" Before you can remove the association between a Creative and a Line Item, you require values for the following fields:\n"," LineItemCreativeAssociation\n"," Use the GET operation of the Line Item Creative Association resource to retrieve the list of LineItemCreativeAssociation objects using the identifier of the desired Line Item. Review each object in the list to find the ones you would like to remove the association.\n"," Next, use the POST operation of the Line Item Creative Association resource to remove the association between a Creative and a Line Item. In the request body of this operation, specify the following:\n","advertiserId: The advertiser identifier you retrieved in the prerequisites section.  operation: Set to DELETE.  The object retrieved in the GET operation above.\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration","content":[" The launch of AMC APIs on the Amazon Ads API represents the next generation API for programmatic access to Amazon features for AMC. All new development is occurring in the Amazon Ads API, including enhanced data protection, security features, usability, and performance. This change ensures developers are using the latest technology and features to utilize, manage, and build with these APIs for the benefit of both partners and customers.\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":2,"text":"What has changed?"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration","content":["Base URL: Previously, API requests used the AMC Instance API URL, a unique URL for each instance. Now, API requests use a common URL prefix depending on the region. - Authorization: Authorization is now based on OAuth2 instead of AWS IAM based permissions. An AWS Account is not a mandatory requirement to access AMC via APIs. - API endpoints: API endpoints that are provided on a per-AMC-instance basis will be replaced by an instanceId parameter included in the Ads. - Request headers: The request header now requires the following mandatory parameters: Amazon-Advertising-API-AdvertiserId (the AMC Account ID) and Amazon-Advertising-API-MarketplaceId in addition to the headers for accessing other Amazon Ads APIs. - Instance-level actions: Previous instance-level APIs contained only instance level actions.\n"," To learn more about Amazon Ads API, visit the Amazon Ads - Advanced tools center.\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":2,"text":"What is the same?"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration","content":[" All AMC API actions will be supported on the Amazon Ads API and will remain the same. For example, if you were making API calls to the AMC reporting (workflows) API, an equivalent API is available on the Amazon Ads API, as listed in the Endpoint equivalencies section.\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":2,"text":"AMC API categories"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration","content":[" AMC APIs are now grouped by functional categories, as listed below:\n","| Category               | API                           | Description                                                           |\n","\\| ---------------------- \\| ----------------------------- \\| --------------------------------------------------------------------- \\|\n","| Administration         | Account / instance management | Manage AMC instances                                                  |\n","| Reporting              | Workflow execution            | Query data sources and generate reporting on demand                   |\n","| Reporting              | Workflow scheduling           | Query data sources and generate reporting per schedule                |\n","| Audience management    | Rule-based audiences          | Create ruled-based audiences ready for Amazon DSP campaign activation |\n","| Audience management    | Lookalike audiences           | Create lookalike audiences ready for Amazon DSP campaign activation   |\n","| Audience management    | Advertiser audiences          | Stream pseudonymized audience records into Amazon Ads                 |\n","| Advertiser data upload | Advertiser data upload        | Upload pseudonymized advertiser first-party signals to Amazon Ads     |\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":3,"text":"Endpoint equivalencies"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration","content":["| Category                         | Resource            | AMC instance-level APIs endpoints                                               | AMC APIs on Amazon Ads endpoints                                                               |\n","\\| -------------------------------- \\| ------------------- \\| ------------------------------------------------------------------------------- \\| ---------------------------------------------------------------------------------------------- \\|\n","| Reporting              | Workflow Executions | POST {unique-amc-url}/prod/workflowExecutions                                   | POST {api_url}/amc/reporting/{instanceId}/workflowExecutions                                   |\n","|                                  |                     | PUT {unique-amc-url}/prod/workflowExecutions/{workflowExecutionId}              | PUT {api_url}/amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId}              |\n","|                                  |                     | GET {unique-amc-url}/prod/workflowExecutions/{workflowExecutionId}/downloadUrls | GET {api_url}/amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId}/downloadUrls |\n","|                                  |                     | GET {unique-amc-url}/prod/workflowExecutions                                    | GET {api_url}/amc/reporting/{instanceId}/workflowExecutions                                    |\n","|                                  |                     | GET {unique-amc-url}/prod/workflowExecutions/{workflowExecutionId}              | GET {api_url}/amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId}              |\n","|                                  |                     | DELETE {unique-amc-url}/prod/workflowExecutions/{workflowExecutionId}           | DELETE {api_url}/amc/reporting/{instanceId}/workflowExecutions/{workflowExecutionId}           |\n","| Reporting              | Workflows           | GET {unique-amc-url}/prod/workflows/{workflowId}                                | GET {api_url}/amc/reporting/{instanceId}/workflows/{workflowId}                                |\n","|                                  |                     | DELETE {unique-amc-url}/prod/workflows/{workflowId}                             | DELETE {api_url} /amc/reporting/{instanceId}/workflows/{workflowId}                            |\n","|                                  |                     | PUT {unique-amc-url}/prod/workflows/{workflowId}                                | PUT {api_url}/amc/reporting/{instanceId}/workflows/{workflowId}                                |\n","|                                  |                     | POST {unique-amc-url}/prod/workflows                                            | POST {api_url}/amc/reporting/{instanceId}/workflows                                            |\n","|                                  |                     | GET {unique-amc-url}/prod/workflows                                             | GET {api_url}/amc/reporting/{instanceId}/workflows                                             |\n","| Reporting              | Schedules           | POST {unique-amc-url}/prod/schedules                                            | POST {api_url}/amc/reporting/{instanceId}/schedules                                            |\n","|                                  |                     | GET {unique-amc-url}/prod/schedules                                             | GET {api_url}/amc/reporting/{instanceId}/schedules                                             |\n","|                                  |                     | GET {unique-amc-url}/prod/schedules{scheduleId}                                 | GET {api_url}/amc/reporting/{instanceId}/schedules/{scheduleId}                                |\n","|                                  |                     | DELETE {unique-amc-url}/prod/schedules{scheduleId}                              | DELETE {api_url}/amc/reporting/{instanceId}/schedules/{scheduleId}                             |\n","|                                  |                     | PUT {unique-amc-url}/prod/schedules{scheduleId}                                 | PUT {api_url}/amc/reporting/{instanceId}/schedules/{scheduleId}                                |\n","| Reporting              | Datasources         | GET {unique-amc-url}/prod/{instance_id}/dataSources                             | GET {api_url}/amc/reporting/{instance_id}/dataSources                                          |\n","| Audiences              | Rule Based Audience | GET {rba_api_url}/amc/audiences/query                                         | GET {api_url}/amc/audiences/query                                                              |\n","|                                  |                     | GET {rba_api_url}/amc/audiences/query                                         | POST {api_url}/amc/audiences/query                                                             |\n","|                                  |                     | GET {rba_api_url}/amc/audiences/query                                         | GET {api_url} /amc/audiences/query/{audienceExecutionId}                                       |\n","| Advertiser data upload | Data sets           | POST {unique-amc-url}/dataSets                                                  | POST {api_url}/amc/advertiserData/{instanceId}/dataSets                                        |\n","|                                  |                     | PUT {unique-amc-url}/dataSets/{datasetID}                                       | PUT {api_url}/amc/advertiserData/{instanceId}/dataSets/{dataSetId}                             |\n","|                                  |                     | GET {unique-amc-url}/dataSets                                                   | POST {api_url}/amc/advertiserData/{instanceId}/dataSets/list                                   |\n","|                                  |                     | GET {unique-amc-url}/dataSets/{datasetID}                                       | GET {api_url}/amc/advertiserData/{instanceId}/dataSets/{dataSetId}                             |\n","|                                  | Uploads             | POST {unique-amc-url}/data/{datasetID}/uploads                                  | POST {api_url}/amc/advertiserData/{instanceId}/uploads/list                                    |\n","|                                  |                     | POST {unique-amc-url}/data/{datasetID}/uploads                                  | POST {api_url}/amc/advertiserData/{instanceId}/uploads/{dataSetId}                             |\n","|                                  |                     | GET {unique-amc-url}/data/{dataSetId}/uploads/{uploadId}                        | GET {api_url}/amc/advertiserData/{instanceId}/uploads/{dataSetId}/{uploadId}                   |\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":3,"text":"New endpoints"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration","content":["| Category                         | Resource                              | Endpoints                                                              |\n","\\| :------------------------------- \\| :------------------------------------ \\| :--------------------------------------------------------------------- \\|\n","| Administration         | Accounts                              | GET {api_url}/amc/accounts                                             |\n","|                                  | Instances                             | POST {api_url}/amc/instances/{instanceId}/updateCustomerAwsAccount     |\n","|                                  |                                       | GET {api_url}/amc/instances                                            |\n","|                                  |                                       | GET {api_url}/amc/instances/{instanceId}/advertisers                   |\n","|                                  |                                       | GET {api_url}/amc/instances/{instanceId}                               |\n","| Audiences              | Advertiser audiences - connection     | POST {api_url} /amc/audiences/connections                              |\n","|                                  |                                       | GET {api_url}/amc/audiences/connections                                |\n","|                                  |                                       | DELETE {api_url}/amc/audiences/connections?connectionId={connectionId} |\n","|                                  | Advertiser audience creation metadata | POST {api_url}/amc/audiences/metadata/                                 |\n","|                                  |                                       | PUT {api_url}/amc/audiences/metadata/{audienceId}                      |\n","|                                  |                                       | GET {api_url}/amc/audiences/metadata/{audienceId}                      |\n","|                                  | Advertiser audience creation          | POST {api_url}/amc/audiences/records                                   |\n","|                                  | AMC terms                             | GET {api_url} /amc/audiences/connections/terms                         |\n","|                                  |                                       | PATCH {api_url} /amc/audiences/connections/terms                       |\n","| Audiences              | Rule-based lookalike audiences        | POST {api_url} /amc/audiences/lookalike                                |\n","| Advertiser data upload | Data sets                             | DELETE {api_url}/amc/advertiserData/{instanceId}/dataSets/{dataSetId}  |\n","|                                  | Data set column                       | POST {api_url}/amc/advertiserData/{instanceId}/dataSets/{dataSetId}    |\n","|                                  |                                       | PUT {api_url}/amc/advertiserData/{instanceId}/dataSets/{dataSetId}     |\n","|                                  |                                       | DELETE {api_url}/amc/advertiserData/{instanceId}/dataSets/{dataSetId}  |\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":3,"text":"Deprecated Endpoint"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration","content":["| Category               | AMC v1 endpoint                                    | Description   |\n","\\| :--------------------- \\| :------------------------------------------------- \\| :------------ \\|\n","| Advertiser data upload | POST {unique-amc-url}/data/{datsetId}/batchUploads | Batch uploads |\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":3,"text":"New or updated parameters for workflow management services"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration","content":[" The following two new parameters have been included in the schedules and workflowExecutions of Sandbox instances.\n","requireSyntheticData - disableAggregationControls\n"," For details, refer to AMC sandbox.\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":3,"text":"New or updated parameters for advertiser data upload resources"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration","content":[" Update strategy\n"," This is a new parameter that allows you to set how new data will be merged with existing data in the instance.\n"," Dataset period\n"," Dataset period options have changed to:\n","P1D (daily partition) - PT1H (hourly partition) - P1M (monthly partition)\n"," S3 bucket for advertiser data upload\n"," The S3 bucket can be within the Connected AWS Account associated to the AMC instance you will be uploading data to, or within a different AWS account. If you are using an S3 bucket within the Connected AWS Account, we recommend using a bucket separate from one created for AMC API report storage.\n"," For more information, refer to Set up the S3 bucket.\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration","content":[],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration-guide","content":[" Migrating AMC APIs to Amazon Ads requires you to first request API access and then onboard your application to the Amazon Ads API.\n"," Step 1: Go to https&#x3A;//developer.amazon.com/ and click Developer console on the top-right of the page.  Create an Amazon developer account. If your account is created successfully, the Amazon developer - Dashboard page shows up.\n"," Step 2: Click Login with Amazon and then click Create a New Security profile. In the Security Profile Management page, provide the following details:\n","Security Profile Name: A name to identify the client application, for example AMC APIs. - Security Profile Description: A description to identify the security profile you are creating.  - Consent Privacy Notice URL: This is the URL address of the privacy policy of your profile. \n"," Click Save. Your Login with Amazon account and a security profile are created. \n"," Step 3: Click the gear icon alongside the profile you just created and select Web Settings. \n","In the Security Profile Management - Web Settings tab, provide a value for Allowed Return URLs. This value is referred to as YOUR_RETURN_URL.  - Click Client secret. Copy the Client ID (referred to as YOUR_LWA_CLIENT_ID) and the Client Secret (referred to as YOUR_SECRET_KEY). \n"," Step 4: Depending on your business Apply for API access, either as a Partner or as a direct advertiser.\n"," Your application could take up to 1 business day to get approved.  If your API access request is approved, you will receive an email from Amazon Ads informing you of the approval and a link that you will use for accessing your APIs.\n"," Step 5: Click the link in the approval email to assign API access to the LwA application you created earlier.\n"," Select the client application listed to which you want to assign API access.  Note the scopes that the client application has been approved to use.  If you need access to the Advertiser audiences or the Advertiser data upload APIs, you must request Data provider access when applying for API access. If your access is approved, you will receive the advertising::audiences scope too.    \n"," At this point, your client application has been approved to access Amazon Ads APIs. You will now set up the authorization workflow for the client application. \n"," Step 6: You now need to create an authorization URL. The output of the authorization URL is an authorization code that you will use to generate an access token. To create the authorization URL, you need the following:\n","The LwA client ID of the application (YOUR_LWA_CLIENT_ID) - Scope(s) to authorize. If you have more than one scope, separate the two scopes with a space. The browser will encode a space at runtime.  - The redirect_uri of the application (YOUR_RETURN_URL) - Response type. This will always be code.\n"," The authorization URL for a user in the North America region will be in the following format:\n"," Step 7: If the parameters in the above URL are valid, the page refreshes to display your client application, asking you for permission to use the application. Click Allow.  You will now be redirected to the redirect url. The address bar of your browser also displays the authorization code that you will use to generate an access token. The format of the returned URL is listed below:\n"," Step 8: Copy the code generated here, referred to as the AUTH_CODE. You need it for the next step.\n"," For your initial setup, you need the following to generate an access token:\n","The LwA client ID of the application (YOUR_LWA_CLIENT_ID) - The client secret of the application (YOUR_SECRET_KEY) - The redirect URI of the application (YOUR_RETURN_URL) - The authorization code that your authorization URL generated (AUTH_CODE) - The grant_type to use, which is authorization_code. \n"," Step 9: Make an HTTP request using the following curl command (after inserting valid values for the listed parameters) to generate tokens from authorization_code:\n"," This will return an access token (value that is prepended with Atza) and a refresh token (value prepended with Atzr). The access token can be used to authenticate all requests by providing it in a header. Now that you have a valid access token and values for the common header parameters, you are ready to make your first call.  \n"," For authenticating your access using Postman, see Quickstart guide: Getting started using the Amazon Ads API Postman collection.\n"," Next steps: Make your first call\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":2,"text":"Updating S3 bucket policy to receive query results. "},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration-guide","content":[" Your query execution results (POST /amc/reporting/{instanceId}/workflowExecutions) can either be downloaded by retrieving a pre-signed URL or accessed through an S3 bucket that you configured when your instance was created. After migrating to the Amazon Ads API, to continue accessing your query execution results from your S3 bucket, you need to update the Identity Access Management (IAM) policy associated with your output bucket to allow your S3 bucket to receive the results.   To update your bucket policy, perform the following steps: \n","Log in to your AWS Account. Access your S3 Console. 2. Access your bucket through your S3 account.  3. Navigate to the Permissions tab and scroll to the Bucket policy section. 4. Click Edit. 5. Update the bucket policy to grant 811639200769 s3:PutObject permissions. Depicted below is how the updated policy for a sample S3 bucket named amc-bucket01 will look. \n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":2,"text":"Migrating from Advertiser Data Upload 1.0 to Advertiser Data Upload APIs on Amazon Ads"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration-guide","content":[" Before you migrate from Advertiser Data Upload v1 (ADU 1.0) to Advertiser Data Upload APIs on Amazon Ads (ADU 2.0), when applying for API access, obtain approved access for the \"Data Provider\" scope in addition to the \"Campaign Management\" scope and set up your S3 bucket to configure it for the files you are uploading. \n"," If you are migrating from ADU 1.0 to AMC Advertiser Data Upload APIs on Amazon Ads (v2) and want to use the same datasets you uploaded using ADU 1.0, you need to:\n","Recreate the datasets using Advertiser Data Upload APIs on Amazon Ads (POST /amc/advertiserData/{instanceId}/dataSets). Refer to Create dataset. \n","Upload the data to the newly created datasets (POST {api_url}/amc/advertiserData/{instanceId}/uploads/{dataSetId}). Refer to Upload data to datasets. \n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration-FAQs","content":[" What are instance-level APIs?\n"," The previous version of the AMC APIs were configured to be accessed at the instance-level of the advertiser. Each AMC instance has its own unique endpoint as detailed in the \"Instance info\" page of the AMC instance. The instance-level APIs were not completely aligned with regular Amazon Ads API practices.\n"," How does the migration impact me? What actions should I take?\n"," We recommend users currently on the instance-level APIs migrate to the upgraded APIs as soon as possible to take advantage of the enhanced security, usability, and performance of new APIs.\n"," Can I still use AMC instance-level APIs?\n"," No, instance-level APIs are completely retired. Calling the instance-level endpoints will result in a 410 error. To avoid disruptions to your business operations, we recommend you migrate to new APIs as soon as possible.\n"," How do I know whether a particular API I am using is instance-level API or the updated version?\n"," If your base URL contains any of the following,\n","https&#x3A;//advertising-api.amazon.com - https&#x3A;//advertising-api-eu.amazon.com - https&#x3A;//advertising-api-fe.amazon.com\n"," it is the updated version. Otherwise, you are using the instance-level version.\n"," How do I migrate to the new AMC APIs?\n"," While detailed steps are outlined in the migration guide, the major steps are outlined below for your easy comprehension:\n","| Steps to onboard and migrate AMC APIs to Amazon Ads                                                                                                                                                                                                                                                                                    | Access to Instance-level AMC API only | Access to other Ad products on Amazon Ads APIs |\n","\\| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| :-----------------------------------: \\| :--------------------------------------------: \\|\n","| Register with Amazon Developer and create Login with Amazon (LwA)                                                                                                                                                                                                      |                   X                   |                                                |\n","| Create anLwA security profile and retrieve LwA Client Id and Client secret                                                                                                                                                                                                                          |                   X                   |                                                |\n","| Apply for API Access as a Partner or as an advertiser.                                                                                    |                                      |                                                |\n","| Remember to select the API scopes required for your business. Note that it usually takes around 1 business day for the team to process the approval request.                                                                                                                                                                            |                   X                   |                                                |\n","| On approval,Assign API access to your LwA application                                                                                                                                                                                                                                              |                   X                   |                                                |\n","| Create an authorization grant (for first time access)                                                                                                                                                                                                                                    |                   X                   |                                                |\n","| Use the code generated from the auth grant URL to generate access and refresh tokens                                                                                                                                                                                                          |                   X                   |                                                |\n","| Set upAMC API header parameters                                                                                                                                                                                                                                |                   X                   |                       X                       |\n","| For each endpoint, replace base URL with the new URLs(AMC endpoints). Where indicated, pass the instance id as path parameter. See AMC API references and AMC migration guide |                   X                   |                       X                       |\n","| If you use S3 bucket to access AMC query results today, you need to update IAM policy associated with your output bucket                                                                                                                                                                                                               |                   X                   |                       X                       |\n"," After I migrate to the new AMC APIs, can I continue to access the query results from my S3 bucket?\n"," Your query execution results (POST /amc/reporting/{instanceId}/workflowExecutions) can either be downloaded by retrieving a pre-signed URL or accessed through an S3 bucket that you configured when your instance was created. After migrating to the Amazon Ads API, to continue accessing your query execution results from your S3 bucket, you will need to update the Identity Access Management (IAM) policy associated with your output bucket to allow your S3 bucket to receive the results. To update your IAM policy, perform the following steps:\n","Log in to your AWS Account. Access your S3 Console. 2. Access your bucket through your S3 account. 3. Navigate to the Permissions tab and scroll to the Bucket policy section. 4. Click Edit. 5. Update the bucket policy to grant 811639200769 s3:PutObject permissions. Depicted below is how the updated policy for a sample instance named amc-instance01 will look.\n"," What should I do if I am already on the closed beta version of some APIs?\n"," If you are already using the closed beta version of AMC APIs, ensure that 1) you have migrated all instances you manage 2) you migrate any other instance-level APIs you are using to Amazon Ads API.\n"," Will the \"AMC Insights on AWS\" and \"AMC Uploader from AWS\" solutions be impacted by this launch?\n"," These solutions have been updated to support the latest Amazon Ads APIs to provide you an uninterrupted experience.\n"," How is this the new version of advertiser data upload API (ADU 2.0) different from the instance-level data upload API (ADU 1.0) in the past?\n"," While the process of performing data upload is still mostly the same as before, ADU API 2.0 includes a number of improvements, as described below:\n","AMC ADU 2.0 can now handle partitioning data into time chunks required to run 1P data analysis. In ADU 1.0 partitioning the data was a manual process that advertisers needed to execute themselves. For example, in the past, if advertisers wanted to upload 5 days worth of data, they needed to manually separate out this data into 5 files and perform the upload; with ADU 2.0, advertisers can just share one file and let AMC know how to read and partition the data into an acceptable format. 2. AMC ADU 2.0 now has dedicated API actions for updating data tables in AMC. These include actions such as updating data, deleting data, and updating columns.\n"," Note that ADU API 2.0 is only available as part of Amazon Ads API, and is not available as instance-level API.\n"," What will happen to the existing advertiser first-party data previously uploaded via the instance-level ADU 1.0? Will I be able to access and utilize those datasets using ADU 2.0?\n"," Data that was uploaded using ADU 1.0 can no longer be queried. To continue querying datasets that you had uploaded in ADU 1.0, delete the previously uploaded data, and re-upload using updated gateway version (ADU 2.0).\n"," Are we expecting more changes after this?\n"," We do not foresee the current set of APIs undergoing any significant or breaking changes. Note that in the future, we expect the AMC API headers to be standardized to align with the rest of the Amazon Ads APIs. The standardized headers will be implemented in a manner that will cause minimal disruption to your current deployments. In case there are other major updates, we will notify developers ahead of time.\n"," What are the key benefits of using the new API for advertiser audiences?\n"," The new advertiser audiences API has the following benefits:\n","Follows industry conventions for creating first-party audiences, similar to the method used by other publishers. - Allows the user the option to send hashed records to both AMC and Amazon DSP. - Allows ingressing signals from any destination, without having to go through S3 buckets. - Supports incremental refresh (add/move members) instead of a full refresh; this helps to reduce processing latency.\n"," Who should / when should I choose to use advertiser audiences API?\n"," Advertiser audience API works best for SaaS providers like CDPs, as well as agencies, or consultancies that would like to build \"always on\" advertiser data upload integrations. Direct advertisers who are willing to build and maintain an API integration with Amazon Ads can use this API as well.\n"," However, if you expect to bring in first-party signals on sales, conversions, or other area that is not related to audiences, or only plan to upload data on an ad hoc basis, we recommend that you use advertiser data upload API instead.\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":3,"text":"Advertiser data upload API"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration-FAQs","content":[" How is this new version of advertiser data upload API (ADU 2.0) different from the instance-level data upload API (ADU 1.0)?\n"," While the process of uploading data to AMC is still the same as before, ADU API 2.0 includes a number of improvements:\n","AMC ADU 2.0 can now handle partitioning data into time chunks required to run 1P data analysis, which was a manual process advertisers needed to execute themselves. - AMC ADU 2.0 now has dedicated API actions for updating data tables in AMC. These include actions such as updating, deleting, and updating columns.\n"," What will happen to the existing advertiser first-party data previously uploaded via the instance-level APIs? Will I be able to access and utilize those datasets using the new advertiser data upload API?\n"," Data that was uploaded using ADU 1.0 can no longer be queried. To continue querying datasets that you had uploaded in ADU 1.0, delete the previously uploaded data, and re-upload using ADU 2.0\n"],"documentType":"guide"},{"title":"AMC migration hub","sectionHeader":{"type":3,"text":"Advertiser audiences"},"path":"/en-us/guides/amazon-marketing-cloud/amc-migration-hub/migration-FAQs","content":[" How is the advertiser audiences API different from the advertiser data upload API?\n"],"documentType":"guide"},{"title":"Ad Server Conversions","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/ad_server_conversions","content":[],"documentType":"guide"},{"title":"Ad Server Conversions","sectionHeader":{"type":2,"text":"adserver\\_conversions"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/ad_server_conversions","content":[" The data source adserver_conversions includes all unattributed conversion activities measured by Amazon Ad Server Tag Manager and conversion activity pixels. All conversion events can be found in this data source, including activities that were assigned to brand(s), but without brand indication. Use this data source to get insight on all adserver conversions.\n"," Use this data source to gain insights about conversions captured by Amazon Ad Server conversion activity tags and for custom attribution insights for Amazon Ad Server captured conversions.\n","| Field Category | Name | Data Type | Metric / Dimension | Description | Aggregation Threshold |\n","\\| :--- \\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| Account setup | account_currency | STRING | Dimension | Currency of the account in Amazon Ad Server. | LOW |\n","| Account setup | account_timezone | STRING | Dimension | Time zone of the account in Amazon Ad Server. | LOW |\n","| Advertiser setup | advertiser | STRING | Dimension | Amazon Ad Server advertiser name. | LOW |\n","| Advertiser setup | advertiser_id | LONG | Dimension | Amazon Ad Server advertiser ID. | LOW |\n","| Event delivery info - Device | browser_family | STRING | Dimension | Browser Name, e.g. Chrome. | LOW |\n","| Geography | city | STRING | Dimension | City name of the conversion event based on the IP of the user when the user converted, e.g. Barcelona. | HIGH |\n","| Conversion Activity setup | conversion_activity | STRING | Dimension | Conversion Activity Name. | LOW |\n","| Conversion Activity setup | conversion_activity_id | STRING | Dimension | Conversion Activity ID, ID of the entity from Tag Manager set up. | LOW |\n","| Conversion Activity setup | conversion_currency | STRING | Dimension | Conversion Activity Currency from setup. | LOW |\n","| Conversion event | conversion_id | STRING | Dimension | Event ID. | VERY_HIGH |\n","| Conversion Activity setup | conversion_type | STRING | Dimension | Conversion Activity Type, sales or counter. | LOW |\n","| Conversion delivery info | conversions | LONG | Metric | Number of unattributed conversion activities. | LOW |\n","| Event delivery info - Device | device_brand | STRING | Dimension | Mobile Device Brand, e.g. Samsung. | LOW |\n","| Event delivery info - Device | device_model | STRING | Dimension | Device Model, e.g. Motorola V600. | LOW |\n","| Event delivery info - Device | device_type | STRING | Dimension | Device Type, e.g. smartphone. | LOW |\n","| Geography | dma_code | STRING | Dimension | DMA Code of the conversion event based on the IP of the user when the user converted. | LOW |\n","| Event delivery info - Device | environment | STRING | Dimension | Environment, e.g. in-app, web, unknown. | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_date | DATE | Dimension | Event Date (Amazon Ad Server account time zone). | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_date_utc | DATE | Dimension | Event Date (UTC). | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_day | INTEGER | Dimension | Event Day of Month (Amazon Ad Server account time zone). | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_day_utc | INTEGER | Dimension | Event Day of Month (UTC). | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt | TIMESTAMP | Dimension | Event Timestamp (Amazon Ad Server account time zone) | MEDIUM |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt_hour | TIMESTAMP | Dimension | Event Timestamp (Amazon Ad Server account time zone). Truncated to Hour. | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt_hour_utc | TIMESTAMP | Dimension | Event Timestamp (UTC). Truncated to Hour. | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt_utc | TIMESTAMP | Dimension | Event Timestamp (UTC). Example: 2019-06-18T03:45:55.000 | MEDIUM |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_hour | INTEGER | Dimension | Event Hour of Day (Amazon Ad Server account time zone). | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_hour_utc | INTEGER | Dimension | Event Hour of Day (UTC). | LOW |\n","| Geography | iso_country_code | STRING | Dimension | ISO Country Code of the conversion event based on the IP of the user when the user converted, e.g. US. | LOW |\n","| Geography | iso_state_province_code | STRING | Dimension | ISO State Province Code of the conversion event based on the IP of the user when the user converted, e.g. MD. | LOW |\n","| Event delivery info - Device | operating_system | STRING | Dimension | Operating System. | LOW |\n","| Conversion Activity setup | order_id | STRING | Dimension | Order ID. | LOW |\n","| Geography | postal_code | STRING | Dimension | Postal Code of the conversion event based on the IP of the user when the user converted. | HIGH |\n","| Conversion Activity setup | product_id | STRING | Dimension | Product ID. | HIGH |\n","| Conversion Activity setup | product_info | STRING | Dimension | Product Info. | LOW |\n","| Conversion Activity setup | quantity | LONG | Metric | Quantity as collected and passed in the tag manager variable. | MEDIUM |\n","| Conversion Activity setup | referrer | STRING | Dimension | Referrer URL. | LOW |\n","| Conversion Activity setup | revenue | DECIMAL | Metric | Conversion Activity Revenue. | LOW |\n","| Conversion Activity setup | tag_manager | STRING | Dimension | Tag Manager Name. | LOW |\n","| Conversion Activity setup | tag_manager_id | LONG | Dimension | Tag Manager ID. | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | user_id | STRING | Dimension | User ID. The user_id can be used to join Amazon Ad Server data sources with other AMC data sources. | VERY_HIGH |\n","| Advertiser setup | vertical | STRING | Dimension | Amazon Ad Server vertical name as defined for the advertiser, describes the related industry of the advertiser, e.g. Consumer Packaged Goods. | LOW |\n"],"documentType":"guide"},{"title":"Ad Server Conversions with Brand","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/adserver_conversions_with_brand","content":[],"documentType":"guide"},{"title":"Ad Server Conversions with Brand","sectionHeader":{"type":2,"text":"adserver\\_conversions\\_with\\_brand"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/adserver_conversions_with_brand","content":[" The data source adserver_conversions_with_brand contains unattributed conversion activities measured by Amazon Ad Server Tag Manager and conversion activity pixels.\n"," This data source includes the adserver brand association. It contains only conversion activities that were associated to brand(s). If a conversion activity in the setup was associated to more than one brand, it will appear in multiple rows - one row per activity + brand association. Use the conversion_id field that represents the unique event identifier to remove duplicated conversions if you are analyzing all conversion data. Use this data source to analyze only conversions that were specifically assigned to one or more brands.\n","| Field Category | Name | Data Type | Metric / Dimension | Description | Aggregation Threshold |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| Account setup | account_currency | STRING | Dimension | Currency of the account in Amazon Ad Server. | LOW |\n","| Account setup | account_timezone | STRING | Dimension | Time zone of the account in Amazon Ad Server. | LOW |\n","| Advertiser setup | advertiser | STRING | Dimension | Amazon Ad Server advertiser name. | LOW |\n","| Advertiser setup | advertiser_id | LONG | Dimension | Amazon Ad Server advertiser identifier. | LOW |\n","| Event delivery info - Device | browser_family | STRING | Dimension | Browser Name, i.e. Chrome. | LOW |\n","| Geography | city | STRING | Dimension | City name of the conversion event based on the IP of the user when the user converted, i.e. Barcelona. | HIGH |\n","| Conversion Activity setup | conversion_activity | STRING | Dimension | Conversion Activity Name. | LOW |\n","| Conversion Activity setup | conversion_activity_id | STRING | Dimension | Conversion Activity ID, ID of the entity from Tag Manager set up. | LOW |\n","| Conversion Activity setup | conversion_currency | STRING | Dimension | Conversion Activity Currency from setup. | LOW |\n","| Conversion event | conversion_id | STRING | Dimension | Event ID. | VERY_HIGH |\n","| Conversion Activity setup | conversion_type | STRING | Dimension | Conversion Activity Type, sales or counter. | LOW |\n","| Event delivery info - Device | device_brand | STRING | Dimension | Mobile Device Brand, i.e. Samsung. | LOW |\n","| Event delivery info - Device | device_model | STRING | Dimension | Device model, i.e. Motorola V600. | LOW |\n","| Event delivery info - Device | device_type | STRING | Dimension | Device Type, i.e. smartphone. | LOW |\n","| Geography | dma_code | STRING | Dimension | DMA Code of the conversion event based on the IP of the user when the user converted. | LOW |\n","| Event delivery info - Device | environment | STRING | Dimension | Environment, i.e. in-app, web, unknown. | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_date | DATE | Dimension | Event Date (Amazon Ad Server account time zone). | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_date_utc | DATE | Dimension | Event Date (UTC). | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_day | INTEGER | Dimension | Event Day of Month (Amazon Ad Server account time zone). | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_day_utc | INTEGER | Dimension | Event Day of Month (UTC). | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt | TIMESTAMP | Dimension | Event Timestamp (Amazon Ad Server account time zone). | MEDIUM |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt_hour | TIMESTAMP | Dimension | Event Timestamp (Amazon Ad Server account time zone). Truncated to Hour. | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt_hour_utc | TIMESTAMP | Dimension | Event Timestamp (UTC). Truncated to Hour. | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt_utc | TIMESTAMP | Dimension | Event Timestamp (UTC). Example: 2019-06-18T03:45:55.000. | MEDIUM |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_hour | INTEGER | Dimension | Event Hour of Day (Amazon Ad Server account time zone). | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_hour_utc | INTEGER | Dimension | Event Hour of Day (UTC). | LOW |\n","| Geography | iso_country_code | STRING | Dimension | ISO Country Code of the conversion event based on the IP of the user when the user converted, i.e. US. | LOW |\n","| Geography | iso_state_province_code | STRING | Dimension | ISO State Province Code of the conversion event based on the IP of the user when the user converted, i.e. MD. | LOW |\n","| Event delivery info - Device | operating_system | STRING | Dimension | Operating System. | LOW |\n","| Conversion event | order_id | STRING | Dimension | Order ID. | LOW |\n","| Geography | postal_code | STRING | Dimension | Postal Code of the conversion event based on the IP of the user when the user converted. | HIGH |\n","| Conversion event | product_id | STRING | Dimension | Product ID. | HIGH |\n","| Conversion event | product_info | STRING | Dimension | Product Info. | LOW |\n","| Conversion event | quantity | LONG | Metric | Quantity. | MEDIUM |\n","| Conversion event | referrer | STRING | Dimension | Referrer URL. | LOW |\n","| Conversion event | revenue | LONG | Metric | Conversion Activity Revenue. | LOW |\n","| Advertiser setup | adserver_brand | STRING | Dimension | Amazon Ad Server brand name. In Amazon Ad Server an advertiser can have multiple brands. Brand can be associated to advertiser campaigns. One campaign can have only a single brand associated to it. | LOW |\n","| Advertiser setup | adserver_brand_id | LONG | Dimension | Amazon Ad Server brand identifier. In Amazon Ad Server an advertiser can have multiple brands. Brand can be associated to advertiser campaigns. One campaign can have only a single brand associated to it. | LOW |\n","| Conversion Activity setup | tag_manager | STRING | Dimension | Tag Manager Name. | LOW |\n","| Conversion Activity setup | tag_manager_id | LONG | Dimension | Tag Manager ID. | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | user_id | STRING | Dimension | User ID. The user_id can be used to join Amazon Ad Server data sources with other AMC data sources. | VERY_HIGH |\n","| Advertiser setup | vertical | STRING | Dimension | Amazon Ad Server vertical name as defined for the advertiser, describes the related industry of the advertiser, i.e. Consumer Packaged Goods. | LOW |\n"],"documentType":"guide"},{"title":"Ad Server traffic","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/adserver_traffic","content":[],"documentType":"guide"},{"title":"Ad Server traffic","sectionHeader":{"type":2,"text":"adserver\\_traffic"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/adserver_traffic","content":[" The data source adserver_traffic includes impressions, clicks, and interactions (video and viewability) from integrations with Search advertising platforms measured by the Amazon Ad Server.\n"," Events that were measured using Amazon Ad Server placement tags on Amazon DSP have a request_tag. The request_tag is a unique token that is similar to (and joins with) the request_tag in the dsp_impressions data source. The request_tag can be used as a join key to enrich adserver events with DSP data, such as bidding costs and other parameters that are native to the Amazon DSP, but not directly accessible on adserver events.\n"," Use this data source to gain insights about your Amazon Ad Server measured media. You can query this data source only if you have ad server campaigns and have completed Amazon Ad Server - AMC onboarding.\n","| Field  Category                                                  | Name                            | Data Type | Metric / Dimension | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Aggregation Threshold |\n","\\| ---------------------------------------------------------------- \\| ------------------------------- \\| --------- \\| ------------------ \\| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \\| --------------------- \\|\n","| Account  setup                                                   | account_currency               | STRING    | Dimension          | Currency of the  Amazon Ad Server account.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | LOW                   |\n","| Account setup                                                    | account_timezone               | STRING    | Dimension          | Time  zone of the Amazon Ad Server account.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| Ad setup                                                         | ad                              | STRING    | Dimension          | Ad  Name, name of the ad that is attached to a placement.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| Interaction info                                                 | ad_duration                    | LONG      | Metric             | Average  time in seconds that ad was in view (ad_duration_value/ad_duration_counter).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| Ad setup                                                         | ad_format                      | STRING    | Dimension          | Ad  Format (in-banner, in-stream video, rich media, etc.).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | LOW                   |\n","| Ad setup                                                         | ad_id                          | LONG      | Dimension          | Ad  ID, ad that is attached to a placement.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| Ad setup                                                         | ad_length                      | LONG      | Dimension          | Total  duration of the ad in seconds, from the ad settings.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| Ad setup                                                         | ad_size                        | STRING    | Dimension          | Ad  size in kb.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| Interaction info                                                 | ad_started                     | LONG      | Metric             | Number  of times when ad started to load in user browser/ player. Equal or less than  impressions.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| Advertiser setup                                                 | adserver_brand                 | STRING    | Dimension          | Amazon  Ad Server brand name. A single Amazon Ad Server advertiser can have multiple  brands. One campaign can be associated to a single brand.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| Advertiser setup                                                 | adserver_brand_id             | LONG      | Dimension          | Amazon  Ad Server brand ID. A single Amazon Ad Server advertiser can have multiple  brands. One campaign can be associated to a single brand.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | LOW                   |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | adserver_session_id           | STRING    | Dimension          | Amazon  Ad Server session ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | VERY_HIGH            |\n","| Site setup                                                       | adserver_site                  | STRING    | Dimension          | Amazon  Ad Server site name. Represents an entity that buys or sells media (can be a  publisher or DSP name; this is not a domain name of site where the ad was  served).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| Advertiser setup                                                 | advertiser                      | STRING    | Dimension          | Amazon  Ad Server advertiser name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| Advertiser setup                                                 | advertiser_id                  | LONG      | Dimension          | Amazon  Ad Server advertiser ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| Event delivery info - Device                                     | browser_family                 | STRING    | Dimension          | Browser  Name, e.g. Chrome.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| Campaign setup                                                   | campaign                        | STRING    | Dimension          | Amazon  Ad Server Campaign Name, as appears in Ad Server (for display and search).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| Campaign setup                                                   | campaign_end_date             | DATE      | Dimension          | End  date of campaign (Amazon Ad Server account time zone).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| Campaign setup                                                   | campaign_end_date_utc        | DATE      | Dimension          | End  date of campaign (UTC).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | LOW                   |\n","| Campaign setup                                                   | campaign_end_dt               | DATE      | Dimension          | End  timestamp of campaign (Amazon Ad Server account time zone).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| Campaign setup                                                   | campaign_end_dt_utc          | DATE      | Dimension          | End  timestamp of campaign (UTC).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| Campaign setup                                                   | campaign_id                    | LONG      | Dimension          | Amazon  Ad Server Campaign ID (internal Amazon Ad Server IDs for display and search).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| Campaign setup                                                   | campaign_start_date           | DATE      | Dimension          | Start  date of campaign (Amazon Ad Server account time zone).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | LOW                   |\n","| Campaign setup                                                   | campaign_start_date_utc      | DATE      | Dimension          | Start  date of campaign (UTC).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW                   |\n","| Campaign setup                                                   | campaign_start_dt             | DATE      | Dimension          | Start  timestamp of campaign (Amazon Ad Server account time zone).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| Campaign setup                                                   | campaign_start_dt_utc        | DATE      | Dimension          | Start  timestamp of campaign (UTC).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | LOW                   |\n","| Campaign setup                                                   | campaign_type                  | STRING    | Dimension          | Campaign  Type, display or search.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| Geography                                                        | city                            | STRING    | Dimension          | City  name, e.g. Barcelona.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | HIGH                  |\n","| Click delivery info                                              | clicks                          | LONG      | Metric             | Number  of clicks. Includes all clicks measured by Amazon Ad Server, among them:  display clicks as well as search_clicks, sivt_clicks, ssai_clicks, and  no_script_clicks.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n","| Click delivery info                                              | clicks_default_ad             | LONG      | Metric             | Number  of clicks when default ad was served.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| Click delivery info                                              | clicks_hard_stop              | LONG      | Metric             | Number  of clicks recorded after stop serving condition defined in Amazon Ad Server  placement was reached.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | NONE                  |\n","| Click delivery info                                              | clicks_no_script              | LONG      | Metric             | Number  of clicks on ads that loaded from &lt;no script> tag of creative snippet.  Indicates that ad was served in the environment where js was disabled and  reach media version of the ad could not render.                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| Click delivery info                                              | clicks_sivt                    | LONG      | Metric             | Number  of clicks marked as sophisticated invalid traffic (SIVT) according to the MRC  Guidelines. Note that only campaigns with advanced verification data  collection mode are measured for SIVT. This metric will be 0 if campaign is  not enabled for advanced verification data collection.                                                                                                                                                                                                                                                                                                                                                                                       | NONE                  |\n","| Click delivery info                                              | clicks_ssai                    | LONG      | Metric             | Number  of clicks delivered using Server Side Ad Insertion (SSAI) method.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| Placement setup                                                  | cost_model_type               | STRING    | Dimension          | Cost  model defined on Amazon Ad Server placement (CPM, CPC, CTA, etc.).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| Placement setup                                                  | cost_per_unit                 | STRING    | Dimension          | Cost  per billable unit defined in placement set up.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| Event delivery info - Device                                     | device_brand                   | STRING    | Dimension          | Mobile  Device Brand, e.g. Samsung.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | LOW                   |\n","| Event delivery info - Device                                     | device_model                   | STRING    | Dimension          | Device  Model, e.g. Motorola V600.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| Event delivery info - Device                                     | device_type                    | STRING    | Dimension          | Device  Type, e.g. smartphone.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW                   |\n","| Geography                                                        | dma_code                       | STRING    | Dimension          | DMA  Code.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | LOW                   |\n","| Event delivery info - Device                                     | environment                     | STRING    | Dimension          | Environment,  e.g. in-app, web, unknown.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_date                     | DATE      | Dimension          | Event  Date (Amazon Ad Server account time zone).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_date_utc                | DATE      | Dimension          | Event  Date (UTC).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_day                      | INTEGER   | Dimension          | Event  Day of Month (Amazon Ad Server account time zone).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_day_utc                 | INTEGER   | Dimension          | Event  Day of Month (UTC).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | LOW                   |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt                       | TIMESTAMP | Dimension          | Event  Timestamp (Amazon Ad Server account time zone).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | MEDIUM                |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt_hour                 | TIMESTAMP | Dimension          | Event  Timestamp (Amazon Ad Server account time zone) Truncated to Hour.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt_hour_utc            | TIMESTAMP | Dimension          | Event  Timestamp (UTC) Truncated to Hour.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_dt_utc                  | TIMESTAMP | Dimension          | Event  Timestamp (UTC). Example: 2019-06-18T03:45:55.000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | MEDIUM                |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_hour                     | INTEGER   | Dimension          | Event  Hour of Day (Amazon Ad Server account time zone).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | event_hour_utc                | INTEGER   | Dimension          | Event  Hour of Day (UTC).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| Impression delivery info                                         | impressions                     | LONG      | Metric             | Total  impressions served, excluding GIVT. Includes all billable impressions served  and tracked by Amazon Ad Server, among them impressions_sivt,  impressions_ssai, and impressions_noscript.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| Impression delivery info                                         | impressions_default_ad        | LONG      | Metric             | Number  of impressions where default banner ad was delivered.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| Impression delivery info                                         | impressions_hard_stop         | LONG      | Metric             | Number  of impressions recorded after stop serving condition defined in Amazon Ad  Server placement was reached.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | NONE                  |\n","| Impression delivery info                                         | impressions_no_script         | LONG      | Metric             | Number  of impressions for ads that were served from &lt;no script> tag of  creative snippet. Indicates that ad was served in the environment where js  was disabled and rich media version of the ad could not render.                                                                                                                                                                                                                                                                                                                                                                                                                                                               | NONE                  |\n","| Impression delivery info                                         | impressions_sivt               | LONG      | Metric             | Number  of impressions marked as sophisticated invalid traffic (SIVT) according to  the MRC Guidelines. For campaigns with 3rd party ad blocking enabled, Amazon  Ad Server includes blocked impressions when calculating SIVT impressions.  Note that only campaigns with advanced verification data collection mode are  measured for SIVT. This metric will be 0 if campaign is not enabled for  advanced verification data collection.                                                                                                                                                                                                                                             | NONE                  |\n","| Impression delivery info                                         | impressions_ssai               | LONG      | Metric             | Number  of impressions delivered using Server Side Ad Insertion (SSAI) method.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| Ad setup                                                         | is_dco_ad                     | BOOLEAN   | Dimension          | TRUE  Indicates that the ad that generated this event is a DCO ad.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| Geography                                                        | iso_country_code              | STRING    | Dimension          | ISO  Country Code, e.g. US.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| Geography                                                        | iso_state_province_code      | STRING    | Dimension          | ISO  State Province Code, e.g. MD.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| Impression delivery info                                         | measurable_impressions         | LONG      | Metric             | Number  of impressions served in campaigns that were enabled for viewability  measurement. Note that only campaigns with verification data collection mode  are measured for viewability. This metric will be 0 if campaign is not  enabled for verification data collection.                                                                                                                                                                                                                                                                                                                                                                                                          | NONE                  |\n","| Event delivery info - Device                                     | operating_system               | STRING    | Dimension          | Operating  System.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| Placement setup                                                  | ordered_units                  | LONG      | Dimension          | Number  of units ordered from publisher.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| Package setup                                                    | package                         | STRING    | Dimension          | Amazon  Ad Server package name. entity that represents a group of placements with  shared flight dates and cost settings.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| Package setup                                                    | package_end_date              | DATE      | Dimension          | Package  end date in Amazon Ad Server account time zone.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| Package setup                                                    | package_end_date_utc         | DATE      | Dimension          | Package  end date in UTC.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| Package setup                                                    | package_id                     | LONG      | Dimension          | Amazon  Ad Server Package ID. entity that represents a group of placements with  shared flight dates and cost settings.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW                   |\n","| Package setup                                                    | package_start_date            | DATE      | Dimension          | Package  start date in Amazon Ad Server account time zone.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | LOW                   |\n","| Package setup                                                    | package_start_date_utc       | DATE      | Dimension          | Package  start date in UTC.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| Placement setup                                                  | placement                       | STRING    | Dimension          | Amazon  Ad Server Placement Name. Media plan entity below campaign that holds site,  ads, cost, flight period and other serving instructions for serving or  tracking.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| Placement setup                                                  | placement_dimensions           | STRING    | Dimension          | Placement  dimensions, e.g. 320x50.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | LOW                   |\n","| Placement setup                                                  | placement_end_date            | DATE      | Dimension          | Placement  end date (Amazon Ad Server account time zone).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| Placement setup                                                  | placement_end_date_utc       | DATE      | Dimension          | Placement  end date (UTC).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | LOW                   |\n","| Placement setup                                                  | placement_id                   | LONG      | Dimension          | Amazon  Ad Server Placement ID. Media plan entity below campaign that holds site,  ads, cost, flight period and other serving instructions for serving or  tracking.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| Placement setup                                                  | placement_start_date          | DATE      | Dimension          | Placement  start date (Amazon Ad Server account time zone).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | LOW                   |\n","| Placement setup                                                  | placement_start_date_utc     | DATE      | Dimension          | Placement  start date (UTC).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | LOW                   |\n","| Placement setup                                                  | placement_type                 | STRING    | Dimension          | Placement  type. e.g. in-stream video tracking.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| Geography                                                        | postal_code                    | STRING    | Dimension          | Postal  Code.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | HIGH                  |\n","| Impression delivery info                                         | recordable_impressions         | LONG      | Metric             | Number  of impressions (out of measurable_impressions) that were successfully  recorded for viewability evaluation. For example, viewability signal cannot be  collected for impression served in unfriendly iframe and so such impression  will not be recorded for viewability. Note that this metric will be 0 if  campaign is not enabled for verification data collection.                                                                                                                                                                                                                                                                                                           | NONE                  |\n","| Event (impression, Click, Interaction) Delivery Info             | request_tag                    | STRING    | Dimension          | An  ID related to the impression event on Amazon DSP. Every time Amazon Ad Server  tag is used in Amazon DSP for serving or tracking an impression recorded by  Amazon Ad Server and impression recorded by Amazon DSP will have same  request_tag token assigned. As such, request_tag can be used as join key to  enrich Amazon Ad Server events with Amazon DSP properties for similar  impression in dsp_impressions data set. It can also be used for deduplicating  impression and click data across adserver and non adserver data sets. For  more information about using request_tag in queries refer to column name  request_tag in dsp_impressions data source. | VERY_HIGH            |\n","| Search Campaign setup                                            | search_account_id             | LONG      | Dimension          | Search  Account ID. ID of the advertiser account in Search platform.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | LOW                   |\n","| Search Campaign setup                                            | search_ad                      | STRING    | Dimension          | Search  Ad Title.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| Search Campaign setup                                            | search_ad_click_through_url | STRING    | Dimension          | Redirect  URL on the search ad.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| Search Campaign setup                                            | search_ad_display_url        | STRING    | Dimension          | URL  displayed in the search ad.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| Search Campaign setup                                            | search_ad_group               | STRING    | Dimension          | Search  Ad Group Name, as defined in Search platform.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| Search Campaign setup                                            | search_ad_group_id           | LONG      | Dimension          | Search  Ad Group ID, external ID assigned by Search platform.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | LOW                   |\n","| Search Campaign setup                                            | search_ad_id                  | LONG      | Dimension          | Search  Ad ID, external ID assigned by Search platform.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | LOW                   |\n","| Search Campaign setup                                            | search_ad_text                | STRING    | Dimension          | Search  Ad Text.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | LOW                   |\n","| Search Campaign setup                                            | search_campaign_id            | LONG      | Dimension          | Search  Campaign ID, external ID assigned by Search platform.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | LOW                   |\n","| Search Campaign setup                                            | search_campaign_type          | STRING    | Dimension          | Type  of search campaign, e.g. Shopping.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| Search click delivery info                                       | search_clicks                  | LONG      | Metric             | Number  of search clicks tracked by Amazon Ad Server through direct integration with  Bing and AdWords or though SEM integration with Kenshoo and Marin.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | NONE                  |\n","| Search Campaign setup                                            | search_integration             | STRING    | Dimension          | Type  of integration: Direct, SEM (Kenshoo or Marin).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| Search Campaign setup                                            | search_keyword_id             | LONG      | Dimension          | Keyword  ID, external ID assigned by Search platform.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| Search Campaign setup                                            | search_keyword_text           | STRING    | Dimension          | Keyword  text.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | LOW                   |\n","| Search Campaign setup                                            | search_keyword_type           | STRING    | Dimension          | Keyword  Type. Type of the targeted entity in Search platform, e.g. keyword, product  ID, dynamic ad.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| Search Click                                                     | search_match_type             | STRING    | Dimension          | Represents  the relevancy of the search term: BROAD, EXACT, PHRASE.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | LOW                   |\n","| Search Campaign setup                                            | search_vendor                  | STRING    | Dimension          | Name  of search provider, e.g. AdWords or Bing.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | LOW                   |\n","| Placement setup                                                  | section                         | STRING    | Dimension          | Amazon  Ad Server site section name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| Placement setup                                                  | section_id                     | LONG      | Dimension          | Amazon  Ad Server site section ID where Amazon Ad Server placement tag is placed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | LOW                   |\n","| Version setup                                                    | smart_items_list              | STRING    | DIMENSION          | List  of all dynamic elements in a particular version.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | LOW                   |\n","| Target Audience setup                                            | target_audience_id            | LONG      | DIMENSION          | Internal  AAS ID of a Target Audience                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| Target Audience setup                                            | target_audience_name          | STRING    | DIMENSION          | Display  name in AAS of a Target Audience                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | LOW                   |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | user_id                        | STRING    | Dimension          | User  ID. The user_id can be used to join Amazon Ad Server data sources with other  AMC data sources.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | VERY_HIGH            |\n","| Version setup                                                    | version_id                     | LONG      | DIMENSION          | Internal  AAS ID of a DCO ad version                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | LOW                   |\n","| Version setup                                                    | version_name                   | STRING    | DIMENSION          | Display  name in AAS of a DCO ad version                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | LOW                   |\n","| Advertiser setup                                                 | vertical                        | STRING    | Dimension          | Amazon  Ad Server vertical name as defined for the advertiser, describes the advertiser related industry e.g. Consumer Packaged Goods.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | LOW                   |\n","| Interaction info                                                 | video_full_screen_duration   | LONG      | Metric             | Duration  of the video in seconds when video played in full screen.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | NONE                  |\n","| Interaction info                                                 | video_full_screen_ended      | LONG      | Metric             | Number  of video played to the end, in full screen.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | NONE                  |\n","| Interaction info                                                 | video_full_screen_muted      | LONG      | Metric             | Number  of mute interactions when video was in full screen. Can be multiple mute  interactions per impression session.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | NONE                  |\n","| Interaction info                                                 | video_full_screen_paused     | LONG      | Metric             | Number  of pause interactions when video was in full screen. Can be multiple pause  interactions per impression session.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | NONE                  |\n","| Interaction info                                                 | video_full_screen_started    | LONG      | Metric             | Number  of video started to play, in full screen                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | NONE                  |\n","| Interaction info                                                 | video_muted                    | LONG      | Metric             | Number  of times user muted the video ad.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| Interaction info                                                 | video_paused                   | LONG      | Metric             | Number  of times video was paused by the user.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| Interaction info                                                 | video_percentage_complete     | LONG      | Metric             | Average  % of the video viewed. e.g. on avg video viewed to 47% of its completion.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | NONE                  |\n","| Interaction info                                                 | video_played_100pc            | LONG      | Metric             | Number  of times when video played to its full completion.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | NONE                  |\n","| Interaction info                                                 | video_played_100pc_viewable  | LONG      | Metric             | Number  of times when video played to its full completion and impression was  viewable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | NONE                  |\n","| Interaction info                                                 | video_played_25pc             | LONG      | Metric             | Number  of times when video played only to 25% of its completion.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| Interaction info                                                 | video_played_25pc_viewable   | LONG      | Metric             | Number  of times when video played only to 25% of its completion and impression was  viewable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| Interaction info                                                 | video_played_50pc             | LONG      | Metric             | Number  of times when video played only to 50% of its completion.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| Interaction info                                                 | video_played_50pc_viewable   | LONG      | Metric             | Number  of times when video played only to 50% of its completion and impression was  viewable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| Interaction info                                                 | video_played_75pc             | LONG      | Metric             | Number  of times when video played only to 75% of its completion.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | NONE                  |\n","| Interaction info                                                 | video_played_75pc_viewable   | LONG      | Metric             | Number  of times when video played only to 75% of its completion and impression was  viewable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | NONE                  |\n","| Interaction info                                                 | video_played_duration         | LONG      | Metric             | Duration  of the video played in seconds.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| Interaction info                                                 | video_played_with_sound      | LONG      | Metric             | Number  of times video played with sound.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| Interaction info                                                 | video_replayed                 | LONG      | Metric             | Number  of times user replayed the video.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | NONE                  |\n","| Interaction info                                                 | video_skipped                  | LONG      | Metric             | Number  of times user clicked skip button on the video ad.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | NONE                  |\n","| Interaction info                                                 | video_started                  | LONG      | Metric             | Number  of times video started to play in user browser/player. There can be multiple  video starts per impression session.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | NONE                  |\n","| Interaction info                                                 | video_unmuted                  | LONG      | Metric             | Number  of times use un-muted the video ad.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | NONE                  |\n","| Impression delivery info                                         | viewable_impressions           | LONG      | Metric             | Number  of viewable impression (IAB standard). Note, viewability signals collected  only for campaigns where verification data collection mode was enabled. This  metric will be 0 if campaign is not enabled for verification data collection.                                                                                                                                                                                                                                                                                                                                                                                                                                        | NONE                  |\n"],"documentType":"guide"},{"title":"Ad Server traffic user segments","sectionHeader":null,"path":"/en-us/guides/amazon-marketing-cloud/datasources/adserver_traffic_user_segments","content":[],"documentType":"guide"},{"title":"Ad Server traffic user segments","sectionHeader":{"type":2,"text":"adserver\\_traffic\\_by\\_user\\_segments"},"path":"/en-us/guides/amazon-marketing-cloud/datasources/adserver_traffic_user_segments","content":[" The data source adserver_traffic_by_user_segments includes Amazon audience segment-level information for impressions and clicks that are measured by the Amazon Ad Server and matched to the Amazon user ID value. This data source has the same structure as adserver_traffic with the addition of Amazon audience segment fields. Each traffic event (impression and click) appears multiple times in this data source. The number of times each event appears in the data source corresponds to the number of segments identified for each user ID value.\n"," The following table shows columns in addition to the ones listed for adserver_traffic.\n","| Field Category | Name | Data Type | Metric / Dimension | Description | Aggregation Threshold |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| Advertiser setup | adserver_brand | STRING | Dimension | Amazon Ad Server brand name. A single Amazon Ad Server advertiser can have multiple brands. One campaign can be associated to a single brand. | LOW |\n","| Advertiser setup | adserver_brand_id | LONG | Dimension | Amazon Ad Server brand ID. A single Amazon Ad Server advertiser can have multiple brands. One campaign can be associated to a single brand. | LOW |\n","| Event (impression, Click, Interaction, Conversion) Delivery Info | adserver_session_id | STRING | Dimension | Amazon Ad Server session ID. | VERY_HIGH |\n","| Site setup | adserver_site | STRING | Dimension | Amazon Ad Server site name. Represents an entity that buys or sells media (can be a publisher or DSP name; this is not a domain name of site where the ad was served). | LOW |\n","| Segments | behavior_segment_description | STRING | Dimension | User behavior segment description. | LOW |\n","| Segments | behavior_segment_id | INTEGER | Dimension | User behavior segment identifier. | LOW |\n","| Segments | behavior_segment_name | STRING | Dimension | User behavior segment name. | LOW |\n"],"documentType":"guide"},{"title":"Developer blog","sectionHeader":null,"path":"/en-us/blog","content":[],"documentType":"guide"},{"title":"Developer blog","sectionHeader":{"type":3,"text":"Introducing ease of use best practices to the Amazon Ads API "},"path":"/en-us/blog","content":[" We recently released product targeting functionality for Sponsored Brands campaigns. With this release, new endpoints have been introduced that implement a set of best practices. These best practices contribute to the ease of use of the Amazon Ads API. \n"," These best practices include: \n","The use of pagination tokens to ensure users do not retrieve data sets that have changed between calls.  2. Separating success and error responses, so there is now an explicit list of errors. This makes it easy to create a new request to retry all error objects.   3. GET operations that were previously filtered with query parameters are now POST operations with request parameters. This enables developers to create more complex filters without running into URL character limits. 4. Replacing PUT and POST archive operations with explicit DELETE operations to avoid risk of accidentally deleting an object. \n"," Developers will see more of these best practices implemented in new API functionality going forward. We are implementing these best practices based on customer feedback, and we are excited to hear developer opinions. You can give us feedback by opening a service desk ticket with the subject line: \"Feedback on best practices\".\n"],"documentType":"guide"},{"title":"Developer blog","sectionHeader":{"type":3,"text":"Introducing Sponsored Display"},"path":"/en-us/blog","content":[" Today, we launched Sponsored Display beta, a new self-service advertising solution that helps advertisers grow their business by reaching relevant audiences both on and off Amazon.   \n"," Why Sponsored Display?\n","Reach the right audiences: Audiences are automatically created based on Amazon shopping activities to help advertisers reach customers beyond those actively shopping on Amazon.  Maximize impact with minimal effort: In just a few clicks, advertisers can promote their entire product catalog with creatives that are auto-generated and optimized for conversion.  Support business objectives: From product awareness to consideration and conversion, Sponsored Display helps measure and meet advertiser goals. The Amazon Ads API now supports Sponsored Display campaigns that reach shoppers off Amazon who visited a product detail page or detail pages of similar products but did not make a purchase. We have designed the Sponsored Display API functionality for easy adoption. Sponsored Display API functionality uses the same security scope as both Sponsored Products and Sponsored Brands, so the same authentication token can be used to access Sponsored Display functionality. There are no additional onboarding steps -- simply call the Sponsored Display API endpoint. We have also designed API functionality for Sponsored Display to be consistent with Sponsored Products and Sponsored Brands, so developers already working with either of these can apply the same practices to Sponsored Display. New users of the Advertising API can learn more about getting started here. As part of this launch, we will also retire legacy functionality that allowed users to update and retrieve Sponsored Display campaign information through Sponsored Products resources. We expect to remove this functionality by Q4 2019. Users that are currently using these resources and want to continue managing or reporting on Sponsored Display campaigns should adopt the newly released functionality. With this launch, advertisers are able to access Product Display Ads audiences and product targeting features within Sponsored Display. All Product Display Ads campaigns are now part of Sponsored Display, with no additional action required. This change will be coming to the API and additional marketplaces later this year. To learn more about API functionality for Sponsored Display, see the reference documentation. To learn more about Sponsored Display, visit the Sponsored Display page.\n"],"documentType":"guide"},{"title":"Developer blog","sectionHeader":{"type":2,"text":"New Sponsored Brands improvements"},"path":"/en-us/blog","content":[" Recently we announced three new improvements to the broad match feature, which helps advertisers reach more shoppers and control advertising costs. In July, we are making these releases available in the API:\n"],"documentType":"guide"},{"title":"Developer blog","sectionHeader":{"type":2,"text":"Introducing Sponsored Brands campaign creation"},"path":"/en-us/blog","content":[" Today we are launching the ability to create Sponsored Brands campaigns via the Amazon Ads API in open beta.   This release introduces version 3 of the API, which includes features that will improve the advertiser and developer  experience. This release will also bring the Amazon Ads API close to parity with the advertising console for  sponsored ads.\n"," We believe this release will make it easier for advertisers to use Sponsored Brands. Advertisers that use the Amazon  Advertising API can now create Sponsored Brands campaigns at scale in the solutions they use to manage their Amazon  business or marketing activities. Advertisers can also make their processes more efficient and create more Sponsored  Brands campaigns faster. Finally, advertisers can achieve better performance by implementing comprehensive creative  testing.\n"," This release will also improve the developer experience. Developers that adopt Sponsored Brands campaign creation  functionality and, through it the new version of the API, will be better positioned to adopt upcoming sponsored ads and  API releases. For sponsored ads releases, in 2019, we are prioritizing releasing new Sponsored Brands functionality  based on customer feedback. For API releases, new API functionality will only be released in the new API version.  Furthermore, the new version of the API will introduce improvements that make it easier for developers to adopt  upcoming releases including meeting OpenAPI specifications. \n"," This functionality is available to all developers that have access to the Amazon Ads API. To learn more visit  the blog post,  or the FAQ section in the developer portal. Also, make sure to see this  section on Sponsored Brands moderation  and campaign life-cycle status.\n"],"documentType":"guide"},{"title":"Developer blog","sectionHeader":{"type":2,"text":"A note about Advertising terminology and name changes"},"path":"/en-us/blog","content":[],"documentType":"guide"},{"title":"Developer blog","sectionHeader":{"type":3,"text":"October, 2018"},"path":"/en-us/blog","content":[" We recently announced that we are now simply, Amazon Ads. With this, we retired the names Amazon Media Group (AMG), Amazon Marketing Services (AMS), and Amazon Ads Platform (AAP), and announced a simplified product portfolio. This change impacts API users because of syntax built into the structure of the API. The documentation for v2 will continue to reference the older product names in the technical reference sections. A key is provided below to assist in transition to the new terminology.\n","| New terminology| Retired terms |\n","\\| --- \\| --- \\|\n","| Amazon Ads |-\tAmazon Marketing Services (AMS)-\tAmazon Media Group (AMG)-\tAmazon Ads Platform (AAP)\t |\n","| Sponsored Brands (SB) | Headline Search Ads (HSA) |\n","|Amazon DSP | Amazon Ads Platform (AAP) |\n"],"documentType":"guide"},{"title":"Developer blog","sectionHeader":{"type":3,"text":"Introducing the Advertising API v2.0!"},"path":"/en-us/blog","content":[" Today we are introducing a new version of the Advertising API with v2.0.\n"," Why did we advance the API version? We did this in order to introduce some new features for Sponsored Brands (SB) (formerly known as Headline Search Ads) and functionality to improve the API performance by reducing rate-limiting (or throttling). Last year we added SB reporting to the API. Today we are adding the ability to manage operations and to retrieve snapshots for existing SB campaigns. At this time you cannot create new campaigns or product ads through the API. New SB campaigns can only be created in the UI. Once created, you can update or archive SB campaigns. You can also now request a snapshot showing every level of your SB campaigns in one report. This is a much more efficient operation than running a command to list campaigns, then listing keywords, and then listing product ads, etc. Snapshots give it to you all in one.\n"," We also mentioned some improvements to reduce throttling. We have observed that many brands split their advertising business across multiple agencies or e-commerce specialists. With the changes introduced in API v2 we can now identify individual operators and place safeguards to prevent their activity from negatively impacting any other customers. The change that makes this possible is the new requirement to include the client_id in the header of all API calls to the v2 endpoints.\n"," What are the most impacting changes? One thing you will notice right away is that your API calls will now return data for both seller and vendor profiles. This will allow you to manage operations or retrieve performance data for both advertiser segments with a single API call.\n"," Using the new API features of v2 means calling the new v2 endpoints. Look closely at the reference documentation for campaigns, keywords, reports, and snapshots to see which operations require use of the new endpoints.\n"," Note: The new endpoints still refer to HSA for Headline Search Ads in certain places. \n"," Stay tuned to the Developer Blog for news about upcoming features and releases. Thanks for using the Amazon Ads API!\n"," Ross Diaz - Technical Content Manager\n"," Amazon Ads API Development\n"],"documentType":"guide"},{"title":"Developer blog","sectionHeader":{"type":3,"text":"Welcome to the Amazon Ads API Developers Portal!"},"path":"/en-us/blog","content":[" When we built this portal, we had one vision in mind: To make using the Advertising API an enjoyable experience for you. We want to save you time, make your operations more efficient, and increase your knowledge and comfort level with the API.\n"," This documentation space was designed with developers in mind and is generated from the feedback we have collected over the last few years from our advertisers who use the API to integrate their applications. Here are some of the most requested features we are now able to provide you with:\n","Web-published HTML documentation. This means no more downloading and\n","Code snippets that are easy to copy to your clip board.\n","Full list of valid character constraints for keywords and campaigns.\n"," We want to add new features to the portal to improve your experience. As we release new features and capabilities for the Advertising API, you will find everything you need to understand and start using those features right here in the Developers Portal. We place a priority on delivering the features and information that you want.\n"," Now it is your turn to speak up and tell us how we are doing! Is something missing? Do you have a great idea for how to make the portal better? Is there a particular feature we introduced that you love? Is there a pain point in working with the API that we have not addressed yet? Let us know!\n"," If your access to the API is already approved, you can give us feedback by opening a service desk ticket with the subject line: \"Developers Portal feedback\" and tell us what improvements you would like to see on the portal to make it more useful to you. We are listening to what you have to say and working to provide you with the information you need to maximize the API for your business.\n"," On behalf of all of us here at the Advertising API development team we want to sincerely thank you for using the API to manage your advertising operations. We are truly excited to be able to deliver to you an improved documentation experience providing the essential information you need for integrating with the Advertising API.\n"," All the best,\n"],"documentType":"guide"}],"toc-reference":[{"title":"Overview","sectionHeader":null,"path":"/en-us/reference/api-overview","content":[" The Amazon Ads API enables Amazon advertisers and partners to programmatically manage advertising operations and retrieve performance data.  Find reference API docs by exploring the API reference navigation menu.\n"," For user guides, recommendations, and tutorials, explore the Developer guides menu or see the developer guides overview.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Typical use cases"},"path":"/en-us/reference/api-overview","content":[" We expect a typical client will perform the following operations regularly:\n","Make batch requests for all campaigns, ad groups, ads and keywords in paginated requests and store/update a local copy of the data. 2. Request recent performance data for all campaigns, ad groups, ads and keywords in reports and use the IDs to associate and store/update performance data with the entities retrieved from a batch request. 3. Analyze performance and make changes to bids and budgets. Optimize performance using the batch update API for campaigns, ad groups, ads and keywords.\n"," These, as well as operations to modify single entities, are supported use cases for the API.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"API endpoints"},"path":"/en-us/reference/api-overview","content":[" The API is accessible through the following regional hosts:\n","| URL | Region | Marketplaces |\n","\\| --- \\| --- \\| --- \\|\n","| https&#x3A;//advertising-api.amazon.com | North America (NA) | United States (US), Canada (CA), Mexico (MX), Brazil (BR) |\n","| https&#x3A;//advertising-api-eu.amazon.com | Europe (EU) | United Kingdom (UK), France (FR), Italy (IT), Spain (ES), Germany (DE), Netherlands (NL), United Arab Emirates (AE), Poland (PL), Turkey (TR), Egypt (EG), Saudi Arabia (SA), Sweden (SE), Belgium (BE), India (IN), South Africa (ZA) |\n","| https&#x3A;//advertising-api-fe.amazon.com | Far East (FE) | Japan (JP), Australia (AU), Singapore (SG) |\n"],"documentType":"guide"},{"title":"Amazon Ads API Concepts Overview","sectionHeader":null,"path":"/en-us/reference/concepts/overview","content":[" This section describes key concepts customers will encounter in using the Amazon Ads API.\n"],"documentType":"guide"},{"title":"Amazon Ads API Concepts Overview","sectionHeader":{"type":2,"text":"Authorization"},"path":"/en-us/reference/concepts/overview","content":[" To use the Amazon Ads API, an application must be delegated access to act on behalf of an advertiser through an OAuth 2.0 flow. Tokens retrieved through this process are used for all operations in the API. \n"," For most operations, API callers also pass a profile identifier representing an advertiser's account in a particular marketplace.\n","See the Authorization Overview for more information about authorization, permissions, and profiles.\n"],"documentType":"guide"},{"title":"Amazon Ads API Concepts Overview","sectionHeader":{"type":2,"text":"Reporting and exports"},"path":"/en-us/reference/concepts/overview","content":[" Use the Ads API reporting functionality to retrieve campaign performance data. To pull current campaign metadata and structure, use exports. \n"," Learn more about:\n","Reporting - Exports\n"],"documentType":"guide"},{"title":"Amazon Ads API Concepts Overview","sectionHeader":{"type":2,"text":"Compatibility and versioning"},"path":"/en-us/reference/concepts/overview","content":[" REST resources in the Amazon Ads API are independently versioned using a major.minor format -- for example, \"3.0\". Resources in an Amazon Ads API service are guaranteed to be backward compatible within a major version. \n"," At present, many resources have only one version.\n","See Compatibility and Versioning for information about specifying versions, compatibility, and deprecation policies.\n"],"documentType":"guide"},{"title":"Amazon Ads API Concepts Overview","sectionHeader":{"type":2,"text":"Rate limiting"},"path":"/en-us/reference/concepts/overview","content":[" Rate limiting in the Amazon Ads API is determined dynamically based on overall system load.\n","See Rate Limiting for information on how to avoid rate limiting and best practices for handling 429 responses.\n"],"documentType":"guide"},{"title":"Amazon Ads API Concepts Overview","sectionHeader":{"type":2,"text":"Reference tables"},"path":"/en-us/reference/concepts/overview","content":[" See the following documents for tables describing limits, constraints, error responses, and status messages.\n","Limits, constraints, and quotas - Errors - Computed status\n"],"documentType":"guide"},{"title":"Amazon Ads API Concepts Overview","sectionHeader":{"type":2,"text":"Developer notes"},"path":"/en-us/reference/concepts/overview","content":[],"documentType":"guide"},{"title":"Error responses and error status codes","sectionHeader":null,"path":"/en-us/reference/concepts/errors","content":[],"documentType":"guide"},{"title":"Error responses and error status codes","sectionHeader":{"type":2,"text":"Error response"},"path":"/en-us/reference/concepts/errors","content":[" This is the universal format for error response objects.\n"],"documentType":"guide"},{"title":"Error responses and error status codes","sectionHeader":{"type":2,"text":"Status codes"},"path":"/en-us/reference/concepts/errors","content":[" The following codes may be returned by the service and should be handled by the client:\n","| Status Code | Notes |\n","\\| --- \\| --- \\|\n","| 200 - OK | Standard respond for successful non-batch requests. |\n","| 202 - Accepted | The request has been accepted and is processing. Used mostly for asynchronous requests. |\n","| 207 - Multi-status | Standard response for batch requests. The request returns the response code related to each sub-request. 207 can contain both success and error responses. |\n","| 307 - Temporary Redirect | Usually seen in requests to download a file. |\n","| 400 - Bad Request | General request error that does not fall into any other category. |\n","| 401 - Unauthorized | Request failed because user is not authenticated. |\n","| 401 - No matching advertiser found for scope | Could not find an advertiser that matches the provided scope. |\n","| 401 - Scope header is missing | Amazon-Advertising-API-Scope header is not present. |\n","| 401 - Not authorized to access scope | Not authorized to manage this profile. Please check permissions and consent from the advertiser. |\n","| 403 - Forbidden | Request failed because user does not have access to a specified resource. |\n","| 404 - Not Found | Requested resource does not exist or is not visible for the authenticated user. |\n","| 406 - Not Acceptable | The Accept header for your request is not supported. |\n","| 415 - Unsupported Media Type | The Accept or Content-Type header for your request is not supported. | \n","| 422 - Unprocessable Entity | Request was understood, but contained incorrect parameters. |\n","| 429 - Too Many Requests | Request was rate-limited. Retry later. |\n","| 500 - Internal Error | Something went wrong on the server. Retry later and report an error if unresolved. |\n","| 502 - Internal Error| Something went wrong on the server. Retry later and report an error if unresolved. |\n","| 504 - Internal Error | Something went wrong on the server. Retry later and report an error if unresolved. |\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":null,"path":"/en-us/reference/concepts/limits","content":[" This document includes tables describing limits, constraints, and quotas in the Amazon Ads API, including:\n","Service limits - Bid constraints by marketplace - Budget constraints by marketplace - Valid characters\n"," For more information on rate limiting (\"throttling\"), please see Rate Limiting.\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":2,"text":"Service limits"},"path":"/en-us/reference/concepts/limits","content":["| Operation | P99 Guarantee |\n","\\| --- \\| --- \\|\n","| Synchronous CRUD operations | 30s |\n","| Impression/click event to availability via API| 12h |\n","| Impression/click invalidation | 72h |\n","| Async report generation time | 15m |\n","| Async snapshot generation time | 15m |\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":2,"text":"Bid constraints by marketplace"},"path":"/en-us/reference/concepts/limits","content":[" This table details the maximum allowable bid (in local currency) for keywords or targets by marketplace for Sponsored Products (SP), Sponsored Brands (SB), Sponsored Brands Video (SBV), and Sponsored Display (SD). This also includes differences between vCPM and CPC for different goal types like Grow Brand Impression Share (BIS) and Acquire New Customers (NTB).\n","| Marketplace | Currency | Min / Max bid for SP | Min / Max bid for SD (CPC) | Min / Max bid for SD (vCPM) | Min / Max bid for SB (CPC) Image | Min / Max for SBV (CPC) Video | Min / Max bid for SB (vCPM) Image - BIS |  Min / Max bid for SBV (vCPM) Video - BIS  | Max bid for SB (vCPM) Image - NTB |  Min / Max bid for SBV (vCPM) Video - NTB  |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| MX | MXN | 0.1/20000 | 0.1/20000 | 5/20000 |0.10/20000 | 0.15/20000 | 128/800000 |  80/800000 | 8/800000 |  24/800000 | \n","| UK | GBP | 0.02/1000 | 0.02/1000 | 1/1000 |0.10/31 | 0.15/31 | 4/5000 | 8/5000 | 1/5000 |  2/5000 | \n","| DE | EUR | 0.02/1000 | 0.02/1000 | 1/1000 | 0.10/39 | 0.15/39 | 5/5000 | 7/5000 | 1/5000 |  3/5000 | \n","| CA | CAD | 0.02/1000 | 0.02/1000 | 1/1000 | 0.10/49 | 0.15/49 | 11/5000 | 11/5000 | 1/5000 |  2/5000 | \n","| AU | AUD | 0.02/1410 | 0.2/1000 | 1/1000 |0.10/70 | 0.15/70 | 14/2800 | 20/2800 | 3/2800 |  3/2800 | \n","| US | USD | 0.02/1000 | 0.02/1000 | 1/1000 |0.10/49 | 0.25/49 | 8/5000 | 12/5000 | 1/5000 |  4/5000 | \n","| FR | EUR | 0.02/1000 | 0.02/1000 | 1/1000 |0.10/39 | 0.15/39 | 4/5000 | 8/5000 | 1/5000 |  2/5000 | \n","| ES | EUR | 0.02/1000 | 0.02/1000 | 1/1000 | 0.10/39 | 0.15/39 | 4/5000 | 7/5000 | 2/5000 |  2/5000 | \n","| IT | EUR | 0.02/1000 | 0.02/1000 | 1/1000 |0.10/39 | 0.15/39 | 4/5000 | 6/5000 | 1/5000 |  2/5000 | \n","| NL | EUR | 0.02/1000 | 0.02/1000 | 1/1000 |0.10/39 | 0.15/39 | 6/1560 | 8/1560 | 1/1560 |  2/1560 | \n","| JP | JPY | 2/100000 | 2/100000 | 100/100000 |10.0/7760 |  15.0/7760 | 560/310400 | 800/310400 | 100/310400 |  356/310400 | \n","| AE | AED | 0.24/184 | 0.2/3670 | 1/3670|0.40/184 | 0.6/184 | 44/7360 | 28/7360 | 4/7360 |  8/7360 | \n","| BR | BRL | 0.07/3700 | 0.07/3700 | 2/3700 |0.53/200 | 0.8/25000 | 37/8000 | 53/8000 | 6/8000 |  10/8000 | \n","| SG | SGD | 0.02/1100 | .14/1410 | 4/1410 |0.14/100 | 0.2/1400 | 6/4000 | 29/4000 | 4/4000 |  8/4000 | \n","| SE | SEK | 0.18/9300 | 0.18/1000 | 1/1000 |0.90/500| 1.30/500 | 36/20000 | 276/20000 | 2/200000 |  2/200000 | \n","| IN | INR | 1/5000 | 1/5000 | 4/5000 | 1/500 | 1.5/500 | 84/80000 |  200/80000 | 28/800000 |  111/800000 | \n","| PL | PLN | 0.04/2000 | 0.02/1000 | 1/1000 | 0.2/200 | 0.3/200 | 92/8000  | 180/8000 | 1/80000 |  2/80000 | \n","| TR | TRY | 0.05/2500 | 0.05/2500 | 1.85/2500 |0.2/200 | 0.3/200 | 74/8000 | 0.3/200 | 106/8000 | 2/80000 | \n","| EG | EGP | 0.15/5.50 | 0.15/7400 | 5/7400 |0.7/400 | 1/400 | 160/16000 | 300/16000 | 5/160000 |  10/160000 | \n","| SA | SAR | 0.10/3670 | 0.10/3670 | 4/3670 |0.40/184| 0.60/184 | 28/7360 | 40/7360 | 5/7360|  12/7360 | \n","| BE | EUR | 0.02/1000 | 0.02/1000 | 1/1000 |0.10/39 | 0.15/39 | 4/1560 | 6/1560 | 1/1560 |  2/1560 | \n","| ZA | ZAR | 1/7000 |  0.7/1000 | 1.5/1000 | 0.7/350 | 1.1/350 | 0.7/350 | 1.1/350 | 0.7/350 | 1.1/350 |\n","| IE | EUR | 0.02/1000 | NA | NA | 0.10/39| 0.15/39 | 4/1560 | 6/1560 | 1/1560 |  2/1560 | \n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":3,"text":"Amazon DSP"},"path":"/en-us/reference/concepts/limits","content":["|Marketplace\t|Currency\t|Min/Max baseBid - DISPLAY (when maxAverageCPM is null)\t|Min/Max maxAverageCPM - DISPLAY\t|Min/Max baseBid - VIDEO (when maxAverageCPM is null)\t|Min/Max maxAverageCPM - VIDEO\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|US\t|USD\t|0.01/39.99\t|0.01/79.99\t|0.01/116.99\t|0.01/233.99\t|\n"," Notes:\n","When maxAverageCPM is not null, then the max baseBid is the same as the max maxAverageCPM.  The API min/max bids for other currencies can be calculated by converting the USD amounts below to other currencies. Due to variable FX rates, this number may change over time. Amazon DSP uses OANDA for currency conversion.  The min/max amounts in the UI for non-US countries differ from those in the API (typically, the API max is lower than the UI max).\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":2,"text":"Budget constraints by marketplace"},"path":"/en-us/reference/concepts/limits","content":[],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/reference/concepts/limits","content":["|Marketplace\t|Entity type\t|Min daily\t|Max daily\t|\n","|---\t|---\t|---\t|---\t|\n","|US\t|Seller, vendor\t|1\t|1000000\t|\n","|CA\t|Seller, vendor\t|1\t|1000000\t|\n","|UK\t|Seller, vendor\t|1\t|1000000\t|\n","|DE\t|Seller, vendor\t|1\t|1000000\t|\n","|FR\t|Seller, vendor\t|1\t|1000000\t|\n","|IT\t|Seller, vendor\t|1\t|1000000\t|\n","|ES\t|Seller, vendor\t|1\t|1000000\t|\n","|IN\t|Seller, vendor\t|50\t|21000000\t|\n","|JP\t|Seller, vendor\t|100\t|21000000\t|\n","|CN\t|Seller, vendor\t|1\t|21000000\t|\n","|AU\t|Seller, vendor\t|1.4\t|1500000\t|\n","|MX\t|Seller, vendor\t|1\t|21000000\t|\n","|UAE\t|Seller, vendor\t|4\t|3700000\t|\n","|SA\t|Seller, vendor\t|4\t|3700000\t|\n","|BR\t|Seller, vendor\t|1.32\t|5300000\t|\n","|NL\t|Seller, vendor\t|1\t|1000000\t|\n","|SG\t|Seller, vendor\t|1.39\t|1300000\t|\n","|TR\t|Seller, vendor\t|2\t|2500000\t|\n","|PL\t|Seller, vendor\t|2\t|2000000\t|\n","|SE | Seller, vendor | 9 | 9300000 |\n","|EG | Seller, vendor | 7 | 7400000|\n","|BE\t|Seller, vendor\t|1\t|1000000\t|\n","|ZA | Seller, vendor | 20 | 7000000 | \n","|IE\t|Seller, vendor\t|1\t|1000000\t|\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/reference/concepts/limits","content":["|Marketplace\t|Entity Type\t|Min daily\t|Max daily\t|Min lifetime\t|Max lifetime\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|US\t|Seller, vendor\t|1\t|1000000\t|100\t|20000000\t|\n","|CA\t|Seller, vendor\t|1\t|1000000\t|100\t|20000000\t|\n","|UK\t|Seller, vendor\t|1\t|1000000\t|100\t|20000000\t|\n","|DE\t|Seller, vendor\t|1\t|1000000\t|100\t|20000000\t|\n","|FR\t|Seller, vendor\t|1\t|1000000\t|100\t|20000000\t|\n","|IT\t|Seller, vendor\t|1\t|1000000\t|100\t|20000000\t|\n","|ES\t|Seller, vendor\t|1\t|1000000\t|100\t|20000000\t|\n","|IN\t|Seller\t|100\t|21000000\t|5000\t|200000000\t|\n","|IN\t|Vendor\t|500\t|21000000\t|5000\t|200000000\t|\n","|JP\t|Seller, vendor\t|100\t|21000000\t|10000\t|21000000\t|\n","|CN\t|Seller, vendor\t|1\t|21000000\t|100\t|200000000\t|\n","|AU\t|Seller, vendor\t|1.4\t|1500000\t|141\t|28000000\t|\n","|MX\t|Seller, vendor\t|1\t|21000000\t|1000\t|200000000\t|\n","|UAE\t|Seller, vendor\t|4\t|3700000\t|367\t|74000000\t|\n","|SA\t|Seller, vendor\t|4\t|3700000\t|367\t|74000000\t|\n","|BR\t|Seller, vendor\t|4\t|3700000\t|367\t|74000000\t|\n","|NL\t|Seller, vendor\t|4\t|3700000\t|367\t|74000000\t|\n","|SG\t|Seller, vendor\t|4\t|3700000\t|367\t|74000000\t|\n","|TR\t|Seller, vendor\t|2\t|2700000\t|250\t|53000000\t|\n","|PL\t|Seller, vendor\t|2\t|2400000\t|200\t|47000000\t|\n","|SE | Seller, vendor | 9 | 9400000 | 900 | 187000000 |\n","|EG | Seller, vendor | 7 | 7600000 | 750 | 151000000| \n","|BE\t|Seller, vendor\t|1\t|1000000\t|100\t|20000000\t|\n","|ZA | Seller, vendor | 6 | 7000000| 650 | 140000000 |\n","|IE | Seller, vendor  | 1 | 1000000 | 100 | 2000000 |\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":3,"text":"Sponsored Display"},"path":"/en-us/reference/concepts/limits","content":["|Marketplace\t|Entity Type\t|Min daily\t|Max daily\t|\n","|---\t|---\t|---\t|---\t|\n","|US\t|Seller\t|1\t|1000000\t|\n","|US\t|Vendor\t|1\t|50000\t|\n","|CA\t|Seller\t|1\t|1000000\t|\n","|CA\t|Vendor\t|1\t|50000\t|\n","|UK\t|Seller\t|1\t|1000000\t|\n","|UK\t|Vendor\t|1\t|50000\t|\n","|DE\t|Seller\t|1\t|1000000\t|\n","|DE\t|Vendor\t|1\t|50000\t|\n","|FR\t|Seller\t|1\t|1000000\t|\n","|FR\t|Vendor\t|1\t|50000\t|\n","|IT\t|Seller\t|1\t|1000000\t|\n","|IT\t|Vendor\t|1\t|50000\t|\n","|ES\t|Seller\t|1\t|1000000\t|\n","|ES\t|Vendor\t|1\t|50000\t|\n","|IN\t|Seller\t|50\t|21000000\t|\n","|IN\t|Vendor\t|50\t|5000000\t|\n","|JP\t|Seller\t|100\t|21000000\t|\n","|JP\t|Vendor\t|100\t|5000000\t|\n","|AU\t|Seller, vendor\t|1.4\t|1500000\t|\n","|MX\t|Seller, vendor\t|1\t|21000000\t|\n","|UAE\t|Seller, vendor\t|4\t|3700000\t|\n","|BR\t|Seller, vendor\t|1.32\t|5300000\t|\n","|NL\t|Seller, vendor\t|1\t|1000000\t|\n","|SG\t|Seller, vendor\t|4\t|1300000\t|\n","|SE |Seller, vendor |1| 1000000|\n","|EG |Seller, vendor | 7 | 7600000|\n","|PL |Seller, vendor | 1 | 1000000 |\n","|SA | Seller, vendor | 4 | 3700000 |\n","|TR | Seller, vendor | 2 | 2700000 |\n","|BE | Seller, vendor | 1 | 1000000 |\n","|ZA | Seller, vendor | 6 | 7000000| \n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":2,"text":"Metric minimum threshold values"},"path":"/en-us/reference/concepts/limits","content":[],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":3,"text":"Sponsored Display"},"path":"/en-us/reference/concepts/limits","content":[" When creating Sponsored Display rules, metric threshold is a required field. The threshold values have defined minimums depending on the metric names per marketplace in the following table.\n","| Marketplace    |Metric name     |  Minimum threshold |\n","\\|---    \\|---     \\|--- \\|\n","|US|COST PER CLICK|0.5|\n","|US|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|US|COST PER ORDER|5|\n","|CA|COST PER CLICK|0.1|\n","|CA|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|CA|COST PER ORDER|3|\n","|MX|COST PER CLICK|0.1|\n","|MX|COST PER THOUSAND VIEWABLE IMPRESSIONS|5|\n","|MX|COST PER ORDER|2|\n","|BR|COST PER CLICK|0.07|\n","|BR|COST PER THOUSAND VIEWABLE IMPRESSIONS|7|\n","|BR|COST PER ORDER|4|\n","|UK|COST PER CLICK|0.02|\n","|UK|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|UK|COST PER ORDER|2|\n","|DE|COST PER CLICK|0.02|\n","|DE|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|DE|COST PER ORDER|1|\n","|FR|COST PER CLICK|0.05|\n","|FR|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|FR|COST PER ORDER|3|\n","|IT|COST PER CLICK|0.05|\n","|IT|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|IT|COST PER ORDER|3|\n","|ES|COST PER CLICK|0.05|\n","|ES|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|ES|COST PER ORDER|3|\n","|IN|COST PER CLICK|2|\n","|IN|COST PER THOUSAND VIEWABLE IMPRESSIONS|15|\n","|IN|COST PER ORDER|50|\n","|AE|COST PER CLICK|0.2|\n","|AE|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|AE|COST PER ORDER|10|\n","|NL|COST PER CLICK|0.3|\n","|NL|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|NL|COST PER ORDER|1|\n","|SE|COST PER CLICK|0.2|\n","|SE|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|SE|COST PER ORDER|2|\n","|PL|COST PER CLICK|0.2|\n","|PL|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|PL|COST PER ORDER|1.5|\n","|EG|COST PER CLICK|0.2|\n","|EG|COST PER THOUSAND VIEWABLE IMPRESSIONS|5|\n","|EG|COST PER ORDER|6|\n","|TR|COST PER CLICK|0.2|\n","|TR|COST PER THOUSAND VIEWABLE IMPRESSIONS|2|\n","|TR|COST PER ORDER|0.4|\n","|SA|COST PER CLICK|0.2|\n","|SA|COST PER THOUSAND VIEWABLE IMPRESSIONS|4|\n","|SA|COST PER ORDER|5|\n","|BE|COST PER CLICK|0.02|\n","|BE|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|BE|COST PER ORDER|0.3|\n","|JP|COST PER CLICK|8|\n","|JP|COST PER THOUSAND VIEWABLE IMPRESSIONS|100|\n","|JP|COST PER ORDER|100|\n","|AU|COST PER CLICK|0.15|\n","|AU|COST PER THOUSAND VIEWABLE IMPRESSIONS|1|\n","|AU|COST PER ORDER|5|\n","|SG|COST PER CLICK|0.2|\n","|SG|COST PER THOUSAND VIEWABLE IMPRESSIONS|4|\n","|SG|COST PER ORDER|1|\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":2,"text":"Default budgets"},"path":"/en-us/reference/concepts/limits","content":[],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":3,"text":"Sponsored Display"},"path":"/en-us/reference/concepts/limits","content":[" When creating Sponsored Display campaigns, budget is not a required field. If you do not input a budget, your campaign will take the default budget for your region.\n","|Country code\t|Default budget in local currency\t|\n","|---\t|---\t|\n","|AU\t|100\t|\n","|BR\t|150\t|\n","|CA\t|100\t|\n","|DE\t|100\t|\n","|EG\t|500\t|\n","|ES\t|100\t|\n","|FR\t|100\t|\n","|IN\t|1000\t|\n","|IT\t|100\t|\n","|JP\t|10000\t|\n","|SA\t|400\t|\n","|MX\t|150\t|\n","|NL\t|100\t|\n","|PL\t|100\t|\n","|SE\t|100\t|\n","|SG\t|300\t|\n","|TR\t|300\t|\n","|BE\t|100\t|\n","|UK\t|100\t|\n","|AE\t|400\t|\n","|US\t|100\t|\n","|ZA | 100|\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":2,"text":"Keyword character constraints"},"path":"/en-us/reference/concepts/limits","content":[" The constraints in this section apply to keywords or targets for Sponsored Products (SP), Sponsored Brands (SB), and Sponsored Display (SD).\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":3,"text":"General rules (all marketplaces)"},"path":"/en-us/reference/concepts/limits","content":["You can use a blank space in a keyword, but leading or trailing spaces are not allowed. - When using the period (.) character, it can only be used in the middle of keywords or in the middle of blank spaces. - When using the hyphen (-) or the plus (+) characters, they can only be used in the middle of keywords and cannot have blank spaces around them. This applies only to keywords; campaign names do not have this restriction. - The double-quote (\") character must be used in pairs (for example, leather \"rocker\" jacket). Phrases with a single use of the character (for example, 40\" screen) are not supported. - The maximum length of characters in a keyword is 80. - The maximum number of parts for a positive keyword is 10. - The maximum number of parts for a negative keyword is 4. - For negativeExact match type, the negative keyword can have up to 10 parts. - The reserved phrase Automatically Selected Keywords is not accepted as a keyword.\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":3,"text":"Supported scripts by marketplace"},"path":"/en-us/reference/concepts/limits","content":[" The following scripts are accepted in all marketplaces:\n","Basic Latin (a-z, A-Z) - Selected ranges from Latin-1 Supplement: \\\\u00AE, \\\\u00C0-\\\\u00C9, \\\\u00CA-\\\\u00CF, \\\\u00D1-\\\\u00D6, \\\\u00D9-\\\\u00DC, \\\\u00DF, \\\\u00E0-\\\\u00E9, \\\\u00EA-\\\\u00EF, \\\\u00F1-\\\\u00F6, \\\\u00F9-\\\\u00FC, \\\\u00FF - Selected ranges from Latin Extended-A: \\\\u0104-\\\\u0107, \\\\u0118-\\\\u0119, \\\\u0130-\\\\u0131, \\\\u0141-\\\\u0144, \\\\u015A-\\\\u015F, \\\\u0179-\\\\u017E, plus \\\\u0152-\\\\u0153 and \\\\u0178 - Hiragana (\\\\u3000-\\\\u309F) - Katakana (\\\\u30A0-\\\\u30FF) - Kanji (\\\\u4E00-\\\\u9FFF) - Halfwidth and Fullwidth Forms (\\\\uFF00-\\\\uFFEF)\n"," The following scripts are accepted only in marketplaces other than AE, SA, and EG:\n","Devanagari (\\\\u0900-\\\\u097F) - Tamil (\\\\u0B80-\\\\u0BFF)\n"," The following Arabic-script ranges are accepted only in the AE, SA, and EG marketplaces:\n","Arabic: \\\\u0600-\\\\u061C, \\\\u061E-\\\\u06FF - Arabic Supplement: \\\\u0750-\\\\u077F - Arabic Extended-A: \\\\u08A0-\\\\u08B4, \\\\u08B6-\\\\u08C7, \\\\u08D3-\\\\u08FF - Arabic Presentation Forms-A: \\\\uFB50-\\\\uFBC1, \\\\uFBD3-\\\\uFD3D, \\\\uFD50-\\\\uFD8F, \\\\uFD92-\\\\uFDC7, \\\\uFDF0-\\\\uFDFD - Arabic Presentation Forms-B: \\\\uFE70-\\\\uFE74, \\\\uFE76-\\\\uFEFC\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":3,"text":"Valid keyword symbols"},"path":"/en-us/reference/concepts/limits","content":[" The following non-alphanumeric characters are accepted in all marketplaces:\n","\\|\\|\\|\\|\\|\\|\\|\\|\\|\n","\\|--- \\|--- \\|--- \\|--- \\|--- \\|--- \\|--- \\|--- \\|\n","| - | & | + |  |  | \\\\t | \\\\n | \\\\r |\n","| ' | \" |  |  |  |  |  |  |\n"," The % symbol is accepted only in the AE, SA, and EG marketplaces.\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":2,"text":"Entity name character constraints"},"path":"/en-us/reference/concepts/limits","content":["You can use a blank space in an entity name, but leading or trailing space are not allowed. - The maximum length of a campaign name is 128 characters for sellers and 116 characters for vendors. - The maximum length of an ad group is 255 characters. - Basic Latin characters, a-z and A-Z, are supported as well as the following Unicode scopes: \n"," Valid symbols for campaign names and ad group names are listed in the table below. In addition to these symbols, the pipe character (|) may be used.\n"],"documentType":"guide"},{"title":"Limits, constraints, and quotas","sectionHeader":{"type":3,"text":"Valid entity name characters"},"path":"/en-us/reference/concepts/limits","content":["\\|  \\|   \\|   \\|   \\|   \\|   \\|   \\|   \\|\n","\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|---\\|\n","| - | $ | \" | ' | & | ( | ) | \\* |\n","| + | , | . | / | : | ; | = | ? |\n","| @ | \\\\ | \\\\\\\\  |  |  | \\_ | \\` | ~ |\n","| { | } |   |   |   |   |   |   |\n"],"documentType":"guide"},{"title":"Rate limiting","sectionHeader":null,"path":"/en-us/reference/concepts/rate-limiting","content":[" Rate limiting, sometimes referred to as throttling, occurs when the Amazon Ads API receives too many requests within a given time period. \n"," When this happens, you will receive a response with the code 429. Contained within that response is a Retry-After header. The Retry-After value is the number of seconds that you should wait before submitting another API call. Rate limiting will occur dynamically based on the overall system load.\n"],"documentType":"guide"},{"title":"Rate limiting","sectionHeader":{"type":2,"text":"Avoiding rate limits for reports"},"path":"/en-us/reference/concepts/rate-limiting","content":[" Rate limits associated with the Sponsored Ads reporting API, Sponsored Display reports API, and the Sponsored Brands reports API depend on the size of the report generation queue. These limits are determined on a per-region basis with multiple limit tiers that correspond to the current reporting queue size in a given region. Higher utilization periods with higher report queue sizes result in lower rate limits. Lower utilization periods result in higher rate limits with a higher number of accepted report generation requests.\n"," Depending on the region, there may be different time periods of higher utilization each day. If you encounter lower rate limits and a higher occurrence of 429 HTTP response codes, we recommend that you distribute report generation requests throughout each day. For example, perform reporting backfills or request older data periods in smaller increments throughout the day and, in general, refrain from sending large batches of report generation requests. \n"," We also recommend use of exponential backoff in response to a high occurrence of 429 HTTP response codes. \n"],"documentType":"guide"},{"title":"Rate limiting","sectionHeader":{"type":2,"text":"Avoiding rate limits for all other API calls"},"path":"/en-us/reference/concepts/rate-limiting","content":[" Rate limits in the Amazon Ads API are dynamic and based on system load. If you experience frequent rate limits, you can decrease this by following these best practices:\n"],"documentType":"guide"},{"title":"Rate limiting","sectionHeader":{"type":3,"text":"Use retry logic with exponential backoff"},"path":"/en-us/reference/concepts/rate-limiting","content":[" If a call to the Amazon Ads API fails, the error falls into one of three classes:\n","Server error: The HTTP response is a 500-level code that indicates a problem with API services. 2. Throttling error: The HTTP response is 429, an administratively enforced restriction limiting the allowed frequency of API calls. 3. Client error: The HTTP response is a 400-level code other than 429, indicating an issue with the request. Investigate the error in your request before retrying.\n"," In general, you should retry requests that receive server or throttling errors. When retrying your requests, use an exponential backoff algorithm. The idea behind exponential backoff is to use progressively longer waits between retries for consecutive error responses. For example, when a 429 or 5xx error is received, your application could backoff for 2 seconds and try again. If error is received, backoff for 4 seconds and try again. If error is still being received, backoff 8 seconds and try again, etc. You should implement a maximum delay interval, as well as a maximum number of retries for the retry logic.\n"," For more details on this type of strategy, see error retries and exponential backoff in the AWS reference guide.\n"],"documentType":"guide"},{"title":"Rate limiting","sectionHeader":{"type":3,"text":"Do not call list extended data operations when extended properties are not necessary"},"path":"/en-us/reference/concepts/rate-limiting","content":[" These calls hold 5x the weight of standard calls towards throttling limits, and are quite expensive to process. The only difference between a list on extended data operations and standard list operations is that extended call provides the status of the entities. Avoid calling extended data operations unless you specifically need to know the status of the entities.\n"],"documentType":"guide"},{"title":"Rate limiting","sectionHeader":{"type":3,"text":"Do not call list operations on all entities"},"path":"/en-us/reference/concepts/rate-limiting","content":[" To list all entities at a given level requires a significant number of API calls, and this operation does not scale well. A better alternative to making thousands of list operations is to request an export and parse the results.\n"," To understand the exports specifications, see Exports.\n"],"documentType":"guide"},{"title":"Rate limiting","sectionHeader":{"type":3,"text":"Avoid making reporting requests during high usage times."},"path":"/en-us/reference/concepts/rate-limiting","content":[],"documentType":"guide"},{"title":"Compatibility and versioning policy","sectionHeader":null,"path":"/en-us/reference/concepts/compatibility-versioning-policy","content":[],"documentType":"guide"},{"title":"Compatibility and versioning policy","sectionHeader":{"type":2,"text":"Versioning"},"path":"/en-us/reference/concepts/compatibility-versioning-policy","content":[" Resources in the Amazon Ads API are independently versioned, which enables customers to adopt new features on their desired timeframe and enables Amazon developers to evolve APIs independently. Version information for a given resource can be found in the technical specifications for that resource.\n"],"documentType":"guide"},{"title":"Compatibility and versioning policy","sectionHeader":{"type":3,"text":"Specifying versions"},"path":"/en-us/reference/concepts/compatibility-versioning-policy","content":[" Some resources in the API use content negotiation via the Accept and Content-Type headers to determine the resource version that will be returned. For other resources, the request URL determines the resource version, for instance by including /v2 in the path.\n"," See the API specification for a given resource to determine the appropriate method for specifying a version.\n"],"documentType":"guide"},{"title":"Compatibility and versioning policy","sectionHeader":{"type":2,"text":"Compatibility"},"path":"/en-us/reference/concepts/compatibility-versioning-policy","content":[" Changes to resources in the Amazon Ads API are backwards compatible within a version.\n"," Any breaking change introduced to a resource will be accompanied by a corresponding increment in the version and will be announced via a release note. Non-breaking changes may be introduced within versions.\n"],"documentType":"guide"},{"title":"Compatibility and versioning policy","sectionHeader":{"type":3,"text":"Exceptions to backwards compatibility"},"path":"/en-us/reference/concepts/compatibility-versioning-policy","content":[" The Amazon Ads API may not return a stable resource representation in the following circumstances:\n","A legal issue arises that requires breaking a stable resource representation.  A critical bug is discovered that can be corrected only by breaking a stable resource representation.  A critical security flaw is discovered that can only be mitigated by breaking a stable resource representation.\n"," In the case where a stable resource representation is not returned, the Amazon Ads API will communicate the change and work with clients to migrate to the new version of the resource representation.\n"],"documentType":"guide"},{"title":"Compatibility and versioning policy","sectionHeader":{"type":3,"text":"Enum fields"},"path":"/en-us/reference/concepts/compatibility-versioning-policy","content":[" When a field with enumerated values (an enum field or enum) is introduced, the same representation will be used in all use cases of that enum model and will be consistent for requests and responses on the same API endpoint. Any enums used only in responses are documented using the OpenAPI \"read-only\" annotation or with explanatory text in the documentation.\n"," Any enum fields added to an existing resource absent a version change will be optional, with a default value that maps to the previous API behavior.\n"," Within a version, an API resource will not:\n","Rename or remove an enum field.  Change the type of an enum field.  Make an enum field required when it was previously optional. \\* Change the default behavior of an enum field.\n"," The addition of a new enum value to an existing enum field in a request or response is generally not a breaking change and will not require a version increment.\n"," However, the following changes to enum values are considered breaking and will not be made without a version increment. Within a version, an API resource will not:\n","Remove an existing enum value.  Change an existing enum value, including any change to the behavior of an existing enum value.  Rename an enum value.  Replace (split) an enum value with more granular enum values. For example, a \"state\" enum value may not be split into more granular states.  Add a new enum value that changes the meaning or behavior of existing enum values.\n"],"documentType":"guide"},{"title":"Compatibility and versioning policy","sectionHeader":{"type":2,"text":"Deprecations & shutoffs"},"path":"/en-us/reference/concepts/compatibility-versioning-policy","content":[" The Amazon Ads API supports deprecation of unused, lightly used, or old versions of existing operations. \n"," Before any version of a resource representation is shut off, clients will be given at least six months notice. Once a shutoff date is announced, the associated resources are considered deprecated. During the deprecation period, no new features will be added to the existing endpoint and support may be limited. \n"],"documentType":"guide"},{"title":"Computed status and campaign status","sectionHeader":null,"path":"/en-us/reference/concepts/computed-status","content":["| Global | Meaning |\n","\\|------\\|------\\|\n","| STATUS_UNAVAILABLE | Eligibility status is null or the corresponding status reason cannot be found. |\n","| ADVERTISER_STATUS_ENABLED | Advertiser status is ENABLED. |\n","| ADVERTISER_PAUSED | Advertiser status is PAUSED |\n","| ACCOUNT_OUT_OF_BUDGET | Total ad-spend for the day across all of your campaigns has reached your Account Daily Budget Cap threshold. Your account level budget governs how much you spend per day across all of your campaigns. |\n","| ADVERTISER_PAYMENT_FAILURE | Advertiser payment was unsuccessful. |\n","| Campaign status | Meaning |\n","\\| --- \\| --- \\|\n","| CAMPAIGN_STATUS_ENABLED | Campaign status is ENABLED. |\n","| CAMPAIGN_PAUSED | Campaign status is PAUSED. |\n","| CAMPAIGN_ARCHIVED | Campaign status is ARCHIVED |\n","| PENDING_START_DATE | Campaign start date is in the future and has not started yet. |\n","| ENDED | Campaign end date is in the past. |\n","| CAMPAIGN_INCOMPLETE | Campaign does not contain any ads or keywords. |\n","| CAMPAIGN_OUT_OF_BUDGET | Campaign daily budget has been exceeded. |\n","| PORTFOLIO_PAUSED | The associated portfolio is paused. |\n","| PORTFOLIO_ARCHIVED | The associated portfolio is archived. |\n","| PORTFOLIO_OUT_OF_BUDGET | The maximum budget cap at the portfolio level has been reached. |\n","| PORTFOLIO_ENDED | The portfolio end date is in the past. | \n","| Ad group status | Meaning |\n","\\| --- \\| --- \\|\n","| AD_GROUP_STATUS_ENABLED | Ad group status is ENABLED. |\n","| AD_GROUP_PAUSED | Ad group status is PAUSED. |\n","| AD_GROUP_ARCHIVED | Ad group status is ARCHIVED. |\n","| AD_GROUP_INCOMPLETE | Ad group does not contain at least one keyword and one ad. |\n","| AD_GROUP_LOW_BID | Maximum bid of the ad group is less than the minimum allowed bid in its marketplace. |\n","| Ad status | Meaning |\n","\\| --- \\| --- \\|\n","| AD_STATUS_LIVE | Ad status is ENABLED. |\n","| AD_PAUSED | Ad status is PAUSED. |\n","| AD_ARCHIVED | Ad status is ARCHIVED. |\n","| MISSING_IMAGE | Ad offer does not have Item decoration, or Item decoration does not have a product page. |\n","| MISSING_DECORATION | Ad is not servable. Please check status in Amazon Ads UI (Seller Central/Advertising Console) for additional details. |\n","| NOT_BUYABLE | Ad offer does not have decoration or buyability data. |\n","| NOT_IN_BUYBOX | This field is no longer supported. |\n","| OUT_OF_STOCK | Ad offer is out of stock. |\n","| Keyword status | Meaning |\n","\\| --- \\| --- \\|\n","| TARGETING_CLAUSE_STATUS_LIVE | Keyword status is ENABLED. |\n","| TARGETING_CLAUSE_POLICING_SUSPENDED | Keyword is suspended because of a policing reason. |\n","| TARGETING_CLAUSE_PAUSED | Keyword status is PAUSED. |\n","| TARGETING_CLAUSE_ARCHIVED | Keyword status is ARCHIVED. |\n","| TARGETING_CLAUSE_BLOCKED | Keyword is blocked and not eligible for advertising. |\n","| NO_INVENTORY | Ad offer is ineligible because inventory was removed. |\n","| Sponsored Brands campaign status | Meaning |\n","\\| --- \\| --- \\|\n","| PENDING_REVIEW | The campaign is pending review with moderation. |\n","| READY | The campaign is scheduled and ready to run (startDate set in future, but passed moderation). |\n","| SCHEDULED | Transitive state between ready and running. |\n","| RUNNING | The campaign is running. |\n","| PAUSED | The campaign state was set to PAUSED by the user. |\n","| REJECTED | The campaign has been rejected by moderation process. |\n","| ENDED | The campaign has passed end date. |\n","| BILLING_ERROR | The campaign has been stopped because of billing error. |\n","| ASIN_NOT_BUYABLE | Associated ASIN is not buyable. |\n","| LANDING_PAGE_NOT_AVAILABLE | The associated landing page is no longer available or valid (must have at least 3 eligible ASINs) |\n","| OUT_OF_BUDGET | The campaign has run out of budget. |\n"],"documentType":"guide"},{"title":"Computed status and campaign status","sectionHeader":{"type":2,"text":"Sponsored Brands Campaign Status"},"path":"/en-us/reference/concepts/computed-status","content":["| Status | Actions that lead to a change in status | Resulting Campaign Status | Campaign state | Eligible states a user can set the state to in a PUT request |\n","\\| --- \\| --- \\|\n","| PENDING_REVIEW | Moderation approval | READY | PAUSED | None |\n","|  | Moderation rejected | REJECTED | PAUSED | None |\n","| READY | Campaign state set to PAUSED thru PUT request | PAUSED | ENABLED | PAUSED, ARCHIVED |\n","|  | Campaign archived thru DELETE request | TERMINATED | ENABLED | PAUSED, ARCHIVED |\n","|  | If campaign state in ENABLED and within start and end date | SCHEDULED, RUNNING | ENABLED | PAUSED, ARCHIVED |\n","|  | If past the end date of the campaign | ENDED | ENABLED | PAUSED, ARCHIVED |\n","|  | If there is a billing error | BILLING_ERROR | ENABLED | PAUSED, ARCHIVED |\n","|  | If the associated ASIN is no longer buyable | ASIN_NOT_BUYABLE | ENABLED | PAUSED, ARCHIVED |\n","|  | If the associated landing page is no longer available | LANDING_PAGE\\_ NOT_AVAILABLE | ENABLED | PAUSED, ARCHIVED |\n","| SCHEDULED | Campaign gets updated to RUNNING | RUNNING | ENABLED | PAUSED, ARCHIVED |\n","| RUNNING | Campaign state set to PAUSED thru PUT request | PAUSED | ENABLED | PAUSED, ARCHIVED |\n","|  | Campaign archived thru DELETE request | TERMINATED | ENABLED | PAUSED, ARCHIVED |\n","|  | If past the end date of the campaign | ENDED | ENABLED | PAUSED, ARCHIVED |\n","|  | If there is a billing error | BILLING_ERROR | ENABLED | PAUSED, ARCHIVED |\n","|  | If the associated ASIN is no longer buyable | ASIN_NOT_BUYABLE | ENABLED | PAUSED, ARCHIVED |\n","|  | If the associated landing page is no longer available | LANDING_PAGE\\_ NOT_AVAILABLE | ENABLED | PAUSED, ARCHIVED |\n","|  | If the campaign runs out of budget | OUT_OF_BUDGET | ENABLED | PAUSED, ARCHIVED |\n","| PAUSED | Campaign state set to ENABLED thru PUT request on /sb/campaigns | READY, SCHEDULED, RUNNING | PAUSED | ENABLED, ARCHIVED |\n","|  | Campaign archived thru DELETE request | TERMINATED | PAUSED | ENABLED, ARCHIVED |\n","|  | If past the end date of the campaign | ENDED | PAUSED | ENABLED, ARCHIVED |\n","|  | If there is a billing error | BILLING_ERROR | PAUSED | ENABLED, ARCHIVED |\n","|  | If the associated ASIN is no longer buyable | ASIN_NOT_BUYABLE | PAUSED | ENABLED, ARCHIVED |\n","|  | If the associated landing page is no longer available | LANDING_PAGE\\_ NOT_AVAILABLE | PAUSED | ENABLED, ARCHIVED |\n","|  | If the campaign runs out of budget | OUT_OF_BUDGET | PAUSED | ENABLED, ARCHIVED |\n","| REJECTED | Terminal status No action available | REJECTED | PAUSED | ARCHIVED |\n","| ENDED | Terminal status No action available | ENDED | PAUSED | ARCHIVED |\n","| BILLING_ERROR | Fix billing error(s) | PAUSED, READY, SCHEDULED, RUNNING | PAUSED | ARCHIVED |\n","|  | Campaign archived thru DELETE request on /sb/campaigns | TERMINATED | PAUSED | ARCHIVED |\n","| ASIN_NOT_BUYABLE | Issue(s) with ASIN fixed | PAUSED, READY, SCHEDULED, RUNNING | PAUSED | ARCHIVED |\n","|  | Campaign archived through a DELETE request on /sb/campaigns | TERMINATED | PAUSED | ARCHIVED |\n","| LANDING_PAGE\\_ NOT_AVAILABLE | Campaign archived through a DELETE request on /sb/campaigns | TERMINATED | PAUSED | ARCHIVED |\n","| OUT_OF_BUDGET | Increase the budget (for daily budget only) through a PUT request | PAUSED, READY, SCHEDULED, RUNNING | PAUSED | ARCHIVED |\n","|  | The next calendar day has started, causing the daily spent budget to refresh | PAUSED, READY, SCHEDULED, RUNNING | PAUSED | ARCHIVED |\n"],"documentType":"guide"},{"title":"Developer notes","sectionHeader":null,"path":"/en-us/reference/concepts/developer-notes","content":[],"documentType":"guide"},{"title":"Developer notes","sectionHeader":{"type":2,"text":"Object IDs"},"path":"/en-us/reference/concepts/developer-notes","content":[" The API assigns immutable IDs to all entities. These entity IDs are used to reconcile performance data retrieved through the reporting interface against campaign entities managed through the campaign management interface. IDs for all entities will be in the range of 64-bit unsigned integers. IDs are unique for a given type, but two objects with different types may share the same ID (for example, a campaignId for a campaign may be the same as an adGroupId for an unrelated ad group).\n"," IDs for each type are unique within a Profile. For example, two campaigns (regardless of ad type) associated with the same profile cannot share a campaignId, but you could see the same campaignId appear under a different profile.\n"],"documentType":"guide"},{"title":"Developer notes","sectionHeader":{"type":2,"text":"Archiving"},"path":"/en-us/reference/concepts/developer-notes","content":[" This is a change. Modifying archived entities is not allowed, but you can continue to view archived entities and their performance as you do now in campaign manager and in downloadable reports. Additionally, we do not count archived entities towards the entity limits that we have in place, which, in effect increases your entity limits.\n"],"documentType":"guide"},{"title":"Developer notes","sectionHeader":{"type":2,"text":"Pagination consistency"},"path":"/en-us/reference/concepts/developer-notes","content":[" When making batch requests via the management API, each page request is made independently. Results are ordered consistently, but pagination may result in duplicate or missing records if the set of records satisfying the filtering criteria changes between paged requests. Entity exports and reports do not suffer from the same problem.\n"],"documentType":"guide"},{"title":"Developer notes","sectionHeader":{"type":2,"text":"Atomicity of operations"},"path":"/en-us/reference/concepts/developer-notes","content":[" Note that batch update and creation operations are non-atomic.\n"],"documentType":"guide"},{"title":"Developer notes","sectionHeader":{"type":2,"text":"Idempotency"},"path":"/en-us/reference/concepts/developer-notes","content":[" All operations are idempotent in that the final server state will remain the same if the same operation is performed multiple times. However, this does not guarantee that the same response will be returned, since duplicate creations will result in an error on the second request.\n"," For creation, idempotency is guaranteed by the following uniqueness constraints which, when violated, will return an error indicating that the resource already exists:\n","Campaigns: Campaign name - Ad groups: Campaign name, ad group name - Keywords: Campaign name, ad group name, keyword, match type - Negative keywords: Campaign name, ad group name, keyword, match type - Campaign negative keywords: campaign name, keyword, match type - Product ad: Campaign name, ad group name, SKU, ASIN\n"," For reporting and snapshots, files are memorized, so duplicate requests will return the same report ID\n"],"documentType":"guide"},{"title":"Developer notes","sectionHeader":{"type":2,"text":"Partial updates"},"path":"/en-us/reference/concepts/developer-notes","content":[" The only required attribute to update entities is the ID. This allows for partial updates where only a subset of the attributes are provided and all other attributes will remain unchanged. This allows for less verbose requests for common operations like changing a large batch of keyword bids.\n"],"documentType":"guide"},{"title":"Developer notes","sectionHeader":{"type":2,"text":"Implicit operations"},"path":"/en-us/reference/concepts/developer-notes","content":[" Batch updates can be used to create and archive/delete entities implicitly. The absence of an ID in an update, along with the presence of all attributes required for creation, is interpreted as intent to create a new entity. Similarly, the presence of an ID and state of archived can be used to archive an entity.\n"],"documentType":"guide"},{"title":"Developer notes","sectionHeader":{"type":2,"text":"Asynchronous exports vs. synchronous batch GETs for campaign management"},"path":"/en-us/reference/concepts/developer-notes","content":[" The API is used for synchronous batch operations to get campaigns, ad groups, keywords, and ads. Additionally, the API provides an asynchronous interface for getting a complete export of all entities of a single type. Exports are generally more efficient if the client intends to get all campaigns, ad groups, keywords, or ads in bulk. This is useful for clients who replicate their account structures locally.\n"," To understand the exports specifications for each ad type, see Exports.\n"],"documentType":"guide"},{"title":"Developer notes","sectionHeader":{"type":2,"text":"GETs with extended attributes"},"path":"/en-us/reference/concepts/developer-notes","content":[" Because extended attributes include computed/inherited status, batch gets where these attributes are requested are inherently costlier. It is recommended that clients attempt to calculate inherited status locally using stored parent and grandparent status, particularly if account structure is requested multiple times per day.\n"],"documentType":"guide"},{"title":"Developer notes","sectionHeader":{"type":2,"text":"Sponsored Brands moderation"},"path":"/en-us/reference/concepts/developer-notes","content":[],"documentType":"guide"},{"title":"Amazon Ads API common model overview","sectionHeader":null,"path":"/en-us/reference/common-models/overview","content":[" The common model for the Amazon Ads API provides advertisers with a standard way to refer to common concepts across our different ad products (Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored Television, and Amazon DSP).\n"," We currently support common models for:\n","Campaigns - Ad groups - Targets - Ads - Ad associations\n"," We also support common enums that are referenced within each model.\n"," Campaigns group ads that share common objectives and optimization strategies. Campaigns may also have budgets, fees and frequency caps settings that are defaults to all ad groups, targets, and ads that are associated with the campaign.\n"," Specific attributes for each ad product are preserved in the common model based on the adProduct attribute of a given campaign or child entity.\n"],"documentType":"guide"},{"title":"Amazon Ads API common model overview","sectionHeader":{"type":2,"text":"Entity relationships"},"path":"/en-us/reference/common-models/overview","content":[" The general structure of campaigns for sponsored ads and Amazon DSP.\n"],"documentType":"guide"},{"title":"Amazon Ads API common model overview","sectionHeader":{"type":2,"text":"Entity guides"},"path":"/en-us/reference/common-models/overview","content":[" The following documents contain information about available attributes by ad product for each type of entity.\n","| Entity | API Specification |\n","\\|-------\\|-------------------\\|\n","| Campaign | Campaign API Specification |\n","| Ad Group | Ad Group API Specification |\n","| Ad | Ad API Specification |\n","| Target | Target API Specification |\n","| Ad Association | Ad Association API Specification |\n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/reference/common-models/campaigns","content":[" Campaigns group ads that share common objectives and optimization strategies. Campaigns may also have budgets, fees and frequency caps settings that are defaults to all ad groups, targets, and ads that are associated with the campaign.\n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Campaign parameters by ad product"},"path":"/en-us/reference/common-models/campaigns","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| adProduct                                                           \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| autoCreationSettings                                                \t| ○\t| ✓\t| ○\t|  \t| \n","| autoCreationSettings.autoCreateTargets                              \t| ○\t| ✓\t| ○\t|  \t| \n","| brandId                                                             \t| ○\t|  \t| ○\t|  \t| \n","| budgets                                                 \t| ◐\t| ✓◐\t| ✓◐\t| ◐\t| \n","| campaignId                                                          \t| □\t| □\t| □\t| □\t| \n","| costType                                                            \t| ○\t|  \t| ✓\t|  \t| \n","| countries                                                           \t| ○\t| ○\t| ○\t| ○\t| \n","| countries.CountryCode\\[]                                             \t| ○\t| ○\t| ○\t| ○\t| \n","| creationDateTime                                                    \t| □\t| □\t| □\t| □\t| \n","| endDateTime                                                         \t| ○\t| ○\t| ○\t| □\t| \n","| fees                                                       \t| ◐\t|  \t|  \t| ◐\t| \n","| flights                                                 \t| ◐\t|  \t|  \t| ✓◐\t| \n","| frequencies                                         \t| ◐\t|  \t|  \t| ◐\t| \n","| isMultiAdGroupsEnabled                                              \t| □\t|  \t| □\t|  \t| \n","| lastUpdatedDateTime                                                 \t| □\t| □\t| □\t| □\t| \n","| marketplaceConfigurations                                           \t|  \t|  \t|  \t|  \t| \n","| marketplaceScope                                                    \t| ○\t| ✓\t| ✓\t|  \t| \n","| marketplaces                                                        \t| ○\t| ○\t| ○\t| ○\t| \n","| marketplaces.Marketplace\\[]                                          \t| ○\t| ○\t| ○\t| ○\t| \n","| name                                                                \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| optimizations                                                       \t| ○\t| ○\t| ○\t| ✓\t| \n","| optimizations.bidSettings                           \t| ◐\t| ◐\t| ◐\t| ✓◐\t| \n","| optimizations.budgetSettings                     \t| ◐\t| ◐\t|  \t| ◐\t| \n","| optimizations.goalSettings                         \t| ◐\t|  \t| ◐\t| ◐\t| \n","| optimizations.primaryInventoryTypes       \t| ◐\t|  \t|  \t| ◐\t| \n","| portfolioId                                                         \t| ○\t| ○\t| ○\t|  \t| \n","| productCategoryId                                                   \t| ○\t|  \t|  \t|  \t| \n","| purchaseOrderNumber                                                 \t| ○\t|  \t|  \t| ○\t| \n","| salesChannel                                                        \t| ○\t|  \t| ○\t|  \t| \n","| siteRestrictions                                                    \t| ○\t| ○\t|  \t|  \t| \n","| siteRestrictions.SiteRestriction\\[]                                  \t| ○\t| ○\t|  \t|  \t| \n","| skanAppId                                                           \t| ○\t|  \t|  \t| ○\t| \n","| startDateTime                                                       \t| ○\t| ✓\t| ✓\t| □\t| \n","| state                                                               \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| status                                                              \t| □\t| □\t| □\t| □\t| \n","| tags                                                                \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[]                                                          \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[].key                                                 \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| tags.Tag\\[].value                                               \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| targetsAmazonDeal                                                   \t| □\t|  \t|  \t| □\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/reference/common-models/campaigns","content":[],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"BidSettings"},"path":"/en-us/reference/common-models/campaigns","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| bidAdjustments                                                                                         \t| ○\t| ○\t| ○\t|  \t| \n","| bidAdjustments.audienceBidAdjustments                                                                  \t| ○\t| ○\t| ○\t|  \t| \n","| bidAdjustments.audienceBidAdjustments.AudienceBidAdjustment\\[]                                     \t| ○\t| ○\t| ○\t|  \t| \n","| bidAdjustments.placementBidAdjustments                                                                 \t| ○\t| ○\t| ○\t|  \t| \n","| bidAdjustments.placementBidAdjustments.PlacementBidAdjustment\\[]                                   \t| ○\t| ○\t| ○\t|  \t| \n","| bidAdjustments.shopperSegmentBidAdjustments                                                            \t| ○\t|  \t| ○\t|  \t| \n","| bidAdjustments.shopperSegmentBidAdjustments.ShopperSegmentBidAdjustment\\[]                         \t| ○\t|  \t| ○\t|  \t| \n","| bidStrategy                                                                                            \t| ○\t| ○\t| ○\t| ✓\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"BudgetSettings"},"path":"/en-us/reference/common-models/campaigns","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| budgetAllocation                                            \t| ○\t|  \t|  \t| ○\t| \n","| flightBudgetRolloverStrategy                                \t| ○\t|  \t|  \t| ○\t| \n","| offAmazonBudgetControlStrategy                              \t| ○\t| ○\t|  \t|  \t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Budgets"},"path":"/en-us/reference/common-models/campaigns","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| Budget\\[]                                                              \t| ○\t| ○\t| ○\t| ○\t| \n","| Budget\\[].budgetType                                                   \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| Budget\\[].budgetValue                                                  \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| Budget\\[].budgetValue.monetaryBudgetValue                         \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| Budget\\[].recurrenceTimePeriod                                         \t| ○\t| ✓\t| ✓\t| ✓\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Fees"},"path":"/en-us/reference/common-models/campaigns","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| CampaignFee\\[]                                           \t| ○\t|  \t|  \t| ○\t| \n","| CampaignFee\\[].feeType                                   \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFee\\[].feeValue                                  \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFee\\[].feeValueType                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Flights"},"path":"/en-us/reference/common-models/campaigns","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| CampaignFlight\\[]                                                 \t| ○\t|  \t|  \t| ○\t| \n","| CampaignFlight\\[].budget                                          \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFlight\\[].budget.budgetType                          \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFlight\\[].budget.budgetValue                         \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFlight\\[].endDateTime                                     \t| ○\t|  \t|  \t| ✓\t| \n","| CampaignFlight\\[].flightId                                        \t| ○\t|  \t|  \t| ○\t| \n","| CampaignFlight\\[].startDateTime                                   \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Frequencies"},"path":"/en-us/reference/common-models/campaigns","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| Frequency\\[]                                                        \t| ○\t|  \t|  \t| ○\t| \n","| Frequency\\[].eventMaxCount                                          \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].frequencyTargetingSetting                              \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].timeCount                                              \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].timeUnit                                               \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"GoalSettings"},"path":"/en-us/reference/common-models/campaigns","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| currencyCode                              \t| □\t|  \t|  \t| □\t| \n","| goal                                      \t| ○\t|  \t| □\t| □\t| \n","| kpi                                       \t| ○\t|  \t| ✓\t| ✓\t| \n","| kpiValue                                  \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The campaign entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"PrimaryInventoryTypes"},"path":"/en-us/reference/common-models/campaigns","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| PrimaryInventoryType\\[]                              \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The ad group entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/reference/common-models/ad-groups","content":[" Ad groups are used to group ads that have common targeting, strategy, and creatives.\n"],"documentType":"guide"},{"title":"The ad group entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Ad group parameters by ad product"},"path":"/en-us/reference/common-models/ad-groups","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| adGroupId                                                 \t| □\t| □\t| □\t| □\t| \n","| adProduct                                                 \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| advertisedProductCategoryIds                              \t| ○\t|  \t|  \t| ○\t| \n","| bid                                               \t| ◐\t| ✓◐\t|  \t| ✓◐\t| \n","| budgets                                       \t| ◐\t|  \t|  \t| ◐\t| \n","| campaignId                                                \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| creationDateTime                                          \t| □\t| □\t| □\t| □\t| \n","| creativeRotationType                                      \t| ○\t|  \t|  \t| ✓\t| \n","| endDateTime                                               \t| ○\t|  \t|  \t| ✓\t| \n","| fees                                             \t| ◐\t|  \t|  \t| ◐\t| \n","| frequencies                               \t| ◐\t|  \t|  \t| ◐\t| \n","| inventoryType                                             \t| ○\t|  \t|  \t| ✓\t| \n","| lastUpdatedDateTime                                       \t| □\t| □\t| □\t| □\t| \n","| marketplaceConfigurations                                 \t|  \t|  \t|  \t|  \t| \n","| marketplaceScope                                          \t| ○\t| □\t| □\t|  \t| \n","| marketplaces                                              \t| ○\t| □\t| □\t|  \t| \n","| marketplaces.Marketplace\\[]                                \t| ○\t|  \t|  \t|  \t| \n","| name                                                      \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| optimization                             \t| ◐\t|  \t|  \t| ✓◐\t| \n","| pacing                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| pacing.deliveryProfile                                    \t| ○\t|  \t|  \t| ✓\t| \n","| purchaseOrderNumber                                       \t| ○\t|  \t|  \t| ○\t| \n","| startDateTime                                             \t| ○\t|  \t|  \t| ✓\t| \n","| state                                                     \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| status                                                    \t| □\t| □\t| □\t| □\t| \n","| tags                                                      \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[]                                                \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[].key                                       \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| tags.Tag\\[].value                                     \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| targetingSettings                   \t| ◐\t|  \t|  \t| ✓◐\t| \n"],"documentType":"guide"},{"title":"The ad group entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/reference/common-models/ad-groups","content":[],"documentType":"guide"},{"title":"The ad group entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Bid"},"path":"/en-us/reference/common-models/ad-groups","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| baseBid                                                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| currencyCode                                                                                 \t| □\t| □\t|  \t| □\t| \n","| defaultBid                                                                                   \t| ○\t| ✓\t|  \t|  \t| \n","| marketplaceSettings                                                                          \t| ○\t|  \t|  \t|  \t| \n","| marketplaceSettings.AdGroupBidMarketplaceSetting\\[]                                           \t| ○\t|  \t|  \t|  \t| \n","| marketplaceSettings.AdGroupBidMarketplaceSetting\\[].currencyCode                         \t| ○\t|  \t|  \t|  \t| \n","| marketplaceSettings.AdGroupBidMarketplaceSetting\\[].defaultBid                           \t| ○\t|  \t|  \t|  \t| \n","| marketplaceSettings.AdGroupBidMarketplaceSetting\\[].marketplace                          \t| ○\t|  \t|  \t|  \t| \n","| maxAverageBid                                                                                \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The ad group entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Budgets"},"path":"/en-us/reference/common-models/ad-groups","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| Budget\\[]                                                              \t| ○\t|  \t|  \t| ○\t| \n","| Budget\\[].budgetType                                                   \t| ○\t|  \t|  \t| ✓\t| \n","| Budget\\[].budgetValue                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| Budget\\[].budgetValue.monetaryBudgetValue                         \t| ○\t|  \t|  \t| ✓\t| \n","| Budget\\[].recurrenceTimePeriod                                         \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad group entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Fees"},"path":"/en-us/reference/common-models/ad-groups","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| Fee\\[]                                                     \t| ○\t|  \t|  \t| ○\t| \n","| Fee\\[].addToBudgetSpentAmount                              \t| ○\t|  \t|  \t| ✓\t| \n","| Fee\\[].feeType                                             \t| ○\t|  \t|  \t| ✓\t| \n","| Fee\\[].feeValue                                            \t| ○\t|  \t|  \t| ✓\t| \n","| Fee\\[].thirdPartyProvider                                  \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad group entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Frequencies"},"path":"/en-us/reference/common-models/ad-groups","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| Frequency\\[]                                                        \t| ○\t|  \t|  \t| ○\t| \n","| Frequency\\[].eventMaxCount                                          \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].frequencyTargetingSetting                              \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].timeCount                                              \t| ○\t|  \t|  \t| ✓\t| \n","| Frequency\\[].timeUnit                                               \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad group entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"Optimization"},"path":"/en-us/reference/common-models/ad-groups","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| bidStrategy                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| budgetSettings                                                 \t| ○\t|  \t|  \t| ○\t| \n","| budgetSettings.budgetAllocation                                \t| ○\t|  \t|  \t| ○\t| \n","| budgetSettings.dailyMinSpendValue                              \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The ad group entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"TargetingSettings"},"path":"/en-us/reference/common-models/ad-groups","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| amazonViewability                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| amazonViewability.includeUnmeasurableImpressions                              \t| ○\t|  \t|  \t| ✓\t| \n","| amazonViewability.viewabilityTier                                             \t| ○\t|  \t|  \t| ✓\t| \n","| automatedTargetingTactic                                                      \t| □\t|  \t|  \t| □\t| \n","| defaultAudienceTargetingMatchType                                             \t| ○\t|  \t|  \t| ○\t| \n","| enableLanguageTargeting                                                       \t| ○\t|  \t|  \t| ○\t| \n","| siteLanguage                                                                  \t| □\t|  \t|  \t| □\t| \n","| tacticsConvertersExclusionType                                                \t| ○\t|  \t|  \t| ○\t| \n","| targetedPGDealId                                                              \t| ○\t|  \t|  \t| ○\t| \n","| timeZoneType                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| userLocationSignal                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| videoCompletionTier                                                           \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/reference/common-models/targets","content":[" Targets allow advertisers to influence when ads will or will not appear, as well as specify how much to bid for an ad when these conditions are met.\n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Target parameters by ad product"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| adGroupId                                                                          \t| ○\t| ○\t| ✓\t| ✓\t| \n","| adProduct                                                                          \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| bid                                                                                \t| ○\t| ○\t| ○\t|  \t| \n","| bid.bid                                                                            \t| ○\t| ○\t| ✓\t|  \t| \n","| bid.currencyCode                                                                   \t| □\t| □\t| □\t|  \t| \n","| bid.marketplaceSettings                                                            \t| ○\t|  \t|  \t|  \t| \n","| bid.marketplaceSettings.TargetBidMarketplaceSetting\\[]                         \t| ○\t|  \t|  \t|  \t| \n","| campaignId                                                                         \t| ○\t| ○\t| ○\t|  \t| \n","| creationDateTime                                                                   \t| □\t| □\t| □\t| □\t| \n","| lastUpdatedDateTime                                                                \t| □\t| □\t| □\t| □\t| \n","| marketplaceConfigurations                                                          \t|  \t|  \t|  \t|  \t| \n","| marketplaceScope                                                                   \t| ○\t| □\t| □\t|  \t| \n","| marketplaces                                                                       \t| ○\t| □\t| □\t|  \t| \n","| marketplaces.Marketplace\\[]                                                         \t| ○\t|  \t|  \t|  \t| \n","| negative                                                                           \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| state                                                                              \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| status                                                                             \t| □\t| □\t| □\t| □\t| \n","| tags                                                                               \t| ○\t| ○\t|  \t|  \t| \n","| tags.Tag\\[]                                                                         \t| ○\t| ○\t|  \t|  \t| \n","| tags.Tag\\[].key                                                                \t| ○\t| ✓\t|  \t|  \t| \n","| tags.Tag\\[].value                                                              \t| ○\t| ✓\t|  \t|  \t| \n","| targetDetails                                                                      \t| ○\t| ○\t| ○\t| ○\t| \n","| targetDetails.adInitiationTarget                            \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.adPlayerSizeTarget                            \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.appTarget                                              \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.audienceTarget                                    \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.contentCategoryTarget                      \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.contentGenreTarget                            \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.contentInstreamPositionTarget      \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.contentOutstreamPositionTarget    \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.contentRatingTarget                          \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.dayPartTarget                                      \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.deviceTarget                                        \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.domainTarget                                        \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.foldPositionTarget                            \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.inventorySourceTarget                      \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.keywordTarget                                      \t| ◐\t| ◐\t| ◐\t| ◐\t| \n","| targetDetails.locationTarget                                    \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.nativeContentPositionTarget          \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.productCategoryTarget                      \t| ◐\t| ◐\t| ◐\t| ◐\t| \n","| targetDetails.productTarget                                      \t| ◐\t| ◐\t| ◐\t| ◐\t| \n","| targetDetails.themeTarget                                          \t| ◐\t| ◐\t| ◐\t| ◐\t| \n","| targetDetails.thirdPartyTarget                                \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.videoAdFormatTarget                          \t| ◐\t|  \t|  \t| ◐\t| \n","| targetDetails.videoContentDurationTarget            \t| ◐\t|  \t|  \t| ◐\t| \n","| targetId                                                                           \t| □\t| □\t| □\t| □\t| \n","| targetLevel                                                                        \t| □\t| □\t| □\t| □\t| \n","| targetType                                                                         \t| ✓\t| ✓\t| ✓\t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/reference/common-models/targets","content":[],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdInitiationTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| videoInitiationType                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdPlayerSizeTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| adPlayerSize                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AppTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| appId                                \t| ○\t|  \t|  \t| ✓\t| \n","| appType                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AudienceTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| acrossGroupOperator                                                                    \t| ○\t|  \t|  \t| ○\t| \n","| audienceId                                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| audienceId.defaultValue                                                                \t| ○\t|  \t|  \t| ○\t| \n","| audienceId.marketplaceSettings                                                         \t| ○\t|  \t|  \t|  \t| \n","| audienceId.marketplaceSettings.StringMarketplaceSetting\\[]                         \t| ○\t|  \t|  \t|  \t| \n","| groupId                                                                                \t| ○\t|  \t|  \t| ○\t| \n","| inGroupOperator                                                                        \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ContentCategoryTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| contentCategoryId                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ContentGenreTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| contentGenre                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ContentInstreamPositionTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| instreamPosition                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ContentOutstreamPositionTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| outstreamPosition                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ContentRatingTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| contentRatingType                                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| contentRatingTypeDetails                                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| contentRatingTypeDetails.dspContentRating                                                     \t| ○\t|  \t|  \t| ○\t| \n","| contentRatingTypeDetails.dspContentRating.dspContentRating                               \t| ○\t|  \t|  \t| ✓\t| \n","| contentRatingTypeDetails.twitchContentRating                                                  \t| ○\t|  \t|  \t| ○\t| \n","| contentRatingTypeDetails.twitchContentRating.twitchContentRating                         \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"DayPartTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| dayOfWeek                                        \t| ○\t|  \t|  \t| ✓\t| \n","| timeOfDay                                        \t| ○\t|  \t|  \t| ✓\t| \n","| timeOfDay.endTime                                \t| ○\t|  \t|  \t| ✓\t| \n","| timeOfDay.startTime                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"DeviceTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| deviceOrientation                              \t| ○\t|  \t|  \t| ○\t| \n","| deviceType                                     \t| ○\t|  \t|  \t| ✓\t| \n","| mobileDevice                                   \t| ○\t|  \t|  \t| ○\t| \n","| mobileEnvironment                              \t| ○\t|  \t|  \t| ○\t| \n","| mobileOs                                       \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"DomainTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| domainTargetDetails                                                                         \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetDetails.advertiserDomainList                                                    \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.advertiserDomainList.inheritFromAdvertiser                         \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetDetails.domainFileTarget                                                        \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.domainFileTarget.domainFileId                                      \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.domainFileTarget.domainFileKey                                     \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetDetails.domainFileTarget.domainFileName                                    \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetDetails.domainFileTarget.domainFileUrl                                     \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.domainListTarget                                                        \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.domainListTarget.domainListId                                      \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetDetails.domainNameTarget                                                        \t| ○\t|  \t|  \t| ○\t| \n","| domainTargetDetails.domainNameTarget.domainName                                        \t| ○\t|  \t|  \t| ✓\t| \n","| domainTargetType                                                                            \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"FoldPositionTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| foldPosition                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"InventorySourceTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| inventorySourceId                                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| inventorySourceId.defaultValue                                                                \t| ○\t|  \t|  \t| ○\t| \n","| inventorySourceId.marketplaceSettings                                                         \t| ○\t|  \t|  \t|  \t| \n","| inventorySourceId.marketplaceSettings.StringMarketplaceSetting\\[]                         \t| ○\t|  \t|  \t|  \t| \n","| inventorySourceType                                                                           \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"KeywordTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| keyword                                            \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| matchType                                          \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| nativeLanguageKeyword                              \t| ○\t| ○\t| ○\t|  \t| \n","| nativeLanguageLocale                               \t| ○\t| ○\t| ○\t|  \t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"LocationTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| locationId                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"NativeContentPositionTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| nativePosition                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ProductCategoryTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| productCategoryRefinement                                                                                                \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| productCategoryRefinement.marketplaceSettings                                                                            \t| ○\t|  \t|  \t|  \t| \n","| productCategoryRefinement.marketplaceSettings.ProductCategoryRefinementMarketplaceSetting\\[]                         \t| ○\t|  \t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement                                                                      \t| ○\t| ✓\t| ○\t| ○\t| \n","| productCategoryRefinement.productCategoryRefinement.productAgeRangeId                                               \t| ○\t| ○\t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productAgeRangeIdResolved                                       \t| ○\t| ○\t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productBrandId                                                  \t| ○\t| ○\t| ○\t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productBrandIdResolved                                          \t| ○\t| ○\t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productCategoryId                                               \t| ○\t| ○\t| ○\t| ○\t| \n","| productCategoryRefinement.productCategoryRefinement.productCategoryIdResolved                                       \t| ○\t| ○\t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productPriceGreaterThan                                         \t| ○\t| ○\t| ○\t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productPriceLessThan                                            \t| ○\t| ○\t| ○\t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productPrimeShippingEligible                                    \t| ○\t| ○\t|  \t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productRatingGreaterThan                                        \t| ○\t| ○\t| ○\t|  \t| \n","| productCategoryRefinement.productCategoryRefinement.productRatingLessThan                                           \t| ○\t| ○\t| ○\t|  \t| \n","| productGenreRefinement                                                                                                   \t| ○\t| ○\t|  \t|  \t| \n","| productGenreRefinement.productGenreId                                                                                    \t| ○\t| ✓\t|  \t|  \t| \n","| productGenreRefinement.productGenreIdResolved                                                                            \t| ○\t| ○\t|  \t|  \t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ProductTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| matchType                                                                            \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| product                                                                              \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| product.marketplaceSettings                                                          \t| ○\t|  \t|  \t|  \t| \n","| product.marketplaceSettings.ProductMarketplaceSetting\\[]                         \t| ○\t|  \t|  \t|  \t| \n","| product.productId                                                                    \t| ○\t| ✓\t| ○\t|  \t| \n","| productIdType                                                                        \t| ✓\t| ✓\t| ✓\t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ThemeTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| matchType                              \t| ✓\t| ✓\t| ✓\t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ThirdPartyTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| thirdPartyTargetDetails                                                                                                     \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyTargetDetails.doubleVerifyAuthenticAttention                                                                      \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyAuthenticAttention.universalAttention                                              \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyTargetDetails.doubleVerifyAuthenticBrandSafety                                                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyAuthenticBrandSafety.doubleVerifySegmentId                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.appAgeRating                                                           \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.appStarRating                                                          \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.contentCategories                                                      \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.contentCategoriesWithRisk                                              \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.excludeAppsWithInsufficientRating                                      \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyBrandSafety.unknownContent                                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyCustomContextualSegmentId                                                               \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyCustomContextualSegmentId.doubleVerifySegmentId                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyFraudInvalidTraffic                                                                     \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyFraudInvalidTraffic.blockAppAndSites                                               \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyFraudInvalidTraffic.excludeAppsAndSites                                            \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyFraudInvalidTraffic.excludeImpressions                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyStandardDisplayBrandSafety                                                              \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyStandardDisplayBrandSafety.contentCategories                                       \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyStandardDisplayBrandSafety.contentCategoriesWithRisk                               \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyStandardDisplayBrandSafety.unknownContent                                          \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyViewability                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyViewability.averageCompletionAndFullyViewableRateTargeting                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyViewability.brandExposureViewabilityTargeting                                      \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyViewability.includeUnmeasurableImpressions                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.doubleVerifyViewability.mrcViewabilityTargeting                                                \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.excludeContent                                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyAdult                                               \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyAlcohol                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyGambling                                            \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyHateSpeech                                          \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyIllegalDownloads                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyIllegalDrugs                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyOffensiveLanguage                                   \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceBrandSafety.iasBrandSafetyViolence                                            \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceContextualAvoidance                                                                \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceContextualAvoidance.avoidanceSegments                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceContextualTargeting                                                                \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceContextualTargeting.topicalSegments                                           \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceContextualTargeting.verticalSegments                                          \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceFraudInvalidTraffic                                                                \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceFraudInvalidTraffic.targetSetting                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceQualitySync                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceQualitySync.segmentId                                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceViewability                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.integralAdScienceViewability.standard                                                          \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyTargetDetails.integralAdScienceViewability.viewabilityTargeting                                              \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.newsGuardBrandGuardMisinformationSafety                                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.newsGuardBrandGuardMisinformationSafety.avoidanceList                                          \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.newsGuardBrandGuardTrustedNewsTargeting                                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.newsGuardBrandGuardTrustedNewsTargeting.targetingList                                          \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.pixalateFraudInvalidTraffic                                                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.pixalateFraudInvalidTraffic.excludeAppsAndDomains                                              \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.pixalateFraudInvalidTraffic.excludeIpAddressAndUserAgents                                      \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.pixalateFraudInvalidTraffic.excludeOttAndMobileDevices                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetDetails.pixalateFraudInvalidTraffic.excludeRemovedAppsFromAppStores                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyTargetType                                                                                                        \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"VideoAdFormatTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| videoAdFormat                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The target entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"VideoContentDurationTarget"},"path":"/en-us/reference/common-models/targets","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| duration                              \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/reference/common-models/ads","content":[" An ad is the smallest unit of an advertising campaign. An ad represents the creative and advertised products that a customer sees and interacts with.\n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Ad parameters by ad product"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| activeCreative                                           \t| □\t|  \t| □\t|  \t| \n","| adGroupId                                                \t| ○\t| ✓\t| ✓\t|  \t| \n","| adId                                                     \t| □\t| □\t| □\t| □\t| \n","| adProduct                                                \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| adType                                                   \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| campaignId                                               \t| □\t| □\t| □\t|  \t| \n","| creationDateTime                                         \t| □\t| □\t| □\t| □\t| \n","| creative                                                 \t| ○\t| ○\t| ○\t| ○\t| \n","| creative.audioCreative                 \t| ◐\t|  \t|  \t| ◐\t| \n","| creative.componentCreative         \t| ◐\t|  \t| ◐\t| ◐\t| \n","| creative.displayCreative             \t| ◐\t|  \t|  \t| ◐\t| \n","| creative.productCreative             \t| ◐\t| ◐\t|  \t|  \t| \n","| creative.thirdPartyCreative       \t| ◐\t|  \t|  \t| ◐\t| \n","| creative.videoCreative                 \t| ◐\t|  \t|  \t| ◐\t| \n","| lastUpdatedDateTime                                      \t| □\t| □\t| □\t| □\t| \n","| marketplaceConfigurations                                \t|  \t|  \t|  \t|  \t| \n","| marketplaceScope                                         \t| ○\t| □\t| □\t|  \t| \n","| marketplaces                                             \t| ✓\t| □\t| □\t| ✓\t| \n","| marketplaces.Marketplace\\[]                               \t| ○\t|  \t|  \t| ○\t| \n","| name                                                     \t| ○\t|  \t| ✓\t| ✓\t| \n","| state                                                    \t| ✓\t| ✓\t| ✓\t| ✓\t| \n","| status                                                   \t| □\t| □\t| □\t|  \t| \n","| tags                                                     \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[]                                               \t| ○\t| ○\t| ○\t| ○\t| \n","| tags.Tag\\[].key                                      \t| ○\t| ✓\t| ✓\t| ✓\t| \n","| tags.Tag\\[].value                                    \t| ○\t| ✓\t| ✓\t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/reference/common-models/ads","content":[],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AssetBasedCreativeSettings"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| additionalHtml                                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| bodyText                                                                                              \t| ○\t|  \t|  \t| ○\t| \n","| brand                                                                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| callToActions                                                                                         \t| ○\t|  \t|  \t| ✓\t| \n","| callToActions.assetBasedCreativeCallToActionSettings                                                  \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.assetBasedCreativeCallToActionSettings.callToActionType                            \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.assetBasedCreativeCallToActionSettings.deepLinkingBehavior                         \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.assetBasedCreativeCallToActionSettings.url                                         \t| ○\t|  \t|  \t| ✓\t| \n","| clickTrackingUrls                                                                                     \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[]                                                               \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[].url                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| creativeSizes                                                                                         \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[]                                                                                  \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[].height                                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| creativeSizes.Size\\[].width                                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| customVideos                                                                                          \t| ○\t|  \t|  \t| ○\t| \n","| customVideos.assetId                                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| customVideos.assetVersion                                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| disclaimers                                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| headlines                                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls                                                                                \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[]                                                          \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[].url                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes                                                                                        \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes.ComponentInventoryType\\[]                                                               \t| ○\t|  \t|  \t| ○\t| \n","| language                                                                                              \t| ○\t|  \t|  \t| ✓\t| \n","| logos                                                                                                 \t| ○\t|  \t|  \t| ○\t| \n","| logos.Image\\[]                                                                                         \t| ○\t|  \t|  \t| ○\t| \n","| logos.Image\\[].assetId                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| logos.Image\\[].assetVersion                                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| logos.Image\\[].formatProperties                                                                   \t| ○\t|  \t|  \t| ○\t| \n","| optimizationGoalKpi                                                                                   \t| ○\t|  \t|  \t| ✓\t| \n","| responsiveSizingBehavior                                                                              \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages                                                                                          \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[]                                                                                  \t| ○\t|  \t|  \t| ○\t| \n","| squareImages.Image\\[].assetId                                                                     \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[].assetVersion                                                                \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[].formatProperties                                                            \t| ○\t|  \t|  \t| ○\t| \n","| tallImages                                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[]                                                                                    \t| ○\t|  \t|  \t| ○\t| \n","| tallImages.Image\\[].assetId                                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[].assetVersion                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[].formatProperties                                                              \t| ○\t|  \t|  \t| ○\t| \n","| wideImages                                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[]                                                                                    \t| ○\t|  \t|  \t| ○\t| \n","| wideImages.Image\\[].assetId                                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[].assetVersion                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[].formatProperties                                                              \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AudioCreative"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| standardAudioSettings                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| standardAudioSettings.audio                                                                     \t| ○\t|  \t|  \t| ✓\t| \n","| standardAudioSettings.audio.assetId                                                        \t| ○\t|  \t|  \t| ✓\t| \n","| standardAudioSettings.audio.assetVersion                                                   \t| ○\t|  \t|  \t| ✓\t| \n","| standardAudioSettings.impressionTrackingUrls                                                    \t| ○\t|  \t|  \t| ○\t| \n","| standardAudioSettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                         \t| ○\t|  \t|  \t| ○\t| \n","| standardAudioSettings.language                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| standardAudioSettings.products                                                                  \t| ○\t|  \t|  \t| ○\t| \n","| standardAudioSettings.products.AdvertisedProducts\\[]                                        \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"BrandStoreSettings"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| additionalHtml                                                                                \t| ○\t|  \t|  \t| ○\t| \n","| bodyText                                                                                      \t| ○\t|  \t|  \t| ○\t| \n","| brand                                                                                         \t| ○\t|  \t|  \t| ✓\t| \n","| callToActions                                                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| callToActions.brandStoreCallToActionSettings                                                  \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.brandStoreCallToActionSettings.callToActionType                            \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.brandStoreCallToActionSettings.deepLinkingBehavior                         \t| ○\t|  \t|  \t| ○\t| \n","| callToActions.brandStoreCallToActionSettings.url                                         \t| ○\t|  \t|  \t| ✓\t| \n","| clickTrackingUrls                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[]                                                       \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[].url                                              \t| ○\t|  \t|  \t| ✓\t| \n","| creativeSizes                                                                                 \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[]                                                                          \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[].height                                                              \t| ○\t|  \t|  \t| ✓\t| \n","| creativeSizes.Size\\[].width                                                               \t| ○\t|  \t|  \t| ✓\t| \n","| disclaimers                                                                                   \t| ○\t|  \t|  \t| ○\t| \n","| headlines                                                                                     \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[]                                                  \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[].url                                         \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes                                                                                \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes.ComponentInventoryType\\[]                                                       \t| ○\t|  \t|  \t| ○\t| \n","| language                                                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| logos                                                                                         \t| ○\t|  \t|  \t| ○\t| \n","| logos.assetId                                                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| logos.assetVersion                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| logos.formatProperties                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| logos.formatProperties.FormatProperties\\[]                                                \t| ○\t|  \t|  \t| ○\t| \n","| optimizationGoalKpi                                                                           \t| ○\t|  \t|  \t| ✓\t| \n","| responsiveSizingBehavior                                                                      \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages                                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[]                                                                          \t| ○\t|  \t|  \t| ○\t| \n","| squareImages.Image\\[].assetId                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[].assetVersion                                                        \t| ○\t|  \t|  \t| ✓\t| \n","| squareImages.Image\\[].formatProperties                                                    \t| ○\t|  \t|  \t| ○\t| \n","| tallImages                                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[]                                                                            \t| ○\t|  \t|  \t| ○\t| \n","| tallImages.Image\\[].assetId                                                               \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[].assetVersion                                                          \t| ○\t|  \t|  \t| ✓\t| \n","| tallImages.Image\\[].formatProperties                                                      \t| ○\t|  \t|  \t| ○\t| \n","| wideImages                                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[]                                                                            \t| ○\t|  \t|  \t| ○\t| \n","| wideImages.Image\\[].assetId                                                               \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[].assetVersion                                                          \t| ○\t|  \t|  \t| ✓\t| \n","| wideImages.Image\\[].formatProperties                                                      \t| ○\t|  \t|  \t| ○\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ComponentCreative"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| assetBasedCreativeSettings\t| ◐\t|  \t|  \t| ◐\t| \n","| automaticCollectionSettings        \t| ◐\t|  \t| ◐\t|  \t| \n","| brandStoreSettings                \t| ◐\t|  \t|  \t| ◐\t| \n","| dynamicCollectionSettings  \t| ◐\t|  \t|  \t|  \t| \n","| manualCollectionSettings    \t| ◐\t|  \t| ◐\t|  \t| \n","| productCollectionSettings (Deprecated)  \t| ◐\t|  \t| ◐\t|  \t| \n","| productVideoSettings            \t| ◐\t|  \t| ◐\t|  \t| \n","| responsiveEcommerceSettings\t| ◐\t|  \t|  \t| ◐\t| \n","| storeSpotlightSettings        \t| ◐\t|  \t| ◐\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"DisplayCreative"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| standardDisplaySettings                                                                                 \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.adChoicesPosition                                                               \t| ○\t|  \t|  \t| ✓\t| \n","| standardDisplaySettings.callToAction                                                                    \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.callToAction.clickToAppDisplayCallToActionSettings                         \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.callToAction.clickToUrlDisplayCallToActionSettings                         \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.clickTrackingUrls                                                               \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.clickTrackingUrls.CreativeTrackingUrl\\[]                                    \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.creativeSizes                                                                   \t| ○\t|  \t|  \t| ✓\t| \n","| standardDisplaySettings.creativeSizes.Size\\[]                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| standardDisplaySettings.customImages                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| standardDisplaySettings.customImages.Image\\[]                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| standardDisplaySettings.impressionTrackingUrls                                                          \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                               \t| ○\t|  \t|  \t| ○\t| \n","| standardDisplaySettings.language                                                                        \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"DynamicCollectionSettings"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| products                                                                         \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[]                                                    \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].globalStoreSetting                            \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].marketplaceSettings                           \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].productId                                     \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].productIdType                                 \t| ✓\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductId                             \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductIdType                         \t| ○\t|  \t|  \t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AutomaticCollectionSettings"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| -- \\| --- \\| -- \\| --- \\| \n","| sharedSettings                                                                   \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brand                                                             \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos                                                        \t| ○\t|  \t| ○\t|  \t| \n","| sharedSettings.brandLogos.assetId                                           \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos.assetVersion                                      \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos.formatProperties                                  \t| ○\t|  \t| ○\t|  \t|\n","| productExclusions                                                                \t| ○\t|  \t| ○\t|  \t| \n","| productExclusions.AdvertisedProducts\\[]                                           \t| ○\t|  \t| ○\t|  \t| \n","| productExclusions.AdvertisedProducts\\[].productId                            \t| ○\t|  \t| ✓\t|  \t| \n","| productExclusions.AdvertisedProducts\\[].productIdType                        \t| ○\t|  \t| ✓\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ManualCollectionSettings"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| -- \\| --- \\| - \\| --- \\| \n","| sharedSettings                                                                   \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brand                                                             \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos                                                        \t| ○\t|  \t| ○\t|  \t| \n","| sharedSettings.brandLogos.assetId                                           \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos.assetVersion                                      \t| ○\t|  \t| ✓\t|  \t| \n","| sharedSettings.brandLogos.formatProperties                                  \t| ○\t|  \t| ○\t|  \t| \n","| productInclusions                                                                \t| ○\t|  \t| ✓\t|  \t| \n","| productInclusions.AdvertisedProducts\\[]                                           \t| ○\t|  \t| ✓\t|  \t| \n","| productInclusions.AdvertisedProducts\\[].productId                            \t| ○\t|  \t| ✓\t|  \t| \n","| productInclusions.AdvertisedProducts\\[].productIdType                        \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage                                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageType                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageUrl                                                       \t| ○\t|  \t| ○\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ProductCollectionSettings"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| brand                                                                                                     \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos                                                                                                \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[]                                                                                        \t| ○\t|  \t| ○\t|  \t| \n","| brandLogos.Image\\[].assetId                                                                           \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].assetVersion                                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].formatProperties                                                                  \t| ○\t|  \t| ○\t|  \t| \n","| creativePropertiesToOptimize                                                                              \t| ○\t|  \t| ○\t|  \t| \n","| creativePropertiesToOptimize.ProductCollectionCreativePropertiesToOptimize\\[]                              \t| ○\t|  \t| ○\t|  \t| \n","| customImages                                                                                              \t| ○\t|  \t| ✓\t|  \t| \n","| customImages.Image\\[]                                                                                      \t| ○\t|  \t| ○\t|  \t| \n","| customImages.Image\\[].assetId                                                                         \t| ○\t|  \t| ✓\t|  \t| \n","| customImages.Image\\[].assetVersion                                                                    \t| ○\t|  \t| ✓\t|  \t| \n","| customImages.Image\\[].formatProperties                                                                \t| ○\t|  \t| ○\t|  \t| \n","| enableCreativeAutoTranslation                                                                             \t| ○\t|  \t| ○\t|  \t| \n","| headlines                                                                                                 \t| ○\t|  \t| ○\t|  \t| \n","| landingPage                                                                                               \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageAsins                                                                              \t| ○\t|  \t| ○\t|  \t| \n","| landingPage.landingPageAsins.asins                                                                   \t| ○\t|  \t| ○\t|  \t| \n","| landingPage.landingPageType                                                                               \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageUrl                                                                                \t| ○\t|  \t| ○\t|  \t| \n","| moderationStatus                                                                                          \t| ○\t|  \t| ○\t|  \t| \n","| moderationStatus.moderationStatus                                                                         \t| ○\t|  \t| ✓\t|  \t| \n","| products                                                                                                  \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[]                                                                             \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[].globalStoreSetting                                                     \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].marketplaceSettings                                                    \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].productId                                                              \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[].productIdType                                                          \t| ✓\t|  \t| ✓\t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductId                                                      \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductIdType                                                  \t| ○\t|  \t|  \t|  \t| \n","| untranslatedHeadlines                                                                                     \t| ○\t|  \t| ○\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ProductCreative"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| productCreativeSettings                                                                      \t| ○\t| ✓\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct                                                    \t| ○\t| ✓\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.globalStoreSetting                            \t| ○\t| ✓\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.marketplaceSettings                           \t| ○\t|  \t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.productId                                     \t| ○\t| ✓\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.productIdType                                 \t| ✓\t| ✓\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.resolvedProductId                             \t| ○\t| ○\t|  \t|  \t| \n","| productCreativeSettings.advertisedProduct.resolvedProductIdType                         \t| ○\t| ○\t|  \t|  \t| \n","| productCreativeSettings.headline                                                             \t| ○\t| ○\t|  \t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ProductVideoSettings"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| brand                                                                            \t| ○\t|  \t| ○\t|  \t| \n","| brandLogos                                                                       \t| ○\t|  \t| ○\t|  \t| \n","| brandLogos.Image\\[]                                                               \t| ○\t|  \t| ○\t|  \t| \n","| brandLogos.Image\\[].assetId                                                  \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].assetVersion                                             \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].formatProperties                                         \t| ○\t|  \t| ○\t|  \t| \n","| enableCreativeAutoTranslation                                                    \t| ○\t|  \t| ○\t|  \t| \n","| headlines                                                                        \t| ○\t|  \t| ○\t|  \t| \n","| landingPage                                                                      \t| ○\t|  \t| ○\t|  \t| \n","| landingPage.landingPageType                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageUrl                                                       \t| ○\t|  \t| ○\t|  \t| \n","| moderationStatus                                                                 \t| ○\t|  \t| ○\t|  \t| \n","| moderationStatus.moderationStatus                                                \t| ○\t|  \t| ✓\t|  \t| \n","| products                                                                         \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[]                                                    \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[].globalStoreSetting                            \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].marketplaceSettings                           \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].productId                                     \t| ○\t|  \t| ○\t|  \t| \n","| products.AdvertisedProducts\\[].productIdType                                 \t| ✓\t|  \t| ✓\t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductId                             \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductIdType                         \t| ○\t|  \t|  \t|  \t| \n","| untranslatedHeadlines                                                            \t| ○\t|  \t| ○\t|  \t| \n","| untranslatedVideos                                                               \t| ○\t|  \t| ✓\t|  \t| \n","| untranslatedVideos.Video\\[]                                                       \t| ○\t|  \t| ○\t|  \t| \n","| untranslatedVideos.Video\\[].assetId                                          \t| ○\t|  \t| ✓\t|  \t| \n","| untranslatedVideos.Video\\[].assetVersion                                     \t| ○\t|  \t| ✓\t|  \t| \n","| videos                                                                           \t| ○\t|  \t| ✓\t|  \t| \n","| videos.Video\\[]                                                                   \t| ○\t|  \t| ○\t|  \t| \n","| videos.Video\\[].assetId                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| videos.Video\\[].assetVersion                                                 \t| ○\t|  \t| ✓\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ResponsiveEcommerceSettings"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| clickTrackingUrls                                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[]                                                                     \t| ○\t|  \t|  \t| ○\t| \n","| clickTrackingUrls.CreativeTrackingUrl\\[].url                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| creativePropertiesToOptimize                                                                                \t| ○\t|  \t|  \t| ○\t| \n","| creativePropertiesToOptimize.ResponsiveEcommerceCreativePropertiesToOptimize\\[]                              \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes                                                                                               \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[]                                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| creativeSizes.Size\\[].height                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| creativeSizes.Size\\[].width                                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| disclaimers                                                                                                 \t| ○\t|  \t|  \t| ○\t| \n","| headlines                                                                                                   \t| ○\t|  \t|  \t| ○\t| \n","| images                                                                                                      \t| ○\t|  \t|  \t| ○\t| \n","| images.Image\\[]                                                                                              \t| ○\t|  \t|  \t| ○\t| \n","| images.Image\\[].assetId                                                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| images.Image\\[].assetVersion                                                                            \t| ○\t|  \t|  \t| ✓\t| \n","| images.Image\\[].formatProperties                                                                        \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls                                                                                      \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[]                                                                \t| ○\t|  \t|  \t| ○\t| \n","| impressionTrackingUrls.CreativeTrackingUrl\\[].url                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes                                                                                              \t| ○\t|  \t|  \t| ✓\t| \n","| inventoryTypes.ComponentInventoryType\\[]                                                                     \t| ○\t|  \t|  \t| ○\t| \n","| language                                                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| logos                                                                                                       \t| ○\t|  \t|  \t| ○\t| \n","| logos.assetId                                                                                               \t| ○\t|  \t|  \t| ✓\t| \n","| logos.assetVersion                                                                                          \t| ○\t|  \t|  \t| ✓\t| \n","| logos.formatProperties                                                                                      \t| ○\t|  \t|  \t| ○\t| \n","| logos.formatProperties.FormatProperties\\[]                                                              \t| ○\t|  \t|  \t| ○\t| \n","| optimizationGoalKpi                                                                                         \t| ○\t|  \t|  \t| ✓\t| \n","| products                                                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| products.AdvertisedProducts\\[]                                                                               \t| ○\t|  \t|  \t| ○\t| \n","| products.AdvertisedProducts\\[].globalStoreSetting                                                       \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].marketplaceSettings                                                      \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].productId                                                                \t| ○\t|  \t|  \t| ✓\t| \n","| products.AdvertisedProducts\\[].productIdType                                                            \t| ✓\t|  \t|  \t| ✓\t| \n","| products.AdvertisedProducts\\[].resolvedProductId                                                        \t| ○\t|  \t|  \t|  \t| \n","| products.AdvertisedProducts\\[].resolvedProductIdType                                                    \t| ○\t|  \t|  \t|  \t| \n","| recAdVariations                                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| recAdVariations.ResponsiveEcommerceAdVariations\\[]                                                           \t| ○\t|  \t|  \t| ○\t| \n","| responsiveSizingBehavior                                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| supportedThirdPartySellers                                                                                  \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"StoreSpotlightSettings"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| brand                                                                                                  \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos                                                                                             \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[]                                                                                     \t| ○\t|  \t| ○\t|  \t| \n","| brandLogos.Image\\[].assetId                                                                        \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].assetVersion                                                                   \t| ○\t|  \t| ✓\t|  \t| \n","| brandLogos.Image\\[].formatProperties                                                               \t| ○\t|  \t| ○\t|  \t| \n","| cards                                                                                                  \t| ○\t|  \t| ✓\t|  \t| \n","| cards.CardCreativeElement\\[]                                                                            \t| ○\t|  \t| ○\t|  \t| \n","| cards.CardCreativeElement\\[].headline                                                              \t| ○\t|  \t| ✓\t|  \t| \n","| cards.CardCreativeElement\\[].landingPage                                                           \t| ○\t|  \t| ○\t|  \t| \n","| cards.CardCreativeElement\\[].products                                                              \t| ○\t|  \t| ○\t|  \t| \n","| creativePropertiesToOptimize                                                                           \t| ○\t|  \t| ○\t|  \t| \n","| creativePropertiesToOptimize.StoreSpotlightCreativePropertiesToOptimize\\[]                              \t| ○\t|  \t| ○\t|  \t| \n","| enableCreativeAutoTranslation                                                                          \t| ○\t|  \t| ○\t|  \t| \n","| headlines                                                                                              \t| ○\t|  \t| ○\t|  \t| \n","| landingPage                                                                                            \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageType                                                                            \t| ○\t|  \t| ✓\t|  \t| \n","| landingPage.landingPageUrl                                                                             \t| ○\t|  \t| ✓\t|  \t| \n","| moderationStatus                                                                                       \t| ○\t|  \t| ○\t|  \t| \n","| moderationStatus.moderationStatus                                                                      \t| ○\t|  \t| ✓\t|  \t| \n","| untranslatedHeadlines                                                                                  \t| ○\t|  \t| ○\t|  \t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"ThirdPartyCreative"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| thirdPartyDisplaySettings                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.adChoicesPosition                                                         \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyDisplaySettings.additionalHtml                                                            \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.clickTrackingUrls                                                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.clickTrackingUrls.CreativeTrackingUrl\\[]                              \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.creativeSizes                                                             \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyDisplaySettings.creativeSizes.Size\\[]                                                 \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyDisplaySettings.impressionTrackingUrls                                                    \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                         \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyDisplaySettings.language                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyDisplaySettings.thirdPartyTagHostingSource                                                \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyVideoSettings                                                                             \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyVideoSettings.impressionTrackingUrls                                                      \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyVideoSettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                           \t| ○\t|  \t|  \t| ○\t| \n","| thirdPartyVideoSettings.language                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| thirdPartyVideoSettings.vastUrl                                                                     \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"VideoCreative"},"path":"/en-us/reference/common-models/ads","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Sponsored Products |Sponsored Brands |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| \n","| onlineVideoSettings                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.callToActions                                                             \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.callToActions.VideoCallToAction\\[]                                    \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.clickTrackingUrls                                                         \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.clickTrackingUrls.CreativeTrackingUrl\\[]                              \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.impressionTrackingUrls                                                    \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                         \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.language                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| onlineVideoSettings.products                                                                  \t| ○\t|  \t|  \t| ○\t| \n","| onlineVideoSettings.products.globalStoreSetting                                          \t| ○\t|  \t|  \t|  \t| \n","| onlineVideoSettings.products.marketplaceSettings                                         \t| ○\t|  \t|  \t|  \t| \n","| onlineVideoSettings.products.productId                                                   \t| ○\t|  \t|  \t| ✓\t| \n","| onlineVideoSettings.products.productIdType                                               \t| ✓\t|  \t|  \t| ✓\t| \n","| onlineVideoSettings.products.resolvedProductId                                           \t| ○\t|  \t|  \t|  \t| \n","| onlineVideoSettings.products.resolvedProductIdType                                       \t| ○\t|  \t|  \t|  \t| \n","| onlineVideoSettings.videos                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| onlineVideoSettings.videos.assetId                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| onlineVideoSettings.videos.assetVersion                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| streamingTvSettings                                                                           \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.callToActions                                                             \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.callToActions.VideoCallToAction\\[]                                    \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.impressionTrackingUrls                                                    \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.impressionTrackingUrls.CreativeTrackingUrl\\[]                         \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.language                                                                  \t| ○\t|  \t|  \t| ✓\t| \n","| streamingTvSettings.products                                                                  \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.products.AdvertisedProducts\\[]                                        \t| ○\t|  \t|  \t| ○\t| \n","| streamingTvSettings.videos                                                                    \t| ○\t|  \t|  \t| ✓\t| \n","| streamingTvSettings.videos.assetId                                                       \t| ○\t|  \t|  \t| ✓\t| \n","| streamingTvSettings.videos.assetVersion                                                  \t| ○\t|  \t|  \t| ✓\t| \n"],"documentType":"guide"},{"title":"The ad association entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/reference/common-models/ad-associations","content":[" Ad associations apply to Amazon DSP ad groups only and correspond to ad creative associations in earlier versions of the campaign management API.\n"],"documentType":"guide"},{"title":"The ad association entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Ad association parameters by ad product"},"path":"/en-us/reference/common-models/ad-associations","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Common model |Amazon DSP |\n","\\| --- \\| --- \\| --- \\| \n","| adAssociationId                              \t| □\t| □\t| \n","| adGroupId                                    \t| ✓\t| ✓\t| \n","| adId                                         \t| ✓\t| ✓\t| \n","| endDateTime                                  \t| ○\t| ○\t| \n","| startDateTime                                \t| ○\t| ○\t| \n","| state                                        \t| ✓\t| ✓\t| \n","| weight                                       \t| ○\t| ○\t| \n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":null,"path":"/en-us/reference/common-models/enums","content":[" This document contains the enums referenced by common models. When enum values in the common models differ from those used in campaign management APIs, the values table contains extra columns to show equivalencies. \n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`adProduct`"},"path":"/en-us/reference/common-models/enums","content":[" Description: An ad product is a top-level offering from Amazon Ads, with a given feature set, business rules, and consistent logic.\n","| Values |\n","\\|-----\\|\n","| SPONSORED_PRODUCTS |\n","| SPONSORED_BRANDS |\n","| SPONSORED_DISPLAY |\n"," Referenced by: Campaigns, ad groups\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`adType`"},"path":"/en-us/reference/common-models/enums","content":[" Description: The type or format of an ad.\n","| Values|\n","\\|-----\\|\n","| PRODUCT_AD | \n","| IMAGE |\n","| VIDEO |\n","| PRODUCT_COLLECTION |\n","| STORE_SPOTLIGHT | \n"," Referenced by: Ad\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`audienceSegmentType`"},"path":"/en-us/reference/common-models/enums","content":[" Description: Specifies types of audience segment.\n","| Values              |\n","\\|---------------------\\|\n","| SPONSORED_ADS_AMC |\n","| BEHAVIOR_DYNAMIC    |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`bidStrategy`"},"path":"/en-us/reference/common-models/enums","content":[" Description: The auto bidding strategy applied to the campaign.\n","|Values\t|Sponsored Products (dynamicBidding)\t|Sponsored Brands (bidOptimizationStrategy)\t|\n","|---\t|---\t|---\t|\n","|SALES_DOWN_ONLY\t|LEGACY_FOR_SALES\t|none\t|\n","|SALES\t|AUTO_FOR_SALES\t|MAXIMIZE_IMMEDIATE_SALES\t|\n","|NEW_TO_BRAND\t|none\t|MAXIMIZE_NEW_TO_BRAND_CUSTOMERS\t|\n","|RULE_BASED\t|RULE_BASED\t|none if a bidRule is present\t|\n","|none / null\t|MANUAL\t| \t|\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`budgetType`"},"path":"/en-us/reference/common-models/enums","content":[" Description: The type of budget associated with the campaign.\n","| Values |\n","\\|-----\\|\n","| MONETARY |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`costType`"},"path":"/en-us/reference/common-models/enums","content":[" Description: The way the campaign is charged. \n","| Values |\n","\\|-----\\|\n","| CPC |\n","| VCPM | \n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`currencyCode`"},"path":"/en-us/reference/common-models/enums","content":[" Description: An ISO 4217 standard currency code for all currency-related attributes.\n","|Values\t|\n","\\|-----\\|\n","|AED\t|\n","|AUD\t|\n","|BRL\t|\n","|CAD\t|\n","|CHF\t|\n","|CNY\t|\n","|DKK\t|\n","|EUR\t|\n","|GBP\t|\n","|INR\t|\n","|JPY\t|\n","|MXN\t|\n","|NOK\t|\n","|SAR\t|\n","|SEK\t|\n","|SGD\t|\n","|TRY\t|\n","|USD\t|\n","|BHD\t|\n","|CNH\t|\n","|CZK\t|\n","|HKD\t|\n","|HUF\t|\n","|ILS\t|\n","|JOD\t|\n","|KWD\t|\n","|PLN\t|\n","|QAR\t|\n","|RON\t|\n","|THB\t|\n","|ZAR\t|\n","|ARS\t|\n","|BGN\t|\n","|BOB\t|\n","|CLP\t|\n","|COP\t|\n","|CRC\t|\n","|DOP\t|\n","|DZD\t|\n","|EGP\t|\n","|GTQ\t|\n","|HNL\t|\n","|HRK\t|\n","|IDR\t|\n","|JMD\t|\n","|KRW\t|\n","|MAD\t|\n","|MYR\t|\n","|NGN\t|\n","|NZD\t|\n","|PAB\t|\n","|PEN\t|\n","|PHP\t|\n","|PKR\t|\n","|PYG\t|\n","|RSD\t|\n","|RUB\t|\n","|TND\t|\n","|TWD\t|\n","|UAH\t|\n","|UYU\t|\n","|VND\t|\n"," Referenced by: Campaigns, ad groups\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`deliveryReasons`"},"path":"/en-us/reference/common-models/enums","content":[" Description: A list of reasons that explains the delivery status of the entity. It explains why the entity is delivering or not delivering. This value is not defined by the user and is read only.\n","|Values\t|Sponsored Products\t|Sponsored Brands\t|Sponsored Display\t|\n","\\|-----\\|------\\|-------\\|--------\\|\n","|CAMPAIGN_PAUSED\t|CAMPAIGN_PAUSED\t|CAMPAIGN_PAUSED\t|CAMPAIGN_PAUSED\t|\n","|CAMPAIGN_ARCHIVED\t|CAMPAIGN_ARCHIVED\t|CAMPAIGN_ARCHIVED\t|CAMPAIGN_ARCHIVED\t|\n","|CAMPAIGN_PENDING_START_DATE\t|PENDING_START_DATE\t|PENDING_START_DATE\t|PENDING_START_DATE\t|\n","|CAMPAIGN_END_DATE_REACHED\t|ENDED\t|ENDED\t|ENDED\t|\n","|CAMPAIGN_REJECTED\t|REJECTED\t|REJECTED\t| \t|\n","|CAMPAIGN_PENDING_REVIEW\t|PENDING_REVIEW\t|PENDING_REVIEW\t| \t|\n","|CAMPAIGN_INCOMPLETE\t|CAMPAIGN_INCOMPLETE\t|CAMPAIGN_INCOMPLETE\t| \t|\n","|CAMPAIGN_OUT_OF_BUDGET\t|CAMPAIGN_OUT_OF_BUDGET\t|CAMPAIGN_OUT_OF_BUDGET\t|CAMPAIGN_OUT_OF_BUDGET\t|\n","|PORTFOLIO_OUT_OF_BUDGET\t|PORTFOLIO_OUT_OF_BUDGET\t| \t| \t|\n","|PORTFOLIO_END_DATE_REACHED\t|PORTFOLIO_ENDED\t|PORTFOLIO_ENDED\t| \t|\n","|PORTFOLIO_ARCHIVED\t|PORTFOLIO_ARCHIVED\t|PORTFOLIO_ARCHIVED\t| \t|\n","|PORTFOLIO_PAUSED\t|PORTFOLIO_PAUSED\t|PORTFOLIO_PAUSED\t| \t|\n","|PORTFOLIO_PENDING_START_DATE\t|PORTFOLIO_PENDING_START_DATE\t|PORTFOLIO_PENDING_START_DATE\t| \t|\n","|ADVERTISER_POLICING_SUSPENDED\t|ADVERTISER_POLICING_SUSPENDED\t|ADVERTISER_POLICING_SUSPENDED\t| \t|\n","|ADVERTISER_POLICING_PENDING_REVIEW\t|ADVERTISER_POLICING_PENDING_REVIEW\t|ADVERTISER_POLICING_PENDING_REVIEW\t| \t|\n","|ADVERTISER_ARCHIVED\t|ADVERTISER_ARCHIVED\t|ADVERTISER_ARCHIVED\t| \t|\n","|ADVERTISER_OUT_OF_BUDGET\t|ADVERTISER_OUT_OF_BUDGET AND ACCOUNT_OUT_OF_BUDGET\t|ADVERTISER_ACCOUNT_OUT_OF_BUDGET\t|ACCOUNT_OUT_OF_BUDGET\t|\n","|ADVERTISER_PAUSED\t|ADVERTISER_PAUSED\t|ADVERTISER_PAUSED\t|ADVERTISER_PAUSED\t|\n","|ADVERTISER_PAYMENT_FAILURE\t|ADVERTISER_PAYMENT_FAILURE\t|ADVERTISER_PAYMENT_FAILURE\t|ADVERTISER_PAYMENT_FAILURE\t|\n","|ADVERTISER_OUT_OF_PREPAY_BALANCE\t| \t|ADVERTISER_OUT_OF_PREPAY_BALANCE\t| \t|\n","|ADVERTISER_INELIGIBLE\t| \t|INELIGIBLE\t| \t|\n","|ADVERTISER_OUT_OF_PREPAY_BALANCE\t| \t|ADVERTISER_OUT_OF_PREPAY_BALANCE\t| \t|\n","|AD_GROUP_PAUSED\t|AD_GROUP_PAUSED\t|AD_GROUP_PAUSED\t|AD_GROUP_PAUSED\t|\n","|AD_GROUP_ARCHIVED\t|AD_GROUP_ARCHIVED\t|AD_GROUP_ARCHIVED\t|AD_GROUP_ARCHIVED\t|\n","|AD_GROUP_INCOMPLETE\t|AD_GROUP_INCOMPLETE\t|AD_GROUP_INCOMPLETE\t|AD_GROUP_INCOMPLETE\t|\n","|AD_GROUP_POLICING_PENDING_REVIEW\t|AD_GROUP_POLICING_PENDING_REVIEW\t|AD_GROUP_POLICING_PENDING_REVIEW\t| \t|\n","|AD_GROUP_LOW_BID\t|AD_GROUP_LOW_BID\t|AD_GROUP_LOW_BID\t|AD_GROUP_LOW_BID\t|\n","|AD_GROUP_PENDING_REVIEW\t|PENDING_REVIEW\t| \t| \t|\n","|AD_GROUP_REJECTED\t|REJECTED\t| \t| \t|\n","|TARGET_POLICING_SUSPENDED\t|TARGETING_CLAUSE_POLICING_SUSPENDED\t| \t| \t|\n","|TARGET_PAUSED\t|TARGETING_CLAUSE_PAUSED\t| \t|TARGET_STATUS_PAUSED\t|\n","|TARGET_ARCHIVED\t|TARGETING_CLAUSE_ARCHIVED\t| \t|TARGET_STATUS_ARCHIVED\t|\n","|TARGET_BLOCKED\t|TARGETING_CLAUSE_BLOCKED\t| \t| \t|\n","|AD_PAUSED\t|AD_PAUSED\t|AD_PAUSED\t|AD_STATUS_PAUSED\t|\n","|AD_ARCHIVED\t|AD_ARCHIVED\t|AD_ARCHIVED\t|AD_STATUS_ARCHIVED\t|\n","|AD_POLICING_PENDING_REVIEW\t|AD_POLICING_PENDING_REVIEW\t|AD_POLICING_PENDING_REVIEW\t| \t|\n","|AD_POLICING_SUSPENDED\t|AD_POLICING_SUSPENDED\t|AD_POLICING_SUSPENDED\t| \t|\n","|AD_CREATION_FAILED\t|AD_CREATION_OFFLINE_FAILED or AD_CREATION_FAILED\t| \t| \t|\n","|AD_CREATION_IN_PROGRESS\t|AD_CREATION_OFFLINE_PENDING or AD_CREATION_OFFLINE_IN_PROGRESS\t| \t| \t|\n","|LANDING_PAGE_NOT_AVAILABLE\t|LANDING_PAGE_NOT_AVAILABLE or AD_LANDING_PAGE_NOT_AVAILABLE\t| \t| \t|\n","|NOT_BUYABLE\t|NOT_BUYABLE or AD_NOT_BUYABLE\t| \t|NOT_BUYABLE\t|\n","|NOT_IN_BUYBOX\t|NOT_IN_BUYBOX or AD_NOT_IN_BUYBOX\t| \t|NOT_IN_BUYBOX\t|\n","|NOT_IN_POLICY\t| \t| \t|NOT_IN_POLICY\t|\n","|OUT_OF_STOCK\t|OUT_OF_STOCK or AD_OUT_OF_STOCK\t| \t|OUT_OF_STOCK\t|\n","|AD_MISSING_IMAGE\t|MISSING_IMAGE or AD_MISSING_IMAGE\t| \t|MISSING_IMAGE\t|\n","|SECURITY_SCAN_PENDING_REVIEW\t|SECURITY_SCAN_PENDING_REVIEW\t| \t| \t|\n","|SECURITY_SCAN_REJECTED\t|SECURITY_SCAN_REJECTED\t| \t| \t|\n","|STATUS_UNAVAILABLE\t|STATUS_UNAVAILABLE\t| \t| \t|\n","|NO_INVENTORY\t|NO_INVENTORY\t| \t| \t|\n","|NO_PURCHASABLE_OFFER\t|NO_PURCHASABLE_OFFER or AD_NO_PURCHASABLE_OFFER\t| \t| \t|\n","|AD_INELIGIBLE\t|INELIGIBLE or AD_INELIGIBLE\t|INELIGIBLE\t| \t|\n","|CREATIVE_MISSING_ASSET\t| \t| \t| \t|\n","|CREATIVE_PENDING_REVIEW\t| \t|SUBMITTED_FOR_MODERATION or PENDING_MODERATION_REVIEW\t|PENDING_REVIEW\t|\n","|CREATIVE_REJECTED\t|AD_GROUP_POLICING_CREATIVE_REJECTED\t|REJECTED_BY_MODERATION or AD_GROUP_POLICING_CREATIVE_REJECTED\t|REJECTED\t|\n","|AD_MISSING_DECORATION\t|AD_MISSING_DECORATION\t| \t|MISSING_DECORATION\t|\n","|PIR_RULE_EXCLUDED\t|PIR_RULE_EXCLUDED\t| \t| \t|\n","|AD_NOT_DELIVERING\t|CAMPAIGN_ADS_NOT_DELIVERING\t| \t|CAMPAIGN_ADS_NOT_DELIVERING |\n","|OTHER\t| \t| \t| \t|\n"," Referenced by: Campaigns, ad groups\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`deliveryStatus`"},"path":"/en-us/reference/common-models/enums","content":[" Description: An overall status indicating whether the entity is delivering. This value is not defined by the user and is read only.\n","|Values|\n","\\|-----\\|\n","| DELIVERING |\n","| NOT_DELIVERING |\n","| UNAVAILABLE |\n"," Referenced by: Campaigns, ad groups\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`event`"},"path":"/en-us/reference/common-models/enums","content":[" Description: A target event is an event used in audience targets to define what product event to target based on.\n","| Allowed values|\n","\\|-----\\|\n","| PURCHASE |\n","| VIEW |\n"," Referenced by: Targets\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`goal`"},"path":"/en-us/reference/common-models/enums","content":[" Description: The objective of the campaign or ad group.\n","| Allowed values | Sponsored Display |\n","\\|-----\\|-----\\|\n","| AWARENESS | reach |\n","| CONSIDERATION | clicks |\n","| CONVERSIONS | conversions | \n"," Referenced by: ad groups\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`kpi`"},"path":"/en-us/reference/common-models/enums","content":[" Description: The way a goal is measured. \n","| Allowed values |\n","\\|-----\\|\n","| CLICKS |\n"," Referenced by: ad groups\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`landingPageType`"},"path":"/en-us/reference/common-models/enums","content":[" Description: The type of landing page used in an ad. Only certain landing page types are supported for each ad type.\n","| Values | IMAGE | VIDEO | PRODUCT_COLLECTION | STORE_SPOTLIGHT |\n","\\|-------\\|---\\|-----\\|------\\|------\\|\n","| PRODUCT_LIST | | | x | |\n","| STORE | x | x | x | x |\n","| CUSTOM_URL | | | x| | \n","| DETAIL_PAGE | | x | | | \n","| OFF_AMAZON_LINK | x | | | |\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`matchType`"},"path":"/en-us/reference/common-models/enums","content":[" Description: The type of matching that Amazon applies to the given target. Different match types are available based on the target type and ad product.\n","|Allowed values\t| Description | Sponsored Products\t|Sponsored Brands\t|Sponsored Display\t|\n","\\|------\\|-----\\|-----\\|-------\\|\n","|SEARCH_LOOSE_MATCH\t|Targets customers using search terms loosely related to your products. |QUERY_BROAD_REL_MATCHES\t|N/a\t|N/a\t|\n","|SEARCH_CLOSE_MATCH\t|Targets customers using search terms closely related to your products.| QUERY_HIGH_REL_MATCHES\t|N/a\t|N/a\t|\n","|PRODUCT_SUBSTITUTES\t|Targets customers who view detail pages of products similar to yours.| ASIN_SUBSTITUTE_RELATED\t|N/a\t|N/a\t|\n","|PRODUCT_COMPLEMENTS\t|Targets customers who view detail pages of products that complement your product.| ASIN_ACCESSORY_RELATED\t|N/a\t|N/a\t|\n","|PRODUCT_SIMILAR\t| Targets customers who view detail pages of products similar to yours.|N/a\t|N/a\t|similarProduct\t|\n","|SEARCH_RELATED_TO_YOUR_BRAND\t| A set of keywords that are often used to search for brands and promote brand impressions. |N/a\t|KEYWORDS_RELATED_TO_YOUR_BRAND\t|N/a\t|\n","|SEARCH_RELATED_TO_YOUR_LANDING_PAGES\t|A set of keywords that promote brand discovery and can help drive traffic to brand store page or product detail pages. |N/a\t|KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES\t|N/a\t|\n","|Allowed values\t| Description | Sponsored Products\t|Sponsored Brands\t|\n","\\|--------\\|-------\\|------\\|\n","|BROAD\t|Offers broad exposure to customer shopping queries. Search terms may include keyword terms in any order, and may also include singulars, plurals, variations, synonyms, and related terms. | BROAD\t|broad\t|\n","|PHRASE\t| For Sponsored Products, the search term must contain the exact phrase or sequence of words. This match type is more restrictive than broad match. Phrase match also includes the plural form of the keyword. In Sponsored Brands campaigns, this match type includes search terms matching the meaning of the keyword. |PHRASE\t|phrase\t|\n","|EXACT\t| The search term must exactly match the keyword or close variations of the keyword. The sequence of words must also match. This is the most restrictive keyword match type. |EXACT\t|exact\t|\n","|Allowed values\t|Sponsored Products\t|Sponsored Brands\t|Sponsored Display\t|\n","\\|--------\\|-------\\|-------\\|-------\\|\n","|PRODUCT_EXACT\t|ASIN_SAME_AS\t|asinSameAs\t|asinSameAs\t|\n","|PRODUCT_SIMILAR\t|ASIN_EXPANDED_FROM\t|N/a\t|N/a\t|\n","|Allowed values\t|Sponsored Display mapping\t|\n","\\|-------\\|-----\\|\n","|PRODUCT_EXACT\t|exactProduct\t|\n","|PRODUCT_SIMILAR\t|relatedProduct, similarProduct\t|\n","| Allowed values | Sponsored Products |\n","\\| --- \\| --- \\|\n","| KEYWORDS_RELATED_TO_YOUR_BRAND | brand | \n","| KEYWORDS_RELATED_TO_GIFTS | gift |\n","| KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY | category |\n"," Referenced by: Targets\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`placement`"},"path":"/en-us/reference/common-models/enums","content":[" Description: Refers to the placement where an ad appears.\n","| Values | Sponsored Products | Sponsored Brands |\n","\\|-----\\|-------\\|------\\|\n","| HOME_PAGE | | HOME | \n","| TOP_OF_SEARCH | PLACEMENT_TOP | |\n","| PRODUCT_PAGE | PLACEMENT_PRODUCT_PAGE | DETAIL_PAGE | \n","| REST_OF_SEARCH | REST_OF_SEARCH | |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`recurrenceTimePeriod` "},"path":"/en-us/reference/common-models/enums","content":[" Description: The possible recurrence options for a budget.\n","|Values|\n","\\|-----\\|\n","| DAILY |\n","| LIFETIME |\n","| OTHER |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`productIdType`"},"path":"/en-us/reference/common-models/enums","content":[" Description: The type of ID used to identify a product.\n","| Values |\n","\\|-------\\|\n","| ASIN |\n","| SKU |\n"," Referenced by: Ads\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`shopperCohortType`"},"path":"/en-us/reference/common-models/enums","content":[" Description: Specifies types of shopper cohort.\n","| Values                             |\n","\\|------------------------------------\\|\n","| AUDIENCE_SEGMENT |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`shopperSegment`"},"path":"/en-us/reference/common-models/enums","content":[" Description: Specifies types of shoppers. \n","| Values |\n","\\|----\\|\n","| NEW_TO_BRAND_PURCHASE |\n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`state`"},"path":"/en-us/reference/common-models/enums","content":[" Description: The user-chosen state of a campaign.\n","|Values|\n","\\|-----\\|\n","| ENABLED |\n","| PAUSED |\n","| ARCHIVED |\n","| OTHER |\n"," Referenced by: Campaigns, ad groups\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`targetingSettings`"},"path":"/en-us/reference/common-models/enums","content":[" Description: Used to indicate the type of targeting supported by the campaign.\n","|Values| Description |\n","\\|-----\\|------\\|\n","| MANUAL | Sponsored Products manual targeting.| \n","| AUTO |  Sponsored Products auto targeting. |\n","| T00020 | Sponsored Display contextual targeting. |\n","| T00030 | Sponsored Display audience targeting. | \n"," Referenced by: Campaigns\n"],"documentType":"guide"},{"title":"Amazon Ads API common enums","sectionHeader":{"type":3,"text":"`targetType`"},"path":"/en-us/reference/common-models/enums","content":[" Description: A target type defines the type of target criteria for inclusion or exclusion on the given ad group or campaign.\n","|Values|\n","\\|-----\\|\n","| AUTO | \n","| KEYWORD | \n","| PRODUCT_CATEGORY | \n","| PRODUCT | \n","| PRODUCT_CATEGORY_AUDIENCE | \n","| PRODUCT_AUDIENCE |\n","| AUDIENCE | \n"],"documentType":"guide"},{"title":"Amazon Ads API v1 overview","sectionHeader":null,"path":"/en-us/reference/amazon-ads/overview","content":[" The Amazon Ads API v1 represents a reimagined approach to the Ads API, built from the ground up with consistency and efficiency in mind. The new API provides a seamless experience across all Amazon advertising products through a common model. This common model introduces standard concepts and naming and consistent API behavior across Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored Television, and Amazon DSP.\n"," If you are just starting out using Amazon Ads APIs, we highly recommend using these v1 APIs. They will eventually fully replace the ad product-specific APIs.\n"],"documentType":"release-note"},{"title":"Amazon Ads API v1 overview","sectionHeader":{"type":2,"text":"Key benefits"},"path":"/en-us/reference/amazon-ads/overview","content":["Consistent experience: Common field names, error handling, and resource patterns across all advertising products  Reduced development effort: Significantly less code duplication when implementing features across multiple ad products  Single integration: Integrate once and access multiple ad products (Sponsored Products, Sponsored Brands, Sponsored Display, etc.) through a consistent API interface  Future-ready: New features and ad products will be built into this consistent framework  Predictable updates: Clear versioning strategy, support windows, and deprecation timelines for major versions\n"],"documentType":"release-note"},{"title":"Amazon Ads API v1 overview","sectionHeader":{"type":2,"text":"Vision"},"path":"/en-us/reference/amazon-ads/overview","content":[" The Amazon Ads API v1 establishes the foundation for all future Amazon Ads API development. The vision includes:\n","Building all new features and capabilities into the common model  Expanding the common model across all advertising products  Maintaining predictable release cycles and deprecation schedules \\* Providing a seamless upgrade path for developers\n"],"documentType":"release-note"},{"title":"Amazon Ads API v1 overview","sectionHeader":{"type":2,"text":"Developer experience"},"path":"/en-us/reference/amazon-ads/overview","content":[" This new API structure is designed to make the development process more efficient:\n","Consistent error codes and messaging across products  Simplified documentation and implementation guides  Reusable code patterns across different ad products  Reduced time to market for new feature adoption  Consistent OAS file and namespacing that makes for easy generation or integration into a client\n"],"documentType":"release-note"},{"title":"Amazon Ads API v1 overview","sectionHeader":{"type":2,"text":"General availability and beta releases"},"path":"/en-us/reference/amazon-ads/overview","content":[" For v1 APIs in beta, see Betas. APIs that have been released will be visible in the v1 API spec.\n"," For news on feature expansions and other updates, see API v1 release notes.\n"],"documentType":"release-note"},{"title":"Amazon Ads API v1 overview","sectionHeader":{"type":2,"text":"Future vision"},"path":"/en-us/reference/amazon-ads/overview","content":[" The long-term vision for the Ads API v1 is to continue expanding the coverage of Amazon advertising products and features. We plan to generate all APIs in the Ads API v1 from a common domain model, ensuring consistent data representations and functionality across ad products. This will enable us to quickly add new ad products and features to the Ads API v1 while maintaining a consistent developer experience.\n"," Some of the key areas we expect to expand in the future include support for:\n","reporting - recommendations - rules  - media planning\n"],"documentType":"release-note"},{"title":"Getting started with Amazon Ads API v1","sectionHeader":null,"path":"/en-us/reference/amazon-ads/getting-started","content":[],"documentType":"release-note"},{"title":"Getting started with Amazon Ads API v1","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/reference/amazon-ads/getting-started","content":[" All clients who have completed onboarding to the Amazon Ads API are permitted to call the Ads API v1 generally.\n"],"documentType":"release-note"},{"title":"Getting started with Amazon Ads API v1","sectionHeader":{"type":2,"text":"Required headers"},"path":"/en-us/reference/amazon-ads/getting-started","content":[" Just as for other Amazon Ads APIs, Ads API v1 requests must provide Amazon-Ads-ClientId and Authorization headers to authorize calls. Learn more about authorization using Login With Amazon.\n"," Additional headers may be required for requests, depending on the functionality and ad product:\n","Amazon-Advertising-API-Scope: Required for most sponsored ads requests. Use the Profiles API to retrieve the profile ID of the desired advertiser and marketplace to use as the value for this header for your Sponsored Ads Seller or Vendor. You can also retrieve profile ID information from the Manager Accounts API for Sponsored Ads Seller and Vendor accounts. - Amazon-Ads-AccountId: Required for ADSP and cross-product requests. - Amazon-Ads-Manager-AccountId: Manager account ID for manager account operations\n"],"documentType":"release-note"},{"title":"Getting started with Amazon Ads API v1","sectionHeader":{"type":2,"text":"Understanding advertising accounts"},"path":"/en-us/reference/amazon-ads/getting-started","content":[" Amazon Ads API v1 uses a unified account model that works across headers and request body fields:\n"],"documentType":"release-note"},{"title":"Getting started with Amazon Ads API v1","sectionHeader":{"type":3,"text":"Account types and relationships"},"path":"/en-us/reference/amazon-ads/getting-started","content":["Advertising Account: The primary account entity that contains campaigns and data across all ad products - Profile ID: Identifier used for sponsored ads operations (Amazon-Advertising-API-Scope header) - Account ID: Identifier used for cross-product operations (Amazon-Ads-AccountId header)\n"],"documentType":"release-note"},{"title":"Getting started with Amazon Ads API v1","sectionHeader":{"type":3,"text":"Header vs. body field usage"},"path":"/en-us/reference/amazon-ads/getting-started","content":["Headers: Use appropriate account identifiers for account-scoped operations - Body fields: Use advertiserAccount.id in request bodies to specify the account data to retrieve or modify - Access requested accounts: Use the accessRequested field to specify which accounts you want to access in multi-account scenarios\n"],"documentType":"release-note"},{"title":"Getting started with Amazon Ads API v1","sectionHeader":{"type":2,"text":"OpenAPI specification interface"},"path":"/en-us/reference/amazon-ads/getting-started","content":[" The Amazon Ads API v1 OpenAPI specification is presented in an enhanced interface featuring a new ad product selection control for select APIs (for example, campaign management).\n"," By default, the page displays a specification common to all ad products, including all available attributes. With any ad product selected, the page displays a specification specific to that ad product, including only those attributes that apply to the given entity for that ad product. These ad product-specific specifications display what is needed for the business rules and validations of a specific ad product.\n"," Similarly, the Download OpenAPI spec link in the description adjusts depending on whether an ad product is selected.\n"],"documentType":"release-note"},{"title":"Getting started with Amazon Ads API v1","sectionHeader":{"type":2,"text":"Implementation recommendations"},"path":"/en-us/reference/amazon-ads/getting-started","content":[],"documentType":"release-note"},{"title":"Getting started with Amazon Ads API v1","sectionHeader":{"type":3,"text":"Test accounts"},"path":"/en-us/reference/amazon-ads/getting-started","content":[],"documentType":"release-note"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":null,"path":"/en-us/guides/get-started/generate-sdk","content":[],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/guides/get-started/generate-sdk","content":[" The Amazon Ads API v1 represents a reimagined approach to the Amazon Ads API, built from the ground up to provide a seamless experience across all Amazon advertising products through a common model. One major benefit of this common model is improved compatibility with code generation tools such as client library generators.\n"," The following walkthrough uses OpenAPI Generator to create a client library for campaign management from the Ads API v1 specifications.\n"],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/get-started/generate-sdk","content":[],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":3,"text":"Authentication and authorization"},"path":"/en-us/guides/get-started/generate-sdk","content":[" This walkthrough requires that you have already onboarded to the Amazon Ads API as described in our onboarding overview. This enables you to retrieve your client ID and client secret, which are required for the client application described below.\n"," You should also have retrieved an access token, refresh token, and a profile ID as described in our \"getting started\" overview. The refresh token and profile ID are required for the client application described below.\n"],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":3,"text":"Node"},"path":"/en-us/guides/get-started/generate-sdk","content":[" The example code below is configured to use Node 24 in your development environment. Adjustments are required to use earlier versions of Node.\n"],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":3,"text":"Java"},"path":"/en-us/guides/get-started/generate-sdk","content":[" The openapi-generator-cli NPM package is a wrapper around the OpenAPI Generator core, which is a Java project. The generator requires the java executable to be available in your PATH at a minimum version of JDK 11. For more information on Java as a prerequisite, see the documentation for the openapi-generator-cli package.\n"],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":2,"text":"Steps"},"path":"/en-us/guides/get-started/generate-sdk","content":[],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":3,"text":"1. Set up the workspace"},"path":"/en-us/guides/get-started/generate-sdk","content":[" First, create a workspace directory for this demo. \n"," The commands above create a workspace with the following structure:\n"," The amazon-ads-library-demo directory will include the necessary input and processing scripts to generate a client library from the Amazon Ads API OpenAPI specification. The amazon-ads-client-demo directory will contain a demonstration client that uses your generated client library.\n"," Optionally, you can create a package.json in this workspace to add scripts that build each package or the workspace as a whole. This is not required for the steps below.\n"],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":3,"text":"2. Set up the client library package"},"path":"/en-us/guides/get-started/generate-sdk","content":[" First, initialize the client library directory as an NPM package, then create two required subdirectories.\n"," The specifications for Ads API v1 can be downloaded as JSON using the Download Amazon Ads API V1 OpenAPI Spec link in the description of any API Specification on the Amazon Ads API V1 Reference page.\n"," Alternatively, you can download the common specification and the product-specific specifications directly using the following links:\n","Common specification (AmazonAdsAPIALLMerged_prod_3p.json) - Sponsored Products specification (AmazonAdsAPISPMerged_prod_3p.json) - Sponsored Brands specification (AmazonAdsAPISBMerged_prod_3p.json) - Amazon DSP specification (AmazonAdsAPIDSPMerged_prod_3p.json) - Sponsored Display specification (AmazonAdsAPISDMerged_prod_3p.json) - Sponsored Television specification (AmazonAdsAPISTMerged_prod_3p.json)\n"," Add these files to the /input directory. Your file tree should resemble the following:\n"," Given the downloaded OAS files found in /input, this script will prune the contracts (i.e., scrub polymorphism, remove auth header parameters) and output a singular client library in the /generated directory. \n"," The unified models will be found directly under /v1, while the ad product-specific models will each be found in a subdirectory one level below /v1 (i.e. /v1/sp).\n"," Replace the content of the existing amazon-ads-library-demo/package.json with the following:\n"," Create amazon-ads-library-demo/tsconfig.json and add the following configurations:\n"," Before the first time you generate the client library, install the dependencies specified in package.json and create a link to make the built client library available to the client package locally by running the following commands:\n"," To generate the client library, either for the first time or to incorporate any updates to the OAS inputs, run:\n"],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":3,"text":"3. Set up the client package"},"path":"/en-us/guides/get-started/generate-sdk","content":[" First, initialize the client directory as an NPM package, then create the required subdirectory and a local link to the client library package.\n"," As discussed in Prerequisites above, your client application requires credentials to make a successful request to the API. Replace the values for the exported constant variables in the code below with your client ID, client secret, refresh token, and profile ID, then add this code to a new file in the src directory called auth_config.ts:\n"," Next, create a client application in the src directory called client.ts that uses the generated client library, along with the auth script above, to test several operations:\n","use the common CampaignCreate model to create a Sponsored Products campaign - use the SBCampaignCreate model to create a Sponsored Brands campaign - use the SPCampaignCreate model to create a Sponsored Products campaign\n"," Replace the content of the existing amazon-ads-client-demo/package.json with the following:\n"," Create amazon-ads-client-demo/tsconfig.json and add the following configurations:\n"," Before the first time you build the client, install the dependencies specified in package.json:\n"," To build the client application, either the first time or to incorporate any updates, run:\n"," To test the client, run:\n"],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":3,"text":"4. Response"},"path":"/en-us/guides/get-started/generate-sdk","content":[" Each operation in the demo client logs the response to the console. A successful response should produce output similar to the following:\n"],"documentType":"guide"},{"title":"Generating a client library from Amazon Ads API v1 specifications","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/get-started/generate-sdk","content":[" For each OpenAPI specification input, the generated client library exports an object containing both the appropriate models and a set of API classes corresponding to resources in the specification. Each API class includes methods corresponding to available operations in the API.\n"," For instance, in the example client, an instance of v1.CampaignsApi is created, then the v1.CampaignCreate model is used to supply an argument to the .createCampaign method. Similar models and methods are available for each resource included in the OpenAPI specification -- for example, an instance of v1.AdGroupsApi will include the .createAdGroup method. For each resource, additional methods are available to carry out other operations in the API, such as query, update, or delete requests.\n"],"documentType":"guide"},{"title":"Amazon Ads API v0 overview","sectionHeader":null,"path":"/en-us/reference/v0-overview","content":[" This section contains API references for the Amazon Ads API v0 (legacy) APIs. These are product-specific APIs that predate the Amazon Ads API v1 domain model.\n"],"documentType":"guide"},{"title":"Amazon Ads API v0 overview","sectionHeader":{"type":2,"text":"When to use v0 APIs"},"path":"/en-us/reference/v0-overview","content":[" Use v0 APIs only when the functionality you need is not yet available in the Amazon Ads API v1. All v0 APIs are on the path to deprecation and are not recommended for new integrations unless they provide functionality not yet available in v1.\n"],"documentType":"guide"},{"title":"Amazon Ads API v0 overview","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/reference/v0-overview","content":[],"documentType":"guide"},{"title":"Amazon DSP campaign management API overview","sectionHeader":null,"path":"/en-us/reference/dsp/dsp-campaign-management-overview","content":[" The new Amazon DSP campaign management APIs enable self-serve advertisers to programmatically manage their Amazon DSP campaign data (campaigns, ad groups, targeting). Use cases include:\n","Tracking campaigns in your own tools: Sync campaign metadata with your own data storage solution and then surface the data in a custom UI to track all of your campaigns.  Simplifying campaign creation: Build templates or custom workflows that reduce the time it takes to create a new campaign.  Automating campaign optimization: Automatically adjust bids and budgets in real-time to maximize campaign performance. \\* Targeting: Target specific inventory and audiences, add domain exclusions, and easily add or remove targets to maximize campaign performance.\n"],"documentType":"guide"},{"title":"Stores","sectionHeader":null,"path":"/en-us/reference/2/stores","content":[" Use this interface to request and retrieve store information. This can be used for Sponsored Brands campaign creation,  to pull the store URL information, and for asset registration for Stores.\n","| Method | URL | Use case |\n","\\| --- \\| --- \\| --- \\|\n","| GET | /v2/stores | List store information for all registered stores under an advertiser. |\n"],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":2,"text":"Operations"},"path":"/en-us/reference/2/stores","content":[],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":3,"text":"listStores"},"path":"/en-us/reference/2/stores","content":[" Retrieves a list of stores for a given advertiser.\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 200 - success | List of StoreInfoResponse |\n","| 401 - unauthorized | Error |\n","| 404 - campaign not found | Error |\n"],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":2,"text":"Resource representations"},"path":"/en-us/reference/2/stores","content":[],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":3,"text":"StorePageInfo"},"path":"/en-us/reference/2/stores","content":[],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":3,"text":"StoreInfoResponse"},"path":"/en-us/reference/2/stores","content":[],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":3,"text":"Error"},"path":"/en-us/reference/2/stores","content":[],"documentType":"guide"},{"title":"Amazon Ads API v0 overview","sectionHeader":null,"path":"/en-us/reference/v0-overview","content":[" This section contains API references for the Amazon Ads API v0 (legacy) APIs. These are product-specific APIs that predate the Amazon Ads API v1 domain model.\n"],"documentType":"guide"},{"title":"Amazon Ads API v0 overview","sectionHeader":{"type":2,"text":"When to use v0 APIs"},"path":"/en-us/reference/v0-overview","content":[" Use v0 APIs only when the functionality you need is not yet available in the Amazon Ads API v1. All v0 APIs are on the path to deprecation and are not recommended for new integrations unless they provide functionality not yet available in v1.\n"],"documentType":"guide"},{"title":"Amazon Ads API v0 overview","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/reference/v0-overview","content":[],"documentType":"guide"},{"title":"Amazon DSP campaign management API overview","sectionHeader":null,"path":"/en-us/reference/dsp/dsp-campaign-management-overview","content":[" The new Amazon DSP campaign management APIs enable self-serve advertisers to programmatically manage their Amazon DSP campaign data (campaigns, ad groups, targeting). Use cases include:\n","Tracking campaigns in your own tools: Sync campaign metadata with your own data storage solution and then surface the data in a custom UI to track all of your campaigns.  Simplifying campaign creation: Build templates or custom workflows that reduce the time it takes to create a new campaign.  Automating campaign optimization: Automatically adjust bids and budgets in real-time to maximize campaign performance. \\* Targeting: Target specific inventory and audiences, add domain exclusions, and easily add or remove targets to maximize campaign performance.\n"],"documentType":"guide"},{"title":"Stores","sectionHeader":null,"path":"/en-us/reference/2/stores","content":[" Use this interface to request and retrieve store information. This can be used for Sponsored Brands campaign creation,  to pull the store URL information, and for asset registration for Stores.\n","| Method | URL | Use case |\n","\\| --- \\| --- \\| --- \\|\n","| GET | /v2/stores | List store information for all registered stores under an advertiser. |\n"],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":2,"text":"Operations"},"path":"/en-us/reference/2/stores","content":[],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":3,"text":"listStores"},"path":"/en-us/reference/2/stores","content":[" Retrieves a list of stores for a given advertiser.\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 200 - success | List of StoreInfoResponse |\n","| 401 - unauthorized | Error |\n","| 404 - campaign not found | Error |\n"],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":2,"text":"Resource representations"},"path":"/en-us/reference/2/stores","content":[],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":3,"text":"StorePageInfo"},"path":"/en-us/reference/2/stores","content":[],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":3,"text":"StoreInfoResponse"},"path":"/en-us/reference/2/stores","content":[],"documentType":"guide"},{"title":"Stores","sectionHeader":{"type":3,"text":"Error"},"path":"/en-us/reference/2/stores","content":[],"documentType":"guide"},{"title":"Deprecations overview","sectionHeader":null,"path":"/en-us/reference/deprecations","content":[" This section contains API references for Amazon Ads APIs that have been deprecated or shut off. These APIs are no longer recommended for use and will be removed in the future.\n"],"documentType":"guide"},{"title":"Deprecations overview","sectionHeader":{"type":2,"text":"Migration guidance"},"path":"/en-us/reference/deprecations","content":[" If you are currently using a deprecated API, migrate to the recommended replacement as soon as possible. See the individual API pages for specific migration guidance and shutdown dates.\n"],"documentType":"guide"},{"title":"Deprecations overview","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/reference/deprecations","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":null,"path":"/en-us/reference/1/profiles","content":[" Marketplaces include associated properties that are specific to the region-- for example, countryCode, currencyCode, or timezone. These properties dictate the behavior of the Advertising API such as scheduling, budget, and billing. For this reason, Advertisers with accounts associated with more than one marketplace (for example: Amazon.com, Amazon.co.uk, Amazon.co.jp) will have only one profile associated with each marketplace. Each profile must be associated with a unique Login with Amazon account. Each Login with Amazon account requires a unique email address. When generating API authentication tokens you must use the correct profile for the international marketplace where you manage your campaigns\n"," Authentication tokens are used to obtain all the profiles associated with the advertiser. The profile ID is passed in the header for calls to the API. Reports and all entity management operations are associated with a single profile. Advertisers cannot have more than one profile for each marketplace.\n"," Profiles are associated with a unique Profile ID. A management scope is required in the header for all API calls. Use your Profile ID as the value for the management scope (Amazon-Advertising-API-Scope) in the header. To retrieve your profile ID, make a call to list profiles associated with the access token you are using.\n"," The following methods are used to read and update profiles. The following table describes the service behavior in terms of the URL space and HTTP methods supported by the service-managed resources.\n","| Method | URL                   | Use Case                                              |\n","\\|--------\\|-----------------------\\|-------------------------------------------------------\\|\n","| GET    | /profiles             | Retrieve all profiles associated with the auth token. |\n","| GET    | /profiles/{profileId} | Retrieve a profile by ID                              |\n","| PUT    | /profiles/            | Update one or more profiles                           |\n"," Use the exact text and format in the 'Time zone' column to designate the correct time zone.\n","| Region | Time zone |\n","\\| --- \\| --- \\|\n","| US | America/Los_Angeles |\n","| CA | America/Los_Angeles |\n","| UK | Europe/London |\n","| DE | Europe/Paris |\n","| FR | Europe/Paris |\n","| ES | Europe/Paris |\n","| IT | Europe/Paris |\n","| JP | Asia/Tokyo |\n","| AU | Australia/Sydney |\n","| AE | Asia/Dubai |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Operations"},"path":"/en-us/reference/1/profiles","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"listProfiles"},"path":"/en-us/reference/1/profiles","content":[" Retrieves profiles associated with an auth token.\n"," None\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 200 - success | List of Profile  |\n","| 401 - unauthorized | Error |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"getProfile"},"path":"/en-us/reference/1/profiles","content":[" Retrieves a single profile specified by identifier.\n","| Parameter Name | Type | Description |\n","\\| --- \\| --- \\| --- \\|\n","| profileId | string | The profile identifier. |\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 200 - success | List of Profile  |\n","| 401 - unauthorized | Error |\n","| 404 - profile not found | Error |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"updateProfiles"},"path":"/en-us/reference/1/profiles","content":[" Updates one or more profiles. Advertisers are identified using their profileId.\n","| Type | Specified In | Description |\n","\\| --- \\| --- \\| --- \\|\n","| List of Profile  | body | A list of updates containing profile IDs and the mutable fields to be modified. Mutable fields: dailyBudget |\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 207 - multi-response | List of ProfileResponse reflecting the same order as the input |\n","| 401 - unauthorized | Error |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"registerProfile"},"path":"/en-us/reference/1/profiles","content":[" Registers a profile in sandbox. If this call is made to a production endpoint you will receive an error.\n","| Type | Specified In | Description |\n","\\| --- \\| --- \\| --- \\|\n","| countryCode | Body | The country in which you wish to register the profile. Can be one of: US, CA, UK, DE, FR, ES, IT, JP, AU, AE |\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 200 - Success | Profile registration succeeded. |\n","| 401 - Unauthorized | Error |\n","| 404 - Not Found | Error. This will be returned if making the call to a production endpoint. |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"registerBrand"},"path":"/en-us/reference/1/profiles","content":[" Registers a brand in sandbox. If this call is made to a production endpoint you will receive an error.\n","| Type | Specified In | Description |\n","\\| --- \\| --- \\| --- \\|\n","| countryCode | Body | The country in which you wish to register the profile. Can be one of: US, CA, UK, DE, FR, IT, ES, JP, AU, AE |\n","| brand | Body | REQUIRED. Brand name. |\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 200 - Success | Profile registration succeeded. |\n","| 401 - Unauthorized | Error |\n","| 404 - Not Found | Error. This will be returned if making the call to a production endpoint. |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Resource representations"},"path":"/en-us/reference/1/profiles","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"Profile"},"path":"/en-us/reference/1/profiles","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"ProfileResponse"},"path":"/en-us/reference/1/profiles","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"Error"},"path":"/en-us/reference/1/profiles","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":null,"path":"/en-us/reference/1/suggested-keywords","content":[" Note: See the complete list of valid keyword characters and constraints in the Limits section.\n"," Used to request suggested keywords at the ad group and ASIN levels. Suggested keywords are ordered by most effective to least.\n","| Method | URL | Use Case  |\n","\\|--------\\|-----\\|-----------\\|\n","| GET    | /adGroups/{adGroupId}/suggested/keywords | Request suggested keywords for specified ad group |\n","| GET    | /adGroups/{adGroupId}/suggested/keywords/extended | Provides suggested keywords for Ad Group. Returns additional fields: campaignId, adGroupId, and state (of the ad) with each suggested keyword |\n","| GET    | /asins/{asinValue}/suggested/keywords | Provides suggested keywords for specified ASIN |\n","| POST   | /asins/suggested/keywords | Provides suggested keywords for specified list of ASINs |\n"],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":2,"text":"Operations"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"getAdGroupSuggestedKeywords"},"path":"/en-us/reference/1/suggested-keywords","content":[" Retrieve suggested keyword data for the specified adGroupId\n","| Parameter Name    | Type   | Specified In | Description |\n","\\|-------------------\\|--------\\|--------------\\|-------------\\|\n","| adGroupId         | number | URL path     | The ID of the requested ad group |\n","| maxNumSuggestions | number | URL query    | Maximum number of returned suggested keywords. Default is 100, maximum is 1000 |\n","| adStateFilter     | string | URL query    | Ad state filter (values are comma separated), to filter out the Ads to get suggested keywords for their ASINs. Valid values are: enabled, paused, and archived. Default values are enabled and paused |\n","| Status Code   | Response object                               |\n","\\|---------------\\|-----------------------------------------------\\|\n","| 200 - Success | Suggested keywords for specified adGroupId    |\n","| 400 – Error   | No Ad Group was found for specified adGroupId |\n","| 404 – Error   | One or more incorrect URL query parameters      |\n"],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"getAdGroupSuggestedKeywordsEx"},"path":"/en-us/reference/1/suggested-keywords","content":[" Retrieve extended suggested keyword data for the specified adGroupId\n","| Parameter Name    | Type   | Specified In | Description |\n","\\|-------------------\\|--------\\|--------------\\|-------------\\|\n","| adGroupId         | number | URL path     | The ID of the requested ad group |\n","| maxNumSuggestions | number | URL query    | Maximum expected number of suggested keywords. Default is 100, maximum is 1000 |\n","| suggestBids       | string | URL query    | Valid values are yes and no. Default value is no. If yes, any suggested keywords can contain the extra bid field, where bid will be populated by calculated suggested bid.  Note: The bid field will be missing if there are no suggested bids for the keyword |\n","| adStateFilter     | string | URL query    | Ad state filter (values are comma separated) to filter out the ads to get suggested keywords for their ASINs. Valid values are: enabled, paused, and archived. Default values are enabled and paused |\n","| Status Code     | Response object                                     |\n","\\|-----------------\\|-----------------------------------------------------\\|\n","| 200 - Success   | Extended suggested keywords for specified adGroupId |\n","| 404 – Not Found | No Ad Group was found for specified adGroupId       |\n","| 400 – Error     | One or more incorrect URL query parameters            |\n"],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"getAsinSuggestedKeywords"},"path":"/en-us/reference/1/suggested-keywords","content":[" Provides suggested keywords for specified ASIN. Suggested keywords are ordered by most effective to least effective.\n","| Parameter Name    | Type   | Specified In | Description                                                                    |\n","\\|-------------------\\|--------\\|--------------\\|--------------------------------------------------------------------------------\\|\n","| asinValue         | string | URL path     | ASIN                                                                           |\n","| maxNumSuggestions | number | URL query    | Maximum number of returned suggested keywords. Default is 100, maximum is 1000 |\n","| Status Code   | Response object                                          |\n","\\|---------------\\|----------------------------------------------------------\\|\n","| 200 – Success | Suggested keywords for specified asinValue               |\n","| 400 – Error   | One or more incorrect URL query parameters or incorrect ASIN |\n"],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"bulkGetAsinSuggestedKeywords"},"path":"/en-us/reference/1/suggested-keywords","content":[" Provides keyword suggestions for specified list of ASINs. Suggested keywords are ordered by most effective to least effective.\n","| Parameter name    | Type            | Specified in | Description                                                                    |\n","\\|-------------------\\|-----------------\\|--------------\\|--------------------------------------------------------------------------------\\|\n","| asins            | List of strings | body         | List of ASINs for which keywords are suggested                                 |\n","| maxNumSuggestions | Number          | body         | Maximum number of returned suggested keywords. Default is 100, maximum is 1000 |\n","| Status Code   | Response object                                          |\n","\\|---------------\\|----------------------------------------------------------\\|\n","| 200 – Success | Suggested keywords for specified list of ASINs           |\n","| 400 – Error   | One or more incorrect URL query parameters or incorrect ASIN |\n"],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":2,"text":"Resource representations"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"AdGroupSuggestedKeywordsResponse"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"GetAdGroupSuggestedKeywordsExResponse"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"GetAsinSuggestedKeywordsResponse"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"BulkGetAsinSuggestedKeywordsResponse"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"Error"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Bid controls","sectionHeader":null,"path":"/en-us/reference/1/bid-controls","content":[],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Using bid controls in the sandbox environment"},"path":"/en-us/reference/1/bid-controls","content":[" Bid controls feature is not enabled by default in the sandbox. There is an additional requirement to add a header with API calls using bid controls in the sandbox. The bid controls header does not follow the standard syntax of other headers. The acceptable values for the header that will activate bid controls are: true or yes. If your header contains other values besides true or yes, your request will still be accepted, but bid controls feature will remain deactivated.\n"],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Bidding strategies"},"path":"/en-us/reference/1/bid-controls","content":[" There are three bidding strategies available to you at the campaign level.\n","| Attribute name | Strategy name | Description |\n","\\| --- \\| --- \\| --- \\|\n","| legacyForSales | Adjust bidding (down only) | Lowers your bids in real time when your ad may be less likely to convert to a sale. Any campaign created before October 2018 uses this setting by default. |\n","| autoForSales | Adjust bidding (up and down) | Increases your bids (by a maximum of 100%) in real time when your ad may be more likely to convert to a sale, and lowers your bids when less likely to convert to a sale. |\n","| manual | Fixed bid | Uses your exact bid and any manual adjustments you set, and is not subject to adjusted bidding. |\n"],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Bid adjustments by placement"},"path":"/en-us/reference/1/bid-controls","content":[" You can enable controls to adjust your bid based on the placement location. Specify a location where you want to use bid controls. The percentage value set is the percentage of the original bid for which you want to have your bid adjustment increased. For example, a 50% adjustment on a $1.00 bid would increase the bid to $1.50 for the opportunity to win a specified placement.\n","| Predicate | Placement | Percentage increase range |\n","\\| --- \\| --- \\|\n","| placementTop | Top of search page | 0 - 900% |\n","| placementProductPage | On a product page | 0 - 900% |\n"],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Methods"},"path":"/en-us/reference/1/bid-controls","content":["| Method | URL | Use Case |\n","\\| --- \\| --- \\| --- \\|\n","| GET | /v1/sp/campaigns/{campaignId} | Retrieve a campaign by ID |\n","| GET | /v1/sp/campaigns | Retrieve a list of campaigns |\n","| PUT | /v1/sp/campaigns &lt;campaign_obj_json> | Update bid controls for a list of campaigns with the values included in the campaign_obj_json |\n","| POST | /v1/sp/campaigns | Create new bid controls for a list of campaigns with the values included in the campaign_obj_json |\n"],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Resource representation"},"path":"/en-us/reference/1/bid-controls","content":[],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":3,"text":"Campaign"},"path":"/en-us/reference/1/bid-controls","content":[],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Bid controls and premium bid adjustments (Bid+)"},"path":"/en-us/reference/1/bid-controls","content":[" Bid controls replaces premium bid adjustments (also known as Bid+). Premium bid adjustments feature will be deprecated in the future. While Bid+ is still an active feature, it is important to note that you cannot use Bid+ together with bidding controls. Existing campaigns using Bid+ will be converted to the bidding strategy: Legacy for sales (down only) with a 50% adjustment for the top-of-search placement. \n"],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Reports and exports"},"path":"/en-us/reference/1/bid-controls","content":[],"documentType":"guide"},{"title":"Reports","sectionHeader":null,"path":"/en-us/reference/1/reports","content":[" Use the requestReport operation to retrieve performance reports. There are multiple ways to retrieve your campaign data, and using reports may not always be the most efficient way. If you are trying to download a record of your campaign structure and all of its entities (like AdGroups, keywords, productAds), we recommended that you run a snapshot of your entities instead of requesting a list of all elements in the campaign. For more information, see snapshots.\n"," Note: When generating a report (POST), there are separate endpoints for ad types Sponsored Products and Sponsored Brands reports. These endpoints are specified at the beginning of each section. When retrieving the report ID and downloading the report (GET), it is not necessary to differentiate the endpoints based on the ad type.\n"," The following table describes the service behavior in terms of the URL space and HTTP methods supported by the service-managed resources.\n","| Method | URL                  | Use Case                                                                                             |\n","\\|--------\\|----------------------\\|------------------------------------------------------------------------------------------------------\\|\n","| POST   | /{recordType}/report | Request the creation of a performance report for all entities of a single type which have performance data to report. |\n","| GET    | /reports/{reportId}  | Retrieve status, metadata and location of a previously requested performance report.                 |\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Operations"},"path":"/en-us/reference/1/reports","content":[],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"requestReport"},"path":"/en-us/reference/1/reports","content":["| Parameter Name | Type   | Specified In | Description |\n","\\|----------------\\|--------\\|--------------\\|-------------\\|\n","| recordType     | string | URL          | The type of entity for which the report should be generated. This must be one of: campaigns, adGroups, keywords, productAds, or asins |\n","| campaignType   | string | POST body    | The type of campaign for which performance data should be generated. Must be: sponsoredProducts or headlineSearch|\n","| segment        | string | POST body    | Optional. Dimension on which to segment the report. If specified, must be query for keyword report or placement for campaigns report. |\n","| reportDate     | string | POST body    | The date for which to retrieve the performance report in YYYYMMDD format. The time zone is specified by the profile used to request the report. If this date is today, then the performance report may contain partial information. Reports are not available for data older than 60 days. For details on data latency, see the Service Guarantees in the developer notes section. |\n","| metrics        | string | POST body    | A comma-separated list of the metrics to be included in the report.|\n","| Status Code                | Response object                                             |\n","\\|----------------------------\\|-------------------------------------------------------------\\|\n","| 202 - success              | ReportResponse                                              |\n","| 401 - unauthorized         | Error                                                       |\n","| 406 – not acceptable       | Error (failed due to report date being too far in the past) |\n","| 422 - unprocessable entity | Error (failed due to incorrect parameters)                    |\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"getReport"},"path":"/en-us/reference/1/reports","content":[" Retrieve a previously requested report identified by the reportId.\n","| Parameter Name | Type   | Specified In | Description                    |\n","\\|----------------\\|--------\\|--------------\\|--------------------------------\\|\n","| reportId       | number | URL path     | The ID of the requested report |\n","| Status Code            | Response object |\n","\\|------------------------\\|-----------------\\|\n","| 200 - success          | ReportResponse     |\n","| 401 - unauthorized     | Error           |\n","| 404 - report not found | Error           |\n","| 404 - not found server | Error           |\n"," The ReportResponse will contain report status. When the report has completed, the location field will provide a redirect URL for the gzipped file containing the report. See downloading reports for more details.\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Valid report requests"},"path":"/en-us/reference/1/reports","content":[" Report requests will return a 422 if the parameters specified are unrecognized or if the combination of parameters is not supported. In particular, the choice of recordType may restrict the use of certain segments. Query segmentation can only be used in combination with keyword reports.\n"," If you are receiving '404 - Not Found Server' errors, check that you have the input the entityType endpoint correctly. Must be one of: campaigns, adGroups, keywords, asins, or productAds\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Resource representations"},"path":"/en-us/reference/1/reports","content":[],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"ReportResponse"},"path":"/en-us/reference/1/reports","content":[],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Error"},"path":"/en-us/reference/1/reports","content":[" See error object return format as described in Developer notes.\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Report file format"},"path":"/en-us/reference/1/reports","content":[" The report file contains one row per entity for which performance data is present. These records are represented as JSON containing the ID attribute corresponding to the recordType, the segment (if specified), and each of the metrics in the request.\n"," For example, a report requested with the following call:\n"," Would have a report that looks something like this:\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Downloading reports"},"path":"/en-us/reference/1/reports","content":[" When reports have completed, the location field will provide a URI for the download action against the generated report. Note that requests against this URI require authentication, so the authorization header must be passed. The response to these requests will not contain a body and will return a 307 redirect with the location header populated with an S3 file location. The resulting file location is short lived (expires in 30 seconds). If this time elapses before a client is able to begin downloading the file, the client may make another request against the download action URI.\n"," Note that the report file in S3 is gzipped.\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Report metrics"},"path":"/en-us/reference/1/reports","content":[" The following tables summarize report metrics which can be requested via the Reports interface. Different report types can use different metrics.\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Campaigns reports"},"path":"/en-us/reference/1/reports","content":[" These metrics can be used to request reports of type: campaigns\n","| Metric | Details |\n","\\|---------------------------------\\|---------------\\|\n","| bidPlus  | A dimensional metric. See premium bid adjustment in the developer notes. |\n","| campaignName| Unique name of the campaign |\n","| campaignId  | Unique numerical ID of the campaign  |\n","| campaignStatus   | Status of the campaign  |\n","| campaignBudget| Total budget allotted to the campaign  |\n","| impressions  | Total ad impressions.  |\n","| clicks  | Total ad clicks.  |\n","| cost| Total cost of all clicks. Can be divided by clicks to obtain average CPC. |\n","| attributedConversions1d | Number of attributed conversion events occurring within 1 day of click on ad. |\n","| attributedConversions7d | Number of attributed conversion events occurring within 7 days of click on ad. |\n","| attributedConversions14d| Number of attributed conversion events occurring within 14 days of click on ad. |\n","| attributedConversions30d | Number of attributed conversion events occurring within 30 days of click on ad. |\n","| attributedConversions1dSameSKU  | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised.   |\n","| attributedConversions7dSameSKU  | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised.  |\n","| attributedConversions14dSameSKU | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions30dSameSKU | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedUnitsOrdered1d  | Number of attributed units ordered within 1 day of click on ad.   |\n","| attributedUnitsOrdered7d  | Number of attributed units ordered within 7 days of click on ad.   |\n","| attributedUnitsOrdered14d  | Number of attributed units ordered within 14 days of click on ad.   |\n","| attributedUnitsOrdered30d  | Number of attributed units ordered within 30 days of click on ad.   |\n","| attributedSales1d  | Number of attributed sales occurring within 1 day of click on ad.|\n","| attributedSales7d | Number of attributed sales occurring within 7 days of click on ad.  |\n","| attributedSales14d   | Number of attributed sales occurring within 14 days of click on ad.  |\n","| attributedSales30d  | Number of attributed sales occurring within 30 days of click on ad.   |\n","| attributedSales1dSameSKU  | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales7dSameSKU| Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales14dSameSKU | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised.|\n","| attributedSales30dSameSKU| Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised.|\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Ad Group reports"},"path":"/en-us/reference/1/reports","content":[" These metrics can be used to request reports of type: adGroups\n","| Metric  | Details |\n","\\|---------------------------------\\|----------------------\\|\n","| campaignName| Unique name of the campaign |\n","| campaignId | Unique numerical ID of the campaign |\n","| adGroupName | Unique name of the ad group  |\n","| adGroupId | Unique numerical ID of the ad group  |\n","| impressions | Total ad impressions.   |\n","| clicks  | Total ad clicks.  |\n","| cost  | Total cost of all clicks. Can be divided by clicks to obtain average CPC. |\n","| attributedConversions1d | Number of attributed conversion events occurring within 1 day of click on ad.  |\n","| attributedConversions7d  | Number of attributed conversion events occurring within 7 days of click on ad. |\n","| attributedConversions14d  | Number of attributed conversion events occurring within 14 days of click on ad. |\n","| attributedConversions30d  | Number of attributed conversion events occurring within 30 days of click on ad.  |\n","| attributedConversions1dSameSKU | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised.  |\n","| attributedConversions7dSameSKU  | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised.  |\n","| attributedConversions14dSameSKU | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions30dSameSKU | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedUnitsOrdered1d  | Number of attributed units ordered within 1 day of click on ad.   |\n","| attributedUnitsOrdered7d  | Number of attributed units ordered within 7 days of click on ad.   |\n","| attributedUnitsOrdered14d  | Number of attributed units ordered within 14 days of click on ad.   |\n","| attributedUnitsOrdered30d  | Number of attributed units ordered within 30 days of click on ad.   |\n","| attributedSales1d | Number of attributed sales occurring within 1 day of click on ad. |\n","| attributedSales7d  | Number of attributed sales occurring within 7 days of click on ad.  |\n","| attributedSales14d | Number of attributed sales occurring within 14 days of click on ad.  |\n","| attributedSales30d  | Number of attributed sales occurring within 30 days of click on ad.  |\n","| attributedSales1dSameSKU | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales7dSameSKU| Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales14dSameSKU | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales30dSameSKU       | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Keyword reports"},"path":"/en-us/reference/1/reports","content":[" These metrics can be used to request reports of type: keywords \n","| Metric  | Details  |\n","\\|---------\\|----------\\|\n","| campaignName  | Unique name of the campaign   |\n","| campaignId | Unique numerical ID of the campaign   |\n","| keywordId  | ID of the keyword used in bid |\n","| keywordText| Text of the keyword or phrase used in bid |\n","| matchType   | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact|\n","| impressions | Total ad impressions.  |\n","| clicks  | Total ad clicks. |\n","| cost | Total cost of all clicks. Can be divided by clicks to obtain average CPC.  |\n","| attributedConversions1d| Number of attributed conversion events occurring within 1 day of click on ad. |\n","| attributedConversions7d | Number of attributed conversion events occurring within 7 days of click on ad. |\n","| attributedConversions14d| Number of attributed conversion events occurring within 14 days of click on ad. |\n","| attributedConversions30d| Number of attributed conversion events occurring within 30 days of click on ad. |\n","| attributedConversions1dSameSKU| Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions7dSameSKU| Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions14dSameSKU | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions30dSameSKU | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedUnitsOrdered1d  | Number of attributed units ordered within 1 day of click on ad.   |\n","| attributedUnitsOrdered7d  | Number of attributed units ordered within 7 days of click on ad.   |\n","| attributedUnitsOrdered14d  | Number of attributed units ordered within 14 days of click on ad.   |\n","| attributedUnitsOrdered30d  | Number of attributed units ordered within 30 days of click on ad.   |\n","| attributedSales1d | Number of attributed sales occurring within 1 day of click on ad.|\n","| attributedSales7d| Number of attributed sales occurring within 7 days of click on ad. |\n","| attributedSales14d| Number of attributed sales occurring within 14 days of click on ad. |\n","| attributedSales30d| Number of attributed sales occurring within 30 days of click on ad. |\n","| attributedSales1dSameSKU| Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales7dSameSKU | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised.|\n","| attributedSales14dSameSKU | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised.|\n","| attributedSales30dSameSKU | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Product Ads reports"},"path":"/en-us/reference/1/reports","content":[" These metrics can be used to request reports of type: productAds\n","| Metric       | Details   |\n","\\|--------------\\|-----------\\|\n","| campaignName| Unique name of the campaign  |\n","| campaignId | Unique numerical ID of the campaign  |\n","| adGroupName | Unique name of the ad group |\n","| adGroupId  | Unique numerical ID of the ad group |\n","| impressions| Total ad impressions.|\n","| clicks  | Total ad clicks. |\n","| cost | Total cost of all clicks. Can be divided by clicks to obtain average CPC. |\n","| currency| A dimensional metric  |\n","| asin | The ASIN that is being advertised. This is available for both merchants and vendors. |\n","| sku | The SKU that is being advertised. Not available for vendors.|\n","| attributedConversions1d| Number of attributed conversion events occurring within 1 day of click on ad.  |\n","| attributedConversions7d | Number of attributed conversion events occurring within 7 days of click on ad. |\n","| attributedConversions14d | Number of attributed conversion events occurring within 14 days of click on ad. |\n","| attributedConversions30d | Number of attributed conversion events occurring within 30 days of click on ad. |\n","| attributedConversions1dSameSKU | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions7dSameSKU | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions14dSameSKU | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions30dSameSKU | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedUnitsOrdered1d  | Number of attributed units ordered within 1 day of click on ad.   |\n","| attributedUnitsOrdered7d  | Number of attributed units ordered within 7 days of click on ad.   |\n","| attributedUnitsOrdered14d  | Number of attributed units ordered within 14 days of click on ad.   |\n","| attributedUnitsOrdered30d  | Number of attributed units ordered within 30 days of click on ad.   |\n","| attributedSales1d | Number of attributed sales occurring within 1 day of click on ad. |\n","| attributedSales7d | Number of attributed sales occurring within 7 days of click on ad. |\n","| attributedSales14d| Number of attributed sales occurring within 14 days of click on ad.|\n","| attributedSales30d| Number of attributed sales occurring within 30 days of click on ad. |\n","| attributedSales1dSameSKU | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales7dSameSKU| Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales14dSameSKU| Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised.|\n","| attributedSales30dSameSKU | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised.|\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"ASINs report"},"path":"/en-us/reference/1/reports","content":[" These metrics can be used to request reports of type: asins\n","| Metric                            | Details                                         |\n","\\|-----------------------------------\\|-------------------------------------------------\\|\n","| campaignName                            | Unique name of the campaign   |\n","| campaignId                            | Unique numerical ID of the campaign   |\n","| adGroupName                          | Unique name of the ad group                |\n","| adGroupId                          | Unique numerical ID of the ad group                |\n","| keywordId                       | Unique numerical ID of the keyword                  |\n","| keywordText                       | Keyword or phrase used in bid                   |\n","| asin                              | Unique ASIN advertised                          |\n","| otherAsin                         | A non-dimensional metric for ASINs other than the one advertised   |\n","| sku                               | Unique SKU advertised                           |\n","| currency                          | A dimensional metric                            |\n","| matchType                         | One of: broad, phrase, or exact           |\n","| attributedUnitsOrdered1dOtherSKU  | Number of other ASIN (SKU) units sold. 1 day.   |\n","| attributedUnitsOrdered7dOtherSKU  | Number of other ASIN (SKU) units sold. 7 days.  |\n","| attributedUnitsOrdered14dOtherSKU | Number of other ASIN (SKU) units sold. 14 days. |\n","| attributedUnitsOrdered30dOtherSKU | Number of other ASIN (SKU) units sold. 30 days. |\n","| attributedSales1dOtherSKU         | Sales for another ASIN (SKU). 1 day.            |\n","| attributedSales7dOtherSKU         | Sales for another ASIN (SKU). 7 days.           |\n","| attributedSales14dOtherSKU        | Sales for another ASIN (SKU). 14 days.          |\n","| attributedSales30dOtherSKU        | Sales for another ASIN (SKU). 30 days.          |\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Sponsored Brands reporting"},"path":"/en-us/reference/1/reports","content":[" Sponsored Brands (SB) (formerly known as Headline Search Ads) are a type of ad product with different characteristics and page placement options from those of Sponsored Products. The Sponsored Brands reporting feature is designed to deliver reporting information only for SB campaigns via the API. To create or modify SB ads and campaigns, continue to use the web interface. The object that differentiates between Sponsored Products and Sponsored Brands is the campaignType object.\n"," Sponsored Brands reporting data is only available from the following endpoints:\n","/v1/campaigns/report - /v1/adGroups/report - /v1/keywords/report\n"," Sponsored Brands reporting data cannot be combined with Sponsored Products data into one report. Use headlineSearch for the campaignType to retrieve reporting data for SB campaigns. Only 14-day data is available for SB. Attribution windows of 1, 7, and 30-day intervals are not available. For Sponsored Brands, query segmentation or search-term reporting is not supported.\n"," Reporting for SB adds the following fields:\n","| Report type | New fields                                                                                                       |\n","\\|-------------\\|------------------------------------------------------------------------------------------------------------------\\|\n","| Campaign    | campaignType, campaignBudget, campaignBudgetType, and campaignStatus                                             |\n","| Ad Groups   | campaignId, campaignName, campaignType, campaignBudget, campaignBudgetType, campaignStatus, adGroupName, adGroupId |\n","| Keyword     | campaignId, campaignName, adGroupId, adGroupName, campaignBudgetType, campaignStatus, keywordText, and matchType |\n"," Sponsored Brands entities are not included in the snapshot report. To obtain reporting on your SB campaigns, use the SB report metrics listed in the next section. These metrics can be used to request reports of type: headlineSearch\n","| Metric | Details |\n","\\|--------\\|---------\\|\n","| campaignName\\*\\*\\*  | Advertiser created campaign name                 |\n","| campaignId          | Unique campaign ID                               |\n","| campaignType        | One of: headlineSearch or sponsoredProducts  |\n","| campaignStatus\\*\\*\\*     | Current status of the campaign                   |\n","| campaignBudget\\*\\*\\*  | The campaign budget                            |\n","| campaignBudgetType\\*\\*\\* | One of: daily or lifetime               |\n","| adGroupName\\*\\*\\*        | Unique AdGroup name                         |\n","| adGroupId                | Unique AdGroup ID                           |\n","| keywordText              | Keyword or phrase used in bid               |\n","| matchType                | One of: broad, phrase, or exact       |\n","| impressions              | Total ad impressions.                       |\n","| clicks                   | Total ad clicks.                            |\n","| cost                     | Total cost of all clicks. Can be divided by clicks to obtain average CPC.          |\n","| attributedSales14d       | Number of attributed sales occurring within 14 days of click on an ad.              |\n","| attributedSales14dSameSKU      | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions14d       | Number of attributed conversion events occurring within 14 days of click on ad.    |\n","| attributedConversions14dSameSKU| Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised.        |\n"],"documentType":"guide"},{"title":"Deprecations overview","sectionHeader":null,"path":"/en-us/reference/deprecations","content":[" This section contains API references for Amazon Ads APIs that have been deprecated or shut off. These APIs are no longer recommended for use and will be removed in the future.\n"],"documentType":"guide"},{"title":"Deprecations overview","sectionHeader":{"type":2,"text":"Migration guidance"},"path":"/en-us/reference/deprecations","content":[" If you are currently using a deprecated API, migrate to the recommended replacement as soon as possible. See the individual API pages for specific migration guidance and shutdown dates.\n"],"documentType":"guide"},{"title":"Deprecations overview","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/reference/deprecations","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":null,"path":"/en-us/reference/1/profiles","content":[" Marketplaces include associated properties that are specific to the region-- for example, countryCode, currencyCode, or timezone. These properties dictate the behavior of the Advertising API such as scheduling, budget, and billing. For this reason, Advertisers with accounts associated with more than one marketplace (for example: Amazon.com, Amazon.co.uk, Amazon.co.jp) will have only one profile associated with each marketplace. Each profile must be associated with a unique Login with Amazon account. Each Login with Amazon account requires a unique email address. When generating API authentication tokens you must use the correct profile for the international marketplace where you manage your campaigns\n"," Authentication tokens are used to obtain all the profiles associated with the advertiser. The profile ID is passed in the header for calls to the API. Reports and all entity management operations are associated with a single profile. Advertisers cannot have more than one profile for each marketplace.\n"," Profiles are associated with a unique Profile ID. A management scope is required in the header for all API calls. Use your Profile ID as the value for the management scope (Amazon-Advertising-API-Scope) in the header. To retrieve your profile ID, make a call to list profiles associated with the access token you are using.\n"," The following methods are used to read and update profiles. The following table describes the service behavior in terms of the URL space and HTTP methods supported by the service-managed resources.\n","| Method | URL                   | Use Case                                              |\n","\\|--------\\|-----------------------\\|-------------------------------------------------------\\|\n","| GET    | /profiles             | Retrieve all profiles associated with the auth token. |\n","| GET    | /profiles/{profileId} | Retrieve a profile by ID                              |\n","| PUT    | /profiles/            | Update one or more profiles                           |\n"," Use the exact text and format in the 'Time zone' column to designate the correct time zone.\n","| Region | Time zone |\n","\\| --- \\| --- \\|\n","| US | America/Los_Angeles |\n","| CA | America/Los_Angeles |\n","| UK | Europe/London |\n","| DE | Europe/Paris |\n","| FR | Europe/Paris |\n","| ES | Europe/Paris |\n","| IT | Europe/Paris |\n","| JP | Asia/Tokyo |\n","| AU | Australia/Sydney |\n","| AE | Asia/Dubai |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Operations"},"path":"/en-us/reference/1/profiles","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"listProfiles"},"path":"/en-us/reference/1/profiles","content":[" Retrieves profiles associated with an auth token.\n"," None\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 200 - success | List of Profile  |\n","| 401 - unauthorized | Error |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"getProfile"},"path":"/en-us/reference/1/profiles","content":[" Retrieves a single profile specified by identifier.\n","| Parameter Name | Type | Description |\n","\\| --- \\| --- \\| --- \\|\n","| profileId | string | The profile identifier. |\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 200 - success | List of Profile  |\n","| 401 - unauthorized | Error |\n","| 404 - profile not found | Error |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"updateProfiles"},"path":"/en-us/reference/1/profiles","content":[" Updates one or more profiles. Advertisers are identified using their profileId.\n","| Type | Specified In | Description |\n","\\| --- \\| --- \\| --- \\|\n","| List of Profile  | body | A list of updates containing profile IDs and the mutable fields to be modified. Mutable fields: dailyBudget |\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 207 - multi-response | List of ProfileResponse reflecting the same order as the input |\n","| 401 - unauthorized | Error |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"registerProfile"},"path":"/en-us/reference/1/profiles","content":[" Registers a profile in sandbox. If this call is made to a production endpoint you will receive an error.\n","| Type | Specified In | Description |\n","\\| --- \\| --- \\| --- \\|\n","| countryCode | Body | The country in which you wish to register the profile. Can be one of: US, CA, UK, DE, FR, ES, IT, JP, AU, AE |\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 200 - Success | Profile registration succeeded. |\n","| 401 - Unauthorized | Error |\n","| 404 - Not Found | Error. This will be returned if making the call to a production endpoint. |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"registerBrand"},"path":"/en-us/reference/1/profiles","content":[" Registers a brand in sandbox. If this call is made to a production endpoint you will receive an error.\n","| Type | Specified In | Description |\n","\\| --- \\| --- \\| --- \\|\n","| countryCode | Body | The country in which you wish to register the profile. Can be one of: US, CA, UK, DE, FR, IT, ES, JP, AU, AE |\n","| brand | Body | REQUIRED. Brand name. |\n","| Status Code | Response object |\n","\\| --- \\| --- \\|\n","| 200 - Success | Profile registration succeeded. |\n","| 401 - Unauthorized | Error |\n","| 404 - Not Found | Error. This will be returned if making the call to a production endpoint. |\n"],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":2,"text":"Resource representations"},"path":"/en-us/reference/1/profiles","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"Profile"},"path":"/en-us/reference/1/profiles","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"ProfileResponse"},"path":"/en-us/reference/1/profiles","content":[],"documentType":"guide"},{"title":"Profiles","sectionHeader":{"type":3,"text":"Error"},"path":"/en-us/reference/1/profiles","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":null,"path":"/en-us/reference/1/suggested-keywords","content":[" Note: See the complete list of valid keyword characters and constraints in the Limits section.\n"," Used to request suggested keywords at the ad group and ASIN levels. Suggested keywords are ordered by most effective to least.\n","| Method | URL | Use Case  |\n","\\|--------\\|-----\\|-----------\\|\n","| GET    | /adGroups/{adGroupId}/suggested/keywords | Request suggested keywords for specified ad group |\n","| GET    | /adGroups/{adGroupId}/suggested/keywords/extended | Provides suggested keywords for Ad Group. Returns additional fields: campaignId, adGroupId, and state (of the ad) with each suggested keyword |\n","| GET    | /asins/{asinValue}/suggested/keywords | Provides suggested keywords for specified ASIN |\n","| POST   | /asins/suggested/keywords | Provides suggested keywords for specified list of ASINs |\n"],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":2,"text":"Operations"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"getAdGroupSuggestedKeywords"},"path":"/en-us/reference/1/suggested-keywords","content":[" Retrieve suggested keyword data for the specified adGroupId\n","| Parameter Name    | Type   | Specified In | Description |\n","\\|-------------------\\|--------\\|--------------\\|-------------\\|\n","| adGroupId         | number | URL path     | The ID of the requested ad group |\n","| maxNumSuggestions | number | URL query    | Maximum number of returned suggested keywords. Default is 100, maximum is 1000 |\n","| adStateFilter     | string | URL query    | Ad state filter (values are comma separated), to filter out the Ads to get suggested keywords for their ASINs. Valid values are: enabled, paused, and archived. Default values are enabled and paused |\n","| Status Code   | Response object                               |\n","\\|---------------\\|-----------------------------------------------\\|\n","| 200 - Success | Suggested keywords for specified adGroupId    |\n","| 400 – Error   | No Ad Group was found for specified adGroupId |\n","| 404 – Error   | One or more incorrect URL query parameters      |\n"],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"getAdGroupSuggestedKeywordsEx"},"path":"/en-us/reference/1/suggested-keywords","content":[" Retrieve extended suggested keyword data for the specified adGroupId\n","| Parameter Name    | Type   | Specified In | Description |\n","\\|-------------------\\|--------\\|--------------\\|-------------\\|\n","| adGroupId         | number | URL path     | The ID of the requested ad group |\n","| maxNumSuggestions | number | URL query    | Maximum expected number of suggested keywords. Default is 100, maximum is 1000 |\n","| suggestBids       | string | URL query    | Valid values are yes and no. Default value is no. If yes, any suggested keywords can contain the extra bid field, where bid will be populated by calculated suggested bid.  Note: The bid field will be missing if there are no suggested bids for the keyword |\n","| adStateFilter     | string | URL query    | Ad state filter (values are comma separated) to filter out the ads to get suggested keywords for their ASINs. Valid values are: enabled, paused, and archived. Default values are enabled and paused |\n","| Status Code     | Response object                                     |\n","\\|-----------------\\|-----------------------------------------------------\\|\n","| 200 - Success   | Extended suggested keywords for specified adGroupId |\n","| 404 – Not Found | No Ad Group was found for specified adGroupId       |\n","| 400 – Error     | One or more incorrect URL query parameters            |\n"],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"getAsinSuggestedKeywords"},"path":"/en-us/reference/1/suggested-keywords","content":[" Provides suggested keywords for specified ASIN. Suggested keywords are ordered by most effective to least effective.\n","| Parameter Name    | Type   | Specified In | Description                                                                    |\n","\\|-------------------\\|--------\\|--------------\\|--------------------------------------------------------------------------------\\|\n","| asinValue         | string | URL path     | ASIN                                                                           |\n","| maxNumSuggestions | number | URL query    | Maximum number of returned suggested keywords. Default is 100, maximum is 1000 |\n","| Status Code   | Response object                                          |\n","\\|---------------\\|----------------------------------------------------------\\|\n","| 200 – Success | Suggested keywords for specified asinValue               |\n","| 400 – Error   | One or more incorrect URL query parameters or incorrect ASIN |\n"],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"bulkGetAsinSuggestedKeywords"},"path":"/en-us/reference/1/suggested-keywords","content":[" Provides keyword suggestions for specified list of ASINs. Suggested keywords are ordered by most effective to least effective.\n","| Parameter name    | Type            | Specified in | Description                                                                    |\n","\\|-------------------\\|-----------------\\|--------------\\|--------------------------------------------------------------------------------\\|\n","| asins            | List of strings | body         | List of ASINs for which keywords are suggested                                 |\n","| maxNumSuggestions | Number          | body         | Maximum number of returned suggested keywords. Default is 100, maximum is 1000 |\n","| Status Code   | Response object                                          |\n","\\|---------------\\|----------------------------------------------------------\\|\n","| 200 – Success | Suggested keywords for specified list of ASINs           |\n","| 400 – Error   | One or more incorrect URL query parameters or incorrect ASIN |\n"],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":2,"text":"Resource representations"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"AdGroupSuggestedKeywordsResponse"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"GetAdGroupSuggestedKeywordsExResponse"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"GetAsinSuggestedKeywordsResponse"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"BulkGetAsinSuggestedKeywordsResponse"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Suggested keywords","sectionHeader":{"type":3,"text":"Error"},"path":"/en-us/reference/1/suggested-keywords","content":[],"documentType":"guide"},{"title":"Bid controls","sectionHeader":null,"path":"/en-us/reference/1/bid-controls","content":[],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Using bid controls in the sandbox environment"},"path":"/en-us/reference/1/bid-controls","content":[" Bid controls feature is not enabled by default in the sandbox. There is an additional requirement to add a header with API calls using bid controls in the sandbox. The bid controls header does not follow the standard syntax of other headers. The acceptable values for the header that will activate bid controls are: true or yes. If your header contains other values besides true or yes, your request will still be accepted, but bid controls feature will remain deactivated.\n"],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Bidding strategies"},"path":"/en-us/reference/1/bid-controls","content":[" There are three bidding strategies available to you at the campaign level.\n","| Attribute name | Strategy name | Description |\n","\\| --- \\| --- \\| --- \\|\n","| legacyForSales | Adjust bidding (down only) | Lowers your bids in real time when your ad may be less likely to convert to a sale. Any campaign created before October 2018 uses this setting by default. |\n","| autoForSales | Adjust bidding (up and down) | Increases your bids (by a maximum of 100%) in real time when your ad may be more likely to convert to a sale, and lowers your bids when less likely to convert to a sale. |\n","| manual | Fixed bid | Uses your exact bid and any manual adjustments you set, and is not subject to adjusted bidding. |\n"],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Bid adjustments by placement"},"path":"/en-us/reference/1/bid-controls","content":[" You can enable controls to adjust your bid based on the placement location. Specify a location where you want to use bid controls. The percentage value set is the percentage of the original bid for which you want to have your bid adjustment increased. For example, a 50% adjustment on a $1.00 bid would increase the bid to $1.50 for the opportunity to win a specified placement.\n","| Predicate | Placement | Percentage increase range |\n","\\| --- \\| --- \\|\n","| placementTop | Top of search page | 0 - 900% |\n","| placementProductPage | On a product page | 0 - 900% |\n"],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Methods"},"path":"/en-us/reference/1/bid-controls","content":["| Method | URL | Use Case |\n","\\| --- \\| --- \\| --- \\|\n","| GET | /v1/sp/campaigns/{campaignId} | Retrieve a campaign by ID |\n","| GET | /v1/sp/campaigns | Retrieve a list of campaigns |\n","| PUT | /v1/sp/campaigns &lt;campaign_obj_json> | Update bid controls for a list of campaigns with the values included in the campaign_obj_json |\n","| POST | /v1/sp/campaigns | Create new bid controls for a list of campaigns with the values included in the campaign_obj_json |\n"],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Resource representation"},"path":"/en-us/reference/1/bid-controls","content":[],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":3,"text":"Campaign"},"path":"/en-us/reference/1/bid-controls","content":[],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Bid controls and premium bid adjustments (Bid+)"},"path":"/en-us/reference/1/bid-controls","content":[" Bid controls replaces premium bid adjustments (also known as Bid+). Premium bid adjustments feature will be deprecated in the future. While Bid+ is still an active feature, it is important to note that you cannot use Bid+ together with bidding controls. Existing campaigns using Bid+ will be converted to the bidding strategy: Legacy for sales (down only) with a 50% adjustment for the top-of-search placement. \n"],"documentType":"guide"},{"title":"Bid controls","sectionHeader":{"type":2,"text":"Reports and exports"},"path":"/en-us/reference/1/bid-controls","content":[],"documentType":"guide"},{"title":"Reports","sectionHeader":null,"path":"/en-us/reference/1/reports","content":[" Use the requestReport operation to retrieve performance reports. There are multiple ways to retrieve your campaign data, and using reports may not always be the most efficient way. If you are trying to download a record of your campaign structure and all of its entities (like AdGroups, keywords, productAds), we recommended that you run a snapshot of your entities instead of requesting a list of all elements in the campaign. For more information, see snapshots.\n"," Note: When generating a report (POST), there are separate endpoints for ad types Sponsored Products and Sponsored Brands reports. These endpoints are specified at the beginning of each section. When retrieving the report ID and downloading the report (GET), it is not necessary to differentiate the endpoints based on the ad type.\n"," The following table describes the service behavior in terms of the URL space and HTTP methods supported by the service-managed resources.\n","| Method | URL                  | Use Case                                                                                             |\n","\\|--------\\|----------------------\\|------------------------------------------------------------------------------------------------------\\|\n","| POST   | /{recordType}/report | Request the creation of a performance report for all entities of a single type which have performance data to report. |\n","| GET    | /reports/{reportId}  | Retrieve status, metadata and location of a previously requested performance report.                 |\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Operations"},"path":"/en-us/reference/1/reports","content":[],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"requestReport"},"path":"/en-us/reference/1/reports","content":["| Parameter Name | Type   | Specified In | Description |\n","\\|----------------\\|--------\\|--------------\\|-------------\\|\n","| recordType     | string | URL          | The type of entity for which the report should be generated. This must be one of: campaigns, adGroups, keywords, productAds, or asins |\n","| campaignType   | string | POST body    | The type of campaign for which performance data should be generated. Must be: sponsoredProducts or headlineSearch|\n","| segment        | string | POST body    | Optional. Dimension on which to segment the report. If specified, must be query for keyword report or placement for campaigns report. |\n","| reportDate     | string | POST body    | The date for which to retrieve the performance report in YYYYMMDD format. The time zone is specified by the profile used to request the report. If this date is today, then the performance report may contain partial information. Reports are not available for data older than 60 days. For details on data latency, see the Service Guarantees in the developer notes section. |\n","| metrics        | string | POST body    | A comma-separated list of the metrics to be included in the report.|\n","| Status Code                | Response object                                             |\n","\\|----------------------------\\|-------------------------------------------------------------\\|\n","| 202 - success              | ReportResponse                                              |\n","| 401 - unauthorized         | Error                                                       |\n","| 406 – not acceptable       | Error (failed due to report date being too far in the past) |\n","| 422 - unprocessable entity | Error (failed due to incorrect parameters)                    |\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"getReport"},"path":"/en-us/reference/1/reports","content":[" Retrieve a previously requested report identified by the reportId.\n","| Parameter Name | Type   | Specified In | Description                    |\n","\\|----------------\\|--------\\|--------------\\|--------------------------------\\|\n","| reportId       | number | URL path     | The ID of the requested report |\n","| Status Code            | Response object |\n","\\|------------------------\\|-----------------\\|\n","| 200 - success          | ReportResponse     |\n","| 401 - unauthorized     | Error           |\n","| 404 - report not found | Error           |\n","| 404 - not found server | Error           |\n"," The ReportResponse will contain report status. When the report has completed, the location field will provide a redirect URL for the gzipped file containing the report. See downloading reports for more details.\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Valid report requests"},"path":"/en-us/reference/1/reports","content":[" Report requests will return a 422 if the parameters specified are unrecognized or if the combination of parameters is not supported. In particular, the choice of recordType may restrict the use of certain segments. Query segmentation can only be used in combination with keyword reports.\n"," If you are receiving '404 - Not Found Server' errors, check that you have the input the entityType endpoint correctly. Must be one of: campaigns, adGroups, keywords, asins, or productAds\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Resource representations"},"path":"/en-us/reference/1/reports","content":[],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"ReportResponse"},"path":"/en-us/reference/1/reports","content":[],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Error"},"path":"/en-us/reference/1/reports","content":[" See error object return format as described in Developer notes.\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Report file format"},"path":"/en-us/reference/1/reports","content":[" The report file contains one row per entity for which performance data is present. These records are represented as JSON containing the ID attribute corresponding to the recordType, the segment (if specified), and each of the metrics in the request.\n"," For example, a report requested with the following call:\n"," Would have a report that looks something like this:\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Downloading reports"},"path":"/en-us/reference/1/reports","content":[" When reports have completed, the location field will provide a URI for the download action against the generated report. Note that requests against this URI require authentication, so the authorization header must be passed. The response to these requests will not contain a body and will return a 307 redirect with the location header populated with an S3 file location. The resulting file location is short lived (expires in 30 seconds). If this time elapses before a client is able to begin downloading the file, the client may make another request against the download action URI.\n"," Note that the report file in S3 is gzipped.\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":2,"text":"Report metrics"},"path":"/en-us/reference/1/reports","content":[" The following tables summarize report metrics which can be requested via the Reports interface. Different report types can use different metrics.\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Campaigns reports"},"path":"/en-us/reference/1/reports","content":[" These metrics can be used to request reports of type: campaigns\n","| Metric | Details |\n","\\|---------------------------------\\|---------------\\|\n","| bidPlus  | A dimensional metric. See premium bid adjustment in the developer notes. |\n","| campaignName| Unique name of the campaign |\n","| campaignId  | Unique numerical ID of the campaign  |\n","| campaignStatus   | Status of the campaign  |\n","| campaignBudget| Total budget allotted to the campaign  |\n","| impressions  | Total ad impressions.  |\n","| clicks  | Total ad clicks.  |\n","| cost| Total cost of all clicks. Can be divided by clicks to obtain average CPC. |\n","| attributedConversions1d | Number of attributed conversion events occurring within 1 day of click on ad. |\n","| attributedConversions7d | Number of attributed conversion events occurring within 7 days of click on ad. |\n","| attributedConversions14d| Number of attributed conversion events occurring within 14 days of click on ad. |\n","| attributedConversions30d | Number of attributed conversion events occurring within 30 days of click on ad. |\n","| attributedConversions1dSameSKU  | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised.   |\n","| attributedConversions7dSameSKU  | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised.  |\n","| attributedConversions14dSameSKU | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions30dSameSKU | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedUnitsOrdered1d  | Number of attributed units ordered within 1 day of click on ad.   |\n","| attributedUnitsOrdered7d  | Number of attributed units ordered within 7 days of click on ad.   |\n","| attributedUnitsOrdered14d  | Number of attributed units ordered within 14 days of click on ad.   |\n","| attributedUnitsOrdered30d  | Number of attributed units ordered within 30 days of click on ad.   |\n","| attributedSales1d  | Number of attributed sales occurring within 1 day of click on ad.|\n","| attributedSales7d | Number of attributed sales occurring within 7 days of click on ad.  |\n","| attributedSales14d   | Number of attributed sales occurring within 14 days of click on ad.  |\n","| attributedSales30d  | Number of attributed sales occurring within 30 days of click on ad.   |\n","| attributedSales1dSameSKU  | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales7dSameSKU| Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales14dSameSKU | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised.|\n","| attributedSales30dSameSKU| Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised.|\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Ad Group reports"},"path":"/en-us/reference/1/reports","content":[" These metrics can be used to request reports of type: adGroups\n","| Metric  | Details |\n","\\|---------------------------------\\|----------------------\\|\n","| campaignName| Unique name of the campaign |\n","| campaignId | Unique numerical ID of the campaign |\n","| adGroupName | Unique name of the ad group  |\n","| adGroupId | Unique numerical ID of the ad group  |\n","| impressions | Total ad impressions.   |\n","| clicks  | Total ad clicks.  |\n","| cost  | Total cost of all clicks. Can be divided by clicks to obtain average CPC. |\n","| attributedConversions1d | Number of attributed conversion events occurring within 1 day of click on ad.  |\n","| attributedConversions7d  | Number of attributed conversion events occurring within 7 days of click on ad. |\n","| attributedConversions14d  | Number of attributed conversion events occurring within 14 days of click on ad. |\n","| attributedConversions30d  | Number of attributed conversion events occurring within 30 days of click on ad.  |\n","| attributedConversions1dSameSKU | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised.  |\n","| attributedConversions7dSameSKU  | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised.  |\n","| attributedConversions14dSameSKU | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions30dSameSKU | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedUnitsOrdered1d  | Number of attributed units ordered within 1 day of click on ad.   |\n","| attributedUnitsOrdered7d  | Number of attributed units ordered within 7 days of click on ad.   |\n","| attributedUnitsOrdered14d  | Number of attributed units ordered within 14 days of click on ad.   |\n","| attributedUnitsOrdered30d  | Number of attributed units ordered within 30 days of click on ad.   |\n","| attributedSales1d | Number of attributed sales occurring within 1 day of click on ad. |\n","| attributedSales7d  | Number of attributed sales occurring within 7 days of click on ad.  |\n","| attributedSales14d | Number of attributed sales occurring within 14 days of click on ad.  |\n","| attributedSales30d  | Number of attributed sales occurring within 30 days of click on ad.  |\n","| attributedSales1dSameSKU | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales7dSameSKU| Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales14dSameSKU | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales30dSameSKU       | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Keyword reports"},"path":"/en-us/reference/1/reports","content":[" These metrics can be used to request reports of type: keywords \n","| Metric  | Details  |\n","\\|---------\\|----------\\|\n","| campaignName  | Unique name of the campaign   |\n","| campaignId | Unique numerical ID of the campaign   |\n","| keywordId  | ID of the keyword used in bid |\n","| keywordText| Text of the keyword or phrase used in bid |\n","| matchType   | Type of matching for the keyword or phrase used in bid. Must be one of: broad, phrase, or exact|\n","| impressions | Total ad impressions.  |\n","| clicks  | Total ad clicks. |\n","| cost | Total cost of all clicks. Can be divided by clicks to obtain average CPC.  |\n","| attributedConversions1d| Number of attributed conversion events occurring within 1 day of click on ad. |\n","| attributedConversions7d | Number of attributed conversion events occurring within 7 days of click on ad. |\n","| attributedConversions14d| Number of attributed conversion events occurring within 14 days of click on ad. |\n","| attributedConversions30d| Number of attributed conversion events occurring within 30 days of click on ad. |\n","| attributedConversions1dSameSKU| Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions7dSameSKU| Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions14dSameSKU | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions30dSameSKU | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedUnitsOrdered1d  | Number of attributed units ordered within 1 day of click on ad.   |\n","| attributedUnitsOrdered7d  | Number of attributed units ordered within 7 days of click on ad.   |\n","| attributedUnitsOrdered14d  | Number of attributed units ordered within 14 days of click on ad.   |\n","| attributedUnitsOrdered30d  | Number of attributed units ordered within 30 days of click on ad.   |\n","| attributedSales1d | Number of attributed sales occurring within 1 day of click on ad.|\n","| attributedSales7d| Number of attributed sales occurring within 7 days of click on ad. |\n","| attributedSales14d| Number of attributed sales occurring within 14 days of click on ad. |\n","| attributedSales30d| Number of attributed sales occurring within 30 days of click on ad. |\n","| attributedSales1dSameSKU| Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales7dSameSKU | Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised.|\n","| attributedSales14dSameSKU | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised.|\n","| attributedSales30dSameSKU | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Product Ads reports"},"path":"/en-us/reference/1/reports","content":[" These metrics can be used to request reports of type: productAds\n","| Metric       | Details   |\n","\\|--------------\\|-----------\\|\n","| campaignName| Unique name of the campaign  |\n","| campaignId | Unique numerical ID of the campaign  |\n","| adGroupName | Unique name of the ad group |\n","| adGroupId  | Unique numerical ID of the ad group |\n","| impressions| Total ad impressions.|\n","| clicks  | Total ad clicks. |\n","| cost | Total cost of all clicks. Can be divided by clicks to obtain average CPC. |\n","| currency| A dimensional metric  |\n","| asin | The ASIN that is being advertised. This is available for both merchants and vendors. |\n","| sku | The SKU that is being advertised. Not available for vendors.|\n","| attributedConversions1d| Number of attributed conversion events occurring within 1 day of click on ad.  |\n","| attributedConversions7d | Number of attributed conversion events occurring within 7 days of click on ad. |\n","| attributedConversions14d | Number of attributed conversion events occurring within 14 days of click on ad. |\n","| attributedConversions30d | Number of attributed conversion events occurring within 30 days of click on ad. |\n","| attributedConversions1dSameSKU | Number of attributed conversion events occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions7dSameSKU | Number of attributed conversion events occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions14dSameSKU | Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions30dSameSKU | Number of attributed conversion events occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedUnitsOrdered1d  | Number of attributed units ordered within 1 day of click on ad.   |\n","| attributedUnitsOrdered7d  | Number of attributed units ordered within 7 days of click on ad.   |\n","| attributedUnitsOrdered14d  | Number of attributed units ordered within 14 days of click on ad.   |\n","| attributedUnitsOrdered30d  | Number of attributed units ordered within 30 days of click on ad.   |\n","| attributedSales1d | Number of attributed sales occurring within 1 day of click on ad. |\n","| attributedSales7d | Number of attributed sales occurring within 7 days of click on ad. |\n","| attributedSales14d| Number of attributed sales occurring within 14 days of click on ad.|\n","| attributedSales30d| Number of attributed sales occurring within 30 days of click on ad. |\n","| attributedSales1dSameSKU | Aggregate value of attributed sales occurring within 1 day of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales7dSameSKU| Aggregate value of attributed sales occurring within 7 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedSales14dSameSKU| Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised.|\n","| attributedSales30dSameSKU | Aggregate value of attributed sales occurring within 30 days of click on ad where the purchased SKU was the same as the one advertised.|\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"ASINs report"},"path":"/en-us/reference/1/reports","content":[" These metrics can be used to request reports of type: asins\n","| Metric                            | Details                                         |\n","\\|-----------------------------------\\|-------------------------------------------------\\|\n","| campaignName                            | Unique name of the campaign   |\n","| campaignId                            | Unique numerical ID of the campaign   |\n","| adGroupName                          | Unique name of the ad group                |\n","| adGroupId                          | Unique numerical ID of the ad group                |\n","| keywordId                       | Unique numerical ID of the keyword                  |\n","| keywordText                       | Keyword or phrase used in bid                   |\n","| asin                              | Unique ASIN advertised                          |\n","| otherAsin                         | A non-dimensional metric for ASINs other than the one advertised   |\n","| sku                               | Unique SKU advertised                           |\n","| currency                          | A dimensional metric                            |\n","| matchType                         | One of: broad, phrase, or exact           |\n","| attributedUnitsOrdered1dOtherSKU  | Number of other ASIN (SKU) units sold. 1 day.   |\n","| attributedUnitsOrdered7dOtherSKU  | Number of other ASIN (SKU) units sold. 7 days.  |\n","| attributedUnitsOrdered14dOtherSKU | Number of other ASIN (SKU) units sold. 14 days. |\n","| attributedUnitsOrdered30dOtherSKU | Number of other ASIN (SKU) units sold. 30 days. |\n","| attributedSales1dOtherSKU         | Sales for another ASIN (SKU). 1 day.            |\n","| attributedSales7dOtherSKU         | Sales for another ASIN (SKU). 7 days.           |\n","| attributedSales14dOtherSKU        | Sales for another ASIN (SKU). 14 days.          |\n","| attributedSales30dOtherSKU        | Sales for another ASIN (SKU). 30 days.          |\n"],"documentType":"guide"},{"title":"Reports","sectionHeader":{"type":3,"text":"Sponsored Brands reporting"},"path":"/en-us/reference/1/reports","content":[" Sponsored Brands (SB) (formerly known as Headline Search Ads) are a type of ad product with different characteristics and page placement options from those of Sponsored Products. The Sponsored Brands reporting feature is designed to deliver reporting information only for SB campaigns via the API. To create or modify SB ads and campaigns, continue to use the web interface. The object that differentiates between Sponsored Products and Sponsored Brands is the campaignType object.\n"," Sponsored Brands reporting data is only available from the following endpoints:\n","/v1/campaigns/report - /v1/adGroups/report - /v1/keywords/report\n"," Sponsored Brands reporting data cannot be combined with Sponsored Products data into one report. Use headlineSearch for the campaignType to retrieve reporting data for SB campaigns. Only 14-day data is available for SB. Attribution windows of 1, 7, and 30-day intervals are not available. For Sponsored Brands, query segmentation or search-term reporting is not supported.\n"," Reporting for SB adds the following fields:\n","| Report type | New fields                                                                                                       |\n","\\|-------------\\|------------------------------------------------------------------------------------------------------------------\\|\n","| Campaign    | campaignType, campaignBudget, campaignBudgetType, and campaignStatus                                             |\n","| Ad Groups   | campaignId, campaignName, campaignType, campaignBudget, campaignBudgetType, campaignStatus, adGroupName, adGroupId |\n","| Keyword     | campaignId, campaignName, adGroupId, adGroupName, campaignBudgetType, campaignStatus, keywordText, and matchType |\n"," Sponsored Brands entities are not included in the snapshot report. To obtain reporting on your SB campaigns, use the SB report metrics listed in the next section. These metrics can be used to request reports of type: headlineSearch\n","| Metric | Details |\n","\\|--------\\|---------\\|\n","| campaignName\\*\\*\\*  | Advertiser created campaign name                 |\n","| campaignId          | Unique campaign ID                               |\n","| campaignType        | One of: headlineSearch or sponsoredProducts  |\n","| campaignStatus\\*\\*\\*     | Current status of the campaign                   |\n","| campaignBudget\\*\\*\\*  | The campaign budget                            |\n","| campaignBudgetType\\*\\*\\* | One of: daily or lifetime               |\n","| adGroupName\\*\\*\\*        | Unique AdGroup name                         |\n","| adGroupId                | Unique AdGroup ID                           |\n","| keywordText              | Keyword or phrase used in bid               |\n","| matchType                | One of: broad, phrase, or exact       |\n","| impressions              | Total ad impressions.                       |\n","| clicks                   | Total ad clicks.                            |\n","| cost                     | Total cost of all clicks. Can be divided by clicks to obtain average CPC.          |\n","| attributedSales14d       | Number of attributed sales occurring within 14 days of click on an ad.              |\n","| attributedSales14dSameSKU      | Aggregate value of attributed sales occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised. |\n","| attributedConversions14d       | Number of attributed conversion events occurring within 14 days of click on ad.    |\n","| attributedConversions14dSameSKU| Number of attributed conversion events occurring within 14 days of click on ad where the purchased SKU was the same as the one advertised.        |\n"],"documentType":"guide"},{"title":"Creative assets","content":["Use the creative assets API to create and manage video and image assets for use in Amazon Ads campaigns. For details on using this API, see Creatives overview.\n"],"path":"/en-us/creative-asset-library","sectionHeader":{"type":2,"text":"Creative assets"},"documentType":"api-reference"},{"title":"Creative assets","content":["/assets",{"summary":"Retrieve an asset","operationId":"getAsset","responses":{"200":{"description":"Returns asset metadata.","content":{"application/vnd.creativeassetsgetresponse.v3+json":{"schema":{"type":"object","properties":{"assetVersionList":{"minItems":1,"maxItems":100,"description":"The asset version list.","type":"array","items":{"type":"object","properties":{"lastUpdatedBy":{"type":"string"},"creationTime":{"format":"int64","type":"integer"},"specCheckApprovedPrograms":{"description":"List of spec programs for which asset spec check is approved","type":"array","items":{"type":"string","enum":["SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","SPONSORED_DISPLAY_LANDSCAPE_VIDEO","SPONSORED_DISPLAY_PORTRAIT_VIDEO","SPONSORED_DISPLAY_SQUARE_VIDEO","STORES_VIDEO_TILE","STORES_BACKGROUND_VIDEO_TILE","STORES_INTRO_SPLASH","FIRE_TV_FEATURE_ROTATOR","SPONSORED_TV","SPONSORED_BRANDS_VIDEO_PORTRAIT","DEMAND_SIDE_PLATFORM_OTT","DEMAND_SIDE_PLATFORM_OLV","DEMAND_SIDE_PLATFORM_H1_DESKTOP","DEMAND_SIDE_PLATFORM_H1_MOBILE","LIVE_IMAGE_SPONSORED_DISPLAY"]}},"assetIdentifier":{"type":"object","properties":{"assetId":{"description":"The asset identifier.","type":"string"},"version":{"description":"The version of the asset.","type":"string"}}},"assetFiles":{"description":"Structure containing processed transcode files for an asset\n defaultUrl: This is the location of the original source.\n processedFiles: List of processed files with metadata.","type":"object","properties":{"processedFiles":{"type":"array","items":{"description":"Structure containing url, program, profile and metadata of processed output\n program: This is the program for which this transcoding is done.\n profile: This is the profile/outformat of the processed file.\n url: This is the location of the processed file.\n fileMetadata: This contains the metadata of file.","type":"object","properties":{"fileMetadata":{"description":"Structure containing metadata of processed file.\n contentHash: This is the location of the original source.\n contentType: This is the location of the original source.\n videoStreams: This contains the metadata of Video streams.\n audioStreams: This contains the metadata of Audio streams.","type":"object","properties":{"videoStreams":{"type":"array","items":{"description":"Structure containing metadata of Video Stream.\n profile: This is the profile of the stream.\n width: This is the resolution width of stream.\n height: This is the resolution height of stream.\n duration: This is the duration of the stream in secs.\n codecName: This tells the codec of the media stream.\n codecType: This is the codec type of stream.\n displayAspectRatio: This tells the aspect ratio of the stream.\n bitRate: This tells the bit rate of the stream.\n frameRate: This is the frame rate of video stream per sec.","type":"object","properties":{"duration":{"format":"double","type":"number"},"frameRate":{"format":"double","type":"number"},"bitRate":{"format":"int64","type":"integer"},"profile":{"type":"string"},"width":{"type":"integer"},"codecName":{"type":"string"},"codecType":{"type":"string"},"height":{"type":"integer"},"displayAspectRatio":{"type":"string"}}}},"audioStreams":{"type":"array","items":{"description":"Structure containing metadata of Video Stream.\n profile: This is the profile of the stream.\n duration: This is the duration of the stream in secs.\n codecName: This tells the codec of the media stream.\n codecType: This is the codec type of stream.\n bitRate: This tells the bit rate of the stream.\n channelLayout: This tells the channel of the stream\n sampleRate: This is the sample rate of the stream","type":"object","properties":{"duration":{"format":"double","type":"number"},"channelLayout":{"type":"string"},"bitRate":{"format":"int64","type":"integer"},"profile":{"type":"string"},"codecName":{"type":"string"},"codecType":{"type":"string"},"sampleRate":{"format":"int64","type":"integer"}}}},"contentType":{"type":"string"},"contentHash":{"type":"string"}}},"profile":{"description":"Enum containing different type of processed urls\n1. `MODERATION`: This is an internal url that will be used to moderate the asset.\n2. `IMAGE_THUMBNAIL_500`: This is the url for image asset type to support thumbnail rendering of max side 500px.\n3. `VIDEO_DEFAULT_OPTIMIZED`: This is the default processed url for video asset type for optimized rendering.\n4. `PRODUCT_VIDEO_OPTIMIZED`: This is the processed url for video that can be used for product.\n5. `BACKGROUND_VIDEO_TILE`: This is the processed url for video that can be used for background video tile.\n6. `VIDEO_TILE`: This is the processed url for video that can be used for video tile.\n7. `INTRO_SPLASH`: This is the processed url for video that can be used for intro splash.\n8. `MP4_260KBS_25FPS_48KHZ_64KBS_180P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 260KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 64KBS audio bit rate, 180p height and generated with codec profile H.264/ Baseline.\n9. `MP4_300KBS_15FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 300KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height.\n10. `MP4_300KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 300KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline.\n11. `MP4_320KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 320KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 576p height and generated with codec profile H.264/ High.\n12. `MP4_375KBS_30FPS_48KHZ_192KBS_360P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 375KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 360p height and generated with codec profile H.264/ High.\n13. `MP4_450KBS_15FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 450KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height. \n14. `MP4_450KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 450KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline.\n15. `MP4_600KBS_15FPS_48KHZ_96KBS_480P`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 480p height. \n16. `MP4_600KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 480p height and generated with codec profile H.264/ Baseline.\n17. `MP4_600KBS_25FPS_48KHZ_128KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline.\n18. `MP4_600KBS_30FPS_48KHZ_128KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline.\n19. `MP4_700KBS_24FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 700KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height.\n20. `MP4_750KBS_30FPS_48KHZ_192KBS_432P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 750KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 432p height and generated with codec profile H.264/ High.\n21. `MP4_750KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 750KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 576p height and generated with codec profile H.264/ High.\n22. `MP4_900KBS_15FPS_48KHZ_96KBS_480P`: This is the processed url for video that can be used with mp4 container, 900KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 480p height. \n23. `MP4_900KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 900KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 480p height and generated with codec profile H.264/ Baseline.\n24. `MP4_1350KBS_30FPS_48KHZ_96KBS_720P`: This is the processed url for video that can be used with mp4 container, 1350KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 720p height. \n25. `MP4_1350KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.35MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 720p height and generated with codec profile H.264/ High.\n26. `MP4_1350KBS_25FPS_48KHZ_128KBS_540P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 1.35MBPS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 540p height and generated with codec profile H.264/ Main.\n27. `MP4_1500KBS_24FPS_48KHZ_96KBS_576P`: This is the processed url for video that can be used with mp4 container, 1500KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 576p height.\n28. `MP4_1500KBS_30FPS_48KHZ_192KBS_540P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.5MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 540p height and generated with codec profile H.264/ High.\n29. `MP4_1500KBS_25FPS_48KHZ_128KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.5MBPS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 576p height and generated with codec profile H.264/ High.\n30. `MP4_2000KBS_30FPS_48KHZ_96KBS_720P`: This is the processed url for video that can be used with mp4 container, 2000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 720p height. \n31. `MP4_2000KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 720p height and generated with codec profile H.264/ High.\n32. `MP4_2000KBS_30FPS_48KHZ_192KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 720p height and generated with codec profile H.264/ High.\n33. `MP4_2100KBS_30FPS_48KHZ_192KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2.1MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 576p height and generated with codec profile H.264/ High.\n34. `MP4_2100KBS_30FPS_48KHZ_192KBS_480P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 2.1MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 480p height and generated with codec profile H.264/ Main.\n35. `MP4_3400KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 3.4MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High.\n36. `MP4_3500KBS_24FPS_48KHZ_96KBS_1080P`: This is the processed url for video that can be used with mp4 container, 3500KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 1080p height.\n37. `MP4_3500KBS_30FPS_48KHZ_128KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 3.5MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 720p height and generated with codec profile H.264/ High.\n38. `MP4_4000KBS_30FPS_48KHZ_192KBS_1080P`: This is the processed url for video that can be used with mp4 container, 4000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate and 1080p height. \n39. `MP4_4000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 4MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High.\n40. `MP4_10000KBS_30FPS_48KHZ_320KBS_1080P`: This is the processed url for video that can be used with mp4 container, 10000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 320KBS audio bit rate and 1080p height. \n41. `MP4_10000KBS_30FPS_48KHZ_320KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 10MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 320KBS audio bit rate, 1080p height and generated with codec profile H.264/ High.\n42. `MP4_20000KBS_AUTOFPS_48KHZ_320KBS`: This is the processed url for video that can be used with mp4 container, 20000KBS bitrate, auto fps, 48KHZ sampleRate, 320KBS audio bit rate.\n43. `MP4_20000KBS_AUTOFPS_48KHZ_320KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 20MBPS bitrate, auto fps, 48KHZ sampleRate, 320KBS audio bit rate, 1080p height and generated with codec profile H.264/ High.\n44. `MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 25MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High.\n45. `MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 25MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ Main.","type":"string","enum":["MODERATION","IMAGE_THUMBNAIL_500","VIDEO_DEFAULT_OPTIMIZED","PRODUCT_VIDEO_OPTIMIZED","BACKGROUND_VIDEO_TILE","VIDEO_TILE","INTRO_SPLASH","MP4_260KBS_25FPS_48KHZ_64KBS_180P_H264_BASELINE","MP4_300KBS_15FPS_48KHZ_96KBS_360P","MP4_300KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE","MP4_320KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH","MP4_375KBS_30FPS_48KHZ_192KBS_360P_H264_HIGH","MP4_450KBS_15FPS_48KHZ_96KBS_360P","MP4_450KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE","MP4_600KBS_15FPS_48KHZ_96KBS_480P","MP4_600KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE","MP4_600KBS_25FPS_48KHZ_128KBS_360P_H264_BASELINE","MP4_600KBS_30FPS_48KHZ_128KBS_360P_H264_BASELINE","MP4_700KBS_24FPS_48KHZ_96KBS_360P","MP4_750KBS_30FPS_48KHZ_192KBS_432P_H264_HIGH","MP4_750KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH","MP4_900KBS_15FPS_48KHZ_96KBS_480P","MP4_900KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE","MP4_1350KBS_30FPS_48KHZ_96KBS_720P","MP4_1350KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH","MP4_1350KBS_25FPS_48KHZ_128KBS_540P_H264_MAIN","MP4_1500KBS_24FPS_48KHZ_96KBS_576P","MP4_1500KBS_30FPS_48KHZ_192KBS_540P_H264_HIGH","MP4_1500KBS_25FPS_48KHZ_128KBS_576P_H264_HIGH","MP4_2000KBS_30FPS_48KHZ_96KBS_720P","MP4_2000KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH","MP4_2000KBS_30FPS_48KHZ_192KBS_720P_H264_HIGH","MP4_2100KBS_30FPS_48KHZ_192KBS_576P_H264_HIGH","MP4_2100KBS_30FPS_48KHZ_192KBS_480P_H264_MAIN","MP4_3400KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH","MP4_3500KBS_24FPS_48KHZ_96KBS_1080P","MP4_3500KBS_30FPS_48KHZ_128KBS_720P_H264_HIGH","MP4_4000KBS_30FPS_48KHZ_192KBS_1080P","MP4_4000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH","MP4_10000KBS_30FPS_48KHZ_320KBS_1080P","MP4_10000KBS_30FPS_48KHZ_320KBS_1080P_H264_HIGH","MP4_20000KBS_AUTOFPS_48KHZ_320KBS","MP4_20000KBS_AUTOFPS_48KHZ_320KBS_1080P_H264_HIGH","MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH","MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_MAIN"]},"programs":{"type":"array","items":{"type":"string","description":"Use this field to specify which program you are uploading an asset for. Currently, the accepted value here on registration is to associate an asset with a DSP advertiser.","enum":["A_PLUS","INTEGRATED_VIDEO_EXPERIENCE","SB","POSTS","STORES","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","AMAZON_DSP","FIRE_TV","SPONSORED_TV","PRODUCT_DESCRIPTION_PAGE"]}},"url":{"type":"string"}}}},"defaultUrl":{"type":"string"}}},"otherMetadata":{"description":"Include key-value pairs related to the asset. For DSP use \"dspAdvertiserId\" = \"ID\". Include program as AMAZON_DSP.","additionalProperties":{"type":"string"},"type":"object","example":{"dspAdvertiserId":"string"}},"url":{"description":"The URL of the asset.","type":"string"},"assetSubTypes":{"description":"1. For assetType `IMAGE` acceptable assetSubTypes are `LOGO`, `PRODUCT_IMAGE`, `AUTHOR_IMAGE`, `LIFESTYLE_IMAGE`, `OTHER_IMAGE`\n\n2. For assetType `VIDEO` acceptable assetSubtype is `BACKGROUND_VIDEO`.","minItems":1,"maxItems":10,"type":"array","items":{"type":"string","enum":["LOGO","PRODUCT_IMAGE","AUTHOR_IMAGE","LIFESTYLE_IMAGE","OTHER_IMAGE","BACKGROUND_VIDEO"]}},"fileMetadata":{"type":"object","properties":{"duration":{"format":"double","type":"number"},"extension":{"description":"The extension of the file name.","type":"string"},"fileSize":{"description":"The asset size in bytes.","type":"number"},"resolutionHeight":{"type":"integer"},"width":{"description":"The width of the asset in pixels.","type":"number"},"aspectRatio":{"pattern":"[0-9]+:[0-9]+","description":"The aspect ration of the asset.","type":"string"},"resolutionWidth":{"type":"integer"},"contentType":{"description":"The content type of the asset.","type":"string","enum":["jpeg","jpg","png","mp4","image/jpg","image/jpeg","image/png"]},"audioSampleRate":{"format":"double","type":"number"},"height":{"description":"The height of the asset in pixels.","type":"number"}}},"createdBy":{"type":"string"},"name":{"pattern":"[\\w]+\\.jpg|png|mp4|mov|wmv|avi","description":"The fileName of the asset.","type":"string"},"lastUpdatedTime":{"format":"int64","type":"integer"},"versionNotes":{"description":"The URL of the asset","type":"string"},"assetStatus":{"type":"string","enum":["ACTIVE","PROCESSING","ARCHIVED"]},"failedSpecChecks":{"description":"Specification Checks for all programs","type":"array","items":{"description":"Specification Check for program, This contains program name and specifications","type":"object","properties":{"specProgramName":{"type":"string","enum":["SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","SPONSORED_DISPLAY_LANDSCAPE_VIDEO","SPONSORED_DISPLAY_PORTRAIT_VIDEO","SPONSORED_DISPLAY_SQUARE_VIDEO","STORES_VIDEO_TILE","STORES_BACKGROUND_VIDEO_TILE","STORES_INTRO_SPLASH","FIRE_TV_FEATURE_ROTATOR","SPONSORED_TV","SPONSORED_BRANDS_VIDEO_PORTRAIT","DEMAND_SIDE_PLATFORM_OTT","DEMAND_SIDE_PLATFORM_OLV","DEMAND_SIDE_PLATFORM_H1_DESKTOP","DEMAND_SIDE_PLATFORM_H1_MOBILE","LIVE_IMAGE_SPONSORED_DISPLAY"]},"specifications":{"description":"List of specifications","type":"array","items":{"description":"Structure containing specification\n stringId: This is the translated string Id, client will be retrieving the translation corresponding to this string.\n failureReason: This specifies the failure reason of specification. \n arguments: Arguments required for translation string.\n isPassed: Whether spec got passed or failed.\n actualValue: If spec got failed then this attribute represent the actual value of the spec parameter in the file.","type":"object","properties":{"stringId":{"type":"string"},"isPassed":{"type":"boolean"},"failureReason":{"type":"string"},"actualValue":{"type":"string"},"arguments":{"description":"List of arguments for translation string","type":"array","items":{"type":"string"}}}}}}}},"storageLocationUrls":{"type":"object","properties":{"processedUrls":{"description":"Map containing processed urls of the asset. Key is the processed type and value is the url","additionalProperties":{"type":"object"},"type":"object","example":{"MODERATION":"http://abc.xyz"}},"defaultUrl":{"type":"string"}}},"moderationContentList":{"type":"array","items":{"type":"object","properties":{"assetSubType":{"type":"string","enum":["LOGO","PRODUCT_IMAGE","AUTHOR_IMAGE","LIFESTYLE_IMAGE","OTHER_IMAGE","BACKGROUND_VIDEO"]},"adPolicyModerationResultList":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"marketplaceId":{"type":"string"},"policyName":{"type":"string"},"moderationStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING"]},"locale":{"type":"string"}}}},"moderationContentStatus":{"type":"string","enum":["IN_PROGRESS","COMPLETED","FAILED"]}}}}}}},"assetGlobal":{"type":"object","properties":{"assetId":{"description":"The asset identifier.","type":"string"},"assetType":{"description":"The asset type you are registering [`IMAGE`, `VIDEO`]","type":"string","enum":["IMAGE","VIDEO"]},"accountIds":{"description":"The list of advertiser accounts the asset can be shared with. All the accounts within this list will be able to search this asset. Additional validation of checking that the accounts are associated will be done as part of this call.","type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}},"marketplaceId":{"description":"The list of marketplace Ids.","type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.creativeassetsgetresponse.v3+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetsgetresponse.v3+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"Forbidden Operation","content":{"application/vnd.creativeassetsgetresponse.v3+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.creativeassetsgetresponse.v3+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":true},{"schema":{"type":"string"},"in":"query","name":"assetId","description":"The assetId","required":true},{"schema":{"type":"string"},"in":"query","name":"version","description":"The versionId of the asset, if not included all versions will return.","required":false}],"tags":["Creative assets"]}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/getAsset","sectionHeader":{"type":3,"text":"GET /assets"},"summary":"Retrieve an asset","documentType":"api-reference"},{"title":"Creative assets","content":["/assets/batchRegister/{requestId}",{"summary":"Retrieves status of the batch asset registration request, uniquely identified by requestId.","operationId":"getAssetsBatchRegister","responses":{"200":{"description":"Registration status of each media file( uniquely identified by their url).","content":{"application/vnd.creativeassetsgetbatchregisterresponse.v3+json":{"schema":{"title":"GetBatchRegisterAssetStatusOutput","type":"object","properties":{"registrationStatus":{"description":"Possible statuses of batch registration request","type":"string","enum":["FAILED","IN_PROGRESS","COMPLETE"]},"successfullyRegisteredAssets":{"description":"List containing successful registration details","type":"array","minItems":0,"maxItems":100,"items":{"description":"Structure containing details of successful registration for each url in a batch registration request.","type":"object","properties":{"url":{"type":"string","description":"Url of the media file as provided in the input of batch registration request."},"assetIdentifier":{"type":"object","properties":{"assetId":{"description":"The asset identifier.","type":"string"},"version":{"description":"The version of the asset.","type":"string"}}}}}},"inProgressAssetDetails":{"description":"List containing in progress registration details","type":"array","minItems":0,"maxItems":100,"items":{"description":"Structure containing details of in progress registration for each url in a batch registration request.","type":"object","properties":{"url":{"type":"string","description":"Url of the media file as provided in the input of batch registration request."}}}},"failedAssetDetails":{"description":"List containing failed registration details","type":"array","minItems":0,"maxItems":100,"items":{"description":"Structure containing details of registration failure for each url in a batch registration request.","type":"object","properties":{"url":{"type":"string","description":"Url of the media file as provided in the input of batch registration request."},"failureReason":{"type":"string","description":"Failure reason for registration of media file identified by corresponding url in batch registration request."}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.creativeassetsgetbatchregisterresponse.v3+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetsgetbatchregisterresponse.v3+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"Forbidden Operation","content":{"application/vnd.creativeassetsgetbatchregisterresponse.v3+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"429":{"description":"Operation Throttled.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"429 request throttled","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.creativeassetsgetbatchregisterresponse.v3+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":true},{"schema":{"type":"string"},"in":"path","name":"requestId","description":"Batch asset registration request id. It is returned in response of POST /assets/batchRegister API.","required":true}],"tags":["Creative assets"]}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/getAssetsBatchRegister","sectionHeader":{"type":3,"text":"GET /assets/batchRegister/{requestId}"},"summary":"Retrieves status of the batch asset registration request, uniquely identified by requestId.","documentType":"api-reference"},{"title":"Creative assets","content":["/assets/batchRegister",{"tags":["Creative assets"],"summary":"Batch register uploaded assets","description":"This is an asynchronous api that provides clients an identifier for their batch registration request. They need to check for the status of their request by calling the `GET /assets/batchRegister/{requestId}` api with the identifier.","operationId":"assetsBatchRegister","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Batch Register Uploaded Assets.","content":{"application/vnd.assetsbatchregisterrequest.v1+json":{"schema":{"title":"AssetsBatchRegisterRequest","type":"object","properties":{"assetDetailsList":{"maxItems":50,"minItems":1,"type":"array","description":"List containing details of assets to register.","items":{"type":"object","properties":{"asinList":{"minItems":1,"maxItems":100,"description":"Tagging assets with ASIN, promotes asset discoverability downstream. If ASIN is provided at the time of upload/during asset registration, it is applied as a tag on that asset. This allows for that asset to be searchable using that ASIN#. For e.g., An advertiser may want to search for assets tagged with ASIN BC10001, so they can create a store spotlight ad with product images for that ASIN.","type":"array","items":{"type":"string"}},"assetSubTypeList":{"maxItems":10,"minItems":1,"type":"array","items":{"type":"string","enum":["LOGO","PRODUCT_IMAGE","AUTHOR_IMAGE","LIFESTYLE_IMAGE","OTHER_IMAGE","BACKGROUND_VIDEO"]}},"assetType":{"description":"The asset type you are registering [`IMAGE`, `VIDEO`]","type":"string","enum":["IMAGE","VIDEO"]},"associatedPrograms":{"maxItems":100,"minItems":1,"type":"array","items":{"type":"object","properties":{"metadata":{"description":"Include key-value pairs related to the asset. For DSP use \"dspAdvertiserId\" = \"ID\". Include program as AMAZON_DSP.","additionalProperties":{"type":"string"},"type":"object","example":{"dspAdvertiserId":"string"}},"programName":{"type":"string","description":"Use this field to specify which program you are uploading an asset for. Currently, the accepted value here on registration is to associate an asset with a DSP advertiser.","enum":["A_PLUS","INTEGRATED_VIDEO_EXPERIENCE","SB","POSTS","STORES","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","AMAZON_DSP","FIRE_TV","SPONSORED_TV","PRODUCT_DESCRIPTION_PAGE"]}}}},"name":{"description":"The name to be given to the asset being registered.","type":"string"},"otherMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Any other metadata that client wants to associate with this asset."},"skipAssetSubTypesDetection":{"type":"boolean","description":"Flag to determine if asset subtype detection should be skipped."},"tagList":{"maxItems":10,"minItems":1,"type":"array","description":"List of tags.","items":{"minLength":1,"type":"string","description":"Tag Name."}},"url":{"type":"string","description":"Url of the media file to be registered as an asset."},"versionInfo":{"type":"object","properties":{"linkedAssetId":{"description":"The registering asset will be created as a new version of this linkedAssetId.","type":"string"},"versionNotes":{"description":"The version notes that client can associate to the asset.Versioning enables users to update an old asset, so that you can ensure the latest asset is being used. You can upload a new version of an existing asset along with version notes. Any tags/ASINs from previous version, will be retained on the new version too.","type":"string","maxLength":1000}}}},"description":"Object containing details for individual assets to register."}},"batchRegistrationContext":{"type":"object","description":"Contextual information for asset registration e.g. what is the source of this asset.","properties":{"assetSourceInfo":{"type":"object","description":"Details on the source of this asset and any source specific metadata to be associated against it.","properties":{"assetSourceId":{"type":"string","enum":["AMAZON_CREATIVE_SERVICES","AMAZON_VIDEO_BUILDER","ASSET_LIBRARY","SELF_SERVICE_FIRE_TV","INTEGRATED_VIDEO_EXPERIENCE","CANVA_PLUGIN","AMAZON_DSP","SPONSORED_DISPLAY","SPONSORED_BRANDS"]},"assetSourceMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Map containing source information details. Total map size should not exceed 5, with each Key's length 50 and Value's length 500.","example":{"key":"String upto length 50","value":"String upto length 500"}}}}}}}}}},"required":true},"responses":{"200":{"description":"Identifier for the batch registration request.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"title":"BatchRegisterAssetResponse","type":"object","properties":{"requestId":{"type":"string"}}}}}},"400":{"description":"Bad Request.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"Forbidden Operation.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"429":{"description":"Operation Throttled.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"429 request throttled","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}}}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/assetsBatchRegister","sectionHeader":{"type":3,"text":"POST /assets/batchRegister"},"summary":"Batch register uploaded assets","documentType":"api-reference"},{"title":"Creative assets","content":["/assets/register",{"summary":"Register an uploaded asset","x-amazon-advertising-authorization":{"permissions":["amazon_stores_edit","advertiser_campaign_edit","creatives_edit","creatives_view","campaign_view","campaign_edit"],"rules":[{"resourceType":"DSP_ACCOUNT","resourceLocation":{"parameterName":"Amazon-Ads-AccountId","in":"header"},"allowFallback":"true"}]},"requestBody":{"description":"Note - **asinList**, **versionInfo**, and **tags** are optional in the request body.","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The url to upload the asset. The url expires in 15 minutes.","type":"string"},"name":{"description":"The name to be given to the asset being registered.","type":"string"},"asinList":{"minItems":1,"maxItems":100,"description":"Tagging assets with ASIN, promotes asset discoverability downstream. If ASIN is provided at the time of upload/during asset registration, it is applied as a tag on that asset. This allows for that asset to be searchable using that ASIN#. For e.g., An advertiser may want to search for assets tagged with ASIN BC10001, so they can create a store spotlight ad with product images for that ASIN.","type":"array","items":{"type":"string"}},"assetType":{"description":"The asset type you are registering [`IMAGE`, `VIDEO`]","type":"string","enum":["IMAGE","VIDEO"]},"assetSubTypeList":{"description":"1. For assetType `IMAGE` acceptable assetSubTypes are `LOGO`, `PRODUCT_IMAGE`, `AUTHOR_IMAGE`, `LIFESTYLE_IMAGE`, `OTHER_IMAGE`\n\n2. For assetType `VIDEO` acceptable assetSubtype is `BACKGROUND_VIDEO`.","minItems":1,"maxItems":10,"type":"array","items":{"type":"string","enum":["LOGO","PRODUCT_IMAGE","AUTHOR_IMAGE","LIFESTYLE_IMAGE","OTHER_IMAGE","BACKGROUND_VIDEO"]}},"versionInfo":{"type":"object","properties":{"linkedAssetId":{"description":"The registering asset will be created as a new version of this linkedAssetId.","type":"string"},"versionNotes":{"description":"The version notes that client can associate to the asset.Versioning enables users to update an old asset, so that you can ensure the latest asset is being used. You can upload a new version of an existing asset along with version notes. Any tags/ASINs from previous version, will be retained on the new version too.","type":"string","maxLength":1000}}},"tags":{"type":"array","items":{"type":"string"}},"registrationContext":{"type":"object","description":"This is used on registration of an asset, to associate DSP assets to a specific advertiser. This is **required** for assets being uploaded for use in DSP.","properties":{"associatedPrograms":{"type":"array","items":{"type":"object","properties":{"metadata":{"description":"Include key-value pairs related to the asset. For DSP use \"dspAdvertiserId\" = \"ID\". Include program as AMAZON_DSP.","additionalProperties":{"type":"string"},"type":"object","example":{"dspAdvertiserId":"string"}},"programName":{"type":"string","description":"Use this field to specify which program you are uploading an asset for. Currently, the accepted value here on registration is to associate an asset with a DSP advertiser.","enum":["A_PLUS","INTEGRATED_VIDEO_EXPERIENCE","SB","POSTS","STORES","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","AMAZON_DSP","FIRE_TV","SPONSORED_TV","PRODUCT_DESCRIPTION_PAGE"]}}}}}},"associatedSubEntityList":{"minItems":1,"maxItems":100,"description":"This field is required for sellers, but not required for vendors. The brandEntityId is required for sellers uploading assets for use in Sponsored Brands. As a best practice, ensure to include brandEntityId when uploading assets for sellers.","type":"array","items":{"type":"object","properties":{"brandEntityId":{"description":"The entity id of brand, which can be retrieved using GET /brands.","type":"string"}}}},"skipAssetSubTypesDetection":{"description":"Select true if you want to set an asset to a specific assetSubType, if this is not included the system may reclassify your asset based on specifications.","type":"boolean"}}}}},"required":true},"description":"The API should be called once the asset is uploaded to the location\nprovided by the /asset/upload API endpoint. See [Creating assets](guides/creative-asset/creating-assets) to understand the call flow.","operationId":"registerAsset","responses":{"200":{"description":"AssetResource","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"type":"object","properties":{"assetId":{"description":"The asset identifier.","type":"string"},"versionId":{"description":"The version of the asset.","type":"string"},"failedSpecChecks":{"description":"Specification Checks for all programs","type":"array","items":{"description":"Specification Check for program, This contains program name and specifications","type":"object","properties":{"specProgramName":{"type":"string","enum":["SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","SPONSORED_DISPLAY_LANDSCAPE_VIDEO","SPONSORED_DISPLAY_PORTRAIT_VIDEO","SPONSORED_DISPLAY_SQUARE_VIDEO","STORES_VIDEO_TILE","STORES_BACKGROUND_VIDEO_TILE","STORES_INTRO_SPLASH","FIRE_TV_FEATURE_ROTATOR","SPONSORED_TV","SPONSORED_BRANDS_VIDEO_PORTRAIT","DEMAND_SIDE_PLATFORM_OTT","DEMAND_SIDE_PLATFORM_OLV","DEMAND_SIDE_PLATFORM_H1_DESKTOP","DEMAND_SIDE_PLATFORM_H1_MOBILE","LIVE_IMAGE_SPONSORED_DISPLAY"]},"specifications":{"description":"List of specifications","type":"array","items":{"description":"Structure containing specification\n stringId: This is the translated string Id, client will be retrieving the translation corresponding to this string.\n failureReason: This specifies the failure reason of specification. \n arguments: Arguments required for translation string.\n isPassed: Whether spec got passed or failed.\n actualValue: If spec got failed then this attribute represent the actual value of the spec parameter in the file.","type":"object","properties":{"stringId":{"type":"string"},"isPassed":{"type":"boolean"},"failureReason":{"type":"string"},"actualValue":{"type":"string"},"arguments":{"description":"List of arguments for translation string","type":"array","items":{"type":"string"}}}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"404":{"description":"Resource not found","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"description":"404 requested resource not found","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level."},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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."}],"tags":["Creative assets"]}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/registerAsset","sectionHeader":{"type":3,"text":"POST /assets/register"},"summary":"Register an uploaded asset","documentType":"api-reference"},{"title":"Creative assets","content":["/assets/upload",{"summary":"Create an upload location","x-amazon-advertising-authorization":{"permissions":["amazon_stores_edit","advertiser_campaign_edit","creatives_edit","creatives_view","campaign_view","campaign_edit"],"rules":[{"resourceType":"DSP_ACCOUNT","resourceLocation":{"parameterName":"Amazon-Ads-AccountId","in":"header"},"allowFallback":"true"}]},"requestBody":{"description":"Make sure to include file extension along with filename . (ie. \"filename.mp4\")","content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"pattern":"[\\w]+\\.jpg|png|mp4|mov|wmv|avi","description":"The fileName of the asset.","type":"string"}}}}},"required":true},"description":"Creates an ephemeral resource (upload location) to upload Assets to Creative Assets tool. The upload location is short lived and expires in 15 minutes.The upload location only supports PUT HTTP Method to upload the asset content. If the upload location expires, API user will get `403` Forbidden response.\n* All ad specs - sizes and policies can be found [here](https://advertising.amazon.com/resources/ad-specs/?ref_=a20m_us_hnav_spcs)\n\n* Program specific links\n1. **Stores** - [here](https://advertising.amazon.com/resources/ad-specs/stores?ref_=a20m_us_spcs_stcrgd)\n2. **SB/SBV/sponsored ads** - [here](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies?ref_=a20m_us_spcs_sbv_spcs_spadcap)\nSee [Creating assets](guides/creative-asset/creating-assets) to understand the call flow.","operationId":"getUploadLocation","responses":{"200":{"description":"Returns an upload location.","content":{"application/vnd.creativeassetsuploadresponse.v3+json":{"schema":{"type":"object","properties":{"url":{"description":"The url to upload the asset. The url expires in 15 minutes.","type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.creativeassetsuploadresponse.v3+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetsuploadresponse.v3+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"Forbidden Operation","content":{"application/vnd.creativeassetsuploadresponse.v3+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.creativeassetsuploadresponse.v3+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}},"tags":["Creative assets"],"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level."},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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."}]}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/getUploadLocation","sectionHeader":{"type":3,"text":"POST /assets/upload"},"summary":"Create an upload location","documentType":"api-reference"},{"title":"Creative assets","content":["/assets/search",{"summary":"Search assets","requestBody":{"description":"text - optional, this field matches asset name, asset name prefix, tags and ASINs associated with the assets\n\nfilterCriteria - optional, this is used to filter results\n\nsortCriteria - optional, this is used to get sorted results\n\npageCriteria - optional, this is used for pagination\n","content":{"application/json":{"schema":{"properties":{"text":{"description":"The text used for searching assets, it matches asset name, asset name prefix, tags and ASINs associated with the assets","type":"string"},"filterCriteria":{"description":"**Optional** this is used to filter results, we support two types of filters, valueFilter and rangeFilter","type":"object","properties":{"valueFilters":{"type":"array","items":{"description":"Filter for certain values of asset attributes","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"valueField":{"type":"string","enum":["TAG","ASIN","CAMPAIGN_NAME","CAMPAIGN_ID","PROGRAM","ASSET_TYPE","ASSET_SUB_TYPE","APPROVED_AD_POLICY","ASSET_EXTENSION"]}}}},"rangeFilters":{"type":"array","items":{"description":"Filter assets which have certain ranges of asset attributes.\n\nFor example, filter assets which have file size in the range of [10,20] or [40,50].\n","type":"object","properties":{"rangeField":{"anyOf":[{"type":"string","description":"File size in bytes."},{"type":"string","description":"The value for this should be timestamp in milliseconds. It is the same as creation date."}]},"ranges":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}}}}}}}},"sortCriteria":{"type":"object","properties":{"field":{"type":"string","enum":["CREATED_TIME","SIZE","NAME","IMAGE_HEIGHT","IMAGE_WIDTH","EXTENSION"]},"order":{"type":"string","enum":["ASC","DESC"]}}},"pageCriteria":{"description":"used for pagination\n\nwhen searching for the first page, no need to put anything, otherwise, use the token returned from previous search call\n","type":"object","properties":{"identifier":{"type":"object","properties":{"pageNumber":{"type":"integer"},"token":{"type":"string"}}},"size":{"type":"integer","default":25,"minimum":1,"maximum":500}}}}}}},"required":true},"operationId":"searchAssets","responses":{"200":{"description":"Returns search results","content":{"application/vnd.creativeassetssearchassetsresponse.v3+json":{"schema":{"type":"object","properties":{"totalRecords":{"format":"int64","type":"integer"},"assetList":{"type":"array","items":{"type":"object","properties":{"moderationPolicyMap":{"description":"A hashmap of key-value pairs, this is the most accurate way of defining a map in swagger 2.0","type":"object","example":{"HSA":"REJECTED","Stores":"PENDING","Logo":"APPROVED"}},"lastUpdatedBy":{"type":"string"},"creationTime":{"format":"int64","type":"integer"},"specCheckApprovedPrograms":{"description":"List of spec programs for which asset spec check is approved","type":"array","items":{"type":"string","enum":["SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","SPONSORED_DISPLAY_LANDSCAPE_VIDEO","SPONSORED_DISPLAY_PORTRAIT_VIDEO","SPONSORED_DISPLAY_SQUARE_VIDEO","STORES_VIDEO_TILE","STORES_BACKGROUND_VIDEO_TILE","STORES_INTRO_SPLASH","FIRE_TV_FEATURE_ROTATOR","SPONSORED_TV","SPONSORED_BRANDS_VIDEO_PORTRAIT","DEMAND_SIDE_PLATFORM_OTT","DEMAND_SIDE_PLATFORM_OLV","DEMAND_SIDE_PLATFORM_H1_DESKTOP","DEMAND_SIDE_PLATFORM_H1_MOBILE","LIVE_IMAGE_SPONSORED_DISPLAY"]}},"associatedAccountIds":{"type":"array","items":{"type":"string"}},"marketplaces":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"assetType":{"description":"The asset type you are registering [`IMAGE`, `VIDEO`]","type":"string","enum":["IMAGE","VIDEO"]},"fileMetadata":{"type":"object","properties":{"duration":{"format":"double","type":"number"},"extension":{"description":"The extension of the file name.","type":"string"},"fileSize":{"description":"The asset size in bytes.","type":"number"},"resolutionHeight":{"type":"integer"},"width":{"description":"The width of the asset in pixels.","type":"number"},"aspectRatio":{"pattern":"[0-9]+:[0-9]+","description":"The aspect ration of the asset.","type":"string"},"resolutionWidth":{"type":"integer"},"contentType":{"description":"The content type of the asset.","type":"string","enum":["jpeg","jpg","png","mp4","image/jpg","image/jpeg","image/png"]},"audioSampleRate":{"format":"double","type":"number"},"height":{"description":"The height of the asset in pixels.","type":"number"}}},"collections":{"type":"array","items":{"type":"string"}},"createdBy":{"type":"string"},"assetId":{"type":"string"},"storageLocationUrls":{"type":"object","properties":{"processedUrls":{"description":"Map containing processed urls of the asset. Key is the processed type and value is the url","additionalProperties":{"type":"object"},"type":"object","example":{"MODERATION":"http://abc.xyz"}},"defaultUrl":{"type":"string"}}},"name":{"type":"string"},"lastUpdatedTime":{"format":"int64","type":"integer"},"associatedContexts":{"description":"A hashmap of key-value pairs, this is the most accurate way of defining a map in swagger 2.0","type":"object","example":{"ASIN":"ContextDetailsList"}},"assetSubTypes":{"type":"array","items":{"type":"string","enum":["LOGO","PRODUCT_IMAGE","AUTHOR_IMAGE","LIFESTYLE_IMAGE","OTHER_IMAGE","BACKGROUND_VIDEO"]}},"status":{"type":"string","enum":["ACTIVE","PROCESSING","ARCHIVED"]}}}},"token":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.creativeassetssearchassetsresponse.v3+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetssearchassetsresponse.v3+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"Forbidden Operation","content":{"application/vnd.creativeassetssearchassetsresponse.v3+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.creativeassetssearchassetsresponse.v3+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":true}],"tags":["Creative assets"]}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/searchAssets","sectionHeader":{"type":3,"text":"POST /assets/search"},"summary":"Search assets","documentType":"api-reference"},{"title":"Amazon Ads API - Profiles","content":["Profiles represent an advertiser and their account's marketplace, and are used in all subsequent API calls via a management scope, Amazon-Advertising-API-Scope. Reports and all entity management operations are associated with a single profile. Advertisers cannot have more than one profile for each marketplace.\n\nAdvertisers who operate in more than one marketplace (for example, Amazon.com, Amazon.co.uk, Amazon.co.jp) will have only one profile associated with each marketplace. See this link for a list of marketplaces associated with each endpoint.\n\nTo retrieve your profile IDs, call the listProfiles operation, and include a valid authorization access token in the header. Use a profileId from the returned list as the value for the management scope (Amazon-Advertising-API-Scope) in the headers for subsequent API calls.\n"],"path":"/en-us/reference/2/profiles","sectionHeader":{"type":2,"text":"Amazon Ads API - Profiles"},"documentType":"api-reference"},{"title":"Amazon Ads API - Profiles","content":["/v2/profiles",{"tags":["Profiles"],"summary":"Gets a list of profiles.","description":"Note that this operation does not return a response unless the current account has created at least one campaign using the advertising console.","operationId":"listProfiles","parameters":[{"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","schema":{"type":"string"},"required":true},{"name":"apiProgram","in":"query","description":"Filters response to include profiles that have permissions for the specified Advertising API program only. Setting `apiProgram=billing` filters the response to include only profiles to which the user and application associated with the access token have permission to view or edit billing information.","schema":{"type":"string","enum":["billing","campaign","paymentMethod","store","report","account","posts"],"default":"campaign"}},{"name":"accessLevel","in":"query","description":"Filters response to include profiles that have specified permissions for the specified Advertising API program only. Currently, the only supported access level is `view` and `edit`. Setting `accessLevel=view` filters the response to include only profiles to which the user and application associated with the access token have view permission to the provided api program.","schema":{"type":"string","enum":["edit","view"],"default":"edit"}},{"name":"profileTypeFilter","in":"query","description":"Filters response to include profiles that are of the specified types in the comma-delimited list. Default is all types. Note that this filter performs an inclusive AND operation on the types.","schema":{"type":"string","enum":["seller","vendor","agency"]}},{"name":"validPaymentMethodFilter","in":"query","description":"Filter response to include profiles that have valid payment methods. Default is to include all profiles. Setting this filter to `true` returns only profiles with either no `validPaymentMethod` field, or the `validPaymentMethod` field set to `true`.  Setting this to `false` returns profiles with the `validPaymentMethod` field set to `false` only.","schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"array","maxItems":5000,"items":{"properties":{"profileId":{"type":"integer","format":"int64"},"countryCode":{"type":"string","readOnly":true,"description":"The countryCode for a given country\n|Region|`countryCode`|Country Name|\n|------|-----|-------|\n|NA|BR|Brazil|\n|NA|CA|Canada|\n|NA|MX|Mexico|\n|NA|US|United States|\n|EU|AE|United Arab Emirates|\n|EU|BE|Belgium| \n|EU|DE|Germany|\n|EU|EG|Egypt|\n|EU|ES|Spain|\n|EU|FR|France|\n|EU|IE|Ireland|\n|EU|IN|India|\n|EU|IT|Italy|\n|EU|NL|The Netherlands|\n|EU|PL|Poland|\n|EU|SA|Saudi Arabia| \n|EU|SE|Sweden|  \n|EU|TR|Turkey|\n|EU|UK|United Kingdom|\n|EU|ZA| South Africa |\n|FE|AU|Australia|    \n|FE|JP|Japan|\n|FE|SG|Singapore|","enum":["BR","CA","MX","US","AE","BE","DE","EG","ES","FR","IE","IN","IT","NL","PL","SA","SE","TR","UK","AU","JP","SG","ZA"]},"currencyCode":{"type":"string","readOnly":true,"description":"The currency used for all monetary values for entities under this profile.\n|Region|`countryCode`|Country Name|`currencyCode`|\n|-----|------|------|------|\n|NA|BR|Brazil|BRL|\n|NA|CA|Canada|CAD|\n|NA|MX|Mexico|MXN|\n|NA|US|United States|USD|\n|EU|AE|United Arab Emirates|AED|\n|EU|BE|Belgium|EUR|\n|EU|DE|Germany|EUR|\n|EU|EG|Egypt|EGP|\n|EU|ES|Spain|EUR|\n|EU|FR|France|EUR|\n|EU|IE|Ireland|EUR|\n|EU|IN|India|INR|\n|EU|IT|Italy|EUR|\n|EU|NL|The Netherlands|EUR|\n|EU|PL|Poland|PLN|\n|EU|SA|Saudi Arabia|SAR|\n|EU|SE|Sweden|SEK|\n|EU|TR|Turkey|TRY|\n|EU|UK|United Kingdom|GBP|\n|EU|ZA| South Africa | ZAR|\n|FE|AU|Australia|AUD|\n|FE|JP|Japan|JPY|\n|FE|SG|Singapore|SGD|","enum":["BRL","CAD","MXN","USD","AED","EUR","EGP","INR","PLN","SAR","SEK","TRY","GBP","AUD","JPY","SGD","ZAR"]},"dailyBudget":{"type":"number","readOnly":false,"description":"Note that this field applies to Sponsored Product campaigns for seller type accounts only. Not supported for vendor type accounts."},"timezone":{"type":"string","readOnly":true,"description":"The time zone used for all date-based campaign management and reporting.\n|Region|`countryCode`|Country Name|`timezone`|\n|------|-----|-----|------|\n|NA|BR|Brazil|America/Sao_Paulo|\n|NA|CA|Canada|America/Los_Angeles|\n|NA|MX|Mexico|America/Los_Angeles|\n|NA|US|United States|America/Los_Angeles|\n|EU|AE|United Arab Emirates|Asia/Dubai|\n|EU|BE|Belgium|Europe/Brussels|\n|EU|DE|Germany|Europe/Paris|\n|EU|EG|Egypt|Africa/Cairo|\n|EU|ES|Spain|Europe/Paris|\n|EU|FR|France|Europe/Paris|\n|EU|IE|Ireland|Europe/Dublin|\n|EU|IN|India|Asia/Kolkata|\n|EU|IT|Italy|Europe/Paris|\n|EU|NL|The Netherlands|Europe/Amsterdam|\n|EU|PL|Poland|Europe/Warsaw|\n|EU|SA|Saudi Arabia|Asia/Riyadh|\n|EU|SE|Sweden|Europe/Stockholm|\n|EU|TR|Turkey|Europe/Istanbul|\n|EU|UK|United Kingdom|Europe/London|\n|EU|ZA| South Africa | Africa/Johannesburg |\n|FE|AU|Australia|Australia/Sydney|\n|FE|JP|Japan|Asia/Tokyo|\n|FE|SG|Singapore|Asia/Singapore|","enum":["Africa/Cairo","America/Sao_Paulo","America/Los_Angeles","Asia/Dubai","Asia/Kolkata","Asia/Riyadh","Asia/Singapore","Asia/Tokyo","Australia/Sydney","Europe/Amsterdam","Europe/Dublin","Europe/Istanbul","Europe/London","Europe/Paris","Europe/Stockholm","Europe/Warsaw","Europe/Brussels","Africa/Johannesburg"]},"accountInfo":{"properties":{"marketplaceStringId":{"type":"string","readOnly":true,"description":"The identifier of the marketplace to which the account is associated."},"id":{"type":"string","readOnly":true,"description":"Identifier for sellers and vendors. Note that this value is not unique and may be the same across marketplace."},"type":{"type":"string","readOnly":true,"enum":["vendor","seller","agency"],"description":"The `seller` and `vendor` account types are associated with Sponsored Ads APIs. The `agency` account type is associated with DSP and Data Provider APIs."},"name":{"type":"string","readOnly":true,"description":"Account name."},"subType":{"type":"string","readOnly":true,"enum":["KDP_AUTHOR","AMAZON_ATTRIBUTION"],"description":"The account subtype."},"validPaymentMethod":{"description":"Only present for Vendors, this returns whether the Advertiser has set up a valid payment method or not.","readOnly":true,"type":"boolean"}}}}}}}}}}}],"path":"/en-us/reference/2/profiles#tag/Profiles/operation/listProfiles","sectionHeader":{"type":3,"text":"GET /v2/profiles"},"summary":"Gets a list of profiles.","documentType":"api-reference"},{"title":"Amazon Ads API - Profiles","content":["/v2/profiles",{"tags":["Profiles"],"summary":"Update the daily budget for one or more profiles.","description":"Note that this operation is only used for Sellers using Sponsored Products. This operation is not enabled for vendor type accounts.","operationId":"updateProfiles","parameters":[{"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"properties":{"profileId":{"type":"integer","format":"int64"},"countryCode":{"type":"string","readOnly":true,"description":"The countryCode for a given country\n|Region|`countryCode`|Country Name|\n|------|-----|-------|\n|NA|BR|Brazil|\n|NA|CA|Canada|\n|NA|MX|Mexico|\n|NA|US|United States|\n|EU|AE|United Arab Emirates|\n|EU|BE|Belgium| \n|EU|DE|Germany|\n|EU|EG|Egypt|\n|EU|ES|Spain|\n|EU|FR|France|\n|EU|IE|Ireland|\n|EU|IN|India|\n|EU|IT|Italy|\n|EU|NL|The Netherlands|\n|EU|PL|Poland|\n|EU|SA|Saudi Arabia| \n|EU|SE|Sweden|  \n|EU|TR|Turkey|\n|EU|UK|United Kingdom|\n|EU|ZA| South Africa |\n|FE|AU|Australia|    \n|FE|JP|Japan|\n|FE|SG|Singapore|","enum":["BR","CA","MX","US","AE","BE","DE","EG","ES","FR","IE","IN","IT","NL","PL","SA","SE","TR","UK","AU","JP","SG","ZA"]},"currencyCode":{"type":"string","readOnly":true,"description":"The currency used for all monetary values for entities under this profile.\n|Region|`countryCode`|Country Name|`currencyCode`|\n|-----|------|------|------|\n|NA|BR|Brazil|BRL|\n|NA|CA|Canada|CAD|\n|NA|MX|Mexico|MXN|\n|NA|US|United States|USD|\n|EU|AE|United Arab Emirates|AED|\n|EU|BE|Belgium|EUR|\n|EU|DE|Germany|EUR|\n|EU|EG|Egypt|EGP|\n|EU|ES|Spain|EUR|\n|EU|FR|France|EUR|\n|EU|IE|Ireland|EUR|\n|EU|IN|India|INR|\n|EU|IT|Italy|EUR|\n|EU|NL|The Netherlands|EUR|\n|EU|PL|Poland|PLN|\n|EU|SA|Saudi Arabia|SAR|\n|EU|SE|Sweden|SEK|\n|EU|TR|Turkey|TRY|\n|EU|UK|United Kingdom|GBP|\n|EU|ZA| South Africa | ZAR|\n|FE|AU|Australia|AUD|\n|FE|JP|Japan|JPY|\n|FE|SG|Singapore|SGD|","enum":["BRL","CAD","MXN","USD","AED","EUR","EGP","INR","PLN","SAR","SEK","TRY","GBP","AUD","JPY","SGD","ZAR"]},"dailyBudget":{"type":"number","readOnly":false,"description":"Note that this field applies to Sponsored Product campaigns for seller type accounts only. Not supported for vendor type accounts."},"timezone":{"type":"string","readOnly":true,"description":"The time zone used for all date-based campaign management and reporting.\n|Region|`countryCode`|Country Name|`timezone`|\n|------|-----|-----|------|\n|NA|BR|Brazil|America/Sao_Paulo|\n|NA|CA|Canada|America/Los_Angeles|\n|NA|MX|Mexico|America/Los_Angeles|\n|NA|US|United States|America/Los_Angeles|\n|EU|AE|United Arab Emirates|Asia/Dubai|\n|EU|BE|Belgium|Europe/Brussels|\n|EU|DE|Germany|Europe/Paris|\n|EU|EG|Egypt|Africa/Cairo|\n|EU|ES|Spain|Europe/Paris|\n|EU|FR|France|Europe/Paris|\n|EU|IE|Ireland|Europe/Dublin|\n|EU|IN|India|Asia/Kolkata|\n|EU|IT|Italy|Europe/Paris|\n|EU|NL|The Netherlands|Europe/Amsterdam|\n|EU|PL|Poland|Europe/Warsaw|\n|EU|SA|Saudi Arabia|Asia/Riyadh|\n|EU|SE|Sweden|Europe/Stockholm|\n|EU|TR|Turkey|Europe/Istanbul|\n|EU|UK|United Kingdom|Europe/London|\n|EU|ZA| South Africa | Africa/Johannesburg |\n|FE|AU|Australia|Australia/Sydney|\n|FE|JP|Japan|Asia/Tokyo|\n|FE|SG|Singapore|Asia/Singapore|","enum":["Africa/Cairo","America/Sao_Paulo","America/Los_Angeles","Asia/Dubai","Asia/Kolkata","Asia/Riyadh","Asia/Singapore","Asia/Tokyo","Australia/Sydney","Europe/Amsterdam","Europe/Dublin","Europe/Istanbul","Europe/London","Europe/Paris","Europe/Stockholm","Europe/Warsaw","Europe/Brussels","Africa/Johannesburg"]},"accountInfo":{"properties":{"marketplaceStringId":{"type":"string","readOnly":true,"description":"The identifier of the marketplace to which the account is associated."},"id":{"type":"string","readOnly":true,"description":"Identifier for sellers and vendors. Note that this value is not unique and may be the same across marketplace."},"type":{"type":"string","readOnly":true,"enum":["vendor","seller","agency"],"description":"The `seller` and `vendor` account types are associated with Sponsored Ads APIs. The `agency` account type is associated with DSP and Data Provider APIs."},"name":{"type":"string","readOnly":true,"description":"Account name."},"subType":{"type":"string","readOnly":true,"enum":["KDP_AUTHOR","AMAZON_ATTRIBUTION"],"description":"The account subtype."},"validPaymentMethod":{"description":"Only present for Vendors, this returns whether the Advertiser has set up a valid payment method or not.","readOnly":true,"type":"boolean"}}}}}}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"profileId":{"type":"integer","format":"int64"},"code":{"type":"string"},"details":{"type":"string"}}}}}}}}}],"path":"/en-us/reference/2/profiles#tag/Profiles/operation/updateProfiles","sectionHeader":{"type":3,"text":"PUT /v2/profiles"},"summary":"Update the daily budget for one or more profiles.","documentType":"api-reference"},{"title":"Amazon Ads API - Profiles","content":["/v2/profiles/{profileId}",{"tags":["Profiles"],"summary":"Gets a profile specified by identifier.","description":"This operation does not return a response unless the current account has created at least one campaign using the advertising console.","operationId":"getProfileById","parameters":[{"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","schema":{"type":"string"},"required":true},{"name":"profileId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"profileId":{"type":"integer","format":"int64"},"countryCode":{"type":"string","readOnly":true,"description":"The countryCode for a given country\n|Region|`countryCode`|Country Name|\n|------|-----|-------|\n|NA|BR|Brazil|\n|NA|CA|Canada|\n|NA|MX|Mexico|\n|NA|US|United States|\n|EU|AE|United Arab Emirates|\n|EU|BE|Belgium| \n|EU|DE|Germany|\n|EU|EG|Egypt|\n|EU|ES|Spain|\n|EU|FR|France|\n|EU|IE|Ireland|\n|EU|IN|India|\n|EU|IT|Italy|\n|EU|NL|The Netherlands|\n|EU|PL|Poland|\n|EU|SA|Saudi Arabia| \n|EU|SE|Sweden|  \n|EU|TR|Turkey|\n|EU|UK|United Kingdom|\n|EU|ZA| South Africa |\n|FE|AU|Australia|    \n|FE|JP|Japan|\n|FE|SG|Singapore|","enum":["BR","CA","MX","US","AE","BE","DE","EG","ES","FR","IE","IN","IT","NL","PL","SA","SE","TR","UK","AU","JP","SG","ZA"]},"currencyCode":{"type":"string","readOnly":true,"description":"The currency used for all monetary values for entities under this profile.\n|Region|`countryCode`|Country Name|`currencyCode`|\n|-----|------|------|------|\n|NA|BR|Brazil|BRL|\n|NA|CA|Canada|CAD|\n|NA|MX|Mexico|MXN|\n|NA|US|United States|USD|\n|EU|AE|United Arab Emirates|AED|\n|EU|BE|Belgium|EUR|\n|EU|DE|Germany|EUR|\n|EU|EG|Egypt|EGP|\n|EU|ES|Spain|EUR|\n|EU|FR|France|EUR|\n|EU|IE|Ireland|EUR|\n|EU|IN|India|INR|\n|EU|IT|Italy|EUR|\n|EU|NL|The Netherlands|EUR|\n|EU|PL|Poland|PLN|\n|EU|SA|Saudi Arabia|SAR|\n|EU|SE|Sweden|SEK|\n|EU|TR|Turkey|TRY|\n|EU|UK|United Kingdom|GBP|\n|EU|ZA| South Africa | ZAR|\n|FE|AU|Australia|AUD|\n|FE|JP|Japan|JPY|\n|FE|SG|Singapore|SGD|","enum":["BRL","CAD","MXN","USD","AED","EUR","EGP","INR","PLN","SAR","SEK","TRY","GBP","AUD","JPY","SGD","ZAR"]},"dailyBudget":{"type":"number","readOnly":false,"description":"Note that this field applies to Sponsored Product campaigns for seller type accounts only. Not supported for vendor type accounts."},"timezone":{"type":"string","readOnly":true,"description":"The time zone used for all date-based campaign management and reporting.\n|Region|`countryCode`|Country Name|`timezone`|\n|------|-----|-----|------|\n|NA|BR|Brazil|America/Sao_Paulo|\n|NA|CA|Canada|America/Los_Angeles|\n|NA|MX|Mexico|America/Los_Angeles|\n|NA|US|United States|America/Los_Angeles|\n|EU|AE|United Arab Emirates|Asia/Dubai|\n|EU|BE|Belgium|Europe/Brussels|\n|EU|DE|Germany|Europe/Paris|\n|EU|EG|Egypt|Africa/Cairo|\n|EU|ES|Spain|Europe/Paris|\n|EU|FR|France|Europe/Paris|\n|EU|IE|Ireland|Europe/Dublin|\n|EU|IN|India|Asia/Kolkata|\n|EU|IT|Italy|Europe/Paris|\n|EU|NL|The Netherlands|Europe/Amsterdam|\n|EU|PL|Poland|Europe/Warsaw|\n|EU|SA|Saudi Arabia|Asia/Riyadh|\n|EU|SE|Sweden|Europe/Stockholm|\n|EU|TR|Turkey|Europe/Istanbul|\n|EU|UK|United Kingdom|Europe/London|\n|EU|ZA| South Africa | Africa/Johannesburg |\n|FE|AU|Australia|Australia/Sydney|\n|FE|JP|Japan|Asia/Tokyo|\n|FE|SG|Singapore|Asia/Singapore|","enum":["Africa/Cairo","America/Sao_Paulo","America/Los_Angeles","Asia/Dubai","Asia/Kolkata","Asia/Riyadh","Asia/Singapore","Asia/Tokyo","Australia/Sydney","Europe/Amsterdam","Europe/Dublin","Europe/Istanbul","Europe/London","Europe/Paris","Europe/Stockholm","Europe/Warsaw","Europe/Brussels","Africa/Johannesburg"]},"accountInfo":{"properties":{"marketplaceStringId":{"type":"string","readOnly":true,"description":"The identifier of the marketplace to which the account is associated."},"id":{"type":"string","readOnly":true,"description":"Identifier for sellers and vendors. Note that this value is not unique and may be the same across marketplace."},"type":{"type":"string","readOnly":true,"enum":["vendor","seller","agency"],"description":"The `seller` and `vendor` account types are associated with Sponsored Ads APIs. The `agency` account type is associated with DSP and Data Provider APIs."},"name":{"type":"string","readOnly":true,"description":"Account name."},"subType":{"type":"string","readOnly":true,"enum":["KDP_AUTHOR","AMAZON_ATTRIBUTION"],"description":"The account subtype."},"validPaymentMethod":{"description":"Only present for Vendors, this returns whether the Advertiser has set up a valid payment method or not.","readOnly":true,"type":"boolean"}}}}}}}}}}],"path":"/en-us/reference/2/profiles#tag/Profiles/operation/getProfileById","sectionHeader":{"type":3,"text":"GET /v2/profiles/{profileId}"},"summary":"Gets a profile specified by identifier.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["Use the Amazon Ads API for Sponsored Products for campaign, ad group, keyword, negative keyword, and product ad management operations. For more information about Sponsored Products, see the Sponsored Products Support Center. For onboarding information, see the account setup topic.  Note: This contract contains endpoints with upcoming planned deprecations. For more information on the latest versions and migration details, see Deprecations. \n"],"path":"/en-us/sponsored-products/2-0/openapi","sectionHeader":{"type":2,"text":"DEPRECATED - Amazon Ads API - Sponsored Products"},"documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/adGroups/{adGroupId}/bidRecommendations",{"tags":["Bid recommendations"],"operationId":"getAdGroupBidRecommendations","summary":"DEPRECATED - Gets a bid recommendation for an ad group.","deprecated":true,"description":"**Deprecation notice: This endpoint will be deprecated on March 27, 2024. Use [theme-based bid recommendations](/API/docs/en-us/sponsored-products/3-0/openapi/prod#/ThemeBasedBidRecommendation/GetThemeBasedBidRecommendationForAdGroup_v1) going forward.**","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of an existing ad group.","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"adGroupId":{"description":"The identifier of the ad group.","type":"number"},"suggestedBid":{"description":"Information about the recommended bid.","type":"object","properties":{"suggested":{"description":"The bid recommendation.","type":"number"},"rangeStart":{"description":"The lower bound bid recommendation.","type":"number"},"rangeEnd":{"description":"The upper bound bid recommendation.","type":"number"}}}}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"Either the specified ad group identifier was not found, or the specified ad group was found but no associated bid was found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Bid%20recommendations/operation/getAdGroupBidRecommendations","sectionHeader":{"type":3,"text":"GET /v2/sp/adGroups/{adGroupId}/bidRecommendations"},"summary":"DEPRECATED - Gets a bid recommendation for an ad group.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/keywords/{keywordId}/bidRecommendations",{"tags":["Bid recommendations"],"operationId":"getKeywordBidRecommendations","summary":"DEPRECATED - Gets a bid recommendation for a keyword. [PLANNED DEPRECATION 3/27/2024]","deprecated":true,"description":"**Deprecation notice: This endpoint will be deprecated on March 27, 2024. Use [theme-based bid recommendations](/API/docs/en-us/sponsored-products/3-0/openapi/prod#/ThemeBasedBidRecommendation/GetThemeBasedBidRecommendationForAdGroup_v1) going forward.**","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"keywordId","in":"path","description":"The identifier of an existing keyword.","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"keywordId":{"description":"The identifier of the keyword that the bid is associated with.","type":"number"},"adGroupId":{"description":"The identifier of the ad group that the bid is associated with.","type":"number"},"suggestedBid":{"description":"Information about the recommended bid.","type":"object","properties":{"suggested":{"description":"The bid recommendation.","type":"number"},"rangeStart":{"description":"The lower bound bid recommendation.","type":"number"},"rangeEnd":{"description":"The upper bound bid recommendation.","type":"number"}}}}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Bid%20recommendations/operation/getKeywordBidRecommendations","sectionHeader":{"type":3,"text":"GET /v2/sp/keywords/{keywordId}/bidRecommendations"},"summary":"DEPRECATED - Gets a bid recommendation for a keyword. [PLANNED DEPRECATION 3/27/2024]","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/keywords/bidRecommendations",{"tags":["Bid recommendations"],"operationId":"createKeywordBidRecommendations","summary":"DEPRECATED - Gets bid recommendations for keywords.","deprecated":true,"description":"**Deprecation notice: This endpoint will be deprecated on March 27, 2024. Use [theme-based bid recommendations](/API/docs/en-us/sponsored-products/3-0/openapi/prod#/ThemeBasedBidRecommendation/GetThemeBasedBidRecommendationForAdGroup_v1) going forward.**","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of keyword bid recommendation objects.","content":{"application/json":{"schema":{"properties":{"adGroupId":{"description":"The identifier of the ad group that the keywords are associated with.","type":"number"},"keywords":{"description":"An array of keyword data objects.","type":"array","items":{"type":"object","properties":{"keyword":{"description":"The keyword text.","type":"string"},"matchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]}}},"minItems":0,"maxItems":5000}}}}}},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"properties":{"adGroupId":{"description":"The identifier of the ad group that the recommendations are associated with.","type":"string"},"recommendations":{"description":"An array of bid recommendation objects.","type":"array","items":{"properties":{"code":{"description":"The resulting status code for retrieving the bid.","type":"string","enum":["SUCCESS","NOT_FOUND"]},"keyword":{"description":"The keyword text.","type":"string"},"matchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]},"suggestedBid":{"description":"Information about the recommended bid.","type":"object","properties":{"suggested":{"description":"The bid recommendation.","type":"number"},"rangeStart":{"description":"The lower bound bid recommendation.","type":"number"},"rangeEnd":{"description":"The upper bound bid recommendation.","type":"number"}}}}}}}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Bid%20recommendations/operation/createKeywordBidRecommendations","sectionHeader":{"type":3,"text":"POST /v2/sp/keywords/bidRecommendations"},"summary":"DEPRECATED - Gets bid recommendations for keywords.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/adGroups/{adGroupId}/suggested/keywords",{"tags":["Suggested keywords"],"operationId":"getAdGroupSuggestedKeywords","summary":"DEPRECATED - Gets suggested keywords for the specified ad group.","deprecated":true,"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of a valid ad group.","required":true,"schema":{"type":"number"}},{"name":"maxNumSuggestions","in":"query","description":"The maximum number of suggested keywords for the response.","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000}},{"name":"adStateFilter","in":"query","description":"Filters results to ad groups with state matching the comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"]}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"suggestededKeywords":{"description":"An array of suggested keywords.","type":"array","items":{"type":"string"}}}}}}},"400":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Suggested%20keywords/operation/getAdGroupSuggestedKeywords","sectionHeader":{"type":3,"text":"GET /v2/sp/adGroups/{adGroupId}/suggested/keywords"},"summary":"DEPRECATED - Gets suggested keywords for the specified ad group.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/adGroups/{adGroupId}/suggested/keywords/extended",{"tags":["Suggested keywords"],"operationId":"getAdGroupSuggestedKeywordsEx","summary":"DEPRECATED - Gets suggested keywords with extended data for the specified ad group.","deprecated":true,"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of a valid ad group.","required":true,"schema":{"type":"number"}},{"name":"maxNumSuggestions","in":"query","description":"The maximum number of suggested keywords for the response.","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000}},{"name":"suggestBids","in":"query","description":"Set to `yes` to include a suggest bid for the suggested keyword in the response. Otherwise, set to `no`.","schema":{"type":"string","default":"no","enum":["yes","no"]}},{"name":"adStateFilter","in":"query","description":"Filters results to ad groups with state matching the comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"]}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"campaignId":{"description":"The campaign identifier.","type":"number"},"keywordText":{"description":"The suggested keyword.","type":"string"},"matchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]},"state":{"description":"The state of the ad for which the keyword is suggested.","type":"string","enum":["enabled","paused"]},"bid":{"description":"The suggested bid for the suggested keyword. Note that this field will not be included in the response if the `suggestBids` query parameter is set to `no` in the request.","type":"number"}}}}}}},"400":{"description":"One or more query parameters contained an invalid value.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Suggested%20keywords/operation/getAdGroupSuggestedKeywordsEx","sectionHeader":{"type":3,"text":"GET /v2/sp/adGroups/{adGroupId}/suggested/keywords/extended"},"summary":"DEPRECATED - Gets suggested keywords with extended data for the specified ad group.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/asins/{asinValue}/suggested/keywords",{"tags":["Suggested keywords"],"operationId":"getAsinSuggestedKeywords","summary":"DEPRECATED - Gets suggested keywords for the specified ASIN.","deprecated":true,"description":"Suggested keywords are returned in an array ordered by descending effectiveness.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"asinValue","in":"path","required":true,"description":"An ASIN.","schema":{"type":"string"}},{"name":"maxNumSuggestions","in":"query","description":"The maximum number of suggested keywords for the response.","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"asin":{"description":"The ASIN for which keywords are suggested.","type":"string"},"suggestedKeywords":{"description":"The list of suggested keywords.","type":"array","items":{"type":"object","properties":{"keywordText":{"description":"The text of the suggested keyword.","type":"string"},"matchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]}}}}}}}}},"400":{"description":"One or more query parameters contained an invalid value.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Suggested%20keywords/operation/getAsinSuggestedKeywords","sectionHeader":{"type":3,"text":"GET /v2/sp/asins/{asinValue}/suggested/keywords"},"summary":"DEPRECATED - Gets suggested keywords for the specified ASIN.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/asins/suggested/keywords",{"tags":["Suggested keywords"],"operationId":"bulkGetAsinSuggestedKeywords","summary":"DEPRECATED - Gets suggested keyword for a specified list of ASINs.","deprecated":true,"description":"Suggested keywords are returned in an array ordered by descending effectiveness.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"asins":{"description":"A list of ASINs.","type":"array","items":{"type":"string"}},"maxNumSuggestions":{"description":"The maximum number of suggested keywords in the response.","type":"integer","minItems":1,"maxItems":1000,"default":100}}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]}}}}}}},"400":{"description":"One or more query parameters contained an invalid value.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Suggested%20keywords/operation/bulkGetAsinSuggestedKeywords","sectionHeader":{"type":3,"text":"POST /v2/sp/asins/suggested/keywords"},"summary":"DEPRECATED - Gets suggested keyword for a specified list of ASINs.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/targets/bidRecommendations",{"tags":["Bid recommendations"],"operationId":"getBidRecommendations","summary":"DEPRECATED - Gets a list of bid recommendations for keyword, product, or auto targeting expressions.","deprecated":true,"requestBody":{"description":"An ad group identifier and list of associated targeting expressions for which to generate bid recommendations. Note that targeting expressions are required to be of the same type. That is, all targeting expressions in the list must be one of **keyword**, **product**, or **auto** target types.","content":{"application/json":{"schema":{"type":"object","properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"expressions":{"description":"The list of targeting expressions.","type":"array","items":{"type":"array","items":{"properties":{"value":{"description":"The expression value","type":"string"},"type":{"description":"The type of targeting expression. You can specify values for the following predicates:\n| Predicate | Description |\n| --- | --- |\n| `asinCategorySameAs` | Negatively Target the same category as the category expressed. |\n| `asinBrandSameAs` | Target the brand that is the same as the brand expressed. |\n| `asinPriceLessThan` | Target a price that is less than the price expressed. |\n| `asinPriceBetween` | Target a price that is between the prices expressed. |\n| `asinPriceGreaterThan` | Target a price that is greater than the price expressed. |\n| `asinReviewRatingLessThan` | Target a review rating less than the review rating that is expressed. |\n| `asinReviewRatingBetween` | Target a review rating that is between the review ratings expressed. |\n| `asinReviewRatingGreaterThan` | Target a review rating that is greater than the review rating expressed. |\n| `asinSameAs` | Target an ASIN that is the same as the ASIN expressed. |\n| `asinIsPrimeShippingEligible` | Target products that are Prime Shipping Eligible. This refinement can be applied at a category or brand level only. |\n| `asinAgeRangeSameAs` | Target an age range that is in the expressed range. This refinement can be applied for toys and games categories only. |\n| `asinGenreSameAs` | Target products related to the expressed genre. This refinement can be applied for Books and eBooks categories only.   |\n| `asinExpandedFrom` | Target a single product along with others closely related to it, including substitutes and complements.   |\n| `queryExactMatches` | Use this enum to exactly match your query with search queries.   |\n| `queryPhraseMatches` | Use this enum to match your query with search phrases.   |\n| `queryBroadMatches` | Use this enum to broadly match your query with search queries.   |","type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs","queryBroadRelMatches","queryHighRelMatches","asinSubstituteRelated","asinAccessoryRelated","asinAgeRangeSameAs","asinGenreSameAs","asinIsPrimeShippingEligible","asinExpandedFrom","queryExactMatches","queryPhraseMatches","queryBroadMatches"]}}}}}}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"recommendations":{"description":"The list of recommended bids with associated targeting expressions.","type":"array","items":{"type":"object","properties":{"suggestedBid":{"description":"Information about the recommended bid.","type":"object","properties":{"suggested":{"description":"The bid recommendation.","type":"number"},"rangeStart":{"description":"The lower bound bid recommendation.","type":"number"},"rangeEnd":{"description":"The upper bound bid recommendation.","type":"number"}}},"expression":{"properties":{"value":{"description":"The expression value","type":"string"},"type":{"description":"The type of targeting expression. You can specify values for the following predicates:\n| Predicate | Description |\n| --- | --- |\n| `asinCategorySameAs` | Negatively Target the same category as the category expressed. |\n| `asinBrandSameAs` | Target the brand that is the same as the brand expressed. |\n| `asinPriceLessThan` | Target a price that is less than the price expressed. |\n| `asinPriceBetween` | Target a price that is between the prices expressed. |\n| `asinPriceGreaterThan` | Target a price that is greater than the price expressed. |\n| `asinReviewRatingLessThan` | Target a review rating less than the review rating that is expressed. |\n| `asinReviewRatingBetween` | Target a review rating that is between the review ratings expressed. |\n| `asinReviewRatingGreaterThan` | Target a review rating that is greater than the review rating expressed. |\n| `asinSameAs` | Target an ASIN that is the same as the ASIN expressed. |\n| `asinIsPrimeShippingEligible` | Target products that are Prime Shipping Eligible. This refinement can be applied at a category or brand level only. |\n| `asinAgeRangeSameAs` | Target an age range that is in the expressed range. This refinement can be applied for toys and games categories only. |\n| `asinGenreSameAs` | Target products related to the expressed genre. This refinement can be applied for Books and eBooks categories only.   |\n| `asinExpandedFrom` | Target a single product along with others closely related to it, including substitutes and complements.   |\n| `queryExactMatches` | Use this enum to exactly match your query with search queries.   |\n| `queryPhraseMatches` | Use this enum to match your query with search phrases.   |\n| `queryBroadMatches` | Use this enum to broadly match your query with search queries.   |","type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs","queryBroadRelMatches","queryHighRelMatches","asinSubstituteRelated","asinAccessoryRelated","asinAgeRangeSameAs","asinGenreSameAs","asinIsPrimeShippingEligible","asinExpandedFrom","queryExactMatches","queryPhraseMatches","queryBroadMatches"]}}},"code":{"description":"The response code.","type":"string","enum":["SUCCESS","INVALID_ARGUMENT","NOT_FOUND","INTERNAL_ERROR","SERVER_IS_BUSY","UNAUTHORIZED"]}}}}}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Bid%20recommendations/operation/getBidRecommendations","sectionHeader":{"type":3,"text":"POST /v2/sp/targets/bidRecommendations"},"summary":"DEPRECATED - Gets a list of bid recommendations for keyword, product, or auto targeting expressions.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/{recordType}/snapshot",{"tags":["Snapshots"],"operationId":"requestSnapshot","summary":"DEPRECATED - Request a snapshot","deprecated":true,"description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nRequest a file-based snapshot of all entities of the specified type in the account satisfying the filtering criteria.\n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/get-started).","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"recordType","in":"path","required":true,"description":"The type of entity for which the snapshot is generated.","schema":{"type":"string","enum":["campaigns","adGroups","keywords","negativeKeywords","campaignNegativeKeywords","productAds","targets","negativeTargets"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"stateFilter":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"]}}}}}},"responses":{"202":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"snapshotId":{"description":"The snapshot identifier.","type":"string"},"recordType":{"description":"The record type of the report.","type":"string","enum":["campaigns","adGroups","keywords","negativeKeywords","campaignNegativeKeywords","productAds","targets","negativeTargets"]},"status":{"description":"The generation status of the snapshot.","type":"string","enum":["IN_PROGRESS","SUCCESS","FAILURE"]}}}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Snapshots/operation/requestSnapshot","sectionHeader":{"type":3,"text":"POST /v2/sp/{recordType}/snapshot"},"summary":"DEPRECATED - Request a snapshot","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/snapshots/{snapshotId}",{"tags":["Snapshots"],"operationId":"getSnapshotStatus","summary":"DEPRECATED - Get the status of a requested snapshot","deprecated":true,"description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/overview).","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"snapshotId","in":"path","required":true,"description":"The snapshot identifier.","schema":{"type":"number"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"snapshotId":{"description":"The snapshot identifier.","type":"string"},"recordType":{"description":"The record type of the report.","type":"string","enum":["campaigns","adGroups","keywords","negativeKeywords","campaignNegativeKeywords","productAds","targets","negativeTargets"]},"status":{"description":"The generation status of the snapshot.","type":"string","enum":["IN_PROGRESS","SUCCESS","FAILURE"]}}}}}},"307":{"description":"Temporary redirect.","headers":{"Location":{"schema":{"type":"string","description":"The download location of the requested snapshot."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Snapshots/operation/getSnapshotStatus","sectionHeader":{"type":3,"text":"GET /v2/sp/snapshots/{snapshotId}"},"summary":"DEPRECATED - Get the status of a requested snapshot","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/snapshots/{snapshotId}/download",{"tags":["Snapshots"],"operationId":"downloadSnapshot","summary":"DEPRECATED - Download requested snapshot","deprecated":true,"description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/get-started).","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"snapshotId","in":"path","required":true,"description":"The snapshot identifier.","schema":{"type":"number"}}],"responses":{"307":{"description":"Successful operation.","headers":{"Location":{"schema":{"type":"string","description":"Redirect URI with S3 file location containing snapshot data"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Snapshots/operation/downloadSnapshot","sectionHeader":{"type":3,"text":"GET /v2/sp/snapshots/{snapshotId}/download"},"summary":"DEPRECATED - Download requested snapshot","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["Use the Amazon Ads API for Sponsored Brands for campaign, ad group, keyword, negative keyword, drafts, Stores, landing pages, and Brands management operations. For more information about Sponsored Brands, see the Sponsored Brands Support Center. For onboarding information, see the account setup topic. \n"],"path":"/en-us/sponsored-brands/3-0/openapi","sectionHeader":{"type":2,"text":"Amazon Ads API - Sponsored Brands"},"documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/brands",{"tags":["Brands"],"summary":"getBrands","description":"Gets an array of Brand data objects for the Brand associated with the profile ID passed in the header. For more information about Brands, see [Brand Services](https://brandservices.amazon.com/).","operationId":"getBrands","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"brandTypeFilter","schema":{"type":"string","enum":["brandRegistry","bookAuthor"],"description":"| brandType | description |\n|-----------|-------------|\n| brandRegistry | The brand is in the brand registry. |\n| bookAuthor    | The brand is a book author. |"},"in":"query","description":"The returned array is filtered to include only brands with brand type set to one of the values in the specified comma-delimited list. Returns all brands if not specified."}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.brand.v3+json":{"schema":{"type":"array","items":{"properties":{"brandId":{"description":"The Brand identifier.","type":"string"},"brandEntityId":{"description":"The Brand entity identifier available exclusively for seller advertisers.","type":"string"},"brandRegistryName":{"description":"The Brand name.","type":"string"}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Brands/operation/getBrands","sectionHeader":{"type":3,"text":"GET /brands"},"summary":"getBrands","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/keywords",{"tags":["Keywords"],"operationId":"listKeywords","summary":"Gets an array of keywords, filtered by optional criteria.","description":"**Note**: Keywords associated with BrandVideo ad groups are only available in v3.2 version.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","schema":{"type":"integer","default":0},"in":"query","description":"Sets a zero-based offset into the requested set of keywords. Use in conjunction with the `count` parameter to control pagination of the returned array."},{"name":"count","schema":{"type":"integer","default":"max page size"},"in":"query","description":"Sets the number of keywords in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten keywords set `startIndex=0` and `count=10`. To return the next ten keywords, set `startIndex=10` and `count=10`, and so on."},{"name":"matchTypeFilter","schema":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"],"default":"broad,exact,phrase"},"in":"query","description":"The returned array is filtered to include only keywords with `matchType` set to one of the values in the specified comma-delimited list."},{"name":"keywordText","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords with the specified text."},{"name":"stateFilter","schema":{"type":"string","enum":["enabled","paused","archived"],"default":"enabled,paused"},"in":"query","description":"The returned array is filtered to include only keywords with 'state' set to one of the values in the specified comma-delimited list."},{"name":"campaignIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords associated with campaigns matching those specified by identifier in the comma-delimited string."},{"name":"adGroupIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords associated with ad groups matching those specified by identifier in the comma-delimited string."},{"name":"keywordIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords with identifiers matching those specified in the comma-delimited string."},{"name":"creativeType","schema":{"type":"string","enum":["productCollection","video"],"description":"collection is deprecated in favor of productCollection."},"in":"query","description":"Filter by the type of creative the campaign is associated with. To get keywords associated with non-video campaigns specify 'productCollection'. To get keywords associated with video campaigns, this must be set to 'video'. Returns all keywords if not specified."},{"name":"locale","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords with locale matching those specified string."}],"responses":{"200":{"description":"Success.","content":{"application/vnd.sbkeyword.v3.2+json":{"schema":{"type":"array","items":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[listKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords|\n|[getKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group associated with the keyword.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign associated with the keyword.","type":"integer","format":"int64"},"keywordText":{"description":"The keyword text. The maximum number of words for this string is 10.","type":"string"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"matchType":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"description":"The bid associated with the keyword. Note that this value must be less than the budget associated with the Advertiser account. For more information, see the **Keyword bid constraints by marketplace** section of the [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features) article.","type":"number"}}}}},"application/vnd.sbkeyword.v3+json":{"schema":{"type":"array","items":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[listKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords|\n|[getKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group associated with the keyword.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign associated with the keyword.","type":"integer","format":"int64"},"keywordText":{"description":"The keyword text. The maximum number of words for this string is 10.","type":"string"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"matchType":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"description":"The bid associated with the keyword. Note that this value must be less than the budget associated with the Advertiser account. For more information, see the **Keyword bid constraints by marketplace** section of the [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features) article.","type":"number"}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keywords/operation/listKeywords","sectionHeader":{"type":3,"text":"GET /sb/keywords"},"summary":"Gets an array of keywords, filtered by optional criteria.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/keywords",{"tags":["Keywords"],"operationId":"updateKeywords","summary":"Updates one or more keywords.","description":"Updates one or more targeting clauses. Operation supports a maximum list size of 100 keywords. <bold>Note</bold> that negative keywords can be updated on campaigns where campaign's serving status is not one of `archived`, `terminated`, `rejected`, or `ended`.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of keywords. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"array","maximum":100,"items":{"properties":{"keywordId":{"description":"The identifier of the keyword.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of an existing ad group to which the keyword is associated.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of an existing campaign to which the keyword is associated.","type":"integer","format":"int64"},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The bid associated with the keyword. Note that this value must be less than the budget associated with the Advertiser account. For more information, see the **Keyword bid constraints by marketplace** section of the [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features) article."}},"required":["keywordId","adGroupId","campaignId"]}}}}},"responses":{"207":{"description":"Multi-status. Note that the order of the returned array matches the order of the array passed in the request.","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keywords/operation/updateKeywords","sectionHeader":{"type":3,"text":"PUT /sb/keywords"},"summary":"Updates one or more keywords.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/keywords",{"tags":["Keywords"],"operationId":"createKeywords","summary":"Creates one or more keywords.","description":"Note that `state` can't be set at keyword creation. <br/>Note that keywords can be created on campaigns where serving status is not one of `archived`, `terminated`, `rejected`, or `ended`. <br/>Note that this operation supports a maximum list size of 100 keywords.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of keywords. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"array","maximum":100,"items":{"properties":{"adGroupId":{"description":"The identifier of an existing ad group to which the keyword is associated.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of an existing campaign to which the keyword is associated.","type":"integer","format":"int64"},"keywordText":{"type":"string","description":"The keyword text. The maximum number of words for this string is 10."},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"description":"The locale preference of the advertiser. For example, if the advertiser’s preferred language is Simplified Chinese, set the locale to `zh_CN`. Supported locales include: Simplified Chinese (locale: zh_CN) for US, UK and CA. English (locale: en_GB) for DE, FR, IT and ES.","type":"string"},"matchType":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]},"bid":{"type":"number","description":"The bid associated with the keyword. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [Keyword bid constraints by marketplace](https://advertising.amazon.com/API/docs/en-us/reference/concepts/limits#bid-constraints-by-marketplace)."}}}}}}},"responses":{"207":{"description":"Multi-status. Note that the order of the returned array matches the order of the array passed in the request.","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keywords/operation/createKeywords","sectionHeader":{"type":3,"text":"POST /sb/keywords"},"summary":"Creates one or more keywords.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/keywords/{keywordId}",{"tags":["Keywords"],"operationId":"getKeyword","summary":"Gets a keyword specified by identifier.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"keywordId","description":"The identifier of an existing keyword.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"locale","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords associated with locale matching those specified by identifier."}],"responses":{"200":{"description":"Success.","content":{"application/vnd.sbkeyword.v3+json":{"schema":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[listKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords|\n|[getKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group associated with the keyword.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign associated with the keyword.","type":"integer","format":"int64"},"keywordText":{"description":"The keyword text. The maximum number of words for this string is 10.","type":"string"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"matchType":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"description":"The bid associated with the keyword. Note that this value must be less than the budget associated with the Advertiser account. For more information, see the **Keyword bid constraints by marketplace** section of the [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features) article.","type":"number"}}}}}},"404":{"description":"Bad request. Keyword identifier not found.","content":{"application/vnd.error.v3+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keywords/operation/getKeyword","sectionHeader":{"type":3,"text":"GET /sb/keywords/{keywordId}"},"summary":"Gets a keyword specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/keywords/{keywordId}",{"tags":["Keywords"],"operationId":"archiveKeyword","summary":"Archives a keyword specified by identifier.","description":"This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See [Developer Notes](https://advertising.amazon.com/API/docs/v2/guides/developer_notes) for more information.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"keywordId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}},"404":{"description":"Bad request. Keyword identifier not found.","content":{"application/vnd.error.v3+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keywords/operation/archiveKeyword","sectionHeader":{"type":3,"text":"DELETE /sb/keywords/{keywordId}"},"summary":"Archives a keyword specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeKeywords",{"tags":["Negative keywords"],"operationId":"listNegativeKeywords","summary":"Gets an array of negative keywords, filtered by optional criteria.","description":"**Note**: Negative keywords associated with BrandVideo ad groups are only available in v3.2 version.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","schema":{"type":"integer","default":0},"in":"query","description":"Sets a zero-based offset into the requested set of negative keywords. Use in conjunction with the `count` parameter to control pagination of the returned array."},{"name":"count","schema":{"type":"integer","default":"max page size"},"in":"query","description":"Sets the number of negative keywords in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten negative keywords set `startIndex=0` and `count=10`. To return the next ten negative keywords, set `startIndex=10` and `count=10`, and so on."},{"name":"matchTypeFilter","schema":{"type":"string","description":"The negative match type. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["negativeExact","negativePhrase"]},"in":"query","description":"The returned array is filtered to include only negative keywords with `matchType` set to one of the values in the specified comma-delimited list."},{"name":"keywordText","schema":{"type":"string"},"in":"query","description":"The returned array includes only negative keywords with the specified text."},{"name":"stateFilter","schema":{"type":"string","enum":["enabled","archived"]},"in":"query","description":"The returned array includes only negative keywords with `state` set to the specified value."},{"name":"campaignIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only negative keywords associated with campaigns matching those specified by identifier in the comma-delimited string."},{"name":"adGroupIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only negative keywords associated with ad groups matching those specified by identifier in the comma-delimited string."},{"name":"keywordIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only negative keywords with identifiers matching those specified in the comma-delimited string."},{"name":"creativeType","schema":{"type":"string","enum":["productCollection","video"],"description":"collection is deprecated in favor of productCollection."},"in":"query","description":"Filter by the type of creative the campaign is associated with. To get negative keywords associated with non-video campaigns specify 'productCollection'. To get negative keywords associated with video campaigns, this must be set to 'video'. Returns all negative keywords if not specified."}],"responses":{"200":{"description":"Success.","content":{"application/vnd.sbnegativekeyword.v3.2+json":{"schema":{"type":"array","items":{"properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group associated with the keyword.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign associated with the keyword.","type":"integer","format":"int64"},"keywordText":{"description":"The keyword text. The maximum number of words for this string is 10.","type":"string"},"matchType":{"type":"string","description":"The negative match type. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["negativeExact","negativePhrase"]},"state":{"type":"string","enum":["enabled","paused","archived","draft"]}}}}},"application/vnd.sbnegativekeyword.v3+json":{"schema":{"type":"array","items":{"properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group associated with the keyword.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign associated with the keyword.","type":"integer","format":"int64"},"keywordText":{"description":"The keyword text. The maximum number of words for this string is 10.","type":"string"},"matchType":{"type":"string","description":"The negative match type. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["negativeExact","negativePhrase"]},"state":{"type":"string","enum":["enabled","paused","archived","draft"]}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20keywords/operation/listNegativeKeywords","sectionHeader":{"type":3,"text":"GET /sb/negativeKeywords"},"summary":"Gets an array of negative keywords, filtered by optional criteria.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeKeywords",{"tags":["Negative keywords"],"operationId":"updateNegativeKeywords","summary":"Updates one or more negative keywords.","description":"Updates one or more targeting clauses. Operation supports a maximum list size of 100 negative keywords. <bold>Note</bold> that negative keywords can be updated on campaigns where campaign's serving status is not one of `archived`, `terminated`, `rejected`, or `ended`.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of negative keywords.","content":{"application/json":{"schema":{"type":"array","maximum":100,"items":{"properties":{"keywordId":{"description":"The identifier of the negative keyword.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group to which the negative keyword is associated.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign to which the negative keyword is associated.","type":"integer","format":"int64"},"state":{"type":"string","enum":["enabled","archived","draft"],"description":"The current state of the negative keyword."}}}}}}},"responses":{"207":{"description":"Multi-status. Note that the order of the returned array matches the order of the array passed in the request.","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"type":"array","items":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20keywords/operation/updateNegativeKeywords","sectionHeader":{"type":3,"text":"PUT /sb/negativeKeywords"},"summary":"Updates one or more negative keywords.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeKeywords",{"tags":["Negative keywords"],"operationId":"createNegativeKeywords","summary":"Creates one or more negative keywords.","description":"Creates one or more negative targeting clauses. Operation supports a maximum list size of 100 negative keywords. The `bid` and `state` can't be set at negative keyword creation. <br/>Note that negative keywords can be created on campaigns where campaign's serving status is not one of `archived`, `terminated`, `rejected`, or `ended`.\n<br>**Note** that negative keywords *can not* be recreated for a campaign if the negative keyword has previously been associated with a campaign and subsequently archived. ","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of negative keywords.","content":{"application/json":{"schema":{"type":"array","maximum":100,"items":{"properties":{"adGroupId":{"description":"The identifier of the ad group to which the negative keyword is associated.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign to which the negative keyword is associated.","type":"integer","format":"int64"},"keywordText":{"type":"string","description":"The keyword text. Maximum length is ten words if 'matchType' is 'negativeExact'. Maximum length is 4 words if 'matchType' is 'negativePhrase'"},"matchType":{"type":"string","description":"The negative match type. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["negativeExact","negativePhrase"]}}}}}}},"responses":{"207":{"description":"Multi-status. Note that the order of the returned array matches the order of the array passed in the request.","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"type":"array","items":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20keywords/operation/createNegativeKeywords","sectionHeader":{"type":3,"text":"POST /sb/negativeKeywords"},"summary":"Creates one or more negative keywords.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeKeywords/{keywordId}",{"tags":["Negative keywords"],"operationId":"getNegativeKeyword","summary":"Gets a negative keyword specified by identifier.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"keywordId","description":"The identifier of an existing negative keyword.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success.","content":{"application/vnd.sbnegativekeyword.v3+json":{"schema":{"properties":{"keywordId":{"description":"The identifier of the negative keyword.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group to which the negative keyword is associated.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign to which the negative keyword is associated.","type":"integer","format":"int64"},"keywordText":{"type":"string","description":"The keyword text. Maximum length of string is ten words if `matchType` is set to `negativeExact`. Maximum length is 4 words if `matchType` is set to `negativePhrase`."},"matchType":{"type":"string","description":"The negative match type. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["negativeExact","negativePhrase"]},"state":{"type":"string","enum":["enabled","archived","draft"],"description":"The current state of the negative keyword."}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20keywords/operation/getNegativeKeyword","sectionHeader":{"type":3,"text":"GET /sb/negativeKeywords/{keywordId}"},"summary":"Gets a negative keyword specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeKeywords/{keywordId}",{"tags":["Negative keywords"],"operationId":"archiveNegativeKeyword","summary":"Archives a negative keyword specified by identifier.","description":"This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See [Developer Notes](https://advertising.amazon.com/API/docs/v2/guides/developer_notes) for more information.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"keywordId","description":"The identifier of an existing campaign.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success.","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}},"404":{"description":"Bad request. The specified negative keyword identifier was not found.","content":{"application/vnd.error.v3+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20keywords/operation/archiveNegativeKeyword","sectionHeader":{"type":3,"text":"DELETE /sb/negativeKeywords/{keywordId}"},"summary":"Archives a negative keyword specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/pageAsins",{"tags":["Landing page asins"],"operationId":"listAsins","summary":"Gets ASIN information for a specified address.","description":"Note that for sellers, the addresss must be a Store page. Vendors may also specify a custom landing page address. Only the `ASINs` that are directly associated on creation with a Store landing page are returned by this API. Any other `ASINs` that are not directly associated to the Store landing page or are listed on other pages are not returned by this API. This includes `ASINs` that are on Dynamic widgets, product selections, and featured deals widgets.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"pageUrl","in":"query","description":"For sellers, the address of a Store page. Vendors may also specify the address of a custom landing page. For more information, see the [Stores section](https://advertising.amazon.com/help#GPRM3ZHEXEY5RBFZ) of the Amazon Ads support center.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/vnd.pageasins.v3+json":{"schema":{"properties":{"asinList":{"description":"An array of ASINs. Note that this field is present only if there were no errors during the request. If there were errors, the `code` field is the enumerated error, and the `details` field contains a human-readable description of the error.","type":"array","readOnly":false,"items":{"description":"A single ASIN.","type":"string"}},"code":{"description":"The enumerated response code.\n| Code | Description |\n|------|--------|\n|SUCCESS| The request was successful. The `asinList` field includes all available ASINs.|\n|INVALID_ARGUMENT| The request was not successful because the address was not for a valid landing page.|\n|BAD_GATEWAY| The request failed because the landing page at the specified address did not have any ASINs.|","type":"string"},"details":{"description":"A human-readable description of the `code` field.","type":"string"}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Landing%20page%20asins/operation/listAsins","sectionHeader":{"type":3,"text":"GET /pageAsins"},"summary":"Gets ASIN information for a specified address.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/media/describe",{"tags":["Media"],"summary":"API to poll for media status","description":"API to poll for media status.\nIn order to attach media to campaign, media should be in either `PendingDeepValidation` or `Available` status.\n\n`Available` status guarantees that media has completed processing and published for usage.\n\nThough media can be attached to campaign once the status of the media transitions to `PendingDeepValidation`, media could still fail additional validation and transition to `Failed` status. For example in the context of SBV, SBV campaign can be created when status transitions to `PendingDeepValidation`, it could result in SBV campaign to be rejected later if media transitions to `Failed` status.","operationId":"describeMedia","parameters":[{"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","schema":{"type":"string"},"required":true},{"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","schema":{"type":"string"},"required":true},{"name":"mediaId","in":"query","description":"Media Identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Media Resource","content":{"*/*":{"schema":{"type":"object","properties":{"mediaId":{"type":"string","description":"The Media identifier."},"status":{"type":"string","description":"Media status:\n * `Processing` - The media is being processed\n * `PendingDeepValidation` - The media is pending additional validation carried out during media conversion.\n * `Available` - Media has successfully finished validation and conversion and the media is published.\n * `Failed` - Media processing failed\n","enum":["Processing","PendingDeepValidation","Available","Failed"]},"statusMetadata":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"description":"Additional status metadata. It is only available when status is `Failed` and `statusMetadata` provides additional detail on why media status is `Failed`. `statusMetadata` is comprised of code and message."}},"publishedMediaUrl":{"type":"string","description":"The preview URL of the media. It is only available when status is `Available`."},"originalMediaUrl":{"type":"string","description":"This is a signed URL which returns the original media in .mp4 file extension. The URL is only active for 7 days and requires to be regenerated if the video is not downloaded within 7 days. If you try to upload the downloaded video using the Asset Library API and get an error, then please retry upload after changing the file extension to .mov."}}}}}},"404":{"description":"Resource not found","content":{"*/*":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Media/operation/describeMedia","sectionHeader":{"type":3,"text":"GET /media/describe"},"summary":"API to poll for media status","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/stores/assets",{"tags":["Stores"],"operationId":"listAssets","summary":"Gets a list of assets associated with a specified brand entity identifier.","description":"For sellers or vendors, gets an array of assets associated with the specified brand entity identifier. Vendors are not required to specify a brand entity identifier, and in this case all assets associated with the vendor are returned.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"brandEntityId","in":"query","description":"For sellers, this field is required. It is the Brand entity identifier of the Brand for which assets are returned. This identifier is retrieved using the [getBrands operation](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/brands). For vendors, this field is optional. If a vendor does not specify this field, all assets associated with the vendor are returned. For more information about the [difference between a seller and a vendor](https://advertising.amazon.com/resources/faq#advertising-basics), see the Amazon Ads FAQ.","schema":{"type":"string"}},{"name":"mediaType","in":"query","description":"Specifies the media types used to filter the returned array. Currently, only the `brandLogo` type is supported. If not specified, all media types are returned.","schema":{"description":"The supported media types.","type":"string","enum":["brandLogo","image"]}}],"responses":{"200":{"description":"Success.","content":{"application/vnd.mediaasset.v3+json":{"schema":{"type":"array","items":{"properties":{"assetID":{"description":"The identifier of an asset associated with a store.","type":"string"},"url":{"description":"The address where the asset is stored.","type":"string"},"mediaType":{"description":"The supported media types.","type":"string","enum":["brandLogo","image"]},"name":{"description":"The name of the asset.","type":"string"}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Stores/operation/listAssets","sectionHeader":{"type":3,"text":"GET /stores/assets"},"summary":"Gets a list of assets associated with a specified brand entity identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/stores/assets",{"tags":["Stores"],"operationId":"createAsset","summary":"Creates a new image asset.","description":"Image assets are stored in the Store Assets Library. Note that there may be a delay before the image is displayed in the console.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"in":"header","name":"Content-Disposition","description":"The name of the image file.","schema":{"type":"string"},"required":true},{"in":"header","name":"Content-Type","description":"The image format type. The following table lists the valid image types:\n|Image Type|Description|\n|----------|-----------|\n|PNG|[Portable network graphics](https://en.wikipedia.org/wiki/Portable_Network_Graphics)|\n|JPEG|[JPEG](https://en.wikipedia.org/wiki/JPEG)|\n|GIF|[Graphics interchange format](https://en.wikipedia.org/wiki/GIF)|","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"assetInfo":{"description":"A JSON object specifying the Brand entity identifier an media type. The Brand entity identifier is optional, but media type is not.\n|Field|Type|Values|\n|-----|-----|-----|\n|brandEntityId|string|The Brand entity identifier.|\n|mediaType|string| Only `brandLogo` is currently supported.|\nExample:\n```\n{\n  brandEntityId: \"12345678\",\n  mediaType: {\n    \"brandLogo\"\n  }\n}\n```","type":"string"},"asset":{"description":"The binary data for the image. For more information,  File size must be smaller than 1MB, and the resolution must be a minimum of 400 pixels by 400 pixels.","type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"properties":{"assetID":{"type":"string","description":"ID of created asset"},"code":{"type":"string"},"details":{"type":"string"}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Stores/operation/createAsset","sectionHeader":{"type":3,"text":"POST /stores/assets"},"summary":"Creates a new image asset.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/recommendations/bids",{"tags":["Bid recommendations"],"operationId":"getBidsRecommendations","description":"Get a list of bid recommendation objects for a specified list of keywords or products.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of keywords or targeting expressions for which to generate bid recommendations. Note that if a value is specified for the `campaignId` field, the past performance data for the campaign may be use to create bid recommendations.","content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign for which bid recommendations are created."},"targets":{"type":"array","items":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"maxItems":100,"description":"Sum of the sizes of (targets + keywords + themeTypes) arrays should be <= 100"},"keywords":{"type":"array","items":{"type":"object","properties":{"matchType":{"type":"string","description":"MatchType should be non-null and non-empty","enum":["broad","exact","phrase"]},"keywordText":{"description":"The text of the keyword. Maximum of 10 words.","type":"string","minLength":1}}},"maxItems":100,"description":"Sum of the sizes of (targets + keywords + themeTypes) arrays should be <= 100"},"adFormat":{"type":"string","enum":["productCollection","video"],"description":"The type of ad format."},"costType":{"type":"string","description":"Optional. Support `CPC` (cost per click) and `VCPM` (cost per thousand viewable impressions).\n| costType | goal | Expected result |\n|----------|------|-----------------|\n| Empty | Empty | Recommendation will be generated for costType= `CPC` and goal=`PAGE_VISIT`.\n| Specified | Empty | It will return error and no recommendation will be generated.\n| Empty | Specified | It will use default costType based on goal selection. e.g. goal=`BRAND_IMPRESSION_SHARE` then it will use costType = `VCPM` to generate recommendation.\n| Specified | Specified | The recommendation will be based on selected goal and costType. If the mismatch then it will generate an error."},"themeTypes":{"type":"array","items":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"minItems":0,"maxItems":100,"description":"Sum of the sizes of (targets + keywords + themeTypes) arrays should be <= 100"},"goal":{"type":"string","description":"The goal type of the campaign.\nIf no goal is selected then it will default to `PAGE_VISIT`.\n| goal | description |\n|-----------|-------------|\n| BRAND_IMPRESSION_SHARE | Brand Impression Share (BIS) is Top of search (ToS) impression shares for branded search terms. |\n| PAGE_VISIT | Facilitate consumers' awareness of your brand |\n| ACQUIRE_NEW_CUSTOMERS | This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal drives new customer acquisition for your brands. |\n| AD_VIEWS | This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal maximizes view for your ads. |"}}}}}},"responses":{"200":{"description":"A list of bid recommendations.","content":{"application/vnd.sbbidsrecommendation.v3+json":{"schema":{"type":"object","properties":{"keywordsBidsRecommendationSuccessResults":{"description":"Lists the bid recommendations for the keywords specified in the request.","type":"array","items":{"type":"object","properties":{"recommendationId":{"description":"The identifier of the keyword bid recommendation.","type":"string"},"recommendedBid":{"type":"object","properties":{"rangeEnd":{"type":"number","format":"double"},"rangeStart":{"type":"number","format":"double"},"recommended":{"type":"number","format":"double"}}},"keyword":{"type":"object","properties":{"keywordText":{"description":"The text of the keyword.","type":"string"},"matchType":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]}}},"keywordIndex":{"description":"Correlates the keyword to the keyword array index specified in the request. Zero-based.","type":"number"}}}},"keywordsBidsRecommendationErrorResults":{"description":"Lists errors that occurred during creation of keyword bid recommendations.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"keyword":{"type":"object","properties":{"type":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]},"value":{"description":"The text of the keyword. Maximum of 10 words.","type":"string","minLength":1}}},"keywordIndex":{"description":"Correlates the keyword to the keyword array index specified in the request. Zero-based.","type":"number"}}}]}},"targetsBidsRecommendationSuccessResults":{"description":"Lists the bid recommendations for the keywords or targets specified in the request.","type":"array","items":{"type":"object","properties":{"recommendationId":{"description":"The identifier of the target bid recommendation."},"recommendedBid":{"type":"object","properties":{"rangeEnd":{"type":"number","format":"double"},"rangeStart":{"type":"number","format":"double"},"recommended":{"type":"number","format":"double"}}},"targets":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"targetsIndex":{"description":"Correlates the keyword to the keyword array index specified in the request. Zero-based.","type":"number"}}}},"targetsBidsRecommendationErrorResults":{"description":"Lists errors that occurred during creation of target bid recommendations.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"targets":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"targetsIndex":{"description":"Correlates the keyword to the keyword array index specified in the request. Zero-based.","type":"number"}}}]}},"themesRecommendationSuccessResults":{"description":"Lists the theme targets recommendations for the theme targets specified in the request.","type":"array","items":{"type":"object","properties":{"recommendationId":{"description":"The identifier of the target bid recommendation."},"recommendedBid":{"type":"object","properties":{"rangeEnd":{"type":"number","format":"double"},"rangeStart":{"type":"number","format":"double"},"recommended":{"type":"number","format":"double"}}},"themeType":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"themeIndex":{"description":"Correlates the theme targets to the theme targets array index specified in the request. Zero-based.","type":"number"}}},"minItems":0,"maxItems":10},"themesRecommendationErrorResults":{"description":"Lists errors that occurred during creation of theme targets bid recommendations.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"themeType":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"themeIndex":{"description":"Correlates the theme targets to the theme targets array index specified in the request. Zero-based.","type":"number"}}}]},"minItems":0,"maxItems":10}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Bid%20recommendations/operation/getBidsRecommendations","sectionHeader":{"type":3,"text":"POST /sb/recommendations/bids"},"documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/campaigns/budgetRules/recommendations",{"tags":["Budget Rules Recommendations"],"operationId":"SBGetBudgetRulesRecommendation","summary":"Gets a list of special events with suggested date range and suggested budget increase for a campaign specified by identifier.","description":"A rule enables an automatic budget increase for a specified date range or for a special event. The response also includes a suggested budget increase for each special event.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":false,"schema":{"type":"string"}},{"name":"Amazon-Ads-AccountId","in":"header","description":"The identifier of an account. The account must be a global advertising account..","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.sbbudgetrulesrecommendation.v3+json":{"schema":{"oneOf":[{"type":"object","properties":{"campaignId":{"description":"The campaign identifier.","type":"string"}},"required":["campaignId"]}],"discriminator":{"mapping":{"EVENTS_FOR_EXISTING_CAMPAIGN":"#/components/schemas/SBBudgetRulesRecommendationEventRequest"},"propertyName":"recommendationType"}}}}},"responses":{"200":{"description":"Successful Operation.","content":{"application/vnd.sbbudgetrulesrecommendation.v3+json":{"schema":{"description":"Special events with date range and suggested budget increase.","type":"object","properties":{"recommendedBudgetRuleEvents":{"description":"A list of recommended special events with date range and suggested budget increase.","type":"array","items":{"type":"object","properties":{"eventId":{"description":"The event identifier.","type":"string"},"endDate":{"description":"The end date in YYYYMMDD format.","type":"string"},"suggestedBudgetIncreasePercent":{"description":"The suggested budget increase expressed as a percent.","type":"number"},"eventName":{"description":"The event name.","type":"string"},"startDate":{"description":"The start date in YYYYMMDD format.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/vnd.sbbudgetrulesrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. Request was rate-limited. Retry later.","content":{"application/vnd.sbbudgetrulesrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server.","content":{"application/vnd.sbbudgetrulesrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Budget%20Rules%20Recommendations/operation/SBGetBudgetRulesRecommendation","sectionHeader":{"type":3,"text":"POST /sb/campaigns/budgetRules/recommendations"},"summary":"Gets a list of special events with suggested date range and suggested budget increase for a campaign specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/recommendations/keyword",{"tags":["Keyword Recommendations"],"summary":"Gets keyword recommendations","operationId":"getKeywordRecommendations","description":"Gets an array of keyword recommendation objects for a set of ASINs included either on a landing page or a Stores page. Vendors may also specify a custom landing page.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"**Must contain exactly only one of** \n\n 1.) An array of ASINs for which keyword recommendations are generated. \n\n 2.) The URL of a Stores page. Vendors may also specify the URL of a custom landing page. The products on the landing page are used to generate keyword recommendations. \n\n Optional parameters include the max number of suggestions and locale for keyword translations. Supported locales include: Simplified Chinese (locale: “zh_CN”) for US, UK and CA. English (locale:  “en_GB”) for DE, FR, IT and ES. If locale is invalid or unsupported, no translations will be returned.","content":{"application/vnd.sbkeywordrecommendation.v3+json":{"schema":{"oneOf":[{"type":"object","required":["asins"],"properties":{"asins":{"type":"array","items":{"description":"An array of landing page ASINs.","maximum":100,"type":"string","minimum":1}},"goal":{"default":"PAGE_VISIT","description":"Optionally indicate the desired goal of your campaign. Different keyword recommendations will be provided depending on your specified goal. \n|Identifier|Description|\n|----------|-----------|\n|PAGE_VISIT| Boost the visits to your landing page|\n|BRAND_IMPRESSION_SHARE| Facilitate consumers' awareness of your brand|\n|ACQUIRE_NEW_CUSTOMERS| This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal drives new customer acquisition for your brands|\n|AD_VIEWS| This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal maximizes view for your ads|<br/>","type":"string","enum":["PAGE_VISIT","BRAND_IMPRESSION_SHARE","ACQUIRE_NEW_CUSTOMERS","AD_VIEWS"]},"creativeType":{"description":"Optional SB creative type used for generating static or video generated keyword recommendations.  Inferred by asins if not included.\n|Identifier|Description|Recommendations|\n|----------|-----------|-----------|\n|PRODUCT_COLLECTION| Showcase multiple products within a branded shopping experience|Static|\n|AUTHOR_COLLECTION| Showcase books under your name that direct to your Book Brand landing page|Static|\n|STORE_SPOTLIGHT| Showcase your brand logo, headline, and up to 3 product categories or sub-pages|Static|\n|VIDEO| Display a video ad promoting a product that redirects to its landing page|Video|\n|BRAND_VIDEO| Display a branded video ad that redirects shoppers to your Brand Store landing page|Video|\n<br/>","type":"string","enum":["PRODUCT_COLLECTION","AUTHOR_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"maxNumSuggestions":{"format":"int64","description":"Maximum number of suggestions to return. Max value is 1000. If not provided, default to 100.","type":"integer"},"creativeAsins":{"type":"array","items":{"description":"Optional. An array of creative ASINs that are displayed in the SB creative.","maximum":3,"type":"string","minimum":0}},"locale":{"description":"Optional locale to request keyword suggestion translations. For example, to request Simplified Chinese translations in US, provide locale “zh_CN”. Response will include both keyword suggestions and their translations. Supported locales include: Simplified Chinese (locale: “zh_CN”) for US, UK and CA. English (locale: “en_GB”) for DE, FR, IT and ES.","type":"string"}}},{"type":"object","required":["url"],"properties":{"goal":{"default":"PAGE_VISIT","description":"Optionally indicate the desired goal of your campaign. Different keyword recommendations will be provided depending on your specified goal. \n|Identifier|Description|\n|----------|-----------|\n|PAGE_VISIT| Boost the visits to your landing page|\n|BRAND_IMPRESSION_SHARE| Facilitate consumers' awareness of your brand|\n|ACQUIRE_NEW_CUSTOMERS| This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal drives new customer acquisition for your brands|\n|AD_VIEWS| This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal maximizes view for your ads|<br/>","type":"string","enum":["PAGE_VISIT","BRAND_IMPRESSION_SHARE","ACQUIRE_NEW_CUSTOMERS","AD_VIEWS"]},"creativeType":{"description":"Optional SB creative type used for generating static or video generated keyword recommendations.  Inferred by asins if not included.\n|Identifier|Description|Recommendations|\n|----------|-----------|-----------|\n|PRODUCT_COLLECTION| Showcase multiple products within a branded shopping experience|Static|\n|AUTHOR_COLLECTION| Showcase books under your name that direct to your Book Brand landing page|Static|\n|STORE_SPOTLIGHT| Showcase your brand logo, headline, and up to 3 product categories or sub-pages|Static|\n|VIDEO| Display a video ad promoting a product that redirects to its landing page|Video|\n|BRAND_VIDEO| Display a branded video ad that redirects shoppers to your Brand Store landing page|Video|\n<br/>","type":"string","enum":["PRODUCT_COLLECTION","AUTHOR_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"maxNumSuggestions":{"format":"int64","description":"Maximum number of suggestions to return. Max value is 1000. If not provided, default to 100.","type":"integer"},"creativeAsins":{"type":"array","items":{"description":"Optional. An array of creative ASINs that are displayed in the SB creative.","maximum":3,"type":"string","minimum":0}},"locale":{"description":"Optional locale to request keyword suggestion translations. For example, to request Simplified Chinese translations in US, provide locale “zh_CN”. Response will include both keyword suggestions and their translations. Supported locales include: Simplified Chinese (locale: “zh_CN”) for US, UK and CA. English (locale: “en_GB”) for DE, FR, IT and ES.","type":"string"},"url":{"description":"The URL of the Stores page, or, Vendors may also specify the URL of a custom landing page.","type":"string"}}}]},"examples":{"URL Request":{"value":{"goal":"BRAND_IMPRESSION_SHARE","creativeType":"VIDEO","maxNumSuggestions":"100","locale":"zh_CN","url":"www.amazon.com/sample_landing_page"}},"ASIN Request":{"value":{"asins":["asin1","asin2","asin3"],"goal":"PAGE_VISIT","creativeType":"PRODUCT_COLLECTION","maxNumSuggestions":"100","locale":"zh_CN"}}}}}},"responses":{"200":{"description":"Successful recommendations response","content":{"application/vnd.sbkeywordrecommendation.v3+json":{"schema":{"type":"array","items":{"type":"object","properties":{"searchTermImpressionShare":{"format":"double","maximum":100,"description":"The account-level ad-attributed impression share for the search-term / keyword. Provides percentage share of all ad impressions the advertiser has for the keyword in the last 7 days. This metric helps advertisers identify potential opportunities based on their share of relevant keywords.","type":"number","minimum":0},"matchType":{"description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Advertising support center.","type":"string","enum":["broad","exact","phrase"]},"translation":{"description":"Localized keyword value if locale was specified.","type":"string"},"searchTermImpressionRank":{"format":"int64","description":"The account-level ad-attributed impression rank for the search-term / keyword. Provides the [1:N] place the advertiser ranks among all advertisers for the keyword by ad impressions in a marketplace in the last 7 days. It tells an advertiser how many advertisers had higher share of ad impressions.","type":"integer"},"recommendationId":{"description":"Unique ID for each recommendation.","type":"string"},"type":{"description":"A recommendation identifier that describes the suggested action for the recommendation.\n|Identifier|Description|\n|----------|-----------|\n|addKeyword|The suggested action is to add the keyword.|\n<br/>","type":"string","enum":["addKeyword"]},"value":{"description":"Recommended keyword value.","type":"string"}}}},"example":[{"searchTermImpressionShare":1,"matchType":"PHRASE","translation":"跑鞋","searchTermImpressionRank":10,"recommendationId":"1111111111","type":"addKeyword","value":"running shoes"}]}}},"400":{"description":"Bad Request.","content":{"application/vnd.sbkeywordrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later","content":{"application/vnd.sbkeywordrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server SB Keyword Recommendations Error - Something went wrong on the server. Retry later and report an SB Keyword Recommendations Error if unresolved.","content":{"application/vnd.sbkeywordrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keyword%20Recommendations/operation/getKeywordRecommendations","sectionHeader":{"type":3,"text":"POST /sb/recommendations/keyword"},"summary":"Gets keyword recommendations","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/targets/list",{"tags":["Product targeting"],"operationId":"listTargets","description":"Gets a list of product targets associated with the client identifier passed in the authorization header, filtered by specified criteria.\n\n**Note**: Product targets associated with BrandVideo ad groups are only available in v3.2 version.","requestBody":{"description":"A set of filters.","content":{"application/json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048},"maxResults":{"description":"Sets a limit on the number of results returned by an operation.","type":"integer","minimum":1,"maximum":5000}}},{"type":"object","properties":{"filters":{"description":"Restricts results to targets with the specified filters.  Filters are inclusive. Filters are joined using 'and' logic. Specify one type of each filter. Specifying multiples of the same type of filter results in an error.","type":"array","items":{"anyOf":[{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `CREATIVE_TYPE` to filter by creative type. If no filter is specified, all targets will be returned.","type":"string","enum":["CREATIVE_TYPE"]}}},{"type":"object","properties":{"values":{"description":"A list of creative types.","type":"array","items":{"type":"string","enum":["productCollection","video"]},"minItems":1,"maxItems":2}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `TARGETING_STATE` to filter by target state.","type":"string","enum":["TARGETING_STATE"]}}},{"type":"object","properties":{"values":{"description":"A list of target states.","type":"array","items":{"type":"string","enum":["archived","paused","enabled"]},"minItems":1,"maxItems":5}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `CAMPAIGN_ID` to filter by campaign identifiers.","type":"string","enum":["CAMPAIGN_ID"]}}},{"type":"object","properties":{"values":{"description":"A list of campaign identifiers.","type":"array","items":{"description":"A campaign identifier.","type":"string","minItems":1,"maxItems":100}}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `AD_GROUP_ID` to filter by ad group identifier.","type":"string","enum":["AD_GROUP_ID"]}}},{"type":"object","properties":{"values":{"description":"A list of ad group identifiers.","type":"array","items":{"type":"integer","format":"int64","description":"The ad group identifier."},"minItems":1,"maxItems":100}}}]}],"minItems":0,"maxItems":3}}}}]}}}},"responses":{"200":{"description":"A list of targeting clauses.","content":{"application/vnd.sblisttargetsresponse.v3.2+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"targets":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"expressions":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"resolvedExpressions":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}}}}}]}},"application/vnd.sblisttargetsresponse.v3+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"targets":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"expressions":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"resolvedExpressions":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}}}}}]}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Product%20targeting/operation/listTargets","sectionHeader":{"type":3,"text":"POST /sb/targets/list"},"documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/targets",{"tags":["Product targeting"],"operationId":"updateTargets","summary":"Updates one or more targets.","requestBody":{"description":"A list of targets with updated values. <br/>Note that targets can be updated on campaigns where serving status is not one of `archived`, `terminated`, `rejected`, or `ended`. <br/>Note that this operation supports a maximum list size of 100 targets. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"object","required":["targets"],"properties":{"targets":{"type":"array","items":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The identifier of the target."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}},"minItems":1,"maxItems":100}}}}}},"responses":{"200":{"description":"A list of success and error results for targets submitted for update.","content":{"application/vnd.updatetargetsresponse.v3+json":{"schema":{"type":"object","properties":{"updateTargetSuccessResults":{"description":"Lists the successfully updated targets. Note that targets in the response are correlated to targets in the request using the `targetRequestIndex` field. For example, if `targetRequestIndex` is set to `2`, the values correlate to the third target object in the request.","type":"array","items":{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."},"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"}}}},"updateTargetErrorResults":{"description":"Lists errors that occured during target update. Note that errors are correlated to target update requests by the `targetRequestIndex` field. This field corresponds to the order of the target in the request. For example, if `targetRequestIndex` is set to `2`, the values correlate to the third target object in the request array.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."},"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"}}}]}}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Product%20targeting/operation/updateTargets","sectionHeader":{"type":3,"text":"PUT /sb/targets"},"summary":"Updates one or more targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/targets",{"tags":["Product targeting"],"operationId":"createTargets","summary":"Create one or more targets.","requestBody":{"description":"A list of targeting clauses for creation. <br/>Note that targets can be created on campaigns where serving status is not one of `archived`, `terminated`, `rejected`, or `ended`. <br/>Note that this operation supports a maximum list size of 100 targets. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"object","required":["targets"],"properties":{"targets":{"type":"array","items":{"properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of an existing ad group. The newly created target is associated to this ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of an existing campaign. The newly created target is associated to this campaign."},"expressions":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}},"minItems":1,"maxItems":100}}}}}},"responses":{"200":{"description":"A list of success and error results for targeting clauses submitted for creation.","content":{"application/vnd.sbcreatetargetsresponse.v3+json":{"schema":{"properties":{"createTargetSuccessResults":{"description":"Lists the successfully created targets. Note that targets in the response are correlated to targets in the request using the `targetRequestIndex` field. For example, if `targetRequestIndex` is set to `2`, the values correlate to the third target object in the request.","type":"array","items":{"type":"object","properties":{"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"},"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."}}}},"createTargetErrorResults":{"description":"Lists errors that occured during target creation. Note that errors are correlated to target create requests by the `targetRequestIndex` field. This field corresponds to the order of the target object in the request. For example, if `targetRequestIndex` is set to `3`, an error occured during creation of the fourth target in the request.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"},"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."}}}]}}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Product%20targeting/operation/createTargets","sectionHeader":{"type":3,"text":"POST /sb/targets"},"summary":"Create one or more targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/targets/{targetId}",{"tags":["Product targeting"],"operationId":"getTarget","summary":"Gets a target specified by identifier.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"targetId","description":"The identifier of an existing target.","in":"path","required":true,"schema":{"type":"integer","format":"int64","description":"The identifier of a target."}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbtarget.v3+json":{"schema":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"expressions":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}},"resolvedExpressions":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Product%20targeting/operation/getTarget","sectionHeader":{"type":3,"text":"GET /sb/targets/{targetId}"},"summary":"Gets a target specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/targets/{targetId}",{"tags":["Product targeting"],"operationId":"archiveTarget","summary":"Archives a target specified by identifier. Note that archiving is permanent, and once a target has been archived it can't be made active again.","description":"The identifier of an existing target.","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"integer","format":"int64","description":"The identifier of a target."}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbtargetresponse.v3+json":{"schema":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"code":{"type":"string"}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Product%20targeting/operation/archiveTarget","sectionHeader":{"type":3,"text":"DELETE /sb/targets/{targetId}"},"summary":"Archives a target specified by identifier. Note that archiving is permanent, and once a target has been archived it can't be made active again.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeTargets/list",{"tags":["Negative product targeting"],"operationId":"listNegativeTargets","summary":"Gets a list of product negative targets associated with the client identifier passed in the authorization header, filtered by specified criteria.","description":"**Note**: Negative targets associated with BrandVideo ad groups are only available in v3.2 version.","requestBody":{"description":"A set of filters.","content":{"application/json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048},"maxResults":{"description":"Sets a limit on the number of results returned by an operation.","type":"integer","minimum":1,"maximum":5000}}},{"type":"object","properties":{"filters":{"description":"Restricts results to negative targets with the specified filters.  Filters are inclusive. Filters are joined using 'and' logic. Specify one each type of filter. Specifying multiples of the same type of filter results in an error.","type":"array","items":{"anyOf":[{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `CREATIVE_TYPE` to filter by creative type. If no filter is specified, all negative targets will be returned.","type":"string","enum":["CREATIVE_TYPE"]}}},{"type":"object","properties":{"values":{"description":"A list of creative types.","type":"array","items":{"type":"string","enum":["productCollection","video"]},"minItems":1,"maxItems":2}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `TARGETING_STATE` to filter by negative target state.","type":"string","enum":["TARGETING_STATE"]}}},{"type":"object","properties":{"values":{"description":"A list of negative target states.","type":"array","items":{"type":"string","enum":["enabled","archived"]},"minItems":1,"maxItems":3}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `CAMPAIGN_ID` to filter by campaign identifiers.","type":"string","enum":["CAMPAIGN_ID"]}}},{"type":"object","properties":{"values":{"description":"A list of campaign identifiers.","type":"array","items":{"description":"An existing campaign identifier.","type":"string"},"minItems":1,"maxItems":100}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `AD_GROUP_ID` to filter by ad group identifier.","type":"string","enum":["AD_GROUP_ID"]}}},{"type":"object","properties":{"values":{"description":"A list of ad group identifiers.","type":"array","items":{"description":"An existing ad group identifier.","type":"string"},"minItems":1,"maxItems":100}}}]}]},"minItems":0,"maxItems":3}}}]}}}},"responses":{"200":{"description":"A list of negative targets.","content":{"application/vnd.sblistnegativetargetsresponse.v3.2+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"negativeTargets":{"type":"array","items":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"expressions":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}},"resolvedExpressions":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}}}}}]}},"application/vnd.sblistnegativetargetsresponse.v3+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"negativeTargets":{"type":"array","items":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"expressions":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}},"resolvedExpressions":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}}}}}]}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20product%20targeting/operation/listNegativeTargets","sectionHeader":{"type":3,"text":"POST /sb/negativeTargets/list"},"summary":"Gets a list of product negative targets associated with the client identifier passed in the authorization header, filtered by specified criteria.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeTargets",{"tags":["Negative product targeting"],"operationId":"updateNegativeTargets","summary":"Updates one or more negative targets.","requestBody":{"description":"A list of negative targets with updated values. <br/>Note that negative targeting clauses can be created on campaigns where serving status is not one of `archived`, `terminated`, `rejected`, or `ended`. <br/>Note that this operation supports a maximum list size of 100 negative targets.","content":{"application/json":{"schema":{"type":"object","properties":{"negativeTargets":{"type":"array","minItems":1,"maxItems":100,"items":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of an existing ad group. The newly created target is associated to this ad group."},"state":{"type":"string","enum":["enabled","paused","archived","draft"]}}}}}}}}},"responses":{"200":{"description":"A list of success and error results for negative targets submitted for update.","content":{"application/vnd.updatenegativetargetsresponse.v3+json":{"schema":{"type":"object","properties":{"updateTargetSuccessResults":{"description":"Lists the successfully updated negative targets. Note that negative targets in the response are correlated to negative targets in the request using the `targetRequestIndex` field. For example, if `targetRequestIndex` is set to `2`, the values correlate to the third negative target object in the request.","type":"array","items":{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."},"targetRequestIndex":{"description":"Correlates the negative target to the negative target array index specified in the request. Zero-based.","type":"number"}}}},"updateTargetErrorResults":{"description":"Lists errors that occured during negative target update. Note that errors are correlated to negative target update requests by the `negativeTargetRequestIndex` field. This field corresponds to the order of the negative target in the request. For example, if `negativeTargetRequestIndex` is set to `2`, the values correlate to the third negative target object in the request.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."},"targetRequestIndex":{"description":"Correlates the negative target to the negative target array index specified in the request. Zero-based.","type":"number"}}}]}}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20product%20targeting/operation/updateNegativeTargets","sectionHeader":{"type":3,"text":"PUT /sb/negativeTargets"},"summary":"Updates one or more negative targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeTargets",{"tags":["Negative product targeting"],"operationId":"createNegativeTargets","summary":"Create one or more negative targets.","requestBody":{"description":"A list of negative targeting clauses for creation. <br/>Note that negative targeting clauses can be created on campaigns where serving status is not one of `archived`, `terminated`, `rejected`, or `ended`. <br/>Note that this operation supports a maximum list size of 100 negative targets.","content":{"application/json":{"schema":{"type":"object","required":["negativeTargets"],"properties":{"negativeTargets":{"type":"array","items":{"properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of an existing ad group. The newly created target is associated to this ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of an existing campaign. The newly created target is associated to this campaign."},"expressions":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["asinBrandSameAs","asinSameAs"]},"value":{"type":"string","description":"The text of the negative expression."}}}}}},"minItems":1,"maxItems":100}}}}}},"responses":{"200":{"description":"A list of success and error results for targeting clauses submitted for creation.","content":{"application/vnd.sbcreatenegativetargetsrequest.v3+json":{"schema":{"properties":{"createTargetSuccessResults":{"description":"Lists the successfully created targets. Note that targets in the response are correlated to targets in the request using the `targetRequestIndex` field. For example, if `targetRequestIndex` is set to `2`, the values correlate to the third target object in the request.","type":"array","items":{"type":"object","properties":{"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"},"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."}}}},"createTargetErrorResults":{"description":"Lists errors that occured during target creation. Note that errors are correlated to target create requests by the `targetRequestIndex` field. This field corresponds to the order of the target object in the request. For example, if `targetRequestIndex` is set to `3`, an error occured during creation of the fourth target in the request.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"},"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."}}}]}}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20product%20targeting/operation/createNegativeTargets","sectionHeader":{"type":3,"text":"POST /sb/negativeTargets"},"summary":"Create one or more negative targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeTargets/{negativeTargetId}",{"tags":["Negative product targeting"],"operationId":"getNegativeTarget","summary":"Gets a negative target specified by identifier.","parameters":[{"name":"negativeTargetId","description":"The identifier of an existing negative target.","in":"path","required":true,"schema":{"type":"integer","format":"int64","description":"The identifier of a negative target."}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbnegativetarget.v3+json":{"schema":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of an existing ad group. The newly created target is associated to this ad group"},"campaignId":{"type":"integer","format":"int64","description":"The identifier of an existing campaign. The newly created target is associated to this campaign"},"expressions":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["asinBrandSameAs","asinSameAs"]},"value":{"type":"string","description":"The text of the negative expression."}}}},"resolvedExpressions":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20product%20targeting/operation/getNegativeTarget","sectionHeader":{"type":3,"text":"GET /sb/negativeTargets/{negativeTargetId}"},"summary":"Gets a negative target specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeTargets/{negativeTargetId}",{"tags":["Negative product targeting"],"operationId":"archiveNegativeTarget","summary":"Archives a negative target specified by identifier. Note that archiving is permanent, and once a negative target has been archived it can't be made active again.","parameters":[{"name":"negativeTargetId","in":"path","required":true,"schema":{"type":"integer","format":"int64","description":"The identifier of a negative target."}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbnegativetarget.v3+json":{"schema":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"code":{"type":"string"}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20product%20targeting/operation/archiveNegativeTarget","sectionHeader":{"type":3,"text":"DELETE /sb/negativeTargets/{negativeTargetId}"},"summary":"Archives a negative target specified by identifier. Note that archiving is permanent, and once a negative target has been archived it can't be made active again.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/themes/list",{"tags":["Theme targeting"],"operationId":"sbListThemes","description":"Note that this endpoint does not support for **Author profiles**. Gets a list of theme targets associated with the client identifier passed in the authorization header, filtered by specified criteria.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A set of filters.","content":{"application/json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048},"maxResults":{"description":"Sets a limit on the number of results returned by an operation.","type":"integer","minimum":1,"maximum":5000}}},{"type":"object","properties":{"themeIdFilter":{"description":"A list of theme targets identifiers.","properties":{"include":{"type":"array","items":{"description":"An theme target identifier.","type":"string","minItems":1,"maxItems":100}}}},"adGroupIdFilter":{"description":"A list of ad group identifiers.","properties":{"include":{"type":"array","items":{"description":"An ad group identifier.","type":"string","minItems":1,"maxItems":100}}}},"campaignIdFilter":{"description":"A list of campaign identifiers.","properties":{"include":{"type":"array","items":{"description":"A campaign identifier.","type":"string","minItems":1,"maxItems":100}}}},"stateFilter":{"description":"A list of theme target states.","properties":{"include":{"type":"array","items":{"type":"string","enum":["paused","enabled","archived"],"default":"enabled,paused","minItems":1,"maxItems":3}}}},"themeTypeFilter":{"description":"A list of theme target type.","properties":{"include":{"type":"array","items":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"minItems":1,"maxItems":2}}}}}]}}}},"responses":{"200":{"description":"A list of targeting clauses.","content":{"application/vnd.sbthemeslistresponse.v3+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"themes":{"type":"array","items":{"description":"| themeType | description |\n|-----------|-------------|\n| KEYWORDS_RELATED_TO_YOUR_BRAND | keywords related to brands. |\n| KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES | keywords related to your landing pages. |","properties":{"themeId":{"description":"The theme target identifier.","type":"string"},"adGroupId":{"description":"The identifier of the ad group associated with the theme target.","type":"string"},"campaignId":{"description":"The identifier of the campaign associated with the theme target.","type":"string"},"themeType":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features).","type":"number"}}},"minItems":0,"maxItems":5000}}}]}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Theme%20targeting/operation/sbListThemes","sectionHeader":{"type":3,"text":"POST /sb/themes/list"},"documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/themes",{"tags":["Theme targeting"],"operationId":"sbUpdateThemes","description":"Note that this endpoint does not support for **Author profiles**.","summary":"Updates one or more theme targets.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of theme targets with updated values. <br/>Note that theme targets can be updated on multi-adGroups campaigns and where campaign serving status is not one of `archived`, `terminated`, `rejected`, or `ended` and adgroup state is not 'archived'. <br/>Note that this operation supports a maximum list size of 100 theme targets. Also theme target can not be archived. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"object","required":["themes"],"properties":{"themes":{"type":"array","items":{"properties":{"themeId":{"type":"string","description":"The identifier of the theme target."},"adGroupId":{"type":"string","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"string","description":"The identifier of the campaign to which the target is associated."},"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}},"required":["themeId","adGroupId"]},"minItems":1,"maxItems":100}}}}}},"responses":{"200":{"description":"A list of success and error results for theme targets submitted for update.","content":{"application/vnd.sbthemesupdateresponse.v3+json":{"schema":{"type":"object","properties":{"success":{"description":"Lists the successfully updated theme targets. Note that theme targets in the response are correlated to theme targets in the request using the `index` field. For example, if `index` is set to `2`, the values correlate to the third theme target object in the request.","type":"array","items":{"type":"object","properties":{"themeId":{"type":"string","description":"The identifier of theme target."},"index":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"}}},"minItems":0,"maxItems":100},"error":{"description":"Lists errors that occurred during theme target update. Note that errors are correlated to theme target update requests by the `index` field. This field corresponds to the order of the theme target in the request. For example, if `index` is set to `2`, the values correlate to the third theme target object in the request array.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"themeId":{"type":"string","description":"The identifier of theme target."},"index":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"}}}]},"minItems":0,"maxItems":100}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Theme%20targeting/operation/sbUpdateThemes","sectionHeader":{"type":3,"text":"PUT /sb/themes"},"summary":"Updates one or more theme targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/themes",{"tags":["Theme targeting"],"operationId":"sbCreateThemes","description":"Note that this endpoint does not support for **Author profiles**.","summary":"Create one or more theme targets.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of theme targets for creation. <br/>Note that theme targets can be created on multi-adGroups campaigns and where campaign serving status is not one of `archived`, `terminated`, `rejected`, or `ended` and adgroup state is not 'archived'. <br/>Note that this operation supports a maximum list size of 100 theme targets and only one target can be created for each themeType per adGroup. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"object","required":["themes"],"properties":{"themes":{"type":"array","items":{"properties":{"adGroupId":{"type":"string","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"string","description":"The identifier of the campaign to which the target is associated."},"themeType":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}},"required":["adGroupId","themeType","bid"]},"minItems":1,"maxItems":100}}}}}},"responses":{"200":{"description":"A list of success and error results for theme targets submitted for creation.","content":{"application/vnd.sbthemescreateresponse.v3+json":{"schema":{"properties":{"success":{"description":"Lists the successfully created theme targets. Note that theme targets in the response are correlated to theme targets in the request using the `index` field. For example, if `index` is set to `2`, the values correlate to the third theme target object in the request.","type":"array","items":{"type":"object","properties":{"index":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"},"themeId":{"type":"string","description":"The identifier of theme target."}}},"minItems":0,"maxItems":100},"error":{"description":"Lists errors that occurred during theme target creation. Note that errors are correlated to theme target create requests by the `index` field. This field corresponds to the order of the target object in the request. For example, if `index` is set to `3`, an error occurred during creation of the fourth theme target in the request.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"index":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"}}}]},"minItems":0,"maxItems":100}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Theme%20targeting/operation/sbCreateThemes","sectionHeader":{"type":3,"text":"POST /sb/themes"},"summary":"Create one or more theme targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/recommendations/targets/product/list",{"tags":["Targeting recommendations"],"operationId":"getProductRecommendations","summary":"Gets a list of recommended products for targeting.","description":"Recommendations are based on the ASINs that are passed in the request.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of ASINs.","content":{"application/json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048},"maxResults":{"description":"Sets a limit on the number of results returned by an operation.","type":"integer","minimum":1,"maximum":100}}},{"type":"object","properties":{"filters":{"description":"Restricts recommendations to the criteria specified in the filters.","type":"array","items":{"anyOf":[{"allOf":[{"type":"object","properties":{"filterType":{"type":"string","enum":["ASINS"]}}},{"type":"object","properties":{"values":{"description":"A list of ASINs.","type":"array","items":{"description":"An ASIN.","type":"string"},"minItems":1,"maxItems":100}}}]}]}}}}]}}}},"responses":{"200":{"description":"A list of product targeting recommendations.","content":{"application/vnd.sbproductrecommendationsresponse.v3.1+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"recommendedProducts":{"type":"array","items":{"type":"object","properties":{"recommendedTargetAsin":{"description":"The recommended target ASIN.","type":"string"}}}}}}]}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Targeting%20recommendations/operation/getProductRecommendations","sectionHeader":{"type":3,"text":"POST /sb/recommendations/targets/product/list"},"summary":"Gets a list of recommended products for targeting.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/recommendations/targets/category",{"tags":["Targeting recommendations"],"operationId":"getTargetingCategories","summary":"Gets a list of recommended categories for targeting.","description":"Recommendations are based on the ASINs that are passed in the request.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"Return the categories in the specified locale.","required":false,"schema":{"type":"string","enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"]}}],"requestBody":{"description":"List of ASINs.","content":{"application/json":{"schema":{"type":"object","properties":{"asins":{"type":"array","description":"A list of ASINs.","items":{"type":"string"}},"supplySource":{"type":"string","description":"(As of 05/28/2024, `STREAMING_VIDEO` is deprecated). The supply source of the campaign. Use `AMAZON` for placements on Amazon website. Use `STREAMING_VIDEO` for off-site video placements such as IMDb TV. Default value is `AMAZON`.","enum":["AMAZON","STREAMING_VIDEO"]}}}}}},"responses":{"200":{"description":"A list of category targeting recommendations.","content":{"application/vnd.sbcategoryrecommendationsresponse.v3.2+json":{"schema":{"type":"object","properties":{"categoryRecommendationResults":{"type":"array","items":{"properties":{"id":{"type":"integer","format":"int64","description":"The category identifier."},"name":{"type":"string","description":"The category name."},"translatedName":{"type":"string","description":"The category name translated to the specified locale in the request."},"isTargetable":{"type":"boolean","description":"Set to `true` if the category can be targeted in a targeting expression, and `false` if not."},"path":{"type":"string","description":"The path of the category within the category catalogue."},"translatedPath":{"type":"string","description":"The path of the category within the category catalogue translated to the specified locale in the request."},"estimatedReach":{"type":"string","description":"(As of 05/28/2024, `STREAMING_VIDEO` is deprecated). The estimated daily reach range of the category. Only set when supply source is `STREAMING_VIDEO`"}}}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Targeting%20recommendations/operation/getTargetingCategories","sectionHeader":{"type":3,"text":"POST /sb/recommendations/targets/category"},"summary":"Gets a list of recommended categories for targeting.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/recommendations/targets/brand",{"tags":["Targeting recommendations"],"operationId":"getBrandRecommendations","summary":"Gets a list of brand suggestions.","description":"The Brand suggestions are based on a list of either category identifiers or keywords passed in the request. It is not valid to specify both category identifiers and keywords in the request.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"categoryId":{"type":"integer","format":"int64","description":"The category identifier for which to get recommendations."}}},{"type":"object","properties":{"keyword":{"type":"string","description":"The keyword for which to get recommendations."}}}]}}}},"responses":{"200":{"description":"success","content":{"application/vnd.sbbrandrecommendationsresponse.v3.1+json":{"schema":{"type":"object","properties":{"brandRecommendationResults":{"type":"array","items":{"properties":{"id":{"type":"integer","format":"int64","description":"The Brand identifier."},"name":{"type":"string","description":"The Brand name."}}}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Targeting%20recommendations/operation/getBrandRecommendations","sectionHeader":{"type":3,"text":"POST /sb/recommendations/targets/brand"},"summary":"Gets a list of brand suggestions.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/moderation/campaigns/{campaignId}",{"tags":["Moderation"],"summary":"[DEPRECATED] Gets the moderation result for a campaign specified by identifier.","deprecated":true,"description":"[DEPRECATED - Do not use] https://advertising.amazon.com/API/docs/en-us/release-notes/deprecations#deprecation-announcement-sponsored-brands-legacy-version-of-moderation-results-api-will-shut-off-on-dec-15-2025\n\nNote that this resource is only available for campaigns in the US marketplace.\n","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"campaignId","in":"path","description":"The campaign identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbmoderation.v3+json":{"schema":{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The campaign identifier."},"moderationStatus":{"type":"string","enum":["APPROVED","IN_PROGRESS","REJECTED"],"description":"The moderation status of the campaign.\n|Status|Description|\n|------|-----------|\n|APPROVED|Moderation for the campaign is complete.|\n|IN_PROGRESS|Moderation for the campaign is in progress. The expected date and time for completion are specfied in the `etaForModeration` field.|\n|REJECTED|The campaign has failed moderation. Specific information about the content that violated policy is available in `policyViolations`.|"},"etaForModeration":{"type":"string","format":"date-time","description":"Expected date and time by which moderation will be complete. Note that this field is present in the response only when `moderationStatus` is set to `IN_PROGRESS`."},"policyViolations":{"type":"array","description":"A list of policy violations for a campaign that has failed moderation. Note that this field is present in the response only when `moderationStatus` is set to `REJECTED`.","items":{"type":"object","properties":{"policyDescription":{"type":"string","example":"Advertising alcohol is not allowed","description":"A human-readable description of the policy."},"policyLinkUrl":{"type":"string","format":"uri","example":"https://advertising.amazon.com/resources/ad-policy/en/creative-acceptance#alcohol","description":"Address of the policy documentation. Follow the link to learn more about the specified policy."},"violatingTextContents":{"type":"array","description":"Information about the specific text that violates the specified policy in the campaign.","items":{"type":"object","properties":{"moderatedComponent":{"type":"string","description":"The ad component that includes the text that violates the specified policy.","example":"headline"},"reviewedText":{"type":"string","description":"The specific text reviewed during moderation.","example":"Best alcohol money can buy"},"textEvidences":{"type":"array","items":{"type":"object","properties":{"violatingText":{"type":"string","description":"The specific text determined to violate the specified policy in `reviewedText`.","example":"alcohol"},"violatingTextPosition":{"type":"object","properties":{"start":{"type":"integer","description":"Zero-based index into the text in `reviewedText` where the text specified in `violatingText` starts.","example":5},"end":{"type":"integer","description":"Zero-based index into the text in `reviewedText` where the text specified in `violatingText` ends.","example":11}}}}}}}}},"violatingImageContents":{"type":"array","description":"Information about the specific image that violates the specified policy.","items":{"type":"object","properties":{"moderatedComponent":{"type":"string","description":"The ad component that includes the image that violates the specified policy.","example":"brandlogo"},"reviewedImageUrl":{"type":"string","description":"Address of the image reviewed during moderation.","example":"https://media-central.amazon.com/ejfkkfwkeclkmd.jpg"},"imageEvidences":{"type":"array","items":{"properties":{"violatingImageCrop":{"type":"object","properties":{"topLeftX":{"type":"integer","description":"The top left X-coordinate of the content that violates the specfied policy within the image.","example":24},"topLeftY":{"type":"integer","description":"The top left Y-coordinate of the content that violates the specfied policy within the image.","example":87},"height":{"type":"integer","description":"The height of the content that violates the specified policy within the image.","example":50},"width":{"type":"integer","description":"The width of the content that violates the specified policy within the image.","example":75}}}}}}}}},"violatingAsinContents":{"type":"array","description":"Information about the specific ASIN in the campaign that violates the specified policy.","items":{"type":"object","properties":{"moderatedComponent":{"type":"string","description":"The ad component that includes the ASIN that violates the specified policy.","example":"landingPageAsin"},"asinEvidences":{"type":"array","items":{"properties":{"asin":{"type":"string","description":"The ASIN that violates the specified policy.","pattern":"[A-Za-z0-9]{10}","example":"B0786PRKBP"}}}}}}}}}}}}}}},"404":{"description":"Requested campaignId not found","content":{"application/vnd.error.v3+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Moderation","sectionHeader":{"type":3,"text":"GET /sb/moderation/campaigns/{campaignId}"},"summary":"[DEPRECATED] Gets the moderation result for a campaign specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/v2/hsa/{recordType}/report",{"tags":["Reports"],"summary":"Requests the creation of a report containing performance data related to Sponsored Brands campaigns.","description":"Use this interface to request and retrieve performance reports. **To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).**\n\n**KDP support**\n\nNote that KDP profiles cannot currently request reports for Sponsored Brands campaigns using the API. Authors should use the advertising console to download reporting data. \n\n**Filtering**\n\nFor more information, see the [Reporting FAQ](/API/docs/en-us/guides/reporting/v2/faq#can-i-filter-a-sponsored-brands-report).\n\n**Constraints of Sponsored Brands reporting**\n\nSponsored Brands reporting data cannot be combined with Sponsored Products data into one report. Only 14-day data is available for Sponsored Brands. Attribution windows of 1, 7, and 30-day intervals are not available.\n\n**New-to-brand performance metrics**\n\nWith new-to-brand metrics, advertisers can measure and optimize campaigns, as well as plan future marketing strategies to grow their customer base on Amazon. New-to-brand metrics determine whether an ad-attributed purchase was made by an existing customer or one buying a brand’s product on Amazon for the first time over the prior year. With new-to-brand metrics, advertisers receive campaign performance metrics such as total new-to-brand purchases and sales, new-to-brand purchase rate, and cost per new-to-brand customer. Advertisers now have the tools they need to estimate the cost of acquiring new customers on Amazon and identify the most efficient channels and tactics to achieve their campaign goals.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"recordType","in":"path","description":"The type of report. Valid types are `campaigns`, `adGroups`, `ads`, `targets`, and `keywords`.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reportDate","metrics"],"properties":{"reportDate":{"type":"string","description":"Date in YYYYMMDD format. The report only contains performance data for the specified date. The time zone is specified by the profile used to request the report. If this date is today, then the performance report may contain partial information. Reports are not available for data older than 60 days. For details on data latency, see [Service Guarantees](../../reference/concepts/developer-notes)."},"segment":{"type":"string","description":"Optional. Allows you to run a report based on secondary dimensions. Use `placement` to segment a `campaigns` report by the location on a page where your ad appears. Use `query` to segment a `keywords` report and create a search terms report.","enum":["placement","query"]},"creativeType":{"type":"string","description":"Optional. Supported values are `video` (for video campaigns) and `all` (for both non-video and video campaigns). If not specified, the report will contain data for non-video campaigns. For `ads` report types only, `creativeType` is required and must be set to `all` (`video` is not allowed). To return performance data for [multi-ad group campaigns](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#/Campaigns), you must include `creativeType` set to `all`` in your request.","enum":["video","all"]},"metrics":{"type":"string","description":"Each report type supports different metrics. **To understand supported metrics for each report type, see [Report types](/API/docs/en-us/guides/reporting/v2/report-types).** "}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"type":"string","description":"The unique ID for your requested report."},"recordType":{"type":"string","description":"The record type of the report. It can be `campaign`, `adGroup`, `keyword`, or `targets`."},"status":{"type":"string","description":"The status of the report. Status is one of `IN_PROGRESS`, `SUCCESS`, or `FAILURE`."},"statusDetails":{"type":"string","description":"Description of the status."}}}}}},"406":{"description":"Failed due to report date being too far in the past. Reports are not available for data older than 60 days.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"422":{"description":"Report formed incorrectly. Report requests return a 422 status code if the parameters specified are unrecognized or if the combination of parameters is not supported. In particular, the choice of `recordType` may restrict the use of certain segments. Query segmentation can only be used in combination with keyword and product ad reports.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Reports","sectionHeader":{"type":3,"text":"POST /v2/hsa/{recordType}/report"},"summary":"Requests the creation of a report containing performance data related to Sponsored Brands campaigns.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/v2/reports/{reportId}",{"tags":["Reports"],"summary":"Returns the status of a previously requested report.","description":"To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"reportId","in":"path","description":"Report ID returned by POST report method.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"type":"string","description":"The unique ID for your requested report."},"status":{"type":"string","description":"The status of the report. Status is one of `IN_PROGRESS`, `SUCCESS`, or `FAILURE`."},"statusDetails":{"type":"string","description":"Description of the status."}}}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Reports","sectionHeader":{"type":3,"text":"GET /v2/reports/{reportId}"},"summary":"Returns the status of a previously requested report.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/v2/reports/{reportId}/download",{"tags":["Reports"],"summary":"Downloads a previously requested report identified by `reportId`.","description":"Gets a `307 Temporary Redirect` response that includes a `location` header with the value set to an AWS S3 path where the report is located. The path expires after 30 seconds. If the path expires before the report is downloaded, a new report request must be created. \n\n**To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).**\n\nThe report file contains one row per entity for which performance data is present. These records are represented as JSON containing the ID attribute corresponding to the `recordType`, the segment (if specified), and each of the metrics in the request.\n\n**Note**: The report files in S3 are gzipped.\n\n*Example report download*\n\n`$ curl -o /tmp/report.json.gz \"https://sandboxreports.s3.amazonaws.com/amzn1.clicksAPI.v1.m1.580149D6.c7aa92c1-ca5b-435d-bb8b-51cb26ad5731?AWSAccessKeyId=AKIAIKLHNT32USZOWVRA&amp;Expires=1476479900&amp;Signature=I%2F2Gd%2B8TbcPbXbBUM6ix%2BSVP3qA%3D\"`","operationId":"downloadReport","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"reportId","in":"path","description":"The identifier of the requested report.","required":true,"schema":{"type":"string"}}],"responses":{"307":{"description":"Successful operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Redirect URI with S3 file location containing report data"}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"404":{"description":"Not found - requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"429":{"description":"Too many requests - request was rate-limited. Retry later.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"500":{"description":"Internal server error - something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Reports/operation/downloadReport","sectionHeader":{"type":3,"text":"GET /v2/reports/{reportId}/download"},"summary":"Downloads a previously requested report identified by `reportId`.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["Create and manage Sponsored Brands campaigns. \n\nTo learn more about Sponsored Brands campaigns, see:\n\nSponsored Brands overview\n\nSponsored Brands campaign structure\n\nGet started with Sponsored Brands campaigns\n"],"path":"/en-us/sponsored-brands/3-0/openapi/prod","sectionHeader":{"type":2,"text":"Sponsored Brands campaign management"},"documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/campaigns",{"summary":"Create campaigns","requestBody":{"content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"budgetType":{"description":"For the lifetime budget type, `startDate` and `endDate` must be specified.","type":"string","enum":["DAILY","LIFETIME"]},"brandEntityId":{"description":"Please note that brandEntityId is only required for sellers. You can get the brandEntityId by calling the [GET /brands](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#tag/Brands/operation/getBrands) endpoint.","type":"string"},"goal":{"description":"Goal will allow you to set goal type to help drive your campaign performance. If no goal is selected then it will default to PAGE_VISIT.\nThe goal type of the campaign.\n- BRAND_IMPRESSION_SHARE - This goal will allow you grown your brand impression share on top of search placement\n- PAGE_VISIT [DEFAULT] - This goal drives traffic to your landing and detail pages through all placements.\n\nNote: Goal-based campaigns are not supported in the Ireland (IE) marketplace. For IE, both `goal` and `costType` must be omitted from the request, which creates a standard (non-goal-based) campaign. Supplying `goal` and `costType` in IE returns a `GOAL_BASED_CAMPAIGNS_DISABLED` error.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"endDate is optional. If endDate is specified, startDate must be specified as well.","type":"string"},"productLocation":{"description":"The product location of the campaign.\n- SOLD_ON_AMAZON - For products sold on Amazon websites.\n- NOT_SOLD_ON_AMAZON - For products not sold on Amazon websites.\n- SOLD_ON_DTC - Deprecated (For products sold on DTC websites).","type":"string","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON","SOLD_ON_DTC"]},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"costType":{"description":"The costType can be set to determines how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace\n- CPC [Default] - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad.\n- VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\n- FIXED_PRICE - Sale price for a specific ad placement. It can only be used for campaign with a targetedPGDealId.","type":"string"},"smartDefault":{"minItems":1,"maxItems":100,"description":"The smartDefault specifies a list of the smart default options for the campaign.\n\n`smartDefault` is optional for create campaign requests. `smartDefault` are applicable to all applicable child entities of the campaign and are not editable once the campaign is created. When using [\"TARGETING\"], targets will be automatically added based on the goal selected.  When [\"MANUAL\"] is selected, you will still be required to manually add targets.\n\nIf you don't specify `smartDefault`, default value will be applied based on `goal` . If campaign's `goal` is selected, `smartDefault` will be set to [\"TARGETING\"].  Otherwise, a campaign's `smartDefault` will be set to [\"MANUAL\"].\n\nEach element in smartDefault can be set to determines which default strategy to be used\n- MANUAL - Manual settings, no smart default be applied to the campaign, if MANUAL is added in the list, no other items are allowed in the list (the list must contains only one item)\n- TARGETING - Smart Default Targeting creation, will automatically creating targetings when create ad group\n\nExample: [\"TARGETING\"]","type":"array","items":{"type":"string"}},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"startDate is optional. If startDate is not specified, current date will be used.","type":"string"},"budget":{"format":"double","description":"The budget of the campaign.","type":"number"},"siteRestrictions":{"type":"array","items":{"type":"string","enum":["AMAZON_BUSINESS"]},"maxItems":1,"minItems":1,"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.  If this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business. \nPlease note that:\n1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU);\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions doesn't support shopperCohortBidding setting."},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"}},"required":["budget","budgetType","name","state"]}}},"required":["campaigns"]}}},"required":true},"description":"Creates Sponsored Brands campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsCampaigns","responses":{"207":{"description":"CreateSponsoredBrandsCampaigns 207 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"campaignId":{"description":"The campaign ID.","type":"string"},"index":{"description":"The index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"campaign":{"type":"object","properties":{"budgetType":{"description":"For the lifetime budget type, `startDate` and `endDate` must be specified.","type":"string","enum":["DAILY","LIFETIME"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}},"brandEntityId":{"type":"string"},"isMultiAdGroupsEnabled":{"type":"boolean"},"goal":{"description":"Goal will allow you to set goal type to help drive your campaign performance. If no goal is selected then it will default to PAGE_VISIT.\nThe goal type of the campaign.\n- BRAND_IMPRESSION_SHARE - This goal will allow you grown your brand impression share on top of search placements\n- PAGE_VISIT [DEFAULT] - This goal drives traffic to your landing and detail pages through all placements\n- ACQUIRE_NEW_CUSTOMERS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal drives new customer acquisition for your brands.\n- AD_VIEWS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal maximizes view for your ads.\n\nNote: Goal-based campaigns are not supported in the Ireland (IE) marketplace. For IE, both `goal` and `costType` must be omitted from the request, which creates a standard (non-goal-based) campaign. Supplying `goal` and `costType` in IE returns a `GOAL_BASED_CAMPAIGNS_DISABLED` error.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"productLocation":{"description":"The product location of the campaign.\n- SOLD_ON_AMAZON - For products sold on Amazon websites.\n- NOT_SOLD_ON_AMAZON - For products not sold on Amazon websites.\n- SOLD_ON_DTC - Deprecated (For products sold on DTC websites).","type":"string","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON","SOLD_ON_DTC"]},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"costType":{"description":"The costType can be set to determines how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace\n- CPC [Default] - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad.\n- VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\n- FIXED_PRICE - Sale price for a specific ad placement. It can only be used for campaign with a targetedPGDealId.","type":"string"},"smartDefault":{"minItems":1,"maxItems":100,"description":"The smartDefault specifies a list of the smart default options for the campaign.\n\n`smartDefault` is optional for create campaign requests. `smartDefault` are applicable to all applicable child entities of the campaign and are not editable once the campaign is created. When using [\"TARGETING\"], targets will be automatically added based on the goal selected.  When [\"MANUAL\"] is selected, you will still be required to manually add targets.\n\nIf you don't specify `smartDefault`, default value will be applied based on `goal` . If campaign's `goal` is selected, `smartDefault` will be set to [\"TARGETING\"].  Otherwise, a campaign's `smartDefault` will be set to [\"MANUAL\"].\n\nEach element in smartDefault can be set to determines which default strategy to be used\n- MANUAL - Manual settings, no smart default be applied to the campaign, if MANUAL is added in the list, no other items are allowed in the list (the list must contains only one item)\n- TARGETING - Smart Default Targeting creation, will automatically creating targetings when create ad group\n\nExample: [\"TARGETING\"]","type":"array","items":{"type":"string"}},"siteRestrictions":{"minItems":1,"maxItems":1,"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.  If this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business. \nPlease note that:\n1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU);\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions doesn't support shopperCohortBidding setting.","type":"array","items":{"type":"string","enum":["AMAZON_BUSINESS"]}},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"budget":{"format":"double","type":"number"},"extendedData":{"description":"CampaignExtendedData can only be retrieved via the list API. It won't be available in the response during update/create.","type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe campaign serving status determined by system.\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's status is enabled.\n- CAMPAIGN_PAUSED - Campaign's status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's status is enabled\n- PORTFOLIO_PAUSED - Portfolio's status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's start date is in the future\n- PORTFOLIO_ENDED - Portfolio's end date is in the past.\n\n- INELIGIBLE - Ad Offer is ineligible\n- ELIGIBLE - Ad Offer is eligible\n- ENDED - Campaign's end date is in the past.\n- PENDING_REVIEW - Campaign is pending review.\n- PENDING_START_DATE - Campaign's start date is in the future.\n- REJECTED - Campaign is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Campaign.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}},"targetedPGDealId":{"description":"DealId associated with the campaign. This field is immutable and cannot be changed after the campaign is created.","type":"string"}},"required":["budget","budgetType","campaignId","name","state"]}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"budgetError":{"type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"billingError":{"description":"Errors related to billing.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Campaigns"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Campaigns/operation/CreateSponsoredBrandsCampaigns","sectionHeader":{"type":3,"text":"POST /sb/v4/campaigns"},"summary":"Create campaigns","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/campaigns",{"summary":"Update campaigns","requestBody":{"content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"portfolioId":{"nullable":true,"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"nullable":true,"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"endDate is optional. If endDate is specified, startDate must be specified as well. Note: This property is nullable. If null is explicitly provided in a campaign update request, any existing endDate for the campaign will be removed.","type":"string"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"startDate can only be changed if the current startDate is in the future.","type":"string"},"budget":{"format":"double","description":"The budget of the campaign. See https://advertising.amazon.com/help?entityId=ENTITYJDATFOIA05Q7#GE5QEBS6QRJJAT3A","type":"number"},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0}},"required":["campaignId"]}}},"required":["campaigns"]}}},"required":true},"description":"Updates Sponsored Brands campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredBrandsCampaigns","responses":{"207":{"description":"UpdateSponsoredBrandsCampaigns 207 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"campaignId":{"description":"The campaign ID.","type":"string"},"index":{"description":"The index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"campaign":{"type":"object","properties":{"budgetType":{"description":"For the lifetime budget type, `startDate` and `endDate` must be specified.","type":"string","enum":["DAILY","LIFETIME"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}},"brandEntityId":{"type":"string"},"isMultiAdGroupsEnabled":{"type":"boolean"},"goal":{"description":"Goal will allow you to set goal type to help drive your campaign performance. If no goal is selected then it will default to PAGE_VISIT.\nThe goal type of the campaign.\n- BRAND_IMPRESSION_SHARE - This goal will allow you grown your brand impression share on top of search placements\n- PAGE_VISIT [DEFAULT] - This goal drives traffic to your landing and detail pages through all placements\n- ACQUIRE_NEW_CUSTOMERS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal drives new customer acquisition for your brands.\n- AD_VIEWS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal maximizes view for your ads.\n\nNote: Goal-based campaigns are not supported in the Ireland (IE) marketplace. For IE, both `goal` and `costType` must be omitted from the request, which creates a standard (non-goal-based) campaign. Supplying `goal` and `costType` in IE returns a `GOAL_BASED_CAMPAIGNS_DISABLED` error.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"productLocation":{"description":"The product location of the campaign.\n- SOLD_ON_AMAZON - For products sold on Amazon websites.\n- NOT_SOLD_ON_AMAZON - For products not sold on Amazon websites.\n- SOLD_ON_DTC - Deprecated (For products sold on DTC websites).","type":"string","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON","SOLD_ON_DTC"]},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"costType":{"description":"The costType can be set to determines how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace\n- CPC [Default] - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad.\n- VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\n- FIXED_PRICE - Sale price for a specific ad placement. It can only be used for campaign with a targetedPGDealId.","type":"string"},"smartDefault":{"minItems":1,"maxItems":100,"description":"The smartDefault specifies a list of the smart default options for the campaign.\n\n`smartDefault` is optional for create campaign requests. `smartDefault` are applicable to all applicable child entities of the campaign and are not editable once the campaign is created. When using [\"TARGETING\"], targets will be automatically added based on the goal selected.  When [\"MANUAL\"] is selected, you will still be required to manually add targets.\n\nIf you don't specify `smartDefault`, default value will be applied based on `goal` . If campaign's `goal` is selected, `smartDefault` will be set to [\"TARGETING\"].  Otherwise, a campaign's `smartDefault` will be set to [\"MANUAL\"].\n\nEach element in smartDefault can be set to determines which default strategy to be used\n- MANUAL - Manual settings, no smart default be applied to the campaign, if MANUAL is added in the list, no other items are allowed in the list (the list must contains only one item)\n- TARGETING - Smart Default Targeting creation, will automatically creating targetings when create ad group\n\nExample: [\"TARGETING\"]","type":"array","items":{"type":"string"}},"siteRestrictions":{"minItems":1,"maxItems":1,"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.  If this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business. \nPlease note that:\n1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU);\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions doesn't support shopperCohortBidding setting.","type":"array","items":{"type":"string","enum":["AMAZON_BUSINESS"]}},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"budget":{"format":"double","type":"number"},"extendedData":{"description":"CampaignExtendedData can only be retrieved via the list API. It won't be available in the response during update/create.","type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe campaign serving status determined by system.\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's status is enabled.\n- CAMPAIGN_PAUSED - Campaign's status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's status is enabled\n- PORTFOLIO_PAUSED - Portfolio's status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's start date is in the future\n- PORTFOLIO_ENDED - Portfolio's end date is in the past.\n\n- INELIGIBLE - Ad Offer is ineligible\n- ELIGIBLE - Ad Offer is eligible\n- ENDED - Campaign's end date is in the past.\n- PENDING_REVIEW - Campaign is pending review.\n- PENDING_START_DATE - Campaign's start date is in the future.\n- REJECTED - Campaign is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Campaign.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}},"targetedPGDealId":{"description":"DealId associated with the campaign. This field is immutable and cannot be changed after the campaign is created.","type":"string"}},"required":["budget","budgetType","campaignId","name","state"]}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"budgetError":{"type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"billingError":{"description":"Errors related to billing.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Campaigns"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Campaigns/operation/UpdateSponsoredBrandsCampaigns","sectionHeader":{"type":3,"text":"PUT /sb/v4/campaigns"},"summary":"Update campaigns","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/campaigns/list",{"summary":"List campaigns","requestBody":{"content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaignIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"portfolioIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"stateFilter":{"description":"Filter entities by state.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]}}}},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","maximum":100,"type":"number","minimum":1},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"goalTypeFilter":{"description":"Filter entities by goal type.","type":"object","properties":{"include":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}}}},"includeExtendedDataFields":{"description":"Setting to true will slow down performance because the API needs to retrieve extra information for each campaign.","type":"boolean"},"nameFilter":{"description":"Filter entities by name.","type":"object","properties":{"queryTermMatchType":{"description":"Defines how would the string resource field (e.g. campaign name, ad group name) be matched with the query term in filter.","type":"string","enum":["BROAD_MATCH","EXACT_MATCH"]},"include":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}}}}}}}}},"description":"Lists Sponsored Brands campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredBrandsCampaigns","responses":{"200":{"description":"ListSponsoredBrandsCampaigns 200 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"object","properties":{"budgetType":{"description":"For the lifetime budget type, `startDate` and `endDate` must be specified.","type":"string","enum":["DAILY","LIFETIME"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}},"brandEntityId":{"type":"string"},"isMultiAdGroupsEnabled":{"type":"boolean"},"goal":{"description":"Goal will allow you to set goal type to help drive your campaign performance. If no goal is selected then it will default to PAGE_VISIT.\nThe goal type of the campaign.\n- BRAND_IMPRESSION_SHARE - This goal will allow you grown your brand impression share on top of search placements\n- PAGE_VISIT [DEFAULT] - This goal drives traffic to your landing and detail pages through all placements\n- ACQUIRE_NEW_CUSTOMERS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal drives new customer acquisition for your brands.\n- AD_VIEWS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal maximizes view for your ads.\n\nNote: Goal-based campaigns are not supported in the Ireland (IE) marketplace. For IE, both `goal` and `costType` must be omitted from the request, which creates a standard (non-goal-based) campaign. Supplying `goal` and `costType` in IE returns a `GOAL_BASED_CAMPAIGNS_DISABLED` error.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"productLocation":{"description":"The product location of the campaign.\n- SOLD_ON_AMAZON - For products sold on Amazon websites.\n- NOT_SOLD_ON_AMAZON - For products not sold on Amazon websites.\n- SOLD_ON_DTC - Deprecated (For products sold on DTC websites).","type":"string","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON","SOLD_ON_DTC"]},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"costType":{"description":"The costType can be set to determines how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace\n- CPC [Default] - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad.\n- VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\n- FIXED_PRICE - Sale price for a specific ad placement. It can only be used for campaign with a targetedPGDealId.","type":"string"},"smartDefault":{"minItems":1,"maxItems":100,"description":"The smartDefault specifies a list of the smart default options for the campaign.\n\n`smartDefault` is optional for create campaign requests. `smartDefault` are applicable to all applicable child entities of the campaign and are not editable once the campaign is created. When using [\"TARGETING\"], targets will be automatically added based on the goal selected.  When [\"MANUAL\"] is selected, you will still be required to manually add targets.\n\nIf you don't specify `smartDefault`, default value will be applied based on `goal` . If campaign's `goal` is selected, `smartDefault` will be set to [\"TARGETING\"].  Otherwise, a campaign's `smartDefault` will be set to [\"MANUAL\"].\n\nEach element in smartDefault can be set to determines which default strategy to be used\n- MANUAL - Manual settings, no smart default be applied to the campaign, if MANUAL is added in the list, no other items are allowed in the list (the list must contains only one item)\n- TARGETING - Smart Default Targeting creation, will automatically creating targetings when create ad group\n\nExample: [\"TARGETING\"]","type":"array","items":{"type":"string"}},"siteRestrictions":{"minItems":1,"maxItems":1,"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.  If this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business. \nPlease note that:\n1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU);\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions doesn't support shopperCohortBidding setting.","type":"array","items":{"type":"string","enum":["AMAZON_BUSINESS"]}},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"budget":{"format":"double","type":"number"},"extendedData":{"description":"CampaignExtendedData can only be retrieved via the list API. It won't be available in the response during update/create.","type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe campaign serving status determined by system.\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's status is enabled.\n- CAMPAIGN_PAUSED - Campaign's status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's status is enabled\n- PORTFOLIO_PAUSED - Portfolio's status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's start date is in the future\n- PORTFOLIO_ENDED - Portfolio's end date is in the past.\n\n- INELIGIBLE - Ad Offer is ineligible\n- ELIGIBLE - Ad Offer is eligible\n- ENDED - Campaign's end date is in the past.\n- PENDING_REVIEW - Campaign is pending review.\n- PENDING_START_DATE - Campaign's start date is in the future.\n- REJECTED - Campaign is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Campaign.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}},"targetedPGDealId":{"description":"DealId associated with the campaign. This field is immutable and cannot be changed after the campaign is created.","type":"string"}},"required":["budget","budgetType","campaignId","name","state"]}},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalCount":{"description":"The total number of entities.","type":"number"}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Campaigns"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Campaigns/operation/ListSponsoredBrandsCampaigns","sectionHeader":{"type":3,"text":"POST /sb/v4/campaigns/list"},"summary":"List campaigns","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/campaigns/delete",{"summary":"Delete campaigns.","requestBody":{"content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaignIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}}}}}}},"description":"Deletes Sponsored Brands campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredBrandsCampaigns","responses":{"207":{"description":"DeleteSponsoredBrandsCampaigns 207 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"campaignId":{"description":"The campaign ID.","type":"string"},"index":{"description":"The index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"campaign":{"type":"object","properties":{"budgetType":{"description":"For the lifetime budget type, `startDate` and `endDate` must be specified.","type":"string","enum":["DAILY","LIFETIME"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}},"brandEntityId":{"type":"string"},"isMultiAdGroupsEnabled":{"type":"boolean"},"goal":{"description":"Goal will allow you to set goal type to help drive your campaign performance. If no goal is selected then it will default to PAGE_VISIT.\nThe goal type of the campaign.\n- BRAND_IMPRESSION_SHARE - This goal will allow you grown your brand impression share on top of search placements\n- PAGE_VISIT [DEFAULT] - This goal drives traffic to your landing and detail pages through all placements\n- ACQUIRE_NEW_CUSTOMERS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal drives new customer acquisition for your brands.\n- AD_VIEWS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal maximizes view for your ads.\n\nNote: Goal-based campaigns are not supported in the Ireland (IE) marketplace. For IE, both `goal` and `costType` must be omitted from the request, which creates a standard (non-goal-based) campaign. Supplying `goal` and `costType` in IE returns a `GOAL_BASED_CAMPAIGNS_DISABLED` error.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"productLocation":{"description":"The product location of the campaign.\n- SOLD_ON_AMAZON - For products sold on Amazon websites.\n- NOT_SOLD_ON_AMAZON - For products not sold on Amazon websites.\n- SOLD_ON_DTC - Deprecated (For products sold on DTC websites).","type":"string","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON","SOLD_ON_DTC"]},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"costType":{"description":"The costType can be set to determines how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace\n- CPC [Default] - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad.\n- VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\n- FIXED_PRICE - Sale price for a specific ad placement. It can only be used for campaign with a targetedPGDealId.","type":"string"},"smartDefault":{"minItems":1,"maxItems":100,"description":"The smartDefault specifies a list of the smart default options for the campaign.\n\n`smartDefault` is optional for create campaign requests. `smartDefault` are applicable to all applicable child entities of the campaign and are not editable once the campaign is created. When using [\"TARGETING\"], targets will be automatically added based on the goal selected.  When [\"MANUAL\"] is selected, you will still be required to manually add targets.\n\nIf you don't specify `smartDefault`, default value will be applied based on `goal` . If campaign's `goal` is selected, `smartDefault` will be set to [\"TARGETING\"].  Otherwise, a campaign's `smartDefault` will be set to [\"MANUAL\"].\n\nEach element in smartDefault can be set to determines which default strategy to be used\n- MANUAL - Manual settings, no smart default be applied to the campaign, if MANUAL is added in the list, no other items are allowed in the list (the list must contains only one item)\n- TARGETING - Smart Default Targeting creation, will automatically creating targetings when create ad group\n\nExample: [\"TARGETING\"]","type":"array","items":{"type":"string"}},"siteRestrictions":{"minItems":1,"maxItems":1,"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.  If this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business. \nPlease note that:\n1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU);\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions doesn't support shopperCohortBidding setting.","type":"array","items":{"type":"string","enum":["AMAZON_BUSINESS"]}},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"budget":{"format":"double","type":"number"},"extendedData":{"description":"CampaignExtendedData can only be retrieved via the list API. It won't be available in the response during update/create.","type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe campaign serving status determined by system.\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's status is enabled.\n- CAMPAIGN_PAUSED - Campaign's status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's status is enabled\n- PORTFOLIO_PAUSED - Portfolio's status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's start date is in the future\n- PORTFOLIO_ENDED - Portfolio's end date is in the past.\n\n- INELIGIBLE - Ad Offer is ineligible\n- ELIGIBLE - Ad Offer is eligible\n- ENDED - Campaign's end date is in the past.\n- PENDING_REVIEW - Campaign is pending review.\n- PENDING_START_DATE - Campaign's start date is in the future.\n- REJECTED - Campaign is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Campaign.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}},"targetedPGDealId":{"description":"DealId associated with the campaign. This field is immutable and cannot be changed after the campaign is created.","type":"string"}},"required":["budget","budgetType","campaignId","name","state"]}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"budgetError":{"type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"billingError":{"description":"Errors related to billing.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Campaigns"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Campaigns/operation/DeleteSponsoredBrandsCampaigns","sectionHeader":{"type":3,"text":"POST /sb/v4/campaigns/delete"},"summary":"Delete campaigns.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/adGroups",{"summary":"Create ad groups","requestBody":{"content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]}},"required":["campaignId","name","state"]}}},"required":["adGroups"]}}},"required":true},"description":"Creates Sponsored Brands ad groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsAdGroups","responses":{"207":{"description":"CreateSponsoredBrandsAdGroups 207 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adGroup":{"type":"object","properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The identifier of the keyword.","type":"string"},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe ad group serving status determined by system.\n- AD_GROUP_STATUS_ENABLED - Ad group's status is enabled.\n- AD_GROUP_PAUSED - Ad group's status is paused.\n- AD_GROUP_ARCHIVED - Ad group's status is archived.\n- AD_GROUP_INCOMPLETE - Ad group does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad group is ineligible.\n- ELIGIBLE - Ad group is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad Group.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","name","state"]},"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"adGroupId":{"description":"the adGroup ID.","type":"string"}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ad groups"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20groups/operation/CreateSponsoredBrandsAdGroups","sectionHeader":{"type":3,"text":"POST /sb/v4/adGroups"},"summary":"Create ad groups","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/adGroups",{"summary":"Update ad groups","requestBody":{"content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The identifier of the keyword.","type":"string"}},"required":["adGroupId"]}}},"required":["adGroups"]}}},"required":true},"description":"Updates Sponsored Brands ad groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredBrandsAdGroups","responses":{"207":{"description":"UpdateSponsoredBrandsAdGroups 207 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adGroup":{"type":"object","properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The identifier of the keyword.","type":"string"},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe ad group serving status determined by system.\n- AD_GROUP_STATUS_ENABLED - Ad group's status is enabled.\n- AD_GROUP_PAUSED - Ad group's status is paused.\n- AD_GROUP_ARCHIVED - Ad group's status is archived.\n- AD_GROUP_INCOMPLETE - Ad group does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad group is ineligible.\n- ELIGIBLE - Ad group is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad Group.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","name","state"]},"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"adGroupId":{"description":"the adGroup ID.","type":"string"}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ad groups"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20groups/operation/UpdateSponsoredBrandsAdGroups","sectionHeader":{"type":3,"text":"PUT /sb/v4/adGroups"},"summary":"Update ad groups","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/adGroups/list",{"summary":"List ad groups","requestBody":{"content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"campaignIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"stateFilter":{"description":"Filter entities by state.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]}}}},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","maximum":100,"type":"number","minimum":1},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"adGroupIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"includeExtendedDataFields":{"description":"Setting to true will slow down performance because the API needs to retrieve extra information for each campaign.","type":"boolean"},"nameFilter":{"description":"Filter entities by name.","type":"object","properties":{"queryTermMatchType":{"description":"Defines how would the string resource field (e.g. campaign name, ad group name) be matched with the query term in filter.","type":"string","enum":["BROAD_MATCH","EXACT_MATCH"]},"include":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}}}}}}}}},"description":"Lists Sponsored Brands ad groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredBrandsAdGroups","responses":{"200":{"description":"ListSponsoredBrandsAdGroups 200 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"totalResults":{"description":"The total number of entities.","type":"number"},"adGroups":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"object","properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The identifier of the keyword.","type":"string"},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe ad group serving status determined by system.\n- AD_GROUP_STATUS_ENABLED - Ad group's status is enabled.\n- AD_GROUP_PAUSED - Ad group's status is paused.\n- AD_GROUP_ARCHIVED - Ad group's status is archived.\n- AD_GROUP_INCOMPLETE - Ad group does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad group is ineligible.\n- ELIGIBLE - Ad group is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad Group.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","name","state"]}},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ad groups"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20groups/operation/ListSponsoredBrandsAdGroups","sectionHeader":{"type":3,"text":"POST /sb/v4/adGroups/list"},"summary":"List ad groups","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/adGroups/delete",{"summary":"Delete ad groups","requestBody":{"content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroupIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}}}}}}},"description":"Deletes Sponsored Brands ad groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredBrandsAdGroups","responses":{"207":{"description":"DeleteSponsoredBrandsAdGroups 207 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adGroup":{"type":"object","properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The identifier of the keyword.","type":"string"},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe ad group serving status determined by system.\n- AD_GROUP_STATUS_ENABLED - Ad group's status is enabled.\n- AD_GROUP_PAUSED - Ad group's status is paused.\n- AD_GROUP_ARCHIVED - Ad group's status is archived.\n- AD_GROUP_INCOMPLETE - Ad group does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad group is ineligible.\n- ELIGIBLE - Ad group is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad Group.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","name","state"]},"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"adGroupId":{"description":"the adGroup ID.","type":"string"}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ad groups"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20groups/operation/DeleteSponsoredBrandsAdGroups","sectionHeader":{"type":3,"text":"POST /sb/v4/adGroups/delete"},"summary":"Delete ad groups","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/autoCollection",{"description":"Creates Sponsored Brands automatic collection ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsAutoCollectionAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"ads":{"items":{"properties":{"adGroupId":{"description":"Entity object identifier.","type":"string"},"creative":{"properties":{"asinExclusions":{"items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"brandLogoAssetID":{"type":"string"},"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"maxLength":30,"minLength":1,"type":"string"}},"required":["brandName"],"type":"object"},"name":{"maxLength":255,"minLength":1,"type":"string"},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]}},"required":["adGroupId","creative","name","state"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"}}},"required":true},"responses":{"207":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}},"type":"object"}}},"description":"CreateSponsoredBrandsAutoCollectionAds 207 response."},"400":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}},"description":"InvalidArgumentException 400 response."},"401":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"UnauthorizedException 401 response."},"403":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"AccessDeniedException 403 response."},"429":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"ThrottlingException 429 response.","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"InternalServerException 500 response."}},"tags":["Ads"],"summary":"Create Sponsored Brands Auto Collection Ads"}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsAutoCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/autoCollection"},"summary":"Create Sponsored Brands Auto Collection Ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/manualCollection",{"description":"Creates Sponsored Brands manual collection ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsManualCollectionAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"ads":{"items":{"properties":{"adGroupId":{"description":"Entity object identifier.","type":"string"},"creative":{"properties":{"asins":{"items":{"type":"string"},"maxItems":10,"minItems":3,"type":"array"},"brandLogoAssetID":{"type":"string"},"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"maxLength":30,"minLength":1,"type":"string"},"landingPage":{"properties":{"pageType":{"description":"The BrandCollectionLandingPageType is used for brand collection ads, supporting only store page and product list landing pages.","enum":["PRODUCT_LIST","STORE"],"type":"string"},"url":{"description":"URL of an existing simple landing page or Store page for brand collection ads.\nIf the pageType is PRODUCT_LIST, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.","type":"string"}},"type":"object"},"title":{"description":"Optional title for the collection. If not provided, title will be auto-generated.","maxLength":32,"type":"string"}},"required":["asins","brandName"],"type":"object"},"name":{"maxLength":255,"minLength":1,"type":"string"},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]}},"required":["adGroupId","creative","name","state"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"}}},"required":true},"responses":{"207":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}},"type":"object"}}},"description":"CreateSponsoredBrandsManualCollectionAds 207 response."},"400":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}},"description":"InvalidArgumentException 400 response."},"401":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"UnauthorizedException 401 response."},"403":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"AccessDeniedException 403 response."},"429":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"ThrottlingException 429 response.","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"InternalServerException 500 response."}},"tags":["Ads"],"summary":"Create Sponsored Brands Manual Collection Ads"}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsManualCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/manualCollection"},"summary":"Create Sponsored Brands Manual Collection Ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/brandVideo",{"summary":"Create brand video ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"asins":{"minItems":0,"maxItems":3,"type":"array","items":{"type":"string"}},"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"videoAssetIds":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50}}}},"required":["adGroupId","creative","landingPage","name","state"]}}},"required":["ads"]}}},"required":true},"description":"Creates Sponsored Brands brand video ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsBrandVideoAds","responses":{"207":{"description":"CreateSponsoredBrandsBrandVideoAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsBrandVideoAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/brandVideo"},"summary":"Create brand video ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/productCollectionExtended",{"summary":"[DEPRECATED] Creates Sponsored Brands new product collection ads with collection of custom images","deprecated":true,"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"description":"An array of Product Collection ad objects to create. Maximum length of the array is 10 objects.","type":"array","items":{"type":"object","properties":{"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"asins":{"minItems":0,"maxItems":3,"type":"array","items":{"type":"string"}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"type":"string","maxLength":50}}}},"required":["adGroupId","creative","landingPage","name","state"]}}},"required":["ads"]}}},"required":true},"description":"[DEPRECATED - Do not use] Refer to the [Product Collection Deprecation Notice](https://advertising.amazon.com/API/docs/en-us/release-notes/deprecations#deprecation-of-sponsored-brands-product-collection-ad-type) for more details. Use [/sb/v4/ads/manualCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsManualCollectionAds) or [/sb/v4/ads/autoCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsAutoCollectionAds) instead.\n\n---\n\nCreates Sponsored Brands product collection ads with collection of custom images[1-5].\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsExtendedProductCollectionAds","responses":{"207":{"description":"CreateSponsoredBrandsExtendedProductCollectionAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsExtendedProductCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/productCollectionExtended"},"summary":"[DEPRECATED] Creates Sponsored Brands new product collection ads with collection of custom images","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/video",{"summary":"Create video ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"asins":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"string"}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}}}}},"required":["adGroupId","creative","name","state"]}}},"required":["ads"]}}},"required":true},"description":"Creates Sponsored Brands video ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsVideoAds","responses":{"207":{"description":"CreateSponsoredBrandsVideoAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsVideoAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/video"},"summary":"Create video ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/productCollection",{"summary":"[DEPRECATED] Create product collection ads","deprecated":true,"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"asins":{"minItems":0,"maxItems":3,"type":"array","items":{"type":"string"}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50}}}},"required":["adGroupId","creative","landingPage","name","state"]}}},"required":["ads"]}}},"required":true},"description":"[DEPRECATED - Do not use] Refer to the [Product Collection Deprecation Notice](https://advertising.amazon.com/API/docs/en-us/release-notes/deprecations#deprecation-of-sponsored-brands-product-collection-ad-type) for more details. Use [/sb/v4/ads/manualCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsManualCollectionAds) or [/sb/v4/ads/autoCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsAutoCollectionAds) instead.\n\n---\n\nCreates Sponsored Brands product collection ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsProductCollectionAds","responses":{"207":{"description":"CreateSponsoredBrandsProductCollectionAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsProductCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/productCollection"},"summary":"[DEPRECATED] Create product collection ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/storeSpotlight",{"summary":"Create store spotlight ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50}}}},"required":["adGroupId","creative","landingPage","name","state"]}}},"required":["ads"]}}},"required":true},"description":"Creates Sponsored Brands store spotlight ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandStoreSpotlightAds","responses":{"207":{"description":"CreateSponsoredBrandStoreSpotlightAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandStoreSpotlightAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/storeSpotlight"},"summary":"Create store spotlight ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads",{"summary":"Update ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"The product ad identifier.","type":"string"},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]}},"required":["adId"]}}},"required":["ads"]}}},"required":true},"description":"Updates Sponsored Brands ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredBrandsAds","responses":{"207":{"description":"UpdateSponsoredBrandsAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/UpdateSponsoredBrandsAds","sectionHeader":{"type":3,"text":"PUT /sb/v4/ads"},"summary":"Update ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/autoCollection",{"description":"Updates the ad settings for an automatic collection by creating a new version\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredBrandsAutoCollectionAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"description":"Updates the ad settings for an automatic collection by creating a new version","properties":{"ads":{"description":"List of Automatic Collection Ad Updates","items":{"properties":{"adId":{"description":"Entity object identifier.","type":"string"},"creative":{"properties":{"asinExclusions":{"items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"brandLogoAssetID":{"type":"string"},"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"maxLength":30,"minLength":1,"type":"string"}},"required":["brandName"],"type":"object"}},"required":["adId","creative"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"}}},"required":true},"responses":{"207":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"creatives":{"properties":{"error":{"items":{"properties":{"errors":{"description":"A list of validation errors.","items":{"properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"properties":{"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}},"type":"object"}},"required":["errorType","errorValue"],"type":"object"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"the index of the creative in the array from the request body.","maximum":10,"minimum":0,"type":"number"}},"required":["index"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"},"success":{"items":{"properties":{"adId":{"description":"Entity object identifier.","type":"string"},"creativeVersion":{"type":"string"},"index":{"description":"The index in the original list from the request.","maximum":10,"minimum":0,"type":"number"}},"required":["adId","index"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"UpdateSponsoredBrandsAutoCollectionAds 207 response."},"400":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}},"description":"InvalidArgumentException 400 response."},"401":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"UnauthorizedException 401 response."},"403":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"AccessDeniedException 403 response."},"429":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"ThrottlingException 429 response.","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"InternalServerException 500 response."}},"tags":["Ads"],"summary":"Update Sponsored Brands Auto Collection Ads"}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/UpdateSponsoredBrandsAutoCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/autoCollection"},"summary":"Update Sponsored Brands Auto Collection Ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/manualCollection",{"description":"Updates the ad settings for a manual collection by creating a new version\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredBrandsManualCollectionAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"description":"Updates the ad settings for a manual collection by creating a new version","properties":{"ads":{"description":"List of Manual Collection Ad Updates","items":{"properties":{"adId":{"description":"Entity object identifier.","type":"string"},"creative":{"properties":{"asins":{"items":{"type":"string"},"maxItems":10,"minItems":3,"type":"array"},"brandLogoAssetID":{"type":"string"},"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"maxLength":30,"minLength":1,"type":"string"},"landingPage":{"properties":{"pageType":{"description":"The BrandCollectionLandingPageType is used for brand collection ads, supporting only store page and product list landing pages.","enum":["PRODUCT_LIST","STORE"],"type":"string"},"url":{"description":"URL of an existing simple landing page or Store page for brand collection ads.\nIf the pageType is PRODUCT_LIST, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.","type":"string"}},"type":"object"},"title":{"description":"Optional title for the collection. If not provided, title will be auto-generated.","maxLength":32,"type":"string"}},"required":["asins","brandName"],"type":"object"}},"required":["adId","creative"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"}}},"required":true},"responses":{"207":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"creatives":{"properties":{"error":{"items":{"properties":{"errors":{"description":"A list of validation errors.","items":{"properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"properties":{"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}},"type":"object"}},"required":["errorType","errorValue"],"type":"object"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"the index of the creative in the array from the request body.","maximum":10,"minimum":0,"type":"number"}},"required":["index"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"},"success":{"items":{"properties":{"adId":{"description":"Entity object identifier.","type":"string"},"creativeVersion":{"type":"string"},"index":{"description":"The index in the original list from the request.","maximum":10,"minimum":0,"type":"number"}},"required":["adId","index"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"UpdateSponsoredBrandsManualCollectionAds 207 response."},"400":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}},"description":"InvalidArgumentException 400 response."},"401":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"UnauthorizedException 401 response."},"403":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"AccessDeniedException 403 response."},"429":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"ThrottlingException 429 response.","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"InternalServerException 500 response."}},"tags":["Ads"],"summary":"Update Sponsored Brands Manual Collection Ads"}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/UpdateSponsoredBrandsManualCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/manualCollection"},"summary":"Update Sponsored Brands Manual Collection Ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/list",{"summary":"List ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"campaignIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"stateFilter":{"description":"Filter entities by state.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]}}}},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","maximum":100,"type":"number","minimum":1},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"adIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"adGroupIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"nameFilter":{"description":"Filter entities by name.","type":"object","properties":{"queryTermMatchType":{"description":"Defines how would the string resource field (e.g. campaign name, ad group name) be matched with the query term in filter.","type":"string","enum":["BROAD_MATCH","EXACT_MATCH"]},"include":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}}}}}}}}},"description":"Lists Sponsored Brands ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredBrandsAds","responses":{"200":{"description":"ListSponsoredBrandsAds 200 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"object","properties":{"adId":{"description":"The ad identifier. Note: Ads created using version 3/non-multi ad group campaigns do not have an associated adId. [Learn more](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/campaigns/managing-multi-ad-group-campaigns#ads).","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad. Note: Ads created using version 3/non-multi ad group campaigns do not have an associated name. [Learn more](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/campaigns/managing-multi-ad-group-campaigns#ads).","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","state"]}},"totalResults":{"description":"The total number of entities.","type":"number"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/ListSponsoredBrandsAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/list"},"summary":"List ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/delete",{"summary":"Delete ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"adIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}}}}}}},"description":"Deletes Sponsored Brands ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredBrandsAds","responses":{"207":{"description":"DeleteSponsoredBrandsAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/DeleteSponsoredBrandsAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/delete"},"summary":"Delete ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/brandVideo",{"summary":"Create new version of brand video ad creative","requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creative":{"type":"object","properties":{"asins":{"minItems":0,"maxItems":3,"description":"An array of ASINs associated with the creative.","type":"array","items":{"description":"ASIN","type":"string"}},"brandLogoCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandName":{"description":"The displayed brand name in the ad headline.\nMaximum length is 30 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"},"landingPage":{"description":"Landing page V2, where type is String with allowed values listed, and url or asins of that type.","type":"object","properties":{"asins":{"minItems":0,"maxItems":100,"description":"The list of asins on the landingPage If type is PRODUCT_LIST. A minimum of 3 asins are required. For the 'PRODUCT_LIST' type, the asins property is mandatory, and the url should not be included.","type":"array","items":{"description":"ASIN","type":"string"}},"type":{"description":"Supported types are PRODUCT_LIST, STORE, DETAIL_PAGE, CUSTOM_URL. More could be added in future.","type":"string"},"url":{"description":"The url of the landingPage. When including the 'asins' property in the request, do not include this property, as they are mutually exclusive. For the PRODUCT_LIST type, the asins property is mandatory, and the url should not be included.","type":"string"}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language.\nIf Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then 'videoAssetIds' will return translated video assetId whereas `originalVideoAssetIds` will return the original video assetId. In all other cases, `videoAssetIds` will return original video assetId.","type":"array","items":{"description":"The identifier of image/video asset from the store's asset library","type":"string"}},"brandLogoAssetId":{"description":"The identifier of the [brand logo](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#brandlogo) image from the brand store's asset library.\nNote that for campaigns created in the Amazon Advertising console prior to release of the brand store's assets library, responses will not include a value for this field.","type":"string"},"headline":{"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"}},"required":["asins","brandLogoAssetId","brandName","headline","videoAssetIds"]}},"required":["adId","creative"]}}},"required":true},"description":"This API creates a new version of an existing creative for given Sponsored Brands Ad by supplying brand video creative content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateBrandVideoCreative","responses":{"200":{"description":"CreateBrandVideoCreative 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"description":"Create creative response","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"409":{"description":"ConflictStateException 409 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["CONFLICT_STATE"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/CreateBrandVideoCreative","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/brandVideo"},"summary":"Create new version of brand video ad creative","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/productCollectionExtended",{"summary":"[DEPRECATED] Creates Sponsored Brands new version of product collection with collection of custom image ads","deprecated":true,"requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creative":{"type":"object","properties":{"asins":{"minItems":0,"maxItems":3,"uniqueItems":true,"description":"An array of ASINs associated with the creative.","type":"array","items":{"description":"ASIN","type":"string"}},"brandLogoCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandName":{"description":"The displayed brand name in the ad headline.\nMaximum length is 30 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"},"landingPage":{"description":"Landing page V2, where type is String with allowed values listed, and url or asins of that type.","type":"object","properties":{"asins":{"minItems":0,"maxItems":100,"description":"The list of asins on the landingPage If type is PRODUCT_LIST. A minimum of 3 asins are required. For the 'PRODUCT_LIST' type, the asins property is mandatory, and the url should not be included.","type":"array","items":{"description":"ASIN","type":"string"}},"type":{"description":"Supported types are PRODUCT_LIST, STORE, DETAIL_PAGE, CUSTOM_URL. More could be added in future.","type":"string"},"url":{"description":"The url of the landingPage. When including the 'asins' property in the request, do not include this property, as they are mutually exclusive. For the PRODUCT_LIST type, the asins property is mandatory, and the url should not be included.","type":"string"}}},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"An array of customImages associated with the creative.","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language.\nIf Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"brandLogoAssetId":{"description":"The identifier of the [brand logo](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#brandlogo) image from the brand store's asset library.\nNote that for campaigns created in the Amazon Advertising console prior to release of the brand store's assets library, responses will not include a value for this field.","type":"string"},"headline":{"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"}},"required":["asins","brandLogoAssetId","brandName","headline"]}},"required":["adId","creative"]}}},"required":true},"description":"[DEPRECATED - Do not use] Refer to the [Product Collection Deprecation Notice](https://advertising.amazon.com/API/docs/en-us/release-notes/deprecations#deprecation-of-sponsored-brands-product-collection-ad-type) for more details. Use [/sb/ads/creatives/manualCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad-creatives/operation/UpdateSponsoredBrandsManualCollectionAds) instead.\n\n---\n\nThis API creates a new version of creative for given Sponsored Brands ad by supplying extended product collection creative content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateExtendedProductCollectionCreative","responses":{"200":{"description":"CreateExtendedProductCollectionCreative 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"description":"Create creative response","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"409":{"description":"ConflictStateException 409 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["CONFLICT_STATE"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/CreateExtendedProductCollectionCreative","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/productCollectionExtended"},"summary":"[DEPRECATED] Creates Sponsored Brands new version of product collection with collection of custom image ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/video",{"summary":"Create new version of video ad creative","requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creative":{"type":"object","properties":{"consentToTranslate":{"description":"If set to true and the heaadline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language.\nIf Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then 'videoAssetIds' will return translated video assetId whereas `originalVideoAssetIds` will return the original video assetId. In all other cases, `videoAssetIds` will return original video assetId.","type":"array","items":{"description":"The identifier of image/video asset from the store's asset library","type":"string"}}},"required":["videoAssetIds"]}},"required":["adId","creative"]}}},"required":true},"description":"This API creates a new version of an existing creative for given Sponsored Brands ad by supplying video creative content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateVideoCreative","responses":{"200":{"description":"CreateVideoCreative 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"description":"Create creative response","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"409":{"description":"ConflictStateException 409 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["CONFLICT_STATE"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/CreateVideoCreative","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/video"},"summary":"Create new version of video ad creative","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/productCollection",{"summary":"[DEPRECATED] Create new version of product collection ad creative","deprecated":true,"requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creative":{"type":"object","properties":{"asins":{"minItems":0,"maxItems":3,"uniqueItems":true,"description":"An array of ASINs associated with the creative.","type":"array","items":{"description":"ASIN","type":"string"}},"brandLogoCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandName":{"description":"The displayed brand name in the ad headline.\nMaximum length is 30 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"},"customImageAssetId":{"description":"The identifier of the Custom image from the Store assets library.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#customimage) for more information on what constitutes a valid Custom image.","type":"string"},"customImageCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandLogoAssetId":{"description":"The identifier of the [brand logo](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#brandlogo) image from the brand store's asset library.\nNote that for campaigns created in the Amazon Advertising console prior to release of the brand store's assets library, responses will not include a value for this field.","type":"string"},"headline":{"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"}},"required":["asins","brandLogoAssetId","brandName","headline"]}},"required":["adId","creative"]}}},"required":true},"description":"[DEPRECATED - Do not use] Refer to the [Product Collection Deprecation Notice](https://advertising.amazon.com/API/docs/en-us/release-notes/deprecations#deprecation-of-sponsored-brands-product-collection-ad-type) for more details. Use [/sb/ads/creatives/manualCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad-creatives/operation/UpdateSponsoredBrandsManualCollectionAds) instead.\n\n---\n\nThis API creates a new version of creative for given Sponsored Brands ad by supplying product collection creative content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateProductCollectionCreative","responses":{"200":{"description":"CreateProductCollectionCreative 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"description":"Create creative response","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"409":{"description":"ConflictStateException 409 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["CONFLICT_STATE"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/CreateProductCollectionCreative","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/productCollection"},"summary":"[DEPRECATED] Create new version of product collection ad creative","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/storeSpotlight",{"summary":"Create new version of store spotlight ad creative","requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandName":{"description":"The displayed brand name in the ad headline.\nMaximum length is 30 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"},"subpages":{"description":"An array of subpages","type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"landingPage":{"description":"Landing page V2, where type is String with allowed values listed, and url or asins of that type.","type":"object","properties":{"asins":{"minItems":0,"maxItems":100,"description":"The list of asins on the landingPage If type is PRODUCT_LIST. A minimum of 3 asins are required. For the 'PRODUCT_LIST' type, the asins property is mandatory, and the url should not be included.","type":"array","items":{"description":"ASIN","type":"string"}},"type":{"description":"Supported types are PRODUCT_LIST, STORE, DETAIL_PAGE, CUSTOM_URL. More could be added in future.","type":"string"},"url":{"description":"The url of the landingPage. When including the 'asins' property in the request, do not include this property, as they are mutually exclusive. For the PRODUCT_LIST type, the asins property is mandatory, and the url should not be included.","type":"string"}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language.\nIf Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"brandLogoAssetId":{"description":"The identifier of the [brand logo](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#brandlogo) image from the brand store's asset library.\nNote that for campaigns created in the Amazon Advertising console prior to release of the brand store's assets library, responses will not include a value for this field.","type":"string"},"headline":{"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"}},"required":["brandLogoAssetId","brandName","headline","subpages"]}},"required":["adId","creative"]}}},"required":true},"description":"This API creates a new version of creative for given Sponsored Brands ad by supplying store spotlight creative content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateStoreSpotlightCreative","responses":{"200":{"description":"CreateStoreSpotlightCreative 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"description":"Create creative response","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"409":{"description":"ConflictStateException 409 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["CONFLICT_STATE"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/CreateStoreSpotlightCreative","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/storeSpotlight"},"summary":"Create new version of store spotlight ad creative","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/list",{"summary":"List ad creatives","requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"creativeTypeFilter":{"uniqueItems":true,"description":"Filters creatives by optional creative type.\nBy default, you can list all creative versions regardless of creative type.","type":"array","items":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]}},"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field.\nTo retrieve the next page of results, call the same operation and specify this token in the request.\nIf the `NextToken` field is empty, there are no further results.","type":"string"},"maxResults":{"description":"Set a limit on the number of results returned by an operation.","maximum":100,"type":"number","minimum":1},"creativeVersionFilter":{"maxItems":100,"uniqueItems":true,"description":"Filters creatives by optional creative version.\nThis means you can either list all creative versions without specific creative version filter, all just retrieve a single creative version by providing a specific version identifier.","type":"array","items":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}},"creativeStatusFilter":{"uniqueItems":true,"description":"Filters creatives by optional creative status.\nBy default, you can list all creative versions regardless of creative status.","type":"array","items":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]}}},"required":["adId"]}}},"required":true},"description":"This API gets an array of all Sponsored Brands creatives that qualify the given resource identifiers and filters\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListCreatives","responses":{"200":{"description":"ListCreatives 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"totalResults":{"description":"The total number of results returned by an operation.","type":"number"},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field.\nTo retrieve the next page of results, call the same operation and specify this token in the request.\nIf the `NextToken` field is empty, there are no further results.","type":"string"},"creatives":{"description":"A list of creatives","type":"array","items":{"description":"-----------------------------------------------\nStructure types\n-----------------------------------------------\nCreative","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creationTime":{"format":"double","type":"number"},"creativeType":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeProperties":{"description":"Creative properties","type":"object","properties":{"brandLogoCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandName":{"description":"The displayed brand name in the ad headline.\nMaximum length is 30 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"},"customImageAssetId":{"description":"The identifier of image/video asset from the store's asset library","type":"string"},"landingPage":{"description":"Landing page.","type":"object","properties":{"asins":{"minItems":0,"maxItems":100,"description":"The list of asins on the landingPage If type is PRODUCT_LIST.","type":"array","items":{"description":"ASIN","type":"string"}},"type":{"description":"Landing page type","type":"string","enum":["PRODUCT_LIST","STORE","DETAIL_PAGE","CUSTOM_URL","AD_LANDING_PREVIEW","SEARCH","BROWSE","ADVERTISING_LANDING_PAGE","UNKNOWN"]},"value":{"description":"The url of the landingPage.","type":"string"}}},"customImages":{"minItems":0,"maxItems":5,"uniqueItems":true,"description":"An array of customImages associated with the creative.","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImageCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"customImageUrl":{"type":"string"},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"description":"The identifier of image/video asset from the store's asset library","type":"string"}},"asins":{"minItems":0,"maxItems":100,"description":"-----------------------------------------------\nList types\n-----------------------------------------------\nA list of ASINs","type":"array","items":{"description":"ASIN","type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"description":"An array of subpages","type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"description":"The original headline submitted by the advertiser.","type":"string"},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then 'videoAssetIds' will return translated video assetId whereas `originalVideoAssetIds` will return the original video assetId. In all other cases, `videoAssetIds` will return original video assetId.","type":"array","items":{"description":"The identifier of image/video asset from the store's asset library","type":"string"}},"brandLogoAssetId":{"description":"The identifier of image/video asset from the store's asset library","type":"string"},"headline":{"description":"If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `headline` will return the translated headline whereas `originalHeadline` will return the original headline. In all other cases, 'originalHeadline' and `headline` both will return the original headline.","type":"string"}}},"lastUpdateTime":{"format":"double","type":"number"}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"404":{"description":"NotFoundException 404 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/ListCreatives","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/list"},"summary":"List ad creatives","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/negativeTargets/brands/recommendations",{"summary":"Get brand recommendations for negative targeting","description":"Returns brands recommended for negative targeting. Only available for Sellers and Vendors. These recommendations include your own brands because targeting your own brands usually results in lower performance than targeting competitors' brands. \n\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SBTargetingGetNegativeBrands","responses":{"200":{"description":"SBTargetingGetNegativeBrands 200 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Response object for /sb/negativeTargets/brands/recommendations containing list of brands for negative targeting.","type":"object","properties":{"brands":{"maxItems":100,"description":"List of Brands.","type":"array","items":{"type":"object","properties":{"brandRefinementId":{"description":"Id of brand. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Brand Refinement IDs.","type":"string"},"name":{"description":"Name of brand.","type":"string"}},"required":["brandRefinementId"]}},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"SBTargetingBadRequestException 400 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a BadRequestException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"401":{"description":"SBTargetingUnauthorizedException 401 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an UnauthorizedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"403":{"description":"SBTargetingAccessDeniedException 403 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an AccessDeniedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBTargetingThrottlingException 429 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a ThrottlingException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"500":{"description":"SBTargetingInternalServerException 500 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an InternalServerException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}}},"parameters":[{"schema":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"in":"query","name":"nextToken","description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results."},{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Recommendations"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Recommendations/operation/SBTargetingGetNegativeBrands","sectionHeader":{"type":3,"text":"GET /sb/negativeTargets/brands/recommendations"},"summary":"Get brand recommendations for negative targeting","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/recommendations/optimization",{"summary":"Get recommendation for optimization rule","description":"Returns recommended bid value for optimization rule enable campaigns. Recommendations are generated based landing page, page type and ASINs provided in request. Only available for Sellers and Vendors.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]\"","requestBody":{"content":{"application/vnd.sboptimizationrecommendationresource.v4+json":{"schema":{"type":"object","properties":{"costControlMetric":{"description":"Cost control metric to retrieve recommended value for.  Currently only COST_PER_CLICK is supported.","type":"string","enum":["COST_PER_CLICK"]},"landingPages":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}}}},"required":["costControlMetric","landingPages"]}}},"required":true},"operationId":"SBOptimizationRecommendation","responses":{"207":{"description":"SBOptimizationRecommendation 207 response","content":{"application/vnd.sboptimizationrecommendationresource.v4+json":{"schema":{"type":"object","properties":{"minimumValue":{"format":"double","description":"Minimum accepted value for cost control metric.","type":"number"},"costControlMetric":{"description":"Cost control metric to retrieve recommended value for.  Currently only COST_PER_CLICK is supported.","type":"string","enum":["COST_PER_CLICK"]},"recommendedValue":{"format":"double","description":"Recommended value for cost control metric.","type":"number"}},"required":["costControlMetric","minimumValue","recommendedValue"]}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":true}],"tags":["Recommendations"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Recommendations/operation/SBOptimizationRecommendation","sectionHeader":{"type":3,"text":"POST /sb/recommendations/optimization"},"summary":"Get recommendation for optimization rule","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/recommendations/creative/headline",{"summary":"Get recommendations for creative headline","requestBody":{"content":{"application/json":{"schema":{"description":"Request structure of headline suggestion API.","type":"object","properties":{"asins":{"minItems":1,"maxItems":3,"description":"An array of ASINs associated with the creative. Note do not pass an empty array, this results in an error.\n","type":"array","items":{"type":"string"}},"storePages":{"minItems":1,"maxItems":3,"description":"An array of Store Pages associated with SB Spotlight Creative.","type":"array","items":{"type":"object","properties":{"displayName":{"description":"Display Name of the store page shown on a store spotlight campaign.","type":"string"},"primaryAsin":{"description":"Selected asin from the store page which is displayed on the store spotlight campaign.","type":"string"}}}},"maxNumSuggestions":{"description":"Maximum number of suggestions that API should return. Response will [0, maxNumSuggestions] suggestions (suggestions are not guaranteed).","maximum":10,"type":"number","minimum":1},"adFormat":{"type":"string","enum":["SPONSORED_BRANDS","SPONSORED_BRANDS_SPOTLIGHT"]}}}}},"required":true},"description":"API to receive creative headline suggestions.","operationId":"getHeadlineRecommendations","responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"description":"Response structure of headline suggestion API.","type":"object","properties":{"requestId":{"description":"An identifier for request made which is generated by server.","type":"string"},"suggestions":{"description":"Suggestions are sorted, i.e., more suitable headline has lesser array index value","type":"array","items":{"description":"Suggested Headline in response object.","type":"object","properties":{"headlineId":{"description":"Unique Id of suggested headline.","type":"string","example":"e991e32c-0136-427a-843b-ff04162f2f91"},"headline":{"description":"String that contains suggested headline.","type":"string","example":"This is a suggested headline."}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.\n","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity - Failed due to invalid parameters.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry\nlater and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":true}],"tags":["Recommendations"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Recommendations/operation/getHeadlineRecommendations","sectionHeader":{"type":3,"text":"POST /sb/recommendations/creative/headline"},"summary":"Get recommendations for creative headline","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/budgetRecommendations",{"summary":"Get budget recommendations","requestBody":{"content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"campaignIds":{"minItems":1,"maxItems":100,"description":"List of CampaignIds","type":"array","items":{"description":"The identifier of a campaign.","type":"string"}}},"required":["campaignIds"]}}},"required":true},"description":"Provides daily budget recommendations for a list of requested Sponsored Brands campaigns, with context on estimated historical missed opportunities.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"GetBudgetRecommendations","responses":{"207":{"description":"GetBudgetRecommendations 207 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"success":{"minItems":0,"maxItems":100,"description":"List of successful budget recommendations for campaigns.","type":"array","items":{"description":"Budget recomendation for campagins.","type":"object","properties":{"campaignId":{"description":"The identifier of a campaign.","type":"string"},"suggestedBudget":{"format":"double","description":"Recommended budget for the campaign.","type":"number"},"index":{"description":"Correlate the recommendation to the campaign index in the request. Zero-based.","type":"number"},"sevenDaysMissedOpportunities":{"description":"Missed Opportunities in the trailing seven days.","type":"object","properties":{"estimatedMissedSalesLower":{"format":"double","description":"Lower bound of the estimated Missed Sales. This will be in local currency.","type":"number"},"estimatedMissedSalesUpper":{"format":"double","description":"Upper bound of the estimated Missed Sales. This will be in local currency.","type":"number"},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"End date of the Missed Opportunities date range (YYYY-MM-DD) in local time.","type":"string"},"estimatedMissedImpressionsLower":{"description":"Lower bound of the estimated Missed Impressions.","type":"number"},"estimatedMissedClicksLower":{"description":"Lower bound of the estimated Missed Clicks.","type":"number"},"estimatedMissedClicksUpper":{"description":"Upper bound of the estimated Missed Clicks.","type":"number"},"estimatedMissedImpressionsUpper":{"description":"Upper bound of the estimated Missed Impressions.","type":"number"},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"Start date of the Missed Opportunities date range (YYYY-MM-DD) in local time.","type":"string"},"percentTimeInBudget":{"format":"double","description":"Percentage of time the campaign is active with a budget.","type":"number"}}}},"required":["campaignId","index","sevenDaysMissedOpportunities","suggestedBudget"]}},"error":{"minItems":0,"maxItems":100,"description":"List of errors that occurred when generating budget recommendations.","type":"array","items":{"description":"Error that occurred when generating budget recommendations.","type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"campaignId":{"description":"The identifier of a campaign.","type":"string"},"index":{"description":"Correlate the recommendation to the campaign index in the request. Zero-based.","type":"number"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["campaignId","code","details","index"]}}},"required":["error","success"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"422":{"description":"InvalidArgumentException 422 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":false},{"schema":{"description":"The identifier of an account. Account must be a global advertising account.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"The identifier of an account. Account must be a global advertising account.","required":false}],"tags":["Recommendations"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Recommendations/operation/GetBudgetRecommendations","sectionHeader":{"type":3,"text":"POST /sb/campaigns/budgetRecommendations"},"summary":"Get budget recommendations","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/targets/categories",{"summary":"Get targetable categories","description":"Returns all targetable categories by default in a list. List of categories can be used to build and traverse category tree.\nSet query parameter `includeOnlyRootCategories=true` to return only the root categories, or set `parentCategoryRefinementId` to return children of a specific parent category.\nEach category node has the fields - category name, category refinement id, parent category refinement id, isTargetable flag, and ASIN count range. \n\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SBTargetingGetTargetableCategories","responses":{"200":{"description":"SBTargetingGetTargetableCategories 200 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Response object for /sb/targets/categories containing all targetable categories for the advertiser's marketplace.","type":"object","properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"categoryTree":{"maxItems":5000,"description":"List of categories.","type":"array","items":{"description":"Category details.","type":"object","properties":{"asinCountRange":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"isTargetable":{"description":"If the category is targetable or not.","type":"boolean"},"parentCategoryRefinementId":{"description":"The category refinement id of the parent category. Missing parentCategoryRefinementId signifies this is a root category.","type":"string"},"estimatedReach":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"name":{"description":"Name of category.","type":"string"},"translatedName":{"description":"Translated name of the category.","type":"string"},"categoryRefinementId":{"description":"The category refinement id. Please use /sb/targets/categories or /sb/recommendations/targets/category to retrieve category IDs.","type":"string"}}}}}}}}},"400":{"description":"SBTargetingBadRequestException 400 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a BadRequestException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"401":{"description":"SBTargetingUnauthorizedException 401 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an UnauthorizedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBTargetingThrottlingException 429 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a ThrottlingException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"500":{"description":"SBTargetingInternalServerException 500 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an InternalServerException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}}},"parameters":[{"schema":{"description":"The locale to which the caller wishes to translate the targetable categories or refinements to. For example, if the caller wishes to receive the targetable categories in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the returned tagetable categories will be in the default language of the marketplace.","type":"string","enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"]},"in":"query","name":"locale","description":"The locale to which the caller wishes to translate the targetable categories or refinements to. For example, if the caller wishes to receive the targetable categories in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the returned tagetable categories will be in the default language of the marketplace."},{"schema":{"description":"[UPDATE: As of 05/28/2024, `STREAMING_VIDEO` is deprecated]. \n The supply source where the target will be used. Use `AMAZON` for placements on Amazon website. Use `STREAMING_VIDEO` for off-site video placements such as IMDb TV.","type":"string","enum":["AMAZON","STREAMING_VIDEO"]},"in":"query","name":"supplySource","description":"[UPDATE: As of 05/28/2024, `STREAMING_VIDEO` is deprecated]. \n The supply source where the target will be used. Use `AMAZON` for placements on Amazon website. Use `STREAMING_VIDEO` for off-site video placements such as IMDb TV.","required":true},{"schema":{"description":"Indicates whether to only retun root categories or not.","type":"boolean"},"in":"query","name":"includeOnlyRootCategories","description":"Indicates whether to only retun root categories or not."},{"schema":{"description":"Returns child categories of category.","type":"string"},"in":"query","name":"parentCategoryRefinementId","description":"Returns child categories of category."},{"schema":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"in":"query","name":"nextToken","description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results."},{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Product targeting categories"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Product%20targeting%20categories/operation/SBTargetingGetTargetableCategories","sectionHeader":{"type":3,"text":"GET /sb/targets/categories"},"summary":"Get targetable categories","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/targets/products/count",{"summary":"Get number of products in a category","requestBody":{"content":{"application/vnd.sbtargeting.v4+json":{"schema":{"type":"object","properties":{"ageRanges":{"maxItems":100,"description":"List of Age Range Refinement Ids.","type":"array","items":{"description":"Id of Age Range. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Age Range Refinement IDs.","type":"string"}},"brands":{"maxItems":100,"description":"List of Brand Refinement Ids.","type":"array","items":{"description":"Id of brand. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Brand Refinement IDs.","type":"string"}},"genres":{"maxItems":100,"description":"List of Genre Refinement Ids.","type":"array","items":{"description":"Id of Genre. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Genre Refinement IDs.","type":"string"}},"isPrimeShipping":{"description":"Indicates if products have prime shipping. Leave empty to include both prime shipping and non-prime shipping products.","type":"boolean"},"ratingRange":{"description":"Rating range is restricted to integers between 0 and 5, inclusive. Min must be less than or equal to max. We use this to retrieve the number of targetable ASINs that falls within this rating range.","type":"object","properties":{"min":{"maximum":5,"type":"integer","minimum":0},"max":{"maximum":5,"type":"integer","minimum":0}}},"category":{"description":"The category refinement id. Please use /sb/targets/categories or /sb/recommendations/targets/category to retrieve category IDs.","type":"string"},"priceRange":{"description":"A range of prices. We use this to retrieve the number of targetable ASINs that falls within this price range.","type":"object","properties":{"min":{"format":"double","type":"number"},"max":{"format":"double","type":"number"}}}},"required":["category"]}}},"required":true},"description":"Get number of targetable asins based on refinements provided by the user.\n\nUse `/sb/targets/categories` or `/sb/recommendations/targets/category` to retrieve the category ID. Use `/sb/targets/categories/{categoryRefinementId}/refinements` to retrieve refinements data for a category.\n\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SBTargetingGetTargetableASINCounts","responses":{"200":{"description":"SBTargetingGetTargetableASINCounts 200 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Response object for /sb/targets/products/count to get number of targetable asins for refinements provided by the user","type":"object","properties":{"asinCounts":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}}}}}}},"400":{"description":"SBTargetingBadRequestException 400 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a BadRequestException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"401":{"description":"SBTargetingUnauthorizedException 401 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an UnauthorizedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"422":{"description":"SBTargetingUnprocessableEntityException 422 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an UnprocessableEntityException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBTargetingThrottlingException 429 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a ThrottlingException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"500":{"description":"SBTargetingInternalServerException 500 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an InternalServerException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Product targeting categories"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Product%20targeting%20categories/operation/SBTargetingGetTargetableASINCounts","sectionHeader":{"type":3,"text":"POST /sb/targets/products/count"},"summary":"Get number of products in a category","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/targets/categories/{categoryRefinementId}/refinements",{"summary":"Get refinements for category","description":"Returns refinements according to category input. \n\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SBTargetingGetRefinementsForCategory","responses":{"200":{"description":"SBTargetingGetRefinementsForCategory 200 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Response object for /sb/targets/categories/{categoryRefinementId}/refinements containing information on Brand Nodes, Age Range Nodes, and Genre Nodes.\n    Response is paginated with pagination occurring for all three arrays at once.\n    Example: If there are 800 brands, 5 age ranges, and 600 genres, the first response will return 500 brands, 5 age ranges, and 500 genres. The next paginated response will return 300 brands, 0 age ranges, and 100 genres.","type":"object","properties":{"ageRanges":{"maxItems":500,"description":"List of Age Ranges. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Age Ranges. Age Ranges are only available for categories related to children's toys and games.","type":"array","items":{"type":"object","properties":{"ageRangeRefinementId":{"description":"Id of Age Range. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Age Range Refinement IDs.","type":"string"},"name":{"description":"Name of Age Range.","type":"string"},"translatedName":{"description":"Translated name of Age Range based off locale sent in request.","type":"string"}},"required":["ageRangeRefinementId"]}},"brands":{"maxItems":500,"description":"List of Brands.","type":"array","items":{"type":"object","properties":{"brandRefinementId":{"description":"Id of brand. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Brand Refinement IDs.","type":"string"},"name":{"description":"Name of brand.","type":"string"}},"required":["brandRefinementId"]}},"genres":{"maxItems":500,"description":"List of Genres. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Genre Node IDs. Genres are only available for categories related to books.","type":"array","items":{"type":"object","properties":{"genreRefinementId":{"description":"Id of Genre. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Genre Refinement IDs.","type":"string"},"name":{"description":"Name of Genre.","type":"string"},"translatedName":{"description":"Translated name of Genre based off locale sent in request.","type":"string"}},"required":["genreRefinementId"]}},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"SBTargetingBadRequestException 400 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a BadRequestException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"401":{"description":"SBTargetingUnauthorizedException 401 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an UnauthorizedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBTargetingThrottlingException 429 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a ThrottlingException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"500":{"description":"SBTargetingInternalServerException 500 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an InternalServerException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}}},"parameters":[{"schema":{"description":"The category refinement id. Please use /sb/targets/categories or /sb/recommendations/targets/category to retrieve category IDs.","type":"string"},"in":"path","name":"categoryRefinementId","description":"The category refinement id. Please use /sb/targets/categories or /sb/recommendations/targets/category to retrieve category IDs.","required":true},{"schema":{"description":"The locale to which the caller wishes to translate the targetable categories or refinements to. For example, if the caller wishes to receive the targetable categories in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the returned tagetable categories will be in the default language of the marketplace.","type":"string","enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"]},"in":"query","name":"locale","description":"The locale to which the caller wishes to translate the targetable categories or refinements to. For example, if the caller wishes to receive the targetable categories in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the returned tagetable categories will be in the default language of the marketplace."},{"schema":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"in":"query","name":"nextToken","description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results."},{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Product targeting categories"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Product%20targeting%20categories/operation/SBTargetingGetRefinementsForCategory","sectionHeader":{"type":3,"text":"GET /sb/targets/categories/{categoryRefinementId}/refinements"},"summary":"Get refinements for category","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/insights",{"summary":"Get insights for campaigns","requestBody":{"content":{"application/vnd.sbinsights.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"minItems":0,"maxItems":100,"type":"array","items":{"description":"The ad group settings.","type":"object","properties":{"keywords":{"minItems":0,"maxItems":800,"type":"array","items":{"description":"Keyword associated with the campaign.","type":"object","properties":{"matchType":{"description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Advertising support center.","type":"string","enum":["EXACT","PHRASE","BROAD"]},"bid":{"format":"double","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features).","type":"number"},"keywordText":{"description":"The keyword text. Maximum of 10 words.","type":"string"}},"required":["bid","keywordText","matchType"]}},"adFormat":{"description":"Type of Ad format.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]}},"required":["adFormat"]}}},"required":["adGroups"]}}},"required":true},"description":"Creates campaign level insights. Insights will be provided for passed in campaign parameters.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SBInsightsCampaignInsights","responses":{"200":{"description":"SBInsightsCampaignInsights 200 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Response object for /sb/campaigns/insights containing a list of insights for the campaign.","type":"object","properties":{"insights":{"minItems":0,"maxItems":1000,"type":"array","items":{"oneOf":[{"type":"object","title":"keywordInsight","properties":{"keywordInsight":{"description":"Insights for keywords selected for targeting.","type":"object","properties":{"alerts":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Keyword alert insights associated with the selected keyword targets and bids.\nLOW_KEYWORD_TRAFFIC is provided if the keyword has very low traffic and is available in all marketplaces.\nLOW_BID is provided if the selected bid is low compared to the historical bids for this keyword\nand is only available in the following marketplaces: US, CA, MX, BR, UK, DE, FR, ES, IT, IN, AE, NL, SE, JP, AU, SG.","type":"string","enum":["LOW_KEYWORD_TRAFFIC","LOW_BID"]}},"searchTermImpressionShare":{"format":"double","description":"The account-level ad-attributed impression share for the search-term / keyword.\nProvides percentage share of all ad impressions the advertiser has for the keyword in the last 7 days.\nThis metric helps advertisers identify potential opportunities based on their share of relevant keywords.\nThis information is only available for keywords the advertiser targeted with ad impressions.\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP.","maximum":100,"type":"number","minimum":0},"matchType":{"description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Advertising support center.","type":"string","enum":["EXACT","PHRASE","BROAD"]},"adGroupIndex":{"description":"Correlates the ad group to the ad group array index specified in the request. Zero-based.","type":"integer"},"searchTermImpressionRank":{"description":"The account-level ad-attributed impression rank for the search-term / keyword.\nProvides the [1:N] place the advertiser ranks among all advertisers for the keyword by ad impressions in a marketplace in the last 7 days.\nIt tells an advertiser how many advertisers had higher share of ad impressions.\nThis information is only available for keywords the advertiser targeted with ad impressions.\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP.","type":"integer"},"bid":{"format":"double","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features).","type":"number"},"keywordIndex":{"description":"Correlates the keyword to the keyword array index specified in the request. Zero-based.","type":"integer"},"keywordText":{"description":"The keyword text. Maximum of 10 words.","type":"string"}}}},"required":["keywordInsight"]}]}},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"SBInsightsBadRequestException 400 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Returns information about a BadRequestException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"401":{"description":"SBInsightsUnauthorizedException 401 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Returns information about an UnauthorizedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"422":{"description":"SBInsightsUnprocessableEntityException 422 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Returns information about an UnprocessableEntityException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBInsightsThrottlingException 429 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Returns information about a ThrottlingException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"500":{"description":"SBInsightsInternalServerException 500 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Returns information about an InternalServerException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}}},"parameters":[{"schema":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"in":"query","name":"nextToken","description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Insights"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Insights/operation/SBInsightsCampaignInsights","sectionHeader":{"type":3,"text":"POST /sb/campaigns/insights"},"summary":"Get insights for campaigns","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/budgetRules",{"summary":"Create budget rules","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"budgetRulesDetails":{"maxItems":25,"description":"A list of budget rule details.","type":"array","items":{"type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss' ","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time. ","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["IS","NTB","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}}}}}}},"required":true},"operationId":"CreateBudgetRulesForSBCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The rule identifier.","type":"string"},"associatedCampaignIds":{"type":"array","items":{"description":"The campaign identifier for which rule based budget may get updated","type":"string"}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetRuleError - Something went wrong on the server. Retry later and report an BudgetRuleError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/CreateBudgetRulesForSBCampaigns","sectionHeader":{"type":3,"text":"POST /sb/budgetRules"},"summary":"Create budget rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/budgetRules",{"summary":"Update budget rules","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"budgetRulesDetails":{"maxItems":25,"description":"A list of budget rule details.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss' ","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time. ","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["IS","NTB","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}}}}}},"required":true},"operationId":"UpdateBudgetRulesForSBCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The rule identifier.","type":"string"},"associatedCampaignIds":{"type":"array","items":{"description":"The campaign identifier for which rule based budget may get updated","type":"string"}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetRuleError - Something went wrong on the server. Retry later and report an BudgetRuleError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/UpdateBudgetRulesForSBCampaigns","sectionHeader":{"type":3,"text":"PUT /sb/budgetRules"},"summary":"Update budget rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/budgetRules",{"summary":"Get budget rules","operationId":"GetSBBudgetRulesForAdvertiser","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"budgetRulesForAdvertiserResponse":{"minItems":0,"maxItems":30,"description":"A list of rules created by the advertiser.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss' ","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time. ","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["IS","NTB","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"query","name":"nextToken","description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results."},{"schema":{"type":"number"},"in":"query","name":"pageSize","description":"Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/GetSBBudgetRulesForAdvertiser","sectionHeader":{"type":3,"text":"GET /sb/budgetRules"},"summary":"Get budget rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/budgetRules/{budgetRuleId}",{"summary":"Get budget rule by ID","operationId":"GetBudgetRuleByRuleIdForSBCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"budgetRule":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss' ","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time. ","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["IS","NTB","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/GetBudgetRuleByRuleIdForSBCampaigns","sectionHeader":{"type":3,"text":"GET /sb/budgetRules/{budgetRuleId}"},"summary":"Get budget rule by ID","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/{campaignId}/budgetRules",{"summary":"Associate budget rules to campaign","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"budgetRuleIds":{"maxItems":25,"description":"A list of budget rule identifiers.","type":"array","items":{"type":"string"}}}}}},"required":true},"description":"A maximum of 250 rules can be associated to a campaign. Note that the name of each rule associated to a campaign is required to be unique.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateAssociatedBudgetRulesForSBCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of associated budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The budget rule identifier.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/CreateAssociatedBudgetRulesForSBCampaigns","sectionHeader":{"type":3,"text":"POST /sb/campaigns/{campaignId}/budgetRules"},"summary":"Associate budget rules to campaign","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/{campaignId}/budgetRules",{"summary":"Get budget rules associated to campaign","operationId":"ListAssociatedBudgetRulesForSBCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"associatedRules":{"description":"A list of associated budget rules.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss' ","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time. ","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["IS","NTB","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule evaluation status. Read-only.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/ListAssociatedBudgetRulesForSBCampaigns","sectionHeader":{"type":3,"text":"GET /sb/campaigns/{campaignId}/budgetRules"},"summary":"Get budget rules associated to campaign","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/budgetRules/{budgetRuleId}/campaigns",{"summary":"Get campaigns associated with budget rule","operationId":"GetCampaignsAssociatedWithSBBudgetRule","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"associatedCampaigns":{"minItems":0,"maxItems":30,"description":"A list of campaigns that are associated to this budget rule.","type":"array","items":{"type":"object","required":["campaignId","campaignName","ruleStatus"],"properties":{"campaignId":{"description":"The campaign identifier.","type":"string"},"ruleStatus":{"description":"The budget rule evaluation status for this campaign. Read-only.","type":"string"},"campaignName":{"description":"The campaign name.","type":"string"}}}},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true},{"schema":{"type":"string"},"in":"query","name":"nextToken","description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results."},{"schema":{"type":"number"},"in":"query","name":"pageSize","description":"Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/GetCampaignsAssociatedWithSBBudgetRule","sectionHeader":{"type":3,"text":"GET /sb/budgetRules/{budgetRuleId}/campaigns"},"summary":"Get campaigns associated with budget rule","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/{campaignId}/budgetRules/{budgetRuleId}",{"summary":"Disassociate budget rule from campaign","operationId":"DisassociateAssociatedBudgetRuleForSBCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/DisassociateAssociatedBudgetRuleForSBCampaigns","sectionHeader":{"type":3,"text":"DELETE /sb/campaigns/{campaignId}/budgetRules/{budgetRuleId}"},"summary":"Disassociate budget rule from campaign","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/budget/usage",{"summary":"Get budget usage","description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","tags":["Budget usage"],"requestBody":{"content":{"application/vnd.sbcampaignbudgetusage.v1+json":{"schema":{"type":"object","properties":{"campaignIds":{"minItems":1,"maxItems":100,"description":"A list of campaign IDs","type":"array","items":{"type":"string"}}}}}},"required":true},"operationId":"sbCampaignsBudgetUsage","responses":{"207":{"description":"Multi-status. An object containing a list of budget usage response objects reflecting the same order as the input.","content":{"application/vnd.sbcampaignbudgetusage.v1+json":{"schema":{"type":"object","properties":{"success":{"description":"List of budget usage percentages that were successfully pulled","type":"array","items":{"type":"object","properties":{"budgetUsagePercent":{"description":"Budget usage percentage (spend / available budget) for the given budget policy.","type":"number"},"campaignId":{"description":"ID of requested resource","type":"string"},"usageUpdatedTimestamp":{"format":"date-time","description":"Last evaluation time for budget usage","type":"string"},"index":{"description":"An index to maintain order of the campaignIds","type":"number"},"budget":{"description":"Budget amount of resource requested","type":"number"}}}},"error":{"description":"List of budget usage percentages that failed to pull","type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"campaignId":{"description":"ID of requested resource","type":"string"},"index":{"description":"An index to maintain order of the campaignIds","type":"number"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetUsageError - Something went wrong on the server. Retry later and report an BudgetUsageError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20usage/operation/sbCampaignsBudgetUsage","sectionHeader":{"type":3,"text":"POST /sb/campaigns/budget/usage"},"summary":"Get budget usage","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/forecasts",{"summary":"Get performance forecasts for campaigns","requestBody":{"content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","description":"The campaign settings.","properties":{"budget":{"type":"number","description":"The amount of the budget.","format":"double"},"budgetType":{"type":"string","description":"Budget can be set to DAILY or LIFETIME. \n\n|BudgetType|Description|\n|-----------|-----------|\n|DAILY| The amount that you're willing to spend on this campaign each day. If the campaign spends less than your daily budget, the unspent amount can be used to increase your daily budget on the other days of the calendar month.|\n|LIFETIME| The total amount that you are willing to spend on this campaign.| \n\n"},"forecastType":{"type":"string","description":"The forecast type. can be set to WEEKLY or MONTHLY. \n\n**If have not set the forecastType during campaign creation then use WEEKLY as goal value.**\n"},"startDate":{"type":"string","description":"The YYYY-MM-DD start date for the campaign. If this field is not set to a value, the current date is used.","format":"date-time"},"endDate":{"type":"string","description":"The YYYY-MM-DD end date for the campaign. Must be greater than the value for `startDate`. If not specified, the campaign has no end date and runs continuously.","format":"date-time"},"goal":{"type":"string","description":"Goal will allow you to set goal type to help drive your campaign performance. \n\n**If have not set the goal during campaign creation then use PAGE_VISIT as goal type.** \n\n\nThe goal type of the campaign. Initial launch only supports PAGE_VISIT. \n\nBRAND_IMPRESSION_SHARE - This goal is a PREVIEW ONLY and cannot be set currently. It will allow you grown your brand impression share on top of search placement. \n\nPAGE_VISIT - This goal drives traffic to your landing and detail pages through all placements. \n\nACQUIRE_NEW_CUSTOMERS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal drives new customer acquisition for your brands. \n\nAD_VIEWS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal maximizes view for your ads. \n\n"},"adGroups":{"type":"array","items":{"type":"object","description":"The ad group settings.","properties":{"targets":{"type":"array","items":{"type":"object","description":"The target associated with the ad group.","properties":{"expressions":{"type":"array","items":{"type":"object","description":"Expression settings for the target.","properties":{"type":{"type":"string","description":"The expression type associated with the target. Valid value: ASIN_CATEGORY_SAME_AS, ASIN_BRAND_SAME_AS, ASIN_PRICE_LESS_THAN, ASIN_PRICE_BETWEEN, ASIN_PRICE_GREATER_THAN, ASIN_REVIEW_RATING_LESS_THAN, ASIN_REVIEW_RATING_BETWEEN, ASIN_REVIEW_RATING_GREATER_THAN, ASIN_SAME_AS."},"value":{"type":"string","description":"The expression value associated with targets."}}},"maxItems":100,"minItems":0},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account.","format":"float"}}},"maxItems":100,"minItems":0},"negativeTargets":{"type":"array","items":{"type":"object","description":"The negative target associated with the ad group.","properties":{"expressions":{"type":"array","items":{"type":"object","description":"Negative expression settings for the target.","properties":{"type":{"type":"string","description":"The negative expression type associated with the target. Valid value: ASIN_BRAND_SAME_AS, ASIN_SAME_AS."},"value":{"type":"string","description":"The expression value associated with targets."}}},"maxItems":100,"minItems":0}}},"maxItems":100,"minItems":0},"landingPages":{"type":"array","items":{"type":"object","properties":{"landingPageUrl":{"type":"string","description":"Landing page information."}}},"maxItems":100,"minItems":0},"themes":{"type":"array","items":{"type":"object","description":"The theme.","properties":{"themeType":{"type":"string","description":"The theme target type. Valid value: KEYWORDS_RELATED_TO_YOUR_BRAND, KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES. \n\nKEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands. \n\nKEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages."},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account.","format":"float"}}},"maxItems":100,"minItems":0},"keywords":{"type":"array","items":{"type":"object","description":"Keyword associated with the campaign.","properties":{"keywordText":{"type":"string","description":"The keyword text. Maximum of 10 words."},"matchType":{"type":"string","description":"The match type. Valid value: EXACT, PHRASE, BROAD. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Advertising support center."},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account.","format":"float"}}},"maxItems":100,"minItems":0},"negativeKeywords":{"type":"array","items":{"type":"object","description":"Negative keyword associated with the campaign.","properties":{"keywordText":{"type":"string","description":"The keyword text. Maximum of 10 words."},"matchType":{"type":"string","description":"The negative match type. Valid value: NEGATIVE_EXACT, NEGATIVE_PHRASE. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Advertising support center."}}},"maxItems":100,"minItems":0},"creativeAsins":{"type":"array","items":{"description":"Optional. An array of creative ASINs that are displayed in the SB creative.","type":"string","maxItems":1000,"minItems":0}}}},"maxItems":1,"minItems":1}},"required":["adGroups","budget","budgetType","forecastType"]},"maxItems":1,"minItems":1}},"required":["campaigns"]}}},"required":true},"description":"Returns forecasts for a list of new campaigns specified in SB forecast request. Currently only one new campaign is supported. \n\n**If the campaign is not set to any goal during campaign creation then use PAGE_VISIT as goal value.**","operationId":"SBCampaignPerformanceForecasts","responses":{"207":{"description":"SBCampaignPerformanceForecasts 207 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Response object for /sb/forecasts containing a list of performance forecast for the campaign.","properties":{"campaigns":{"type":"object","properties":{"successes":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"Correlates the campaign to the campaign list index specified in the request. Zero-based."},"campaign":{"type":"object","properties":{"forecasts":{"type":"array","items":{"type":"object","description":"The forecast metric.","properties":{"metric":{"type":"string","description":"The forecast metric name. Currently supported metrics are IMPRESSION and CLICK."},"value":{"type":"object","description":"The forecast min and max value.","properties":{"min":{"type":"number","maximum":10000,"minimum":0,"description":"The forecast min value.","format":"float"},"max":{"type":"number","maximum":10000,"minimum":0,"description":"The forecast max value.","format":"float"}}}}},"maxItems":2,"minItems":1},"forecastTimestamp":{"type":"string","description":"The forecast timestamp."}}}}},"maxItems":1,"minItems":0},"errors":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"Correlates the campaign to the campaign list index specified in the request. Zero-based."},"code":{"type":"string","description":"The forecast error code."},"description":{"type":"string","description":"The forecast error description."}}},"maxItems":1,"minItems":0}}}}}}}},"400":{"description":"SBForecastingBadRequestException 400 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about a BadRequestException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}},"401":{"description":"SBForecastingUnauthorizedException 401 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about an UnauthorizedException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}},"403":{"description":"SBForecastingAccessDeniedException 403 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about an AccessDeniedException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}},"422":{"description":"SBForecastingUnprocessableEntityException 422 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about an UnprocessableEntityException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBForecastingThrottlingException 429 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about a ThrottlingException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}},"500":{"description":"SBForecastingInternalServerException 500 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about a InternalServerException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}}},"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","schema":{"type":"string","description":"The identifier of a client associated with a \"Login with Amazon\" account."},"required":true},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input.","schema":{"type":"string","description":"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 and choose profile id `profileId` from the response to pass it as input."},"required":true}],"tags":["Forecasts"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Forecasts/operation/SBCampaignPerformanceForecasts","sectionHeader":{"type":3,"text":"POST /sb/forecasts"},"summary":"Get performance forecasts for campaigns","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/rules/optimization",{"summary":"Create optimization rules","requestBody":{"content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRules":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"entityType":{"description":"Enum: \"CAMPAIGN\"\n\nThe type of entity passed.","type":"string"},"entityId":{"description":"Entity object identifier.","type":"string"},"conditions":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"criteria":{"type":"object","properties":{"comparisonOperator":{"description":"Enum: \"LESS_THAN_OR_EQUAL_TO\"\n\nThe comparison operator.","type":"string"},"value":{"description":"The value of the threshold associated with the attribute.","format":"double","type":"number"}}},"attributeName":{"description":"Enum: \"COST_PER_CLICK\"\n\nThe name of the attribute.\n\n Supported rule metrics and corresponding supported comparisonOperators:\n| AttributeName                      |  ComparisonOperator       |  Description                                                                            |\n|------------------------------------|---------------------------|-----------------------------------------------------------------------------------------|\n| COST_PER_CLICK                     | LESS_THAN_OR_EQUAL_TO     | Maximize page visits while cost per click less than or equal to threshold.              |","type":"string"}},"required":["attributeName","criteria"]}}}}}},"required":["optimizationRules"]}}},"required":true},"description":"Currently available in beta. \n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"CreateSponsoredBrandsOptimizationRules","responses":{"207":{"description":"CreateSponsoredBrandsOptimizationRules 207 response.","content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRules":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"optimizationRule":{"type":"object","properties":{"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"},"conditions":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"criteria":{"type":"object","properties":{"comparisonOperator":{"description":"Enum: \"LESS_THAN_OR_EQUAL_TO\"\n\nThe comparison operator.","type":"string"},"value":{"description":"The value of the threshold associated with the attribute.","format":"double","type":"number"}}},"attributeName":{"description":"Enum: \"COST_PER_CLICK\"\n\nThe name of the attribute.\n\n Supported rule metrics and corresponding supported comparisonOperators:\n| AttributeName                      |  ComparisonOperator       |  Description                                                                            |\n|------------------------------------|---------------------------|-----------------------------------------------------------------------------------------|\n| COST_PER_CLICK                     | LESS_THAN_OR_EQUAL_TO     | Maximize page visits while cost per click less than or equal to threshold.              |","type":"string"}},"required":["attributeName","criteria"]}}}},"entityType":{"type":"string"},"index":{"description":"The index of the entityId in the array from the request body.","maximum":10,"type":"number","minimum":0},"entityId":{"description":"Entity object identifier.","type":"string"},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["entityId","entityType","index","optimizationRule","optimizationRuleId"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the optimization rule id/entity Id in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors","type":"array","items":{"type":"object","properties":{"code":{"description":"The type of the error.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"required":["index"]}}}}},"required":["optimizationRules"]}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Optimization rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Optimization%20rules/operation/CreateSponsoredBrandsOptimizationRules","sectionHeader":{"type":3,"text":"POST /sb/rules/optimization"},"summary":"Create optimization rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/rules/optimization",{"summary":"Update optimization rules","requestBody":{"content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRules":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"},"conditions":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"criteria":{"type":"object","properties":{"comparisonOperator":{"description":"Enum: \"LESS_THAN_OR_EQUAL_TO\"\n\nThe comparison operator.","type":"string"},"value":{"description":"The value of the threshold associated with the attribute.","format":"double","type":"number"}}},"attributeName":{"description":"Enum: \"COST_PER_CLICK\"\n\nThe name of the attribute.\n\n Supported rule metrics and corresponding supported comparisonOperators:\n| AttributeName                      |  ComparisonOperator       |  Description                                                                            |\n|------------------------------------|---------------------------|-----------------------------------------------------------------------------------------|\n| COST_PER_CLICK                     | LESS_THAN_OR_EQUAL_TO     | Maximize page visits while cost per click less than or equal to threshold.              |","type":"string"}},"required":["attributeName","criteria"]}}}}}},"required":["optimizationRules"]}}},"required":true},"description":"Currently available in beta. \n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"UpdateSponsoredBrandsOptimizationRules","responses":{"207":{"description":"UpdateSponsoredBrandsOptimizationRules 207 response.","content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRules":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"optimizationRule":{"type":"object","properties":{"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"},"conditions":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"criteria":{"type":"object","properties":{"comparisonOperator":{"description":"Enum: \"LESS_THAN_OR_EQUAL_TO\"\n\nThe comparison operator.","type":"string"},"value":{"description":"The value of the threshold associated with the attribute.","format":"double","type":"number"}}},"attributeName":{"description":"Enum: \"COST_PER_CLICK\"\n\nThe name of the attribute.\n\n Supported rule metrics and corresponding supported comparisonOperators:\n| AttributeName                      |  ComparisonOperator       |  Description                                                                            |\n|------------------------------------|---------------------------|-----------------------------------------------------------------------------------------|\n| COST_PER_CLICK                     | LESS_THAN_OR_EQUAL_TO     | Maximize page visits while cost per click less than or equal to threshold.              |","type":"string"}},"required":["attributeName","criteria"]}}}},"index":{"description":"The index of the entityId in the array from the request body.","maximum":10,"type":"number","minimum":0},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["index","optimizationRule","optimizationRuleId"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the optimization rule id/entity Id in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors","type":"array","items":{"type":"object","properties":{"code":{"description":"The type of the error.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"required":["index"]}}}}},"required":["optimizationRules"]}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Optimization rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Optimization%20rules/operation/UpdateSponsoredBrandsOptimizationRules","sectionHeader":{"type":3,"text":"PUT /sb/rules/optimization"},"summary":"Update optimization rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/rules/optimization/associate",{"summary":"Associate optimization rules","requestBody":{"content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRuleAssociations":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"entityType":{"description":"Enum: \"CAMPAIGN\"\n\nThe type of entity passed.","type":"string"},"entityId":{"description":"Entity object identifier.","type":"string"},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["entityId","entityType","optimizationRuleId"]}}},"required":["optimizationRuleAssociations"]}}},"required":true},"description":"Currently available in beta. Associate one or more optimization rules by providing combinations of entityId-ruleId that require association.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"AssociateSponsoredBrandsOptimizationRules","responses":{"207":{"description":"AssociateSponsoredBrandsOptimizationRules 207 response.","content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRuleAssociations":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string"},"index":{"description":"The index of the entityId/optimizationId in the array from the request body.","maximum":10,"type":"number","minimum":0},"entityId":{"description":"Entity object identifier.","type":"string"},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["entityId","entityType","index","optimizationRuleId"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the optimization rule id/entity Id in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors","type":"array","items":{"type":"object","properties":{"code":{"description":"The type of the error.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"required":["index"]}}}}},"required":["optimizationRuleAssociations"]}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Optimization rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Optimization%20rules/operation/AssociateSponsoredBrandsOptimizationRules","sectionHeader":{"type":3,"text":"POST /sb/rules/optimization/associate"},"summary":"Associate optimization rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/rules/optimization/list",{"summary":"List optimization rules","requestBody":{"content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"entityFilter":{"description":"Filter optimization rules by entityId and entityType","type":"object","properties":{"entityType":{"description":"Enum: \"CAMPAIGN\"\n\nThe type of entity passed.","type":"string"},"entityId":{"description":"Entity object identifier.","type":"string"}}},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","maximum":100,"type":"number","minimum":1},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"optimizationRuleIdFilter":{"description":"Filter optimization rules by the list of optimization rule ids.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}}}}}}},"operationId":"ListSponsoredBrandsOptimizationRules","description":"Currently available in beta. \n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","responses":{"200":{"description":"ListSponsoredBrandsOptimizationRules 200 response.","content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalCount":{"description":"The total number of entities.","type":"number"},"optimizationRules":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"},"conditions":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"criteria":{"type":"object","properties":{"comparisonOperator":{"description":"Enum: \"LESS_THAN_OR_EQUAL_TO\"\n\nThe comparison operator.","type":"string"},"value":{"description":"The value of the threshold associated with the attribute.","format":"double","type":"number"}}},"attributeName":{"description":"Enum: \"COST_PER_CLICK\"\n\nThe name of the attribute.\n\n Supported rule metrics and corresponding supported comparisonOperators:\n| AttributeName                      |  ComparisonOperator       |  Description                                                                            |\n|------------------------------------|---------------------------|-----------------------------------------------------------------------------------------|\n| COST_PER_CLICK                     | LESS_THAN_OR_EQUAL_TO     | Maximize page visits while cost per click less than or equal to threshold.              |","type":"string"}},"required":["attributeName","criteria"]}}}}}},"required":["optimizationRules"]}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Optimization rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Optimization%20rules/operation/ListSponsoredBrandsOptimizationRules","sectionHeader":{"type":3,"text":"POST /sb/rules/optimization/list"},"summary":"List optimization rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/rules/optimization/disassociate",{"summary":"Disassociate optimization rules","requestBody":{"content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRuleDisassociations":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"entityType":{"description":"Enum: \"CAMPAIGN\"\n\nThe type of entity passed.","type":"string"},"entityId":{"description":"Entity object identifier.","type":"string"},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["entityId","entityType","optimizationRuleId"]}}},"required":["optimizationRuleDisassociations"]}}},"required":true},"description":"Currently available in beta. Disassociate one or more optimization rules by providing combinations of entityId-ruleId that require disassociation\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"DisassociateSponsoredBrandsOptimizationRules","responses":{"207":{"description":"DisassociateSponsoredBrandsOptimizationRules 207 response.","content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRuleDisassociations":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string"},"index":{"description":"The index of the entityId/optimizationId in the array from the request body.","maximum":10,"type":"number","minimum":0},"entityId":{"description":"Entity object identifier.","type":"string"},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["entityId","entityType","index","optimizationRuleId"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the optimization rule id/entity Id in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors","type":"array","items":{"type":"object","properties":{"code":{"description":"The type of the error.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"required":["index"]}}}}},"required":["optimizationRuleDisassociations"]}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Optimization rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Optimization%20rules/operation/DisassociateSponsoredBrandsOptimizationRules","sectionHeader":{"type":3,"text":"POST /sb/rules/optimization/disassociate"},"summary":"Disassociate optimization rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/legacyCampaigns/migrationJob",{"summary":"Creates Migration Job for V3 campaigns.","requestBody":{"content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"campaignIds":{"type":"array","items":{"type":"string"},"maxItems":1000,"minItems":0,"description":"Provide list of campaign ids that needs to be migrated"},"isStagedMigration":{"type":"boolean","description":"Set this flag to true if you want generate new campaign ID based on V3 campaign ID. These campaigns will not be visible through V4 campaign list call. If set to true not all campaign entities such as ad group, targeting, ad, or creatives are created. Use this flag for staging purpose only.\nBy default it will always be false"},"newCampaignState":{"type":"string","description":"This is optional parameter. By default, the new migrated campaigns will have the original status of V3 campaigns. If this parameter is set, then all newly migrated campaigns will have this state.\n Supported campaign states\n| State                                              |  Description |\n|----------------------------------------------------------|--------------|\n| ENABLED                               | Campaign entity has ENABLED state |"},"enableThemeTargeting":{"type":"boolean","description":"By default, theme targeting is set true if no value is provide. To disable theme targeting, set this flag to false."},"brandEntityId":{"type":"string","description":"Please note that brandEntityId is only required for sellers. You can get the brandEntityId by calling the <a href = https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#tag/Brands/operation/getBrands>GET /brands</a> endpoint."}},"required":["campaignIds","enableThemeTargeting"]}}},"required":true},"description":"Creates Migration Job for V3 campaigns.","operationId":"StartMigrationJob","responses":{"200":{"description":"StartMigrationJob 200 response","content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","description":"This jobId can be used to track migration status through /sb/v4/legacyCampaigns/migrationJob/status\nand results of each campaign through /sb/v4/legacyCampaigns/migrationJob/results API"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"type":"number","description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string","description":"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 and choose profile id `profileId` from the response to pass it as input."},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["V3 Campaign Migration"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/V3%20Campaign%20Migration/operation/StartMigrationJob","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/migrationJob"},"summary":"Creates Migration Job for V3 campaigns.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/legacyCampaigns/migrationJob/results",{"summary":"List Migration Results of all Campaign.","requestBody":{"content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"jobId":{"type":"string"},"nextToken":{"type":"string","description":"Token value allowing to navigate to the next response page."}},"required":["jobId"]}}},"required":true},"description":"List Migration Results of all Campaign.","operationId":"MigrationJobResults","responses":{"200":{"description":"MigrationJobResults 200 response","content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"jobId":{"type":"string"},"migrationJobStatus":{"type":"string","description":"Enumerated status code for migration job status\n| Status                                             |  Description |\n|----------------------------------------------------------|--------------|\n| COMPLETE  | Migration job is complete |\n| FAILED    | Migration failed and no V3 campaigns were migrated |\n| IN_PROGRESS    | Migration job is running |"},"campaigns":{"type":"array","items":{"type":"object","properties":{"legacyCampaignId":{"type":"string","description":"Entity object identifier."},"newCampaignId":{"type":"string"},"migrationStatus":{"type":"string","description":"Enumerated status code for migration job status\n| Status                                             |  Description |\n|----------------------------------------------------------|--------------|\n| MIGRATION_COMPLETE  | Migration is complete and new V4 campaigns are ready to serve. The V3 campaigns are archived |\n| STAGING_COMPLETE    | Staging of V4 campaign IDs are complete |\n| MIGRATION_FAILED         | Migration of V3 campaign failed  |\n| MIGRATION_IN_PROGRESS   | Migration for V3 campaign is in-progress |"},"migrationStatusReason":{"type":"string","description":"Status reason for the given migration status"}}}},"nextToken":{"type":"string","description":"Token value allowing to navigate to the next response page."}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"type":"number","description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string","description":"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 and choose profile id `profileId` from the response to pass it as input."},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["V3 Campaign Migration"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/V3%20Campaign%20Migration/operation/MigrationJobResults","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/migrationJob/results"},"summary":"List Migration Results of all Campaign.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/legacyCampaigns/migrationJob/status",{"summary":"List Migration Job Status.","requestBody":{"content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]}}},"required":true},"description":"List Migration Job Status.","operationId":"MigrationJobStatus","responses":{"200":{"description":"MigrationJobStatus 200 response","content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"jobId":{"type":"string"},"migrationJobStatus":{"type":"string","description":"Enumerated status code for migration job status\n| Status                                             |  Description |\n|----------------------------------------------------------|--------------|\n| COMPLETE  | Migration job is complete |\n| FAILED    | Migration failed and no V3 campaigns were migrated |\n| IN_PROGRESS    | Migration job is running |"},"migrationJobStatusReason":{"type":"string","description":"Status reason for the migration job status"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"type":"number","description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string","description":"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 and choose profile id `profileId` from the response to pass it as input."},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["V3 Campaign Migration"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/V3%20Campaign%20Migration/operation/MigrationJobStatus","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/migrationJob/status"},"summary":"List Migration Job Status.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/legacyCampaigns/overallMigrationResults",{"summary":"Lists all Campaign Migration results for an advertiser.","requestBody":{"content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"nextToken":{"type":"string","description":"Token value allowing to navigate to the next response page."}}}}}},"description":"Lists all Campaign Migration results for an advertiser","operationId":"MigrationResults","responses":{"200":{"description":"MigrationResults 200 response","content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","properties":{"legacyCampaignId":{"type":"string","description":"Entity object identifier."},"newCampaignId":{"type":"string"},"migrationStatus":{"type":"string","description":"Enumerated status code for migration job status\n| Status                                             |  Description |\n|----------------------------------------------------------|--------------|\n| MIGRATION_COMPLETE  | Migration is complete and new V4 campaigns are ready to serve. The V3 campaigns are archived |\n| STAGING_COMPLETE    | Staging of V4 campaign IDs are complete |\n| MIGRATION_FAILED         | Migration of V3 campaign failed  |\n| MIGRATION_IN_PROGRESS   | Migration for V3 campaign is in-progress |"},"migrationStatusReason":{"type":"string","description":"Status reason for the given migration status"}}}},"nextToken":{"type":"string","description":"Token value allowing to navigate to the next response page."}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"type":"number","description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string","description":"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 and choose profile id `profileId` from the response to pass it as input."},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["V3 Campaign Migration"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/V3%20Campaign%20Migration/operation/MigrationResults","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/overallMigrationResults"},"summary":"Lists all Campaign Migration results for an advertiser.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/migrations/list",{"description":"Lists eligible Product Collection ads with recommended SB Collection replacement options.\n\nSponsored Brands collections replace the legacy Product Collection format with improved functionality and performance in the same high-visibility placements. Collections feature up to 10 products per ad (compared to 3 with Product Collection).\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListMigrations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.sbAdMigration.v4+json":{"schema":{"properties":{"adGroupIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"adIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"adStateFilter":{"description":"Filter entities by state.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]}}}},"campaignIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"maxResults":{"description":"Default: 20, Max: 100.","maximum":100,"minimum":1,"type":"number"},"migrationStatusFilter":{"description":"Filter migrations by option-level status. Returns migrations with at least one option matching the filter.","properties":{"include":{"items":{"description":"The lifecycle status of a migration option.","enum":["ACCEPTED","ELIGIBLE","MIGRATED","MIGRATION_FAILED"],"type":"string"},"maxItems":4,"minItems":0,"type":"array"}},"type":"object"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.sbAdMigration.v4+json":{"schema":{"properties":{"migrations":{"items":{"description":"A migration represents one source PC ad with its recommended replacement options.","properties":{"migrationEntity":{"description":"The source ad being migrated, enriched with campaign and ad group display names.","properties":{"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier. Note: Ads created using version 3/non-multi ad group campaigns do not have an associated adId. [Learn more](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/campaigns/managing-multi-ad-group-campaigns#ads).","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad. Note: Ads created using version 3/non-multi ad group campaigns do not have an associated name. [Learn more](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/campaigns/managing-multi-ad-group-campaigns#ads).","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","state"]},"adGroupName":{"description":"Display name of the source ad group.","type":"string"},"campaignName":{"description":"Display name of the source campaign.","type":"string"}},"type":"object"},"migrationId":{"description":"Unique identifier for this migration. Currently equal to the source adId.","type":"string"},"migrationOptions":{"description":"The recommended replacement options (1-2 options: Manual Collection, Auto Collection).","items":{"description":"A replacement option offered to the advertiser for a source PC ad.","properties":{"adGroupId":{"description":"The adGroupId of the created ad. Populated only after status = MIGRATED.","type":"string"},"adId":{"description":"The adId of the created ad. Populated only after status = MIGRATED.","type":"string"},"asins":{"description":"For MANUAL_COLLECTION: 3-10 recommended ASINs.\nFor AUTO_COLLECTION: empty (system selects dynamically at serve time).","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"errorCode":{"description":"Error code. Populated only when status = MIGRATION_FAILED.","type":"string"},"errorMessage":{"description":"Error message. Populated only when status = MIGRATION_FAILED.","type":"string"},"migrationType":{"description":"The type of migration being offered for this option.\n- MIGRATE: Preserves the advertiser's original configuration as closely as possible.\n- IMPROVE: Optimizes the configuration for better performance.","enum":["IMPROVE","MIGRATE"],"type":"string"},"optionType":{"description":"The type of SB Collection to migrate to.","enum":["AUTO_COLLECTION","MANUAL_COLLECTION"],"type":"string"},"rationale":{"description":"Rationale explaining why this migration option is being offered.","type":"string"},"status":{"description":"The lifecycle status of a migration option.","enum":["ACCEPTED","ELIGIBLE","MIGRATED","MIGRATION_FAILED"],"type":"string"}},"required":["optionType"],"type":"object"},"maxItems":2,"minItems":1,"type":"array"}},"required":["migrationEntity","migrationId","migrationOptions"],"type":"object"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalCount":{"description":"The total number of migrations matching the request filters. Only returned on the first page.","type":"number"}},"type":"object"}}},"description":"ListMigrations 200 response."},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}},"description":"InvalidArgumentException 400 response."},"401":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"UnauthorizedException 401 response."},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"AccessDeniedException 403 response."},"415":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}},"description":"UnsupportedMediaTypeException 415 response."},"429":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"ThrottlingException 429 response.","headers":{"Retry-After":{"description":"Delay in seconds before the next retry attempt.","schema":{"type":"number"}}}},"500":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"InternalServerException 500 response."}},"tags":["Ad Migrations"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20Migrations/operation/ListMigrations","sectionHeader":{"type":3,"text":"POST /sb/v4/migrations/list"},"documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["This API enables programmatic access for campaign creation, management, and reporting for Sponsored Display campaigns. For more information on the functionality, see the Sponsored Display Support Center. For API onboarding information, see the account setup topic.\n\nThis specification is available for download from the Advertising API developer portal.\n"],"path":"/en-us/sponsored-display/3-0/openapi","sectionHeader":{"type":2,"text":"Amazon Ads API for Sponsored Display"},"documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns",{"tags":["Campaigns"],"summary":"Gets a list of campaigns.","description":"Gets an array of Campaign objects for a requested set of Sponsored Display campaigns. Note that the Campaign object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the campaign operations that return the CampaignResponseEx object.","operationId":"listCampaigns","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of campaigns. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32","default":0}},{"name":"count","in":"query","description":"Optional. Sets the number of Campaign objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten campaigns set `startIndex=0` and `count=10`. To return the next ten campaigns, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"name","in":"query","description":"Optional. The returned array includes only campaign with the specified name using an exact string match.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array includes only campaigns with identifiers matching those specified in the comma-delimited string.","schema":{"type":"string"}},{"name":"portfolioIdFilter","in":"query","description":"Optional. The returned array includes only campaigns associated with Portfolio identifiers matching those specified in the comma-delimited string.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double","example":"3.00"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future.","example":"20190101"},"endDate":{"type":"string","nullable":true,"description":"The YYYYMMDD end date of the campaign.","example":null},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |\n\nTo view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","enum":["cpc","vcpm"]},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","format":"int64","nullable":true,"description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","example":null}}},{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"deliveryProfile":{"type":"string","enum":["as_soon_as_possible"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/listCampaigns","sectionHeader":{"type":3,"text":"GET /sd/campaigns"},"summary":"Gets a list of campaigns.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns",{"tags":["Campaigns"],"summary":"Updates one or more campaigns.","operationId":"updateCampaigns","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of Campaign objects. For each object, specify a campaign identifier and mutable fields with their updated values. The mutable fields are `name`, `state`, `budget`, `startDate`, and `endDate`. Maximum length of the array is 100 objects.","content":{"application/json":{"schema":{"type":"array","items":{"required":["campaignId"],"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double","example":"3.00"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future.","example":"20190101"},"endDate":{"type":"string","nullable":true,"description":"The YYYYMMDD end date of the campaign.","example":null},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |\n\nTo view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","enum":["cpc","vcpm"]},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","format":"int64","nullable":true,"description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","example":null}}},{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/updateCampaigns","sectionHeader":{"type":3,"text":"PUT /sd/campaigns"},"summary":"Updates one or more campaigns.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns",{"tags":["Campaigns"],"summary":"Creates one or more campaigns.","operationId":"createCampaigns","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of Campaign objects. For each object, specify required fields and their values. Required fields are `name`, `tactic`, `state`, and `startDate`. Maximum length of the array is 100 objects. If you don't specify a `budget`, it will be set as the [default budget for your region](https://advertising.amazon.com/API/docs/en-us/concepts/limits#default-budgets). Campaign names must be unique across SD, SB, and SP.\n  If you are using Optimization rules, the following campaign budget must be at least:\n  - 5x the value of any COST_PER_ORDER threshold.\n  - 10x the value of any COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS threshold.\n  - 20x the value of any COST_PER_CLICK threshold.\n","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double","example":"3.00"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future.","example":"20190101"},"endDate":{"type":"string","nullable":true,"description":"The YYYYMMDD end date of the campaign.","example":null},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |\n\nTo view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","enum":["cpc","vcpm"]},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","format":"int64","nullable":true,"description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","example":null}}},{"type":"object","properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/createCampaigns","sectionHeader":{"type":3,"text":"POST /sd/campaigns"},"summary":"Creates one or more campaigns.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/{campaignId}",{"tags":["Campaigns"],"summary":"Gets a requested campaign.","description":"Returns a Campaign object for a requested campaign. Note that the Campaign object is designed for performance, with a small set of commonly used campaign fields to reduce size. If the extended set of fields is required, use the campaign operations that return the CampaignResponseEx object.","operationId":"getCampaign","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"campaignId","in":"path","description":"The identifier of the requested campaign.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double","example":"3.00"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future.","example":"20190101"},"endDate":{"type":"string","nullable":true,"description":"The YYYYMMDD end date of the campaign.","example":null},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |\n\nTo view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","enum":["cpc","vcpm"]},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","format":"int64","nullable":true,"description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","example":null}}},{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"deliveryProfile":{"type":"string","enum":["as_soon_as_possible"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/getCampaign","sectionHeader":{"type":3,"text":"GET /sd/campaigns/{campaignId}"},"summary":"Gets a requested campaign.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/{campaignId}",{"tags":["Campaigns"],"summary":"Sets the campaign status to archived.","description":"This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See [Developer Notes](https://advertising.amazon.com/API/docs/en-us/info/developer-notes#archiving) for more information.","operationId":"archiveCampaign","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"campaignId","in":"path","description":"The identifier of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/archiveCampaign","sectionHeader":{"type":3,"text":"DELETE /sd/campaigns/{campaignId}"},"summary":"Sets the campaign status to archived.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/extended",{"tags":["Campaigns"],"summary":"Gets a list of campaigns with extended fields.","description":"Gets an array of CampaignResponseEx objects for a set of requested campaigns.","operationId":"listCampaignsEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of campaigns. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of Campaign objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten campaigns set `startIndex=0` and `count=10`. To return the next ten campaigns, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"name","in":"query","description":"Optional. The returned array includes only campaign with the specified name using an exact string match.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array includes only campaigns with identifiers matching those specified in the comma-delimited string.","schema":{"type":"string"}},{"name":"portfolioIdFilter","in":"query","description":"Optional. The returned array includes only campaigns associated with Portfolio identifiers matching those specified in the comma-delimited string.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"number","description":"The identifier of the campaign."},"name":{"type":"string","description":"The name of the campaign."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future."},"endDate":{"type":"string","description":"The YYYYMMDD end date of the campaign."},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","format":"int64"},"servingStatus":{"type":"string","description":"The status of the campaign.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|-----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm|The performance of this campaign is measured by the viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","enum":["cpc","vcpm"]},"creationDate":{"type":"integer","description":"Epoch date the campaign was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the campaign.","format":"int64"},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/listCampaignsEx","sectionHeader":{"type":3,"text":"GET /sd/campaigns/extended"},"summary":"Gets a list of campaigns with extended fields.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/extended/{campaignId}",{"tags":["Campaigns"],"summary":"Gets extended information for a requested campaign.","description":"Returns a CampaignResponseEx object for a requested campaign. The CampaignResponseEx includes the extended set of available fields.","operationId":"getCampaignResponseEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"campaignId","in":"path","description":"The identifier of the requested campaign.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"number","description":"The identifier of the campaign."},"name":{"type":"string","description":"The name of the campaign."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future."},"endDate":{"type":"string","description":"The YYYYMMDD end date of the campaign."},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","format":"int64"},"servingStatus":{"type":"string","description":"The status of the campaign.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|-----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm|The performance of this campaign is measured by the viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","enum":["cpc","vcpm"]},"creationDate":{"type":"integer","description":"Epoch date the campaign was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the campaign.","format":"int64"},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/getCampaignResponseEx","sectionHeader":{"type":3,"text":"GET /sd/campaigns/extended/{campaignId}"},"summary":"Gets extended information for a requested campaign.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups",{"tags":["Ad Groups"],"summary":"Gets a list of ad groups.","description":"Gets an array of AdGroup objects for a requested set of Sponsored Display ad groups. Note that the AdGroup object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the ad group operations that return the AdGroupResponseEx object.","operationId":"listAdGroups","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of campaigns. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of AdGroup objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten ad groups set `startIndex=0` and `count=10`. To return the next ten ad groups, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only ad groups with state set to one of the values in the specified comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array is filtered to include only ad groups associated with the campaign identifiers in the specified comma-delimited list.","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional. The returned array is filtered to include only ad groups with an identifier specified in the comma-delimited list.","schema":{"type":"string"}},{"name":"name","in":"query","description":"Optional. The returned array includes only ad groups with the specified name.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"bidOptimization":{"type":"string","description":"Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks |cpc|[Default] Optimize for page visits.|\n|conversions |cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"state":{"type":"string","description":"The state of the ad group.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"creativeType":{"type":"string","nullable":true,"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/listAdGroups","sectionHeader":{"type":3,"text":"GET /sd/adGroups"},"summary":"Gets a list of ad groups.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups",{"tags":["Ad Groups"],"summary":"Updates on or more ad groups.","operationId":"updateAdGroups","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of AdGroup objects. For each object, specify an ad group identifier and mutable fields with their updated values. The mutable fields are 'name', 'defaultBid', and 'state'. Maximum length of the array is 100 objects.","content":{"application/json":{"schema":{"type":"array","items":{"required":["adGroupId"],"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"bidOptimization":{"type":"string","description":"Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks |cpc|[Default] Optimize for page visits.|\n|conversions |cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"state":{"type":"string","description":"The state of the ad group.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/updateAdGroups","sectionHeader":{"type":3,"text":"PUT /sd/adGroups"},"summary":"Updates on or more ad groups.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups",{"tags":["Ad Groups"],"summary":"Creates one or more ad groups.","operationId":"createAdGroups","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of AdGroup objects. For each object, specify required fields and their values. Required fields are `campaignId`, `name`, `state`, and `defaultBid`. Maximum length of the array is 100 objects. Note - when using landingPageType of OFF_AMAZON_LINK or STORES within productAds, only 1 adGroup is supported.","content":{"application/json":{"schema":{"type":"array","items":{"required":["campaignId","name","state"],"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"bidOptimization":{"type":"string","description":"Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks |cpc|[Default] Optimize for page visits.|\n|conversions |cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"state":{"type":"string","description":"The state of the ad group.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"creativeType":{"type":"string","nullable":true,"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/createAdGroups","sectionHeader":{"type":3,"text":"POST /sd/adGroups"},"summary":"Creates one or more ad groups.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/{adGroupId}",{"tags":["Ad Groups"],"summary":"Gets a requested ad group.","description":"Returns an AdGroup object for a requested campaign. Note that the AdGroup object is designed for performance, with a small set of commonly used ad group fields to reduce size. If the extended set of fields is required, use the campaign operations that return the AdGroupResponseEx object.","operationId":"getAdGroup","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the requested ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"bidOptimization":{"type":"string","description":"Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks |cpc|[Default] Optimize for page visits.|\n|conversions |cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"state":{"type":"string","description":"The state of the ad group.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"creativeType":{"type":"string","nullable":true,"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/getAdGroup","sectionHeader":{"type":3,"text":"GET /sd/adGroups/{adGroupId}"},"summary":"Gets a requested ad group.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/{adGroupId}",{"tags":["Ad Groups"],"summary":"Sets the ad group status to archived.","description":"This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See [Developer Notes](https://advertising.amazon.com/API/docs/en-us/info/developer-notes#archiving) for more information.","operationId":"archiveAdGroup","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the requested ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/archiveAdGroup","sectionHeader":{"type":3,"text":"DELETE /sd/adGroups/{adGroupId}"},"summary":"Sets the ad group status to archived.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/extended",{"tags":["Ad Groups"],"summary":"Gets a list of ad groups with extended fields.","description":"Gets an array of AdGroupResponseEx objects for a set of requested ad groups.","operationId":"listAdGroupsEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of ad groups. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of Campaign objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten campaigns set `startIndex=0` and `count=10`. To return the next ten campaigns, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only campaigns with state set to one of the values in the comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array is filtered to include only ad groups associated with the campaign identifiers in the comma-delimited list.","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional. The returned array is filtered to include only ad groups with an identifier specified in the comma-delimited list.","schema":{"type":"string"}},{"name":"name","in":"query","description":"Optional. The returned array includes only ad groups with the specified name.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Object containing an extended set of data fields for an Ad Group.","properties":{"adGroupId":{"type":"number","description":"The identifier of the ad group."},"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"number","description":"The identifier of the campaign that this ad group is associated with."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"state":{"type":"string","description":"The delivery state of the ad group.","enum":["enabled","paused","archived"]},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"creativeType":{"type":"string","nullable":false,"description":"\nThe type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided.|","example":"IMAGE","enum":["IMAGE","VIDEO"]},"servingStatus":{"type":"string","description":"The status of the ad group.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","ADGROUP_POLICING_PENDING_REVIEW","ADGROUP_POLICING_CREATIVE_REJECTED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"bidOptimization":{"type":"string","description":"Bid optimization type for the Adgroup. Default behavior is to optimize for clicks. Note, reach, clicks are only accepted with productAds that include landingPageURL OFF_AMAZON_LINK.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks [Default]|cpc|Optimize for page visits.|\n|conversions|cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"creationDate":{"type":"integer","description":"Epoch time the ad group was created.","format":"int64"},"lastUpdatedDate":{"description":"Epoch time any property in the ad group was last updated.","type":"integer","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/listAdGroupsEx","sectionHeader":{"type":3,"text":"GET /sd/adGroups/extended"},"summary":"Gets a list of ad groups with extended fields.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/extended/{adGroupId}",{"tags":["Ad Groups"],"summary":"Gets extended information for a requested ad group.","operationId":"getAdGroupResponseEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the requested ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","description":"Object containing an extended set of data fields for an Ad Group.","properties":{"adGroupId":{"type":"number","description":"The identifier of the ad group."},"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"number","description":"The identifier of the campaign that this ad group is associated with."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"state":{"type":"string","description":"The delivery state of the ad group.","enum":["enabled","paused","archived"]},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"creativeType":{"type":"string","nullable":false,"description":"\nThe type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided.|","example":"IMAGE","enum":["IMAGE","VIDEO"]},"servingStatus":{"type":"string","description":"The status of the ad group.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","ADGROUP_POLICING_PENDING_REVIEW","ADGROUP_POLICING_CREATIVE_REJECTED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"bidOptimization":{"type":"string","description":"Bid optimization type for the Adgroup. Default behavior is to optimize for clicks. Note, reach, clicks are only accepted with productAds that include landingPageURL OFF_AMAZON_LINK.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks [Default]|cpc|Optimize for page visits.|\n|conversions|cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"creationDate":{"type":"integer","description":"Epoch time the ad group was created.","format":"int64"},"lastUpdatedDate":{"description":"Epoch time any property in the ad group was last updated.","type":"integer","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/getAdGroupResponseEx","sectionHeader":{"type":3,"text":"GET /sd/adGroups/extended/{adGroupId}"},"summary":"Gets extended information for a requested ad group.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds",{"tags":["Product Ads"],"summary":"Gets a list of product ads.","description":"Gets an array of ProductAd objects for a requested set of Sponsored Display product ads. Note that the ProductAd object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use a product ad operation that returns the ProductAdResponseEx object.","operationId":"listProductAds","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of product ads. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of ProductAd objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten product ad set `startIndex=0` and `count=10`. To return the next ten product ads, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only products ads associated with campaigns that have state set to one of the values in the comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"adIdFilter","in":"query","description":"Optional. The returned array includes only product ads with identifiers matching those in the comma-delimited string.","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional. The returned array is filtered to include only products ads associated with ad groups identifiers in the comma-delimited list.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array is filtered to include only product ads associated with the campaign identifiers in the comma-delimited list.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the campaign associated with the product ad.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adId":{"type":"integer","format":"int64","description":"The identifier of the product ad."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The Amazon ASIN of the product advertised by the product ad. This parameter is included in the response for sellers and vendors."},"sku":{"type":"string","description":"The Amazon SKU of the product advertised by the product ad. This parameter is included in the response for sellers."}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/listProductAds","sectionHeader":{"type":3,"text":"GET /sd/productAds"},"summary":"Gets a list of product ads.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds",{"tags":["Product Ads"],"summary":"Updates one or more product ads.","operationId":"updateProductAds","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of ProductAd objects. For each object, specify a product ad identifier and the only mutable field, `state`. Maximum length of the array is 100 objects.","content":{"application/json":{"schema":{"type":"array","items":{"required":["adId"],"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the campaign associated with the product ad.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adId":{"type":"integer","format":"int64","description":"The identifier of the product ad."}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adId":{"type":"number","description":"The identifier of the ad."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/updateProductAds","sectionHeader":{"type":3,"text":"PUT /sd/productAds"},"summary":"Updates one or more product ads.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds",{"tags":["Product Ads"],"summary":"Creates one or more product ads.","operationId":"createProductAds","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of ProductAd objects. For each object, specify required fields and their values. Required fields are `adGroupId` and `state`. Within any campaign, you must pass consistent fields of either `asin` (for vendors), `sku` (for sellers), or `landingPageURL` (when linking to other pages), these cannot be mixed for any given campaign. Maximum length of the array is 100 objects.","content":{"application/json":{"schema":{"type":"array","items":{"required":["campaignId","adGroupId","state"],"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the campaign associated with the product ad.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The ASIN of the product advertised by the product ad. Defined for vendors only."},"sku":{"type":"string","description":"The SKU of the product advertised by the product ad. Defined for seller accounts only."}}}]}},"examples":{"Vendor example":{"value":[{"state":"enabled","adGroupId":0,"campaignId":0,"asin":"B081FGSWTJ"}]},"Seller example":{"value":[{"state":"enabled","adGroupId":0,"campaignId":0,"sku":"sku-1234567"}]},"Off Amazon example":{"value":[{"state":"enabled","adGroupId":0,"campaignId":0,"landingPageURL":"https://advertising.amazon.com","landingPageType":"OFF_AMAZON_LINK","adName":"AmazonAdvertising"}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adId":{"type":"number","description":"The identifier of the ad."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/createProductAds","sectionHeader":{"type":3,"text":"POST /sd/productAds"},"summary":"Creates one or more product ads.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds/{adId}",{"tags":["Product Ads"],"summary":"Gets a requested product ad.","description":"Note that the ProductAd object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use a product ad operations that returns the ProductAdResponseEx object.","operationId":"getProductAd","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adId","in":"path","description":"The identifier of the requested product ad.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the campaign associated with the product ad.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adId":{"type":"integer","format":"int64","description":"The identifier of the product ad."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The Amazon ASIN of the product advertised by the product ad. This parameter is included in the response for sellers and vendors."},"sku":{"type":"string","description":"The Amazon SKU of the product advertised by the product ad. This parameter is included in the response for sellers."}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/getProductAd","sectionHeader":{"type":3,"text":"GET /sd/productAds/{adId}"},"summary":"Gets a requested product ad.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds/{adId}",{"tags":["Product Ads"],"summary":"Sets the status of a sproduct ad to archived.","description":"This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See [Developer Notes](https://advertising.amazon.com/API/docs/en-us/info/developer-notes#archiving) for more information.","operationId":"archiveProductAd","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adId","in":"path","description":"The identifier of the produce ad.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adId":{"type":"number","description":"The identifier of the ad."}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/archiveProductAd","sectionHeader":{"type":3,"text":"DELETE /sd/productAds/{adId}"},"summary":"Sets the status of a sproduct ad to archived.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds/extended",{"tags":["Product Ads"],"summary":"Gets a list of product ads with extended fields.","description":"Gets an array of ProductAdResponseEx objects for a set of requested ad groups. The ProductAdResponseEx object includes the extended set of available fields.","operationId":"listProductAdsEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of product ads. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of ProduceAdEx objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten product ads set `startIndex=0` and `count=10`. To return the next ten campaigns, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"adIdFilter","in":"query","description":"Optional. The returned array includes only product ads with identifiers matching those in the comma-delimited string.","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional. The returned array is filtered to include only products ads associated with ad groups identifiers in the comma-delimited list.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array is filtered to include only product ads associated with the campaign identifiers in the comma-delimited list.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"adId":{"type":"number","description":"The identifier of the ad."},"adGroupId":{"type":"number","description":"The identifier of the ad group associated with the ad."},"campaignId":{"type":"number","description":"The identifier of the campaign associated with the ad."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The ASIN of the product being advertised. This parameter is included in the response for sellers and vendors."},"sku":{"type":"string","description":"The SKU of the product being advertised. This parameter is included in the response for sellers."},"state":{"type":"string","description":"The state of the product ad.","enum":["enabled","paused","archived"]},"servingStatus":{"type":"string","description":"The status of the product ad.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_STATUS_LIVE","AD_STATUS_PAUSED","AD_STATUS_ARCHIVED","MISSING_IMAGE","MISSING_DECORATION","NOT_BUYABLE","NOT_IN_BUYBOX","OUT_OF_STOCK","NOT_IN_POLICY","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the product ad was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the product ad.","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/listProductAdsEx","sectionHeader":{"type":3,"text":"GET /sd/productAds/extended"},"summary":"Gets a list of product ads with extended fields.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds/extended/{adId}",{"tags":["Product Ads"],"summary":"Gets extended information for a product ad.","operationId":"getProductAdResponseEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adId","in":"path","description":"The identifier of the requested product ad.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"adId":{"type":"number","description":"The identifier of the ad."},"adGroupId":{"type":"number","description":"The identifier of the ad group associated with the ad."},"campaignId":{"type":"number","description":"The identifier of the campaign associated with the ad."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The ASIN of the product being advertised. This parameter is included in the response for sellers and vendors."},"sku":{"type":"string","description":"The SKU of the product being advertised. This parameter is included in the response for sellers."},"state":{"type":"string","description":"The state of the product ad.","enum":["enabled","paused","archived"]},"servingStatus":{"type":"string","description":"The status of the product ad.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_STATUS_LIVE","AD_STATUS_PAUSED","AD_STATUS_ARCHIVED","MISSING_IMAGE","MISSING_DECORATION","NOT_BUYABLE","NOT_IN_BUYBOX","OUT_OF_STOCK","NOT_IN_POLICY","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the product ad was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the product ad.","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/getProductAdResponseEx","sectionHeader":{"type":3,"text":"GET /sd/productAds/extended/{adId}"},"summary":"Gets extended information for a product ad.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/deny",{"tags":["Brand Safety List"],"summary":"Gets a list of websites/apps that are on the advertiser's Brand Safety Deny List.","description":"Gets an array of websites/apps that are on the advertiser's Brand Safety Deny List. It can take up to 15 minutes\nfrom the time a domain is added/deleted to the time it is reflected in the deny list.","operationId":"listDomains","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","required":false,"description":"Optional. Sets a cursor into the requested set of domains. Use in conjunction with the count parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.\n","schema":{"type":"integer","minimum":0}},{"name":"count","in":"query","required":false,"description":"Optional. Sets the number of domain objects in the returned array. Use in conjunction with the startIndex parameter to control pagination. For example, to return the first 1000 domains set startIndex=0 and count=1000. To return the next 1000 domains, set startIndex=1000 and count=1000, and so on. Defaults to max page size(1000).\n","schema":{"type":"integer","minimum":0,"maximum":1000}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"description":"Response for Brand Safety Deny List GET requests","properties":{"pagination":{"type":"object","description":"Response pagination info for Brand Safety Deny List GET requests","properties":{"total":{"type":"integer","description":"The total number of deny list domains created by the advertiser"},"limit":{"type":"integer","description":"The maximum number of deny list domains returned from GET request"},"offset":{"type":"integer","description":"The number of deny list domains skipped"}}},"domains":{"type":"array","description":"List of Brand Safety Deny List Domains","items":{"type":"object","properties":{"domainId":{"type":"integer","description":"The identifier of the Brand Safety List domain.","format":"int64"},"name":{"type":"string","description":"The website or app identifier. This can be in the form of full domain (eg. 'example.com' or 'example.net'), or mobile app identifier (eg. 'com.example.app' for Android apps or '1234567890' for iOS apps)\n","maxLength":250},"type":{"type":"string","description":"The domain type.","enum":["WEBSITE","APP"]},"state":{"type":"string","description":"The state of the domain.","enum":["ENABLED","ARCHIVED"],"default":"ENABLED"},"createdAt":{"type":"string","format":"date-time","description":"The date time the domain was created at. Format YYYY-MM-ddT:HH:mm:ssZ","example":"2018-09-16T11:43:21Z"},"lastModified":{"type":"string","format":"date-time","description":"The date time the domain was last modified. Format YYYY-MM-ddT:HH:mm:ssZ","example":"2018-09-16T11:43:21Z"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/listDomains","sectionHeader":{"type":3,"text":"GET /sd/brandSafety/deny"},"summary":"Gets a list of websites/apps that are on the advertiser's Brand Safety Deny List.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/deny",{"tags":["Brand Safety List"],"summary":"Creates one or more domains to add to a Brand Safety Deny List.\n","description":"Creates one or more domains to add to a Brand Safety Deny List. The Brand Safety Deny List is at the advertiser level. It can take up to 15 minutes from the time a domain is added to the time it is reflected in the deny list.\n","operationId":"createBrandSafetyDenyListDomains","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of Brand Safety List Domain objects. For each object, specify required fields and their values. Maximum length of the array is 10,000 objects.\n","required":true,"content":{"application/json":{"schema":{"description":"POST Request for Brand Safety","required":["domains"],"properties":{"domains":{"type":"array","minItems":1,"maxItems":10000,"items":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The website or app identifier. This can be in the form of full domain (eg. 'example.com' or 'example.net'), or mobile app identifier (eg. 'com.example.app' for Android apps or '1234567890' for iOS apps)\n","maxLength":250},"type":{"type":"string","description":"The domain type.","enum":["WEBSITE","APP"]}},"example":{"name":"example.com","type":"WEBSITE"}}}}}}}},"responses":{"202":{"description":"Request has been accepted for processing.","content":{"application/json":{"schema":{"description":"Response for Brand Safety POST and DELETE requests","properties":{"requestId":{"type":"string","description":"The identifier of the request"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/createBrandSafetyDenyListDomains","sectionHeader":{"type":3,"text":"POST /sd/brandSafety/deny"},"summary":"Creates one or more domains to add to a Brand Safety Deny List.\n","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/deny",{"tags":["Brand Safety List"],"summary":"Archives all of the domains in the Brand Safety Deny List.\n","description":"Archives all of the domains in the Brand Safety Deny List. It can take several hours from the time a domain is deleted to the time it is reflected in the deny list. You can check the status of the delete request by calling GET /sd/brandSafety/{requestId}/status. If the status is \"COMPLETED\", you can call GET /sd/brandSafety/deny to validate that your deny list has been successfully deleted.\n","operationId":"deleteBrandSafetyDenyList","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Request has been accepted for processing.","content":{"application/json":{"schema":{"description":"Response for Brand Safety POST and DELETE requests","properties":{"requestId":{"type":"string","description":"The identifier of the request"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/deleteBrandSafetyDenyList","sectionHeader":{"type":3,"text":"DELETE /sd/brandSafety/deny"},"summary":"Archives all of the domains in the Brand Safety Deny List.\n","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/v2/reports/{reportId}",{"tags":["Reports"],"summary":"Gets the status of a report previously requested.","description":"Uses the `reportId` value from the response of a report previously requested via `POST` method of the `/sd/{recordType}/report` operation.\n\n**To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).**","operationId":"getReportStatus","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"reportId","in":"path","description":"The identifier of the requested report.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"type":"string","description":"The identifier of the report."},"recordType":{"type":"string","description":"The type of report requested.","enum":["CAMPAIGN","AD_GROUP","PRODUCT_AD"]},"status":{"type":"string","description":"The build status of the report.","enum":["IN_PROGRESS","SUCCESS","FAILURE"]},"statusDetails":{"description":"A human-readable description of the current status.","type":"string"},"location":{"type":"string","description":"The URI location of the report."},"fileSize":{"type":"integer","description":"The size of the report file, in bytes.","format":"int64"},"expiration":{"type":"integer","description":"Epoch date of the expiration of the URI in the `location` property.","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Reports/operation/getReportStatus","sectionHeader":{"type":3,"text":"GET /v2/reports/{reportId}"},"summary":"Gets the status of a report previously requested.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/v2/reports/{reportId}/download",{"tags":["Reports"],"summary":"Downloads a previously requested report identified by reportId.","description":"Gets a `307 Temporary Redirect` response that includes a `location` header with the value set to an AWS S3 path where the report is located. The path expires after 30 seconds. If the path expires before the report is downloaded, a new report request must be created.\n\n**To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).**","operationId":"downloadReport","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"reportId","in":"path","description":"The identifier of the requested report.","required":true,"schema":{"type":"string"}}],"responses":{"307":{"description":"Successful operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Redirect URI with S3 file location containing report data"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Reports/operation/downloadReport","sectionHeader":{"type":3,"text":"GET /v2/reports/{reportId}/download"},"summary":"Downloads a previously requested report identified by reportId.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/{recordType}/report",{"tags":["Reports"],"summary":"Creates a report request.","deprecated":true,"description":"**To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).**\n\nThe Sponsored Display API supports creation of reports for campaigns, ad groups, product ads, targets, and asins. Create a ReportRequest object specifying the fields corresponding to performance data metrics to include in the report.","operationId":"requestReport","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"recordType","in":"path","description":"The type of report to generate, either `campaigns`, `adGroups`, `productAds`, `targets`, or `asins`. The 'asins' report, also known as the Purchased products report, is only available for seller brand owners.","required":true,"schema":{"type":"string","enum":["campaigns","adGroups","productAds","targets","asins"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reportDate":{"type":"string","description":"Date in YYYYMMDD format. The report contains only metrics generated on the specified date. Note that the time zone used for date calculation is the one associated with the profile used to make the request.","example":"20190401"},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"segment":{"type":"string","description":"Optional. A dimension used to further segment certain types of reports.\n\nNote: matchedTarget reports only return targets that have generated at least one click.\n| Dimension | Report types | Tactics | Metrics | Description |\n|---------|------------------|-------------|-------------|------------|\n| matchedTarget | campaigns, adGroups, targets | T00020, T00030 | Existing metrics for each report type are accepted. |  Segments a report based on the ASIN of the product page where the ad appeared.|","example":"matchedTarget","enum":["matchedTarget"]},"metrics":{"type":"string","description":"A comma-separated list of the metrics to be included in the report.\n\nEach report type supports different metrics. **To understand supported metrics for each report type, see [Report types](/API/docs/en-us/guides/reporting/v2/report-types).**\n\n**Note**: Campaigns with vCPM costType should use view+click based metrics (viewAttributedConversions14d, viewAttributedDetailPageView14d, viewAttributedSales14d, viewAttributedUnitsOrdered14d, viewImpressions).\n\n**Note**: Detail page view metrics (attributedDetailPageView14d, viewAttributedDetailPageView14d) have an SLA of 3 days.\n\n**Tip**: Use new-to-brand (NTB) metrics to calculate how efficient your campaigns are at driving new shoppers:\n\n  1. Percentage of NTB orders = attributedOrdersNewToBrand14d / attributedConversions14d\n  2. Percentage NTB sales = attributedSalesNewToBrand14d / attributedSales14d\n  3. Percentage NTB units = attributedUnitsOrderedNewToBrand14d / attributedUnitsOrdered14d\n  4. NTB order rate = attributedOrdersNewToBrand14 / impressions","example":"campaignName,campaignId,impressions,clicks,cost,attributedSales14d"}}}}},"required":false},"responses":{"202":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"type":"string","description":"The identifier of the report."},"recordType":{"type":"string","description":"The type of report requested.","enum":["CAMPAIGN","AD_GROUP","PRODUCT_AD"]},"status":{"type":"string","description":"The build status of the report.","enum":["IN_PROGRESS","SUCCESS","FAILURE"]},"statusDetails":{"description":"A human-readable description of the current status.","type":"string"},"location":{"type":"string","description":"The URI location of the report."},"fileSize":{"type":"integer","description":"The size of the report file, in bytes.","format":"int64"},"expiration":{"type":"integer","description":"Epoch date of the expiration of the URI in the `location` property.","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"406":{"description":"Not acceptable - Failed due to report date being too far in the past.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable entity - Failed due to invalid parameters.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Reports/operation/requestReport","sectionHeader":{"type":3,"text":"POST /sd/{recordType}/report"},"summary":"Creates a report request.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets",{"tags":["Targeting"],"summary":"Gets a list of targeting clauses.","description":"Gets a list of targeting clauses objects for a requested set of Sponsored Display targets. Note that the Targeting Clause object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the target operations that return the TargetingClauseEx object.","operationId":"listTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. 0-indexed record offset for the result set. Defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Number of records to include in the paged response. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. Restricts results to those with `state` set to values in the specified comma-separated list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"targetIdFilter","in":"query","description":"Optional. Restricts results to ads with the specified `tagetId` specified in comma-separated list","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional list of comma separated adGroupIds. Restricts results to targeting clauses with the specified `adGroupId`.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. Restricts results to targeting clauses within campaigns specified in comma-separated list.","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the [\"Bid constraints by marketplace\" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.","format":"float","nullable":true,"minimum":0.02}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"expressionType":{"type":"string","enum":["manual","auto"],"description":"Tactic T00020 & T00030 ad groups should use 'manual' targeting."},"expression":{"type":"array","description":"The targeting expression to match against.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"resolvedExpression":{"type":"array","description":"The resolved targeting expression.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}]}},"example":{"targetId":123,"adGroupId":321,"campaignId":234,"state":"enabled","expressionType":"manual","bid":1.5,"expression":{"type":"asinSameAs","value":"B0123456789"},"resolvedExpression":{"type":"asinSameAs","value":"B0123456789"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/listTargetingClauses","sectionHeader":{"type":3,"text":"GET /sd/targets"},"summary":"Gets a list of targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets",{"tags":["Targeting"],"summary":"Updates one or more targeting clauses.","description":"Updates one or more targeting clauses. Targeting clauses are identified using their targetId. The mutable fields are `bid` and `state`. Maximum length of the array is 100 objects.","operationId":"updateTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of up to 1000 targeting clauses. Mutable fields:\n* `state`\n* `bid` (only mutable when the targeting clause's adGroup does not have any enabled optimization rule)","content":{"application/json":{"schema":{"type":"array","items":{"required":["targetId"],"allOf":[{"type":"object","properties":{"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the [\"Bid constraints by marketplace\" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.","format":"float","nullable":true,"minimum":0.02}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/updateTargetingClauses","sectionHeader":{"type":3,"text":"PUT /sd/targets"},"summary":"Updates one or more targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets",{"tags":["Targeting"],"summary":"Creates one or more targeting clauses.","description":"Successfully created targeting clauses are assigned a unique `targetId` value.\n\nCreate new targeting clauses for **both** Audience and Contextual campaigns with tactic 'T00030' using the above and the following:\n| Contextual targeting clause | Description |\n|------------------|-------------|\n| similarProduct | Dynamic segment to target products that are similar to the advertised asin. We recommend using 'similarProduct' targeting for all adGroups. |\n| asinSameAs=B0123456789 | Target this product. |\n| asinCategorySameAs=12345 | Target products in the category. |\n| asinCategorySameAs=12345 asinBrandSameAs=45678 | Target products in the category and brand. |\n\n**Refinements:**\n- asinBrandSameAs\n- asinPriceBetween\n- asinPriceGreaterThan\n- asinPriceLessThan\n- asinReviewRatingLessThan\n- asinReviewRatingGreaterThan\n- asinReviewRatingBetween\n- asinIsPrimeShippingEligible\n- asinAgeRangeSameAs\n- asinGenreSameAs\n\n**Refinement Notes:**\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* 'similarProduct' has no expression value or refinements.\n\n| Audience targeting clause | Description |\n|------------------|-------------|\n| views(exactProduct lookback=30) | Target an audience that has viewed the advertised asins in the past 7,14,30,60, or 90 days. Note: This target should only be used for productAds with SKU or ASIN. |\n| views(similarProduct lookback=60) | Target an audience that has viewed similar products to the advertised asins in the past 7,14,30,60, or 90 days. Note: This target should only be used for productAds with SKU or ASIN.|\n| views(asinCategorySameAs=12345 lookback=90) | Target an audience that has viewed products in the given category in the past 7,14,30,60, or 90 days. |\n| views(asinCategorySameAs=12345 asinBrandSameAs=45678 asinPriceBetween=50-100 lookback=60) | Target an audience that has viewed products in the given category, brand, and price range in the past 7,14,30,60, or 90 days. |\n| purchases(relatedProduct lookback=180) | Target an audience that has purchased a related product in the past 7,14,30,60,90,180 or 365 days. Note: This target should only be used for productAds with SKU or ASIN.|\n| purchases(exactProduct lookback=365) | Target an audience that has purchased the advertised asins in the past 7,14,30,60,90,180 or 365 days. Note: This target should only be used for productAds with SKU or ASIN.|\n| purchases(asinCategorySameAs=12345 asinBrandSameAs=45678 asinPriceBetween=50-100 lookback=90) | Target an audience that has purchased products in the given category, brand, and price range in the past 7,14,30,60,90,180 or 365 days |\n| audiencesLikelyInterestedInAd | Dynamic segment to target audiences that are likely to consider and buy from your business. We recommend that you add this segment to all of your campaigns to help you achieve greater reach and campaign scale. Note: this is only supported when using landingPageType of OFF_AMAZON_LINK |\n| audience(audienceSameAs=12345) | Target the given Amazon Audience. |\n\n| Content targeting clause | Description |\n|------------------|-------------|\n| contentCategorySameAs=amzn1.iab-content.325 | Target an audience that has engaged with or shown interest in the given entertainment category. |\n\nNotes on content targeting:\n* The `contentCategorySameAs` targeting predicate is required\n* For all iab categories, see [Discovering entertainment target categories](https://advertising.amazon.com/API/docs/en-us/guides/sponsored-display/entertainment-targeting#discovering-entertainment-target-categories).\n\nNote:\n1. You can still create new targeting clauses for Contextual campaigns with tactic 'T00020' using the Contextual clauses above.\n2. There is a limit of 200 targeting clauses per request for T00030.\n3. There is a limit of 1000 targeting clauses per request for T00020.\n4. There is a total limit of 1000 targeting clauses per ad group.\n5. If you receive the error of \"Cannot create targeting clause: audience size is too small\", please expand or broaden your targeting clause to increase the audience size.","operationId":"createTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of targeting clauses for creation.","content":{"application/json":{"schema":{"type":"array","items":{"required":["adGroupId","expressionType","expression"],"allOf":[{"type":"object","properties":{"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the [\"Bid constraints by marketplace\" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.","format":"float","nullable":true,"minimum":0.02}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expressionType":{"type":"string","enum":["manual","auto"],"description":"Tactic T00020 ad groups only allow manual targeting."},"expression":{"type":"array","description":"The targeting expression to match against.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}],"example":{"expression":[{"type":"views","value":[{"type":"similarProduct"},{"type":"lookback","value":"30"}]}],"bid":"1.25","adGroupId":209426065351234,"expressionType":"manual","state":"enabled"}}}}},"required":false},"responses":{"207":{"description":"multi-status","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/createTargetingClauses","sectionHeader":{"type":3,"text":"POST /sd/targets"},"summary":"Creates one or more targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/{targetId}",{"tags":["Targeting"],"summary":"Gets a targeting clause specified by identifier.","description":"This call returns the minimal set of targeting clause fields.","operationId":"getTargets","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"targetId","in":"path","description":"The identifier of a targeting clause.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the [\"Bid constraints by marketplace\" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.","format":"float","nullable":true,"minimum":0.02}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"expressionType":{"type":"string","enum":["manual","auto"],"description":"Tactic T00020 & T00030 ad groups should use 'manual' targeting."},"expression":{"type":"array","description":"The targeting expression to match against.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"resolvedExpression":{"type":"array","description":"The resolved targeting expression.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}]},"example":{"targetId":123,"adGroupId":321,"campaignId":234,"state":"enabled","expressionType":"manual","bid":1.5,"expression":{"type":"asinSameAs","value":"B0123456789"},"resolvedExpression":{"type":"asinSameAs","value":"B0123456789"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/getTargets","sectionHeader":{"type":3,"text":"GET /sd/targets/{targetId}"},"summary":"Gets a targeting clause specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/{targetId}",{"tags":["Targeting"],"summary":"Sets the `state` of a targeting clause to `archived`.","description":"Equivalent to using the `updateTargetingClauses` operation to set the `state` property of a targeting clause to `archived`. See [Developer\nNotes](http://advertising.amazon.com/API/docs/guides/developer_notes#Archiving) for more information.","operationId":"archiveTargetingClause","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"targetId","in":"path","description":"The identifer of a targeting clause.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/archiveTargetingClause","sectionHeader":{"type":3,"text":"DELETE /sd/targets/{targetId}"},"summary":"Sets the `state` of a targeting clause to `archived`.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/extended",{"tags":["Targeting"],"summary":"Gets a list of targeting clause objects with extended fields.","description":"Gets an array of TargetingClauseEx objects for a set of requested targets. Note that this call returns the full set of targeting clause extended fields, but is less efficient than getTargets.","operationId":"listTargetingClausesEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. 0-indexed record offset for the result set. Defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Number of records to include in the paged response. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. Restricts results to keywords with state within the specified comma-separated list. Must be one of: `enabled`, `paused`, or `archived`. Default behavior is to include enabled, paused, and archived.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"targetIdFilter","in":"query","description":"Optional. Restricts results to ads with the specified `tagetId` specified in comma-separated list","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional list of comma separated adGroupIds. Restricts results to targeting clauses with the specified `adGroupId`.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. Restricts results to ads within campaigns specified in comma-separated list.","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"number"},"adGroupId":{"type":"number"},"campaignId":{"type":"number"},"state":{"type":"string","enum":["enabled","paused","archived"]},"expressionType":{"type":"string","enum":["auto","manual"]},"bid":{"type":"number","description":"If a value for `bid` is specified, it overrides the current adGroup bid. When using vcpm costType. $1 is the minimum bid for vCPM. Note that this field is ignored for negative targeting clauses."},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual or content targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can contain 'TargetingPredicate' or 'ContentTargetingPredicate' components.\n* Contextual expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"resolvedExpression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual or content targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can contain 'TargetingPredicate' or 'ContentTargetingPredicate' components.\n* Contextual expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"servingStatus":{"type":"string","description":"The status of the target.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","TARGET_STATUS_LIVE","TARGET_STATUS_PAUSED","TARGET_STATUS_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the target was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the target.","format":"int64"}}}},"example":{"targetId":123,"adGroupId":321,"campaignId":234,"state":"enabled","expressionType":"manual","bid":1.5,"expression":{"type":"asinSameAs","value":"B0123456789"},"resolvedExpression":{"type":"asinSameAs","value":"B0123456789"},"servingStatus":"TARGET_STATUS_PAUSED","creationDate":1537568785000,"lastUpdateDate":1537568785000}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/listTargetingClausesEx","sectionHeader":{"type":3,"text":"GET /sd/targets/extended"},"summary":"Gets a list of targeting clause objects with extended fields.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/extended/{targetId}",{"tags":["Targeting"],"summary":"Gets extended information for a targeting clause.","description":"Gets a targeting clause object with extended fields. Note that this call returns the full set of targeting clause extended fields, but is less efficient than getTarget.","operationId":"getTargetsEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"targetId","in":"path","description":"The identifier of a targeting clause.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"number"},"adGroupId":{"type":"number"},"campaignId":{"type":"number"},"state":{"type":"string","enum":["enabled","paused","archived"]},"expressionType":{"type":"string","enum":["auto","manual"]},"bid":{"type":"number","description":"If a value for `bid` is specified, it overrides the current adGroup bid. When using vcpm costType. $1 is the minimum bid for vCPM. Note that this field is ignored for negative targeting clauses."},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual or content targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can contain 'TargetingPredicate' or 'ContentTargetingPredicate' components.\n* Contextual expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"resolvedExpression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual or content targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can contain 'TargetingPredicate' or 'ContentTargetingPredicate' components.\n* Contextual expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"servingStatus":{"type":"string","description":"The status of the target.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","TARGET_STATUS_LIVE","TARGET_STATUS_PAUSED","TARGET_STATUS_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the target was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the target.","format":"int64"}}},"example":{"targetId":123,"adGroupId":321,"campaignId":234,"state":"enabled","expressionType":"manual","bid":1.5,"expression":{"type":"asinSameAs","value":"B0123456789"},"resolvedExpression":{"type":"asinSameAs","value":"B0123456789"},"servingStatus":"TARGET_STATUS_PAUSED","creationDate":1537568785000,"lastUpdateDate":1537568785000}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/getTargetsEx","sectionHeader":{"type":3,"text":"GET /sd/targets/extended/{targetId}"},"summary":"Gets extended information for a targeting clause.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/recommendations",{"tags":["Targeting Recommendations"],"operationId":"getTargetRecommendations","summary":"Returns a set of recommended products and categories to target","description":"This API provides product, category and standard audience recommendations to target based on the list of input ASINs. Allow 1 week for our systems to process data for any new ASINs listed on Amazon before using this service. Note -  recommendations are only available for productAds with SKU or ASIN.\n\nFor API v3.0, the API returns up to 100 recommendations for contextual targeting.\n\nFor API v3.1, the API returns up to 100 recommendations for both product and category targeting.\n\nFor API v3.2, the API introduces contextual targeting themes in the request and returns product recommendations based on different targeting themes.\n\nFor API v3.3, the API introduces standard audience recommendations and translated category recommendations based on locale.\n\nFor API v3.4, the API includes the theme expression used in contextual targeting recommendations in the response.\n\n[PREVIEW ONLY] For API v3.5, the API supports recommendations for landing pages for audience targeting with tactic T00030.\nThe API also supports entertainment targeting recommendations. Both features are currently limited to US marketplace.\n\nThe currently available tactic identifiers are:\n\n|Tactic Name|Type|Description|\n|-----------|----|-----------|\n|T00020&nbsp;|Contextual Targeting|Products: Choose individual products to show your ads in placements related to those products.|\n|T00030&nbsp;|Audiences or Contextual Targeting| Select individual products, categories, refined categories, or audiences to show your ads.|","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"The requested locale from query parameter to return translated category recommendations.","required":false,"schema":{"type":"string","description":"List of supported locales.","enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"]}}],"requestBody":{"content":{"application/vnd.sdtargetingrecommendations.v3.5+json":{"schema":{"description":"Request for targeting recommendations for API version 3.5.","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|\n        |T00030&nbsp;|Audiences or Contextual Targeting &nbsp;|Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"products":{"description":"A list of products for which to get targeting recommendations. This array can only contain either asins or landing pages. If landingPageUrl is used,\nthere can only be one item in the array for each request.","type":"array","minItems":1,"maxItems":10000,"items":{"description":"Product that advertisers want to advertise. Recommendations will be made for specified products. SDAdvertisedProduct can only contain either asins or landing pages. If landingPageUrl is used, there can only be one item for each request.","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is not supported when using asin field.","enum":["OFF_AMAZON_LINK"]},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if landingPageType field is set.\nThis field is not supported when using asin field.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com.|"}},"example":[{"asin":"B00PN11UNW"}]},"example":[{"asin":"B00PN11UNW"}]},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":3,"example":["PRODUCT","CATEGORY","AUDIENCE","CONTENT_CATEGORY"],"items":{"type":"string","description":"Signifies a type of recommendation. PRODUCT, CATEGORY, and CONTENT_CATEGORY are supported by tactic T00020. CATEGORY, AUDIENCE, and CONTENT_CATEGORY are supported by tactic T00030.","example":"PRODUCT","enum":["PRODUCT","CATEGORY","AUDIENCE","CONTENT_CATEGORY"]}},"themes":{"type":"object","description":"The themes used to refine the recommendations. Currently only contextual targeting themes are supported.","properties":{"product":{"type":"array","minItems":0,"maxItems":5,"description":"A list of themes for product targeting recommendations. If this list is empty, the service will return all the current available theme recommendations. Recommendations will be returned for each theme. If specified, each theme should only include unique expressions.","items":{"type":"object","description":"Contextual targeting theme definitions.","required":["name","expression"],"properties":{"name":{"type":"string","description":"This is the meaningful theme name which will be used as a unique identifier across various themes in the same request.\nThis identifier will also be used to map the recommendations back to the theme in the response body.\nNote: the value for this field cannot be \"default\" as that's a reserved keyword in the system.","minLength":1,"maxLength":100,"pattern":"^(?!default$)"},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the contextual targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: Currently the service only supports one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}}}}}}},"categoryType":{"type":"string","description":"This field is optional unless the field locationExpression is present in the request. It is used for category audience targeting\nto specify if the audience is for views (re-marketing) or purchases (re-purchasing). The specified categories will be returned accordingly.","enum":["views","purchases"]},"locationExpression":{"description":"This optional field is used to specify the locations used in SD location targeting for non-Amazon sellers only at the moment.\nTherefore it's only supported if the product is a landing page url.","type":"array","minItems":1,"maxItems":20,"items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.","example":"amzn1.ad-geo.XHvCjcKHXmJ7woVowo7CjmvCjcKWbMKHwp3CsGvCk8KrcmstQ2l0eQ=="}}}}}}},"application/vnd.sdtargetingrecommendations.v3.4+json":{"schema":{"description":"Request for targeting recommendations for API version 3.4.","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|\n        |T00030&nbsp;|Audiences or Contextual Targeting &nbsp;|Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"products":{"type":"array","description":"A list of products for which to get targeting recommendations","minItems":1,"maxItems":10000,"items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":2,"example":["PRODUCT","CATEGORY","AUDIENCE"],"items":{"type":"string","description":"Signifies a type of recommendation. PRODUCT and CATEGORY are supported by tactic T00020. CATEGORY and AUDIENCE are supported by tactic T00030.","example":"PRODUCT","enum":["PRODUCT","CATEGORY","AUDIENCE"]}},"themes":{"type":"object","description":"The themes used to refine the recommendations. Currently only contextual targeting themes are supported.","properties":{"product":{"type":"array","minItems":0,"maxItems":5,"description":"A list of themes for product targeting recommendations. If this list is empty, the service will return all the current available theme recommendations. Recommendations will be returned for each theme. If specified, each theme should only include unique expressions.","items":{"type":"object","description":"Contextual targeting theme definitions.","required":["name","expression"],"properties":{"name":{"type":"string","description":"This is the meaningful theme name which will be used as a unique identifier across various themes in the same request.\nThis identifier will also be used to map the recommendations back to the theme in the response body.\nNote: the value for this field cannot be \"default\" as that's a reserved keyword in the system.","minLength":1,"maxLength":100,"pattern":"^(?!default$)"},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the contextual targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: Currently the service only supports one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.3+json":{"schema":{"description":"Request for targeting recommendations for API version 3.3.","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|\n        |T00030&nbsp;|Audiences or Contextual Targeting &nbsp;|Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"products":{"type":"array","description":"A list of products for which to get targeting recommendations","minItems":1,"maxItems":10000,"items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":2,"example":["PRODUCT","CATEGORY","AUDIENCE"],"items":{"type":"string","description":"Signifies a type of recommendation. PRODUCT and CATEGORY are supported by tactic T00020. CATEGORY and AUDIENCE are supported by tactic T00030.","example":"PRODUCT","enum":["PRODUCT","CATEGORY","AUDIENCE"]}},"themes":{"type":"object","description":"The themes used to refine the recommendations. Currently only contextual targeting themes are supported.","properties":{"product":{"type":"array","minItems":0,"maxItems":5,"description":"A list of themes for product targeting recommendations. If this list is empty, the service will return all the current available theme recommendations. Recommendations will be returned for each theme. If specified, each theme should only include unique expressions.","items":{"type":"object","description":"Contextual targeting theme definitions.","required":["name","expression"],"properties":{"name":{"type":"string","description":"This is the meaningful theme name which will be used as a unique identifier across various themes in the same request.\nThis identifier will also be used to map the recommendations back to the theme in the response body.\nNote: the value for this field cannot be \"default\" as that's a reserved keyword in the system.","minLength":1,"maxLength":100,"pattern":"^(?!default$)"},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the contextual targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: Currently the service only supports one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.2+json":{"schema":{"description":"Request for targeting recommendations for API version 3.2.","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|\n        |T00030&nbsp;|Audiences or Contextual Targeting &nbsp;|Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"products":{"type":"array","description":"A list of products for which to get targeting recommendations","minItems":1,"maxItems":10000,"items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":2,"example":["PRODUCT","CATEGORY"],"items":{"type":"string","description":"Signifies a type of recommendation","example":"PRODUCT","enum":["PRODUCT","CATEGORY"]}},"themes":{"type":"object","description":"The themes used to refine the recommendations. Currently only contextual targeting themes are supported.","properties":{"product":{"type":"array","minItems":0,"maxItems":5,"description":"A list of themes for product targeting recommendations. If this list is empty, the service will return all the current available theme recommendations. Recommendations will be returned for each theme. If specified, each theme should only include unique expressions.","items":{"type":"object","description":"Contextual targeting theme definitions.","required":["name","expression"],"properties":{"name":{"type":"string","description":"This is the meaningful theme name which will be used as a unique identifier across various themes in the same request.\nThis identifier will also be used to map the recommendations back to the theme in the response body.\nNote: the value for this field cannot be \"default\" as that's a reserved keyword in the system.","minLength":1,"maxLength":100,"pattern":"^(?!default$)"},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the contextual targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: Currently the service only supports one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.1+json":{"schema":{"description":"Request for targeting recommendations","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|\n        |T00030&nbsp;|Audiences or Contextual Targeting &nbsp;|Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"products":{"type":"array","description":"A list of products for which to get targeting recommendations","minItems":1,"maxItems":10000,"items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":2,"example":["PRODUCT","CATEGORY"],"items":{"type":"string","description":"Signifies a type of recommendation","example":"PRODUCT","enum":["PRODUCT","CATEGORY"]}}}}},"application/vnd.sdtargetingrecommendations.v3.0+json":{"schema":{"description":"Request for targeting recommendations","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.","example":"T00030","enum":["T00020"]},"products":{"type":"array","minItems":1,"maxItems":10000,"description":"A list of products for which to get targeting recommendations","items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":1,"items":{"type":"string","description":"Signifies a type of recommendation","example":"PRODUCT","enum":["PRODUCT"]}}}}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.sdtargetingrecommendations.v3.5+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"description":"For v3.5 the service will continue to return the recommendations returned for v3.4, return Entertainment targeting recommendations if requested and return asin-less recommendations if a landing page URL was passed in the request","type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}},"categories":{"type":"array","description":"List of recommended category targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended category to target ads on","properties":{"category":{"type":"integer","description":"The category identifier","example":7352105011},"name":{"type":"string","description":"The category name"},"translatedName":{"type":"string","description":"The translated category name by requested locale, field will not be provided if locale is not provided or campaign localization service is down."},"path":{"type":"array","description":"The path of the category within the category catalogue.","minItems":1,"items":{"type":"string"}},"translatedPath":{"type":"array","description":"The translated path of the category within the category catalogue by requested locale, field will not be provided if locale is not provided or campaign localization is down.","minItems":1,"items":{"type":"string"}},"targetableAsinCountRange":{"type":"object","description":"The range of ASINs available within the category catalogue.","properties":{"rangeLower":{"type":"integer"},"rangeUpper":{"type":"integer"}}},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation.","minimum":1}}}},"audiences":{"type":"array","description":"List of recommended audience targets, broken down by audience category","minItems":0,"maxItems":10,"items":{"description":"List of recommended standard Amazon audience targets of a specific audience category","properties":{"category":{"type":"string","description":"An audience category determines the goal of the audience such as In-market, Interest, Lifestyle and Life Event","example":"In-Market","enum":["In-market","Lifestyle","Interest","Life event"]},"audiences":{"type":"array","description":"List of recommended standard Amazon audience targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended standard Amazon audience to target ads on","properties":{"audience":{"type":"string","description":"The audience identifier","example":417464173123977660},"name":{"type":"string","description":"The Amazon audience name"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}}},"contentCategories":{"type":"array","description":"List of recommended entertainment targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended content category to target ads on","properties":{"contentCategory":{"type":"string","description":"The content category value","example":"amzn1.iab-content.647"},"name":{"type":"string","description":"The content category name","example":"Drama"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}},"themes":{"type":"object","properties":{"themes":{"properties":{"products":{"type":"array","description":"A list of contextual targeting theme recommendations.","minItems":1,"maxItems":5,"items":{"oneOf":[{"type":"object","description":"Recommendation results for contextual targeting.","properties":{"code":{"type":"string","description":"HTTP status code 200 indicating a successful response for product recommendations.","example":200},"name":{"type":"string","description":"The theme name specified in the request."},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the product targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: currently the service only support one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}},"recommendations":{"type":"array","description":"A list of recommended products.","minItems":1,"maxItems":100,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}]}}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.4+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"description":"For v3.4 the service will continue to return the recommendations returned for v3.2, return audience recommendations if requested, and return the theme expression used in product targeting if requested.","type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}},"categories":{"type":"array","description":"List of recommended category targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended category to target ads on","properties":{"category":{"type":"integer","description":"The category identifier","example":7352105011},"name":{"type":"string","description":"The category name"},"translatedName":{"type":"string","description":"The translated category name by requested locale, field will not be provided if locale is not provided or campaign localization service is down."},"path":{"type":"array","description":"The path of the category within the category catalogue.","minItems":1,"items":{"type":"string"}},"translatedPath":{"type":"array","description":"The translated path of the category within the category catalogue by requested locale, field will not be provided if locale is not provided or campaign localization is down.","minItems":1,"items":{"type":"string"}},"targetableAsinCountRange":{"type":"object","description":"The range of ASINs available within the category catalogue.","properties":{"rangeLower":{"type":"integer"},"rangeUpper":{"type":"integer"}}},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation.","minimum":1}}}},"audiences":{"type":"array","description":"List of recommended audience targets, broken down by audience category","minItems":0,"maxItems":10,"items":{"description":"List of recommended standard Amazon audience targets of a specific audience category","properties":{"category":{"type":"string","description":"An audience category determines the goal of the audience such as In-market, Interest, Lifestyle and Life Event","example":"In-Market","enum":["In-market","Lifestyle","Interest","Life event"]},"audiences":{"type":"array","description":"List of recommended standard Amazon audience targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended standard Amazon audience to target ads on","properties":{"audience":{"type":"string","description":"The audience identifier","example":417464173123977660},"name":{"type":"string","description":"The Amazon audience name"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}}},"themes":{"type":"object","properties":{"themes":{"properties":{"products":{"type":"array","description":"A list of contextual targeting theme recommendations.","minItems":1,"maxItems":5,"items":{"oneOf":[{"type":"object","description":"Recommendation results for contextual targeting.","properties":{"code":{"type":"string","description":"HTTP status code 200 indicating a successful response for product recommendations.","example":200},"name":{"type":"string","description":"The theme name specified in the request."},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the product targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: currently the service only support one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}},"recommendations":{"type":"array","description":"A list of recommended products.","minItems":1,"maxItems":100,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}]}}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.3+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"description":"For v3.3 the service will continue to return the recommendations returned for v3.2, and return audience recommendations if requested.","allOf":[{"type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}},{"type":"object","properties":{"categories":{"type":"array","description":"List of recommended category targets.","minItems":0,"maxItems":1000,"items":{"description":"A recommended category to target ads on","properties":{"category":{"type":"integer","description":"The category identifier","example":7352105011},"name":{"type":"string","description":"The category name"},"translatedName":{"type":"string","description":"The translated category name by requested locale, field will not be provided if locale is not provided or campaign localization service is down."},"path":{"type":"array","description":"The path of the category within the category catalogue.","minItems":1,"items":{"type":"string"}},"translatedPath":{"type":"array","description":"The translated path of the category within the category catalogue by requested locale, field will not be provided if locale is not provided or campaign localization is down.","minItems":1,"items":{"type":"string"}},"targetableAsinCountRange":{"type":"object","description":"The range of ASINs available within the category catalogue.","properties":{"rangeLower":{"type":"integer"},"rangeUpper":{"type":"integer"}}},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation.","minimum":1}}}}}},{"type":"object","properties":{"audiences":{"type":"array","description":"List of recommended audience targets, broken down by audience category","minItems":0,"maxItems":10,"items":{"description":"List of recommended standard Amazon audience targets of a specific audience category","properties":{"category":{"type":"string","description":"An audience category determines the goal of the audience such as In-market, Interest, Lifestyle and Life Event","example":"In-Market","enum":["In-market","Lifestyle","Interest","Life event"]},"audiences":{"type":"array","description":"List of recommended standard Amazon audience targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended standard Amazon audience to target ads on","properties":{"audience":{"type":"string","description":"The audience identifier","example":417464173123977660},"name":{"type":"string","description":"The Amazon audience name"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}}}}},{"type":"object","properties":{"themes":{"properties":{"products":{"type":"array","description":"A list of contextual targeting theme recommendations.","minItems":1,"maxItems":5,"items":{"oneOf":[{"type":"object","description":"Recommendation results for contextual targeting.","properties":{"code":{"type":"string","description":"HTTP status code 200 indicating a successful response for product recomendations.","example":200},"name":{"type":"string","description":"The theme name specified in the request."},"recommendations":{"type":"array","description":"A list of recommended products.","minItems":1,"maxItems":100,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}]}}}}}}]}}}},"application/vnd.sdtargetingrecommendations.v3.2+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"description":"For v3.2 the service will continue to return the recommendations returned for v3.1 in products field, and return recommendations for contextual targeting themes in themes field.","allOf":[{"type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}},{"type":"object","properties":{"categories":{"type":"array","description":"List of recommended category targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended category to target ads on","properties":{"category":{"type":"integer","description":"The category identifier","example":7352105011},"name":{"type":"string","description":"The category name"},"path":{"type":"array","description":"The path of the category within the category catalogue.","minItems":1,"items":{"type":"string"}},"targetableAsinCountRange":{"type":"object","description":"The range of ASINs available within the category catalogue. If no targetable ASIN counts are available then the targetableAsinCountRange value will be null without any properties.","properties":{"rangeLower":{"type":"integer"},"rangeUpper":{"type":"integer"}}},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}},{"type":"object","properties":{"themes":{"properties":{"products":{"type":"array","description":"A list of contextual targeting theme recommendations.","minItems":1,"maxItems":5,"items":{"oneOf":[{"type":"object","description":"Recommendation results for contextual targeting.","properties":{"code":{"type":"string","description":"HTTP status code 200 indicating a successful response for product recomendations.","example":200},"name":{"type":"string","description":"The theme name specified in the request."},"recommendations":{"type":"array","description":"A list of recommended products.","minItems":1,"maxItems":100,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}]}}}}}}]}}}},"application/vnd.sdtargetingrecommendations.v3.1+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"allOf":[{"type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}},{"type":"object","properties":{"categories":{"type":"array","description":"List of recommended category targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended category to target ads on","properties":{"category":{"type":"integer","description":"The category identifier","example":7352105011},"name":{"type":"string","description":"The category name"},"path":{"type":"array","description":"The path of the category within the category catalogue.","minItems":1,"items":{"type":"string"}},"targetableAsinCountRange":{"type":"object","description":"The range of ASINs available within the category catalogue. If no targetable ASIN counts are available then the targetableAsinCountRange value will be null without any properties.","properties":{"rangeLower":{"type":"integer"},"rangeUpper":{"type":"integer"}}},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}}]}}}},"application/vnd.sdtargetingrecommendations.v3.0+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"description":"A collection of targeting recommendations. Results will be sorted with strongest recommendations in the beginning.","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}}}}}}},"400":{"description":"Generic bad request error.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting%20Recommendations/operation/getTargetRecommendations","sectionHeader":{"type":3,"text":"POST /sd/targets/recommendations"},"summary":"Returns a set of recommended products and categories to target","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/budgetRecommendations",{"tags":["Budget Recommendations"],"operationId":"getSDBudgetRecommendations","summary":"Returns recommended daily budget and estimated missed opportunities for campaigns","description":"Given a list of campaigns as input, this API provides the following metrics:\n<br> <b>1. Recommended daily budget - </b> Estimated budget needed to keep the campaign in budget for the full 24-hour period. Consider this budget to minimize your campaign's chances of running out of budget. \n<br> <b>2. Percent time in budget </b> - The share of time the campaign was in budget during the past 7 days.\n<br> <b>3. Estimated missed impressions, clicks and sales </b> - These are the estimated additional impressions, clicks and sales the campaign might have generated had it adopted the recommended budget. These are estimates based on campaign's historical performance - and not a guarantee of actual impressions, clicks and sales. Consider using these metrics to further inform your budget allocation decisions.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":false,"schema":{"type":"string"}},{"name":"Amazon-Ads-AccountId","in":"header","description":"The identifier of an account. Account must be a global advertising account.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.sdbudgetrecommendations.v3+json":{"schema":{"description":"Request for budget recommendations.","required":["campaignIds"],"properties":{"campaignIds":{"type":"array","description":"A list of campaign ids for which to get budget recommendations and missed opportunities.","minItems":1,"maxItems":100,"items":{"type":"string"},"example":["5292131569371","5292131569372"]}}}}}},"responses":{"207":{"description":"Multi-status.","content":{"application/vnd.sdbudgetrecommendations.v3+json":{"schema":{"required":["budgetRecommendationsSuccessResults","budgetRecommendationsErrorResults"],"properties":{"budgetRecommendationsSuccessResults":{"type":"array","minItems":0,"maxItems":100,"items":{"required":["index","campaignId","suggestedBudget","sevenDaysMissedOpportunities"],"properties":{"index":{"type":"integer","description":"Correlate the recommendation to the campaign index in the request. Zero-based.","example":0},"campaignId":{"type":"string","description":"Campaign id.","example":5292131569371},"suggestedBudget":{"type":"number","description":"Recommended budget for the campaign. This will be in local currency.","example":350.12},"sevenDaysMissedOpportunities":{"properties":{"startDate":{"type":"string","format":"date","description":"Start date of the missed opportunities date range (YYYY-MM-DD).","example":"2023-05-01"},"endDate":{"type":"string","format":"date","description":"End date of the missed opportunities date range (YYYY-MM-DD).","example":"2023-05-07"},"percentTimeInBudget":{"type":"number","description":"Percentage of time the campaign is active with a budget.","example":60.5},"estimatedMissedSalesLower":{"type":"number","description":"Lower bound of the estimated missed sales. This will be in local currency.","example":200.75},"estimatedMissedSalesUpper":{"type":"number","description":"Upper bound of the estimated missed sales. This will be in local currency.","example":400.75},"estimatedMissedClicksLower":{"type":"integer","description":"Lower bound of the estimated missed clicks.","example":30},"estimatedMissedClicksUpper":{"type":"integer","description":"Upper bound of the estimated missed clicks.","example":50},"estimatedMissedImpressionsLower":{"type":"integer","description":"Lower bound of the estimated missed impressions.","example":50},"estimatedMissedImpressionsUpper":{"type":"integer","description":"Upper bound of the estimated missed impressions.","example":70},"estimatedMissedViewableImpressionsLower":{"type":"integer","description":"Lower bound of the estimated missed viewable impressions for vCPM campaigns.","example":70},"estimatedMissedViewableImpressionsUpper":{"type":"integer","description":"Upper bound of the estimated missed viewable impressions for vCPM campaigns.","example":90}}}}},"description":"List of successful budget recommendation for campaigns."},"budgetRecommendationsErrorResults":{"type":"array","minItems":0,"maxItems":100,"items":{"required":["index","campaignId","code","details"],"properties":{"index":{"type":"integer","description":"Correlate the recommendation to the campaign index in the request. Zero-based.","example":1},"campaignId":{"type":"string","description":"Campaign id.","example":5292131569372},"code":{"type":"string","description":"The HTTP status code of the response.","example":"404"},"details":{"type":"string","description":"A human-readable description of the response.","example":"Budget recommendation is not found."}}},"description":"List of errors that occurred when generating budget recommendation."}}}}}},"400":{"description":"Generic bad request error.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"415":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Recommendations/operation/getSDBudgetRecommendations","sectionHeader":{"type":3,"text":"POST /sd/campaigns/budgetRecommendations"},"summary":"Returns recommended daily budget and estimated missed opportunities for campaigns","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets",{"tags":["Negative Targeting"],"summary":"Gets a list of negative targeting clauses.","description":"Gets a list of negative targeting clauses objects for a requested set of Sponsored Display negative targets. Note that the Negative Targeting Clause object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the negative target operations that return the NegativeTargetingClauseEx object.","operationId":"listNegativeTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. 0-indexed record offset for the result set. Defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Number of records to include in the paged response. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. Restricts results to those with state within the specified comma-separated list. Must be one of: `enabled`, `paused`, or `archived`. Default behavior is to include enabled, paused, and archived.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"adGroupIdFilter","in":"query","description":"Optional list of comma separated adGroupIds. Restricts results to negative targeting clauses with the specified `adGroupId`.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. Restricts results to targeting clauses within campaigns specified in comma-separated list.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"properties":{"state":{"type":"string","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expressionType":{"type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"resolvedExpression":{"type":"array","description":"The resolved negative targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/listNegativeTargetingClauses","sectionHeader":{"type":3,"text":"GET /sd/negativeTargets"},"summary":"Gets a list of negative targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets",{"tags":["Negative Targeting"],"summary":"Updates one or more negative targeting clauses.","description":"Updates one or more negative targeting clauses. Negative targeting clauses are identified using their targetId. The mutable field is `state`. Maximum length of the array is 100 objects.","operationId":"updateNegativeTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of up to 100 negative targeting clauses. Note that the only mutable field is `state`.","content":{"application/json":{"schema":{"type":"array","items":{"required":["targetId"],"allOf":[{"properties":{"state":{"type":"string","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/updateNegativeTargetingClauses","sectionHeader":{"type":3,"text":"PUT /sd/negativeTargets"},"summary":"Updates one or more negative targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets",{"tags":["Negative Targeting"],"summary":"Creates one or more negative targeting clauses.","description":"Successfully created negative targeting clauses associated with an ad group are assigned a unique target identifier.\nProduct negative targeting clause examples:\n| Negative targeting clause | Description |\n|---------------------------|-------------|\n| asinSameAs=B0123456789 | Negatively target this product.|\n| asinBrandSameAs=12345 | Negatively target products in the brand.|","operationId":"createNegativeTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of up to 100 negative targeting clauses for creation.","content":{"application/json":{"schema":{"type":"array","items":{"required":["adGroupId","expressionType","expression","state"],"allOf":[{"properties":{"state":{"type":"string","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"expressionType":{"type":"string","enum":["manual","auto"]}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/createNegativeTargetingClauses","sectionHeader":{"type":3,"text":"POST /sd/negativeTargets"},"summary":"Creates one or more negative targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets/{negativeTargetId}",{"tags":["Negative Targeting"],"summary":"Gets a negative targeting clause specified by identifier.","description":"This call returns the minimal set of negative targeting clause fields, but is more efficient than getNegativeTargetsEx.","operationId":"getNegativeTargets","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"negativeTargetId","in":"path","description":"The negative targeting clause identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"allOf":[{"properties":{"state":{"type":"string","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expressionType":{"type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"resolvedExpression":{"type":"array","description":"The resolved negative targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/getNegativeTargets","sectionHeader":{"type":3,"text":"GET /sd/negativeTargets/{negativeTargetId}"},"summary":"Gets a negative targeting clause specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets/{negativeTargetId}",{"tags":["Negative Targeting"],"summary":"Sets the `state` of a negative targeting clause to `archived`.","description":"Equivalent to using the updateNegativeTargetingClauses operation to set the `state` property of a targeting clause to `archived`. See [Developer Notes](http://advertising.amazon.com/API/docs/guides/developer_notes#Archiving) for more information.","operationId":"archiveNegativeTargetingClause","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"negativeTargetId","in":"path","description":"The identifier of a negative targeting clause.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/archiveNegativeTargetingClause","sectionHeader":{"type":3,"text":"DELETE /sd/negativeTargets/{negativeTargetId}"},"summary":"Sets the `state` of a negative targeting clause to `archived`.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets/extended",{"tags":["Negative Targeting"],"summary":"Gets a list of negative targeting clause objects with extended fields.","description":"Gets an array of NegativeTargetingClauseEx objects for a set of requested negative targets. Note that this call returns the full set of negative targeting clause extended fields, but is less efficient than getNegativeTargets.","operationId":"listNegativeTargetingClausesEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. 0-indexed record offset for the result set. Defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Number of records to include in the paged response. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. Restricts results to keywords with state within the specified comma-separated list. Must be one of: `enabled`, `paused`, or `archived`. Default behavior is to include `enabled`, `paused`, and `archived`.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"targetIdFilter","in":"query","description":"Optional. Restricts results to ads with the specified `tagetId` specified in comma-separated list","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional list of comma separated adGroupIds. Restricts results to negative targeting clauses with the specified `adGroupId`.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. Restricts results to ads within campaigns specified in the comma-separated list.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"number"},"adGroupId":{"type":"number"},"state":{"type":"string","enum":["enabled","paused","archived"]},"expressionType":{"type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"servingStatus":{"type":"string","description":"The status of the target.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","TARGET_STATUS_LIVE","TARGET_STATUS_PAUSED","TARGET_STATUS_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the target was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the target.","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/listNegativeTargetingClausesEx","sectionHeader":{"type":3,"text":"GET /sd/negativeTargets/extended"},"summary":"Gets a list of negative targeting clause objects with extended fields.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets/extended/{negativeTargetId}",{"tags":["Negative Targeting"],"summary":"Gets extended information for a negative targeting clause.","description":"Gets a negative targeting clause with extended fields. Note that this call returns the full set of negative targeting clause extended fields, but is less efficient than getNegativeTarget.","operationId":"getNegativeTargetsEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"negativeTargetId","in":"path","description":"The negative targeting clause identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"number"},"adGroupId":{"type":"number"},"state":{"type":"string","enum":["enabled","paused","archived"]},"expressionType":{"type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"servingStatus":{"type":"string","description":"The status of the target.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","TARGET_STATUS_LIVE","TARGET_STATUS_PAUSED","TARGET_STATUS_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the target was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the target.","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/getNegativeTargetsEx","sectionHeader":{"type":3,"text":"GET /sd/negativeTargets/extended/{negativeTargetId}"},"summary":"Gets extended information for a negative targeting clause.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/{recordType}/snapshot",{"tags":["Snapshots"],"summary":"Request a file-based snapshot of all entities of the specified type in the account satisfying the filtering criteria","description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/get-started).","operationId":"createSnapshot","deprecated":true,"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"recordType","in":"path","description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \nThe type of entity for which the snapshot should be generated. Must be one of: `campaigns`, `adgroups`, `productAds`, or `targets`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request a snapshot file for all entities of a single record type.","content":{"application/json":{"schema":{"type":"object","properties":{"stateFilter":{"type":"string","description":"Optional. Restricts results to entities with state within the specified comma-separated list. Default behavior is to include 'enabled' and 'paused'. You can include 'enabled', 'paused', and 'archived' or any combination.","enum":["enabled","paused","archived"]},"tacticFilter":{"type":"string","description":"Optional. Restricts results to entities with the advertising tactic associated with the campaign. Must be one of the following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00020,T00030","enum":["T00020","T00030","T00020,T00030"]}}}}}},"responses":{"202":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"snapshotId":{"type":"string","description":"The identifier of the snapshot that was requested."},"recordType":{"type":"string","description":"The record type of the snapshot file.","enum":["campaigns","adgroups","productAds","targets"]},"status":{"type":"string","description":"The status of the generation of the snapshot.","enum":["IN_PROGRESS","SUCCESS","FAILURE"]},"statusDetails":{"type":"string","description":"Optional description of the status."},"location":{"type":"string","description":"The URI for the snapshot. It's only available if status is SUCCESS."},"fileSize":{"type":"number","description":"The size of the snapshot file in bytes. It's only available if status is SUCCESS."},"expiration":{"type":"number","description":"The epoch time for expiration of the snapshot file and each snapshot file will be expired in 30 mins after generated. It's only available if status is SUCCESS."}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Snapshots/operation/createSnapshot","sectionHeader":{"type":3,"text":"POST /sd/{recordType}/snapshot"},"summary":"Request a file-based snapshot of all entities of the specified type in the account satisfying the filtering criteria","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/snapshots/{snapshotId}",{"tags":["Snapshots"],"summary":"Retrieve status, metadata, and location of previously requested snapshot","description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/get-started).","operationId":"getSnapshot","deprecated":true,"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"snapshotId","in":"path","description":"The Snapshot identifier.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"snapshotId":{"type":"string","description":"The identifier of the snapshot that was requested."},"recordType":{"type":"string","description":"The record type of the snapshot file.","enum":["campaigns","adgroups","productAds","targets"]},"status":{"type":"string","description":"The status of the generation of the snapshot.","enum":["IN_PROGRESS","SUCCESS","FAILURE"]},"statusDetails":{"type":"string","description":"Optional description of the status."},"location":{"type":"string","description":"The URI for the snapshot. It's only available if status is SUCCESS."},"fileSize":{"type":"number","description":"The size of the snapshot file in bytes. It's only available if status is SUCCESS."},"expiration":{"type":"number","description":"The epoch time for expiration of the snapshot file and each snapshot file will be expired in 30 mins after generated. It's only available if status is SUCCESS."}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified   resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Snapshots/operation/getSnapshot","sectionHeader":{"type":3,"text":"GET /sd/snapshots/{snapshotId}"},"summary":"Retrieve status, metadata, and location of previously requested snapshot","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/snapshots/{snapshotId}/download",{"tags":["Snapshots"],"summary":"Download previously requested snapshot","description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/overview).","operationId":"downloadSnapshot","deprecated":true,"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"snapshotId","in":"path","description":"The Snapshot identifier.","required":true,"schema":{"type":"string"}}],"responses":{"307":{"description":"Successful operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Redirect URI with S3 file location containing snapshot data"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Snapshots/operation/downloadSnapshot","sectionHeader":{"type":3,"text":"GET /sd/snapshots/{snapshotId}/download"},"summary":"Download previously requested snapshot","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/creatives",{"tags":["Creatives"],"summary":"Gets a list of creatives","description":"","operationId":"listCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Sets a cursor into the requested set of creatives. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32","default":0}},{"name":"count","in":"query","description":"Sets the number of creative objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten creatives set `startIndex=0` and `count=10`. To return the next ten creatives, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32","maximum":100,"default":100}},{"name":"adGroupIdFilter","in":"query","description":"The returned array includes only creatives associated with ad group identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `creativeIdFilter` parameter.","schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array includes only creatives with identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `adGroupIdFilter` parameter.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Creative model.","required":["creativeId","adGroupId","properties","moderationStatus","creativeType"],"properties":{"creativeId":{"type":"number","description":"Unique identifier of the creative."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"creativeType":{"type":"string","nullable":false,"description":"\nThe type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided.|","example":"IMAGE","enum":["IMAGE","VIDEO"]},"properties":{"description":"Select customizations on your creative from any combination of headline, logo, custom image and backgrounds.","anyOf":[{"type":"object","description":"User-customizable properties of a creative with headline.","properties":{"headline":{"type":"string","maxLength":50,"description":"A marketing phrase to display on the ad. This field is optional and mutable. Maximum number of characters allowed is 50."},"hasTermsAndConditions":{"type":"boolean","description":"Indicates that the ad promotes a free product or service (e.g., 'buy one get one free' or 'free one-month trial') and has qualifying terms and conditions applicable to your customer. Only supported for productAds with landingPageType of OFF_AMAZON_LINK. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those."},"originalHeadline":{"type":"string","description":"The original headline submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `headline` will return the translated headline whereas `originalHeadline` will return the original headline. In all other cases, 'originalHeadline' and `headline` both will return the original headline."}}},{"type":"object","description":"User-customizable properties of a creative with a logo.","properties":{"brandLogo":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}},{"type":"object","description":"User-customizable properties of a custom image creative.","properties":{"rectCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareImages":{"type":"array","description":"An optional collection of 1:1 square images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"horizontalImages":{"type":"array","description":"An optional collection of 1.91:1 horizontal images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"verticalImages":{"type":"array","description":"An optional collection of 9:16 vertical images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}}},{"type":"object","description":"User-customizable properties of a video creative. Use either the 'video' property for a single video, OR one or more of the aspect-ratio-specific collections (squareVideos, horizontalVideos, verticalVideos).","properties":{"video":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}},"squareVideos":{"type":"array","description":"An optional collection of 1:1 square videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"horizontalVideos":{"type":"array","description":"An optional collection of 16:9 horizontal videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"verticalVideos":{"type":"array","description":"An optional collection of 9:16 vertical videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}}}},{"type":"object","description":"User-customizable properties of a creative with background. Only supported for productAds with landingPageType of OFF_AMAZON_LINK.","properties":{"backgrounds":{"type":"array","description":"An optional collection of backgrounds which are displayed on the ad.","items":{"type":"object","description":"This field denotes background which are displayed on the ad. This field is optional and mutable.","properties":{"color":{"type":"string","description":"The standard HTML hex color codes of the background (e.g. '#3cb371')."}}}}}}]},"moderationStatus":{"type":"string","description":"The moderation status of the creative","enum":["APPROVED","PENDING_REVIEW","REJECTED"]}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Creatives/operation/listCreatives","sectionHeader":{"type":3,"text":"GET /sd/creatives"},"summary":"Gets a list of creatives","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/creatives",{"tags":["Creatives"],"summary":"Updates one or more creatives.","description":"","operationId":"updateCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects to update. Maximum length of the array is 100 objects.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Creative update model.","required":["creativeId","properties"],"properties":{"creativeId":{"type":"number","description":"Unique identifier of the creative."},"creativeType":{"type":"string","nullable":true,"description":"The type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]},"properties":{"description":"Select customizations on your creative from any combination of headline, logo, custom image and backgrounds.","anyOf":[{"type":"object","description":"User-customizable properties of a creative with headline.","properties":{"headline":{"type":"string","maxLength":50,"description":"A marketing phrase to display on the ad. This field is optional and mutable. Maximum number of characters allowed is 50."},"hasTermsAndConditions":{"type":"boolean","description":"Indicates that the ad promotes a free product or service (e.g., 'buy one get one free' or 'free one-month trial') and has qualifying terms and conditions applicable to your customer. Only supported for productAds with landingPageType of OFF_AMAZON_LINK. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those."},"originalHeadline":{"type":"string","description":"The original headline submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `headline` will return the translated headline whereas `originalHeadline` will return the original headline. In all other cases, 'originalHeadline' and `headline` both will return the original headline."}}},{"type":"object","description":"User-customizable properties of a creative with a logo.","properties":{"brandLogo":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}},{"type":"object","description":"User-customizable properties of a custom image creative.","properties":{"rectCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareImages":{"type":"array","description":"An optional collection of 1:1 square images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"horizontalImages":{"type":"array","description":"An optional collection of 1.91:1 horizontal images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"verticalImages":{"type":"array","description":"An optional collection of 9:16 vertical images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}}},{"type":"object","description":"User-customizable properties of a video creative. Use either the 'video' property for a single video, OR one or more of the aspect-ratio-specific collections (squareVideos, horizontalVideos, verticalVideos).","properties":{"video":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}},"squareVideos":{"type":"array","description":"An optional collection of 1:1 square videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"horizontalVideos":{"type":"array","description":"An optional collection of 16:9 horizontal videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"verticalVideos":{"type":"array","description":"An optional collection of 9:16 vertical videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}}}},{"type":"object","description":"User-customizable properties of a creative with background. Only supported for productAds with landingPageType of OFF_AMAZON_LINK.","properties":{"backgrounds":{"type":"array","description":"An optional collection of backgrounds which are displayed on the ad.","items":{"type":"object","description":"This field denotes background which are displayed on the ad. This field is optional and mutable.","properties":{"color":{"type":"string","description":"The standard HTML hex color codes of the background (e.g. '#3cb371')."}}}}}}]}}},"minItems":1,"maxItems":100}}}},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"creativeId":{"type":"number","description":"The identifier of the creative."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Creatives/operation/updateCreatives","sectionHeader":{"type":3,"text":"PUT /sd/creatives"},"summary":"Updates one or more creatives.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/creatives",{"tags":["Creatives"],"summary":"A POST request of one or more creatives.","description":"","operationId":"createCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of Creative objects to create. Maximum length of the array is 100 objects. Note - when using productAds with landingPageURL of OFF_AMAZON_LINK, STORE, or MOMENT, the following properties are required all together;\n1) headline, 2) brandLogo, and 3) rectCustomImage, squareCustomImage.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Creative create model.","example":{"adGroupId":21035454911234,"properties":{"rectCustomImage":{"assetId":"amzn1.assetlibrary.asset1.fbb498fe19248f834be4b7xxxxxxxx","assetVersion":"version_v1","croppingCoordinates":{"top":0,"left":0,"width":1200,"height":628}},"squareCustomImage":{"assetId":"amzn1.assetlibrary.asset1.fbb498fe19248f834be4b8xxxxxxxx","assetVersion":"version_v1","croppingCoordinates":{"top":0,"left":0,"width":628,"height":628}}}},"required":["adGroupId","properties"],"properties":{"adGroupId":{"type":"number","description":"Unqiue identifier for the ad group associated with the creative."},"creativeType":{"type":"string","nullable":true,"description":"The type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]},"properties":{"description":"Select customizations on your creative from any combination of headline, logo, custom image and backgrounds.","anyOf":[{"type":"object","description":"User-customizable properties of a creative with headline.","properties":{"headline":{"type":"string","maxLength":50,"description":"A marketing phrase to display on the ad. This field is optional and mutable. Maximum number of characters allowed is 50."},"hasTermsAndConditions":{"type":"boolean","description":"Indicates that the ad promotes a free product or service (e.g., 'buy one get one free' or 'free one-month trial') and has qualifying terms and conditions applicable to your customer. Only supported for productAds with landingPageType of OFF_AMAZON_LINK. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those."},"originalHeadline":{"type":"string","description":"The original headline submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `headline` will return the translated headline whereas `originalHeadline` will return the original headline. In all other cases, 'originalHeadline' and `headline` both will return the original headline."}}},{"type":"object","description":"User-customizable properties of a creative with a logo.","properties":{"brandLogo":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}},{"type":"object","description":"User-customizable properties of a custom image creative.","properties":{"rectCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareImages":{"type":"array","description":"An optional collection of 1:1 square images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"horizontalImages":{"type":"array","description":"An optional collection of 1.91:1 horizontal images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"verticalImages":{"type":"array","description":"An optional collection of 9:16 vertical images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}}},{"type":"object","description":"User-customizable properties of a video creative. Use either the 'video' property for a single video, OR one or more of the aspect-ratio-specific collections (squareVideos, horizontalVideos, verticalVideos).","properties":{"video":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}},"squareVideos":{"type":"array","description":"An optional collection of 1:1 square videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"horizontalVideos":{"type":"array","description":"An optional collection of 16:9 horizontal videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"verticalVideos":{"type":"array","description":"An optional collection of 9:16 vertical videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}}}},{"type":"object","description":"User-customizable properties of a creative with background. Only supported for productAds with landingPageType of OFF_AMAZON_LINK.","properties":{"backgrounds":{"type":"array","description":"An optional collection of backgrounds which are displayed on the ad.","items":{"type":"object","description":"This field denotes background which are displayed on the ad. This field is optional and mutable.","properties":{"color":{"type":"string","description":"The standard HTML hex color codes of the background (e.g. '#3cb371')."}}}}}}]},"consentToTranslate":{"type":"boolean","description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch."}}},"minItems":1,"maxItems":100}}}},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"creativeId":{"type":"number","description":"The identifier of the creative."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Creatives/operation/createCreatives","sectionHeader":{"type":3,"text":"POST /sd/creatives"},"summary":"A POST request of one or more creatives.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/creatives/preview",{"tags":["Creatives"],"summary":"Gets creative preview HTML.","description":"","operationId":"postCreativePreview","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["creative","previewConfiguration"],"properties":{"creative":{"type":"object","description":"Creative model for preview.","properties":{"creativeType":{"type":"string","nullable":true,"description":"The type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]},"properties":{"description":"Select customizations on your creative from any combination of headline, logo, custom image and backgrounds.","anyOf":[{"type":"object","description":"User-customizable properties of a creative with headline.","properties":{"headline":{"type":"string","maxLength":50,"description":"A marketing phrase to display on the ad. This field is optional and mutable. Maximum number of characters allowed is 50."},"hasTermsAndConditions":{"type":"boolean","description":"Indicates that the ad promotes a free product or service (e.g., 'buy one get one free' or 'free one-month trial') and has qualifying terms and conditions applicable to your customer. Only supported for productAds with landingPageType of OFF_AMAZON_LINK. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those."},"originalHeadline":{"type":"string","description":"The original headline submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `headline` will return the translated headline whereas `originalHeadline` will return the original headline. In all other cases, 'originalHeadline' and `headline` both will return the original headline."}}},{"type":"object","description":"User-customizable properties of a creative with a logo.","properties":{"brandLogo":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}},{"type":"object","description":"User-customizable properties of a custom image creative.","properties":{"rectCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareImages":{"type":"array","description":"An optional collection of 1:1 square images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"horizontalImages":{"type":"array","description":"An optional collection of 1.91:1 horizontal images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"verticalImages":{"type":"array","description":"An optional collection of 9:16 vertical images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}}},{"type":"object","description":"User-customizable properties of a video creative. Use either the 'video' property for a single video, OR one or more of the aspect-ratio-specific collections (squareVideos, horizontalVideos, verticalVideos).","properties":{"video":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}},"squareVideos":{"type":"array","description":"An optional collection of 1:1 square videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"horizontalVideos":{"type":"array","description":"An optional collection of 16:9 horizontal videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"verticalVideos":{"type":"array","description":"An optional collection of 9:16 vertical videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}}}},{"type":"object","description":"User-customizable properties of a creative with background. Only supported for productAds with landingPageType of OFF_AMAZON_LINK.","properties":{"backgrounds":{"type":"array","description":"An optional collection of backgrounds which are displayed on the ad.","items":{"type":"object","description":"This field denotes background which are displayed on the ad. This field is optional and mutable.","properties":{"color":{"type":"string","description":"The standard HTML hex color codes of the background (e.g. '#3cb371')."}}}}}}]}}},"previewConfiguration":{"type":"object","description":"Optional configuration for creative preview.","properties":{"size":{"type":"object","description":"The slot dimension to render the creative. Sponsored Display creatives are responsive to a limited list of width and height pairs, including 300x250, 650x130, 245x250, 414x125, 600x160, 600x300, 728x90, 980x55, 320x50, 970x250 and 270x150.","properties":{"width":{"type":"integer"},"height":{"type":"integer"}}},"products":{"type":"array","description":"The products to preview. Currently only the first product is previewable.","items":{"type":"object","properties":{"asin":{"type":"string","description":"The ASIN of the product."}}}},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"isMobile":{"type":"boolean","description":"Preview the creative as if it is on a mobile environment."},"isOnAmazon":{"type":"boolean","description":"Preview the creative as if it is on an amazon site or third party site. The main difference is whether the preview will contain an AdChoices icon."}}},"previewConfigurations":{"type":"array","items":{"type":"object","description":"Optional configuration for creative preview.","properties":{"size":{"type":"object","description":"The slot dimension to render the creative. Sponsored Display creatives are responsive to a limited list of width and height pairs, including 300x250, 650x130, 245x250, 414x125, 600x160, 600x300, 728x90, 980x55, 320x50, 970x250 and 270x150.","properties":{"width":{"type":"integer"},"height":{"type":"integer"}}},"products":{"type":"array","description":"The products to preview. Currently only the first product is previewable.","items":{"type":"object","properties":{"asin":{"type":"string","description":"The ASIN of the product."}}}},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"isMobile":{"type":"boolean","description":"Preview the creative as if it is on a mobile environment."},"isOnAmazon":{"type":"boolean","description":"Preview the creative as if it is on an amazon site or third party site. The main difference is whether the preview will contain an AdChoices icon."}}}}}}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","required":["previewHtml"],"properties":{"previewHtml":{"type":"string"},"previewHtmls":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Creatives/operation/postCreativePreview","sectionHeader":{"type":3,"text":"POST /sd/creatives/preview"},"summary":"Gets creative preview HTML.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/moderation/creatives",{"tags":["Creatives"],"summary":"Gets a list of creative moderations","description":"","operationId":"listCreativeModerations","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","description":"The language of the returned creative moderation metadata.","required":true,"schema":{"type":"string","description":"Locale string as described in [BCP 47](https://tools.ietf.org/html/bcp47). For example, `en-US`","pattern":"^\\[a-z]{2}-[AZ]{2}$","enum":["en-US","es-MX","zh-CN","es-ES","it-IT","fr-FR","fr-CA","de-DE","ja-JP","ko-KR","en-GB","en-CA","hi-IN","en-IN","en-DE","en-ES","en-FR","en-IT","en-JP","en-AE","ar-AE"]}},{"name":"startIndex","in":"query","description":"Sets a cursor into the requested set of creative moderations. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32","default":0}},{"name":"count","in":"query","description":"Sets the number of creative objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten creative moderations set `startIndex=0` and `count=10`. To return the next ten creative moderations, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32","maximum":100,"default":100}},{"name":"adGroupIdFilter","in":"query","description":"The returned array includes only creative moderations associated with ad group identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `creativeIdFilter` parameter.","schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array includes only creative moderations with creative identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `adGroupIdFilter` parameter.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"System generated Creative moderation.","required":["creativeId","moderationStatus","etaForModeration","policyViolations","creativeType"],"properties":{"creativeId":{"type":"number","description":"Unique identifier of the creative."},"creativeType":{"type":"string","nullable":false,"description":"\nThe type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided.|","example":"IMAGE","enum":["IMAGE","VIDEO"]},"moderationStatus":{"type":"string","description":"The moderation status of the creative.\n|Status|Description|\n|------|-----------|\n|APPROVED|Moderation for the creative is complete.|\n|IN_PROGRESS|Moderation for the creative is in progress. The expected date and time for completion are specfied in the `etaForModeration` field.|\n|REJECTED|The creative has failed moderation. Specific information about the content that violated policy is available in `policyViolations`.|","enum":["APPROVED","PENDING_REVIEW","REJECTED"]},"etaForModeration":{"type":"string","format":"date-time","description":"Expected date and time by which moderation will be complete."},"policyViolations":{"type":"array","description":"A list of policy violations for a creative that has failed moderation.","items":{"type":"object","properties":{"policyDescription":{"type":"string","description":"A human-readable description of the policy."},"policyLinkUrl":{"type":"string","description":"Address of the policy documentation. Follow the link to learn more about the specified policy."},"violatingHeadlineContents":{"type":"array","description":"Information about the headline text that violates the specified policy.","items":{"type":"object","properties":{"reviewedText":{"type":"string","description":"The specific text reviewed during moderation."},"textEvidence":{"type":"array","items":{"type":"object","properties":{"violatingText":{"type":"string","description":"The specific text determined to violate the specified policy in reviewedText"},"violatingTextPosition":{"type":"object","properties":{"start":{"type":"integer","description":"Zero-based index into the text in reviewedText where the text specified in violatingText starts"},"end":{"type":"integer","description":"Zero-based index into the text in reviewedText where the text specified in violatingText ends"}}}}}}}}},"violatingBrandLogoContents":{"type":"array","description":"Information about the brand logo that violates the specified policy.","items":{"type":"object","properties":{"reviewedImageUrl":{"type":"string","description":"Address of the image reviewed during moderation."},"imageEvidences":{"type":"array","items":{"type":"object","properties":{"violatingImageCrop":{"type":"object","properties":{"topLeftX":{"type":"integer","description":"The top left X-coordinate of the content that violates the specfied policy within the image."},"topLeftY":{"type":"integer","description":"The top left Y-coordinate of the content that violates the specfied policy within the image."},"height":{"type":"integer","description":"The height of the content that violates the specfied policy within the image."},"width":{"type":"integer","description":"The width of the content that violates the specfied policy within the image."}}}}}}}}},"violatingCustomImageContents":{"type":"array","description":"Information about the custom image that violates the specified policy.","items":{"type":"object","properties":{"reviewedImageUrl":{"type":"string","description":"Address of the image reviewed during moderation."},"imageEvidences":{"type":"array","items":{"type":"object","properties":{"violatingImageCrop":{"type":"object","properties":{"topLeftX":{"type":"integer","description":"The top left X-coordinate of the content that violates the specfied policy within the image."},"topLeftY":{"type":"integer","description":"The top left Y-coordinate of the content that violates the specfied policy within the image."},"height":{"type":"integer","description":"The height of the content that violates the specfied policy within the image."},"width":{"type":"integer","description":"The width of the content that violates the specfied policy within the image."}}}}}}}}},"violatingVideoContents":{"type":"array","description":"Information about the video that violates the specified policy.","items":{"type":"object","properties":{"reviewedVideoUrl":{"type":"string","description":"Address of the video reviewed during moderation."},"videoEvidences":{"type":"array","items":{"type":"object","properties":{"violatingVideoPosition":{"type":"object","properties":{"start":{"type":"integer","description":"Time at which policy violation within video asset starts."},"end":{"type":"integer","description":"Time at which policy violation within the video asset ends."}}}}}}}}}}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Creatives/operation/listCreativeModerations","sectionHeader":{"type":3,"text":"GET /sd/moderation/creatives"},"summary":"Gets a list of creative moderations","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/{requestId}/results",{"tags":["Brand Safety List"],"summary":"Gets the results for the given request","description":"When a user adds domains to their Brand Safety Deny List, the request is processed asynchronously, and a requestId is provided to the user. This requestId can be used to view the request results for up to 90 days from when the request was submitted. The results provide the status of each domain in the given request. Request results may contain multiple pages. This endpoint will only be available once the request has completed processing. To see the status of the request you can call GET /sd/brandSafety/{requestId}/status. Note that this endpoint only lists the results of POST requests to /sd/brandSafety/deny - it does not reflect the results of DELETE requests.\n","operationId":"getRequestResults","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"description":"The ID of the request previously submitted.","name":"requestId","in":"path","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","required":false,"description":"Optional. Sets a cursor into the requested set of results. Use in conjunction with the count parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.\n","schema":{"type":"integer","minimum":0}},{"name":"count","in":"query","required":false,"description":"Optional. Sets the number of results in the returned array. Use in conjunction with the startIndex parameter to control pagination. For example, to return the first 1000 results set startIndex=0 and count=1000. To return the next 1000 results, set startIndex=1000 and count=1000, and so on. Defaults to max page size(1000).\n","schema":{"type":"integer","minimum":0,"maximum":1000}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","description":"A list of results for the given requestId","items":{"type":"object","properties":{"status":{"type":"string","description":"The state of the domain.","enum":["SUCCESS","FAILURE"],"default":"SUCCESS"},"details":{"type":"string","description":"A human-readable description of the response."},"domainId":{"type":"integer","description":"The identifier of the Brand Safety Deny List Domain.","format":"int64"},"name":{"type":"string","description":"The website or app identifier."}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/getRequestResults","sectionHeader":{"type":3,"text":"GET /sd/brandSafety/{requestId}/results"},"summary":"Gets the results for the given request","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/{requestId}/status",{"tags":["Brand Safety List"],"summary":"Gets the status of the given request","description":"When a user modifies their Brand Safety Deny List, the request is processed asynchronously, and a requestId is provided to the user. This requestId can be used to check the status of the request for up to 90 days from when the request was submitted.\n","operationId":"getRequestStatus","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"description":"The ID of the request previously submitted.","name":"requestId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","description":"The status of the request.","properties":{"requestStatus":{"type":"object","properties":{"requestId":{"type":"string","description":"Request ID"},"timestamp":{"type":"string","description":"Request timestamp"},"status":{"type":"string","description":"The status of the request","enum":["IN_PROGRESS","COMPLETED","FAILURE"]},"statusDetails":{"type":"string","description":"Details related to the request status"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/getRequestStatus","sectionHeader":{"type":3,"text":"GET /sd/brandSafety/{requestId}/status"},"summary":"Gets the status of the given request","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/status",{"tags":["Brand Safety List"],"summary":"List status of all requests","description":"List status of all Brand Safety List requests. The list will contain requests that were submitted in the past 90 days.\n","operationId":"listRequestStatus","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","description":"List of all requests' status.","properties":{"requestStatusList":{"type":"array","description":"List of all requests' status.","items":{"type":"object","properties":{"requestId":{"type":"string","description":"Request ID"},"timestamp":{"type":"string","description":"Request timestamp"},"status":{"type":"string","description":"The status of the request","enum":["IN_PROGRESS","COMPLETED","FAILURE"]},"statusDetails":{"type":"string","description":"Details related to the request status"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/listRequestStatus","sectionHeader":{"type":3,"text":"GET /sd/brandSafety/status"},"summary":"List status of all requests","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/bid/recommendations",{"tags":["Bid Recommendations"],"operationId":"getTargetBidRecommendations","summary":"Returns a set of bid recommendations for targeting clauses","description":"Provides a list of bid recommendations based on the list of input advertised ASINs and targeting clauses in the same format as the targeting API. For each targeting clause in the request a corresponding bid recommendation will be returned in the response. Currently the API will accept up to 100 targeting clauses. Note - these recommendations are only available when productAds have ASIN or SKU fields.\nThis API provides a corresponding bid recommendation for each targeting clause in a request. Currently the API will accept up to 100 targeting clauses.\n\nFor API v3.1, the API provides a list of bid recommendations based on the list of input advertised ASINs and targeting clauses in the same format as the targeting API. Note - these recommendations are only available when productAds have ASIN or SKU fields.\n\nFor API v3.2, the API accepts optimizationType and costType and returns bid recommendations accordingly.\n\nFor API v3.3, the API accepts creativeType and returns bid recommendations accordingly.\n\n[PREVIEW ONLY] For API v3.4, the API supports entertainment targeting bid recommendations which is currently limited to US marketplace.\n\nThe recommended bids are derived from the last 7 days of winning auction bids for the related targeting clause.\n\n\nReceive bid recommendations using the following:\nContextual targeting clause|Description|\n|-----------|----|\n|asinSameAs=B0123456789|Receive a bid recommendation for this target product\n|asinCategorySameAs=12345|Receive a bid recommendation for this target category\n|similarProduct|Receive a bid recommendation for targets that are similar to the advertised asins.\n\n\nAudience targeting clause|Description|\n|-----------|----|\n|views(asinCategorySameAs=12345 lookback=30)|Receive a bid recommendation for a target audience that has viewed products in the given category\n|views(similarProduct lookback=30)|Receive a bid recommendation for a target audience that has viewed similar products to the advertised asins\n|views(exactProduct lookback=30)|Receive a bid recommendation for a target audience that has viewed the advertised asins\n|purchases(asinCategorySameAs=12345 lookback=30)|Receive a bid recommendation for a target audience that has purchased products in the given category\n|purchases(exactProduct lookback=30)|Receive a bid recommendation for a target audience that has purchased the advertised asins\n|purchases(relatedProduct lookback=30)|Receive a bid recommendation for a target audience that has purchased related products to the advertised asins\n|audience(audienceSameAs=12345)|Receive a bid recommendation for the given target audience\n\n| Content targeting clause | Description |\n|------------------|-------------|\n| [PREVIEW ONLY] contentCategorySameAs=amzn1.iab-content.325 | Receive a bid recommendation for the given content target |\n\n\n#### Notes:\n- Refinements are currently not supported and if included will not impact the bid recommendation for the target.\n\n\n#### Advertised ASIN Notes:\n- For asinSameAs targets the advertised asins will not impact the bid recommendation\n- For asinCategorySameAs targets the advertised asins are optional, but including them will provide a more refined bid recommendation\n- For similarProduct, exactProduct, and relatedProduct targets the advertised asins are required","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.sdtargetingrecommendations.v3.4+json":{"schema":{"description":"Request for targeting bid recommendations.","example":{"products":[{"asin":"B01B8R6V2E"}],"bidOptimization":"reach","costType":"vcpm","creativeType":"VIDEO","targetingClauses":[{"targetingClause":{"expressionType":"manual","expression":[{"type":"views","value":[{"type":"similarProduct"},{"type":"lookback","value":"30"}]}]}}]},"required":["targetingClauses","bidOptimization","costType"],"properties":{"products":{"type":"array","minItems":0,"maxItems":10000,"description":"A list of products to tailor bid recommendations for category and audience based targeting clauses.\nThis array must contain consistent fields of either asins or landing pages (when linking to other pages), these cannot be mixed for any given request.\nIf landingPageUrl is used, only one item is allowed for the list.","items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}},"example":[{"asin":"B00PN11UNW"}]},"bidOptimization":{"type":"string","description":"Determines what the recommended bids will be optimized for. \n\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks|cpc|Optimize for page visits|\n|conversions|cpc|Optimize for conversion|","enum":["reach","clicks","conversions"]},"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"creativeType":{"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. Only supports one type (VIDEO or IMAGE) at a time.","type":"string","nullable":true,"enum":["IMAGE","VIDEO"]},"targetingClauses":{"type":"array","minItems":1,"maxItems":100,"description":"A list of targeting clauses to receive bid recommendations for.","items":{"type":"object","required":["targetingClause"],"properties":{"targetingClause":{"description":"The targeting clause","required":["expressionType","expression"],"type":"object","properties":{"expressionType":{"description":"Tactic T00020 ad groups only allow manual targeting.","type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can only contain 'TargetingPredicate' or 'ContentTargetingPredicate' components.\n* Expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","minItems":1,"items":{"oneOf":[{"type":"object","description":"A predicate to match against in the Targeting Expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","required":["type"],"properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","required":["type","value"],"properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The exactProduct, similarProduct, relatedProduct, and negative types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.","required":["type"],"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","relatedProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","required":["type","value"],"properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"amzn1.iab-content.325"}}}]}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.3+json":{"schema":{"description":"Request for targeting bid recommendations.","example":{"products":[{"asin":"B01B8R6V2E"}],"bidOptimization":"reach","costType":"vcpm","creativeType":"VIDEO","targetingClauses":[{"targetingClause":{"expressionType":"manual","expression":[{"type":"views","value":[{"type":"similarProduct"},{"type":"lookback","value":"30"}]}]}}]},"required":["targetingClauses","bidOptimization","costType"],"properties":{"products":{"type":"array","minItems":0,"maxItems":10000,"description":"A list of products to tailor bid recommendations for category and audience based targeting clauses.","items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"bidOptimization":{"type":"string","description":"Determines what the recommended bids will be optimized for. \n\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks|cpc|Optimize for page visits|\n|conversions|cpc|Optimize for conversion|","enum":["reach","clicks","conversions"]},"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"creativeType":{"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. Only supports one type (VIDEO or IMAGE) at a time.","type":"string","nullable":true,"enum":["IMAGE","VIDEO"]},"targetingClauses":{"type":"array","minItems":1,"maxItems":100,"description":"A list of targeting clauses to receive bid recommendations for.","items":{"type":"object","required":["targetingClause"],"properties":{"targetingClause":{"description":"The targeting clause","required":["expressionType","expression"],"type":"object","properties":{"expressionType":{"description":"Tactic T00020 ad groups only allow manual targeting.","type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can only contain 'TargetingPredicate' components.\n* Expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","minItems":1,"items":{"oneOf":[{"type":"object","description":"A predicate to match against in the Targeting Expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","required":["type"],"properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","required":["type","value"],"properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The exactProduct, similarProduct, relatedProduct, and negative types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.","required":["type"],"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","relatedProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.2+json":{"schema":{"description":"Request for targeting bid recommendations.","example":{"products":[{"asin":"B01B8R6V2E"}],"bidOptimization":"reach","costType":"vcpm","targetingClauses":[{"targetingClause":{"expressionType":"manual","expression":[{"type":"views","value":[{"type":"similarProduct"},{"type":"lookback","value":"30"}]}]}}]},"required":["targetingClauses","bidOptimization","costType"],"properties":{"products":{"type":"array","minItems":0,"maxItems":10000,"description":"A list of products to tailor bid recommendations for category and audience based targeting clauses.","items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"bidOptimization":{"type":"string","description":"Determines what the recommended bids will be optimized for. \n\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks|cpc|Optimize for page visits|\n|conversions|cpc|Optimize for conversion|","enum":["reach","clicks","conversions"]},"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"targetingClauses":{"type":"array","minItems":1,"maxItems":100,"description":"A list of targeting clauses to receive bid recommendations for.","items":{"type":"object","required":["targetingClause"],"properties":{"targetingClause":{"description":"The targeting clause","required":["expressionType","expression"],"type":"object","properties":{"expressionType":{"description":"Tactic T00020 ad groups only allow manual targeting.","type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can only contain 'TargetingPredicate' components.\n* Expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","minItems":1,"items":{"oneOf":[{"type":"object","description":"A predicate to match against in the Targeting Expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","required":["type"],"properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","required":["type","value"],"properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The exactProduct, similarProduct, relatedProduct, and negative types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.","required":["type"],"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","relatedProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.1+json":{"schema":{"description":"Request for targeting bid recommendations.","example":{"products":[{"asin":"B01B8R6V2E"}],"targetingClauses":[{"targetingClause":{"expressionType":"manual","expression":[{"type":"views","value":[{"type":"similarProduct"},{"type":"lookback","value":"30"}]}]}}]},"required":["targetingClauses"],"properties":{"products":{"type":"array","minItems":0,"maxItems":10000,"description":"A list of products to tailor bid recommendations for category and audience based targeting clauses.","items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"targetingClauses":{"type":"array","minItems":1,"maxItems":100,"description":"A list of targeting clauses to receive bid recommendations for.","items":{"type":"object","required":["targetingClause"],"properties":{"targetingClause":{"description":"The targeting clause","required":["expressionType","expression"],"type":"object","properties":{"expressionType":{"description":"Tactic T00020 ad groups only allow manual targeting.","type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can only contain 'TargetingPredicate' components.\n* Expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","minItems":1,"items":{"oneOf":[{"type":"object","description":"A predicate to match against in the Targeting Expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","required":["type"],"properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","required":["type","value"],"properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The exactProduct, similarProduct, relatedProduct, and negative types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.","required":["type"],"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","relatedProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}}}}}}}}},"responses":{"207":{"description":"multi-status","content":{"application/vnd.sdtargetingrecommendations.v3.3+json":{"schema":{"description":"Response to a request for targeting bid recommendations.","required":["bidRecommendations","costType","bidOptimization"],"properties":{"bidOptimization":{"type":"string","description":"Determines what the recommended bids will be optimized for. \n\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks|cpc|Optimize for page visits|\n|conversions|cpc|Optimize for conversion|","enum":["reach","clicks","conversions"]},"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"bidRecommendations":{"minItems":1,"maxItems":100,"items":{"oneOf":[{"description":"A recommended bid range to use for a target.","required":["code"],"allOf":[{"description":"Success response for corresponding targeting clause on the request.","properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"200"}}},{"required":["rangeLower","rangeUpper","recommended"],"description":"A recommended bid range to use for a target.","properties":{"rangeLower":{"type":"number","description":"The lowest recommended bid to use to win an ad placement for this target.","example":0.5},"rangeUpper":{"type":"number","description":"The highest recommended bid to use to win an ad placement for this target.","example":1},"recommended":{"type":"number","description":"The recommended bid to use to win an ad placement for this target.","example":0.75}}}]},{"description":"Failed bid recommendation response.","required":["code","details"],"properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"400"},"details":{"type":"string","description":"A human-readable description of this item on error.","example":"Targeting expression does not conform to language specific rules."}}}]}}}}},"application/vnd.sdtargetingrecommendations.v3.2+json":{"schema":{"description":"Response to a request for targeting bid recommendations.","required":["bidRecommendations","costType","bidOptimization"],"properties":{"bidOptimization":{"type":"string","description":"Determines what the recommended bids will be optimized for. \n\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks|cpc|Optimize for page visits|\n|conversions|cpc|Optimize for conversion|","enum":["reach","clicks","conversions"]},"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"bidRecommendations":{"minItems":1,"maxItems":100,"items":{"oneOf":[{"description":"A recommended bid range to use for a target.","required":["code"],"allOf":[{"description":"Success response for corresponding targeting clause on the request.","properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"200"}}},{"required":["rangeLower","rangeUpper","recommended"],"description":"A recommended bid range to use for a target.","properties":{"rangeLower":{"type":"number","description":"The lowest recommended bid to use to win an ad placement for this target.","example":0.5},"rangeUpper":{"type":"number","description":"The highest recommended bid to use to win an ad placement for this target.","example":1},"recommended":{"type":"number","description":"The recommended bid to use to win an ad placement for this target.","example":0.75}}}]},{"description":"Failed bid recommendation response.","required":["code","details"],"properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"400"},"details":{"type":"string","description":"A human-readable description of this item on error.","example":"Targeting expression does not conform to language specific rules."}}}]}}}}},"application/vnd.sdtargetingrecommendations.v3.1+json":{"schema":{"description":"Response to a request for targeting bid recommendations.","required":["bidRecommendations","costType"],"properties":{"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"bidRecommendations":{"minItems":1,"maxItems":100,"items":{"oneOf":[{"description":"A recommended bid range to use for a target.","required":["code"],"allOf":[{"description":"Success response for corresponding targeting clause on the request.","properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"200"}}},{"required":["rangeLower","rangeUpper","recommended"],"description":"A recommended bid range to use for a target.","properties":{"rangeLower":{"type":"number","description":"The lowest recommended bid to use to win an ad placement for this target.","example":0.5},"rangeUpper":{"type":"number","description":"The highest recommended bid to use to win an ad placement for this target.","example":1},"recommended":{"type":"number","description":"The recommended bid to use to win an ad placement for this target.","example":0.75}}}]},{"description":"Failed bid recommendation response.","required":["code","details"],"properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"400"},"details":{"type":"string","description":"A human-readable description of this item on error.","example":"Targeting expression does not conform to language specific rules."}}}]}}}}}}},"400":{"description":"Generic bad request error.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Bid%20Recommendations/operation/getTargetBidRecommendations","sectionHeader":{"type":3,"text":"POST /sd/targets/bid/recommendations"},"summary":"Returns a set of bid recommendations for targeting clauses","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/recommendations/creative/headline",{"requestBody":{"description":"Request body for SD headline recommendations API.","content":{"application/vnd.sdheadlinerecommendationrequest.v4.0+json":{"schema":{"description":"Request structure of SD headline recommendation API.","type":"object","properties":{"asins":{"minItems":1,"maxItems":100,"description":"An array of ASINs associated with the creative.","type":"array","items":{"type":"string"}},"maxNumRecommendations":{"description":"Maximum number of recommendations that API should return. Response will [0, maxNumRecommendations] recommendations (recommendations are not guaranteed as there can be instances where the ML model can not generate policy compliant headlines for the given set of asins).","maximum":10,"type":"number","minimum":1},"adFormat":{"type":"string","enum":["SPONSORED_DISPLAY"]}}}}},"required":true},"description":"You can use this Sponsored Display API to retrieve creative headline recommendations from an array of ASINs.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"getHeadlineRecommendationsForSD","responses":{"200":{"description":"Successful operation.","content":{"application/vnd.sdheadlinerecommendationresponse.v4.0+json":{"schema":{"description":"Response structure of SD headline recommendation API.","type":"object","properties":{"requestId":{"description":"An identifier for request made which is generated by server.","type":"string"},"recommendations":{"minItems":1,"maxItems":10,"description":"Recommendations are sorted, i.e., more suitable headline has lesser array index value.","type":"array","items":{"description":"Recommended Headline in response object. Recommended headline will be locale specific, i.e. for an asin input in ES, Recommended headline will be in ES.","type":"object","properties":{"headlineId":{"description":"Unique Id of Recommended headline.","type":"string","example":"e991e32c-0136-427a-843b-ff04162f2f91"},"headline":{"description":"String that contains Recommended headline.","type":"string","maxLength":50,"example":"This is a Recommended headline."}}}}}}}}},"400":{"description":"SchemaValidationException 400 response.","content":{"application/vnd.sdheadlinerecommendationschemavalidationexception.v4.0+json":{"schema":{"type":"object","properties":{"code":{"description":"InvalidArgumentErrorCode.","type":"string","enum":["INVALID_ARGUMENT"]},"details":{"description":"A human-readable description of the error response.","type":"string"}}}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sdheadlinerecommendationaccessdeniedexception.v4.0+json":{"schema":{"type":"object","properties":{"code":{"description":"AccessDeniedErrorCode.","type":"string","enum":["ACCESS_DENIED"]},"details":{"description":"A human-readable description of the error response.","type":"string"}}}}}},"404":{"description":"IdentifierNotFoundException 404 response.","content":{"application/vnd.sdheadlinerecommendationidentifiernotfoundexception.v4.0+json":{"schema":{"type":"object","properties":{"code":{"description":"IdentiferNotFoundErrorCode.","type":"string","enum":["IDENTIFIER_NOT_FOUND"]},"details":{"description":"A human-readable description of the error response.","type":"string"}}}}}},"429":{"description":"ThrottlingException 429 response.","content":{"application/vnd.sdheadlinerecommendationthrottlingexception.v4.0+json":{"schema":{"type":"object","properties":{"code":{"description":"ThrottledErrorCode.","type":"string","enum":["THROTTLED"]},"details":{"description":"A human-readable description of the error response.","type":"string"}}}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sdheadlinerecommendationinternalserverexception.v4.0+json":{"schema":{"type":"object","properties":{"code":{"description":"InternalErrorCode.","type":"string","enum":["INTERNAL_ERROR"]},"details":{"description":"A human-readable description of the error response.","type":"string"}}}}}}},"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"tags":["Headline Recommendations"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Headline%20Recommendations/operation/getHeadlineRecommendationsForSD","sectionHeader":{"type":3,"text":"POST /sd/recommendations/creative/headline"},"documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/optimizationRules",{"tags":["Optimization Rules (beta)"],"summary":"Gets a list of optimization rules.","description":"Gets an array of OptimizationRule objects for a requested set of Sponsored Display optimization rules.","operationId":"listOptimizationRules","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of optimization rules. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of OptimizationRule objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten optimization rules set `startIndex=0` and `count=10`. To return the next ten optimization rules, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only optimization rules with state set to one of the values in the specified comma-delimited list.\nAvailable values:\n  - enabled\n  - paused [COMING LATER]\n  - enabled, paused [COMING LATER]","schema":{"type":"string","default":"enabled"}},{"name":"name","in":"query","description":"Optional. The returned array includes only optimization rules with the specified name using an exact string match.","schema":{"type":"string"}},{"name":"optimizationRuleIdFilter","in":"query","description":"Optional. The returned array is filtered to include only optimization rules associated with the optimization rule identifiers in the specified comma-delimited list.\n\nMaximum size limit 50.","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional. The returned array is filtered to include only optimization rules associated with the ad group identifiers in the comma-delimited list.\n\nMaximum size limit 50.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}},{"type":"object","properties":{"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)/operation/listOptimizationRules","sectionHeader":{"type":3,"text":"GET /sd/optimizationRules"},"summary":"Gets a list of optimization rules.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/optimizationRules",{"tags":["Optimization Rules (beta)"],"summary":"Updates one or more optimization rules.","operationId":"updateOptimizationRules","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of OptimizationRule objects. For each object, specify an optimization rule identifier and mutable fields with their updated values. The mutable fields are `ruleName`, `state`, and `ruleConditions`.","content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"required":["ruleId"],"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}},{"type":"object","properties":{"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)/operation/updateOptimizationRules","sectionHeader":{"type":3,"text":"PUT /sd/optimizationRules"},"summary":"Updates one or more optimization rules.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/optimizationRules",{"tags":["Optimization Rules (beta)"],"summary":"Creates one or more optimization rules, also known as outcome optimizations.","description":"\n* When an optimization rule is associated to an ad group, manual bids for individual targets will be overridden.\n* Optimization rules can only be associated to ad groups that have productAds with ASIN or SKU.\n* We may add targets while your campaign is running to try to stay at or below a cost per order value you have specified.\n* Only one optimization rule can be associated per adGroup. \n* If you are using optimization rules, the following campaign budget must be at least:\n  - 5x the value of any COST_PER_ORDER threshold.\n  - 10x the value of any COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS threshold.\n  - 20x the value of any COST_PER_CLICK threshold.","operationId":"createOptimizationRules","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of OptimizationRule objects. For each object, specify required fields and their values. Required fields are `state` and `ruleConditions`.","content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"example":{"state":"enabled","ruleName":"Optimization Rule Name","ruleConditions":[{"metricName":"COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","comparisonOperator":"LESS_THAN_OR_EQUAL_TO","threshold":1.5}]},"required":["state","ruleConditions"],"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)/operation/createOptimizationRules","sectionHeader":{"type":3,"text":"POST /sd/optimizationRules"},"summary":"Creates one or more optimization rules, also known as outcome optimizations.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/optimizationRules/{optimizationRuleId}",{"tags":["Optimization Rules (beta)"],"summary":"Gets a requested optimization rule.","description":"Gets an OptimizationRule object for a requested Sponsored Display optimization rule.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"optimizationRuleId","in":"path","description":"The identifier of the requested optimization rule.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}},{"type":"object","properties":{"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)","sectionHeader":{"type":3,"text":"GET /sd/optimizationRules/{optimizationRuleId}"},"summary":"Gets a requested optimization rule.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/{adGroupId}/optimizationRules",{"tags":["Optimization Rules (beta)"],"summary":"Associate one or more optimization rules to an ad group specified by identifier.","description":"\n* When an optimization rule is associated to an ad group, manual bids for individual targets will be overridden.\n* Only one optimization rule can be associated per adGroup. This note will be removed when multiple rules are supported per adGroup.","operationId":"associateOptimizationRulesWithAdGroup","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"A list of optimization rule identifiers. Only one optimization rule identifier is currently supported per request. This note will be removed when multiple rule identifiers are supported.\n\nFor each ad group, only one optimization rule metric name is supported, based on the ad group's `bidOptimization` type. Refer to the following table for the metric names supported for each type.\n|  AdGroup.bidOptimization |     Supported OptimizationRule.metricName       |\n|------------------|--------------------|\n|   reach       | COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  |\n|   clicks      | COST_PER_CLICK          |\n|  conversions  | COST_PER_ORDER          |","content":{"application/json":{"schema":{"type":"object","properties":{"optimizationRuleIds":{"type":"array","description":"A list of optimization rule identifiers.","minItems":1,"maxItems":1,"items":{"type":"string","description":"The identifier of the optimization rule."}}}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)/operation/associateOptimizationRulesWithAdGroup","sectionHeader":{"type":3,"text":"POST /sd/adGroups/{adGroupId}/optimizationRules"},"summary":"Associate one or more optimization rules to an ad group specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/{adGroupId}/optimizationRules",{"tags":["Optimization Rules (beta)"],"summary":"Gets a list of optimization rules associated to an adgroup specified by identifier.","description":"Gets an OptimizationRule object for a requested Sponsored Display optimization rule.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}},{"type":"object","properties":{"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)","sectionHeader":{"type":3,"text":"GET /sd/adGroups/{adGroupId}/optimizationRules"},"summary":"Gets a list of optimization rules associated to an adgroup specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/{adGroupId}/optimizationRules/disassociate",{"tags":["Optimization Rules (beta)"],"summary":"Disassociate one or more optimization rules from an ad group specified by identifier.","description":"\n* Only one optimization rule can be disassociated per adGroup. This note will be removed when multiple rules are supported per adGroup.\n* When an optimization rule is disassociated from an ad group, you can set the manual bids for the individual targets under the adGroup.","operationId":"disassociateOptimizationRulesFromAdGroup","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"A list of optimization rule identifiers. Only one optimization rule identifier is currently supported per request. This note will be removed when multiple rule identifiers are supported.","content":{"application/json":{"schema":{"type":"object","properties":{"optimizationRuleIds":{"type":"array","description":"A list of optimization rule identifiers.","minItems":1,"maxItems":1,"items":{"type":"string","description":"The identifier of the optimization rule."}}}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"responses":{"type":"array","description":"An array of response objects. Each response object has code, details and optimizationRuleId.","maxItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."},"optimizationRuleId":{"type":"string","description":"The identifier of the optimization rule."}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)/operation/disassociateOptimizationRulesFromAdGroup","sectionHeader":{"type":3,"text":"POST /sd/adGroups/{adGroupId}/optimizationRules/disassociate"},"summary":"Disassociate one or more optimization rules from an ad group specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/forecasts",{"tags":["Forecasts"],"summary":"Return forecasts for an ad group that may or may not exist.","requestBody":{"content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"type":"object","description":"Request payload for SD forecasting. Below are required and optional fields. Fields not listed will not impact forecast results.\n|Field              |Object            |Required|\n|-------------------|------------------|--------|\n|startDate          |Campaign          |required|\n|endDate            |Campaign          |optional|\n|costType           |Campaign          |optional|\n|bidOptimization    |AdGroup           |required|\n|creativeType       |AdGroup           |optional|\n|defaultBid         |AdGroup           |optional|\n|asin               |ProductAds        |required for vendors|\n|sku                |ProductAds        |required for sellers|\n|bid                |TargetingClauses  |required when defaultBid is not set|\n|expression         |TargetingClauses  |required|\n|ruleConditions     |OptimizationRules |optional|","required":["campaign","adGroup","productAds","targetingClauses"],"properties":{"campaign":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double","example":"3.00"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future.","example":"20190101"},"endDate":{"type":"string","nullable":true,"description":"The YYYYMMDD end date of the campaign.","example":null},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |\n\nTo view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","enum":["cpc","vcpm"]},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","format":"int64","nullable":true,"description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","example":null}}},{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"deliveryProfile":{"type":"string","enum":["as_soon_as_possible"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}}}}]},"adGroup":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"bidOptimization":{"type":"string","description":"Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks |cpc|[Default] Optimize for page visits.|\n|conversions |cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"state":{"type":"string","description":"The state of the ad group.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"creativeType":{"type":"string","nullable":true,"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]}}}]},"optimizationRules":{"type":"array","minItems":0,"maxItems":100,"description":"A list of SD optimization rules. Forecast will be affected by the optimization strategy rules.  Currently, supported rule metrics by forecast are `COST_PER_CLICK`, `COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS` and `COST_PER_ORDER`.","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}},{"type":"object","properties":{"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}]}},"productAds":{"type":"array","minItems":1,"maxItems":100,"items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the campaign associated with the product ad.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adId":{"type":"integer","format":"int64","description":"The identifier of the product ad."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The Amazon ASIN of the product advertised by the product ad. This parameter is included in the response for sellers and vendors."},"sku":{"type":"string","description":"The Amazon SKU of the product advertised by the product ad. This parameter is included in the response for sellers."}}}]}},"targetingClauses":{"minItems":1,"maxItems":100,"description":"A list of SD targeting clauses.","type":"array","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the [\"Bid constraints by marketplace\" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.","format":"float","nullable":true,"minimum":0.02}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expressionType":{"type":"string","enum":["manual","auto"],"description":"Tactic T00020 & T00030 ad groups should use 'manual' targeting."},"expression":{"type":"array","description":"The targeting expression to match against.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"resolvedExpression":{"type":"array","description":"The resolved targeting expression.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}]}},"negativeTargetingClauses":{"minItems":1,"maxItems":100,"description":"A list of SD negative targeting clauses.","type":"array","items":{"allOf":[{"properties":{"state":{"type":"string","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expressionType":{"type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"resolvedExpression":{"type":"array","description":"The resolved negative targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}}}}]}},"locationExpressions":{"minItems":0,"maxItems":100,"description":"A list of location expressions. Only applicable for advertisers using landingPageType of OFF_AMAZON_LINK.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.","example":"amzn1.ad-geo.XHvCjcKHXmJ7woVowo7CjmvCjcKWbMKHwp3CsGvCk8KrcmstQ2l0eQ=="}}}}}}}}},"operationId":"createSDForecast","description":"Returns forecasts for a given ad group specified in SD forecast request.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"description":"Response to a request for SD forecasting.","type":"object","properties":{"bidOptimization":{"type":"string"},"lifetimeForecasts":{"description":"Forecasts for campaign start date and end date. Default end date is start date plus 7 days.","type":"array","minItems":1,"maxItems":4,"items":{"description":"Forecast impressions, clicks, reach, or conversions.","type":"object","properties":{"metric":{"type":"string","description":"Describes which metric is forecasted.\n|Name|Description|\n|-----------|------------------------|\n|IMPRESSIONS| Available impressions|\n|REACH      | Delivered viewable impressions|\n|CLICKS     | Delivered page visits|\n|CONVERSIONS| [Preview only] Delivered conversions|","enum":["IMPRESSIONS","REACH","CLICKS","CONVERSIONS"]},"value":{"description":"Forecast range values.","properties":{"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}}},"weeklyForecasts":{"description":"Weekly average forecasts.","type":"array","minItems":1,"maxItems":4,"items":{"description":"Forecast impressions, clicks, reach, or conversions.","type":"object","properties":{"metric":{"type":"string","description":"Describes which metric is forecasted.\n|Name|Description|\n|-----------|------------------------|\n|IMPRESSIONS| Available impressions|\n|REACH      | Delivered viewable impressions|\n|CLICKS     | Delivered page visits|\n|CONVERSIONS| [Preview only] Delivered conversions|","enum":["IMPRESSIONS","REACH","CLICKS","CONVERSIONS"]},"value":{"description":"Forecast range values.","properties":{"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}}},"dailyForecasts":{"description":"Daily average forecasts.","type":"array","minItems":1,"maxItems":4,"items":{"description":"Forecast impressions, clicks, reach, or conversions.","type":"object","properties":{"metric":{"type":"string","description":"Describes which metric is forecasted.\n|Name|Description|\n|-----------|------------------------|\n|IMPRESSIONS| Available impressions|\n|REACH      | Delivered viewable impressions|\n|CLICKS     | Delivered page visits|\n|CONVERSIONS| [Preview only] Delivered conversions|","enum":["IMPRESSIONS","REACH","CLICKS","CONVERSIONS"]},"value":{"description":"Forecast range values.","properties":{"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}}},"curves":{"description":"Forecasting curves.","type":"array","minItems":0,"maxItems":10,"items":{"description":"Forecast curve of a certain type. The type could be budget vs forecast outcome.","type":"object","properties":{"meetThreshold":{"type":"boolean","description":"True if the budget utilization is good to show the curve."},"graph":{"type":"string","description":"Type of Graph.","enum":["BUDGET"]},"points":{"type":"array","minItems":50,"maxItems":100,"items":{"description":"A single point on a curve.","type":"object","properties":{"isFocus":{"type":"boolean","description":"If this point is the point with the focus circle."},"x":{"type":"object","description":"x-axis value.","items":{"type":"object","properties":{"value":{"type":"number","format":"double"}}}},"y":{"type":"array","description":"y-axis value of multiple KPI types.","minItems":0,"maxItems":2,"items":{"description":"A ranged value.","type":"object","properties":{"label":{"type":"string","description":"KPI label.","enum":["CLICKS","REACH"]},"value":{"description":"A range of value.","type":"object","properties":{"min":{"type":"number","format":"double","description":"Lower bound."},"mean":{"type":"number","format":"double","description":"Geometric mean of the upper and lower bounds."},"max":{"type":"number","format":"double","description":"Upper bound."}}}}}}}}}}}},"forecastStatus":{"description":"It contains the forecast status. The IMPRESSION_TARGETING_TOO_NARROW field means the targeting  clauses are too narrow, and the IMPRESSION_TARGETING_TOO_BROAD field means the targeting clauses are too broad,  so our inventory impression forecast won't provide any useful information. The COMPLETE field means all the forecasts are complete.","type":"string","enum":["IMPRESSION_TARGETING_TOO_NARROW","IMPRESSION_TARGETING_TOO_BROAD","COMPLETE"]}}}}}},"400":{"description":"Bad Request.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Forecasts/operation/createSDForecast","sectionHeader":{"type":3,"text":"POST /sd/forecasts"},"summary":"Return forecasts for an ad group that may or may not exist.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/budgetRules/{budgetRuleId}",{"summary":"Gets a budget rule specified by identifier.","operationId":"GetBudgetRuleByRuleIdForSDCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"budgetRule":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"description":"Object representing details of a budget rule for SD campaign","type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss'","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time.","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["ACOS","CTR","CVR","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/GetBudgetRuleByRuleIdForSDCampaigns","sectionHeader":{"type":3,"text":"GET /sd/budgetRules/{budgetRuleId}"},"summary":"Gets a budget rule specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/budgetRules",{"summary":"Creates one or more budget rules.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"budgetRulesDetails":{"maxItems":25,"description":"A list of budget rule details.","type":"array","items":{"description":"Object representing details of a budget rule for SD campaign","type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss'","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time.","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["ACOS","CTR","CVR","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}}}}}}},"required":true},"operationId":"CreateBudgetRulesForSDCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The rule identifier.","type":"string"},"associatedCampaignIds":{"type":"array","items":{"description":"The campaign identifier for which rule based budget may get updated","type":"string"}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetRuleError - Something went wrong on the server. Retry later and report an BudgetRuleError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/CreateBudgetRulesForSDCampaigns","sectionHeader":{"type":3,"text":"POST /sd/budgetRules"},"summary":"Creates one or more budget rules.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/budgetRules",{"summary":"Get all budget rules created by an advertiser","operationId":"GetSDBudgetRulesForAdvertiser","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"budgetRulesForAdvertiserResponse":{"minItems":0,"maxItems":30,"description":"A list of rules created by the advertiser.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"description":"Object representing details of a budget rule for SD campaign","type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss'","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time.","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["ACOS","CTR","CVR","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"query","name":"nextToken","description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results."},{"schema":{"type":"number"},"in":"query","name":"pageSize","description":"Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/GetSDBudgetRulesForAdvertiser","sectionHeader":{"type":3,"text":"GET /sd/budgetRules"},"summary":"Get all budget rules created by an advertiser","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/budgetRules",{"summary":"Update one or more budget rules.","requestBody":{"content":{"application/json":{"schema":{"description":"Request object for updating budget rule for SD campaign","type":"object","properties":{"budgetRulesDetails":{"maxItems":25,"description":"A list of budget rule details.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"description":"Object representing details of a budget rule for SD campaign","type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss'","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time.","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["ACOS","CTR","CVR","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}}}}}},"required":true},"operationId":"UpdateBudgetRulesForSDCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The rule identifier.","type":"string"},"associatedCampaignIds":{"type":"array","items":{"description":"The campaign identifier for which rule based budget may get updated","type":"string"}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetRuleError - Something went wrong on the server. Retry later and report an BudgetRuleError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/UpdateBudgetRulesForSDCampaigns","sectionHeader":{"type":3,"text":"PUT /sd/budgetRules"},"summary":"Update one or more budget rules.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/budgetRules/{budgetRuleId}/campaigns",{"summary":"Gets all the campaigns associated with a budget rule","operationId":"GetCampaignsAssociatedWithSDBudgetRule","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"associatedCampaigns":{"minItems":0,"maxItems":30,"description":"A list of campaigns that are associated to this budget rule.","type":"array","items":{"type":"object","required":["campaignId","campaignName","ruleStatus"],"properties":{"campaignId":{"description":"The campaign identifier.","type":"string"},"ruleStatus":{"description":"The budget rule evaluation status for this campaign. Read-only.","type":"string"},"campaignName":{"description":"The campaign name.","type":"string"}}}},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true},{"schema":{"type":"string"},"in":"query","name":"nextToken","description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results."},{"schema":{"type":"number"},"in":"query","name":"pageSize","description":"Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/GetCampaignsAssociatedWithSDBudgetRule","sectionHeader":{"type":3,"text":"GET /sd/budgetRules/{budgetRuleId}/campaigns"},"summary":"Gets all the campaigns associated with a budget rule","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/{campaignId}/budgetRules/{budgetRuleId}",{"summary":"Disassociates a budget rule specified by identifier from a campaign specified by identifier.","operationId":"DisassociateAssociatedBudgetRuleForSDCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/DisassociateAssociatedBudgetRuleForSDCampaigns","sectionHeader":{"type":3,"text":"DELETE /sd/campaigns/{campaignId}/budgetRules/{budgetRuleId}"},"summary":"Disassociates a budget rule specified by identifier from a campaign specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/{campaignId}/budgetRules",{"summary":"Associates one or more budget rules to a campaign specified by identifer.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"budgetRuleIds":{"maxItems":25,"description":"A list of budget rule identifiers.","type":"array","items":{"type":"string"}}}}}},"required":true},"description":"A maximum of 250 rules can be associated to a campaign. Note that the name of each rule associated to a campaign is required to be unique.","operationId":"CreateAssociatedBudgetRulesForSDCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of associated budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The budget rule identifier.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/CreateAssociatedBudgetRulesForSDCampaigns","sectionHeader":{"type":3,"text":"POST /sd/campaigns/{campaignId}/budgetRules"},"summary":"Associates one or more budget rules to a campaign specified by identifer.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/{campaignId}/budgetRules",{"summary":"Gets a list of budget rules associated to a campaign specified by identifier.","operationId":"ListAssociatedBudgetRulesForSDCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"associatedRules":{"description":"A list of associated budget rules.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"description":"Object representing details of a budget rule for SD campaign","type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss'","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time.","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["ACOS","CTR","CVR","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/ListAssociatedBudgetRulesForSDCampaigns","sectionHeader":{"type":3,"text":"GET /sd/campaigns/{campaignId}/budgetRules"},"summary":"Gets a list of budget rules associated to a campaign specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/budget/usage",{"summary":"Budget usage API for SD campaigns","description":"**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","tags":["Budget Usage"],"requestBody":{"content":{"application/vnd.sdcampaignbudgetusage.v1+json":{"schema":{"type":"object","properties":{"campaignIds":{"minItems":1,"maxItems":100,"description":"A list of campaign IDs","type":"array","items":{"type":"string"}}}}}}},"operationId":"sdCampaignsBudgetUsage","responses":{"207":{"description":"Multi-status. An object containing a list of budget usage response objects reflecting the same order as the input.","content":{"application/vnd.sdcampaignbudgetusage.v1+json":{"schema":{"type":"object","properties":{"success":{"description":"List of budget usage percentages that were successfully pulled","type":"array","items":{"type":"object","properties":{"budgetUsagePercent":{"description":"Budget usage percentage (spend / available budget) for the given budget policy.","type":"number"},"campaignId":{"description":"ID of requested resource","type":"string"},"usageUpdatedTimestamp":{"format":"date-time","description":"Last evaluation time for budget usage","type":"string"},"index":{"description":"An index to maintain order of the campaignIds","type":"number"},"budget":{"description":"Budget amount of resource requested","type":"number"}}}},"error":{"description":"List of budget usage percentages that failed to pull","type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"campaignId":{"description":"ID of requested resource","type":"string"},"index":{"description":"An index to maintain order of the campaignIds","type":"number"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetUsageError - Something went wrong on the server. Retry later and report an BudgetUsageError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Usage/operation/sdCampaignsBudgetUsage","sectionHeader":{"type":3,"text":"POST /sd/campaigns/budget/usage"},"summary":"Budget usage API for SD campaigns","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/locations",{"tags":["Locations (beta)"],"summary":"Gets a list of locations associated with ad groups.","description":"Gets a list of Sponsored Display Location objects. This resource is not available when productAds have ASIN or SKU fields and only available for advertisers that do not sell products on Amazon. See [Developer Guide](https://advertising.amazon.com/API/docs/en-us/guides/sponsored-display/non-amazon-sellers/get-started)","operationId":"listLocations","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. 0-indexed record offset for the result set. Defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Number of records to include in the paged response. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. Restricts results to those with state within the specified comma-separated list. Must be one of: `enabled`.","schema":{"type":"string","enum":["enabled"],"default":"enabled"}},{"name":"adGroupIdFilter","in":"query","description":"Optional list of comma separated adGroupIds. Restricts results to locations with the specified `adGroupId`.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional list of comma separated campaignIds. Restricts results to locations with the specified `campaignId`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"properties":{"state":{"type":"string","enum":["enabled"]}}},{"type":"object","properties":{"locationExpressionId":{"type":"integer","format":"int64","description":"The identifier of the location."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expression":{"type":"array","description":"The Location definition.","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.","example":"amzn1.ad-geo.XHvCjcKHXmJ7woVowo7CjmvCjcKWbMKHwp3CsGvCk8KrcmstQ2l0eQ=="}}}},"resolvedExpression":{"type":"array","description":"The human-readable location definition.","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The human-readable location name.","example":"New York City, New York, US"}}}}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Locations%20(beta)/operation/listLocations","sectionHeader":{"type":3,"text":"GET /sd/locations"},"summary":"Gets a list of locations associated with ad groups.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/locations",{"tags":["Locations (beta)"],"summary":"Creates one or more locations associated with an ad group.","description":"This resource is not available when productAds have ASIN or SKU fields and only available for advertisers that do not sell products on Amazon.   See [Developer Guide](https://advertising.amazon.com/API/docs/en-us/guides/sponsored-display/non-amazon-sellers/get-started)\n\nLocations optimize Ad Groups for delivery to users that have an association with those locations. For example,\nan Ad Group might contain the following: \n- A Targeting Clause representing an audience of users that viewed a shoe \n- A Location representing Seattle, Washington, USA.\n- A Location representing New York, New York, USA.\nIn this case, delivery of the Targeting Clause will be optimized for New York and Seattle.\n\n\nYou can discover predefined Locations to use in your ad group by calling the GET /locations API. The table below lists \nseveral example Locations.\n| Location | Description |\n|---------------------------|-------------|\n| location=amzn1.ad-geo.XHvCjcKHXsKUwos= | Optimize the ad group for the specified location (either a 'city', 'state', 'dma', 'postal code', or 'country').|\n\nUsing locations is optional. ","operationId":"createLocations","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of up to 100 Locations for creation for each call.  1000 locations can be added for each ad group.","content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":20,"items":{"required":["adGroupId","expression","state"],"allOf":[{"properties":{"state":{"type":"string","enum":["enabled"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expression":{"type":"array","description":"The location definition.","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.","example":"amzn1.ad-geo.XHvCjcKHXmJ7woVowo7CjmvCjcKWbMKHwp3CsGvCk8KrcmstQ2l0eQ=="}}}}}}]}}}},"required":false},"responses":{"200":{"description":"An array of Locations.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"properties":{"state":{"type":"string","enum":["enabled"]}}},{"type":"object","properties":{"locationExpressionId":{"type":"integer","format":"int64","description":"The identifier of the location."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expression":{"type":"array","description":"The Location definition.","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.","example":"amzn1.ad-geo.XHvCjcKHXmJ7woVowo7CjmvCjcKWbMKHwp3CsGvCk8KrcmstQ2l0eQ=="}}}},"resolvedExpression":{"type":"array","description":"The human-readable location definition.","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The human-readable location name.","example":"New York City, New York, US"}}}}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"a-pplication/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Locations%20(beta)/operation/createLocations","sectionHeader":{"type":3,"text":"POST /sd/locations"},"summary":"Creates one or more locations associated with an ad group.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/locations/delete",{"tags":["Locations (beta)"],"summary":"Sets the `state` of each Location clause given to `archived`.","description":"This is a bulk operation that accepts up to a limit of 1000 Location Expression Ids at a time.\nThis deletion operation is equivalent to using the `updateTargetingClauses` operation to set the `state` property of a Location clause to `archived`.","operationId":"archiveLocations","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of up to 1000 Location Expression Ids for archival.","content":{"application/json":{"schema":{"description":"Request body for the Archive Locations API","type":"object","required":["LocationExpressionIdFilter"],"properties":{"locationExpressionIdFilter":{"description":"Filter entities by the list of objectIds","required":["include"],"properties":{"include":{"description":"Array of Location Expression Ids","type":"array","minItems":1,"maxItems":1000,"items":{"type":"integer","format":"int64","description":"The identifier of the location."}}}}}}}},"required":true},"responses":{"207":{"description":"An array response containing a response for each Location Expression","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Returns \"SUCCESS\" for a successful response, otherwise a HTTP error code"},"description":{"type":"string","description":"A human-readable description of the response if there is an error"},"locationExpressionId":{"type":"integer","format":"int64","description":"The identifier of the location."}}}}}}},"400":{"description":"Bad Request - Request failed because payload is empty, includes invalid types, or exceeds batch limit.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"a-pplication/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Locations%20(beta)/operation/archiveLocations","sectionHeader":{"type":3,"text":"POST /sd/locations/delete"},"summary":"Sets the `state` of each Location clause given to `archived`.","documentType":"api-reference"},{"title":"Amazon Ads API for DSP","content":["Retrieve information of DSP advertisers.\n"],"path":"/en-us/dsp-advertiser","sectionHeader":{"type":2,"text":"Amazon Ads API for DSP"},"documentType":"api-reference"},{"title":"Amazon Ads API for DSP","content":["/dsp/advertisers/{advertiserId}",{"description":"Returns advertiser information based on given advertiser id.","tags":["Advertiser"],"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The client identifier of the customer making the request.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"advertiserId","in":"path","description":"Unique id to identify advertiser","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","description":"The DSP Advertiser object","properties":{"advertiserId":{"type":"string","description":"The advertiser identifier.","example":"4728736040201"},"name":{"type":"string","description":"The advertiser name.","example":"DSP Public API Advertiser"},"currency":{"type":"string","description":"The supported currencies.","enum":["USD","CAD","JPY","GBP","EUR","INR","MXN","AED","SAR","BRL","AUD","SEK","SGD","TRY"],"example":"USD"},"url":{"type":"string","description":"The URL of the advertiser’s website.","example":"www.example.com"},"country":{"type":"string","description":"The country code.","enum":["US","CA","MX","JP","AU","IN","UK","GB","DE","FR","IT","ES","AT","AE","SA","BR","NL","SE","SG","TR"],"example":"US"},"timezone":{"type":"string","description":"The advertiser timezone.\n- America/Anchorage\n- America/Caracas\n- America/Chicago\n- America/Denver\n- America/Halifax\n- America/Los_Angeles\n- America/New_York\n- America/Sao_Paulo\n- America/St_Johns\n- Asia/Almaty\n- Asia/Baghdad\n- Asia/Bangkok\n- Asia/Hong_Kong\n- Asia/Kabul\n- Asia/Kathmandu\n- Asia/Kolkata\n- Asia/Magadan\n- Asia/Shanghai\n- Asia/Tehran\n- Asia/Tokyo\n- Asia/Yekaterinburg\n- Asia/Yerevan\n- Atlantic/Azores\n- Atlantic/South_Georgia\n- Australia/Brisbane\n- Australia/Darwin\n- Europe/London\n- Europe/Paris\n- Indian/Cocos\n- Pacific/Fiji\n- Pacific/Honolulu\n- Pacific/Kwajalein\n- Pacific/Midway\n"},"isRegional":{"type":"boolean","description":"Set to `true` if account is associated with a Global Advertiser Account.","example":false}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"422":{"description":"Unprocessable entity - Failed due to invalid parameters.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Validation Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"DSP_INVALID_PATH_PARAM","field":"advertiserId","message":"AdvertiserId must be a valid numeric id."}]}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-advertiser#tag/Advertiser","sectionHeader":{"type":3,"text":"GET /dsp/advertisers/{advertiserId}"},"documentType":"api-reference"},{"title":"Amazon Ads API for DSP","content":["/dsp/advertisers",{"description":"Returns a list of advertisers with information which satisfy the filtering criteria.","tags":["Advertiser"],"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The client identifier of the customer making the request.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Sets a cursor into the requested set of advertisers. Use in conjunction with the count parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32","maximum":29900,"default":0}},{"name":"count","in":"query","description":"Sets the number of advertisers to be returned in a single call. Maximum of 100 advertisers per call.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":100}},{"name":"advertiserIdFilter","in":"query","description":"List of comma separated advertiser ids to filter the advertisers. If no advertiser ids provided, all advertisers in this entity will be returned.","schema":{"type":"string"},"example":"6753579448901,8753890875385"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","description":"List of advertisers along with total number of advertisers which satisfy the filtering criteria.","properties":{"totalResults":{"type":"integer","format":"int32","description":"Total number of advertisers which satisfy the filtering criteria. This number is given to support pagination and tell the client if there are more advertisers to be fetched.","example":1100},"response":{"type":"array","description":"List of advertisers with complete information.","items":{"type":"object","description":"The DSP Advertiser object","properties":{"advertiserId":{"type":"string","description":"The advertiser identifier.","example":"4728736040201"},"name":{"type":"string","description":"The advertiser name.","example":"DSP Public API Advertiser"},"currency":{"type":"string","description":"The supported currencies.","enum":["USD","CAD","JPY","GBP","EUR","INR","MXN","AED","SAR","BRL","AUD","SEK","SGD","TRY"],"example":"USD"},"url":{"type":"string","description":"The URL of the advertiser’s website.","example":"www.example.com"},"country":{"type":"string","description":"The country code.","enum":["US","CA","MX","JP","AU","IN","UK","GB","DE","FR","IT","ES","AT","AE","SA","BR","NL","SE","SG","TR"],"example":"US"},"timezone":{"type":"string","description":"The advertiser timezone.\n- America/Anchorage\n- America/Caracas\n- America/Chicago\n- America/Denver\n- America/Halifax\n- America/Los_Angeles\n- America/New_York\n- America/Sao_Paulo\n- America/St_Johns\n- Asia/Almaty\n- Asia/Baghdad\n- Asia/Bangkok\n- Asia/Hong_Kong\n- Asia/Kabul\n- Asia/Kathmandu\n- Asia/Kolkata\n- Asia/Magadan\n- Asia/Shanghai\n- Asia/Tehran\n- Asia/Tokyo\n- Asia/Yekaterinburg\n- Asia/Yerevan\n- Atlantic/Azores\n- Atlantic/South_Georgia\n- Australia/Brisbane\n- Australia/Darwin\n- Europe/London\n- Europe/Paris\n- Indian/Cocos\n- Pacific/Fiji\n- Pacific/Honolulu\n- Pacific/Kwajalein\n- Pacific/Midway\n"},"isRegional":{"type":"boolean","description":"Set to `true` if account is associated with a Global Advertiser Account.","example":false}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"422":{"description":"Unprocessable entity - Failed due to invalid parameters.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Validation Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"DSP_INVALID_QUERY_PARAM","field":"advertiserIdFilter","message":"Each advertiserId must be a valid numeric id separated by comma."}]}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-advertiser#tag/Advertiser","sectionHeader":{"type":3,"text":"GET /dsp/advertisers"},"documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["Use the Amazon Ads API for DSP for campaign, creative, line item and association operations. For onboarding information, see the account setup topic.\n"],"path":"/en-us/dsp-campaigns","sectionHeader":{"type":2,"text":"Amazon Ads API - Amazon DSP"},"documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/orders/{orderId}",{"tags":["Order"],"summary":"Gets an order with complete information specified by an identifier.","description":"Gets an order with complete information specified by an identifier.","operationId":"getOrder","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"orderId","in":"path","description":"The order identifier.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dsporders.v2.6+json":{"schema":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json. FREQUENCY is available since application/vnd.dsporders.v2.6+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)\n* FREQUENCY: The number of times an ad is shown to a unique user","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE","FREQUENCY"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}},"application/vnd.dsporders.v2.5+json":{"schema":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}},"application/vnd.dsporders.v2.4+json":{"schema":{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}},"application/vnd.dsporders.v2.3+json":{"schema":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]}],"enum":["COMBINED_RETURN_ON_AD_SPEND"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}},"application/vnd.dsporders.v2.2+json":{"schema":{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}},"application/vnd.dsporders.v2.1+json":{"schema":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}},"application/vnd.dsporders.v2+json":{"schema":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON.","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON.","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON.","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Order/operation/getOrder","sectionHeader":{"type":3,"text":"GET /dsp/orders/{orderId}"},"summary":"Gets an order with complete information specified by an identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/orders/",{"tags":["Order"],"summary":"Gets one or more orders with basic information.","description":"Gets one or more orders with basic information.","operationId":"getOrders","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"startIndex","description":"Optional. Sets a zero-based offset into the requested set of orders. Use in conjunction with the `count` parameter to control pagination of the returned array. Default startIndex is 0. Minimum count is 0.","in":"query","required":false,"schema":{"type":"string"}},{"name":"count","description":"Optional. Sets the number of orders in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten orders set `startIndex=0` and `count=10`. To return the next ten orders, set `startIndex=10` and `count=10`, and so on. Default count is 100. Minimum count is 1 and maximum count is 100.","in":"query","required":false,"schema":{"type":"string"}},{"name":"statusFilter","description":"Optional. The returned array is filtered to include only orders with delivery status matching those specified in the comma-delimited string.","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderIdFilter","description":"The returned array is filtered to include only orders with identifiers matching those specified in the comma-delimited string. Either one of (OrderIdFilter or advertiserIdFilter) should be provided.","in":"query","required":false,"schema":{"type":"string"}},{"name":"advertiserIdFilter","description":"The returned array is filtered to include only orders with identifiers matching those specified in the comma-delimited string. Either one of (OrderIdFilter or advertiserIdFilter) should be provided.","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dsporders.v2.6+json":{"schema":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json. FREQUENCY is available since application/vnd.dsporders.v2.6+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)\n* FREQUENCY: The number of times an ad is shown to a unique user","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE","FREQUENCY"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}},"application/vnd.dsporders.v2.5+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. \"N/A\" (not applicable) is a valid value. This field will be deprecated and renamed to poNumber in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsporders.v2.4+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. \"N/A\" (not applicable) is a valid value. This field will be deprecated and renamed to poNumber in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsporders.v2.3+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. \"N/A\" (not applicable) is a valid value. This field will be deprecated and renamed to poNumber in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]}],"enum":["COMBINED_RETURN_ON_AD_SPEND"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsporders.v2.2+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true}}}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsporders.v2.1+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsporders.v2+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}},"minItems":1,"maxItems":100}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Order/operation/getOrders","sectionHeader":{"type":3,"text":"GET /dsp/orders/"},"summary":"Gets one or more orders with basic information.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/orders/",{"tags":["Order"],"summary":"Update an order.","description":"This is a full update, not partial patch. All the fields/data returned by GET Order by Id must be provided(including read-only fields). Any field that is changed/removed would be updated as provided in the request.\nTo update `deliveryActivationStatus` use POST deliveryActivationStatus by Order Id instead.\n\nCallout - A future update will add support for multiple at a time.\n","operationId":"UpdateOrders","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of order objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dsporders.v2.6+json":{"schema":{"type":"array","items":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json. FREQUENCY is available since application/vnd.dsporders.v2.6+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)\n* FREQUENCY: The number of times an ad is shown to a unique user","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE","FREQUENCY"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}},"minItems":1,"maxItems":1}},"application/vnd.dsporders.v2.5+json":{"schema":{"type":"array","items":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}},"minItems":1,"maxItems":1}},"application/vnd.dsporders.v2.3+json":{"schema":{"type":"array","items":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]}],"enum":["COMBINED_RETURN_ON_AD_SPEND"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]},"minItems":1,"maxItems":1}},"application/vnd.dsporders.v2.2+json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}},"minItems":1,"maxItems":1}},"application/vnd.dsporders.v2.1+json":{"schema":{"type":"array","items":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]},"minItems":1,"maxItems":1}},"application/vnd.dsporders.v2+json":{"schema":{"type":"array","items":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dsporders.v2.6+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsporders.v2.5+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsporders.v2.3+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsporders.v2.2+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsporders.v2.1+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsporders.v2+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Order/operation/UpdateOrders","sectionHeader":{"type":3,"text":"PUT /dsp/orders/"},"summary":"Update an order.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/orders/{orderId}/conversionTracking",{"tags":["Order"],"summary":"Get conversion tracking information for given order.","description":"Get conversion tracking information for given order.","operationId":"GetConversionTrackings","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"orderId","in":"path","description":"The order identifier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"type":"object","properties":{"products":{"allOf":[{"type":"object","properties":{"productList":{"type":"array","description":"The tracking product list.","items":{"type":"object","properties":{"productId":{"type":"string","description":"The product identifier."},"productAssociation":{"type":"string","description":"The product feature type.","enum":["FEATURED","NOT_FEATURED"]},"domain":{"type":"string","description":"The ASIN domain type. Applicable to ASIN line item type only.","enum":["AMAZON_US","AMAZON_CA","AMAZON_MX","PRIME_NOW_US","PRIME_NOW_CA","WHOLE_FOODS_MARKET_US"]}},"required":["productId","productAssociation","domain"]}},"productFile":{"type":"string","description":"The URL of the product tracking file.","readOnly":true}}}],"type":"object","properties":{"productList":{"items":{"allOf":[{"type":"object","properties":{"productId":{"type":"string","description":"The product identifier."},"productAssociation":{"type":"string","description":"The product feature type.","enum":["FEATURED","NOT_FEATURED"]},"domain":{"type":"string","description":"The ASIN domain type. Applicable to ASIN line item type only.","enum":["AMAZON_US","AMAZON_CA","AMAZON_MX","PRIME_NOW_US","PRIME_NOW_CA","WHOLE_FOODS_MARKET_US"]}},"required":["productId","productAssociation","domain"]}],"type":"object","properties":{"domain":{"allOf":[{"type":"string","description":"The ASIN domain type. Applicable to ASIN line item type only.","enum":["AMAZON_US","AMAZON_CA","AMAZON_MX","PRIME_NOW_US","PRIME_NOW_CA","WHOLE_FOODS_MARKET_US"]}],"type":"string","description":"The ASIN domain type. Applicable to ASIN line item type only. FRESH_STORES_US is available since application/vnd.dsporders.v2.1+json.","enum":["FRESH_STORES_US"]}},"required":["domain"]}}}},"pixels":{"type":"array","description":"A list of pixels associated with the campaign.","items":{"type":"string","description":"The pixel identifier."}}}}},"application/vnd.dsporders.v2+json":{"schema":{"type":"object","properties":{"products":{"type":"object","properties":{"productList":{"type":"array","description":"The tracking product list.","items":{"type":"object","properties":{"productId":{"type":"string","description":"The product identifier."},"productAssociation":{"type":"string","description":"The product feature type.","enum":["FEATURED","NOT_FEATURED"]},"domain":{"type":"string","description":"The ASIN domain type. Applicable to ASIN line item type only.","enum":["AMAZON_US","AMAZON_CA","AMAZON_MX","PRIME_NOW_US","PRIME_NOW_CA","WHOLE_FOODS_MARKET_US"]}},"required":["productId","productAssociation","domain"]}},"productFile":{"type":"string","description":"The URL of the product tracking file.","readOnly":true}}},"pixels":{"type":"array","description":"A list of pixels associated with the campaign.","items":{"type":"string","description":"The pixel identifier."}}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Order/operation/GetConversionTrackings","sectionHeader":{"type":3,"text":"GET /dsp/orders/{orderId}/conversionTracking"},"summary":"Get conversion tracking information for given order.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/orders/{orderId}/conversionTracking/products",{"tags":["Order"],"summary":"Add or remove conversion tracking products from the order.","description":"Add or remove conversion tracking products from the order. It can be updated by either providing values for productList or productFile field. For productList, up to 2,000 ProductTrackingItems can be added, including up to 20 ProductTrackingItems per domain if FEATURED_WITH_VARIATIONS is specified in productAssociation. For productFile, up to 50,000 Products can be used. Check out our tutorial for more details.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"orderId","in":"path","description":"The order identifier.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Conversion tracking product tracking object","content":{"application/vnd.dspproducttracking.v1+json":{"schema":{"type":"object","properties":{"productList":{"type":"array","description":"The tracking product list.","items":{"type":"object","properties":{"productId":{"type":"string","description":"The product identifier."},"productAssociation":{"type":"string","description":"The product feature type.","enum":["FEATURED","NOT_FEATURED","FEATURED_WITH_VARIATION"]},"domain":{"type":"string","description":"The ASIN domain type.","enum":["AMAZON_US","AMAZON_CA","AMAZON_MX","PRIME_NOW_US","PRIME_NOW_CA","WHOLE_FOODS_MARKET_US","FRESH_STORES_US","PRIME_VIDEO_ROW_NA"]}},"required":["productId","productAssociation","domain"]}},"productFile":{"type":"string","description":"The URL of the product tracking file.","readOnly":true}}}}}},"responses":{"204":{"description":"Success with no body content."},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Order","sectionHeader":{"type":3,"text":"PUT /dsp/orders/{orderId}/conversionTracking/products"},"summary":"Add or remove conversion tracking products from the order.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/lineItems/",{"tags":["LineItem"],"summary":"Gets one or more line items with basic information.","description":"Gets one or more line items with basic information.","operationId":"getLineItems","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"startIndex","description":"Optional. Sets a zero-based offset into the requested set of line items. Use in conjunction with the `count` parameter to control pagination of the returned array. Default startIndex is 0. Minimum count is 0.","in":"query","required":false,"schema":{"type":"string"}},{"name":"count","description":"Optional. Sets the number of line items in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten line items set `startIndex=0` and `count=10`. To return the next ten line items, set `startIndex=10` and `count=10`, and so on. Default count is 100. Minimum count is 1 and maximum count is 100.","in":"query","required":false,"schema":{"type":"string"}},{"name":"statusFilter","description":"Optional. The returned array is filtered to include only line items with delivery status matching those specified in the comma-delimited string.","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderIdFilter","description":"The returned array is filtered to include only line items with identifiers matching those specified in the comma-delimited string. Either one of (orderIdFilter or lineItemIdFilter) should be provided.","in":"query","required":false,"schema":{"type":"string"}},{"name":"lineItemIdFilter","description":"The returned array is filtered to include only line items with identifiers matching those specified in the comma-delimited string. Either one of (orderIdFilter or lineItemIdFilter) should be provided.","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspbasiclineitems.v3+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"type":"object","readOnly":true,"properties":{"lineItemId":{"type":"string","description":"The line item identifier."},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"externalId":{"type":"string","description":"The line item external identifier."},"comments":{"type":"string","description":"The line item comments."},"orderId":{"type":"string","description":"The order to which the line item is associated."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example,2020-07-16T19:20:30+01:00"},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]}}}],"properties":{"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`. OTT_GUARANTEED is supported only for batch read API since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO","OTT_GUARANTEED"]},"creationDate":{"type":"string","description":"The line item creation date. This field is available since version `application/vnd.dsplineitems.v2.2+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date. This field is available since version `application/vnd.dsplineitems.v2.2+json`.","readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"type":"object","readOnly":true,"properties":{"lineItemId":{"type":"string","description":"The line item identifier."},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"externalId":{"type":"string","description":"The line item external identifier."},"comments":{"type":"string","description":"The line item comments."},"orderId":{"type":"string","description":"The order to which the line item is associated."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example,2020-07-16T19:20:30+01:00"},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]}}}],"properties":{"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`. OTT_GUARANTEED is supported only for batch read API since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO","OTT_GUARANTEED"]},"creationDate":{"type":"string","description":"The line item creation date. This field is available since version `application/vnd.dsplineitems.v2.2+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date. This field is available since version `application/vnd.dsplineitems.v2.2+json`.","readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"type":"object","readOnly":true,"properties":{"lineItemId":{"type":"string","description":"The line item identifier."},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"externalId":{"type":"string","description":"The line item external identifier."},"comments":{"type":"string","description":"The line item comments."},"orderId":{"type":"string","description":"The order to which the line item is associated."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example,2020-07-16T19:20:30+01:00"},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]}}}],"properties":{"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`. OTT_GUARANTEED is supported only for batch read API since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO","OTT_GUARANTEED"]}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsplineitems.v2+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","readOnly":true,"properties":{"lineItemId":{"type":"string","description":"The line item identifier."},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"externalId":{"type":"string","description":"The line item external identifier."},"comments":{"type":"string","description":"The line item comments."},"orderId":{"type":"string","description":"The order to which the line item is associated."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example,2020-07-16T19:20:30+01:00"},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]}}},"minItems":1,"maxItems":100}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation."}]}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation."}]}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation."}]}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation."}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/LineItem/operation/getLineItems","sectionHeader":{"type":3,"text":"GET /dsp/lineItems/"},"summary":"Gets one or more line items with basic information.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/lineItems/",{"tags":["LineItem"],"summary":"Update line item.","description":"This is a full update, not partial patch. All the fields/data returned by GET LineItem by Id must be provided(including read-only fields). Any field that is changed/removed would be updated as provided in the request.\nTo update `deliveryActivationStatus` use POST deliveryActivationStatus by LineItem Id instead.\n\nCallout - A future update will add support for multiple at a time.\n","operationId":"updateLineItems","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of line item objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dsplineitems.v3.3+json":{"schema":{"type":"array","items":{"allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}}}}}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}}}}}}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}],"properties":{"integralAdScience":{"allOf":[{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"contextualTargeting":{"type":"object","properties":{"avoidanceSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual avoidance segment"}}}},"contextualAvoidance":{"type":"object","properties":{"verticalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual vertical targeting segment"}},"topicalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual topical targeting segment"}}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}],"properties":{"integralAdScience":{"allOf":[{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}],"properties":{"contextualTargeting":{"type":"object","properties":{"avoidanceSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual avoidance segment"}}}},"contextualAvoidance":{"type":"object","properties":{"verticalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual vertical targeting segment"}},"topicalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual topical targeting segment"}}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"allOf":[{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}],"properties":{"integralAdScience":{"allOf":[{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"contextualTargeting":{"type":"object","properties":{"avoidanceSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual avoidance segment"}}}},"contextualAvoidance":{"type":"object","properties":{"verticalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual vertical targeting segment"}},"topicalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual topical targeting segment"}}}}}}}}}}}}}},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v3.2+json":{"schema":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}}}}}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}}}}}},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v3.1+json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}}}}},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v3+json":{"schema":{"type":"array","items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdateDate":{"type":"string","description":"The line item last update date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]}],"properties":{"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"targeting":{"allOf":[{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}}}],"type":"object","properties":{"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}}}},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdateDate":{"type":"string","description":"The line item last update date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]}],"properties":{"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"targeting":{"allOf":[{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}}}],"type":"object","properties":{"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}}}},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v2+json":{"schema":{"type":"array","items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdateDate":{"type":"string","description":"The line item last update date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dsplineitemsresponse.v3.1+json":{"schema":{"type":"array","items":{"description":"Response for the line item create/update operations. Success contains only lineItemId and failure contains only errorDetails corresponding to that requested index in that batch (array of items).","type":"object","properties":{"lineItemId":{"type":"string","description":"The Line item identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsplineitemsresponse.v3+json":{"schema":{"type":"array","items":{"description":"Response for the line item create/update operations. Success contains only lineItemId and failure contains only errorDetails corresponding to that requested index in that batch (array of items).","type":"object","properties":{"lineItemId":{"type":"string","description":"The Line item identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"type":"array","items":{"description":"Response for the line item create/update operations. Success contains only lineItemId and failure contains only errorDetails corresponding to that requested index in that batch (array of items).","type":"object","properties":{"lineItemId":{"type":"string","description":"The Line item identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"type":"array","items":{"description":"Response for the line item create/update operations. Success contains only lineItemId and failure contains only errorDetails corresponding to that requested index in that batch (array of items).","type":"object","properties":{"lineItemId":{"type":"string","description":"The Line item identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsplineitems.v2+json":{"schema":{"type":"array","items":{"description":"Response for the line item create/update operations. Success contains only lineItemId and failure contains only errorDetails corresponding to that requested index in that batch (array of items).","type":"object","properties":{"lineItemId":{"type":"string","description":"The Line item identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/LineItem/operation/updateLineItems","sectionHeader":{"type":3,"text":"PUT /dsp/lineItems/"},"summary":"Update line item.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/",{"tags":["Creative"],"summary":"Gets one or more creatives.","description":"Gets one or more creatives.","operationId":"getCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"startIndex","description":"Optional. Sets a zero-based offset into the requested set of creatives. Use in conjunction with the `count` parameter to control pagination of the returned array. Default startIndex is 0. Minimum count is 0.","in":"query","required":false,"schema":{"type":"string"}},{"name":"count","description":"Optional. Sets the number of creatives in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten creatives set `startIndex=0` and `count=10`. To return the next ten creatives, set `startIndex=10` and `count=10`, and so on. Default count is 100. Minimum count is 1 and maximum count is 100.","in":"query","required":false,"schema":{"type":"string"}},{"name":"creativeIdFilter","description":"The returned array is filtered to include only creatives with identifiers matching those specified in the comma-delimited string. Either one of (creativeIdFilter or advertiserIdFilter) should be given.","in":"query","required":false,"schema":{"type":"string"}},{"name":"advertiserIdFilter","description":"The returned array is filtered to include only creatives with identifiers matching those specified in the comma-delimited string. Either one of (creativeIdFilter or advertiserIdFilter) should be given.","in":"query","required":false,"schema":{"type":"string"}},{"name":"lineItemTypeFilter","description":"The returned array is filtered to include only creatives with line item type matching those specified in the comma-delimited string. If the given filter value is not part of enumeration (LineItemType), Response code will be 404. VIDEO line item type filter is available since version `application/vnd.dspcreatives.v2.1+json`.","in":"query","required":false,"schema":{"type":"string","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP","VIDEO"]}}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","properties":{"advertiserId":{"type":"string","description":"The identifier of the advertiser.","readOnly":true},"creativeId":{"type":"string","description":"The identifier of the creative.","readOnly":true},"type":{"type":"string","description":"The creative type.","readOnly":true},"name":{"type":"string","description":"The creative name.","readOnly":true},"externalId":{"type":"string","description":"The external identifier of the creative.","readOnly":true},"size":{"type":"string","description":"The creative size.","readOnly":true},"supportedLineItemTypes":{"type":"array","description":"Supported lineItemTypes where creatives can be associated. VIDEO line item type is supported since version `application/vnd.dspcreatives.v2.1+json`","items":{"type":"string","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP","VIDEO"]}}}},"minItems":1,"maxItems":100}}}},"application/vnd.dspcreatives.v2+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","properties":{"advertiserId":{"type":"string","description":"The identifier of the advertiser.","readOnly":true},"creativeId":{"type":"string","description":"The identifier of the creative.","readOnly":true},"type":{"type":"string","description":"The creative type.","readOnly":true},"name":{"type":"string","description":"The creative name.","readOnly":true},"externalId":{"type":"string","description":"The external identifier of the creative.","readOnly":true},"size":{"type":"string","description":"The creative size.","readOnly":true},"supportedLineItemTypes":{"type":"array","description":"Supported lineItemTypes where creatives can be associated. VIDEO line item type is supported since version `application/vnd.dspcreatives.v2.1+json`","items":{"type":"string","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP","VIDEO"]}}}},"minItems":1,"maxItems":100}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Creative/operation/getCreatives","sectionHeader":{"type":3,"text":"GET /dsp/creatives/"},"summary":"Gets one or more creatives.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/image",{"tags":["Image Creative"],"summary":"[DEPRECATED] Get image creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nGet an image creative matching criteria provided in request.\n\nCallout - A future update will add support to get multiple Image creatives at a time.\n","operationId":"getImageCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array is filtered to include only creatives with Ids matching those specified in the comma-delimited string.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspimagecreatives.v1+json":{"schema":{"type":"object","description":"Read image creatives response.","properties":{"creatives":{"type":"array","items":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for image creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"type":"object","description":"Image's click through action which can have any one of the following properties. One action and one action alone must be provided.","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]},"detailPage":{"type":"object","description":"Click through Action - Detail Page. This is applicable only to `MOBILE_OO` and `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Define which product's detail page the customer should be taken to when tapping on the creative."},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. By default it is false. This will be considered only for `MOBILE_AAP` supply."}},"required":["productAsin"]},"searchAsin":{"type":"object","description":"Click through Action - Search Asins. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"productAsins":{"type":"array","description":"Define the Asins to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":25,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. Default value is `false`."}},"required":["productAsins"]},"searchKeyword":{"type":"object","description":"Click through action - Search Keywords. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"keywords":{"type":"array","description":"Define the keywords to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. By default it is `false`."}},"required":["keywords"]},"androidAppDownload":{"type":"object","description":"To target Android app download as click through action, at least `storeId`, `productAsin` or `downloadUrl` must be provided. If both `storeId` and `productAsin` is provided, `storePriority` must be provided as well. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"isRtb":{"type":"boolean","description":"Indicates whether it's for real time bidding or not. Default value is `false`. This is applicable only to `MOBILE_AAP` supply."},"storeId":{"type":"string","description":"Android play store Id for app, used to build the download URL."},"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL. This is applicable only to `MOBILE_AAP` supply."},"storePriority":{"type":"string","description":"The higher priority store will be tried first, then if it does not exist on device the second store will be tried. Default value is `PLAY_STORE_THEN_AMAZON_APP_STORE`. This is applicable only to `MOBILE_AAP` supply.","enum":["PLAY_STORE_THEN_AMAZON_APP_STORE","AMAZON_APP_STORE_THEN_PLAY_STORE"]},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `playStoreId` and `productAsin` information provided. It can be overriden."}}},"iosAppDownload":{"type":"object","description":"Click through action - IOS App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"storeLink":{"type":"string","description":"Apple app store link for app, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `storeLink` information provided. It can be overridden."}},"required":["storeLink"]},"kindleAppDownload":{"type":"object","description":"Click through Action - Kindle App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, this will be built automatically using `productAsin` information provided. It can be overridden."}},"required":["productAsin"]}}},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","asset","clickThroughAction"]},{"type":"object","description":"Create image creative request.","properties":{"supply":{"allOf":[{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]}]}},"required":["supply"]}]},{"description":"Update image creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for image creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"type":"object","description":"Image's click through action which can have any one of the following properties. One action and one action alone must be provided.","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]},"detailPage":{"type":"object","description":"Click through Action - Detail Page. This is applicable only to `MOBILE_OO` and `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Define which product's detail page the customer should be taken to when tapping on the creative."},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. By default it is false. This will be considered only for `MOBILE_AAP` supply."}},"required":["productAsin"]},"searchAsin":{"type":"object","description":"Click through Action - Search Asins. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"productAsins":{"type":"array","description":"Define the Asins to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":25,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. Default value is `false`."}},"required":["productAsins"]},"searchKeyword":{"type":"object","description":"Click through action - Search Keywords. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"keywords":{"type":"array","description":"Define the keywords to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. By default it is `false`."}},"required":["keywords"]},"androidAppDownload":{"type":"object","description":"To target Android app download as click through action, at least `storeId`, `productAsin` or `downloadUrl` must be provided. If both `storeId` and `productAsin` is provided, `storePriority` must be provided as well. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"isRtb":{"type":"boolean","description":"Indicates whether it's for real time bidding or not. Default value is `false`. This is applicable only to `MOBILE_AAP` supply."},"storeId":{"type":"string","description":"Android play store Id for app, used to build the download URL."},"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL. This is applicable only to `MOBILE_AAP` supply."},"storePriority":{"type":"string","description":"The higher priority store will be tried first, then if it does not exist on device the second store will be tried. Default value is `PLAY_STORE_THEN_AMAZON_APP_STORE`. This is applicable only to `MOBILE_AAP` supply.","enum":["PLAY_STORE_THEN_AMAZON_APP_STORE","AMAZON_APP_STORE_THEN_PLAY_STORE"]},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `playStoreId` and `productAsin` information provided. It can be overriden."}}},"iosAppDownload":{"type":"object","description":"Click through action - IOS App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"storeLink":{"type":"string","description":"Apple app store link for app, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `storeLink` information provided. It can be overridden."}},"required":["storeLink"]},"kindleAppDownload":{"type":"object","description":"Click through Action - Kindle App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, this will be built automatically using `productAsin` information provided. It can be overridden."}},"required":["productAsin"]}}},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","asset","clickThroughAction"]}]},{"type":"object","description":"This holds common read-only properties of all creative types.","properties":{"approvalStatus":{"type":"string","description":"The creative approval status.","enum":["PENDING","APPROVED","NOT_APPROVED","WAITING_FOR_LINEITEM","APPROVED_WITH_EXCEPTIONS"]},"createdDate":{"type":"string","description":"The creative created date."},"lastUpdatedDate":{"type":"string","description":"The creative last updated date."}}}]},"minItems":1,"maxItems":1}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Image%20Creative/operation/getImageCreatives","sectionHeader":{"type":3,"text":"GET /dsp/creatives/image"},"summary":"[DEPRECATED] Get image creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/image",{"tags":["Image Creative"],"summary":"[DEPRECATED] Create image creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nCreate an image creative.\n\nCallout - A future update will add support to create multiple Image creatives at a time.\n","operationId":"CreateImageCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspcreateimagecreatives.v1+json":{"schema":{"type":"array","description":"Create image creatives request.","items":{"allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for image creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"type":"object","description":"Image's click through action which can have any one of the following properties. One action and one action alone must be provided.","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]},"detailPage":{"type":"object","description":"Click through Action - Detail Page. This is applicable only to `MOBILE_OO` and `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Define which product's detail page the customer should be taken to when tapping on the creative."},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. By default it is false. This will be considered only for `MOBILE_AAP` supply."}},"required":["productAsin"]},"searchAsin":{"type":"object","description":"Click through Action - Search Asins. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"productAsins":{"type":"array","description":"Define the Asins to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":25,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. Default value is `false`."}},"required":["productAsins"]},"searchKeyword":{"type":"object","description":"Click through action - Search Keywords. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"keywords":{"type":"array","description":"Define the keywords to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. By default it is `false`."}},"required":["keywords"]},"androidAppDownload":{"type":"object","description":"To target Android app download as click through action, at least `storeId`, `productAsin` or `downloadUrl` must be provided. If both `storeId` and `productAsin` is provided, `storePriority` must be provided as well. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"isRtb":{"type":"boolean","description":"Indicates whether it's for real time bidding or not. Default value is `false`. This is applicable only to `MOBILE_AAP` supply."},"storeId":{"type":"string","description":"Android play store Id for app, used to build the download URL."},"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL. This is applicable only to `MOBILE_AAP` supply."},"storePriority":{"type":"string","description":"The higher priority store will be tried first, then if it does not exist on device the second store will be tried. Default value is `PLAY_STORE_THEN_AMAZON_APP_STORE`. This is applicable only to `MOBILE_AAP` supply.","enum":["PLAY_STORE_THEN_AMAZON_APP_STORE","AMAZON_APP_STORE_THEN_PLAY_STORE"]},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `playStoreId` and `productAsin` information provided. It can be overriden."}}},"iosAppDownload":{"type":"object","description":"Click through action - IOS App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"storeLink":{"type":"string","description":"Apple app store link for app, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `storeLink` information provided. It can be overridden."}},"required":["storeLink"]},"kindleAppDownload":{"type":"object","description":"Click through Action - Kindle App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, this will be built automatically using `productAsin` information provided. It can be overridden."}},"required":["productAsin"]}}},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","asset","clickThroughAction"]},{"type":"object","description":"Create image creative request.","properties":{"supply":{"allOf":[{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]}]}},"required":["supply"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspimagecreativesresponse.v1+json":{"schema":{"type":"array","description":"Create/Update operation's image creatives response.","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Image%20Creative/operation/CreateImageCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/image"},"summary":"[DEPRECATED] Create image creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/image",{"tags":["Image Creative"],"summary":"[DEPRECATED] Update image creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nUpdate an image creative.\n\nCallout - A future update will add support to update multiple Image creatives at a time.\n","operationId":"UpdateImageCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspupdateimagecreatives.v1+json":{"schema":{"type":"array","description":"Update image creatives request.","items":{"description":"Update image creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for image creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"type":"object","description":"Image's click through action which can have any one of the following properties. One action and one action alone must be provided.","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]},"detailPage":{"type":"object","description":"Click through Action - Detail Page. This is applicable only to `MOBILE_OO` and `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Define which product's detail page the customer should be taken to when tapping on the creative."},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. By default it is false. This will be considered only for `MOBILE_AAP` supply."}},"required":["productAsin"]},"searchAsin":{"type":"object","description":"Click through Action - Search Asins. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"productAsins":{"type":"array","description":"Define the Asins to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":25,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. Default value is `false`."}},"required":["productAsins"]},"searchKeyword":{"type":"object","description":"Click through action - Search Keywords. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"keywords":{"type":"array","description":"Define the keywords to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. By default it is `false`."}},"required":["keywords"]},"androidAppDownload":{"type":"object","description":"To target Android app download as click through action, at least `storeId`, `productAsin` or `downloadUrl` must be provided. If both `storeId` and `productAsin` is provided, `storePriority` must be provided as well. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"isRtb":{"type":"boolean","description":"Indicates whether it's for real time bidding or not. Default value is `false`. This is applicable only to `MOBILE_AAP` supply."},"storeId":{"type":"string","description":"Android play store Id for app, used to build the download URL."},"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL. This is applicable only to `MOBILE_AAP` supply."},"storePriority":{"type":"string","description":"The higher priority store will be tried first, then if it does not exist on device the second store will be tried. Default value is `PLAY_STORE_THEN_AMAZON_APP_STORE`. This is applicable only to `MOBILE_AAP` supply.","enum":["PLAY_STORE_THEN_AMAZON_APP_STORE","AMAZON_APP_STORE_THEN_PLAY_STORE"]},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `playStoreId` and `productAsin` information provided. It can be overriden."}}},"iosAppDownload":{"type":"object","description":"Click through action - IOS App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"storeLink":{"type":"string","description":"Apple app store link for app, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `storeLink` information provided. It can be overridden."}},"required":["storeLink"]},"kindleAppDownload":{"type":"object","description":"Click through Action - Kindle App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, this will be built automatically using `productAsin` information provided. It can be overridden."}},"required":["productAsin"]}}},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","asset","clickThroughAction"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspimagecreativesresponse.v1+json":{"schema":{"type":"array","description":"Create/Update operation's image creatives response.","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Image%20Creative/operation/UpdateImageCreative","sectionHeader":{"type":3,"text":"PUT /dsp/creatives/image"},"summary":"[DEPRECATED] Update image creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/image/preview",{"tags":["Image Creative"],"summary":"[DEPRECATED] Preview an image creative.","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nPreview an image creative.\n","operationId":"previewImageCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A preview request.","content":{"application/vnd.dsppreviewimagecreatives.v1+json":{"schema":{"description":"Image creative preview request. Either `creativeId` or `creativeModel` must be provided, but not both.","type":"object","properties":{"creativeId":{"type":"string","description":"The creative Id."},"creativeModel":{"description":"Image creative preview model. Populate this to preview a new creative.","type":"object","properties":{"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]},"supply":{"allOf":[{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]}]},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"type":"object","description":"Image's click through action which can have any one of the following properties. One action and one action alone must be provided.","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]},"detailPage":{"type":"object","description":"Click through Action - Detail Page. This is applicable only to `MOBILE_OO` and `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Define which product's detail page the customer should be taken to when tapping on the creative."},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. By default it is false. This will be considered only for `MOBILE_AAP` supply."}},"required":["productAsin"]},"searchAsin":{"type":"object","description":"Click through Action - Search Asins. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"productAsins":{"type":"array","description":"Define the Asins to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":25,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. Default value is `false`."}},"required":["productAsins"]},"searchKeyword":{"type":"object","description":"Click through action - Search Keywords. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"keywords":{"type":"array","description":"Define the keywords to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. By default it is `false`."}},"required":["keywords"]},"androidAppDownload":{"type":"object","description":"To target Android app download as click through action, at least `storeId`, `productAsin` or `downloadUrl` must be provided. If both `storeId` and `productAsin` is provided, `storePriority` must be provided as well. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"isRtb":{"type":"boolean","description":"Indicates whether it's for real time bidding or not. Default value is `false`. This is applicable only to `MOBILE_AAP` supply."},"storeId":{"type":"string","description":"Android play store Id for app, used to build the download URL."},"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL. This is applicable only to `MOBILE_AAP` supply."},"storePriority":{"type":"string","description":"The higher priority store will be tried first, then if it does not exist on device the second store will be tried. Default value is `PLAY_STORE_THEN_AMAZON_APP_STORE`. This is applicable only to `MOBILE_AAP` supply.","enum":["PLAY_STORE_THEN_AMAZON_APP_STORE","AMAZON_APP_STORE_THEN_PLAY_STORE"]},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `playStoreId` and `productAsin` information provided. It can be overriden."}}},"iosAppDownload":{"type":"object","description":"Click through action - IOS App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"storeLink":{"type":"string","description":"Apple app store link for app, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `storeLink` information provided. It can be overridden."}},"required":["storeLink"]},"kindleAppDownload":{"type":"object","description":"Click through Action - Kindle App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, this will be built automatically using `productAsin` information provided. It can be overridden."}},"required":["productAsin"]}}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["marketplace","supply","size","asset","adChoicesPosition"]},"previewConfiguration":{"description":"Configuration settings for preview","type":"object","properties":{"isOnAmazon":{"type":"boolean","description":"If it's true, shows preview in amazon websites, else shows in other websites","default":true}}}}}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dsppreviewcreativesresponse.v1+json":{"schema":{"description":"Creative preview response.","type":"object","properties":{"previewContent":{"description":"The HTML content","type":"string"}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Image%20Creative/operation/previewImageCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/image/preview"},"summary":"[DEPRECATED] Preview an image creative.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/video",{"tags":["Video Creative"],"summary":"[DEPRECATED] Get video creative(s)","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nGet a video creative matching criteria provided in request.\n\nCallout - A future update will add support to get multiple Video creatives at a time.\n","operationId":"getVideoCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array is filtered to include only creatives with Ids matching those specified in the comma-delimited string.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspvideocreatives.v1+json":{"schema":{"type":"object","description":"Read video creatives response.","properties":{"creatives":{"type":"array","items":{"allOf":[{"description":"Create video creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for video creative","properties":{"externalId":{"description":"The creative external identifier.","type":"string"},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"description":"Click through action for video creatives","type":"object","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]}}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["asset","clickThroughAction"]}]},{"description":"Update video creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for video creative","properties":{"externalId":{"description":"The creative external identifier.","type":"string"},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"description":"Click through action for video creatives","type":"object","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]}}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["asset","clickThroughAction"]}]},{"type":"object","description":"This holds common read-only properties of all creative types.","properties":{"approvalStatus":{"type":"string","description":"The creative approval status.","enum":["PENDING","APPROVED","NOT_APPROVED","WAITING_FOR_LINEITEM","APPROVED_WITH_EXCEPTIONS"]},"createdDate":{"type":"string","description":"The creative created date."},"lastUpdatedDate":{"type":"string","description":"The creative last updated date."}}}]},"minItems":1,"maxItems":1}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Video%20Creative/operation/getVideoCreatives","sectionHeader":{"type":3,"text":"GET /dsp/creatives/video"},"summary":"[DEPRECATED] Get video creative(s)","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/video",{"tags":["Video Creative"],"summary":"[DEPRECATED] Create video creative(s)","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nCreate a video creative\n\nCallout - A future update will add support to create multiple Video creatives at a time.\n","operationId":"createVideoCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspcreatevideocreatives.v1+json":{"schema":{"description":"Create video creatives request.","type":"array","items":{"description":"Create video creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for video creative","properties":{"externalId":{"description":"The creative external identifier.","type":"string"},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"description":"Click through action for video creatives","type":"object","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]}}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["asset","clickThroughAction"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspvideocreativesresponse.v1+json":{"schema":{"description":"Create/Update operation's video creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Video%20Creative/operation/createVideoCreatives","sectionHeader":{"type":3,"text":"POST /dsp/creatives/video"},"summary":"[DEPRECATED] Create video creative(s)","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/video",{"tags":["Video Creative"],"summary":"[DEPRECATED] Update video creative(s)","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nUpdate a video creative\n\nCallout - A future update will add support to update multiple Video creatives at a time.\n","operationId":"updateVideoCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspupdatevideocreatives.v1+json":{"schema":{"description":"Update video creatives request","type":"array","items":{"description":"Update video creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for video creative","properties":{"externalId":{"description":"The creative external identifier.","type":"string"},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"description":"Click through action for video creatives","type":"object","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]}}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["asset","clickThroughAction"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspvideocreativesresponse.v1+json":{"schema":{"description":"Create/Update operation's video creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Video%20Creative/operation/updateVideoCreatives","sectionHeader":{"type":3,"text":"PUT /dsp/creatives/video"},"summary":"[DEPRECATED] Update video creative(s)","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/video/preview",{"tags":["Video Creative"],"summary":"[DEPRECATED] Preview a video creative","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nPreview a video creative\n","operationId":"previewVideoCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A preview request.","content":{"application/vnd.dsppreviewvideocreatives.v1+json":{"schema":{"description":"Video creative preview request. Either `creativeId` or `creativeModel` must be provided, but not both.","type":"object","properties":{"creativeId":{"description":"The creative Id.","type":"string"},"creativeModel":{"description":"Video creative preview model. Populate this to preview a new creative.","type":"object","properties":{"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"description":"Click through action for video creatives","type":"object","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]}}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["marketplace","asset"]}}}}}},"responses":{"200":{"description":"Successful operation","content":{"application/vnd.dsppreviewcreativesresponse.v1+json":{"schema":{"description":"Creative preview response.","type":"object","properties":{"previewContent":{"description":"The HTML content","type":"string"}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Video%20Creative/operation/previewVideoCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/video/preview"},"summary":"[DEPRECATED] Preview a video creative","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/rec",{"tags":["Responsive eCommerce Creative"],"summary":"[DEPRECATED] Get Responsive eCommerce Creative  (REC).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nGet an Responsive eCommerce Creative (REC) matching criteria provided in request.\n\nCallout - A future update will add support to get multiple REC creatives at a time.\n","operationId":"getRecCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array is filtered to include only creatives with Ids matching those specified in the comma-delimited string.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspreccreatives.v1+json":{"schema":{"type":"object","description":"Read Responsive eCommerce creative (REC) creatives response.","properties":{"creatives":{"type":"array","items":{"allOf":[{"description":"Create Responsive eCommerce creative (REC) request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for REC creative.","properties":{"additionalHtml":{"description":"Add HTML to the creative for surveys or other arbitrary HTML.","type":"string","maxLength":5000},"allowThirdPartySellers":{"description":"If it's true, orders can be fulfilled by third party sellers.","type":"boolean"},"content":{"description":"Responsive eCommerce creative field for displaying customized content. Provide either Background or LogoHeadline but not both.","type":"object","properties":{"background":{"description":"Creative customization field for displaying custom images.","type":"array","items":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]}},"logoHeadline":{"description":"Creative customization field for displaying brandlogo and headline.","type":"object","properties":{"brandLogo":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"headline":{"description":"Creative customization field for displaying headline.","type":"string","maxLength":50}},"required":["brandLogo"]}}},"allowedFormats":{"description":"A list of formats configured to display for the creative.","type":"array","items":{"description":"Formats configured to display for the creative.\n* `SHOP_NOW`: Clicking on the ad will take customer to the relevant product detail page.\n* `ADD_TO_CART`: Clicking on the ad will add the product to the customer’s Cart.\n* `COUPON`: Clicking on the ad will clip the coupon and take the customer to the product detail page for that item, if signed in; otherwise take them to the coupon landing page where the customer is instructed to sign in.\n","type":"string","enum":["SHOP_NOW","ADD_TO_CART","COUPON"]},"minItems":0,"maxItems":3},"optimizationGoal":{"description":"Metric which creative optimization should attempt to improve.","type":"string","enum":["PURCHASE_RATE","CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE"]},"allowedSizes":{"description":"A list of sizes configured to display for the creative. This overrides the default REC supported sizes.","type":"array","items":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"minItems":0,"maxItems":11},"associatedProducts":{"type":"array","description":"Product objects associated with the creative.","items":{"description":"The object representation of a product.","type":"object","properties":{"asin":{"description":"Amazon standard identification number.","type":"string"},"productTitle":{"description":"Retail product title.","type":"string"}},"required":["asin"]},"minItems":1,"maxItems":20},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","description":"URL used for tracking interactions with third party","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["associatedProducts"]}]},{"description":"Update Responsive eCommerce creative (REC) request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for REC creative.","properties":{"additionalHtml":{"description":"Add HTML to the creative for surveys or other arbitrary HTML.","type":"string","maxLength":5000},"allowThirdPartySellers":{"description":"If it's true, orders can be fulfilled by third party sellers.","type":"boolean"},"content":{"description":"Responsive eCommerce creative field for displaying customized content. Provide either Background or LogoHeadline but not both.","type":"object","properties":{"background":{"description":"Creative customization field for displaying custom images.","type":"array","items":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]}},"logoHeadline":{"description":"Creative customization field for displaying brandlogo and headline.","type":"object","properties":{"brandLogo":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"headline":{"description":"Creative customization field for displaying headline.","type":"string","maxLength":50}},"required":["brandLogo"]}}},"allowedFormats":{"description":"A list of formats configured to display for the creative.","type":"array","items":{"description":"Formats configured to display for the creative.\n* `SHOP_NOW`: Clicking on the ad will take customer to the relevant product detail page.\n* `ADD_TO_CART`: Clicking on the ad will add the product to the customer’s Cart.\n* `COUPON`: Clicking on the ad will clip the coupon and take the customer to the product detail page for that item, if signed in; otherwise take them to the coupon landing page where the customer is instructed to sign in.\n","type":"string","enum":["SHOP_NOW","ADD_TO_CART","COUPON"]},"minItems":0,"maxItems":3},"optimizationGoal":{"description":"Metric which creative optimization should attempt to improve.","type":"string","enum":["PURCHASE_RATE","CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE"]},"allowedSizes":{"description":"A list of sizes configured to display for the creative. This overrides the default REC supported sizes.","type":"array","items":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"minItems":0,"maxItems":11},"associatedProducts":{"type":"array","description":"Product objects associated with the creative.","items":{"description":"The object representation of a product.","type":"object","properties":{"asin":{"description":"Amazon standard identification number.","type":"string"},"productTitle":{"description":"Retail product title.","type":"string"}},"required":["asin"]},"minItems":1,"maxItems":20},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","description":"URL used for tracking interactions with third party","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["associatedProducts"]}]},{"type":"object","description":"This holds common read-only properties of all creative types.","properties":{"approvalStatus":{"type":"string","description":"The creative approval status.","enum":["PENDING","APPROVED","NOT_APPROVED","WAITING_FOR_LINEITEM","APPROVED_WITH_EXCEPTIONS"]},"createdDate":{"type":"string","description":"The creative created date."},"lastUpdatedDate":{"type":"string","description":"The creative last updated date."}}}]},"minItems":1,"maxItems":1}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Responsive%20eCommerce%20Creative/operation/getRecCreatives","sectionHeader":{"type":3,"text":"GET /dsp/creatives/rec"},"summary":"[DEPRECATED] Get Responsive eCommerce Creative  (REC).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/rec",{"tags":["Responsive eCommerce Creative"],"summary":"[DEPRECATED] Create Responsive eCommerce Creatives(REC).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nCreate a new Responsive eCommerce Creatives(REC).\n\nCallout - A future update will add support to create multiple REC creatives at a time.\n","operationId":"createRecCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspcreatereccreatives.v1+json":{"schema":{"description":"Create Responsive eCommerce creatives (REC) request.","type":"array","items":{"description":"Create Responsive eCommerce creative (REC) request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for REC creative.","properties":{"additionalHtml":{"description":"Add HTML to the creative for surveys or other arbitrary HTML.","type":"string","maxLength":5000},"allowThirdPartySellers":{"description":"If it's true, orders can be fulfilled by third party sellers.","type":"boolean"},"content":{"description":"Responsive eCommerce creative field for displaying customized content. Provide either Background or LogoHeadline but not both.","type":"object","properties":{"background":{"description":"Creative customization field for displaying custom images.","type":"array","items":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]}},"logoHeadline":{"description":"Creative customization field for displaying brandlogo and headline.","type":"object","properties":{"brandLogo":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"headline":{"description":"Creative customization field for displaying headline.","type":"string","maxLength":50}},"required":["brandLogo"]}}},"allowedFormats":{"description":"A list of formats configured to display for the creative.","type":"array","items":{"description":"Formats configured to display for the creative.\n* `SHOP_NOW`: Clicking on the ad will take customer to the relevant product detail page.\n* `ADD_TO_CART`: Clicking on the ad will add the product to the customer’s Cart.\n* `COUPON`: Clicking on the ad will clip the coupon and take the customer to the product detail page for that item, if signed in; otherwise take them to the coupon landing page where the customer is instructed to sign in.\n","type":"string","enum":["SHOP_NOW","ADD_TO_CART","COUPON"]},"minItems":0,"maxItems":3},"optimizationGoal":{"description":"Metric which creative optimization should attempt to improve.","type":"string","enum":["PURCHASE_RATE","CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE"]},"allowedSizes":{"description":"A list of sizes configured to display for the creative. This overrides the default REC supported sizes.","type":"array","items":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"minItems":0,"maxItems":11},"associatedProducts":{"type":"array","description":"Product objects associated with the creative.","items":{"description":"The object representation of a product.","type":"object","properties":{"asin":{"description":"Amazon standard identification number.","type":"string"},"productTitle":{"description":"Retail product title.","type":"string"}},"required":["asin"]},"minItems":1,"maxItems":20},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","description":"URL used for tracking interactions with third party","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["associatedProducts"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspreccreativesresponse.v1+json":{"schema":{"description":"Create/Update operation's rec creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Responsive%20eCommerce%20Creative/operation/createRecCreatives","sectionHeader":{"type":3,"text":"POST /dsp/creatives/rec"},"summary":"[DEPRECATED] Create Responsive eCommerce Creatives(REC).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/rec",{"tags":["Responsive eCommerce Creative"],"summary":"[DEPRECATED] Update Responsive eCommerce Creatives(REC).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nUpdate existing Responsive eCommerce Creatives(REC).\n\nCallout - A future update will add support for multiple at a time.\n","operationId":"updateRecCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspupdatereccreatives.v1+json":{"schema":{"type":"array","description":"Update Responsive eCommerce creatives (REC) request.","items":{"description":"Update Responsive eCommerce creative (REC) request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for REC creative.","properties":{"additionalHtml":{"description":"Add HTML to the creative for surveys or other arbitrary HTML.","type":"string","maxLength":5000},"allowThirdPartySellers":{"description":"If it's true, orders can be fulfilled by third party sellers.","type":"boolean"},"content":{"description":"Responsive eCommerce creative field for displaying customized content. Provide either Background or LogoHeadline but not both.","type":"object","properties":{"background":{"description":"Creative customization field for displaying custom images.","type":"array","items":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]}},"logoHeadline":{"description":"Creative customization field for displaying brandlogo and headline.","type":"object","properties":{"brandLogo":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"headline":{"description":"Creative customization field for displaying headline.","type":"string","maxLength":50}},"required":["brandLogo"]}}},"allowedFormats":{"description":"A list of formats configured to display for the creative.","type":"array","items":{"description":"Formats configured to display for the creative.\n* `SHOP_NOW`: Clicking on the ad will take customer to the relevant product detail page.\n* `ADD_TO_CART`: Clicking on the ad will add the product to the customer’s Cart.\n* `COUPON`: Clicking on the ad will clip the coupon and take the customer to the product detail page for that item, if signed in; otherwise take them to the coupon landing page where the customer is instructed to sign in.\n","type":"string","enum":["SHOP_NOW","ADD_TO_CART","COUPON"]},"minItems":0,"maxItems":3},"optimizationGoal":{"description":"Metric which creative optimization should attempt to improve.","type":"string","enum":["PURCHASE_RATE","CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE"]},"allowedSizes":{"description":"A list of sizes configured to display for the creative. This overrides the default REC supported sizes.","type":"array","items":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"minItems":0,"maxItems":11},"associatedProducts":{"type":"array","description":"Product objects associated with the creative.","items":{"description":"The object representation of a product.","type":"object","properties":{"asin":{"description":"Amazon standard identification number.","type":"string"},"productTitle":{"description":"Retail product title.","type":"string"}},"required":["asin"]},"minItems":1,"maxItems":20},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","description":"URL used for tracking interactions with third party","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["associatedProducts"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspreccreativesresponse.v1+json":{"schema":{"description":"Create/Update operation's rec creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Responsive%20eCommerce%20Creative/operation/updateRecCreatives","sectionHeader":{"type":3,"text":"PUT /dsp/creatives/rec"},"summary":"[DEPRECATED] Update Responsive eCommerce Creatives(REC).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/rec/preview",{"tags":["Responsive eCommerce Creative"],"summary":"[DEPRECATED] Preview a Responsive eCommerce Creative(REC).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nPreview a Responsive eCommerce Creative(REC).\n","operationId":"previewRecCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A preview request.","content":{"application/vnd.dsppreviewreccreatives.v1+json":{"schema":{"description":"Responsive eCommerce creative preview request. Either `creativeId` or `creativeModel` must be provided, but not both.","type":"object","properties":{"creativeId":{"description":"The identifier of the creative.","type":"string"},"creativeModel":{"description":"Responsive eCommerce Creative preview model. Populate this to preview a new creative.","type":"object","properties":{"content":{"description":"Responsive eCommerce creative field for displaying customized content. Provide either Background or LogoHeadline but not both.","type":"object","properties":{"background":{"description":"Creative customization field for displaying custom images.","type":"array","items":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]}},"logoHeadline":{"description":"Creative customization field for displaying brandlogo and headline.","type":"object","properties":{"brandLogo":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"headline":{"description":"Creative customization field for displaying headline.","type":"string","maxLength":50}},"required":["brandLogo"]}}},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["marketplace"]},"previewConfiguration":{"allOf":[{"description":"Configuration settings for preview","type":"object","properties":{"isOnAmazon":{"type":"boolean","description":"If it's true, shows preview in amazon websites, else shows in other websites","default":true}}},{"type":"object","description":"REC Creative Preview Configuration","properties":{"allowedSize":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"allowedFormat":{"description":"Formats configured to display for the creative.\n* `SHOP_NOW`: Clicking on the ad will take customer to the relevant product detail page.\n* `ADD_TO_CART`: Clicking on the ad will add the product to the customer’s Cart.\n* `COUPON`: Clicking on the ad will clip the coupon and take the customer to the product detail page for that item, if signed in; otherwise take them to the coupon landing page where the customer is instructed to sign in.\n","type":"string","enum":["SHOP_NOW","ADD_TO_CART","COUPON"]},"associatedProduct":{"description":"The object representation of a product.","type":"object","properties":{"asin":{"description":"Amazon standard identification number.","type":"string"},"productTitle":{"description":"Retail product title.","type":"string"}},"required":["asin"]}},"required":["allowedSize","allowedFormat","associatedProduct"]}]}},"required":["previewConfiguration"]}}}},"responses":{"200":{"description":"Successful operation","content":{"application/vnd.dsppreviewcreativesresponse.v1+json":{"schema":{"description":"Creative preview response.","type":"object","properties":{"previewContent":{"description":"The HTML content","type":"string"}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Responsive%20eCommerce%20Creative/operation/previewRecCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/rec/preview"},"summary":"[DEPRECATED] Preview a Responsive eCommerce Creative(REC).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/thirdparty",{"tags":["Third Party Creative"],"summary":"[DEPRECATED] Get third party creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nGet a third party creative matching criteria provided in request.\n\nNote that a future update will add support to get multiple third party creatives at a time.\n","operationId":"getThirdPartyCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array is filtered to include only creatives with Ids matching those specified in the comma-delimited string.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspthirdpartycreatives.v1+json":{"schema":{"type":"object","description":"Read Third Party creative creatives response.","properties":{"creatives":{"type":"array","items":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for Third Party creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"tagSource":{"type":"string","description":"The third party tag associated with creative."},"destination":{"description":"Choose `AMAZON` if the `tag` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","allOf":[{"type":"string","description":"Choose `AMAZON` if the `click through` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","enum":["AMAZON","OTHER"],"default":"OTHER"}]},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","tagSource"]},{"type":"object","description":"Create Third Party creative request.","properties":{"supply":{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]}},"required":["supply"]}]},{"description":"Update Third Party creative request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for Third Party creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"tagSource":{"type":"string","description":"The third party tag associated with creative."},"destination":{"description":"Choose `AMAZON` if the `tag` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","allOf":[{"type":"string","description":"Choose `AMAZON` if the `click through` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","enum":["AMAZON","OTHER"],"default":"OTHER"}]},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","tagSource"]}]},{"type":"object","description":"This holds common read-only properties of all creative types.","properties":{"approvalStatus":{"type":"string","description":"The creative approval status.","enum":["PENDING","APPROVED","NOT_APPROVED","WAITING_FOR_LINEITEM","APPROVED_WITH_EXCEPTIONS"]},"createdDate":{"type":"string","description":"The creative created date."},"lastUpdatedDate":{"type":"string","description":"The creative last updated date."}}}]},"minItems":1,"maxItems":1}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Third%20Party%20Creative/operation/getThirdPartyCreatives","sectionHeader":{"type":3,"text":"GET /dsp/creatives/thirdparty"},"summary":"[DEPRECATED] Get third party creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/thirdparty",{"tags":["Third Party Creative"],"summary":"[DEPRECATED] Create third party creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nCreate a third party creative.\n\nNote that a future update will add support to create multiple third party creatives at a time.\n","operationId":"createThirdPartyCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspcreatethirdpartycreatives.v1+json":{"schema":{"description":"Create Third Party creatives request.","type":"array","items":{"allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for Third Party creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"tagSource":{"type":"string","description":"The third party tag associated with creative."},"destination":{"description":"Choose `AMAZON` if the `tag` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","allOf":[{"type":"string","description":"Choose `AMAZON` if the `click through` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","enum":["AMAZON","OTHER"],"default":"OTHER"}]},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","tagSource"]},{"type":"object","description":"Create Third Party creative request.","properties":{"supply":{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]}},"required":["supply"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspthirdpartycreativesresponse.v1+json":{"schema":{"description":"Create/Update third party creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Third%20Party%20Creative/operation/createThirdPartyCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/thirdparty"},"summary":"[DEPRECATED] Create third party creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/thirdparty",{"tags":["Third Party Creative"],"summary":"[DEPRECATED] Update third party creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nUpdate a third party creative.\n\nNote that a future update will add support to update multiple third party creatives at a time.\n","operationId":"updateThirdPartyCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspupdatethirdpartycreatives.v1+json":{"schema":{"type":"array","description":"Update Third Party creatives request.","items":{"description":"Update Third Party creative request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for Third Party creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"tagSource":{"type":"string","description":"The third party tag associated with creative."},"destination":{"description":"Choose `AMAZON` if the `tag` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","allOf":[{"type":"string","description":"Choose `AMAZON` if the `click through` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","enum":["AMAZON","OTHER"],"default":"OTHER"}]},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","tagSource"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspthirdpartycreativesresponse.v1+json":{"schema":{"description":"Create/Update third party creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Third%20Party%20Creative/operation/updateThirdPartyCreative","sectionHeader":{"type":3,"text":"PUT /dsp/creatives/thirdparty"},"summary":"[DEPRECATED] Update third party creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/thirdparty/preview",{"tags":["Third Party Creative"],"summary":"[DEPRECATED] Preview third party creative.","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nPreview a third party creative.\n","operationId":"previewThirdPartyCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A preview request.","content":{"application/vnd.dsppreviewthirdpartycreatives.v1+json":{"schema":{"description":"Third Party creative preview request. Either `creativeId` or `creativeModel` must be provided, but not both.","type":"object","properties":{"creativeId":{"description":"The identifier of the creative.","type":"string"},"creativeModel":{"description":"Third Party Creative preview model. Populate this to preview a new creative.","type":"object","properties":{"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]},"supply":{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"tagSource":{"type":"string","description":"The third party tag associated with creative."},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["marketplace","supply","size","tagSource","adChoicesPosition"]},"previewConfiguration":{"description":"Configuration settings for preview","type":"object","properties":{"isOnAmazon":{"type":"boolean","description":"If it's true, shows preview in amazon websites, else shows in other websites","default":true}}}},"required":["previewConfiguration"]}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dsppreviewcreativesresponse.v1+json":{"schema":{"description":"Creative preview response.","type":"object","properties":{"previewContent":{"description":"The HTML content","type":"string"}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Third%20Party%20Creative/operation/previewThirdPartyCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/thirdparty/preview"},"summary":"[DEPRECATED] Preview third party creative.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/moderation/creatives",{"tags":["Moderation"],"summary":"[DEPRECATED] Get creative moderation summary by creativeId.","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nGet creative moderation summary by creativeId.\n","operationId":"getCreativeModeration","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array is filtered to include only creatives with Ids matching those specified in the comma-delimited string.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspmoderationcreatives.v1+json":{"schema":{"type":"array","items":{"type":"object","description":"The creative moderation summary.","properties":{"creativeId":{"type":"string"},"status":{"type":"string","description":"The creative approval status.","enum":["PENDING","APPROVED","NOT_APPROVED","WAITING_FOR_LINEITEM","APPROVED_WITH_EXCEPTIONS"]},"reasons":{"type":"array","description":"The reasons why creative is not approved.","items":{"type":"string"},"maxItems":50},"additionalNotes":{"type":"array","description":"The additional notes.","items":{"type":"string"},"maxItems":50}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Moderation/operation/getCreativeModeration","sectionHeader":{"type":3,"text":"GET /dsp/moderation/creatives"},"summary":"[DEPRECATED] Get creative moderation summary by creativeId.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/lineItemCreativeAssociations",{"tags":["LineItemCreativeAssociation"],"summary":"[DEPRECATED] Create/delete association between line item and creative.","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nCreate/delete association between line item and creative.\n\nCallout -  Do not pass in startDate, endDate and weight. Use the PUT operation instead to populate these fields. We will add support in POST in a future update. A future update will also include support for multiple at a time.\n","operationId":"AssociateLineItemsToCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"required":["advertiserId","operation","associations"],"type":"object","properties":{"advertiserId":{"type":"string","description":"The advertiser identifier."},"operation":{"type":"string","description":"A lineItemCreativeAssociation operation.","enum":["CREATE","DELETE"]},"associations":{"type":"array","description":"A list of the associations to operate on. This object requires only lineItemId and creativeId and other fields are not required.","items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The lineitem to operate on."},"creativeId":{"type":"string","description":"The creative to operate on."},"startDate":{"type":"string","description":"The creative start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDate":{"type":"string","description":"The creative end date in in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"weight":{"type":"integer","description":"The weight of the creative. This field will be available only if the creative rotation type is `WEIGHTED`."}},"required":["lineItemId","creativeId"]},"maxItems":1,"minItems":1}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"required":["advertiserId","operation","associations"],"type":"object","properties":{"advertiserId":{"type":"string","description":"The advertiser identifier."},"operation":{"type":"string","description":"A lineItemCreativeAssociation operation.","enum":["CREATE","DELETE"]},"associations":{"type":"array","description":"A list of the associations to operate on. This object requires only lineItemId and creativeId and other fields are not required.","items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The lineitem to operate on."},"creativeId":{"type":"string","description":"The creative to operate on."},"startDate":{"type":"string","description":"The creative start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDate":{"type":"string","description":"The creative end date in in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"weight":{"type":"integer","description":"The weight of the creative. This field will be available only if the creative rotation type is `WEIGHTED`."}},"required":["lineItemId","creativeId"]},"maxItems":1,"minItems":1}}}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"Response for the update operation. This object will have either success or failure property for the corresponding requests on the index.","type":"object","properties":{"success":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The lineitem to operate on."},"creativeId":{"type":"string","description":"The creative to operate on."},"startDate":{"type":"string","description":"The creative start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDate":{"type":"string","description":"The creative end date in in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"weight":{"type":"integer","description":"The weight of the creative. This field will be available only if the creative rotation type is `WEIGHTED`."}},"required":["lineItemId","creativeId"]},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"Response for the update operation. This object will have either success or failure property for the corresponding requests on the index.","type":"object","properties":{"success":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The lineitem to operate on."},"creativeId":{"type":"string","description":"The creative to operate on."},"startDate":{"type":"string","description":"The creative start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDate":{"type":"string","description":"The creative end date in in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"weight":{"type":"integer","description":"The weight of the creative. This field will be available only if the creative rotation type is `WEIGHTED`."}},"required":["lineItemId","creativeId"]},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/LineItemCreativeAssociation/operation/AssociateLineItemsToCreatives","sectionHeader":{"type":3,"text":"POST /dsp/lineItemCreativeAssociations"},"summary":"[DEPRECATED] Create/delete association between line item and creative.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/geoLocations",{"tags":["Discovery"],"summary":"Gets locationTargeting objects based on locationTargetingId or text query","description":"Gets location targeting objects based on geoLocationID(s) or a text query (country, state, city, postal code, or DMA). Either geoLocationIdFilter or textQuery must be supplied, but not both. \n\nText Query Examples:\n\nWhen you search for \"California States\", only the state of California is returned.\\\nWhen you search for \"California counties\" only the counties in California are returned.\\\nWhen you search for \"California postal\" only the zip codes in California are returned.\\\nWhen you search for \"California cities\" only the cities in California are returned.\\\nWhen you search for \"US states\" all of the US states are returned.\\\nWhen you search for \"US states A\" only the US states beginning with A are returned.\\\nWhen you search for \"US DMAs\" only the DMAs in the US are returned.\\\nWhen you search for \"US postal\" only the postal codes in the US are returned.\n","operationId":"getGeoLocations","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"in":"query","name":"geoLocationIdFilter","schema":{"type":"array","items":{"type":"string"}},"description":"An array of location IDs to retrieve, up to 10 in one request.","required":false},{"in":"query","name":"textQuery","schema":{"type":"string"},"description":"Filter by text such as city, state, country, dma, or postal code. Retrieves top 100 results in decreasing order of relevancy. Results may be paginated to retrieve these items in pages, but no query will return more than 100 items total.","required":false},{"in":"query","name":"nextToken","schema":{"type":"string"},"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","required":false},{"in":"query","name":"maxResults","schema":{"type":"integer","minimum":1,"default":10,"maximum":2000},"description":"Sets the maximum number of locations in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,2000] with default as 10. For example, supplying maxResults=20 with a previously returned token will fetch up to the next 20 items. In some cases, fewer items may be returned.","required":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"geoLocations":{"type":"array","description":"Array of results matching the given IDs or text query","items":{"type":"object","description":"Single geo location information.","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Name of geo location."},"category":{"type":"string","description":"Category of the geo location.","enum":["COUNTRY","STATE","CITY","POSTAL_CODE","DMA"]}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"403":{"description":"Forbidden. The request failed because the user does not have access to the specified resource.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}}}],"path":"/en-us/dsp-campaigns#tag/Discovery/operation/getGeoLocations","sectionHeader":{"type":3,"text":"GET /dsp/geoLocations"},"summary":"Gets locationTargeting objects based on locationTargetingId or text query","documentType":"api-reference"},{"title":"Inventory Groups","content":["Inventory Groups Public API\n"],"path":"/en-us/dsp-inventory-groups","sectionHeader":{"type":2,"text":"Inventory Groups"},"documentType":"api-reference"},{"title":"Inventory Groups","content":["/dsp/v1/inventory/inventoryGroups/list",{"summary":"Gets a list of inventory groups.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"maxResults":{"default":"50","description":"Sets the maximum number of results in the response. Used in conjunction with `nextToken` to control pagination.","maximum":100,"type":"integer","minimum":1},"nextToken":{"description":"To retrieve the next page of paginated results, specify this token in the request.","type":"string"}}},{"description":"Field by which to sort the results.","type":"object","properties":{"sortOrder":{"description":"The direction by which to sort the results.","type":"string","enum":["ASCENDING","DESCENDING"]},"sortField":{"description":"The field by which to sort the results. Defaults to `CREATION_DATE_TIME` if unspecified.","type":"string","enum":["INVENTORY_GROUP_ID","INVENTORY_GROUP_NAME","INVENTORY_TYPE","CREATION_DATE_TIME"]}}},{"allOf":[{"type":"object","properties":{"isAmazonCuratedFilter":{"nullable":true,"description":"If true, the inventory group was created by Amazon.","type":"boolean"},"inventoryGroupIdFilter":{"minItems":0,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75}},"inventoryGroupNameFilter":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"inventoryTypeFilter":{"minItems":0,"maxItems":6,"uniqueItems":true,"type":"array","items":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]}}}}],"type":"object","properties":{"inventoryTypeFilter":{"minItems":0,"maxItems":6,"uniqueItems":true,"type":"array","items":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]}}}}],"type":"object"}}}},"description":"Gets a list of inventory groups based on the sorting and filtering criteria provided in the request.","operationId":"DspApiListInventoryGroupsV1","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"totalResults":{"description":"The total number of results across all pages.","type":"integer","minimum":0},"nextToken":{"description":"Used for pagination, a string that can be sent in the next request to get the next page of results.","type":"string"}}}],"type":"object","properties":{"inventoryGroups":{"minItems":0,"maxItems":100,"description":"The inventory groups returned.","type":"array","items":{"type":"object","properties":{"inventoryType":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]},"inventoryGroupName":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"inventoryGroupId":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75},"dealIds":{"minItems":0,"maxItems":100,"description":"The IDs of the deals included in the inventory group.","type":"array","items":{"type":"string"}},"isAmazonCurated":{"nullable":true,"description":"If true, the inventory group was created by Amazon.","type":"boolean"},"creationDateTime":{"format":"date-time","type":"string"}},"required":["inventoryGroupId","inventoryGroupName","dealIds","creationDateTime"]}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"415":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"429":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Service Failure.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a &quot;Login with Amazon&quot; account.","required":true},{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":false}],"tags":["Inventory Group"]}],"path":"/en-us/dsp-inventory-groups#tag/Inventory%20Group/operation/DspApiListInventoryGroupsV1","sectionHeader":{"type":3,"text":"POST /dsp/v1/inventory/inventoryGroups/list"},"summary":"Gets a list of inventory groups.","documentType":"api-reference"},{"title":"Inventory Groups","content":["/dsp/v1/inventory/inventoryGroups",{"summary":"Creates a new inventory group.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"inventoryType":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]},"inventoryGroupName":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"dealIds":{"minItems":0,"maxItems":100,"description":"The IDs of the deals included in the inventory group.","type":"array","items":{"type":"string"}}},"required":["inventoryGroupName","dealIds","inventoryType"]}],"type":"object"}}}},"description":"Creates a new inventory group with the configuration provided in the request body.","operationId":"DspApiCreateInventoryGroupV1","responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"inventoryGroupId":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"415":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"429":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Service Failure.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a &quot;Login with Amazon&quot; account.","required":true},{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":false}],"tags":["Inventory Group"]}],"path":"/en-us/dsp-inventory-groups#tag/Inventory%20Group/operation/DspApiCreateInventoryGroupV1","sectionHeader":{"type":3,"text":"POST /dsp/v1/inventory/inventoryGroups"},"summary":"Creates a new inventory group.","documentType":"api-reference"},{"title":"Inventory Groups","content":["/dsp/v1/inventory/inventoryGroups",{"summary":"Updates an inventory group.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"inventoryGroupName":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"inventoryGroupId":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75},"dealIds":{"minItems":0,"maxItems":100,"description":"The IDs of the deals included in the inventory group.","type":"array","items":{"type":"string"}}}}],"type":"object"}}}},"description":"Updates an inventory group by overwriting the existing metadata with the content in the request object.","operationId":"DspApiUpdateInventoryGroupV1","responses":{"204":{"description":"No content."},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"404":{"description":"Resource Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"415":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"429":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Service Failure.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a &quot;Login with Amazon&quot; account.","required":true},{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":false}],"tags":["Inventory Group"]}],"path":"/en-us/dsp-inventory-groups#tag/Inventory%20Group/operation/DspApiUpdateInventoryGroupV1","sectionHeader":{"type":3,"text":"PUT /dsp/v1/inventory/inventoryGroups"},"summary":"Updates an inventory group.","documentType":"api-reference"},{"title":"Inventory Groups","content":["/dsp/v1/inventory/eligibility/inventoryGroups/list",{"summary":"Gets the eligible inventory groups for the specified inventory type.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"maxResults":{"default":"50","description":"Sets the maximum number of results in the response. Used in conjunction with `nextToken` to control pagination.","maximum":100,"type":"integer","minimum":1},"nextToken":{"description":"To retrieve the next page of paginated results, specify this token in the request.","type":"string"}}},{"description":"Field by which to sort the results.","type":"object","properties":{"sortOrder":{"description":"The direction by which to sort the results.","type":"string","enum":["ASCENDING","DESCENDING"]},"sortField":{"description":"The field by which to sort the results. Defaults to `CREATION_DATE_TIME` if unspecified.","type":"string","enum":["INVENTORY_GROUP_ID","INVENTORY_GROUP_NAME","INVENTORY_TYPE","CREATION_DATE_TIME"]}}},{"allOf":[{"type":"object","properties":{"isAmazonCuratedFilter":{"nullable":true,"description":"If true, the inventory group was created by Amazon.","type":"boolean"},"inventoryGroupIdFilter":{"minItems":0,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75}},"inventoryGroupNameFilter":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"inventoryTypeFilter":{"minItems":0,"maxItems":6,"uniqueItems":true,"type":"array","items":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]}}}}],"type":"object","properties":{"inventoryTypeFilter":{"minItems":1,"maxItems":6,"uniqueItems":true,"type":"array","items":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]}}},"required":["inventoryTypeFilter"]}],"type":"object"}}}},"description":"Gets the eligible inventory groups for the specified inventory type.","operationId":"DspApiListEligibleInventoryGroupsV1","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"totalResults":{"description":"The total number of results across all pages.","type":"integer","minimum":0},"nextToken":{"description":"Used for pagination, a string that can be sent in the next request to get the next page of results.","type":"string"}}}],"type":"object","properties":{"inventoryGroups":{"minItems":0,"maxItems":100,"description":"The inventory groups returned.","type":"array","items":{"type":"object","properties":{"inventoryType":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]},"inventoryGroupName":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"inventoryGroupId":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75},"dealIds":{"minItems":0,"maxItems":100,"description":"The IDs of the deals included in the inventory group.","type":"array","items":{"type":"string"}},"isAmazonCurated":{"nullable":true,"description":"If true, the inventory group was created by Amazon.","type":"boolean"},"creationDateTime":{"format":"date-time","type":"string"}},"required":["inventoryGroupId","inventoryGroupName","dealIds","creationDateTime"]}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"415":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"429":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Service Failure.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}}},"parameters":[{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a &quot;Login with Amazon&quot; account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":false}],"tags":["Inventory Group"]}],"path":"/en-us/dsp-inventory-groups#tag/Inventory%20Group/operation/DspApiListEligibleInventoryGroupsV1","sectionHeader":{"type":3,"text":"POST /dsp/v1/inventory/eligibility/inventoryGroups/list"},"summary":"Gets the eligible inventory groups for the specified inventory type.","documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["Use to create, read, or update audience metadata and to add or remove audience records. For onboarding information, see setting up for the Amazon Ads API.\n"],"path":"/en-us/data-provider/openapi","sectionHeader":{"type":2,"text":"Amazon Ads API for Data Providers."},"documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["/v2/dp/audiencemetadata/",{"tags":["Metadata"],"summary":"Creates a new data provider audience. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","parameters":[{"in":"header","name":"Authorization","description":"A valid access token.","schema":{"type":"string"},"example":"Bearer Atza|IQEBLjAsAhRmHjNgHpi0UDme37rR6CuUpSR","required":true},{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The `Content-Type` is application/json.","example":"application/json","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","description","advertiserId","metadata"],"properties":{"name":{"type":"string","description":"The audience name. Must be an alphanumeric string between 10 to 128 characters in length."},"description":{"type":"string","description":"The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length."},"advertiserId":{"type":"integer","format":"int64","description":"The advertiser identifier."},"metadata":{"type":"object","required":["type","externalAudienceId","dataSourceCountry"],"properties":{"type":{"type":"string","description":"The audience metadata type. Only 'DATA_PROVIDER' is currently supported.","enum":["DATA_PROVIDER"]},"externalAudienceId":{"type":"string","description":"The user-defined audience identifier."},"ttl":{"type":"integer","description":"Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.","minimum":0,"maximum":34300800},"audienceFees":{"type":"array","items":{"type":"object","required":["cpmCents","currency"],"description":"Object describing the audience fee.","properties":{"cpmCents":{"type":"integer","description":"Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents."},"currency":{"type":"string","description":"Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.","enum":["USD","CAD","JPY","GBP","EUR","AUD","AED","SAR","MXN","INR","SEK","TRY","BRL"]}}}},"dataSourceCountry":{"type":"array","description":"A list of country codes describing where data in an audience is collected from. Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":["US","CA"],"items":{"type":"string","description":"Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":"GB"}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"audience":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The"},"name":{"type":"string","description":"The audience name. Must be an alphanumeric string between 10 to 128 characters in length."},"description":{"type":"string","description":"The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length."},"advertiserId":{"type":"integer","format":"int64","description":"The advertiser identifier."},"metadata":{"type":"object","properties":{"type":{"type":"string","description":"The audience metadata type. Only 'DATA_PROVIDER' is currently supported.","enum":["DATA_PROVIDER"]},"externalAudienceId":{"type":"string","description":"The user-defined audience identifier."},"ttl":{"type":"integer","description":"Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.","minimum":0,"maximum":34300800},"audienceFees":{"type":"array","items":{"type":"object","required":["cpmCents","currency"],"description":"Object describing the audience fee.","properties":{"cpmCents":{"type":"integer","description":"Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents."},"currency":{"type":"string","description":"Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.","enum":["USD","CAD","JPY","GBP","EUR","AUD","AED","SAR","MXN","INR","SEK","TRY","BRL"]}}}},"dataSourceCountry":{"type":"array","description":"A list of country codes describing where data in an audience is collected from. Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":["US","CA"],"items":{"type":"string","description":"Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":"GB"}}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"403":{"description":"The client is not allowed to update the audience.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"404":{"description":"The specified identifier was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"429":{"description":"The client exceeded the allowed number of requests..","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"503":{"description":"The service is unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}}}}],"path":"/en-us/data-provider/openapi#tag/Metadata","sectionHeader":{"type":3,"text":"POST /v2/dp/audiencemetadata/"},"summary":"Creates a new data provider audience. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["/v2/dp/audiencemetadata/{audienceId}",{"tags":["Metadata"],"summary":"Updates metadata of an existing audience specified by identifier. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","parameters":[{"in":"header","name":"Authorization","description":"A valid access token.","schema":{"type":"string"},"example":"Bearer Atza|IQEBLjAsAhRmHjNgHpi0UDme37rR6CuUpSR","required":true},{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The `Content-Type` is application/json.","example":"application/json","required":true},{"name":"audienceId","in":"path","required":true,"description":"The audience identifier.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"A data provider audience object with updated values.","properties":{"description":{"type":"string","description":"The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length."},"metadata":{"type":"object","properties":{"ttl":{"type":"integer","description":"Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.","minimum":0,"maximum":34300800},"audienceFees":{"type":"array","items":{"type":"object","required":["cpmCents","currency"],"description":"Object describing the audience fee.","properties":{"cpmCents":{"type":"integer","description":"Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents."},"currency":{"type":"string","description":"Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.","enum":["USD","CAD","JPY","GBP","EUR","AUD","AED","SAR","MXN","INR","SEK","TRY","BRL"]}}}},"dataSourceCountry":{"type":"array","description":"A list of country codes describing where data in an audience is collected from. Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":["US","CA"],"items":{"type":"string","description":"Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":"GB"}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"audience":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The"},"name":{"type":"string","description":"The audience name. Must be an alphanumeric string between 10 to 128 characters in length."},"description":{"type":"string","description":"The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length."},"advertiserId":{"type":"integer","format":"int64","description":"The advertiser identifier."},"metadata":{"type":"object","properties":{"type":{"type":"string","description":"The audience metadata type. Only 'DATA_PROVIDER' is currently supported.","enum":["DATA_PROVIDER"]},"externalAudienceId":{"type":"string","description":"The user-defined audience identifier."},"ttl":{"type":"integer","description":"Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.","minimum":0,"maximum":34300800},"audienceFees":{"type":"array","items":{"type":"object","required":["cpmCents","currency"],"description":"Object describing the audience fee.","properties":{"cpmCents":{"type":"integer","description":"Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents."},"currency":{"type":"string","description":"Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.","enum":["USD","CAD","JPY","GBP","EUR","AUD","AED","SAR","MXN","INR","SEK","TRY","BRL"]}}}},"dataSourceCountry":{"type":"array","description":"A list of country codes describing where data in an audience is collected from. Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":["US","CA"],"items":{"type":"string","description":"Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":"GB"}}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"403":{"description":"The client is not allowed to update the audience.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"404":{"description":"The specified identifier was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"429":{"description":"The client exceeded the allowed number of requests..","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"503":{"description":"The service is unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}}}}],"path":"/en-us/data-provider/openapi#tag/Metadata","sectionHeader":{"type":3,"text":"PUT /v2/dp/audiencemetadata/{audienceId}"},"summary":"Updates metadata of an existing audience specified by identifier. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["/v2/dp/audiencemetadata/{audienceId}",{"tags":["Metadata"],"summary":"Gets metadata for an audience specified by identifier. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","parameters":[{"in":"header","name":"Authorization","description":"A valid access token.","schema":{"type":"string"},"example":"Bearer Atza|IQEBLjAsAhRmHjNgHpi0UDme37rR6CuUpSR","required":true},{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The `Content-Type` is application/json.","example":"application/json","required":true},{"name":"audienceId","in":"path","required":true,"description":"The audience identifier.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"audience":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The"},"name":{"type":"string","description":"The audience name. Must be an alphanumeric string between 10 to 128 characters in length."},"description":{"type":"string","description":"The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length."},"advertiserId":{"type":"integer","format":"int64","description":"The advertiser identifier."},"metadata":{"type":"object","properties":{"type":{"type":"string","description":"The audience metadata type. Only 'DATA_PROVIDER' is currently supported.","enum":["DATA_PROVIDER"]},"externalAudienceId":{"type":"string","description":"The user-defined audience identifier."},"ttl":{"type":"integer","description":"Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.","minimum":0,"maximum":34300800},"audienceFees":{"type":"array","items":{"type":"object","required":["cpmCents","currency"],"description":"Object describing the audience fee.","properties":{"cpmCents":{"type":"integer","description":"Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents."},"currency":{"type":"string","description":"Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.","enum":["USD","CAD","JPY","GBP","EUR","AUD","AED","SAR","MXN","INR","SEK","TRY","BRL"]}}}},"audienceSize":{"type":"object","description":"Information about the size of the audience.","properties":{"receivedRecordSize":{"type":"integer","description":"The number of received records."},"matchedRecordSize":{"type":"integer","description":"The number of matched records."},"matchRate":{"type":"number","format":"float","description":"The match rate.","minimum":0,"maximum":1}}},"dataSourceCountry":{"type":"array","description":"A list of country codes describing where data in an audience is collected from. Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":["US","CA"],"items":{"type":"string","description":"Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":"GB"}}}}}}}}}}},"403":{"description":"The client is not allowed to update the audience.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"404":{"description":"The specified identifier was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"429":{"description":"The client exceeded the allowed number of requests..","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"503":{"description":"The service is unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}}}}],"path":"/en-us/data-provider/openapi#tag/Metadata","sectionHeader":{"type":3,"text":"GET /v2/dp/audiencemetadata/{audienceId}"},"summary":"Gets metadata for an audience specified by identifier. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["/v2/dp/audience",{"summary":"Associates or disassociates a record with an audience. Note that the API call rate is limited to 100 transactions per second (TPS). Calls exceeding this rate are throttled. Payload size is limited to a maximum of 6MB or 2000 records. Calls with a payload exceeding limit receive a 413 response.","tags":["Add or remove records"],"parameters":[{"in":"header","name":"Authorization","description":"A valid access token.","schema":{"type":"string"},"example":"Bearer Atza|IQEBLjAsAhRmHjNgHpi0UDme37rR6CuUpSR","required":true},{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The `Content-Type` is application/json.","example":"application/json","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patches":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","description":"Specifies the type of operation. Valid operations are `add` or `remove`.","enum":["add","remove"]},"path":{"type":"string","format":"/<recordIdType>-<recordIdValue>/audiences","example":"/COOKIE-EMpBAI0GRcK4nBNGpPGg5g/audiences","description":"A formatted string that specifies the URL of the record. The format of the string is `/<recordIdType>-<recordIdValue>/audiences`, where 'recordIdType' specifies the record's origin and 'recordIdValue' specifies the record's Id. Valid 'recordIdType' values are `COOKIE`, a cookie Id sent from a data provider to Amazon by a cookie sync; `MAID`, a mobile advertising identifier; `EXTERNAL_USER_ID`, an external id defined by data providers."},"value":{"type":"array","items":{"type":"integer","format":"int64","description":"An integer value representing the Amazon audience identifer. This is the identifier that is returned during audience creation.","example":72057594038053890}},"consent":{"type":"object","description":"An object that contains user consent. Only one type of consent(TCF, GPP, amazonConsent) should be provided.","discriminator":{"propertyName":"consentType","mapping":{"TCF":"#/components/schemas/tcf","GPP":"#/components/schemas/gpp","Amazon":"#/components/schemas/amazonConsent"}},"properties":{"consentType":{"type":"string","description":"The type of consent provided.","enum":["TCF","GPP","Amazon"]},"tcf":{"type":"string","description":"TCF(Transparency & Consent Framework) consent string that wraps privacy consent information from user.","example":"CQB4ySFQB4ySFBlAAAENCZCAAAAAAAAAAAAAAAAAAAAA.II7Nd_X__bX9n-_7_6ft0eY1f9_r37uQzDhfNs-8F3L_W_LwX32E7NF36tq4KmR4ku1bBIQNtHMnUDUmxaolVrzHsak2cpyNKJ_JkknsZe2dYGF9Pn9lD-YKZ7_5_9_f52T_9_9_-39z3_9f___dv_-__-vjf_599n_v9fV_78_Kf9______-____________8A"},"gpp":{"type":"string","description":"GPP(Global Privacy Platform) consent string that wraps privacy consent information from user.","example":"DBADMZg~CQB2TAAQB2TAAPoABABGA9EAAAAAAAAAAAAAAAAAAAAA.QAAA.IAAA~BQB2TAAQB2TAAPoABABGBZCAAAAAAAgAAAAAAAAAAA.YAAAAAAAAAA~BAAAAAAAAQA.QA"},"amazonConsent":{"type":"object","properties":{"amazonAdStorage":{"type":"string","description":"Set consent for advertising related storage such as cookies(web) or device identifiers(apps).","enum":["GRANTED","DENIED"]},"amazonUserData":{"type":"string","description":"Set consent to use personal data for online advertising purposes.","enum":["GRANTED","DENIED"]}},"required":["amazonAdStorage","amazonUserData"],"example":{"amazonAdStorage":"GRANTED","amazonUserData":"GRANTED"}}}}}}}}}}}},"responses":{"200":{"description":"The request to add or remove an audience was submitted. Note that requests can take up to two hours to be processed.","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","description":"A unique identifier representing the workflow of the submitted request.","example":"f076ddd9-3f84-44e8-b5cf-742b08f2bc9f"},"requestId":{"type":"string","description":"A unique identifier representing the request.","example":"F88750355N-B70JY53CSD"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"413":{"description":"Input Too Large.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":413},"description":{"description":"Description of the error.","type":"string","example":"Input Too Large"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"INPUT_TOO_LARGE"},"message":{"description":"Error message","type":"string","example":"The input payload exceeds 1MB limit."}}}}}}}}}}},"429":{"description":"The client exceeded the allowed number of requests..","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"503":{"description":"The service is unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}}}}],"path":"/en-us/data-provider/openapi#tag/Add%20or%20remove%20records","sectionHeader":{"type":3,"text":"PATCH /v2/dp/audience"},"summary":"Associates or disassociates a record with an audience. Note that the API call rate is limited to 100 transactions per second (TPS). Calls exceeding this rate are throttled. Payload size is limited to a maximum of 6MB or 2000 records. Calls with a payload exceeding limit receive a 413 response.","documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["/v2/dp/users",{"description":"Deletes user data sourced from data providers. Deletes users scoped either to an advertiser or for the data provider. The SLA for data deletion is 30 days.","summary":"Deletes user data originally sourced from the client. The API call rate is limited to 1 transactions per second (TPS). Calls exceeding this rate are throttled. Payload size is limited to 1000 users or 1MB. Calls with a more than 1000 users or 1MB will receive a 413 response.","tags":["User deletion"],"parameters":[{"in":"header","name":"Authorization","schema":{"type":"string"},"description":"A valid access token. ","example":"Bearer Atza|IQEBLjAsAhRmHjNgHpi0UDme37rR6CuUpSR","required":true},{"in":"header","name":"Amazon-Advertising-API-ClientID","schema":{"type":"string"},"description":"The client identifier.","example":"amzn1.application-oa2-client.8baa9caa3eac48eab89780e73ce03b19","required":true},{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The Content-Type is `application/json`.","example":"application/json","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"object","properties":{"type":{"type":"string","description":"Specifies the type of the user identifier.","enum":["COOKIE","MAID","EXTERNAL_USER_ID"]},"value":{"type":"string","description":"The user identifer."}}},"advertiserId":{"type":"string","description":"The advertiser identifier. If present, the user data for the specified advertiser is deleted. Otherwise, all data about this user sourced from this client is deleted.","example":205759403805},"consentTime":{"type":"integer","format":"int64","description":"User consent time in epoch milliseconds","example":1581557890000}}}},"operation":{"type":"string","enum":["DELETE"]}}},"example":{"users":[{"userId":{"type":"COOKIE","value":"EMpBAI0GRcK4nBNGpPGg5g"},"advertiserId":205759403805,"consentTime":1581557890000},{"userId":{"type":"COOKIE","value":"EMpBAI0GRcK4nBNGpPGg5g"},"advertiserId":305759403805,"consentTime":1581557900000}],"operation":"DELETE"}}}},"responses":{"202":{"description":"The request to delete user data was submitted.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","description":"A unique identifier representing the request.","example":"F88750355N-B70JY53CSD"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":400},"description":{"description":"Description of the error.","type":"string","example":"Bad Request"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"Error message","type":"string","example":"The inputs that you provided are not valid."}}}}}}}}}}},"413":{"description":"Input Too Large.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":413},"description":{"description":"Description of the error.","type":"string","example":"Input Too Large"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"INPUT_TOO_LARGE"},"message":{"description":"Error message","type":"string","example":"The input payload exceeds 1MB limit."}}}}}}}}}}},"429":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":429},"description":{"description":"Description of the error.","type":"string","example":"Too Many Requests"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"TOO_MANY_REQUESTS"},"message":{"description":"Error message","type":"string","example":"The number of requests exceeded 100 TPS."}}}}}}}}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":500},"description":{"description":"Description of the error.","type":"string","example":"Internal Error"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"INTERNAL_ERROR"},"message":{"description":"Error message","type":"string","example":"Internal error."}}}}}}}}}}},"503":{"description":"Server Unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":503},"description":{"description":"Description of the error.","type":"string","example":"Service unavailable"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"SERVICE_UNAVAILABLE"},"message":{"description":"Error message","type":"string","example":"Service unavailable."}}}}}}}}}}}}}],"path":"/en-us/data-provider/openapi#tag/User%20deletion","sectionHeader":{"type":3,"text":"PATCH /v2/dp/users"},"summary":"Deletes user data originally sourced from the client. The API call rate is limited to 1 transactions per second (TPS). Calls exceeding this rate are throttled. Payload size is limited to 1000 users or 1MB. Calls with a more than 1000 users or 1MB will receive a 413 response.","documentType":"api-reference"},{"title":"Creative assets","content":["Use the creative assets API to create and manage video and image assets for use in Amazon Ads campaigns. For details on using this API, see Creatives overview.\n"],"path":"/en-us/creative-asset-library","sectionHeader":{"type":2,"text":"Creative assets"},"documentType":"api-reference"},{"title":"Creative assets","content":["/assets",{"summary":"Retrieve an asset","operationId":"getAsset","responses":{"200":{"description":"Returns asset metadata.","content":{"application/vnd.creativeassetsgetresponse.v3+json":{"schema":{"type":"object","properties":{"assetVersionList":{"minItems":1,"maxItems":100,"description":"The asset version list.","type":"array","items":{"type":"object","properties":{"lastUpdatedBy":{"type":"string"},"creationTime":{"format":"int64","type":"integer"},"specCheckApprovedPrograms":{"description":"List of spec programs for which asset spec check is approved","type":"array","items":{"type":"string","enum":["SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","SPONSORED_DISPLAY_LANDSCAPE_VIDEO","SPONSORED_DISPLAY_PORTRAIT_VIDEO","SPONSORED_DISPLAY_SQUARE_VIDEO","STORES_VIDEO_TILE","STORES_BACKGROUND_VIDEO_TILE","STORES_INTRO_SPLASH","FIRE_TV_FEATURE_ROTATOR","SPONSORED_TV","SPONSORED_BRANDS_VIDEO_PORTRAIT","DEMAND_SIDE_PLATFORM_OTT","DEMAND_SIDE_PLATFORM_OLV","DEMAND_SIDE_PLATFORM_H1_DESKTOP","DEMAND_SIDE_PLATFORM_H1_MOBILE","LIVE_IMAGE_SPONSORED_DISPLAY"]}},"assetIdentifier":{"type":"object","properties":{"assetId":{"description":"The asset identifier.","type":"string"},"version":{"description":"The version of the asset.","type":"string"}}},"assetFiles":{"description":"Structure containing processed transcode files for an asset\n defaultUrl: This is the location of the original source.\n processedFiles: List of processed files with metadata.","type":"object","properties":{"processedFiles":{"type":"array","items":{"description":"Structure containing url, program, profile and metadata of processed output\n program: This is the program for which this transcoding is done.\n profile: This is the profile/outformat of the processed file.\n url: This is the location of the processed file.\n fileMetadata: This contains the metadata of file.","type":"object","properties":{"fileMetadata":{"description":"Structure containing metadata of processed file.\n contentHash: This is the location of the original source.\n contentType: This is the location of the original source.\n videoStreams: This contains the metadata of Video streams.\n audioStreams: This contains the metadata of Audio streams.","type":"object","properties":{"videoStreams":{"type":"array","items":{"description":"Structure containing metadata of Video Stream.\n profile: This is the profile of the stream.\n width: This is the resolution width of stream.\n height: This is the resolution height of stream.\n duration: This is the duration of the stream in secs.\n codecName: This tells the codec of the media stream.\n codecType: This is the codec type of stream.\n displayAspectRatio: This tells the aspect ratio of the stream.\n bitRate: This tells the bit rate of the stream.\n frameRate: This is the frame rate of video stream per sec.","type":"object","properties":{"duration":{"format":"double","type":"number"},"frameRate":{"format":"double","type":"number"},"bitRate":{"format":"int64","type":"integer"},"profile":{"type":"string"},"width":{"type":"integer"},"codecName":{"type":"string"},"codecType":{"type":"string"},"height":{"type":"integer"},"displayAspectRatio":{"type":"string"}}}},"audioStreams":{"type":"array","items":{"description":"Structure containing metadata of Video Stream.\n profile: This is the profile of the stream.\n duration: This is the duration of the stream in secs.\n codecName: This tells the codec of the media stream.\n codecType: This is the codec type of stream.\n bitRate: This tells the bit rate of the stream.\n channelLayout: This tells the channel of the stream\n sampleRate: This is the sample rate of the stream","type":"object","properties":{"duration":{"format":"double","type":"number"},"channelLayout":{"type":"string"},"bitRate":{"format":"int64","type":"integer"},"profile":{"type":"string"},"codecName":{"type":"string"},"codecType":{"type":"string"},"sampleRate":{"format":"int64","type":"integer"}}}},"contentType":{"type":"string"},"contentHash":{"type":"string"}}},"profile":{"description":"Enum containing different type of processed urls\n1. `MODERATION`: This is an internal url that will be used to moderate the asset.\n2. `IMAGE_THUMBNAIL_500`: This is the url for image asset type to support thumbnail rendering of max side 500px.\n3. `VIDEO_DEFAULT_OPTIMIZED`: This is the default processed url for video asset type for optimized rendering.\n4. `PRODUCT_VIDEO_OPTIMIZED`: This is the processed url for video that can be used for product.\n5. `BACKGROUND_VIDEO_TILE`: This is the processed url for video that can be used for background video tile.\n6. `VIDEO_TILE`: This is the processed url for video that can be used for video tile.\n7. `INTRO_SPLASH`: This is the processed url for video that can be used for intro splash.\n8. `MP4_260KBS_25FPS_48KHZ_64KBS_180P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 260KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 64KBS audio bit rate, 180p height and generated with codec profile H.264/ Baseline.\n9. `MP4_300KBS_15FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 300KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height.\n10. `MP4_300KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 300KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline.\n11. `MP4_320KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 320KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 576p height and generated with codec profile H.264/ High.\n12. `MP4_375KBS_30FPS_48KHZ_192KBS_360P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 375KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 360p height and generated with codec profile H.264/ High.\n13. `MP4_450KBS_15FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 450KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height. \n14. `MP4_450KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 450KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline.\n15. `MP4_600KBS_15FPS_48KHZ_96KBS_480P`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 480p height. \n16. `MP4_600KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 480p height and generated with codec profile H.264/ Baseline.\n17. `MP4_600KBS_25FPS_48KHZ_128KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline.\n18. `MP4_600KBS_30FPS_48KHZ_128KBS_360P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 600KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 360p height and generated with codec profile H.264/ Baseline.\n19. `MP4_700KBS_24FPS_48KHZ_96KBS_360P`: This is the processed url for video that can be used with mp4 container, 700KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 360p height.\n20. `MP4_750KBS_30FPS_48KHZ_192KBS_432P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 750KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 432p height and generated with codec profile H.264/ High.\n21. `MP4_750KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 750KBS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 576p height and generated with codec profile H.264/ High.\n22. `MP4_900KBS_15FPS_48KHZ_96KBS_480P`: This is the processed url for video that can be used with mp4 container, 900KBS bitrate, 15fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 480p height. \n23. `MP4_900KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE`: This is the processed url for video that can be used with mp4 container, 900KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 480p height and generated with codec profile H.264/ Baseline.\n24. `MP4_1350KBS_30FPS_48KHZ_96KBS_720P`: This is the processed url for video that can be used with mp4 container, 1350KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 720p height. \n25. `MP4_1350KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.35MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 720p height and generated with codec profile H.264/ High.\n26. `MP4_1350KBS_25FPS_48KHZ_128KBS_540P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 1.35MBPS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 540p height and generated with codec profile H.264/ Main.\n27. `MP4_1500KBS_24FPS_48KHZ_96KBS_576P`: This is the processed url for video that can be used with mp4 container, 1500KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 576p height.\n28. `MP4_1500KBS_30FPS_48KHZ_192KBS_540P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.5MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 540p height and generated with codec profile H.264/ High.\n29. `MP4_1500KBS_25FPS_48KHZ_128KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 1.5MBPS bitrate, 25fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 576p height and generated with codec profile H.264/ High.\n30. `MP4_2000KBS_30FPS_48KHZ_96KBS_720P`: This is the processed url for video that can be used with mp4 container, 2000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 720p height. \n31. `MP4_2000KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate, 720p height and generated with codec profile H.264/ High.\n32. `MP4_2000KBS_30FPS_48KHZ_192KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 720p height and generated with codec profile H.264/ High.\n33. `MP4_2100KBS_30FPS_48KHZ_192KBS_576P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 2.1MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 576p height and generated with codec profile H.264/ High.\n34. `MP4_2100KBS_30FPS_48KHZ_192KBS_480P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 2.1MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 480p height and generated with codec profile H.264/ Main.\n35. `MP4_3400KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 3.4MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High.\n36. `MP4_3500KBS_24FPS_48KHZ_96KBS_1080P`: This is the processed url for video that can be used with mp4 container, 3500KBS bitrate, 24fps(frame per sec), 48KHZ sampleRate, 96KBS audio bit rate and 1080p height.\n37. `MP4_3500KBS_30FPS_48KHZ_128KBS_720P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 3.5MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 128KBS audio bit rate, 720p height and generated with codec profile H.264/ High.\n38. `MP4_4000KBS_30FPS_48KHZ_192KBS_1080P`: This is the processed url for video that can be used with mp4 container, 4000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate and 1080p height. \n39. `MP4_4000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 4MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High.\n40. `MP4_10000KBS_30FPS_48KHZ_320KBS_1080P`: This is the processed url for video that can be used with mp4 container, 10000KBS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 320KBS audio bit rate and 1080p height. \n41. `MP4_10000KBS_30FPS_48KHZ_320KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 10MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 320KBS audio bit rate, 1080p height and generated with codec profile H.264/ High.\n42. `MP4_20000KBS_AUTOFPS_48KHZ_320KBS`: This is the processed url for video that can be used with mp4 container, 20000KBS bitrate, auto fps, 48KHZ sampleRate, 320KBS audio bit rate.\n43. `MP4_20000KBS_AUTOFPS_48KHZ_320KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 20MBPS bitrate, auto fps, 48KHZ sampleRate, 320KBS audio bit rate, 1080p height and generated with codec profile H.264/ High.\n44. `MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH`: This is the processed url for video that can be used with mp4 container, 25MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ High.\n45. `MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_MAIN`: This is the processed url for video that can be used with mp4 container, 25MBPS bitrate, 30fps(frame per sec), 48KHZ sampleRate, 192KBS audio bit rate, 1080p height and generated with codec profile H.264/ Main.","type":"string","enum":["MODERATION","IMAGE_THUMBNAIL_500","VIDEO_DEFAULT_OPTIMIZED","PRODUCT_VIDEO_OPTIMIZED","BACKGROUND_VIDEO_TILE","VIDEO_TILE","INTRO_SPLASH","MP4_260KBS_25FPS_48KHZ_64KBS_180P_H264_BASELINE","MP4_300KBS_15FPS_48KHZ_96KBS_360P","MP4_300KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE","MP4_320KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH","MP4_375KBS_30FPS_48KHZ_192KBS_360P_H264_HIGH","MP4_450KBS_15FPS_48KHZ_96KBS_360P","MP4_450KBS_30FPS_48KHZ_96KBS_360P_H264_BASELINE","MP4_600KBS_15FPS_48KHZ_96KBS_480P","MP4_600KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE","MP4_600KBS_25FPS_48KHZ_128KBS_360P_H264_BASELINE","MP4_600KBS_30FPS_48KHZ_128KBS_360P_H264_BASELINE","MP4_700KBS_24FPS_48KHZ_96KBS_360P","MP4_750KBS_30FPS_48KHZ_192KBS_432P_H264_HIGH","MP4_750KBS_25FPS_48KHZ_96KBS_576P_H264_HIGH","MP4_900KBS_15FPS_48KHZ_96KBS_480P","MP4_900KBS_30FPS_48KHZ_96KBS_480P_H264_BASELINE","MP4_1350KBS_30FPS_48KHZ_96KBS_720P","MP4_1350KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH","MP4_1350KBS_25FPS_48KHZ_128KBS_540P_H264_MAIN","MP4_1500KBS_24FPS_48KHZ_96KBS_576P","MP4_1500KBS_30FPS_48KHZ_192KBS_540P_H264_HIGH","MP4_1500KBS_25FPS_48KHZ_128KBS_576P_H264_HIGH","MP4_2000KBS_30FPS_48KHZ_96KBS_720P","MP4_2000KBS_30FPS_48KHZ_96KBS_720P_H264_HIGH","MP4_2000KBS_30FPS_48KHZ_192KBS_720P_H264_HIGH","MP4_2100KBS_30FPS_48KHZ_192KBS_576P_H264_HIGH","MP4_2100KBS_30FPS_48KHZ_192KBS_480P_H264_MAIN","MP4_3400KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH","MP4_3500KBS_24FPS_48KHZ_96KBS_1080P","MP4_3500KBS_30FPS_48KHZ_128KBS_720P_H264_HIGH","MP4_4000KBS_30FPS_48KHZ_192KBS_1080P","MP4_4000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH","MP4_10000KBS_30FPS_48KHZ_320KBS_1080P","MP4_10000KBS_30FPS_48KHZ_320KBS_1080P_H264_HIGH","MP4_20000KBS_AUTOFPS_48KHZ_320KBS","MP4_20000KBS_AUTOFPS_48KHZ_320KBS_1080P_H264_HIGH","MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_HIGH","MP4_25000KBS_30FPS_48KHZ_192KBS_1080P_H264_MAIN"]},"programs":{"type":"array","items":{"type":"string","description":"Use this field to specify which program you are uploading an asset for. Currently, the accepted value here on registration is to associate an asset with a DSP advertiser.","enum":["A_PLUS","INTEGRATED_VIDEO_EXPERIENCE","SB","POSTS","STORES","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","AMAZON_DSP","FIRE_TV","SPONSORED_TV","PRODUCT_DESCRIPTION_PAGE"]}},"url":{"type":"string"}}}},"defaultUrl":{"type":"string"}}},"otherMetadata":{"description":"Include key-value pairs related to the asset. For DSP use \"dspAdvertiserId\" = \"ID\". Include program as AMAZON_DSP.","additionalProperties":{"type":"string"},"type":"object","example":{"dspAdvertiserId":"string"}},"url":{"description":"The URL of the asset.","type":"string"},"assetSubTypes":{"description":"1. For assetType `IMAGE` acceptable assetSubTypes are `LOGO`, `PRODUCT_IMAGE`, `AUTHOR_IMAGE`, `LIFESTYLE_IMAGE`, `OTHER_IMAGE`\n\n2. For assetType `VIDEO` acceptable assetSubtype is `BACKGROUND_VIDEO`.","minItems":1,"maxItems":10,"type":"array","items":{"type":"string","enum":["LOGO","PRODUCT_IMAGE","AUTHOR_IMAGE","LIFESTYLE_IMAGE","OTHER_IMAGE","BACKGROUND_VIDEO"]}},"fileMetadata":{"type":"object","properties":{"duration":{"format":"double","type":"number"},"extension":{"description":"The extension of the file name.","type":"string"},"fileSize":{"description":"The asset size in bytes.","type":"number"},"resolutionHeight":{"type":"integer"},"width":{"description":"The width of the asset in pixels.","type":"number"},"aspectRatio":{"pattern":"[0-9]+:[0-9]+","description":"The aspect ration of the asset.","type":"string"},"resolutionWidth":{"type":"integer"},"contentType":{"description":"The content type of the asset.","type":"string","enum":["jpeg","jpg","png","mp4","image/jpg","image/jpeg","image/png"]},"audioSampleRate":{"format":"double","type":"number"},"height":{"description":"The height of the asset in pixels.","type":"number"}}},"createdBy":{"type":"string"},"name":{"pattern":"[\\w]+\\.jpg|png|mp4|mov|wmv|avi","description":"The fileName of the asset.","type":"string"},"lastUpdatedTime":{"format":"int64","type":"integer"},"versionNotes":{"description":"The URL of the asset","type":"string"},"assetStatus":{"type":"string","enum":["ACTIVE","PROCESSING","ARCHIVED"]},"failedSpecChecks":{"description":"Specification Checks for all programs","type":"array","items":{"description":"Specification Check for program, This contains program name and specifications","type":"object","properties":{"specProgramName":{"type":"string","enum":["SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","SPONSORED_DISPLAY_LANDSCAPE_VIDEO","SPONSORED_DISPLAY_PORTRAIT_VIDEO","SPONSORED_DISPLAY_SQUARE_VIDEO","STORES_VIDEO_TILE","STORES_BACKGROUND_VIDEO_TILE","STORES_INTRO_SPLASH","FIRE_TV_FEATURE_ROTATOR","SPONSORED_TV","SPONSORED_BRANDS_VIDEO_PORTRAIT","DEMAND_SIDE_PLATFORM_OTT","DEMAND_SIDE_PLATFORM_OLV","DEMAND_SIDE_PLATFORM_H1_DESKTOP","DEMAND_SIDE_PLATFORM_H1_MOBILE","LIVE_IMAGE_SPONSORED_DISPLAY"]},"specifications":{"description":"List of specifications","type":"array","items":{"description":"Structure containing specification\n stringId: This is the translated string Id, client will be retrieving the translation corresponding to this string.\n failureReason: This specifies the failure reason of specification. \n arguments: Arguments required for translation string.\n isPassed: Whether spec got passed or failed.\n actualValue: If spec got failed then this attribute represent the actual value of the spec parameter in the file.","type":"object","properties":{"stringId":{"type":"string"},"isPassed":{"type":"boolean"},"failureReason":{"type":"string"},"actualValue":{"type":"string"},"arguments":{"description":"List of arguments for translation string","type":"array","items":{"type":"string"}}}}}}}},"storageLocationUrls":{"type":"object","properties":{"processedUrls":{"description":"Map containing processed urls of the asset. Key is the processed type and value is the url","additionalProperties":{"type":"object"},"type":"object","example":{"MODERATION":"http://abc.xyz"}},"defaultUrl":{"type":"string"}}},"moderationContentList":{"type":"array","items":{"type":"object","properties":{"assetSubType":{"type":"string","enum":["LOGO","PRODUCT_IMAGE","AUTHOR_IMAGE","LIFESTYLE_IMAGE","OTHER_IMAGE","BACKGROUND_VIDEO"]},"adPolicyModerationResultList":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"marketplaceId":{"type":"string"},"policyName":{"type":"string"},"moderationStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING"]},"locale":{"type":"string"}}}},"moderationContentStatus":{"type":"string","enum":["IN_PROGRESS","COMPLETED","FAILED"]}}}}}}},"assetGlobal":{"type":"object","properties":{"assetId":{"description":"The asset identifier.","type":"string"},"assetType":{"description":"The asset type you are registering [`IMAGE`, `VIDEO`]","type":"string","enum":["IMAGE","VIDEO"]},"accountIds":{"description":"The list of advertiser accounts the asset can be shared with. All the accounts within this list will be able to search this asset. Additional validation of checking that the accounts are associated will be done as part of this call.","type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}},"marketplaceId":{"description":"The list of marketplace Ids.","type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.creativeassetsgetresponse.v3+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetsgetresponse.v3+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"Forbidden Operation","content":{"application/vnd.creativeassetsgetresponse.v3+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.creativeassetsgetresponse.v3+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":true},{"schema":{"type":"string"},"in":"query","name":"assetId","description":"The assetId","required":true},{"schema":{"type":"string"},"in":"query","name":"version","description":"The versionId of the asset, if not included all versions will return.","required":false}],"tags":["Creative assets"]}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/getAsset","sectionHeader":{"type":3,"text":"GET /assets"},"summary":"Retrieve an asset","documentType":"api-reference"},{"title":"Creative assets","content":["/assets/batchRegister/{requestId}",{"summary":"Retrieves status of the batch asset registration request, uniquely identified by requestId.","operationId":"getAssetsBatchRegister","responses":{"200":{"description":"Registration status of each media file( uniquely identified by their url).","content":{"application/vnd.creativeassetsgetbatchregisterresponse.v3+json":{"schema":{"title":"GetBatchRegisterAssetStatusOutput","type":"object","properties":{"registrationStatus":{"description":"Possible statuses of batch registration request","type":"string","enum":["FAILED","IN_PROGRESS","COMPLETE"]},"successfullyRegisteredAssets":{"description":"List containing successful registration details","type":"array","minItems":0,"maxItems":100,"items":{"description":"Structure containing details of successful registration for each url in a batch registration request.","type":"object","properties":{"url":{"type":"string","description":"Url of the media file as provided in the input of batch registration request."},"assetIdentifier":{"type":"object","properties":{"assetId":{"description":"The asset identifier.","type":"string"},"version":{"description":"The version of the asset.","type":"string"}}}}}},"inProgressAssetDetails":{"description":"List containing in progress registration details","type":"array","minItems":0,"maxItems":100,"items":{"description":"Structure containing details of in progress registration for each url in a batch registration request.","type":"object","properties":{"url":{"type":"string","description":"Url of the media file as provided in the input of batch registration request."}}}},"failedAssetDetails":{"description":"List containing failed registration details","type":"array","minItems":0,"maxItems":100,"items":{"description":"Structure containing details of registration failure for each url in a batch registration request.","type":"object","properties":{"url":{"type":"string","description":"Url of the media file as provided in the input of batch registration request."},"failureReason":{"type":"string","description":"Failure reason for registration of media file identified by corresponding url in batch registration request."}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.creativeassetsgetbatchregisterresponse.v3+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetsgetbatchregisterresponse.v3+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"Forbidden Operation","content":{"application/vnd.creativeassetsgetbatchregisterresponse.v3+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"429":{"description":"Operation Throttled.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"429 request throttled","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.creativeassetsgetbatchregisterresponse.v3+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":true},{"schema":{"type":"string"},"in":"path","name":"requestId","description":"Batch asset registration request id. It is returned in response of POST /assets/batchRegister API.","required":true}],"tags":["Creative assets"]}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/getAssetsBatchRegister","sectionHeader":{"type":3,"text":"GET /assets/batchRegister/{requestId}"},"summary":"Retrieves status of the batch asset registration request, uniquely identified by requestId.","documentType":"api-reference"},{"title":"Creative assets","content":["/assets/batchRegister",{"tags":["Creative assets"],"summary":"Batch register uploaded assets","description":"This is an asynchronous api that provides clients an identifier for their batch registration request. They need to check for the status of their request by calling the `GET /assets/batchRegister/{requestId}` api with the identifier.","operationId":"assetsBatchRegister","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Batch Register Uploaded Assets.","content":{"application/vnd.assetsbatchregisterrequest.v1+json":{"schema":{"title":"AssetsBatchRegisterRequest","type":"object","properties":{"assetDetailsList":{"maxItems":50,"minItems":1,"type":"array","description":"List containing details of assets to register.","items":{"type":"object","properties":{"asinList":{"minItems":1,"maxItems":100,"description":"Tagging assets with ASIN, promotes asset discoverability downstream. If ASIN is provided at the time of upload/during asset registration, it is applied as a tag on that asset. This allows for that asset to be searchable using that ASIN#. For e.g., An advertiser may want to search for assets tagged with ASIN BC10001, so they can create a store spotlight ad with product images for that ASIN.","type":"array","items":{"type":"string"}},"assetSubTypeList":{"maxItems":10,"minItems":1,"type":"array","items":{"type":"string","enum":["LOGO","PRODUCT_IMAGE","AUTHOR_IMAGE","LIFESTYLE_IMAGE","OTHER_IMAGE","BACKGROUND_VIDEO"]}},"assetType":{"description":"The asset type you are registering [`IMAGE`, `VIDEO`]","type":"string","enum":["IMAGE","VIDEO"]},"associatedPrograms":{"maxItems":100,"minItems":1,"type":"array","items":{"type":"object","properties":{"metadata":{"description":"Include key-value pairs related to the asset. For DSP use \"dspAdvertiserId\" = \"ID\". Include program as AMAZON_DSP.","additionalProperties":{"type":"string"},"type":"object","example":{"dspAdvertiserId":"string"}},"programName":{"type":"string","description":"Use this field to specify which program you are uploading an asset for. Currently, the accepted value here on registration is to associate an asset with a DSP advertiser.","enum":["A_PLUS","INTEGRATED_VIDEO_EXPERIENCE","SB","POSTS","STORES","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","AMAZON_DSP","FIRE_TV","SPONSORED_TV","PRODUCT_DESCRIPTION_PAGE"]}}}},"name":{"description":"The name to be given to the asset being registered.","type":"string"},"otherMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Any other metadata that client wants to associate with this asset."},"skipAssetSubTypesDetection":{"type":"boolean","description":"Flag to determine if asset subtype detection should be skipped."},"tagList":{"maxItems":10,"minItems":1,"type":"array","description":"List of tags.","items":{"minLength":1,"type":"string","description":"Tag Name."}},"url":{"type":"string","description":"Url of the media file to be registered as an asset."},"versionInfo":{"type":"object","properties":{"linkedAssetId":{"description":"The registering asset will be created as a new version of this linkedAssetId.","type":"string"},"versionNotes":{"description":"The version notes that client can associate to the asset.Versioning enables users to update an old asset, so that you can ensure the latest asset is being used. You can upload a new version of an existing asset along with version notes. Any tags/ASINs from previous version, will be retained on the new version too.","type":"string","maxLength":1000}}}},"description":"Object containing details for individual assets to register."}},"batchRegistrationContext":{"type":"object","description":"Contextual information for asset registration e.g. what is the source of this asset.","properties":{"assetSourceInfo":{"type":"object","description":"Details on the source of this asset and any source specific metadata to be associated against it.","properties":{"assetSourceId":{"type":"string","enum":["AMAZON_CREATIVE_SERVICES","AMAZON_VIDEO_BUILDER","ASSET_LIBRARY","SELF_SERVICE_FIRE_TV","INTEGRATED_VIDEO_EXPERIENCE","CANVA_PLUGIN","AMAZON_DSP","SPONSORED_DISPLAY","SPONSORED_BRANDS"]},"assetSourceMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Map containing source information details. Total map size should not exceed 5, with each Key's length 50 and Value's length 500.","example":{"key":"String upto length 50","value":"String upto length 500"}}}}}}}}}},"required":true},"responses":{"200":{"description":"Identifier for the batch registration request.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"title":"BatchRegisterAssetResponse","type":"object","properties":{"requestId":{"type":"string"}}}}}},"400":{"description":"Bad Request.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"Forbidden Operation.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"429":{"description":"Operation Throttled.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"429 request throttled","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.assetsbatchregisterresponse.v1+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}}}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/assetsBatchRegister","sectionHeader":{"type":3,"text":"POST /assets/batchRegister"},"summary":"Batch register uploaded assets","documentType":"api-reference"},{"title":"Creative assets","content":["/assets/register",{"summary":"Register an uploaded asset","x-amazon-advertising-authorization":{"permissions":["amazon_stores_edit","advertiser_campaign_edit","creatives_edit","creatives_view","campaign_view","campaign_edit"],"rules":[{"resourceType":"DSP_ACCOUNT","resourceLocation":{"parameterName":"Amazon-Ads-AccountId","in":"header"},"allowFallback":"true"}]},"requestBody":{"description":"Note - **asinList**, **versionInfo**, and **tags** are optional in the request body.","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The url to upload the asset. The url expires in 15 minutes.","type":"string"},"name":{"description":"The name to be given to the asset being registered.","type":"string"},"asinList":{"minItems":1,"maxItems":100,"description":"Tagging assets with ASIN, promotes asset discoverability downstream. If ASIN is provided at the time of upload/during asset registration, it is applied as a tag on that asset. This allows for that asset to be searchable using that ASIN#. For e.g., An advertiser may want to search for assets tagged with ASIN BC10001, so they can create a store spotlight ad with product images for that ASIN.","type":"array","items":{"type":"string"}},"assetType":{"description":"The asset type you are registering [`IMAGE`, `VIDEO`]","type":"string","enum":["IMAGE","VIDEO"]},"assetSubTypeList":{"description":"1. For assetType `IMAGE` acceptable assetSubTypes are `LOGO`, `PRODUCT_IMAGE`, `AUTHOR_IMAGE`, `LIFESTYLE_IMAGE`, `OTHER_IMAGE`\n\n2. For assetType `VIDEO` acceptable assetSubtype is `BACKGROUND_VIDEO`.","minItems":1,"maxItems":10,"type":"array","items":{"type":"string","enum":["LOGO","PRODUCT_IMAGE","AUTHOR_IMAGE","LIFESTYLE_IMAGE","OTHER_IMAGE","BACKGROUND_VIDEO"]}},"versionInfo":{"type":"object","properties":{"linkedAssetId":{"description":"The registering asset will be created as a new version of this linkedAssetId.","type":"string"},"versionNotes":{"description":"The version notes that client can associate to the asset.Versioning enables users to update an old asset, so that you can ensure the latest asset is being used. You can upload a new version of an existing asset along with version notes. Any tags/ASINs from previous version, will be retained on the new version too.","type":"string","maxLength":1000}}},"tags":{"type":"array","items":{"type":"string"}},"registrationContext":{"type":"object","description":"This is used on registration of an asset, to associate DSP assets to a specific advertiser. This is **required** for assets being uploaded for use in DSP.","properties":{"associatedPrograms":{"type":"array","items":{"type":"object","properties":{"metadata":{"description":"Include key-value pairs related to the asset. For DSP use \"dspAdvertiserId\" = \"ID\". Include program as AMAZON_DSP.","additionalProperties":{"type":"string"},"type":"object","example":{"dspAdvertiserId":"string"}},"programName":{"type":"string","description":"Use this field to specify which program you are uploading an asset for. Currently, the accepted value here on registration is to associate an asset with a DSP advertiser.","enum":["A_PLUS","INTEGRATED_VIDEO_EXPERIENCE","SB","POSTS","STORES","SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","AMAZON_DSP","FIRE_TV","SPONSORED_TV","PRODUCT_DESCRIPTION_PAGE"]}}}}}},"associatedSubEntityList":{"minItems":1,"maxItems":100,"description":"This field is required for sellers, but not required for vendors. The brandEntityId is required for sellers uploading assets for use in Sponsored Brands. As a best practice, ensure to include brandEntityId when uploading assets for sellers.","type":"array","items":{"type":"object","properties":{"brandEntityId":{"description":"The entity id of brand, which can be retrieved using GET /brands.","type":"string"}}}},"skipAssetSubTypesDetection":{"description":"Select true if you want to set an asset to a specific assetSubType, if this is not included the system may reclassify your asset based on specifications.","type":"boolean"}}}}},"required":true},"description":"The API should be called once the asset is uploaded to the location\nprovided by the /asset/upload API endpoint. See [Creating assets](guides/creative-asset/creating-assets) to understand the call flow.","operationId":"registerAsset","responses":{"200":{"description":"AssetResource","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"type":"object","properties":{"assetId":{"description":"The asset identifier.","type":"string"},"versionId":{"description":"The version of the asset.","type":"string"},"failedSpecChecks":{"description":"Specification Checks for all programs","type":"array","items":{"description":"Specification Check for program, This contains program name and specifications","type":"object","properties":{"specProgramName":{"type":"string","enum":["SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","SPONSORED_DISPLAY_LANDSCAPE_VIDEO","SPONSORED_DISPLAY_PORTRAIT_VIDEO","SPONSORED_DISPLAY_SQUARE_VIDEO","STORES_VIDEO_TILE","STORES_BACKGROUND_VIDEO_TILE","STORES_INTRO_SPLASH","FIRE_TV_FEATURE_ROTATOR","SPONSORED_TV","SPONSORED_BRANDS_VIDEO_PORTRAIT","DEMAND_SIDE_PLATFORM_OTT","DEMAND_SIDE_PLATFORM_OLV","DEMAND_SIDE_PLATFORM_H1_DESKTOP","DEMAND_SIDE_PLATFORM_H1_MOBILE","LIVE_IMAGE_SPONSORED_DISPLAY"]},"specifications":{"description":"List of specifications","type":"array","items":{"description":"Structure containing specification\n stringId: This is the translated string Id, client will be retrieving the translation corresponding to this string.\n failureReason: This specifies the failure reason of specification. \n arguments: Arguments required for translation string.\n isPassed: Whether spec got passed or failed.\n actualValue: If spec got failed then this attribute represent the actual value of the spec parameter in the file.","type":"object","properties":{"stringId":{"type":"string"},"isPassed":{"type":"boolean"},"failureReason":{"type":"string"},"actualValue":{"type":"string"},"arguments":{"description":"List of arguments for translation string","type":"array","items":{"type":"string"}}}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"404":{"description":"Resource not found","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"description":"404 requested resource not found","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.creativeassetsregisterresponse.v3+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level."},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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."}],"tags":["Creative assets"]}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/registerAsset","sectionHeader":{"type":3,"text":"POST /assets/register"},"summary":"Register an uploaded asset","documentType":"api-reference"},{"title":"Creative assets","content":["/assets/upload",{"summary":"Create an upload location","x-amazon-advertising-authorization":{"permissions":["amazon_stores_edit","advertiser_campaign_edit","creatives_edit","creatives_view","campaign_view","campaign_edit"],"rules":[{"resourceType":"DSP_ACCOUNT","resourceLocation":{"parameterName":"Amazon-Ads-AccountId","in":"header"},"allowFallback":"true"}]},"requestBody":{"description":"Make sure to include file extension along with filename . (ie. \"filename.mp4\")","content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"pattern":"[\\w]+\\.jpg|png|mp4|mov|wmv|avi","description":"The fileName of the asset.","type":"string"}}}}},"required":true},"description":"Creates an ephemeral resource (upload location) to upload Assets to Creative Assets tool. The upload location is short lived and expires in 15 minutes.The upload location only supports PUT HTTP Method to upload the asset content. If the upload location expires, API user will get `403` Forbidden response.\n* All ad specs - sizes and policies can be found [here](https://advertising.amazon.com/resources/ad-specs/?ref_=a20m_us_hnav_spcs)\n\n* Program specific links\n1. **Stores** - [here](https://advertising.amazon.com/resources/ad-specs/stores?ref_=a20m_us_spcs_stcrgd)\n2. **SB/SBV/sponsored ads** - [here](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies?ref_=a20m_us_spcs_sbv_spcs_spadcap)\nSee [Creating assets](guides/creative-asset/creating-assets) to understand the call flow.","operationId":"getUploadLocation","responses":{"200":{"description":"Returns an upload location.","content":{"application/vnd.creativeassetsuploadresponse.v3+json":{"schema":{"type":"object","properties":{"url":{"description":"The url to upload the asset. The url expires in 15 minutes.","type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.creativeassetsuploadresponse.v3+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetsuploadresponse.v3+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"Forbidden Operation","content":{"application/vnd.creativeassetsuploadresponse.v3+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.creativeassetsuploadresponse.v3+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}},"tags":["Creative assets"],"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level."},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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."}]}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/getUploadLocation","sectionHeader":{"type":3,"text":"POST /assets/upload"},"summary":"Create an upload location","documentType":"api-reference"},{"title":"Creative assets","content":["/assets/search",{"summary":"Search assets","requestBody":{"description":"text - optional, this field matches asset name, asset name prefix, tags and ASINs associated with the assets\n\nfilterCriteria - optional, this is used to filter results\n\nsortCriteria - optional, this is used to get sorted results\n\npageCriteria - optional, this is used for pagination\n","content":{"application/json":{"schema":{"properties":{"text":{"description":"The text used for searching assets, it matches asset name, asset name prefix, tags and ASINs associated with the assets","type":"string"},"filterCriteria":{"description":"**Optional** this is used to filter results, we support two types of filters, valueFilter and rangeFilter","type":"object","properties":{"valueFilters":{"type":"array","items":{"description":"Filter for certain values of asset attributes","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"valueField":{"type":"string","enum":["TAG","ASIN","CAMPAIGN_NAME","CAMPAIGN_ID","PROGRAM","ASSET_TYPE","ASSET_SUB_TYPE","APPROVED_AD_POLICY","ASSET_EXTENSION"]}}}},"rangeFilters":{"type":"array","items":{"description":"Filter assets which have certain ranges of asset attributes.\n\nFor example, filter assets which have file size in the range of [10,20] or [40,50].\n","type":"object","properties":{"rangeField":{"anyOf":[{"type":"string","description":"File size in bytes."},{"type":"string","description":"The value for this should be timestamp in milliseconds. It is the same as creation date."}]},"ranges":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}}}}}}}},"sortCriteria":{"type":"object","properties":{"field":{"type":"string","enum":["CREATED_TIME","SIZE","NAME","IMAGE_HEIGHT","IMAGE_WIDTH","EXTENSION"]},"order":{"type":"string","enum":["ASC","DESC"]}}},"pageCriteria":{"description":"used for pagination\n\nwhen searching for the first page, no need to put anything, otherwise, use the token returned from previous search call\n","type":"object","properties":{"identifier":{"type":"object","properties":{"pageNumber":{"type":"integer"},"token":{"type":"string"}}},"size":{"type":"integer","default":25,"minimum":1,"maximum":500}}}}}}},"required":true},"operationId":"searchAssets","responses":{"200":{"description":"Returns search results","content":{"application/vnd.creativeassetssearchassetsresponse.v3+json":{"schema":{"type":"object","properties":{"totalRecords":{"format":"int64","type":"integer"},"assetList":{"type":"array","items":{"type":"object","properties":{"moderationPolicyMap":{"description":"A hashmap of key-value pairs, this is the most accurate way of defining a map in swagger 2.0","type":"object","example":{"HSA":"REJECTED","Stores":"PENDING","Logo":"APPROVED"}},"lastUpdatedBy":{"type":"string"},"creationTime":{"format":"int64","type":"integer"},"specCheckApprovedPrograms":{"description":"List of spec programs for which asset spec check is approved","type":"array","items":{"type":"string","enum":["SPONSORED_BRANDS_VIDEO","SPONSORED_DISPLAY_VIDEO","SPONSORED_DISPLAY_LANDSCAPE_VIDEO","SPONSORED_DISPLAY_PORTRAIT_VIDEO","SPONSORED_DISPLAY_SQUARE_VIDEO","STORES_VIDEO_TILE","STORES_BACKGROUND_VIDEO_TILE","STORES_INTRO_SPLASH","FIRE_TV_FEATURE_ROTATOR","SPONSORED_TV","SPONSORED_BRANDS_VIDEO_PORTRAIT","DEMAND_SIDE_PLATFORM_OTT","DEMAND_SIDE_PLATFORM_OLV","DEMAND_SIDE_PLATFORM_H1_DESKTOP","DEMAND_SIDE_PLATFORM_H1_MOBILE","LIVE_IMAGE_SPONSORED_DISPLAY"]}},"associatedAccountIds":{"type":"array","items":{"type":"string"}},"marketplaces":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"assetType":{"description":"The asset type you are registering [`IMAGE`, `VIDEO`]","type":"string","enum":["IMAGE","VIDEO"]},"fileMetadata":{"type":"object","properties":{"duration":{"format":"double","type":"number"},"extension":{"description":"The extension of the file name.","type":"string"},"fileSize":{"description":"The asset size in bytes.","type":"number"},"resolutionHeight":{"type":"integer"},"width":{"description":"The width of the asset in pixels.","type":"number"},"aspectRatio":{"pattern":"[0-9]+:[0-9]+","description":"The aspect ration of the asset.","type":"string"},"resolutionWidth":{"type":"integer"},"contentType":{"description":"The content type of the asset.","type":"string","enum":["jpeg","jpg","png","mp4","image/jpg","image/jpeg","image/png"]},"audioSampleRate":{"format":"double","type":"number"},"height":{"description":"The height of the asset in pixels.","type":"number"}}},"collections":{"type":"array","items":{"type":"string"}},"createdBy":{"type":"string"},"assetId":{"type":"string"},"storageLocationUrls":{"type":"object","properties":{"processedUrls":{"description":"Map containing processed urls of the asset. Key is the processed type and value is the url","additionalProperties":{"type":"object"},"type":"object","example":{"MODERATION":"http://abc.xyz"}},"defaultUrl":{"type":"string"}}},"name":{"type":"string"},"lastUpdatedTime":{"format":"int64","type":"integer"},"associatedContexts":{"description":"A hashmap of key-value pairs, this is the most accurate way of defining a map in swagger 2.0","type":"object","example":{"ASIN":"ContextDetailsList"}},"assetSubTypes":{"type":"array","items":{"type":"string","enum":["LOGO","PRODUCT_IMAGE","AUTHOR_IMAGE","LIFESTYLE_IMAGE","OTHER_IMAGE","BACKGROUND_VIDEO"]}},"status":{"type":"string","enum":["ACTIVE","PROCESSING","ARCHIVED"]}}}},"token":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/vnd.creativeassetssearchassetsresponse.v3+json":{"schema":{"description":"400 bad request","type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"description":"UnAuthorized Operation","content":{"application/vnd.creativeassetssearchassetsresponse.v3+json":{"schema":{"description":"401 unauthorized request","type":"object","properties":{"message":{"type":"string"}}}}}},"403":{"description":"Forbidden Operation","content":{"application/vnd.creativeassetssearchassetsresponse.v3+json":{"schema":{"description":"403 forbidden request","type":"object","properties":{"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/vnd.creativeassetssearchassetsresponse.v3+json":{"schema":{"description":"500 internal server error","type":"object","properties":{"message":{"type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":true}],"tags":["Creative assets"]}],"path":"/en-us/creative-asset-library#tag/Creative%20assets/operation/searchAssets","sectionHeader":{"type":3,"text":"POST /assets/search"},"summary":"Search assets","documentType":"api-reference"},{"title":"Amazon Ads API - Profiles","content":["Profiles represent an advertiser and their account's marketplace, and are used in all subsequent API calls via a management scope, Amazon-Advertising-API-Scope. Reports and all entity management operations are associated with a single profile. Advertisers cannot have more than one profile for each marketplace.\n\nAdvertisers who operate in more than one marketplace (for example, Amazon.com, Amazon.co.uk, Amazon.co.jp) will have only one profile associated with each marketplace. See this link for a list of marketplaces associated with each endpoint.\n\nTo retrieve your profile IDs, call the listProfiles operation, and include a valid authorization access token in the header. Use a profileId from the returned list as the value for the management scope (Amazon-Advertising-API-Scope) in the headers for subsequent API calls.\n"],"path":"/en-us/reference/2/profiles","sectionHeader":{"type":2,"text":"Amazon Ads API - Profiles"},"documentType":"api-reference"},{"title":"Amazon Ads API - Profiles","content":["/v2/profiles",{"tags":["Profiles"],"summary":"Gets a list of profiles.","description":"Note that this operation does not return a response unless the current account has created at least one campaign using the advertising console.","operationId":"listProfiles","parameters":[{"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","schema":{"type":"string"},"required":true},{"name":"apiProgram","in":"query","description":"Filters response to include profiles that have permissions for the specified Advertising API program only. Setting `apiProgram=billing` filters the response to include only profiles to which the user and application associated with the access token have permission to view or edit billing information.","schema":{"type":"string","enum":["billing","campaign","paymentMethod","store","report","account","posts"],"default":"campaign"}},{"name":"accessLevel","in":"query","description":"Filters response to include profiles that have specified permissions for the specified Advertising API program only. Currently, the only supported access level is `view` and `edit`. Setting `accessLevel=view` filters the response to include only profiles to which the user and application associated with the access token have view permission to the provided api program.","schema":{"type":"string","enum":["edit","view"],"default":"edit"}},{"name":"profileTypeFilter","in":"query","description":"Filters response to include profiles that are of the specified types in the comma-delimited list. Default is all types. Note that this filter performs an inclusive AND operation on the types.","schema":{"type":"string","enum":["seller","vendor","agency"]}},{"name":"validPaymentMethodFilter","in":"query","description":"Filter response to include profiles that have valid payment methods. Default is to include all profiles. Setting this filter to `true` returns only profiles with either no `validPaymentMethod` field, or the `validPaymentMethod` field set to `true`.  Setting this to `false` returns profiles with the `validPaymentMethod` field set to `false` only.","schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"array","maxItems":5000,"items":{"properties":{"profileId":{"type":"integer","format":"int64"},"countryCode":{"type":"string","readOnly":true,"description":"The countryCode for a given country\n|Region|`countryCode`|Country Name|\n|------|-----|-------|\n|NA|BR|Brazil|\n|NA|CA|Canada|\n|NA|MX|Mexico|\n|NA|US|United States|\n|EU|AE|United Arab Emirates|\n|EU|BE|Belgium| \n|EU|DE|Germany|\n|EU|EG|Egypt|\n|EU|ES|Spain|\n|EU|FR|France|\n|EU|IE|Ireland|\n|EU|IN|India|\n|EU|IT|Italy|\n|EU|NL|The Netherlands|\n|EU|PL|Poland|\n|EU|SA|Saudi Arabia| \n|EU|SE|Sweden|  \n|EU|TR|Turkey|\n|EU|UK|United Kingdom|\n|EU|ZA| South Africa |\n|FE|AU|Australia|    \n|FE|JP|Japan|\n|FE|SG|Singapore|","enum":["BR","CA","MX","US","AE","BE","DE","EG","ES","FR","IE","IN","IT","NL","PL","SA","SE","TR","UK","AU","JP","SG","ZA"]},"currencyCode":{"type":"string","readOnly":true,"description":"The currency used for all monetary values for entities under this profile.\n|Region|`countryCode`|Country Name|`currencyCode`|\n|-----|------|------|------|\n|NA|BR|Brazil|BRL|\n|NA|CA|Canada|CAD|\n|NA|MX|Mexico|MXN|\n|NA|US|United States|USD|\n|EU|AE|United Arab Emirates|AED|\n|EU|BE|Belgium|EUR|\n|EU|DE|Germany|EUR|\n|EU|EG|Egypt|EGP|\n|EU|ES|Spain|EUR|\n|EU|FR|France|EUR|\n|EU|IE|Ireland|EUR|\n|EU|IN|India|INR|\n|EU|IT|Italy|EUR|\n|EU|NL|The Netherlands|EUR|\n|EU|PL|Poland|PLN|\n|EU|SA|Saudi Arabia|SAR|\n|EU|SE|Sweden|SEK|\n|EU|TR|Turkey|TRY|\n|EU|UK|United Kingdom|GBP|\n|EU|ZA| South Africa | ZAR|\n|FE|AU|Australia|AUD|\n|FE|JP|Japan|JPY|\n|FE|SG|Singapore|SGD|","enum":["BRL","CAD","MXN","USD","AED","EUR","EGP","INR","PLN","SAR","SEK","TRY","GBP","AUD","JPY","SGD","ZAR"]},"dailyBudget":{"type":"number","readOnly":false,"description":"Note that this field applies to Sponsored Product campaigns for seller type accounts only. Not supported for vendor type accounts."},"timezone":{"type":"string","readOnly":true,"description":"The time zone used for all date-based campaign management and reporting.\n|Region|`countryCode`|Country Name|`timezone`|\n|------|-----|-----|------|\n|NA|BR|Brazil|America/Sao_Paulo|\n|NA|CA|Canada|America/Los_Angeles|\n|NA|MX|Mexico|America/Los_Angeles|\n|NA|US|United States|America/Los_Angeles|\n|EU|AE|United Arab Emirates|Asia/Dubai|\n|EU|BE|Belgium|Europe/Brussels|\n|EU|DE|Germany|Europe/Paris|\n|EU|EG|Egypt|Africa/Cairo|\n|EU|ES|Spain|Europe/Paris|\n|EU|FR|France|Europe/Paris|\n|EU|IE|Ireland|Europe/Dublin|\n|EU|IN|India|Asia/Kolkata|\n|EU|IT|Italy|Europe/Paris|\n|EU|NL|The Netherlands|Europe/Amsterdam|\n|EU|PL|Poland|Europe/Warsaw|\n|EU|SA|Saudi Arabia|Asia/Riyadh|\n|EU|SE|Sweden|Europe/Stockholm|\n|EU|TR|Turkey|Europe/Istanbul|\n|EU|UK|United Kingdom|Europe/London|\n|EU|ZA| South Africa | Africa/Johannesburg |\n|FE|AU|Australia|Australia/Sydney|\n|FE|JP|Japan|Asia/Tokyo|\n|FE|SG|Singapore|Asia/Singapore|","enum":["Africa/Cairo","America/Sao_Paulo","America/Los_Angeles","Asia/Dubai","Asia/Kolkata","Asia/Riyadh","Asia/Singapore","Asia/Tokyo","Australia/Sydney","Europe/Amsterdam","Europe/Dublin","Europe/Istanbul","Europe/London","Europe/Paris","Europe/Stockholm","Europe/Warsaw","Europe/Brussels","Africa/Johannesburg"]},"accountInfo":{"properties":{"marketplaceStringId":{"type":"string","readOnly":true,"description":"The identifier of the marketplace to which the account is associated."},"id":{"type":"string","readOnly":true,"description":"Identifier for sellers and vendors. Note that this value is not unique and may be the same across marketplace."},"type":{"type":"string","readOnly":true,"enum":["vendor","seller","agency"],"description":"The `seller` and `vendor` account types are associated with Sponsored Ads APIs. The `agency` account type is associated with DSP and Data Provider APIs."},"name":{"type":"string","readOnly":true,"description":"Account name."},"subType":{"type":"string","readOnly":true,"enum":["KDP_AUTHOR","AMAZON_ATTRIBUTION"],"description":"The account subtype."},"validPaymentMethod":{"description":"Only present for Vendors, this returns whether the Advertiser has set up a valid payment method or not.","readOnly":true,"type":"boolean"}}}}}}}}}}}],"path":"/en-us/reference/2/profiles#tag/Profiles/operation/listProfiles","sectionHeader":{"type":3,"text":"GET /v2/profiles"},"summary":"Gets a list of profiles.","documentType":"api-reference"},{"title":"Amazon Ads API - Profiles","content":["/v2/profiles",{"tags":["Profiles"],"summary":"Update the daily budget for one or more profiles.","description":"Note that this operation is only used for Sellers using Sponsored Products. This operation is not enabled for vendor type accounts.","operationId":"updateProfiles","parameters":[{"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"properties":{"profileId":{"type":"integer","format":"int64"},"countryCode":{"type":"string","readOnly":true,"description":"The countryCode for a given country\n|Region|`countryCode`|Country Name|\n|------|-----|-------|\n|NA|BR|Brazil|\n|NA|CA|Canada|\n|NA|MX|Mexico|\n|NA|US|United States|\n|EU|AE|United Arab Emirates|\n|EU|BE|Belgium| \n|EU|DE|Germany|\n|EU|EG|Egypt|\n|EU|ES|Spain|\n|EU|FR|France|\n|EU|IE|Ireland|\n|EU|IN|India|\n|EU|IT|Italy|\n|EU|NL|The Netherlands|\n|EU|PL|Poland|\n|EU|SA|Saudi Arabia| \n|EU|SE|Sweden|  \n|EU|TR|Turkey|\n|EU|UK|United Kingdom|\n|EU|ZA| South Africa |\n|FE|AU|Australia|    \n|FE|JP|Japan|\n|FE|SG|Singapore|","enum":["BR","CA","MX","US","AE","BE","DE","EG","ES","FR","IE","IN","IT","NL","PL","SA","SE","TR","UK","AU","JP","SG","ZA"]},"currencyCode":{"type":"string","readOnly":true,"description":"The currency used for all monetary values for entities under this profile.\n|Region|`countryCode`|Country Name|`currencyCode`|\n|-----|------|------|------|\n|NA|BR|Brazil|BRL|\n|NA|CA|Canada|CAD|\n|NA|MX|Mexico|MXN|\n|NA|US|United States|USD|\n|EU|AE|United Arab Emirates|AED|\n|EU|BE|Belgium|EUR|\n|EU|DE|Germany|EUR|\n|EU|EG|Egypt|EGP|\n|EU|ES|Spain|EUR|\n|EU|FR|France|EUR|\n|EU|IE|Ireland|EUR|\n|EU|IN|India|INR|\n|EU|IT|Italy|EUR|\n|EU|NL|The Netherlands|EUR|\n|EU|PL|Poland|PLN|\n|EU|SA|Saudi Arabia|SAR|\n|EU|SE|Sweden|SEK|\n|EU|TR|Turkey|TRY|\n|EU|UK|United Kingdom|GBP|\n|EU|ZA| South Africa | ZAR|\n|FE|AU|Australia|AUD|\n|FE|JP|Japan|JPY|\n|FE|SG|Singapore|SGD|","enum":["BRL","CAD","MXN","USD","AED","EUR","EGP","INR","PLN","SAR","SEK","TRY","GBP","AUD","JPY","SGD","ZAR"]},"dailyBudget":{"type":"number","readOnly":false,"description":"Note that this field applies to Sponsored Product campaigns for seller type accounts only. Not supported for vendor type accounts."},"timezone":{"type":"string","readOnly":true,"description":"The time zone used for all date-based campaign management and reporting.\n|Region|`countryCode`|Country Name|`timezone`|\n|------|-----|-----|------|\n|NA|BR|Brazil|America/Sao_Paulo|\n|NA|CA|Canada|America/Los_Angeles|\n|NA|MX|Mexico|America/Los_Angeles|\n|NA|US|United States|America/Los_Angeles|\n|EU|AE|United Arab Emirates|Asia/Dubai|\n|EU|BE|Belgium|Europe/Brussels|\n|EU|DE|Germany|Europe/Paris|\n|EU|EG|Egypt|Africa/Cairo|\n|EU|ES|Spain|Europe/Paris|\n|EU|FR|France|Europe/Paris|\n|EU|IE|Ireland|Europe/Dublin|\n|EU|IN|India|Asia/Kolkata|\n|EU|IT|Italy|Europe/Paris|\n|EU|NL|The Netherlands|Europe/Amsterdam|\n|EU|PL|Poland|Europe/Warsaw|\n|EU|SA|Saudi Arabia|Asia/Riyadh|\n|EU|SE|Sweden|Europe/Stockholm|\n|EU|TR|Turkey|Europe/Istanbul|\n|EU|UK|United Kingdom|Europe/London|\n|EU|ZA| South Africa | Africa/Johannesburg |\n|FE|AU|Australia|Australia/Sydney|\n|FE|JP|Japan|Asia/Tokyo|\n|FE|SG|Singapore|Asia/Singapore|","enum":["Africa/Cairo","America/Sao_Paulo","America/Los_Angeles","Asia/Dubai","Asia/Kolkata","Asia/Riyadh","Asia/Singapore","Asia/Tokyo","Australia/Sydney","Europe/Amsterdam","Europe/Dublin","Europe/Istanbul","Europe/London","Europe/Paris","Europe/Stockholm","Europe/Warsaw","Europe/Brussels","Africa/Johannesburg"]},"accountInfo":{"properties":{"marketplaceStringId":{"type":"string","readOnly":true,"description":"The identifier of the marketplace to which the account is associated."},"id":{"type":"string","readOnly":true,"description":"Identifier for sellers and vendors. Note that this value is not unique and may be the same across marketplace."},"type":{"type":"string","readOnly":true,"enum":["vendor","seller","agency"],"description":"The `seller` and `vendor` account types are associated with Sponsored Ads APIs. The `agency` account type is associated with DSP and Data Provider APIs."},"name":{"type":"string","readOnly":true,"description":"Account name."},"subType":{"type":"string","readOnly":true,"enum":["KDP_AUTHOR","AMAZON_ATTRIBUTION"],"description":"The account subtype."},"validPaymentMethod":{"description":"Only present for Vendors, this returns whether the Advertiser has set up a valid payment method or not.","readOnly":true,"type":"boolean"}}}}}}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"profileId":{"type":"integer","format":"int64"},"code":{"type":"string"},"details":{"type":"string"}}}}}}}}}],"path":"/en-us/reference/2/profiles#tag/Profiles/operation/updateProfiles","sectionHeader":{"type":3,"text":"PUT /v2/profiles"},"summary":"Update the daily budget for one or more profiles.","documentType":"api-reference"},{"title":"Amazon Ads API - Profiles","content":["/v2/profiles/{profileId}",{"tags":["Profiles"],"summary":"Gets a profile specified by identifier.","description":"This operation does not return a response unless the current account has created at least one campaign using the advertising console.","operationId":"getProfileById","parameters":[{"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","schema":{"type":"string"},"required":true},{"name":"profileId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"profileId":{"type":"integer","format":"int64"},"countryCode":{"type":"string","readOnly":true,"description":"The countryCode for a given country\n|Region|`countryCode`|Country Name|\n|------|-----|-------|\n|NA|BR|Brazil|\n|NA|CA|Canada|\n|NA|MX|Mexico|\n|NA|US|United States|\n|EU|AE|United Arab Emirates|\n|EU|BE|Belgium| \n|EU|DE|Germany|\n|EU|EG|Egypt|\n|EU|ES|Spain|\n|EU|FR|France|\n|EU|IE|Ireland|\n|EU|IN|India|\n|EU|IT|Italy|\n|EU|NL|The Netherlands|\n|EU|PL|Poland|\n|EU|SA|Saudi Arabia| \n|EU|SE|Sweden|  \n|EU|TR|Turkey|\n|EU|UK|United Kingdom|\n|EU|ZA| South Africa |\n|FE|AU|Australia|    \n|FE|JP|Japan|\n|FE|SG|Singapore|","enum":["BR","CA","MX","US","AE","BE","DE","EG","ES","FR","IE","IN","IT","NL","PL","SA","SE","TR","UK","AU","JP","SG","ZA"]},"currencyCode":{"type":"string","readOnly":true,"description":"The currency used for all monetary values for entities under this profile.\n|Region|`countryCode`|Country Name|`currencyCode`|\n|-----|------|------|------|\n|NA|BR|Brazil|BRL|\n|NA|CA|Canada|CAD|\n|NA|MX|Mexico|MXN|\n|NA|US|United States|USD|\n|EU|AE|United Arab Emirates|AED|\n|EU|BE|Belgium|EUR|\n|EU|DE|Germany|EUR|\n|EU|EG|Egypt|EGP|\n|EU|ES|Spain|EUR|\n|EU|FR|France|EUR|\n|EU|IE|Ireland|EUR|\n|EU|IN|India|INR|\n|EU|IT|Italy|EUR|\n|EU|NL|The Netherlands|EUR|\n|EU|PL|Poland|PLN|\n|EU|SA|Saudi Arabia|SAR|\n|EU|SE|Sweden|SEK|\n|EU|TR|Turkey|TRY|\n|EU|UK|United Kingdom|GBP|\n|EU|ZA| South Africa | ZAR|\n|FE|AU|Australia|AUD|\n|FE|JP|Japan|JPY|\n|FE|SG|Singapore|SGD|","enum":["BRL","CAD","MXN","USD","AED","EUR","EGP","INR","PLN","SAR","SEK","TRY","GBP","AUD","JPY","SGD","ZAR"]},"dailyBudget":{"type":"number","readOnly":false,"description":"Note that this field applies to Sponsored Product campaigns for seller type accounts only. Not supported for vendor type accounts."},"timezone":{"type":"string","readOnly":true,"description":"The time zone used for all date-based campaign management and reporting.\n|Region|`countryCode`|Country Name|`timezone`|\n|------|-----|-----|------|\n|NA|BR|Brazil|America/Sao_Paulo|\n|NA|CA|Canada|America/Los_Angeles|\n|NA|MX|Mexico|America/Los_Angeles|\n|NA|US|United States|America/Los_Angeles|\n|EU|AE|United Arab Emirates|Asia/Dubai|\n|EU|BE|Belgium|Europe/Brussels|\n|EU|DE|Germany|Europe/Paris|\n|EU|EG|Egypt|Africa/Cairo|\n|EU|ES|Spain|Europe/Paris|\n|EU|FR|France|Europe/Paris|\n|EU|IE|Ireland|Europe/Dublin|\n|EU|IN|India|Asia/Kolkata|\n|EU|IT|Italy|Europe/Paris|\n|EU|NL|The Netherlands|Europe/Amsterdam|\n|EU|PL|Poland|Europe/Warsaw|\n|EU|SA|Saudi Arabia|Asia/Riyadh|\n|EU|SE|Sweden|Europe/Stockholm|\n|EU|TR|Turkey|Europe/Istanbul|\n|EU|UK|United Kingdom|Europe/London|\n|EU|ZA| South Africa | Africa/Johannesburg |\n|FE|AU|Australia|Australia/Sydney|\n|FE|JP|Japan|Asia/Tokyo|\n|FE|SG|Singapore|Asia/Singapore|","enum":["Africa/Cairo","America/Sao_Paulo","America/Los_Angeles","Asia/Dubai","Asia/Kolkata","Asia/Riyadh","Asia/Singapore","Asia/Tokyo","Australia/Sydney","Europe/Amsterdam","Europe/Dublin","Europe/Istanbul","Europe/London","Europe/Paris","Europe/Stockholm","Europe/Warsaw","Europe/Brussels","Africa/Johannesburg"]},"accountInfo":{"properties":{"marketplaceStringId":{"type":"string","readOnly":true,"description":"The identifier of the marketplace to which the account is associated."},"id":{"type":"string","readOnly":true,"description":"Identifier for sellers and vendors. Note that this value is not unique and may be the same across marketplace."},"type":{"type":"string","readOnly":true,"enum":["vendor","seller","agency"],"description":"The `seller` and `vendor` account types are associated with Sponsored Ads APIs. The `agency` account type is associated with DSP and Data Provider APIs."},"name":{"type":"string","readOnly":true,"description":"Account name."},"subType":{"type":"string","readOnly":true,"enum":["KDP_AUTHOR","AMAZON_ATTRIBUTION"],"description":"The account subtype."},"validPaymentMethod":{"description":"Only present for Vendors, this returns whether the Advertiser has set up a valid payment method or not.","readOnly":true,"type":"boolean"}}}}}}}}}}],"path":"/en-us/reference/2/profiles#tag/Profiles/operation/getProfileById","sectionHeader":{"type":3,"text":"GET /v2/profiles/{profileId}"},"summary":"Gets a profile specified by identifier.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["Use the Amazon Ads API for Sponsored Products for campaign, ad group, keyword, negative keyword, and product ad management operations. For more information about Sponsored Products, see the Sponsored Products Support Center. For onboarding information, see the account setup topic.  Note: This contract contains endpoints with upcoming planned deprecations. For more information on the latest versions and migration details, see Deprecations. \n"],"path":"/en-us/sponsored-products/2-0/openapi","sectionHeader":{"type":2,"text":"DEPRECATED - Amazon Ads API - Sponsored Products"},"documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/adGroups/{adGroupId}/bidRecommendations",{"tags":["Bid recommendations"],"operationId":"getAdGroupBidRecommendations","summary":"DEPRECATED - Gets a bid recommendation for an ad group.","deprecated":true,"description":"**Deprecation notice: This endpoint will be deprecated on March 27, 2024. Use [theme-based bid recommendations](/API/docs/en-us/sponsored-products/3-0/openapi/prod#/ThemeBasedBidRecommendation/GetThemeBasedBidRecommendationForAdGroup_v1) going forward.**","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of an existing ad group.","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"adGroupId":{"description":"The identifier of the ad group.","type":"number"},"suggestedBid":{"description":"Information about the recommended bid.","type":"object","properties":{"suggested":{"description":"The bid recommendation.","type":"number"},"rangeStart":{"description":"The lower bound bid recommendation.","type":"number"},"rangeEnd":{"description":"The upper bound bid recommendation.","type":"number"}}}}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"Either the specified ad group identifier was not found, or the specified ad group was found but no associated bid was found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Bid%20recommendations/operation/getAdGroupBidRecommendations","sectionHeader":{"type":3,"text":"GET /v2/sp/adGroups/{adGroupId}/bidRecommendations"},"summary":"DEPRECATED - Gets a bid recommendation for an ad group.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/keywords/{keywordId}/bidRecommendations",{"tags":["Bid recommendations"],"operationId":"getKeywordBidRecommendations","summary":"DEPRECATED - Gets a bid recommendation for a keyword. [PLANNED DEPRECATION 3/27/2024]","deprecated":true,"description":"**Deprecation notice: This endpoint will be deprecated on March 27, 2024. Use [theme-based bid recommendations](/API/docs/en-us/sponsored-products/3-0/openapi/prod#/ThemeBasedBidRecommendation/GetThemeBasedBidRecommendationForAdGroup_v1) going forward.**","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"keywordId","in":"path","description":"The identifier of an existing keyword.","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"keywordId":{"description":"The identifier of the keyword that the bid is associated with.","type":"number"},"adGroupId":{"description":"The identifier of the ad group that the bid is associated with.","type":"number"},"suggestedBid":{"description":"Information about the recommended bid.","type":"object","properties":{"suggested":{"description":"The bid recommendation.","type":"number"},"rangeStart":{"description":"The lower bound bid recommendation.","type":"number"},"rangeEnd":{"description":"The upper bound bid recommendation.","type":"number"}}}}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Bid%20recommendations/operation/getKeywordBidRecommendations","sectionHeader":{"type":3,"text":"GET /v2/sp/keywords/{keywordId}/bidRecommendations"},"summary":"DEPRECATED - Gets a bid recommendation for a keyword. [PLANNED DEPRECATION 3/27/2024]","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/keywords/bidRecommendations",{"tags":["Bid recommendations"],"operationId":"createKeywordBidRecommendations","summary":"DEPRECATED - Gets bid recommendations for keywords.","deprecated":true,"description":"**Deprecation notice: This endpoint will be deprecated on March 27, 2024. Use [theme-based bid recommendations](/API/docs/en-us/sponsored-products/3-0/openapi/prod#/ThemeBasedBidRecommendation/GetThemeBasedBidRecommendationForAdGroup_v1) going forward.**","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of keyword bid recommendation objects.","content":{"application/json":{"schema":{"properties":{"adGroupId":{"description":"The identifier of the ad group that the keywords are associated with.","type":"number"},"keywords":{"description":"An array of keyword data objects.","type":"array","items":{"type":"object","properties":{"keyword":{"description":"The keyword text.","type":"string"},"matchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]}}},"minItems":0,"maxItems":5000}}}}}},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"properties":{"adGroupId":{"description":"The identifier of the ad group that the recommendations are associated with.","type":"string"},"recommendations":{"description":"An array of bid recommendation objects.","type":"array","items":{"properties":{"code":{"description":"The resulting status code for retrieving the bid.","type":"string","enum":["SUCCESS","NOT_FOUND"]},"keyword":{"description":"The keyword text.","type":"string"},"matchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]},"suggestedBid":{"description":"Information about the recommended bid.","type":"object","properties":{"suggested":{"description":"The bid recommendation.","type":"number"},"rangeStart":{"description":"The lower bound bid recommendation.","type":"number"},"rangeEnd":{"description":"The upper bound bid recommendation.","type":"number"}}}}}}}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Bid%20recommendations/operation/createKeywordBidRecommendations","sectionHeader":{"type":3,"text":"POST /v2/sp/keywords/bidRecommendations"},"summary":"DEPRECATED - Gets bid recommendations for keywords.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/adGroups/{adGroupId}/suggested/keywords",{"tags":["Suggested keywords"],"operationId":"getAdGroupSuggestedKeywords","summary":"DEPRECATED - Gets suggested keywords for the specified ad group.","deprecated":true,"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of a valid ad group.","required":true,"schema":{"type":"number"}},{"name":"maxNumSuggestions","in":"query","description":"The maximum number of suggested keywords for the response.","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000}},{"name":"adStateFilter","in":"query","description":"Filters results to ad groups with state matching the comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"]}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"suggestededKeywords":{"description":"An array of suggested keywords.","type":"array","items":{"type":"string"}}}}}}},"400":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Suggested%20keywords/operation/getAdGroupSuggestedKeywords","sectionHeader":{"type":3,"text":"GET /v2/sp/adGroups/{adGroupId}/suggested/keywords"},"summary":"DEPRECATED - Gets suggested keywords for the specified ad group.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/adGroups/{adGroupId}/suggested/keywords/extended",{"tags":["Suggested keywords"],"operationId":"getAdGroupSuggestedKeywordsEx","summary":"DEPRECATED - Gets suggested keywords with extended data for the specified ad group.","deprecated":true,"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of a valid ad group.","required":true,"schema":{"type":"number"}},{"name":"maxNumSuggestions","in":"query","description":"The maximum number of suggested keywords for the response.","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000}},{"name":"suggestBids","in":"query","description":"Set to `yes` to include a suggest bid for the suggested keyword in the response. Otherwise, set to `no`.","schema":{"type":"string","default":"no","enum":["yes","no"]}},{"name":"adStateFilter","in":"query","description":"Filters results to ad groups with state matching the comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"]}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"array","items":{"properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"campaignId":{"description":"The campaign identifier.","type":"number"},"keywordText":{"description":"The suggested keyword.","type":"string"},"matchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]},"state":{"description":"The state of the ad for which the keyword is suggested.","type":"string","enum":["enabled","paused"]},"bid":{"description":"The suggested bid for the suggested keyword. Note that this field will not be included in the response if the `suggestBids` query parameter is set to `no` in the request.","type":"number"}}}}}}},"400":{"description":"One or more query parameters contained an invalid value.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Suggested%20keywords/operation/getAdGroupSuggestedKeywordsEx","sectionHeader":{"type":3,"text":"GET /v2/sp/adGroups/{adGroupId}/suggested/keywords/extended"},"summary":"DEPRECATED - Gets suggested keywords with extended data for the specified ad group.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/asins/{asinValue}/suggested/keywords",{"tags":["Suggested keywords"],"operationId":"getAsinSuggestedKeywords","summary":"DEPRECATED - Gets suggested keywords for the specified ASIN.","deprecated":true,"description":"Suggested keywords are returned in an array ordered by descending effectiveness.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"asinValue","in":"path","required":true,"description":"An ASIN.","schema":{"type":"string"}},{"name":"maxNumSuggestions","in":"query","description":"The maximum number of suggested keywords for the response.","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"asin":{"description":"The ASIN for which keywords are suggested.","type":"string"},"suggestedKeywords":{"description":"The list of suggested keywords.","type":"array","items":{"type":"object","properties":{"keywordText":{"description":"The text of the suggested keyword.","type":"string"},"matchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]}}}}}}}}},"400":{"description":"One or more query parameters contained an invalid value.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Suggested%20keywords/operation/getAsinSuggestedKeywords","sectionHeader":{"type":3,"text":"GET /v2/sp/asins/{asinValue}/suggested/keywords"},"summary":"DEPRECATED - Gets suggested keywords for the specified ASIN.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/asins/suggested/keywords",{"tags":["Suggested keywords"],"operationId":"bulkGetAsinSuggestedKeywords","summary":"DEPRECATED - Gets suggested keyword for a specified list of ASINs.","deprecated":true,"description":"Suggested keywords are returned in an array ordered by descending effectiveness.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"asins":{"description":"A list of ASINs.","type":"array","items":{"type":"string"}},"maxNumSuggestions":{"description":"The maximum number of suggested keywords in the response.","type":"integer","minItems":1,"maxItems":1000,"default":100}}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"keywordText":{"description":"The keyword text.","type":"string"},"matchType":{"description":"The type of match. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","type":"string","enum":["exact","phrase","broad"]}}}}}}},"400":{"description":"One or more query parameters contained an invalid value.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Suggested%20keywords/operation/bulkGetAsinSuggestedKeywords","sectionHeader":{"type":3,"text":"POST /v2/sp/asins/suggested/keywords"},"summary":"DEPRECATED - Gets suggested keyword for a specified list of ASINs.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/targets/bidRecommendations",{"tags":["Bid recommendations"],"operationId":"getBidRecommendations","summary":"DEPRECATED - Gets a list of bid recommendations for keyword, product, or auto targeting expressions.","deprecated":true,"requestBody":{"description":"An ad group identifier and list of associated targeting expressions for which to generate bid recommendations. Note that targeting expressions are required to be of the same type. That is, all targeting expressions in the list must be one of **keyword**, **product**, or **auto** target types.","content":{"application/json":{"schema":{"type":"object","properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"expressions":{"description":"The list of targeting expressions.","type":"array","items":{"type":"array","items":{"properties":{"value":{"description":"The expression value","type":"string"},"type":{"description":"The type of targeting expression. You can specify values for the following predicates:\n| Predicate | Description |\n| --- | --- |\n| `asinCategorySameAs` | Negatively Target the same category as the category expressed. |\n| `asinBrandSameAs` | Target the brand that is the same as the brand expressed. |\n| `asinPriceLessThan` | Target a price that is less than the price expressed. |\n| `asinPriceBetween` | Target a price that is between the prices expressed. |\n| `asinPriceGreaterThan` | Target a price that is greater than the price expressed. |\n| `asinReviewRatingLessThan` | Target a review rating less than the review rating that is expressed. |\n| `asinReviewRatingBetween` | Target a review rating that is between the review ratings expressed. |\n| `asinReviewRatingGreaterThan` | Target a review rating that is greater than the review rating expressed. |\n| `asinSameAs` | Target an ASIN that is the same as the ASIN expressed. |\n| `asinIsPrimeShippingEligible` | Target products that are Prime Shipping Eligible. This refinement can be applied at a category or brand level only. |\n| `asinAgeRangeSameAs` | Target an age range that is in the expressed range. This refinement can be applied for toys and games categories only. |\n| `asinGenreSameAs` | Target products related to the expressed genre. This refinement can be applied for Books and eBooks categories only.   |\n| `asinExpandedFrom` | Target a single product along with others closely related to it, including substitutes and complements.   |\n| `queryExactMatches` | Use this enum to exactly match your query with search queries.   |\n| `queryPhraseMatches` | Use this enum to match your query with search phrases.   |\n| `queryBroadMatches` | Use this enum to broadly match your query with search queries.   |","type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs","queryBroadRelMatches","queryHighRelMatches","asinSubstituteRelated","asinAccessoryRelated","asinAgeRangeSameAs","asinGenreSameAs","asinIsPrimeShippingEligible","asinExpandedFrom","queryExactMatches","queryPhraseMatches","queryBroadMatches"]}}}}}}}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"adGroupId":{"description":"The ad group identifier.","type":"number"},"recommendations":{"description":"The list of recommended bids with associated targeting expressions.","type":"array","items":{"type":"object","properties":{"suggestedBid":{"description":"Information about the recommended bid.","type":"object","properties":{"suggested":{"description":"The bid recommendation.","type":"number"},"rangeStart":{"description":"The lower bound bid recommendation.","type":"number"},"rangeEnd":{"description":"The upper bound bid recommendation.","type":"number"}}},"expression":{"properties":{"value":{"description":"The expression value","type":"string"},"type":{"description":"The type of targeting expression. You can specify values for the following predicates:\n| Predicate | Description |\n| --- | --- |\n| `asinCategorySameAs` | Negatively Target the same category as the category expressed. |\n| `asinBrandSameAs` | Target the brand that is the same as the brand expressed. |\n| `asinPriceLessThan` | Target a price that is less than the price expressed. |\n| `asinPriceBetween` | Target a price that is between the prices expressed. |\n| `asinPriceGreaterThan` | Target a price that is greater than the price expressed. |\n| `asinReviewRatingLessThan` | Target a review rating less than the review rating that is expressed. |\n| `asinReviewRatingBetween` | Target a review rating that is between the review ratings expressed. |\n| `asinReviewRatingGreaterThan` | Target a review rating that is greater than the review rating expressed. |\n| `asinSameAs` | Target an ASIN that is the same as the ASIN expressed. |\n| `asinIsPrimeShippingEligible` | Target products that are Prime Shipping Eligible. This refinement can be applied at a category or brand level only. |\n| `asinAgeRangeSameAs` | Target an age range that is in the expressed range. This refinement can be applied for toys and games categories only. |\n| `asinGenreSameAs` | Target products related to the expressed genre. This refinement can be applied for Books and eBooks categories only.   |\n| `asinExpandedFrom` | Target a single product along with others closely related to it, including substitutes and complements.   |\n| `queryExactMatches` | Use this enum to exactly match your query with search queries.   |\n| `queryPhraseMatches` | Use this enum to match your query with search phrases.   |\n| `queryBroadMatches` | Use this enum to broadly match your query with search queries.   |","type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs","queryBroadRelMatches","queryHighRelMatches","asinSubstituteRelated","asinAccessoryRelated","asinAgeRangeSameAs","asinGenreSameAs","asinIsPrimeShippingEligible","asinExpandedFrom","queryExactMatches","queryPhraseMatches","queryBroadMatches"]}}},"code":{"description":"The response code.","type":"string","enum":["SUCCESS","INVALID_ARGUMENT","NOT_FOUND","INTERNAL_ERROR","SERVER_IS_BUSY","UNAUTHORIZED"]}}}}}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Bid%20recommendations/operation/getBidRecommendations","sectionHeader":{"type":3,"text":"POST /v2/sp/targets/bidRecommendations"},"summary":"DEPRECATED - Gets a list of bid recommendations for keyword, product, or auto targeting expressions.","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/{recordType}/snapshot",{"tags":["Snapshots"],"operationId":"requestSnapshot","summary":"DEPRECATED - Request a snapshot","deprecated":true,"description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nRequest a file-based snapshot of all entities of the specified type in the account satisfying the filtering criteria.\n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/get-started).","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"recordType","in":"path","required":true,"description":"The type of entity for which the snapshot is generated.","schema":{"type":"string","enum":["campaigns","adGroups","keywords","negativeKeywords","campaignNegativeKeywords","productAds","targets","negativeTargets"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"stateFilter":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"]}}}}}},"responses":{"202":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"snapshotId":{"description":"The snapshot identifier.","type":"string"},"recordType":{"description":"The record type of the report.","type":"string","enum":["campaigns","adGroups","keywords","negativeKeywords","campaignNegativeKeywords","productAds","targets","negativeTargets"]},"status":{"description":"The generation status of the snapshot.","type":"string","enum":["IN_PROGRESS","SUCCESS","FAILURE"]}}}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Snapshots/operation/requestSnapshot","sectionHeader":{"type":3,"text":"POST /v2/sp/{recordType}/snapshot"},"summary":"DEPRECATED - Request a snapshot","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/snapshots/{snapshotId}",{"tags":["Snapshots"],"operationId":"getSnapshotStatus","summary":"DEPRECATED - Get the status of a requested snapshot","deprecated":true,"description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/overview).","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"snapshotId","in":"path","required":true,"description":"The snapshot identifier.","schema":{"type":"number"}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"properties":{"snapshotId":{"description":"The snapshot identifier.","type":"string"},"recordType":{"description":"The record type of the report.","type":"string","enum":["campaigns","adGroups","keywords","negativeKeywords","campaignNegativeKeywords","productAds","targets","negativeTargets"]},"status":{"description":"The generation status of the snapshot.","type":"string","enum":["IN_PROGRESS","SUCCESS","FAILURE"]}}}}}},"307":{"description":"Temporary redirect.","headers":{"Location":{"schema":{"type":"string","description":"The download location of the requested snapshot."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Snapshots/operation/getSnapshotStatus","sectionHeader":{"type":3,"text":"GET /v2/sp/snapshots/{snapshotId}"},"summary":"DEPRECATED - Get the status of a requested snapshot","documentType":"api-reference"},{"title":"DEPRECATED - Amazon Ads API - Sponsored Products","content":["/v2/sp/snapshots/{snapshotId}/download",{"tags":["Snapshots"],"operationId":"downloadSnapshot","summary":"DEPRECATED - Download requested snapshot","deprecated":true,"description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/get-started).","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" developer account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"snapshotId","in":"path","required":true,"description":"The snapshot identifier.","schema":{"type":"number"}}],"responses":{"307":{"description":"Successful operation.","headers":{"Location":{"schema":{"type":"string","description":"Redirect URI with S3 file location containing snapshot data"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"properties":{"code":{"description":"An enumerated error for machine use.","type":"string","readOnly":true},"details":{"description":"A human-readable description of the error.","type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-products/2-0/openapi#tag/Snapshots/operation/downloadSnapshot","sectionHeader":{"type":3,"text":"GET /v2/sp/snapshots/{snapshotId}/download"},"summary":"DEPRECATED - Download requested snapshot","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["Use the Amazon Ads API for Sponsored Brands for campaign, ad group, keyword, negative keyword, drafts, Stores, landing pages, and Brands management operations. For more information about Sponsored Brands, see the Sponsored Brands Support Center. For onboarding information, see the account setup topic. \n"],"path":"/en-us/sponsored-brands/3-0/openapi","sectionHeader":{"type":2,"text":"Amazon Ads API - Sponsored Brands"},"documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/brands",{"tags":["Brands"],"summary":"getBrands","description":"Gets an array of Brand data objects for the Brand associated with the profile ID passed in the header. For more information about Brands, see [Brand Services](https://brandservices.amazon.com/).","operationId":"getBrands","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"brandTypeFilter","schema":{"type":"string","enum":["brandRegistry","bookAuthor"],"description":"| brandType | description |\n|-----------|-------------|\n| brandRegistry | The brand is in the brand registry. |\n| bookAuthor    | The brand is a book author. |"},"in":"query","description":"The returned array is filtered to include only brands with brand type set to one of the values in the specified comma-delimited list. Returns all brands if not specified."}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.brand.v3+json":{"schema":{"type":"array","items":{"properties":{"brandId":{"description":"The Brand identifier.","type":"string"},"brandEntityId":{"description":"The Brand entity identifier available exclusively for seller advertisers.","type":"string"},"brandRegistryName":{"description":"The Brand name.","type":"string"}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Brands/operation/getBrands","sectionHeader":{"type":3,"text":"GET /brands"},"summary":"getBrands","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/keywords",{"tags":["Keywords"],"operationId":"listKeywords","summary":"Gets an array of keywords, filtered by optional criteria.","description":"**Note**: Keywords associated with BrandVideo ad groups are only available in v3.2 version.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","schema":{"type":"integer","default":0},"in":"query","description":"Sets a zero-based offset into the requested set of keywords. Use in conjunction with the `count` parameter to control pagination of the returned array."},{"name":"count","schema":{"type":"integer","default":"max page size"},"in":"query","description":"Sets the number of keywords in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten keywords set `startIndex=0` and `count=10`. To return the next ten keywords, set `startIndex=10` and `count=10`, and so on."},{"name":"matchTypeFilter","schema":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"],"default":"broad,exact,phrase"},"in":"query","description":"The returned array is filtered to include only keywords with `matchType` set to one of the values in the specified comma-delimited list."},{"name":"keywordText","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords with the specified text."},{"name":"stateFilter","schema":{"type":"string","enum":["enabled","paused","archived"],"default":"enabled,paused"},"in":"query","description":"The returned array is filtered to include only keywords with 'state' set to one of the values in the specified comma-delimited list."},{"name":"campaignIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords associated with campaigns matching those specified by identifier in the comma-delimited string."},{"name":"adGroupIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords associated with ad groups matching those specified by identifier in the comma-delimited string."},{"name":"keywordIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords with identifiers matching those specified in the comma-delimited string."},{"name":"creativeType","schema":{"type":"string","enum":["productCollection","video"],"description":"collection is deprecated in favor of productCollection."},"in":"query","description":"Filter by the type of creative the campaign is associated with. To get keywords associated with non-video campaigns specify 'productCollection'. To get keywords associated with video campaigns, this must be set to 'video'. Returns all keywords if not specified."},{"name":"locale","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords with locale matching those specified string."}],"responses":{"200":{"description":"Success.","content":{"application/vnd.sbkeyword.v3.2+json":{"schema":{"type":"array","items":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[listKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords|\n|[getKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group associated with the keyword.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign associated with the keyword.","type":"integer","format":"int64"},"keywordText":{"description":"The keyword text. The maximum number of words for this string is 10.","type":"string"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"matchType":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"description":"The bid associated with the keyword. Note that this value must be less than the budget associated with the Advertiser account. For more information, see the **Keyword bid constraints by marketplace** section of the [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features) article.","type":"number"}}}}},"application/vnd.sbkeyword.v3+json":{"schema":{"type":"array","items":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[listKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords|\n|[getKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group associated with the keyword.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign associated with the keyword.","type":"integer","format":"int64"},"keywordText":{"description":"The keyword text. The maximum number of words for this string is 10.","type":"string"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"matchType":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"description":"The bid associated with the keyword. Note that this value must be less than the budget associated with the Advertiser account. For more information, see the **Keyword bid constraints by marketplace** section of the [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features) article.","type":"number"}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keywords/operation/listKeywords","sectionHeader":{"type":3,"text":"GET /sb/keywords"},"summary":"Gets an array of keywords, filtered by optional criteria.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/keywords",{"tags":["Keywords"],"operationId":"updateKeywords","summary":"Updates one or more keywords.","description":"Updates one or more targeting clauses. Operation supports a maximum list size of 100 keywords. <bold>Note</bold> that negative keywords can be updated on campaigns where campaign's serving status is not one of `archived`, `terminated`, `rejected`, or `ended`.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of keywords. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"array","maximum":100,"items":{"properties":{"keywordId":{"description":"The identifier of the keyword.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of an existing ad group to which the keyword is associated.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of an existing campaign to which the keyword is associated.","type":"integer","format":"int64"},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The bid associated with the keyword. Note that this value must be less than the budget associated with the Advertiser account. For more information, see the **Keyword bid constraints by marketplace** section of the [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features) article."}},"required":["keywordId","adGroupId","campaignId"]}}}}},"responses":{"207":{"description":"Multi-status. Note that the order of the returned array matches the order of the array passed in the request.","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keywords/operation/updateKeywords","sectionHeader":{"type":3,"text":"PUT /sb/keywords"},"summary":"Updates one or more keywords.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/keywords",{"tags":["Keywords"],"operationId":"createKeywords","summary":"Creates one or more keywords.","description":"Note that `state` can't be set at keyword creation. <br/>Note that keywords can be created on campaigns where serving status is not one of `archived`, `terminated`, `rejected`, or `ended`. <br/>Note that this operation supports a maximum list size of 100 keywords.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of keywords. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"array","maximum":100,"items":{"properties":{"adGroupId":{"description":"The identifier of an existing ad group to which the keyword is associated.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of an existing campaign to which the keyword is associated.","type":"integer","format":"int64"},"keywordText":{"type":"string","description":"The keyword text. The maximum number of words for this string is 10."},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"nativeLanguageLocale":{"description":"The locale preference of the advertiser. For example, if the advertiser’s preferred language is Simplified Chinese, set the locale to `zh_CN`. Supported locales include: Simplified Chinese (locale: zh_CN) for US, UK and CA. English (locale: en_GB) for DE, FR, IT and ES.","type":"string"},"matchType":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]},"bid":{"type":"number","description":"The bid associated with the keyword. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [Keyword bid constraints by marketplace](https://advertising.amazon.com/API/docs/en-us/reference/concepts/limits#bid-constraints-by-marketplace)."}}}}}}},"responses":{"207":{"description":"Multi-status. Note that the order of the returned array matches the order of the array passed in the request.","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keywords/operation/createKeywords","sectionHeader":{"type":3,"text":"POST /sb/keywords"},"summary":"Creates one or more keywords.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/keywords/{keywordId}",{"tags":["Keywords"],"operationId":"getKeyword","summary":"Gets a keyword specified by identifier.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"keywordId","description":"The identifier of an existing keyword.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"locale","schema":{"type":"string"},"in":"query","description":"The returned array includes only keywords associated with locale matching those specified by identifier."}],"responses":{"200":{"description":"Success.","content":{"application/vnd.sbkeyword.v3+json":{"schema":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[listKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords|\n|[getKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| GET /sb/keywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group associated with the keyword.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign associated with the keyword.","type":"integer","format":"int64"},"keywordText":{"description":"The keyword text. The maximum number of words for this string is 10.","type":"string"},"nativeLanguageKeyword":{"description":"The unlocalized keyword text in the preferred locale of the advertiser.","type":"string"},"matchType":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"description":"The bid associated with the keyword. Note that this value must be less than the budget associated with the Advertiser account. For more information, see the **Keyword bid constraints by marketplace** section of the [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features) article.","type":"number"}}}}}},"404":{"description":"Bad request. Keyword identifier not found.","content":{"application/vnd.error.v3+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keywords/operation/getKeyword","sectionHeader":{"type":3,"text":"GET /sb/keywords/{keywordId}"},"summary":"Gets a keyword specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/keywords/{keywordId}",{"tags":["Keywords"],"operationId":"archiveKeyword","summary":"Archives a keyword specified by identifier.","description":"This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See [Developer Notes](https://advertising.amazon.com/API/docs/v2/guides/developer_notes) for more information.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"keywordId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}},"404":{"description":"Bad request. Keyword identifier not found.","content":{"application/vnd.error.v3+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keywords/operation/archiveKeyword","sectionHeader":{"type":3,"text":"DELETE /sb/keywords/{keywordId}"},"summary":"Archives a keyword specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeKeywords",{"tags":["Negative keywords"],"operationId":"listNegativeKeywords","summary":"Gets an array of negative keywords, filtered by optional criteria.","description":"**Note**: Negative keywords associated with BrandVideo ad groups are only available in v3.2 version.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","schema":{"type":"integer","default":0},"in":"query","description":"Sets a zero-based offset into the requested set of negative keywords. Use in conjunction with the `count` parameter to control pagination of the returned array."},{"name":"count","schema":{"type":"integer","default":"max page size"},"in":"query","description":"Sets the number of negative keywords in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten negative keywords set `startIndex=0` and `count=10`. To return the next ten negative keywords, set `startIndex=10` and `count=10`, and so on."},{"name":"matchTypeFilter","schema":{"type":"string","description":"The negative match type. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["negativeExact","negativePhrase"]},"in":"query","description":"The returned array is filtered to include only negative keywords with `matchType` set to one of the values in the specified comma-delimited list."},{"name":"keywordText","schema":{"type":"string"},"in":"query","description":"The returned array includes only negative keywords with the specified text."},{"name":"stateFilter","schema":{"type":"string","enum":["enabled","archived"]},"in":"query","description":"The returned array includes only negative keywords with `state` set to the specified value."},{"name":"campaignIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only negative keywords associated with campaigns matching those specified by identifier in the comma-delimited string."},{"name":"adGroupIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only negative keywords associated with ad groups matching those specified by identifier in the comma-delimited string."},{"name":"keywordIdFilter","schema":{"type":"string"},"in":"query","description":"The returned array includes only negative keywords with identifiers matching those specified in the comma-delimited string."},{"name":"creativeType","schema":{"type":"string","enum":["productCollection","video"],"description":"collection is deprecated in favor of productCollection."},"in":"query","description":"Filter by the type of creative the campaign is associated with. To get negative keywords associated with non-video campaigns specify 'productCollection'. To get negative keywords associated with video campaigns, this must be set to 'video'. Returns all negative keywords if not specified."}],"responses":{"200":{"description":"Success.","content":{"application/vnd.sbnegativekeyword.v3.2+json":{"schema":{"type":"array","items":{"properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group associated with the keyword.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign associated with the keyword.","type":"integer","format":"int64"},"keywordText":{"description":"The keyword text. The maximum number of words for this string is 10.","type":"string"},"matchType":{"type":"string","description":"The negative match type. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["negativeExact","negativePhrase"]},"state":{"type":"string","enum":["enabled","paused","archived","draft"]}}}}},"application/vnd.sbnegativekeyword.v3+json":{"schema":{"type":"array","items":{"properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group associated with the keyword.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign associated with the keyword.","type":"integer","format":"int64"},"keywordText":{"description":"The keyword text. The maximum number of words for this string is 10.","type":"string"},"matchType":{"type":"string","description":"The negative match type. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["negativeExact","negativePhrase"]},"state":{"type":"string","enum":["enabled","paused","archived","draft"]}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20keywords/operation/listNegativeKeywords","sectionHeader":{"type":3,"text":"GET /sb/negativeKeywords"},"summary":"Gets an array of negative keywords, filtered by optional criteria.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeKeywords",{"tags":["Negative keywords"],"operationId":"updateNegativeKeywords","summary":"Updates one or more negative keywords.","description":"Updates one or more targeting clauses. Operation supports a maximum list size of 100 negative keywords. <bold>Note</bold> that negative keywords can be updated on campaigns where campaign's serving status is not one of `archived`, `terminated`, `rejected`, or `ended`.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of negative keywords.","content":{"application/json":{"schema":{"type":"array","maximum":100,"items":{"properties":{"keywordId":{"description":"The identifier of the negative keyword.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group to which the negative keyword is associated.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign to which the negative keyword is associated.","type":"integer","format":"int64"},"state":{"type":"string","enum":["enabled","archived","draft"],"description":"The current state of the negative keyword."}}}}}}},"responses":{"207":{"description":"Multi-status. Note that the order of the returned array matches the order of the array passed in the request.","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"type":"array","items":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20keywords/operation/updateNegativeKeywords","sectionHeader":{"type":3,"text":"PUT /sb/negativeKeywords"},"summary":"Updates one or more negative keywords.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeKeywords",{"tags":["Negative keywords"],"operationId":"createNegativeKeywords","summary":"Creates one or more negative keywords.","description":"Creates one or more negative targeting clauses. Operation supports a maximum list size of 100 negative keywords. The `bid` and `state` can't be set at negative keyword creation. <br/>Note that negative keywords can be created on campaigns where campaign's serving status is not one of `archived`, `terminated`, `rejected`, or `ended`.\n<br>**Note** that negative keywords *can not* be recreated for a campaign if the negative keyword has previously been associated with a campaign and subsequently archived. ","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of negative keywords.","content":{"application/json":{"schema":{"type":"array","maximum":100,"items":{"properties":{"adGroupId":{"description":"The identifier of the ad group to which the negative keyword is associated.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign to which the negative keyword is associated.","type":"integer","format":"int64"},"keywordText":{"type":"string","description":"The keyword text. Maximum length is ten words if 'matchType' is 'negativeExact'. Maximum length is 4 words if 'matchType' is 'negativePhrase'"},"matchType":{"type":"string","description":"The negative match type. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["negativeExact","negativePhrase"]}}}}}}},"responses":{"207":{"description":"Multi-status. Note that the order of the returned array matches the order of the array passed in the request.","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"type":"array","items":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20keywords/operation/createNegativeKeywords","sectionHeader":{"type":3,"text":"POST /sb/negativeKeywords"},"summary":"Creates one or more negative keywords.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeKeywords/{keywordId}",{"tags":["Negative keywords"],"operationId":"getNegativeKeyword","summary":"Gets a negative keyword specified by identifier.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"keywordId","description":"The identifier of an existing negative keyword.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success.","content":{"application/vnd.sbnegativekeyword.v3+json":{"schema":{"properties":{"keywordId":{"description":"The identifier of the negative keyword.","type":"integer","format":"int64"},"adGroupId":{"description":"The identifier of the ad group to which the negative keyword is associated.","type":"integer","format":"int64"},"campaignId":{"description":"The identifier of the campaign to which the negative keyword is associated.","type":"integer","format":"int64"},"keywordText":{"type":"string","description":"The keyword text. Maximum length of string is ten words if `matchType` is set to `negativeExact`. Maximum length is 4 words if `matchType` is set to `negativePhrase`."},"matchType":{"type":"string","description":"The negative match type. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["negativeExact","negativePhrase"]},"state":{"type":"string","enum":["enabled","archived","draft"],"description":"The current state of the negative keyword."}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20keywords/operation/getNegativeKeyword","sectionHeader":{"type":3,"text":"GET /sb/negativeKeywords/{keywordId}"},"summary":"Gets a negative keyword specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeKeywords/{keywordId}",{"tags":["Negative keywords"],"operationId":"archiveNegativeKeyword","summary":"Archives a negative keyword specified by identifier.","description":"This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See [Developer Notes](https://advertising.amazon.com/API/docs/v2/guides/developer_notes) for more information.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"keywordId","description":"The identifier of an existing campaign.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success.","content":{"application/vnd.sbkeywordresponse.v3+json":{"schema":{"description":"Applies to:\n| Operation | Path |\n|-----------| -----|\n|[createKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Keywords)| POST /sb/keywords|\n|[createNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|POST /sb/negativeKeywords|\n|[updateNegativeKeywords](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|PUT /sb/negativeKeywords|\n|[archiveNegativeKeyword](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/Negative_Keywords)|DELETE /sb/negativeKeywords/{keywordId}|\n<br/>","properties":{"keywordId":{"description":"The keyword identifier.","type":"integer","format":"int64"},"code":{"description":"An enumerated response code.","type":"string"},"description":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"errors":{"type":"array","items":{"x-amazon-advertising-package":"SBPublicAPISwagger","type":"object","properties":{"KeywordError":{"allOf":[{"x-amazon-advertising-package":"SBPublicAPISwagger","required":["message","reason"],"properties":{"message":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"},"trigger":{"type":"string"}}},{"type":"object","properties":{"keywordText":{"type":"string"},"matchType":{"type":"string"},"bid":{"type":"string"},"note":{"type":"string"}}}]}}},"description":"An array of error objects."}}}}}},"404":{"description":"Bad request. The specified negative keyword identifier was not found.","content":{"application/vnd.error.v3+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20keywords/operation/archiveNegativeKeyword","sectionHeader":{"type":3,"text":"DELETE /sb/negativeKeywords/{keywordId}"},"summary":"Archives a negative keyword specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/pageAsins",{"tags":["Landing page asins"],"operationId":"listAsins","summary":"Gets ASIN information for a specified address.","description":"Note that for sellers, the addresss must be a Store page. Vendors may also specify a custom landing page address. Only the `ASINs` that are directly associated on creation with a Store landing page are returned by this API. Any other `ASINs` that are not directly associated to the Store landing page or are listed on other pages are not returned by this API. This includes `ASINs` that are on Dynamic widgets, product selections, and featured deals widgets.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"pageUrl","in":"query","description":"For sellers, the address of a Store page. Vendors may also specify the address of a custom landing page. For more information, see the [Stores section](https://advertising.amazon.com/help#GPRM3ZHEXEY5RBFZ) of the Amazon Ads support center.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success.","content":{"application/vnd.pageasins.v3+json":{"schema":{"properties":{"asinList":{"description":"An array of ASINs. Note that this field is present only if there were no errors during the request. If there were errors, the `code` field is the enumerated error, and the `details` field contains a human-readable description of the error.","type":"array","readOnly":false,"items":{"description":"A single ASIN.","type":"string"}},"code":{"description":"The enumerated response code.\n| Code | Description |\n|------|--------|\n|SUCCESS| The request was successful. The `asinList` field includes all available ASINs.|\n|INVALID_ARGUMENT| The request was not successful because the address was not for a valid landing page.|\n|BAD_GATEWAY| The request failed because the landing page at the specified address did not have any ASINs.|","type":"string"},"details":{"description":"A human-readable description of the `code` field.","type":"string"}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Landing%20page%20asins/operation/listAsins","sectionHeader":{"type":3,"text":"GET /pageAsins"},"summary":"Gets ASIN information for a specified address.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/media/describe",{"tags":["Media"],"summary":"API to poll for media status","description":"API to poll for media status.\nIn order to attach media to campaign, media should be in either `PendingDeepValidation` or `Available` status.\n\n`Available` status guarantees that media has completed processing and published for usage.\n\nThough media can be attached to campaign once the status of the media transitions to `PendingDeepValidation`, media could still fail additional validation and transition to `Failed` status. For example in the context of SBV, SBV campaign can be created when status transitions to `PendingDeepValidation`, it could result in SBV campaign to be rejected later if media transitions to `Failed` status.","operationId":"describeMedia","parameters":[{"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","schema":{"type":"string"},"required":true},{"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","schema":{"type":"string"},"required":true},{"name":"mediaId","in":"query","description":"Media Identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Media Resource","content":{"*/*":{"schema":{"type":"object","properties":{"mediaId":{"type":"string","description":"The Media identifier."},"status":{"type":"string","description":"Media status:\n * `Processing` - The media is being processed\n * `PendingDeepValidation` - The media is pending additional validation carried out during media conversion.\n * `Available` - Media has successfully finished validation and conversion and the media is published.\n * `Failed` - Media processing failed\n","enum":["Processing","PendingDeepValidation","Available","Failed"]},"statusMetadata":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"description":"Additional status metadata. It is only available when status is `Failed` and `statusMetadata` provides additional detail on why media status is `Failed`. `statusMetadata` is comprised of code and message."}},"publishedMediaUrl":{"type":"string","description":"The preview URL of the media. It is only available when status is `Available`."},"originalMediaUrl":{"type":"string","description":"This is a signed URL which returns the original media in .mp4 file extension. The URL is only active for 7 days and requires to be regenerated if the video is not downloaded within 7 days. If you try to upload the downloaded video using the Asset Library API and get an error, then please retry upload after changing the file extension to .mov."}}}}}},"404":{"description":"Resource not found","content":{"*/*":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Media/operation/describeMedia","sectionHeader":{"type":3,"text":"GET /media/describe"},"summary":"API to poll for media status","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/stores/assets",{"tags":["Stores"],"operationId":"listAssets","summary":"Gets a list of assets associated with a specified brand entity identifier.","description":"For sellers or vendors, gets an array of assets associated with the specified brand entity identifier. Vendors are not required to specify a brand entity identifier, and in this case all assets associated with the vendor are returned.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"brandEntityId","in":"query","description":"For sellers, this field is required. It is the Brand entity identifier of the Brand for which assets are returned. This identifier is retrieved using the [getBrands operation](https://advertising.amazon.com/API/docs/v3/reference/SponsoredBrands/brands). For vendors, this field is optional. If a vendor does not specify this field, all assets associated with the vendor are returned. For more information about the [difference between a seller and a vendor](https://advertising.amazon.com/resources/faq#advertising-basics), see the Amazon Ads FAQ.","schema":{"type":"string"}},{"name":"mediaType","in":"query","description":"Specifies the media types used to filter the returned array. Currently, only the `brandLogo` type is supported. If not specified, all media types are returned.","schema":{"description":"The supported media types.","type":"string","enum":["brandLogo","image"]}}],"responses":{"200":{"description":"Success.","content":{"application/vnd.mediaasset.v3+json":{"schema":{"type":"array","items":{"properties":{"assetID":{"description":"The identifier of an asset associated with a store.","type":"string"},"url":{"description":"The address where the asset is stored.","type":"string"},"mediaType":{"description":"The supported media types.","type":"string","enum":["brandLogo","image"]},"name":{"description":"The name of the asset.","type":"string"}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Stores/operation/listAssets","sectionHeader":{"type":3,"text":"GET /stores/assets"},"summary":"Gets a list of assets associated with a specified brand entity identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/stores/assets",{"tags":["Stores"],"operationId":"createAsset","summary":"Creates a new image asset.","description":"Image assets are stored in the Store Assets Library. Note that there may be a delay before the image is displayed in the console.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"in":"header","name":"Content-Disposition","description":"The name of the image file.","schema":{"type":"string"},"required":true},{"in":"header","name":"Content-Type","description":"The image format type. The following table lists the valid image types:\n|Image Type|Description|\n|----------|-----------|\n|PNG|[Portable network graphics](https://en.wikipedia.org/wiki/Portable_Network_Graphics)|\n|JPEG|[JPEG](https://en.wikipedia.org/wiki/JPEG)|\n|GIF|[Graphics interchange format](https://en.wikipedia.org/wiki/GIF)|","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"assetInfo":{"description":"A JSON object specifying the Brand entity identifier an media type. The Brand entity identifier is optional, but media type is not.\n|Field|Type|Values|\n|-----|-----|-----|\n|brandEntityId|string|The Brand entity identifier.|\n|mediaType|string| Only `brandLogo` is currently supported.|\nExample:\n```\n{\n  brandEntityId: \"12345678\",\n  mediaType: {\n    \"brandLogo\"\n  }\n}\n```","type":"string"},"asset":{"description":"The binary data for the image. For more information,  File size must be smaller than 1MB, and the resolution must be a minimum of 400 pixels by 400 pixels.","type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"properties":{"assetID":{"type":"string","description":"ID of created asset"},"code":{"type":"string"},"details":{"type":"string"}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Stores/operation/createAsset","sectionHeader":{"type":3,"text":"POST /stores/assets"},"summary":"Creates a new image asset.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/recommendations/bids",{"tags":["Bid recommendations"],"operationId":"getBidsRecommendations","description":"Get a list of bid recommendation objects for a specified list of keywords or products.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of keywords or targeting expressions for which to generate bid recommendations. Note that if a value is specified for the `campaignId` field, the past performance data for the campaign may be use to create bid recommendations.","content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign for which bid recommendations are created."},"targets":{"type":"array","items":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"maxItems":100,"description":"Sum of the sizes of (targets + keywords + themeTypes) arrays should be <= 100"},"keywords":{"type":"array","items":{"type":"object","properties":{"matchType":{"type":"string","description":"MatchType should be non-null and non-empty","enum":["broad","exact","phrase"]},"keywordText":{"description":"The text of the keyword. Maximum of 10 words.","type":"string","minLength":1}}},"maxItems":100,"description":"Sum of the sizes of (targets + keywords + themeTypes) arrays should be <= 100"},"adFormat":{"type":"string","enum":["productCollection","video"],"description":"The type of ad format."},"costType":{"type":"string","description":"Optional. Support `CPC` (cost per click) and `VCPM` (cost per thousand viewable impressions).\n| costType | goal | Expected result |\n|----------|------|-----------------|\n| Empty | Empty | Recommendation will be generated for costType= `CPC` and goal=`PAGE_VISIT`.\n| Specified | Empty | It will return error and no recommendation will be generated.\n| Empty | Specified | It will use default costType based on goal selection. e.g. goal=`BRAND_IMPRESSION_SHARE` then it will use costType = `VCPM` to generate recommendation.\n| Specified | Specified | The recommendation will be based on selected goal and costType. If the mismatch then it will generate an error."},"themeTypes":{"type":"array","items":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"minItems":0,"maxItems":100,"description":"Sum of the sizes of (targets + keywords + themeTypes) arrays should be <= 100"},"goal":{"type":"string","description":"The goal type of the campaign.\nIf no goal is selected then it will default to `PAGE_VISIT`.\n| goal | description |\n|-----------|-------------|\n| BRAND_IMPRESSION_SHARE | Brand Impression Share (BIS) is Top of search (ToS) impression shares for branded search terms. |\n| PAGE_VISIT | Facilitate consumers' awareness of your brand |\n| ACQUIRE_NEW_CUSTOMERS | This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal drives new customer acquisition for your brands. |\n| AD_VIEWS | This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal maximizes view for your ads. |"}}}}}},"responses":{"200":{"description":"A list of bid recommendations.","content":{"application/vnd.sbbidsrecommendation.v3+json":{"schema":{"type":"object","properties":{"keywordsBidsRecommendationSuccessResults":{"description":"Lists the bid recommendations for the keywords specified in the request.","type":"array","items":{"type":"object","properties":{"recommendationId":{"description":"The identifier of the keyword bid recommendation.","type":"string"},"recommendedBid":{"type":"object","properties":{"rangeEnd":{"type":"number","format":"double"},"rangeStart":{"type":"number","format":"double"},"recommended":{"type":"number","format":"double"}}},"keyword":{"type":"object","properties":{"keywordText":{"description":"The text of the keyword.","type":"string"},"matchType":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]}}},"keywordIndex":{"description":"Correlates the keyword to the keyword array index specified in the request. Zero-based.","type":"number"}}}},"keywordsBidsRecommendationErrorResults":{"description":"Lists errors that occurred during creation of keyword bid recommendations.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"keyword":{"type":"object","properties":{"type":{"type":"string","description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Ads support center.","enum":["broad","exact","phrase"]},"value":{"description":"The text of the keyword. Maximum of 10 words.","type":"string","minLength":1}}},"keywordIndex":{"description":"Correlates the keyword to the keyword array index specified in the request. Zero-based.","type":"number"}}}]}},"targetsBidsRecommendationSuccessResults":{"description":"Lists the bid recommendations for the keywords or targets specified in the request.","type":"array","items":{"type":"object","properties":{"recommendationId":{"description":"The identifier of the target bid recommendation."},"recommendedBid":{"type":"object","properties":{"rangeEnd":{"type":"number","format":"double"},"rangeStart":{"type":"number","format":"double"},"recommended":{"type":"number","format":"double"}}},"targets":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"targetsIndex":{"description":"Correlates the keyword to the keyword array index specified in the request. Zero-based.","type":"number"}}}},"targetsBidsRecommendationErrorResults":{"description":"Lists errors that occurred during creation of target bid recommendations.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"targets":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"targetsIndex":{"description":"Correlates the keyword to the keyword array index specified in the request. Zero-based.","type":"number"}}}]}},"themesRecommendationSuccessResults":{"description":"Lists the theme targets recommendations for the theme targets specified in the request.","type":"array","items":{"type":"object","properties":{"recommendationId":{"description":"The identifier of the target bid recommendation."},"recommendedBid":{"type":"object","properties":{"rangeEnd":{"type":"number","format":"double"},"rangeStart":{"type":"number","format":"double"},"recommended":{"type":"number","format":"double"}}},"themeType":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"themeIndex":{"description":"Correlates the theme targets to the theme targets array index specified in the request. Zero-based.","type":"number"}}},"minItems":0,"maxItems":10},"themesRecommendationErrorResults":{"description":"Lists errors that occurred during creation of theme targets bid recommendations.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"themeType":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"themeIndex":{"description":"Correlates the theme targets to the theme targets array index specified in the request. Zero-based.","type":"number"}}}]},"minItems":0,"maxItems":10}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Bid%20recommendations/operation/getBidsRecommendations","sectionHeader":{"type":3,"text":"POST /sb/recommendations/bids"},"documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/campaigns/budgetRules/recommendations",{"tags":["Budget Rules Recommendations"],"operationId":"SBGetBudgetRulesRecommendation","summary":"Gets a list of special events with suggested date range and suggested budget increase for a campaign specified by identifier.","description":"A rule enables an automatic budget increase for a specified date range or for a special event. The response also includes a suggested budget increase for each special event.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":false,"schema":{"type":"string"}},{"name":"Amazon-Ads-AccountId","in":"header","description":"The identifier of an account. The account must be a global advertising account..","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.sbbudgetrulesrecommendation.v3+json":{"schema":{"oneOf":[{"type":"object","properties":{"campaignId":{"description":"The campaign identifier.","type":"string"}},"required":["campaignId"]}],"discriminator":{"mapping":{"EVENTS_FOR_EXISTING_CAMPAIGN":"#/components/schemas/SBBudgetRulesRecommendationEventRequest"},"propertyName":"recommendationType"}}}}},"responses":{"200":{"description":"Successful Operation.","content":{"application/vnd.sbbudgetrulesrecommendation.v3+json":{"schema":{"description":"Special events with date range and suggested budget increase.","type":"object","properties":{"recommendedBudgetRuleEvents":{"description":"A list of recommended special events with date range and suggested budget increase.","type":"array","items":{"type":"object","properties":{"eventId":{"description":"The event identifier.","type":"string"},"endDate":{"description":"The end date in YYYYMMDD format.","type":"string"},"suggestedBudgetIncreasePercent":{"description":"The suggested budget increase expressed as a percent.","type":"number"},"eventName":{"description":"The event name.","type":"string"},"startDate":{"description":"The start date in YYYYMMDD format.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/vnd.sbbudgetrulesrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. Request was rate-limited. Retry later.","content":{"application/vnd.sbbudgetrulesrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server.","content":{"application/vnd.sbbudgetrulesrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Budget%20Rules%20Recommendations/operation/SBGetBudgetRulesRecommendation","sectionHeader":{"type":3,"text":"POST /sb/campaigns/budgetRules/recommendations"},"summary":"Gets a list of special events with suggested date range and suggested budget increase for a campaign specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/recommendations/keyword",{"tags":["Keyword Recommendations"],"summary":"Gets keyword recommendations","operationId":"getKeywordRecommendations","description":"Gets an array of keyword recommendation objects for a set of ASINs included either on a landing page or a Stores page. Vendors may also specify a custom landing page.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"**Must contain exactly only one of** \n\n 1.) An array of ASINs for which keyword recommendations are generated. \n\n 2.) The URL of a Stores page. Vendors may also specify the URL of a custom landing page. The products on the landing page are used to generate keyword recommendations. \n\n Optional parameters include the max number of suggestions and locale for keyword translations. Supported locales include: Simplified Chinese (locale: “zh_CN”) for US, UK and CA. English (locale:  “en_GB”) for DE, FR, IT and ES. If locale is invalid or unsupported, no translations will be returned.","content":{"application/vnd.sbkeywordrecommendation.v3+json":{"schema":{"oneOf":[{"type":"object","required":["asins"],"properties":{"asins":{"type":"array","items":{"description":"An array of landing page ASINs.","maximum":100,"type":"string","minimum":1}},"goal":{"default":"PAGE_VISIT","description":"Optionally indicate the desired goal of your campaign. Different keyword recommendations will be provided depending on your specified goal. \n|Identifier|Description|\n|----------|-----------|\n|PAGE_VISIT| Boost the visits to your landing page|\n|BRAND_IMPRESSION_SHARE| Facilitate consumers' awareness of your brand|\n|ACQUIRE_NEW_CUSTOMERS| This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal drives new customer acquisition for your brands|\n|AD_VIEWS| This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal maximizes view for your ads|<br/>","type":"string","enum":["PAGE_VISIT","BRAND_IMPRESSION_SHARE","ACQUIRE_NEW_CUSTOMERS","AD_VIEWS"]},"creativeType":{"description":"Optional SB creative type used for generating static or video generated keyword recommendations.  Inferred by asins if not included.\n|Identifier|Description|Recommendations|\n|----------|-----------|-----------|\n|PRODUCT_COLLECTION| Showcase multiple products within a branded shopping experience|Static|\n|AUTHOR_COLLECTION| Showcase books under your name that direct to your Book Brand landing page|Static|\n|STORE_SPOTLIGHT| Showcase your brand logo, headline, and up to 3 product categories or sub-pages|Static|\n|VIDEO| Display a video ad promoting a product that redirects to its landing page|Video|\n|BRAND_VIDEO| Display a branded video ad that redirects shoppers to your Brand Store landing page|Video|\n<br/>","type":"string","enum":["PRODUCT_COLLECTION","AUTHOR_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"maxNumSuggestions":{"format":"int64","description":"Maximum number of suggestions to return. Max value is 1000. If not provided, default to 100.","type":"integer"},"creativeAsins":{"type":"array","items":{"description":"Optional. An array of creative ASINs that are displayed in the SB creative.","maximum":3,"type":"string","minimum":0}},"locale":{"description":"Optional locale to request keyword suggestion translations. For example, to request Simplified Chinese translations in US, provide locale “zh_CN”. Response will include both keyword suggestions and their translations. Supported locales include: Simplified Chinese (locale: “zh_CN”) for US, UK and CA. English (locale: “en_GB”) for DE, FR, IT and ES.","type":"string"}}},{"type":"object","required":["url"],"properties":{"goal":{"default":"PAGE_VISIT","description":"Optionally indicate the desired goal of your campaign. Different keyword recommendations will be provided depending on your specified goal. \n|Identifier|Description|\n|----------|-----------|\n|PAGE_VISIT| Boost the visits to your landing page|\n|BRAND_IMPRESSION_SHARE| Facilitate consumers' awareness of your brand|\n|ACQUIRE_NEW_CUSTOMERS| This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal drives new customer acquisition for your brands|\n|AD_VIEWS| This property is a PREVIEW ONLY and cannot be used as part of a request or response, this note will be removed once supported. This goal maximizes view for your ads|<br/>","type":"string","enum":["PAGE_VISIT","BRAND_IMPRESSION_SHARE","ACQUIRE_NEW_CUSTOMERS","AD_VIEWS"]},"creativeType":{"description":"Optional SB creative type used for generating static or video generated keyword recommendations.  Inferred by asins if not included.\n|Identifier|Description|Recommendations|\n|----------|-----------|-----------|\n|PRODUCT_COLLECTION| Showcase multiple products within a branded shopping experience|Static|\n|AUTHOR_COLLECTION| Showcase books under your name that direct to your Book Brand landing page|Static|\n|STORE_SPOTLIGHT| Showcase your brand logo, headline, and up to 3 product categories or sub-pages|Static|\n|VIDEO| Display a video ad promoting a product that redirects to its landing page|Video|\n|BRAND_VIDEO| Display a branded video ad that redirects shoppers to your Brand Store landing page|Video|\n<br/>","type":"string","enum":["PRODUCT_COLLECTION","AUTHOR_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"maxNumSuggestions":{"format":"int64","description":"Maximum number of suggestions to return. Max value is 1000. If not provided, default to 100.","type":"integer"},"creativeAsins":{"type":"array","items":{"description":"Optional. An array of creative ASINs that are displayed in the SB creative.","maximum":3,"type":"string","minimum":0}},"locale":{"description":"Optional locale to request keyword suggestion translations. For example, to request Simplified Chinese translations in US, provide locale “zh_CN”. Response will include both keyword suggestions and their translations. Supported locales include: Simplified Chinese (locale: “zh_CN”) for US, UK and CA. English (locale: “en_GB”) for DE, FR, IT and ES.","type":"string"},"url":{"description":"The URL of the Stores page, or, Vendors may also specify the URL of a custom landing page.","type":"string"}}}]},"examples":{"URL Request":{"value":{"goal":"BRAND_IMPRESSION_SHARE","creativeType":"VIDEO","maxNumSuggestions":"100","locale":"zh_CN","url":"www.amazon.com/sample_landing_page"}},"ASIN Request":{"value":{"asins":["asin1","asin2","asin3"],"goal":"PAGE_VISIT","creativeType":"PRODUCT_COLLECTION","maxNumSuggestions":"100","locale":"zh_CN"}}}}}},"responses":{"200":{"description":"Successful recommendations response","content":{"application/vnd.sbkeywordrecommendation.v3+json":{"schema":{"type":"array","items":{"type":"object","properties":{"searchTermImpressionShare":{"format":"double","maximum":100,"description":"The account-level ad-attributed impression share for the search-term / keyword. Provides percentage share of all ad impressions the advertiser has for the keyword in the last 7 days. This metric helps advertisers identify potential opportunities based on their share of relevant keywords.","type":"number","minimum":0},"matchType":{"description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Advertising support center.","type":"string","enum":["broad","exact","phrase"]},"translation":{"description":"Localized keyword value if locale was specified.","type":"string"},"searchTermImpressionRank":{"format":"int64","description":"The account-level ad-attributed impression rank for the search-term / keyword. Provides the [1:N] place the advertiser ranks among all advertisers for the keyword by ad impressions in a marketplace in the last 7 days. It tells an advertiser how many advertisers had higher share of ad impressions.","type":"integer"},"recommendationId":{"description":"Unique ID for each recommendation.","type":"string"},"type":{"description":"A recommendation identifier that describes the suggested action for the recommendation.\n|Identifier|Description|\n|----------|-----------|\n|addKeyword|The suggested action is to add the keyword.|\n<br/>","type":"string","enum":["addKeyword"]},"value":{"description":"Recommended keyword value.","type":"string"}}}},"example":[{"searchTermImpressionShare":1,"matchType":"PHRASE","translation":"跑鞋","searchTermImpressionRank":10,"recommendationId":"1111111111","type":"addKeyword","value":"running shoes"}]}}},"400":{"description":"Bad Request.","content":{"application/vnd.sbkeywordrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later","content":{"application/vnd.sbkeywordrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server SB Keyword Recommendations Error - Something went wrong on the server. Retry later and report an SB Keyword Recommendations Error if unresolved.","content":{"application/vnd.sbkeywordrecommendation.v3+json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Keyword%20Recommendations/operation/getKeywordRecommendations","sectionHeader":{"type":3,"text":"POST /sb/recommendations/keyword"},"summary":"Gets keyword recommendations","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/targets/list",{"tags":["Product targeting"],"operationId":"listTargets","description":"Gets a list of product targets associated with the client identifier passed in the authorization header, filtered by specified criteria.\n\n**Note**: Product targets associated with BrandVideo ad groups are only available in v3.2 version.","requestBody":{"description":"A set of filters.","content":{"application/json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048},"maxResults":{"description":"Sets a limit on the number of results returned by an operation.","type":"integer","minimum":1,"maximum":5000}}},{"type":"object","properties":{"filters":{"description":"Restricts results to targets with the specified filters.  Filters are inclusive. Filters are joined using 'and' logic. Specify one type of each filter. Specifying multiples of the same type of filter results in an error.","type":"array","items":{"anyOf":[{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `CREATIVE_TYPE` to filter by creative type. If no filter is specified, all targets will be returned.","type":"string","enum":["CREATIVE_TYPE"]}}},{"type":"object","properties":{"values":{"description":"A list of creative types.","type":"array","items":{"type":"string","enum":["productCollection","video"]},"minItems":1,"maxItems":2}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `TARGETING_STATE` to filter by target state.","type":"string","enum":["TARGETING_STATE"]}}},{"type":"object","properties":{"values":{"description":"A list of target states.","type":"array","items":{"type":"string","enum":["archived","paused","enabled"]},"minItems":1,"maxItems":5}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `CAMPAIGN_ID` to filter by campaign identifiers.","type":"string","enum":["CAMPAIGN_ID"]}}},{"type":"object","properties":{"values":{"description":"A list of campaign identifiers.","type":"array","items":{"description":"A campaign identifier.","type":"string","minItems":1,"maxItems":100}}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `AD_GROUP_ID` to filter by ad group identifier.","type":"string","enum":["AD_GROUP_ID"]}}},{"type":"object","properties":{"values":{"description":"A list of ad group identifiers.","type":"array","items":{"type":"integer","format":"int64","description":"The ad group identifier."},"minItems":1,"maxItems":100}}}]}],"minItems":0,"maxItems":3}}}}]}}}},"responses":{"200":{"description":"A list of targeting clauses.","content":{"application/vnd.sblisttargetsresponse.v3.2+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"targets":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"expressions":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"resolvedExpressions":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}}}}}]}},"application/vnd.sblisttargetsresponse.v3+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"targets":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"expressions":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"resolvedExpressions":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}}}}}]}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Product%20targeting/operation/listTargets","sectionHeader":{"type":3,"text":"POST /sb/targets/list"},"documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/targets",{"tags":["Product targeting"],"operationId":"updateTargets","summary":"Updates one or more targets.","requestBody":{"description":"A list of targets with updated values. <br/>Note that targets can be updated on campaigns where serving status is not one of `archived`, `terminated`, `rejected`, or `ended`. <br/>Note that this operation supports a maximum list size of 100 targets. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"object","required":["targets"],"properties":{"targets":{"type":"array","items":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The identifier of the target."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}},"minItems":1,"maxItems":100}}}}}},"responses":{"200":{"description":"A list of success and error results for targets submitted for update.","content":{"application/vnd.updatetargetsresponse.v3+json":{"schema":{"type":"object","properties":{"updateTargetSuccessResults":{"description":"Lists the successfully updated targets. Note that targets in the response are correlated to targets in the request using the `targetRequestIndex` field. For example, if `targetRequestIndex` is set to `2`, the values correlate to the third target object in the request.","type":"array","items":{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."},"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"}}}},"updateTargetErrorResults":{"description":"Lists errors that occured during target update. Note that errors are correlated to target update requests by the `targetRequestIndex` field. This field corresponds to the order of the target in the request. For example, if `targetRequestIndex` is set to `2`, the values correlate to the third target object in the request array.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."},"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"}}}]}}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Product%20targeting/operation/updateTargets","sectionHeader":{"type":3,"text":"PUT /sb/targets"},"summary":"Updates one or more targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/targets",{"tags":["Product targeting"],"operationId":"createTargets","summary":"Create one or more targets.","requestBody":{"description":"A list of targeting clauses for creation. <br/>Note that targets can be created on campaigns where serving status is not one of `archived`, `terminated`, `rejected`, or `ended`. <br/>Note that this operation supports a maximum list size of 100 targets. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"object","required":["targets"],"properties":{"targets":{"type":"array","items":{"properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of an existing ad group. The newly created target is associated to this ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of an existing campaign. The newly created target is associated to this campaign."},"expressions":{"type":"array","items":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}}},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}},"minItems":1,"maxItems":100}}}}}},"responses":{"200":{"description":"A list of success and error results for targeting clauses submitted for creation.","content":{"application/vnd.sbcreatetargetsresponse.v3+json":{"schema":{"properties":{"createTargetSuccessResults":{"description":"Lists the successfully created targets. Note that targets in the response are correlated to targets in the request using the `targetRequestIndex` field. For example, if `targetRequestIndex` is set to `2`, the values correlate to the third target object in the request.","type":"array","items":{"type":"object","properties":{"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"},"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."}}}},"createTargetErrorResults":{"description":"Lists errors that occured during target creation. Note that errors are correlated to target create requests by the `targetRequestIndex` field. This field corresponds to the order of the target object in the request. For example, if `targetRequestIndex` is set to `3`, an error occured during creation of the fourth target in the request.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"},"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."}}}]}}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Product%20targeting/operation/createTargets","sectionHeader":{"type":3,"text":"POST /sb/targets"},"summary":"Create one or more targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/targets/{targetId}",{"tags":["Product targeting"],"operationId":"getTarget","summary":"Gets a target specified by identifier.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"targetId","description":"The identifier of an existing target.","in":"path","required":true,"schema":{"type":"integer","format":"int64","description":"The identifier of a target."}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbtarget.v3+json":{"schema":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"expressions":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}},"resolvedExpressions":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Product%20targeting/operation/getTarget","sectionHeader":{"type":3,"text":"GET /sb/targets/{targetId}"},"summary":"Gets a target specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/targets/{targetId}",{"tags":["Product targeting"],"operationId":"archiveTarget","summary":"Archives a target specified by identifier. Note that archiving is permanent, and once a target has been archived it can't be made active again.","description":"The identifier of an existing target.","parameters":[{"name":"targetId","in":"path","required":true,"schema":{"type":"integer","format":"int64","description":"The identifier of a target."}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbtargetresponse.v3+json":{"schema":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"code":{"type":"string"}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Product%20targeting/operation/archiveTarget","sectionHeader":{"type":3,"text":"DELETE /sb/targets/{targetId}"},"summary":"Archives a target specified by identifier. Note that archiving is permanent, and once a target has been archived it can't be made active again.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeTargets/list",{"tags":["Negative product targeting"],"operationId":"listNegativeTargets","summary":"Gets a list of product negative targets associated with the client identifier passed in the authorization header, filtered by specified criteria.","description":"**Note**: Negative targets associated with BrandVideo ad groups are only available in v3.2 version.","requestBody":{"description":"A set of filters.","content":{"application/json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048},"maxResults":{"description":"Sets a limit on the number of results returned by an operation.","type":"integer","minimum":1,"maximum":5000}}},{"type":"object","properties":{"filters":{"description":"Restricts results to negative targets with the specified filters.  Filters are inclusive. Filters are joined using 'and' logic. Specify one each type of filter. Specifying multiples of the same type of filter results in an error.","type":"array","items":{"anyOf":[{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `CREATIVE_TYPE` to filter by creative type. If no filter is specified, all negative targets will be returned.","type":"string","enum":["CREATIVE_TYPE"]}}},{"type":"object","properties":{"values":{"description":"A list of creative types.","type":"array","items":{"type":"string","enum":["productCollection","video"]},"minItems":1,"maxItems":2}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `TARGETING_STATE` to filter by negative target state.","type":"string","enum":["TARGETING_STATE"]}}},{"type":"object","properties":{"values":{"description":"A list of negative target states.","type":"array","items":{"type":"string","enum":["enabled","archived"]},"minItems":1,"maxItems":3}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `CAMPAIGN_ID` to filter by campaign identifiers.","type":"string","enum":["CAMPAIGN_ID"]}}},{"type":"object","properties":{"values":{"description":"A list of campaign identifiers.","type":"array","items":{"description":"An existing campaign identifier.","type":"string"},"minItems":1,"maxItems":100}}}]},{"allOf":[{"type":"object","properties":{"filterType":{"description":"Set `filterType` to `AD_GROUP_ID` to filter by ad group identifier.","type":"string","enum":["AD_GROUP_ID"]}}},{"type":"object","properties":{"values":{"description":"A list of ad group identifiers.","type":"array","items":{"description":"An existing ad group identifier.","type":"string"},"minItems":1,"maxItems":100}}}]}]},"minItems":0,"maxItems":3}}}]}}}},"responses":{"200":{"description":"A list of negative targets.","content":{"application/vnd.sblistnegativetargetsresponse.v3.2+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"negativeTargets":{"type":"array","items":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"expressions":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}},"resolvedExpressions":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}}}}}]}},"application/vnd.sblistnegativetargetsresponse.v3+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"negativeTargets":{"type":"array","items":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign to which the target is associated."},"expressions":{"description":"A name value pair that defines a targeting expression. The `type` field defines the predicate. The `value` field defines the value to match for the predicate. ","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"type":"string","description":"The text of the targeting expression. The `-` token defines a range. For example, `2-4` defines a range of 2, 3, and 4."}}},"resolvedExpressions":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}}}}}}]}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20product%20targeting/operation/listNegativeTargets","sectionHeader":{"type":3,"text":"POST /sb/negativeTargets/list"},"summary":"Gets a list of product negative targets associated with the client identifier passed in the authorization header, filtered by specified criteria.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeTargets",{"tags":["Negative product targeting"],"operationId":"updateNegativeTargets","summary":"Updates one or more negative targets.","requestBody":{"description":"A list of negative targets with updated values. <br/>Note that negative targeting clauses can be created on campaigns where serving status is not one of `archived`, `terminated`, `rejected`, or `ended`. <br/>Note that this operation supports a maximum list size of 100 negative targets.","content":{"application/json":{"schema":{"type":"object","properties":{"negativeTargets":{"type":"array","minItems":1,"maxItems":100,"items":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of an existing ad group. The newly created target is associated to this ad group."},"state":{"type":"string","enum":["enabled","paused","archived","draft"]}}}}}}}}},"responses":{"200":{"description":"A list of success and error results for negative targets submitted for update.","content":{"application/vnd.updatenegativetargetsresponse.v3+json":{"schema":{"type":"object","properties":{"updateTargetSuccessResults":{"description":"Lists the successfully updated negative targets. Note that negative targets in the response are correlated to negative targets in the request using the `targetRequestIndex` field. For example, if `targetRequestIndex` is set to `2`, the values correlate to the third negative target object in the request.","type":"array","items":{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."},"targetRequestIndex":{"description":"Correlates the negative target to the negative target array index specified in the request. Zero-based.","type":"number"}}}},"updateTargetErrorResults":{"description":"Lists errors that occured during negative target update. Note that errors are correlated to negative target update requests by the `negativeTargetRequestIndex` field. This field corresponds to the order of the negative target in the request. For example, if `negativeTargetRequestIndex` is set to `2`, the values correlate to the third negative target object in the request.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."},"targetRequestIndex":{"description":"Correlates the negative target to the negative target array index specified in the request. Zero-based.","type":"number"}}}]}}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20product%20targeting/operation/updateNegativeTargets","sectionHeader":{"type":3,"text":"PUT /sb/negativeTargets"},"summary":"Updates one or more negative targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeTargets",{"tags":["Negative product targeting"],"operationId":"createNegativeTargets","summary":"Create one or more negative targets.","requestBody":{"description":"A list of negative targeting clauses for creation. <br/>Note that negative targeting clauses can be created on campaigns where serving status is not one of `archived`, `terminated`, `rejected`, or `ended`. <br/>Note that this operation supports a maximum list size of 100 negative targets.","content":{"application/json":{"schema":{"type":"object","required":["negativeTargets"],"properties":{"negativeTargets":{"type":"array","items":{"properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of an existing ad group. The newly created target is associated to this ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of an existing campaign. The newly created target is associated to this campaign."},"expressions":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["asinBrandSameAs","asinSameAs"]},"value":{"type":"string","description":"The text of the negative expression."}}}}}},"minItems":1,"maxItems":100}}}}}},"responses":{"200":{"description":"A list of success and error results for targeting clauses submitted for creation.","content":{"application/vnd.sbcreatenegativetargetsrequest.v3+json":{"schema":{"properties":{"createTargetSuccessResults":{"description":"Lists the successfully created targets. Note that targets in the response are correlated to targets in the request using the `targetRequestIndex` field. For example, if `targetRequestIndex` is set to `2`, the values correlate to the third target object in the request.","type":"array","items":{"type":"object","properties":{"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"},"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."}}}},"createTargetErrorResults":{"description":"Lists errors that occured during target creation. Note that errors are correlated to target create requests by the `targetRequestIndex` field. This field corresponds to the order of the target object in the request. For example, if `targetRequestIndex` is set to `3`, an error occured during creation of the fourth target in the request.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"targetRequestIndex":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"},"targetId":{"type":"integer","format":"int64","description":"The identifier of a target."}}}]}}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20product%20targeting/operation/createNegativeTargets","sectionHeader":{"type":3,"text":"POST /sb/negativeTargets"},"summary":"Create one or more negative targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeTargets/{negativeTargetId}",{"tags":["Negative product targeting"],"operationId":"getNegativeTarget","summary":"Gets a negative target specified by identifier.","parameters":[{"name":"negativeTargetId","description":"The identifier of an existing negative target.","in":"path","required":true,"schema":{"type":"integer","format":"int64","description":"The identifier of a negative target."}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbnegativetarget.v3+json":{"schema":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of an existing ad group. The newly created target is associated to this ad group"},"campaignId":{"type":"integer","format":"int64","description":"The identifier of an existing campaign. The newly created target is associated to this campaign"},"expressions":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["asinBrandSameAs","asinSameAs"]},"value":{"type":"string","description":"The text of the negative expression."}}}},"resolvedExpressions":{"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceLessThan","asinPriceBetween","asinPriceGreaterThan","asinReviewRatingLessThan","asinReviewRatingBetween","asinReviewRatingGreaterThan","asinSameAs"]},"value":{"readOnly":true,"type":"string","description":"The human-readable target text."}}},"state":{"type":"string","enum":["enabled","paused","archived","draft"]}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20product%20targeting/operation/getNegativeTarget","sectionHeader":{"type":3,"text":"GET /sb/negativeTargets/{negativeTargetId}"},"summary":"Gets a negative target specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/negativeTargets/{negativeTargetId}",{"tags":["Negative product targeting"],"operationId":"archiveNegativeTarget","summary":"Archives a negative target specified by identifier. Note that archiving is permanent, and once a negative target has been archived it can't be made active again.","parameters":[{"name":"negativeTargetId","in":"path","required":true,"schema":{"type":"integer","format":"int64","description":"The identifier of a negative target."}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbnegativetarget.v3+json":{"schema":{"properties":{"targetId":{"type":"integer","format":"int64","description":"The target identifier."},"code":{"type":"string"}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"404":{"description":"The requested resource was not found.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Negative%20product%20targeting/operation/archiveNegativeTarget","sectionHeader":{"type":3,"text":"DELETE /sb/negativeTargets/{negativeTargetId}"},"summary":"Archives a negative target specified by identifier. Note that archiving is permanent, and once a negative target has been archived it can't be made active again.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/themes/list",{"tags":["Theme targeting"],"operationId":"sbListThemes","description":"Note that this endpoint does not support for **Author profiles**. Gets a list of theme targets associated with the client identifier passed in the authorization header, filtered by specified criteria.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A set of filters.","content":{"application/json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048},"maxResults":{"description":"Sets a limit on the number of results returned by an operation.","type":"integer","minimum":1,"maximum":5000}}},{"type":"object","properties":{"themeIdFilter":{"description":"A list of theme targets identifiers.","properties":{"include":{"type":"array","items":{"description":"An theme target identifier.","type":"string","minItems":1,"maxItems":100}}}},"adGroupIdFilter":{"description":"A list of ad group identifiers.","properties":{"include":{"type":"array","items":{"description":"An ad group identifier.","type":"string","minItems":1,"maxItems":100}}}},"campaignIdFilter":{"description":"A list of campaign identifiers.","properties":{"include":{"type":"array","items":{"description":"A campaign identifier.","type":"string","minItems":1,"maxItems":100}}}},"stateFilter":{"description":"A list of theme target states.","properties":{"include":{"type":"array","items":{"type":"string","enum":["paused","enabled","archived"],"default":"enabled,paused","minItems":1,"maxItems":3}}}},"themeTypeFilter":{"description":"A list of theme target type.","properties":{"include":{"type":"array","items":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"minItems":1,"maxItems":2}}}}}]}}}},"responses":{"200":{"description":"A list of targeting clauses.","content":{"application/vnd.sbthemeslistresponse.v3+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"themes":{"type":"array","items":{"description":"| themeType | description |\n|-----------|-------------|\n| KEYWORDS_RELATED_TO_YOUR_BRAND | keywords related to brands. |\n| KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES | keywords related to your landing pages. |","properties":{"themeId":{"description":"The theme target identifier.","type":"string"},"adGroupId":{"description":"The identifier of the ad group associated with the theme target.","type":"string"},"campaignId":{"description":"The identifier of the campaign associated with the theme target.","type":"string"},"themeType":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features).","type":"number"}}},"minItems":0,"maxItems":5000}}}]}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Theme%20targeting/operation/sbListThemes","sectionHeader":{"type":3,"text":"POST /sb/themes/list"},"documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/themes",{"tags":["Theme targeting"],"operationId":"sbUpdateThemes","description":"Note that this endpoint does not support for **Author profiles**.","summary":"Updates one or more theme targets.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of theme targets with updated values. <br/>Note that theme targets can be updated on multi-adGroups campaigns and where campaign serving status is not one of `archived`, `terminated`, `rejected`, or `ended` and adgroup state is not 'archived'. <br/>Note that this operation supports a maximum list size of 100 theme targets. Also theme target can not be archived. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"object","required":["themes"],"properties":{"themes":{"type":"array","items":{"properties":{"themeId":{"type":"string","description":"The identifier of the theme target."},"adGroupId":{"type":"string","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"string","description":"The identifier of the campaign to which the target is associated."},"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}},"required":["themeId","adGroupId"]},"minItems":1,"maxItems":100}}}}}},"responses":{"200":{"description":"A list of success and error results for theme targets submitted for update.","content":{"application/vnd.sbthemesupdateresponse.v3+json":{"schema":{"type":"object","properties":{"success":{"description":"Lists the successfully updated theme targets. Note that theme targets in the response are correlated to theme targets in the request using the `index` field. For example, if `index` is set to `2`, the values correlate to the third theme target object in the request.","type":"array","items":{"type":"object","properties":{"themeId":{"type":"string","description":"The identifier of theme target."},"index":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"}}},"minItems":0,"maxItems":100},"error":{"description":"Lists errors that occurred during theme target update. Note that errors are correlated to theme target update requests by the `index` field. This field corresponds to the order of the theme target in the request. For example, if `index` is set to `2`, the values correlate to the third theme target object in the request array.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"themeId":{"type":"string","description":"The identifier of theme target."},"index":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"}}}]},"minItems":0,"maxItems":100}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Theme%20targeting/operation/sbUpdateThemes","sectionHeader":{"type":3,"text":"PUT /sb/themes"},"summary":"Updates one or more theme targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/themes",{"tags":["Theme targeting"],"operationId":"sbCreateThemes","description":"Note that this endpoint does not support for **Author profiles**.","summary":"Create one or more theme targets.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of theme targets for creation. <br/>Note that theme targets can be created on multi-adGroups campaigns and where campaign serving status is not one of `archived`, `terminated`, `rejected`, or `ended` and adgroup state is not 'archived'. <br/>Note that this operation supports a maximum list size of 100 theme targets and only one target can be created for each themeType per adGroup. <br/>Note the bid is only mutable when the keyword's corresponding campaign does not have any enabled optimization rule.","content":{"application/json":{"schema":{"type":"object","required":["themes"],"properties":{"themes":{"type":"array","items":{"properties":{"adGroupId":{"type":"string","description":"The identifier of the ad group to which the target is associated."},"campaignId":{"type":"string","description":"The identifier of the campaign to which the target is associated."},"themeType":{"type":"string","description":"The theme target type.\n- KEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands.\n- KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages.\n- Note: Additional theme types may be added in the future."},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features)."}},"required":["adGroupId","themeType","bid"]},"minItems":1,"maxItems":100}}}}}},"responses":{"200":{"description":"A list of success and error results for theme targets submitted for creation.","content":{"application/vnd.sbthemescreateresponse.v3+json":{"schema":{"properties":{"success":{"description":"Lists the successfully created theme targets. Note that theme targets in the response are correlated to theme targets in the request using the `index` field. For example, if `index` is set to `2`, the values correlate to the third theme target object in the request.","type":"array","items":{"type":"object","properties":{"index":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"},"themeId":{"type":"string","description":"The identifier of theme target."}}},"minItems":0,"maxItems":100},"error":{"description":"Lists errors that occurred during theme target creation. Note that errors are correlated to theme target create requests by the `index` field. This field corresponds to the order of the target object in the request. For example, if `index` is set to `3`, an error occurred during creation of the fourth theme target in the request.","type":"array","items":{"allOf":[{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}},{"type":"object","properties":{"index":{"description":"Correlates the target to the target array index specified in the request. Zero-based.","type":"number"}}}]},"minItems":0,"maxItems":100}}}}}},"400":{"description":"Bad request.","content":{"application/vnd.sberror.v3.0+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Theme%20targeting/operation/sbCreateThemes","sectionHeader":{"type":3,"text":"POST /sb/themes"},"summary":"Create one or more theme targets.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/recommendations/targets/product/list",{"tags":["Targeting recommendations"],"operationId":"getProductRecommendations","summary":"Gets a list of recommended products for targeting.","description":"Recommendations are based on the ASINs that are passed in the request.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of ASINs.","content":{"application/json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048},"maxResults":{"description":"Sets a limit on the number of results returned by an operation.","type":"integer","minimum":1,"maximum":100}}},{"type":"object","properties":{"filters":{"description":"Restricts recommendations to the criteria specified in the filters.","type":"array","items":{"anyOf":[{"allOf":[{"type":"object","properties":{"filterType":{"type":"string","enum":["ASINS"]}}},{"type":"object","properties":{"values":{"description":"A list of ASINs.","type":"array","items":{"description":"An ASIN.","type":"string"},"minItems":1,"maxItems":100}}}]}]}}}}]}}}},"responses":{"200":{"description":"A list of product targeting recommendations.","content":{"application/vnd.sbproductrecommendationsresponse.v3.1+json":{"schema":{"allOf":[{"properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string","minLength":1,"maxLength":2048}}},{"type":"object","properties":{"recommendedProducts":{"type":"array","items":{"type":"object","properties":{"recommendedTargetAsin":{"description":"The recommended target ASIN.","type":"string"}}}}}}]}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Targeting%20recommendations/operation/getProductRecommendations","sectionHeader":{"type":3,"text":"POST /sb/recommendations/targets/product/list"},"summary":"Gets a list of recommended products for targeting.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/recommendations/targets/category",{"tags":["Targeting recommendations"],"operationId":"getTargetingCategories","summary":"Gets a list of recommended categories for targeting.","description":"Recommendations are based on the ASINs that are passed in the request.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"Return the categories in the specified locale.","required":false,"schema":{"type":"string","enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"]}}],"requestBody":{"description":"List of ASINs.","content":{"application/json":{"schema":{"type":"object","properties":{"asins":{"type":"array","description":"A list of ASINs.","items":{"type":"string"}},"supplySource":{"type":"string","description":"(As of 05/28/2024, `STREAMING_VIDEO` is deprecated). The supply source of the campaign. Use `AMAZON` for placements on Amazon website. Use `STREAMING_VIDEO` for off-site video placements such as IMDb TV. Default value is `AMAZON`.","enum":["AMAZON","STREAMING_VIDEO"]}}}}}},"responses":{"200":{"description":"A list of category targeting recommendations.","content":{"application/vnd.sbcategoryrecommendationsresponse.v3.2+json":{"schema":{"type":"object","properties":{"categoryRecommendationResults":{"type":"array","items":{"properties":{"id":{"type":"integer","format":"int64","description":"The category identifier."},"name":{"type":"string","description":"The category name."},"translatedName":{"type":"string","description":"The category name translated to the specified locale in the request."},"isTargetable":{"type":"boolean","description":"Set to `true` if the category can be targeted in a targeting expression, and `false` if not."},"path":{"type":"string","description":"The path of the category within the category catalogue."},"translatedPath":{"type":"string","description":"The path of the category within the category catalogue translated to the specified locale in the request."},"estimatedReach":{"type":"string","description":"(As of 05/28/2024, `STREAMING_VIDEO` is deprecated). The estimated daily reach range of the category. Only set when supply source is `STREAMING_VIDEO`"}}}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Targeting%20recommendations/operation/getTargetingCategories","sectionHeader":{"type":3,"text":"POST /sb/recommendations/targets/category"},"summary":"Gets a list of recommended categories for targeting.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/recommendations/targets/brand",{"tags":["Targeting recommendations"],"operationId":"getBrandRecommendations","summary":"Gets a list of brand suggestions.","description":"The Brand suggestions are based on a list of either category identifiers or keywords passed in the request. It is not valid to specify both category identifiers and keywords in the request.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"categoryId":{"type":"integer","format":"int64","description":"The category identifier for which to get recommendations."}}},{"type":"object","properties":{"keyword":{"type":"string","description":"The keyword for which to get recommendations."}}}]}}}},"responses":{"200":{"description":"success","content":{"application/vnd.sbbrandrecommendationsresponse.v3.1+json":{"schema":{"type":"object","properties":{"brandRecommendationResults":{"type":"array","items":{"properties":{"id":{"type":"integer","format":"int64","description":"The Brand identifier."},"name":{"type":"string","description":"The Brand name."}}}}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Targeting%20recommendations/operation/getBrandRecommendations","sectionHeader":{"type":3,"text":"POST /sb/recommendations/targets/brand"},"summary":"Gets a list of brand suggestions.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/sb/moderation/campaigns/{campaignId}",{"tags":["Moderation"],"summary":"[DEPRECATED] Gets the moderation result for a campaign specified by identifier.","deprecated":true,"description":"[DEPRECATED - Do not use] https://advertising.amazon.com/API/docs/en-us/release-notes/deprecations#deprecation-announcement-sponsored-brands-legacy-version-of-moderation-results-api-will-shut-off-on-dec-15-2025\n\nNote that this resource is only available for campaigns in the US marketplace.\n","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"campaignId","in":"path","description":"The campaign identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"success","content":{"application/vnd.sbmoderation.v3+json":{"schema":{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The campaign identifier."},"moderationStatus":{"type":"string","enum":["APPROVED","IN_PROGRESS","REJECTED"],"description":"The moderation status of the campaign.\n|Status|Description|\n|------|-----------|\n|APPROVED|Moderation for the campaign is complete.|\n|IN_PROGRESS|Moderation for the campaign is in progress. The expected date and time for completion are specfied in the `etaForModeration` field.|\n|REJECTED|The campaign has failed moderation. Specific information about the content that violated policy is available in `policyViolations`.|"},"etaForModeration":{"type":"string","format":"date-time","description":"Expected date and time by which moderation will be complete. Note that this field is present in the response only when `moderationStatus` is set to `IN_PROGRESS`."},"policyViolations":{"type":"array","description":"A list of policy violations for a campaign that has failed moderation. Note that this field is present in the response only when `moderationStatus` is set to `REJECTED`.","items":{"type":"object","properties":{"policyDescription":{"type":"string","example":"Advertising alcohol is not allowed","description":"A human-readable description of the policy."},"policyLinkUrl":{"type":"string","format":"uri","example":"https://advertising.amazon.com/resources/ad-policy/en/creative-acceptance#alcohol","description":"Address of the policy documentation. Follow the link to learn more about the specified policy."},"violatingTextContents":{"type":"array","description":"Information about the specific text that violates the specified policy in the campaign.","items":{"type":"object","properties":{"moderatedComponent":{"type":"string","description":"The ad component that includes the text that violates the specified policy.","example":"headline"},"reviewedText":{"type":"string","description":"The specific text reviewed during moderation.","example":"Best alcohol money can buy"},"textEvidences":{"type":"array","items":{"type":"object","properties":{"violatingText":{"type":"string","description":"The specific text determined to violate the specified policy in `reviewedText`.","example":"alcohol"},"violatingTextPosition":{"type":"object","properties":{"start":{"type":"integer","description":"Zero-based index into the text in `reviewedText` where the text specified in `violatingText` starts.","example":5},"end":{"type":"integer","description":"Zero-based index into the text in `reviewedText` where the text specified in `violatingText` ends.","example":11}}}}}}}}},"violatingImageContents":{"type":"array","description":"Information about the specific image that violates the specified policy.","items":{"type":"object","properties":{"moderatedComponent":{"type":"string","description":"The ad component that includes the image that violates the specified policy.","example":"brandlogo"},"reviewedImageUrl":{"type":"string","description":"Address of the image reviewed during moderation.","example":"https://media-central.amazon.com/ejfkkfwkeclkmd.jpg"},"imageEvidences":{"type":"array","items":{"properties":{"violatingImageCrop":{"type":"object","properties":{"topLeftX":{"type":"integer","description":"The top left X-coordinate of the content that violates the specfied policy within the image.","example":24},"topLeftY":{"type":"integer","description":"The top left Y-coordinate of the content that violates the specfied policy within the image.","example":87},"height":{"type":"integer","description":"The height of the content that violates the specified policy within the image.","example":50},"width":{"type":"integer","description":"The width of the content that violates the specified policy within the image.","example":75}}}}}}}}},"violatingAsinContents":{"type":"array","description":"Information about the specific ASIN in the campaign that violates the specified policy.","items":{"type":"object","properties":{"moderatedComponent":{"type":"string","description":"The ad component that includes the ASIN that violates the specified policy.","example":"landingPageAsin"},"asinEvidences":{"type":"array","items":{"properties":{"asin":{"type":"string","description":"The ASIN that violates the specified policy.","pattern":"[A-Za-z0-9]{10}","example":"B0786PRKBP"}}}}}}}}}}}}}}},"404":{"description":"Requested campaignId not found","content":{"application/vnd.error.v3+json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Moderation","sectionHeader":{"type":3,"text":"GET /sb/moderation/campaigns/{campaignId}"},"summary":"[DEPRECATED] Gets the moderation result for a campaign specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/v2/hsa/{recordType}/report",{"tags":["Reports"],"summary":"Requests the creation of a report containing performance data related to Sponsored Brands campaigns.","description":"Use this interface to request and retrieve performance reports. **To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).**\n\n**KDP support**\n\nNote that KDP profiles cannot currently request reports for Sponsored Brands campaigns using the API. Authors should use the advertising console to download reporting data. \n\n**Filtering**\n\nFor more information, see the [Reporting FAQ](/API/docs/en-us/guides/reporting/v2/faq#can-i-filter-a-sponsored-brands-report).\n\n**Constraints of Sponsored Brands reporting**\n\nSponsored Brands reporting data cannot be combined with Sponsored Products data into one report. Only 14-day data is available for Sponsored Brands. Attribution windows of 1, 7, and 30-day intervals are not available.\n\n**New-to-brand performance metrics**\n\nWith new-to-brand metrics, advertisers can measure and optimize campaigns, as well as plan future marketing strategies to grow their customer base on Amazon. New-to-brand metrics determine whether an ad-attributed purchase was made by an existing customer or one buying a brand’s product on Amazon for the first time over the prior year. With new-to-brand metrics, advertisers receive campaign performance metrics such as total new-to-brand purchases and sales, new-to-brand purchase rate, and cost per new-to-brand customer. Advertisers now have the tools they need to estimate the cost of acquiring new customers on Amazon and identify the most efficient channels and tactics to achieve their campaign goals.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"recordType","in":"path","description":"The type of report. Valid types are `campaigns`, `adGroups`, `ads`, `targets`, and `keywords`.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reportDate","metrics"],"properties":{"reportDate":{"type":"string","description":"Date in YYYYMMDD format. The report only contains performance data for the specified date. The time zone is specified by the profile used to request the report. If this date is today, then the performance report may contain partial information. Reports are not available for data older than 60 days. For details on data latency, see [Service Guarantees](../../reference/concepts/developer-notes)."},"segment":{"type":"string","description":"Optional. Allows you to run a report based on secondary dimensions. Use `placement` to segment a `campaigns` report by the location on a page where your ad appears. Use `query` to segment a `keywords` report and create a search terms report.","enum":["placement","query"]},"creativeType":{"type":"string","description":"Optional. Supported values are `video` (for video campaigns) and `all` (for both non-video and video campaigns). If not specified, the report will contain data for non-video campaigns. For `ads` report types only, `creativeType` is required and must be set to `all` (`video` is not allowed). To return performance data for [multi-ad group campaigns](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#/Campaigns), you must include `creativeType` set to `all`` in your request.","enum":["video","all"]},"metrics":{"type":"string","description":"Each report type supports different metrics. **To understand supported metrics for each report type, see [Report types](/API/docs/en-us/guides/reporting/v2/report-types).** "}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"type":"string","description":"The unique ID for your requested report."},"recordType":{"type":"string","description":"The record type of the report. It can be `campaign`, `adGroup`, `keyword`, or `targets`."},"status":{"type":"string","description":"The status of the report. Status is one of `IN_PROGRESS`, `SUCCESS`, or `FAILURE`."},"statusDetails":{"type":"string","description":"Description of the status."}}}}}},"406":{"description":"Failed due to report date being too far in the past. Reports are not available for data older than 60 days.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"422":{"description":"Report formed incorrectly. Report requests return a 422 status code if the parameters specified are unrecognized or if the combination of parameters is not supported. In particular, the choice of `recordType` may restrict the use of certain segments. Query segmentation can only be used in combination with keyword and product ad reports.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Reports","sectionHeader":{"type":3,"text":"POST /v2/hsa/{recordType}/report"},"summary":"Requests the creation of a report containing performance data related to Sponsored Brands campaigns.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/v2/reports/{reportId}",{"tags":["Reports"],"summary":"Returns the status of a previously requested report.","description":"To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"reportId","in":"path","description":"Report ID returned by POST report method.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"type":"string","description":"The unique ID for your requested report."},"status":{"type":"string","description":"The status of the report. Status is one of `IN_PROGRESS`, `SUCCESS`, or `FAILURE`."},"statusDetails":{"type":"string","description":"Description of the status."}}}}}},"404":{"description":"Report not found.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Reports","sectionHeader":{"type":3,"text":"GET /v2/reports/{reportId}"},"summary":"Returns the status of a previously requested report.","documentType":"api-reference"},{"title":"Amazon Ads API - Sponsored Brands","content":["/v2/reports/{reportId}/download",{"tags":["Reports"],"summary":"Downloads a previously requested report identified by `reportId`.","description":"Gets a `307 Temporary Redirect` response that includes a `location` header with the value set to an AWS S3 path where the report is located. The path expires after 30 seconds. If the path expires before the report is downloaded, a new report request must be created. \n\n**To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).**\n\nThe report file contains one row per entity for which performance data is present. These records are represented as JSON containing the ID attribute corresponding to the `recordType`, the segment (if specified), and each of the metrics in the request.\n\n**Note**: The report files in S3 are gzipped.\n\n*Example report download*\n\n`$ curl -o /tmp/report.json.gz \"https://sandboxreports.s3.amazonaws.com/amzn1.clicksAPI.v1.m1.580149D6.c7aa92c1-ca5b-435d-bb8b-51cb26ad5731?AWSAccessKeyId=AKIAIKLHNT32USZOWVRA&amp;Expires=1476479900&amp;Signature=I%2F2Gd%2B8TbcPbXbBUM6ix%2BSVP3qA%3D\"`","operationId":"downloadReport","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a **Login with Amazon** account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"reportId","in":"path","description":"The identifier of the requested report.","required":true,"schema":{"type":"string"}}],"responses":{"307":{"description":"Successful operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Redirect URI with S3 file location containing report data"}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"404":{"description":"Not found - requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"429":{"description":"Too many requests - request was rate-limited. Retry later.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}},"500":{"description":"Internal server error - something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","readOnly":true},"details":{"type":"string","readOnly":true}}}}}}}}],"path":"/en-us/sponsored-brands/3-0/openapi#tag/Reports/operation/downloadReport","sectionHeader":{"type":3,"text":"GET /v2/reports/{reportId}/download"},"summary":"Downloads a previously requested report identified by `reportId`.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["Create and manage Sponsored Brands campaigns. \n\nTo learn more about Sponsored Brands campaigns, see:\n\nSponsored Brands overview\n\nSponsored Brands campaign structure\n\nGet started with Sponsored Brands campaigns\n"],"path":"/en-us/sponsored-brands/3-0/openapi/prod","sectionHeader":{"type":2,"text":"Sponsored Brands campaign management"},"documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/campaigns",{"summary":"Create campaigns","requestBody":{"content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"budgetType":{"description":"For the lifetime budget type, `startDate` and `endDate` must be specified.","type":"string","enum":["DAILY","LIFETIME"]},"brandEntityId":{"description":"Please note that brandEntityId is only required for sellers. You can get the brandEntityId by calling the [GET /brands](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#tag/Brands/operation/getBrands) endpoint.","type":"string"},"goal":{"description":"Goal will allow you to set goal type to help drive your campaign performance. If no goal is selected then it will default to PAGE_VISIT.\nThe goal type of the campaign.\n- BRAND_IMPRESSION_SHARE - This goal will allow you grown your brand impression share on top of search placement\n- PAGE_VISIT [DEFAULT] - This goal drives traffic to your landing and detail pages through all placements.\n\nNote: Goal-based campaigns are not supported in the Ireland (IE) marketplace. For IE, both `goal` and `costType` must be omitted from the request, which creates a standard (non-goal-based) campaign. Supplying `goal` and `costType` in IE returns a `GOAL_BASED_CAMPAIGNS_DISABLED` error.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"endDate is optional. If endDate is specified, startDate must be specified as well.","type":"string"},"productLocation":{"description":"The product location of the campaign.\n- SOLD_ON_AMAZON - For products sold on Amazon websites.\n- NOT_SOLD_ON_AMAZON - For products not sold on Amazon websites.\n- SOLD_ON_DTC - Deprecated (For products sold on DTC websites).","type":"string","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON","SOLD_ON_DTC"]},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"costType":{"description":"The costType can be set to determines how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace\n- CPC [Default] - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad.\n- VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\n- FIXED_PRICE - Sale price for a specific ad placement. It can only be used for campaign with a targetedPGDealId.","type":"string"},"smartDefault":{"minItems":1,"maxItems":100,"description":"The smartDefault specifies a list of the smart default options for the campaign.\n\n`smartDefault` is optional for create campaign requests. `smartDefault` are applicable to all applicable child entities of the campaign and are not editable once the campaign is created. When using [\"TARGETING\"], targets will be automatically added based on the goal selected.  When [\"MANUAL\"] is selected, you will still be required to manually add targets.\n\nIf you don't specify `smartDefault`, default value will be applied based on `goal` . If campaign's `goal` is selected, `smartDefault` will be set to [\"TARGETING\"].  Otherwise, a campaign's `smartDefault` will be set to [\"MANUAL\"].\n\nEach element in smartDefault can be set to determines which default strategy to be used\n- MANUAL - Manual settings, no smart default be applied to the campaign, if MANUAL is added in the list, no other items are allowed in the list (the list must contains only one item)\n- TARGETING - Smart Default Targeting creation, will automatically creating targetings when create ad group\n\nExample: [\"TARGETING\"]","type":"array","items":{"type":"string"}},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"startDate is optional. If startDate is not specified, current date will be used.","type":"string"},"budget":{"format":"double","description":"The budget of the campaign.","type":"number"},"siteRestrictions":{"type":"array","items":{"type":"string","enum":["AMAZON_BUSINESS"]},"maxItems":1,"minItems":1,"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.  If this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business. \nPlease note that:\n1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU);\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions doesn't support shopperCohortBidding setting."},"targetedPGDealId":{"description":"DealId associated with the campaign.","type":"string"}},"required":["budget","budgetType","name","state"]}}},"required":["campaigns"]}}},"required":true},"description":"Creates Sponsored Brands campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsCampaigns","responses":{"207":{"description":"CreateSponsoredBrandsCampaigns 207 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"campaignId":{"description":"The campaign ID.","type":"string"},"index":{"description":"The index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"campaign":{"type":"object","properties":{"budgetType":{"description":"For the lifetime budget type, `startDate` and `endDate` must be specified.","type":"string","enum":["DAILY","LIFETIME"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}},"brandEntityId":{"type":"string"},"isMultiAdGroupsEnabled":{"type":"boolean"},"goal":{"description":"Goal will allow you to set goal type to help drive your campaign performance. If no goal is selected then it will default to PAGE_VISIT.\nThe goal type of the campaign.\n- BRAND_IMPRESSION_SHARE - This goal will allow you grown your brand impression share on top of search placements\n- PAGE_VISIT [DEFAULT] - This goal drives traffic to your landing and detail pages through all placements\n- ACQUIRE_NEW_CUSTOMERS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal drives new customer acquisition for your brands.\n- AD_VIEWS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal maximizes view for your ads.\n\nNote: Goal-based campaigns are not supported in the Ireland (IE) marketplace. For IE, both `goal` and `costType` must be omitted from the request, which creates a standard (non-goal-based) campaign. Supplying `goal` and `costType` in IE returns a `GOAL_BASED_CAMPAIGNS_DISABLED` error.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"productLocation":{"description":"The product location of the campaign.\n- SOLD_ON_AMAZON - For products sold on Amazon websites.\n- NOT_SOLD_ON_AMAZON - For products not sold on Amazon websites.\n- SOLD_ON_DTC - Deprecated (For products sold on DTC websites).","type":"string","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON","SOLD_ON_DTC"]},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"costType":{"description":"The costType can be set to determines how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace\n- CPC [Default] - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad.\n- VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\n- FIXED_PRICE - Sale price for a specific ad placement. It can only be used for campaign with a targetedPGDealId.","type":"string"},"smartDefault":{"minItems":1,"maxItems":100,"description":"The smartDefault specifies a list of the smart default options for the campaign.\n\n`smartDefault` is optional for create campaign requests. `smartDefault` are applicable to all applicable child entities of the campaign and are not editable once the campaign is created. When using [\"TARGETING\"], targets will be automatically added based on the goal selected.  When [\"MANUAL\"] is selected, you will still be required to manually add targets.\n\nIf you don't specify `smartDefault`, default value will be applied based on `goal` . If campaign's `goal` is selected, `smartDefault` will be set to [\"TARGETING\"].  Otherwise, a campaign's `smartDefault` will be set to [\"MANUAL\"].\n\nEach element in smartDefault can be set to determines which default strategy to be used\n- MANUAL - Manual settings, no smart default be applied to the campaign, if MANUAL is added in the list, no other items are allowed in the list (the list must contains only one item)\n- TARGETING - Smart Default Targeting creation, will automatically creating targetings when create ad group\n\nExample: [\"TARGETING\"]","type":"array","items":{"type":"string"}},"siteRestrictions":{"minItems":1,"maxItems":1,"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.  If this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business. \nPlease note that:\n1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU);\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions doesn't support shopperCohortBidding setting.","type":"array","items":{"type":"string","enum":["AMAZON_BUSINESS"]}},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"budget":{"format":"double","type":"number"},"extendedData":{"description":"CampaignExtendedData can only be retrieved via the list API. It won't be available in the response during update/create.","type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe campaign serving status determined by system.\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's status is enabled.\n- CAMPAIGN_PAUSED - Campaign's status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's status is enabled\n- PORTFOLIO_PAUSED - Portfolio's status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's start date is in the future\n- PORTFOLIO_ENDED - Portfolio's end date is in the past.\n\n- INELIGIBLE - Ad Offer is ineligible\n- ELIGIBLE - Ad Offer is eligible\n- ENDED - Campaign's end date is in the past.\n- PENDING_REVIEW - Campaign is pending review.\n- PENDING_START_DATE - Campaign's start date is in the future.\n- REJECTED - Campaign is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Campaign.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}},"targetedPGDealId":{"description":"DealId associated with the campaign. This field is immutable and cannot be changed after the campaign is created.","type":"string"}},"required":["budget","budgetType","campaignId","name","state"]}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"budgetError":{"type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"billingError":{"description":"Errors related to billing.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Campaigns"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Campaigns/operation/CreateSponsoredBrandsCampaigns","sectionHeader":{"type":3,"text":"POST /sb/v4/campaigns"},"summary":"Create campaigns","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/campaigns",{"summary":"Update campaigns","requestBody":{"content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"portfolioId":{"nullable":true,"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"nullable":true,"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"endDate is optional. If endDate is specified, startDate must be specified as well. Note: This property is nullable. If null is explicitly provided in a campaign update request, any existing endDate for the campaign will be removed.","type":"string"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"startDate can only be changed if the current startDate is in the future.","type":"string"},"budget":{"format":"double","description":"The budget of the campaign. See https://advertising.amazon.com/help?entityId=ENTITYJDATFOIA05Q7#GE5QEBS6QRJJAT3A","type":"number"},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0}},"required":["campaignId"]}}},"required":["campaigns"]}}},"required":true},"description":"Updates Sponsored Brands campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredBrandsCampaigns","responses":{"207":{"description":"UpdateSponsoredBrandsCampaigns 207 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"campaignId":{"description":"The campaign ID.","type":"string"},"index":{"description":"The index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"campaign":{"type":"object","properties":{"budgetType":{"description":"For the lifetime budget type, `startDate` and `endDate` must be specified.","type":"string","enum":["DAILY","LIFETIME"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}},"brandEntityId":{"type":"string"},"isMultiAdGroupsEnabled":{"type":"boolean"},"goal":{"description":"Goal will allow you to set goal type to help drive your campaign performance. If no goal is selected then it will default to PAGE_VISIT.\nThe goal type of the campaign.\n- BRAND_IMPRESSION_SHARE - This goal will allow you grown your brand impression share on top of search placements\n- PAGE_VISIT [DEFAULT] - This goal drives traffic to your landing and detail pages through all placements\n- ACQUIRE_NEW_CUSTOMERS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal drives new customer acquisition for your brands.\n- AD_VIEWS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal maximizes view for your ads.\n\nNote: Goal-based campaigns are not supported in the Ireland (IE) marketplace. For IE, both `goal` and `costType` must be omitted from the request, which creates a standard (non-goal-based) campaign. Supplying `goal` and `costType` in IE returns a `GOAL_BASED_CAMPAIGNS_DISABLED` error.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"productLocation":{"description":"The product location of the campaign.\n- SOLD_ON_AMAZON - For products sold on Amazon websites.\n- NOT_SOLD_ON_AMAZON - For products not sold on Amazon websites.\n- SOLD_ON_DTC - Deprecated (For products sold on DTC websites).","type":"string","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON","SOLD_ON_DTC"]},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"costType":{"description":"The costType can be set to determines how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace\n- CPC [Default] - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad.\n- VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\n- FIXED_PRICE - Sale price for a specific ad placement. It can only be used for campaign with a targetedPGDealId.","type":"string"},"smartDefault":{"minItems":1,"maxItems":100,"description":"The smartDefault specifies a list of the smart default options for the campaign.\n\n`smartDefault` is optional for create campaign requests. `smartDefault` are applicable to all applicable child entities of the campaign and are not editable once the campaign is created. When using [\"TARGETING\"], targets will be automatically added based on the goal selected.  When [\"MANUAL\"] is selected, you will still be required to manually add targets.\n\nIf you don't specify `smartDefault`, default value will be applied based on `goal` . If campaign's `goal` is selected, `smartDefault` will be set to [\"TARGETING\"].  Otherwise, a campaign's `smartDefault` will be set to [\"MANUAL\"].\n\nEach element in smartDefault can be set to determines which default strategy to be used\n- MANUAL - Manual settings, no smart default be applied to the campaign, if MANUAL is added in the list, no other items are allowed in the list (the list must contains only one item)\n- TARGETING - Smart Default Targeting creation, will automatically creating targetings when create ad group\n\nExample: [\"TARGETING\"]","type":"array","items":{"type":"string"}},"siteRestrictions":{"minItems":1,"maxItems":1,"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.  If this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business. \nPlease note that:\n1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU);\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions doesn't support shopperCohortBidding setting.","type":"array","items":{"type":"string","enum":["AMAZON_BUSINESS"]}},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"budget":{"format":"double","type":"number"},"extendedData":{"description":"CampaignExtendedData can only be retrieved via the list API. It won't be available in the response during update/create.","type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe campaign serving status determined by system.\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's status is enabled.\n- CAMPAIGN_PAUSED - Campaign's status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's status is enabled\n- PORTFOLIO_PAUSED - Portfolio's status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's start date is in the future\n- PORTFOLIO_ENDED - Portfolio's end date is in the past.\n\n- INELIGIBLE - Ad Offer is ineligible\n- ELIGIBLE - Ad Offer is eligible\n- ENDED - Campaign's end date is in the past.\n- PENDING_REVIEW - Campaign is pending review.\n- PENDING_START_DATE - Campaign's start date is in the future.\n- REJECTED - Campaign is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Campaign.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}},"targetedPGDealId":{"description":"DealId associated with the campaign. This field is immutable and cannot be changed after the campaign is created.","type":"string"}},"required":["budget","budgetType","campaignId","name","state"]}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"budgetError":{"type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"billingError":{"description":"Errors related to billing.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Campaigns"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Campaigns/operation/UpdateSponsoredBrandsCampaigns","sectionHeader":{"type":3,"text":"PUT /sb/v4/campaigns"},"summary":"Update campaigns","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/campaigns/list",{"summary":"List campaigns","requestBody":{"content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaignIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"portfolioIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"stateFilter":{"description":"Filter entities by state.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]}}}},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","maximum":100,"type":"number","minimum":1},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"goalTypeFilter":{"description":"Filter entities by goal type.","type":"object","properties":{"include":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}}}},"includeExtendedDataFields":{"description":"Setting to true will slow down performance because the API needs to retrieve extra information for each campaign.","type":"boolean"},"nameFilter":{"description":"Filter entities by name.","type":"object","properties":{"queryTermMatchType":{"description":"Defines how would the string resource field (e.g. campaign name, ad group name) be matched with the query term in filter.","type":"string","enum":["BROAD_MATCH","EXACT_MATCH"]},"include":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}}}}}}}}},"description":"Lists Sponsored Brands campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredBrandsCampaigns","responses":{"200":{"description":"ListSponsoredBrandsCampaigns 200 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"object","properties":{"budgetType":{"description":"For the lifetime budget type, `startDate` and `endDate` must be specified.","type":"string","enum":["DAILY","LIFETIME"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}},"brandEntityId":{"type":"string"},"isMultiAdGroupsEnabled":{"type":"boolean"},"goal":{"description":"Goal will allow you to set goal type to help drive your campaign performance. If no goal is selected then it will default to PAGE_VISIT.\nThe goal type of the campaign.\n- BRAND_IMPRESSION_SHARE - This goal will allow you grown your brand impression share on top of search placements\n- PAGE_VISIT [DEFAULT] - This goal drives traffic to your landing and detail pages through all placements\n- ACQUIRE_NEW_CUSTOMERS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal drives new customer acquisition for your brands.\n- AD_VIEWS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal maximizes view for your ads.\n\nNote: Goal-based campaigns are not supported in the Ireland (IE) marketplace. For IE, both `goal` and `costType` must be omitted from the request, which creates a standard (non-goal-based) campaign. Supplying `goal` and `costType` in IE returns a `GOAL_BASED_CAMPAIGNS_DISABLED` error.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"productLocation":{"description":"The product location of the campaign.\n- SOLD_ON_AMAZON - For products sold on Amazon websites.\n- NOT_SOLD_ON_AMAZON - For products not sold on Amazon websites.\n- SOLD_ON_DTC - Deprecated (For products sold on DTC websites).","type":"string","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON","SOLD_ON_DTC"]},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"costType":{"description":"The costType can be set to determines how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace\n- CPC [Default] - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad.\n- VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\n- FIXED_PRICE - Sale price for a specific ad placement. It can only be used for campaign with a targetedPGDealId.","type":"string"},"smartDefault":{"minItems":1,"maxItems":100,"description":"The smartDefault specifies a list of the smart default options for the campaign.\n\n`smartDefault` is optional for create campaign requests. `smartDefault` are applicable to all applicable child entities of the campaign and are not editable once the campaign is created. When using [\"TARGETING\"], targets will be automatically added based on the goal selected.  When [\"MANUAL\"] is selected, you will still be required to manually add targets.\n\nIf you don't specify `smartDefault`, default value will be applied based on `goal` . If campaign's `goal` is selected, `smartDefault` will be set to [\"TARGETING\"].  Otherwise, a campaign's `smartDefault` will be set to [\"MANUAL\"].\n\nEach element in smartDefault can be set to determines which default strategy to be used\n- MANUAL - Manual settings, no smart default be applied to the campaign, if MANUAL is added in the list, no other items are allowed in the list (the list must contains only one item)\n- TARGETING - Smart Default Targeting creation, will automatically creating targetings when create ad group\n\nExample: [\"TARGETING\"]","type":"array","items":{"type":"string"}},"siteRestrictions":{"minItems":1,"maxItems":1,"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.  If this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business. \nPlease note that:\n1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU);\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions doesn't support shopperCohortBidding setting.","type":"array","items":{"type":"string","enum":["AMAZON_BUSINESS"]}},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"budget":{"format":"double","type":"number"},"extendedData":{"description":"CampaignExtendedData can only be retrieved via the list API. It won't be available in the response during update/create.","type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe campaign serving status determined by system.\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's status is enabled.\n- CAMPAIGN_PAUSED - Campaign's status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's status is enabled\n- PORTFOLIO_PAUSED - Portfolio's status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's start date is in the future\n- PORTFOLIO_ENDED - Portfolio's end date is in the past.\n\n- INELIGIBLE - Ad Offer is ineligible\n- ELIGIBLE - Ad Offer is eligible\n- ENDED - Campaign's end date is in the past.\n- PENDING_REVIEW - Campaign is pending review.\n- PENDING_START_DATE - Campaign's start date is in the future.\n- REJECTED - Campaign is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Campaign.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}},"targetedPGDealId":{"description":"DealId associated with the campaign. This field is immutable and cannot be changed after the campaign is created.","type":"string"}},"required":["budget","budgetType","campaignId","name","state"]}},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalCount":{"description":"The total number of entities.","type":"number"}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Campaigns"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Campaigns/operation/ListSponsoredBrandsCampaigns","sectionHeader":{"type":3,"text":"POST /sb/v4/campaigns/list"},"summary":"List campaigns","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/campaigns/delete",{"summary":"Delete campaigns.","requestBody":{"content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaignIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}}}}}}},"description":"Deletes Sponsored Brands campaigns.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredBrandsCampaigns","responses":{"207":{"description":"DeleteSponsoredBrandsCampaigns 207 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"campaignId":{"description":"The campaign ID.","type":"string"},"index":{"description":"The index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"campaign":{"type":"object","properties":{"budgetType":{"description":"For the lifetime budget type, `startDate` and `endDate` must be specified.","type":"string","enum":["DAILY","LIFETIME"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}},"brandEntityId":{"type":"string"},"isMultiAdGroupsEnabled":{"type":"boolean"},"goal":{"description":"Goal will allow you to set goal type to help drive your campaign performance. If no goal is selected then it will default to PAGE_VISIT.\nThe goal type of the campaign.\n- BRAND_IMPRESSION_SHARE - This goal will allow you grown your brand impression share on top of search placements\n- PAGE_VISIT [DEFAULT] - This goal drives traffic to your landing and detail pages through all placements\n- ACQUIRE_NEW_CUSTOMERS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal drives new customer acquisition for your brands.\n- AD_VIEWS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal maximizes view for your ads.\n\nNote: Goal-based campaigns are not supported in the Ireland (IE) marketplace. For IE, both `goal` and `costType` must be omitted from the request, which creates a standard (non-goal-based) campaign. Supplying `goal` and `costType` in IE returns a `GOAL_BASED_CAMPAIGNS_DISABLED` error.","type":"string"},"bidding":{"type":"object","properties":{"bidOptimization":{"description":"Whether to use automatic placement level bid optimization. If set to true, Amazon will automatically set the right placement adjustment and the bidAdjustmentsByPlacement field is ignored. If set to false, the bidAdjustmentsByPlacement field will be used to adjust bid on different placements.\nIf this field is changed from false to true, the bidAdjustmentsByPlacement field will be reset to null.","type":"boolean"},"shopperCohortBidAdjustments":{"minItems":0,"maxItems":1,"description":"Shopper cohort based bid adjustments.","type":"array","items":{"type":"object","properties":{"shopperCohortType":{"description":"The shopper cohort type. The shopperCohortType is required to specify the type of shopper cohort used to apply bid adjustments. Currently only \"AUDIENCE_SEGMENT\" is supported.","type":"string","enum":["AUDIENCE_SEGMENT"]},"percentage":{"maximum":900,"type":"number","minimum":0},"audienceSegments":{"minItems":1,"maxItems":1,"description":"Required when \"AUDIENCE_SEGMENT\" is used for shopperCohortType.","type":"array","items":{"type":"object","properties":{"audienceId":{"type":"string"},"audienceSegmentType":{"description":"The audience segment type is required to specify the type of audience being used to apply bid adjustments.\n|Value               | Description|\n|---------------------|------------|\n| `SPONSORED_ADS_AMC` | This type refers to the Audience Segments created in AMC for Sponsored Ads. See [AMC API](https://advertising.amazon.com/API/docs/en-us/amc-rba#tag/Rule-based-audience) for details on how to create AMC Audiences. Once the AMC Audiences are created, the Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"AMC\"]]`. Only the audiences retrieved using these filters are usable.|\n| `BEHAVIOR_DYNAMIC` | This type refers to the Audience Segments created by Amazon for Sponsored Ads. The Audience Ids can be retrieved using the Discovery API [ListTargetableEntities](https://advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities) with parameters; `adProduct`=`SPONSORED_BRANDS`, `targetTypeFilter`=`AUDIENCE` and `pathsFilter` = `[[\"Audience Category\", \"Custom-built\", \"Product\"]]`. Only the audiences retrieved using these filters are usable.|\n","type":"string","enum":["SPONSORED_ADS_AMC","BEHAVIOR_DYNAMIC"]}}}}}}},"bidAdjustmentsByPlacement":{"minItems":0,"maxItems":3,"description":"Placement level bid adjustment. Note that this field can only be set when 'bidOptimization' is set to false.","type":"array","items":{"type":"object","properties":{"percentage":{"maximum":900,"type":"number","minimum":-99},"placement":{"description":"List of bid adjustments for placements.\n- HOME - The home page of the Amazon store.\n- DETAIL_PAGE - Product detail pages within the Amazon store.\n- OTHER - Other placement groups. Such as search pages in the Amazon Store.\n- TOP_OF_SEARCH - Top of search ads generally appear above the top search results.","type":"string","enum":["HOME","DETAIL_PAGE","OTHER","TOP_OF_SEARCH"]}}}}}},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"campaignId":{"description":"The identifier of the campaign.","type":"string"},"productLocation":{"description":"The product location of the campaign.\n- SOLD_ON_AMAZON - For products sold on Amazon websites.\n- NOT_SOLD_ON_AMAZON - For products not sold on Amazon websites.\n- SOLD_ON_DTC - Deprecated (For products sold on DTC websites).","type":"string","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON","SOLD_ON_DTC"]},"tags":{"description":"A list of advertiser-specified custom identifiers for the campaign. Each customer identifier is a key-value pair. You can specify a maximum of 50 identifiers.","additionalProperties":{"type":"string"},"maxProperties":50,"type":"object","minProperties":0},"portfolioId":{"description":"The identifier of an existing portfolio to which the campaign is associated.","type":"string"},"costType":{"description":"The costType can be set to determines how the campaign will bid and charge. To view the bid maximums and minimums by geography and costType, see https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace\n- CPC [Default] - Cost per click. The performance of this campaign is measured by the clicks triggered by the ad.\n- VCPM - Cost per 1000 viewable impressions. The performance of this campaign is measured by the viewable impressions triggered by the ad.\n- FIXED_PRICE - Sale price for a specific ad placement. It can only be used for campaign with a targetedPGDealId.","type":"string"},"smartDefault":{"minItems":1,"maxItems":100,"description":"The smartDefault specifies a list of the smart default options for the campaign.\n\n`smartDefault` is optional for create campaign requests. `smartDefault` are applicable to all applicable child entities of the campaign and are not editable once the campaign is created. When using [\"TARGETING\"], targets will be automatically added based on the goal selected.  When [\"MANUAL\"] is selected, you will still be required to manually add targets.\n\nIf you don't specify `smartDefault`, default value will be applied based on `goal` . If campaign's `goal` is selected, `smartDefault` will be set to [\"TARGETING\"].  Otherwise, a campaign's `smartDefault` will be set to [\"MANUAL\"].\n\nEach element in smartDefault can be set to determines which default strategy to be used\n- MANUAL - Manual settings, no smart default be applied to the campaign, if MANUAL is added in the list, no other items are allowed in the list (the list must contains only one item)\n- TARGETING - Smart Default Targeting creation, will automatically creating targetings when create ad group\n\nExample: [\"TARGETING\"]","type":"array","items":{"type":"string"}},"siteRestrictions":{"minItems":1,"maxItems":1,"description":"Restrict the ad to a particular site. siteRestrictions is an optional field.  If this field is not set, ads from the campaign will appear on Amazon - including both Amazon retail and Amazon Business. \nPlease note that:\n1) AMAZON_BUSINESS option is only available for Amazon Business operated marketplaces (US, CA, MX, UK, DE, FR, IT, ES, IN, JP, AU);\n2) siteRestrictions cannot be changed post campaign creation;\n3) siteRestrictions doesn't support shopperCohortBidding setting.","type":"array","items":{"type":"string","enum":["AMAZON_BUSINESS"]}},"name":{"minLength":1,"description":"The name of the campaign.","type":"string","maxLength":128},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"The format of the date is YYYY-MM-DD.","type":"string"},"budget":{"format":"double","type":"number"},"extendedData":{"description":"CampaignExtendedData can only be retrieved via the list API. It won't be available in the response during update/create.","type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe campaign serving status determined by system.\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's status is enabled.\n- CAMPAIGN_PAUSED - Campaign's status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's status is enabled\n- PORTFOLIO_PAUSED - Portfolio's status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's start date is in the future\n- PORTFOLIO_ENDED - Portfolio's end date is in the past.\n\n- INELIGIBLE - Ad Offer is ineligible\n- ELIGIBLE - Ad Offer is eligible\n- ENDED - Campaign's end date is in the past.\n- PENDING_REVIEW - Campaign is pending review.\n- PENDING_START_DATE - Campaign's start date is in the future.\n- REJECTED - Campaign is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Campaign.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}},"targetedPGDealId":{"description":"DealId associated with the campaign. This field is immutable and cannot be changed after the campaign is created.","type":"string"}},"required":["budget","budgetType","campaignId","name","state"]}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the campaign in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"budgetError":{"type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"billingError":{"description":"Errors related to billing.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbcampaignresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Campaigns"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Campaigns/operation/DeleteSponsoredBrandsCampaigns","sectionHeader":{"type":3,"text":"POST /sb/v4/campaigns/delete"},"summary":"Delete campaigns.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/adGroups",{"summary":"Create ad groups","requestBody":{"content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]}},"required":["campaignId","name","state"]}}},"required":["adGroups"]}}},"required":true},"description":"Creates Sponsored Brands ad groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsAdGroups","responses":{"207":{"description":"CreateSponsoredBrandsAdGroups 207 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adGroup":{"type":"object","properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The identifier of the keyword.","type":"string"},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe ad group serving status determined by system.\n- AD_GROUP_STATUS_ENABLED - Ad group's status is enabled.\n- AD_GROUP_PAUSED - Ad group's status is paused.\n- AD_GROUP_ARCHIVED - Ad group's status is archived.\n- AD_GROUP_INCOMPLETE - Ad group does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad group is ineligible.\n- ELIGIBLE - Ad group is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad Group.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","name","state"]},"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"adGroupId":{"description":"the adGroup ID.","type":"string"}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ad groups"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20groups/operation/CreateSponsoredBrandsAdGroups","sectionHeader":{"type":3,"text":"POST /sb/v4/adGroups"},"summary":"Create ad groups","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/adGroups",{"summary":"Update ad groups","requestBody":{"content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The identifier of the keyword.","type":"string"}},"required":["adGroupId"]}}},"required":["adGroups"]}}},"required":true},"description":"Updates Sponsored Brands ad groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredBrandsAdGroups","responses":{"207":{"description":"UpdateSponsoredBrandsAdGroups 207 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adGroup":{"type":"object","properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The identifier of the keyword.","type":"string"},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe ad group serving status determined by system.\n- AD_GROUP_STATUS_ENABLED - Ad group's status is enabled.\n- AD_GROUP_PAUSED - Ad group's status is paused.\n- AD_GROUP_ARCHIVED - Ad group's status is archived.\n- AD_GROUP_INCOMPLETE - Ad group does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad group is ineligible.\n- ELIGIBLE - Ad group is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad Group.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","name","state"]},"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"adGroupId":{"description":"the adGroup ID.","type":"string"}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ad groups"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20groups/operation/UpdateSponsoredBrandsAdGroups","sectionHeader":{"type":3,"text":"PUT /sb/v4/adGroups"},"summary":"Update ad groups","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/adGroups/list",{"summary":"List ad groups","requestBody":{"content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"campaignIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"stateFilter":{"description":"Filter entities by state.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]}}}},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","maximum":100,"type":"number","minimum":1},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"adGroupIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"includeExtendedDataFields":{"description":"Setting to true will slow down performance because the API needs to retrieve extra information for each campaign.","type":"boolean"},"nameFilter":{"description":"Filter entities by name.","type":"object","properties":{"queryTermMatchType":{"description":"Defines how would the string resource field (e.g. campaign name, ad group name) be matched with the query term in filter.","type":"string","enum":["BROAD_MATCH","EXACT_MATCH"]},"include":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}}}}}}}}},"description":"Lists Sponsored Brands ad groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredBrandsAdGroups","responses":{"200":{"description":"ListSponsoredBrandsAdGroups 200 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"totalResults":{"description":"The total number of entities.","type":"number"},"adGroups":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"object","properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The identifier of the keyword.","type":"string"},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe ad group serving status determined by system.\n- AD_GROUP_STATUS_ENABLED - Ad group's status is enabled.\n- AD_GROUP_PAUSED - Ad group's status is paused.\n- AD_GROUP_ARCHIVED - Ad group's status is archived.\n- AD_GROUP_INCOMPLETE - Ad group does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad group is ineligible.\n- ELIGIBLE - Ad group is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad Group.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","name","state"]}},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ad groups"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20groups/operation/ListSponsoredBrandsAdGroups","sectionHeader":{"type":3,"text":"POST /sb/v4/adGroups/list"},"summary":"List ad groups","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/adGroups/delete",{"summary":"Delete ad groups","requestBody":{"content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroupIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}}}}}}},"description":"Deletes Sponsored Brands ad groups.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredBrandsAdGroups","responses":{"207":{"description":"DeleteSponsoredBrandsAdGroups 207 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adGroup":{"type":"object","properties":{"campaignId":{"description":"The identifier of the campaign to which the keyword is associated.","type":"string"},"name":{"minLength":1,"description":"The name of the ad group.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The identifier of the keyword.","type":"string"},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"`Notice: the servingStatus enums have not been finalized yet.`\nThe ad group serving status determined by system.\n- AD_GROUP_STATUS_ENABLED - Ad group's status is enabled.\n- AD_GROUP_PAUSED - Ad group's status is paused.\n- AD_GROUP_ARCHIVED - Ad group's status is archived.\n- AD_GROUP_INCOMPLETE - Ad group does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad group is ineligible.\n- ELIGIBLE - Ad group is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad Group.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","name","state"]},"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"adGroupId":{"description":"the adGroup ID.","type":"string"}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the adGroup in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"dateError":{"description":"Errors related to dates.","type":"object","properties":{"reason":{"description":"Exact error reason..","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"biddingError":{"description":"Errors related to bids.","type":"object","properties":{"reason":{"description":"Exact error reason.","type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"type":"string"},"lowerLimit":{"type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadgroupresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ad groups"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20groups/operation/DeleteSponsoredBrandsAdGroups","sectionHeader":{"type":3,"text":"POST /sb/v4/adGroups/delete"},"summary":"Delete ad groups","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/autoCollection",{"description":"Creates Sponsored Brands automatic collection ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsAutoCollectionAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"ads":{"items":{"properties":{"adGroupId":{"description":"Entity object identifier.","type":"string"},"creative":{"properties":{"asinExclusions":{"items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"brandLogoAssetID":{"type":"string"},"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"maxLength":30,"minLength":1,"type":"string"}},"required":["brandName"],"type":"object"},"name":{"maxLength":255,"minLength":1,"type":"string"},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]}},"required":["adGroupId","creative","name","state"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"}}},"required":true},"responses":{"207":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}},"type":"object"}}},"description":"CreateSponsoredBrandsAutoCollectionAds 207 response."},"400":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}},"description":"InvalidArgumentException 400 response."},"401":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"UnauthorizedException 401 response."},"403":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"AccessDeniedException 403 response."},"429":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"ThrottlingException 429 response.","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"InternalServerException 500 response."}},"tags":["Ads"],"summary":"Create Sponsored Brands Auto Collection Ads"}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsAutoCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/autoCollection"},"summary":"Create Sponsored Brands Auto Collection Ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/manualCollection",{"description":"Creates Sponsored Brands manual collection ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsManualCollectionAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"ads":{"items":{"properties":{"adGroupId":{"description":"Entity object identifier.","type":"string"},"creative":{"properties":{"asins":{"items":{"type":"string"},"maxItems":10,"minItems":3,"type":"array"},"brandLogoAssetID":{"type":"string"},"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"maxLength":30,"minLength":1,"type":"string"},"landingPage":{"properties":{"pageType":{"description":"The BrandCollectionLandingPageType is used for brand collection ads, supporting only store page and product list landing pages.","enum":["PRODUCT_LIST","STORE"],"type":"string"},"url":{"description":"URL of an existing simple landing page or Store page for brand collection ads.\nIf the pageType is PRODUCT_LIST, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.","type":"string"}},"type":"object"},"title":{"description":"Optional title for the collection. If not provided, title will be auto-generated.","maxLength":32,"type":"string"}},"required":["asins","brandName"],"type":"object"},"name":{"maxLength":255,"minLength":1,"type":"string"},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]}},"required":["adGroupId","creative","name","state"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"}}},"required":true},"responses":{"207":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}},"type":"object"}}},"description":"CreateSponsoredBrandsManualCollectionAds 207 response."},"400":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}},"description":"InvalidArgumentException 400 response."},"401":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"UnauthorizedException 401 response."},"403":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"AccessDeniedException 403 response."},"429":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"ThrottlingException 429 response.","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"InternalServerException 500 response."}},"tags":["Ads"],"summary":"Create Sponsored Brands Manual Collection Ads"}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsManualCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/manualCollection"},"summary":"Create Sponsored Brands Manual Collection Ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/brandVideo",{"summary":"Create brand video ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"asins":{"minItems":0,"maxItems":3,"type":"array","items":{"type":"string"}},"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"videoAssetIds":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50}}}},"required":["adGroupId","creative","landingPage","name","state"]}}},"required":["ads"]}}},"required":true},"description":"Creates Sponsored Brands brand video ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsBrandVideoAds","responses":{"207":{"description":"CreateSponsoredBrandsBrandVideoAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsBrandVideoAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/brandVideo"},"summary":"Create brand video ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/productCollectionExtended",{"summary":"[DEPRECATED] Creates Sponsored Brands new product collection ads with collection of custom images","deprecated":true,"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"description":"An array of Product Collection ad objects to create. Maximum length of the array is 10 objects.","type":"array","items":{"type":"object","properties":{"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"asins":{"minItems":0,"maxItems":3,"type":"array","items":{"type":"string"}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"type":"string","maxLength":50}}}},"required":["adGroupId","creative","landingPage","name","state"]}}},"required":["ads"]}}},"required":true},"description":"[DEPRECATED - Do not use] Refer to the [Product Collection Deprecation Notice](https://advertising.amazon.com/API/docs/en-us/release-notes/deprecations#deprecation-of-sponsored-brands-product-collection-ad-type) for more details. Use [/sb/v4/ads/manualCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsManualCollectionAds) or [/sb/v4/ads/autoCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsAutoCollectionAds) instead.\n\n---\n\nCreates Sponsored Brands product collection ads with collection of custom images[1-5].\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsExtendedProductCollectionAds","responses":{"207":{"description":"CreateSponsoredBrandsExtendedProductCollectionAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsExtendedProductCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/productCollectionExtended"},"summary":"[DEPRECATED] Creates Sponsored Brands new product collection ads with collection of custom images","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/video",{"summary":"Create video ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"asins":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"string"}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}}}}},"required":["adGroupId","creative","name","state"]}}},"required":["ads"]}}},"required":true},"description":"Creates Sponsored Brands video ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsVideoAds","responses":{"207":{"description":"CreateSponsoredBrandsVideoAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsVideoAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/video"},"summary":"Create video ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/productCollection",{"summary":"[DEPRECATED] Create product collection ads","deprecated":true,"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"asins":{"minItems":0,"maxItems":3,"type":"array","items":{"type":"string"}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50}}}},"required":["adGroupId","creative","landingPage","name","state"]}}},"required":["ads"]}}},"required":true},"description":"[DEPRECATED - Do not use] Refer to the [Product Collection Deprecation Notice](https://advertising.amazon.com/API/docs/en-us/release-notes/deprecations#deprecation-of-sponsored-brands-product-collection-ad-type) for more details. Use [/sb/v4/ads/manualCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsManualCollectionAds) or [/sb/v4/ads/autoCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsAutoCollectionAds) instead.\n\n---\n\nCreates Sponsored Brands product collection ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandsProductCollectionAds","responses":{"207":{"description":"CreateSponsoredBrandsProductCollectionAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandsProductCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/productCollection"},"summary":"[DEPRECATED] Create product collection ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/storeSpotlight",{"summary":"Create store spotlight ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50}}}},"required":["adGroupId","creative","landingPage","name","state"]}}},"required":["ads"]}}},"required":true},"description":"Creates Sponsored Brands store spotlight ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateSponsoredBrandStoreSpotlightAds","responses":{"207":{"description":"CreateSponsoredBrandStoreSpotlightAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/CreateSponsoredBrandStoreSpotlightAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/storeSpotlight"},"summary":"Create store spotlight ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads",{"summary":"Update ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"The product ad identifier.","type":"string"},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"Entity state for create or update operation.","type":"string","enum":["ENABLED","PAUSED"]}},"required":["adId"]}}},"required":["ads"]}}},"required":true},"description":"Updates Sponsored Brands ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredBrandsAds","responses":{"207":{"description":"UpdateSponsoredBrandsAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/UpdateSponsoredBrandsAds","sectionHeader":{"type":3,"text":"PUT /sb/v4/ads"},"summary":"Update ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/autoCollection",{"description":"Updates the ad settings for an automatic collection by creating a new version\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredBrandsAutoCollectionAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"description":"Updates the ad settings for an automatic collection by creating a new version","properties":{"ads":{"description":"List of Automatic Collection Ad Updates","items":{"properties":{"adId":{"description":"Entity object identifier.","type":"string"},"creative":{"properties":{"asinExclusions":{"items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"brandLogoAssetID":{"type":"string"},"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"maxLength":30,"minLength":1,"type":"string"}},"required":["brandName"],"type":"object"}},"required":["adId","creative"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"}}},"required":true},"responses":{"207":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"creatives":{"properties":{"error":{"items":{"properties":{"errors":{"description":"A list of validation errors.","items":{"properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"properties":{"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}},"type":"object"}},"required":["errorType","errorValue"],"type":"object"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"the index of the creative in the array from the request body.","maximum":10,"minimum":0,"type":"number"}},"required":["index"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"},"success":{"items":{"properties":{"adId":{"description":"Entity object identifier.","type":"string"},"creativeVersion":{"type":"string"},"index":{"description":"The index in the original list from the request.","maximum":10,"minimum":0,"type":"number"}},"required":["adId","index"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"UpdateSponsoredBrandsAutoCollectionAds 207 response."},"400":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}},"description":"InvalidArgumentException 400 response."},"401":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"UnauthorizedException 401 response."},"403":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"AccessDeniedException 403 response."},"429":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"ThrottlingException 429 response.","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"InternalServerException 500 response."}},"tags":["Ads"],"summary":"Update Sponsored Brands Auto Collection Ads"}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/UpdateSponsoredBrandsAutoCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/autoCollection"},"summary":"Update Sponsored Brands Auto Collection Ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/manualCollection",{"description":"Updates the ad settings for a manual collection by creating a new version\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"UpdateSponsoredBrandsManualCollectionAds","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"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 and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"}}],"requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"description":"Updates the ad settings for a manual collection by creating a new version","properties":{"ads":{"description":"List of Manual Collection Ad Updates","items":{"properties":{"adId":{"description":"Entity object identifier.","type":"string"},"creative":{"properties":{"asins":{"items":{"type":"string"},"maxItems":10,"minItems":3,"type":"array"},"brandLogoAssetID":{"type":"string"},"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"maxLength":30,"minLength":1,"type":"string"},"landingPage":{"properties":{"pageType":{"description":"The BrandCollectionLandingPageType is used for brand collection ads, supporting only store page and product list landing pages.","enum":["PRODUCT_LIST","STORE"],"type":"string"},"url":{"description":"URL of an existing simple landing page or Store page for brand collection ads.\nIf the pageType is PRODUCT_LIST, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.","type":"string"}},"type":"object"},"title":{"description":"Optional title for the collection. If not provided, title will be auto-generated.","maxLength":32,"type":"string"}},"required":["asins","brandName"],"type":"object"}},"required":["adId","creative"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"required":["ads"],"type":"object"}}},"required":true},"responses":{"207":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"properties":{"creatives":{"properties":{"error":{"items":{"properties":{"errors":{"description":"A list of validation errors.","items":{"properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"properties":{"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}},"type":"object"}},"required":["errorType","errorValue"],"type":"object"},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"the index of the creative in the array from the request body.","maximum":10,"minimum":0,"type":"number"}},"required":["index"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"},"success":{"items":{"properties":{"adId":{"description":"Entity object identifier.","type":"string"},"creativeVersion":{"type":"string"},"index":{"description":"The index in the original list from the request.","maximum":10,"minimum":0,"type":"number"}},"required":["adId","index"],"type":"object"},"maxItems":10,"minItems":1,"type":"array"}},"type":"object"}},"type":"object"}}},"description":"UpdateSponsoredBrandsManualCollectionAds 207 response."},"400":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}},"description":"InvalidArgumentException 400 response."},"401":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"UnauthorizedException 401 response."},"403":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"AccessDeniedException 403 response."},"429":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"ThrottlingException 429 response.","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"}}}},"500":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"InternalServerException 500 response."}},"tags":["Ads"],"summary":"Update Sponsored Brands Manual Collection Ads"}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/UpdateSponsoredBrandsManualCollectionAds","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/manualCollection"},"summary":"Update Sponsored Brands Manual Collection Ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/list",{"summary":"List ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"campaignIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"stateFilter":{"description":"Filter entities by state.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]}}}},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","maximum":100,"type":"number","minimum":1},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"adIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"adGroupIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"nameFilter":{"description":"Filter entities by name.","type":"object","properties":{"queryTermMatchType":{"description":"Defines how would the string resource field (e.g. campaign name, ad group name) be matched with the query term in filter.","type":"string","enum":["BROAD_MATCH","EXACT_MATCH"]},"include":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}}}}}}}}},"description":"Lists Sponsored Brands ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListSponsoredBrandsAds","responses":{"200":{"description":"ListSponsoredBrandsAds 200 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"object","properties":{"adId":{"description":"The ad identifier. Note: Ads created using version 3/non-multi ad group campaigns do not have an associated adId. [Learn more](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/campaigns/managing-multi-ad-group-campaigns#ads).","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad. Note: Ads created using version 3/non-multi ad group campaigns do not have an associated name. [Learn more](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/campaigns/managing-multi-ad-group-campaigns#ads).","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","state"]}},"totalResults":{"description":"The total number of entities.","type":"number"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/ListSponsoredBrandsAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/list"},"summary":"List ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/ads/delete",{"summary":"Delete ads","requestBody":{"content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"adIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}}}}}}},"description":"Deletes Sponsored Brands ads.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"DeleteSponsoredBrandsAds","responses":{"207":{"description":"DeleteSponsoredBrandsAds 207 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"ads":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"adId":{"description":"the Ad ID.","type":"string"},"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier.","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad.","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","adId","campaignId","name","state"]},"index":{"description":"The index in the original list from the request.","maximum":10,"type":"number","minimum":0}},"required":["index"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the ad in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error.","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["index"]}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sbadresource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Ads"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ads/operation/DeleteSponsoredBrandsAds","sectionHeader":{"type":3,"text":"POST /sb/v4/ads/delete"},"summary":"Delete ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/brandVideo",{"summary":"Create new version of brand video ad creative","requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creative":{"type":"object","properties":{"asins":{"minItems":0,"maxItems":3,"description":"An array of ASINs associated with the creative.","type":"array","items":{"description":"ASIN","type":"string"}},"brandLogoCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandName":{"description":"The displayed brand name in the ad headline.\nMaximum length is 30 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"},"landingPage":{"description":"Landing page V2, where type is String with allowed values listed, and url or asins of that type.","type":"object","properties":{"asins":{"minItems":0,"maxItems":100,"description":"The list of asins on the landingPage If type is PRODUCT_LIST. A minimum of 3 asins are required. For the 'PRODUCT_LIST' type, the asins property is mandatory, and the url should not be included.","type":"array","items":{"description":"ASIN","type":"string"}},"type":{"description":"Supported types are PRODUCT_LIST, STORE, DETAIL_PAGE, CUSTOM_URL. More could be added in future.","type":"string"},"url":{"description":"The url of the landingPage. When including the 'asins' property in the request, do not include this property, as they are mutually exclusive. For the PRODUCT_LIST type, the asins property is mandatory, and the url should not be included.","type":"string"}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language.\nIf Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then 'videoAssetIds' will return translated video assetId whereas `originalVideoAssetIds` will return the original video assetId. In all other cases, `videoAssetIds` will return original video assetId.","type":"array","items":{"description":"The identifier of image/video asset from the store's asset library","type":"string"}},"brandLogoAssetId":{"description":"The identifier of the [brand logo](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#brandlogo) image from the brand store's asset library.\nNote that for campaigns created in the Amazon Advertising console prior to release of the brand store's assets library, responses will not include a value for this field.","type":"string"},"headline":{"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"}},"required":["asins","brandLogoAssetId","brandName","headline","videoAssetIds"]}},"required":["adId","creative"]}}},"required":true},"description":"This API creates a new version of an existing creative for given Sponsored Brands Ad by supplying brand video creative content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateBrandVideoCreative","responses":{"200":{"description":"CreateBrandVideoCreative 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"description":"Create creative response","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"409":{"description":"ConflictStateException 409 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["CONFLICT_STATE"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/CreateBrandVideoCreative","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/brandVideo"},"summary":"Create new version of brand video ad creative","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/productCollectionExtended",{"summary":"[DEPRECATED] Creates Sponsored Brands new version of product collection with collection of custom image ads","deprecated":true,"requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creative":{"type":"object","properties":{"asins":{"minItems":0,"maxItems":3,"uniqueItems":true,"description":"An array of ASINs associated with the creative.","type":"array","items":{"description":"ASIN","type":"string"}},"brandLogoCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandName":{"description":"The displayed brand name in the ad headline.\nMaximum length is 30 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"},"landingPage":{"description":"Landing page V2, where type is String with allowed values listed, and url or asins of that type.","type":"object","properties":{"asins":{"minItems":0,"maxItems":100,"description":"The list of asins on the landingPage If type is PRODUCT_LIST. A minimum of 3 asins are required. For the 'PRODUCT_LIST' type, the asins property is mandatory, and the url should not be included.","type":"array","items":{"description":"ASIN","type":"string"}},"type":{"description":"Supported types are PRODUCT_LIST, STORE, DETAIL_PAGE, CUSTOM_URL. More could be added in future.","type":"string"},"url":{"description":"The url of the landingPage. When including the 'asins' property in the request, do not include this property, as they are mutually exclusive. For the PRODUCT_LIST type, the asins property is mandatory, and the url should not be included.","type":"string"}}},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"An array of customImages associated with the creative.","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language.\nIf Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"brandLogoAssetId":{"description":"The identifier of the [brand logo](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#brandlogo) image from the brand store's asset library.\nNote that for campaigns created in the Amazon Advertising console prior to release of the brand store's assets library, responses will not include a value for this field.","type":"string"},"headline":{"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"}},"required":["asins","brandLogoAssetId","brandName","headline"]}},"required":["adId","creative"]}}},"required":true},"description":"[DEPRECATED - Do not use] Refer to the [Product Collection Deprecation Notice](https://advertising.amazon.com/API/docs/en-us/release-notes/deprecations#deprecation-of-sponsored-brands-product-collection-ad-type) for more details. Use [/sb/ads/creatives/manualCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad-creatives/operation/UpdateSponsoredBrandsManualCollectionAds) instead.\n\n---\n\nThis API creates a new version of creative for given Sponsored Brands ad by supplying extended product collection creative content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateExtendedProductCollectionCreative","responses":{"200":{"description":"CreateExtendedProductCollectionCreative 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"description":"Create creative response","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"409":{"description":"ConflictStateException 409 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["CONFLICT_STATE"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/CreateExtendedProductCollectionCreative","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/productCollectionExtended"},"summary":"[DEPRECATED] Creates Sponsored Brands new version of product collection with collection of custom image ads","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/video",{"summary":"Create new version of video ad creative","requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creative":{"type":"object","properties":{"consentToTranslate":{"description":"If set to true and the heaadline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language.\nIf Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then 'videoAssetIds' will return translated video assetId whereas `originalVideoAssetIds` will return the original video assetId. In all other cases, `videoAssetIds` will return original video assetId.","type":"array","items":{"description":"The identifier of image/video asset from the store's asset library","type":"string"}}},"required":["videoAssetIds"]}},"required":["adId","creative"]}}},"required":true},"description":"This API creates a new version of an existing creative for given Sponsored Brands ad by supplying video creative content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateVideoCreative","responses":{"200":{"description":"CreateVideoCreative 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"description":"Create creative response","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"409":{"description":"ConflictStateException 409 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["CONFLICT_STATE"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/CreateVideoCreative","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/video"},"summary":"Create new version of video ad creative","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/productCollection",{"summary":"[DEPRECATED] Create new version of product collection ad creative","deprecated":true,"requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creative":{"type":"object","properties":{"asins":{"minItems":0,"maxItems":3,"uniqueItems":true,"description":"An array of ASINs associated with the creative.","type":"array","items":{"description":"ASIN","type":"string"}},"brandLogoCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandName":{"description":"The displayed brand name in the ad headline.\nMaximum length is 30 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"},"customImageAssetId":{"description":"The identifier of the Custom image from the Store assets library.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#customimage) for more information on what constitutes a valid Custom image.","type":"string"},"customImageCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandLogoAssetId":{"description":"The identifier of the [brand logo](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#brandlogo) image from the brand store's asset library.\nNote that for campaigns created in the Amazon Advertising console prior to release of the brand store's assets library, responses will not include a value for this field.","type":"string"},"headline":{"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"}},"required":["asins","brandLogoAssetId","brandName","headline"]}},"required":["adId","creative"]}}},"required":true},"description":"[DEPRECATED - Do not use] Refer to the [Product Collection Deprecation Notice](https://advertising.amazon.com/API/docs/en-us/release-notes/deprecations#deprecation-of-sponsored-brands-product-collection-ad-type) for more details. Use [/sb/ads/creatives/manualCollection](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad-creatives/operation/UpdateSponsoredBrandsManualCollectionAds) instead.\n\n---\n\nThis API creates a new version of creative for given Sponsored Brands ad by supplying product collection creative content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateProductCollectionCreative","responses":{"200":{"description":"CreateProductCollectionCreative 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"description":"Create creative response","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"409":{"description":"ConflictStateException 409 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["CONFLICT_STATE"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/CreateProductCollectionCreative","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/productCollection"},"summary":"[DEPRECATED] Create new version of product collection ad creative","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/storeSpotlight",{"summary":"Create new version of store spotlight ad creative","requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandName":{"description":"The displayed brand name in the ad headline.\nMaximum length is 30 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"},"subpages":{"description":"An array of subpages","type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"landingPage":{"description":"Landing page V2, where type is String with allowed values listed, and url or asins of that type.","type":"object","properties":{"asins":{"minItems":0,"maxItems":100,"description":"The list of asins on the landingPage If type is PRODUCT_LIST. A minimum of 3 asins are required. For the 'PRODUCT_LIST' type, the asins property is mandatory, and the url should not be included.","type":"array","items":{"description":"ASIN","type":"string"}},"type":{"description":"Supported types are PRODUCT_LIST, STORE, DETAIL_PAGE, CUSTOM_URL. More could be added in future.","type":"string"},"url":{"description":"The url of the landingPage. When including the 'asins' property in the request, do not include this property, as they are mutually exclusive. For the PRODUCT_LIST type, the asins property is mandatory, and the url should not be included.","type":"string"}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language.\nIf Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"brandLogoAssetId":{"description":"The identifier of the [brand logo](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#brandlogo) image from the brand store's asset library.\nNote that for campaigns created in the Amazon Advertising console prior to release of the brand store's assets library, responses will not include a value for this field.","type":"string"},"headline":{"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"}},"required":["brandLogoAssetId","brandName","headline","subpages"]}},"required":["adId","creative"]}}},"required":true},"description":"This API creates a new version of creative for given Sponsored Brands ad by supplying store spotlight creative content\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateStoreSpotlightCreative","responses":{"200":{"description":"CreateStoreSpotlightCreative 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"description":"Create creative response","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"409":{"description":"ConflictStateException 409 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["CONFLICT_STATE"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/CreateStoreSpotlightCreative","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/storeSpotlight"},"summary":"Create new version of store spotlight ad creative","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/ads/creatives/list",{"summary":"List ad creatives","requestBody":{"content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"creativeTypeFilter":{"uniqueItems":true,"description":"Filters creatives by optional creative type.\nBy default, you can list all creative versions regardless of creative type.","type":"array","items":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]}},"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field.\nTo retrieve the next page of results, call the same operation and specify this token in the request.\nIf the `NextToken` field is empty, there are no further results.","type":"string"},"maxResults":{"description":"Set a limit on the number of results returned by an operation.","maximum":100,"type":"number","minimum":1},"creativeVersionFilter":{"maxItems":100,"uniqueItems":true,"description":"Filters creatives by optional creative version.\nThis means you can either list all creative versions without specific creative version filter, all just retrieve a single creative version by providing a specific version identifier.","type":"array","items":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"}},"creativeStatusFilter":{"uniqueItems":true,"description":"Filters creatives by optional creative status.\nBy default, you can list all creative versions regardless of creative status.","type":"array","items":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]}}},"required":["adId"]}}},"required":true},"description":"This API gets an array of all Sponsored Brands creatives that qualify the given resource identifiers and filters\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListCreatives","responses":{"200":{"description":"ListCreatives 200 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"totalResults":{"description":"The total number of results returned by an operation.","type":"number"},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field.\nTo retrieve the next page of results, call the same operation and specify this token in the request.\nIf the `NextToken` field is empty, there are no further results.","type":"string"},"creatives":{"description":"A list of creatives","type":"array","items":{"description":"-----------------------------------------------\nStructure types\n-----------------------------------------------\nCreative","type":"object","properties":{"adId":{"description":"The unique ID of a Sponsored Brands ad.","type":"string"},"creationTime":{"format":"double","type":"number"},"creativeType":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"creativeVersion":{"description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative.","type":"string"},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeProperties":{"description":"Creative properties","type":"object","properties":{"brandLogoCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"brandName":{"description":"The displayed brand name in the ad headline.\nMaximum length is 30 characters.\nSee [the policy](https://advertising.amazon.com/resources/ad-policy/sponsored-ads-policies#headlines) for headline requirements.","type":"string"},"customImageAssetId":{"description":"The identifier of image/video asset from the store's asset library","type":"string"},"landingPage":{"description":"Landing page.","type":"object","properties":{"asins":{"minItems":0,"maxItems":100,"description":"The list of asins on the landingPage If type is PRODUCT_LIST.","type":"array","items":{"description":"ASIN","type":"string"}},"type":{"description":"Landing page type","type":"string","enum":["PRODUCT_LIST","STORE","DETAIL_PAGE","CUSTOM_URL","AD_LANDING_PREVIEW","SEARCH","BROWSE","ADVERTISING_LANDING_PAGE","UNKNOWN"]},"value":{"description":"The url of the landingPage.","type":"string"}}},"customImages":{"minItems":0,"maxItems":5,"uniqueItems":true,"description":"An array of customImages associated with the creative.","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"consentToTranslate":{"description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImageCrop":{"description":"Asset cropping attributes","type":"object","properties":{"top":{"description":"The highest pixel from which to begin cropping","type":"number"},"left":{"description":"The leftmost pixel from which to begin cropping","type":"number"},"width":{"description":"The number of pixels to crop rightwards from the value specified as left","type":"number"},"height":{"description":"The number of pixels to crop down from the value specified as top","type":"number"}}},"customImageUrl":{"type":"string"},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"description":"The identifier of image/video asset from the store's asset library","type":"string"}},"asins":{"minItems":0,"maxItems":100,"description":"-----------------------------------------------\nList types\n-----------------------------------------------\nA list of ASINs","type":"array","items":{"description":"ASIN","type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"description":"An array of subpages","type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"description":"The original headline submitted by the advertiser.","type":"string"},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then 'videoAssetIds' will return translated video assetId whereas `originalVideoAssetIds` will return the original video assetId. In all other cases, `videoAssetIds` will return original video assetId.","type":"array","items":{"description":"The identifier of image/video asset from the store's asset library","type":"string"}},"brandLogoAssetId":{"description":"The identifier of image/video asset from the store's asset library","type":"string"},"headline":{"description":"If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `headline` will return the translated headline whereas `originalHeadline` will return the original headline. In all other cases, 'originalHeadline' and `headline` both will return the original headline.","type":"string"}}},"lastUpdateTime":{"format":"double","type":"number"}}}}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"404":{"description":"NotFoundException 404 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["NOT_FOUND"]},"message":{"type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbAdCreativeResource.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type.","type":"string","enum":["application/vnd.sbAdCreativeResource.v4+json","application/vnd.sbCreativeImageRecommendationResource.v4+json","application/vnd.sbCreativeRecommendationResource.v4+json"]},"in":"header","name":"Accept","description":"Clients request a specific version of a resource using the Accept request-header field set to the value field of the desired content-type."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"The identifier of a profile associated with the advertiser account.\nUse GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and use profileId from the response to pass as input.\nThis is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Ad creatives"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20creatives/operation/ListCreatives","sectionHeader":{"type":3,"text":"POST /sb/ads/creatives/list"},"summary":"List ad creatives","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/negativeTargets/brands/recommendations",{"summary":"Get brand recommendations for negative targeting","description":"Returns brands recommended for negative targeting. Only available for Sellers and Vendors. These recommendations include your own brands because targeting your own brands usually results in lower performance than targeting competitors' brands. \n\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SBTargetingGetNegativeBrands","responses":{"200":{"description":"SBTargetingGetNegativeBrands 200 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Response object for /sb/negativeTargets/brands/recommendations containing list of brands for negative targeting.","type":"object","properties":{"brands":{"maxItems":100,"description":"List of Brands.","type":"array","items":{"type":"object","properties":{"brandRefinementId":{"description":"Id of brand. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Brand Refinement IDs.","type":"string"},"name":{"description":"Name of brand.","type":"string"}},"required":["brandRefinementId"]}},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"SBTargetingBadRequestException 400 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a BadRequestException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"401":{"description":"SBTargetingUnauthorizedException 401 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an UnauthorizedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"403":{"description":"SBTargetingAccessDeniedException 403 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an AccessDeniedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBTargetingThrottlingException 429 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a ThrottlingException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"500":{"description":"SBTargetingInternalServerException 500 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an InternalServerException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}}},"parameters":[{"schema":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"in":"query","name":"nextToken","description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results."},{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Recommendations"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Recommendations/operation/SBTargetingGetNegativeBrands","sectionHeader":{"type":3,"text":"GET /sb/negativeTargets/brands/recommendations"},"summary":"Get brand recommendations for negative targeting","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/recommendations/optimization",{"summary":"Get recommendation for optimization rule","description":"Returns recommended bid value for optimization rule enable campaigns. Recommendations are generated based landing page, page type and ASINs provided in request. Only available for Sellers and Vendors.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]\"","requestBody":{"content":{"application/vnd.sboptimizationrecommendationresource.v4+json":{"schema":{"type":"object","properties":{"costControlMetric":{"description":"Cost control metric to retrieve recommended value for.  Currently only COST_PER_CLICK is supported.","type":"string","enum":["COST_PER_CLICK"]},"landingPages":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}}}},"required":["costControlMetric","landingPages"]}}},"required":true},"operationId":"SBOptimizationRecommendation","responses":{"207":{"description":"SBOptimizationRecommendation 207 response","content":{"application/vnd.sboptimizationrecommendationresource.v4+json":{"schema":{"type":"object","properties":{"minimumValue":{"format":"double","description":"Minimum accepted value for cost control metric.","type":"number"},"costControlMetric":{"description":"Cost control metric to retrieve recommended value for.  Currently only COST_PER_CLICK is supported.","type":"string","enum":["COST_PER_CLICK"]},"recommendedValue":{"format":"double","description":"Recommended value for cost control metric.","type":"number"}},"required":["costControlMetric","minimumValue","recommendedValue"]}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":true}],"tags":["Recommendations"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Recommendations/operation/SBOptimizationRecommendation","sectionHeader":{"type":3,"text":"POST /sb/recommendations/optimization"},"summary":"Get recommendation for optimization rule","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/recommendations/creative/headline",{"summary":"Get recommendations for creative headline","requestBody":{"content":{"application/json":{"schema":{"description":"Request structure of headline suggestion API.","type":"object","properties":{"asins":{"minItems":1,"maxItems":3,"description":"An array of ASINs associated with the creative. Note do not pass an empty array, this results in an error.\n","type":"array","items":{"type":"string"}},"storePages":{"minItems":1,"maxItems":3,"description":"An array of Store Pages associated with SB Spotlight Creative.","type":"array","items":{"type":"object","properties":{"displayName":{"description":"Display Name of the store page shown on a store spotlight campaign.","type":"string"},"primaryAsin":{"description":"Selected asin from the store page which is displayed on the store spotlight campaign.","type":"string"}}}},"maxNumSuggestions":{"description":"Maximum number of suggestions that API should return. Response will [0, maxNumSuggestions] suggestions (suggestions are not guaranteed).","maximum":10,"type":"number","minimum":1},"adFormat":{"type":"string","enum":["SPONSORED_BRANDS","SPONSORED_BRANDS_SPOTLIGHT"]}}}}},"required":true},"description":"API to receive creative headline suggestions.","operationId":"getHeadlineRecommendations","responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"description":"Response structure of headline suggestion API.","type":"object","properties":{"requestId":{"description":"An identifier for request made which is generated by server.","type":"string"},"suggestions":{"description":"Suggestions are sorted, i.e., more suitable headline has lesser array index value","type":"array","items":{"description":"Suggested Headline in response object.","type":"object","properties":{"headlineId":{"description":"Unique Id of suggested headline.","type":"string","example":"e991e32c-0136-427a-843b-ff04162f2f91"},"headline":{"description":"String that contains suggested headline.","type":"string","example":"This is a suggested headline."}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.\n","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity - Failed due to invalid parameters.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry\nlater and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":true}],"tags":["Recommendations"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Recommendations/operation/getHeadlineRecommendations","sectionHeader":{"type":3,"text":"POST /sb/recommendations/creative/headline"},"summary":"Get recommendations for creative headline","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/budgetRecommendations",{"summary":"Get budget recommendations","requestBody":{"content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"campaignIds":{"minItems":1,"maxItems":100,"description":"List of CampaignIds","type":"array","items":{"description":"The identifier of a campaign.","type":"string"}}},"required":["campaignIds"]}}},"required":true},"description":"Provides daily budget recommendations for a list of requested Sponsored Brands campaigns, with context on estimated historical missed opportunities.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"GetBudgetRecommendations","responses":{"207":{"description":"GetBudgetRecommendations 207 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"success":{"minItems":0,"maxItems":100,"description":"List of successful budget recommendations for campaigns.","type":"array","items":{"description":"Budget recomendation for campagins.","type":"object","properties":{"campaignId":{"description":"The identifier of a campaign.","type":"string"},"suggestedBudget":{"format":"double","description":"Recommended budget for the campaign.","type":"number"},"index":{"description":"Correlate the recommendation to the campaign index in the request. Zero-based.","type":"number"},"sevenDaysMissedOpportunities":{"description":"Missed Opportunities in the trailing seven days.","type":"object","properties":{"estimatedMissedSalesLower":{"format":"double","description":"Lower bound of the estimated Missed Sales. This will be in local currency.","type":"number"},"estimatedMissedSalesUpper":{"format":"double","description":"Upper bound of the estimated Missed Sales. This will be in local currency.","type":"number"},"endDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"End date of the Missed Opportunities date range (YYYY-MM-DD) in local time.","type":"string"},"estimatedMissedImpressionsLower":{"description":"Lower bound of the estimated Missed Impressions.","type":"number"},"estimatedMissedClicksLower":{"description":"Lower bound of the estimated Missed Clicks.","type":"number"},"estimatedMissedClicksUpper":{"description":"Upper bound of the estimated Missed Clicks.","type":"number"},"estimatedMissedImpressionsUpper":{"description":"Upper bound of the estimated Missed Impressions.","type":"number"},"startDate":{"pattern":"^20[1-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","description":"Start date of the Missed Opportunities date range (YYYY-MM-DD) in local time.","type":"string"},"percentTimeInBudget":{"format":"double","description":"Percentage of time the campaign is active with a budget.","type":"number"}}}},"required":["campaignId","index","sevenDaysMissedOpportunities","suggestedBudget"]}},"error":{"minItems":0,"maxItems":100,"description":"List of errors that occurred when generating budget recommendations.","type":"array","items":{"description":"Error that occurred when generating budget recommendations.","type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"campaignId":{"description":"The identifier of a campaign.","type":"string"},"index":{"description":"Correlate the recommendation to the campaign index in the request. Zero-based.","type":"number"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["campaignId","code","details","index"]}}},"required":["error","success"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"422":{"description":"InvalidArgumentException 422 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/vnd.sbbudgetrecommendation.v4+json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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.","required":false},{"schema":{"description":"The identifier of an account. Account must be a global advertising account.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"The identifier of an account. Account must be a global advertising account.","required":false}],"tags":["Recommendations"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Recommendations/operation/GetBudgetRecommendations","sectionHeader":{"type":3,"text":"POST /sb/campaigns/budgetRecommendations"},"summary":"Get budget recommendations","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/targets/categories",{"summary":"Get targetable categories","description":"Returns all targetable categories by default in a list. List of categories can be used to build and traverse category tree.\nSet query parameter `includeOnlyRootCategories=true` to return only the root categories, or set `parentCategoryRefinementId` to return children of a specific parent category.\nEach category node has the fields - category name, category refinement id, parent category refinement id, isTargetable flag, and ASIN count range. \n\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SBTargetingGetTargetableCategories","responses":{"200":{"description":"SBTargetingGetTargetableCategories 200 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Response object for /sb/targets/categories containing all targetable categories for the advertiser's marketplace.","type":"object","properties":{"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"categoryTree":{"maxItems":5000,"description":"List of categories.","type":"array","items":{"description":"Category details.","type":"object","properties":{"asinCountRange":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"isTargetable":{"description":"If the category is targetable or not.","type":"boolean"},"parentCategoryRefinementId":{"description":"The category refinement id of the parent category. Missing parentCategoryRefinementId signifies this is a root category.","type":"string"},"estimatedReach":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}},"name":{"description":"Name of category.","type":"string"},"translatedName":{"description":"Translated name of the category.","type":"string"},"categoryRefinementId":{"description":"The category refinement id. Please use /sb/targets/categories or /sb/recommendations/targets/category to retrieve category IDs.","type":"string"}}}}}}}}},"400":{"description":"SBTargetingBadRequestException 400 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a BadRequestException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"401":{"description":"SBTargetingUnauthorizedException 401 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an UnauthorizedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBTargetingThrottlingException 429 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a ThrottlingException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"500":{"description":"SBTargetingInternalServerException 500 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an InternalServerException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}}},"parameters":[{"schema":{"description":"The locale to which the caller wishes to translate the targetable categories or refinements to. For example, if the caller wishes to receive the targetable categories in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the returned tagetable categories will be in the default language of the marketplace.","type":"string","enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"]},"in":"query","name":"locale","description":"The locale to which the caller wishes to translate the targetable categories or refinements to. For example, if the caller wishes to receive the targetable categories in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the returned tagetable categories will be in the default language of the marketplace."},{"schema":{"description":"[UPDATE: As of 05/28/2024, `STREAMING_VIDEO` is deprecated]. \n The supply source where the target will be used. Use `AMAZON` for placements on Amazon website. Use `STREAMING_VIDEO` for off-site video placements such as IMDb TV.","type":"string","enum":["AMAZON","STREAMING_VIDEO"]},"in":"query","name":"supplySource","description":"[UPDATE: As of 05/28/2024, `STREAMING_VIDEO` is deprecated]. \n The supply source where the target will be used. Use `AMAZON` for placements on Amazon website. Use `STREAMING_VIDEO` for off-site video placements such as IMDb TV.","required":true},{"schema":{"description":"Indicates whether to only retun root categories or not.","type":"boolean"},"in":"query","name":"includeOnlyRootCategories","description":"Indicates whether to only retun root categories or not."},{"schema":{"description":"Returns child categories of category.","type":"string"},"in":"query","name":"parentCategoryRefinementId","description":"Returns child categories of category."},{"schema":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"in":"query","name":"nextToken","description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results."},{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Product targeting categories"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Product%20targeting%20categories/operation/SBTargetingGetTargetableCategories","sectionHeader":{"type":3,"text":"GET /sb/targets/categories"},"summary":"Get targetable categories","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/targets/products/count",{"summary":"Get number of products in a category","requestBody":{"content":{"application/vnd.sbtargeting.v4+json":{"schema":{"type":"object","properties":{"ageRanges":{"maxItems":100,"description":"List of Age Range Refinement Ids.","type":"array","items":{"description":"Id of Age Range. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Age Range Refinement IDs.","type":"string"}},"brands":{"maxItems":100,"description":"List of Brand Refinement Ids.","type":"array","items":{"description":"Id of brand. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Brand Refinement IDs.","type":"string"}},"genres":{"maxItems":100,"description":"List of Genre Refinement Ids.","type":"array","items":{"description":"Id of Genre. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Genre Refinement IDs.","type":"string"}},"isPrimeShipping":{"description":"Indicates if products have prime shipping. Leave empty to include both prime shipping and non-prime shipping products.","type":"boolean"},"ratingRange":{"description":"Rating range is restricted to integers between 0 and 5, inclusive. Min must be less than or equal to max. We use this to retrieve the number of targetable ASINs that falls within this rating range.","type":"object","properties":{"min":{"maximum":5,"type":"integer","minimum":0},"max":{"maximum":5,"type":"integer","minimum":0}}},"category":{"description":"The category refinement id. Please use /sb/targets/categories or /sb/recommendations/targets/category to retrieve category IDs.","type":"string"},"priceRange":{"description":"A range of prices. We use this to retrieve the number of targetable ASINs that falls within this price range.","type":"object","properties":{"min":{"format":"double","type":"number"},"max":{"format":"double","type":"number"}}}},"required":["category"]}}},"required":true},"description":"Get number of targetable asins based on refinements provided by the user.\n\nUse `/sb/targets/categories` or `/sb/recommendations/targets/category` to retrieve the category ID. Use `/sb/targets/categories/{categoryRefinementId}/refinements` to retrieve refinements data for a category.\n\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SBTargetingGetTargetableASINCounts","responses":{"200":{"description":"SBTargetingGetTargetableASINCounts 200 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Response object for /sb/targets/products/count to get number of targetable asins for refinements provided by the user","type":"object","properties":{"asinCounts":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"}}}}}}}},"400":{"description":"SBTargetingBadRequestException 400 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a BadRequestException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"401":{"description":"SBTargetingUnauthorizedException 401 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an UnauthorizedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"422":{"description":"SBTargetingUnprocessableEntityException 422 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an UnprocessableEntityException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBTargetingThrottlingException 429 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a ThrottlingException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"500":{"description":"SBTargetingInternalServerException 500 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an InternalServerException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Product targeting categories"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Product%20targeting%20categories/operation/SBTargetingGetTargetableASINCounts","sectionHeader":{"type":3,"text":"POST /sb/targets/products/count"},"summary":"Get number of products in a category","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/targets/categories/{categoryRefinementId}/refinements",{"summary":"Get refinements for category","description":"Returns refinements according to category input. \n\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SBTargetingGetRefinementsForCategory","responses":{"200":{"description":"SBTargetingGetRefinementsForCategory 200 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Response object for /sb/targets/categories/{categoryRefinementId}/refinements containing information on Brand Nodes, Age Range Nodes, and Genre Nodes.\n    Response is paginated with pagination occurring for all three arrays at once.\n    Example: If there are 800 brands, 5 age ranges, and 600 genres, the first response will return 500 brands, 5 age ranges, and 500 genres. The next paginated response will return 300 brands, 0 age ranges, and 100 genres.","type":"object","properties":{"ageRanges":{"maxItems":500,"description":"List of Age Ranges. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Age Ranges. Age Ranges are only available for categories related to children's toys and games.","type":"array","items":{"type":"object","properties":{"ageRangeRefinementId":{"description":"Id of Age Range. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Age Range Refinement IDs.","type":"string"},"name":{"description":"Name of Age Range.","type":"string"},"translatedName":{"description":"Translated name of Age Range based off locale sent in request.","type":"string"}},"required":["ageRangeRefinementId"]}},"brands":{"maxItems":500,"description":"List of Brands.","type":"array","items":{"type":"object","properties":{"brandRefinementId":{"description":"Id of brand. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Brand Refinement IDs.","type":"string"},"name":{"description":"Name of brand.","type":"string"}},"required":["brandRefinementId"]}},"genres":{"maxItems":500,"description":"List of Genres. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Genre Node IDs. Genres are only available for categories related to books.","type":"array","items":{"type":"object","properties":{"genreRefinementId":{"description":"Id of Genre. Use /sb/targets/categories/{categoryRefinementId}/refinements to retrieve Genre Refinement IDs.","type":"string"},"name":{"description":"Name of Genre.","type":"string"},"translatedName":{"description":"Translated name of Genre based off locale sent in request.","type":"string"}},"required":["genreRefinementId"]}},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"SBTargetingBadRequestException 400 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a BadRequestException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"401":{"description":"SBTargetingUnauthorizedException 401 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an UnauthorizedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBTargetingThrottlingException 429 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about a ThrottlingException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"500":{"description":"SBTargetingInternalServerException 500 response","content":{"application/vnd.sbtargeting.v4+json":{"schema":{"description":"Returns information about an InternalServerException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}}},"parameters":[{"schema":{"description":"The category refinement id. Please use /sb/targets/categories or /sb/recommendations/targets/category to retrieve category IDs.","type":"string"},"in":"path","name":"categoryRefinementId","description":"The category refinement id. Please use /sb/targets/categories or /sb/recommendations/targets/category to retrieve category IDs.","required":true},{"schema":{"description":"The locale to which the caller wishes to translate the targetable categories or refinements to. For example, if the caller wishes to receive the targetable categories in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the returned tagetable categories will be in the default language of the marketplace.","type":"string","enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"]},"in":"query","name":"locale","description":"The locale to which the caller wishes to translate the targetable categories or refinements to. For example, if the caller wishes to receive the targetable categories in Simplified Chinese, the locale parameter should be set to zh_CN. If no locale is provided, the returned tagetable categories will be in the default language of the marketplace."},{"schema":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"in":"query","name":"nextToken","description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results."},{"schema":{"description":"The identifier of a client associated with a `Login with Amazon` account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a `Login with Amazon` account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Product targeting categories"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Product%20targeting%20categories/operation/SBTargetingGetRefinementsForCategory","sectionHeader":{"type":3,"text":"GET /sb/targets/categories/{categoryRefinementId}/refinements"},"summary":"Get refinements for category","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/insights",{"summary":"Get insights for campaigns","requestBody":{"content":{"application/vnd.sbinsights.v4+json":{"schema":{"type":"object","properties":{"adGroups":{"minItems":0,"maxItems":100,"type":"array","items":{"description":"The ad group settings.","type":"object","properties":{"keywords":{"minItems":0,"maxItems":800,"type":"array","items":{"description":"Keyword associated with the campaign.","type":"object","properties":{"matchType":{"description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Advertising support center.","type":"string","enum":["EXACT","PHRASE","BROAD"]},"bid":{"format":"double","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features).","type":"number"},"keywordText":{"description":"The keyword text. Maximum of 10 words.","type":"string"}},"required":["bid","keywordText","matchType"]}},"adFormat":{"description":"Type of Ad format.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]}},"required":["adFormat"]}}},"required":["adGroups"]}}},"required":true},"description":"Creates campaign level insights. Insights will be provided for passed in campaign parameters.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"SBInsightsCampaignInsights","responses":{"200":{"description":"SBInsightsCampaignInsights 200 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Response object for /sb/campaigns/insights containing a list of insights for the campaign.","type":"object","properties":{"insights":{"minItems":0,"maxItems":1000,"type":"array","items":{"oneOf":[{"type":"object","title":"keywordInsight","properties":{"keywordInsight":{"description":"Insights for keywords selected for targeting.","type":"object","properties":{"alerts":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Keyword alert insights associated with the selected keyword targets and bids.\nLOW_KEYWORD_TRAFFIC is provided if the keyword has very low traffic and is available in all marketplaces.\nLOW_BID is provided if the selected bid is low compared to the historical bids for this keyword\nand is only available in the following marketplaces: US, CA, MX, BR, UK, DE, FR, ES, IT, IN, AE, NL, SE, JP, AU, SG.","type":"string","enum":["LOW_KEYWORD_TRAFFIC","LOW_BID"]}},"searchTermImpressionShare":{"format":"double","description":"The account-level ad-attributed impression share for the search-term / keyword.\nProvides percentage share of all ad impressions the advertiser has for the keyword in the last 7 days.\nThis metric helps advertisers identify potential opportunities based on their share of relevant keywords.\nThis information is only available for keywords the advertiser targeted with ad impressions.\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP.","maximum":100,"type":"number","minimum":0},"matchType":{"description":"The match type. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Advertising support center.","type":"string","enum":["EXACT","PHRASE","BROAD"]},"adGroupIndex":{"description":"Correlates the ad group to the ad group array index specified in the request. Zero-based.","type":"integer"},"searchTermImpressionRank":{"description":"The account-level ad-attributed impression rank for the search-term / keyword.\nProvides the [1:N] place the advertiser ranks among all advertisers for the keyword by ad impressions in a marketplace in the last 7 days.\nIt tells an advertiser how many advertisers had higher share of ad impressions.\nThis information is only available for keywords the advertiser targeted with ad impressions.\nOnly available in the following marketplaces: US, CA, MX, UK, DE, FR, ES, IT, IN, JP.","type":"integer"},"bid":{"format":"double","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account. For more information, see [supported features](https://advertising.amazon.com/API/docs/v2/guides/supported_features).","type":"number"},"keywordIndex":{"description":"Correlates the keyword to the keyword array index specified in the request. Zero-based.","type":"integer"},"keywordText":{"description":"The keyword text. Maximum of 10 words.","type":"string"}}}},"required":["keywordInsight"]}]}},"nextToken":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"SBInsightsBadRequestException 400 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Returns information about a BadRequestException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"401":{"description":"SBInsightsUnauthorizedException 401 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Returns information about an UnauthorizedException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"422":{"description":"SBInsightsUnprocessableEntityException 422 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Returns information about an UnprocessableEntityException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBInsightsThrottlingException 429 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Returns information about a ThrottlingException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}},"500":{"description":"SBInsightsInternalServerException 500 response","content":{"application/vnd.sbinsights.v4+json":{"schema":{"description":"Returns information about an InternalServerException.","type":"object","properties":{"code":{"description":"The HTTP status code of the response.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"required":["code","details"]}}}}},"parameters":[{"schema":{"description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results.","type":"string"},"in":"query","name":"nextToken","description":"Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the `NextToken` field is empty, there are no further results."},{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Insights"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Insights/operation/SBInsightsCampaignInsights","sectionHeader":{"type":3,"text":"POST /sb/campaigns/insights"},"summary":"Get insights for campaigns","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/budgetRules",{"summary":"Create budget rules","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"budgetRulesDetails":{"maxItems":25,"description":"A list of budget rule details.","type":"array","items":{"type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss' ","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time. ","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["IS","NTB","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}}}}}}},"required":true},"operationId":"CreateBudgetRulesForSBCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The rule identifier.","type":"string"},"associatedCampaignIds":{"type":"array","items":{"description":"The campaign identifier for which rule based budget may get updated","type":"string"}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetRuleError - Something went wrong on the server. Retry later and report an BudgetRuleError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/CreateBudgetRulesForSBCampaigns","sectionHeader":{"type":3,"text":"POST /sb/budgetRules"},"summary":"Create budget rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/budgetRules",{"summary":"Update budget rules","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"budgetRulesDetails":{"maxItems":25,"description":"A list of budget rule details.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss' ","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time. ","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["IS","NTB","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}}}}}},"required":true},"operationId":"UpdateBudgetRulesForSBCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The rule identifier.","type":"string"},"associatedCampaignIds":{"type":"array","items":{"description":"The campaign identifier for which rule based budget may get updated","type":"string"}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetRuleError - Something went wrong on the server. Retry later and report an BudgetRuleError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/UpdateBudgetRulesForSBCampaigns","sectionHeader":{"type":3,"text":"PUT /sb/budgetRules"},"summary":"Update budget rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/budgetRules",{"summary":"Get budget rules","operationId":"GetSBBudgetRulesForAdvertiser","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"budgetRulesForAdvertiserResponse":{"minItems":0,"maxItems":30,"description":"A list of rules created by the advertiser.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss' ","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time. ","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["IS","NTB","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"query","name":"nextToken","description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results."},{"schema":{"type":"number"},"in":"query","name":"pageSize","description":"Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/GetSBBudgetRulesForAdvertiser","sectionHeader":{"type":3,"text":"GET /sb/budgetRules"},"summary":"Get budget rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/budgetRules/{budgetRuleId}",{"summary":"Get budget rule by ID","operationId":"GetBudgetRuleByRuleIdForSBCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"budgetRule":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss' ","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time. ","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["IS","NTB","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/GetBudgetRuleByRuleIdForSBCampaigns","sectionHeader":{"type":3,"text":"GET /sb/budgetRules/{budgetRuleId}"},"summary":"Get budget rule by ID","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/{campaignId}/budgetRules",{"summary":"Associate budget rules to campaign","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"budgetRuleIds":{"maxItems":25,"description":"A list of budget rule identifiers.","type":"array","items":{"type":"string"}}}}}},"required":true},"description":"A maximum of 250 rules can be associated to a campaign. Note that the name of each rule associated to a campaign is required to be unique.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","operationId":"CreateAssociatedBudgetRulesForSBCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of associated budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The budget rule identifier.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/CreateAssociatedBudgetRulesForSBCampaigns","sectionHeader":{"type":3,"text":"POST /sb/campaigns/{campaignId}/budgetRules"},"summary":"Associate budget rules to campaign","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/{campaignId}/budgetRules",{"summary":"Get budget rules associated to campaign","operationId":"ListAssociatedBudgetRulesForSBCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"associatedRules":{"description":"A list of associated budget rules.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss' ","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time. ","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["IS","NTB","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule evaluation status. Read-only.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/ListAssociatedBudgetRulesForSBCampaigns","sectionHeader":{"type":3,"text":"GET /sb/campaigns/{campaignId}/budgetRules"},"summary":"Get budget rules associated to campaign","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/budgetRules/{budgetRuleId}/campaigns",{"summary":"Get campaigns associated with budget rule","operationId":"GetCampaignsAssociatedWithSBBudgetRule","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"associatedCampaigns":{"minItems":0,"maxItems":30,"description":"A list of campaigns that are associated to this budget rule.","type":"array","items":{"type":"object","required":["campaignId","campaignName","ruleStatus"],"properties":{"campaignId":{"description":"The campaign identifier.","type":"string"},"ruleStatus":{"description":"The budget rule evaluation status for this campaign. Read-only.","type":"string"},"campaignName":{"description":"The campaign name.","type":"string"}}}},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true},{"schema":{"type":"string"},"in":"query","name":"nextToken","description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results."},{"schema":{"type":"number"},"in":"query","name":"pageSize","description":"Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/GetCampaignsAssociatedWithSBBudgetRule","sectionHeader":{"type":3,"text":"GET /sb/budgetRules/{budgetRuleId}/campaigns"},"summary":"Get campaigns associated with budget rule","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/{campaignId}/budgetRules/{budgetRuleId}",{"summary":"Disassociate budget rule from campaign","operationId":"DisassociateAssociatedBudgetRuleForSBCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true}],"tags":["Budget rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20rules/operation/DisassociateAssociatedBudgetRuleForSBCampaigns","sectionHeader":{"type":3,"text":"DELETE /sb/campaigns/{campaignId}/budgetRules/{budgetRuleId}"},"summary":"Disassociate budget rule from campaign","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/campaigns/budget/usage",{"summary":"Get budget usage","description":"\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","tags":["Budget usage"],"requestBody":{"content":{"application/vnd.sbcampaignbudgetusage.v1+json":{"schema":{"type":"object","properties":{"campaignIds":{"minItems":1,"maxItems":100,"description":"A list of campaign IDs","type":"array","items":{"type":"string"}}}}}},"required":true},"operationId":"sbCampaignsBudgetUsage","responses":{"207":{"description":"Multi-status. An object containing a list of budget usage response objects reflecting the same order as the input.","content":{"application/vnd.sbcampaignbudgetusage.v1+json":{"schema":{"type":"object","properties":{"success":{"description":"List of budget usage percentages that were successfully pulled","type":"array","items":{"type":"object","properties":{"budgetUsagePercent":{"description":"Budget usage percentage (spend / available budget) for the given budget policy.","type":"number"},"campaignId":{"description":"ID of requested resource","type":"string"},"usageUpdatedTimestamp":{"format":"date-time","description":"Last evaluation time for budget usage","type":"string"},"index":{"description":"An index to maintain order of the campaignIds","type":"number"},"budget":{"description":"Budget amount of resource requested","type":"number"}}}},"error":{"description":"List of budget usage percentages that failed to pull","type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"campaignId":{"description":"ID of requested resource","type":"string"},"index":{"description":"An index to maintain order of the campaignIds","type":"number"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetUsageError - Something went wrong on the server. Retry later and report an BudgetUsageError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Budget%20usage/operation/sbCampaignsBudgetUsage","sectionHeader":{"type":3,"text":"POST /sb/campaigns/budget/usage"},"summary":"Get budget usage","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/forecasts",{"summary":"Get performance forecasts for campaigns","requestBody":{"content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","description":"The campaign settings.","properties":{"budget":{"type":"number","description":"The amount of the budget.","format":"double"},"budgetType":{"type":"string","description":"Budget can be set to DAILY or LIFETIME. \n\n|BudgetType|Description|\n|-----------|-----------|\n|DAILY| The amount that you're willing to spend on this campaign each day. If the campaign spends less than your daily budget, the unspent amount can be used to increase your daily budget on the other days of the calendar month.|\n|LIFETIME| The total amount that you are willing to spend on this campaign.| \n\n"},"forecastType":{"type":"string","description":"The forecast type. can be set to WEEKLY or MONTHLY. \n\n**If have not set the forecastType during campaign creation then use WEEKLY as goal value.**\n"},"startDate":{"type":"string","description":"The YYYY-MM-DD start date for the campaign. If this field is not set to a value, the current date is used.","format":"date-time"},"endDate":{"type":"string","description":"The YYYY-MM-DD end date for the campaign. Must be greater than the value for `startDate`. If not specified, the campaign has no end date and runs continuously.","format":"date-time"},"goal":{"type":"string","description":"Goal will allow you to set goal type to help drive your campaign performance. \n\n**If have not set the goal during campaign creation then use PAGE_VISIT as goal type.** \n\n\nThe goal type of the campaign. Initial launch only supports PAGE_VISIT. \n\nBRAND_IMPRESSION_SHARE - This goal is a PREVIEW ONLY and cannot be set currently. It will allow you grown your brand impression share on top of search placement. \n\nPAGE_VISIT - This goal drives traffic to your landing and detail pages through all placements. \n\nACQUIRE_NEW_CUSTOMERS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal drives new customer acquisition for your brands. \n\nAD_VIEWS - This property is a PREVIEW ONLY and cannot be used as part of a request or response. This goal maximizes view for your ads. \n\n"},"adGroups":{"type":"array","items":{"type":"object","description":"The ad group settings.","properties":{"targets":{"type":"array","items":{"type":"object","description":"The target associated with the ad group.","properties":{"expressions":{"type":"array","items":{"type":"object","description":"Expression settings for the target.","properties":{"type":{"type":"string","description":"The expression type associated with the target. Valid value: ASIN_CATEGORY_SAME_AS, ASIN_BRAND_SAME_AS, ASIN_PRICE_LESS_THAN, ASIN_PRICE_BETWEEN, ASIN_PRICE_GREATER_THAN, ASIN_REVIEW_RATING_LESS_THAN, ASIN_REVIEW_RATING_BETWEEN, ASIN_REVIEW_RATING_GREATER_THAN, ASIN_SAME_AS."},"value":{"type":"string","description":"The expression value associated with targets."}}},"maxItems":100,"minItems":0},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account.","format":"float"}}},"maxItems":100,"minItems":0},"negativeTargets":{"type":"array","items":{"type":"object","description":"The negative target associated with the ad group.","properties":{"expressions":{"type":"array","items":{"type":"object","description":"Negative expression settings for the target.","properties":{"type":{"type":"string","description":"The negative expression type associated with the target. Valid value: ASIN_BRAND_SAME_AS, ASIN_SAME_AS."},"value":{"type":"string","description":"The expression value associated with targets."}}},"maxItems":100,"minItems":0}}},"maxItems":100,"minItems":0},"landingPages":{"type":"array","items":{"type":"object","properties":{"landingPageUrl":{"type":"string","description":"Landing page information."}}},"maxItems":100,"minItems":0},"themes":{"type":"array","items":{"type":"object","description":"The theme.","properties":{"themeType":{"type":"string","description":"The theme target type. Valid value: KEYWORDS_RELATED_TO_YOUR_BRAND, KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES. \n\nKEYWORDS_RELATED_TO_YOUR_BRAND - keywords related to brands. \n\nKEYWORDS_RELATED_TO_YOUR_LANDING_PAGES - keywords related to your landing pages."},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account.","format":"float"}}},"maxItems":100,"minItems":0},"keywords":{"type":"array","items":{"type":"object","description":"Keyword associated with the campaign.","properties":{"keywordText":{"type":"string","description":"The keyword text. Maximum of 10 words."},"matchType":{"type":"string","description":"The match type. Valid value: EXACT, PHRASE, BROAD. For more information, see [match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Advertising support center."},"bid":{"type":"number","description":"The associated bid. Note that this value must be less than the budget associated with the Advertiser account.","format":"float"}}},"maxItems":100,"minItems":0},"negativeKeywords":{"type":"array","items":{"type":"object","description":"Negative keyword associated with the campaign.","properties":{"keywordText":{"type":"string","description":"The keyword text. Maximum of 10 words."},"matchType":{"type":"string","description":"The negative match type. Valid value: NEGATIVE_EXACT, NEGATIVE_PHRASE. For more information, see [negative keyword match types](https://advertising.amazon.com/help#GHTRFDZRJPW6764R) in the Amazon Advertising support center."}}},"maxItems":100,"minItems":0},"creativeAsins":{"type":"array","items":{"description":"Optional. An array of creative ASINs that are displayed in the SB creative.","type":"string","maxItems":1000,"minItems":0}}}},"maxItems":1,"minItems":1}},"required":["adGroups","budget","budgetType","forecastType"]},"maxItems":1,"minItems":1}},"required":["campaigns"]}}},"required":true},"description":"Returns forecasts for a list of new campaigns specified in SB forecast request. Currently only one new campaign is supported. \n\n**If the campaign is not set to any goal during campaign creation then use PAGE_VISIT as goal value.**","operationId":"SBCampaignPerformanceForecasts","responses":{"207":{"description":"SBCampaignPerformanceForecasts 207 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Response object for /sb/forecasts containing a list of performance forecast for the campaign.","properties":{"campaigns":{"type":"object","properties":{"successes":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"Correlates the campaign to the campaign list index specified in the request. Zero-based."},"campaign":{"type":"object","properties":{"forecasts":{"type":"array","items":{"type":"object","description":"The forecast metric.","properties":{"metric":{"type":"string","description":"The forecast metric name. Currently supported metrics are IMPRESSION and CLICK."},"value":{"type":"object","description":"The forecast min and max value.","properties":{"min":{"type":"number","maximum":10000,"minimum":0,"description":"The forecast min value.","format":"float"},"max":{"type":"number","maximum":10000,"minimum":0,"description":"The forecast max value.","format":"float"}}}}},"maxItems":2,"minItems":1},"forecastTimestamp":{"type":"string","description":"The forecast timestamp."}}}}},"maxItems":1,"minItems":0},"errors":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","description":"Correlates the campaign to the campaign list index specified in the request. Zero-based."},"code":{"type":"string","description":"The forecast error code."},"description":{"type":"string","description":"The forecast error description."}}},"maxItems":1,"minItems":0}}}}}}}},"400":{"description":"SBForecastingBadRequestException 400 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about a BadRequestException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}},"401":{"description":"SBForecastingUnauthorizedException 401 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about an UnauthorizedException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}},"403":{"description":"SBForecastingAccessDeniedException 403 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about an AccessDeniedException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}},"422":{"description":"SBForecastingUnprocessableEntityException 422 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about an UnprocessableEntityException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"integer"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"SBForecastingThrottlingException 429 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about a ThrottlingException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}},"500":{"description":"SBForecastingInternalServerException 500 response","content":{"application/vnd.sbforecasting.v4+json":{"schema":{"type":"object","description":"Returns information about a InternalServerException.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}},"required":["code","details"]}}}}},"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","schema":{"type":"string","description":"The identifier of a client associated with a \"Login with Amazon\" account."},"required":true},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input.","schema":{"type":"string","description":"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 and choose profile id `profileId` from the response to pass it as input."},"required":true}],"tags":["Forecasts"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Forecasts/operation/SBCampaignPerformanceForecasts","sectionHeader":{"type":3,"text":"POST /sb/forecasts"},"summary":"Get performance forecasts for campaigns","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/rules/optimization",{"summary":"Create optimization rules","requestBody":{"content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRules":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"entityType":{"description":"Enum: \"CAMPAIGN\"\n\nThe type of entity passed.","type":"string"},"entityId":{"description":"Entity object identifier.","type":"string"},"conditions":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"criteria":{"type":"object","properties":{"comparisonOperator":{"description":"Enum: \"LESS_THAN_OR_EQUAL_TO\"\n\nThe comparison operator.","type":"string"},"value":{"description":"The value of the threshold associated with the attribute.","format":"double","type":"number"}}},"attributeName":{"description":"Enum: \"COST_PER_CLICK\"\n\nThe name of the attribute.\n\n Supported rule metrics and corresponding supported comparisonOperators:\n| AttributeName                      |  ComparisonOperator       |  Description                                                                            |\n|------------------------------------|---------------------------|-----------------------------------------------------------------------------------------|\n| COST_PER_CLICK                     | LESS_THAN_OR_EQUAL_TO     | Maximize page visits while cost per click less than or equal to threshold.              |","type":"string"}},"required":["attributeName","criteria"]}}}}}},"required":["optimizationRules"]}}},"required":true},"description":"Currently available in beta. \n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"CreateSponsoredBrandsOptimizationRules","responses":{"207":{"description":"CreateSponsoredBrandsOptimizationRules 207 response.","content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRules":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"optimizationRule":{"type":"object","properties":{"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"},"conditions":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"criteria":{"type":"object","properties":{"comparisonOperator":{"description":"Enum: \"LESS_THAN_OR_EQUAL_TO\"\n\nThe comparison operator.","type":"string"},"value":{"description":"The value of the threshold associated with the attribute.","format":"double","type":"number"}}},"attributeName":{"description":"Enum: \"COST_PER_CLICK\"\n\nThe name of the attribute.\n\n Supported rule metrics and corresponding supported comparisonOperators:\n| AttributeName                      |  ComparisonOperator       |  Description                                                                            |\n|------------------------------------|---------------------------|-----------------------------------------------------------------------------------------|\n| COST_PER_CLICK                     | LESS_THAN_OR_EQUAL_TO     | Maximize page visits while cost per click less than or equal to threshold.              |","type":"string"}},"required":["attributeName","criteria"]}}}},"entityType":{"type":"string"},"index":{"description":"The index of the entityId in the array from the request body.","maximum":10,"type":"number","minimum":0},"entityId":{"description":"Entity object identifier.","type":"string"},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["entityId","entityType","index","optimizationRule","optimizationRuleId"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the optimization rule id/entity Id in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors","type":"array","items":{"type":"object","properties":{"code":{"description":"The type of the error.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"required":["index"]}}}}},"required":["optimizationRules"]}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Optimization rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Optimization%20rules/operation/CreateSponsoredBrandsOptimizationRules","sectionHeader":{"type":3,"text":"POST /sb/rules/optimization"},"summary":"Create optimization rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/rules/optimization",{"summary":"Update optimization rules","requestBody":{"content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRules":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"},"conditions":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"criteria":{"type":"object","properties":{"comparisonOperator":{"description":"Enum: \"LESS_THAN_OR_EQUAL_TO\"\n\nThe comparison operator.","type":"string"},"value":{"description":"The value of the threshold associated with the attribute.","format":"double","type":"number"}}},"attributeName":{"description":"Enum: \"COST_PER_CLICK\"\n\nThe name of the attribute.\n\n Supported rule metrics and corresponding supported comparisonOperators:\n| AttributeName                      |  ComparisonOperator       |  Description                                                                            |\n|------------------------------------|---------------------------|-----------------------------------------------------------------------------------------|\n| COST_PER_CLICK                     | LESS_THAN_OR_EQUAL_TO     | Maximize page visits while cost per click less than or equal to threshold.              |","type":"string"}},"required":["attributeName","criteria"]}}}}}},"required":["optimizationRules"]}}},"required":true},"description":"Currently available in beta. \n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"UpdateSponsoredBrandsOptimizationRules","responses":{"207":{"description":"UpdateSponsoredBrandsOptimizationRules 207 response.","content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRules":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"optimizationRule":{"type":"object","properties":{"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"},"conditions":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"criteria":{"type":"object","properties":{"comparisonOperator":{"description":"Enum: \"LESS_THAN_OR_EQUAL_TO\"\n\nThe comparison operator.","type":"string"},"value":{"description":"The value of the threshold associated with the attribute.","format":"double","type":"number"}}},"attributeName":{"description":"Enum: \"COST_PER_CLICK\"\n\nThe name of the attribute.\n\n Supported rule metrics and corresponding supported comparisonOperators:\n| AttributeName                      |  ComparisonOperator       |  Description                                                                            |\n|------------------------------------|---------------------------|-----------------------------------------------------------------------------------------|\n| COST_PER_CLICK                     | LESS_THAN_OR_EQUAL_TO     | Maximize page visits while cost per click less than or equal to threshold.              |","type":"string"}},"required":["attributeName","criteria"]}}}},"index":{"description":"The index of the entityId in the array from the request body.","maximum":10,"type":"number","minimum":0},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["index","optimizationRule","optimizationRuleId"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the optimization rule id/entity Id in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors","type":"array","items":{"type":"object","properties":{"code":{"description":"The type of the error.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"required":["index"]}}}}},"required":["optimizationRules"]}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Optimization rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Optimization%20rules/operation/UpdateSponsoredBrandsOptimizationRules","sectionHeader":{"type":3,"text":"PUT /sb/rules/optimization"},"summary":"Update optimization rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/rules/optimization/associate",{"summary":"Associate optimization rules","requestBody":{"content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRuleAssociations":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"entityType":{"description":"Enum: \"CAMPAIGN\"\n\nThe type of entity passed.","type":"string"},"entityId":{"description":"Entity object identifier.","type":"string"},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["entityId","entityType","optimizationRuleId"]}}},"required":["optimizationRuleAssociations"]}}},"required":true},"description":"Currently available in beta. Associate one or more optimization rules by providing combinations of entityId-ruleId that require association.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"AssociateSponsoredBrandsOptimizationRules","responses":{"207":{"description":"AssociateSponsoredBrandsOptimizationRules 207 response.","content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRuleAssociations":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string"},"index":{"description":"The index of the entityId/optimizationId in the array from the request body.","maximum":10,"type":"number","minimum":0},"entityId":{"description":"Entity object identifier.","type":"string"},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["entityId","entityType","index","optimizationRuleId"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the optimization rule id/entity Id in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors","type":"array","items":{"type":"object","properties":{"code":{"description":"The type of the error.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"required":["index"]}}}}},"required":["optimizationRuleAssociations"]}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Optimization rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Optimization%20rules/operation/AssociateSponsoredBrandsOptimizationRules","sectionHeader":{"type":3,"text":"POST /sb/rules/optimization/associate"},"summary":"Associate optimization rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/rules/optimization/list",{"summary":"List optimization rules","requestBody":{"content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"entityFilter":{"description":"Filter optimization rules by entityId and entityType","type":"object","properties":{"entityType":{"description":"Enum: \"CAMPAIGN\"\n\nThe type of entity passed.","type":"string"},"entityId":{"description":"Entity object identifier.","type":"string"}}},"maxResults":{"description":"Number of records to include in the paginated response. Defaults to max page size for given API.","maximum":100,"type":"number","minimum":1},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"optimizationRuleIdFilter":{"description":"Filter optimization rules by the list of optimization rule ids.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}}}}}}},"operationId":"ListSponsoredBrandsOptimizationRules","description":"Currently available in beta. \n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","responses":{"200":{"description":"ListSponsoredBrandsOptimizationRules 200 response.","content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalCount":{"description":"The total number of entities.","type":"number"},"optimizationRules":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"},"conditions":{"minItems":1,"maxItems":1,"type":"array","items":{"type":"object","properties":{"criteria":{"type":"object","properties":{"comparisonOperator":{"description":"Enum: \"LESS_THAN_OR_EQUAL_TO\"\n\nThe comparison operator.","type":"string"},"value":{"description":"The value of the threshold associated with the attribute.","format":"double","type":"number"}}},"attributeName":{"description":"Enum: \"COST_PER_CLICK\"\n\nThe name of the attribute.\n\n Supported rule metrics and corresponding supported comparisonOperators:\n| AttributeName                      |  ComparisonOperator       |  Description                                                                            |\n|------------------------------------|---------------------------|-----------------------------------------------------------------------------------------|\n| COST_PER_CLICK                     | LESS_THAN_OR_EQUAL_TO     | Maximize page visits while cost per click less than or equal to threshold.              |","type":"string"}},"required":["attributeName","criteria"]}}}}}},"required":["optimizationRules"]}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Optimization rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Optimization%20rules/operation/ListSponsoredBrandsOptimizationRules","sectionHeader":{"type":3,"text":"POST /sb/rules/optimization/list"},"summary":"List optimization rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/rules/optimization/disassociate",{"summary":"Disassociate optimization rules","requestBody":{"content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRuleDisassociations":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"entityType":{"description":"Enum: \"CAMPAIGN\"\n\nThe type of entity passed.","type":"string"},"entityId":{"description":"Entity object identifier.","type":"string"},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["entityId","entityType","optimizationRuleId"]}}},"required":["optimizationRuleDisassociations"]}}},"required":true},"description":"Currently available in beta. Disassociate one or more optimization rules by providing combinations of entityId-ruleId that require disassociation\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"DisassociateSponsoredBrandsOptimizationRules","responses":{"207":{"description":"DisassociateSponsoredBrandsOptimizationRules 207 response.","content":{"application/vnd.sbruleoptimization.v4+json":{"schema":{"type":"object","properties":{"optimizationRuleDisassociations":{"type":"object","properties":{"success":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string"},"index":{"description":"The index of the entityId/optimizationId in the array from the request body.","maximum":10,"type":"number","minimum":0},"entityId":{"description":"Entity object identifier.","type":"string"},"optimizationRuleId":{"description":"The identifier of the optimization rule.","type":"string"}},"required":["entityId","entityType","index","optimizationRuleId"]}},"error":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"index":{"description":"the index of the optimization rule id/entity Id in the array from the request body.","maximum":10,"type":"number","minimum":0},"errors":{"minItems":0,"maxItems":100,"description":"A list of validation errors","type":"array","items":{"type":"object","properties":{"code":{"description":"The type of the error.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"required":["index"]}}}}},"required":["optimizationRuleDisassociations"]}}}},"400":{"description":"InvalidArgumentException 400 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"415":{"description":"UnsupportedMediaTypeException 415 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}}},"429":{"headers":{"Retry-After":{"schema":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","type":"number"},"description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}},"description":"ThrottlingException 429 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"description":"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 and choose profile id `profileId` from the response to pass it as input.","type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["Optimization rules"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Optimization%20rules/operation/DisassociateSponsoredBrandsOptimizationRules","sectionHeader":{"type":3,"text":"POST /sb/rules/optimization/disassociate"},"summary":"Disassociate optimization rules","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/legacyCampaigns/migrationJob",{"summary":"Creates Migration Job for V3 campaigns.","requestBody":{"content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"campaignIds":{"type":"array","items":{"type":"string"},"maxItems":1000,"minItems":0,"description":"Provide list of campaign ids that needs to be migrated"},"isStagedMigration":{"type":"boolean","description":"Set this flag to true if you want generate new campaign ID based on V3 campaign ID. These campaigns will not be visible through V4 campaign list call. If set to true not all campaign entities such as ad group, targeting, ad, or creatives are created. Use this flag for staging purpose only.\nBy default it will always be false"},"newCampaignState":{"type":"string","description":"This is optional parameter. By default, the new migrated campaigns will have the original status of V3 campaigns. If this parameter is set, then all newly migrated campaigns will have this state.\n Supported campaign states\n| State                                              |  Description |\n|----------------------------------------------------------|--------------|\n| ENABLED                               | Campaign entity has ENABLED state |"},"enableThemeTargeting":{"type":"boolean","description":"By default, theme targeting is set true if no value is provide. To disable theme targeting, set this flag to false."},"brandEntityId":{"type":"string","description":"Please note that brandEntityId is only required for sellers. You can get the brandEntityId by calling the <a href = https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#tag/Brands/operation/getBrands>GET /brands</a> endpoint."}},"required":["campaignIds","enableThemeTargeting"]}}},"required":true},"description":"Creates Migration Job for V3 campaigns.","operationId":"StartMigrationJob","responses":{"200":{"description":"StartMigrationJob 200 response","content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","description":"This jobId can be used to track migration status through /sb/v4/legacyCampaigns/migrationJob/status\nand results of each campaign through /sb/v4/legacyCampaigns/migrationJob/results API"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"type":"number","description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string","description":"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 and choose profile id `profileId` from the response to pass it as input."},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["V3 Campaign Migration"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/V3%20Campaign%20Migration/operation/StartMigrationJob","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/migrationJob"},"summary":"Creates Migration Job for V3 campaigns.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/legacyCampaigns/migrationJob/results",{"summary":"List Migration Results of all Campaign.","requestBody":{"content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"jobId":{"type":"string"},"nextToken":{"type":"string","description":"Token value allowing to navigate to the next response page."}},"required":["jobId"]}}},"required":true},"description":"List Migration Results of all Campaign.","operationId":"MigrationJobResults","responses":{"200":{"description":"MigrationJobResults 200 response","content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"jobId":{"type":"string"},"migrationJobStatus":{"type":"string","description":"Enumerated status code for migration job status\n| Status                                             |  Description |\n|----------------------------------------------------------|--------------|\n| COMPLETE  | Migration job is complete |\n| FAILED    | Migration failed and no V3 campaigns were migrated |\n| IN_PROGRESS    | Migration job is running |"},"campaigns":{"type":"array","items":{"type":"object","properties":{"legacyCampaignId":{"type":"string","description":"Entity object identifier."},"newCampaignId":{"type":"string"},"migrationStatus":{"type":"string","description":"Enumerated status code for migration job status\n| Status                                             |  Description |\n|----------------------------------------------------------|--------------|\n| MIGRATION_COMPLETE  | Migration is complete and new V4 campaigns are ready to serve. The V3 campaigns are archived |\n| STAGING_COMPLETE    | Staging of V4 campaign IDs are complete |\n| MIGRATION_FAILED         | Migration of V3 campaign failed  |\n| MIGRATION_IN_PROGRESS   | Migration for V3 campaign is in-progress |"},"migrationStatusReason":{"type":"string","description":"Status reason for the given migration status"}}}},"nextToken":{"type":"string","description":"Token value allowing to navigate to the next response page."}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"type":"number","description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string","description":"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 and choose profile id `profileId` from the response to pass it as input."},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["V3 Campaign Migration"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/V3%20Campaign%20Migration/operation/MigrationJobResults","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/migrationJob/results"},"summary":"List Migration Results of all Campaign.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/legacyCampaigns/migrationJob/status",{"summary":"List Migration Job Status.","requestBody":{"content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]}}},"required":true},"description":"List Migration Job Status.","operationId":"MigrationJobStatus","responses":{"200":{"description":"MigrationJobStatus 200 response","content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"jobId":{"type":"string"},"migrationJobStatus":{"type":"string","description":"Enumerated status code for migration job status\n| Status                                             |  Description |\n|----------------------------------------------------------|--------------|\n| COMPLETE  | Migration job is complete |\n| FAILED    | Migration failed and no V3 campaigns were migrated |\n| IN_PROGRESS    | Migration job is running |"},"migrationJobStatusReason":{"type":"string","description":"Status reason for the migration job status"}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"type":"number","description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string","description":"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 and choose profile id `profileId` from the response to pass it as input."},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["V3 Campaign Migration"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/V3%20Campaign%20Migration/operation/MigrationJobStatus","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/migrationJob/status"},"summary":"List Migration Job Status.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/legacyCampaigns/overallMigrationResults",{"summary":"Lists all Campaign Migration results for an advertiser.","requestBody":{"content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"nextToken":{"type":"string","description":"Token value allowing to navigate to the next response page."}}}}}},"description":"Lists all Campaign Migration results for an advertiser","operationId":"MigrationResults","responses":{"200":{"description":"MigrationResults 200 response","content":{"application/vnd.SponsoredBrands.SponsoredBrandsMigrationApi.v4+json":{"schema":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","properties":{"legacyCampaignId":{"type":"string","description":"Entity object identifier."},"newCampaignId":{"type":"string"},"migrationStatus":{"type":"string","description":"Enumerated status code for migration job status\n| Status                                             |  Description |\n|----------------------------------------------------------|--------------|\n| MIGRATION_COMPLETE  | Migration is complete and new V4 campaigns are ready to serve. The V3 campaigns are archived |\n| STAGING_COMPLETE    | Staging of V4 campaign IDs are complete |\n| MIGRATION_FAILED         | Migration of V3 campaign failed  |\n| MIGRATION_IN_PROGRESS   | Migration for V3 campaign is in-progress |"},"migrationStatusReason":{"type":"string","description":"Status reason for the given migration status"}}}},"nextToken":{"type":"string","description":"Token value allowing to navigate to the next response page."}}}}}},"400":{"description":"InvalidArgumentException 400 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}}},"401":{"description":"UnauthorizedException 401 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"403":{"description":"AccessDeniedException 403 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"429":{"description":"ThrottlingException 429 response","headers":{"Retry-After":{"description":"Delay in seconds, before the next re-try attempt to the operation is recommended.","schema":{"type":"number","description":"Delay in seconds, before the next re-try attempt to the operation is recommended."}}},"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}},"500":{"description":"InternalServerException 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}}}},"parameters":[{"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true},{"schema":{"type":"string","description":"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 and choose profile id `profileId` from the response to pass it as input."},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":true}],"tags":["V3 Campaign Migration"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/V3%20Campaign%20Migration/operation/MigrationResults","sectionHeader":{"type":3,"text":"POST /sb/v4/legacyCampaigns/overallMigrationResults"},"summary":"Lists all Campaign Migration results for an advertiser.","documentType":"api-reference"},{"title":"Sponsored Brands campaign management","content":["/sb/v4/migrations/list",{"description":"Lists eligible Product Collection ads with recommended SB Collection replacement options.\n\nSponsored Brands collections replace the legacy Product Collection format with improved functionality and performance in the same high-visibility placements. Collections feature up to 10 products per ad (compared to 3 with Product Collection).\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"ListMigrations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.sbAdMigration.v4+json":{"schema":{"properties":{"adGroupIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"adIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"adStateFilter":{"description":"Filter entities by state.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]}}}},"campaignIdFilter":{"description":"Filter entities by the list of objectIds.","type":"object","properties":{"include":{"minItems":0,"maxItems":10,"type":"array","items":{"description":"Entity object identifier.","type":"string"}}}},"maxResults":{"description":"Default: 20, Max: 100.","maximum":100,"minimum":1,"type":"number"},"migrationStatusFilter":{"description":"Filter migrations by option-level status. Returns migrations with at least one option matching the filter.","properties":{"include":{"items":{"description":"The lifecycle status of a migration option.","enum":["ACCEPTED","ELIGIBLE","MIGRATED","MIGRATION_FAILED"],"type":"string"},"maxItems":4,"minItems":0,"type":"array"}},"type":"object"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/vnd.sbAdMigration.v4+json":{"schema":{"properties":{"migrations":{"items":{"description":"A migration represents one source PC ad with its recommended replacement options.","properties":{"migrationEntity":{"description":"The source ad being migrated, enriched with campaign and ad group display names.","properties":{"ad":{"type":"object","properties":{"adId":{"description":"The ad identifier. Note: Ads created using version 3/non-multi ad group campaigns do not have an associated adId. [Learn more](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/campaigns/managing-multi-ad-group-campaigns#ads).","type":"string"},"campaignId":{"description":"The campaign identifier.","type":"string"},"landingPage":{"type":"object","properties":{"asins":{"minItems":3,"maxItems":100,"type":"array","items":{"type":"string"}},"pageType":{"description":"The type of landing page, such as store page, product list (simple landing page), custom url.","type":"string","enum":["PRODUCT_LIST","STORE","CUSTOM_URL","DETAIL_PAGE"]},"url":{"description":"URL of an existing simple landing page or Store page. Vendors may also specify the URL of a custom landing page.\nIf a custom URL is specified, the landing page must include the ASINs of at least three products that are\nadvertised as part of the campaign. Do not include this property in the request if the asins property is also\nincluded, these properties are mutually exclusive.\nNote that brandVideo ads only support Store page as landing page and does not allow asins property.","type":"string"}}},"name":{"minLength":1,"description":"The name of the ad. Note: Ads created using version 3/non-multi ad group campaigns do not have an associated name. [Learn more](https://advertising.amazon.com/API/docs/en-us/sponsored-brands/campaigns/managing-multi-ad-group-campaigns#ads).","type":"string","maxLength":255},"state":{"description":"The current resource state.","type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]},"adGroupId":{"description":"The adGroup identifier.","type":"string"},"creative":{"type":"object","properties":{"brandLogoCrop":{"description":"The crop to apply to the selected Brand logo. A Brand logo must have minimum dimensions of 400x400. If a brandLogoAssetID is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"brandName":{"minLength":1,"type":"string","maxLength":30},"customImageAssetId":{"type":"string"},"consentToTranslate":{"description":"If set to true and the headline and/or video asset are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch. See developer notes for more information.","type":"boolean"},"customImages":{"minItems":1,"maxItems":5,"uniqueItems":true,"description":"Requires minimum one custom image. You can add an optional collection of custom images that can be displayed on the ad as slideshow. Learn more about slideshow here https://advertising.amazon.com/resources/whats-new/slideshow-ads-creative-for-sponsored-brands/","type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"crop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"url":{"type":"string"}}}},"customImageCrop":{"description":"The crop to apply to the selected Custom image. A Custom image must have a 1200x628 aspect ratio, with a .01 delta for floating point precision. If a customImageAssetId is supplied but a crop is not, the crop will be defaulted to the whole image.","type":"object","properties":{"top":{"type":"number"},"left":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}},"customImageUrl":{"type":"string"},"type":{"description":"The creative type of SB ad.","type":"string","enum":["PRODUCT_COLLECTION","STORE_SPOTLIGHT","VIDEO","BRAND_VIDEO"]},"originalVideoAssetIds":{"minItems":1,"maxItems":1,"description":"The assetIds of the original videos submitted by the advertiser.\nIf 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalVideoAssetIds` will return the original video assetId whereas `videoAssetIds` will return translated video assetId. In all other cases, 'originalVideoAssetIds' and `videoAssetIds` both will return original video assetId.","type":"array","items":{"type":"string"}},"asins":{"minItems":0,"maxItems":100,"type":"array","items":{"type":"string"}},"brandLogoUrl":{"type":"string"},"subpages":{"minItems":3,"maxItems":3,"type":"array","items":{"type":"object","properties":{"pageTitle":{"type":"string"},"asin":{"type":"string"},"url":{"type":"string"}}}},"creativePropertiesToOptimize":{"minItems":0,"maxItems":1,"description":"If this property is enabled, Sponsored Brands will dynamically optimize by enhancing or generating creative properties based on shopper search intent.","type":"array","items":{"description":"| CreativePropertyToOptimize                            |  Description                                                                            |\n|------------------------------------|-----------------------------------------------------------------------------------------|\n| HEADLINE                            | Optimizes headlines by leveraging provided versions and customizing them based on factors such as audience, placement, and featured products.                                                                            |","type":"string","enum":["HEADLINE"]}},"originalHeadline":{"minLength":1,"description":"The original headline submitted by the advertiser.","type":"string","maxLength":50},"videoAssetIds":{"minItems":1,"maxItems":1,"description":"In SB API V4, `videoMediaIds` is replaced by `videoAssetIds`.\n`videoAssetIds` will only allow Asset Library identifiers for ad creation, but responses can include mediaIds for v1 campaigns and API V3 operations.\nAt a future state, existing mediaIds will be added to Asset library for use in SB campaigns.","type":"array","items":{"type":"string"}},"brandLogoAssetID":{"type":"string"},"headline":{"minLength":1,"description":"The headline text. Maximum length of the string is 50 characters for all marketplaces other than Japan, which has a maximum length of 35 characters.","type":"string","maxLength":50},"creativeStatus":{"description":"The lifecycle status of a creative","type":"string","enum":["SUBMITTED_FOR_MODERATION","PENDING_TRANSLATION","PENDING_MODERATION_REVIEW","APPROVED_BY_MODERATION","REJECTED_BY_MODERATION","PUBLISHED"]},"creativeVersion":{"type":"string","description":"The version identifier that helps you keep track of multiple versions of a submitted (non-draft) Sponsored Brands creative."}}},"extendedData":{"type":"object","properties":{"servingStatus":{"description":"The ad serving status determined by system.\n- AD_STATUS_LIVE - Ad's status is enabled.\n- AD_POLICING_PENDING_REVIEW - Ad is pending review because of policing reason.\n- AD_POLICING_SUSPENDED - Ad is suspended review because of policing reason.\n- AD_PAUSED - Ad's status is paused.\n- AD_ARCHIVED - Ad's status is archived.\n\n- AD_GROUP_STATUS_ENABLED - Ad group's (parent) status is enabled.\n- AD_GROUP_PAUSED - Ad group's (parent) status is paused.\n- AD_GROUP_ARCHIVED - Ad group's (parent) status is archived.\n- AD_GROUP_INCOMPLETE - Ad group (parent) does not contain any ads or targeting clauses.\n- AD_GROUP_POLICING_PENDING_REVIEW - Ad group is pending review because of policing reason\n- AD_GROUP_POLICING_CREATIVE_REJECTED - Ad group is rejected due to creative because of policing reason\n- AD_GROUP_LOW_BID - Ad group is less than the minimum allowed bid in its marketplace\n\n- ADVERTISER_STATUS_ENABLED - Advertiser's status is enabled\n- ADVERTISER_POLICING_PENDING_REVIEW - Avertiser is pending review because of policing reason\n- ADVERTISER_POLICING_SUSPENDED - Advertiser's status is suspended because of policing reason\n- ADVERTISER_PAUSED - Advertiser's status is paused\n- ADVERTISER_ARCHIVED - Advertiser's status is archived\n- ADVERTISER_PAYMENT_FAILURE - Advertiser's internal status is suspended\n- ADVERTISER_ACCOUNT_OUT_OF_BUDGET - Advertiser is out of budget for all Sponsored Ads campaigns\n- ADVERTISER_OUT_OF_PREPAY_BALANCE - Advertiser is out of prepay balance for all Sponsored Ads campaigns\n- ADVERTISER_EXCEED_SPENDS_LIMIT - Advertiser spends over the daily limit\n\n- CAMPAIGN_STATUS_ENABLED - Campaign's (parent) status is enabled.\n- CAMPAIGN_PAUSED - Campaign's (parent) status is paused.\n- CAMPAIGN_ARCHIVED - Campaign's (parent) status is archived.\n- CAMPAIGN_INCOMPLETE - Campaign (parent) does not contain any ads or targeting clauses.\n- CAMPAIGN_OUT_OF_BUDGET - Campaign (parent) is out of budget.\n\n- PORTFOLIO_STATUS_ENABLED - Portfolio's (parent) status is enabled\n- PORTFOLIO_PAUSED - Portfolio's (parent) status is paused\n- PORTFOLIO_ARCHIVED - Portfolio's (parent) status is archived\n- PORTFOLIO_OUT_OF_BUDGET - Portfolio (parent) is out of budget\n- PORTFOLIO_PENDING_START_DATE - Portfolio's (parent) start date is in the future\n- PORTFOLIO_ENDED - Portfolio's (parent) end date is in the past.\n\n- INELIGIBLE - Ad is ineligible.\n- ELIGIBLE  - Ad is eligible.\n- ENDED - Campaign's (parent) end date is in the past.\n- PENDING_REVIEW - Campaign (parent) is pending review.\n- PENDING_START_DATE - Campaign's (parent) start date is in the future.\n- REJECTED - Campaign (parent) is rejected by moderation process.\n- UNKNOWN - Serving status is unknown. Please contact us for support.","type":"string","enum":["AD_STATUS_LIVE","AD_POLICING_PENDING_REVIEW","AD_POLICING_SUSPENDED","AD_PAUSED","AD_ARCHIVED","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_POLICING_PENDING_REVIEW","AD_GROUP_POLICING_CREATIVE_REJECTED","AD_GROUP_LOW_BID","ADVERTISER_STATUS_ENABLED","ADVERTISER_POLICING_PENDING_REVIEW","ADVERTISER_POLICING_SUSPENDED","ADVERTISER_PAUSED","ADVERTISER_ARCHIVED","ADVERTISER_PAYMENT_FAILURE","ADVERTISER_ACCOUNT_OUT_OF_BUDGET","ADVERTISER_OUT_OF_PREPAY_BALANCE","ADVERTISER_EXCEED_SPENDS_LIMIT","CAMPAIGN_STATUS_ENABLED","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","CAMPAIGN_INCOMPLETE","CAMPAIGN_OUT_OF_BUDGET","PORTFOLIO_STATUS_ENABLED","PORTFOLIO_PAUSED","PORTFOLIO_ARCHIVED","PORTFOLIO_OUT_OF_BUDGET","PORTFOLIO_PENDING_START_DATE","PORTFOLIO_ENDED","INELIGIBLE","ELIGIBLE","ENDED","PENDING_REVIEW","PENDING_START_DATE","REJECTED","UNKNOWN"]},"lastUpdateDate":{"description":"Date of last update in epoch time.","type":"number"},"servingStatusDetails":{"minItems":0,"maxItems":100,"description":"The serving status reasons of the Ad.","type":"array","items":{"type":"string"}},"creationDate":{"description":"Creation date in epoch time.","type":"number"}}}},"required":["adGroupId","campaignId","state"]},"adGroupName":{"description":"Display name of the source ad group.","type":"string"},"campaignName":{"description":"Display name of the source campaign.","type":"string"}},"type":"object"},"migrationId":{"description":"Unique identifier for this migration. Currently equal to the source adId.","type":"string"},"migrationOptions":{"description":"The recommended replacement options (1-2 options: Manual Collection, Auto Collection).","items":{"description":"A replacement option offered to the advertiser for a source PC ad.","properties":{"adGroupId":{"description":"The adGroupId of the created ad. Populated only after status = MIGRATED.","type":"string"},"adId":{"description":"The adId of the created ad. Populated only after status = MIGRATED.","type":"string"},"asins":{"description":"For MANUAL_COLLECTION: 3-10 recommended ASINs.\nFor AUTO_COLLECTION: empty (system selects dynamically at serve time).","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"errorCode":{"description":"Error code. Populated only when status = MIGRATION_FAILED.","type":"string"},"errorMessage":{"description":"Error message. Populated only when status = MIGRATION_FAILED.","type":"string"},"migrationType":{"description":"The type of migration being offered for this option.\n- MIGRATE: Preserves the advertiser's original configuration as closely as possible.\n- IMPROVE: Optimizes the configuration for better performance.","enum":["IMPROVE","MIGRATE"],"type":"string"},"optionType":{"description":"The type of SB Collection to migrate to.","enum":["AUTO_COLLECTION","MANUAL_COLLECTION"],"type":"string"},"rationale":{"description":"Rationale explaining why this migration option is being offered.","type":"string"},"status":{"description":"The lifecycle status of a migration option.","enum":["ACCEPTED","ELIGIBLE","MIGRATED","MIGRATION_FAILED"],"type":"string"}},"required":["optionType"],"type":"object"},"maxItems":2,"minItems":1,"type":"array"}},"required":["migrationEntity","migrationId","migrationOptions"],"type":"object"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"description":"Token value allowing to navigate to the next response page.","type":"string"},"totalCount":{"description":"The total number of migrations matching the request filters. Only returned on the first page.","type":"number"}},"type":"object"}}},"description":"ListMigrations 200 response."},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_ARGUMENT"]},"message":{"description":"Human readable error message.","type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of the error","type":"string"},"errorValue":{"type":"object","properties":{"rangeError":{"description":"Errors related to range constraints violations.","type":"object","properties":{"reason":{"type":"string"},"allowed":{"minItems":0,"maxItems":100,"description":"Allowed values.","type":"array","items":{"type":"string"}},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"upperLimit":{"description":"Optional upper limit.","type":"string"},"lowerLimit":{"description":"Optional lower limit.","type":"string"},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]},"otherError":{"description":"Errors not related to any of the other error types.","type":"object","properties":{"reason":{"type":"string"},"cause":{"description":"Structure describing error cause - location in the payload and data causing error.","type":"object","properties":{"location":{"description":"Error location, JSON Path expression specifying element of API payload causing error.","type":"string"},"trigger":{"description":"Optional value causing error.","type":"string"}},"required":["location"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["cause","message","reason"]}}}},"required":["errorType","errorValue"]}}},"required":["code","message"]}}},"description":"InvalidArgumentException 400 response."},"401":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"UnauthorizedException 401 response."},"403":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["ACCESS_DENIED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"AccessDeniedException 403 response."},"415":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"A human-readable description of the enumerated response code in the `code` field.","type":"string"},"details":{"description":"An enumerated response code.","type":"string"}},"required":["code","details"]}}},"description":"UnsupportedMediaTypeException 415 response."},"429":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["THROTTLED"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"ThrottlingException 429 response.","headers":{"Retry-After":{"description":"Delay in seconds before the next retry attempt.","schema":{"type":"number"}}}},"500":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_ERROR"]},"message":{"description":"Human readable error message.","type":"string"}},"required":["code","message"]}}},"description":"InternalServerException 500 response."}},"tags":["Ad Migrations"]}],"path":"/en-us/sponsored-brands/3-0/openapi/prod#tag/Ad%20Migrations/operation/ListMigrations","sectionHeader":{"type":3,"text":"POST /sb/v4/migrations/list"},"documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["This API enables programmatic access for campaign creation, management, and reporting for Sponsored Display campaigns. For more information on the functionality, see the Sponsored Display Support Center. For API onboarding information, see the account setup topic.\n\nThis specification is available for download from the Advertising API developer portal.\n"],"path":"/en-us/sponsored-display/3-0/openapi","sectionHeader":{"type":2,"text":"Amazon Ads API for Sponsored Display"},"documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns",{"tags":["Campaigns"],"summary":"Gets a list of campaigns.","description":"Gets an array of Campaign objects for a requested set of Sponsored Display campaigns. Note that the Campaign object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the campaign operations that return the CampaignResponseEx object.","operationId":"listCampaigns","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of campaigns. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32","default":0}},{"name":"count","in":"query","description":"Optional. Sets the number of Campaign objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten campaigns set `startIndex=0` and `count=10`. To return the next ten campaigns, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"name","in":"query","description":"Optional. The returned array includes only campaign with the specified name using an exact string match.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array includes only campaigns with identifiers matching those specified in the comma-delimited string.","schema":{"type":"string"}},{"name":"portfolioIdFilter","in":"query","description":"Optional. The returned array includes only campaigns associated with Portfolio identifiers matching those specified in the comma-delimited string.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double","example":"3.00"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future.","example":"20190101"},"endDate":{"type":"string","nullable":true,"description":"The YYYYMMDD end date of the campaign.","example":null},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |\n\nTo view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","enum":["cpc","vcpm"]},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","format":"int64","nullable":true,"description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","example":null}}},{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"deliveryProfile":{"type":"string","enum":["as_soon_as_possible"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/listCampaigns","sectionHeader":{"type":3,"text":"GET /sd/campaigns"},"summary":"Gets a list of campaigns.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns",{"tags":["Campaigns"],"summary":"Updates one or more campaigns.","operationId":"updateCampaigns","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of Campaign objects. For each object, specify a campaign identifier and mutable fields with their updated values. The mutable fields are `name`, `state`, `budget`, `startDate`, and `endDate`. Maximum length of the array is 100 objects.","content":{"application/json":{"schema":{"type":"array","items":{"required":["campaignId"],"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double","example":"3.00"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future.","example":"20190101"},"endDate":{"type":"string","nullable":true,"description":"The YYYYMMDD end date of the campaign.","example":null},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |\n\nTo view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","enum":["cpc","vcpm"]},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","format":"int64","nullable":true,"description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","example":null}}},{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/updateCampaigns","sectionHeader":{"type":3,"text":"PUT /sd/campaigns"},"summary":"Updates one or more campaigns.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns",{"tags":["Campaigns"],"summary":"Creates one or more campaigns.","operationId":"createCampaigns","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of Campaign objects. For each object, specify required fields and their values. Required fields are `name`, `tactic`, `state`, and `startDate`. Maximum length of the array is 100 objects. If you don't specify a `budget`, it will be set as the [default budget for your region](https://advertising.amazon.com/API/docs/en-us/concepts/limits#default-budgets). Campaign names must be unique across SD, SB, and SP.\n  If you are using Optimization rules, the following campaign budget must be at least:\n  - 5x the value of any COST_PER_ORDER threshold.\n  - 10x the value of any COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS threshold.\n  - 20x the value of any COST_PER_CLICK threshold.\n","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double","example":"3.00"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future.","example":"20190101"},"endDate":{"type":"string","nullable":true,"description":"The YYYYMMDD end date of the campaign.","example":null},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |\n\nTo view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","enum":["cpc","vcpm"]},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","format":"int64","nullable":true,"description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","example":null}}},{"type":"object","properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/createCampaigns","sectionHeader":{"type":3,"text":"POST /sd/campaigns"},"summary":"Creates one or more campaigns.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/{campaignId}",{"tags":["Campaigns"],"summary":"Gets a requested campaign.","description":"Returns a Campaign object for a requested campaign. Note that the Campaign object is designed for performance, with a small set of commonly used campaign fields to reduce size. If the extended set of fields is required, use the campaign operations that return the CampaignResponseEx object.","operationId":"getCampaign","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"campaignId","in":"path","description":"The identifier of the requested campaign.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double","example":"3.00"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future.","example":"20190101"},"endDate":{"type":"string","nullable":true,"description":"The YYYYMMDD end date of the campaign.","example":null},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |\n\nTo view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","enum":["cpc","vcpm"]},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","format":"int64","nullable":true,"description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","example":null}}},{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"deliveryProfile":{"type":"string","enum":["as_soon_as_possible"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/getCampaign","sectionHeader":{"type":3,"text":"GET /sd/campaigns/{campaignId}"},"summary":"Gets a requested campaign.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/{campaignId}",{"tags":["Campaigns"],"summary":"Sets the campaign status to archived.","description":"This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See [Developer Notes](https://advertising.amazon.com/API/docs/en-us/info/developer-notes#archiving) for more information.","operationId":"archiveCampaign","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"campaignId","in":"path","description":"The identifier of the campaign.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/archiveCampaign","sectionHeader":{"type":3,"text":"DELETE /sd/campaigns/{campaignId}"},"summary":"Sets the campaign status to archived.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/extended",{"tags":["Campaigns"],"summary":"Gets a list of campaigns with extended fields.","description":"Gets an array of CampaignResponseEx objects for a set of requested campaigns.","operationId":"listCampaignsEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of campaigns. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of Campaign objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten campaigns set `startIndex=0` and `count=10`. To return the next ten campaigns, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"name","in":"query","description":"Optional. The returned array includes only campaign with the specified name using an exact string match.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array includes only campaigns with identifiers matching those specified in the comma-delimited string.","schema":{"type":"string"}},{"name":"portfolioIdFilter","in":"query","description":"Optional. The returned array includes only campaigns associated with Portfolio identifiers matching those specified in the comma-delimited string.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"number","description":"The identifier of the campaign."},"name":{"type":"string","description":"The name of the campaign."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future."},"endDate":{"type":"string","description":"The YYYYMMDD end date of the campaign."},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","format":"int64"},"servingStatus":{"type":"string","description":"The status of the campaign.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|-----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm|The performance of this campaign is measured by the viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","enum":["cpc","vcpm"]},"creationDate":{"type":"integer","description":"Epoch date the campaign was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the campaign.","format":"int64"},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/listCampaignsEx","sectionHeader":{"type":3,"text":"GET /sd/campaigns/extended"},"summary":"Gets a list of campaigns with extended fields.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/extended/{campaignId}",{"tags":["Campaigns"],"summary":"Gets extended information for a requested campaign.","description":"Returns a CampaignResponseEx object for a requested campaign. The CampaignResponseEx includes the extended set of available fields.","operationId":"getCampaignResponseEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"campaignId","in":"path","description":"The identifier of the requested campaign.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"number","description":"The identifier of the campaign."},"name":{"type":"string","description":"The name of the campaign."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future."},"endDate":{"type":"string","description":"The YYYYMMDD end date of the campaign."},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","format":"int64"},"servingStatus":{"type":"string","description":"The status of the campaign.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|-----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm|The performance of this campaign is measured by the viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","enum":["cpc","vcpm"]},"creationDate":{"type":"integer","description":"Epoch date the campaign was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the campaign.","format":"int64"},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Campaigns/operation/getCampaignResponseEx","sectionHeader":{"type":3,"text":"GET /sd/campaigns/extended/{campaignId}"},"summary":"Gets extended information for a requested campaign.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups",{"tags":["Ad Groups"],"summary":"Gets a list of ad groups.","description":"Gets an array of AdGroup objects for a requested set of Sponsored Display ad groups. Note that the AdGroup object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the ad group operations that return the AdGroupResponseEx object.","operationId":"listAdGroups","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of campaigns. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of AdGroup objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten ad groups set `startIndex=0` and `count=10`. To return the next ten ad groups, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only ad groups with state set to one of the values in the specified comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array is filtered to include only ad groups associated with the campaign identifiers in the specified comma-delimited list.","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional. The returned array is filtered to include only ad groups with an identifier specified in the comma-delimited list.","schema":{"type":"string"}},{"name":"name","in":"query","description":"Optional. The returned array includes only ad groups with the specified name.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"bidOptimization":{"type":"string","description":"Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks |cpc|[Default] Optimize for page visits.|\n|conversions |cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"state":{"type":"string","description":"The state of the ad group.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"creativeType":{"type":"string","nullable":true,"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/listAdGroups","sectionHeader":{"type":3,"text":"GET /sd/adGroups"},"summary":"Gets a list of ad groups.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups",{"tags":["Ad Groups"],"summary":"Updates on or more ad groups.","operationId":"updateAdGroups","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of AdGroup objects. For each object, specify an ad group identifier and mutable fields with their updated values. The mutable fields are 'name', 'defaultBid', and 'state'. Maximum length of the array is 100 objects.","content":{"application/json":{"schema":{"type":"array","items":{"required":["adGroupId"],"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"bidOptimization":{"type":"string","description":"Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks |cpc|[Default] Optimize for page visits.|\n|conversions |cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"state":{"type":"string","description":"The state of the ad group.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/updateAdGroups","sectionHeader":{"type":3,"text":"PUT /sd/adGroups"},"summary":"Updates on or more ad groups.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups",{"tags":["Ad Groups"],"summary":"Creates one or more ad groups.","operationId":"createAdGroups","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of AdGroup objects. For each object, specify required fields and their values. Required fields are `campaignId`, `name`, `state`, and `defaultBid`. Maximum length of the array is 100 objects. Note - when using landingPageType of OFF_AMAZON_LINK or STORES within productAds, only 1 adGroup is supported.","content":{"application/json":{"schema":{"type":"array","items":{"required":["campaignId","name","state"],"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"bidOptimization":{"type":"string","description":"Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks |cpc|[Default] Optimize for page visits.|\n|conversions |cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"state":{"type":"string","description":"The state of the ad group.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"creativeType":{"type":"string","nullable":true,"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/createAdGroups","sectionHeader":{"type":3,"text":"POST /sd/adGroups"},"summary":"Creates one or more ad groups.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/{adGroupId}",{"tags":["Ad Groups"],"summary":"Gets a requested ad group.","description":"Returns an AdGroup object for a requested campaign. Note that the AdGroup object is designed for performance, with a small set of commonly used ad group fields to reduce size. If the extended set of fields is required, use the campaign operations that return the AdGroupResponseEx object.","operationId":"getAdGroup","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the requested ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"bidOptimization":{"type":"string","description":"Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks |cpc|[Default] Optimize for page visits.|\n|conversions |cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"state":{"type":"string","description":"The state of the ad group.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"creativeType":{"type":"string","nullable":true,"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/getAdGroup","sectionHeader":{"type":3,"text":"GET /sd/adGroups/{adGroupId}"},"summary":"Gets a requested ad group.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/{adGroupId}",{"tags":["Ad Groups"],"summary":"Sets the ad group status to archived.","description":"This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See [Developer Notes](https://advertising.amazon.com/API/docs/en-us/info/developer-notes#archiving) for more information.","operationId":"archiveAdGroup","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the requested ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/archiveAdGroup","sectionHeader":{"type":3,"text":"DELETE /sd/adGroups/{adGroupId}"},"summary":"Sets the ad group status to archived.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/extended",{"tags":["Ad Groups"],"summary":"Gets a list of ad groups with extended fields.","description":"Gets an array of AdGroupResponseEx objects for a set of requested ad groups.","operationId":"listAdGroupsEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of ad groups. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of Campaign objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten campaigns set `startIndex=0` and `count=10`. To return the next ten campaigns, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only campaigns with state set to one of the values in the comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array is filtered to include only ad groups associated with the campaign identifiers in the comma-delimited list.","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional. The returned array is filtered to include only ad groups with an identifier specified in the comma-delimited list.","schema":{"type":"string"}},{"name":"name","in":"query","description":"Optional. The returned array includes only ad groups with the specified name.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Object containing an extended set of data fields for an Ad Group.","properties":{"adGroupId":{"type":"number","description":"The identifier of the ad group."},"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"number","description":"The identifier of the campaign that this ad group is associated with."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"state":{"type":"string","description":"The delivery state of the ad group.","enum":["enabled","paused","archived"]},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"creativeType":{"type":"string","nullable":false,"description":"\nThe type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided.|","example":"IMAGE","enum":["IMAGE","VIDEO"]},"servingStatus":{"type":"string","description":"The status of the ad group.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","ADGROUP_POLICING_PENDING_REVIEW","ADGROUP_POLICING_CREATIVE_REJECTED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"bidOptimization":{"type":"string","description":"Bid optimization type for the Adgroup. Default behavior is to optimize for clicks. Note, reach, clicks are only accepted with productAds that include landingPageURL OFF_AMAZON_LINK.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks [Default]|cpc|Optimize for page visits.|\n|conversions|cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"creationDate":{"type":"integer","description":"Epoch time the ad group was created.","format":"int64"},"lastUpdatedDate":{"description":"Epoch time any property in the ad group was last updated.","type":"integer","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/listAdGroupsEx","sectionHeader":{"type":3,"text":"GET /sd/adGroups/extended"},"summary":"Gets a list of ad groups with extended fields.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/extended/{adGroupId}",{"tags":["Ad Groups"],"summary":"Gets extended information for a requested ad group.","operationId":"getAdGroupResponseEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the requested ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","description":"Object containing an extended set of data fields for an Ad Group.","properties":{"adGroupId":{"type":"number","description":"The identifier of the ad group."},"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"number","description":"The identifier of the campaign that this ad group is associated with."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"state":{"type":"string","description":"The delivery state of the ad group.","enum":["enabled","paused","archived"]},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"creativeType":{"type":"string","nullable":false,"description":"\nThe type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided.|","example":"IMAGE","enum":["IMAGE","VIDEO"]},"servingStatus":{"type":"string","description":"The status of the ad group.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","ADGROUP_POLICING_PENDING_REVIEW","ADGROUP_POLICING_CREATIVE_REJECTED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"bidOptimization":{"type":"string","description":"Bid optimization type for the Adgroup. Default behavior is to optimize for clicks. Note, reach, clicks are only accepted with productAds that include landingPageURL OFF_AMAZON_LINK.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks [Default]|cpc|Optimize for page visits.|\n|conversions|cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"creationDate":{"type":"integer","description":"Epoch time the ad group was created.","format":"int64"},"lastUpdatedDate":{"description":"Epoch time any property in the ad group was last updated.","type":"integer","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Ad%20Groups/operation/getAdGroupResponseEx","sectionHeader":{"type":3,"text":"GET /sd/adGroups/extended/{adGroupId}"},"summary":"Gets extended information for a requested ad group.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds",{"tags":["Product Ads"],"summary":"Gets a list of product ads.","description":"Gets an array of ProductAd objects for a requested set of Sponsored Display product ads. Note that the ProductAd object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use a product ad operation that returns the ProductAdResponseEx object.","operationId":"listProductAds","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of product ads. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of ProductAd objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten product ad set `startIndex=0` and `count=10`. To return the next ten product ads, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only products ads associated with campaigns that have state set to one of the values in the comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"adIdFilter","in":"query","description":"Optional. The returned array includes only product ads with identifiers matching those in the comma-delimited string.","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional. The returned array is filtered to include only products ads associated with ad groups identifiers in the comma-delimited list.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array is filtered to include only product ads associated with the campaign identifiers in the comma-delimited list.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the campaign associated with the product ad.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adId":{"type":"integer","format":"int64","description":"The identifier of the product ad."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The Amazon ASIN of the product advertised by the product ad. This parameter is included in the response for sellers and vendors."},"sku":{"type":"string","description":"The Amazon SKU of the product advertised by the product ad. This parameter is included in the response for sellers."}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/listProductAds","sectionHeader":{"type":3,"text":"GET /sd/productAds"},"summary":"Gets a list of product ads.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds",{"tags":["Product Ads"],"summary":"Updates one or more product ads.","operationId":"updateProductAds","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of ProductAd objects. For each object, specify a product ad identifier and the only mutable field, `state`. Maximum length of the array is 100 objects.","content":{"application/json":{"schema":{"type":"array","items":{"required":["adId"],"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the campaign associated with the product ad.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adId":{"type":"integer","format":"int64","description":"The identifier of the product ad."}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adId":{"type":"number","description":"The identifier of the ad."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/updateProductAds","sectionHeader":{"type":3,"text":"PUT /sd/productAds"},"summary":"Updates one or more product ads.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds",{"tags":["Product Ads"],"summary":"Creates one or more product ads.","operationId":"createProductAds","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of ProductAd objects. For each object, specify required fields and their values. Required fields are `adGroupId` and `state`. Within any campaign, you must pass consistent fields of either `asin` (for vendors), `sku` (for sellers), or `landingPageURL` (when linking to other pages), these cannot be mixed for any given campaign. Maximum length of the array is 100 objects.","content":{"application/json":{"schema":{"type":"array","items":{"required":["campaignId","adGroupId","state"],"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the campaign associated with the product ad.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The ASIN of the product advertised by the product ad. Defined for vendors only."},"sku":{"type":"string","description":"The SKU of the product advertised by the product ad. Defined for seller accounts only."}}}]}},"examples":{"Vendor example":{"value":[{"state":"enabled","adGroupId":0,"campaignId":0,"asin":"B081FGSWTJ"}]},"Seller example":{"value":[{"state":"enabled","adGroupId":0,"campaignId":0,"sku":"sku-1234567"}]},"Off Amazon example":{"value":[{"state":"enabled","adGroupId":0,"campaignId":0,"landingPageURL":"https://advertising.amazon.com","landingPageType":"OFF_AMAZON_LINK","adName":"AmazonAdvertising"}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adId":{"type":"number","description":"The identifier of the ad."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/createProductAds","sectionHeader":{"type":3,"text":"POST /sd/productAds"},"summary":"Creates one or more product ads.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds/{adId}",{"tags":["Product Ads"],"summary":"Gets a requested product ad.","description":"Note that the ProductAd object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use a product ad operations that returns the ProductAdResponseEx object.","operationId":"getProductAd","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adId","in":"path","description":"The identifier of the requested product ad.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the campaign associated with the product ad.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adId":{"type":"integer","format":"int64","description":"The identifier of the product ad."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The Amazon ASIN of the product advertised by the product ad. This parameter is included in the response for sellers and vendors."},"sku":{"type":"string","description":"The Amazon SKU of the product advertised by the product ad. This parameter is included in the response for sellers."}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/getProductAd","sectionHeader":{"type":3,"text":"GET /sd/productAds/{adId}"},"summary":"Gets a requested product ad.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds/{adId}",{"tags":["Product Ads"],"summary":"Sets the status of a sproduct ad to archived.","description":"This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See [Developer Notes](https://advertising.amazon.com/API/docs/en-us/info/developer-notes#archiving) for more information.","operationId":"archiveProductAd","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adId","in":"path","description":"The identifier of the produce ad.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"adId":{"type":"number","description":"The identifier of the ad."}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/archiveProductAd","sectionHeader":{"type":3,"text":"DELETE /sd/productAds/{adId}"},"summary":"Sets the status of a sproduct ad to archived.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds/extended",{"tags":["Product Ads"],"summary":"Gets a list of product ads with extended fields.","description":"Gets an array of ProductAdResponseEx objects for a set of requested ad groups. The ProductAdResponseEx object includes the extended set of available fields.","operationId":"listProductAdsEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of product ads. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of ProduceAdEx objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten product ads set `startIndex=0` and `count=10`. To return the next ten campaigns, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only campaigns with state set to one of the values in the specified comma-delimited list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"adIdFilter","in":"query","description":"Optional. The returned array includes only product ads with identifiers matching those in the comma-delimited string.","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional. The returned array is filtered to include only products ads associated with ad groups identifiers in the comma-delimited list.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. The returned array is filtered to include only product ads associated with the campaign identifiers in the comma-delimited list.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"adId":{"type":"number","description":"The identifier of the ad."},"adGroupId":{"type":"number","description":"The identifier of the ad group associated with the ad."},"campaignId":{"type":"number","description":"The identifier of the campaign associated with the ad."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The ASIN of the product being advertised. This parameter is included in the response for sellers and vendors."},"sku":{"type":"string","description":"The SKU of the product being advertised. This parameter is included in the response for sellers."},"state":{"type":"string","description":"The state of the product ad.","enum":["enabled","paused","archived"]},"servingStatus":{"type":"string","description":"The status of the product ad.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_STATUS_LIVE","AD_STATUS_PAUSED","AD_STATUS_ARCHIVED","MISSING_IMAGE","MISSING_DECORATION","NOT_BUYABLE","NOT_IN_BUYBOX","OUT_OF_STOCK","NOT_IN_POLICY","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the product ad was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the product ad.","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/listProductAdsEx","sectionHeader":{"type":3,"text":"GET /sd/productAds/extended"},"summary":"Gets a list of product ads with extended fields.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/productAds/extended/{adId}",{"tags":["Product Ads"],"summary":"Gets extended information for a product ad.","operationId":"getProductAdResponseEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adId","in":"path","description":"The identifier of the requested product ad.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"adId":{"type":"number","description":"The identifier of the ad."},"adGroupId":{"type":"number","description":"The identifier of the ad group associated with the ad."},"campaignId":{"type":"number","description":"The identifier of the campaign associated with the ad."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The ASIN of the product being advertised. This parameter is included in the response for sellers and vendors."},"sku":{"type":"string","description":"The SKU of the product being advertised. This parameter is included in the response for sellers."},"state":{"type":"string","description":"The state of the product ad.","enum":["enabled","paused","archived"]},"servingStatus":{"type":"string","description":"The status of the product ad.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","AD_STATUS_LIVE","AD_STATUS_PAUSED","AD_STATUS_ARCHIVED","MISSING_IMAGE","MISSING_DECORATION","NOT_BUYABLE","NOT_IN_BUYBOX","OUT_OF_STOCK","NOT_IN_POLICY","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the product ad was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the product ad.","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Product%20Ads/operation/getProductAdResponseEx","sectionHeader":{"type":3,"text":"GET /sd/productAds/extended/{adId}"},"summary":"Gets extended information for a product ad.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/deny",{"tags":["Brand Safety List"],"summary":"Gets a list of websites/apps that are on the advertiser's Brand Safety Deny List.","description":"Gets an array of websites/apps that are on the advertiser's Brand Safety Deny List. It can take up to 15 minutes\nfrom the time a domain is added/deleted to the time it is reflected in the deny list.","operationId":"listDomains","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","required":false,"description":"Optional. Sets a cursor into the requested set of domains. Use in conjunction with the count parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.\n","schema":{"type":"integer","minimum":0}},{"name":"count","in":"query","required":false,"description":"Optional. Sets the number of domain objects in the returned array. Use in conjunction with the startIndex parameter to control pagination. For example, to return the first 1000 domains set startIndex=0 and count=1000. To return the next 1000 domains, set startIndex=1000 and count=1000, and so on. Defaults to max page size(1000).\n","schema":{"type":"integer","minimum":0,"maximum":1000}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"description":"Response for Brand Safety Deny List GET requests","properties":{"pagination":{"type":"object","description":"Response pagination info for Brand Safety Deny List GET requests","properties":{"total":{"type":"integer","description":"The total number of deny list domains created by the advertiser"},"limit":{"type":"integer","description":"The maximum number of deny list domains returned from GET request"},"offset":{"type":"integer","description":"The number of deny list domains skipped"}}},"domains":{"type":"array","description":"List of Brand Safety Deny List Domains","items":{"type":"object","properties":{"domainId":{"type":"integer","description":"The identifier of the Brand Safety List domain.","format":"int64"},"name":{"type":"string","description":"The website or app identifier. This can be in the form of full domain (eg. 'example.com' or 'example.net'), or mobile app identifier (eg. 'com.example.app' for Android apps or '1234567890' for iOS apps)\n","maxLength":250},"type":{"type":"string","description":"The domain type.","enum":["WEBSITE","APP"]},"state":{"type":"string","description":"The state of the domain.","enum":["ENABLED","ARCHIVED"],"default":"ENABLED"},"createdAt":{"type":"string","format":"date-time","description":"The date time the domain was created at. Format YYYY-MM-ddT:HH:mm:ssZ","example":"2018-09-16T11:43:21Z"},"lastModified":{"type":"string","format":"date-time","description":"The date time the domain was last modified. Format YYYY-MM-ddT:HH:mm:ssZ","example":"2018-09-16T11:43:21Z"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/listDomains","sectionHeader":{"type":3,"text":"GET /sd/brandSafety/deny"},"summary":"Gets a list of websites/apps that are on the advertiser's Brand Safety Deny List.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/deny",{"tags":["Brand Safety List"],"summary":"Creates one or more domains to add to a Brand Safety Deny List.\n","description":"Creates one or more domains to add to a Brand Safety Deny List. The Brand Safety Deny List is at the advertiser level. It can take up to 15 minutes from the time a domain is added to the time it is reflected in the deny list.\n","operationId":"createBrandSafetyDenyListDomains","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of Brand Safety List Domain objects. For each object, specify required fields and their values. Maximum length of the array is 10,000 objects.\n","required":true,"content":{"application/json":{"schema":{"description":"POST Request for Brand Safety","required":["domains"],"properties":{"domains":{"type":"array","minItems":1,"maxItems":10000,"items":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The website or app identifier. This can be in the form of full domain (eg. 'example.com' or 'example.net'), or mobile app identifier (eg. 'com.example.app' for Android apps or '1234567890' for iOS apps)\n","maxLength":250},"type":{"type":"string","description":"The domain type.","enum":["WEBSITE","APP"]}},"example":{"name":"example.com","type":"WEBSITE"}}}}}}}},"responses":{"202":{"description":"Request has been accepted for processing.","content":{"application/json":{"schema":{"description":"Response for Brand Safety POST and DELETE requests","properties":{"requestId":{"type":"string","description":"The identifier of the request"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/createBrandSafetyDenyListDomains","sectionHeader":{"type":3,"text":"POST /sd/brandSafety/deny"},"summary":"Creates one or more domains to add to a Brand Safety Deny List.\n","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/deny",{"tags":["Brand Safety List"],"summary":"Archives all of the domains in the Brand Safety Deny List.\n","description":"Archives all of the domains in the Brand Safety Deny List. It can take several hours from the time a domain is deleted to the time it is reflected in the deny list. You can check the status of the delete request by calling GET /sd/brandSafety/{requestId}/status. If the status is \"COMPLETED\", you can call GET /sd/brandSafety/deny to validate that your deny list has been successfully deleted.\n","operationId":"deleteBrandSafetyDenyList","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Request has been accepted for processing.","content":{"application/json":{"schema":{"description":"Response for Brand Safety POST and DELETE requests","properties":{"requestId":{"type":"string","description":"The identifier of the request"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/deleteBrandSafetyDenyList","sectionHeader":{"type":3,"text":"DELETE /sd/brandSafety/deny"},"summary":"Archives all of the domains in the Brand Safety Deny List.\n","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/v2/reports/{reportId}",{"tags":["Reports"],"summary":"Gets the status of a report previously requested.","description":"Uses the `reportId` value from the response of a report previously requested via `POST` method of the `/sd/{recordType}/report` operation.\n\n**To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).**","operationId":"getReportStatus","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"reportId","in":"path","description":"The identifier of the requested report.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"type":"string","description":"The identifier of the report."},"recordType":{"type":"string","description":"The type of report requested.","enum":["CAMPAIGN","AD_GROUP","PRODUCT_AD"]},"status":{"type":"string","description":"The build status of the report.","enum":["IN_PROGRESS","SUCCESS","FAILURE"]},"statusDetails":{"description":"A human-readable description of the current status.","type":"string"},"location":{"type":"string","description":"The URI location of the report."},"fileSize":{"type":"integer","description":"The size of the report file, in bytes.","format":"int64"},"expiration":{"type":"integer","description":"Epoch date of the expiration of the URI in the `location` property.","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Reports/operation/getReportStatus","sectionHeader":{"type":3,"text":"GET /v2/reports/{reportId}"},"summary":"Gets the status of a report previously requested.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/v2/reports/{reportId}/download",{"tags":["Reports"],"summary":"Downloads a previously requested report identified by reportId.","description":"Gets a `307 Temporary Redirect` response that includes a `location` header with the value set to an AWS S3 path where the report is located. The path expires after 30 seconds. If the path expires before the report is downloaded, a new report request must be created.\n\n**To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).**","operationId":"downloadReport","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"reportId","in":"path","description":"The identifier of the requested report.","required":true,"schema":{"type":"string"}}],"responses":{"307":{"description":"Successful operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Redirect URI with S3 file location containing report data"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Reports/operation/downloadReport","sectionHeader":{"type":3,"text":"GET /v2/reports/{reportId}/download"},"summary":"Downloads a previously requested report identified by reportId.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/{recordType}/report",{"tags":["Reports"],"summary":"Creates a report request.","deprecated":true,"description":"**To understand the call flow for asynchronous reports, see [Getting started with sponsored ads reports](/API/docs/en-us/guides/reporting/v2/sponsored-ads-reports).**\n\nThe Sponsored Display API supports creation of reports for campaigns, ad groups, product ads, targets, and asins. Create a ReportRequest object specifying the fields corresponding to performance data metrics to include in the report.","operationId":"requestReport","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"recordType","in":"path","description":"The type of report to generate, either `campaigns`, `adGroups`, `productAds`, `targets`, or `asins`. The 'asins' report, also known as the Purchased products report, is only available for seller brand owners.","required":true,"schema":{"type":"string","enum":["campaigns","adGroups","productAds","targets","asins"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reportDate":{"type":"string","description":"Date in YYYYMMDD format. The report contains only metrics generated on the specified date. Note that the time zone used for date calculation is the one associated with the profile used to make the request.","example":"20190401"},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"segment":{"type":"string","description":"Optional. A dimension used to further segment certain types of reports.\n\nNote: matchedTarget reports only return targets that have generated at least one click.\n| Dimension | Report types | Tactics | Metrics | Description |\n|---------|------------------|-------------|-------------|------------|\n| matchedTarget | campaigns, adGroups, targets | T00020, T00030 | Existing metrics for each report type are accepted. |  Segments a report based on the ASIN of the product page where the ad appeared.|","example":"matchedTarget","enum":["matchedTarget"]},"metrics":{"type":"string","description":"A comma-separated list of the metrics to be included in the report.\n\nEach report type supports different metrics. **To understand supported metrics for each report type, see [Report types](/API/docs/en-us/guides/reporting/v2/report-types).**\n\n**Note**: Campaigns with vCPM costType should use view+click based metrics (viewAttributedConversions14d, viewAttributedDetailPageView14d, viewAttributedSales14d, viewAttributedUnitsOrdered14d, viewImpressions).\n\n**Note**: Detail page view metrics (attributedDetailPageView14d, viewAttributedDetailPageView14d) have an SLA of 3 days.\n\n**Tip**: Use new-to-brand (NTB) metrics to calculate how efficient your campaigns are at driving new shoppers:\n\n  1. Percentage of NTB orders = attributedOrdersNewToBrand14d / attributedConversions14d\n  2. Percentage NTB sales = attributedSalesNewToBrand14d / attributedSales14d\n  3. Percentage NTB units = attributedUnitsOrderedNewToBrand14d / attributedUnitsOrdered14d\n  4. NTB order rate = attributedOrdersNewToBrand14 / impressions","example":"campaignName,campaignId,impressions,clicks,cost,attributedSales14d"}}}}},"required":false},"responses":{"202":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"type":"string","description":"The identifier of the report."},"recordType":{"type":"string","description":"The type of report requested.","enum":["CAMPAIGN","AD_GROUP","PRODUCT_AD"]},"status":{"type":"string","description":"The build status of the report.","enum":["IN_PROGRESS","SUCCESS","FAILURE"]},"statusDetails":{"description":"A human-readable description of the current status.","type":"string"},"location":{"type":"string","description":"The URI location of the report."},"fileSize":{"type":"integer","description":"The size of the report file, in bytes.","format":"int64"},"expiration":{"type":"integer","description":"Epoch date of the expiration of the URI in the `location` property.","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"406":{"description":"Not acceptable - Failed due to report date being too far in the past.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable entity - Failed due to invalid parameters.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Reports/operation/requestReport","sectionHeader":{"type":3,"text":"POST /sd/{recordType}/report"},"summary":"Creates a report request.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets",{"tags":["Targeting"],"summary":"Gets a list of targeting clauses.","description":"Gets a list of targeting clauses objects for a requested set of Sponsored Display targets. Note that the Targeting Clause object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the target operations that return the TargetingClauseEx object.","operationId":"listTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. 0-indexed record offset for the result set. Defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Number of records to include in the paged response. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. Restricts results to those with `state` set to values in the specified comma-separated list.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"targetIdFilter","in":"query","description":"Optional. Restricts results to ads with the specified `tagetId` specified in comma-separated list","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional list of comma separated adGroupIds. Restricts results to targeting clauses with the specified `adGroupId`.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. Restricts results to targeting clauses within campaigns specified in comma-separated list.","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the [\"Bid constraints by marketplace\" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.","format":"float","nullable":true,"minimum":0.02}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"expressionType":{"type":"string","enum":["manual","auto"],"description":"Tactic T00020 & T00030 ad groups should use 'manual' targeting."},"expression":{"type":"array","description":"The targeting expression to match against.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"resolvedExpression":{"type":"array","description":"The resolved targeting expression.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}]}},"example":{"targetId":123,"adGroupId":321,"campaignId":234,"state":"enabled","expressionType":"manual","bid":1.5,"expression":{"type":"asinSameAs","value":"B0123456789"},"resolvedExpression":{"type":"asinSameAs","value":"B0123456789"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/listTargetingClauses","sectionHeader":{"type":3,"text":"GET /sd/targets"},"summary":"Gets a list of targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets",{"tags":["Targeting"],"summary":"Updates one or more targeting clauses.","description":"Updates one or more targeting clauses. Targeting clauses are identified using their targetId. The mutable fields are `bid` and `state`. Maximum length of the array is 100 objects.","operationId":"updateTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of up to 1000 targeting clauses. Mutable fields:\n* `state`\n* `bid` (only mutable when the targeting clause's adGroup does not have any enabled optimization rule)","content":{"application/json":{"schema":{"type":"array","items":{"required":["targetId"],"allOf":[{"type":"object","properties":{"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the [\"Bid constraints by marketplace\" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.","format":"float","nullable":true,"minimum":0.02}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/updateTargetingClauses","sectionHeader":{"type":3,"text":"PUT /sd/targets"},"summary":"Updates one or more targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets",{"tags":["Targeting"],"summary":"Creates one or more targeting clauses.","description":"Successfully created targeting clauses are assigned a unique `targetId` value.\n\nCreate new targeting clauses for **both** Audience and Contextual campaigns with tactic 'T00030' using the above and the following:\n| Contextual targeting clause | Description |\n|------------------|-------------|\n| similarProduct | Dynamic segment to target products that are similar to the advertised asin. We recommend using 'similarProduct' targeting for all adGroups. |\n| asinSameAs=B0123456789 | Target this product. |\n| asinCategorySameAs=12345 | Target products in the category. |\n| asinCategorySameAs=12345 asinBrandSameAs=45678 | Target products in the category and brand. |\n\n**Refinements:**\n- asinBrandSameAs\n- asinPriceBetween\n- asinPriceGreaterThan\n- asinPriceLessThan\n- asinReviewRatingLessThan\n- asinReviewRatingGreaterThan\n- asinReviewRatingBetween\n- asinIsPrimeShippingEligible\n- asinAgeRangeSameAs\n- asinGenreSameAs\n\n**Refinement Notes:**\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* 'similarProduct' has no expression value or refinements.\n\n| Audience targeting clause | Description |\n|------------------|-------------|\n| views(exactProduct lookback=30) | Target an audience that has viewed the advertised asins in the past 7,14,30,60, or 90 days. Note: This target should only be used for productAds with SKU or ASIN. |\n| views(similarProduct lookback=60) | Target an audience that has viewed similar products to the advertised asins in the past 7,14,30,60, or 90 days. Note: This target should only be used for productAds with SKU or ASIN.|\n| views(asinCategorySameAs=12345 lookback=90) | Target an audience that has viewed products in the given category in the past 7,14,30,60, or 90 days. |\n| views(asinCategorySameAs=12345 asinBrandSameAs=45678 asinPriceBetween=50-100 lookback=60) | Target an audience that has viewed products in the given category, brand, and price range in the past 7,14,30,60, or 90 days. |\n| purchases(relatedProduct lookback=180) | Target an audience that has purchased a related product in the past 7,14,30,60,90,180 or 365 days. Note: This target should only be used for productAds with SKU or ASIN.|\n| purchases(exactProduct lookback=365) | Target an audience that has purchased the advertised asins in the past 7,14,30,60,90,180 or 365 days. Note: This target should only be used for productAds with SKU or ASIN.|\n| purchases(asinCategorySameAs=12345 asinBrandSameAs=45678 asinPriceBetween=50-100 lookback=90) | Target an audience that has purchased products in the given category, brand, and price range in the past 7,14,30,60,90,180 or 365 days |\n| audiencesLikelyInterestedInAd | Dynamic segment to target audiences that are likely to consider and buy from your business. We recommend that you add this segment to all of your campaigns to help you achieve greater reach and campaign scale. Note: this is only supported when using landingPageType of OFF_AMAZON_LINK |\n| audience(audienceSameAs=12345) | Target the given Amazon Audience. |\n\n| Content targeting clause | Description |\n|------------------|-------------|\n| contentCategorySameAs=amzn1.iab-content.325 | Target an audience that has engaged with or shown interest in the given entertainment category. |\n\nNotes on content targeting:\n* The `contentCategorySameAs` targeting predicate is required\n* For all iab categories, see [Discovering entertainment target categories](https://advertising.amazon.com/API/docs/en-us/guides/sponsored-display/entertainment-targeting#discovering-entertainment-target-categories).\n\nNote:\n1. You can still create new targeting clauses for Contextual campaigns with tactic 'T00020' using the Contextual clauses above.\n2. There is a limit of 200 targeting clauses per request for T00030.\n3. There is a limit of 1000 targeting clauses per request for T00020.\n4. There is a total limit of 1000 targeting clauses per ad group.\n5. If you receive the error of \"Cannot create targeting clause: audience size is too small\", please expand or broaden your targeting clause to increase the audience size.","operationId":"createTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of targeting clauses for creation.","content":{"application/json":{"schema":{"type":"array","items":{"required":["adGroupId","expressionType","expression"],"allOf":[{"type":"object","properties":{"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the [\"Bid constraints by marketplace\" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.","format":"float","nullable":true,"minimum":0.02}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expressionType":{"type":"string","enum":["manual","auto"],"description":"Tactic T00020 ad groups only allow manual targeting."},"expression":{"type":"array","description":"The targeting expression to match against.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}],"example":{"expression":[{"type":"views","value":[{"type":"similarProduct"},{"type":"lookback","value":"30"}]}],"bid":"1.25","adGroupId":209426065351234,"expressionType":"manual","state":"enabled"}}}}},"required":false},"responses":{"207":{"description":"multi-status","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/createTargetingClauses","sectionHeader":{"type":3,"text":"POST /sd/targets"},"summary":"Creates one or more targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/{targetId}",{"tags":["Targeting"],"summary":"Gets a targeting clause specified by identifier.","description":"This call returns the minimal set of targeting clause fields.","operationId":"getTargets","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"targetId","in":"path","description":"The identifier of a targeting clause.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the [\"Bid constraints by marketplace\" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.","format":"float","nullable":true,"minimum":0.02}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"expressionType":{"type":"string","enum":["manual","auto"],"description":"Tactic T00020 & T00030 ad groups should use 'manual' targeting."},"expression":{"type":"array","description":"The targeting expression to match against.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"resolvedExpression":{"type":"array","description":"The resolved targeting expression.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}]},"example":{"targetId":123,"adGroupId":321,"campaignId":234,"state":"enabled","expressionType":"manual","bid":1.5,"expression":{"type":"asinSameAs","value":"B0123456789"},"resolvedExpression":{"type":"asinSameAs","value":"B0123456789"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/getTargets","sectionHeader":{"type":3,"text":"GET /sd/targets/{targetId}"},"summary":"Gets a targeting clause specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/{targetId}",{"tags":["Targeting"],"summary":"Sets the `state` of a targeting clause to `archived`.","description":"Equivalent to using the `updateTargetingClauses` operation to set the `state` property of a targeting clause to `archived`. See [Developer\nNotes](http://advertising.amazon.com/API/docs/guides/developer_notes#Archiving) for more information.","operationId":"archiveTargetingClause","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"targetId","in":"path","description":"The identifer of a targeting clause.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/archiveTargetingClause","sectionHeader":{"type":3,"text":"DELETE /sd/targets/{targetId}"},"summary":"Sets the `state` of a targeting clause to `archived`.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/extended",{"tags":["Targeting"],"summary":"Gets a list of targeting clause objects with extended fields.","description":"Gets an array of TargetingClauseEx objects for a set of requested targets. Note that this call returns the full set of targeting clause extended fields, but is less efficient than getTargets.","operationId":"listTargetingClausesEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. 0-indexed record offset for the result set. Defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Number of records to include in the paged response. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. Restricts results to keywords with state within the specified comma-separated list. Must be one of: `enabled`, `paused`, or `archived`. Default behavior is to include enabled, paused, and archived.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"targetIdFilter","in":"query","description":"Optional. Restricts results to ads with the specified `tagetId` specified in comma-separated list","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional list of comma separated adGroupIds. Restricts results to targeting clauses with the specified `adGroupId`.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. Restricts results to ads within campaigns specified in comma-separated list.","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"number"},"adGroupId":{"type":"number"},"campaignId":{"type":"number"},"state":{"type":"string","enum":["enabled","paused","archived"]},"expressionType":{"type":"string","enum":["auto","manual"]},"bid":{"type":"number","description":"If a value for `bid` is specified, it overrides the current adGroup bid. When using vcpm costType. $1 is the minimum bid for vCPM. Note that this field is ignored for negative targeting clauses."},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual or content targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can contain 'TargetingPredicate' or 'ContentTargetingPredicate' components.\n* Contextual expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"resolvedExpression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual or content targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can contain 'TargetingPredicate' or 'ContentTargetingPredicate' components.\n* Contextual expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"servingStatus":{"type":"string","description":"The status of the target.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","TARGET_STATUS_LIVE","TARGET_STATUS_PAUSED","TARGET_STATUS_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the target was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the target.","format":"int64"}}}},"example":{"targetId":123,"adGroupId":321,"campaignId":234,"state":"enabled","expressionType":"manual","bid":1.5,"expression":{"type":"asinSameAs","value":"B0123456789"},"resolvedExpression":{"type":"asinSameAs","value":"B0123456789"},"servingStatus":"TARGET_STATUS_PAUSED","creationDate":1537568785000,"lastUpdateDate":1537568785000}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/listTargetingClausesEx","sectionHeader":{"type":3,"text":"GET /sd/targets/extended"},"summary":"Gets a list of targeting clause objects with extended fields.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/extended/{targetId}",{"tags":["Targeting"],"summary":"Gets extended information for a targeting clause.","description":"Gets a targeting clause object with extended fields. Note that this call returns the full set of targeting clause extended fields, but is less efficient than getTarget.","operationId":"getTargetsEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"targetId","in":"path","description":"The identifier of a targeting clause.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"number"},"adGroupId":{"type":"number"},"campaignId":{"type":"number"},"state":{"type":"string","enum":["enabled","paused","archived"]},"expressionType":{"type":"string","enum":["auto","manual"]},"bid":{"type":"number","description":"If a value for `bid` is specified, it overrides the current adGroup bid. When using vcpm costType. $1 is the minimum bid for vCPM. Note that this field is ignored for negative targeting clauses."},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual or content targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can contain 'TargetingPredicate' or 'ContentTargetingPredicate' components.\n* Contextual expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"resolvedExpression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual or content targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can contain 'TargetingPredicate' or 'ContentTargetingPredicate' components.\n* Contextual expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"servingStatus":{"type":"string","description":"The status of the target.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","TARGET_STATUS_LIVE","TARGET_STATUS_PAUSED","TARGET_STATUS_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the target was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the target.","format":"int64"}}},"example":{"targetId":123,"adGroupId":321,"campaignId":234,"state":"enabled","expressionType":"manual","bid":1.5,"expression":{"type":"asinSameAs","value":"B0123456789"},"resolvedExpression":{"type":"asinSameAs","value":"B0123456789"},"servingStatus":"TARGET_STATUS_PAUSED","creationDate":1537568785000,"lastUpdateDate":1537568785000}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting/operation/getTargetsEx","sectionHeader":{"type":3,"text":"GET /sd/targets/extended/{targetId}"},"summary":"Gets extended information for a targeting clause.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/recommendations",{"tags":["Targeting Recommendations"],"operationId":"getTargetRecommendations","summary":"Returns a set of recommended products and categories to target","description":"This API provides product, category and standard audience recommendations to target based on the list of input ASINs. Allow 1 week for our systems to process data for any new ASINs listed on Amazon before using this service. Note -  recommendations are only available for productAds with SKU or ASIN.\n\nFor API v3.0, the API returns up to 100 recommendations for contextual targeting.\n\nFor API v3.1, the API returns up to 100 recommendations for both product and category targeting.\n\nFor API v3.2, the API introduces contextual targeting themes in the request and returns product recommendations based on different targeting themes.\n\nFor API v3.3, the API introduces standard audience recommendations and translated category recommendations based on locale.\n\nFor API v3.4, the API includes the theme expression used in contextual targeting recommendations in the response.\n\n[PREVIEW ONLY] For API v3.5, the API supports recommendations for landing pages for audience targeting with tactic T00030.\nThe API also supports entertainment targeting recommendations. Both features are currently limited to US marketplace.\n\nThe currently available tactic identifiers are:\n\n|Tactic Name|Type|Description|\n|-----------|----|-----------|\n|T00020&nbsp;|Contextual Targeting|Products: Choose individual products to show your ads in placements related to those products.|\n|T00030&nbsp;|Audiences or Contextual Targeting| Select individual products, categories, refined categories, or audiences to show your ads.|","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"The requested locale from query parameter to return translated category recommendations.","required":false,"schema":{"type":"string","description":"List of supported locales.","enum":["ar_AE","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_ES","es_MX","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN"]}}],"requestBody":{"content":{"application/vnd.sdtargetingrecommendations.v3.5+json":{"schema":{"description":"Request for targeting recommendations for API version 3.5.","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|\n        |T00030&nbsp;|Audiences or Contextual Targeting &nbsp;|Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"products":{"description":"A list of products for which to get targeting recommendations. This array can only contain either asins or landing pages. If landingPageUrl is used,\nthere can only be one item in the array for each request.","type":"array","minItems":1,"maxItems":10000,"items":{"description":"Product that advertisers want to advertise. Recommendations will be made for specified products. SDAdvertisedProduct can only contain either asins or landing pages. If landingPageUrl is used, there can only be one item for each request.","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is not supported when using asin field.","enum":["OFF_AMAZON_LINK"]},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if landingPageType field is set.\nThis field is not supported when using asin field.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com.|"}},"example":[{"asin":"B00PN11UNW"}]},"example":[{"asin":"B00PN11UNW"}]},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":3,"example":["PRODUCT","CATEGORY","AUDIENCE","CONTENT_CATEGORY"],"items":{"type":"string","description":"Signifies a type of recommendation. PRODUCT, CATEGORY, and CONTENT_CATEGORY are supported by tactic T00020. CATEGORY, AUDIENCE, and CONTENT_CATEGORY are supported by tactic T00030.","example":"PRODUCT","enum":["PRODUCT","CATEGORY","AUDIENCE","CONTENT_CATEGORY"]}},"themes":{"type":"object","description":"The themes used to refine the recommendations. Currently only contextual targeting themes are supported.","properties":{"product":{"type":"array","minItems":0,"maxItems":5,"description":"A list of themes for product targeting recommendations. If this list is empty, the service will return all the current available theme recommendations. Recommendations will be returned for each theme. If specified, each theme should only include unique expressions.","items":{"type":"object","description":"Contextual targeting theme definitions.","required":["name","expression"],"properties":{"name":{"type":"string","description":"This is the meaningful theme name which will be used as a unique identifier across various themes in the same request.\nThis identifier will also be used to map the recommendations back to the theme in the response body.\nNote: the value for this field cannot be \"default\" as that's a reserved keyword in the system.","minLength":1,"maxLength":100,"pattern":"^(?!default$)"},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the contextual targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: Currently the service only supports one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}}}}}}},"categoryType":{"type":"string","description":"This field is optional unless the field locationExpression is present in the request. It is used for category audience targeting\nto specify if the audience is for views (re-marketing) or purchases (re-purchasing). The specified categories will be returned accordingly.","enum":["views","purchases"]},"locationExpression":{"description":"This optional field is used to specify the locations used in SD location targeting for non-Amazon sellers only at the moment.\nTherefore it's only supported if the product is a landing page url.","type":"array","minItems":1,"maxItems":20,"items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.","example":"amzn1.ad-geo.XHvCjcKHXmJ7woVowo7CjmvCjcKWbMKHwp3CsGvCk8KrcmstQ2l0eQ=="}}}}}}},"application/vnd.sdtargetingrecommendations.v3.4+json":{"schema":{"description":"Request for targeting recommendations for API version 3.4.","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|\n        |T00030&nbsp;|Audiences or Contextual Targeting &nbsp;|Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"products":{"type":"array","description":"A list of products for which to get targeting recommendations","minItems":1,"maxItems":10000,"items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":2,"example":["PRODUCT","CATEGORY","AUDIENCE"],"items":{"type":"string","description":"Signifies a type of recommendation. PRODUCT and CATEGORY are supported by tactic T00020. CATEGORY and AUDIENCE are supported by tactic T00030.","example":"PRODUCT","enum":["PRODUCT","CATEGORY","AUDIENCE"]}},"themes":{"type":"object","description":"The themes used to refine the recommendations. Currently only contextual targeting themes are supported.","properties":{"product":{"type":"array","minItems":0,"maxItems":5,"description":"A list of themes for product targeting recommendations. If this list is empty, the service will return all the current available theme recommendations. Recommendations will be returned for each theme. If specified, each theme should only include unique expressions.","items":{"type":"object","description":"Contextual targeting theme definitions.","required":["name","expression"],"properties":{"name":{"type":"string","description":"This is the meaningful theme name which will be used as a unique identifier across various themes in the same request.\nThis identifier will also be used to map the recommendations back to the theme in the response body.\nNote: the value for this field cannot be \"default\" as that's a reserved keyword in the system.","minLength":1,"maxLength":100,"pattern":"^(?!default$)"},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the contextual targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: Currently the service only supports one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.3+json":{"schema":{"description":"Request for targeting recommendations for API version 3.3.","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|\n        |T00030&nbsp;|Audiences or Contextual Targeting &nbsp;|Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"products":{"type":"array","description":"A list of products for which to get targeting recommendations","minItems":1,"maxItems":10000,"items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":2,"example":["PRODUCT","CATEGORY","AUDIENCE"],"items":{"type":"string","description":"Signifies a type of recommendation. PRODUCT and CATEGORY are supported by tactic T00020. CATEGORY and AUDIENCE are supported by tactic T00030.","example":"PRODUCT","enum":["PRODUCT","CATEGORY","AUDIENCE"]}},"themes":{"type":"object","description":"The themes used to refine the recommendations. Currently only contextual targeting themes are supported.","properties":{"product":{"type":"array","minItems":0,"maxItems":5,"description":"A list of themes for product targeting recommendations. If this list is empty, the service will return all the current available theme recommendations. Recommendations will be returned for each theme. If specified, each theme should only include unique expressions.","items":{"type":"object","description":"Contextual targeting theme definitions.","required":["name","expression"],"properties":{"name":{"type":"string","description":"This is the meaningful theme name which will be used as a unique identifier across various themes in the same request.\nThis identifier will also be used to map the recommendations back to the theme in the response body.\nNote: the value for this field cannot be \"default\" as that's a reserved keyword in the system.","minLength":1,"maxLength":100,"pattern":"^(?!default$)"},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the contextual targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: Currently the service only supports one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.2+json":{"schema":{"description":"Request for targeting recommendations for API version 3.2.","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|\n        |T00030&nbsp;|Audiences or Contextual Targeting &nbsp;|Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"products":{"type":"array","description":"A list of products for which to get targeting recommendations","minItems":1,"maxItems":10000,"items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":2,"example":["PRODUCT","CATEGORY"],"items":{"type":"string","description":"Signifies a type of recommendation","example":"PRODUCT","enum":["PRODUCT","CATEGORY"]}},"themes":{"type":"object","description":"The themes used to refine the recommendations. Currently only contextual targeting themes are supported.","properties":{"product":{"type":"array","minItems":0,"maxItems":5,"description":"A list of themes for product targeting recommendations. If this list is empty, the service will return all the current available theme recommendations. Recommendations will be returned for each theme. If specified, each theme should only include unique expressions.","items":{"type":"object","description":"Contextual targeting theme definitions.","required":["name","expression"],"properties":{"name":{"type":"string","description":"This is the meaningful theme name which will be used as a unique identifier across various themes in the same request.\nThis identifier will also be used to map the recommendations back to the theme in the response body.\nNote: the value for this field cannot be \"default\" as that's a reserved keyword in the system.","minLength":1,"maxLength":100,"pattern":"^(?!default$)"},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the contextual targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: Currently the service only supports one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.1+json":{"schema":{"description":"Request for targeting recommendations","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.|\n        |T00030&nbsp;|Audiences or Contextual Targeting &nbsp;|Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"products":{"type":"array","description":"A list of products for which to get targeting recommendations","minItems":1,"maxItems":10000,"items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":2,"example":["PRODUCT","CATEGORY"],"items":{"type":"string","description":"Signifies a type of recommendation","example":"PRODUCT","enum":["PRODUCT","CATEGORY"]}}}}},"application/vnd.sdtargetingrecommendations.v3.0+json":{"schema":{"description":"Request for targeting recommendations","required":["tactic","products","typeFilter"],"properties":{"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n        |-----------|-----|-----------|\n        |T00020 &nbsp;    |Products&nbsp;| Products: Choose individual products to show your ads in placements related to those products.<br>Categories: Choose individual categories to show your ads in placements related to those categories.","example":"T00030","enum":["T00020"]},"products":{"type":"array","minItems":1,"maxItems":10000,"description":"A list of products for which to get targeting recommendations","items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"typeFilter":{"type":"array","description":"A filter to indicate which types of recommendations to request.","minItems":1,"maxItems":1,"items":{"type":"string","description":"Signifies a type of recommendation","example":"PRODUCT","enum":["PRODUCT"]}}}}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.sdtargetingrecommendations.v3.5+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"description":"For v3.5 the service will continue to return the recommendations returned for v3.4, return Entertainment targeting recommendations if requested and return asin-less recommendations if a landing page URL was passed in the request","type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}},"categories":{"type":"array","description":"List of recommended category targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended category to target ads on","properties":{"category":{"type":"integer","description":"The category identifier","example":7352105011},"name":{"type":"string","description":"The category name"},"translatedName":{"type":"string","description":"The translated category name by requested locale, field will not be provided if locale is not provided or campaign localization service is down."},"path":{"type":"array","description":"The path of the category within the category catalogue.","minItems":1,"items":{"type":"string"}},"translatedPath":{"type":"array","description":"The translated path of the category within the category catalogue by requested locale, field will not be provided if locale is not provided or campaign localization is down.","minItems":1,"items":{"type":"string"}},"targetableAsinCountRange":{"type":"object","description":"The range of ASINs available within the category catalogue.","properties":{"rangeLower":{"type":"integer"},"rangeUpper":{"type":"integer"}}},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation.","minimum":1}}}},"audiences":{"type":"array","description":"List of recommended audience targets, broken down by audience category","minItems":0,"maxItems":10,"items":{"description":"List of recommended standard Amazon audience targets of a specific audience category","properties":{"category":{"type":"string","description":"An audience category determines the goal of the audience such as In-market, Interest, Lifestyle and Life Event","example":"In-Market","enum":["In-market","Lifestyle","Interest","Life event"]},"audiences":{"type":"array","description":"List of recommended standard Amazon audience targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended standard Amazon audience to target ads on","properties":{"audience":{"type":"string","description":"The audience identifier","example":417464173123977660},"name":{"type":"string","description":"The Amazon audience name"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}}},"contentCategories":{"type":"array","description":"List of recommended entertainment targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended content category to target ads on","properties":{"contentCategory":{"type":"string","description":"The content category value","example":"amzn1.iab-content.647"},"name":{"type":"string","description":"The content category name","example":"Drama"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}},"themes":{"type":"object","properties":{"themes":{"properties":{"products":{"type":"array","description":"A list of contextual targeting theme recommendations.","minItems":1,"maxItems":5,"items":{"oneOf":[{"type":"object","description":"Recommendation results for contextual targeting.","properties":{"code":{"type":"string","description":"HTTP status code 200 indicating a successful response for product recommendations.","example":200},"name":{"type":"string","description":"The theme name specified in the request."},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the product targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: currently the service only support one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}},"recommendations":{"type":"array","description":"A list of recommended products.","minItems":1,"maxItems":100,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}]}}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.4+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"description":"For v3.4 the service will continue to return the recommendations returned for v3.2, return audience recommendations if requested, and return the theme expression used in product targeting if requested.","type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}},"categories":{"type":"array","description":"List of recommended category targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended category to target ads on","properties":{"category":{"type":"integer","description":"The category identifier","example":7352105011},"name":{"type":"string","description":"The category name"},"translatedName":{"type":"string","description":"The translated category name by requested locale, field will not be provided if locale is not provided or campaign localization service is down."},"path":{"type":"array","description":"The path of the category within the category catalogue.","minItems":1,"items":{"type":"string"}},"translatedPath":{"type":"array","description":"The translated path of the category within the category catalogue by requested locale, field will not be provided if locale is not provided or campaign localization is down.","minItems":1,"items":{"type":"string"}},"targetableAsinCountRange":{"type":"object","description":"The range of ASINs available within the category catalogue.","properties":{"rangeLower":{"type":"integer"},"rangeUpper":{"type":"integer"}}},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation.","minimum":1}}}},"audiences":{"type":"array","description":"List of recommended audience targets, broken down by audience category","minItems":0,"maxItems":10,"items":{"description":"List of recommended standard Amazon audience targets of a specific audience category","properties":{"category":{"type":"string","description":"An audience category determines the goal of the audience such as In-market, Interest, Lifestyle and Life Event","example":"In-Market","enum":["In-market","Lifestyle","Interest","Life event"]},"audiences":{"type":"array","description":"List of recommended standard Amazon audience targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended standard Amazon audience to target ads on","properties":{"audience":{"type":"string","description":"The audience identifier","example":417464173123977660},"name":{"type":"string","description":"The Amazon audience name"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}}},"themes":{"type":"object","properties":{"themes":{"properties":{"products":{"type":"array","description":"A list of contextual targeting theme recommendations.","minItems":1,"maxItems":5,"items":{"oneOf":[{"type":"object","description":"Recommendation results for contextual targeting.","properties":{"code":{"type":"string","description":"HTTP status code 200 indicating a successful response for product recommendations.","example":200},"name":{"type":"string","description":"The theme name specified in the request."},"expression":{"type":"array","minItems":1,"maxItems":1,"description":"A list of expressions defining the product targeting theme. The list will define an AND operator on different expressions.\nFor example, asinPriceGreaterThan and asinReviewRatingLessThan can be used to request product recommendations\nwhich are both with greater price and less review rating compared to the goal products.\nNote: currently the service only support one item in the array.","items":{"type":"object","description":"The expression used to define the contextual targeting theme.","required":["type"],"properties":{"type":{"type":"string","description":"The contextual targeting grammar used to define the targeting theme. Note asinAsBestSeller is currently not supported.","enum":["asinPriceGreaterThan","asinBrandSameAs","asinReviewRatingLessThan","asinGlanceViewsGreaterThan"]}}}},"recommendations":{"type":"array","description":"A list of recommended products.","minItems":1,"maxItems":100,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}]}}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.3+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"description":"For v3.3 the service will continue to return the recommendations returned for v3.2, and return audience recommendations if requested.","allOf":[{"type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}},{"type":"object","properties":{"categories":{"type":"array","description":"List of recommended category targets.","minItems":0,"maxItems":1000,"items":{"description":"A recommended category to target ads on","properties":{"category":{"type":"integer","description":"The category identifier","example":7352105011},"name":{"type":"string","description":"The category name"},"translatedName":{"type":"string","description":"The translated category name by requested locale, field will not be provided if locale is not provided or campaign localization service is down."},"path":{"type":"array","description":"The path of the category within the category catalogue.","minItems":1,"items":{"type":"string"}},"translatedPath":{"type":"array","description":"The translated path of the category within the category catalogue by requested locale, field will not be provided if locale is not provided or campaign localization is down.","minItems":1,"items":{"type":"string"}},"targetableAsinCountRange":{"type":"object","description":"The range of ASINs available within the category catalogue.","properties":{"rangeLower":{"type":"integer"},"rangeUpper":{"type":"integer"}}},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation.","minimum":1}}}}}},{"type":"object","properties":{"audiences":{"type":"array","description":"List of recommended audience targets, broken down by audience category","minItems":0,"maxItems":10,"items":{"description":"List of recommended standard Amazon audience targets of a specific audience category","properties":{"category":{"type":"string","description":"An audience category determines the goal of the audience such as In-market, Interest, Lifestyle and Life Event","example":"In-Market","enum":["In-market","Lifestyle","Interest","Life event"]},"audiences":{"type":"array","description":"List of recommended standard Amazon audience targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended standard Amazon audience to target ads on","properties":{"audience":{"type":"string","description":"The audience identifier","example":417464173123977660},"name":{"type":"string","description":"The Amazon audience name"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}}}}},{"type":"object","properties":{"themes":{"properties":{"products":{"type":"array","description":"A list of contextual targeting theme recommendations.","minItems":1,"maxItems":5,"items":{"oneOf":[{"type":"object","description":"Recommendation results for contextual targeting.","properties":{"code":{"type":"string","description":"HTTP status code 200 indicating a successful response for product recomendations.","example":200},"name":{"type":"string","description":"The theme name specified in the request."},"recommendations":{"type":"array","description":"A list of recommended products.","minItems":1,"maxItems":100,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}]}}}}}}]}}}},"application/vnd.sdtargetingrecommendations.v3.2+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"description":"For v3.2 the service will continue to return the recommendations returned for v3.1 in products field, and return recommendations for contextual targeting themes in themes field.","allOf":[{"type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}},{"type":"object","properties":{"categories":{"type":"array","description":"List of recommended category targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended category to target ads on","properties":{"category":{"type":"integer","description":"The category identifier","example":7352105011},"name":{"type":"string","description":"The category name"},"path":{"type":"array","description":"The path of the category within the category catalogue.","minItems":1,"items":{"type":"string"}},"targetableAsinCountRange":{"type":"object","description":"The range of ASINs available within the category catalogue. If no targetable ASIN counts are available then the targetableAsinCountRange value will be null without any properties.","properties":{"rangeLower":{"type":"integer"},"rangeUpper":{"type":"integer"}}},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}},{"type":"object","properties":{"themes":{"properties":{"products":{"type":"array","description":"A list of contextual targeting theme recommendations.","minItems":1,"maxItems":5,"items":{"oneOf":[{"type":"object","description":"Recommendation results for contextual targeting.","properties":{"code":{"type":"string","description":"HTTP status code 200 indicating a successful response for product recomendations.","example":200},"name":{"type":"string","description":"The theme name specified in the request."},"recommendations":{"type":"array","description":"A list of recommended products.","minItems":1,"maxItems":100,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1},"advertisedAsins":{"type":"array","description":"The top advertised products this recommendation is made for.","minItems":1,"maxItems":5,"items":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}}}}}]}}}}}}]}}}},"application/vnd.sdtargetingrecommendations.v3.1+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"allOf":[{"type":"object","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}},{"type":"object","properties":{"categories":{"type":"array","description":"List of recommended category targets","minItems":0,"maxItems":1000,"items":{"description":"A recommended category to target ads on","properties":{"category":{"type":"integer","description":"The category identifier","example":7352105011},"name":{"type":"string","description":"The category name"},"path":{"type":"array","description":"The path of the category within the category catalogue.","minItems":1,"items":{"type":"string"}},"targetableAsinCountRange":{"type":"object","description":"The range of ASINs available within the category catalogue. If no targetable ASIN counts are available then the targetableAsinCountRange value will be null without any properties.","properties":{"rangeLower":{"type":"integer"},"rangeUpper":{"type":"integer"}}},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}}]}}}},"application/vnd.sdtargetingrecommendations.v3.0+json":{"schema":{"description":"Response to a request for targeting recommendations.","properties":{"recommendations":{"description":"A collection of targeting recommendations. Results will be sorted with strongest recommendations in the beginning.","properties":{"products":{"type":"array","description":"List of recommended product targets","minItems":0,"maxItems":1000,"items":{"type":"object","description":"A recommended product to target ads on","properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"},"rank":{"type":"integer","description":"A rank to signify which recommendations are weighed more heavily, with a lower rank signifying a stronger recommendation","minimum":1}}}}}}}}}}},"400":{"description":"Generic bad request error.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Targeting%20Recommendations/operation/getTargetRecommendations","sectionHeader":{"type":3,"text":"POST /sd/targets/recommendations"},"summary":"Returns a set of recommended products and categories to target","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/budgetRecommendations",{"tags":["Budget Recommendations"],"operationId":"getSDBudgetRecommendations","summary":"Returns recommended daily budget and estimated missed opportunities for campaigns","description":"Given a list of campaigns as input, this API provides the following metrics:\n<br> <b>1. Recommended daily budget - </b> Estimated budget needed to keep the campaign in budget for the full 24-hour period. Consider this budget to minimize your campaign's chances of running out of budget. \n<br> <b>2. Percent time in budget </b> - The share of time the campaign was in budget during the past 7 days.\n<br> <b>3. Estimated missed impressions, clicks and sales </b> - These are the estimated additional impressions, clicks and sales the campaign might have generated had it adopted the recommended budget. These are estimates based on campaign's historical performance - and not a guarantee of actual impressions, clicks and sales. Consider using these metrics to further inform your budget allocation decisions.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":false,"schema":{"type":"string"}},{"name":"Amazon-Ads-AccountId","in":"header","description":"The identifier of an account. Account must be a global advertising account.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.sdbudgetrecommendations.v3+json":{"schema":{"description":"Request for budget recommendations.","required":["campaignIds"],"properties":{"campaignIds":{"type":"array","description":"A list of campaign ids for which to get budget recommendations and missed opportunities.","minItems":1,"maxItems":100,"items":{"type":"string"},"example":["5292131569371","5292131569372"]}}}}}},"responses":{"207":{"description":"Multi-status.","content":{"application/vnd.sdbudgetrecommendations.v3+json":{"schema":{"required":["budgetRecommendationsSuccessResults","budgetRecommendationsErrorResults"],"properties":{"budgetRecommendationsSuccessResults":{"type":"array","minItems":0,"maxItems":100,"items":{"required":["index","campaignId","suggestedBudget","sevenDaysMissedOpportunities"],"properties":{"index":{"type":"integer","description":"Correlate the recommendation to the campaign index in the request. Zero-based.","example":0},"campaignId":{"type":"string","description":"Campaign id.","example":5292131569371},"suggestedBudget":{"type":"number","description":"Recommended budget for the campaign. This will be in local currency.","example":350.12},"sevenDaysMissedOpportunities":{"properties":{"startDate":{"type":"string","format":"date","description":"Start date of the missed opportunities date range (YYYY-MM-DD).","example":"2023-05-01"},"endDate":{"type":"string","format":"date","description":"End date of the missed opportunities date range (YYYY-MM-DD).","example":"2023-05-07"},"percentTimeInBudget":{"type":"number","description":"Percentage of time the campaign is active with a budget.","example":60.5},"estimatedMissedSalesLower":{"type":"number","description":"Lower bound of the estimated missed sales. This will be in local currency.","example":200.75},"estimatedMissedSalesUpper":{"type":"number","description":"Upper bound of the estimated missed sales. This will be in local currency.","example":400.75},"estimatedMissedClicksLower":{"type":"integer","description":"Lower bound of the estimated missed clicks.","example":30},"estimatedMissedClicksUpper":{"type":"integer","description":"Upper bound of the estimated missed clicks.","example":50},"estimatedMissedImpressionsLower":{"type":"integer","description":"Lower bound of the estimated missed impressions.","example":50},"estimatedMissedImpressionsUpper":{"type":"integer","description":"Upper bound of the estimated missed impressions.","example":70},"estimatedMissedViewableImpressionsLower":{"type":"integer","description":"Lower bound of the estimated missed viewable impressions for vCPM campaigns.","example":70},"estimatedMissedViewableImpressionsUpper":{"type":"integer","description":"Upper bound of the estimated missed viewable impressions for vCPM campaigns.","example":90}}}}},"description":"List of successful budget recommendation for campaigns."},"budgetRecommendationsErrorResults":{"type":"array","minItems":0,"maxItems":100,"items":{"required":["index","campaignId","code","details"],"properties":{"index":{"type":"integer","description":"Correlate the recommendation to the campaign index in the request. Zero-based.","example":1},"campaignId":{"type":"string","description":"Campaign id.","example":5292131569372},"code":{"type":"string","description":"The HTTP status code of the response.","example":"404"},"details":{"type":"string","description":"A human-readable description of the response.","example":"Budget recommendation is not found."}}},"description":"List of errors that occurred when generating budget recommendation."}}}}}},"400":{"description":"Generic bad request error.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"415":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Recommendations/operation/getSDBudgetRecommendations","sectionHeader":{"type":3,"text":"POST /sd/campaigns/budgetRecommendations"},"summary":"Returns recommended daily budget and estimated missed opportunities for campaigns","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets",{"tags":["Negative Targeting"],"summary":"Gets a list of negative targeting clauses.","description":"Gets a list of negative targeting clauses objects for a requested set of Sponsored Display negative targets. Note that the Negative Targeting Clause object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the negative target operations that return the NegativeTargetingClauseEx object.","operationId":"listNegativeTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. 0-indexed record offset for the result set. Defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Number of records to include in the paged response. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. Restricts results to those with state within the specified comma-separated list. Must be one of: `enabled`, `paused`, or `archived`. Default behavior is to include enabled, paused, and archived.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"adGroupIdFilter","in":"query","description":"Optional list of comma separated adGroupIds. Restricts results to negative targeting clauses with the specified `adGroupId`.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. Restricts results to targeting clauses within campaigns specified in comma-separated list.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"properties":{"state":{"type":"string","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expressionType":{"type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"resolvedExpression":{"type":"array","description":"The resolved negative targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/listNegativeTargetingClauses","sectionHeader":{"type":3,"text":"GET /sd/negativeTargets"},"summary":"Gets a list of negative targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets",{"tags":["Negative Targeting"],"summary":"Updates one or more negative targeting clauses.","description":"Updates one or more negative targeting clauses. Negative targeting clauses are identified using their targetId. The mutable field is `state`. Maximum length of the array is 100 objects.","operationId":"updateNegativeTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of up to 100 negative targeting clauses. Note that the only mutable field is `state`.","content":{"application/json":{"schema":{"type":"array","items":{"required":["targetId"],"allOf":[{"properties":{"state":{"type":"string","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/updateNegativeTargetingClauses","sectionHeader":{"type":3,"text":"PUT /sd/negativeTargets"},"summary":"Updates one or more negative targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets",{"tags":["Negative Targeting"],"summary":"Creates one or more negative targeting clauses.","description":"Successfully created negative targeting clauses associated with an ad group are assigned a unique target identifier.\nProduct negative targeting clause examples:\n| Negative targeting clause | Description |\n|---------------------------|-------------|\n| asinSameAs=B0123456789 | Negatively target this product.|\n| asinBrandSameAs=12345 | Negatively target products in the brand.|","operationId":"createNegativeTargetingClauses","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of up to 100 negative targeting clauses for creation.","content":{"application/json":{"schema":{"type":"array","items":{"required":["adGroupId","expressionType","expression","state"],"allOf":[{"properties":{"state":{"type":"string","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"expressionType":{"type":"string","enum":["manual","auto"]}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/createNegativeTargetingClauses","sectionHeader":{"type":3,"text":"POST /sd/negativeTargets"},"summary":"Creates one or more negative targeting clauses.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets/{negativeTargetId}",{"tags":["Negative Targeting"],"summary":"Gets a negative targeting clause specified by identifier.","description":"This call returns the minimal set of negative targeting clause fields, but is more efficient than getNegativeTargetsEx.","operationId":"getNegativeTargets","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"negativeTargetId","in":"path","description":"The negative targeting clause identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"allOf":[{"properties":{"state":{"type":"string","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expressionType":{"type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"resolvedExpression":{"type":"array","description":"The resolved negative targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/getNegativeTargets","sectionHeader":{"type":3,"text":"GET /sd/negativeTargets/{negativeTargetId}"},"summary":"Gets a negative targeting clause specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets/{negativeTargetId}",{"tags":["Negative Targeting"],"summary":"Sets the `state` of a negative targeting clause to `archived`.","description":"Equivalent to using the updateNegativeTargetingClauses operation to set the `state` property of a targeting clause to `archived`. See [Developer Notes](http://advertising.amazon.com/API/docs/guides/developer_notes#Archiving) for more information.","operationId":"archiveNegativeTargetingClause","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"negativeTargetId","in":"path","description":"The identifier of a negative targeting clause.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"targetId":{"type":"integer","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/archiveNegativeTargetingClause","sectionHeader":{"type":3,"text":"DELETE /sd/negativeTargets/{negativeTargetId}"},"summary":"Sets the `state` of a negative targeting clause to `archived`.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets/extended",{"tags":["Negative Targeting"],"summary":"Gets a list of negative targeting clause objects with extended fields.","description":"Gets an array of NegativeTargetingClauseEx objects for a set of requested negative targets. Note that this call returns the full set of negative targeting clause extended fields, but is less efficient than getNegativeTargets.","operationId":"listNegativeTargetingClausesEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. 0-indexed record offset for the result set. Defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Number of records to include in the paged response. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. Restricts results to keywords with state within the specified comma-separated list. Must be one of: `enabled`, `paused`, or `archived`. Default behavior is to include `enabled`, `paused`, and `archived`.","schema":{"type":"string","enum":["enabled","paused","archived","enabled, paused","enabled, archived","paused, archived","enabled, paused, archived"],"default":"enabled, paused, archived"}},{"name":"targetIdFilter","in":"query","description":"Optional. Restricts results to ads with the specified `tagetId` specified in comma-separated list","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional list of comma separated adGroupIds. Restricts results to negative targeting clauses with the specified `adGroupId`.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional. Restricts results to ads within campaigns specified in the comma-separated list.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"number"},"adGroupId":{"type":"number"},"state":{"type":"string","enum":["enabled","paused","archived"]},"expressionType":{"type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"servingStatus":{"type":"string","description":"The status of the target.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","TARGET_STATUS_LIVE","TARGET_STATUS_PAUSED","TARGET_STATUS_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the target was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the target.","format":"int64"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/listNegativeTargetingClausesEx","sectionHeader":{"type":3,"text":"GET /sd/negativeTargets/extended"},"summary":"Gets a list of negative targeting clause objects with extended fields.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/negativeTargets/extended/{negativeTargetId}",{"tags":["Negative Targeting"],"summary":"Gets extended information for a negative targeting clause.","description":"Gets a negative targeting clause with extended fields. Note that this call returns the full set of negative targeting clause extended fields, but is less efficient than getNegativeTarget.","operationId":"getNegativeTargetsEx","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"negativeTargetId","in":"path","description":"The negative targeting clause identifier.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"targetId":{"type":"number"},"adGroupId":{"type":"number"},"state":{"type":"string","enum":["enabled","paused","archived"]},"expressionType":{"type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"servingStatus":{"type":"string","description":"The status of the target.","enum":["ADVERTISER_STATUS_ENABLED","STATUS_UNAVAILABLE","ADVERTISER_PAUSED","ACCOUNT_OUT_OF_BUDGET","ADVERTISER_PAYMENT_FAILURE","CAMPAIGN_PAUSED","CAMPAIGN_ARCHIVED","PENDING_START_DATE","ENDED","CAMPAIGN_OUT_OF_BUDGET","AD_GROUP_STATUS_ENABLED","AD_GROUP_PAUSED","AD_GROUP_ARCHIVED","AD_GROUP_INCOMPLETE","AD_GROUP_LOW_BID","TARGET_STATUS_LIVE","TARGET_STATUS_PAUSED","TARGET_STATUS_ARCHIVED","ADVERTISER_EXCEED_SPENDS_LIMIT","AD_POLICING_PENDING_REVIEW","CAMPAIGN_INCOMPLETE","INELIGIBLE","PORTFOLIO_ENDED","PORTFOLIO_OUT_OF_BUDGET","ADVERTISER_ARCHIVED","ADVERTISER_ACCOUNT_OUT_OF_BUDGET"]},"creationDate":{"type":"integer","description":"Epoch date the target was created.","format":"int64"},"lastUpdatedDate":{"type":"integer","description":"Epoch date of the last update to any property associated with the target.","format":"int64"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Negative%20Targeting/operation/getNegativeTargetsEx","sectionHeader":{"type":3,"text":"GET /sd/negativeTargets/extended/{negativeTargetId}"},"summary":"Gets extended information for a negative targeting clause.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/{recordType}/snapshot",{"tags":["Snapshots"],"summary":"Request a file-based snapshot of all entities of the specified type in the account satisfying the filtering criteria","description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/get-started).","operationId":"createSnapshot","deprecated":true,"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"recordType","in":"path","description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \nThe type of entity for which the snapshot should be generated. Must be one of: `campaigns`, `adgroups`, `productAds`, or `targets`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request a snapshot file for all entities of a single record type.","content":{"application/json":{"schema":{"type":"object","properties":{"stateFilter":{"type":"string","description":"Optional. Restricts results to entities with state within the specified comma-separated list. Default behavior is to include 'enabled' and 'paused'. You can include 'enabled', 'paused', and 'archived' or any combination.","enum":["enabled","paused","archived"]},"tacticFilter":{"type":"string","description":"Optional. Restricts results to entities with the advertising tactic associated with the campaign. Must be one of the following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00020,T00030","enum":["T00020","T00030","T00020,T00030"]}}}}}},"responses":{"202":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"snapshotId":{"type":"string","description":"The identifier of the snapshot that was requested."},"recordType":{"type":"string","description":"The record type of the snapshot file.","enum":["campaigns","adgroups","productAds","targets"]},"status":{"type":"string","description":"The status of the generation of the snapshot.","enum":["IN_PROGRESS","SUCCESS","FAILURE"]},"statusDetails":{"type":"string","description":"Optional description of the status."},"location":{"type":"string","description":"The URI for the snapshot. It's only available if status is SUCCESS."},"fileSize":{"type":"number","description":"The size of the snapshot file in bytes. It's only available if status is SUCCESS."},"expiration":{"type":"number","description":"The epoch time for expiration of the snapshot file and each snapshot file will be expired in 30 mins after generated. It's only available if status is SUCCESS."}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Snapshots/operation/createSnapshot","sectionHeader":{"type":3,"text":"POST /sd/{recordType}/snapshot"},"summary":"Request a file-based snapshot of all entities of the specified type in the account satisfying the filtering criteria","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/snapshots/{snapshotId}",{"tags":["Snapshots"],"summary":"Retrieve status, metadata, and location of previously requested snapshot","description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/get-started).","operationId":"getSnapshot","deprecated":true,"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"snapshotId","in":"path","description":"The Snapshot identifier.","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"snapshotId":{"type":"string","description":"The identifier of the snapshot that was requested."},"recordType":{"type":"string","description":"The record type of the snapshot file.","enum":["campaigns","adgroups","productAds","targets"]},"status":{"type":"string","description":"The status of the generation of the snapshot.","enum":["IN_PROGRESS","SUCCESS","FAILURE"]},"statusDetails":{"type":"string","description":"Optional description of the status."},"location":{"type":"string","description":"The URI for the snapshot. It's only available if status is SUCCESS."},"fileSize":{"type":"number","description":"The size of the snapshot file in bytes. It's only available if status is SUCCESS."},"expiration":{"type":"number","description":"The epoch time for expiration of the snapshot file and each snapshot file will be expired in 30 mins after generated. It's only available if status is SUCCESS."}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified   resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Snapshots/operation/getSnapshot","sectionHeader":{"type":3,"text":"GET /sd/snapshots/{snapshotId}"},"summary":"Retrieve status, metadata, and location of previously requested snapshot","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/snapshots/{snapshotId}/download",{"tags":["Snapshots"],"summary":"Download previously requested snapshot","description":"**Note: Snapshots APIs are deprecated and will be shut off on October 15, 2024. For replacement functionality, see the [exports](guides/exports/overview) API. To learn more, view the [migration guide](reference/migration-guides/snapshots-exports).** \n\nTo understand the call flow for asynchronous snapshots, see [Getting started with sponsored ads snapshots](/API/docs/en-us/guides/snapshots/overview).","operationId":"downloadSnapshot","deprecated":true,"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"snapshotId","in":"path","description":"The Snapshot identifier.","required":true,"schema":{"type":"string"}}],"responses":{"307":{"description":"Successful operation.","headers":{"Location":{"schema":{"type":"string"},"description":"Redirect URI with S3 file location containing snapshot data"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Snapshots/operation/downloadSnapshot","sectionHeader":{"type":3,"text":"GET /sd/snapshots/{snapshotId}/download"},"summary":"Download previously requested snapshot","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/creatives",{"tags":["Creatives"],"summary":"Gets a list of creatives","description":"","operationId":"listCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Sets a cursor into the requested set of creatives. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32","default":0}},{"name":"count","in":"query","description":"Sets the number of creative objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten creatives set `startIndex=0` and `count=10`. To return the next ten creatives, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32","maximum":100,"default":100}},{"name":"adGroupIdFilter","in":"query","description":"The returned array includes only creatives associated with ad group identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `creativeIdFilter` parameter.","schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array includes only creatives with identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `adGroupIdFilter` parameter.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Creative model.","required":["creativeId","adGroupId","properties","moderationStatus","creativeType"],"properties":{"creativeId":{"type":"number","description":"Unique identifier of the creative."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"creativeType":{"type":"string","nullable":false,"description":"\nThe type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided.|","example":"IMAGE","enum":["IMAGE","VIDEO"]},"properties":{"description":"Select customizations on your creative from any combination of headline, logo, custom image and backgrounds.","anyOf":[{"type":"object","description":"User-customizable properties of a creative with headline.","properties":{"headline":{"type":"string","maxLength":50,"description":"A marketing phrase to display on the ad. This field is optional and mutable. Maximum number of characters allowed is 50."},"hasTermsAndConditions":{"type":"boolean","description":"Indicates that the ad promotes a free product or service (e.g., 'buy one get one free' or 'free one-month trial') and has qualifying terms and conditions applicable to your customer. Only supported for productAds with landingPageType of OFF_AMAZON_LINK. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those."},"originalHeadline":{"type":"string","description":"The original headline submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `headline` will return the translated headline whereas `originalHeadline` will return the original headline. In all other cases, 'originalHeadline' and `headline` both will return the original headline."}}},{"type":"object","description":"User-customizable properties of a creative with a logo.","properties":{"brandLogo":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}},{"type":"object","description":"User-customizable properties of a custom image creative.","properties":{"rectCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareImages":{"type":"array","description":"An optional collection of 1:1 square images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"horizontalImages":{"type":"array","description":"An optional collection of 1.91:1 horizontal images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"verticalImages":{"type":"array","description":"An optional collection of 9:16 vertical images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}}},{"type":"object","description":"User-customizable properties of a video creative. Use either the 'video' property for a single video, OR one or more of the aspect-ratio-specific collections (squareVideos, horizontalVideos, verticalVideos).","properties":{"video":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}},"squareVideos":{"type":"array","description":"An optional collection of 1:1 square videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"horizontalVideos":{"type":"array","description":"An optional collection of 16:9 horizontal videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"verticalVideos":{"type":"array","description":"An optional collection of 9:16 vertical videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}}}},{"type":"object","description":"User-customizable properties of a creative with background. Only supported for productAds with landingPageType of OFF_AMAZON_LINK.","properties":{"backgrounds":{"type":"array","description":"An optional collection of backgrounds which are displayed on the ad.","items":{"type":"object","description":"This field denotes background which are displayed on the ad. This field is optional and mutable.","properties":{"color":{"type":"string","description":"The standard HTML hex color codes of the background (e.g. '#3cb371')."}}}}}}]},"moderationStatus":{"type":"string","description":"The moderation status of the creative","enum":["APPROVED","PENDING_REVIEW","REJECTED"]}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Creatives/operation/listCreatives","sectionHeader":{"type":3,"text":"GET /sd/creatives"},"summary":"Gets a list of creatives","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/creatives",{"tags":["Creatives"],"summary":"Updates one or more creatives.","description":"","operationId":"updateCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects to update. Maximum length of the array is 100 objects.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Creative update model.","required":["creativeId","properties"],"properties":{"creativeId":{"type":"number","description":"Unique identifier of the creative."},"creativeType":{"type":"string","nullable":true,"description":"The type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]},"properties":{"description":"Select customizations on your creative from any combination of headline, logo, custom image and backgrounds.","anyOf":[{"type":"object","description":"User-customizable properties of a creative with headline.","properties":{"headline":{"type":"string","maxLength":50,"description":"A marketing phrase to display on the ad. This field is optional and mutable. Maximum number of characters allowed is 50."},"hasTermsAndConditions":{"type":"boolean","description":"Indicates that the ad promotes a free product or service (e.g., 'buy one get one free' or 'free one-month trial') and has qualifying terms and conditions applicable to your customer. Only supported for productAds with landingPageType of OFF_AMAZON_LINK. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those."},"originalHeadline":{"type":"string","description":"The original headline submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `headline` will return the translated headline whereas `originalHeadline` will return the original headline. In all other cases, 'originalHeadline' and `headline` both will return the original headline."}}},{"type":"object","description":"User-customizable properties of a creative with a logo.","properties":{"brandLogo":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}},{"type":"object","description":"User-customizable properties of a custom image creative.","properties":{"rectCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareImages":{"type":"array","description":"An optional collection of 1:1 square images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"horizontalImages":{"type":"array","description":"An optional collection of 1.91:1 horizontal images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"verticalImages":{"type":"array","description":"An optional collection of 9:16 vertical images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}}},{"type":"object","description":"User-customizable properties of a video creative. Use either the 'video' property for a single video, OR one or more of the aspect-ratio-specific collections (squareVideos, horizontalVideos, verticalVideos).","properties":{"video":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}},"squareVideos":{"type":"array","description":"An optional collection of 1:1 square videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"horizontalVideos":{"type":"array","description":"An optional collection of 16:9 horizontal videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"verticalVideos":{"type":"array","description":"An optional collection of 9:16 vertical videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}}}},{"type":"object","description":"User-customizable properties of a creative with background. Only supported for productAds with landingPageType of OFF_AMAZON_LINK.","properties":{"backgrounds":{"type":"array","description":"An optional collection of backgrounds which are displayed on the ad.","items":{"type":"object","description":"This field denotes background which are displayed on the ad. This field is optional and mutable.","properties":{"color":{"type":"string","description":"The standard HTML hex color codes of the background (e.g. '#3cb371')."}}}}}}]}}},"minItems":1,"maxItems":100}}}},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"creativeId":{"type":"number","description":"The identifier of the creative."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Creatives/operation/updateCreatives","sectionHeader":{"type":3,"text":"PUT /sd/creatives"},"summary":"Updates one or more creatives.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/creatives",{"tags":["Creatives"],"summary":"A POST request of one or more creatives.","description":"","operationId":"createCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of Creative objects to create. Maximum length of the array is 100 objects. Note - when using productAds with landingPageURL of OFF_AMAZON_LINK, STORE, or MOMENT, the following properties are required all together;\n1) headline, 2) brandLogo, and 3) rectCustomImage, squareCustomImage.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Creative create model.","example":{"adGroupId":21035454911234,"properties":{"rectCustomImage":{"assetId":"amzn1.assetlibrary.asset1.fbb498fe19248f834be4b7xxxxxxxx","assetVersion":"version_v1","croppingCoordinates":{"top":0,"left":0,"width":1200,"height":628}},"squareCustomImage":{"assetId":"amzn1.assetlibrary.asset1.fbb498fe19248f834be4b8xxxxxxxx","assetVersion":"version_v1","croppingCoordinates":{"top":0,"left":0,"width":628,"height":628}}}},"required":["adGroupId","properties"],"properties":{"adGroupId":{"type":"number","description":"Unqiue identifier for the ad group associated with the creative."},"creativeType":{"type":"string","nullable":true,"description":"The type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]},"properties":{"description":"Select customizations on your creative from any combination of headline, logo, custom image and backgrounds.","anyOf":[{"type":"object","description":"User-customizable properties of a creative with headline.","properties":{"headline":{"type":"string","maxLength":50,"description":"A marketing phrase to display on the ad. This field is optional and mutable. Maximum number of characters allowed is 50."},"hasTermsAndConditions":{"type":"boolean","description":"Indicates that the ad promotes a free product or service (e.g., 'buy one get one free' or 'free one-month trial') and has qualifying terms and conditions applicable to your customer. Only supported for productAds with landingPageType of OFF_AMAZON_LINK. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those."},"originalHeadline":{"type":"string","description":"The original headline submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `headline` will return the translated headline whereas `originalHeadline` will return the original headline. In all other cases, 'originalHeadline' and `headline` both will return the original headline."}}},{"type":"object","description":"User-customizable properties of a creative with a logo.","properties":{"brandLogo":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}},{"type":"object","description":"User-customizable properties of a custom image creative.","properties":{"rectCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareImages":{"type":"array","description":"An optional collection of 1:1 square images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"horizontalImages":{"type":"array","description":"An optional collection of 1.91:1 horizontal images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"verticalImages":{"type":"array","description":"An optional collection of 9:16 vertical images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}}},{"type":"object","description":"User-customizable properties of a video creative. Use either the 'video' property for a single video, OR one or more of the aspect-ratio-specific collections (squareVideos, horizontalVideos, verticalVideos).","properties":{"video":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}},"squareVideos":{"type":"array","description":"An optional collection of 1:1 square videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"horizontalVideos":{"type":"array","description":"An optional collection of 16:9 horizontal videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"verticalVideos":{"type":"array","description":"An optional collection of 9:16 vertical videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}}}},{"type":"object","description":"User-customizable properties of a creative with background. Only supported for productAds with landingPageType of OFF_AMAZON_LINK.","properties":{"backgrounds":{"type":"array","description":"An optional collection of backgrounds which are displayed on the ad.","items":{"type":"object","description":"This field denotes background which are displayed on the ad. This field is optional and mutable.","properties":{"color":{"type":"string","description":"The standard HTML hex color codes of the background (e.g. '#3cb371')."}}}}}}]},"consentToTranslate":{"type":"boolean","description":"If set to true and the headline and/or video are not in the marketplace's default language, Amazon will attempt to translate them to the marketplace's default language. If Amazon is unable to translate them, the ad will be rejected by moderation. We only support translating headlines and videos from English to German, French, Italian, Spanish, Japanese, and Dutch."}}},"minItems":1,"maxItems":100}}}},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"creativeId":{"type":"number","description":"The identifier of the creative."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Creatives/operation/createCreatives","sectionHeader":{"type":3,"text":"POST /sd/creatives"},"summary":"A POST request of one or more creatives.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/creatives/preview",{"tags":["Creatives"],"summary":"Gets creative preview HTML.","description":"","operationId":"postCreativePreview","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["creative","previewConfiguration"],"properties":{"creative":{"type":"object","description":"Creative model for preview.","properties":{"creativeType":{"type":"string","nullable":true,"description":"The type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]},"properties":{"description":"Select customizations on your creative from any combination of headline, logo, custom image and backgrounds.","anyOf":[{"type":"object","description":"User-customizable properties of a creative with headline.","properties":{"headline":{"type":"string","maxLength":50,"description":"A marketing phrase to display on the ad. This field is optional and mutable. Maximum number of characters allowed is 50."},"hasTermsAndConditions":{"type":"boolean","description":"Indicates that the ad promotes a free product or service (e.g., 'buy one get one free' or 'free one-month trial') and has qualifying terms and conditions applicable to your customer. Only supported for productAds with landingPageType of OFF_AMAZON_LINK. LandingPageURL must link out to a page detailing terms and conditions or contain a link to those."},"originalHeadline":{"type":"string","description":"The original headline submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `headline` will return the translated headline whereas `originalHeadline` will return the original headline. In all other cases, 'originalHeadline' and `headline` both will return the original headline."}}},{"type":"object","description":"User-customizable properties of a creative with a logo.","properties":{"brandLogo":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}},{"type":"object","description":"User-customizable properties of a custom image creative.","properties":{"rectCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareCustomImage":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}},"squareImages":{"type":"array","description":"An optional collection of 1:1 square images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"horizontalImages":{"type":"array","description":"An optional collection of 1.91:1 horizontal images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}},"verticalImages":{"type":"array","description":"An optional collection of 9:16 vertical images which are displayed on the ad.","items":{"type":"object","description":"This field denotes image which is displayed on the ad. This can either be a brand logo or a custom image. This field is optional and mutable. For custom image, both rectCustomImage and squareCustomImage should use the same asset id and asset version. Specific restrictions based on the Image type are listed in the following table.\n|Image type|Maximum file size|Minimum width|Minimum height|Accepted file formats|\n|------|-----------|-----------|-----------|-----------|\n|Custom Image|5MB|1200|628|JPEG, JPG, PNG, GIF|\n|Brand Logo|1MB|600|100|JPEG, JPG, PNG|\nNote: For square custom images the cropped image should be 628x628 at minimum.","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the image asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular image assetversion."},"croppingCoordinates":{"type":"object","description":"Optional cropping coordinates to apply to the image.","required":["top","left","width","height"],"properties":{"top":{"type":"integer","minimum":0,"description":"Pixel distance from the top edge of the cropping zone to the top edge of the original image."},"left":{"type":"integer","minimum":0,"description":"Pixel distance from the left edge of the cropping zone to the left edge of the original image."},"width":{"type":"integer","minimum":0,"description":"Pixel width of the cropping zone."},"height":{"type":"integer","minimum":0,"description":"Pixel height of the cropping zone."}}}}}}}},{"type":"object","description":"User-customizable properties of a video creative. Use either the 'video' property for a single video, OR one or more of the aspect-ratio-specific collections (squareVideos, horizontalVideos, verticalVideos).","properties":{"video":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}},"squareVideos":{"type":"array","description":"An optional collection of 1:1 square videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"horizontalVideos":{"type":"array","description":"An optional collection of 16:9 horizontal videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}},"verticalVideos":{"type":"array","description":"An optional collection of 9:16 vertical videos which are displayed on the ad. Currently, only one asset is supported in the array.","items":{"type":"object","description":"This field denotes video which is displayed on the ad. This field is optional and mutable. A video asset must be provided for a VIDEO creative. Specific restrictions based on the video are listed in the following table.\n||Specifications|\n|------------------|------------------|\n|Maximum file size|500MB|\n|Aspect ratio|16:9|\n|Minimum duration|6s|\n|Maximum duration|45s|\n|Minimum frame size|1920x1080|\n|Minimum video bitrate|4mbps|\n|Video frame rate(fps)|23.976(recommended), 24, 25, or 29.97|\n|Video frame rate mode|Constant|\n|Minimum audio bitrate|192kbps|\n|Audio sample rate|44.1kHz or 48kHz|\n|Supported Formats|Video: H.264, MPEG-2, or MPEG-4; Audio: PCM or AAC|\n|Audio Channel|Audio format needs to be stereo or mono.|\n|Recommended video bitrate|8mbps|\n|Recommended duration|A duration of exactly 6s, 15s, 20s, or 30s is recommended. Use of videos outside of these durations may negatively impact your campaign performance. Shorter lengths will drive higher VCR (although scale on 6s may be limited).|","required":["assetId","assetVersion"],"properties":{"assetId":{"type":"string","description":"The unique identifier of the video asset. This assetId comes from the Creative Asset Library."},"assetVersion":{"type":"string","description":"The identifier of the particular video assetversion."},"originalAssetId":{"type":"string","description":"The assetId of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetId` will return the assetId of the original video whereas `assetId` will return the assetId of the translated video. In all other cases, 'originalAssetId' and `assetId` both will return the assetId of the original video."},"originalAssetVersion":{"type":"string","description":"The asset version of the original video submitted by the advertiser. If 'consentToTranslate' is set to true and translation is SUCCESSFUL then `originalAssetVersion` will return the asset version of the original video whereas `assetVersion` will return the asset version of the translated video. In all other cases, 'originalAssetVersion' and `assetVersion` both will return the asset version of the original video."}}}}}},{"type":"object","description":"User-customizable properties of a creative with background. Only supported for productAds with landingPageType of OFF_AMAZON_LINK.","properties":{"backgrounds":{"type":"array","description":"An optional collection of backgrounds which are displayed on the ad.","items":{"type":"object","description":"This field denotes background which are displayed on the ad. This field is optional and mutable.","properties":{"color":{"type":"string","description":"The standard HTML hex color codes of the background (e.g. '#3cb371')."}}}}}}]}}},"previewConfiguration":{"type":"object","description":"Optional configuration for creative preview.","properties":{"size":{"type":"object","description":"The slot dimension to render the creative. Sponsored Display creatives are responsive to a limited list of width and height pairs, including 300x250, 650x130, 245x250, 414x125, 600x160, 600x300, 728x90, 980x55, 320x50, 970x250 and 270x150.","properties":{"width":{"type":"integer"},"height":{"type":"integer"}}},"products":{"type":"array","description":"The products to preview. Currently only the first product is previewable.","items":{"type":"object","properties":{"asin":{"type":"string","description":"The ASIN of the product."}}}},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"isMobile":{"type":"boolean","description":"Preview the creative as if it is on a mobile environment."},"isOnAmazon":{"type":"boolean","description":"Preview the creative as if it is on an amazon site or third party site. The main difference is whether the preview will contain an AdChoices icon."}}},"previewConfigurations":{"type":"array","items":{"type":"object","description":"Optional configuration for creative preview.","properties":{"size":{"type":"object","description":"The slot dimension to render the creative. Sponsored Display creatives are responsive to a limited list of width and height pairs, including 300x250, 650x130, 245x250, 414x125, 600x160, 600x300, 728x90, 980x55, 320x50, 970x250 and 270x150.","properties":{"width":{"type":"integer"},"height":{"type":"integer"}}},"products":{"type":"array","description":"The products to preview. Currently only the first product is previewable.","items":{"type":"object","properties":{"asin":{"type":"string","description":"The ASIN of the product."}}}},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"isMobile":{"type":"boolean","description":"Preview the creative as if it is on a mobile environment."},"isOnAmazon":{"type":"boolean","description":"Preview the creative as if it is on an amazon site or third party site. The main difference is whether the preview will contain an AdChoices icon."}}}}}}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","required":["previewHtml"],"properties":{"previewHtml":{"type":"string"},"previewHtmls":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Creatives/operation/postCreativePreview","sectionHeader":{"type":3,"text":"POST /sd/creatives/preview"},"summary":"Gets creative preview HTML.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/moderation/creatives",{"tags":["Creatives"],"summary":"Gets a list of creative moderations","description":"","operationId":"listCreativeModerations","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","description":"The language of the returned creative moderation metadata.","required":true,"schema":{"type":"string","description":"Locale string as described in [BCP 47](https://tools.ietf.org/html/bcp47). For example, `en-US`","pattern":"^\\[a-z]{2}-[AZ]{2}$","enum":["en-US","es-MX","zh-CN","es-ES","it-IT","fr-FR","fr-CA","de-DE","ja-JP","ko-KR","en-GB","en-CA","hi-IN","en-IN","en-DE","en-ES","en-FR","en-IT","en-JP","en-AE","ar-AE"]}},{"name":"startIndex","in":"query","description":"Sets a cursor into the requested set of creative moderations. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32","default":0}},{"name":"count","in":"query","description":"Sets the number of creative objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten creative moderations set `startIndex=0` and `count=10`. To return the next ten creative moderations, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32","maximum":100,"default":100}},{"name":"adGroupIdFilter","in":"query","description":"The returned array includes only creative moderations associated with ad group identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `creativeIdFilter` parameter.","schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array includes only creative moderations with creative identifiers matching those specified in the comma-delimited string. Cannot be used in conjunction with the `adGroupIdFilter` parameter.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"System generated Creative moderation.","required":["creativeId","moderationStatus","etaForModeration","policyViolations","creativeType"],"properties":{"creativeId":{"type":"number","description":"Unique identifier of the creative."},"creativeType":{"type":"string","nullable":false,"description":"\nThe type of the creative.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have video assets provided.|","example":"IMAGE","enum":["IMAGE","VIDEO"]},"moderationStatus":{"type":"string","description":"The moderation status of the creative.\n|Status|Description|\n|------|-----------|\n|APPROVED|Moderation for the creative is complete.|\n|IN_PROGRESS|Moderation for the creative is in progress. The expected date and time for completion are specfied in the `etaForModeration` field.|\n|REJECTED|The creative has failed moderation. Specific information about the content that violated policy is available in `policyViolations`.|","enum":["APPROVED","PENDING_REVIEW","REJECTED"]},"etaForModeration":{"type":"string","format":"date-time","description":"Expected date and time by which moderation will be complete."},"policyViolations":{"type":"array","description":"A list of policy violations for a creative that has failed moderation.","items":{"type":"object","properties":{"policyDescription":{"type":"string","description":"A human-readable description of the policy."},"policyLinkUrl":{"type":"string","description":"Address of the policy documentation. Follow the link to learn more about the specified policy."},"violatingHeadlineContents":{"type":"array","description":"Information about the headline text that violates the specified policy.","items":{"type":"object","properties":{"reviewedText":{"type":"string","description":"The specific text reviewed during moderation."},"textEvidence":{"type":"array","items":{"type":"object","properties":{"violatingText":{"type":"string","description":"The specific text determined to violate the specified policy in reviewedText"},"violatingTextPosition":{"type":"object","properties":{"start":{"type":"integer","description":"Zero-based index into the text in reviewedText where the text specified in violatingText starts"},"end":{"type":"integer","description":"Zero-based index into the text in reviewedText where the text specified in violatingText ends"}}}}}}}}},"violatingBrandLogoContents":{"type":"array","description":"Information about the brand logo that violates the specified policy.","items":{"type":"object","properties":{"reviewedImageUrl":{"type":"string","description":"Address of the image reviewed during moderation."},"imageEvidences":{"type":"array","items":{"type":"object","properties":{"violatingImageCrop":{"type":"object","properties":{"topLeftX":{"type":"integer","description":"The top left X-coordinate of the content that violates the specfied policy within the image."},"topLeftY":{"type":"integer","description":"The top left Y-coordinate of the content that violates the specfied policy within the image."},"height":{"type":"integer","description":"The height of the content that violates the specfied policy within the image."},"width":{"type":"integer","description":"The width of the content that violates the specfied policy within the image."}}}}}}}}},"violatingCustomImageContents":{"type":"array","description":"Information about the custom image that violates the specified policy.","items":{"type":"object","properties":{"reviewedImageUrl":{"type":"string","description":"Address of the image reviewed during moderation."},"imageEvidences":{"type":"array","items":{"type":"object","properties":{"violatingImageCrop":{"type":"object","properties":{"topLeftX":{"type":"integer","description":"The top left X-coordinate of the content that violates the specfied policy within the image."},"topLeftY":{"type":"integer","description":"The top left Y-coordinate of the content that violates the specfied policy within the image."},"height":{"type":"integer","description":"The height of the content that violates the specfied policy within the image."},"width":{"type":"integer","description":"The width of the content that violates the specfied policy within the image."}}}}}}}}},"violatingVideoContents":{"type":"array","description":"Information about the video that violates the specified policy.","items":{"type":"object","properties":{"reviewedVideoUrl":{"type":"string","description":"Address of the video reviewed during moderation."},"videoEvidences":{"type":"array","items":{"type":"object","properties":{"violatingVideoPosition":{"type":"object","properties":{"start":{"type":"integer","description":"Time at which policy violation within video asset starts."},"end":{"type":"integer","description":"Time at which policy violation within the video asset ends."}}}}}}}}}}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Creatives/operation/listCreativeModerations","sectionHeader":{"type":3,"text":"GET /sd/moderation/creatives"},"summary":"Gets a list of creative moderations","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/{requestId}/results",{"tags":["Brand Safety List"],"summary":"Gets the results for the given request","description":"When a user adds domains to their Brand Safety Deny List, the request is processed asynchronously, and a requestId is provided to the user. This requestId can be used to view the request results for up to 90 days from when the request was submitted. The results provide the status of each domain in the given request. Request results may contain multiple pages. This endpoint will only be available once the request has completed processing. To see the status of the request you can call GET /sd/brandSafety/{requestId}/status. Note that this endpoint only lists the results of POST requests to /sd/brandSafety/deny - it does not reflect the results of DELETE requests.\n","operationId":"getRequestResults","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"description":"The ID of the request previously submitted.","name":"requestId","in":"path","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","required":false,"description":"Optional. Sets a cursor into the requested set of results. Use in conjunction with the count parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.\n","schema":{"type":"integer","minimum":0}},{"name":"count","in":"query","required":false,"description":"Optional. Sets the number of results in the returned array. Use in conjunction with the startIndex parameter to control pagination. For example, to return the first 1000 results set startIndex=0 and count=1000. To return the next 1000 results, set startIndex=1000 and count=1000, and so on. Defaults to max page size(1000).\n","schema":{"type":"integer","minimum":0,"maximum":1000}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","description":"A list of results for the given requestId","items":{"type":"object","properties":{"status":{"type":"string","description":"The state of the domain.","enum":["SUCCESS","FAILURE"],"default":"SUCCESS"},"details":{"type":"string","description":"A human-readable description of the response."},"domainId":{"type":"integer","description":"The identifier of the Brand Safety Deny List Domain.","format":"int64"},"name":{"type":"string","description":"The website or app identifier."}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/getRequestResults","sectionHeader":{"type":3,"text":"GET /sd/brandSafety/{requestId}/results"},"summary":"Gets the results for the given request","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/{requestId}/status",{"tags":["Brand Safety List"],"summary":"Gets the status of the given request","description":"When a user modifies their Brand Safety Deny List, the request is processed asynchronously, and a requestId is provided to the user. This requestId can be used to check the status of the request for up to 90 days from when the request was submitted.\n","operationId":"getRequestStatus","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"description":"The ID of the request previously submitted.","name":"requestId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","description":"The status of the request.","properties":{"requestStatus":{"type":"object","properties":{"requestId":{"type":"string","description":"Request ID"},"timestamp":{"type":"string","description":"Request timestamp"},"status":{"type":"string","description":"The status of the request","enum":["IN_PROGRESS","COMPLETED","FAILURE"]},"statusDetails":{"type":"string","description":"Details related to the request status"}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/getRequestStatus","sectionHeader":{"type":3,"text":"GET /sd/brandSafety/{requestId}/status"},"summary":"Gets the status of the given request","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/brandSafety/status",{"tags":["Brand Safety List"],"summary":"List status of all requests","description":"List status of all Brand Safety List requests. The list will contain requests that were submitted in the past 90 days.\n","operationId":"listRequestStatus","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","description":"List of all requests' status.","properties":{"requestStatusList":{"type":"array","description":"List of all requests' status.","items":{"type":"object","properties":{"requestId":{"type":"string","description":"Request ID"},"timestamp":{"type":"string","description":"Request timestamp"},"status":{"type":"string","description":"The status of the request","enum":["IN_PROGRESS","COMPLETED","FAILURE"]},"statusDetails":{"type":"string","description":"Details related to the request status"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Brand%20Safety%20List/operation/listRequestStatus","sectionHeader":{"type":3,"text":"GET /sd/brandSafety/status"},"summary":"List status of all requests","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/targets/bid/recommendations",{"tags":["Bid Recommendations"],"operationId":"getTargetBidRecommendations","summary":"Returns a set of bid recommendations for targeting clauses","description":"Provides a list of bid recommendations based on the list of input advertised ASINs and targeting clauses in the same format as the targeting API. For each targeting clause in the request a corresponding bid recommendation will be returned in the response. Currently the API will accept up to 100 targeting clauses. Note - these recommendations are only available when productAds have ASIN or SKU fields.\nThis API provides a corresponding bid recommendation for each targeting clause in a request. Currently the API will accept up to 100 targeting clauses.\n\nFor API v3.1, the API provides a list of bid recommendations based on the list of input advertised ASINs and targeting clauses in the same format as the targeting API. Note - these recommendations are only available when productAds have ASIN or SKU fields.\n\nFor API v3.2, the API accepts optimizationType and costType and returns bid recommendations accordingly.\n\nFor API v3.3, the API accepts creativeType and returns bid recommendations accordingly.\n\n[PREVIEW ONLY] For API v3.4, the API supports entertainment targeting bid recommendations which is currently limited to US marketplace.\n\nThe recommended bids are derived from the last 7 days of winning auction bids for the related targeting clause.\n\n\nReceive bid recommendations using the following:\nContextual targeting clause|Description|\n|-----------|----|\n|asinSameAs=B0123456789|Receive a bid recommendation for this target product\n|asinCategorySameAs=12345|Receive a bid recommendation for this target category\n|similarProduct|Receive a bid recommendation for targets that are similar to the advertised asins.\n\n\nAudience targeting clause|Description|\n|-----------|----|\n|views(asinCategorySameAs=12345 lookback=30)|Receive a bid recommendation for a target audience that has viewed products in the given category\n|views(similarProduct lookback=30)|Receive a bid recommendation for a target audience that has viewed similar products to the advertised asins\n|views(exactProduct lookback=30)|Receive a bid recommendation for a target audience that has viewed the advertised asins\n|purchases(asinCategorySameAs=12345 lookback=30)|Receive a bid recommendation for a target audience that has purchased products in the given category\n|purchases(exactProduct lookback=30)|Receive a bid recommendation for a target audience that has purchased the advertised asins\n|purchases(relatedProduct lookback=30)|Receive a bid recommendation for a target audience that has purchased related products to the advertised asins\n|audience(audienceSameAs=12345)|Receive a bid recommendation for the given target audience\n\n| Content targeting clause | Description |\n|------------------|-------------|\n| [PREVIEW ONLY] contentCategorySameAs=amzn1.iab-content.325 | Receive a bid recommendation for the given content target |\n\n\n#### Notes:\n- Refinements are currently not supported and if included will not impact the bid recommendation for the target.\n\n\n#### Advertised ASIN Notes:\n- For asinSameAs targets the advertised asins will not impact the bid recommendation\n- For asinCategorySameAs targets the advertised asins are optional, but including them will provide a more refined bid recommendation\n- For similarProduct, exactProduct, and relatedProduct targets the advertised asins are required","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.sdtargetingrecommendations.v3.4+json":{"schema":{"description":"Request for targeting bid recommendations.","example":{"products":[{"asin":"B01B8R6V2E"}],"bidOptimization":"reach","costType":"vcpm","creativeType":"VIDEO","targetingClauses":[{"targetingClause":{"expressionType":"manual","expression":[{"type":"views","value":[{"type":"similarProduct"},{"type":"lookback","value":"30"}]}]}}]},"required":["targetingClauses","bidOptimization","costType"],"properties":{"products":{"type":"array","minItems":0,"maxItems":10000,"description":"A list of products to tailor bid recommendations for category and audience based targeting clauses.\nThis array must contain consistent fields of either asins or landing pages (when linking to other pages), these cannot be mixed for any given request.\nIf landingPageUrl is used, only one item is allowed for the list.","items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}},"example":[{"asin":"B00PN11UNW"}]},"bidOptimization":{"type":"string","description":"Determines what the recommended bids will be optimized for. \n\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks|cpc|Optimize for page visits|\n|conversions|cpc|Optimize for conversion|","enum":["reach","clicks","conversions"]},"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"creativeType":{"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. Only supports one type (VIDEO or IMAGE) at a time.","type":"string","nullable":true,"enum":["IMAGE","VIDEO"]},"targetingClauses":{"type":"array","minItems":1,"maxItems":100,"description":"A list of targeting clauses to receive bid recommendations for.","items":{"type":"object","required":["targetingClause"],"properties":{"targetingClause":{"description":"The targeting clause","required":["expressionType","expression"],"type":"object","properties":{"expressionType":{"description":"Tactic T00020 ad groups only allow manual targeting.","type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can only contain 'TargetingPredicate' or 'ContentTargetingPredicate' components.\n* Expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","minItems":1,"items":{"oneOf":[{"type":"object","description":"A predicate to match against in the Targeting Expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","required":["type"],"properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","required":["type","value"],"properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The exactProduct, similarProduct, relatedProduct, and negative types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.","required":["type"],"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","relatedProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","required":["type","value"],"properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"amzn1.iab-content.325"}}}]}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.3+json":{"schema":{"description":"Request for targeting bid recommendations.","example":{"products":[{"asin":"B01B8R6V2E"}],"bidOptimization":"reach","costType":"vcpm","creativeType":"VIDEO","targetingClauses":[{"targetingClause":{"expressionType":"manual","expression":[{"type":"views","value":[{"type":"similarProduct"},{"type":"lookback","value":"30"}]}]}}]},"required":["targetingClauses","bidOptimization","costType"],"properties":{"products":{"type":"array","minItems":0,"maxItems":10000,"description":"A list of products to tailor bid recommendations for category and audience based targeting clauses.","items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"bidOptimization":{"type":"string","description":"Determines what the recommended bids will be optimized for. \n\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks|cpc|Optimize for page visits|\n|conversions|cpc|Optimize for conversion|","enum":["reach","clicks","conversions"]},"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"creativeType":{"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. Only supports one type (VIDEO or IMAGE) at a time.","type":"string","nullable":true,"enum":["IMAGE","VIDEO"]},"targetingClauses":{"type":"array","minItems":1,"maxItems":100,"description":"A list of targeting clauses to receive bid recommendations for.","items":{"type":"object","required":["targetingClause"],"properties":{"targetingClause":{"description":"The targeting clause","required":["expressionType","expression"],"type":"object","properties":{"expressionType":{"description":"Tactic T00020 ad groups only allow manual targeting.","type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can only contain 'TargetingPredicate' components.\n* Expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","minItems":1,"items":{"oneOf":[{"type":"object","description":"A predicate to match against in the Targeting Expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","required":["type"],"properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","required":["type","value"],"properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The exactProduct, similarProduct, relatedProduct, and negative types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.","required":["type"],"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","relatedProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.2+json":{"schema":{"description":"Request for targeting bid recommendations.","example":{"products":[{"asin":"B01B8R6V2E"}],"bidOptimization":"reach","costType":"vcpm","targetingClauses":[{"targetingClause":{"expressionType":"manual","expression":[{"type":"views","value":[{"type":"similarProduct"},{"type":"lookback","value":"30"}]}]}}]},"required":["targetingClauses","bidOptimization","costType"],"properties":{"products":{"type":"array","minItems":0,"maxItems":10000,"description":"A list of products to tailor bid recommendations for category and audience based targeting clauses.","items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"bidOptimization":{"type":"string","description":"Determines what the recommended bids will be optimized for. \n\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks|cpc|Optimize for page visits|\n|conversions|cpc|Optimize for conversion|","enum":["reach","clicks","conversions"]},"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"targetingClauses":{"type":"array","minItems":1,"maxItems":100,"description":"A list of targeting clauses to receive bid recommendations for.","items":{"type":"object","required":["targetingClause"],"properties":{"targetingClause":{"description":"The targeting clause","required":["expressionType","expression"],"type":"object","properties":{"expressionType":{"description":"Tactic T00020 ad groups only allow manual targeting.","type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can only contain 'TargetingPredicate' components.\n* Expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","minItems":1,"items":{"oneOf":[{"type":"object","description":"A predicate to match against in the Targeting Expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","required":["type"],"properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","required":["type","value"],"properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The exactProduct, similarProduct, relatedProduct, and negative types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.","required":["type"],"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","relatedProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}}}}}}},"application/vnd.sdtargetingrecommendations.v3.1+json":{"schema":{"description":"Request for targeting bid recommendations.","example":{"products":[{"asin":"B01B8R6V2E"}],"targetingClauses":[{"targetingClause":{"expressionType":"manual","expression":[{"type":"views","value":[{"type":"similarProduct"},{"type":"lookback","value":"30"}]}]}}]},"required":["targetingClauses"],"properties":{"products":{"type":"array","minItems":0,"maxItems":10000,"description":"A list of products to tailor bid recommendations for category and audience based targeting clauses.","items":{"description":"A product an advertisers wants to advertise. Recommendations will be made for specified goal products.","required":["asin"],"properties":{"asin":{"type":"string","description":"Amazon Standard Identification Number","example":"B00PN11UNW","pattern":"[a-zA-Z0-9]{10}"}}}},"targetingClauses":{"type":"array","minItems":1,"maxItems":100,"description":"A list of targeting clauses to receive bid recommendations for.","items":{"type":"object","required":["targetingClause"],"properties":{"targetingClause":{"description":"The targeting clause","required":["expressionType","expression"],"type":"object","properties":{"expressionType":{"description":"Tactic T00020 ad groups only allow manual targeting.","type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The targeting expression to match against.\n\n------- Applicable to contextual targeting (T00020) -------\n* A 'TargetingExpression' in a contextual targeting campaign can only contain 'TargetingPredicate' components.\n* Expressions must specify either a category predicate or an ASIN predicate, but never both.\n* Only one category may be specified per targeting expression.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression you must create a negative targeting expression in the same ad group as the positive targeting expression.\n\n------- Applicable to audiences or contextual targeting (T00030) -------\n* A 'TargetingExpression' in a audiences or contextual campaign can contain any target, including 'TargetingPredicate', 'ContentTargetingPredicate', or 'TargetingPredicateNested'.","minItems":1,"items":{"oneOf":[{"type":"object","description":"A predicate to match against in the Targeting Expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","required":["type"],"properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","required":["type","value"],"properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The exactProduct, similarProduct, relatedProduct, and negative types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.","required":["type"],"properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","relatedProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}}}}}}}}},"responses":{"207":{"description":"multi-status","content":{"application/vnd.sdtargetingrecommendations.v3.3+json":{"schema":{"description":"Response to a request for targeting bid recommendations.","required":["bidRecommendations","costType","bidOptimization"],"properties":{"bidOptimization":{"type":"string","description":"Determines what the recommended bids will be optimized for. \n\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks|cpc|Optimize for page visits|\n|conversions|cpc|Optimize for conversion|","enum":["reach","clicks","conversions"]},"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"bidRecommendations":{"minItems":1,"maxItems":100,"items":{"oneOf":[{"description":"A recommended bid range to use for a target.","required":["code"],"allOf":[{"description":"Success response for corresponding targeting clause on the request.","properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"200"}}},{"required":["rangeLower","rangeUpper","recommended"],"description":"A recommended bid range to use for a target.","properties":{"rangeLower":{"type":"number","description":"The lowest recommended bid to use to win an ad placement for this target.","example":0.5},"rangeUpper":{"type":"number","description":"The highest recommended bid to use to win an ad placement for this target.","example":1},"recommended":{"type":"number","description":"The recommended bid to use to win an ad placement for this target.","example":0.75}}}]},{"description":"Failed bid recommendation response.","required":["code","details"],"properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"400"},"details":{"type":"string","description":"A human-readable description of this item on error.","example":"Targeting expression does not conform to language specific rules."}}}]}}}}},"application/vnd.sdtargetingrecommendations.v3.2+json":{"schema":{"description":"Response to a request for targeting bid recommendations.","required":["bidRecommendations","costType","bidOptimization"],"properties":{"bidOptimization":{"type":"string","description":"Determines what the recommended bids will be optimized for. \n\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach|vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks|cpc|Optimize for page visits|\n|conversions|cpc|Optimize for conversion|","enum":["reach","clicks","conversions"]},"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"bidRecommendations":{"minItems":1,"maxItems":100,"items":{"oneOf":[{"description":"A recommended bid range to use for a target.","required":["code"],"allOf":[{"description":"Success response for corresponding targeting clause on the request.","properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"200"}}},{"required":["rangeLower","rangeUpper","recommended"],"description":"A recommended bid range to use for a target.","properties":{"rangeLower":{"type":"number","description":"The lowest recommended bid to use to win an ad placement for this target.","example":0.5},"rangeUpper":{"type":"number","description":"The highest recommended bid to use to win an ad placement for this target.","example":1},"recommended":{"type":"number","description":"The recommended bid to use to win an ad placement for this target.","example":0.75}}}]},{"description":"Failed bid recommendation response.","required":["code","details"],"properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"400"},"details":{"type":"string","description":"A human-readable description of this item on error.","example":"Targeting expression does not conform to language specific rules."}}}]}}}}},"application/vnd.sdtargetingrecommendations.v3.1+json":{"schema":{"description":"Response to a request for targeting bid recommendations.","required":["bidRecommendations","costType"],"properties":{"costType":{"description":"Determines what performance metric the bid recommendations will be optimized for.\n|Name|Description|\n|----|----------|-----------|\n|cpc|The bid recommendations will be optimized for clicks triggered by the ad.|\n|vcpm|The bid recommendations will be optimized for viewed impressions triggered by the ad. $1 is the minimum bid for vCPM.|","type":"string","enum":["cpc","vcpm"]},"bidRecommendations":{"minItems":1,"maxItems":100,"items":{"oneOf":[{"description":"A recommended bid range to use for a target.","required":["code"],"allOf":[{"description":"Success response for corresponding targeting clause on the request.","properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"200"}}},{"required":["rangeLower","rangeUpper","recommended"],"description":"A recommended bid range to use for a target.","properties":{"rangeLower":{"type":"number","description":"The lowest recommended bid to use to win an ad placement for this target.","example":0.5},"rangeUpper":{"type":"number","description":"The highest recommended bid to use to win an ad placement for this target.","example":1},"recommended":{"type":"number","description":"The recommended bid to use to win an ad placement for this target.","example":0.75}}}]},{"description":"Failed bid recommendation response.","required":["code","details"],"properties":{"code":{"type":"string","description":"The HTTP status code of this item.","example":"400"},"details":{"type":"string","description":"A human-readable description of this item on error.","example":"Targeting expression does not conform to language specific rules."}}}]}}}}}}},"400":{"description":"Generic bad request error.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Bid%20Recommendations/operation/getTargetBidRecommendations","sectionHeader":{"type":3,"text":"POST /sd/targets/bid/recommendations"},"summary":"Returns a set of bid recommendations for targeting clauses","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/recommendations/creative/headline",{"requestBody":{"description":"Request body for SD headline recommendations API.","content":{"application/vnd.sdheadlinerecommendationrequest.v4.0+json":{"schema":{"description":"Request structure of SD headline recommendation API.","type":"object","properties":{"asins":{"minItems":1,"maxItems":100,"description":"An array of ASINs associated with the creative.","type":"array","items":{"type":"string"}},"maxNumRecommendations":{"description":"Maximum number of recommendations that API should return. Response will [0, maxNumRecommendations] recommendations (recommendations are not guaranteed as there can be instances where the ML model can not generate policy compliant headlines for the given set of asins).","maximum":10,"type":"number","minimum":1},"adFormat":{"type":"string","enum":["SPONSORED_DISPLAY"]}}}}},"required":true},"description":"You can use this Sponsored Display API to retrieve creative headline recommendations from an array of ASINs.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_view\"]","operationId":"getHeadlineRecommendationsForSD","responses":{"200":{"description":"Successful operation.","content":{"application/vnd.sdheadlinerecommendationresponse.v4.0+json":{"schema":{"description":"Response structure of SD headline recommendation API.","type":"object","properties":{"requestId":{"description":"An identifier for request made which is generated by server.","type":"string"},"recommendations":{"minItems":1,"maxItems":10,"description":"Recommendations are sorted, i.e., more suitable headline has lesser array index value.","type":"array","items":{"description":"Recommended Headline in response object. Recommended headline will be locale specific, i.e. for an asin input in ES, Recommended headline will be in ES.","type":"object","properties":{"headlineId":{"description":"Unique Id of Recommended headline.","type":"string","example":"e991e32c-0136-427a-843b-ff04162f2f91"},"headline":{"description":"String that contains Recommended headline.","type":"string","maxLength":50,"example":"This is a Recommended headline."}}}}}}}}},"400":{"description":"SchemaValidationException 400 response.","content":{"application/vnd.sdheadlinerecommendationschemavalidationexception.v4.0+json":{"schema":{"type":"object","properties":{"code":{"description":"InvalidArgumentErrorCode.","type":"string","enum":["INVALID_ARGUMENT"]},"details":{"description":"A human-readable description of the error response.","type":"string"}}}}}},"403":{"description":"AccessDeniedException 403 response.","content":{"application/vnd.sdheadlinerecommendationaccessdeniedexception.v4.0+json":{"schema":{"type":"object","properties":{"code":{"description":"AccessDeniedErrorCode.","type":"string","enum":["ACCESS_DENIED"]},"details":{"description":"A human-readable description of the error response.","type":"string"}}}}}},"404":{"description":"IdentifierNotFoundException 404 response.","content":{"application/vnd.sdheadlinerecommendationidentifiernotfoundexception.v4.0+json":{"schema":{"type":"object","properties":{"code":{"description":"IdentiferNotFoundErrorCode.","type":"string","enum":["IDENTIFIER_NOT_FOUND"]},"details":{"description":"A human-readable description of the error response.","type":"string"}}}}}},"429":{"description":"ThrottlingException 429 response.","content":{"application/vnd.sdheadlinerecommendationthrottlingexception.v4.0+json":{"schema":{"type":"object","properties":{"code":{"description":"ThrottledErrorCode.","type":"string","enum":["THROTTLED"]},"details":{"description":"A human-readable description of the error response.","type":"string"}}}}}},"500":{"description":"InternalServerException 500 response.","content":{"application/vnd.sdheadlinerecommendationinternalserverexception.v4.0+json":{"schema":{"type":"object","properties":{"code":{"description":"InternalErrorCode.","type":"string","enum":["INTERNAL_ERROR"]},"details":{"description":"A human-readable description of the error response.","type":"string"}}}}}}},"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"tags":["Headline Recommendations"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Headline%20Recommendations/operation/getHeadlineRecommendationsForSD","sectionHeader":{"type":3,"text":"POST /sd/recommendations/creative/headline"},"documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/optimizationRules",{"tags":["Optimization Rules (beta)"],"summary":"Gets a list of optimization rules.","description":"Gets an array of OptimizationRule objects for a requested set of Sponsored Display optimization rules.","operationId":"listOptimizationRules","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. Sets a cursor into the requested set of optimization rules. Use in conjunction with the `count` parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Sets the number of OptimizationRule objects in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten optimization rules set `startIndex=0` and `count=10`. To return the next ten optimization rules, set `startIndex=10` and `count=10`, and so on. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. The returned array is filtered to include only optimization rules with state set to one of the values in the specified comma-delimited list.\nAvailable values:\n  - enabled\n  - paused [COMING LATER]\n  - enabled, paused [COMING LATER]","schema":{"type":"string","default":"enabled"}},{"name":"name","in":"query","description":"Optional. The returned array includes only optimization rules with the specified name using an exact string match.","schema":{"type":"string"}},{"name":"optimizationRuleIdFilter","in":"query","description":"Optional. The returned array is filtered to include only optimization rules associated with the optimization rule identifiers in the specified comma-delimited list.\n\nMaximum size limit 50.","schema":{"type":"string"}},{"name":"adGroupIdFilter","in":"query","description":"Optional. The returned array is filtered to include only optimization rules associated with the ad group identifiers in the comma-delimited list.\n\nMaximum size limit 50.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}},{"type":"object","properties":{"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)/operation/listOptimizationRules","sectionHeader":{"type":3,"text":"GET /sd/optimizationRules"},"summary":"Gets a list of optimization rules.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/optimizationRules",{"tags":["Optimization Rules (beta)"],"summary":"Updates one or more optimization rules.","operationId":"updateOptimizationRules","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of OptimizationRule objects. For each object, specify an optimization rule identifier and mutable fields with their updated values. The mutable fields are `ruleName`, `state`, and `ruleConditions`.","content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"required":["ruleId"],"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}},{"type":"object","properties":{"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)/operation/updateOptimizationRules","sectionHeader":{"type":3,"text":"PUT /sd/optimizationRules"},"summary":"Updates one or more optimization rules.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/optimizationRules",{"tags":["Optimization Rules (beta)"],"summary":"Creates one or more optimization rules, also known as outcome optimizations.","description":"\n* When an optimization rule is associated to an ad group, manual bids for individual targets will be overridden.\n* Optimization rules can only be associated to ad groups that have productAds with ASIN or SKU.\n* We may add targets while your campaign is running to try to stay at or below a cost per order value you have specified.\n* Only one optimization rule can be associated per adGroup. \n* If you are using optimization rules, the following campaign budget must be at least:\n  - 5x the value of any COST_PER_ORDER threshold.\n  - 10x the value of any COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS threshold.\n  - 20x the value of any COST_PER_CLICK threshold.","operationId":"createOptimizationRules","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of OptimizationRule objects. For each object, specify required fields and their values. Required fields are `state` and `ruleConditions`.","content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"example":{"state":"enabled","ruleName":"Optimization Rule Name","ruleConditions":[{"metricName":"COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","comparisonOperator":"LESS_THAN_OR_EQUAL_TO","threshold":1.5}]},"required":["state","ruleConditions"],"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}}]}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)/operation/createOptimizationRules","sectionHeader":{"type":3,"text":"POST /sd/optimizationRules"},"summary":"Creates one or more optimization rules, also known as outcome optimizations.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/optimizationRules/{optimizationRuleId}",{"tags":["Optimization Rules (beta)"],"summary":"Gets a requested optimization rule.","description":"Gets an OptimizationRule object for a requested Sponsored Display optimization rule.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"optimizationRuleId","in":"path","description":"The identifier of the requested optimization rule.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}},{"type":"object","properties":{"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)","sectionHeader":{"type":3,"text":"GET /sd/optimizationRules/{optimizationRuleId}"},"summary":"Gets a requested optimization rule.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/{adGroupId}/optimizationRules",{"tags":["Optimization Rules (beta)"],"summary":"Associate one or more optimization rules to an ad group specified by identifier.","description":"\n* When an optimization rule is associated to an ad group, manual bids for individual targets will be overridden.\n* Only one optimization rule can be associated per adGroup. This note will be removed when multiple rules are supported per adGroup.","operationId":"associateOptimizationRulesWithAdGroup","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"A list of optimization rule identifiers. Only one optimization rule identifier is currently supported per request. This note will be removed when multiple rule identifiers are supported.\n\nFor each ad group, only one optimization rule metric name is supported, based on the ad group's `bidOptimization` type. Refer to the following table for the metric names supported for each type.\n|  AdGroup.bidOptimization |     Supported OptimizationRule.metricName       |\n|------------------|--------------------|\n|   reach       | COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  |\n|   clicks      | COST_PER_CLICK          |\n|  conversions  | COST_PER_ORDER          |","content":{"application/json":{"schema":{"type":"object","properties":{"optimizationRuleIds":{"type":"array","description":"A list of optimization rule identifiers.","minItems":1,"maxItems":1,"items":{"type":"string","description":"The identifier of the optimization rule."}}}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"description":{"type":"string","description":"A human-readable description of the response."},"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)/operation/associateOptimizationRulesWithAdGroup","sectionHeader":{"type":3,"text":"POST /sd/adGroups/{adGroupId}/optimizationRules"},"summary":"Associate one or more optimization rules to an ad group specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/{adGroupId}/optimizationRules",{"tags":["Optimization Rules (beta)"],"summary":"Gets a list of optimization rules associated to an adgroup specified by identifier.","description":"Gets an OptimizationRule object for a requested Sponsored Display optimization rule.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}},{"type":"object","properties":{"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)","sectionHeader":{"type":3,"text":"GET /sd/adGroups/{adGroupId}/optimizationRules"},"summary":"Gets a list of optimization rules associated to an adgroup specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/adGroups/{adGroupId}/optimizationRules/disassociate",{"tags":["Optimization Rules (beta)"],"summary":"Disassociate one or more optimization rules from an ad group specified by identifier.","description":"\n* Only one optimization rule can be disassociated per adGroup. This note will be removed when multiple rules are supported per adGroup.\n* When an optimization rule is disassociated from an ad group, you can set the manual bids for the individual targets under the adGroup.","operationId":"disassociateOptimizationRulesFromAdGroup","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"adGroupId","in":"path","description":"The identifier of the ad group.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"A list of optimization rule identifiers. Only one optimization rule identifier is currently supported per request. This note will be removed when multiple rule identifiers are supported.","content":{"application/json":{"schema":{"type":"object","properties":{"optimizationRuleIds":{"type":"array","description":"A list of optimization rule identifiers.","minItems":1,"maxItems":1,"items":{"type":"string","description":"The identifier of the optimization rule."}}}}}},"required":false},"responses":{"207":{"description":"Multi-status.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"responses":{"type":"array","description":"An array of response objects. Each response object has code, details and optimizationRuleId.","maxItems":1,"items":{"type":"object","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."},"optimizationRuleId":{"type":"string","description":"The identifier of the optimization rule."}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Optimization%20Rules%20(beta)/operation/disassociateOptimizationRulesFromAdGroup","sectionHeader":{"type":3,"text":"POST /sd/adGroups/{adGroupId}/optimizationRules/disassociate"},"summary":"Disassociate one or more optimization rules from an ad group specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/forecasts",{"tags":["Forecasts"],"summary":"Return forecasts for an ad group that may or may not exist.","requestBody":{"content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"type":"object","description":"Request payload for SD forecasting. Below are required and optional fields. Fields not listed will not impact forecast results.\n|Field              |Object            |Required|\n|-------------------|------------------|--------|\n|startDate          |Campaign          |required|\n|endDate            |Campaign          |optional|\n|costType           |Campaign          |optional|\n|bidOptimization    |AdGroup           |required|\n|creativeType       |AdGroup           |optional|\n|defaultBid         |AdGroup           |optional|\n|asin               |ProductAds        |required for vendors|\n|sku                |ProductAds        |required for sellers|\n|bid                |TargetingClauses  |required when defaultBid is not set|\n|expression         |TargetingClauses  |required|\n|ruleConditions     |OptimizationRules |optional|","required":["campaign","adGroup","productAds","targetingClauses"],"properties":{"campaign":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"budgetType":{"type":"string","description":"The time period over which the amount specified in the `budget` property is allocated.","enum":["daily"]},"budget":{"type":"number","description":"The amount of the budget.","format":"double","example":"3.00"},"startDate":{"type":"string","description":"The YYYYMMDD start date of the campaign. The date must be today or in the future.","example":"20190101"},"endDate":{"type":"string","nullable":true,"description":"The YYYYMMDD end date of the campaign.","example":null},"costType":{"type":"string","description":"Determines how the campaign will bid and charge.\n|Name|Description|\n|----|----------|\n|cpc |[Default] The performance of this campaign is measured by the clicks triggered by the ad.|\n|vcpm |The performance of this campaign is measured by the viewed impressions triggered by the ad. |\n\nTo view minimum and maximum bids based on the costType, see [Limits](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace).","enum":["cpc","vcpm"]},"state":{"type":"string","description":"The state of the campaign.","enum":["enabled","paused","archived"]},"portfolioId":{"type":"integer","format":"int64","nullable":true,"description":"Identifier of the portfolio that will be associated with the campaign. If null then the campaign will be disassociated from existing portfolio. Campaigns with CPC and vCPM costType are supported.","example":null}}},{"type":"object","properties":{"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"deliveryProfile":{"type":"string","enum":["as_soon_as_possible"]},"ruleBasedBudget":{"type":"object","properties":{"isProcessing":{"type":"boolean"},"applicableRuleName":{"type":"string"},"value":{"format":"double","type":"number"},"applicableRuleId":{"type":"string"}}}}}]},"adGroup":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"defaultBid":{"type":"number","description":"The amount of the default bid associated with the ad group. Used if no bid is specified.","format":"double"},"bidOptimization":{"type":"string","description":"Bid Optimization for the Adgroup. Default behavior is to optimize for clicks.\n|Name|CostType|Description|\n|----|--------|-----------|\n|reach |vcpm|Optimize for viewable impressions. $1 is the minimum bid for vCPM.|\n|clicks |cpc|[Default] Optimize for page visits.|\n|conversions |cpc|Optimize for conversion.|","enum":["reach","clicks","conversions"]},"state":{"type":"string","description":"The state of the ad group.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"tactic":{"type":"string","description":"The advertising tactic associated with the campaign. The following table lists available tactic names:\n|Tactic Name|Type|Description|\n|-----------|-----|-----------|\n|T00020     |Contextual targeting | Choose individual products to show your ads in placements related to those products.<br> Choose individual categories to show your ads in placements related to those categories on and off Amazon.|\n|T00030     |Audiences or Contextual Targeting | Select individual products, categories, refined categories, or audiences to show your ads.|","example":"T00030","enum":["T00020","T00030"]},"creativeType":{"type":"string","nullable":true,"description":"The type of the associated creative. If the field is empty or null, a default value of IMAGE will be used. One ad group only supports one type (VIDEO or IMAGE) of creativeType at a time.\n|Name|Description|\n|----|-----------|\n|IMAGE |The creative will display static assets (e.g. headline, brandLogo or custom image).|\n|VIDEO |The creative will display video assets. This type of creative must have a video asset provided. Only supported when using productAds with ASIN or SKU.|","example":null,"enum":["IMAGE","VIDEO"]}}}]},"optimizationRules":{"type":"array","minItems":0,"maxItems":100,"description":"A list of SD optimization rules. Forecast will be affected by the optimization strategy rules.  Currently, supported rule metrics by forecast are `COST_PER_CLICK`, `COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS` and `COST_PER_ORDER`.","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the optimization rule.","enum":["enabled","paused [COMING LATER]"]},"ruleName":{"type":"string","description":"The name of the optimization rule."},"ruleConditions":{"type":"array","description":"A list of rule conditions that define the advertiser's intent for the outcome of the rule. The rule uses 'AND' logic to combine every condition in this list, and will validate the combination when the rule is created or updated.","minItems":1,"maxItems":1,"items":{"type":"object","description":"A rule condition that defines the advertiser's intent for the outcome of the rule.\nCertain actions are performed by the product to achieve and maintain the rule condition.","properties":{"metricName":{"type":"string","description":"The name of the metric.\nSupported rule metrics and corresponding supported comparisonOperators:\n|      MetricName      |ComparisonOperator  |Description|\n|------------------|--------------------|-------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS     |              LESS_THAN_OR_EQUAL_TO             |Maximize viewable impressions while cost per 1000 views less than or equal to `threshold`|\n|COST_PER_CLICK    |              LESS_THAN_OR_EQUAL_TO            |Maximize page visits while cost per click less than or equal to `threshold`|\n|COST_PER_ORDER    |              LESS_THAN_OR_EQUAL_TO            |Maximize viewable impressions/page visits/conversion while cost per order less than or equal to `threshold`|","enum":["COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS","COST_PER_CLICK","COST_PER_ORDER"]},"comparisonOperator":{"type":"string","description":"The comparison operator.","enum":["LESS_THAN_OR_EQUAL_TO"]},"threshold":{"type":"number","description":"The value of the threshold associated with the metric. The threshold values has defined minimums depending on the metric names in the following table:\n|                  MetricName            | Minimum of `threshold` Value  |\n|----------------------------------------|-----------------------------------|\n|COST_PER_THOUSAND_VIEWABLE_IMPRESSIONS  | 1                                 |\n|COST_PER_CLICK                          | 0.5                               |\n|COST_PER_ORDER                          | 5                                 |","format":"double","example":1.5}},"required":["metricName","comparisonOperator","threshold"]}}}},{"type":"object","properties":{"ruleId":{"type":"string","description":"The identifier of the optimization rule."}}}]}},"productAds":{"type":"array","minItems":1,"maxItems":100,"items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","description":"The state of the campaign associated with the product ad.","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"adId":{"type":"integer","format":"int64","description":"The identifier of the product ad."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"campaignId":{"type":"integer","format":"int64","description":"The identifier of the campaign."},"landingPageURL":{"type":"string","description":"The URL where customers will land after clicking on its link. Must be provided if a LandingPageType is set. Please note that if a single product ad sets the landing page url, only one product ad can be added to the ad group. This field is not supported when using ASIN or SKU fields.\n||Specifications|\n|------------------|------------------|\n|LandingPageType| Description|\n|STORE| The url should be in the format of https://www.amazon.com/stores/* (using a correct Amazon url based on the marketplace)|\n|OFF_AMAZON_LINK| The url should be in the format of https://www.****.com. Note that this LandingPageType is not supported when using ASIN or SKU fields. A custom creative of headline, logo, image are require for this LandingPageType. |\n|MOMENT| Not yet supported. The url should be in the format of https://www.amazon.com/moments/promotion/{campaignId} (using a correct Amazon url based on the marketplace)|"},"landingPageType":{"type":"string","description":"The type of the landingPage used. This field is completely optional and will be set in conjunction with the LandingPageURL to indicate the type of landing page that will be set. This field is not supported when using ASIN or SKU fields.","enum":["STORE","MOMENT","OFF_AMAZON_LINK"]},"adName":{"type":"string","description":"The name of the ad. Note that this field is not supported when using ASIN or SKU fields."},"asin":{"type":"string","description":"The Amazon ASIN of the product advertised by the product ad. This parameter is included in the response for sellers and vendors."},"sku":{"type":"string","description":"The Amazon SKU of the product advertised by the product ad. This parameter is included in the response for sellers."}}}]}},"targetingClauses":{"minItems":1,"maxItems":100,"description":"A list of SD targeting clauses.","type":"array","items":{"allOf":[{"type":"object","properties":{"state":{"type":"string","enum":["enabled","paused","archived"]},"bid":{"type":"number","description":"The bid will override the adGroup bid if specified. This field is not used for negative targeting clauses. The bid must be less than the maximum allowable bid for the campaign's marketplace; for a list of maximum allowable bids, find the [\"Bid constraints by marketplace\" table in our documentation overview](https://advertising.amazon.com/API/docs/en-us/concepts/limits#bid-constraints-by-marketplace). You cannot manually set a bid when the targeting clause's adGroup has an enabled optimization rule.","format":"float","nullable":true,"minimum":0.02}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expressionType":{"type":"string","enum":["manual","auto"],"description":"Tactic T00020 & T00030 ad groups should use 'manual' targeting."},"expression":{"type":"array","description":"The targeting expression to match against.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}},"resolvedExpression":{"type":"array","description":"The resolved targeting expression.","items":{"oneOf":[{"type":"object","description":"A predicate to match against in the targeting expression (only applicable to contextual targeting - T00020).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","similarProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}},{"type":"object","description":"A predicate to match against in the content targeting expression.","properties":{"type":{"type":"string","enum":["contentCategorySameAs"]},"value":{"type":"string","description":"The value to be targeted.\n\nThe following table shows all possible values of the `contentCategorySameAs` predicate.\n| Category              | Subcategory                             | Value                    |\n|-----------------------|-----------------------------------------|--------------------------|\n| Movies and Television | All Movies and Television               | amzn1.iab-content.SPSHQ5 |\n| Movies and Television | Action or Adventure                     | amzn1.iab-content.325    |\n| Movies and Television | Animation or Anime                      | amzn1.iab-content.641    |\n| Movies and Television | Biographies                             | amzn1.iab-content.44     |\n| Movies and Television | Comedy                                  | amzn1.iab-content.646    |\n| Movies and Television | Documentary                             | amzn1.iab-content.332    |\n| Movies and Television | Drama                                   | amzn1.iab-content.647    |\n| Movies and Television | Factual                                 | amzn1.iab-content.648    |\n| Movies and Television | Family                                  | amzn1.iab-content.645    |\n| Movies and Television | Fantasy                                 | amzn1.iab-content.335    |\n| Movies and Television | History                                 | amzn1.iab-content.EZWB7V |\n| Movies and Television | Holiday                                 | amzn1.iab-content.649    |\n| Movies and Television | Horror                                  | amzn1.iab-content.336    |\n| Movies and Television | Lifestyle                               | amzn1.iab-content.TIFQA5 |\n| Movies and Television | Music Video                             | amzn1.iab-content.650    |\n| Movies and Television | Musicals                                | amzn1.iab-content.156    |\n| Movies and Television | Mystery                                 | amzn1.iab-content.331    |\n| Movies and Television | Reality TV                              | amzn1.iab-content.651    |\n| Movies and Television | Romance                                 | amzn1.iab-content.326    |\n| Movies and Television | Science Fiction                         | amzn1.iab-content.652    |\n| Movies and Television | Soap Opera                              | amzn1.iab-content.642    |\n| Movies and Television | Special Interest (Indie or Art House)   | amzn1.iab-content.643    |\n| Movies and Television | Sports Radio                            | amzn1.iab-content.370    |\n| Movies and Television | Talk Show                               | amzn1.iab-content.A0AH3G |\n| Movies and Television | True Crime                              | amzn1.iab-content.KHPC5A |\n| Movies and Television | Western                                 | amzn1.iab-content.KHPC6A |\n| Music and Radio       | All Music and Radio                     | amzn1.iab-content.338    |\n| Music and Radio       | Blues                                   | amzn1.iab-content.360    |\n| Music and Radio       | Classical Music                         | amzn1.iab-content.346    |\n| Music and Radio       | Comedy (Music and Audio)                | amzn1.iab-content.348    |\n| Music and Radio       | Pop, Contemporary Hits, or Top 40 Music | amzn1.iab-content.349    |\n| Music and Radio       | Country Music                           | amzn1.iab-content.350    |\n| Music and Radio       | Dance and Electronic Music              | amzn1.iab-content.351    |\n| Music and Radio       | Hip Hop Music                           | amzn1.iab-content.355    |\n| Music and Radio       | Inspirational or New Age Music          | amzn1.iab-content.356    |\n| Music and Radio       | Jazz                                    | amzn1.iab-content.357    |\n| Music and Radio       | Oldies or Adult Standards               | amzn1.iab-content.358    |\n| Music and Radio       | R&B, Soul or Funk Music                 | amzn1.iab-content.362    |\n| Music and Radio       | Reggae                                  | amzn1.iab-content.359    |\n| Music and Radio       | Rock Music                              | amzn1.iab-content.363    |\n| Music and Radio       | Songwriters or Folk                     | amzn1.iab-content.353    |\n| Music and Radio       | World or International Music            | amzn1.iab-content.352    |\n| Video Games           | All Video Games                         | amzn1.iab-content.680    |\n| Video Games           | Action-Adventure Games                  | amzn1.iab-content.691    |\n| Video Games           | Casual Games                            | amzn1.iab-content.693    |\n| Video Games           | Puzzle Video Games                      | amzn1.iab-content.698    |\n| Video Games           | Racing Video Games                      | amzn1.iab-content.VK7KD0 |\n| Video Games           | Role-Playing Video Games                | amzn1.iab-content.687    |\n| Video Games           | Simulation Video Games                  | amzn1.iab-content.688    |\n| Video Games           | Sports Video Games                      | amzn1.iab-content.689    |\n| Video Games           | Strategy Video Games                    | amzn1.iab-content.690    |\n| Video Games           | PC Games                                | amzn1.iab-content.684    |\n| Video Games           | Mobile Games                            | amzn1.iab-content.683    |\n| Video Games           | Console Games                           | amzn1.iab-content.681    |\n| Video Games           | eSports                                 | amzn1.iab-content.682    |","example":"amzn1.iab-content.325"}}},{"type":"object","properties":{"type":{"type":"string","enum":["asinSameAs","asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"},"eventType":{"type":"string","description":"The type of event that the value applies to. Only available for similarProduct and exactProduct currently.\n* views event type corresponds to a customer who viewed the detail page of the product(s).","enum":["views"]}}},{"type":"object","description":"A behavioral event and list of targeting predicates that represents an audience to target (only applicable to audience targeting - T00030).\n\n* For manual ASIN-grain targeting, the value array must contain only, 'exactProduct', 'similarProduct', 'relatedProduct' and 'lookback' TargetingPredicateBase components. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For manual Category-grain targeting, the value array must contain a 'lookback' and 'asinCategorySameAs' TargetingPredicateBase component, which can be further refined with optional brand, price, star-rating and shipping eligibility refinements. The 'lookback' is mandatory and the value should be set to '7', '14', '30', '60', '90', '180' or '365'.\n* For Amazon Audiences targeting, the TargetingPredicateNested type should be set to 'audience' and the value array should include one TargetingPredicateBase component with type set to 'audienceSameAs'.","properties":{"type":{"type":"string","enum":["views","audience","purchases"]},"value":{"type":"array","items":{"type":"object","description":"A predicate to match against inside the TargetingPredicateNested component (only applicable to audience targeting - T00030).\n\n* All IDs passed for category and brand-targeting predicates must be valid IDs in the Amazon Ads browse system.\n* Brand, price, and review predicates are optional and may only be specified if category is also specified.\n* Review predicates accept numbers between 0 and 5 and are inclusive.\n* When using either of the 'between' strings to construct a targeting expression the format of the string is 'double-double' where the first double must be smaller than the second double. Prices are not inclusive.\n* The 'exactProduct', 'similarProduct', 'relatedProduct', 'negative', and 'audiencesLikelyInterestedInAd' types do not utilize the value field.\n* The only type currently applicable to Amazon Audiences targeting is 'audienceSameAs'.\n* A 'relatedProduct' TargetingPredicateBase will Target an audience that has purchased a related product in the past 7,14,30,60,90,180, or 365 days.\n* The 'audiencesLikelyInterestedInAd' type is only supported when using landingPageType of OFF_AMAZON_LINK.","properties":{"type":{"type":"string","enum":["asinCategorySameAs","asinBrandSameAs","asinPriceBetween","asinPriceGreaterThan","asinPriceLessThan","asinReviewRatingLessThan","asinReviewRatingGreaterThan","asinReviewRatingBetween","similarProduct","exactProduct","asinIsPrimeShippingEligible","asinAgeRangeSameAs","asinGenreSameAs","audienceSameAs","lookback","negative","relatedProduct"]},"value":{"type":"string","description":"The value to be targeted.","example":"B0123456789"}}}}}}]}}}}]}},"negativeTargetingClauses":{"minItems":1,"maxItems":100,"description":"A list of SD negative targeting clauses.","type":"array","items":{"allOf":[{"properties":{"state":{"type":"string","enum":["enabled","paused","archived"]}}},{"type":"object","properties":{"targetId":{"type":"integer","format":"int64"},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expressionType":{"type":"string","enum":["manual","auto"]},"expression":{"type":"array","description":"The expression to negatively match against.\n* Only one brand may be specified per targeting expression.\n* Only one asin may be specified per targeting expression.\n* To exclude a brand from a targeting expression, you must create a negative targeting expression in the same ad group as the positive targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}},"resolvedExpression":{"type":"array","description":"The resolved negative targeting expression.","items":{"type":"object","properties":{"type":{"type":"string","description":"The intent type. See the [targeting topic](https://advertising.amazon.com/help#GQCBASRVERXSARL3) in the Amazon Ads support center for more information.","enum":["asinSameAs","asinBrandSameAs"]},"value":{"type":"string","description":"The value to be negatively targeted. Used only in manual expressions.","example":"B0123456789"}}}}}}]}},"locationExpressions":{"minItems":0,"maxItems":100,"description":"A list of location expressions. Only applicable for advertisers using landingPageType of OFF_AMAZON_LINK.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.","example":"amzn1.ad-geo.XHvCjcKHXmJ7woVowo7CjmvCjcKWbMKHwp3CsGvCk8KrcmstQ2l0eQ=="}}}}}}}}},"operationId":"createSDForecast","description":"Returns forecasts for a given ad group specified in SD forecast request.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"description":"Response to a request for SD forecasting.","type":"object","properties":{"bidOptimization":{"type":"string"},"lifetimeForecasts":{"description":"Forecasts for campaign start date and end date. Default end date is start date plus 7 days.","type":"array","minItems":1,"maxItems":4,"items":{"description":"Forecast impressions, clicks, reach, or conversions.","type":"object","properties":{"metric":{"type":"string","description":"Describes which metric is forecasted.\n|Name|Description|\n|-----------|------------------------|\n|IMPRESSIONS| Available impressions|\n|REACH      | Delivered viewable impressions|\n|CLICKS     | Delivered page visits|\n|CONVERSIONS| [Preview only] Delivered conversions|","enum":["IMPRESSIONS","REACH","CLICKS","CONVERSIONS"]},"value":{"description":"Forecast range values.","properties":{"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}}},"weeklyForecasts":{"description":"Weekly average forecasts.","type":"array","minItems":1,"maxItems":4,"items":{"description":"Forecast impressions, clicks, reach, or conversions.","type":"object","properties":{"metric":{"type":"string","description":"Describes which metric is forecasted.\n|Name|Description|\n|-----------|------------------------|\n|IMPRESSIONS| Available impressions|\n|REACH      | Delivered viewable impressions|\n|CLICKS     | Delivered page visits|\n|CONVERSIONS| [Preview only] Delivered conversions|","enum":["IMPRESSIONS","REACH","CLICKS","CONVERSIONS"]},"value":{"description":"Forecast range values.","properties":{"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}}},"dailyForecasts":{"description":"Daily average forecasts.","type":"array","minItems":1,"maxItems":4,"items":{"description":"Forecast impressions, clicks, reach, or conversions.","type":"object","properties":{"metric":{"type":"string","description":"Describes which metric is forecasted.\n|Name|Description|\n|-----------|------------------------|\n|IMPRESSIONS| Available impressions|\n|REACH      | Delivered viewable impressions|\n|CLICKS     | Delivered page visits|\n|CONVERSIONS| [Preview only] Delivered conversions|","enum":["IMPRESSIONS","REACH","CLICKS","CONVERSIONS"]},"value":{"description":"Forecast range values.","properties":{"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}}}}},"curves":{"description":"Forecasting curves.","type":"array","minItems":0,"maxItems":10,"items":{"description":"Forecast curve of a certain type. The type could be budget vs forecast outcome.","type":"object","properties":{"meetThreshold":{"type":"boolean","description":"True if the budget utilization is good to show the curve."},"graph":{"type":"string","description":"Type of Graph.","enum":["BUDGET"]},"points":{"type":"array","minItems":50,"maxItems":100,"items":{"description":"A single point on a curve.","type":"object","properties":{"isFocus":{"type":"boolean","description":"If this point is the point with the focus circle."},"x":{"type":"object","description":"x-axis value.","items":{"type":"object","properties":{"value":{"type":"number","format":"double"}}}},"y":{"type":"array","description":"y-axis value of multiple KPI types.","minItems":0,"maxItems":2,"items":{"description":"A ranged value.","type":"object","properties":{"label":{"type":"string","description":"KPI label.","enum":["CLICKS","REACH"]},"value":{"description":"A range of value.","type":"object","properties":{"min":{"type":"number","format":"double","description":"Lower bound."},"mean":{"type":"number","format":"double","description":"Geometric mean of the upper and lower bounds."},"max":{"type":"number","format":"double","description":"Upper bound."}}}}}}}}}}}},"forecastStatus":{"description":"It contains the forecast status. The IMPRESSION_TARGETING_TOO_NARROW field means the targeting  clauses are too narrow, and the IMPRESSION_TARGETING_TOO_BROAD field means the targeting clauses are too broad,  so our inventory impression forecast won't provide any useful information. The COMPLETE field means all the forecasts are complete.","type":"string","enum":["IMPRESSION_TARGETING_TOO_NARROW","IMPRESSION_TARGETING_TOO_BROAD","COMPLETE"]}}}}}},"400":{"description":"Bad Request.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/vnd.sdforecasts.v3.1+json":{"schema":{"properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Forecasts/operation/createSDForecast","sectionHeader":{"type":3,"text":"POST /sd/forecasts"},"summary":"Return forecasts for an ad group that may or may not exist.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/budgetRules/{budgetRuleId}",{"summary":"Gets a budget rule specified by identifier.","operationId":"GetBudgetRuleByRuleIdForSDCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"budgetRule":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"description":"Object representing details of a budget rule for SD campaign","type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss'","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time.","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["ACOS","CTR","CVR","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/GetBudgetRuleByRuleIdForSDCampaigns","sectionHeader":{"type":3,"text":"GET /sd/budgetRules/{budgetRuleId}"},"summary":"Gets a budget rule specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/budgetRules",{"summary":"Creates one or more budget rules.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"budgetRulesDetails":{"maxItems":25,"description":"A list of budget rule details.","type":"array","items":{"description":"Object representing details of a budget rule for SD campaign","type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss'","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time.","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["ACOS","CTR","CVR","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}}}}}}},"required":true},"operationId":"CreateBudgetRulesForSDCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The rule identifier.","type":"string"},"associatedCampaignIds":{"type":"array","items":{"description":"The campaign identifier for which rule based budget may get updated","type":"string"}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetRuleError - Something went wrong on the server. Retry later and report an BudgetRuleError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/CreateBudgetRulesForSDCampaigns","sectionHeader":{"type":3,"text":"POST /sd/budgetRules"},"summary":"Creates one or more budget rules.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/budgetRules",{"summary":"Get all budget rules created by an advertiser","operationId":"GetSDBudgetRulesForAdvertiser","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"budgetRulesForAdvertiserResponse":{"minItems":0,"maxItems":30,"description":"A list of rules created by the advertiser.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"description":"Object representing details of a budget rule for SD campaign","type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss'","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time.","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["ACOS","CTR","CVR","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"query","name":"nextToken","description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results."},{"schema":{"type":"number"},"in":"query","name":"pageSize","description":"Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/GetSDBudgetRulesForAdvertiser","sectionHeader":{"type":3,"text":"GET /sd/budgetRules"},"summary":"Get all budget rules created by an advertiser","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/budgetRules",{"summary":"Update one or more budget rules.","requestBody":{"content":{"application/json":{"schema":{"description":"Request object for updating budget rule for SD campaign","type":"object","properties":{"budgetRulesDetails":{"maxItems":25,"description":"A list of budget rule details.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"description":"Object representing details of a budget rule for SD campaign","type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss'","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time.","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["ACOS","CTR","CVR","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}}}}}},"required":true},"operationId":"UpdateBudgetRulesForSDCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The rule identifier.","type":"string"},"associatedCampaignIds":{"type":"array","items":{"description":"The campaign identifier for which rule based budget may get updated","type":"string"}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetRuleError - Something went wrong on the server. Retry later and report an BudgetRuleError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/UpdateBudgetRulesForSDCampaigns","sectionHeader":{"type":3,"text":"PUT /sd/budgetRules"},"summary":"Update one or more budget rules.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/budgetRules/{budgetRuleId}/campaigns",{"summary":"Gets all the campaigns associated with a budget rule","operationId":"GetCampaignsAssociatedWithSDBudgetRule","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"associatedCampaigns":{"minItems":0,"maxItems":30,"description":"A list of campaigns that are associated to this budget rule.","type":"array","items":{"type":"object","required":["campaignId","campaignName","ruleStatus"],"properties":{"campaignId":{"description":"The campaign identifier.","type":"string"},"ruleStatus":{"description":"The budget rule evaluation status for this campaign. Read-only.","type":"string"},"campaignName":{"description":"The campaign name.","type":"string"}}}},"nextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results.","type":"string"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true},{"schema":{"type":"string"},"in":"query","name":"nextToken","description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the `nextToken` field is empty, there are no further results."},{"schema":{"type":"number"},"in":"query","name":"pageSize","description":"Sets a limit on the number of results returned. Maximum limit of `pageSize` is 30.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/GetCampaignsAssociatedWithSDBudgetRule","sectionHeader":{"type":3,"text":"GET /sd/budgetRules/{budgetRuleId}/campaigns"},"summary":"Gets all the campaigns associated with a budget rule","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/{campaignId}/budgetRules/{budgetRuleId}",{"summary":"Disassociates a budget rule specified by identifier from a campaign specified by identifier.","operationId":"DisassociateAssociatedBudgetRuleForSDCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true},{"schema":{"type":"string"},"in":"path","name":"budgetRuleId","description":"The budget rule identifier.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/DisassociateAssociatedBudgetRuleForSDCampaigns","sectionHeader":{"type":3,"text":"DELETE /sd/campaigns/{campaignId}/budgetRules/{budgetRuleId}"},"summary":"Disassociates a budget rule specified by identifier from a campaign specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/{campaignId}/budgetRules",{"summary":"Associates one or more budget rules to a campaign specified by identifer.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"budgetRuleIds":{"maxItems":25,"description":"A list of budget rule identifiers.","type":"array","items":{"type":"string"}}}}}},"required":true},"description":"A maximum of 250 rules can be associated to a campaign. Note that the name of each rule associated to a campaign is required to be unique.","operationId":"CreateAssociatedBudgetRulesForSDCampaigns","responses":{"207":{"description":"Multi-status. An object containing a list of associated budget rule response objects reflecting the same order as the input.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the error, if unsuccessful","type":"string"},"ruleId":{"description":"The budget rule identifier.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/CreateAssociatedBudgetRulesForSDCampaigns","sectionHeader":{"type":3,"text":"POST /sd/campaigns/{campaignId}/budgetRules"},"summary":"Associates one or more budget rules to a campaign specified by identifer.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/{campaignId}/budgetRules",{"summary":"Gets a list of budget rules associated to a campaign specified by identifier.","operationId":"ListAssociatedBudgetRulesForSDCampaigns","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","properties":{"associatedRules":{"description":"A list of associated budget rules.","type":"array","items":{"type":"object","required":["ruleId"],"properties":{"ruleState":{"description":"The budget rule state.","type":"string","enum":["ACTIVE","PAUSED"]},"lastUpdatedDate":{"format":"int64","description":"Epoch time of budget rule update. Read-only.","type":"number"},"createdDate":{"format":"int64","description":"Epoch time of budget rule creation. Read-only.","type":"number"},"ruleDetails":{"description":"Object representing details of a budget rule for SD campaign","type":"object","properties":{"duration":{"type":"object","properties":{"eventTypeRuleDuration":{"description":"Object representing event type rule duration.","type":"object","required":["eventId"],"properties":{"eventId":{"description":"The event identifier. This value is available from the budget rules recommendation API.","type":"string"},"endDate":{"description":"The event end date in YYYYMMDD format. Read-only.","type":"string"},"eventName":{"description":"The event name. Read-only.","type":"string"},"startDate":{"description":"The event start date in YYYYMMDD format. Read-only. Note that this field is present only for announced events.","type":"string"}}},"dateRangeTypeRuleDuration":{"description":"Object representing date range type rule duration.","type":"object","required":["startDate"],"properties":{"endDate":{"description":"The end date of the budget rule in YYYYMMDD format. The end date is inclusive. Required to be equal or greater than `startDate`.","type":"string"},"startDate":{"description":"The start date of the budget rule in YYYYMMDD format. The start date is inclusive. Required to be greater than or equal to current date.","type":"string"}}}}},"recurrence":{"type":"object","properties":{"type":{"description":"depicts the type of recurrence","type":"string","enum":["DAILY","WEEKLY"]},"daysOfWeek":{"description":"Object representing days of the week for weekly type rule. It is not required for daily recurrence type","type":"array","items":{"description":"The day of the week.","type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"intraDaySchedule":{"maxItems":1,"description":"List of objects representing start and end time of desired intra-day budget rule window","type":"array","items":{"type":"object","properties":{"startTime":{"description":"The start time of intra-day budget rule window in the format 'hh:mm:ss'","type":"string"},"endTime":{"description":"The end time of intra-day budget rule window in the format 'hh:mm:ss'. Required to be greater than start-time.","type":"string"}}}}}},"ruleType":{"description":"The type of budget rule. SCHEDULE: A budget rule based on a start and end date. PERFORMANCE: A budget rule based on advertising performance criteria.","type":"string","enum":["SCHEDULE","PERFORMANCE"]},"budgetIncreaseBy":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The value by which to update the budget of the budget rule.","type":"string","enum":["PERCENT"]},"value":{"format":"double","description":"The budget value.","type":"number"}}},"name":{"description":"The budget rule name. Required to be unique within a campaign.","type":"string","maxLength":355},"performanceMeasureCondition":{"type":"object","required":["comparisonOperator","metricName","threshold"],"properties":{"metricName":{"description":"The advertising performance metric.","type":"string","enum":["ACOS","CTR","CVR","ROAS"]},"comparisonOperator":{"description":"The comparison operator.","type":"string","enum":["GREATER_THAN","LESS_THAN","LESS_THAN_OR_EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"]},"threshold":{"format":"double","description":"The performance threshold value.","type":"number"}}}}},"ruleId":{"description":"The budget rule identifier.","type":"string"},"ruleStatus":{"description":"The budget rule status. Read-only.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"description":"**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"format":"int64","type":"number"},"in":"path","name":"campaignId","description":"The campaign identifier.","required":true}],"tags":["Budget Rules"]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Rules/operation/ListAssociatedBudgetRulesForSDCampaigns","sectionHeader":{"type":3,"text":"GET /sd/campaigns/{campaignId}/budgetRules"},"summary":"Gets a list of budget rules associated to a campaign specified by identifier.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/campaigns/budget/usage",{"summary":"Budget usage API for SD campaigns","description":"**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","tags":["Budget Usage"],"requestBody":{"content":{"application/vnd.sdcampaignbudgetusage.v1+json":{"schema":{"type":"object","properties":{"campaignIds":{"minItems":1,"maxItems":100,"description":"A list of campaign IDs","type":"array","items":{"type":"string"}}}}}}},"operationId":"sdCampaignsBudgetUsage","responses":{"207":{"description":"Multi-status. An object containing a list of budget usage response objects reflecting the same order as the input.","content":{"application/vnd.sdcampaignbudgetusage.v1+json":{"schema":{"type":"object","properties":{"success":{"description":"List of budget usage percentages that were successfully pulled","type":"array","items":{"type":"object","properties":{"budgetUsagePercent":{"description":"Budget usage percentage (spend / available budget) for the given budget policy.","type":"number"},"campaignId":{"description":"ID of requested resource","type":"string"},"usageUpdatedTimestamp":{"format":"date-time","description":"Last evaluation time for budget usage","type":"string"},"index":{"description":"An index to maintain order of the campaignIds","type":"number"},"budget":{"description":"Budget amount of resource requested","type":"number"}}}},"error":{"description":"List of budget usage percentages that failed to pull","type":"array","items":{"type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"campaignId":{"description":"ID of requested resource","type":"string"},"index":{"description":"An index to maintain order of the campaignIds","type":"number"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"403":{"description":"Forbidden. The request failed because user does not have access to a specified resource.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"422":{"description":"Unprocessable entity. The server understood the request, but was unable to process the instruction.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}},"500":{"description":"Internal Server BudgetUsageError - Something went wrong on the server. Retry later and report an BudgetUsageError if unresolved.","content":{"application/json":{"schema":{"description":"The Error Response Object.","type":"object","properties":{"code":{"description":"An enumerated error code for machine use.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a \"Login with Amazon\" account. This is a required header for advertisers and integrators using the Advertising API.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. This is a required header for advertisers and integrators using the Advertising API.","required":true}]}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Budget%20Usage/operation/sdCampaignsBudgetUsage","sectionHeader":{"type":3,"text":"POST /sd/campaigns/budget/usage"},"summary":"Budget usage API for SD campaigns","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/locations",{"tags":["Locations (beta)"],"summary":"Gets a list of locations associated with ad groups.","description":"Gets a list of Sponsored Display Location objects. This resource is not available when productAds have ASIN or SKU fields and only available for advertisers that do not sell products on Amazon. See [Developer Guide](https://advertising.amazon.com/API/docs/en-us/guides/sponsored-display/non-amazon-sellers/get-started)","operationId":"listLocations","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Optional. 0-indexed record offset for the result set. Defaults to 0.","schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","description":"Optional. Number of records to include in the paged response. Defaults to max page size.","schema":{"type":"integer","format":"int32"}},{"name":"stateFilter","in":"query","description":"Optional. Restricts results to those with state within the specified comma-separated list. Must be one of: `enabled`.","schema":{"type":"string","enum":["enabled"],"default":"enabled"}},{"name":"adGroupIdFilter","in":"query","description":"Optional list of comma separated adGroupIds. Restricts results to locations with the specified `adGroupId`.","schema":{"type":"string"}},{"name":"campaignIdFilter","in":"query","description":"Optional list of comma separated campaignIds. Restricts results to locations with the specified `campaignId`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"properties":{"state":{"type":"string","enum":["enabled"]}}},{"type":"object","properties":{"locationExpressionId":{"type":"integer","format":"int64","description":"The identifier of the location."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expression":{"type":"array","description":"The Location definition.","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.","example":"amzn1.ad-geo.XHvCjcKHXmJ7woVowo7CjmvCjcKWbMKHwp3CsGvCk8KrcmstQ2l0eQ=="}}}},"resolvedExpression":{"type":"array","description":"The human-readable location definition.","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The human-readable location name.","example":"New York City, New York, US"}}}}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Locations%20(beta)/operation/listLocations","sectionHeader":{"type":3,"text":"GET /sd/locations"},"summary":"Gets a list of locations associated with ad groups.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/locations",{"tags":["Locations (beta)"],"summary":"Creates one or more locations associated with an ad group.","description":"This resource is not available when productAds have ASIN or SKU fields and only available for advertisers that do not sell products on Amazon.   See [Developer Guide](https://advertising.amazon.com/API/docs/en-us/guides/sponsored-display/non-amazon-sellers/get-started)\n\nLocations optimize Ad Groups for delivery to users that have an association with those locations. For example,\nan Ad Group might contain the following: \n- A Targeting Clause representing an audience of users that viewed a shoe \n- A Location representing Seattle, Washington, USA.\n- A Location representing New York, New York, USA.\nIn this case, delivery of the Targeting Clause will be optimized for New York and Seattle.\n\n\nYou can discover predefined Locations to use in your ad group by calling the GET /locations API. The table below lists \nseveral example Locations.\n| Location | Description |\n|---------------------------|-------------|\n| location=amzn1.ad-geo.XHvCjcKHXsKUwos= | Optimize the ad group for the specified location (either a 'city', 'state', 'dma', 'postal code', or 'country').|\n\nUsing locations is optional. ","operationId":"createLocations","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of up to 100 Locations for creation for each call.  1000 locations can be added for each ad group.","content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":20,"items":{"required":["adGroupId","expression","state"],"allOf":[{"properties":{"state":{"type":"string","enum":["enabled"]}}},{"type":"object","properties":{"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expression":{"type":"array","description":"The location definition.","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.","example":"amzn1.ad-geo.XHvCjcKHXmJ7woVowo7CjmvCjcKWbMKHwp3CsGvCk8KrcmstQ2l0eQ=="}}}}}}]}}}},"required":false},"responses":{"200":{"description":"An array of Locations.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"properties":{"state":{"type":"string","enum":["enabled"]}}},{"type":"object","properties":{"locationExpressionId":{"type":"integer","format":"int64","description":"The identifier of the location."},"adGroupId":{"type":"integer","format":"int64","description":"The identifier of the ad group."},"expression":{"type":"array","description":"The Location definition.","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The location identifier. Currently, this can correspond to either a 'city', 'state', 'dma', 'postal code', or 'country'. Its value is discoverable using the GET /locations API.","example":"amzn1.ad-geo.XHvCjcKHXmJ7woVowo7CjmvCjcKWbMKHwp3CsGvCk8KrcmstQ2l0eQ=="}}}},"resolvedExpression":{"type":"array","description":"The human-readable location definition.","items":{"type":"object","properties":{"type":{"type":"string","description":"The location category.","enum":["location"]},"value":{"type":"string","description":"The human-readable location name.","example":"New York City, New York, US"}}}}}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"a-pplication/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Locations%20(beta)/operation/createLocations","sectionHeader":{"type":3,"text":"POST /sd/locations"},"summary":"Creates one or more locations associated with an ad group.","documentType":"api-reference"},{"title":"Amazon Ads API for Sponsored Display","content":["/sd/locations/delete",{"tags":["Locations (beta)"],"summary":"Sets the `state` of each Location clause given to `archived`.","description":"This is a bulk operation that accepts up to a limit of 1000 Location Expression Ids at a time.\nThis deletion operation is equivalent to using the `updateTargetingClauses` operation to set the `state` property of a Location clause to `archived`.","operationId":"archiveLocations","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A list of up to 1000 Location Expression Ids for archival.","content":{"application/json":{"schema":{"description":"Request body for the Archive Locations API","type":"object","required":["LocationExpressionIdFilter"],"properties":{"locationExpressionIdFilter":{"description":"Filter entities by the list of objectIds","required":["include"],"properties":{"include":{"description":"Array of Location Expression Ids","type":"array","minItems":1,"maxItems":1000,"items":{"type":"integer","format":"int64","description":"The identifier of the location."}}}}}}}},"required":true},"responses":{"207":{"description":"An array response containing a response for each Location Expression","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Returns \"SUCCESS\" for a successful response, otherwise a HTTP error code"},"description":{"type":"string","description":"A human-readable description of the response if there is an error"},"locationExpressionId":{"type":"integer","format":"int64","description":"The identifier of the location."}}}}}}},"400":{"description":"Bad Request - Request failed because payload is empty, includes invalid types, or exceeds batch limit.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"422":{"description":"Unprocessable Entity - Request was understood, but contained invalid parameters","content":{"a-pplication/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"type":"object","description":"The error response object.","properties":{"code":{"type":"string","description":"The HTTP status code of the response."},"details":{"type":"string","description":"A human-readable description of the response."}}}}}}}}],"path":"/en-us/sponsored-display/3-0/openapi#tag/Locations%20(beta)/operation/archiveLocations","sectionHeader":{"type":3,"text":"POST /sd/locations/delete"},"summary":"Sets the `state` of each Location clause given to `archived`.","documentType":"api-reference"},{"title":"Amazon Ads API for DSP","content":["Retrieve information of DSP advertisers.\n"],"path":"/en-us/dsp-advertiser","sectionHeader":{"type":2,"text":"Amazon Ads API for DSP"},"documentType":"api-reference"},{"title":"Amazon Ads API for DSP","content":["/dsp/advertisers/{advertiserId}",{"description":"Returns advertiser information based on given advertiser id.","tags":["Advertiser"],"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The client identifier of the customer making the request.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"advertiserId","in":"path","description":"Unique id to identify advertiser","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","description":"The DSP Advertiser object","properties":{"advertiserId":{"type":"string","description":"The advertiser identifier.","example":"4728736040201"},"name":{"type":"string","description":"The advertiser name.","example":"DSP Public API Advertiser"},"currency":{"type":"string","description":"The supported currencies.","enum":["USD","CAD","JPY","GBP","EUR","INR","MXN","AED","SAR","BRL","AUD","SEK","SGD","TRY"],"example":"USD"},"url":{"type":"string","description":"The URL of the advertiser’s website.","example":"www.example.com"},"country":{"type":"string","description":"The country code.","enum":["US","CA","MX","JP","AU","IN","UK","GB","DE","FR","IT","ES","AT","AE","SA","BR","NL","SE","SG","TR"],"example":"US"},"timezone":{"type":"string","description":"The advertiser timezone.\n- America/Anchorage\n- America/Caracas\n- America/Chicago\n- America/Denver\n- America/Halifax\n- America/Los_Angeles\n- America/New_York\n- America/Sao_Paulo\n- America/St_Johns\n- Asia/Almaty\n- Asia/Baghdad\n- Asia/Bangkok\n- Asia/Hong_Kong\n- Asia/Kabul\n- Asia/Kathmandu\n- Asia/Kolkata\n- Asia/Magadan\n- Asia/Shanghai\n- Asia/Tehran\n- Asia/Tokyo\n- Asia/Yekaterinburg\n- Asia/Yerevan\n- Atlantic/Azores\n- Atlantic/South_Georgia\n- Australia/Brisbane\n- Australia/Darwin\n- Europe/London\n- Europe/Paris\n- Indian/Cocos\n- Pacific/Fiji\n- Pacific/Honolulu\n- Pacific/Kwajalein\n- Pacific/Midway\n"},"isRegional":{"type":"boolean","description":"Set to `true` if account is associated with a Global Advertiser Account.","example":false}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"422":{"description":"Unprocessable entity - Failed due to invalid parameters.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Validation Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"DSP_INVALID_PATH_PARAM","field":"advertiserId","message":"AdvertiserId must be a valid numeric id."}]}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-advertiser#tag/Advertiser","sectionHeader":{"type":3,"text":"GET /dsp/advertisers/{advertiserId}"},"documentType":"api-reference"},{"title":"Amazon Ads API for DSP","content":["/dsp/advertisers",{"description":"Returns a list of advertisers with information which satisfy the filtering criteria.","tags":["Advertiser"],"parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The client identifier of the customer making the request.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"Sets a cursor into the requested set of advertisers. Use in conjunction with the count parameter to control pagination of the returned array. 0-indexed record offset for the result set, defaults to 0.","schema":{"type":"integer","format":"int32","maximum":29900,"default":0}},{"name":"count","in":"query","description":"Sets the number of advertisers to be returned in a single call. Maximum of 100 advertisers per call.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":100}},{"name":"advertiserIdFilter","in":"query","description":"List of comma separated advertiser ids to filter the advertisers. If no advertiser ids provided, all advertisers in this entity will be returned.","schema":{"type":"string"},"example":"6753579448901,8753890875385"}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","description":"List of advertisers along with total number of advertisers which satisfy the filtering criteria.","properties":{"totalResults":{"type":"integer","format":"int32","description":"Total number of advertisers which satisfy the filtering criteria. This number is given to support pagination and tell the client if there are more advertisers to be fetched.","example":1100},"response":{"type":"array","description":"List of advertisers with complete information.","items":{"type":"object","description":"The DSP Advertiser object","properties":{"advertiserId":{"type":"string","description":"The advertiser identifier.","example":"4728736040201"},"name":{"type":"string","description":"The advertiser name.","example":"DSP Public API Advertiser"},"currency":{"type":"string","description":"The supported currencies.","enum":["USD","CAD","JPY","GBP","EUR","INR","MXN","AED","SAR","BRL","AUD","SEK","SGD","TRY"],"example":"USD"},"url":{"type":"string","description":"The URL of the advertiser’s website.","example":"www.example.com"},"country":{"type":"string","description":"The country code.","enum":["US","CA","MX","JP","AU","IN","UK","GB","DE","FR","IT","ES","AT","AE","SA","BR","NL","SE","SG","TR"],"example":"US"},"timezone":{"type":"string","description":"The advertiser timezone.\n- America/Anchorage\n- America/Caracas\n- America/Chicago\n- America/Denver\n- America/Halifax\n- America/Los_Angeles\n- America/New_York\n- America/Sao_Paulo\n- America/St_Johns\n- Asia/Almaty\n- Asia/Baghdad\n- Asia/Bangkok\n- Asia/Hong_Kong\n- Asia/Kabul\n- Asia/Kathmandu\n- Asia/Kolkata\n- Asia/Magadan\n- Asia/Shanghai\n- Asia/Tehran\n- Asia/Tokyo\n- Asia/Yekaterinburg\n- Asia/Yerevan\n- Atlantic/Azores\n- Atlantic/South_Georgia\n- Australia/Brisbane\n- Australia/Darwin\n- Europe/London\n- Europe/Paris\n- Indian/Cocos\n- Pacific/Fiji\n- Pacific/Honolulu\n- Pacific/Kwajalein\n- Pacific/Midway\n"},"isRegional":{"type":"boolean","description":"Set to `true` if account is associated with a Global Advertiser Account.","example":false}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"422":{"description":"Unprocessable entity - Failed due to invalid parameters.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Validation Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"DSP_INVALID_QUERY_PARAM","field":"advertiserIdFilter","message":"Each advertiserId must be a valid numeric id separated by comma."}]}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/json":{"schema":{"type":"object","description":"Error response object.","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of the response.","example":"Unprocessable entity"},"requestId":{"type":"string","description":"A value will be used to identify your request uniquely.","example":"ad165994-489a-4fcf-a175-7a846c899b41"},"errors":{"type":"array","description":"List of errors. Useful in case of validation errors","items":{"type":"object","description":"Error Object","required":["errorType","message"],"properties":{"errorType":{"type":"string","description":"Enumerated error type.","example":"DSP_ADVERTISER_UNSUPPORTED_INDUSTRY"},"field":{"type":"string","description":"Request body field which is cause of the error.","example":"budget"},"message":{"type":"string","description":"Detailed error description","example":"Health"}}}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-advertiser#tag/Advertiser","sectionHeader":{"type":3,"text":"GET /dsp/advertisers"},"documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["Use the Amazon Ads API for DSP for campaign, creative, line item and association operations. For onboarding information, see the account setup topic.\n"],"path":"/en-us/dsp-campaigns","sectionHeader":{"type":2,"text":"Amazon Ads API - Amazon DSP"},"documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/orders/{orderId}",{"tags":["Order"],"summary":"Gets an order with complete information specified by an identifier.","description":"Gets an order with complete information specified by an identifier.","operationId":"getOrder","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"orderId","in":"path","description":"The order identifier.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dsporders.v2.6+json":{"schema":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json. FREQUENCY is available since application/vnd.dsporders.v2.6+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)\n* FREQUENCY: The number of times an ad is shown to a unique user","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE","FREQUENCY"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}},"application/vnd.dsporders.v2.5+json":{"schema":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}},"application/vnd.dsporders.v2.4+json":{"schema":{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}},"application/vnd.dsporders.v2.3+json":{"schema":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]}],"enum":["COMBINED_RETURN_ON_AD_SPEND"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}},"application/vnd.dsporders.v2.2+json":{"schema":{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}},"application/vnd.dsporders.v2.1+json":{"schema":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}},"application/vnd.dsporders.v2+json":{"schema":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON.","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON.","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON.","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Order/operation/getOrder","sectionHeader":{"type":3,"text":"GET /dsp/orders/{orderId}"},"summary":"Gets an order with complete information specified by an identifier.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/orders/",{"tags":["Order"],"summary":"Gets one or more orders with basic information.","description":"Gets one or more orders with basic information.","operationId":"getOrders","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"startIndex","description":"Optional. Sets a zero-based offset into the requested set of orders. Use in conjunction with the `count` parameter to control pagination of the returned array. Default startIndex is 0. Minimum count is 0.","in":"query","required":false,"schema":{"type":"string"}},{"name":"count","description":"Optional. Sets the number of orders in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten orders set `startIndex=0` and `count=10`. To return the next ten orders, set `startIndex=10` and `count=10`, and so on. Default count is 100. Minimum count is 1 and maximum count is 100.","in":"query","required":false,"schema":{"type":"string"}},{"name":"statusFilter","description":"Optional. The returned array is filtered to include only orders with delivery status matching those specified in the comma-delimited string.","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderIdFilter","description":"The returned array is filtered to include only orders with identifiers matching those specified in the comma-delimited string. Either one of (OrderIdFilter or advertiserIdFilter) should be provided.","in":"query","required":false,"schema":{"type":"string"}},{"name":"advertiserIdFilter","description":"The returned array is filtered to include only orders with identifiers matching those specified in the comma-delimited string. Either one of (OrderIdFilter or advertiserIdFilter) should be provided.","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dsporders.v2.6+json":{"schema":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json. FREQUENCY is available since application/vnd.dsporders.v2.6+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)\n* FREQUENCY: The number of times an ad is shown to a unique user","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE","FREQUENCY"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}},"application/vnd.dsporders.v2.5+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. \"N/A\" (not applicable) is a valid value. This field will be deprecated and renamed to poNumber in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsporders.v2.4+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. \"N/A\" (not applicable) is a valid value. This field will be deprecated and renamed to poNumber in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsporders.v2.3+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. \"N/A\" (not applicable) is a valid value. This field will be deprecated and renamed to poNumber in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]}],"enum":["COMBINED_RETURN_ON_AD_SPEND"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsporders.v2.2+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true}}}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsporders.v2.1+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00. This field is available since version `application/vnd.dsporders.v2.1+json`.","readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsporders.v2+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","description":"This model is designed to support batch get operation for better performance.","properties":{"orderId":{"type":"string","description":"The order identifier."},"advertiserId":{"type":"string","description":"The advertiser identifier."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC"},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},"agencyFee":{"type":"object","description":"The service fee associated with an agency.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}},"minItems":1,"maxItems":100}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Order/operation/getOrders","sectionHeader":{"type":3,"text":"GET /dsp/orders/"},"summary":"Gets one or more orders with basic information.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/orders/",{"tags":["Order"],"summary":"Update an order.","description":"This is a full update, not partial patch. All the fields/data returned by GET Order by Id must be provided(including read-only fields). Any field that is changed/removed would be updated as provided in the request.\nTo update `deliveryActivationStatus` use POST deliveryActivationStatus by Order Id instead.\n\nCallout - A future update will add support for multiple at a time.\n","operationId":"UpdateOrders","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of order objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dsporders.v2.6+json":{"schema":{"type":"array","items":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json. FREQUENCY is available since application/vnd.dsporders.v2.6+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)\n* FREQUENCY: The number of times an ad is shown to a unique user","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE","FREQUENCY"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}},"minItems":1,"maxItems":1}},"application/vnd.dsporders.v2.5+json":{"schema":{"type":"array","items":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}}],"properties":{"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}}}],"properties":{"optimization":{"allOf":[{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.\n* CLICK_THROUGH_RATE: The number of click-throughs divided by the number of impressions. (CTR = Clicks / Impressions)\n* COMBINED_RETURN_ON_AD_SPEND: Return on advertising spend for products sold on and off Amazon, measured as ad-attributed sales per local currency unit of ad spend. (Combined ROAS = Combined product sales / Total cost)\n* COST_PER_ACTION: The cost to acquire an off-Amazon conversion. (CPA = Total cost / Off-Amazon conversions)\n* COST_PER_CLICK: The cost paid per click-through. (CPC = Total cost / Clicks)\n* COST_PER_DETAIL_PAGE_VIEW: The cost to acquire a detail page view for a promoted product. (CPDPV = Total cost / Detail page views)\n* COST_PER_FIRST_APP_OPEN: The cost to acquire a first-time STV app open. (CPFAO = Total cost / First STV app opens)\n* COST_PER_INSTALL: The cost for a mobile app install. (CPI = Total cost / Mobile app installs)\n* COST_PER_VIDEO_COMPLETION: The cost to acquire a video complete conversion. (CPVC = Total cost / Video completions)\n* DETAIL_PAGE_VIEW_RATE: Detail page view rate for promoted products. (DPVR = Detail page views for promoted products / Impressions)\n* NONE: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* OTHER: If this option is chosen, the Amazon DSP will not alter bids based on the likelihood that a given impression will result in a performance action.\n* REACH: The number of unique users exposed to the creative during its flight.\n* RETURN_ON_AD_SPEND: Return on advertising spend for promoted products, measured as ad-attributed sales for promoted products per local currency unit of ad spend. (ROAS = Promoted product sales / Total cost)\n* TOTAL_COST_PER_SUBSCRIPTION: The cost to acquire a new free trial or paid subscription for a Prime Video channel or STV app subscription. (Total cost per subscription = Total cost / Subscription sign ups)\n* TOTAL_RETURN_ON_AD_SPEND: Return on ad spend, measured as ad-attributed sales for the brands’ products per local currency unit of ad spend. (Total ROAS = Total product sales / Total cost)\n* VIDEO_COMPLETION_RATE: The number of video completions relative to the number of video starts. (Video completion rate = Video complete / Video start)","enum":["CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","COST_PER_ACTION","COST_PER_CLICK","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","NONE","OTHER","REACH","RETURN_ON_AD_SPEND","TOTAL_COST_PER_SUBSCRIPTION","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]}],"properties":{"goal":{"type":"string","description":"The budget optimization goal type. \n* PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.\n* CONSIDERATION & CONVERSIONS are available since application/vnd.dsporders.v2.5+json.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS","PURCHASES_ON_OFF_AMAZON","CONSIDERATION","CONVERSIONS"]},"targetKpi":{"type":"number","format":"double","description":"The key performance metric that will be used to measure success of your order. Depending on the `goalKpi` selected, this will be either currency based, percentage based, or an integer."}},"required":["productLocation","goal","goalKpi"]}}},"minItems":1,"maxItems":1}},"application/vnd.dsporders.v2.3+json":{"schema":{"type":"array","items":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type. PURCHASES_ON_OFF_AMAZON is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]}],"enum":["PURCHASES_ON_OFF_AMAZON"]},"goalKpi":{"type":"string","description":"KPI for the selected goal. COMBINED_RETURN_ON_AD_SPEND is available since application/vnd.dsporders.v2.3+json.","allOf":[{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]}],"enum":["COMBINED_RETURN_ON_AD_SPEND"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]},"minItems":1,"maxItems":1}},"application/vnd.dsporders.v2.2+json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]}],"properties":{"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true}}},"minItems":1,"maxItems":1}},"application/vnd.dsporders.v2.1+json":{"schema":{"type":"array","items":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]},"minItems":1,"maxItems":1}},"application/vnd.dsporders.v2+json":{"schema":{"type":"array","items":{"type":"object","description":"Complete order model which willl be used for create/update and get.","properties":{"orderId":{"type":"string","description":"The order identifier. It will be used to perform update operation. Immutable field."},"advertiserId":{"type":"string","description":"The advertiser identifier. Immutable field."},"name":{"type":"string","description":"The order name."},"externalId":{"type":"string","description":"The order external identifier, also known as purchase order number (PO number). This field is required if \"Mandatory PO numbers\" is set at the entity level. `N/A` (not applicable) is a valid value. This field will be deprecated and renamed to `poNumber` in a future release."},"comments":{"type":"string","description":"The order comments."},"startDateTime":{"type":"string","description":"The order start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The start date has to be modeled as a part of flights object.\n","readOnly":true},"endDateTime":{"type":"string","description":"The order end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00 UTC. The end date has to be modeled as a part of flights object.\n","readOnly":true},"budget":{"allOf":[{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount. For create/update operations, budget has to be modeled as part of flights object.\n","readOnly":true},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}}}},{"type":"object","properties":{"flights":{"type":"array","description":"The budget, start date and end date for an order have to be modeled as flight object. An order can have multiple flights.\n","items":{"type":"object","properties":{"flightId":{"type":"string","description":"The flight identifier. Immutable field."},"startDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDateTime":{"type":"string","description":"The flight start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"amount":{"type":"number","format":"double","description":"The total flight budget amount."},"spentAmount":{"type":"number","format":"double","description":"The spent flight budget amount.","readOnly":true},"remainingAmount":{"type":"number","format":"double","description":"The remaining flight budget amount.","readOnly":true}},"required":["startDateTime","endDateTime","amount"]},"minItems":1}}}]},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"agencyFee":{"type":"object","description":"It is immutable if the order has one or more lineItems.","properties":{"feePercentage":{"type":"number","format":"double","description":"Fee expressed as a percentage of the total budget."}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"productLocation":{"type":"string","description":"The product location indicates whether the product is endemic or non-endemic.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, this field isn't used and the value will always be SOLD_ON_AMAZON.","enum":["SOLD_ON_AMAZON","NOT_SOLD_ON_AMAZON"]},"goal":{"type":"string","description":"The budget optimization goal type.","enum":["AWARENESS","ENGAGEMENT_WITH_MY_AD","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","PURCHASES_ON_AMAZON","MOBILE_APP_INSTALLS"]},"goalKpi":{"type":"string","description":"KPI for the selected goal.","enum":["VIDEO_COMPLETION_RATE","CLICK_THROUGH_RATE","COST_PER_CLICK","COST_PER_ACQUISITION","COST_PER_DOWNLOAD","DETAIL_PAGE_VIEW_RATE","COST_PER_DETAIL_PAGE_VIEW","RETURN_ON_AD_SPEND","TOTAL_RETURN_ON_AD_SPEND","COST_PER_VIDEO_COMPLETION","NONE","OTHER","REACH"]},"autoOptimizations":{"type":"array","description":"The list of optimizations supported.\nWhen goal=`AWARENESS`, `CONVERSIONS`, or `CONSIDERATION`, `BID` auto optimization is not supported.","items":{"type":"string","enum":["BUDGET","BID"]}},"biddingStrategy":{"description":"It specifies how Amazon Advertising determines bids on your behalf for each opportunity to serve an impression. It is immutable once the order has started delivering.\n","type":"string","enum":["SPEND_BUDGET_IN_FULL","MAXIMIZE_PERFORMANCE"]}},"required":["productLocation","goal","goalKpi"]},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The order delivery status. DELIVERING: The order is delivering. OUT_OF_BUDGET: The order is out of budget. ENDED: The order has ended. LINEITEMS_NOT_RUNNING: The order doesn’t have any active line items to deliver. INACTIVE: The order is paused by the user. READY_TO_DELIVER: The order has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","LINEITEMS_NOT_RUNNING","INACTIVE","READY_TO_DELIVER"],"readOnly":true},"creationDate":{"type":"string","description":"The order creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The order last update date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-12-16T19:20:30+01:00.","readOnly":true}},"required":["advertiserId","name","budget","frequencyCap","optimization"]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dsporders.v2.6+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsporders.v2.5+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsporders.v2.3+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsporders.v2.2+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsporders.v2.1+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsporders.v2+json":{"schema":{"type":"array","items":{"description":"Response for the order create/update operations. If operation is successful, it contains only orderId. If it is a failure, it contains only errorDetails. success and failure will be corresponding to that requested index in that batch (array of items).\n","type":"object","properties":{"orderId":{"type":"string","description":"The order Identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsporders.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Order/operation/UpdateOrders","sectionHeader":{"type":3,"text":"PUT /dsp/orders/"},"summary":"Update an order.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/orders/{orderId}/conversionTracking",{"tags":["Order"],"summary":"Get conversion tracking information for given order.","description":"Get conversion tracking information for given order.","operationId":"GetConversionTrackings","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"orderId","in":"path","description":"The order identifier.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"type":"object","properties":{"products":{"allOf":[{"type":"object","properties":{"productList":{"type":"array","description":"The tracking product list.","items":{"type":"object","properties":{"productId":{"type":"string","description":"The product identifier."},"productAssociation":{"type":"string","description":"The product feature type.","enum":["FEATURED","NOT_FEATURED"]},"domain":{"type":"string","description":"The ASIN domain type. Applicable to ASIN line item type only.","enum":["AMAZON_US","AMAZON_CA","AMAZON_MX","PRIME_NOW_US","PRIME_NOW_CA","WHOLE_FOODS_MARKET_US"]}},"required":["productId","productAssociation","domain"]}},"productFile":{"type":"string","description":"The URL of the product tracking file.","readOnly":true}}}],"type":"object","properties":{"productList":{"items":{"allOf":[{"type":"object","properties":{"productId":{"type":"string","description":"The product identifier."},"productAssociation":{"type":"string","description":"The product feature type.","enum":["FEATURED","NOT_FEATURED"]},"domain":{"type":"string","description":"The ASIN domain type. Applicable to ASIN line item type only.","enum":["AMAZON_US","AMAZON_CA","AMAZON_MX","PRIME_NOW_US","PRIME_NOW_CA","WHOLE_FOODS_MARKET_US"]}},"required":["productId","productAssociation","domain"]}],"type":"object","properties":{"domain":{"allOf":[{"type":"string","description":"The ASIN domain type. Applicable to ASIN line item type only.","enum":["AMAZON_US","AMAZON_CA","AMAZON_MX","PRIME_NOW_US","PRIME_NOW_CA","WHOLE_FOODS_MARKET_US"]}],"type":"string","description":"The ASIN domain type. Applicable to ASIN line item type only. FRESH_STORES_US is available since application/vnd.dsporders.v2.1+json.","enum":["FRESH_STORES_US"]}},"required":["domain"]}}}},"pixels":{"type":"array","description":"A list of pixels associated with the campaign.","items":{"type":"string","description":"The pixel identifier."}}}}},"application/vnd.dsporders.v2+json":{"schema":{"type":"object","properties":{"products":{"type":"object","properties":{"productList":{"type":"array","description":"The tracking product list.","items":{"type":"object","properties":{"productId":{"type":"string","description":"The product identifier."},"productAssociation":{"type":"string","description":"The product feature type.","enum":["FEATURED","NOT_FEATURED"]},"domain":{"type":"string","description":"The ASIN domain type. Applicable to ASIN line item type only.","enum":["AMAZON_US","AMAZON_CA","AMAZON_MX","PRIME_NOW_US","PRIME_NOW_CA","WHOLE_FOODS_MARKET_US"]}},"required":["productId","productAssociation","domain"]}},"productFile":{"type":"string","description":"The URL of the product tracking file.","readOnly":true}}},"pixels":{"type":"array","description":"A list of pixels associated with the campaign.","items":{"type":"string","description":"The pixel identifier."}}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsporders.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsporders.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Order/operation/GetConversionTrackings","sectionHeader":{"type":3,"text":"GET /dsp/orders/{orderId}/conversionTracking"},"summary":"Get conversion tracking information for given order.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/orders/{orderId}/conversionTracking/products",{"tags":["Order"],"summary":"Add or remove conversion tracking products from the order.","description":"Add or remove conversion tracking products from the order. It can be updated by either providing values for productList or productFile field. For productList, up to 2,000 ProductTrackingItems can be added, including up to 20 ProductTrackingItems per domain if FEATURED_WITH_VARIATIONS is specified in productAssociation. For productFile, up to 50,000 Products can be used. Check out our tutorial for more details.","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"orderId","in":"path","description":"The order identifier.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Conversion tracking product tracking object","content":{"application/vnd.dspproducttracking.v1+json":{"schema":{"type":"object","properties":{"productList":{"type":"array","description":"The tracking product list.","items":{"type":"object","properties":{"productId":{"type":"string","description":"The product identifier."},"productAssociation":{"type":"string","description":"The product feature type.","enum":["FEATURED","NOT_FEATURED","FEATURED_WITH_VARIATION"]},"domain":{"type":"string","description":"The ASIN domain type.","enum":["AMAZON_US","AMAZON_CA","AMAZON_MX","PRIME_NOW_US","PRIME_NOW_CA","WHOLE_FOODS_MARKET_US","FRESH_STORES_US","PRIME_VIDEO_ROW_NA"]}},"required":["productId","productAssociation","domain"]}},"productFile":{"type":"string","description":"The URL of the product tracking file.","readOnly":true}}}}}},"responses":{"204":{"description":"Success with no body content."},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Order","sectionHeader":{"type":3,"text":"PUT /dsp/orders/{orderId}/conversionTracking/products"},"summary":"Add or remove conversion tracking products from the order.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/lineItems/",{"tags":["LineItem"],"summary":"Gets one or more line items with basic information.","description":"Gets one or more line items with basic information.","operationId":"getLineItems","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"startIndex","description":"Optional. Sets a zero-based offset into the requested set of line items. Use in conjunction with the `count` parameter to control pagination of the returned array. Default startIndex is 0. Minimum count is 0.","in":"query","required":false,"schema":{"type":"string"}},{"name":"count","description":"Optional. Sets the number of line items in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten line items set `startIndex=0` and `count=10`. To return the next ten line items, set `startIndex=10` and `count=10`, and so on. Default count is 100. Minimum count is 1 and maximum count is 100.","in":"query","required":false,"schema":{"type":"string"}},{"name":"statusFilter","description":"Optional. The returned array is filtered to include only line items with delivery status matching those specified in the comma-delimited string.","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderIdFilter","description":"The returned array is filtered to include only line items with identifiers matching those specified in the comma-delimited string. Either one of (orderIdFilter or lineItemIdFilter) should be provided.","in":"query","required":false,"schema":{"type":"string"}},{"name":"lineItemIdFilter","description":"The returned array is filtered to include only line items with identifiers matching those specified in the comma-delimited string. Either one of (orderIdFilter or lineItemIdFilter) should be provided.","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspbasiclineitems.v3+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"type":"object","readOnly":true,"properties":{"lineItemId":{"type":"string","description":"The line item identifier."},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"externalId":{"type":"string","description":"The line item external identifier."},"comments":{"type":"string","description":"The line item comments."},"orderId":{"type":"string","description":"The order to which the line item is associated."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example,2020-07-16T19:20:30+01:00"},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]}}}],"properties":{"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`. OTT_GUARANTEED is supported only for batch read API since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO","OTT_GUARANTEED"]},"creationDate":{"type":"string","description":"The line item creation date. This field is available since version `application/vnd.dsplineitems.v2.2+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date. This field is available since version `application/vnd.dsplineitems.v2.2+json`.","readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"type":"object","readOnly":true,"properties":{"lineItemId":{"type":"string","description":"The line item identifier."},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"externalId":{"type":"string","description":"The line item external identifier."},"comments":{"type":"string","description":"The line item comments."},"orderId":{"type":"string","description":"The order to which the line item is associated."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example,2020-07-16T19:20:30+01:00"},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]}}}],"properties":{"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`. OTT_GUARANTEED is supported only for batch read API since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO","OTT_GUARANTEED"]},"creationDate":{"type":"string","description":"The line item creation date. This field is available since version `application/vnd.dsplineitems.v2.2+json`.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date. This field is available since version `application/vnd.dsplineitems.v2.2+json`.","readOnly":true}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"allOf":[{"type":"object","readOnly":true,"properties":{"lineItemId":{"type":"string","description":"The line item identifier."},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"externalId":{"type":"string","description":"The line item external identifier."},"comments":{"type":"string","description":"The line item comments."},"orderId":{"type":"string","description":"The order to which the line item is associated."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example,2020-07-16T19:20:30+01:00"},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]}}}],"properties":{"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`. OTT_GUARANTEED is supported only for batch read API since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO","OTT_GUARANTEED"]}}},"minItems":1,"maxItems":100}}}},"application/vnd.dsplineitems.v2+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","readOnly":true,"properties":{"lineItemId":{"type":"string","description":"The line item identifier."},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"externalId":{"type":"string","description":"The line item external identifier."},"comments":{"type":"string","description":"The line item comments."},"orderId":{"type":"string","description":"The order to which the line item is associated."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example,2020-07-16T19:20:30+01:00"},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]}}},"minItems":1,"maxItems":100}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation."}]}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation."}]}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation."}]}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation."}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/LineItem/operation/getLineItems","sectionHeader":{"type":3,"text":"GET /dsp/lineItems/"},"summary":"Gets one or more line items with basic information.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/lineItems/",{"tags":["LineItem"],"summary":"Update line item.","description":"This is a full update, not partial patch. All the fields/data returned by GET LineItem by Id must be provided(including read-only fields). Any field that is changed/removed would be updated as provided in the request.\nTo update `deliveryActivationStatus` use POST deliveryActivationStatus by LineItem Id instead.\n\nCallout - A future update will add support for multiple at a time.\n","operationId":"updateLineItems","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of line item objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dsplineitems.v3.3+json":{"schema":{"type":"array","items":{"allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}}}}}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}}}}}}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}],"properties":{"integralAdScience":{"allOf":[{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"contextualTargeting":{"type":"object","properties":{"avoidanceSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual avoidance segment"}}}},"contextualAvoidance":{"type":"object","properties":{"verticalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual vertical targeting segment"}},"topicalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual topical targeting segment"}}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}],"properties":{"integralAdScience":{"allOf":[{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}],"properties":{"contextualTargeting":{"type":"object","properties":{"avoidanceSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual avoidance segment"}}}},"contextualAvoidance":{"type":"object","properties":{"verticalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual vertical targeting segment"}},"topicalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual topical targeting segment"}}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"allOf":[{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}],"properties":{"integralAdScience":{"allOf":[{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"contextualTargeting":{"type":"object","properties":{"avoidanceSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual avoidance segment"}}}},"contextualAvoidance":{"type":"object","properties":{"verticalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual vertical targeting segment"}},"topicalSegments":{"type":"array","maxItems":200,"minItems":0,"items":{"type":"string","description":"The unique identifier of the IAS contextual topical targeting segment"}}}}}}}}}}}}}},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v3.2+json":{"schema":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}}}}}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"brandSafety":{"allOf":[{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}}],"properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting. EXTREME_GRAPHIC is available since version `application/vnd.dsplineitems.v3.2+json`.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO","EXTREME_GRAPHIC"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DEATH_INJURIES`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]. `DEATH_INJURIES` is available since version `application/vnd.dsplineitems.v3.2+json`.","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}}}}}}}}}}}}}},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v3.1+json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]}],"properties":{"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"aapMobileAppTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"amazonMobileDisplayTargeting":{"allOf":[{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}}],"properties":{"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}},"videoTargeting":{"allOf":[{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}],"properties":{"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"oracleDataCloud":{"allOf":[{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}}],"properties":{"standardPredictsSegmentIds":{"type":"array","description":"The standard predict segment identifiers.","items":{"type":"string"},"minItems":1,"maxItems":320}}},"pixalate":{"type":"object","description":"Pixalate is a third party provider for digital ad verification. Pixalate offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to `true` to exclude traffic from IPV4 and IPV6 addresses and usger agents identified to to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to `true` to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeAppsAndDomains":{"type":"boolean","description":"Set to `true` to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to `true` to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}}}}}}}}}}},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v3+json":{"schema":{"type":"array","items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"allOf":[{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]}],"description":"The geographical location type of Amazon customers targeted. For example, US advertisers can choose from `US`, `EVERYWHERE`, `NON-US`; Canada advertisers can choose from `CA`, `EVERYWHERE`; Mexico advertisers can choose from `MX`, `EVERYWHERE`; Brazil advertisers can choose from `BR`, `EVERYWHERE`.","enum":["CA","MX","BR"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [`ADULT_CONTENT`, `ALCOHOL`, `CRIME`, `DISASTER_AVIATION`, `DISASTER_MAN_MADE`, `DISASTER_NATURAL`, `DISASTER_TERRORIST_EVENTS`, `DISASTER_VEHICLE`, `HATE_SPEECH`, `PROFANITY`, `SUBSTANCE_ABUSE`, `TOBACCO_ECIGARETTES`, `VIOLENCE_EXTREME_GRAPHIC`]","additionalProperties":{"type":"string","description":"The Double Verify brand suitability risk level.","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]},"example":{"ADULT_CONTENT":"HIGH_MEDIUM"}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, `TEENS_12_PLUS` will only exclude apps with content rated for everyone ages 12 and over. `UNKNOWN` will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["EVERYONE_4_PLUS","TWEENS_9_PLUS","TEENS_12_PLUS","MATURE_17_PLUS","ADULTS_ONLY_18_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"allOf":[{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}}],"properties":{"viewability":{"type":"object","description":"The ODC viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard.","enum":["NONE","MRC"],"example":"MRC"},"viewabilityTargeting":{"type":"string","description":"The type of ODC MRC viewability tier.","enum":["VIEWABILITY_TIER_GT_80","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_30","VIEWABILITY_TIER_GT_20"]}},"required":["standard","viewabilityTargeting"]}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"brandSafety":{"allOf":[{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]}],"properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_RISK","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK"]}}},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"allOf":[{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]}],"description":"The site language targeting type. For example, US/Mexico advertisers can choose from `EN`, `ES`; Canada advertisers can choose from `EN`, `FR`; Brazil advertisers can choose from `EN`, `PT`.","enum":["FR","PT"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"allOf":[{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true}],"enum":["BRL"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdatedDate":{"type":"string","description":"The line item last updated date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdateDate":{"type":"string","description":"The line item last update date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]}],"properties":{"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"targeting":{"allOf":[{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}}}],"type":"object","properties":{"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}}}},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdateDate":{"type":"string","description":"The line item last update date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]}],"properties":{"lineItemType":{"type":"string","description":"The line item type. All operations are supported for VIDEO line item type since version `application/vnd.dsplineitems.v2.1+json`.","allOf":[{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]}],"enum":["VIDEO"]},"targeting":{"allOf":[{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}}}],"type":"object","properties":{"videoTargeting":{"description":"This field is available since version `application/vnd.dsplineitems.v2.1+json`.","type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"allOf":[{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}}],"properties":{"doubleVerify":{"allOf":[{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}}],"properties":{"viewability":{"allOf":[{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}}],"properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]}}}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"array","description":"The targeted device type for video line item type. A list of device types can be provided.","items":{"type":"string","enum":["MOBILE","DESKTOP","CONNECTED_TV"]}},"mobileEnvironmentTargeting":{"type":"array","description":"The targeted mobile environment for video line item type. It is required only when `MOBILE` device type is selected.","items":{"type":"string","enum":["WEB","APP"]}},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"videoInitiationTypeTargeting":{"type":"array","description":"Target video inventory by how the video will be started. A list can be provided. If ANY is selected, no other type can be provided.","items":{"type":"string","enum":["ANY","USER_INITIATED_ONLY","AUTOPLAY_ONLY","UNKNOWN"]}},"videoAdFormatTargeting":{"type":"array","description":"Target a specific type of ad slot used to serve the video. A list can be provided.","items":{"type":"string","enum":["IN_STREAM","OUT_STREAM","IN_STREAM_AND_OUT_STREAM"]}},"limitToFepTargeting":{"type":"boolean","description":"Limit IN STREAM ad slot to full episode players (FEP)."},"videoPlayerSizeTargeting":{"type":"array","description":"Target video inventory by publisher’s player size. A list can be provided.","items":{"type":"string","enum":["ANY","SMALL","MEDIUM","LARGE","UNKNOWN"]}},"videoCompletionTargeting":{"type":"string","description":"These are predictions based on machine learning and aren’t guaranteed. Selecting a higher percentage limits overall reach.","enum":["NO_TARGETING","VIDEO_COMPLETION_GTE_10","VIDEO_COMPLETION_GTE_20","VIDEO_COMPLETION_GTE_30","VIDEO_COMPLETION_GTE_40","VIDEO_COMPLETION_GTE_50","VIDEO_COMPLETION_GTE_60","VIDEO_COMPLETION_GTE_70","VIDEO_COMPLETION_GTE_80","VIDEO_COMPLETION_GTE_90"]},"ottTargeting":{"type":"object","description":"This targeting only applies to Amazon O&O and Amazon Publisher Services (APS) inventory. It can only be provided when CONNECTED_TV is selected in deviceTypeTargeting. Currently API does not support excluding delivery to audience according to content ratings. This feature will be added in later versions. If a user creates or updates a line item with this field on UI, they will not see the data for this field in API and updates via API will not update this field.","properties":{"ottContentGenres":{"type":"array","description":"Select genres to exclude delivery to that audience.","items":{"type":"string","enum":["ACTION","ADVENTURE","ANIMATION","BIOGRAPHY","COMEDY","CRIME","DOCUMENTARY","DRAMA","FAMILY","FANTASY","FILM_NOIR","GAME_SHOW","HISTORY","HORROR","MUSICAL","MYSTERY","NEWS","REALITY_TV","ROMANCE","SCIENCE_FICTION","SHORT","SPORT","SUPER_HERO","TALK_SHOW","THRILLER","WAR","WESTERN","GENRE_NOT_AVAILABLE"]}},"ottAppBlocking":{"type":"array","description":"Select the apps that should be excluded.","items":{"type":"string"}}}}}}}}}},"minItems":1,"maxItems":1}},"application/vnd.dsplineitems.v2+json":{"schema":{"type":"array","items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The line item identifier. This is required when we perform update operations. Immutable field.","readOnly":true},"lineItemType":{"type":"string","description":"The line item type.","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP"]},"name":{"type":"string","description":"The line item name."},"orderId":{"type":"string","description":"The order to which the line item is associated. Immutable field."},"externalId":{"type":"string","description":"The external identifier of the line item."},"startDateTime":{"type":"string","description":"The line item start date in ISO date format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00."},"endDateTime":{"type":"string","description":"The line item end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. For example, 2020-07-16T19:20:30+01:00"},"comments":{"type":"string","description":"The line item comments."},"deliveryActivationStatus":{"type":"string","description":"This will be used to control the delivery activation status of order and lineitem  resource. Active - Activate order or lineitem. INACTIVE - Pause the order or lineitem.\n","enum":["ACTIVE","INACTIVE"],"readOnly":true},"deliveryStatus":{"type":"string","description":"The lineitem delivery status. DELIVERING: The line item is delivering. OUT_OF_BUDGET: The line item is out of budget. ENDED: The line item has ended. CREATIVES_NOT_RUNNING: The line item doesn't have any active creatives to deliver. INACTIVE: The line item is paused by the user. READY_TO_DELIVER: The line item has not yet started.","enum":["DELIVERING","ENDED","OUT_OF_BUDGET","INACTIVE","READY_TO_DELIVER","CREATIVES_NOT_RUNNING"],"readOnly":true},"lineItemClassification":{"type":"object","properties":{"productCategories":{"description":"The array of identifiers of product categories associated with the line item. For `VIDEO` line item type only one parent product category or multiple sub-categories from one parent product category are allowed.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}},"required":["productCategories"]},"frequencyCap":{"type":"object","properties":{"type":{"type":"string","description":"The type of advertising frequency cap. If `UNCAPPED`, no other fields are used.","enum":["UNCAPPED","CUSTOM"]},"maxImpressions":{"type":"integer","description":"The maximum number of times an ad is displayed.","format":"int32"},"timeUnitCount":{"type":"integer","description":"The count of time units.","format":"int32"},"timeUnit":{"type":"string","description":"The time unit.","enum":["DAYS","HOURS"]}},"required":["type"]},"targeting":{"type":"object","properties":{"standardDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"domainListTargeting":{"type":"object","properties":{"mergedDomainList":{"type":"object","properties":{"domainListMergedTargetingType":{"type":"string","description":"The list type of the domain. Either include or exclude","enum":["EXCLUDE","INCLUDE"]},"domainListMergedFile":{"type":"string","description":"The URL address of the domain list file after merging all domains into single file\""}}},"inheritFromAdvertiser":{"type":"boolean","description":"Inherit domains from advertiser settings."}}},"deviceTypeTargeting":{"type":"string","description":"The targeted device type for standard display line item type. It is required input for `STANDARD_DISPLAY` line item type.","enum":["DESKTOP_AND_MOBILE","MOBILE","DESKTOP"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"siteLanguageTargeting":{"type":"string","description":"The site language targeting type. For example, `EN`, `ES`.","enum":["EN","ES"]},"contentTargeting":{"description":"The IAB content category type. IAB content categories enable advertisers to target websites according to their subject matter by scanning their content. This helps deliver ads to relevant sites while ensuring that the ads are not displayed near undesirable content.","type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}},"aapMobileAppTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileAppTargeting":{"type":"object","properties":{"appTargetingOption":{"type":"string","description":"The mobile application targeting inclusion type.","enum":["INCLUDE_APPS","EXCLUDE_APPS"]},"appIds":{"type":"array","description":"The list of application identifiers.","items":{"type":"string"}}},"required":["appTargetingOption","appIds"]},"deviceTypeTargeting":{"type":"array","description":"The targeted mobile application device type. Note that this is applicable only for the `AAP_MOBILE APP` type of line item. It is required input for `AAP_MOBILE APP` line item type.","items":{"type":"string","enum":["IPHONE","IPAD","ANDROID","KINDLE_FIRE","KINDLE_FIRE_HD"]}},"deviceOrientationTargeting":{"type":"string","description":"The mobile device orientation targeting type.","enum":["ANY","PORTRAIT","LANDSCAPE"]}}},"amazonMobileDisplayTargeting":{"type":"object","properties":{"userLocationTargeting":{"type":"string","description":"The geographical location type of Amazon customers targeted. For example, `US`, `EVERYWHERE`, `NON-US`.","enum":["US","EVERYWHERE","NON_US"]},"amazonViewabilityTargeting":{"type":"object","description":"Selects a viewability tier to target. The predicted view rate percentages are based on historical data and are not guaranteed. Actual view rates may vary by measurement provider and order.","properties":{"viewabilityTier":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}},"required":["viewabilityTier","includeUnmeasurableImpressions"]},"thirdPartyPreBidTargeting":{"type":"object","description":"Amazon DSP automatically filters fraudulent and invalid traffic as well as unsafe content using a combination of proprietary technology and solutions from comScore and Sizmek. This service is available by default and at no extra charge for Amazon DSP customers. You may choose to augment the default filters with pre-bid targeting products offered by third parties. These services are currently offered at no charge.","properties":{"doubleVerify":{"type":"object","description":"Double Verify (DV) is a third party provider for digital ad verification. Double Verify offers technologies that drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"In an update from Double Verify (DV), support for `HATE_SPEECH_PROFANITY`, medium severity `ADULT_CONTENT`, and `SEX_EDUCATION` has been dropped. Additionally, DV has moved away from high severity content and medium severity content in favor of content categories and content categories with risk. Any value found below that is represented as a content category will continue to exclude the particular content category that the value represents. Any value found below that is represented as a content category with risk will now exclude the high and medium content category with risk that the value represents. Please consider adopting the latest version of the line item APIs for updated support of DV brand safety.","properties":{"highSeverityContent":{"type":"array","description":"A list of high severity content and corresponding status.","items":{"type":"string","enum":["ADULT_CONTENT","DRUGS_SUBSTANCES","EXTREME_GRAPHICS_VIOLENCE_WEAPONS","HATE_SPEECH_PROFANITY","ILLEGAL_ACTIVITIES","INCENTIVIZED_MALWARE_CLUTTER","PIRACY_COPYRIGHT_INFRINGEMENT"]}},"mediumSeverityContent":{"type":"array","description":"A list of medium severity content and corresponding status.","items":{"type":"string","enum":["AD_SERVER","ADULT_CONTENT","CULTS_SURVIVALISM","CELEBRITY_GOSSIP","GAMBLING","DISASTER_AVIATION","DISASTER_MAN_MADE","DISASTER_NATURAL","DISASTER_TERRORISTS_EVENTS","DISASTER_VEHICLE","DRUGS_ALCOHOL","DRUGS_SMOKING","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","SEX_EDUCATION","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"unknownContent":{"type":"boolean","description":"Set to `true` to exclude unknown content."},"appAgeRating":{"type":"array","description":"A list of app age rating to be used for excluding apps.","items":{"type":"string","enum":["EVERYONE","TWEENS","TEEN","MATURE","ADULTS_ONLY","UNKNOWN"]}},"appStarRating":{"type":"string","description":"Exclude by app star rating (app inventory only)","enum":["ALLOW_ALL","APP_STAR_RATING_LT_15","APP_STAR_RATING_LT_20","APP_STAR_RATING_LT_25","APP_STAR_RATING_LT_30","APP_STAR_RATING_LT_35","APP_STAR_RATING_LT_40","APP_STAR_RATING_LT_45"]},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to `true` to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."}}},"fraudInvalidTraffic":{"type":"object","properties":{"excludeImpressions":{"type":"boolean","description":"Set to `true` to exclude impressions delivered to devices identified to be fraudulent or invalid."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_50","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_02"]},"blockAppAndSites":{"type":"boolean","description":"Set to `true` to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."}}},"authenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string","description":"The segment identifier."}}},"viewability":{"type":"object","properties":{"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_80","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_30"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to `true` to include impressions where impressions can't be measured."}}},"customContextualSegmentId":{"type":"string","description":"The custom segment identifier."}}},"oracleDataCloud":{"type":"object","description":"Oracle Data Cloud is a third party provider in digital ad verification. Oracle Data Cloud offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","description":"The oracle data cloud brand safety.","properties":{"targetingOption":{"type":"string","enum":["NO_BRAND_SAFETY","MAXIMUM_PROTECTION","ESSENTIAL_PROTECTION"]},"essentialProtection":{"type":"string","enum":["ADULT","ARMS","CRIME","INJURY","PIRACY","DRUGS","HATE_SPEECH","MILITARY","OBSCENITY","TERRORISM","TOBACCO"]}}},"fraudInvalidTraffic":{"type":"string","description":"The fraud invalid traffic type.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_ESSENTIAL_PROTECTION","FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION"]},"customSegmentId":{"type":"string","description":"The custom segment identifier."},"contextualPredictsSegmentId":{"type":"string","description":"The custom segment predict identifier."}}},"integralAdScience":{"type":"object","description":"Integral Ad Science (IAS) is a third party provider in digital ad verification. IAS offers technologies to drive high-quality advertising media.","properties":{"brandSafety":{"type":"object","properties":{"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUE_HIGH_RISK","BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK"]},"excludeContent":{"type":"boolean","description":"Set to `true` to exclude content that Integral Ad Science is not able to rate."}},"required":["iasBrandSafetyAdult","iasBrandSafetyAlcohol","iasBrandSafetyGambling","iasBrandSafetyHateSpeech","iasBrandSafetyIllegalDownloads","iasBrandSafetyIllegalDrugs","iasBrandSafetyOffensiveLanguage","iasBrandSafetyViolence","excludeContent"]},"fraudInvalidTraffic":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK"]},"viewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","description":"The viewability standard","enum":["NONE","MRC","GROUPM","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_LT_40"]}},"required":["standard","viewabilityTargeting"]}}}}},"supplyTargeting":{"type":"object","properties":{"supplySourceTargeting":{"type":"object","properties":{"supplySources":{"type":"array","description":"The list of supply sources to target. In case of OPEN_EXCHANGE, the ID is of consolidated supply source.","maxItems":1000,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"supplyDealTargeting":{"type":"object","properties":{"deals":{"type":"array","description":"The list of deal supply sources to target.","maxItems":100,"minItems":0,"items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}}}},"geoLocationTargeting":{"type":"object","description":"Targets based on city, state, country, DMA , or postal code.","properties":{"locationTargetingBy":{"type":"string","description":"The geographic location targeting type. IPADDRESS: includes IP address only. IPADDRESS_POSTALCODE: includes both IP address and postal code.","enum":["IPADDRESS","IPADDRESS_POSTALCODE"]},"inclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}},"exclusions":{"type":"array","items":{"type":"string","description":"The unique identifier of the DSP resource/object."}}}},"segmentTargeting":{"type":"object","properties":{"segmentGroups":{"type":"array","description":"The list of segment groups.","items":{"type":"object","description":"This segment group.","properties":{"segments":{"type":"array","description":"The list of segment clauses.","items":{"type":"object","description":"The segment clause.","properties":{"segmentId":{"type":"string","description":"The unique identifier of the DSP resource/object."},"isNot":{"type":"boolean","description":"Set to `true` to set to negative targeting. Set to `false` to set to  positive targeting. Default is false."}},"required":["segmentId"]}},"intraOperator":{"type":"string","description":"The intra operator used between two segment groups.","enum":["AND","OR"]},"interOperator":{"description":"The inter operator used among segments within the same segment group.","enum":["ANY","ALL"]}},"required":["segments","intraOperator","interOperator"]}}}},"dayPartTargeting":{"type":"object","description":"Specifies time zone and parts of the day to target delivery of the line item.","properties":{"timeZonePreference":{"type":"string","description":"The time zone associated with line item delivery.","enum":["USER_TIMEZONE","AD_SERVER_TIMEZONE"]},"dayParts":{"type":"array","description":"The list of parts of the day.","items":{"type":"object","description":"The parts of a day.","properties":{"hourSlots":{"type":"array","items":{"type":"integer","format":"int64","description":"The hour slot.","minimum":0,"maximum":23}},"dayOfWeek":{"type":"string","description":"The day of the week.","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}},"required":["hourSlots","dayOfWeek"]}}},"required":["timeZonePreference","dayParts"]},"mobileOsTargeting":{"type":"string","description":"The mobile operating system targeting type.","enum":["ALL","IOS","ANDROID"]},"contextualTargeting":{"type":"boolean","description":"Set to `true` to enable contextual targeting. Contextual targeting targets the detail page of products that are frequently viewed or purchased with the products in your ad. Note that this feature applies to Dynamic eCommerce ads only."}}}}},"budget":{"type":"object","properties":{"totalBudgetAmount":{"type":"number","format":"double","description":"The total budget amount."},"budgetCaps":{"type":"array","items":{"type":"object","description":"Adding a budget cap can result in under-delivery.","properties":{"recurrenceTimePeriod":{"type":"string","description":"The type of recurrence for the spending limit.","enum":["UNCAPPED","DAILY","MONTHLY"]},"amount":{"type":"number","format":"double","description":"The spending limit amount."}},"required":["recurrenceTimePeriod","amount"]}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"The type of line item delivery profile. FRONT_LOADED: Front loaded can deliver up to 25% more than the daily Even pace targets. EVENLY: Even pacing spends your budget consistently across the length of the campaign.","enum":["FRONT_LOADED","EVENLY"]}},"required":["deliveryProfile"]}}},"currencyCode":{"type":"string","description":"The currency code.","enum":["USD","CAD","MXN"],"readOnly":true},"appliedFees":{"type":"object","properties":{"thirdPartyFees":{"type":"array","description":"The list of third party fees associated with the line item.","items":{"type":"object","description":"Third-party fees enable the platform to apply an additional fee. For example, a third-party vendor fee for ad verification, an agency markup fee, and the like.","properties":{"providerName":{"type":"string","description":"The provider name.","enum":["INTEGRAL_AD_SCIENCE","DOUBLE_VERIFY","DOUBLE_CLICK_CAMPAIGN_MANAGER","COM_SCORE","CPM_1","CPM_2","CPM_3"]},"feeAmount":{"type":"number","format":"double","description":"The fee amount associated a third-party provider."},"feeAllocation":{"type":"string","description":"The type of fee allocation.","enum":["ABSORB_WITH_AGENCY_FEE","PASS_TO_ADVERTISER"]}},"required":["providerName","feeAmount","feeAllocation"]}},"audienceFees":{"type":"array","description":"The list of audience fees associated with the line item.","items":{"type":"object","description":"The audience fee applied to Amazon (in-market and lifestyle) third-party (automotive).","properties":{"feeName":{"type":"string","description":"The category of the audience fee.","enum":["IN_MARKET_LIFESTYLE","AUTOMOTIVE"]},"amount":{"type":"number","format":"double","description":"The amount of the audience fee."}},"required":["feeName","amount"]},"readOnly":true},"amazonDspConsoleFee":{"type":"object","description":"A service fee for using the Amazon Ad Platform. Fees are applied as a percentage of supply costs.","properties":{"feePercentage":{"type":"number","format":"double","description":"The service fee expressed as a percentage."}},"required":["feePercentage"],"readOnly":true}}},"bidding":{"type":"object","description":"The bid values associated with a line item.","properties":{"baseSupplyBid":{"type":"number","format":"double","description":"The base bid per thousand impressions for ad inventory. Expressed in dollars."},"maxSupplyBid":{"type":"number","format":"double","description":"The maximum cost-per-thousand impressions bid for media supply. Expressed in dollars."}},"required":["baseSupplyBid"]},"optimization":{"type":"object","properties":{"budgetOptimization":{"type":"boolean","description":"Set to `true` to enable budget optimization for the line item."}},"required":["budgetOptimization"]},"creativeOptions":{"type":"object","properties":{"creativeRotationType":{"type":"string","description":"The creative rotation type.","enum":["WEIGHTED","RANDOM"]}}},"creationDate":{"type":"string","description":"The line item creation date.","readOnly":true},"lastUpdateDate":{"type":"string","description":"The line item last update date.","readOnly":true}},"required":["lineItemType","name","orderId","startDateTime","endDateTime","lineItemClassification","frequencyCap","bidding","optimization"]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dsplineitemsresponse.v3.1+json":{"schema":{"type":"array","items":{"description":"Response for the line item create/update operations. Success contains only lineItemId and failure contains only errorDetails corresponding to that requested index in that batch (array of items).","type":"object","properties":{"lineItemId":{"type":"string","description":"The Line item identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsplineitemsresponse.v3+json":{"schema":{"type":"array","items":{"description":"Response for the line item create/update operations. Success contains only lineItemId and failure contains only errorDetails corresponding to that requested index in that batch (array of items).","type":"object","properties":{"lineItemId":{"type":"string","description":"The Line item identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"type":"array","items":{"description":"Response for the line item create/update operations. Success contains only lineItemId and failure contains only errorDetails corresponding to that requested index in that batch (array of items).","type":"object","properties":{"lineItemId":{"type":"string","description":"The Line item identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"type":"array","items":{"description":"Response for the line item create/update operations. Success contains only lineItemId and failure contains only errorDetails corresponding to that requested index in that batch (array of items).","type":"object","properties":{"lineItemId":{"type":"string","description":"The Line item identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}},"application/vnd.dsplineitems.v2+json":{"schema":{"type":"array","items":{"description":"Response for the line item create/update operations. Success contains only lineItemId and failure contains only errorDetails corresponding to that requested index in that batch (array of items).","type":"object","properties":{"lineItemId":{"type":"string","description":"The Line item identifier."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsperrors.v3+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitems.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/LineItem/operation/updateLineItems","sectionHeader":{"type":3,"text":"PUT /dsp/lineItems/"},"summary":"Update line item.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/",{"tags":["Creative"],"summary":"Gets one or more creatives.","description":"Gets one or more creatives.","operationId":"getCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"startIndex","description":"Optional. Sets a zero-based offset into the requested set of creatives. Use in conjunction with the `count` parameter to control pagination of the returned array. Default startIndex is 0. Minimum count is 0.","in":"query","required":false,"schema":{"type":"string"}},{"name":"count","description":"Optional. Sets the number of creatives in the returned array. Use in conjunction with the `startIndex` parameter to control pagination. For example, to return the first ten creatives set `startIndex=0` and `count=10`. To return the next ten creatives, set `startIndex=10` and `count=10`, and so on. Default count is 100. Minimum count is 1 and maximum count is 100.","in":"query","required":false,"schema":{"type":"string"}},{"name":"creativeIdFilter","description":"The returned array is filtered to include only creatives with identifiers matching those specified in the comma-delimited string. Either one of (creativeIdFilter or advertiserIdFilter) should be given.","in":"query","required":false,"schema":{"type":"string"}},{"name":"advertiserIdFilter","description":"The returned array is filtered to include only creatives with identifiers matching those specified in the comma-delimited string. Either one of (creativeIdFilter or advertiserIdFilter) should be given.","in":"query","required":false,"schema":{"type":"string"}},{"name":"lineItemTypeFilter","description":"The returned array is filtered to include only creatives with line item type matching those specified in the comma-delimited string. If the given filter value is not part of enumeration (LineItemType), Response code will be 404. VIDEO line item type filter is available since version `application/vnd.dspcreatives.v2.1+json`.","in":"query","required":false,"schema":{"type":"string","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP","VIDEO"]}}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","properties":{"advertiserId":{"type":"string","description":"The identifier of the advertiser.","readOnly":true},"creativeId":{"type":"string","description":"The identifier of the creative.","readOnly":true},"type":{"type":"string","description":"The creative type.","readOnly":true},"name":{"type":"string","description":"The creative name.","readOnly":true},"externalId":{"type":"string","description":"The external identifier of the creative.","readOnly":true},"size":{"type":"string","description":"The creative size.","readOnly":true},"supportedLineItemTypes":{"type":"array","description":"Supported lineItemTypes where creatives can be associated. VIDEO line item type is supported since version `application/vnd.dspcreatives.v2.1+json`","items":{"type":"string","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP","VIDEO"]}}}},"minItems":1,"maxItems":100}}}},"application/vnd.dspcreatives.v2+json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of results which satisfy the filtering criteria. This will help to support pagination."},"response":{"type":"array","items":{"type":"object","properties":{"advertiserId":{"type":"string","description":"The identifier of the advertiser.","readOnly":true},"creativeId":{"type":"string","description":"The identifier of the creative.","readOnly":true},"type":{"type":"string","description":"The creative type.","readOnly":true},"name":{"type":"string","description":"The creative name.","readOnly":true},"externalId":{"type":"string","description":"The external identifier of the creative.","readOnly":true},"size":{"type":"string","description":"The creative size.","readOnly":true},"supportedLineItemTypes":{"type":"array","description":"Supported lineItemTypes where creatives can be associated. VIDEO line item type is supported since version `application/vnd.dspcreatives.v2.1+json`","items":{"type":"string","enum":["STANDARD_DISPLAY","AMAZON_MOBILE_DISPLAY","AAP_MOBILE_APP","VIDEO"]}}}},"minItems":1,"maxItems":100}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed to perform this operation"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dspcreatives.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dspcreatives.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Creative/operation/getCreatives","sectionHeader":{"type":3,"text":"GET /dsp/creatives/"},"summary":"Gets one or more creatives.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/image",{"tags":["Image Creative"],"summary":"[DEPRECATED] Get image creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nGet an image creative matching criteria provided in request.\n\nCallout - A future update will add support to get multiple Image creatives at a time.\n","operationId":"getImageCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array is filtered to include only creatives with Ids matching those specified in the comma-delimited string.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspimagecreatives.v1+json":{"schema":{"type":"object","description":"Read image creatives response.","properties":{"creatives":{"type":"array","items":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for image creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"type":"object","description":"Image's click through action which can have any one of the following properties. One action and one action alone must be provided.","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]},"detailPage":{"type":"object","description":"Click through Action - Detail Page. This is applicable only to `MOBILE_OO` and `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Define which product's detail page the customer should be taken to when tapping on the creative."},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. By default it is false. This will be considered only for `MOBILE_AAP` supply."}},"required":["productAsin"]},"searchAsin":{"type":"object","description":"Click through Action - Search Asins. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"productAsins":{"type":"array","description":"Define the Asins to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":25,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. Default value is `false`."}},"required":["productAsins"]},"searchKeyword":{"type":"object","description":"Click through action - Search Keywords. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"keywords":{"type":"array","description":"Define the keywords to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. By default it is `false`."}},"required":["keywords"]},"androidAppDownload":{"type":"object","description":"To target Android app download as click through action, at least `storeId`, `productAsin` or `downloadUrl` must be provided. If both `storeId` and `productAsin` is provided, `storePriority` must be provided as well. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"isRtb":{"type":"boolean","description":"Indicates whether it's for real time bidding or not. Default value is `false`. This is applicable only to `MOBILE_AAP` supply."},"storeId":{"type":"string","description":"Android play store Id for app, used to build the download URL."},"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL. This is applicable only to `MOBILE_AAP` supply."},"storePriority":{"type":"string","description":"The higher priority store will be tried first, then if it does not exist on device the second store will be tried. Default value is `PLAY_STORE_THEN_AMAZON_APP_STORE`. This is applicable only to `MOBILE_AAP` supply.","enum":["PLAY_STORE_THEN_AMAZON_APP_STORE","AMAZON_APP_STORE_THEN_PLAY_STORE"]},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `playStoreId` and `productAsin` information provided. It can be overriden."}}},"iosAppDownload":{"type":"object","description":"Click through action - IOS App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"storeLink":{"type":"string","description":"Apple app store link for app, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `storeLink` information provided. It can be overridden."}},"required":["storeLink"]},"kindleAppDownload":{"type":"object","description":"Click through Action - Kindle App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, this will be built automatically using `productAsin` information provided. It can be overridden."}},"required":["productAsin"]}}},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","asset","clickThroughAction"]},{"type":"object","description":"Create image creative request.","properties":{"supply":{"allOf":[{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]}]}},"required":["supply"]}]},{"description":"Update image creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for image creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"type":"object","description":"Image's click through action which can have any one of the following properties. One action and one action alone must be provided.","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]},"detailPage":{"type":"object","description":"Click through Action - Detail Page. This is applicable only to `MOBILE_OO` and `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Define which product's detail page the customer should be taken to when tapping on the creative."},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. By default it is false. This will be considered only for `MOBILE_AAP` supply."}},"required":["productAsin"]},"searchAsin":{"type":"object","description":"Click through Action - Search Asins. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"productAsins":{"type":"array","description":"Define the Asins to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":25,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. Default value is `false`."}},"required":["productAsins"]},"searchKeyword":{"type":"object","description":"Click through action - Search Keywords. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"keywords":{"type":"array","description":"Define the keywords to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. By default it is `false`."}},"required":["keywords"]},"androidAppDownload":{"type":"object","description":"To target Android app download as click through action, at least `storeId`, `productAsin` or `downloadUrl` must be provided. If both `storeId` and `productAsin` is provided, `storePriority` must be provided as well. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"isRtb":{"type":"boolean","description":"Indicates whether it's for real time bidding or not. Default value is `false`. This is applicable only to `MOBILE_AAP` supply."},"storeId":{"type":"string","description":"Android play store Id for app, used to build the download URL."},"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL. This is applicable only to `MOBILE_AAP` supply."},"storePriority":{"type":"string","description":"The higher priority store will be tried first, then if it does not exist on device the second store will be tried. Default value is `PLAY_STORE_THEN_AMAZON_APP_STORE`. This is applicable only to `MOBILE_AAP` supply.","enum":["PLAY_STORE_THEN_AMAZON_APP_STORE","AMAZON_APP_STORE_THEN_PLAY_STORE"]},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `playStoreId` and `productAsin` information provided. It can be overriden."}}},"iosAppDownload":{"type":"object","description":"Click through action - IOS App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"storeLink":{"type":"string","description":"Apple app store link for app, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `storeLink` information provided. It can be overridden."}},"required":["storeLink"]},"kindleAppDownload":{"type":"object","description":"Click through Action - Kindle App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, this will be built automatically using `productAsin` information provided. It can be overridden."}},"required":["productAsin"]}}},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","asset","clickThroughAction"]}]},{"type":"object","description":"This holds common read-only properties of all creative types.","properties":{"approvalStatus":{"type":"string","description":"The creative approval status.","enum":["PENDING","APPROVED","NOT_APPROVED","WAITING_FOR_LINEITEM","APPROVED_WITH_EXCEPTIONS"]},"createdDate":{"type":"string","description":"The creative created date."},"lastUpdatedDate":{"type":"string","description":"The creative last updated date."}}}]},"minItems":1,"maxItems":1}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Image%20Creative/operation/getImageCreatives","sectionHeader":{"type":3,"text":"GET /dsp/creatives/image"},"summary":"[DEPRECATED] Get image creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/image",{"tags":["Image Creative"],"summary":"[DEPRECATED] Create image creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nCreate an image creative.\n\nCallout - A future update will add support to create multiple Image creatives at a time.\n","operationId":"CreateImageCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspcreateimagecreatives.v1+json":{"schema":{"type":"array","description":"Create image creatives request.","items":{"allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for image creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"type":"object","description":"Image's click through action which can have any one of the following properties. One action and one action alone must be provided.","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]},"detailPage":{"type":"object","description":"Click through Action - Detail Page. This is applicable only to `MOBILE_OO` and `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Define which product's detail page the customer should be taken to when tapping on the creative."},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. By default it is false. This will be considered only for `MOBILE_AAP` supply."}},"required":["productAsin"]},"searchAsin":{"type":"object","description":"Click through Action - Search Asins. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"productAsins":{"type":"array","description":"Define the Asins to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":25,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. Default value is `false`."}},"required":["productAsins"]},"searchKeyword":{"type":"object","description":"Click through action - Search Keywords. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"keywords":{"type":"array","description":"Define the keywords to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. By default it is `false`."}},"required":["keywords"]},"androidAppDownload":{"type":"object","description":"To target Android app download as click through action, at least `storeId`, `productAsin` or `downloadUrl` must be provided. If both `storeId` and `productAsin` is provided, `storePriority` must be provided as well. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"isRtb":{"type":"boolean","description":"Indicates whether it's for real time bidding or not. Default value is `false`. This is applicable only to `MOBILE_AAP` supply."},"storeId":{"type":"string","description":"Android play store Id for app, used to build the download URL."},"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL. This is applicable only to `MOBILE_AAP` supply."},"storePriority":{"type":"string","description":"The higher priority store will be tried first, then if it does not exist on device the second store will be tried. Default value is `PLAY_STORE_THEN_AMAZON_APP_STORE`. This is applicable only to `MOBILE_AAP` supply.","enum":["PLAY_STORE_THEN_AMAZON_APP_STORE","AMAZON_APP_STORE_THEN_PLAY_STORE"]},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `playStoreId` and `productAsin` information provided. It can be overriden."}}},"iosAppDownload":{"type":"object","description":"Click through action - IOS App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"storeLink":{"type":"string","description":"Apple app store link for app, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `storeLink` information provided. It can be overridden."}},"required":["storeLink"]},"kindleAppDownload":{"type":"object","description":"Click through Action - Kindle App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, this will be built automatically using `productAsin` information provided. It can be overridden."}},"required":["productAsin"]}}},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","asset","clickThroughAction"]},{"type":"object","description":"Create image creative request.","properties":{"supply":{"allOf":[{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]}]}},"required":["supply"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspimagecreativesresponse.v1+json":{"schema":{"type":"array","description":"Create/Update operation's image creatives response.","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Image%20Creative/operation/CreateImageCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/image"},"summary":"[DEPRECATED] Create image creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/image",{"tags":["Image Creative"],"summary":"[DEPRECATED] Update image creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nUpdate an image creative.\n\nCallout - A future update will add support to update multiple Image creatives at a time.\n","operationId":"UpdateImageCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspupdateimagecreatives.v1+json":{"schema":{"type":"array","description":"Update image creatives request.","items":{"description":"Update image creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for image creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"type":"object","description":"Image's click through action which can have any one of the following properties. One action and one action alone must be provided.","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]},"detailPage":{"type":"object","description":"Click through Action - Detail Page. This is applicable only to `MOBILE_OO` and `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Define which product's detail page the customer should be taken to when tapping on the creative."},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. By default it is false. This will be considered only for `MOBILE_AAP` supply."}},"required":["productAsin"]},"searchAsin":{"type":"object","description":"Click through Action - Search Asins. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"productAsins":{"type":"array","description":"Define the Asins to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":25,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. Default value is `false`."}},"required":["productAsins"]},"searchKeyword":{"type":"object","description":"Click through action - Search Keywords. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"keywords":{"type":"array","description":"Define the keywords to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. By default it is `false`."}},"required":["keywords"]},"androidAppDownload":{"type":"object","description":"To target Android app download as click through action, at least `storeId`, `productAsin` or `downloadUrl` must be provided. If both `storeId` and `productAsin` is provided, `storePriority` must be provided as well. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"isRtb":{"type":"boolean","description":"Indicates whether it's for real time bidding or not. Default value is `false`. This is applicable only to `MOBILE_AAP` supply."},"storeId":{"type":"string","description":"Android play store Id for app, used to build the download URL."},"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL. This is applicable only to `MOBILE_AAP` supply."},"storePriority":{"type":"string","description":"The higher priority store will be tried first, then if it does not exist on device the second store will be tried. Default value is `PLAY_STORE_THEN_AMAZON_APP_STORE`. This is applicable only to `MOBILE_AAP` supply.","enum":["PLAY_STORE_THEN_AMAZON_APP_STORE","AMAZON_APP_STORE_THEN_PLAY_STORE"]},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `playStoreId` and `productAsin` information provided. It can be overriden."}}},"iosAppDownload":{"type":"object","description":"Click through action - IOS App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"storeLink":{"type":"string","description":"Apple app store link for app, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `storeLink` information provided. It can be overridden."}},"required":["storeLink"]},"kindleAppDownload":{"type":"object","description":"Click through Action - Kindle App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, this will be built automatically using `productAsin` information provided. It can be overridden."}},"required":["productAsin"]}}},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","asset","clickThroughAction"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspimagecreativesresponse.v1+json":{"schema":{"type":"array","description":"Create/Update operation's image creatives response.","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Image%20Creative/operation/UpdateImageCreative","sectionHeader":{"type":3,"text":"PUT /dsp/creatives/image"},"summary":"[DEPRECATED] Update image creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/image/preview",{"tags":["Image Creative"],"summary":"[DEPRECATED] Preview an image creative.","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nPreview an image creative.\n","operationId":"previewImageCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A preview request.","content":{"application/vnd.dsppreviewimagecreatives.v1+json":{"schema":{"description":"Image creative preview request. Either `creativeId` or `creativeModel` must be provided, but not both.","type":"object","properties":{"creativeId":{"type":"string","description":"The creative Id."},"creativeModel":{"description":"Image creative preview model. Populate this to preview a new creative.","type":"object","properties":{"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]},"supply":{"allOf":[{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]}]},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"type":"object","description":"Image's click through action which can have any one of the following properties. One action and one action alone must be provided.","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]},"detailPage":{"type":"object","description":"Click through Action - Detail Page. This is applicable only to `MOBILE_OO` and `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Define which product's detail page the customer should be taken to when tapping on the creative."},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. By default it is false. This will be considered only for `MOBILE_AAP` supply."}},"required":["productAsin"]},"searchAsin":{"type":"object","description":"Click through Action - Search Asins. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"productAsins":{"type":"array","description":"Define the Asins to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":25,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. Default value is `false`."}},"required":["productAsins"]},"searchKeyword":{"type":"object","description":"Click through action - Search Keywords. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"keywords":{"type":"array","description":"Define the keywords to query for in the search results that will be displayed on click-through.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"enableDeepLinking":{"type":"boolean","description":"Allow to open URL in Amazon App, if available on device. This will be considered only for `MOBILE_AAP` supply. By default it is `false`."}},"required":["keywords"]},"androidAppDownload":{"type":"object","description":"To target Android app download as click through action, at least `storeId`, `productAsin` or `downloadUrl` must be provided. If both `storeId` and `productAsin` is provided, `storePriority` must be provided as well. This is applicable only to `MOBILE_AAP` and `MOBILE_OO` supply.","properties":{"isRtb":{"type":"boolean","description":"Indicates whether it's for real time bidding or not. Default value is `false`. This is applicable only to `MOBILE_AAP` supply."},"storeId":{"type":"string","description":"Android play store Id for app, used to build the download URL."},"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL. This is applicable only to `MOBILE_AAP` supply."},"storePriority":{"type":"string","description":"The higher priority store will be tried first, then if it does not exist on device the second store will be tried. Default value is `PLAY_STORE_THEN_AMAZON_APP_STORE`. This is applicable only to `MOBILE_AAP` supply.","enum":["PLAY_STORE_THEN_AMAZON_APP_STORE","AMAZON_APP_STORE_THEN_PLAY_STORE"]},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `playStoreId` and `productAsin` information provided. It can be overriden."}}},"iosAppDownload":{"type":"object","description":"Click through action - IOS App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"storeLink":{"type":"string","description":"Apple app store link for app, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, This will be built automatically using `storeLink` information provided. It can be overridden."}},"required":["storeLink"]},"kindleAppDownload":{"type":"object","description":"Click through Action - Kindle App Download. This is applicable only to `MOBILE_AAP` supply.","properties":{"productAsin":{"type":"string","description":"Amazon product Asin, used to build the download URL."},"downloadUrl":{"type":"string","description":"URL to direct users to download app. By default, this will be built automatically using `productAsin` information provided. It can be overridden."}},"required":["productAsin"]}}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["marketplace","supply","size","asset","adChoicesPosition"]},"previewConfiguration":{"description":"Configuration settings for preview","type":"object","properties":{"isOnAmazon":{"type":"boolean","description":"If it's true, shows preview in amazon websites, else shows in other websites","default":true}}}}}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dsppreviewcreativesresponse.v1+json":{"schema":{"description":"Creative preview response.","type":"object","properties":{"previewContent":{"description":"The HTML content","type":"string"}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Image%20Creative/operation/previewImageCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/image/preview"},"summary":"[DEPRECATED] Preview an image creative.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/video",{"tags":["Video Creative"],"summary":"[DEPRECATED] Get video creative(s)","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nGet a video creative matching criteria provided in request.\n\nCallout - A future update will add support to get multiple Video creatives at a time.\n","operationId":"getVideoCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array is filtered to include only creatives with Ids matching those specified in the comma-delimited string.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspvideocreatives.v1+json":{"schema":{"type":"object","description":"Read video creatives response.","properties":{"creatives":{"type":"array","items":{"allOf":[{"description":"Create video creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for video creative","properties":{"externalId":{"description":"The creative external identifier.","type":"string"},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"description":"Click through action for video creatives","type":"object","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]}}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["asset","clickThroughAction"]}]},{"description":"Update video creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for video creative","properties":{"externalId":{"description":"The creative external identifier.","type":"string"},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"description":"Click through action for video creatives","type":"object","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]}}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["asset","clickThroughAction"]}]},{"type":"object","description":"This holds common read-only properties of all creative types.","properties":{"approvalStatus":{"type":"string","description":"The creative approval status.","enum":["PENDING","APPROVED","NOT_APPROVED","WAITING_FOR_LINEITEM","APPROVED_WITH_EXCEPTIONS"]},"createdDate":{"type":"string","description":"The creative created date."},"lastUpdatedDate":{"type":"string","description":"The creative last updated date."}}}]},"minItems":1,"maxItems":1}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Video%20Creative/operation/getVideoCreatives","sectionHeader":{"type":3,"text":"GET /dsp/creatives/video"},"summary":"[DEPRECATED] Get video creative(s)","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/video",{"tags":["Video Creative"],"summary":"[DEPRECATED] Create video creative(s)","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nCreate a video creative\n\nCallout - A future update will add support to create multiple Video creatives at a time.\n","operationId":"createVideoCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspcreatevideocreatives.v1+json":{"schema":{"description":"Create video creatives request.","type":"array","items":{"description":"Create video creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for video creative","properties":{"externalId":{"description":"The creative external identifier.","type":"string"},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"description":"Click through action for video creatives","type":"object","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]}}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["asset","clickThroughAction"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspvideocreativesresponse.v1+json":{"schema":{"description":"Create/Update operation's video creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Video%20Creative/operation/createVideoCreatives","sectionHeader":{"type":3,"text":"POST /dsp/creatives/video"},"summary":"[DEPRECATED] Create video creative(s)","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/video",{"tags":["Video Creative"],"summary":"[DEPRECATED] Update video creative(s)","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nUpdate a video creative\n\nCallout - A future update will add support to update multiple Video creatives at a time.\n","operationId":"updateVideoCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspupdatevideocreatives.v1+json":{"schema":{"description":"Update video creatives request","type":"array","items":{"description":"Update video creative request","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for video creative","properties":{"externalId":{"description":"The creative external identifier.","type":"string"},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"description":"Click through action for video creatives","type":"object","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]}}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["asset","clickThroughAction"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspvideocreativesresponse.v1+json":{"schema":{"description":"Create/Update operation's video creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Video%20Creative/operation/updateVideoCreatives","sectionHeader":{"type":3,"text":"PUT /dsp/creatives/video"},"summary":"[DEPRECATED] Update video creative(s)","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/video/preview",{"tags":["Video Creative"],"summary":"[DEPRECATED] Preview a video creative","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nPreview a video creative\n","operationId":"previewVideoCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A preview request.","content":{"application/vnd.dsppreviewvideocreatives.v1+json":{"schema":{"description":"Video creative preview request. Either `creativeId` or `creativeModel` must be provided, but not both.","type":"object","properties":{"creativeId":{"description":"The creative Id.","type":"string"},"creativeModel":{"description":"Video creative preview model. Populate this to preview a new creative.","type":"object","properties":{"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]},"asset":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"clickThroughAction":{"description":"Click through action for video creatives","type":"object","properties":{"customUrl":{"type":"object","description":"Click through Action - Custom Url.","properties":{"url":{"type":"string","description":"Define where the creative links to on click."}},"required":["url"]}}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["marketplace","asset"]}}}}}},"responses":{"200":{"description":"Successful operation","content":{"application/vnd.dsppreviewcreativesresponse.v1+json":{"schema":{"description":"Creative preview response.","type":"object","properties":{"previewContent":{"description":"The HTML content","type":"string"}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Video%20Creative/operation/previewVideoCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/video/preview"},"summary":"[DEPRECATED] Preview a video creative","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/rec",{"tags":["Responsive eCommerce Creative"],"summary":"[DEPRECATED] Get Responsive eCommerce Creative  (REC).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nGet an Responsive eCommerce Creative (REC) matching criteria provided in request.\n\nCallout - A future update will add support to get multiple REC creatives at a time.\n","operationId":"getRecCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array is filtered to include only creatives with Ids matching those specified in the comma-delimited string.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspreccreatives.v1+json":{"schema":{"type":"object","description":"Read Responsive eCommerce creative (REC) creatives response.","properties":{"creatives":{"type":"array","items":{"allOf":[{"description":"Create Responsive eCommerce creative (REC) request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for REC creative.","properties":{"additionalHtml":{"description":"Add HTML to the creative for surveys or other arbitrary HTML.","type":"string","maxLength":5000},"allowThirdPartySellers":{"description":"If it's true, orders can be fulfilled by third party sellers.","type":"boolean"},"content":{"description":"Responsive eCommerce creative field for displaying customized content. Provide either Background or LogoHeadline but not both.","type":"object","properties":{"background":{"description":"Creative customization field for displaying custom images.","type":"array","items":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]}},"logoHeadline":{"description":"Creative customization field for displaying brandlogo and headline.","type":"object","properties":{"brandLogo":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"headline":{"description":"Creative customization field for displaying headline.","type":"string","maxLength":50}},"required":["brandLogo"]}}},"allowedFormats":{"description":"A list of formats configured to display for the creative.","type":"array","items":{"description":"Formats configured to display for the creative.\n* `SHOP_NOW`: Clicking on the ad will take customer to the relevant product detail page.\n* `ADD_TO_CART`: Clicking on the ad will add the product to the customer’s Cart.\n* `COUPON`: Clicking on the ad will clip the coupon and take the customer to the product detail page for that item, if signed in; otherwise take them to the coupon landing page where the customer is instructed to sign in.\n","type":"string","enum":["SHOP_NOW","ADD_TO_CART","COUPON"]},"minItems":0,"maxItems":3},"optimizationGoal":{"description":"Metric which creative optimization should attempt to improve.","type":"string","enum":["PURCHASE_RATE","CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE"]},"allowedSizes":{"description":"A list of sizes configured to display for the creative. This overrides the default REC supported sizes.","type":"array","items":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"minItems":0,"maxItems":11},"associatedProducts":{"type":"array","description":"Product objects associated with the creative.","items":{"description":"The object representation of a product.","type":"object","properties":{"asin":{"description":"Amazon standard identification number.","type":"string"},"productTitle":{"description":"Retail product title.","type":"string"}},"required":["asin"]},"minItems":1,"maxItems":20},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","description":"URL used for tracking interactions with third party","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["associatedProducts"]}]},{"description":"Update Responsive eCommerce creative (REC) request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for REC creative.","properties":{"additionalHtml":{"description":"Add HTML to the creative for surveys or other arbitrary HTML.","type":"string","maxLength":5000},"allowThirdPartySellers":{"description":"If it's true, orders can be fulfilled by third party sellers.","type":"boolean"},"content":{"description":"Responsive eCommerce creative field for displaying customized content. Provide either Background or LogoHeadline but not both.","type":"object","properties":{"background":{"description":"Creative customization field for displaying custom images.","type":"array","items":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]}},"logoHeadline":{"description":"Creative customization field for displaying brandlogo and headline.","type":"object","properties":{"brandLogo":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"headline":{"description":"Creative customization field for displaying headline.","type":"string","maxLength":50}},"required":["brandLogo"]}}},"allowedFormats":{"description":"A list of formats configured to display for the creative.","type":"array","items":{"description":"Formats configured to display for the creative.\n* `SHOP_NOW`: Clicking on the ad will take customer to the relevant product detail page.\n* `ADD_TO_CART`: Clicking on the ad will add the product to the customer’s Cart.\n* `COUPON`: Clicking on the ad will clip the coupon and take the customer to the product detail page for that item, if signed in; otherwise take them to the coupon landing page where the customer is instructed to sign in.\n","type":"string","enum":["SHOP_NOW","ADD_TO_CART","COUPON"]},"minItems":0,"maxItems":3},"optimizationGoal":{"description":"Metric which creative optimization should attempt to improve.","type":"string","enum":["PURCHASE_RATE","CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE"]},"allowedSizes":{"description":"A list of sizes configured to display for the creative. This overrides the default REC supported sizes.","type":"array","items":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"minItems":0,"maxItems":11},"associatedProducts":{"type":"array","description":"Product objects associated with the creative.","items":{"description":"The object representation of a product.","type":"object","properties":{"asin":{"description":"Amazon standard identification number.","type":"string"},"productTitle":{"description":"Retail product title.","type":"string"}},"required":["asin"]},"minItems":1,"maxItems":20},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","description":"URL used for tracking interactions with third party","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["associatedProducts"]}]},{"type":"object","description":"This holds common read-only properties of all creative types.","properties":{"approvalStatus":{"type":"string","description":"The creative approval status.","enum":["PENDING","APPROVED","NOT_APPROVED","WAITING_FOR_LINEITEM","APPROVED_WITH_EXCEPTIONS"]},"createdDate":{"type":"string","description":"The creative created date."},"lastUpdatedDate":{"type":"string","description":"The creative last updated date."}}}]},"minItems":1,"maxItems":1}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Responsive%20eCommerce%20Creative/operation/getRecCreatives","sectionHeader":{"type":3,"text":"GET /dsp/creatives/rec"},"summary":"[DEPRECATED] Get Responsive eCommerce Creative  (REC).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/rec",{"tags":["Responsive eCommerce Creative"],"summary":"[DEPRECATED] Create Responsive eCommerce Creatives(REC).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nCreate a new Responsive eCommerce Creatives(REC).\n\nCallout - A future update will add support to create multiple REC creatives at a time.\n","operationId":"createRecCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspcreatereccreatives.v1+json":{"schema":{"description":"Create Responsive eCommerce creatives (REC) request.","type":"array","items":{"description":"Create Responsive eCommerce creative (REC) request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for REC creative.","properties":{"additionalHtml":{"description":"Add HTML to the creative for surveys or other arbitrary HTML.","type":"string","maxLength":5000},"allowThirdPartySellers":{"description":"If it's true, orders can be fulfilled by third party sellers.","type":"boolean"},"content":{"description":"Responsive eCommerce creative field for displaying customized content. Provide either Background or LogoHeadline but not both.","type":"object","properties":{"background":{"description":"Creative customization field for displaying custom images.","type":"array","items":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]}},"logoHeadline":{"description":"Creative customization field for displaying brandlogo and headline.","type":"object","properties":{"brandLogo":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"headline":{"description":"Creative customization field for displaying headline.","type":"string","maxLength":50}},"required":["brandLogo"]}}},"allowedFormats":{"description":"A list of formats configured to display for the creative.","type":"array","items":{"description":"Formats configured to display for the creative.\n* `SHOP_NOW`: Clicking on the ad will take customer to the relevant product detail page.\n* `ADD_TO_CART`: Clicking on the ad will add the product to the customer’s Cart.\n* `COUPON`: Clicking on the ad will clip the coupon and take the customer to the product detail page for that item, if signed in; otherwise take them to the coupon landing page where the customer is instructed to sign in.\n","type":"string","enum":["SHOP_NOW","ADD_TO_CART","COUPON"]},"minItems":0,"maxItems":3},"optimizationGoal":{"description":"Metric which creative optimization should attempt to improve.","type":"string","enum":["PURCHASE_RATE","CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE"]},"allowedSizes":{"description":"A list of sizes configured to display for the creative. This overrides the default REC supported sizes.","type":"array","items":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"minItems":0,"maxItems":11},"associatedProducts":{"type":"array","description":"Product objects associated with the creative.","items":{"description":"The object representation of a product.","type":"object","properties":{"asin":{"description":"Amazon standard identification number.","type":"string"},"productTitle":{"description":"Retail product title.","type":"string"}},"required":["asin"]},"minItems":1,"maxItems":20},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","description":"URL used for tracking interactions with third party","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["associatedProducts"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspreccreativesresponse.v1+json":{"schema":{"description":"Create/Update operation's rec creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Responsive%20eCommerce%20Creative/operation/createRecCreatives","sectionHeader":{"type":3,"text":"POST /dsp/creatives/rec"},"summary":"[DEPRECATED] Create Responsive eCommerce Creatives(REC).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/rec",{"tags":["Responsive eCommerce Creative"],"summary":"[DEPRECATED] Update Responsive eCommerce Creatives(REC).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nUpdate existing Responsive eCommerce Creatives(REC).\n\nCallout - A future update will add support for multiple at a time.\n","operationId":"updateRecCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspupdatereccreatives.v1+json":{"schema":{"type":"array","description":"Update Responsive eCommerce creatives (REC) request.","items":{"description":"Update Responsive eCommerce creative (REC) request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for REC creative.","properties":{"additionalHtml":{"description":"Add HTML to the creative for surveys or other arbitrary HTML.","type":"string","maxLength":5000},"allowThirdPartySellers":{"description":"If it's true, orders can be fulfilled by third party sellers.","type":"boolean"},"content":{"description":"Responsive eCommerce creative field for displaying customized content. Provide either Background or LogoHeadline but not both.","type":"object","properties":{"background":{"description":"Creative customization field for displaying custom images.","type":"array","items":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]}},"logoHeadline":{"description":"Creative customization field for displaying brandlogo and headline.","type":"object","properties":{"brandLogo":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"headline":{"description":"Creative customization field for displaying headline.","type":"string","maxLength":50}},"required":["brandLogo"]}}},"allowedFormats":{"description":"A list of formats configured to display for the creative.","type":"array","items":{"description":"Formats configured to display for the creative.\n* `SHOP_NOW`: Clicking on the ad will take customer to the relevant product detail page.\n* `ADD_TO_CART`: Clicking on the ad will add the product to the customer’s Cart.\n* `COUPON`: Clicking on the ad will clip the coupon and take the customer to the product detail page for that item, if signed in; otherwise take them to the coupon landing page where the customer is instructed to sign in.\n","type":"string","enum":["SHOP_NOW","ADD_TO_CART","COUPON"]},"minItems":0,"maxItems":3},"optimizationGoal":{"description":"Metric which creative optimization should attempt to improve.","type":"string","enum":["PURCHASE_RATE","CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE"]},"allowedSizes":{"description":"A list of sizes configured to display for the creative. This overrides the default REC supported sizes.","type":"array","items":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"minItems":0,"maxItems":11},"associatedProducts":{"type":"array","description":"Product objects associated with the creative.","items":{"description":"The object representation of a product.","type":"object","properties":{"asin":{"description":"Amazon standard identification number.","type":"string"},"productTitle":{"description":"Retail product title.","type":"string"}},"required":["asin"]},"minItems":1,"maxItems":20},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","description":"URL used for tracking interactions with third party","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["associatedProducts"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspreccreativesresponse.v1+json":{"schema":{"description":"Create/Update operation's rec creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Responsive%20eCommerce%20Creative/operation/updateRecCreatives","sectionHeader":{"type":3,"text":"PUT /dsp/creatives/rec"},"summary":"[DEPRECATED] Update Responsive eCommerce Creatives(REC).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/rec/preview",{"tags":["Responsive eCommerce Creative"],"summary":"[DEPRECATED] Preview a Responsive eCommerce Creative(REC).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nPreview a Responsive eCommerce Creative(REC).\n","operationId":"previewRecCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A preview request.","content":{"application/vnd.dsppreviewreccreatives.v1+json":{"schema":{"description":"Responsive eCommerce creative preview request. Either `creativeId` or `creativeModel` must be provided, but not both.","type":"object","properties":{"creativeId":{"description":"The identifier of the creative.","type":"string"},"creativeModel":{"description":"Responsive eCommerce Creative preview model. Populate this to preview a new creative.","type":"object","properties":{"content":{"description":"Responsive eCommerce creative field for displaying customized content. Provide either Background or LogoHeadline but not both.","type":"object","properties":{"background":{"description":"Creative customization field for displaying custom images.","type":"array","items":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]}},"logoHeadline":{"description":"Creative customization field for displaying brandlogo and headline.","type":"object","properties":{"brandLogo":{"type":"object","description":"Asset to be associated with creative.","properties":{"assetId":{"type":"string","description":"The uploaded asset Id. This Id is provided by Creative Assets API when user registers an asset with assetType after upload."},"version":{"type":"string","description":"The uploaded asset version. This version is provided by Creative Assets API when user registers an asset with assetType after upload."},"url":{"type":"string","description":"The asset's URL. This will be provided if asset linked with the creative being read is not registered in Creative Assets API."}},"required":["assetId","version"]},"headline":{"description":"Creative customization field for displaying headline.","type":"string","maxLength":50}},"required":["brandLogo"]}}},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]},"thirdPartyClickTrackers":{"type":"array","description":"This URL is pinged when the creative is clicked. The URL can contain macros.","minItems":0,"maxItems":5,"items":{"type":"string","maxLength":2000}},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["marketplace"]},"previewConfiguration":{"allOf":[{"description":"Configuration settings for preview","type":"object","properties":{"isOnAmazon":{"type":"boolean","description":"If it's true, shows preview in amazon websites, else shows in other websites","default":true}}},{"type":"object","description":"REC Creative Preview Configuration","properties":{"allowedSize":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"allowedFormat":{"description":"Formats configured to display for the creative.\n* `SHOP_NOW`: Clicking on the ad will take customer to the relevant product detail page.\n* `ADD_TO_CART`: Clicking on the ad will add the product to the customer’s Cart.\n* `COUPON`: Clicking on the ad will clip the coupon and take the customer to the product detail page for that item, if signed in; otherwise take them to the coupon landing page where the customer is instructed to sign in.\n","type":"string","enum":["SHOP_NOW","ADD_TO_CART","COUPON"]},"associatedProduct":{"description":"The object representation of a product.","type":"object","properties":{"asin":{"description":"Amazon standard identification number.","type":"string"},"productTitle":{"description":"Retail product title.","type":"string"}},"required":["asin"]}},"required":["allowedSize","allowedFormat","associatedProduct"]}]}},"required":["previewConfiguration"]}}}},"responses":{"200":{"description":"Successful operation","content":{"application/vnd.dsppreviewcreativesresponse.v1+json":{"schema":{"description":"Creative preview response.","type":"object","properties":{"previewContent":{"description":"The HTML content","type":"string"}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Responsive%20eCommerce%20Creative/operation/previewRecCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/rec/preview"},"summary":"[DEPRECATED] Preview a Responsive eCommerce Creative(REC).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/thirdparty",{"tags":["Third Party Creative"],"summary":"[DEPRECATED] Get third party creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nGet a third party creative matching criteria provided in request.\n\nNote that a future update will add support to get multiple third party creatives at a time.\n","operationId":"getThirdPartyCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array is filtered to include only creatives with Ids matching those specified in the comma-delimited string.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspthirdpartycreatives.v1+json":{"schema":{"type":"object","description":"Read Third Party creative creatives response.","properties":{"creatives":{"type":"array","items":{"allOf":[{"allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for Third Party creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"tagSource":{"type":"string","description":"The third party tag associated with creative."},"destination":{"description":"Choose `AMAZON` if the `tag` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","allOf":[{"type":"string","description":"Choose `AMAZON` if the `click through` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","enum":["AMAZON","OTHER"],"default":"OTHER"}]},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","tagSource"]},{"type":"object","description":"Create Third Party creative request.","properties":{"supply":{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]}},"required":["supply"]}]},{"description":"Update Third Party creative request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for Third Party creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"tagSource":{"type":"string","description":"The third party tag associated with creative."},"destination":{"description":"Choose `AMAZON` if the `tag` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","allOf":[{"type":"string","description":"Choose `AMAZON` if the `click through` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","enum":["AMAZON","OTHER"],"default":"OTHER"}]},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","tagSource"]}]},{"type":"object","description":"This holds common read-only properties of all creative types.","properties":{"approvalStatus":{"type":"string","description":"The creative approval status.","enum":["PENDING","APPROVED","NOT_APPROVED","WAITING_FOR_LINEITEM","APPROVED_WITH_EXCEPTIONS"]},"createdDate":{"type":"string","description":"The creative created date."},"lastUpdatedDate":{"type":"string","description":"The creative last updated date."}}}]},"minItems":1,"maxItems":1}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Third%20Party%20Creative/operation/getThirdPartyCreatives","sectionHeader":{"type":3,"text":"GET /dsp/creatives/thirdparty"},"summary":"[DEPRECATED] Get third party creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/thirdparty",{"tags":["Third Party Creative"],"summary":"[DEPRECATED] Create third party creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nCreate a third party creative.\n\nNote that a future update will add support to create multiple third party creatives at a time.\n","operationId":"createThirdPartyCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspcreatethirdpartycreatives.v1+json":{"schema":{"description":"Create Third Party creatives request.","type":"array","items":{"allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common immutable properties of all creative types create request.","properties":{"advertiserId":{"type":"string","description":"The advertiser Id. It's an immutable field."},"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]}},"required":["advertiserId","marketplace"]}]},{"type":"object","description":"This holds common properties that can we written and updated for Third Party creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"tagSource":{"type":"string","description":"The third party tag associated with creative."},"destination":{"description":"Choose `AMAZON` if the `tag` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","allOf":[{"type":"string","description":"Choose `AMAZON` if the `click through` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","enum":["AMAZON","OTHER"],"default":"OTHER"}]},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","tagSource"]},{"type":"object","description":"Create Third Party creative request.","properties":{"supply":{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]}},"required":["supply"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspthirdpartycreativesresponse.v1+json":{"schema":{"description":"Create/Update third party creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Third%20Party%20Creative/operation/createThirdPartyCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/thirdparty"},"summary":"[DEPRECATED] Create third party creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/thirdparty",{"tags":["Third Party Creative"],"summary":"[DEPRECATED] Update third party creative(s).","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nUpdate a third party creative.\n\nNote that a future update will add support to update multiple third party creatives at a time.\n","operationId":"updateThirdPartyCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"An array of creative objects. For each object, specify required fields and their values. Maximum length of the array is 1.","content":{"application/vnd.dspupdatethirdpartycreatives.v1+json":{"schema":{"type":"array","description":"Update Third Party creatives request.","items":{"description":"Update Third Party creative request.","allOf":[{"allOf":[{"type":"object","description":"This holds common mutable properties of all creative types update request.","properties":{"name":{"type":"string","description":"The creative name.","maxLength":255}},"required":["name"]},{"type":"object","description":"This holds common server-assigned mutable properties of all creative types update request.","properties":{"creativeId":{"type":"string","description":"The creative Id. It will be used to perform update operation. It's an immutable field."}},"required":["creativeId"]}]},{"type":"object","description":"This holds common properties that can we written and updated for Third Party creative.","properties":{"externalId":{"type":"string","description":"The creative external Id."},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"tagSource":{"type":"string","description":"The third party tag associated with creative."},"destination":{"description":"Choose `AMAZON` if the `tag` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","allOf":[{"type":"string","description":"Choose `AMAZON` if the `click through` links to an Amazon site like Amazon.com or IMDb. Otherwise choose `OTHER`.","enum":["AMAZON","OTHER"],"default":"OTHER"}]},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"}},"required":["size","tagSource"]}]},"minItems":1,"maxItems":1}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dspthirdpartycreativesresponse.v1+json":{"schema":{"description":"Create/Update third party creatives response.","type":"array","items":{"type":"object","description":"Response for the creative create/update operations. If operation is successful, it contains only creativeId. If it is a failure, it contains only errorDetails.","properties":{"creativeId":{"type":"string","description":"The creative Id."},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Third%20Party%20Creative/operation/updateThirdPartyCreative","sectionHeader":{"type":3,"text":"PUT /dsp/creatives/thirdparty"},"summary":"[DEPRECATED] Update third party creative(s).","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/creatives/thirdparty/preview",{"tags":["Third Party Creative"],"summary":"[DEPRECATED] Preview third party creative.","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nPreview a third party creative.\n","operationId":"previewThirdPartyCreative","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A preview request.","content":{"application/vnd.dsppreviewthirdpartycreatives.v1+json":{"schema":{"description":"Third Party creative preview request. Either `creativeId` or `creativeModel` must be provided, but not both.","type":"object","properties":{"creativeId":{"description":"The identifier of the creative.","type":"string"},"creativeModel":{"description":"Third Party Creative preview model. Populate this to preview a new creative.","type":"object","properties":{"marketplace":{"type":"string","description":"Marketplace where this creative is applicable.","enum":["US"]},"supply":{"description":"Different supported supply of creative.","type":"string","enum":["DESKTOP","MOBILE_OO","MOBILE_AAP"]},"size":{"type":"object","description":"Size of the creative.","properties":{"width":{"type":"number","format":"integer","description":"The creative width in pixels."},"height":{"type":"number","format":"integer","description":"The creative height in pixels."}},"required":["width","height"]},"tagSource":{"type":"string","description":"The third party tag associated with creative."},"additionalHtml":{"type":"string","description":"Add HTML to the creative for surveys or other arbitrary HTML.","maxLength":5000},"adChoicesPosition":{"type":"string","description":"Default value is TOP_RIGHT.","enum":["TOP_RIGHT","TOP_LEFT","BOTTOM_RIGHT","BOTTOM_LEFT"],"default":"TOP_RIGHT"},"thirdPartyTrackers":{"type":"array","minItems":0,"maxItems":5,"items":{"type":"object","description":"Trackers used for tracking interactions with third party","properties":{"type":{"type":"string","description":"Third party creative tracker type.","enum":["IMPRESSION"]},"trackerUrl":{"type":"string","description":"URL used for tracking interactions with third party","maxLength":2000}},"required":["type","trackerUrl"]}}},"required":["marketplace","supply","size","tagSource","adChoicesPosition"]},"previewConfiguration":{"description":"Configuration settings for preview","type":"object","properties":{"isOnAmazon":{"type":"boolean","description":"If it's true, shows preview in amazon websites, else shows in other websites","default":true}}}},"required":["previewConfiguration"]}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dsppreviewcreativesresponse.v1+json":{"schema":{"description":"Creative preview response.","type":"object","properties":{"previewContent":{"description":"The HTML content","type":"string"}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Third%20Party%20Creative/operation/previewThirdPartyCreative","sectionHeader":{"type":3,"text":"POST /dsp/creatives/thirdparty/preview"},"summary":"[DEPRECATED] Preview third party creative.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/moderation/creatives",{"tags":["Moderation"],"summary":"[DEPRECATED] Get creative moderation summary by creativeId.","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nGet creative moderation summary by creativeId.\n","operationId":"getCreativeModeration","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"name":"creativeIdFilter","in":"query","description":"The returned array is filtered to include only creatives with Ids matching those specified in the comma-delimited string.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation.","content":{"application/vnd.dspmoderationcreatives.v1+json":{"schema":{"type":"array","items":{"type":"object","description":"The creative moderation summary.","properties":{"creativeId":{"type":"string"},"status":{"type":"string","description":"The creative approval status.","enum":["PENDING","APPROVED","NOT_APPROVED","WAITING_FOR_LINEITEM","APPROVED_WITH_EXCEPTIONS"]},"reasons":{"type":"array","description":"The reasons why creative is not approved.","items":{"type":"string"},"maxItems":50},"additionalNotes":{"type":"array","description":"The additional notes.","items":{"type":"string"},"maxItems":50}}},"minItems":1,"maxItems":1}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Malformed JSON","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"401":{"description":"Unauthenticated request.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthenticated Request","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"403":{"description":"Forbidden - Request failed because user is not authorized to access a resource.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Unauthorized Access","requestId":"ad165994-489a-4fcf-a175-7a846c899b41","errors":[{"errorType":"ENTITY_NOT_ALLOWED","message":"Given entity is not allowed"}]}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Resource Not Found","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `accept` header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Too Many Requests","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"500":{"description":"Internal Server Error.","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Internal Server Error","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"502":{"description":"Bad Gateway Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception","content":{"application/vnd.dsperrors.v1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/Moderation/operation/getCreativeModeration","sectionHeader":{"type":3,"text":"GET /dsp/moderation/creatives"},"summary":"[DEPRECATED] Get creative moderation summary by creativeId.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/lineItemCreativeAssociations",{"tags":["LineItemCreativeAssociation"],"summary":"[DEPRECATED] Create/delete association between line item and creative.","deprecated":true,"description":"[DEPRECATED - Do not use] Migration guide: https://advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives\n\nCreate/delete association between line item and creative.\n\nCallout -  Do not pass in startDate, endDate and weight. Use the PUT operation instead to populate these fields. We will add support in POST in a future update. A future update will also include support for multiple at a time.\n","operationId":"AssociateLineItemsToCreatives","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"required":["advertiserId","operation","associations"],"type":"object","properties":{"advertiserId":{"type":"string","description":"The advertiser identifier."},"operation":{"type":"string","description":"A lineItemCreativeAssociation operation.","enum":["CREATE","DELETE"]},"associations":{"type":"array","description":"A list of the associations to operate on. This object requires only lineItemId and creativeId and other fields are not required.","items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The lineitem to operate on."},"creativeId":{"type":"string","description":"The creative to operate on."},"startDate":{"type":"string","description":"The creative start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDate":{"type":"string","description":"The creative end date in in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"weight":{"type":"integer","description":"The weight of the creative. This field will be available only if the creative rotation type is `WEIGHTED`."}},"required":["lineItemId","creativeId"]},"maxItems":1,"minItems":1}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"required":["advertiserId","operation","associations"],"type":"object","properties":{"advertiserId":{"type":"string","description":"The advertiser identifier."},"operation":{"type":"string","description":"A lineItemCreativeAssociation operation.","enum":["CREATE","DELETE"]},"associations":{"type":"array","description":"A list of the associations to operate on. This object requires only lineItemId and creativeId and other fields are not required.","items":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The lineitem to operate on."},"creativeId":{"type":"string","description":"The creative to operate on."},"startDate":{"type":"string","description":"The creative start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDate":{"type":"string","description":"The creative end date in in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"weight":{"type":"integer","description":"The weight of the creative. This field will be available only if the creative rotation type is `WEIGHTED`."}},"required":["lineItemId","creativeId"]},"maxItems":1,"minItems":1}}}}}},"responses":{"207":{"description":"Multi-status. This holds array of items which represents success or failure corresponding to the index in the request body.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"Response for the update operation. This object will have either success or failure property for the corresponding requests on the index.","type":"object","properties":{"success":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The lineitem to operate on."},"creativeId":{"type":"string","description":"The creative to operate on."},"startDate":{"type":"string","description":"The creative start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDate":{"type":"string","description":"The creative end date in in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"weight":{"type":"integer","description":"The weight of the creative. This field will be available only if the creative rotation type is `WEIGHTED`."}},"required":["lineItemId","creativeId"]},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"Response for the update operation. This object will have either success or failure property for the corresponding requests on the index.","type":"object","properties":{"success":{"type":"object","properties":{"lineItemId":{"type":"string","description":"The lineitem to operate on."},"creativeId":{"type":"string","description":"The creative to operate on."},"startDate":{"type":"string","description":"The creative start date in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"endDate":{"type":"string","description":"The creative end date in in ISO format (YYYY-MM-DD hh:mm:ss z). Timezone is UTC. For example, 2020-10-21 03:59:00 UTC."},"weight":{"type":"integer","description":"The weight of the creative. This field will be available only if the creative rotation type is `WEIGHTED`."}},"required":["lineItemId","creativeId"]},"errorDetails":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}}},"400":{"description":"Bad Request or request body is not matching with input model.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"415":{"description":"Unsupported Media Type - Version not supported.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"requestId":"07939123-b8aa-466a-a991-8ab45b3a2f8e","message":"Invalid `Accept` Header provided. Please ensure you are specifying supported version for the requested resource."}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Bad Gateway","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Service Unavailable","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}},"504":{"description":"Endpoint Request Timed-out Exception.","content":{"application/vnd.dsplineitemcreativeassociations.v2.1+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}},"application/vnd.dsplineitemcreativeassociations.v2+json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}},"example":{"message":"Endpoint Request Timed-out","requestId":"ad165994-489a-4fcf-a175-7a846c899b41"}}}}}}],"path":"/en-us/dsp-campaigns#tag/LineItemCreativeAssociation/operation/AssociateLineItemsToCreatives","sectionHeader":{"type":3,"text":"POST /dsp/lineItemCreativeAssociations"},"summary":"[DEPRECATED] Create/delete association between line item and creative.","documentType":"api-reference"},{"title":"Amazon Ads API - Amazon DSP","content":["/dsp/geoLocations",{"tags":["Discovery"],"summary":"Gets locationTargeting objects based on locationTargetingId or text query","description":"Gets location targeting objects based on geoLocationID(s) or a text query (country, state, city, postal code, or DMA). Either geoLocationIdFilter or textQuery must be supplied, but not both. \n\nText Query Examples:\n\nWhen you search for \"California States\", only the state of California is returned.\\\nWhen you search for \"California counties\" only the counties in California are returned.\\\nWhen you search for \"California postal\" only the zip codes in California are returned.\\\nWhen you search for \"California cities\" only the cities in California are returned.\\\nWhen you search for \"US states\" all of the US states are returned.\\\nWhen you search for \"US states A\" only the US states beginning with A are returned.\\\nWhen you search for \"US DMAs\" only the DMAs in the US are returned.\\\nWhen you search for \"US postal\" only the postal codes in the US are returned.\n","operationId":"getGeoLocations","parameters":[{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"name":"Amazon-Advertising-API-Scope","in":"header","description":"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 and choose profile id `profileId` from the response to pass it as input. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and the `subType` field must not be `AMAZON_ATTRIBUTION`.","required":true,"schema":{"type":"string"}},{"in":"query","name":"geoLocationIdFilter","schema":{"type":"array","items":{"type":"string"}},"description":"An array of location IDs to retrieve, up to 10 in one request.","required":false},{"in":"query","name":"textQuery","schema":{"type":"string"},"description":"Filter by text such as city, state, country, dma, or postal code. Retrieves top 100 results in decreasing order of relevancy. Results may be paginated to retrieve these items in pages, but no query will return more than 100 items total.","required":false},{"in":"query","name":"nextToken","schema":{"type":"string"},"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","required":false},{"in":"query","name":"maxResults","schema":{"type":"integer","minimum":1,"default":10,"maximum":2000},"description":"Sets the maximum number of locations in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,2000] with default as 10. For example, supplying maxResults=20 with a previously returned token will fetch up to the next 20 items. In some cases, fewer items may be returned.","required":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"geoLocations":{"type":"array","description":"Array of results matching the given IDs or text query","items":{"type":"object","description":"Single geo location information.","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Name of geo location."},"category":{"type":"string","description":"Category of the geo location.","enum":["COUNTRY","STATE","CITY","POSTAL_CODE","DMA"]}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"401":{"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"403":{"description":"Forbidden. The request failed because the user does not have access to the specified resource.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"429":{"description":"Too Many Requests. The request was rate-limited. Retry later.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}},"500":{"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved.","content":{"application/json":{"schema":{"description":"The error response object.","properties":{"requestId":{"type":"string","description":"Request Id that uniquely identifies your request."},"message":{"type":"string","description":"A human-readable description of the response."},"errors":{"type":"array","items":{"type":"object","description":"The sub error object.","properties":{"errorType":{"type":"string"},"message":{"type":"string"},"fieldName":{"type":"string"}},"required":["errorType","message"]}}}}}}}}}],"path":"/en-us/dsp-campaigns#tag/Discovery/operation/getGeoLocations","sectionHeader":{"type":3,"text":"GET /dsp/geoLocations"},"summary":"Gets locationTargeting objects based on locationTargetingId or text query","documentType":"api-reference"},{"title":"Inventory Groups","content":["Inventory Groups Public API\n"],"path":"/en-us/dsp-inventory-groups","sectionHeader":{"type":2,"text":"Inventory Groups"},"documentType":"api-reference"},{"title":"Inventory Groups","content":["/dsp/v1/inventory/inventoryGroups/list",{"summary":"Gets a list of inventory groups.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"maxResults":{"default":"50","description":"Sets the maximum number of results in the response. Used in conjunction with `nextToken` to control pagination.","maximum":100,"type":"integer","minimum":1},"nextToken":{"description":"To retrieve the next page of paginated results, specify this token in the request.","type":"string"}}},{"description":"Field by which to sort the results.","type":"object","properties":{"sortOrder":{"description":"The direction by which to sort the results.","type":"string","enum":["ASCENDING","DESCENDING"]},"sortField":{"description":"The field by which to sort the results. Defaults to `CREATION_DATE_TIME` if unspecified.","type":"string","enum":["INVENTORY_GROUP_ID","INVENTORY_GROUP_NAME","INVENTORY_TYPE","CREATION_DATE_TIME"]}}},{"allOf":[{"type":"object","properties":{"isAmazonCuratedFilter":{"nullable":true,"description":"If true, the inventory group was created by Amazon.","type":"boolean"},"inventoryGroupIdFilter":{"minItems":0,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75}},"inventoryGroupNameFilter":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"inventoryTypeFilter":{"minItems":0,"maxItems":6,"uniqueItems":true,"type":"array","items":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]}}}}],"type":"object","properties":{"inventoryTypeFilter":{"minItems":0,"maxItems":6,"uniqueItems":true,"type":"array","items":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]}}}}],"type":"object"}}}},"description":"Gets a list of inventory groups based on the sorting and filtering criteria provided in the request.","operationId":"DspApiListInventoryGroupsV1","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"totalResults":{"description":"The total number of results across all pages.","type":"integer","minimum":0},"nextToken":{"description":"Used for pagination, a string that can be sent in the next request to get the next page of results.","type":"string"}}}],"type":"object","properties":{"inventoryGroups":{"minItems":0,"maxItems":100,"description":"The inventory groups returned.","type":"array","items":{"type":"object","properties":{"inventoryType":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]},"inventoryGroupName":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"inventoryGroupId":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75},"dealIds":{"minItems":0,"maxItems":100,"description":"The IDs of the deals included in the inventory group.","type":"array","items":{"type":"string"}},"isAmazonCurated":{"nullable":true,"description":"If true, the inventory group was created by Amazon.","type":"boolean"},"creationDateTime":{"format":"date-time","type":"string"}},"required":["inventoryGroupId","inventoryGroupName","dealIds","creationDateTime"]}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"415":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"429":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Service Failure.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a &quot;Login with Amazon&quot; account.","required":true},{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":false}],"tags":["Inventory Group"]}],"path":"/en-us/dsp-inventory-groups#tag/Inventory%20Group/operation/DspApiListInventoryGroupsV1","sectionHeader":{"type":3,"text":"POST /dsp/v1/inventory/inventoryGroups/list"},"summary":"Gets a list of inventory groups.","documentType":"api-reference"},{"title":"Inventory Groups","content":["/dsp/v1/inventory/inventoryGroups",{"summary":"Creates a new inventory group.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"inventoryType":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]},"inventoryGroupName":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"dealIds":{"minItems":0,"maxItems":100,"description":"The IDs of the deals included in the inventory group.","type":"array","items":{"type":"string"}}},"required":["inventoryGroupName","dealIds","inventoryType"]}],"type":"object"}}}},"description":"Creates a new inventory group with the configuration provided in the request body.","operationId":"DspApiCreateInventoryGroupV1","responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"inventoryGroupId":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"415":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"429":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Service Failure.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a &quot;Login with Amazon&quot; account.","required":true},{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":false}],"tags":["Inventory Group"]}],"path":"/en-us/dsp-inventory-groups#tag/Inventory%20Group/operation/DspApiCreateInventoryGroupV1","sectionHeader":{"type":3,"text":"POST /dsp/v1/inventory/inventoryGroups"},"summary":"Creates a new inventory group.","documentType":"api-reference"},{"title":"Inventory Groups","content":["/dsp/v1/inventory/inventoryGroups",{"summary":"Updates an inventory group.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"inventoryGroupName":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"inventoryGroupId":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75},"dealIds":{"minItems":0,"maxItems":100,"description":"The IDs of the deals included in the inventory group.","type":"array","items":{"type":"string"}}}}],"type":"object"}}}},"description":"Updates an inventory group by overwriting the existing metadata with the content in the request object.","operationId":"DspApiUpdateInventoryGroupV1","responses":{"204":{"description":"No content."},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"404":{"description":"Resource Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"415":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"429":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Service Failure.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a &quot;Login with Amazon&quot; account.","required":true},{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":false}],"tags":["Inventory Group"]}],"path":"/en-us/dsp-inventory-groups#tag/Inventory%20Group/operation/DspApiUpdateInventoryGroupV1","sectionHeader":{"type":3,"text":"PUT /dsp/v1/inventory/inventoryGroups"},"summary":"Updates an inventory group.","documentType":"api-reference"},{"title":"Inventory Groups","content":["/dsp/v1/inventory/eligibility/inventoryGroups/list",{"summary":"Gets the eligible inventory groups for the specified inventory type.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"maxResults":{"default":"50","description":"Sets the maximum number of results in the response. Used in conjunction with `nextToken` to control pagination.","maximum":100,"type":"integer","minimum":1},"nextToken":{"description":"To retrieve the next page of paginated results, specify this token in the request.","type":"string"}}},{"description":"Field by which to sort the results.","type":"object","properties":{"sortOrder":{"description":"The direction by which to sort the results.","type":"string","enum":["ASCENDING","DESCENDING"]},"sortField":{"description":"The field by which to sort the results. Defaults to `CREATION_DATE_TIME` if unspecified.","type":"string","enum":["INVENTORY_GROUP_ID","INVENTORY_GROUP_NAME","INVENTORY_TYPE","CREATION_DATE_TIME"]}}},{"allOf":[{"type":"object","properties":{"isAmazonCuratedFilter":{"nullable":true,"description":"If true, the inventory group was created by Amazon.","type":"boolean"},"inventoryGroupIdFilter":{"minItems":0,"maxItems":100,"uniqueItems":true,"type":"array","items":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75}},"inventoryGroupNameFilter":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"inventoryTypeFilter":{"minItems":0,"maxItems":6,"uniqueItems":true,"type":"array","items":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]}}}}],"type":"object","properties":{"inventoryTypeFilter":{"minItems":1,"maxItems":6,"uniqueItems":true,"type":"array","items":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]}}},"required":["inventoryTypeFilter"]}],"type":"object"}}}},"description":"Gets the eligible inventory groups for the specified inventory type.","operationId":"DspApiListEligibleInventoryGroupsV1","responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"totalResults":{"description":"The total number of results across all pages.","type":"integer","minimum":0},"nextToken":{"description":"Used for pagination, a string that can be sent in the next request to get the next page of results.","type":"string"}}}],"type":"object","properties":{"inventoryGroups":{"minItems":0,"maxItems":100,"description":"The inventory groups returned.","type":"array","items":{"type":"object","properties":{"inventoryType":{"description":"Inventory group inventory type.","type":"string","enum":["AUDIO","DISPLAY","VIDEO"]},"inventoryGroupName":{"minLength":1,"description":"The name of the inventory group.","type":"string","maxLength":250},"inventoryGroupId":{"minLength":1,"description":"Unique ID of the inventory group.","type":"string","maxLength":75},"dealIds":{"minItems":0,"maxItems":100,"description":"The IDs of the deals included in the inventory group.","type":"array","items":{"type":"string"}},"isAmazonCurated":{"nullable":true,"description":"If true, the inventory group was created by Amazon.","type":"boolean"},"creationDateTime":{"format":"date-time","type":"string"}},"required":["inventoryGroupId","inventoryGroupName","dealIds","creationDateTime"]}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"401":{"description":"Unauthenticated request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"415":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"429":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"500":{"description":"Internal Service Failure.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}},"503":{"description":"Service Unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string"},"errors":{"type":"object","properties":{"errors":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorId":{"type":"string"}}}}}}}}}}}},"parameters":[{"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","type":"string"},"in":"header","name":"Amazon-Ads-AccountId","description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The identifier of a client associated with a &quot;Login with Amazon&quot; account.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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 and choose profile id `profileId` from the response to pass it as input.","required":false}],"tags":["Inventory Group"]}],"path":"/en-us/dsp-inventory-groups#tag/Inventory%20Group/operation/DspApiListEligibleInventoryGroupsV1","sectionHeader":{"type":3,"text":"POST /dsp/v1/inventory/eligibility/inventoryGroups/list"},"summary":"Gets the eligible inventory groups for the specified inventory type.","documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["Use to create, read, or update audience metadata and to add or remove audience records. For onboarding information, see setting up for the Amazon Ads API.\n"],"path":"/en-us/data-provider/openapi","sectionHeader":{"type":2,"text":"Amazon Ads API for Data Providers."},"documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["/v2/dp/audiencemetadata/",{"tags":["Metadata"],"summary":"Creates a new data provider audience. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","parameters":[{"in":"header","name":"Authorization","description":"A valid access token.","schema":{"type":"string"},"example":"Bearer Atza|IQEBLjAsAhRmHjNgHpi0UDme37rR6CuUpSR","required":true},{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The `Content-Type` is application/json.","example":"application/json","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","description","advertiserId","metadata"],"properties":{"name":{"type":"string","description":"The audience name. Must be an alphanumeric string between 10 to 128 characters in length."},"description":{"type":"string","description":"The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length."},"advertiserId":{"type":"integer","format":"int64","description":"The advertiser identifier."},"metadata":{"type":"object","required":["type","externalAudienceId","dataSourceCountry"],"properties":{"type":{"type":"string","description":"The audience metadata type. Only 'DATA_PROVIDER' is currently supported.","enum":["DATA_PROVIDER"]},"externalAudienceId":{"type":"string","description":"The user-defined audience identifier."},"ttl":{"type":"integer","description":"Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.","minimum":0,"maximum":34300800},"audienceFees":{"type":"array","items":{"type":"object","required":["cpmCents","currency"],"description":"Object describing the audience fee.","properties":{"cpmCents":{"type":"integer","description":"Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents."},"currency":{"type":"string","description":"Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.","enum":["USD","CAD","JPY","GBP","EUR","AUD","AED","SAR","MXN","INR","SEK","TRY","BRL"]}}}},"dataSourceCountry":{"type":"array","description":"A list of country codes describing where data in an audience is collected from. Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":["US","CA"],"items":{"type":"string","description":"Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":"GB"}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"audience":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The"},"name":{"type":"string","description":"The audience name. Must be an alphanumeric string between 10 to 128 characters in length."},"description":{"type":"string","description":"The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length."},"advertiserId":{"type":"integer","format":"int64","description":"The advertiser identifier."},"metadata":{"type":"object","properties":{"type":{"type":"string","description":"The audience metadata type. Only 'DATA_PROVIDER' is currently supported.","enum":["DATA_PROVIDER"]},"externalAudienceId":{"type":"string","description":"The user-defined audience identifier."},"ttl":{"type":"integer","description":"Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.","minimum":0,"maximum":34300800},"audienceFees":{"type":"array","items":{"type":"object","required":["cpmCents","currency"],"description":"Object describing the audience fee.","properties":{"cpmCents":{"type":"integer","description":"Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents."},"currency":{"type":"string","description":"Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.","enum":["USD","CAD","JPY","GBP","EUR","AUD","AED","SAR","MXN","INR","SEK","TRY","BRL"]}}}},"dataSourceCountry":{"type":"array","description":"A list of country codes describing where data in an audience is collected from. Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":["US","CA"],"items":{"type":"string","description":"Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":"GB"}}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"403":{"description":"The client is not allowed to update the audience.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"404":{"description":"The specified identifier was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"429":{"description":"The client exceeded the allowed number of requests..","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"503":{"description":"The service is unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}}}}],"path":"/en-us/data-provider/openapi#tag/Metadata","sectionHeader":{"type":3,"text":"POST /v2/dp/audiencemetadata/"},"summary":"Creates a new data provider audience. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["/v2/dp/audiencemetadata/{audienceId}",{"tags":["Metadata"],"summary":"Updates metadata of an existing audience specified by identifier. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","parameters":[{"in":"header","name":"Authorization","description":"A valid access token.","schema":{"type":"string"},"example":"Bearer Atza|IQEBLjAsAhRmHjNgHpi0UDme37rR6CuUpSR","required":true},{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The `Content-Type` is application/json.","example":"application/json","required":true},{"name":"audienceId","in":"path","required":true,"description":"The audience identifier.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"A data provider audience object with updated values.","properties":{"description":{"type":"string","description":"The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length."},"metadata":{"type":"object","properties":{"ttl":{"type":"integer","description":"Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.","minimum":0,"maximum":34300800},"audienceFees":{"type":"array","items":{"type":"object","required":["cpmCents","currency"],"description":"Object describing the audience fee.","properties":{"cpmCents":{"type":"integer","description":"Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents."},"currency":{"type":"string","description":"Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.","enum":["USD","CAD","JPY","GBP","EUR","AUD","AED","SAR","MXN","INR","SEK","TRY","BRL"]}}}},"dataSourceCountry":{"type":"array","description":"A list of country codes describing where data in an audience is collected from. Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":["US","CA"],"items":{"type":"string","description":"Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":"GB"}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"audience":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The"},"name":{"type":"string","description":"The audience name. Must be an alphanumeric string between 10 to 128 characters in length."},"description":{"type":"string","description":"The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length."},"advertiserId":{"type":"integer","format":"int64","description":"The advertiser identifier."},"metadata":{"type":"object","properties":{"type":{"type":"string","description":"The audience metadata type. Only 'DATA_PROVIDER' is currently supported.","enum":["DATA_PROVIDER"]},"externalAudienceId":{"type":"string","description":"The user-defined audience identifier."},"ttl":{"type":"integer","description":"Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.","minimum":0,"maximum":34300800},"audienceFees":{"type":"array","items":{"type":"object","required":["cpmCents","currency"],"description":"Object describing the audience fee.","properties":{"cpmCents":{"type":"integer","description":"Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents."},"currency":{"type":"string","description":"Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.","enum":["USD","CAD","JPY","GBP","EUR","AUD","AED","SAR","MXN","INR","SEK","TRY","BRL"]}}}},"dataSourceCountry":{"type":"array","description":"A list of country codes describing where data in an audience is collected from. Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":["US","CA"],"items":{"type":"string","description":"Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":"GB"}}}}}}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"403":{"description":"The client is not allowed to update the audience.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"404":{"description":"The specified identifier was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"429":{"description":"The client exceeded the allowed number of requests..","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"503":{"description":"The service is unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}}}}],"path":"/en-us/data-provider/openapi#tag/Metadata","sectionHeader":{"type":3,"text":"PUT /v2/dp/audiencemetadata/{audienceId}"},"summary":"Updates metadata of an existing audience specified by identifier. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["/v2/dp/audiencemetadata/{audienceId}",{"tags":["Metadata"],"summary":"Gets metadata for an audience specified by identifier. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","parameters":[{"in":"header","name":"Authorization","description":"A valid access token.","schema":{"type":"string"},"example":"Bearer Atza|IQEBLjAsAhRmHjNgHpi0UDme37rR6CuUpSR","required":true},{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The `Content-Type` is application/json.","example":"application/json","required":true},{"name":"audienceId","in":"path","required":true,"description":"The audience identifier.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"audience":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The"},"name":{"type":"string","description":"The audience name. Must be an alphanumeric string between 10 to 128 characters in length."},"description":{"type":"string","description":"The audience description. Must be an alphanumeric, non-null string between 0 to 1000 characters in length."},"advertiserId":{"type":"integer","format":"int64","description":"The advertiser identifier."},"metadata":{"type":"object","properties":{"type":{"type":"string","description":"The audience metadata type. Only 'DATA_PROVIDER' is currently supported.","enum":["DATA_PROVIDER"]},"externalAudienceId":{"type":"string","description":"The user-defined audience identifier."},"ttl":{"type":"integer","description":"Time-to-live (ttl), in seconds. The amount of time the record is associated with the audience.","minimum":0,"maximum":34300800},"audienceFees":{"type":"array","items":{"type":"object","required":["cpmCents","currency"],"description":"Object describing the audience fee.","properties":{"cpmCents":{"type":"integer","description":"Cost per thousand impressions (CPM) in cents. For example, $1.00 = 100 cents."},"currency":{"type":"string","description":"Currency key as defined in https://en.wikipedia.org/wiki/ISO_4217. Note that the currency key is required to match the default currency associated with the Amazon DSP account.","enum":["USD","CAD","JPY","GBP","EUR","AUD","AED","SAR","MXN","INR","SEK","TRY","BRL"]}}}},"audienceSize":{"type":"object","description":"Information about the size of the audience.","properties":{"receivedRecordSize":{"type":"integer","description":"The number of received records."},"matchedRecordSize":{"type":"integer","description":"The number of matched records."},"matchRate":{"type":"number","format":"float","description":"The match rate.","minimum":0,"maximum":1}}},"dataSourceCountry":{"type":"array","description":"A list of country codes describing where data in an audience is collected from. Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":["US","CA"],"items":{"type":"string","description":"Country code is defined in https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.","example":"GB"}}}}}}}}}}},"403":{"description":"The client is not allowed to update the audience.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"404":{"description":"The specified identifier was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"429":{"description":"The client exceeded the allowed number of requests..","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"503":{"description":"The service is unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}}}}],"path":"/en-us/data-provider/openapi#tag/Metadata","sectionHeader":{"type":3,"text":"GET /v2/dp/audiencemetadata/{audienceId}"},"summary":"Gets metadata for an audience specified by identifier. Note that the API call rate is limited to 1 transaction per second (TPS). Calls exceeding this rate are throttled.","documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["/v2/dp/audience",{"summary":"Associates or disassociates a record with an audience. Note that the API call rate is limited to 100 transactions per second (TPS). Calls exceeding this rate are throttled. Payload size is limited to a maximum of 6MB or 2000 records. Calls with a payload exceeding limit receive a 413 response.","tags":["Add or remove records"],"parameters":[{"in":"header","name":"Authorization","description":"A valid access token.","schema":{"type":"string"},"example":"Bearer Atza|IQEBLjAsAhRmHjNgHpi0UDme37rR6CuUpSR","required":true},{"name":"Amazon-Advertising-API-ClientId","in":"header","description":"The identifier of a client associated with a \"Login with Amazon\" account.","required":true,"schema":{"type":"string"}},{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The `Content-Type` is application/json.","example":"application/json","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"patches":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","description":"Specifies the type of operation. Valid operations are `add` or `remove`.","enum":["add","remove"]},"path":{"type":"string","format":"/<recordIdType>-<recordIdValue>/audiences","example":"/COOKIE-EMpBAI0GRcK4nBNGpPGg5g/audiences","description":"A formatted string that specifies the URL of the record. The format of the string is `/<recordIdType>-<recordIdValue>/audiences`, where 'recordIdType' specifies the record's origin and 'recordIdValue' specifies the record's Id. Valid 'recordIdType' values are `COOKIE`, a cookie Id sent from a data provider to Amazon by a cookie sync; `MAID`, a mobile advertising identifier; `EXTERNAL_USER_ID`, an external id defined by data providers."},"value":{"type":"array","items":{"type":"integer","format":"int64","description":"An integer value representing the Amazon audience identifer. This is the identifier that is returned during audience creation.","example":72057594038053890}},"consent":{"type":"object","description":"An object that contains user consent. Only one type of consent(TCF, GPP, amazonConsent) should be provided.","discriminator":{"propertyName":"consentType","mapping":{"TCF":"#/components/schemas/tcf","GPP":"#/components/schemas/gpp","Amazon":"#/components/schemas/amazonConsent"}},"properties":{"consentType":{"type":"string","description":"The type of consent provided.","enum":["TCF","GPP","Amazon"]},"tcf":{"type":"string","description":"TCF(Transparency & Consent Framework) consent string that wraps privacy consent information from user.","example":"CQB4ySFQB4ySFBlAAAENCZCAAAAAAAAAAAAAAAAAAAAA.II7Nd_X__bX9n-_7_6ft0eY1f9_r37uQzDhfNs-8F3L_W_LwX32E7NF36tq4KmR4ku1bBIQNtHMnUDUmxaolVrzHsak2cpyNKJ_JkknsZe2dYGF9Pn9lD-YKZ7_5_9_f52T_9_9_-39z3_9f___dv_-__-vjf_599n_v9fV_78_Kf9______-____________8A"},"gpp":{"type":"string","description":"GPP(Global Privacy Platform) consent string that wraps privacy consent information from user.","example":"DBADMZg~CQB2TAAQB2TAAPoABABGA9EAAAAAAAAAAAAAAAAAAAAA.QAAA.IAAA~BQB2TAAQB2TAAPoABABGBZCAAAAAAAgAAAAAAAAAAA.YAAAAAAAAAA~BAAAAAAAAQA.QA"},"amazonConsent":{"type":"object","properties":{"amazonAdStorage":{"type":"string","description":"Set consent for advertising related storage such as cookies(web) or device identifiers(apps).","enum":["GRANTED","DENIED"]},"amazonUserData":{"type":"string","description":"Set consent to use personal data for online advertising purposes.","enum":["GRANTED","DENIED"]}},"required":["amazonAdStorage","amazonUserData"],"example":{"amazonAdStorage":"GRANTED","amazonUserData":"GRANTED"}}}}}}}}}}}},"responses":{"200":{"description":"The request to add or remove an audience was submitted. Note that requests can take up to two hours to be processed.","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","description":"A unique identifier representing the workflow of the submitted request.","example":"f076ddd9-3f84-44e8-b5cf-742b08f2bc9f"},"requestId":{"type":"string","description":"A unique identifier representing the request.","example":"F88750355N-B70JY53CSD"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"413":{"description":"Input Too Large.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":413},"description":{"description":"Description of the error.","type":"string","example":"Input Too Large"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"INPUT_TOO_LARGE"},"message":{"description":"Error message","type":"string","example":"The input payload exceeds 1MB limit."}}}}}}}}}}},"429":{"description":"The client exceeded the allowed number of requests..","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}},"503":{"description":"The service is unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"The request identifier.","type":"string","example":"a1b1234c-d11d-4e5f-82gh-c609c22255bd"},"error":{"type":"object","properties":{"httpStatusCode":{"description":"The HTTP status code.","type":"string","example":400},"description":{"description":"A human-readable description of the error.","type":"string","example":"Bad Request"},"errors":{"type":"array","items":{"type":"object","properties":{"errorType":{"description":"The type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"A human-readable description of the error.","type":"string","example":"The input field 'name' cannot be updated"},"fieldName":{"description":"The field name.","type":"string","example":"name"}}}}}}}}}}}}}],"path":"/en-us/data-provider/openapi#tag/Add%20or%20remove%20records","sectionHeader":{"type":3,"text":"PATCH /v2/dp/audience"},"summary":"Associates or disassociates a record with an audience. Note that the API call rate is limited to 100 transactions per second (TPS). Calls exceeding this rate are throttled. Payload size is limited to a maximum of 6MB or 2000 records. Calls with a payload exceeding limit receive a 413 response.","documentType":"api-reference"},{"title":"Amazon Ads API for Data Providers.","content":["/v2/dp/users",{"description":"Deletes user data sourced from data providers. Deletes users scoped either to an advertiser or for the data provider. The SLA for data deletion is 30 days.","summary":"Deletes user data originally sourced from the client. The API call rate is limited to 1 transactions per second (TPS). Calls exceeding this rate are throttled. Payload size is limited to 1000 users or 1MB. Calls with a more than 1000 users or 1MB will receive a 413 response.","tags":["User deletion"],"parameters":[{"in":"header","name":"Authorization","schema":{"type":"string"},"description":"A valid access token. ","example":"Bearer Atza|IQEBLjAsAhRmHjNgHpi0UDme37rR6CuUpSR","required":true},{"in":"header","name":"Amazon-Advertising-API-ClientID","schema":{"type":"string"},"description":"The client identifier.","example":"amzn1.application-oa2-client.8baa9caa3eac48eab89780e73ce03b19","required":true},{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The Content-Type is `application/json`.","example":"application/json","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"object","properties":{"type":{"type":"string","description":"Specifies the type of the user identifier.","enum":["COOKIE","MAID","EXTERNAL_USER_ID"]},"value":{"type":"string","description":"The user identifer."}}},"advertiserId":{"type":"string","description":"The advertiser identifier. If present, the user data for the specified advertiser is deleted. Otherwise, all data about this user sourced from this client is deleted.","example":205759403805},"consentTime":{"type":"integer","format":"int64","description":"User consent time in epoch milliseconds","example":1581557890000}}}},"operation":{"type":"string","enum":["DELETE"]}}},"example":{"users":[{"userId":{"type":"COOKIE","value":"EMpBAI0GRcK4nBNGpPGg5g"},"advertiserId":205759403805,"consentTime":1581557890000},{"userId":{"type":"COOKIE","value":"EMpBAI0GRcK4nBNGpPGg5g"},"advertiserId":305759403805,"consentTime":1581557900000}],"operation":"DELETE"}}}},"responses":{"202":{"description":"The request to delete user data was submitted.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","description":"A unique identifier representing the request.","example":"F88750355N-B70JY53CSD"}}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":400},"description":{"description":"Description of the error.","type":"string","example":"Bad Request"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"INVALID_INPUT"},"message":{"description":"Error message","type":"string","example":"The inputs that you provided are not valid."}}}}}}}}}}},"413":{"description":"Input Too Large.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":413},"description":{"description":"Description of the error.","type":"string","example":"Input Too Large"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"INPUT_TOO_LARGE"},"message":{"description":"Error message","type":"string","example":"The input payload exceeds 1MB limit."}}}}}}}}}}},"429":{"description":"Too Many Requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":429},"description":{"description":"Description of the error.","type":"string","example":"Too Many Requests"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"TOO_MANY_REQUESTS"},"message":{"description":"Error message","type":"string","example":"The number of requests exceeded 100 TPS."}}}}}}}}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":500},"description":{"description":"Description of the error.","type":"string","example":"Internal Error"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"INTERNAL_ERROR"},"message":{"description":"Error message","type":"string","example":"Internal error."}}}}}}}}}}},"503":{"description":"Server Unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"description":"Identifier associated with the request.","type":"string","example":"F88750355N-B70JY53CSD"},"error":{"description":"Detailed error messages associated with the request.","type":"object","properties":{"httpStatusCode":{"description":"HTTP status code associated with the response.","type":"string","example":503},"description":{"description":"Description of the error.","type":"string","example":"Service unavailable"},"errors":{"description":"An array of property objects that include more information about the request.","type":"array","items":{"type":"object","properties":{"errorType":{"description":"Type of error.","type":"string","example":"SERVICE_UNAVAILABLE"},"message":{"description":"Error message","type":"string","example":"Service unavailable."}}}}}}}}}}}}}],"path":"/en-us/data-provider/openapi#tag/User%20deletion","sectionHeader":{"type":3,"text":"PATCH /v2/dp/users"},"summary":"Deletes user data originally sourced from the client. The API call rate is limited to 1 transactions per second (TPS). Calls exceeding this rate are throttled. Payload size is limited to 1000 users or 1MB. Calls with a more than 1000 users or 1MB will receive a 413 response.","documentType":"api-reference"},{"title":"DSP Reports","content":["Fetch reports with performance metrics for DSP campaigns.\n"],"path":"/en-us/dsp/2-2/previous/openapi","sectionHeader":{"type":2,"text":"DSP Reports"},"documentType":"api-reference"},{"title":"DSP Reports","content":["/dsp/reports",{"summary":"Creates a report request.","requestBody":{"description":"Create report request body. Version of request can be specified in the accept. By default takes latest version","content":{"application/vnd.dspcreatereports.v2_2+json":{"schema":{"type":"object","required":["startDate","endDate"],"properties":{"advertiserIds":{"description":"List of advertisers specified by identifier to include in the report. If this field is not specified, the report includes data for all advertisers included in the scope specified in the `Amazon-Advertising-API-Scope` header. Note that if an advertiser identifier is specified that is not available under the scope provided in the header, the response is `422 - Unprocessable Entity`.","type":"array","items":{"maximum":100,"type":"string","minimum":0}},"endDate":{"description":"Date in YYYYMMDD format. The report contains only metrics generated on the specified date range between startDate and endDate. The maximum date range between startDate and endDate is 31 days. The endDate can be up to 90 days older from today.","type":"string"},"format":{"default":"JSON","description":"The report file format.","type":"string","enum":["JSON","CSV"]},"orderIds":{"description":"List of orders specified by identifier to include in the report. If this field is not specified, the report includes data for all orders included in the scope specified in the `Amazon-Advertising-API-Scope` header. Note that if an order identifier is specified that is not available under the scope provided in the header, the response is `422 - Unprocessable Entity`.","type":"array","items":{"maximum":100,"type":"string","minimum":0}},"metrics":{"description":"Specify a comma-delimited string of metrics field names to include in the report. For example: \"impressions, clickThroughs, CTR, eCPC, totalCost, eCPM\". If no metric field names are specified, only the default fields and selected `DIMENSION` fields are included by default. Specifying default fields returns an error.<details><summary>`Common Fields`</summary><summary>These fields will be added when reportType is `CAMPAIGN, INVENTORY, or AUDIENCE`.&nbsp;</summary></br>totalCost</br>supplyCost</br>amazonAudienceFee</br>amazonOmnichannelMetricsFee</br>advertiserTimezone</br>advertiserCountry</br>amazonPlatformFee</br>impressions</br>clickThroughs</br>CTR</br>eCPM</br>eCPC</br>dpv14d</br>dpvViews14d</br>dpvClicks14d</br>dpvr14d</br>eCPDPV14d</br>pRPV14d</br>pRPVViews14d</br>pRPVClicks14d</br>pRPVr14d</br>eCPPRPV14d</br>atl14d</br>atlViews14d</br>atlClicks14d</br>atlr14d</br>eCPAtl14d</br>atc14d</br>atcViews14d</br>atcClicks14d</br>atcr14d</br>eCPAtc14d</br>purchases14d</br>purchasesViews14d</br>purchasesClicks14d</br>purchaseRate14d</br>eCPP14d</br>newToBrandPurchases14d</br>newToBrandPurchasesViews14d</br>newToBrandPurchasesClicks14d</br>newToBrandPurchaseRate14d</br>newToBrandECPP14d</br>percentOfPurchasesNewToBrand14d</br>addToWatchlist14d</br>addToWatchlistViews14d</br>addToWatchlistClicks14d</br>addToWatchlistCVR14d</br>addToWatchlistCPA14d</br>downloadedVideoPlays14d</br>downloadedVideoPlaysViews14d</br>downloadedVideoPlaysClicks14d</br>downloadedVideoPlayRate14d</br>eCPDVP14d</br>videoStreams14d</br>videoStreamsViews14d</br>videoStreamsClicks14d</br>videoStreamsRate14d</br>eCPVS14d</br>playTrailers14d</br>playTrailersViews14d</br>playerTrailersClicks14d</br>playTrailerRate14d</br>eCPPT14d</br>rentals14d</br>rentalsViews14d</br>rentalsClicks14d</br>rentalRate14d</br>ecpr14d</br>videoDownloads14d</br>videoDownloadsViews14d</br>videoDownloadsClicks14d</br>videoDownloadRate14d</br>ecpvd14d</br>newSubscribeAndSave14d</br>newSubscribeAndSaveViews14d</br>newSubscribeAndSaveClicks14d</br>newSubscribeAndSaveRate14d</br>eCPnewSubscribeAndSave14d</br>totalPixel14d</br>totalPixelViews14d</br>totalPixelClicks14d</br>totalPixelCVR14d</br>totalPixelCPA14d</br>marketingLandingPage14d</br>marketingLandingPageViews14d</br>marketingLandingPageClicks14d</br>marketingLandingPageCVR14d</br>marketingLandingPageCPA14d</br>subscriptionPage14d</br>subscriptionPageViews14d</br>subscriptionPageClicks14d</br>subscriptionPageCVR14d</br>subscriptionPageCPA14d</br>signUpPage14d</br>signUpPageViews14d</br>signUpPageClicks14d</br>signUpPageCVR14d</br>signUpPageCPA14d</br>application14d</br>applicationViews14d</br>applicationClicks14d</br>applicationCVR14d</br>applicationCPA14d</br>gameLoad14d</br>gameLoadViews14d</br>gameLoadClicks14d</br>gameLoadCVR14d</br>gameLoadCPA14d</br>widgetLoad14d</br>widgetLoadViews14d</br>widgetLoadClicks14d</br>widgetLoadCVR14d</br>widgetLoadCPA14d</br>surveyStart14d</br>surveyStartViews14d</br>surveyStartClicks14d</br>surveyStartCVR14d</br>surveyStartCPA14d</br>surveyFinish14d</br>surveyFinishViews14d</br>surveyFinishClicks14d</br>surveyFinishCVR14d</br>surveyFinishCPA14d</br>bannerInteraction14d</br>bannerInteractionViews14d</br>bannerInteractionClicks14d</br>bannerInteractionCVR14d</br>bannerInteractionCPA14d</br>widgetInteraction14d</br>widgetInteractionViews14d</br>widgetInteractionClicks14d</br>widgetInteractionCVR14d</br>widgetInteractionCPA14d</br>gameInteraction14d</br>gameInteractionViews14d</br>gameInteractionClicks14d</br>gameInteractionCVR14d</br>gameInteractionCPA14d</br>emailLoad14d</br>emailLoadViews14d</br>emailLoadClicks14d</br>emailLoadCVR14d</br>emailLoadCPA14d</br>emailInteraction14d</br>emailInteractionViews14d</br>emailInteractionClicks14d</br>emailInteractionCVR14d</br>emailInteractionCPA14d</br>submitButton14d</br>submitButtonViews14d</br>submitButtonClicks14d</br>submitButtonCVR14d</br>submitButtonCPA14d</br>purchaseButton14d</br>purchaseButtonViews14d</br>purchaseButtonClicks14d</br>purchaseButtonCVR14d</br>purchaseButtonCPA14d</br>clickOnRedirect14d</br>clickOnRedirectViews14d</br>clickOnRedirectClicks14d</br>clickOnRedirectCVR14d</br>clickOnRedirectCPA14d</br>signUpButton14d</br>signUpButtonViews14d</br>signUpButtonClicks14d</br>signUpButtonCVR14d</br>signUpButtonCPA14d</br>subscriptionButton14d</br>subscriptionButtonViews14d</br>subscriptionButtonClicks14d</br>subscriptionButtonCVR14d</br>subscriptionButtonCPA14d</br>successPage14d</br>successPageViews14d</br>successPageClicks14d</br>successPageCVR14d</br>successPageCPA14d</br>thankYouPage14d</br>thankYouPageViews14d</br>thankYouPageClicks14d</br>thankYouPageCVR14d</br>thankYouPageCPA14d</br>registrationForm14d</br>registrationFormViews14d</br>registrationFormClicks14d</br>registrationFormCVR14d</br>registrationFormCPA14d</br>registrationConfirmPage14d</br>registrationConfirmPageViews14d</br>registrationConfirmPageClicks14d</br>registrationConfirmPageCVR14d</br>registrationConfirmPageCPA14d</br>storeLocatorPage14d</br>storeLocatorPageViews14d</br>storeLocatorPageClicks14d</br>storeLocatorPageCVR14d</br>storeLocatorPageCPA14d</br>mobileAppFirstStarts14d</br>mobileAppFirstStartViews14d</br>mobileAppFirstStartClicks14d</br>mobileAppFirstStartCVR14d</br>mobileAppFirstStartsCPA14d</br>brandStoreEngagement1</br>brandStoreEngagement1Views</br>brandStoreEngagement1Clicks</br>brandStoreEngagement1CVR</br>brandStoreEngagement1CPA</br>brandStoreEngagement2</br>brandStoreEngagement2Views</br>brandStoreEngagement2Clicks</br>brandStoreEngagement2CVR</br>brandStoreEngagement2CPA</br>brandStoreEngagement3</br>brandStoreEngagement3Views</br>brandStoreEngagement3Clicks</br>brandStoreEngagement3CVR</br>brandStoreEngagement3CPA</br>brandStoreEngagement4</br>brandStoreEngagement4Views</br>brandStoreEngagement4Clicks</br>brandStoreEngagement4CVR</br>brandStoreEngagement4CPA</br>brandStoreEngagement5</br>brandStoreEngagement5Views</br>brandStoreEngagement5Clicks</br>brandStoreEngagement5CVR</br>brandStoreEngagement5CPA</br>brandStoreEngagement6</br>brandStoreEngagement6Views</br>brandStoreEngagement6Clicks</br>brandStoreEngagement6CVR</br>brandStoreEngagement6CPA</br>brandStoreEngagement7</br>brandStoreEngagement7Views</br>brandStoreEngagement7Clicks</br>brandStoreEngagement7CVR</br>brandStoreEngagement7CPA</br>addedToShoppingCart14d</br>addedToShoppingCartViews14d</br>addedToShoppingCartClicks14d</br>addedToShoppingCartCVR14d</br>addedToShoppingCartCPA14d</br>productPurchased</br>productPurchasedViews</br>productPurchasedClicks</br>productPurchasedCVR</br>productPurchasedCPA</br>homepageVisit14d</br>homepageVisitViews14d</br>homepageVisitClicks14d</br>homepageVisitCVR14d</br>homepageVisitCPA14d</br>videoStarted</br>videoStartedViews</br>videoStartedClicks</br>videoStartedCVR</br>videoStartedCPA</br>videoCompleted</br>videoCompletedViews</br>videoEndClicks</br>videoCompletedCVR</br>videoCompletedCPA</br>messageSent14d</br>messageSentViews14d</br>messageSentClicks14d</br>messageSentCVR14d</br>messageSentCPA14d</br>mashupClickToPage</br>mashupClickToPageViews</br>mashupClickToPageClicks</br>mashupClickToPageCVR</br>mashupClickToPageCPA</br>mashupBackupImage</br>mashupBackupImageViews</br>mashupBackupImageClicks</br>mashupBackupImageCVR</br>mashupBackupImageCPA</br>mashupAddToCart14d</br>mashupAddToCartViews14d</br>mashupAddToCartClicks14d</br>mashupAddToCartClickCVR14d</br>mashupAddToCartCPA14d</br>mashupAddToWishlist14d</br>mashupAddToWishlistViews14d</br>mashupAddToWishlistClicks14d</br>mashupAddToWishlistCVR14d</br>mashupAddToWishlistCPA14d</br>mashupSubscribeAndSave14d</br>mashupSubscribeAndSaveClickViews14d</br>mashupSubscribeAndSaveClick14d</br>mashupSubscribeAndSaveCVR14d</br>mashupSubscribeAndSaveCPA14d</br>mashupClipCouponClick14d</br>mashupClipCouponClickViews14d</br>mashupClipCouponClickClicks14d</br>mashupClipCouponClickCVR14d</br>mashupClipCouponClickCPA14d</br>mashupShopNowClick14d</br>mashupShopNowClickViews14d</br>mashupShopNowClickClicks14d</br>mashupShopNowClickCVR14d</br>mashupShopNowClickCPA14d</br>referral14d</br>referralViews14d</br>referralClicks14d</br>referralCVR14d</br>referralCPA14d</br>accept14d</br>acceptViews14d</br>acceptClicks14d</br>acceptCVR14d</br>acceptCPA14d</br>decline14d</br>declineViews14d</br>declineClicks14d</br>declineCVR14d</br>declineCPA14d</br>videoStart</br>videoFirstQuartile</br>videoMidpoint</br>videoThirdQuartile</br>videoComplete</br>videoCompletionRate</br>ecpvc</br>videoPause</br>videoResume</br>videoMute</br>videoUnmute</br>dropDownSelection14d</br>dropDownSelectionViews14d</br>dropDownSelectionClicks14d</br>dropDownSelectionCVR14d</br>dropDownSelectionCPA14d</br>brandSearch14d</br>brandSearchViews14d</br>brandSearchClicks14d</br>brandSearchRate14d</br>brandSearchCPA14d</br></details></br><details><summary>`Campaign Fields`</summary><summary>These fields will be added when reportType is Campaign. &nbsp;</summary></br>agencyFee</br>totalFee</br>3pFeeAutomotive</br>3pFeeAutomotiveAbsorbed</br>3pFeeComScore</br>3pFeeComScoreAbsorbed</br>3pFeeCPM1</br>3pFeeCPM1Absorbed</br>3pFeeCPM2</br>3pFeeCPM2Absorbed</br>3pFeeCPM3</br>3pFeeCPM3Absorbed</br>3pFeeDoubleclickCampaignManager</br>3pFeeDoubleclickCampaignManagerAbsorbed</br>3pFeeDoubleVerify</br>3pFeeDoubleVerifyAbsorbed</br>3pFeeIntegralAdScience</br>3pFeeIntegralAdScienceAbsorbed</br>3PFees</br>unitsSold14d</br>sales14d</br>ROAS14d</br>eRPM14d</br>newToBrandUnitsSold14d</br>newToBrandProductSales14d</br>newToBrandROAS14d</br>newToBrandERPM14d</br>totalPRPV14d</br>totalPRPVViews14d</br>totalPRPVClicks14d</br>totalPRPVr14d</br>totalECPPRPV14d</br>totalPurchases14d</br>totalPurchasesViews14d</br>totalPurchasesClicks14d</br>totalPurchaseRate14d</br>totalECPP14d</br>totalNewToBrandPurchases14d</br>totalNewToBrandPurchasesViews14d</br>totalNewToBrandPurchasesClicks14d</br>totalNewToBrandPurchaseRate14d</br>totalNewToBrandECPP14d</br>totalPercentOfPurchasesNewToBrand14d</br>totalUnitsSold14d</br>totalSales14d</br>totalROAS14d</br>totalERPM14d</br>totalNewToBrandUnitsSold14d</br>totalNewToBrandProductSales14d</br>totalNewToBrandROAS14d</br>totalNewToBrandERPM14d</br>viewableImpressions</br>measurableImpressions</br>measurableRate</br>viewabilityRate</br>totalDetailPageViews14d</br>totalDetailPageViewViews14d</br>totalDetailPageClicks14d</br>totalDetailPageViewsCVR14d</br>totalDetaiPageViewCPA14d</br>totalAddToList14d</br>totalAddToListViews14d</br>totalAddToListClicks14d</br>totalAddToListCVR14d</br>totalAddToListCPA14d</br>totalAddToCart14d</br>totalAddToCartViews14d</br>totalAddToCartClicks14d</br>totalAddToCartCVR14d</br>totalAddToCartCPA14d</br>totalSubscribeAndSaveSubscriptions14d</br>totalSubscribeAndSaveSubscriptionViews14d</br>totalSubscribeAndSaveSubscriptionClicks14d</br>totalSubscribeAndSaveSubscriptionCVR14d</br>totalSubscribeAndSaveSubscriptionCPA14d</br></details></br><details><summary>`Inventory Fields`</summary><summary>These fields will be added when reportType is Inventory &nbsp;</summary></br>agencyFee</br>totalFee</br>3pFeeAutomotive</br>3pFeeAutomotiveAbsorbed</br>3pFeeComScore</br>3pFeeComScoreAbsorbed</br>3pFeeCPM1</br>3pFeeCPM1Absorbed</br>3pFeeCPM2</br>3pFeeCPM2Absorbed</br>3pFeeCPM3</br>3pFeeCPM3Absorbed</br>3pFeeDoubleclickCampaignManager</br>3pFeeDoubleclickCampaignManagerAbsorbed</br>3pFeeDoubleVerify</br>3pFeeDoubleVerifyAbsorbed</br>3pFeeIntegralAdScience</br>3pFeeIntegralAdScienceAbsorbed</br>3PFees</br>unitsSold14d</br>sales14d</br>ROAS14d</br>eRPM14d</br>newToBrandUnitsSold14d</br>newToBrandProductSales14d</br>newToBrandROAS14d</br>newToBrandERPM14d</br>totalPRPV14d</br>totalPRPVViews14d</br>totalPRPVClicks14d</br>totalPRPVr14d</br>totalECPPRPV14d</br>totalPurchases14d</br>totalPurchasesViews14d</br>totalPurchasesClicks14d</br>totalPurchaseRate14d</br>totalECPP14d</br>totalNewToBrandPurchases14d</br>totalNewToBrandPurchasesViews14d</br>totalNewToBrandPurchasesClicks14d</br>totalNewToBrandPurchaseRate14d</br>totalNewToBrandECPP14d</br>totalPercentOfPurchasesNewToBrand14d</br>totalUnitsSold14d</br>totalSales14d</br>totalROAS14d</br>totalERPM14d</br>totalNewToBrandUnitsSold14d</br>totalNewToBrandProductSales14d</br>totalNewToBrandROAS14d</br>totalNewToBrandERPM14d</br>viewableImpressions</br>measurableImpressions</br>measurableRate</br>viewabilityRate</br>totalDetailPageViews14d</br>totalDetailPageViewViews14d</br>totalDetailPageClicks14d</br>totalDetailPageViewsCVR14d</br>totalDetaiPageViewCPA14d</br>totalAddToList14d</br>totalAddToListViews14d</br>totalAddToListClicks14d</br>totalAddToListCVR14d</br>totalAddToListCPA14d</br>totalAddToCart14d</br>totalAddToCartViews14d</br>totalAddToCartClicks14d</br>totalAddToCartCVR14d</br>totalAddToCartCPA14d</br>totalSubscribeAndSaveSubscriptions14d</br>totalSubscribeAndSaveSubscriptionViews14d</br>totalSubscribeAndSaveSubscriptionClicks14d</br>totalSubscribeAndSaveSubscriptionCVR14d</br>totalSubscribeAndSaveSubscriptionCPA14d</br>placementName</br>placementSize</br>dealType</br></details></br><details><summary>`Audience Fields`</summary><summary>These fields will be added when reportType is Audience. &nbsp;</summary></br>lineitemtype</br>segmentClassCode</br>segmentSource</br>segmentType</br>segmentMarketplaceID</br>targetingMethod</details></br><details><summary>`Product Fields`</summary><summary>These fields can be specified when reportType is `PRODUCTS`. &nbsp;</summary></br>reportGranularity(Default)</br>amazonStandardId(Default)</br>parentASIN(Default)</br>marketplace(Default)</br>brandName(Default)</br>asinConversionType(Default)</br>featuredASIN(Default)</br>productName</br>productGroup</br>productCategory</br>productSubcategory</br>dpv14d</br>dpvViews14d</br>dpvClicks14d</br>pRPV14d</br>pRPVViews14d</br>pRPVClicks14d</br>atl14d</br>atlViews14d</br>atlClicks14d</br>atc14d</br>atcViews14d</br>atcClicks14d</br>purchases14d</br>purchasesViews14d</br>purchasesClicks14d</br>newToBrandPurchases14d</br>newToBrandPurchasesViews14d</br>newToBrandPurchasesClicks14d</br>percentOfPurchasesNewToBrand14d</br>totalDetailPageViews14d</br>totalDetailPageViewViews14d</br>totalDetailPageClicks14d</br>totalPRPV14d</br>totalPRPVViews14d</br>totalPRPVClicks14d</br>totalAddToList14d</br>totalAddToListViews14d</br>totalAddToListClicks14d</br>totalAddToCart14d</br>totalAddToCartViews14d</br>totalAddToCartClicks14d</br>totalPurchases14d</br>totalPurchasesViews14d</br>totalPurchasesClicks14d</br>totalNewToBrandPurchases14d</br>totalNewToBrandPurchasesViews14d</br>totalNewToBrandPurchasesClicks14d</br>totalPercentOfPurchasesNewToBrand14d</br>newSubscribeAndSave14d</br>newSubscribeAndSaveViews14d</br>newSubscribeAndSaveClicks14d</br>totalSubscribeAndSaveSubscriptions14d</br>totalSubscribeAndSaveSubscriptionViews14d</br>totalSubscribeAndSaveSubscriptionClicks14d</br>unitsSold14d</br>sales14d</br>totalUnitsSold14d</br>totalSales14d</br>newToBrandUnitsSold14d</br>newToBrandProductSales14d</br>brandHaloDetailPage14d</br>brandHaloDetailPageViews14d</br>brandHaloDetailPageClicks14d</br>brandHaloProductReviewPage14d</br>brandHaloProductReviewPageViews14d</br>brandHaloProductReviewPageClicks14d</br>brandHaloAddToList14d</br>brandHaloAddToListViews14d</br>brandHaloAddToListClicks14d</br>brandHaloAddToCart14d</br>brandHaloAddToCartViews14d</br>brandHaloAddToCartClicks14d</br>brandHaloPurchases14d</br>brandHaloPurchasesViews14d</br>brandHaloPurchasesClicks14d</br>brandHaloNewToBrandPurchases14d</br>brandHaloNewToBrandPurchasesViews14d</br>brandHaloNewToBrandPurchasesClicks14d</br>brandHaloPercentOfPurchasesNewToBrand14d</br>brandHaloNewSubscribeAndSave14d</br>brandHaloNewSubscribeAndSaveViews14d</br>brandHaloNewSubscribeAndSaveClicks14d</br>brandHaloTotalUnitsSold14d</br>brandHaloTotalSales14d</br>brandHaloTotalNewToBrandSales14d</br>brandHaloTotalNewToBrandUnitsSold14d</details></br><details><summary>`Tech and Geo Fields`</summary><summary>These fields can be specified when reportType is `TECHNOLOGY` or `Geography`. &nbsp;</summary></br>agencyFee</br>totalCost</br>impressions</br>viewableImpressions</br>clickThroughs</br>totalPixel14d</br>totalPixelViews14d</br>totalPixelClicks14d</br>marketingLandingPage14d</br>marketingLandingPageViews14d</br>marketingLandingPageClicks14d</br>subscriptionPage14d</br>subscriptionPageViews14d</br>subscriptionPageClicks14d</br>signUpPage14d</br>signUpPageViews14d</br>signUpPageClicks14d</br>application14d</br>applicationViews14d</br>applicationClicks14d</br>gameLoad14d</br>gameLoadViews14d</br>gameLoadClicks14d</br>widgetLoad14d</br>widgetLoadViews14d</br>widgetLoadClicks14d</br>surveyStart14d</br>surveyStartViews14d</br>surveyStartClicks14d</br>surveyFinish14d</br>surveyFinishViews14d</br>surveyFinishClicks14d</br>bannerInteraction14d</br>bannerInteractionViews14d</br>bannerInteractionClicks14d</br>widgetInteraction14d</br>widgetInteractionViews14d</br>widgetInteractionClicks14d</br>gameInteraction14d</br>gameInteractionViews14d</br>gameInteractionClicks14d</br>emailLoad14d</br>emailLoadViews14d</br>emailLoadClicks14d</br>emailInteraction14d</br>emailInteractionViews14d</br>emailInteractionClicks14d</br>submitButton14d</br>submitButtonViews14d</br>submitButtonClicks14d</br>purchaseButton14d</br>purchaseButtonViews14d</br>purchaseButtonClicks14d</br>clickOnRedirect14d</br>clickOnRedirectViews14d</br>clickOnRedirectClicks14d</br>dropDownSelection14d</br>dropDownSelectionViews14d</br>dropDownSelectionClicks14d</br>signUpButton14d</br>signUpButtonViews14d</br>signUpButtonClicks14d</br>subscriptionButton14d</br>subscriptionButtonViews14d</br>subscriptionButtonClicks14d</br>successPage14d</br>successPageViews14d</br>successPageClicks14d</br>thankYouPage14d</br>thankYouPageViews14d</br>thankYouPageClicks14d</br>registrationForm14d</br>registrationFormViews14d</br>registrationFormClicks14d</br>registrationConfirmPage14d</br>registrationConfirmPageViews14d</br>registrationConfirmPageClicks14d</br>storeLocatorPage14d</br>storeLocatorPageViews14d</br>storeLocatorPageClicks14d</br>mobileAppFirstStarts14d</br>mobileAppFirstStartViews14d</br>mobileAppFirstStartClicks14d</br>brandStoreEngagement1</br>brandStoreEngagement1Views</br>brandStoreEngagement1Clicks</br>brandStoreEngagement2</br>brandStoreEngagement2Views</br>brandStoreEngagement2Clicks</br>brandStoreEngagement3</br>brandStoreEngagement3Views</br>brandStoreEngagement3Clicks</br>brandStoreEngagement4</br>brandStoreEngagement4Views</br>brandStoreEngagement4Clicks</br>brandStoreEngagement5</br>brandStoreEngagement5Views</br>brandStoreEngagement5Clicks</br>brandStoreEngagement6</br>brandStoreEngagement6Views</br>brandStoreEngagement6Clicks</br>brandStoreEngagement7</br>brandStoreEngagement7Views</br>brandStoreEngagement7Clicks</br>addedToShoppingCart14d</br>addedToShoppingCartViews14d</br>addedToShoppingCartClicks14d</br>productPurchased</br>productPurchasedViews</br>productPurchasedClicks</br>homepageVisit14d</br>homepageVisitViews14d</br>homepageVisitClicks14d</br>videoStarted</br>videoStartedViews</br>videoStartedClicks</br>videoCompleted</br>videoCompletedViews</br>videoEndClicks</br>messageSent14d</br>messageSentViews14d</br>messageSentClicks14d</br>mashupClickToPage</br>mashupClickToPageViews</br>mashupClickToPageClicks</br>mashupBackupImage</br>mashupBackupImageViews</br>mashupBackupImageClicks</br>mashupAddToCart14d</br>mashupAddToCartViews14d</br>mashupAddToCartClicks14d</br>mashupAddToWishlist14d</br>mashupAddToWishlistViews14d</br>mashupAddToWishlistClicks14d</br>mashupSubscribeAndSave14d</br>mashupSubscribeAndSaveClickViews14d</br>mashupSubscribeAndSaveClick14d</br>mashupClipCouponClick14d</br>mashupClipCouponClickViews14d</br>mashupClipCouponClickClicks14d</br>mashupShopNowClick14d</br>mashupShopNowClickViews14d</br>mashupShopNowClickClicks14d</br>referral14d</br>referralViews14d</br>referralClicks14d</br>accept14d</br>acceptViews14d</br>acceptClicks14d</br>decline14d</br>declineViews14d</br>declineClicks14d</br>dpv14d</br>dpvViews14d</br>dpvClicks14d</br>pRPV14d</br>pRPVViews14d</br>pRPVClicks14d</br>atl14d</br>atlViews14d</br>atlClicks14d</br>atc14d</br>atcViews14d</br>atcClicks14d</br>purchases14d</br>purchasesViews14d</br>purchasesClicks14d</br>newToBrandPurchases14d</br>newToBrandPurchasesViews14d</br>newToBrandPurchasesClicks14d</br>newSubscribeAndSave14d</br>newSubscribeAndSaveViews14d</br>newSubscribeAndSaveClicks14d</br>addToWatchlist14d</br>addToWatchlistViews14d</br>addToWatchlistClicks14d</br>downloadedVideoPlays14d</br>downloadedVideoPlaysViews14d</br>downloadedVideoPlaysClicks14d</br>videoStreams14d</br>videoStreamsViews14d</br>videoStreamsClicks14d</br>playTrailers14d</br>playTrailersViews14d</br>playerTrailersClicks14d</br>rentals14d</br>rentalsViews14d</br>rentalsClicks14d</br>videoDownloads14d</br>videoDownloadsViews14d</br>videoDownloadsClicks14d</br>videoStart</br>videoFirstQuartile</br>videoMidpoint</br>videoThirdQuartile</br>videoComplete</br>videoPause</br>videoResume</br>videoMute</br>videoUnmute</br>unitsSold14d</br>sales14d</br>newToBrandUnitsSold14d</br>newToBrandProductSales14d</br>brandSearch14d</br>brandSearchViews14d</br>brandSearchClicks14d</br>brandSearchRate14d</br>brandSearchCPA14d</details>","type":"string"},"type":{"default":"CAMPAIGN","description":"The report type.","type":"string","enum":["CAMPAIGN","INVENTORY","AUDIENCE","PRODUCTS","TECHNOLOGY","GEOGRAPHY"]},"startDate":{"description":"Date in YYYYMMDD format. The report contains only metrics generated on the specified date range between startDate and endDate. The maximum date range between startDate and endDate is 31 days. The startDate can be up to 90 days older from today.","type":"string"},"dimensions":{"description":"List of dimensions to include in the report. Specify one or many comma-delimited strings of dimensions. For example: [\"ORDER\", \"LINE_ITEM\", \"CREATIVE\"]. Adding a dimension in this array determines the aggregation level of the report data and also adds the fields for that dimension in the report. If the list is null or empty, the aggregation of the report data is at `ORDER` level. The allowed values can be used together in this array as an allowed value in which case the report aggregation will be at the lowest aggregation level and the report will contain the fields for all the dimensions included in the report.<details><summary>`Default Fields`</summary></br>date (for timeUnit `DAILY`)</br>intervalStart (for timeUnit `SUMMARY`)</br>intervalEnd (for timeUnit `SUMMARY`)</br>segment (Only present for AUDIENCE Report)</br>entityId</br>advertiserName</br>advertiserId</details></br><summary>The below fields will be added based on selected dimesions &nbsp;</summary></br><details><summary>`ORDER`</summary></br>orderName</br>orderId</br>orderStartDate</br>orderEndDate</br>orderBudget</br>orderExternalId</br>orderCurrency</details></br><details><summary>`LINE_ITEM`</summary></br>lineItemName</br>lineItemId</br>lineItemStartDate</br>lineItemEndDate</br>lineItemBudget</br>lineItemExternalId</details></br><details><summary>`CREATIVE`</summary></br>creativeName</br>creativeID</br>creativeType</br>creativeSize</br>creativeAdId</details></br><details><summary>`SITE`</summary></br>siteName</details></br><details><summary>`SUPPLY`</summary></br>supplySourceName</details></br><details><summary>`DEAL`</summary></br>deal</br>dealID</details></br><details><summary>`COUNTRY`</summary></br>country</details></br><details><summary>`STATE_COUNTY_REGION`</summary></br>region</details></br><details><summary>`CITY`</summary></br>city</details></br><details><summary>`DMA`</summary></br>designatedMarketAreaCode</br>designatedMarketAreaName</details></br><details><summary>`POSTAL_CODE`</summary></br>postalCode</details></br><details><summary>`OPERATING_SYSTEM`</summary></br>operatingSystem</details></br><details><summary>`BROWSER_TYPE`</summary></br>browser</details></br><details><summary>`BROWSER_VERSION`</summary></br>browserVersion</details></br><details><summary>`DEVICE_TYPE`</summary></br>device</details></br><details><summary>`ENVIRONMENT_TYPE`</summary></br>environmentType</details>\n\n| Type | Dimension |\n|------|-----------|\n| CAMPAIGN | ORDER, LINE_ITEM, CREATIVE |\n| INVENTORY | ORDER, LINE_ITEM, SITE, SUPPLY, DEAL |\n| AUDIENCE | ORDER, LINE_ITEM |\n| PRODUCTS | ORDER, LINE_ITEM |\n| TECHNOLOGY | ORDER, LINE_ITEM, OPERATING_SYSTEM, BROWSER_TYPE, BROWSER_VERSION, DEVICE_TYPE, ENVIRONMENT_TYPE |\n| GEOGRAPHY | ORDER, LINE_ITEM, COUNTRY, STATE_COUNTY_REGION, CITY, DMA, POSTAL_CODE |","type":"array","items":{"type":"string","enum":["ORDER","LINE_ITEM","CREATIVE","SITE","SUPPLY","DEAL","COUNTRY","STATE_COUNTY_REGION","CITY","DMA","POSTAL_CODE","OPERATING_SYSTEM","BROWSER_TYPE","BROWSER_VERSION","DEVICE_TYPE","ENVIRONMENT_TYPE"]}},"timeUnit":{"default":"SUMMARY","description":"Adding timeUnit determines the aggregation level (`SUMMARY` or `DAILY`) of the report data. If the timeUnit is null or empty, the aggregation of the report data is at the `SUMMARY` level and aggregated at the time period specified. `DAILY` timeUnit is not supported for `AUDIENCE` report type. The report will contain the fields based on timeUnit:<details><summary>`SUMMARY`</summary>intervalStart</br>intervalEnd</details></br><details><summary>`DAILY`</summary>Date</details>","type":"string","enum":["DAILY","SUMMARY"]}}}}},"required":true},"description":"Use this operation to request creation of a report that includes metrics about your Amazon DSP campaigns. Specify the `type` of report and the `metrics` you'd like to include. Note that the value specified for the `dimensions` field affects the metrics included in the report. See the `dimensions` field description for more information.","operationId":"createReportV2","responses":{"200":{"description":"Successful operation. Version can be specified in the accept. By default returns latest version","content":{"application/vnd.dspcreatereports.v2_2+json":{"schema":{"type":"object","properties":{"reportId":{"description":"The identifier of the report.","type":"string"},"format":{"description":"The data format of the report.","type":"string","enum":["JSON","CSV"]},"statusDetails":{"description":" A human-readable description of the current status.","type":"string"},"location":{"description":"The URI address of the report.","type":"string"},"expiration":{"format":"int64","description":"The expiration time of the URI in the location property in milliseconds. The expiration time is the interval between the time the response was generated and the time the URI expires.","type":"integer"},"type":{"description":"The type of report.","type":"string","enum":["CAMPAIGN","INVENTORY","AUDIENCE","PRODUCTS","TECHNOLOGY","GEOGRAPHY"]},"status":{"description":"The build status of the report.","type":"string","enum":["IN_PROGRESS","SUCCESS","FAILURE"]}}}}}},"400":{"description":"Bad request","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"415":{"description":"415 - Unsupported Media Type","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"422":{"description":"Unprocessable entity - Failed due to invalid parameters.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved..","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"504":{"description":"Endpoint Request Timed-out Exception. This can be due to intermittent issue and can be retried","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and subType must not be `AMAZON_ATTRIBUTION`.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The client identifier. See [create API authorization and refresh tokens](https://advertising.amazon.com/API/docs/en-us/guides/get-started/retrieve-access-token) for more information.","required":true}],"tags":["Reports"]}],"path":"/en-us/dsp/2-2/previous/openapi#tag/Reports/operation/createReportV2","sectionHeader":{"type":3,"text":"POST /dsp/reports"},"summary":"Creates a report request.","documentType":"api-reference"},{"title":"DSP Reports","content":["/dsp/reports/{reportId}",{"summary":"Gets the metadata of a report previously requested.","description":"Pass the identifier of a previously requested report in the `reportId` field to get the current status of the report. While the report is pending, `status` is set to `IN_PROGRESS`. When a reponse with `status` set to `SUCCESS` is returned, the report is available for download at the address specified in the `location` field.","operationId":"getCampaignReportV2","responses":{"200":{"description":"Successful operation. Version can be specified in the accept. By default returns latest version","content":{"application/vnd.dspgetreports.v2_1+json":{"schema":{"type":"object","properties":{"reportId":{"description":"The identifier of the report.","type":"string"},"format":{"description":"The data format of the report.","type":"string","enum":["JSON","CSV"]},"statusDetails":{"description":" A human-readable description of the current status.","type":"string"},"location":{"description":"The URI address of the report.","type":"string"},"expiration":{"format":"int64","description":"The expiration time of the URI in the location property in milliseconds. The expiration time is the interval between the time the response was generated and the time the URI expires.","type":"integer"},"type":{"description":"The type of report.","type":"string","enum":["CAMPAIGN","INVENTORY","AUDIENCE","PRODUCTS","TECHNOLOGY","GEOGRAPHY"]},"status":{"description":"The build status of the report.","type":"string","enum":["IN_PROGRESS","SUCCESS","FAILURE"]}}}}}},"400":{"description":"Bad request","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"415":{"description":"415 - Unsupported Media Type","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved..","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"504":{"description":"Endpoint Request Timed-out Exception. This can be due to intermittent issue and can be retried","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and subType must not be `AMAZON_ATTRIBUTION`.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The client identifier. See [create API authorization and refresh tokens](https://advertising.amazon.com/API/docs/en-us/guides/get-started/retrieve-access-token) for more information. ","required":true},{"schema":{"type":"string"},"in":"path","name":"reportId","description":"The identifier of the requested report.","required":true}],"tags":["Reports"]}],"path":"/en-us/dsp/2-2/previous/openapi#tag/Reports/operation/getCampaignReportV2","sectionHeader":{"type":3,"text":"GET /dsp/reports/{reportId}"},"summary":"Gets the metadata of a report previously requested.","documentType":"api-reference"},{"title":"DSP Reports","content":["Fetch reports with performance metrics for DSP campaigns.\n"],"path":"/en-us/dsp/2-2/previous/openapi","sectionHeader":{"type":2,"text":"DSP Reports"},"documentType":"api-reference"},{"title":"DSP Reports","content":["/dsp/reports",{"summary":"Creates a report request.","requestBody":{"description":"Create report request body. Version of request can be specified in the accept. By default takes latest version","content":{"application/vnd.dspcreatereports.v2_2+json":{"schema":{"type":"object","required":["startDate","endDate"],"properties":{"advertiserIds":{"description":"List of advertisers specified by identifier to include in the report. If this field is not specified, the report includes data for all advertisers included in the scope specified in the `Amazon-Advertising-API-Scope` header. Note that if an advertiser identifier is specified that is not available under the scope provided in the header, the response is `422 - Unprocessable Entity`.","type":"array","items":{"maximum":100,"type":"string","minimum":0}},"endDate":{"description":"Date in YYYYMMDD format. The report contains only metrics generated on the specified date range between startDate and endDate. The maximum date range between startDate and endDate is 31 days. The endDate can be up to 90 days older from today.","type":"string"},"format":{"default":"JSON","description":"The report file format.","type":"string","enum":["JSON","CSV"]},"orderIds":{"description":"List of orders specified by identifier to include in the report. If this field is not specified, the report includes data for all orders included in the scope specified in the `Amazon-Advertising-API-Scope` header. Note that if an order identifier is specified that is not available under the scope provided in the header, the response is `422 - Unprocessable Entity`.","type":"array","items":{"maximum":100,"type":"string","minimum":0}},"metrics":{"description":"Specify a comma-delimited string of metrics field names to include in the report. For example: \"impressions, clickThroughs, CTR, eCPC, totalCost, eCPM\". If no metric field names are specified, only the default fields and selected `DIMENSION` fields are included by default. Specifying default fields returns an error.<details><summary>`Common Fields`</summary><summary>These fields will be added when reportType is `CAMPAIGN, INVENTORY, or AUDIENCE`.&nbsp;</summary></br>totalCost</br>supplyCost</br>amazonAudienceFee</br>amazonOmnichannelMetricsFee</br>advertiserTimezone</br>advertiserCountry</br>amazonPlatformFee</br>impressions</br>clickThroughs</br>CTR</br>eCPM</br>eCPC</br>dpv14d</br>dpvViews14d</br>dpvClicks14d</br>dpvr14d</br>eCPDPV14d</br>pRPV14d</br>pRPVViews14d</br>pRPVClicks14d</br>pRPVr14d</br>eCPPRPV14d</br>atl14d</br>atlViews14d</br>atlClicks14d</br>atlr14d</br>eCPAtl14d</br>atc14d</br>atcViews14d</br>atcClicks14d</br>atcr14d</br>eCPAtc14d</br>purchases14d</br>purchasesViews14d</br>purchasesClicks14d</br>purchaseRate14d</br>eCPP14d</br>newToBrandPurchases14d</br>newToBrandPurchasesViews14d</br>newToBrandPurchasesClicks14d</br>newToBrandPurchaseRate14d</br>newToBrandECPP14d</br>percentOfPurchasesNewToBrand14d</br>addToWatchlist14d</br>addToWatchlistViews14d</br>addToWatchlistClicks14d</br>addToWatchlistCVR14d</br>addToWatchlistCPA14d</br>downloadedVideoPlays14d</br>downloadedVideoPlaysViews14d</br>downloadedVideoPlaysClicks14d</br>downloadedVideoPlayRate14d</br>eCPDVP14d</br>videoStreams14d</br>videoStreamsViews14d</br>videoStreamsClicks14d</br>videoStreamsRate14d</br>eCPVS14d</br>playTrailers14d</br>playTrailersViews14d</br>playerTrailersClicks14d</br>playTrailerRate14d</br>eCPPT14d</br>rentals14d</br>rentalsViews14d</br>rentalsClicks14d</br>rentalRate14d</br>ecpr14d</br>videoDownloads14d</br>videoDownloadsViews14d</br>videoDownloadsClicks14d</br>videoDownloadRate14d</br>ecpvd14d</br>newSubscribeAndSave14d</br>newSubscribeAndSaveViews14d</br>newSubscribeAndSaveClicks14d</br>newSubscribeAndSaveRate14d</br>eCPnewSubscribeAndSave14d</br>totalPixel14d</br>totalPixelViews14d</br>totalPixelClicks14d</br>totalPixelCVR14d</br>totalPixelCPA14d</br>marketingLandingPage14d</br>marketingLandingPageViews14d</br>marketingLandingPageClicks14d</br>marketingLandingPageCVR14d</br>marketingLandingPageCPA14d</br>subscriptionPage14d</br>subscriptionPageViews14d</br>subscriptionPageClicks14d</br>subscriptionPageCVR14d</br>subscriptionPageCPA14d</br>signUpPage14d</br>signUpPageViews14d</br>signUpPageClicks14d</br>signUpPageCVR14d</br>signUpPageCPA14d</br>application14d</br>applicationViews14d</br>applicationClicks14d</br>applicationCVR14d</br>applicationCPA14d</br>gameLoad14d</br>gameLoadViews14d</br>gameLoadClicks14d</br>gameLoadCVR14d</br>gameLoadCPA14d</br>widgetLoad14d</br>widgetLoadViews14d</br>widgetLoadClicks14d</br>widgetLoadCVR14d</br>widgetLoadCPA14d</br>surveyStart14d</br>surveyStartViews14d</br>surveyStartClicks14d</br>surveyStartCVR14d</br>surveyStartCPA14d</br>surveyFinish14d</br>surveyFinishViews14d</br>surveyFinishClicks14d</br>surveyFinishCVR14d</br>surveyFinishCPA14d</br>bannerInteraction14d</br>bannerInteractionViews14d</br>bannerInteractionClicks14d</br>bannerInteractionCVR14d</br>bannerInteractionCPA14d</br>widgetInteraction14d</br>widgetInteractionViews14d</br>widgetInteractionClicks14d</br>widgetInteractionCVR14d</br>widgetInteractionCPA14d</br>gameInteraction14d</br>gameInteractionViews14d</br>gameInteractionClicks14d</br>gameInteractionCVR14d</br>gameInteractionCPA14d</br>emailLoad14d</br>emailLoadViews14d</br>emailLoadClicks14d</br>emailLoadCVR14d</br>emailLoadCPA14d</br>emailInteraction14d</br>emailInteractionViews14d</br>emailInteractionClicks14d</br>emailInteractionCVR14d</br>emailInteractionCPA14d</br>submitButton14d</br>submitButtonViews14d</br>submitButtonClicks14d</br>submitButtonCVR14d</br>submitButtonCPA14d</br>purchaseButton14d</br>purchaseButtonViews14d</br>purchaseButtonClicks14d</br>purchaseButtonCVR14d</br>purchaseButtonCPA14d</br>clickOnRedirect14d</br>clickOnRedirectViews14d</br>clickOnRedirectClicks14d</br>clickOnRedirectCVR14d</br>clickOnRedirectCPA14d</br>signUpButton14d</br>signUpButtonViews14d</br>signUpButtonClicks14d</br>signUpButtonCVR14d</br>signUpButtonCPA14d</br>subscriptionButton14d</br>subscriptionButtonViews14d</br>subscriptionButtonClicks14d</br>subscriptionButtonCVR14d</br>subscriptionButtonCPA14d</br>successPage14d</br>successPageViews14d</br>successPageClicks14d</br>successPageCVR14d</br>successPageCPA14d</br>thankYouPage14d</br>thankYouPageViews14d</br>thankYouPageClicks14d</br>thankYouPageCVR14d</br>thankYouPageCPA14d</br>registrationForm14d</br>registrationFormViews14d</br>registrationFormClicks14d</br>registrationFormCVR14d</br>registrationFormCPA14d</br>registrationConfirmPage14d</br>registrationConfirmPageViews14d</br>registrationConfirmPageClicks14d</br>registrationConfirmPageCVR14d</br>registrationConfirmPageCPA14d</br>storeLocatorPage14d</br>storeLocatorPageViews14d</br>storeLocatorPageClicks14d</br>storeLocatorPageCVR14d</br>storeLocatorPageCPA14d</br>mobileAppFirstStarts14d</br>mobileAppFirstStartViews14d</br>mobileAppFirstStartClicks14d</br>mobileAppFirstStartCVR14d</br>mobileAppFirstStartsCPA14d</br>brandStoreEngagement1</br>brandStoreEngagement1Views</br>brandStoreEngagement1Clicks</br>brandStoreEngagement1CVR</br>brandStoreEngagement1CPA</br>brandStoreEngagement2</br>brandStoreEngagement2Views</br>brandStoreEngagement2Clicks</br>brandStoreEngagement2CVR</br>brandStoreEngagement2CPA</br>brandStoreEngagement3</br>brandStoreEngagement3Views</br>brandStoreEngagement3Clicks</br>brandStoreEngagement3CVR</br>brandStoreEngagement3CPA</br>brandStoreEngagement4</br>brandStoreEngagement4Views</br>brandStoreEngagement4Clicks</br>brandStoreEngagement4CVR</br>brandStoreEngagement4CPA</br>brandStoreEngagement5</br>brandStoreEngagement5Views</br>brandStoreEngagement5Clicks</br>brandStoreEngagement5CVR</br>brandStoreEngagement5CPA</br>brandStoreEngagement6</br>brandStoreEngagement6Views</br>brandStoreEngagement6Clicks</br>brandStoreEngagement6CVR</br>brandStoreEngagement6CPA</br>brandStoreEngagement7</br>brandStoreEngagement7Views</br>brandStoreEngagement7Clicks</br>brandStoreEngagement7CVR</br>brandStoreEngagement7CPA</br>addedToShoppingCart14d</br>addedToShoppingCartViews14d</br>addedToShoppingCartClicks14d</br>addedToShoppingCartCVR14d</br>addedToShoppingCartCPA14d</br>productPurchased</br>productPurchasedViews</br>productPurchasedClicks</br>productPurchasedCVR</br>productPurchasedCPA</br>homepageVisit14d</br>homepageVisitViews14d</br>homepageVisitClicks14d</br>homepageVisitCVR14d</br>homepageVisitCPA14d</br>videoStarted</br>videoStartedViews</br>videoStartedClicks</br>videoStartedCVR</br>videoStartedCPA</br>videoCompleted</br>videoCompletedViews</br>videoEndClicks</br>videoCompletedCVR</br>videoCompletedCPA</br>messageSent14d</br>messageSentViews14d</br>messageSentClicks14d</br>messageSentCVR14d</br>messageSentCPA14d</br>mashupClickToPage</br>mashupClickToPageViews</br>mashupClickToPageClicks</br>mashupClickToPageCVR</br>mashupClickToPageCPA</br>mashupBackupImage</br>mashupBackupImageViews</br>mashupBackupImageClicks</br>mashupBackupImageCVR</br>mashupBackupImageCPA</br>mashupAddToCart14d</br>mashupAddToCartViews14d</br>mashupAddToCartClicks14d</br>mashupAddToCartClickCVR14d</br>mashupAddToCartCPA14d</br>mashupAddToWishlist14d</br>mashupAddToWishlistViews14d</br>mashupAddToWishlistClicks14d</br>mashupAddToWishlistCVR14d</br>mashupAddToWishlistCPA14d</br>mashupSubscribeAndSave14d</br>mashupSubscribeAndSaveClickViews14d</br>mashupSubscribeAndSaveClick14d</br>mashupSubscribeAndSaveCVR14d</br>mashupSubscribeAndSaveCPA14d</br>mashupClipCouponClick14d</br>mashupClipCouponClickViews14d</br>mashupClipCouponClickClicks14d</br>mashupClipCouponClickCVR14d</br>mashupClipCouponClickCPA14d</br>mashupShopNowClick14d</br>mashupShopNowClickViews14d</br>mashupShopNowClickClicks14d</br>mashupShopNowClickCVR14d</br>mashupShopNowClickCPA14d</br>referral14d</br>referralViews14d</br>referralClicks14d</br>referralCVR14d</br>referralCPA14d</br>accept14d</br>acceptViews14d</br>acceptClicks14d</br>acceptCVR14d</br>acceptCPA14d</br>decline14d</br>declineViews14d</br>declineClicks14d</br>declineCVR14d</br>declineCPA14d</br>videoStart</br>videoFirstQuartile</br>videoMidpoint</br>videoThirdQuartile</br>videoComplete</br>videoCompletionRate</br>ecpvc</br>videoPause</br>videoResume</br>videoMute</br>videoUnmute</br>dropDownSelection14d</br>dropDownSelectionViews14d</br>dropDownSelectionClicks14d</br>dropDownSelectionCVR14d</br>dropDownSelectionCPA14d</br>brandSearch14d</br>brandSearchViews14d</br>brandSearchClicks14d</br>brandSearchRate14d</br>brandSearchCPA14d</br></details></br><details><summary>`Campaign Fields`</summary><summary>These fields will be added when reportType is Campaign. &nbsp;</summary></br>agencyFee</br>totalFee</br>3pFeeAutomotive</br>3pFeeAutomotiveAbsorbed</br>3pFeeComScore</br>3pFeeComScoreAbsorbed</br>3pFeeCPM1</br>3pFeeCPM1Absorbed</br>3pFeeCPM2</br>3pFeeCPM2Absorbed</br>3pFeeCPM3</br>3pFeeCPM3Absorbed</br>3pFeeDoubleclickCampaignManager</br>3pFeeDoubleclickCampaignManagerAbsorbed</br>3pFeeDoubleVerify</br>3pFeeDoubleVerifyAbsorbed</br>3pFeeIntegralAdScience</br>3pFeeIntegralAdScienceAbsorbed</br>3PFees</br>unitsSold14d</br>sales14d</br>ROAS14d</br>eRPM14d</br>newToBrandUnitsSold14d</br>newToBrandProductSales14d</br>newToBrandROAS14d</br>newToBrandERPM14d</br>totalPRPV14d</br>totalPRPVViews14d</br>totalPRPVClicks14d</br>totalPRPVr14d</br>totalECPPRPV14d</br>totalPurchases14d</br>totalPurchasesViews14d</br>totalPurchasesClicks14d</br>totalPurchaseRate14d</br>totalECPP14d</br>totalNewToBrandPurchases14d</br>totalNewToBrandPurchasesViews14d</br>totalNewToBrandPurchasesClicks14d</br>totalNewToBrandPurchaseRate14d</br>totalNewToBrandECPP14d</br>totalPercentOfPurchasesNewToBrand14d</br>totalUnitsSold14d</br>totalSales14d</br>totalROAS14d</br>totalERPM14d</br>totalNewToBrandUnitsSold14d</br>totalNewToBrandProductSales14d</br>totalNewToBrandROAS14d</br>totalNewToBrandERPM14d</br>viewableImpressions</br>measurableImpressions</br>measurableRate</br>viewabilityRate</br>totalDetailPageViews14d</br>totalDetailPageViewViews14d</br>totalDetailPageClicks14d</br>totalDetailPageViewsCVR14d</br>totalDetaiPageViewCPA14d</br>totalAddToList14d</br>totalAddToListViews14d</br>totalAddToListClicks14d</br>totalAddToListCVR14d</br>totalAddToListCPA14d</br>totalAddToCart14d</br>totalAddToCartViews14d</br>totalAddToCartClicks14d</br>totalAddToCartCVR14d</br>totalAddToCartCPA14d</br>totalSubscribeAndSaveSubscriptions14d</br>totalSubscribeAndSaveSubscriptionViews14d</br>totalSubscribeAndSaveSubscriptionClicks14d</br>totalSubscribeAndSaveSubscriptionCVR14d</br>totalSubscribeAndSaveSubscriptionCPA14d</br></details></br><details><summary>`Inventory Fields`</summary><summary>These fields will be added when reportType is Inventory &nbsp;</summary></br>agencyFee</br>totalFee</br>3pFeeAutomotive</br>3pFeeAutomotiveAbsorbed</br>3pFeeComScore</br>3pFeeComScoreAbsorbed</br>3pFeeCPM1</br>3pFeeCPM1Absorbed</br>3pFeeCPM2</br>3pFeeCPM2Absorbed</br>3pFeeCPM3</br>3pFeeCPM3Absorbed</br>3pFeeDoubleclickCampaignManager</br>3pFeeDoubleclickCampaignManagerAbsorbed</br>3pFeeDoubleVerify</br>3pFeeDoubleVerifyAbsorbed</br>3pFeeIntegralAdScience</br>3pFeeIntegralAdScienceAbsorbed</br>3PFees</br>unitsSold14d</br>sales14d</br>ROAS14d</br>eRPM14d</br>newToBrandUnitsSold14d</br>newToBrandProductSales14d</br>newToBrandROAS14d</br>newToBrandERPM14d</br>totalPRPV14d</br>totalPRPVViews14d</br>totalPRPVClicks14d</br>totalPRPVr14d</br>totalECPPRPV14d</br>totalPurchases14d</br>totalPurchasesViews14d</br>totalPurchasesClicks14d</br>totalPurchaseRate14d</br>totalECPP14d</br>totalNewToBrandPurchases14d</br>totalNewToBrandPurchasesViews14d</br>totalNewToBrandPurchasesClicks14d</br>totalNewToBrandPurchaseRate14d</br>totalNewToBrandECPP14d</br>totalPercentOfPurchasesNewToBrand14d</br>totalUnitsSold14d</br>totalSales14d</br>totalROAS14d</br>totalERPM14d</br>totalNewToBrandUnitsSold14d</br>totalNewToBrandProductSales14d</br>totalNewToBrandROAS14d</br>totalNewToBrandERPM14d</br>viewableImpressions</br>measurableImpressions</br>measurableRate</br>viewabilityRate</br>totalDetailPageViews14d</br>totalDetailPageViewViews14d</br>totalDetailPageClicks14d</br>totalDetailPageViewsCVR14d</br>totalDetaiPageViewCPA14d</br>totalAddToList14d</br>totalAddToListViews14d</br>totalAddToListClicks14d</br>totalAddToListCVR14d</br>totalAddToListCPA14d</br>totalAddToCart14d</br>totalAddToCartViews14d</br>totalAddToCartClicks14d</br>totalAddToCartCVR14d</br>totalAddToCartCPA14d</br>totalSubscribeAndSaveSubscriptions14d</br>totalSubscribeAndSaveSubscriptionViews14d</br>totalSubscribeAndSaveSubscriptionClicks14d</br>totalSubscribeAndSaveSubscriptionCVR14d</br>totalSubscribeAndSaveSubscriptionCPA14d</br>placementName</br>placementSize</br>dealType</br></details></br><details><summary>`Audience Fields`</summary><summary>These fields will be added when reportType is Audience. &nbsp;</summary></br>lineitemtype</br>segmentClassCode</br>segmentSource</br>segmentType</br>segmentMarketplaceID</br>targetingMethod</details></br><details><summary>`Product Fields`</summary><summary>These fields can be specified when reportType is `PRODUCTS`. &nbsp;</summary></br>reportGranularity(Default)</br>amazonStandardId(Default)</br>parentASIN(Default)</br>marketplace(Default)</br>brandName(Default)</br>asinConversionType(Default)</br>featuredASIN(Default)</br>productName</br>productGroup</br>productCategory</br>productSubcategory</br>dpv14d</br>dpvViews14d</br>dpvClicks14d</br>pRPV14d</br>pRPVViews14d</br>pRPVClicks14d</br>atl14d</br>atlViews14d</br>atlClicks14d</br>atc14d</br>atcViews14d</br>atcClicks14d</br>purchases14d</br>purchasesViews14d</br>purchasesClicks14d</br>newToBrandPurchases14d</br>newToBrandPurchasesViews14d</br>newToBrandPurchasesClicks14d</br>percentOfPurchasesNewToBrand14d</br>totalDetailPageViews14d</br>totalDetailPageViewViews14d</br>totalDetailPageClicks14d</br>totalPRPV14d</br>totalPRPVViews14d</br>totalPRPVClicks14d</br>totalAddToList14d</br>totalAddToListViews14d</br>totalAddToListClicks14d</br>totalAddToCart14d</br>totalAddToCartViews14d</br>totalAddToCartClicks14d</br>totalPurchases14d</br>totalPurchasesViews14d</br>totalPurchasesClicks14d</br>totalNewToBrandPurchases14d</br>totalNewToBrandPurchasesViews14d</br>totalNewToBrandPurchasesClicks14d</br>totalPercentOfPurchasesNewToBrand14d</br>newSubscribeAndSave14d</br>newSubscribeAndSaveViews14d</br>newSubscribeAndSaveClicks14d</br>totalSubscribeAndSaveSubscriptions14d</br>totalSubscribeAndSaveSubscriptionViews14d</br>totalSubscribeAndSaveSubscriptionClicks14d</br>unitsSold14d</br>sales14d</br>totalUnitsSold14d</br>totalSales14d</br>newToBrandUnitsSold14d</br>newToBrandProductSales14d</br>brandHaloDetailPage14d</br>brandHaloDetailPageViews14d</br>brandHaloDetailPageClicks14d</br>brandHaloProductReviewPage14d</br>brandHaloProductReviewPageViews14d</br>brandHaloProductReviewPageClicks14d</br>brandHaloAddToList14d</br>brandHaloAddToListViews14d</br>brandHaloAddToListClicks14d</br>brandHaloAddToCart14d</br>brandHaloAddToCartViews14d</br>brandHaloAddToCartClicks14d</br>brandHaloPurchases14d</br>brandHaloPurchasesViews14d</br>brandHaloPurchasesClicks14d</br>brandHaloNewToBrandPurchases14d</br>brandHaloNewToBrandPurchasesViews14d</br>brandHaloNewToBrandPurchasesClicks14d</br>brandHaloPercentOfPurchasesNewToBrand14d</br>brandHaloNewSubscribeAndSave14d</br>brandHaloNewSubscribeAndSaveViews14d</br>brandHaloNewSubscribeAndSaveClicks14d</br>brandHaloTotalUnitsSold14d</br>brandHaloTotalSales14d</br>brandHaloTotalNewToBrandSales14d</br>brandHaloTotalNewToBrandUnitsSold14d</details></br><details><summary>`Tech and Geo Fields`</summary><summary>These fields can be specified when reportType is `TECHNOLOGY` or `Geography`. &nbsp;</summary></br>agencyFee</br>totalCost</br>impressions</br>viewableImpressions</br>clickThroughs</br>totalPixel14d</br>totalPixelViews14d</br>totalPixelClicks14d</br>marketingLandingPage14d</br>marketingLandingPageViews14d</br>marketingLandingPageClicks14d</br>subscriptionPage14d</br>subscriptionPageViews14d</br>subscriptionPageClicks14d</br>signUpPage14d</br>signUpPageViews14d</br>signUpPageClicks14d</br>application14d</br>applicationViews14d</br>applicationClicks14d</br>gameLoad14d</br>gameLoadViews14d</br>gameLoadClicks14d</br>widgetLoad14d</br>widgetLoadViews14d</br>widgetLoadClicks14d</br>surveyStart14d</br>surveyStartViews14d</br>surveyStartClicks14d</br>surveyFinish14d</br>surveyFinishViews14d</br>surveyFinishClicks14d</br>bannerInteraction14d</br>bannerInteractionViews14d</br>bannerInteractionClicks14d</br>widgetInteraction14d</br>widgetInteractionViews14d</br>widgetInteractionClicks14d</br>gameInteraction14d</br>gameInteractionViews14d</br>gameInteractionClicks14d</br>emailLoad14d</br>emailLoadViews14d</br>emailLoadClicks14d</br>emailInteraction14d</br>emailInteractionViews14d</br>emailInteractionClicks14d</br>submitButton14d</br>submitButtonViews14d</br>submitButtonClicks14d</br>purchaseButton14d</br>purchaseButtonViews14d</br>purchaseButtonClicks14d</br>clickOnRedirect14d</br>clickOnRedirectViews14d</br>clickOnRedirectClicks14d</br>dropDownSelection14d</br>dropDownSelectionViews14d</br>dropDownSelectionClicks14d</br>signUpButton14d</br>signUpButtonViews14d</br>signUpButtonClicks14d</br>subscriptionButton14d</br>subscriptionButtonViews14d</br>subscriptionButtonClicks14d</br>successPage14d</br>successPageViews14d</br>successPageClicks14d</br>thankYouPage14d</br>thankYouPageViews14d</br>thankYouPageClicks14d</br>registrationForm14d</br>registrationFormViews14d</br>registrationFormClicks14d</br>registrationConfirmPage14d</br>registrationConfirmPageViews14d</br>registrationConfirmPageClicks14d</br>storeLocatorPage14d</br>storeLocatorPageViews14d</br>storeLocatorPageClicks14d</br>mobileAppFirstStarts14d</br>mobileAppFirstStartViews14d</br>mobileAppFirstStartClicks14d</br>brandStoreEngagement1</br>brandStoreEngagement1Views</br>brandStoreEngagement1Clicks</br>brandStoreEngagement2</br>brandStoreEngagement2Views</br>brandStoreEngagement2Clicks</br>brandStoreEngagement3</br>brandStoreEngagement3Views</br>brandStoreEngagement3Clicks</br>brandStoreEngagement4</br>brandStoreEngagement4Views</br>brandStoreEngagement4Clicks</br>brandStoreEngagement5</br>brandStoreEngagement5Views</br>brandStoreEngagement5Clicks</br>brandStoreEngagement6</br>brandStoreEngagement6Views</br>brandStoreEngagement6Clicks</br>brandStoreEngagement7</br>brandStoreEngagement7Views</br>brandStoreEngagement7Clicks</br>addedToShoppingCart14d</br>addedToShoppingCartViews14d</br>addedToShoppingCartClicks14d</br>productPurchased</br>productPurchasedViews</br>productPurchasedClicks</br>homepageVisit14d</br>homepageVisitViews14d</br>homepageVisitClicks14d</br>videoStarted</br>videoStartedViews</br>videoStartedClicks</br>videoCompleted</br>videoCompletedViews</br>videoEndClicks</br>messageSent14d</br>messageSentViews14d</br>messageSentClicks14d</br>mashupClickToPage</br>mashupClickToPageViews</br>mashupClickToPageClicks</br>mashupBackupImage</br>mashupBackupImageViews</br>mashupBackupImageClicks</br>mashupAddToCart14d</br>mashupAddToCartViews14d</br>mashupAddToCartClicks14d</br>mashupAddToWishlist14d</br>mashupAddToWishlistViews14d</br>mashupAddToWishlistClicks14d</br>mashupSubscribeAndSave14d</br>mashupSubscribeAndSaveClickViews14d</br>mashupSubscribeAndSaveClick14d</br>mashupClipCouponClick14d</br>mashupClipCouponClickViews14d</br>mashupClipCouponClickClicks14d</br>mashupShopNowClick14d</br>mashupShopNowClickViews14d</br>mashupShopNowClickClicks14d</br>referral14d</br>referralViews14d</br>referralClicks14d</br>accept14d</br>acceptViews14d</br>acceptClicks14d</br>decline14d</br>declineViews14d</br>declineClicks14d</br>dpv14d</br>dpvViews14d</br>dpvClicks14d</br>pRPV14d</br>pRPVViews14d</br>pRPVClicks14d</br>atl14d</br>atlViews14d</br>atlClicks14d</br>atc14d</br>atcViews14d</br>atcClicks14d</br>purchases14d</br>purchasesViews14d</br>purchasesClicks14d</br>newToBrandPurchases14d</br>newToBrandPurchasesViews14d</br>newToBrandPurchasesClicks14d</br>newSubscribeAndSave14d</br>newSubscribeAndSaveViews14d</br>newSubscribeAndSaveClicks14d</br>addToWatchlist14d</br>addToWatchlistViews14d</br>addToWatchlistClicks14d</br>downloadedVideoPlays14d</br>downloadedVideoPlaysViews14d</br>downloadedVideoPlaysClicks14d</br>videoStreams14d</br>videoStreamsViews14d</br>videoStreamsClicks14d</br>playTrailers14d</br>playTrailersViews14d</br>playerTrailersClicks14d</br>rentals14d</br>rentalsViews14d</br>rentalsClicks14d</br>videoDownloads14d</br>videoDownloadsViews14d</br>videoDownloadsClicks14d</br>videoStart</br>videoFirstQuartile</br>videoMidpoint</br>videoThirdQuartile</br>videoComplete</br>videoPause</br>videoResume</br>videoMute</br>videoUnmute</br>unitsSold14d</br>sales14d</br>newToBrandUnitsSold14d</br>newToBrandProductSales14d</br>brandSearch14d</br>brandSearchViews14d</br>brandSearchClicks14d</br>brandSearchRate14d</br>brandSearchCPA14d</details>","type":"string"},"type":{"default":"CAMPAIGN","description":"The report type.","type":"string","enum":["CAMPAIGN","INVENTORY","AUDIENCE","PRODUCTS","TECHNOLOGY","GEOGRAPHY"]},"startDate":{"description":"Date in YYYYMMDD format. The report contains only metrics generated on the specified date range between startDate and endDate. The maximum date range between startDate and endDate is 31 days. The startDate can be up to 90 days older from today.","type":"string"},"dimensions":{"description":"List of dimensions to include in the report. Specify one or many comma-delimited strings of dimensions. For example: [\"ORDER\", \"LINE_ITEM\", \"CREATIVE\"]. Adding a dimension in this array determines the aggregation level of the report data and also adds the fields for that dimension in the report. If the list is null or empty, the aggregation of the report data is at `ORDER` level. The allowed values can be used together in this array as an allowed value in which case the report aggregation will be at the lowest aggregation level and the report will contain the fields for all the dimensions included in the report.<details><summary>`Default Fields`</summary></br>date (for timeUnit `DAILY`)</br>intervalStart (for timeUnit `SUMMARY`)</br>intervalEnd (for timeUnit `SUMMARY`)</br>segment (Only present for AUDIENCE Report)</br>entityId</br>advertiserName</br>advertiserId</details></br><summary>The below fields will be added based on selected dimesions &nbsp;</summary></br><details><summary>`ORDER`</summary></br>orderName</br>orderId</br>orderStartDate</br>orderEndDate</br>orderBudget</br>orderExternalId</br>orderCurrency</details></br><details><summary>`LINE_ITEM`</summary></br>lineItemName</br>lineItemId</br>lineItemStartDate</br>lineItemEndDate</br>lineItemBudget</br>lineItemExternalId</details></br><details><summary>`CREATIVE`</summary></br>creativeName</br>creativeID</br>creativeType</br>creativeSize</br>creativeAdId</details></br><details><summary>`SITE`</summary></br>siteName</details></br><details><summary>`SUPPLY`</summary></br>supplySourceName</details></br><details><summary>`DEAL`</summary></br>deal</br>dealID</details></br><details><summary>`COUNTRY`</summary></br>country</details></br><details><summary>`STATE_COUNTY_REGION`</summary></br>region</details></br><details><summary>`CITY`</summary></br>city</details></br><details><summary>`DMA`</summary></br>designatedMarketAreaCode</br>designatedMarketAreaName</details></br><details><summary>`POSTAL_CODE`</summary></br>postalCode</details></br><details><summary>`OPERATING_SYSTEM`</summary></br>operatingSystem</details></br><details><summary>`BROWSER_TYPE`</summary></br>browser</details></br><details><summary>`BROWSER_VERSION`</summary></br>browserVersion</details></br><details><summary>`DEVICE_TYPE`</summary></br>device</details></br><details><summary>`ENVIRONMENT_TYPE`</summary></br>environmentType</details>\n\n| Type | Dimension |\n|------|-----------|\n| CAMPAIGN | ORDER, LINE_ITEM, CREATIVE |\n| INVENTORY | ORDER, LINE_ITEM, SITE, SUPPLY, DEAL |\n| AUDIENCE | ORDER, LINE_ITEM |\n| PRODUCTS | ORDER, LINE_ITEM |\n| TECHNOLOGY | ORDER, LINE_ITEM, OPERATING_SYSTEM, BROWSER_TYPE, BROWSER_VERSION, DEVICE_TYPE, ENVIRONMENT_TYPE |\n| GEOGRAPHY | ORDER, LINE_ITEM, COUNTRY, STATE_COUNTY_REGION, CITY, DMA, POSTAL_CODE |","type":"array","items":{"type":"string","enum":["ORDER","LINE_ITEM","CREATIVE","SITE","SUPPLY","DEAL","COUNTRY","STATE_COUNTY_REGION","CITY","DMA","POSTAL_CODE","OPERATING_SYSTEM","BROWSER_TYPE","BROWSER_VERSION","DEVICE_TYPE","ENVIRONMENT_TYPE"]}},"timeUnit":{"default":"SUMMARY","description":"Adding timeUnit determines the aggregation level (`SUMMARY` or `DAILY`) of the report data. If the timeUnit is null or empty, the aggregation of the report data is at the `SUMMARY` level and aggregated at the time period specified. `DAILY` timeUnit is not supported for `AUDIENCE` report type. The report will contain the fields based on timeUnit:<details><summary>`SUMMARY`</summary>intervalStart</br>intervalEnd</details></br><details><summary>`DAILY`</summary>Date</details>","type":"string","enum":["DAILY","SUMMARY"]}}}}},"required":true},"description":"Use this operation to request creation of a report that includes metrics about your Amazon DSP campaigns. Specify the `type` of report and the `metrics` you'd like to include. Note that the value specified for the `dimensions` field affects the metrics included in the report. See the `dimensions` field description for more information.","operationId":"createReportV2","responses":{"200":{"description":"Successful operation. Version can be specified in the accept. By default returns latest version","content":{"application/vnd.dspcreatereports.v2_2+json":{"schema":{"type":"object","properties":{"reportId":{"description":"The identifier of the report.","type":"string"},"format":{"description":"The data format of the report.","type":"string","enum":["JSON","CSV"]},"statusDetails":{"description":" A human-readable description of the current status.","type":"string"},"location":{"description":"The URI address of the report.","type":"string"},"expiration":{"format":"int64","description":"The expiration time of the URI in the location property in milliseconds. The expiration time is the interval between the time the response was generated and the time the URI expires.","type":"integer"},"type":{"description":"The type of report.","type":"string","enum":["CAMPAIGN","INVENTORY","AUDIENCE","PRODUCTS","TECHNOLOGY","GEOGRAPHY"]},"status":{"description":"The build status of the report.","type":"string","enum":["IN_PROGRESS","SUCCESS","FAILURE"]}}}}}},"400":{"description":"Bad request","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"401":{"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"415":{"description":"415 - Unsupported Media Type","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"422":{"description":"Unprocessable entity - Failed due to invalid parameters.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved..","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"504":{"description":"Endpoint Request Timed-out Exception. This can be due to intermittent issue and can be retried","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and subType must not be `AMAZON_ATTRIBUTION`.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The client identifier. See [create API authorization and refresh tokens](https://advertising.amazon.com/API/docs/en-us/guides/get-started/retrieve-access-token) for more information.","required":true}],"tags":["Reports"]}],"path":"/en-us/dsp/2-2/previous/openapi#tag/Reports/operation/createReportV2","sectionHeader":{"type":3,"text":"POST /dsp/reports"},"summary":"Creates a report request.","documentType":"api-reference"},{"title":"DSP Reports","content":["/dsp/reports/{reportId}",{"summary":"Gets the metadata of a report previously requested.","description":"Pass the identifier of a previously requested report in the `reportId` field to get the current status of the report. While the report is pending, `status` is set to `IN_PROGRESS`. When a reponse with `status` set to `SUCCESS` is returned, the report is available for download at the address specified in the `location` field.","operationId":"getCampaignReportV2","responses":{"200":{"description":"Successful operation. Version can be specified in the accept. By default returns latest version","content":{"application/vnd.dspgetreports.v2_1+json":{"schema":{"type":"object","properties":{"reportId":{"description":"The identifier of the report.","type":"string"},"format":{"description":"The data format of the report.","type":"string","enum":["JSON","CSV"]},"statusDetails":{"description":" A human-readable description of the current status.","type":"string"},"location":{"description":"The URI address of the report.","type":"string"},"expiration":{"format":"int64","description":"The expiration time of the URI in the location property in milliseconds. The expiration time is the interval between the time the response was generated and the time the URI expires.","type":"integer"},"type":{"description":"The type of report.","type":"string","enum":["CAMPAIGN","INVENTORY","AUDIENCE","PRODUCTS","TECHNOLOGY","GEOGRAPHY"]},"status":{"description":"The build status of the report.","type":"string","enum":["IN_PROGRESS","SUCCESS","FAILURE"]}}}}}},"400":{"description":"Bad request","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"403":{"description":"Forbidden - Request failed because user does not have access to a specified resource.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"404":{"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"415":{"description":"415 - Unsupported Media Type","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"429":{"description":"Too Many Requests - Request was rate-limited. Retry later.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"500":{"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved..","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"502":{"description":"Bad Gateway Exception.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"503":{"description":"Service Unavailable Exception.","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}},"504":{"description":"Endpoint Request Timed-out Exception. This can be due to intermittent issue and can be retried","content":{"application/vnd.dsperror.v1+json":{"schema":{"description":"The error response object.","type":"object","required":["message"],"properties":{"requestId":{"description":"A unique identifier of the request.","type":"string"},"message":{"description":"A human-readable description of the response.","type":"string"},"errors":{"minItems":0,"maxItems":100,"description":"A list of errors. Please check the values in this field for report validation errors.","type":"array","items":{"description":"The sub-error object.","type":"object","required":["errorType","message"],"properties":{"field":{"description":"Request body field which is cause of the error.","type":"string"},"errorType":{"description":"Enumerated error type.","type":"string"},"message":{"description":"Detailed error description","type":"string"}}}}}}}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-Scope","description":"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. For DSP profiles, the `type` field of the `accountInfo` object must be set to `agency` and subType must not be `AMAZON_ATTRIBUTION`.","required":true},{"schema":{"type":"string"},"in":"header","name":"Amazon-Advertising-API-ClientId","description":"The client identifier. See [create API authorization and refresh tokens](https://advertising.amazon.com/API/docs/en-us/guides/get-started/retrieve-access-token) for more information. ","required":true},{"schema":{"type":"string"},"in":"path","name":"reportId","description":"The identifier of the requested report.","required":true}],"tags":["Reports"]}],"path":"/en-us/dsp/2-2/previous/openapi#tag/Reports/operation/getCampaignReportV2","sectionHeader":{"type":3,"text":"GET /dsp/reports/{reportId}"},"summary":"Gets the metadata of a report previously requested.","documentType":"api-reference"}],"toc-knowledge-hub":[{"title":"Knowledge hub overview","sectionHeader":null,"path":"/en-us/knowledge-hub/knowledge-hub-overview","content":[" The Amazon Ads Knowledge Hub is your central resource for building successful advertising solutions on Amazon. Whether you are an advertiser, partner, or developer, you will find curated content including technical blogs, hands-on workshops, and partner-contributed solutions to accelerate your Amazon Ads journey.\n","Blogs: Technical guides, best practices, and deep dives on conversion tracking, generative AI, partner solutions, and usage examples - Hands-on Workshops: Step-by-step, multi-module workshops with downloadable code to build real-world advertising solutions\n"],"documentType":"guide"},{"title":"Knowledge hub overview","sectionHeader":{"type":2,"text":"Featured Workshops"},"path":"/en-us/knowledge-hub/knowledge-hub-overview","content":["| # | Workshop | Duration | Level |\n","\\|---\\|---\\|---\\|---\\|\n","| 1 | Agents with Amazon Ads MCP Server — Build MCP servers, create LangGraph agents, deploy them to Amazon Bedrock AgentCore, and integrate with the Amazon Ads MCP Server. | ~4 hours | Intermediate |\n","| 2 | How to onboard first-party data to Amazon Ads using ADM — Onboard first-party data using the ADM API, and activate it across Amazon DSP and AMC. | ~3 hours | Intermediate |\n","| 3 | Multi-Agent Advertising Campaign Creation Workshop — Build and deploy a multi-agent advertising system using LangGraph, A2A protocol, and MCP servers. | ~3 hours | Intermediate |\n","| 4 | Amazon Ads Events API Implementation Workshop — Send conversion events to Amazon Ads with the Events API, from match key hashing to consent signals and batching. | ~3 hours | Intermediate |\n"],"documentType":"guide"},{"title":"Knowledge hub overview","sectionHeader":{"type":2,"text":"Featured Blogs"},"path":"/en-us/knowledge-hub/knowledge-hub-overview","content":["| # | Blog | Category |\n","\\|---\\|---\\|---\\|\n","| 1 | How Advertisers Increase Customer Satisfaction and Scale Using Amazon Ads API, Amazon Connect and Tealium — Integrate Amazon Connect, Tealium CDP, and Amazon Ads APIs to close the attribution gap between digital advertising and contact center conversions. | Partner |\n","| 2 | How Advertisers Optimize Audiences Using Conversion Events — Implement conversion tracking, measure campaign performance, and build targeted audiences using Amazon Ads Conversion APIs and AMC. | Conversion |\n","| 3 | AI Agents in Advertising — Discover AI-powered advertising solutions and automation with LLMs and Amazon Bedrock. | Generative AI |\n","| 4 | Step-by-Step Guide: Authorization for Amazon Ads API Requests Using Python — Practical guide for authenticating and authorizing Amazon Ads API requests using Python. | Usage Examples |\n","| 5 | Amazon Marketing Stream and Snowflake Integration — Integrate Amazon Marketing Stream with Snowflake for real-time data processing and advanced analytics. | Usage Examples |\n"],"documentType":"guide"},{"title":"Blog overview","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/overview","content":[" Explore technical guides, implementation patterns, and best practices for Amazon Ads API features. These blogs provide in-depth insights into optimizing your advertising campaigns through API integrations.\n"],"documentType":"guide"},{"title":"Blog overview","sectionHeader":{"type":2,"text":"Blog Categories"},"path":"/en-us/knowledge-hub/blogs/overview","content":["| # | Category | Description |\n","\\|---\\|---\\|---\\|\n","| 1 | Conversion | Implement conversion tracking using the Conversions API (CAPI), measure campaign performance, and improve attribution with first-party data. |\n","| 2 | Generative AI | Build AI-powered advertising solutions and automation using LLMs, Amazon Bedrock, and agentic architectures. |\n","| 3 | Amazon Ads Partner | Partner integrations, solution spotlights, and technical deep dives on building with Amazon Ads APIs. |\n","| 4 | Usage Examples | Step-by-step implementation guides covering authorization, data integration, media planning, and more. |\n"],"documentType":"guide"},{"title":"Blog overview","sectionHeader":{"type":2,"text":"All Blogs"},"path":"/en-us/knowledge-hub/blogs/overview","content":[],"documentType":"guide"},{"title":"Blog overview","sectionHeader":{"type":3,"text":"Conversion"},"path":"/en-us/knowledge-hub/blogs/overview","content":["| # | Blog | Description |\n","\\|---\\|---\\|---\\|\n","| 1 | Optimize Campaign using Conversion Events | Complete guide to implementing conversion tracking, measuring campaign performance, and building targeted audiences using Amazon Ads Conversion APIs and AMC. |\n","| 2 | How to test CAPI V2 API Integration | Practical guide for testing your Conversions API V2 integration end-to-end. |\n"],"documentType":"guide"},{"title":"Blog overview","sectionHeader":{"type":3,"text":"Generative AI"},"path":"/en-us/knowledge-hub/blogs/overview","content":["| # | Blog | Description |\n","\\|---\\|---\\|---\\|\n","| 1 | AI Agents in Advertising | Discover how to combine Amazon Bedrock foundation models with Amazon Ads APIs to build AI-powered agents that automate campaign management, reporting, and optimization. |\n"],"documentType":"guide"},{"title":"Blog overview","sectionHeader":{"type":3,"text":"Amazon Ads Partner"},"path":"/en-us/knowledge-hub/blogs/overview","content":["| # | Blog | Description |\n","\\|---\\|---\\|---\\|\n","| 1 | How Advertisers Increase Customer Satisfaction and Scale Using Amazon Ads API, Amazon Connect and Tealium | Integrate Amazon Connect, Tealium CDP, and Amazon Ads APIs to close the attribution gap between digital advertising and contact center conversions. |\n"],"documentType":"guide"},{"title":"Blog overview","sectionHeader":{"type":3,"text":"Usage Examples"},"path":"/en-us/knowledge-hub/blogs/overview","content":["| # | Blog | Description |\n","\\|---\\|---\\|---\\|\n","| 1 | Step-by-step guide: Authorizing Amazon Ads API requests using Python | Practical implementation guide for authenticating and authorizing Amazon Ads API requests using Python. |\n","| 2 | Streamline Amazon Marketing Stream Data Integration with Snowflake | Integrate Amazon Marketing Stream with Snowflake for real-time data processing and advanced analytics. |\n","| 3 | Ads + Selling Partner APIs Onboarding and Best Practices | Best practices for onboarding with both Amazon Ads and Selling Partner APIs. |\n","| 4 | A Tour of Media Planning with the Amazon Ads API | Explore campaign planning strategies, budget allocation, and media planning with the Amazon Ads API. |\n","| 5 | Audience Insights and Persona Builder Overview | Overview of audience insights and the Persona Builder tool for building targeted advertising strategies. |\n","| 6 | Amazon Retail Ad Service Integration Guide | Step-by-step guide for integrating with the Amazon Retail Ad Service API. |\n","| 7 | Sponsored Products & Brands Audience Bid Boosting | Learn how to implement audience bid boosting for Sponsored Products and Sponsored Brands campaigns. |\n"],"documentType":"guide"},{"title":"Conversion API Overview","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/conversion/overview","content":[" Learn how to leverage Amazon Ads Conversion APIs to track customer actions, measure campaign effectiveness, and optimize advertising performance using first-party data. These technical guides help you implement robust conversion tracking solutions that work in a privacy-first world.\n"],"documentType":"guide"},{"title":"Conversion API Overview","sectionHeader":{"type":2,"text":"What are Conversion APIs?"},"path":"/en-us/knowledge-hub/blogs/conversion/overview","content":[" Amazon Ads Conversion APIs enable advertisers to send conversion events directly from their servers to Amazon, providing accurate measurement of customer actions that occur off Amazon platforms. Unlike browser-based tracking, server-side conversion tracking through APIs offers:\n","Privacy-compliant measurement that works without third-party cookies - Improved data accuracy by bypassing browser restrictions and ad blockers - First-party data activation to enhance campaign optimization and attribution - Flexible event tracking for any customer action that matters to your business\n"],"documentType":"guide"},{"title":"Conversion API Overview","sectionHeader":{"type":2,"text":"Blogs"},"path":"/en-us/knowledge-hub/blogs/conversion/overview","content":["| # | Blog | Description |\n","\\|---\\|---\\|---\\|\n","| 1 | Optimize Campaign using Conversion Events | Complete guide to implementing conversion tracking, measuring campaign performance, and building targeted audiences using Amazon Ads Conversion APIs and Amazon Marketing Cloud. |\n","| 2 | How to test CAPI V2 API Integration | Practical guide for testing your Conversions API V2 integration end-to-end, including validation steps and troubleshooting. |\n"],"documentType":"guide"},{"title":"Conversion API Overview","sectionHeader":{"type":2,"text":"Related Workshop"},"path":"/en-us/knowledge-hub/blogs/conversion/overview","content":["| # | Workshop | Duration | Level |\n","\\|---\\|---\\|---\\|---\\|\n","| 1 | How to onboard first-party data to Amazon Ads using ADM — Onboard first-party data using the ADM API, and activate it across Amazon DSP and AMC. Includes conversion event tracking via Events Manager. | ~3 hours | Intermediate |\n"],"documentType":"guide"},{"title":"Conversion overview","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/conversion/conversion","content":[" by Chintan Sanghavi Lead Solutions Architect @ Amazon Ads, Mansi Pedgaonkar Sr. Product Manager at Amazon Ads on December 15th 2025\n"," Traditional tracking methods (like third-party cookies and pixels) are becoming unreliable due to evolving privacy regulations (such as iOS restrictions and ad blockers), leading to a significant \"signal loss\" that causes undercounting of conversions. This creates problems for advertisers such as: \n","Inaccurate Attribution: Advertisers struggle to know which specific ad interactions (clicks or views) actually lead to sales or leads, making it difficult to assess the true effectiveness of their ad spend across different channels (on and off Amazon).  Inefficient Optimization: Without a complete picture of conversions, algorithms receive poor training signals, which results in inefficient bidding, suboptimal ad targeting, and wasted ad budget on underperforming campaigns or audiences.  Fuzzy ROI: You cannot confidently calculate your true Return on Ad Spend (ROAS), making budget justification nearly impossible.\n"],"documentType":"guide"},{"title":"Conversion overview","sectionHeader":{"type":2,"text":"Solution Overview: Harnessing the power of First-Party Data"},"path":"/en-us/knowledge-hub/blogs/conversion/conversion","content":[" The primary purpose of conversion events is to measure the effectiveness of advertising efforts in achieving critical business objectives. They help bridge the gap between ad clicks and actual business outcomes, such as a purchase or a sign-up, allowing advertisers to see which marketing activities are driving real results. In the world of digital advertising, accurate conversion tracking is the cornerstone of effective campaign management and optimization. \n"," Conversion events are important because they provide tangible metrics for evaluating success, which allows advertisers to make informed decisions about their marketing strategy and budget allocation. Advertisers can leverage conversion events in several ways:\n","Performance Measurement: They help determine the success of specific campaigns, ad groups, or keywords in achieving business goals. For example, A retailer runs two Amazon Ads campaigns: one targeting mobile users and one targeting desktop users. By tracking the purchase conversion event for both, they discover the mobile campaign generates 3x the conversions, allowing them to shift more budget there.  Optimization and Bidding: Conversion data is used by automated bidding strategies of ad platforms (e.g., maximize conversions, target return on ad spend) to dynamically target the most relevant audience and maximize performance. For example, An advertiser wants to maximize sign-ups for a webinar. They use an automated bidding strategy in their ad platform set to \"maximize conversions,\" using the form submission as the key signal. The platform automatically bids higher for users most likely to fill out the form.  ROI and CPA Calculation: By tracking conversions, advertisers can accurately calculate key performance indicators like Return on Investment (ROI) and Cost Per Acquisition (CPA), ensuring they spend their budget wisely. For example, An online learning platform spends $5,000 on ads in one month and generates 100 course enrollments (conversions). They calculate the Cost Per Acquisition (CPA) is $50 per student, a key metric for budgeting and demonstrating value to stakeholders.\n"],"documentType":"guide"},{"title":"Conversion overview","sectionHeader":{"type":3,"text":"Amazon Ads Solutions"},"path":"/en-us/knowledge-hub/blogs/conversion/conversion","content":[" Amazon Ads offers comprehensive conversion tracking solutions for both on-Amazon and off-Amazon conversions. \n"," Amazon Ads distinguishes between two types of conversions. First, there are on-Amazon conversions, which occur within Amazon platforms such as Amazon.com, Twitch. These conversions, such as product purchases or add-to-cart actions, are automatically tracked and readily available to advertisers through both the Amazon Ads Console user interface and APIs. For those seeking deeper insights, these conversion metrics are also accessible via Amazon Marketing Cloud (AMC), enabling advanced analysis and reporting.\n"," The second category, off-Amazon conversions, addresses the need to track customer actions that take place outside of Amazon such as the digital properties of advertisers and social media. Amazon provides four distinct methods for tracking these off-platform conversions: \n","Amazon Advertising Tags (AAT) 2. Amazon Attribution Tags 3. Amazon Marketing Cloud (AMC) 4. Amazon Conversions API (CAPI). \n"," Each of these solutions is tailored to specific scenarios and business needs, offering advertisers the flexibility to choose the most suitable approach for their unique requirements.\n"],"documentType":"guide"},{"title":"Conversion overview","sectionHeader":{"type":2,"text":"Architecture Overview"},"path":"/en-us/knowledge-hub/blogs/conversion/conversion","content":[],"documentType":"guide"},{"title":"Conversion overview","sectionHeader":{"type":3,"text":"How to capture and send conversion events? "},"path":"/en-us/knowledge-hub/blogs/conversion/conversion","content":[" As shown in the diagram above, \n","Advertisers will create a campaign to display ads on Amazon platforms or on non-Amazon platforms. This campaign can be ads campaign or also email or social media campaigns. Now, the advertiser wants to measure the campaign’s performance and wants to optimize the current campaign or future campaigns.  2. Customers interact with campaigns, generating conversions on Amazon or off-Amazon platforms. Each platform will generate many events, conversion events, for example,  customer (buyer) has viewed the page, or added product in the cart or has purchased the product. For privacy and security, any personally identifiable information (PII) like email addresses should be hashed (converted into a secure, scrambled code using an algorithm like SHA-256) before being sent to Amazon. 3. Once events are captured,  4. Once events are available in events manager then all conversion events are sent for attribution as well as to AMC. Amazon internally matches the provided hashed identifiers against its own large database of pseudonymized user identifiers. If a match is found, Amazon checks if that user was exposed to one of your Amazon ad campaigns (clicked or viewed an ad) within a specific timeframe. The conversion is then attributed to the most relevant ad interaction based on a specific hierarchy (e.g., clicks are prioritized over views). \n"],"documentType":"guide"},{"title":"Conversion overview","sectionHeader":{"type":3,"text":"How to Use Conversion Events to Create Audiences"},"path":"/en-us/knowledge-hub/blogs/conversion/conversion","content":[" You can leverage your conversion event data to create highly targeted custom audiences for remarketing or prospecting in Amazon DSP.\n"," Via Amazon DSP (using the Events Manager) You can create rule-based audiences directly within the Amazon DSP console using the off-Amazon conversion events you've already defined and tracked.\n","Segment by Behavior: Create audiences based on specific actions (or lack thereof) on your properties. Examples include \"users who added to cart but did not purchase\" or \"users who signed up for a newsletter\".  Set Rules: Define the criteria for audience inclusion, such as the specific conversion event name and the time frame (lookback window, up to 365 days).  Activate: Once created, these audiences appear in your Amazon DSP advertiser account under \"Advertiser Audiences\" and can be applied to new ad groups just like other Amazon audiences. \n"," Via Amazon Marketing Cloud (AMC) For more sophisticated audience creation, you can use the AMC clean room environment:\n","Custom SQL Queries: Within AMC, you can write custom SQL queries to analyze your conversion data alongside Amazon data and build nuanced audience segments. This allows for complex filtering that goes beyond the basic rule builder in the DSP.  Audience Templates: Amazon provides instructional query (IQ) templates to simplify common audience creation tasks, such as creating audiences of users who \"clicked but not purchased\".  Push to DSP: After building your desired audience in AMC (which requires a minimum of 2,000 unique user IDs), you can push it directly to your linked Amazon DSP account for activation. \n"],"documentType":"guide"},{"title":"Conversion overview","sectionHeader":{"type":2,"text":"Conclusion"},"path":"/en-us/knowledge-hub/blogs/conversion/conversion","content":[" As privacy regulations continue to reshape digital advertising and traditional tracking methods become less reliable, conversion events represent a critical solution for maintaining accurate measurement and optimization capabilities. By leveraging first-party data through the comprehensive Amazon conversion tracking ecosystem, advertisers can overcome signal loss challenges while building more effective, targeted campaigns.\n"," The combination of the Amazon Conversions API (CAPI), Amazon Marketing Cloud (AMC), and Amazon DSP creates a powerful framework that enables advertisers to not only track conversions accurately but also transform that data into actionable audience insights. Whether you are looking to measure campaign performance, optimize bidding strategies, or create sophisticated remarketing audiences, conversion events provide the foundation for data-driven advertising success.\n"," To get started with conversion events, begin by identifying your key business objectives and the customer actions that matter most to your success. Then, implement the appropriate Amazon Ads solution—whether through server-side API integration, attribution tags, or direct AMC uploads—to start capturing and leveraging your valuable first-party conversion data.\n"],"documentType":"guide"},{"title":"Conversion overview","sectionHeader":{"type":3,"text":"About the authors"},"path":"/en-us/knowledge-hub/blogs/conversion/conversion","content":["| IMAGE | |\n","\\| --- \\| --- \\|\n","| Chintan SanghaviChintan is a lead solutions architect at Amazon Ads, driving innovation with Generative AI, AWS, and Amazon Ads solutions. He has extensive experience building complex multi-technology solutions. | Chintan Sanghavi |\n","| IMAGE | |\n","\\| --- \\| --- \\|\n","| Mansi PedgaonkarMansi is Senior Product Manager at Amazon Ads with extensive experience building advertising solutions across multiple companies. | Mansi Pedgaonkar |\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":[" by Chintan Sanghavi Lead Solutions Architect @ Amazon Ads on December 15th 2025\n"," This document outlines specific test scenarios and test cases for validating the Amazon Ads Conversion/Events API functionality.\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":2,"text":"Test Scenario #1: Test Consents Passed by Various Users"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":[" Description: Validate that the API correctly handles different types of consent mechanisms from users across different privacy frameworks.\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":3,"text":"Test Cases:"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":["Input: Event with Amazon consent object - Expected:  - Validation: API accepts Amazon-specific consent format\n","Input: Event with TCF consent string - Expected:  - Validation: API accepts IAB TCF v2.0 consent strings\n","Input: Event with GPP consent string - Expected:  - Validation: API accepts Global Privacy Platform consent strings\n","Input: Event without consent object - Expected: Event processed without consent fields - Validation: API handles events from users who have not provided consent\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":2,"text":"Test Scenario #2: Test Events from Different Platforms/Sources"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":[" Description: Validate that events from various platforms and sources are correctly processed and categorized.\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":3,"text":"Test Cases:"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":["Input: Event with eventSource: ANDROID - Expected: Dataset name includes Android (e.g., SubscribeAndroidDataset0190) - Validation: Android app events are properly tracked\n","Input: Event with eventSource: IOS - Expected: Dataset name includes Ios (e.g., CheckoutIosDataset0190) - Validation: iOS app events are properly tracked\n","Input: Event with eventSource: FIRE_TV - Expected: Dataset name includes FireTv (e.g., PageViewFireTvDataset0190) - Validation: Fire TV events are properly tracked\n","Input: Event with eventSource: WEBSITE - Expected: Dataset name includes Website (e.g., LeadWebsiteDataset0190) - Validation: Web-based events are properly tracked\n","Input: Event with eventSource: OFFLINE - Expected: Dataset name includes Offline (e.g., ContactOfflineDataset0190) - Validation: Offline conversion events are properly tracked\n","Input: Events with other event sources (ANDROID, IOS, WEBSITE, etc.) - Expected:  - Validation: Non-attribution events do not include unnecessary fields\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":2,"text":"Test Scenario #3: Test Different Conversion Types"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":[" Description: Validate that various customer actions/conversions are correctly categorized and processed.\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":3,"text":"Test Cases:"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":["Input: Events with conversionType: OFF_AMAZON_PURCHASES - Expected:  - Validation: Off-Amazon purchase events include monetary data\n","Input: Events with conversionType: CHECKOUT or ADD_TO_SHOPPING_CART - Expected:  - Validation: E-commerce events exclude monetary data\n","Input: Events with conversionType: LEAD, CONTACT, SIGN_UP - Expected:  - Validation: Non-purchase events exclude monetary data\n","Input: Events with conversionType: PAGE_VIEW, SEARCH, APPLICATION - Expected:  - Validation: Engagement events are properly tracked\n","Input: Events with conversionType: SUBSCRIBE - Expected:  - Validation: Subscription events are properly categorized\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":2,"text":"Test Scenario #4: Test Global Market Coverage"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":[" Description: Validate that events from users across different countries/regions are properly handled.\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":3,"text":"Test Cases:"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":["Input: Events with countryCode: US, CA, MX - Expected: Events processed with correct country identification - Validation: North American market events are tracked\n","Input: Events with countryCode: DE, FR, GB, IT - Expected: Events processed with correct country identification - Validation: European market events are tracked\n","Input: Events with countryCode: JP, IN, CN, SG - Expected: Events processed with correct country identification - Validation: Asian market events are tracked\n","Input: Events with countryCode: BR, ZA, AU, AE - Expected: Events processed with correct country identification - Validation: Emerging market events are tracked\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":2,"text":"Test Scenario #5: Test Custom Data Handling"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":[" Description: Validate that optional custom data fields are properly processed when provided by advertisers.\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":3,"text":"Test Cases:"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":["Input: Event including customData array with profit and category fields - Expected:  - Validation: Additional advertiser data is captured\n","Input: Event without customData field - Expected: Event processed successfully without custom fields - Validation: Custom data is truly optional\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":2,"text":"Test Scenario #6: Test Dataset Name Compliance"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":[" Description: Validate that generated dataset names meet Amazon naming requirements and constraints.\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":3,"text":"Test Cases:"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":["Input: Various conversion type and event source combinations - Expected: Dataset names match pattern ^\\[A-Za-z]\\[A-Za-z0-9\\_-]{0,99}$ - Validation: All generated names are compliant\n","Input: Longest possible combination of conversion type + event source + program ID - Expected: Dataset name ≤ 100 characters - Validation: Names do not exceed maximum length\n","Input: Dataset names with special characters from event sources - Expected: Only letters, numbers, underscores, and hyphens in final name - Validation: Invalid characters are properly handled\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":2,"text":"Test Scenario #7: Test API Error Handling"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":[" Description: Validate that the system properly handles and logs various API error conditions.\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":3,"text":"Test Cases:"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":["Input: Events with invalid field formats or missing required fields - Expected: 400 Bad Request with descriptive error message - Validation: Input validation errors are properly reported\n","Input: High volume of requests exceeding rate limits - Expected: 429 Too Many Requests response - Validation: Rate limiting is properly enforced and handled\n","Input: Requests during API maintenance or outages - Expected: 5xx server error responses with proper logging - Validation: Server-side errors are captured and logged\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":2,"text":"Success Criteria"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":["All test scenarios pass with expected API responses - Complete request and response logging for audit trails - Proper error handling and recovery mechanisms - Compliance with Amazon Ads API specifications - Coverage of all supported conversion types, event sources, and optional fields\n"],"documentType":"guide"},{"title":"CAPI V2 Testing overview","sectionHeader":{"type":3,"text":"About the authors"},"path":"/en-us/knowledge-hub/blogs/conversion/capi_v2_testing","content":["| IMAGE | |\n","\\| --- \\| --- \\|\n","| Chintan SanghaviChintan is a lead solutions architect at Amazon Ads, driving innovation with Generative AI, AWS, and Amazon Ads solutions. He has extensive experience building complex multi-technology solutions. | Chintan Sanghavi |\n"],"documentType":"guide"},{"title":"From Signals to Outcomes - Why First-Party Data Is the Strategic Backbone of Advertising","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/conversion/from-signals-to-outcomes","content":[" by Mansi Pedgaonkar Sr. Product Manager Tech at Amazon Ads on July 15th 2026\n"," Today, the path from awareness to purchase is increasingly fragmented. Customers move across streaming, retail, mobile, social, search, and offline experiences, often interacting with a brand many times before making a decision. A customer may discover a product while watching streaming TV, research it later on a mobile device, compare options on a marketplace, visit a store, and complete the purchase days or weeks later. This creates a more complex marketing reality: the right audience are harder to identify and engage consistently, relevance is harder to sustain, and business impact is harder to measure with confidence. First-party data is emerging as one of the most important answers to that challenge.\n"],"documentType":"guide"},{"title":"From Signals to Outcomes - Why First-Party Data Is the Strategic Backbone of Advertising","sectionHeader":{"type":2,"text":"First-party data is a growth advantage"},"path":"/en-us/knowledge-hub/blogs/conversion/from-signals-to-outcomes","content":[" First-party data gives companies a clearer view of customer intent, value, and behavior. Signals from customer service calls, sales interactions, app engagement, and website behavior together help gain a multidimensional view of the customer. These signals reveal intent, satisfaction, lifecycle stage, and future potential in ways that transactional data alone cannot. It can improve audience relevance, campaign optimization, measurement, and personalization.\n"," When brands use their own customer relationships responsibly, they can understand customer intent more clearly, personalize experiences more effectively, and measure business outcomes with greater confidence. This creates a stronger value exchange between the customer and the brand. Customers share information through their interactions, purchases, preferences, and engagement. In return, they expect more relevant experiences, fewer wasted messages, and better service. When brands honor that exchange, first-party data becomes a durable asset. It helps marketers move from broad targeting to precision engagement, from fragmented reporting to outcome-based measurement, and from one-time campaigns to long-term customer growth.\n"," Every customer interaction creates a signal. A product view, a streaming session, a search, an app install, an in-store purchase, a subscription renewal, a customer service call, or a loyalty interaction can all reveal something useful about customer intent. The challenge is not simply collecting more signals. The challenge is making those signals usable.\n"," For marketers, the most valuable signals are the ones that can be connected, governed, analyzed, and activated across the marketing funnel. That requires both customer data and advertising technology to work together. This is where first-party data becomes especially powerful when paired with unique browsing, streaming and shopping signals from Amazon and its interoperable ad tech.\n"," Amazon Ads brings together three critical elements: your first-party data, the exclusive signals from Amazon derived from trillions of shopping, browsing, and streaming interactions across Amazon.com, Prime Video, Audible, Whole Foods, Twitch, and more, plus strategic partnerships with data collaboration platforms. Brand first-party data may show who the customers are, what they have purchased, how they have interacted, and where they sit in the buying journey. This data forms the foundation for full-funnel advertising. By combining this data with signals from Amazon in privacy-safe environments such as Amazon Marketing Cloud, advertisers can develop a deeper understanding of their customers and uncover new opportunities. They can then build lookalike audiences to extend their reach beyond known customers across Amazon owned properties and the open internet. Amazon Ads applies these signals across audience expansion, bidding, measurement, and campaign optimization. The result is not simply better targeting, but a more intelligent advertising system.\n"],"documentType":"guide"},{"title":"From Signals to Outcomes - Why First-Party Data Is the Strategic Backbone of Advertising","sectionHeader":{"type":2,"text":"A modern ads system works across four pillars"},"path":"/en-us/knowledge-hub/blogs/conversion/from-signals-to-outcomes","content":[" Effective first-party data activation requires more than just data. It requires an integrated technology stack. Amazon Ads has built this around four core pillars: connect, control, analyze, and activate.\n"," Connect. Brands need flexible ways to bring data into Amazon Ads. This includes direct integrations with customer data platforms, conversion APIs, audience APIs, tags, clean rooms, bulk uploads, file uploads, and partner connectors.\n"," Control. Ads Data Manager ensures governance by giving advertisers control over how their data is accessed, used, diagnosed, and deleted. This is especially important as marketing, technology, analytics, legal, and data stewardship teams work more closely together.\n"," Analyze. Advertiser first-party data becomes more valuable when it can be joined with advertising signals from Amazon in privacy-safe environments. Amazon Marketing Cloud clean rooms and analytics environments allow advertisers to measure reach, frequency, conversion paths, customer lifetime value, and off-platform outcomes with more precision.\n"," Activate. The final step is using those insights to improve campaign performance. First-party data can support audience creation, suppression strategies, lookalike modeling, cross-sell, upsell, retention, AI-powered bidding, and full-funnel optimization through Amazon DSP and Sponsored Ads.\n"," The strongest marketers do not treat these as separate capabilities. They build a connected operating model where data can move from ingestion to insight to activation and back into learning.\n"],"documentType":"guide"},{"title":"From Signals to Outcomes - Why First-Party Data Is the Strategic Backbone of Advertising","sectionHeader":{"type":2,"text":"Conversion data turns into a durable performance signal"},"path":"/en-us/knowledge-hub/blogs/conversion/from-signals-to-outcomes","content":[" One of the most important parts of a first-party data strategy is conversion data. Audience data helps marketers understand who they may want to reach. Conversion data helps advertisers understand what actually happened after media exposure. That is where Events API becomes strategically important.\n"," Events API allows advertisers to send conversion events directly from their own systems into an advertising system. These events may include purchases, leads, app installs, subscriptions, renewals, sign-ups, in-store transactions, call-center outcomes, or other business-defined actions. Unlike browser-only tracking, server-side conversion signals can be more durable, more complete, and more aligned to the actual source of truth for the advertiser.\n"," This matters because customer journeys often span multiple sessions, devices, and channels over days or weeks. Without a way to onboard downstream events like offline purchases, call center conversions, or delayed sign-ups, the advertiser sees only part of the journey. With Events API, advertisers can bring more of the journey back into measurement and optimization.\n"," Events API helps marketers in three important ways:\n","Improve measurement: Marketers can connect media activity to business outcomes that may not be visible through pixel-based tracking alone. This includes offline sales, delayed conversions, app events, or CRM-based outcomes. 2. Improve optimization: When conversion signals flow back into bidding and campaign systems, machine learning models can optimize toward higher-quality outcomes, not just clicks or shallow engagement events. 3. Improve resilience: As the industry moves toward more privacy-conscious and signal-limited environments, marketers need first-party, consented, server-side data flows that are less dependent on fragile third-party identifiers.\n"," In practice, Events API moves conversion data from being a reporting artifact to being an optimization asset. It allows marketers to say: this is the outcome that matters to my business, and I want my media investment to learn from it.\n"],"documentType":"guide"},{"title":"From Signals to Outcomes - Why First-Party Data Is the Strategic Backbone of Advertising","sectionHeader":{"type":2,"text":"First-party data strengthens every stage of the funnel"},"path":"/en-us/knowledge-hub/blogs/conversion/from-signals-to-outcomes","content":[" First-party data can strengthen every stage of the funnel. A completed purchase, a financing inquiry, a product comparison, and a newsletter signup each reveal different levels of intent and future conversion potential. While a completed purchase signals conversion for measurement systems, signals earlier in the customer journey are equally valuable. A customer researching mortgage options, comparing vehicle features, or configuring a high-consideration purchase may provide stronger indicators of future intent than a completed low-value transaction.\n"," First-party data can support the customer journey from initial discovery through conversion and retention. Marketers can begin by using seed audiences to reach new customers who resemble their highest-value existing customers, while suppressing recent purchasers to avoid inefficient acquisition spend. As customers engage with the brand, behavioral and engagement signals can help identify those actively considering a category, product, or service, enabling more relevant messaging and higher-quality traffic. Closer to conversion, marketers can optimize toward outcomes such as revenue, return on ad spend, app installs, subscriptions, leads, or offline purchases. The same data can also extend beyond acquisition by helping identify customers approaching renewal, at risk of churn, or ready for cross-sell and upsell opportunities.\n"," Across all stages, first-party data helps marketers shift from generic campaign execution to customer-aware marketing.\n"],"documentType":"guide"},{"title":"From Signals to Outcomes - Why First-Party Data Is the Strategic Backbone of Advertising","sectionHeader":{"type":2,"text":"Interoperability and signal quality in an agentic advertising era"},"path":"/en-us/knowledge-hub/blogs/conversion/from-signals-to-outcomes","content":[" As the industry races toward agentic advertising and autonomous campaign management, a fundamental challenge remains unresolved: the quality of the data powering these systems. Today, AI agents can manage budgets, optimize campaigns, and orchestrate workflows. Yet the AI-driven automation is only as effective as the signals it receives. The next generation of advertising systems will require a deeper understanding of signal quality and customer intent. This creates an opportunity to go beyond simply tracking events and move towards richer, multidimensional signals.\n"," In addition to the event itself, marketers can incorporate contextual custom attributes such as customer value, engagement level, category affinity, purchase frequency, and intent strength. These dimensions help models better understand not just what happened, but what is likely to happen next.\n"," As AI reshapes advertising, the real differentiator will be the ability to easily onboard high-quality first-party data and effectively use it in campaign tactics. Ads Data Manager connector library enables integration across customer data platforms, identity partners, clean rooms, APIs, ad platforms, measurement tools, and internal business systems. The goal is not to move data everywhere without control. The goal is to make high-quality data usable in the right places, with the right governance, for the right business purpose. This is why first-party data strategy is no longer just a marketing operations topic. It sits at the intersection of product, data infrastructure, privacy, AI, measurement, and business strategy.\n"," As you evaluate your first-party data strategy, consider three questions: How complete is your view of the customer journey? How effectively are you using that data to identify the right audience, optimize campaigns, and measure business outcomes? And are your systems connected well enough to turn insights into action? The answers will reveal where to invest next.\n"," In the next blog post of our series, we will explore how data practitioners can leverage Ads Data Manager to connect and unlock the power of their first-party data.\n"],"documentType":"guide"},{"title":"From Signals to Outcomes - Why First-Party Data Is the Strategic Backbone of Advertising","sectionHeader":{"type":3,"text":"About the authors"},"path":"/en-us/knowledge-hub/blogs/conversion/from-signals-to-outcomes","content":["| IMAGE | |\n","\\| --- \\| --- \\|\n","| Mansi PedgaonkarMansi is Sr. Product Manager Tech at Amazon Ads, she leads advertiser data integrations with focus on building products that enable AI-assisted workflows and decisioning on top of complex, imperfect, and constrained data. | Mansi Pedgaonkar |\n"],"documentType":"guide"},{"title":"Generative AI in Amazon Ads","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/genai/overview","content":[" Discover how to integrate Generative AI and Large Language Models (LLMs) with Amazon Ads APIs to transform your advertising workflows. From building AI agents that automate campaign management to deploying MCP servers on Amazon Bedrock AgentCore, these resources cover practical applications of AI for advertising.\n"],"documentType":"guide"},{"title":"Generative AI in Amazon Ads","sectionHeader":{"type":2,"text":"Blogs"},"path":"/en-us/knowledge-hub/blogs/genai/overview","content":["| # | Blog | Description |\n","\\|---\\|---\\|---\\|\n","| 1 | AI Agents in Advertising | Discover how to combine Amazon Bedrock foundation models with Amazon Ads APIs to build AI-powered agents that automate campaign management, reporting, and optimization. |\n"],"documentType":"guide"},{"title":"Generative AI in Amazon Ads","sectionHeader":{"type":2,"text":"Related Workshops"},"path":"/en-us/knowledge-hub/blogs/genai/overview","content":["| # | Workshop | Duration | Level |\n","\\|---\\|---\\|---\\|---\\|\n","| 1 | Agents with Amazon Ads MCP Server — Build MCP servers, create LangGraph agents, deploy them to Amazon Bedrock AgentCore, and integrate with the Amazon Ads MCP Server. | ~4 hours | Intermediate |\n","| 2 | Multi-Agent Advertising Campaign Creation Workshop — Build and deploy a multi-agent advertising system using LangGraph, A2A protocol, and MCP servers with orchestration, RAG, and a chat frontend. | ~3 hours | Intermediate |\n"],"documentType":"guide"},{"title":"AI Agents in Advertising","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/genai/gen-ai-amazon-ads","content":[" by Chintan Sanghavi Lead Solutions Architect @ Amazon Ads: December 27th 2025\n"],"documentType":"guide"},{"title":"AI Agents in Advertising","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/blogs/genai/gen-ai-amazon-ads","content":[" Advertisers execute several key activities to create and optimize successful campaigns. For example, analysis of past campaign performance, brand guidelines, creative effectiveness, audience creation, targeting, media selection and finally campaign setup in Amazon Ads console.\n"," Once the campaigns are created, advertisers need to obtain performance measurement data to optimize campaigns based on data insights.  \n"," To create an agentic AI system, the advertiser has to consider many aspects such as how to create a modular system, how many agents should they create, how to provide accurate answers, how to validate the response and actions taken by an agent etc. These can be complex and time-consuming tasks. \n"," The objective of this blog is to provide an approach to build an agentic AI system. The final solution depends on the requirements of the advertiser, existing applications etc. \n"],"documentType":"guide"},{"title":"AI Agents in Advertising","sectionHeader":{"type":2,"text":"Solution Overview"},"path":"/en-us/knowledge-hub/blogs/genai/gen-ai-amazon-ads","content":[" To implement an agentic AI system, as shown above in the diagram, advertisers can implement a hierarchical multi-agent architecture with a central orchestrator. This system uses a main Router Agent to direct user queries to specialized agents based on their expertise. This approach delivers a unified user experience while maximizing domain-specific knowledge and tools. The system will run on Amazon Bedrock and Amazon Bedrock AgentCore to meet security, scalability, and performance requirements.\n"," This architecture offers several advantages:  - Independent agent development and deployment allows advertisers to select agents that fit their enterprise needs  - Incremental development enables advertisers to start with basic capabilities and expand over time  - Faster production deployment through the built-in security and scalability features of Amazon Bedrock AgentCore  - Agent monetization opportunities through the Agentic Marketplace, where other advertisers can purchase and use your agents.\n"," The architecture will be composed of the following key layers and components:\n","User Interface (UI) Layer: A unified interface where users submit their queries. The user interacts only with the main system, not the individual sub-agents directly. \n","Orchestration/Routing Layer: This is the core of the system, managed by the Router Agent (or orchestrator). Router Agent (Main Agent): This LLM-based agent is responsible for:\n","Domain Agents Layer: These are the individual, specialized support agents, each acting as an independent microservice. The examples of Specialized Agents are 1/ Audience Agent 2/ Measurement Agent. Each agent is tightly scoped to a specific task or knowledge domain to reduce hallucinations and increase accuracy.  - Communication: Agents will communicate with each other using Agent2Agent (A2A) protocol for collaboration and use Model Context Protocol (MCP) for tool use.  - Discover Capabilities: Agents publish \"Agent Cards\" (structured metadata) that the Router Agent uses to dynamically discover which agent handles which domain. - Manage Tasks: A2A defines a clear lifecycle for tasks (submitted, working, completed, etc.), allowing the Router Agent to monitor progress on long-running requests and manage stateful interactions across different agents.\n","Private Knowledge Bases (Vector DBs): The specialized agent may have access to its own dedicated, domain-specific knowledge base (vector database) via Retrieval-Augmented Generation (RAG). This ensures they provide accurate, relevant information for their area. \n","Tool Integration: Agents will use specific tools or APIs to perform actions, such as creating audiences or creation of campaigns. \n","Infrastructure and Operations Layer:  Use of containerization (e.g., Docker containers) to deploy agents as microservices, allowing them to scale dynamically based on demand. This will help us to deploy agents on Amazon Bedrock AgentCore and if needed outside of AgentCore to Amazon EKS or Amazon ECS. \n","Security, Monitoring and Observability: Robust logging and monitoring tools to track router performance, identify failure points, and ensure compliance and security. It should have enterprise-grade security features like JWT and OAuth 2.0 for authentication, ensuring only authorized agents participate in the workflow.\n","Human-in-the-Loop (HITL) Governance: A mechanism for seamless handoff to a human for complex or sensitive cases that the AI system cannot complete or requires Human approval.  \n","Memory Management and Storage: Memory is handled at different levels to maintain context and provide long-term knowledge access. \n"],"documentType":"guide"},{"title":"AI Agents in Advertising","sectionHeader":{"type":2,"text":"Interaction Workflow"},"path":"/en-us/knowledge-hub/blogs/genai/gen-ai-amazon-ads","content":["A user submits a query via the UI. 2.\tThe Router Agent analyzes the intent and context. 3.\tThe Router Agent selects the appropriate Domain Agent based on its analysis and the capability registry. 4.\tThe selected Domain Agent uses RAG or invokes tool to retrieve information and generates a response. 5.\tThe Router Agent receives the response and presents it to the user. 6.\tIf the next query from the user changes topics, the Router Agent seamlessly routes to a different Domain Agent, maintaining continuity. \n"],"documentType":"guide"},{"title":"AI Agents in Advertising","sectionHeader":{"type":2,"text":"Summary"},"path":"/en-us/knowledge-hub/blogs/genai/gen-ai-amazon-ads","content":[" Agentic AI and generative AI are an evolving space, and can drastically change the way advertisers are working today. They have the potential to increase productivity significantly and increase return on investment (ROI) on advertising spend. \n"," Generative AI technologies like Amazon Bedrock AgentCore, Strands, the choice of LLM model etc are critical components of building Agentic AI systems. \n"," The goal of the above architecture is to accelerate the development and creation of agentic AI applications. \n"," Amazon Ads and technology partners of Amazon Ads have created pre-built MCP servers and agents to help advertisers to build Agentic AI systems. \n"],"documentType":"guide"},{"title":"AI Agents in Advertising","sectionHeader":{"type":3,"text":"About the authors"},"path":"/en-us/knowledge-hub/blogs/genai/gen-ai-amazon-ads","content":["| IMAGE | |\n","\\| --- \\| --- \\|\n","| Chintan SanghaviChintan is a lead solutions architect at Amazon Ads, driving innovation with Generative AI, AWS, and Amazon Ads solutions. He has extensive experience building complex multi-technology solutions. | Chintan Sanghavi |\n"],"documentType":"guide"},{"title":"Amazon Ads Partner Solutions","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/partners/overview","content":[" Discover how advertising partners leverage Amazon Ads APIs to build innovative solutions that help advertisers succeed. These technical guides provide insights into partner integration patterns, best practices, and strategies for creating value-added services on top of Amazon Ads.\n"],"documentType":"guide"},{"title":"Amazon Ads Partner Solutions","sectionHeader":{"type":2,"text":"Who are Amazon Ads Partners?"},"path":"/en-us/knowledge-hub/blogs/partners/overview","content":[" Amazon Ads partners are technology providers, agencies, and solution builders who help advertisers create efficient advertising solutions. Partners use Amazon Ads APIs to:\n","Build campaign management platforms that simplify advertising operations across multiple marketplaces - Develop optimization tools that automate bidding, budgeting, and performance improvements - Create analytics solutions that provide deeper insights into advertising performance and ROI - Offer managed services that combine technology and expertise to drive advertiser success\n"],"documentType":"guide"},{"title":"Amazon Ads Partner Solutions","sectionHeader":{"type":2,"text":"Featured Blogs"},"path":"/en-us/knowledge-hub/blogs/partners/overview","content":["| # | Blog | Description |\n","\\|---\\|---\\|---\\|\n","| 1 | How Advertisers Increase Customer Satisfaction and Scale Using Amazon Ads API, Amazon Connect and Tealium | Learn how integrating Amazon Connect, the real-time CDP of Tealium, and Amazon Ads APIs closes the attribution gap between digital advertising and contact center conversions — enabling offline conversion tracking, agent context enrichment, and first-party audience activation. \n"],"documentType":"guide"},{"title":"How Advertisers Increase Customer Satisfaction and Scale Using Amazon Ads API, Amazon Connect and Tealium","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/partners/How-Advertisers-Increase-Customer","content":[" by Chintan Sanghavi, Steve Berliner, Pyone Thant Win, Josh Wolf\n"],"documentType":"guide"},{"title":"How Advertisers Increase Customer Satisfaction and Scale Using Amazon Ads API, Amazon Connect and Tealium","sectionHeader":{"type":2,"text":"**The $50,000 Phone Call You Cannot Measure**"},"path":"/en-us/knowledge-hub/blogs/partners/How-Advertisers-Increase-Customer","content":[" A customer browses your website after clicking your Sponsored Products ad. They add items to their cart worth $500 but hesitate on a high-consideration purchase. Instead of checking out, they call your contact center to ask questions. The agent answers their questions, and the customer places a $2,000 order over the phone. Over the next 12 months, that customer generates $50,000 in lifetime value. Yet advertising reports show $0 in revenue from the ad click that started this journey.\n"," This disconnection between contact centers and advertising systems creates three problems. First, agents answer calls without seeing recent ad interactions, browsing behavior, or purchase history, forcing customers to repeat information and extending handle times. Second, marketers cannot measure offline conversions like phone sales or appointment bookings, causing them to cut budgets on ads that drive high-value phone conversions. Third, valuable audience segments from contact center interactions—high-intent inquiries, successful upsells, satisfaction scores—cannot be used to target advertising campaigns, suppress ads to customers who converted by phone, or retarget callers who did not complete purchases. Agents lack context to resolve issues quickly, and advertisers optimize campaigns using incomplete data.\n"," You are not alone. Roughly 40% of advertisers view the inability to achieve closed-loop measurement between online advertising and offline conversions as a major concern. This gap prevents accurate return on investment (ROI) measurement, limits audience insights, and creates suboptimal customer experiences across channels.\n"," This changes when you bring together Amazon Connect, the Tealium real-time Customer Data Platform (CDP), and the Amazon Ads API—specifically its Events API and Ads Data Manager capabilities. The result is a cohesive solution that unifies ad performance data, first-party customer context, contact center intelligence, and real-time activation across digital and human touchpoints.\n"," Integrating Amazon Connect with the Tealium Customer Data Platform (CDP) and Amazon Ads closes the attribution gap between digital advertising and contact center conversions. This architecture enables bidirectional data flow across advertising, web properties, and contact center systems through APIs, eliminating point-to-point integrations. Business outcomes include tracking offline conversions (phone orders, calls) as first-party signals in Amazon Ads, equipping agents with customer browsing history and propensity scores before answering calls, building advertising audiences from contact center interactions (high-value callers, product inquiries), and personalizing Interactive Voice Response (IVR) menus based on real-time behavioral signals. Technical teams gain a scalable solution that reduces average handle time, improves first contact resolution, and optimizes advertising budgets with complete conversion data.\n"],"documentType":"guide"},{"title":"How Advertisers Increase Customer Satisfaction and Scale Using Amazon Ads API, Amazon Connect and Tealium","sectionHeader":{"type":2,"text":"**The Solution: A Unified Architecture**"},"path":"/en-us/knowledge-hub/blogs/partners/How-Advertisers-Increase-Customer","content":[" Figure 1 Architecture Overview\n"," This solution integrates Tealium, Amazon Connect, and Amazon Ads to create a closed-loop system that connects advertising, customer data, and contact center operations.\n"," Tealium serves as the real-time data hub, ingesting first-party signals from websites, mobile apps, Customer Relationship Management (CRM) systems, contact centers, and advertising platforms. It builds unified customer profiles and segments that update in real time as customer behaviors change. Tealium provides native integrations with both Amazon Connect and Amazon Ads APIs, creating a solution without custom middleware.\n","When a customer clicks an ad, browses products, abandons their cart, and calls the contact center, Amazon Connect queries the unified customer profile API of Tealium and retrieves their advertising exposures, cart contents, browsing history, and purchase propensity within 200 milliseconds. The call center agent sees this context before greeting the customer, enabling them to address questions without requiring the customer to repeat information. This reduces handle time by 50% and increases conversion rates.  Tealium maintains real-time segments such as \"High-Value Recent Ad Clicker\" and \"Cart Abandoner Over $500\" that feed into the routing rules of Amazon Connect. When a customer in the high-value segment calls, Amazon Connect routes them to a specialized sales team. When a customer in the product support segment calls, they route to technical specialists. This improves first contact resolution rates because the right agent handles each inquiry. The Interactive Voice Response (IVR) system of Amazon Connect personalizes dynamically based on Tealium data. A caller who interacted with ads for commercial products hears menu options focused on business solutions. A returning customer who contacted support receives an IVR option to continue their conversation about their recent order.  The real-time behavioral tracking of Tealium detects patterns that signal customer confusion or intent to abandon. When a customer spends eight minutes on a product comparison page, views the FAQ section, and returns without adding to cart, Tealium triggers a personalized web experience offering a click-to-callback option. The customer enters their phone number, and Amazon Connect routes the callback to an agent with context about what product the customer was comparing.\n"," Tealium’s integration with Ads Data Manager (ADM) brings first-party audience data into the advertising ecosystem for targeting. Tealium creates audience segments based on unified data—for example \"Phone Purchasers - Last 30 Days\" (customers who bought via phone)—and syncs these segments to Amazon Ads via ADM. The integration sends hashed customer identifiers and segment membership to ADM, where they become first-party audiences available for activation. First-party audiences from contact center data provide high-quality targeting signals. These audiences convert at higher rates than broad targeting because they are based on demonstrated intent and real customer interactions. You can use this audience data for audience suppression (stop showing ads to customers who purchased via phone), retargeting audiences (show ads to customers who called with high intent but did not complete a purchase), lookalike audiences (use phone purchasers or high-satisfaction customers as seed audiences to find similar users), and personalized messaging (tailor ad creative based on contact center interaction type). This enables you to refine targeting and optimize campaigns. \n"],"documentType":"guide"},{"title":"How Advertisers Increase Customer Satisfaction and Scale Using Amazon Ads API, Amazon Connect and Tealium","sectionHeader":{"type":2,"text":"**Key Benefits**"},"path":"/en-us/knowledge-hub/blogs/partners/How-Advertisers-Increase-Customer","content":[" The native Tealium integration with Amazon Ads and Amazon Connect delivers three core benefits:\n"," First, offline calls become first-party conversion signals in advertising reports. Advertisers see complete downstream outcomes from digital campaigns, eliminating performance blind spots. Campaign optimization uses complete data instead of partial signals. This enables advertisers to suppress ads to converted customers, retarget engaged prospects who did not convert, and build lookalike audiences based on high-value phone purchasers.\n"," Second, customer experiences remain consistent across channels. Agents, ads, web personalization, and Interactive Voice Response (IVR) menus reflect the same real-time signals. Customers do not repeat themselves, and journeys feel cohesive.\n"," Third, efficiency increases while costs decrease. Agents spend less time collecting context and more time solving problems. Customers experience fewer transfers and repeats. Average handle time decreases, first contact resolution increases, and advertising budgets optimize based on true conversion paths, improving Return on Ad Spend (ROAS).\n"],"documentType":"guide"},{"title":"How Advertisers Increase Customer Satisfaction and Scale Using Amazon Ads API, Amazon Connect and Tealium","sectionHeader":{"type":2,"text":"**Conclusion**"},"path":"/en-us/knowledge-hub/blogs/partners/How-Advertisers-Increase-Customer","content":[" The gap between contact centers and advertising systems has been a persistent challenge in marketing measurement and customer experience. Customers expect seamless journeys, but legacy architectures create fragmented, siloed interactions.\n"," Bringing together Amazon Connect, the real-time CDP of Tealium, and Amazon Ads APIs transforms how organizations respond to customer behavior and measure success. Contact center systems no longer sit outside your advertising ecosystem—they enhance it with authenticated offline signals that improve targeting, measurement, and customer experience.\n"," As privacy constraints and cookieless realities make first-party data more important than ever, this architecture ensures your teams use the most complete, accurate, and actionable view of the customer across every channel, every touchpoint, and every conversion.\n"," The result is better advertising performance, happier customers, more efficient operations, and a competitive advantage built on unified data and real-time action.\n"],"documentType":"guide"},{"title":"How Advertisers Increase Customer Satisfaction and Scale Using Amazon Ads API, Amazon Connect and Tealium","sectionHeader":{"type":2,"text":"**Getting Started**"},"path":"/en-us/knowledge-hub/blogs/partners/How-Advertisers-Increase-Customer","content":[" For Advertisers: Contact Tealium to discuss how this solution can integrate with your existing Amazon Ads campaigns and contact center infrastructure. Tealium’s team will work with you to map data flows, configure integrations, and activate your first audience.\n"," For Technical Teams: Review the technical documentation for:\n","Amazon Ads Events API  Amazon Ads Data Manager  Amazon Connect APIs \\* Tealium Integration Documentation\n"," Learn More:\n","Explore Amazon Ads API Documentation  Learn about Amazon Connect  Discover the Tealium CDP Platform\n"],"documentType":"guide"},{"title":"Usage Examples","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/usage-examples/overview","content":[" Step-by-step implementation guides that walk you through real-world Amazon Ads API use cases — from authorization and data integration to media planning and audience insights.\n"],"documentType":"guide"},{"title":"Usage Examples","sectionHeader":{"type":2,"text":"Blogs"},"path":"/en-us/knowledge-hub/blogs/usage-examples/overview","content":["| # | Blog | Description |\n","\\|---\\|---\\|---\\|\n","| 1 | Step-by-step guide: Authorizing Amazon Ads API requests using Python | Practical guide for authenticating and authorizing Amazon Ads API requests using Python, including code examples and best practices. |\n","| 2 | Streamline Amazon Marketing Stream Data Integration with Snowflake | Integrate Amazon Marketing Stream with Snowflake for real-time data processing and advanced analytics. |\n","| 3 | Ads + Selling Partner APIs Onboarding and Best Practices | Best practices for onboarding with both Amazon Ads and Selling Partner APIs. |\n","| 4 | A Tour of Media Planning with the Amazon Ads API | Explore campaign planning strategies, budget allocation, and media planning with the Amazon Ads API. |\n","| 5 | Audience Insights and Persona Builder Overview | Overview of audience insights and the Persona Builder tool for building targeted advertising strategies. |\n","| 6 | Amazon Retail Ad Service Integration Guide | Step-by-step guide for integrating with the Amazon Retail Ad Service API. |\n","| 7 | Sponsored Products & Brands Audience Bid Boosting | Learn how to implement audience bid boosting for Sponsored Products and Sponsored Brands campaigns. |\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":[" Implementing the authorization flow is a crucial step for developers in integrating with the Amazon Ads API to build their own SaaS products for serving their Amazon advertising clients. However, for developers who are not familiar with API authorization and the OAuth2 protocol, implementing the authorization flow may present a significant learning curve, prolonging the time required to understand and properly implement this crucial step. This article aims to explain the essential concepts related to Amazon Ads API authorization flow alongside Python code examples that developers can reference to accelerate their development process.\n"," Two options for Python implementation are described below, one using native Python and the requests library, the other using the requests_oauthlib library.\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":2,"text":"What is authorization and why is it needed?"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":[" Authorization is a process by which the resource owner gives permission to a third party to access its resources. In the case of Amazon Ads, the advertisers own and control access to their data. For a third party to access and make changes to the data and services of the advertisers on their behalf via API, a safe and robust authorization process is required. Amazon Ads implements its API authorization based on OAuth2, an industry-standard protocol for authorization. Third parties can only access the data and services of an advertiser after they complete the authorization process with the advertiser.\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":2,"text":"Amazon Ads API authorization flow"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":[" The diagram below illustrates the key roles as well as the activities throughout the authorization flow. More details can be found on the Amazon Ads advanced tools center.\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":3,"text":"Key roles"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":["API caller: this is often referred to as the client. In the case of Amazon Ads API, this is a Login with Amazon (LwA) client application. This is the third party that is trying to obtain access to the data and services of an advertiser.  Advertiser: this is often referred to as the resource owner. During the authorization flow, the advertiser gives permission to an API caller to access their data and services.  Login with Amazon authorization server: this is often referred to as the authorization server. It issues the access token and refresh token to the API caller after the authorization is completed successfully. \\* API endpoints: these are hosted by the resource server, it returns the data and services when being called by the API caller.\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":3,"text":"Key activities"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":["Retrieve LwA client ID and secret: The authentication and authorization process begins with LwA client ID and the client secret. You will retrieve these details from your Amazon Developer Account. \\* Get approval from advertisers: The API caller will send an authorization URL to the advertiser. When the advertiser clicks on the URL, they will be led to the Amazon sign-in page. They will sign in their Amazon account using their credential and approve the permission scopes requested by the API caller. The advertiser will then be redirected to the return URL with the authorization code, which will expire after 5 minutes. As a result, the authorization code should be shared with the API caller right away to obtain the access token and refresh token in the next step. See below an illustration that explains the different components of an authorization URL.\n","Get access token and refresh token: The API caller presents the client ID, client secret as well as the authorization code to the authorization server, which will return the access token and refresh token. Access token serves as a permit and is required when the API caller makes an API call to access the data and services of the advertiser. An access token is valid for 60 minutes. After the access token expires, the API caller will use the refresh token to generate a new access token. The refresh token remains valid until the advertiser who granted authorization revokes the authorization.  Retrieve profile ID(s): Profiles represent an account of an advertiser in a specific marketplace. The API caller can use the client ID and the access token to make a call to the profile endpoints (/v2/profiles). This will return all the profiles under the advertiser in a particular region. To get profiles across regions, the API caller will need to make separate calls using the specific host. For example, to get profiles in the EU region, the API caller will need to call https&#x3A;//advertising-api-eu.amazon.com/v2/profiles.  Make an API call: Once the list of profiles from the advertiser is available, the API caller can go ahead to use the client ID, access token and the specific profile ID to make various API calls and access the data and services of the advertiser.\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":2,"text":"User interface steps"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":[" The first two steps in the OAuth process require using Amazon user interfaces to retrieve credentials for the client application and to grant authorization from the resource owner. You will need to note four values as a result of these steps to use in your code later:\n","client ID  client secret  return URL \\* authorization code\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":3,"text":"Retrieve LwA client ID and secret from your Amazon Developer account"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":[" After you create your Login with Amazon security profile on your Amazon Developer account, you can retrieve your client ID and secret by:\n","Log into your Amazon Developer account 2. Click \"Developer Console\" on the top right corner 3. Click \"Login with Amazon\" on the top menu bar 4. Click \"Show Client ID and Client Secret\" for your security profile\n"," More details can be found in Create a Login with Amazon application. Below is a screenshot showing where to find the client ID and secret.\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":3,"text":"Retrieve refresh token"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":[" YOUR_LWA_CLIENT_ID: This is the client ID you retrieved from the Amazon Developer Portal\n"," YOUR_RETURN_URL: This is the return URL you used in the Amazon Developer Portal\n","Paste the authorization URL determined above into the address bar of your browser. Navigate to the URL. 2. Sign in using an Amazon user account with access to the Amazon Ads accounts you want to manage through the API. This account may not be the same as the Amazon Developer account you used to create the LwA client. 3. You will be redirected to a consent form listing the specific data and services included in the authorization grant. To grant access, select Allow. 4. You will be redirected to the redirect_uri that you specified previously, with query parameters appended to the URL. Copy the address from the address bar of your browser, and note the value of the code parameter (the xxxx in the example below):\n"," The code parameter (xxxxxxxxxxxxxxxxxxx in the example above) in the redirect URL is an authorization code, which you can now use in the next step of the onboarding process to get access and refresh tokens\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":2,"text":"Implementing authorization in Python"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":[" Now let us examine how all the steps outlined above can be implemented in Python using two different approaches.\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":3,"text":"Option 1: Retrieving tokens using the `requests` library"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":[" In this example we will show how to retrieve an access token using Python code.\n"," You can use the four values retrieved from the user interface steps to retrieve access and refresh tokens as shown here:\n"," When the access token expires (or even if it has not) you can use the refresh token from the above step to get a new access token.\n"," For most other requests to the Amazon Ads API, a profile ID is required. Using your access token, you can retrieve a profile ID from the profiles endpoint.\n"," You can use a profile ID as the Amazon-Advertising-API-Scope header for other campaign management requests. Adding the following below your profiles request will list the Sponsored Products campaigns for the advertiser using the /sp/campaign/list endpoint with an empty request body.\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":3,"text":"Option 2: Implementation of authorization flow with Requests-OAuthlib"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":[" Requests-OAuthlib is an open-source Python library built on top of Requests and OAuthlib. It provides an easy-to-use Python interface for building OAuth2 clients and abstracting away tasks such as putting together the authorization URL or regenerating an access token using the refresh token.\n"," In this walkthrough, you will manage the LwA client application credentials in a local JSON file named lwa_app_credential.json, which looks like the example below. For a production setup, you can use a cloud service such as AWS Secrets Manager to manage your credentials.\n"," In your Python program, import the required libraries, set values for authorization and API URLs, and read the LwA client application credentials from the JSON file:\n"," Use these values plus the following permission scopes to initialize an OAuth2Session:\n"," Now the OAuth session can be used to generate an authorization URL.\n"," Log in using the user account for the advertising account you want to administer, then input the full callback URL:\n"," The OAuth session established above includes a built-in method for fetching access tokens based on the authorization response. Pass the response to the following method to retrieve access and refresh tokens.\n"," Retrieve the access token and refresh token. In this example, we again write it into a local JSON file named tokens.json. For now, manually create this file, which should look like the example below. Again, you can use a cloud service to manage your credential more securely in production.\n"," Requests-OAuthlib is also capable of automatically refreshing access tokens. We can use the tokens stored in tokens.json to configure a client to auto-refresh tokens when expired.\n"," Use this client to retrieve your list of profiles from the Amazon Ads API:\n"," You can use a profile ID from the response above along with your OAuth client to make other calls to the Amazon Ads API.\n"," Define the headers and make the API call. In this example, we are listing the Sponsored Products campaigns for the advertiser using the /sp/campaign/list endpoint with an empty request body.\n"],"documentType":"guide"},{"title":"Step-by-Step Guide: Authorizing Amazon Ads API Requests Using Python","sectionHeader":{"type":2,"text":"Conclusion"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-03-step-by-step-guide-authorization-amazon-ads-api-requests-using-python","content":[],"documentType":"guide"},{"title":"Streamline Amazon Marketing Stream Data Integration with Snowflake","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-01-ams-and-snowflake-integration","content":[" Amazon Marketing Stream (AMS) helps drive success in digital advertising with near real-time insights from Amazon Ads reporting data.\n"," This guide demonstrates how you can send AMS data directly to Snowflake, regardless of where you host your Snowflake instance (Amazon Web Services, Microsoft Azure, Google Cloud Platform, etc.).\n"],"documentType":"guide"},{"title":"Streamline Amazon Marketing Stream Data Integration with Snowflake","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-01-ams-and-snowflake-integration","content":[" Snowflake AI Data Cloud platform provides data solutions from data warehousing and collaboration to data science and generative AI. Snowflake is an AWS Partner with multiple AWS accreditations that include AWS ISV Competencies in Generative AI, Machine Learning, Data and Analytics, and Retail.\n"," Previous Snowflake integrations were a multi-step process using Amazon Simple Queue Service (Amazon SQS), Amazon Kinesis Data Firehouse, and Amazon Simple Storage Service, introducing latencies and higher costs.\n"," To simplify the process and increase processing speeds while decreasing costs, this guide will show you how to use the Snowflake Snowpipe Streaming API to deliver records from Amazon Data Firehouse as soon as they are available, making data ready for querying in Snowflake within seconds. \n"," This guide describes how to use both the AWS Management Console configuration and the automated AWS CloudFormation deployment. The Infrastructure as Code (IaC) approach ensures consistent and scalable deployments while delivering a low-code, serverless, and cost-effective solution.\n"," Benefits of this implementation include:\n","Near real-time insights: Access up-to-date AMS data in Snowflake within mins  Scalability: Handles increasing data volumes across multiple AMS datasets  Maintainability: Easy updates through CloudFormation \\* Simplified architecture: Direct streaming eliminates need for interim storage\n"],"documentType":"guide"},{"title":"Streamline Amazon Marketing Stream Data Integration with Snowflake","sectionHeader":{"type":2,"text":"Requirements"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-01-ams-and-snowflake-integration","content":[" This guide requires the following:\n","Amazon   \\* Snowflake  \n"],"documentType":"guide"},{"title":"Streamline Amazon Marketing Stream Data Integration with Snowflake","sectionHeader":{"type":2,"text":"Solution"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-01-ams-and-snowflake-integration","content":["Create a Snowflake database, schema, and table 2. Create a Firehose delivery stream 3. Configure IAM roles and policies for Firehose\n"],"documentType":"guide"},{"title":"Streamline Amazon Marketing Stream Data Integration with Snowflake","sectionHeader":{"type":3,"text":"Step 1: Create a Snowflake database, schema, and table"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-01-ams-and-snowflake-integration","content":[" Complete the following steps to set up your Snowflake database, schema, and table:\n","Log in to your Snowflake account and create the database:\n","Create a schema in the new database:\n","Create a table in the new schema:  \n"],"documentType":"guide"},{"title":"Streamline Amazon Marketing Stream Data Integration with Snowflake","sectionHeader":{"type":3,"text":"Step 2: Create a Firehose delivery stream"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-01-ams-and-snowflake-integration","content":[" Complete the following steps to create a Firehose delivery stream with Kinesis Data Streams as the source and Snowflake as its destination:\n","In the Amazon Data Firehose console, select Create Firehose stream. 2. For Source, select Direct PUT. 3. For Destination, select Snowflake. 4. For Firehose Stream Name, enter a name or use the default generated name. Amazon Data Firehose Create Firehose 5. In the Destination settings > Connection Settings, provide the following information to connect Amazon Data Firehose to Snowflake:\n","In this guide we are not using private link, so we will keep VPCE ID empty. 7. Under Database configuration settings, enter your Snowflake database, schema, and table names. 8. In the Backup settings > S3 backup bucket, enter the bucket you created as part of the prerequisites. 9. Click Create Firehose stream.\n"],"documentType":"guide"},{"title":"Streamline Amazon Marketing Stream Data Integration with Snowflake","sectionHeader":{"type":3,"text":"Step 3: Configure IAM roles and policies for Firehose"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-01-ams-and-snowflake-integration","content":[" To set up Amazon Marketing Stream, create two essential IAM roles. Follow the links to create these roles and their associated policies, ensuring proper integration setup:\n","Firehose subscription role - Allows SNS to deliver data to Firehose. 2. Firehose subscriber role - Enables Amazon Marketing Stream to create SNS subscriptions on behalf of you.\n"],"documentType":"guide"},{"title":"Streamline Amazon Marketing Stream Data Integration with Snowflake","sectionHeader":{"type":2,"text":"Use AWS CloudFormation"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-01-ams-and-snowflake-integration","content":[" Alternatively, you can use an AWS CloudFormation template to create the Firehose delivery stream with Snowflake as the destination rather than using the Amazon Data Firehose console:\n","Ensure you have the requirements above. 2. Complete Step 1:Create a Snowflake database, schema, and table. 3. Download the AWS CloudFormation template. Go to GitHub and download a copy of Stream-Firehose-S3-CF-Template.yaml. 4. Deploy the stack using AWS CloudFormation: 5. After the stack is created, use the Amazon Ads API to subscribe to the relevant AMS topics and direct the data to your new Kinesis Data Firehose delivery stream. 6. Verify the data flow:\n"],"documentType":"guide"},{"title":"Streamline Amazon Marketing Stream Data Integration with Snowflake","sectionHeader":{"type":2,"text":"Summary"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-01-ams-and-snowflake-integration","content":[" This solution empowers you with near real-time insights across multiple ad types and metrics, enabling near real-time data-driven decision-making and faster campaign updates.\n"," Amazon Data Firehose provides a straightforward way to deliver data to Snowflake using the Snowflake Snowpipe Streaming API, letting you reduce costs and minimize latency to seconds. Additionally, by leveraging the Amazon CloudFormation template, you can quickly set up a robust, scalable, and efficient data pipeline for your Amazon Marketing Stream data.\n"],"documentType":"guide"},{"title":"Streamline Amazon Marketing Stream Data Integration with Snowflake","sectionHeader":{"type":2,"text":"Next Steps"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-01-ams-and-snowflake-integration","content":["Download the CloudFormation template from the Amazon AMS GitHub repository: Customer.yml   Deploy the stack in your AWS account  Configure your AMS subscriptions to use the new Kinesis Data Firehose stream \\* Start exploring your near real-time advertising data in Snowflake\n"," We are excited to see how you use this integration to drive your advertising strategies forward. If you have any questions or feedback, please do not hesitate to reach out to our support team.\n"],"documentType":"guide"},{"title":"Ads + Selling Partner APIs Onboarding and Best Practices","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/usage-examples/2024-11-sp-and-ads-bp","content":[" The goal of this SOP is to share the best practices and FAQs with dual developers who use both Ads and Selling Partner APIs.\n"," If you are just starting with Selling Partner APIs, please note that Amazon Ads API also uses Login with Amazon as well, however the applications and credentials cannot be used across the two API gateways; i.e. credentials for Ads APIs cannot be used for Selling Partner APIs and vice versa.\n","Create developer account: You must register as a Selling Partner API developer before you can register your Selling Partner API application. For a demo of developer registration and a walkthrough of Seller Central, refer to the Register as an SP-API Developer video \\*\\* on \\[SP-API Developer University.](https&#x3A;//www.youtube.com/@amazon-sp-api?ld=ELXXSPAPI-pt-br-group.readme.io) \\*\\* We recommend a generic email distribution list to avoid the account tied to an individual. 2. Read about SP-API roles and SP-API policies: A role is the mechanism used by Selling Partner APIs to determine whether a developer or application has access to an operation or resource. As a developer, you must request and qualify for a particular role, or you will not be able to access the operations and resources grouped under that role. 3. Registering as a developer: You must register as a Selling Partner API developer before you can register your Selling Partner API application. The Selling Partner API Developer Hub contain steps on how to do it. 4. Create a Sandbox Selling Partner API Application: The Selling Partner API provides two sandbox environments.A Static sandbox where mocked parameters allows you to test request and responses and dynamic sandbox restricted to Vendor direct fulfillment, Fulfillment Outbound API and FBA Inventory returning realistic responses based on the request parameters. For the static sandbox you need to rely on the static sandbox JSON objects to understand which parameters you use to call the API.  5. Registering your Selling Partner API Application in Developer Central: To create your application you can check the Registering your Selling Partner API Application. When creating your application you will be able to assign roles approved in your developer profile. So, if you did not apply in your developer profile, it will not be available in the application register form. 6. Authorizing Selling Partner API Applications: The authorization model for the Selling Partner API is based on Login with Amazon, the Amazon implementation of OAuth 2.0. 7. Connect to Selling Partner API Application: Before your application can connect to the Selling Partner API, you must register it and it must be authorized by a selling partner as indicated in step 1. 8. Test Selling Partner API Endpoints:\n"],"documentType":"guide"},{"title":"Ads + Selling Partner APIs Onboarding and Best Practices","sectionHeader":{"type":3,"text":"**Why most Most 4xx errors occur?**"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2024-11-sp-and-ads-bp","content":[" There are many possible reasons for a 4xx response. The first check is to ensure the following:\n","Required roles are approved for your profile and application. Most 403 errors (Access Denied) occur due to profile or application not having the correct access assigned to them.  A seller account is active. If not and a 400 error is being returned for that seller, then contact the seller and request that they navigate to Seller Central > Settings > Account Info > Charge Information. If the Charge Information page displays a banner requesting a credit card update, then ask the seller to update their credit card information. Allow 48 hours for the updates to process through all Amazon systems. If a seller account has not been used for 90 or more days, the account will be marked dormant, and the seller will be advised to update their credit card. Allow 48-hour waiting period to ensure a successful update. Afterwards, API calls can be made by that account.  If you are receiving 429 errors, that means the request submissions exceed the steady-state request rate and burst limits, SP-API fails the limit-exceeding requests and returns 429 Too Many Requests error responses to the client. If you receive these error responses, you can resubmit the failed requests in a way that is rate limiting while also complying with rate limits. This document describes how to use the defined rate limits for each SP-API operation in an optimized manner and provides strategies for managing API throttling in your applications workloads.  \\* For other information regarding 400 errors check here.\n"],"documentType":"guide"},{"title":"Ads + Selling Partner APIs Onboarding and Best Practices","sectionHeader":{"type":3,"text":"**FAQs**"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2024-11-sp-and-ads-bp","content":["I want to see a list of shopping products i.e. all ASINs listed on Amazon by their clients (both sellers and vendors) - clients can use  How do we tie the information from both APIs? For example we are looking for ad metrics such as impression, clicks, orders, CTR, conversion rate etc. to show in SP-API reports.  How to look for remaining inventory data related to products?  Is it possible to use a single token that I received from Ads API OAuth process?   How Reauthorization works?   What is LWA Rotation?   How to Determine App type - different application types are created with SP-API  What happens if a developer adds a new role later on to their developer profile?  How to calculate Organic sales data?\n"," ONBOARDING - https&#x3A;//advertising.amazon.com/API/docs/en-us/guides/onboarding/create-lwa-app Below is the summary of steps to get access to Ads APIs. Here is the documentation for details – \n"," Onboarding \n","Join Amazon Ads Partner Network - Before an agency/partner get started with Amazon Ads APIs, they will have to set up their Amazon Business Account in Amazon Ads Partner Network -   2. Authorize your LwA application - Follow Getting started steps for an Amazon user account to authorize your LwA application to access their advertising data and services through the API 3. Acceptance of Ads Agreement - This is the prerequisite for registering an ads account through the Amazon Ads API. The purpose of surfacing terms token is to ensure that legal Terms & Conditions (“T&Cs”) are surfaced by the API integrator and have been accepted by the LWA’s user (customer who signed into the partner’s API service by using “login with amazon”) . It is a 2-step process -   4. Billing Setup for a newly created account - Setting up Billing APIs process establishes WHO is going to pay for your advertising spend with Amazon Ads by setting a billing profile and WHAT payment method will be used by setting a payment profile. 5. Register an Ads account - Amazon Ads supports registration via APIfor businesses that do and do not sell on Amazon. 6. User Permissions and Invitations - A user account permission plays a crucial role in managing access and control over advertising accounts. Permissions define what actions a user can perform within their Amazon Ads account.  In the Amazon Ads API, permissions associated with the user account that initiates the authorization grant are crucial for determining whether subsequent API requests will be authorized. 7. Create Campaigns of your choice - SB, SD, SP and ADSP\n"," \\*\\*Amazon Ads API Postman collection\\*\\* Our collection for Postman includes scripts to help manage auth, as well as readymade templates for some common requests to the API. To begin, see Amazon Ads API Postman collection.\n"," Reports across Ads and Retail APIs\n"," To match reports across both APIs, store information at the ASIN (or individual product, SKU) level to allow for granular reporting for optimum insights. E.g. - \n","Track inventory quantities as it negatively affects the customer experience and impacts campaign performance as well as the eligibility to be selected as the Featured Offer. Below is the impact for when inventory is out of stock - \n"," Use cases for Ads and Selling Partner APIs \n","In order to manage and keep your inventory up to date you can use the Building Listings Management Workflows Guide. Also you can track your inventory using ITEM_INVENTORY_EVENT_CHANGE notification or FBA_INVENTORY_AVAILABILITY_CHANGES which is a notification  that includes a snapshot of the FBA inventory in all eligible marketplaces in a particular region. You can measure the performance of advertising-attributed inventory sold, and measure the performance to make decisions.  2. Improve your product catalog content (Product title, Product description, Images etc.); by leveraging Catalog Items API to view the catalog content for detail page optimization (Product title, Product description, Images etc.) and Retail Readiness (Retail readiness is a scoring system for products to classify products that are 'ready for ads' and helps ensure Amazon.com customers have a positive shopping experience and the right information to make a purchase decision) which is important for an advertising campaign to drives traffic to a brand on Amazon.com. You should ensure that any product you are advertising is retail ready prior to setting up advertising campaigns.\n","Ads and Selling Partner APIs together also allow users to optimize campaign based on TACOS (total ACOS - which measures your advertising spend relative to your total revenue generated) ad spend/total sales (ad-attributed sales + organic sales). With Retail API you get the total sales for a product and with Ads API you get the advertising spend for a product. A lower TACoS value is desirable as it indicates that the advertising efforts are efficiently translating into sales revenue, making the advertising approach more effective and profitable for the business.\n"," Some of the common Retail metrics leveraged by Dual Developers are -\n","Inventory status  Page views  Sessions (Visits to your offer pages for a set time period)  Total units  Orders  order item session % (dividing the number of orders of an item by the number of distinct sessions I.e. unique visits to your Amazon product detail pages for a certain time period), and   total sales\n"," Common asked retail metrics - \n","Buy box  Coupons/deals  SNS\n"," Basic reports for Vendors\n","Brand Analytics reports - provides  2. Vendor Retail Analytics reports - provides 3. Vendor Direct Fulfillment APIs + Vendor Retail Procurement APIs - allows vendors in the direct fulfillment (DF) program to manage their direct fulfillment operations programmatically, helping to maintain performance at scale, increase operational efficiency, reducing errors, and improving performance. Through this API, vendors can: \n"," Basic reports for Sellers\n","Analytics APIs - such as Orders API, Reports API, Finances API can be used in combination or alone to derive insights on retail performance 2. Fulfillment APIs - such as FBA inventory, FBA small and light API and Shipment invoicing API can be leveraged to manage inventory and order information, confirm shipments, return package/pallet labels, or programmatically access Amazon’s shipping service.  3. Data Kiosk is a reporting suite in the Amazon Selling Partner API (SP-API). Data Kiosk is a GraphQL-based tool for accessing bulk data. Developers who build reporting solutions on behalf of Selling Partners can use the Data Kiosk API to easily discover and select data fields from a comprehensive Amazon retail dataset to generate business insights. 4. Buyer Selling Messaging APIs – Reach shoppers with APIs such as Solicitations API where you can use insights derived from other APIs (like the ones mentioned above), to send non-critical solicitations to shoppers; or use the Messaging API to send supported message types to customers. \n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" A comprehensive guide for technology professionals such as chief technology officers (CTOs), architects, product, and engineering teams\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Imagine you are preparing to launch a digital advertising campaign: you have high-quality creatives and a solid budget, but where should you run media? Which audiences will actually convert? And how do you allocate spend across channels without wasting money? Media planning turns these myriad decisions into a strategic roadmap that maximizes every dollar of your advertising investment.\n"," Amazon Ads gives media planners the desired reach and precision by extending the owned-and-operated properties of Amazon with open internet inventory. With authenticated audience signals from both connected TV viewership and actual shopping behavior, planners can target high-intent consumers across digital touchpoints while maintaining the accuracy that only real purchase data can provide. This unified approach eliminates guesswork, letting you allocate spend confidently across channels with audiences proven to convert. \n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Solving Media Planning Use Cases with Amazon Ads API"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" The Amazon Ads API provides the foundation for building sophisticated media planning capabilities. This article explores four critical scenarios through API implementation:\n","Reach forecasting - Strategic media planning across all supply packages. Specify geographic marketplace, device type, and audience, content, product, or location targeting, and receive a reach curve to measure expected reach given different impression volumes. 2. Historic reach analysis - Understanding past performance for your desired audiences, for Sponsored TV and Prime Video supply. Specify demographic and geography filters, and measure the reach available at each frequency threshold. 3. Custom audiences with Persona Builder - Develop high-intent targeting through audience layering. Combine different audiences by intersections or unions, and measure attributes such as demographic composition and which product categories they would be most likely to purchase. \n"," Each use case demonstrates real API requests and responses, showing how strategic media planning concepts translate into executable code for scalable advertising platforms.\n"," NOTE: Individual API response values such as spend, reach and other performance metrics are for illustrative purposes and are not intended to reflect typical nor expected nor available data.\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":2,"text":"1. Reach forecasting API - strategic media planning across supply packages"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Media planners face the complex challenge of developing cross-channel strategies that maximize unique reach across advertising channels while avoiding costly audience overlap waste. Traditional planning approaches operate in silos, making it impossible to understand how different supply packages complement each other or identify optimal budget allocation for maximum reach efficiency. The objective is to implement strategic reach forecasting that provides unified reach estimation across all ad products and supply packages, then use deduplication modeling to optimize portfolio allocation for maximum unique reach.\n"," The Reach forecasting API represents the strategic foundation of modern media planning, enabling advertisers to predict campaign performance across the advertising inventory of Amazon before committing budget.\n"," The true power lies in its granular targeting configuration capabilities. Media planners can forecast reach with precise combinations of:\n","Audience segments (behavioral, demographic, custom)  Content targeting (genre, contextual signals, brand safety)  Geographic precision (country, region, DMA-level)  Device specifications (mobile, desktop, connected TV, audio devices)  Keyword contexts (search intent, product categories)\n"," This comprehensive approach transforms media planning from reactive budget allocation to predictive strategy optimization.\n"," Note: For an in-depth exploration of Reach Forecast API usage, including detailed implementation examples and advanced use cases, see the comprehensive guide at https&#x3A;//advertising.amazon.com/API/docs/en-us/guides/media-planning/reach-forecasting/get-started\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Strategic Value Proposition"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Rather than planning campaigns in isolation, the Reach Forecasting API enables holistic media strategy by providing reach estimates across:\n","Search inventory (Sponsored Products, Sponsored Brands)  Display placements (on and off Amazon properties)  Video inventory (streaming, in-app, connected TV)  Audio placements (music streaming, podcasts)  Mobile app inventory (gaming, lifestyle, productivity apps)\n"," Before launching campaigns, media planners can validate targeting strategies by forecasting reach for specific configurations:\n"," The API returns reach estimates for each supply package, enabling data-driven decisions about where to allocate budget for maximum efficiency.\n"," The forecasting engine generates reach curves that reveal the relationship between budget investment and incremental reach across different supply types. This enables strategic questions like:\n","At what budget level does reach plateau for video inventory?  Which supply package delivers the most cost-efficient incremental reach?  How does frequency capping impact total reach potential?\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Forecast deduplication"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Combine individual supply forecasts with the Forecast Deduplication API to estimate unique reach across an entire media plan. This addresses the critical challenge of cross-channel audience overlap.\n","Generate individual forecasts - Get reach estimates for each supply package and targeting combination 2. Model cross-supply overlap - Use deduplication API to estimate audience overlap between channels 3. Optimize portfolio allocation - Adjust budget distribution to maximize unique reach while minimizing waste\n","Eliminate frequency waste: Identify when the same users are being reached across multiple channels  Maximize incremental reach: Discover which supply combinations deliver truly additive audience  Optimize budget efficiency: Shift spend from saturated channels to high-incremental reach opportunities\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Implementation considerations"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" For Product Managers:\n","Present reach forecasts as confidence intervals rather than point estimates  Build scenario planning tools that compare different targeting configurations  Implement automated alerts when forecasted reach drops below campaign requirements \\* Create portfolio-level dashboards showing deduplicated reach across all active campaigns\n"," Strategic applications:\n","Competitive analysis: Forecast reach for competitor targeting strategies  Seasonal planning: Model reach fluctuations during peak shopping periods  New market entry: Assess reach potential before expanding to new geographies \\* Creative testing: Forecast reach for different creative formats across supply types\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"The future of predictive media planning"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" The Reach forecasting API transforms media planning from art to science, enabling advertisers to make data-driven decisions about budget allocation, targeting strategy, and channel mix before campaigns launch. When combined with forecast deduplication, it provides the strategic intelligence needed to maximize reach efficiency.\n"," This predictive approach reduces campaign risk, improves ROI, and enables the sophisticated media planning strategies that drive competitive advantage in the complex advertising landscape of today.\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":2,"text":"2. Historical Reach Analysis"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Use Case: Analyzing Reach Performance for Target Demographic with Frequency Controls\n"," A media planner preparing for an upcoming campaign targeting male 18-34 demographics faces a critical decision: what frequency capping should they apply to maximize reach efficiency without wasting budget? Without historical performance data, they risk either under-delivering due to overly conservative frequency limits or burning through budget with excessive frequency that does not drive incremental reach. The goal is to establish data-driven frequency optimization based on actual historical reach performance for this specific demographic on Sponsored TV inventory.\n"," Historical reach curves provide the solution by analyzing reach and impressions across different frequency thresholds for specific demographics, geographies, or audiences on Sponsored TV (STV) or Prime Video supply. The three-step API workflow creates the curve, monitors processing completion, then retrieves comprehensive results.\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"API interaction"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Historical reach curves require a three-step workflow: create the curve, wait for processing completion, then retrieve results.\n"," Response:\n"," The curve will be processing for some time. Check status until COMPLETED:\n"," Response:\n"," Once status is COMPLETED, retrieve the historical reach curve:\n"," Response:\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Analysis"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" The historical reach analysis reveals that given 2.5M impressions, we can expect 850k users to be reached once, 620k to be reached twice, and so forth. This data enables the media planner to make informed spend decisions, such as \"How many impressions are needed to ensure 80% of my audience is reached more than 3 times?\", providing a data-driven foundation for optimizing future campaigns targeting specific audiences.\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":2,"text":"3. Custom audiences with Persona Builder - creating high-intent shoppers"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Persona Builder transforms audience targeting from broad demographic categories into precise customer personas based on behavioral signals and lifestyle indicators. Consider a fictional gardening equipment company: this means moving beyond simple \"homeowner\" targeting to identify customers who demonstrate both purchase intent and lifestyle alignment with gardening activities.\n"," In this example, our fictional market research has revealed that online grocery shoppers show exceptionally high affinity for gardening equipment purchases - 3.2x higher conversion rates than general homeowner audiences. By combining in-market gardening signals with online grocery shopping behavior, we can create a high-intent persona that maximizes campaign efficiency.\n"," The Persona Builder API enables this strategic audience layering through:\n","Audience discovery - Finding relevant behavioral and lifestyle segments 2. Audience combination - Creating custom personas from multiple signals 3. Performance prediction - Forecasting reach and engagement before campaign launch\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Step 1: Audience discovery flow"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" First, discover available audiences using the Audiences API to find the target segments:\n"," Response:\n"," In this fictional scenario, if our independent market research has shown that online grocery shoppers are a high-affinity and high-loyalty audience for our brand, we can use the Persona Builder to determine a suitable target.\n"," Response:\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Step 2: Creating Combined Audience Persona"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Now use the Persona Builder to analyze the custom audience by combining these audiences.\n"," The Persona Builder accepts an audience targeting expression. An audience targeting expression consists of one or more groups. Included groups are joined by an intersection. Audiences within a group are joined by a union.\n"," Here we define a custom persona that is the intersection of the gardening enthusiasts audience and the online grocery shopper audience. \n"," Response:\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Step 3: Demographic and Behavioral Insights"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Analyze the demographic composition of the combined persona:\n"," Response:\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Step 4: Purchase Behavior Analysis"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Analyze what categories this persona purchases to validate the targeting strategy:\n"," Response:\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Step 5: Audience Overlap Analysis"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Discover additional high-affinity audiences that overlap with the persona:\n"," Response:\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Strategic Persona Insights"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" The Persona Builder analysis reveals a highly valuable customer segment:\n","Size: 850K - 1.2M targetable customers  Demographics:   Behavioral Signals:\n","Outdoor power equipment 6.8x affinity, 24% overlap  Home improvement enthusiasts 4.1x affinity, 31% overlap  Sustainable living interest 3.7x affinity, 18% overlap\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Implementation Strategy"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" For Product Managers:\n","Use demographic insights to inform creative messaging (target 35-54 age group)  Leverage high homeowner affinity (4.2x) in campaign positioning  Consider seasonal budget allocation based on gardening cycles\n"," For Engineers:\n","Implement audience refresh workflows to maintain persona accuracy  Build automated alerts when audience overlap drops below thresholds  Create A/B testing framework for persona variations\n"," Campaign optimization:\n","Start with core 2-audience combination (garden intent + online grocery)  Test expansion audiences individually to measure incremental lift  Monitor affinity scores to detect persona drift over time\n"," This data-driven persona creation transforms broad demographic targeting into precision audience strategy, enabling the gardening equipment company to reach customers with both demonstrated purchase intent and lifestyle alignment.\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":2,"text":"Amazon Ads API is Your Strategic Advantage"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" The Amazon Ads API transforms media planning from reactive campaign management into predictive, data-driven strategy. Through these four use cases, we have seen how strategic media planning concepts translate directly into executable API workflows.\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"The Strategic Advantage"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Organizations that master these API capabilities gain significant competitive advantages:\n","Reduced Campaign Risk through predictive performance modeling  Improved ROI via data-driven budget allocation and audience targeting  Operational Efficiency through automated optimization and scenario planning \\* Strategic Intelligence from cross-channel reach analysis and deduplication\n"],"documentType":"guide"},{"title":"A Tour of Media Planning with the Amazon Ads API","sectionHeader":{"type":3,"text":"Next Steps"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-11-tour-media-planning","content":[" Ready to build your own media planning capabilities? Here is how to get started:\n"," Explore the technical foundation:\n","Review the complete Amazon Ads API documentation for detailed endpoint specifications \n"," Connect with Amazon Ads:\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" This guide provides advanced integration patterns, architectural considerations, and best practices for building production-grade applications using the Retail Ad Service (RAS) API. It assumes familiarity with the getting started guide and focuses on the strategic and technical challenges unique to managing retail advertising campaigns programmatically.\n"," The Retail Ad Service enables advertisers to run campaigns on third-party retailer websites and apps through Amazon Ads infrastructure. This guide addresses the unique challenges of multi-retailer campaign management, product eligibility validation, targeting optimization, and campaign lifecycle automation.\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Understanding the Retail Ad Service Model"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"The Multi-Retailer Challenge"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" Unlike traditional Amazon Sponsored Products campaigns that run exclusively on Amazon properties, RAS campaigns operate across multiple independent retailer environments. This introduces several integration challenges:\n"," Retailer-Specific Product Catalogs - Each retailer maintains its own product catalog with unique offer IDs - Product availability varies by retailer - Eligibility rules differ across retailer platforms - Catalog updates occur independently per retailer\n"," Campaign Scope Boundaries - Ad groups are scoped to a single retailer - Products must exist in the catalog of the target retailer - Budget allocation requires retailer-level consideration\n"," Strategic Implication: Your integration must treat retailers as first-class entities in your data model and workflow design.\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Architecture Patterns"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"1. Retailer-Centric Data Model"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" Design your database schema to reflect the retailer-scoped nature of RAS campaigns:\n"," Key Design Principles:\n","Retailer as a dimension: Index retailer_id across all entity tables for efficient filtering 2. Product catalog mapping: Maintain a separate table mapping your internal product IDs to retailer offer IDs 3. Hierarchical relationships: Enforce referential integrity from campaigns → ad groups → product ads\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"2. Campaign Creation Workflow"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" RAS campaigns require a specific sequence of API calls with validation at each step. The following is a production-ready workflow:\n"," Response Analysis:\n"," Key Observation: The servingStatus of CAMPAIGN_INCOMPLETE is expected at this stage. Your integration should: - Store the campaign ID immediately - Track the serving status through the workflow - Not treat CAMPAIGN_INCOMPLETE as an error during creation\n"," Ad groups are created for each retailer. Retailer discovery is supported via the retailer list API, see the \"Retrieving retailerIds\" section in the getting started guide.\n"," Strategic Note: Different retailers may require different default bids based on their competitive landscape. Your integration should support retailer-specific bid strategies.\n"," Bids are per-target and the defaultBid is used when target level bid is not set.\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"3. Product Discovery and Eligibility Management"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" The Product Metadata API is critical for RAS campaign success. Proper product discovery prevents wasted API calls and campaign delivery issues.\n"," Response Processing:\n"," Integration Best Practices:\n","Filter before creating product ads: Only attempt to create ads for products with eligibilityStatus: \"ELIGIBLE\" and availability: \"AVAILABLE\"\n","Cache eligibility data: Store eligibility status with timestamp to avoid repeated queries\n","Batch product ad creation: Group product ads by ad group to minimize API calls\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Targeting Strategy Implementation"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Auto vs. Manual Targeting: Strategic Considerations"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" The choice between auto and manual targeting affects your entire campaign structure and optimization approach.\n"," Characteristics: - Amazon automatically creates four targeting clauses per ad group, targeting high relevance search terms, browse categories and product detail pages - Initial bids set by Amazon, but are adjustable - Suitable for discovery and broad reach - Campaigns created with AUTO targeting cannot have manual positive targets configured.\n"," Implementation Pattern:\n"," Retrieving Auto Targets:\n"," Response:\n"," Manual campaigns require upfront keyword research and ongoing optimization.\n"," Keyword Target Creation:\n"," Match Type Strategy:\n","| Match Type | Use Case | Bid Strategy |\n","\\|------------\\|----------\\|--------------\\|\n","| EXACT | High-intent, proven keywords | Higher bids, tight control |\n","| PHRASE | Moderate reach, relevant variations | Medium bids, monitor closely |\n","| BROAD | Discovery, maximum reach (only supported for positive targets) | Lower bids, aggressive negatives |\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Negative Targeting Strategy"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" Negative targets prevent wasted spend on underperforming segments. RAS supports only ad-group-level negatives.\n"," Campaign-Level Negatives (affect all ad groups):\n"," Ad-Group-Level Negatives (affect specific ad group):\n"," Automated Negative Keyword Workflow:\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Campaign Lifecycle Management"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Serving Status Monitoring"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" The servingStatus field in extended data provides critical insights into campaign health. Your integration should actively monitor and respond to serving status changes.\n"," Campaign Level:\n"," Ad Group Level:\n"," Product Ad Level:\n"," Alert Configuration:\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Budget Pacing and Monitoring"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" RAS campaigns use daily budgets. Implement budget monitoring to prevent premature budget exhaustion.\n"," Budget Adjustment Strategy:\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Error Handling and Resilience"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Understanding RAS Error Responses"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" RAS API uses HTTP 207 (Multi-Status) for bulk operations, returning both successes and failures in a single response.\n"," Response Structure:\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Error Categories and Handling Strategies"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" Common Validation Errors:\n","| Error Type | Reason | Handling Strategy |\n","\\|------------\\|--------\\|-------------------\\|\n","| malformedValueError | Invalid format or characters | Validate input before API call |\n","| missingValueError | Required field omitted | Check schema requirements |\n","| rangeError | Value out of acceptable range | Validate against marketplace limits |\n","| duplicateValueError | Entity already exists | Check for existing entities first |\n"," Example: Bid Range Validation\n"," Parent Entity Validation:\n"," Products may fail eligibility checks for various reasons. Implement graceful degradation:\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Retry Strategies"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" Not all errors should trigger retries. Implement smart retry logic:\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Reporting and Performance Analysis"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Report Configuration"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" RAS campaigns use Sponsored Products report types in Reporting v3:\n"," Available Report Types: - spCampaigns: Campaign-level performance - spTargeting: Target-level performance (keywords, auto targets) - spSearchTerm: Search term analysis for keyword harvesting - spAdvertisedProduct: Product-level performance - spGrossAndInvalids: Traffic quality metrics\n"," Report Request Example:\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Search Term Analysis for Optimization"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" Use the spSearchTerm report to identify optimization opportunities:\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Testing and Validation"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Pre-Production Testing Strategy"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" Before launching campaigns, validate your integration:\n"," 1\\. Entity Creation Validation\n"," 2\\. Error Handling Validation\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Monitoring Test Campaigns"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" Use tags to identify test campaigns:\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Best Practices Summary"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Data Model Design"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":["Make retailer a first-class entity in your schema - Index foreign keys (campaign_id, ad_group_id, retailer_id) - Store serving status history for troubleshooting - Cache product eligibility data with TTL\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"API Usage"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":["Use bulk operations (up to 1000 entities per request) - Request Prefer: return=representation when you need full entity data - Implement pagination for list endpoints - Validate parent entities before creating children\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Error Handling"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":["Parse 207 responses to separate successes from failures - Do not retry validation errors - Log error causes with location and trigger data - Implement graceful degradation for product eligibility failures\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Campaign Management"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":["Start campaigns in PAUSED state for review - Monitor serving status actively - Use tags for campaign categorization - Implement budget pacing checks\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Product Management"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":["Pre-validate products via Product Metadata API - Sync product catalogs daily per retailer - Handle product unavailability gracefully - Track eligibility reasons for analytics\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Targeting Optimization"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":["Use auto campaigns for discovery - Harvest search terms from spSearchTerm reports - Implement automated negative keyword workflows - Adjust bids based on performance data\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":3,"text":"Testing"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":["Validate complete workflows in test environment - Test error handling paths - Use tags to identify test campaigns - Clean up test entities promptly\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Conclusion"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":[" Building a production-grade RAS API integration requires understanding the unique challenges of multi-retailer campaign management. Success depends on:\n","Proper data modeling that reflects retailer-scoped relationships 2. Robust product catalog management with eligibility validation 3. Sophisticated error handling that gracefully manages partial failures 4. Active monitoring of serving status and campaign health 5. Performance-driven optimization using reporting data\n"," This guide has provided architectural patterns, implementation examples, and best practices for each of these areas. By following these patterns, you can build scalable, reliable integrations that effectively manage retail advertising campaigns across the expanding Amazon retailer network.\n"],"documentType":"guide"},{"title":"Amazon Retail Ad Service API: Integration Guide","sectionHeader":{"type":2,"text":"Additional Resources"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-ras-integration-guide","content":["Getting Started Guide - Basic tutorial and API introduction - RAS Campaign Management API Reference - Reporting v3 Documentation - Product Metadata API - Product discovery and validation - Bid Constraints by Marketplace - Marketplace-specific limits\n","\n"],"documentType":"guide"},{"title":"2025-12 Audience insights and Persona Builder Overview","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-audience-insights-persona-builder-overview","content":[" Amazon Ads provides Audience APIs that enable advertisers and partners to programmatically access audience insights and build targeted marketing strategies. The following sections explore the key components and implementation details of these APIs.\n"],"documentType":"guide"},{"title":"2025-12 Audience insights and Persona Builder Overview","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-audience-insights-persona-builder-overview","content":[" Before working with the Audience APIs, you need to complete several important setup steps:\n","Review Amazon Ads Well-architected framework - Obtain Login with Amazon (LwA) credentials and access token - Retrieve the Profile ID (Amazon-Advertising-API-Scope) - Retrieve the Advertiser ID (advertiserId)\n"],"documentType":"guide"},{"title":"2025-12 Audience insights and Persona Builder Overview","sectionHeader":{"type":2,"text":"Three Core Amazon Ads audiences APIs"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-audience-insights-persona-builder-overview","content":[" You can use Amazon audiences to access a large catalog of audience segments that are ready to use. Amazon Ads offers three main audience APIs:\n","Taxonomy API: The taxonomy API allows advertisers and partners to browse the Amazon audiences catalog hierarchy, level-by-level to discover audiences for targeting. This API allows you to find audiences through a tree-like structure, where each level contains one or more categories. View specifications for the taxonomy API - Audience Discovery API: The discovery API allows integrators to retrieve audience segments. The result set can be filtered by providing an array of Filter objects. Each item in the resulting set matches all specified filters such as category, categoryPath, audienceName, and audienceId. View specifications for the audiences discovery API - Persona Builder API: The persona builder API allows advertisers and partners to access first-party insights from Amazon to learn more about audiences and create custom brand personas. The API helps brands get insights on custom, composite audience expressions. View specifications for Persona Builder API\n"],"documentType":"guide"},{"title":"2025-12 Audience insights and Persona Builder Overview","sectionHeader":{"type":2,"text":"Audience APIs workflow"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-audience-insights-persona-builder-overview","content":[" The following steps illustrate a proposed API workflow to retrieve audience insights and create a persona from an audience expression.\n"],"documentType":"guide"},{"title":"2025-12 Audience insights and Persona Builder Overview","sectionHeader":{"type":3,"text":"Step 1:  Retrieve a profile ID"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-audience-insights-persona-builder-overview","content":[" The response to a successful call at this endpoint includes a list of profiles associated with the user account in the region of the API host. View specifications for profile endpoint.\n"],"documentType":"guide"},{"title":"2025-12 Audience insights and Persona Builder Overview","sectionHeader":{"type":3,"text":"Step 2:  Retrieve an advertiser ID"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-audience-insights-persona-builder-overview","content":[" The response to a successful call at this endpoint includes a list of Amazon DSP advertiser metadata. View specifications for advertisers endpoint\n"],"documentType":"guide"},{"title":"2025-12 Audience insights and Persona Builder Overview","sectionHeader":{"type":3,"text":"Step 3:  Retrieve the audiences catalog hierarchy "},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-audience-insights-persona-builder-overview","content":[" This API allows you to find audiences through a tree-like structure. When you build a category path, start with the top-level node using the following request and build the category path from each response.\n"," The subsequent request can be the following:\n"," To then navigate deeper (e.g., to \"Sporting Goods\"), the next request would use \"categoryPath\": \\[\"In-market\", \"Sporting Goods\"].\n"],"documentType":"guide"},{"title":"2025-12 Audience insights and Persona Builder Overview","sectionHeader":{"type":3,"text":"Step 4: Get the audiences information"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-audience-insights-persona-builder-overview","content":[" The API returns a list of audiences the advertiser has access to. \n"],"documentType":"guide"},{"title":"2025-12 Audience insights and Persona Builder Overview","sectionHeader":{"type":3,"text":"Step 5:  Get Persona Builder insights"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-audience-insights-persona-builder-overview","content":[" The API returns a list of demographic insights, such as age and gender. Affinity, overlap percentage, and segment ID of the corresponding demographic audience are provided for each insight. View specifications for additional persona builder insights\n"," Note: This payload has been shortened for readability. Additional demographic attributes may be included in the full response.\n"],"documentType":"guide"},{"title":"2025-12 Audience insights and Persona Builder Overview","sectionHeader":{"type":3,"text":"Step 6: Create a persona and save it to Amazon DSP "},"path":"/en-us/knowledge-hub/blogs/usage-examples/2025-12-audience-insights-persona-builder-overview","content":[" This API allows you to create an audience targeting expression and save the persona characteristics as a combined audience in Amazon DSP. View specifications for combined audiences\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":null,"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" This blog post provides a general guide on how to utilize the Sponsored Products and Sponsored Brands Audience Bid Boosting feature using the Amazon Ads console and APIs.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":2,"text":"Summary"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" Prior to the introduction of audience bid boosting, advertisers on Amazon had limited options to increase their reach to specific customer segments they valued most. While keyword-based campaigns helped them connect with shoppers searching for relevant terms, they could not prioritize their visibility among particular shopper groups to drive their unique marketing objectives.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":3,"text":"Key Benefits"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" The audience bid boosting capability has now provided advertisers with two key advantages:\n","Leveraging pre-defined audience segments from Amazon: Advertisers can utilize the wealth of customer data and shopping behavior insights from Amazon to more precisely target their ads. 2. Building custom audience segments in Amazon Marketing Cloud (AMC): Advertisers with access to AMC can create their own custom audience segments based on their own data and insights, gaining even more granular control over which shoppers see their ads more prominently.\n"," By activating these audience segments through the Amazon Ads Console, advertisers can then boost their bid amounts for those specific audiences. This enables them to gain increased visibility, engagement, and conversions from the customer segments they value most, helping them connect more effectively with relevant shoppers that are searching for their targeted keywords.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":3,"text":"Use-Case Example"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" A premium outdoor gear brand wants to increase their reach among shoppers who have previously purchased high-end camping equipment. By applying a 25% bid boost to this audience segment, they ensure their ads appear more prominently when these valued shoppers are browsing. This helps them capture more engagement and conversions from customers most likely to appreciate their premium products, rather than competing equally for visibility across all shoppers.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":["Sponsored Ads Advertiser account.  (Optional) To use the API method, you will need to complete the onboarding process as detailed in the Amazon Advertising API documentation: https&#x3A;//advertising.amazon.com/API/docs/en-us/guides/onboarding/overview  (Optional) You may use Amazon Marketing Cloud (AMC) to build custom audiences. This requires access to AMC via the Sponsored Ads Advertiser account.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":2,"text":"Adding Audiences to AMC (Optional)"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" Advertisers can utilize custom audiences that are ingested within the Amazon Marketing Cloud (AMC) to enable audience bid boosting. This allows them to leverage their own audience data and custom queries to target specific customer segments. To use this feature, advertisers with a Sponsored Ads account can instantly create an AMC instance associated with their account and access AMC directly through the Amazon Ads console. Note that the AMC instance will only be connected to the one Sponsored Ads account, and cannot be used to include Amazon DSP or other Sponsored Ads advertisers. Please refer to How AMC Works for more information.\n"," After setting up the AMC instance, you can navigate to the Audiences tab and create your custom audience.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":2,"text":"Audience Bid Boosting Using Console"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":["Navigate to the Sponsored Ads campaign manager page and click on \"Create Campaign\". 2. In the campaign creation flow, find the \"Audience\" bid adjustments section. 3. You have two options for selecting audiences:\n","Adjust the bid boost percentage as needed to increase your visibility and engagement with the selected audience(s). \n"," You may also edit an existing Sponsored Products campaign to enable Audience Bid Boosting:\n","Go to the Campaigns section and select the campaign you want to update. 2. Click on the \"Bid Adjustments\" tab, then navigate to the \"Audiences\" section. 3. Click \"Change audience\" and select either the \"Increase bids for audiences built by Amazon\" option or choose from your custom AMC audiences. 4. Set the appropriate bid boost percentage.\n"," By leveraging Audience Bid Boosting in the Amazon Ads console, you can optimize your Sponsored Products and Sponsored Brands campaigns to better reach and convert your key customer segments, whether using pre-built audiences from Amazon or your own custom audiences from AMC. This can lead to improved campaign performance and a higher return on your advertising investment.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":2,"text":"Audience Bid Boosting Using API"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" Alternatively, you can use the Sponsored Products or Sponsored Brands \"Create Campaign\" or \"Update Campaign\" API to set up audience bid boosting. Before doing so, you would need to first fetch the audience ID that you want to target. This can be done by accessing your custom audiences created in AMC and audiences built by Amazon, retrieving the unique ID associated with each audience.\n"," Once you have the necessary audience ID, you can then use the Sponsored Products or Sponsored Brands Create Campaign or Update Campaign API to configure the audience bid boosting for your campaigns. The API payload will include a section to specify the audience segments you want to target, along with the corresponding bid boost percentage you want to apply.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":3,"text":"Audience ID"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" To fetch the audience ID, you can use the /targetableEntities/list API.\n"," Steps to Use the Targetable Entities Search API:\n","Prepare a POST request to the endpoint /targetableEntities/list 2. Include the required authorization headers with your Amazon Advertising Account ID 3. Create a JSON request body with your search parameters 4. Specify the adProduct parameter (SPONSORED_BRANDS or SPONSORED_PRODUCTS)\n"," JSON body example:\n"," Sample Response:\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" Create Sponsored Products Campaign with Audience Bid Boosting:\n"," Update Existing Sponsored Products Campaign with Audience Bid Boosting:\n"," Note: To fetch the campaign ID that you want to update, you can use the /sp/campaigns/list API.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" Create Sponsored Brands Campaign with Audience Bid Boosting:\n"," Update Sponsored Brands Campaign with Audience Bid Boosting:\n"," Note: To fetch the campaign ID that you want to update, you can use the /sb/v4/campaigns/list API:\n"," In the examples above, the shopperCohortBidding section is used to configure the audience bid adjustments. The audienceSegments array specifies the audience(s) you want to target, and the percentage field sets the bid boost amount. \\* \\* \\*\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":2,"text":"Checking Report Using Console"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" To review performance data for your audience bid adjustments, navigate to the campaign view in the Amazon Ads console and select the \"Bid Adjustments\" section, then the \"Audiences\" tab. This will show you key metrics like impressions, clicks, conversions, and return on ad spend for each of your targeted audiences.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":2,"text":"Running Report using API"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" You can also use the Amazon Ads Reporting API to generate custom performance reports for your audience bid boosting activities. Here is an example of how to request a report:\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":3,"text":"Sponsored Products example API request"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" Base metrics\n"," campaignId, segmentName, segmentClassCode, impressions, clicks, cost, spend, purchases1d, purchases7d, purchases14d, purchases30d, purchasesSameSku1d, purchasesSameSku7d, purchasesSameSku14d, purchasesSameSku30d, unitsSoldClicks1d, unitsSoldClicks7d, unitsSoldClicks14d, unitsSoldClicks30d, sales1d, sales7d, sales14d, sales30d, attributedSalesSameSku1d, attributedSalesSameSku7d, attributedSalesSameSku14d, attributedSalesSameSku30d, unitsSoldSameSku1d, unitsSoldSameSku7d, unitsSoldSameSku14d, unitsSoldSameSku30d, date, startDate, endDate, campaignBiddingStrategy, costPerClick, clickThroughRate, campaignName, campaignStatus, campaignBudgetAmount, campaignBudgetType, marketplaceId\n"," Group by campaign_bid_boost_segment\n"," Additional metrics: segmentName Filters: None\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":3,"text":"Sponsored Brands example API request"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[" Base metrics\n"," campaignId, segmentName, impressions, clicks, cost, spend, purchases, sales, salesClicks, unitsSold, unitsSoldClicks, date, startDate, endDate, costPerClick, clickThroughRate, campaignName, campaignStatus, campaignBudgetAmount, campaignBudgetType, marketplaceId, segmentClassCode\n"," Group by campaign_bid_boost_segment\n"," Additional metrics: segmentName Filters: None\n"," This report will provide detailed performance metrics, including impressions, clicks, conversions, and return on ad spend, segmented by your audience bid adjustments. You can use this data to further optimize your Sponsored Products campaigns and refine your strategy for reaching valued customer segments.\n"],"documentType":"guide"},{"title":"Sponsored Products & Brands: Audience Bid Boosting","sectionHeader":{"type":2,"text":"Conclusion"},"path":"/en-us/knowledge-hub/blogs/usage-examples/2026-01-sp-sb-bid-boosting","content":[],"documentType":"guide"},{"title":"Workshops","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/overview","content":[" Get hands-on experience building advertising solutions with Amazon Ads APIs. These step-by-step workshops walk you through real-world implementations, from environment setup to deployment, so you can learn by doing.\n"],"documentType":"guide"},{"title":"Workshops","sectionHeader":{"type":2,"text":"What you will find here"},"path":"/en-us/knowledge-hub/hands-on-workshops/overview","content":[" Each workshop is a guided, multi-module learning experience designed for developers and partners building with Amazon Ads APIs. Workshops include the following:\n","Step-by-step instructions with code samples you can run immediately - Downloadable source code so you can follow along at your own pace - Architecture deep-dives explaining the design decisions behind each solution - Deployment guides to take your project from local development to production\n"],"documentType":"guide"},{"title":"Workshops","sectionHeader":{"type":2,"text":"Featured Workshops"},"path":"/en-us/knowledge-hub/hands-on-workshops/overview","content":["| # | Workshop | Duration | Level |\n","\\|---\\|---\\|---\\|---\\|\n","| 1 | Agents with Amazon Ads MCP Server — Build MCP servers, create LangGraph agents, deploy them to Amazon Bedrock AgentCore, and integrate with the Amazon Ads MCP Server. Covers custom MCP server development (Track A) and Amazon Ads API integration (Track B). | ~4 hours | Intermediate |\n","| 2 | How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop — Onboard first-party data to Amazon Ads using the ADM API, and activate it across Amazon DSP and AMC. Covers audience onboarding, DSP audiences, AMC sharing, conversion tracking, and privacy compliance. | ~3 hours | Intermediate |\n","| 3 | Multi-Agent Advertising Campaign Creation Workshop — Build and deploy a production-ready multi-agent advertising system using LangGraph, the A2A protocol, and MCP servers. Covers orchestration, RAG with S3 Vectors, and a chat frontend. | ~3 hours | Intermediate |\n","| 4 | Amazon Ads Events API: Hands-On Implementation Workshop — Send conversion events to Amazon Ads with the Events API. Covers match key normalization and hashing, purchase and offline conversions, UK and EEA consent signals, batching and deduplication, and custom attributes. | ~3 hours | Intermediate |\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":["\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":2,"text":"Workshop Overview"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" This workshop is designed to help technical teams at advertisers, agencies, and technology partners accelerate the development of agentic AI solutions for Amazon Ads. By the end of this workshop, you will have hands-on experience building MCP servers, creating LangGraph agents, deploying them to Amazon Bedrock AgentCore, and integrating with the Amazon Ads MCP Server.\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Purpose and Objectives"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":["Understand the Model Context Protocol (MCP) and how it connects AI models to external tools and APIs. - Build and deploy a custom MCP server that wraps an Amazon Bedrock Knowledge Base. - Create a LangGraph agent that discovers and orchestrates MCP tools using Claude on Amazon Bedrock. - Deploy MCP servers and agents to Amazon Bedrock AgentCore as managed runtimes. - Connect to the official Amazon Ads MCP Server to manage advertising campaigns through natural language. - Provide scalable, production-ready artifacts that teams can adapt for their own agentic AI workflows.\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Target Audience"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" This workshop is intended for solutions architects, software engineers, and technical leads who work with the Amazon Ads API and want to build AI-powered automation using MCP and AgentCore.\n","\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":2,"text":"Contributors"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" This workshop was created by Chintan Sanghavi and Christelle Ngambula, both Senior Solutions Architects at Amazon Ads. Chintan works with advertisers and partners to design scalable integrations with the Amazon Ads API, with a focus on agentic AI and MCP-based architectures. Christelle helps partners and advertisers build AI-powered advertising solutions, specializing in agent frameworks, MCP server development, and Amazon Bedrock AgentCore deployments. For questions or additional details about this workshop, connect with either contributor via LinkedIn.\n","\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":["You are starting the workshop for the first time - You want to verify your environment is ready before diving into the hands-on modules\n","\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":2,"text":"Step 1: Understand the Learning Tracks"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" This workshop is organized into two learning tracks so you can choose the depth that fits your needs.\n"," Track A — Build and Deploy Custom MCP Servers and Agents (Modules 1–6)\n"," Track A walks you through building an MCP server with FastMCP, deploying it to Amazon Bedrock AgentCore, creating a LangGraph agent that connects to the deployed MCP server, and deploying the agent to AgentCore using the A2A protocol. You will finish Track A with a fully deployed agent that can answer questions using a Bedrock Knowledge Base.\n"," Track B — Amazon Ads MCP Server Integration (Modules 7–9)\n"," Track B extends your agent by connecting it to the Amazon Ads MCP Server (open beta). You will discover Ads API tools, build a multi-server agent that combines your custom Knowledge Base MCP server with the Ads MCP Server, and test the end-to-end flow. Track B requires Amazon Ads API credentials (Client ID, Client Secret, Refresh Token). If you do not have Ads credentials, you can stop after Module 6.\n"," Module 10 — Cleanup applies to both tracks and guides you through deleting all workshop resources.\n","\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":2,"text":"Step 2: Review the Architecture"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" The diagram below shows the end-state architecture you will build across both tracks.\n"," Data flow:\n","Participant / Client → invokes the LangGraph Agent via invoke_agent_runtime (A2A) - LangGraph Agent → invokes MCP servers via invoke_agent_runtime (MCP) - LangGraph Agent → calls Claude via InvokeModel on Amazon Bedrock - Knowledge Base MCP Server → calls retrieve / retrieve_and_generate on Bedrock Knowledge Base - Amazon Ads MCP Server → calls the Amazon Ads API - LangGraph Agent → reads secrets from AWS Secrets Manager via GetSecretValue - All runtimes stream logs to CloudWatch Logs\n"," Key components:\n","Knowledge Base MCP Server — A FastMCP server you build and deploy to AgentCore. It exposes query_knowledge_base and retrieve_and_generate tools backed by an Amazon Bedrock Knowledge Base. - Amazon Ads MCP Server — The official Amazon Ads MCP Server (open beta) deployed on AgentCore. It translates natural language into Amazon Ads API calls. - LangGraph Agent — A Python agent built with LangChain and LangGraph. It discovers tools from both MCP servers, converts them to LangChain StructuredTool objects, and orchestrates calls using Claude on Amazon Bedrock. - AgentCore — The managed runtime that hosts both MCP servers and the agent. MCP servers use the MCP protocol; the agent uses the A2A protocol.\n","\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":2,"text":"Step 3: Verify Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" Confirm you have the following before starting Module 2.\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Required for All Tracks"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":["| Prerequisite | Details |\n","\\|---\\|---\\|\n","| Python 3.13+ | Required runtime for MCP servers and agents. Verify with python --version. |\n","| AWS Account | An AWS account with Amazon Bedrock access enabled in your target region. |\n","| AWS CLI configured | Run aws configure to set your access key, secret key, and default region. |\n","| AgentCore CLI | Install with pip install bedrock-agentcore and pip install --upgrade bedrock-agentcore-starter-toolkit. Verify with agentcore --help. |\n","| uv | Python package runner required by the agentcore CLI. Install with pip install uv. Verify with uv --version. |\n","| pip | Python package manager for installing dependencies. Ships with Python 3.13+. |\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Required for Track B Only (Modules 7–9)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":["| Prerequisite | Details |\n","\\|---\\|---\\|\n","| Amazon Ads API Client ID | Obtain from the Amazon Ads developer console. |\n","| Amazon Ads API Client Secret | Obtain from the Amazon Ads developer console. |\n","| Amazon Ads API Refresh Token | Generated during the OAuth flow for your Ads API application. |\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Configure AWS Credentials"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" If you have not already configured the AWS CLI, run:\n"," Enter the following when prompted:\n"," Verify your credentials are working:\n"," You should see your account ID, user ARN, and user ID. If this fails, double-check your access key and secret key.\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Create a Virtual Environment and Install Dependencies"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" Create a dedicated virtual environment for the workshop to keep dependencies isolated from your system Python:\n"," Activate the virtual environment:\n"," You should see (.venv) in your terminal prompt. Install the core dependencies:\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Verify Bedrock Access"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" Confirm Claude is available in your region:\n"," If no models appear, enable Claude in the Amazon Bedrock console under Model access.\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Optional: Install Node.js 18+ (for MCP Inspector)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" Node.js is not required for the workshop, but the MCP Inspector is a useful debugging tool that lets you connect to a running MCP server, browse its tools, and invoke them interactively. Install Node.js 18+ if you want to use it:\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Verify Your Setup"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" Run this quick verification script to confirm everything is ready. Create a file called verify_setup.py:\n"," Run it:\n"," All checks should show \\[OK]. Fix any failures before moving to Module 2.\n","\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":2,"text":"Step 4: Create an Amazon Bedrock Knowledge Base"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" The MCP server you build in Module 3 queries an Amazon Bedrock Knowledge Base. Create one now so it is ready when you need it.\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Create an S3 Bucket for Source Documents"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" Create an S3 bucket to store the documents your Knowledge Base will index:\n","Open the S3 console. 2. Click Create bucket. 3. Enter a unique bucket name (for example, workshop-kb-docs-&lt;YOUR_ACCOUNT_ID>). 4. Select your target region (for example, us-east-1). 5. Leave all other settings as default and click Create bucket. 6. Upload one or more documents (PDF, TXT, HTML, or Markdown) to the bucket. These can be product documentation, advertising best practices, campaign guides, or any reference material you want the agent to query.\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Create the Knowledge Base"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":["Open the Amazon Bedrock console. 2. In the left sidebar, click Knowledge bases under Orchestration. 3. Click Create knowledge base. 4. Enter a name (for example, workshop-knowledge-base) and an optional description. 5. Click Next.\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Configure the Data Source"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":["Select Amazon S3 as the data source. 2. Browse to the S3 bucket you created above. 3. Leave the chunking strategy as default (or choose Fixed-size chunking with 300 tokens for smaller documents). 4. Click Next.\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Select the Vector Store"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":["Select Amazon OpenSearch Serverless as the vector database. 2. Choose Quick create a new vector store — this creates an OpenSearch Serverless collection automatically. 3. Click Next.\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":3,"text":"Select the Embeddings Model"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":["Select an embeddings model (for example, Amazon Titan Embeddings V2). 2. Review the configuration summary and click Create knowledge base.\n"," The creation process takes a few minutes. Once the status shows Ready:\n","Click on your Knowledge Base to view its details. 2. Note the Knowledge Base ID — you will need this in Module 3 (for example, XFG61CFOTV). 3. Click Sync to index the documents from your S3 bucket.\n","\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":2,"text":"Step 5: Review the Module Listing"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" The table below lists all 10 modules in order. Track A covers Modules 1–6. Track B covers Modules 7–9. Module 10 applies to both tracks.\n","| Module | Title | Description | Time |\n","\\|---\\|---\\|---\\|---\\|\n","| 01 | Workshop Overview and Prerequisites | Learning tracks, architecture, prerequisites, and module listing (this module) | 20 min |\n","| 02 | MCP and AgentCore Concepts | MCP protocol primitives, AgentCore runtime, deployment types, and communication flow | 15 min |\n","| 03 | Build an MCP Server | Create a FastMCP server with query_knowledge_base and retrieve_and_generate tools | 30 min |\n","| 04 | Deploy MCP Server to AgentCore | Deploy the MCP server using agentcore configure and agentcore deploy | 20 min |\n","| 05 | Build a LangGraph Agent | Create a LangGraph agent that discovers and invokes MCP tools via AgentCore | 45 min |\n","| 06 | Deploy Agent to AgentCore | Deploy the agent as an A2A server with Secrets Manager and IAM configuration | 20 min |\n","| 07 | Connect to Amazon Ads MCP Server | Obtain Ads API credentials, configure the Ads MCP Server, and discover tools | 30 min |\n","| 08 | Build an Ads Campaign Agent | Combine the custom MCP server and Ads MCP Server into a multi-server agent | 45 min |\n","| 09 | Testing and Monitoring | End-to-end testing, CloudWatch logs, and troubleshooting | 20 min |\n","| 10 | Cleanup and Next Steps | Delete all workshop resources and links to further reading | 10 min |\n"," Total estimated time: ~4 hours (Track A: ~2.5 hours, Track B adds ~1.5 hours)\n","\n"],"documentType":"guide"},{"title":"Module 1: Workshop Overview and Prerequisites","sectionHeader":{"type":2,"text":"Step 6: Understand What You Will Build"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/01-overview","content":[" By the end of this workshop you will have built and deployed the following:\n","A Knowledge Base MCP Server — A Python application built with FastMCP that wraps an Amazon Bedrock Knowledge Base. It exposes two MCP tools (query_knowledge_base and retrieve_and_generate) and runs on AgentCore using the MCP protocol with stateless_http transport.\n","A LangGraph Agent — A Python agent that uses Claude on Amazon Bedrock as its foundation model. The agent connects to your deployed MCP server (and optionally the Amazon Ads MCP Server), discovers available tools at runtime via tools/list, converts them to LangChain StructuredTool objects, and uses create_react_agent to orchestrate multi-step tool calls.\n","An Ads Campaign Agent (Track B) — An extended version of the LangGraph agent that aggregates tools from both your custom Knowledge Base MCP server and the Amazon Ads MCP Server. You can send natural language prompts like \"Create a Sponsored Products campaign for my top-selling items\" and the agent will orchestrate the correct sequence of Ads API calls.\n"," All components are deployed to Amazon Bedrock AgentCore using the agentcore CLI. MCP servers use the MCP protocol. Agents use the A2A protocol. Secrets (ARNs, credentials) are stored in AWS Secrets Manager. Logs stream to CloudWatch.\n","\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":["You are new to MCP or AgentCore and want a conceptual foundation before the hands-on modules - You need a reference for how MCP servers and agents communicate through AgentCore\n","\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":2,"text":"Step 1: Understand the Model Context Protocol (MCP)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[" The Model Context Protocol (MCP) is an open standard created by Anthropic for connecting AI models to external tools and data sources. MCP defines a client-server architecture where an AI agent (the client) discovers and invokes capabilities exposed by an MCP server.\n"," MCP defines three primitives:\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":3,"text":"Tools"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[" Tools are functions that an MCP server exposes for agents to invoke. Each tool has a name, a description, and an input schema that defines the parameters it accepts. When an agent calls a tool, the MCP server executes the underlying logic and returns a result.\n"," Example: A Knowledge Base MCP server might expose a query_knowledge_base tool that accepts a query string and returns matching documents.\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":3,"text":"Resources"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[" Resources are read-only data sources that an MCP server can expose. Unlike tools, resources do not perform actions — they provide data that an agent can read. Resources are identified by URIs and can represent files, database records, API responses, or any other data.\n"," Example: An MCP server could expose a config://settings resource that returns the current server configuration.\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":3,"text":"Prompts"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[" Prompts are reusable prompt templates that an MCP server can expose. They allow server authors to define structured interactions that agents can invoke with specific arguments. Prompts help standardize how agents interact with a particular domain.\n"," Example: An MCP server could expose a summarize_document prompt template that accepts a document URI and returns a summarization prompt pre-filled with the document content.\n","\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":2,"text":"Step 2: Understand the AgentCore Runtime"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[" Amazon Bedrock AgentCore is a managed runtime for deploying MCP servers and AI agents. AgentCore handles infrastructure provisioning, scaling, networking, and observability so you can focus on application logic.\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":3,"text":"Deployment Types"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[" AgentCore supports two deployment types:\n","| Deployment Type | Protocol | Use Case |\n","\\|---\\|---\\|---\\|\n","| MCP Server | server_protocol: MCP | Deploy a FastMCP server that exposes tools, resources, or prompts via the MCP protocol |\n","| A2A Agent | server_protocol: A2A | Deploy an AI agent (for example, a LangGraph agent) that orchestrates calls to MCP servers and foundation models |\n"," Both deployment types use the same CLI workflow (agentcore configure → agentcore deploy) and produce a Runtime ARN that clients use to invoke the deployed application.\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":3,"text":"Supported Protocols"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":["MCP (Model Context Protocol) — Used for MCP servers. Clients interact with the server by sending MCP requests (for example, tools/list, tools/call) through AgentCore. - A2A (Agent-to-Agent) — Used for agents. Clients send natural language prompts to the agent through AgentCore. The agent processes the prompt, invokes tools on MCP servers, calls foundation models, and returns a response.\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":3,"text":"The Role of Deployment_Config"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[" The Deployment_Config (.bedrock_agentcore.yaml) is a configuration file that tells AgentCore how to deploy your application. It specifies:\n","The entrypoint file (for example, mcp_knowledgebase.py) - The runtime type (for example, PYTHON_3_13) - The protocol (MCP or A2A) - Network configuration (for example, PUBLIC) - Observability settings (CloudWatch logging) - Memory mode (for example, NO_MEMORY or STM_AND_LTM)\n","\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":2,"text":"Step 3: Understand the Communication Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[" The diagram below shows how a client request flows through AgentCore to an MCP server and back.\n"," How it works:\n","The Client sends a request to AgentCore using the invoke_agent_runtime API (JSON-RPC format). The request targets a specific Runtime ARN. 2. AgentCore forwards the request to the deployed MCP server using the streamable-http transport. 3. The MCP Server processes the request by calling a backend service (for example, Amazon Bedrock Knowledge Base via boto3, or the Amazon Ads API). 4. The Backend Service returns data to the MCP server. 5. The MCP Server formats the result as an MCP response and returns it to AgentCore. 6. AgentCore delivers the response to the client as JSON or Server-Sent Events (SSE).\n"," When an A2A agent is involved, the flow adds an extra layer: the client talks to the agent (A2A), and the agent talks to one or more MCP servers (MCP) through AgentCore. The agent also calls a foundation model (for example, Claude via Amazon Bedrock) to reason about which tools to invoke.\n","\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":2,"text":"Step 4: Compare MCP and A2A Deployments"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[" Understanding the difference between MCP and A2A deployments is key to designing your architecture.\n","| Aspect | MCP Server Deployment | A2A Agent Deployment |\n","\\|---\\|---\\|---\\|\n","| Protocol | server_protocol: MCP | server_protocol: A2A |\n","| Purpose | Expose tools, resources, or prompts | Orchestrate tool calls and model reasoning |\n","| Entrypoint | A FastMCP server (for example, mcp_knowledgebase.py) | A LangGraph agent (for example, campaign_agent.py) |\n","| Invocation | Clients send MCP requests (tools/list, tools/call) | Clients send natural language prompts |\n","| Foundation model | Not required — the server executes tool logic directly | Required — the agent uses a model (for example, Claude) to decide which tools to call |\n","| Connects to | Backend services (Knowledge Base, APIs) | MCP servers (via AgentCore) + foundation models (via Bedrock) |\n","| Example CLI | agentcore configure --protocol MCP | agentcore configure --protocol A2A |\n"," In this workshop:\n","Module 3–4: You build and deploy a Knowledge Base MCP server (server_protocol: MCP). It exposes tools that query a Bedrock Knowledge Base. - Module 5–6: You build and deploy a LangGraph agent (server_protocol: A2A). It discovers tools on your MCP server, converts them to LangChain StructuredTool objects, and uses Claude to orchestrate calls. - Module 7–8: You connect the agent to a second MCP server (the Amazon Ads MCP Server) and aggregate tools from both servers.\n","\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":2,"text":"Step 5: Understand the `stateless_http` Transport Mode"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":[" When you build an MCP server with FastMCP for deployment on AgentCore, you configure it with stateless_http=True. This setting controls how the MCP server communicates with AgentCore.\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":3,"text":"What `stateless_http` Does"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":["Transport: The server uses the Streamable HTTP transport instead of stdio (standard input/output). AgentCore sends MCP requests to the server over HTTP, and the server responds over the same connection. - Stateless: Each request is independent. The server does not maintain session state between requests. This is required for AgentCore deployments because AgentCore may route requests to different server instances. - Scalable: Because there is no session affinity, AgentCore can scale the server horizontally by adding more instances behind the same Runtime ARN.\n"],"documentType":"guide"},{"title":"Module 2: MCP and AgentCore Concepts","sectionHeader":{"type":3,"text":"When to Use Each Transport"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/02-concepts","content":["| Transport | Setting | Use Case |\n","\\|---\\|---\\|---\\|\n","| stdio | Default (no flag) | Local development and testing. The MCP client communicates with the server via standard input/output. |\n","| stateless_http | stateless_http=True | AgentCore deployment. The server listens for HTTP requests from AgentCore. |\n","\n"],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":[],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":["You have completed Module 2 and understand MCP concepts - You want to build a working MCP server before deploying it to AgentCore in Module 4\n","\n"],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":{"type":2,"text":"Step 1: Set Up the Project Structure"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":[" Create a new directory inside your workshop-mcp folder for the MCP server.\n"," Create a requirements.txt file with the following dependencies:\n"," Install the dependencies:\n","\n"],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":{"type":2,"text":"Step 2: Configure Environment Variables"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":[" Create a .env.example file that lists all required environment variables with placeholder values. Copy this to .env and fill in your actual values.\n","| Variable | Description |\n","\\|---\\|---\\|\n","| KNOWLEDGE_BASE_ID | The ID of your Amazon Bedrock Knowledge Base |\n","| AWS_REGION | AWS region where your Knowledge Base is deployed |\n","| KB_MCP_PORT | Port the MCP server listens on (default: 8000, required by AgentCore) |\n","\n"],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":{"type":2,"text":"Step 3: Initialize the FastMCP Server"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":[" Create a file named mcp_knowledgebase.py. Start by importing dependencies and initializing the FastMCP instance with stateless_http=True.\n"," Key points:\n","stateless_http=True configures the server to use the Streamable HTTP transport required by AgentCore (see Module 2, Step 5). - host=\"0.0.0.0\" allows AgentCore to reach the server from outside the container. - port=KB_MCP_PORT defaults to 8000, which is the port AgentCore expects. - Logging uses print() with \\[INFO]/\\[ERROR] prefixes for CloudWatch compatibility.\n","\n"],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":{"type":2,"text":"Step 4: Initialize the Bedrock Client"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":[" Add a lazy-initialization function for the Bedrock Agent Runtime client. This avoids creating the client at import time, which helps with testing.\n","\n"],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":{"type":2,"text":"Step 5: Define the `query_knowledge_base` Tool"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":[" Add the first MCP tool using the @mcp.tool() decorator. This tool queries the Knowledge Base and returns matching documents.\n"," How it works:\n","The @mcp.tool() decorator registers the function as an MCP tool. Agents discover it via tools/list and invoke it via tools/call. - The function validates that KNOWLEDGE_BASE_ID is set, then calls the Bedrock retrieve API. - Results are returned as a JSON string. On error, a JSON object with an error key is returned instead of raising an exception.\n","\n"],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":{"type":2,"text":"Step 6: Add the Server Entrypoint"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":[" Add the \\_\\_main\\_\\_ block at the bottom of mcp_knowledgebase.py. This block supports two modes: a test mode for quick validation and the production mode that starts the HTTP transport.\n"," Two modes:\n","Test mode (python mcp_knowledgebase.py test): Calls the tool directly with a sample query and prints the results. Use this to verify your Knowledge Base connection before deploying. - Production mode (python mcp_knowledgebase.py): Starts the MCP server with the streamable-http transport. AgentCore uses this mode when running your server.\n","\n"],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":{"type":2,"text":"Step 7: Test Locally in Test Mode"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":[" Run the server in test mode to verify that your tool works and your Knowledge Base connection is configured correctly.\n"," You should see output similar to:\n"," If you see an error like {\"error\": \"KNOWLEDGE_BASE_ID not configured\"}, verify that your .env file contains a valid KNOWLEDGE_BASE_ID.\n","\n"],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":{"type":2,"text":"Step 8: Test with MCP Inspector (Optional)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":[" If you have Node.js 18+ installed, you can use the MCP Inspector for interactive visual testing. First, start your server in production mode:\n"," In a separate terminal, launch the inspector:\n"," Open the URL it prints (typically http&#x3A;//localhost:6274), select Streamable HTTP as the transport, enter http&#x3A;//localhost:8000/mcp as the server URL, and click Connect. Then click the Tools tab and List Tools to see your tool. You can invoke it directly from the inspector UI to verify the response.\n"," Press Ctrl+C in both terminals when done.\n","\n"],"documentType":"guide"},{"title":"Module 3: Build an MCP Server","sectionHeader":{"type":2,"text":"Step 9: Review the Complete Server"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/03-build-mcp-server","content":[" Your mcp-knowledgebase/ directory should now contain:\n"," The MCP server exposes one tool:\n","| Tool | Description | Key Parameters |\n","\\|---\\|---\\|---\\|\n","| query_knowledge_base | Retrieves matching documents from the Knowledge Base | query (str), max_results (int, default 5) |\n"," The tool returns a JSON string. On success, the JSON contains the results. On failure, the JSON contains an error key with a description of the problem.\n"," In the next module, you will deploy this server to Amazon Bedrock AgentCore using the agentcore CLI.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":["You have completed Module 3 and have a working MCP server (mcp_knowledgebase.py) - You want to deploy the server to AgentCore so that agents can discover and invoke its tools remotely\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 1: Install the AgentCore Toolkit"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" Install the AgentCore CLI tool, which provides the agentcore configure and agentcore deploy commands for deploying runtimes.\n"," Verify the installation:\n"," You should see a list of available commands including configure, deploy, and invoke.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 2: Understand the Deployment Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" The diagram below shows the deployment flow you will follow in this module. The agentcore CLI handles configuration, packaging, and uploading your code to AgentCore.\n"," Two commands handle the entire deployment:\n","agentcore configure — Walks you through an interactive setup and generates the .bedrock_agentcore.yaml configuration file. 2. agentcore deploy — Packages your code and configuration, uploads everything to AgentCore, and returns a Runtime ARN.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 3: Configure the Deployment"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" Navigate to your MCP server directory and run agentcore configure with the --protocol MCP flag. This tells AgentCore that your runtime is an MCP server (not an A2A agent).\n","| Flag | Description |\n","\\|---\\|---\\|\n","| -e mcp_knowledgebase.py | The entrypoint file that AgentCore runs to start your server |\n","| --protocol MCP | Declares this runtime as an MCP server (uses the MCP protocol) |\n","| --runtime PYTHON_3_13 | Specifies the Python 3.13 runtime environment |\n","| -rf requirements.txt | Points to the file listing your pip dependencies |\n"," The CLI walks you through an interactive setup. Accept the defaults for each prompt:\n"," After completing the prompts, the CLI displays a configuration summary and saves the .bedrock_agentcore.yaml file:\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 4: Review the Auto-Generated Configuration"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" The agentcore configure command creates a .bedrock_agentcore.yaml file that looks similar to this:\n"," Key fields:\n","server_protocol: MCP — Confirms this runtime uses the MCP protocol. Agents will communicate with it using the MCP tools/list and tools/call methods. - deployment_type: direct_code_deploy — AgentCore packages and deploys your Python code directly. - execution_role_auto_create: true — AgentCore creates an IAM execution role for the runtime automatically. - network_mode: PUBLIC — The runtime is accessible over the public network. - mode: NO_MEMORY — MCP servers are stateless and do not use AgentCore memory.\n"," You do not need to modify this file. The agentcore configure command sets all values based on the flags you provided.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 5: Deploy to AgentCore"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" Deploy the server:\n"," The CLI packages your code (mcp_knowledgebase.py, requirements.txt, and any other files in the directory), uploads everything to AgentCore, and provisions the runtime.\n"," After a successful deployment, the CLI displays a Runtime ARN:\n"," Save this ARN. You will need it in Module 5 when you build a LangGraph agent that connects to this MCP server.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 6: Add Environment Variables and Host the Agent"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" After deployment, you need to add your environment variables (like KNOWLEDGE_BASE_ID) through the AWS console before the MCP server can connect to your Knowledge Base.\n","Sign in to the AWS Management Console. 2. Navigate to Amazon Bedrock > AgentCore in the left sidebar, then click Runtime under the Build section in the left navigation panel. 3. Find your mcp_knowledgebase runtime in the list and click on it. 4. Click Update hosting. 5. Click Advanced configuration to expand the additional settings. 6. In the Environment variables section, add the following key-value pairs:\n","| Key | Value |\n","\\|---\\|---\\|\n","| KNOWLEDGE_BASE_ID | Your Bedrock Knowledge Base ID |\n","| AWS_REGION | us-east-1 (or your target region) |\n","Click Host agent/tool to save the configuration and redeploy with the environment variables.\n"," Wait for the status to show Active before proceeding to the next step.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 7: Update IAM Permissions for the Execution Role"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" The AgentCore execution role needs permission to call the Bedrock Knowledge Base APIs. Without this, you will get an AccessDeniedException when the MCP server tries to query the Knowledge Base.\n","In the AgentCore runtime details page, click the latest version under the Endpoints section. The Execution role ARN is listed under Permissions > IAM service role (it looks like AmazonBedrockAgentCoreSDKRuntime-us-east-1-XXXXXXXXXX). 2. Open the IAM console and search for that role name. 3. Click on the role, then click Add permissions > Create inline policy. 4. Switch to the JSON tab and paste the following policy:\n"," Replace &lt;YOUR_REGION>, &lt;YOUR_ACCOUNT_ID>, and &lt;YOUR_KNOWLEDGE_BASE_ID> with your actual values.\n","Click Next, name the policy BedrockKnowledgeBaseAccess, and click Create policy.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 8: Test the Endpoint from the Console"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" Once the runtime is active, verify it works using the built-in test endpoint in the console.\n","In the AgentCore runtime details page, scroll down to the Endpoints section. 2. Select the new version that was created by your deployment. 3. Click Test endpoint. 4. In the test panel, send a tools/list request to verify your tool is discoverable:\n"," You should see the query_knowledge_base tool in the response.\n","Test the tool by sending a tools/call request:\n"," A successful response confirms that:\n","Your MCP server is running on AgentCore. 2. The query_knowledge_base tool is accessible via tools/call. 3. The server can reach your Amazon Bedrock Knowledge Base from the AgentCore runtime.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 9: View Runtime Logs"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" AgentCore streams runtime logs to Amazon CloudWatch. The log group name follows the pattern /aws/bedrock-agentcore/runtimes/&lt;RUNTIME_NAME>-&lt;RUNTIME_ID>-DEFAULT.\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":3,"text":"Find the Log Group in the Console"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":["Open the CloudWatch Logs console. 2. In the Filter box, type /aws/bedrock-agentcore/runtimes/mcp_knowledgebase to narrow the results. 3. You should see a log group like /aws/bedrock-agentcore/runtimes/mcp_knowledgebase-r4Th4q5u1b-DEFAULT (the ID portion will differ for your deployment). 4. Click on the log group, then click on the latest log stream to view the server output.\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":3,"text":"Tail Logs from the CLI"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" You can also tail the logs from your terminal. Replace the log group name with the one you found in the console:\n"," You should see the \\[INFO] log messages from your server, including initialization messages and any tool invocation logs.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 10: Troubleshooting"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" If your deployment or invocation fails, work through this checklist.\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":3,"text":"Deployment Fails (`agentcore deploy`)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":["| Issue | Solution |\n","\\|---\\|---\\|\n","| Missing IAM permissions | Ensure your AWS credentials have permissions to create AgentCore runtimes. Run aws sts get-caller-identity to verify your identity. |\n","| Incorrect entrypoint | Verify the -e flag points to the correct Python file. The file must exist in the current directory. |\n","| Missing dependencies | Ensure all imports in your entrypoint are listed in requirements.txt. Run pip install -r requirements.txt locally to verify. |\n","| AWS credentials not configured | Run aws configure to set your access key, secret key, and default region. |\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":3,"text":"Invocation Fails (`invoke_agent_runtime`)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":["| Issue | Solution |\n","\\|---\\|---\\|\n","| Runtime not found | Double-check the Runtime ARN. Copy it exactly from the agentcore deploy output. |\n","| Timeout error | The MCP server may be initializing. Wait 30–60 seconds after deployment and retry. |\n","| Tool returns error JSON | Check that environment variables (KNOWLEDGE_BASE_ID, AWS_REGION) are set. You may need to redeploy with the variables configured. |\n","| Access denied | Verify the AgentCore execution role has permissions to access your Bedrock Knowledge Base. |\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":3,"text":"General Checks"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" If you continue to have issues, verify that your MCP server runs correctly in local test mode (python mcp_knowledgebase.py test) before redeploying.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Step 11: Summary"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" In this module you deployed your Knowledge Base MCP server to AgentCore using two commands:\n","agentcore configure — Generated the .bedrock_agentcore.yaml configuration with --protocol MCP. 2. agentcore deploy — Packaged and deployed your code to AgentCore.\n"," You verified the deployment by invoking the MCP server via invoke_agent_runtime and confirmed that the query_knowledge_base tool is accessible remotely.\n"," Your MCP server is now running as a managed runtime on AgentCore. In the next module, you will build a LangGraph agent that connects to this deployed MCP server, discovers its tools, and orchestrates multi-step queries.\n","\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":2,"text":"Security Considerations"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" This workshop uses network_mode: PUBLIC and IAM authorization for simplicity. For production deployments, apply the following security practices.\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":3,"text":"Deploy in a VPC (Private Network)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" In this workshop the MCP server is deployed with public network access so you can test it easily. In production, deploy your MCP servers inside a VPC with private subnets to prevent direct internet access. You can configure this during agentcore configure by selecting a VPC and private subnets, or by setting network_mode: VPC in the .bedrock_agentcore.yaml file. Only other resources within the same VPC (or connected via VPC peering / PrivateLink) will be able to reach the runtime.\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":3,"text":"IAM Authorization (Default)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" AgentCore uses IAM authorization by default. Every call to invoke_agent_runtime must be signed with valid AWS credentials, and the IAM policy of the caller must include bedrock-agentcore:InvokeAgentRuntime permission on the runtime ARN. This is the approach used throughout this workshop. For production, scope the resource ARN in your IAM policies to specific runtimes rather than using wildcards (runtime/\\*).\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":3,"text":"OAuth / JWT Authorization"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":[" For scenarios where external clients (outside your AWS account) need to invoke your MCP server, AgentCore supports OAuth authorization with JWT token validation. During agentcore configure, select \"yes\" when prompted for OAuth authorizer configuration and provide your OAuth issuer URL and audience. AgentCore will validate the JWT token on every request before forwarding it to your runtime. You can also configure allowed request headers (for example, Authorization, X-Amzn-Bedrock-AgentCore-Runtime-Custom-\\*) to pass custom headers through to your server.\n"],"documentType":"guide"},{"title":"Module 4: Deploy MCP Server to AgentCore","sectionHeader":{"type":3,"text":"Additional Recommendations"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/04-deploy-mcp-server","content":["Store all secrets (API keys, ARNs, credentials) in AWS Secrets Manager — never hardcode them in your source code or environment variables. - Apply least-privilege IAM policies to the AgentCore execution role. Grant only the specific actions and resources your MCP server needs (for example, bedrock:Retrieve on a specific Knowledge Base ARN). - Enable CloudWatch logging (enabled by default) and set up CloudWatch Alarms for error rates and latency. - Rotate credentials regularly and use short-lived tokens where possible.\n","\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":["You have completed Module 4 and have a deployed MCP server with a Runtime ARN - You want to build an agent that can discover and invoke MCP tools via AgentCore\n","\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":2,"text":"Step 1: Set Up the Project"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[" Create a new directory in workshop-mcp directory for your agent and add the required files.\n"," Create a requirements.txt with the following dependencies:\n"," Install the dependencies:\n","\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":2,"text":"Step 2: Configure Environment Variables"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[" Create a .env.example file listing the required environment variables. Copy this to .env and fill in your values.\n","| Variable | Description |\n","\\|---\\|---\\|\n","| SECRET_NAME | Name of the AWS Secrets Manager secret that stores your configuration. Used when deployed to AgentCore. |\n","| AWS_REGION | AWS region where your MCP server and Bedrock models are deployed. |\n","| MCP_KB_ARN | Runtime ARN of the Knowledge Base MCP server you deployed in Module 4. |\n","| MODEL_ID | Bedrock model ID for the LLM. Uses cross-region inference prefix us. to avoid on-demand throughput errors. |\n"," Create your .env file from the example:\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":3,"text":"Create a Secrets Manager Secret"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[" The agent loads its configuration from AWS Secrets Manager when deployed to AgentCore. Create the secret now so it is ready for deployment in Module 6.\n"," Replace &lt;YOUR_SECRET_NAME> with a descriptive name (for example, workshop/kb-agent-config), and &lt;YOUR_MCP_KB_RUNTIME_ARN> with the Runtime ARN from Module 4.\n"," Verify the secret was created:\n"," Update your .env file with the secret name you chose:\n","\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":2,"text":"Step 3: Set Up Logging and Configuration Loading"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[" Create a file named kb_agent.py. Start with imports, logging helpers, and the configuration loader that reads from AWS Secrets Manager with a fallback to environment variables.\n"," Key points:\n","The agent loads its configuration from Secrets Manager when deployed to AgentCore. Locally, it falls back to the .env file. - Only one MCP server is configured here — the Knowledge Base server from Module 4. Module 8 expands this to multiple servers.\n","\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":2,"text":"Step 4: Connect to the MCP Server via AgentCore"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[" Add the functions that communicate with your deployed MCP server through the AgentCore invoke_agent_runtime API.\n"," This function sends a JSON-RPC request to the deployed MCP server through the AgentCore invoke_agent_runtime API. It handles both SSE (Server-Sent Events) and plain JSON response formats that AgentCore may return.\n","\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":2,"text":"Step 5: Discover Tools via `tools/list`"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[" MCP servers expose their available tools through the tools/list method. When the agent starts, it calls tools/list on each configured MCP server to discover what tools are available.\n"," The tools/list response returns an array of tool definitions, each containing:\n"," You will use this discovery step in the agent initialization (Step 7). The key call is:\n"," This dynamic discovery means your agent automatically adapts if tools are added or removed from the MCP server — no code changes needed on the agent side.\n","\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":2,"text":"Step 6: Convert MCP Tools to LangChain StructuredTool Objects"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[" LangGraph agents work with LangChain StructuredTool objects. Add a function that converts each MCP tool definition into a StructuredTool with a Pydantic schema for its arguments.\n"," How it works:\n","Prefixes the tool name with the server name (knowledge_base_query_knowledge_base) to avoid collisions when multiple MCP servers expose tools with the same name. 2. Builds a Pydantic model from the MCP inputSchema so LangChain can validate arguments before calling the tool. 3. Wraps the MCP call in a function that sends tools/call to the MCP server via AgentCore and extracts the text content from the response.\n","\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":2,"text":"Step 7: Create the LangGraph Agent"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[" Add the lazy initialization function that discovers tools from the MCP server, initializes Claude via ChatBedrock, and creates a create_agent graph.\n"," What happens during initialization:\n","Tool discovery — The agent calls initialize (MCP protocol handshake) and then tools/list on the Knowledge Base MCP server to get the list of available tools. 2. Tool conversion — Each MCP tool definition is converted to a LangChain StructuredTool using the create_langchain_tool function from Step 6. 3. LLM setup — A ChatBedrock instance is created pointing to Claude. You can change the model_id to use a different Claude variant. 4. Graph creation — create_agent creates a ReAct agent that can reason about which tools to call and in what order.\n","\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":2,"text":"Step 8: Add the A2A Server Endpoint"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[" Wrap the agent in a FastAPI application that accepts A2A JSON-RPC requests. This is the entrypoint that AgentCore will run when you deploy the agent in Module 6.\n"," The FastAPI app exposes a single POST / endpoint that:\n","Extracts the user message from the A2A request body. 2. Initializes the agent on the first request (lazy initialization). 3. Invokes the LangGraph agent with the user message. 4. Returns the response in A2A JSON-RPC format.\n","\n","\n"],"documentType":"guide"},{"title":"Module 5: Build a LangGraph Agent","sectionHeader":{"type":2,"text":"Step 9: Review the Complete File Structure"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/05-build-langgraph-agent","content":[" After completing this module, your kb-agent/ directory should contain:\n"," What you built:\n","A LangGraph agent that connects to a deployed MCP server on AgentCore via invoke_agent_runtime. - Dynamic tool discovery using the MCP tools/list method — the agent adapts automatically when tools change on the server. - MCP tool definitions converted to LangChain StructuredTool objects with Pydantic schemas for argument validation. - A create_agent graph that uses Claude to reason about which tools to call and in what order. - A FastAPI A2A server ready for deployment to AgentCore in the next module.\n","\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":[],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":["You have completed Module 5 and have a working LangGraph agent (kb_agent.py) - You have a deployed MCP server from Module 4 with a Runtime ARN - You have created a Secrets Manager secret in Module 5 with the MCP server ARN - You want to deploy the agent to AgentCore so it can be invoked as a managed runtime\n","\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":2,"text":"Step 1: Configure the Deployment"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":[" Navigate to your agent directory and run agentcore configure with the --protocol A2A flag. This tells AgentCore that your runtime is an A2A agent (not an MCP server).\n","| Flag | Description |\n","\\|---\\|---\\|\n","| -e kb_agent.py | The entrypoint file that AgentCore runs to start your agent |\n","| --protocol A2A | Declares this runtime as an A2A agent (uses the Agent-to-Agent protocol) |\n","| --runtime PYTHON_3_13 | Specifies the Python 3.13 runtime environment |\n","| -rf requirements.txt | Points to the file listing your pip dependencies |\n"," The CLI walks you through an interactive setup. Accept the defaults for each prompt:\n"," After completing the prompts, the CLI displays a configuration summary:\n","\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":2,"text":"Step 2: Review the Auto-Generated Configuration"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":[" The agentcore configure command creates a .bedrock_agentcore.yaml file that looks similar to this:\n"," Key differences from the MCP server deployment in Module 4:\n","server_protocol: A2A — The agent uses the Agent-to-Agent protocol instead of MCP. Clients communicate with it by sending natural language prompts rather than MCP JSON-RPC requests. - The rest of the configuration is identical: direct_code_deploy, auto-created execution role, public network, and CloudWatch observability enabled.\n"," You do not need to modify this file. The agentcore configure command sets all values based on the flags you provided.\n","\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":2,"text":"Step 3: Deploy to AgentCore"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":[" Launch the deployment:\n"," The CLI packages your code (kb_agent.py, requirements.txt, and any other files in the directory), uploads everything to AgentCore, and provisions the runtime.\n"," After a successful deployment, the CLI displays a Runtime ARN:\n"," Save this ARN. You will need it to test the agent and in later modules if you extend the agent with additional MCP servers.\n","\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":2,"text":"Step 4: Add Environment Variables and Host the Agent"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":[" After deployment, add your environment variables through the AWS console so the agent can read the Secrets Manager secret name.\n","Sign in to the AWS Management Console. 2. Navigate to Amazon Bedrock > AgentCore in the left sidebar. 3. Find your kb_agent runtime in the list and click on it. 4. Click Update hosting. 5. Click Advanced configuration to expand the additional settings. 6. In the Environment variables section, add the following key-value pairs:\n","| Key | Value |\n","\\|---\\|---\\|\n","| SECRET_NAME | The name of your Secrets Manager secret (for example, workshop/kb-agent-config) |\n","| AWS_REGION | us-east-1 (or your target region) |\n","| MODEL_ID | us.anthropic.claude-sonnet-4-6 (or your preferred Bedrock model ID) |\n","Click Host agent/tool to save the configuration and redeploy with the environment variables.\n"," Wait for the status to show Active before proceeding.\n","\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":2,"text":"Step 5: Update IAM Permissions for the Execution Role"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":[" The AgentCore execution role needs permissions to access Secrets Manager, invoke MCP servers, call Bedrock models, and write logs.\n","In the AgentCore runtime details page, click the latest version under the Endpoints section. The Execution role ARN is listed under Permissions > IAM service role (it looks like AmazonBedrockAgentCoreSDKRuntime-us-east-1-XXXXXXXXXX). 2. Open the IAM console and search for that role name. 3. Click on the role, then click Add permissions > Create inline policy. 4. Switch to the JSON tab and paste the following policy:\n","Click Next, name the policy AgentCoreAgentPolicy, and click Create policy.\n","\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":2,"text":"Step 6: Test the Endpoint from the Console"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":[" Once the runtime is active, verify it works using the built-in test endpoint.\n","In the AgentCore runtime details page, scroll down to the Endpoints section. 2. Select the new version that was created by your deployment. 3. Click Test endpoint. 4. Send a natural language prompt:\n"," A successful response confirms that:\n","Your agent is running on AgentCore. 2. The agent loaded its configuration from Secrets Manager. 3. The agent discovered tools from the Knowledge Base MCP server. 4. Claude processed the prompt and orchestrated the correct tool calls.\n","\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":2,"text":"Step 7: View Runtime Logs"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":[" AgentCore streams runtime logs to Amazon CloudWatch. The log group name follows the pattern /aws/bedrock-agentcore/runtimes/&lt;RUNTIME_NAME>-&lt;RUNTIME_ID>-DEFAULT.\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":3,"text":"Find the Log Group in the Console"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":["Open the CloudWatch Logs console. 2. In the Filter box, type /aws/bedrock-agentcore/runtimes/kb_agent to narrow the results. 3. Click on the log group, then click on the latest log stream.\n"," You should see the \\[INFO] log messages from your agent, including:\n","Configuration loading from Secrets Manager - MCP server tool discovery (tools/list) - Tool invocations (tools/call) for each user request - Claude model invocations and response generation\n","\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":2,"text":"Step 8: Troubleshooting"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":[" If your deployment or invocation fails, work through this checklist.\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":3,"text":"Deployment Fails (`agentcore deploy`)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":["| Issue | Solution |\n","\\|---\\|---\\|\n","| Missing IAM permissions | Ensure your AWS credentials have permissions to create AgentCore runtimes. Run aws sts get-caller-identity to verify your identity. |\n","| Incorrect entrypoint | Verify the -e flag points to the correct Python file. The file must exist in the current directory. |\n","| Missing dependencies | Ensure all imports in your entrypoint are listed in requirements.txt. Run pip install -r requirements.txt locally to verify. |\n","| AWS credentials not configured | Run aws configure to set your access key, secret key, and default region. |\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":3,"text":"Agent Invocation Fails"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":["| Issue | Solution |\n","\\|---\\|---\\|\n","| Secrets Manager access denied | Verify the execution role has secretsmanager:GetSecretValue permission for your secret. See Step 5. |\n","| MCP server connection fails | Verify the MCP_KB_ARN in your Secrets Manager secret matches the ARN from Module 4. Test the MCP server directly from the AgentCore console. |\n","| Bedrock model access denied | Verify the execution role has bedrock:InvokeModel permission. Ensure Claude is enabled in your Bedrock console for the target region. |\n","| Timeout on first request | The agent initializes lazily on the first request. Wait 30–60 seconds and retry. |\n","| Empty or error response | Check CloudWatch logs for \\[ERROR] messages. Common causes: missing environment variables, incorrect secret structure, MCP server not responding. |\n","\n"],"documentType":"guide"},{"title":"Module 6: Deploy Agent to AgentCore","sectionHeader":{"type":2,"text":"Step 9: Summary"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/06-deploy-agent","content":[" In this module you deployed your LangGraph agent to AgentCore as an A2A server:\n","agentcore configure — Generated the .bedrock_agentcore.yaml configuration with --protocol A2A. 2. agentcore deploy — Packaged and deployed your agent code to AgentCore. 3. Environment variables — Added SECRET_NAME and AWS_REGION through the AgentCore console. 4. IAM permissions — Configured the execution role with access to Secrets Manager, AgentCore runtimes, Bedrock models, and CloudWatch Logs. 5. Testing — Verified the agent responds to natural language prompts via the console test endpoint.\n"," Your agent is now running as a managed A2A runtime on AgentCore. It loads configuration from Secrets Manager, discovers tools from the Knowledge Base MCP server, and uses Claude to orchestrate responses.\n"," This completes Track A of the workshop. In the next module, you will begin Track B by connecting to the Amazon Ads MCP Server.\n","\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":[],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":["You have completed Track A (Modules 1–6) and have a working agent deployed on AgentCore - You have Amazon Ads API credentials (Client ID, Client Secret, Refresh Token) - You want to extend your agent with Amazon Ads capabilities in Track B\n","\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"Step 1: Obtain Amazon Ads API Credentials"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":[" To connect to the Amazon Ads MCP Server, you need three credentials from the Amazon Ads developer console.\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":3,"text":"Register an Application"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":["Go to the Amazon Ads developer console. 2. Register a new application (or use an existing one). 3. Note the Client ID and Client Secret assigned to your application.\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":3,"text":"Generate a Refresh Token"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":["Complete the OAuth authorization flow for your registered application. 2. Exchange the authorization code for an access token and Refresh Token. 3. Store the Refresh Token securely — the Ads MCP Server uses it to obtain short-lived access tokens automatically.\n","| Credential | Description |\n","\\|---\\|---\\|\n","| Client ID | Identifies your registered application with the Amazon Ads API |\n","| Client Secret | Secret key paired with your Client ID for authentication |\n","| Refresh Token | Long-lived token used to obtain short-lived access tokens without re-authorization |\n","\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"Step 2: Install Additional Dependencies"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":[" The Ads MCP Server connection uses langchain-mcp-adapters for tool discovery via Streamable HTTP. Add these to your requirements.txt:\n"," Install them:\n","\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"Step 3: Understand the Connection Pattern"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":[" Unlike the Knowledge Base MCP server (which you deployed to AgentCore and connect to via invoke_agent_runtime), the Amazon Ads MCP Server is a remote managed endpoint that you connect to directly via Streamable HTTP.\n"," The connection requires: 1. An access token obtained by exchanging your Refresh Token via the Amazon OAuth endpoint. 2. The MCP Server URL for your region. 3. Your Client ID passed as a header.\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":3,"text":"MCP Server URLs"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":["| Region | Endpoint URL |\n","\\|--------\\|-------------\\|\n","| NA (North America) | https&#x3A;//advertising-ai.amazon.com/mcp |\n","| EU (Europe) | https&#x3A;//advertising-ai-eu.amazon.com/mcp |\n","| FE (Far East) | https&#x3A;//advertising-ai-fe.amazon.com/mcp |\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":3,"text":"Connection Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":["\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"Step 4: Filter Tools by Group (Optional)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":[" The Amazon Ads MCP Server exposes 50+ tools. You can filter to only the tool groups you need using the TOOL_FILTER environment variable.\n"," Add to your .env:\n"," Filter in code:\n","\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"Step 5: Understand the Tool Naming Convention"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":[" Amazon Ads MCP Server tools follow a &lt;tool_group>-&lt;tool_name> naming convention.\n","| Tool Group | Description | Example Tools |\n","\\|---\\|---\\|---\\|\n","| account_management | Manage advertiser accounts and list profiles | account_management-list_profiles, account_management-create_advertiser_account |\n","| reporting | Generate and retrieve campaign performance reports | reporting-get_campaign_report, reporting-get_ad_group_report |\n","| campaign_management | Create, update, and manage campaigns and ad groups | campaign_management-create_campaign, campaign_management-list_campaigns |\n","| locale_expansion | Recommendations for expanding to new marketplaces | locale_expansion-get_locale_recommendations |\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":3,"text":"Account Identification Parameters"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":[" Many tools require account identifiers to scope operations:\n","| Parameter | Description |\n","\\|---\\|---\\|\n","| profileId | Identifies an Amazon Ads profile for a specific marketplace. Obtain via account_management-list_profiles. |\n","| advertiserAccountId | Identifies a specific advertiser account (format: amzn1.ads-account.g.xxx). |\n","| managerAccountId | Identifies the manager (agency) account that oversees multiple advertisers. |\n"," A typical workflow: call query_advertiser_accounts first to discover available accounts, then use the returned identifiers in subsequent tool calls.\n","\n"],"documentType":"guide"},{"title":"Module 7: Connect to Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"Step 6: Summary"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/07-connect-ads-mcp-server","content":[" In this module you learned about the Amazon Ads MCP Server connection:\n","Credentials — Obtained Client ID, Client Secret, and Refresh Token from the Amazon Ads developer console. 2. Connection pattern — Understood the Streamable HTTP connection flow: OAuth token exchange → connect with headers → discover tools. 3. Dependencies — Installed langchain-mcp-adapters and requests for the connection. 4. Filtering — Learned how to filter tools by group prefix to reduce context size. 5. Naming Convention — Learned the &lt;tool_group>-&lt;tool_name> pattern and account identification parameters.\n"," In the next module, you will extend the LangGraph agent from Module 5 to include both the Knowledge Base MCP server tools and the Amazon Ads MCP Server tools.\n","\n"],"documentType":"guide"},{"title":"Module 8: Build an Ads Campaign Agent","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/08-build-ads-agent","content":[],"documentType":"guide"},{"title":"Module 8: Build an Ads Campaign Agent","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/08-build-ads-agent","content":["You have completed Module 6 and have a deployed single-server agent on AgentCore - You have completed Module 7 and can connect to the Amazon Ads MCP Server - You want to build an agent that orchestrates calls across multiple MCP servers\n","\n"],"documentType":"guide"},{"title":"Module 8: Build an Ads Campaign Agent","sectionHeader":{"type":2,"text":"Step 1: Understand the Multi-Server Architecture"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/08-build-ads-agent","content":[" In Module 5 you built an agent that connects to a single MCP server (Knowledge Base via AgentCore). Now you will expand it to connect to two MCP servers using different transports.\n"," The key differences from Module 5:\n","Two MCP servers — Knowledge Base (via AgentCore) and Amazon Ads (via Streamable HTTP direct connection). 2. Tools from both servers are merged into a single tool set. 3. OAuth authentication — The agent obtains an access token to authenticate with the Ads MCP Server. 4. The LLM decides which tools from each server to call based on the user prompt.\n","\n"],"documentType":"guide"},{"title":"Module 8: Build an Ads Campaign Agent","sectionHeader":{"type":2,"text":"Step 2: Set Up the Project"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/08-build-ads-agent","content":[" Create a new directory for the multi-server agent:\n"," Create a requirements.txt with all dependencies:\n"," Install the dependencies:\n","\n"],"documentType":"guide"},{"title":"Module 8: Build an Ads Campaign Agent","sectionHeader":{"type":2,"text":"Step 3: Update Secrets Manager with Ads Credentials"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/08-build-ads-agent","content":[" In Module 5 you created a Secrets Manager secret with MCP_KB_ARN and AWS_REGION. Now update it to include the Amazon Ads credentials and model configuration.\n"," Verify the update:\n"," Also update your .env file for local development:\n","\n"],"documentType":"guide"},{"title":"Module 8: Build an Ads Campaign Agent","sectionHeader":{"type":2,"text":"Step 4: Create the Ads Campaign Agent"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/08-build-ads-agent","content":[" Create a file named ads_agent.py. This extends the pattern from kb_agent.py in Module 5 by adding the Amazon Ads MCP Server connection alongside the existing Knowledge Base MCP server connection.\n","\n"],"documentType":"guide"},{"title":"Module 8: Build an Ads Campaign Agent","sectionHeader":{"type":2,"text":"Step 5: Build the Agent with Combined Tools"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/08-build-ads-agent","content":[" Add the agent initialization function that discovers tools from both servers and creates the LangGraph agent. This follows the same lazy-initialization pattern as kb_agent.py from Module 5.\n","\n"],"documentType":"guide"},{"title":"Module 8: Build an Ads Campaign Agent","sectionHeader":{"type":2,"text":"Step 6: Add the A2A Server Endpoint"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/08-build-ads-agent","content":[" Add the FastAPI A2A endpoint — the same pattern as kb_agent.py from Module 5.\n","\n"],"documentType":"guide"},{"title":"Module 8: Build an Ads Campaign Agent","sectionHeader":{"type":2,"text":"Step 7: Deploy to AgentCore"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/08-build-ads-agent","content":[" Deploy the multi-server agent using the same pattern from Module 6.\n"," Accept the defaults for each prompt (same as Module 6, Step 1). Then deploy:\n"," After deployment, add environment variables through the AgentCore console (same as Module 6, Step 4):\n","| Key | Value |\n","\\|---\\|---\\|\n","| SECRET_NAME | Your Secrets Manager secret name |\n","| AWS_REGION | us-east-1 (or your region) |\n","| TOOL_FILTER | account_management,campaign_management,reporting (optional) |\n","| AGENT_PORT | 9000 (optional — defaults to 9000 if not set) |\n"," All other credentials (CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN, MCP_KB_ARN, MODEL_ID) are loaded from Secrets Manager at startup — no need to set them as environment variables.\n"," Click Host agent/tool and wait for the status to show Active.\n","\n"],"documentType":"guide"},{"title":"Module 8: Build an Ads Campaign Agent","sectionHeader":{"type":2,"text":"Step 8: Review the Complete File Structure"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/08-build-ads-agent","content":[" After completing this module, your ads-agent/ directory should contain:\n"," What you built:\n","A LangGraph agent that connects to two MCP servers: Knowledge Base (via AgentCore) and Amazon Ads (via Streamable HTTP). - OAuth authentication using get_access_token to obtain short-lived access tokens for the Ads MCP Server. - Tool discovery from both servers using MCPToolkit.get_tools() (Ads) and manual tools/list (KB), merged into a single tool set. - Optional tool filtering by group prefix to reduce context size. - A StateGraph with system prompt guiding Claude through campaign creation workflows. - A BedrockAgentCoreApp entrypoint for A2A deployment to AgentCore.\n","\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":["You have completed Module 8 and have a multi-server agent deployed to AgentCore - You want to verify the agent correctly orchestrates calls across both MCP servers - You need to diagnose failures or unexpected behavior in your deployed runtimes\n","\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":2,"text":"Step 1: Run an End-to-End Test with AWS Console"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" The quickest way to test your deployed agent is through the built-in test endpoint in the AgentCore console.\n","Sign in to the AWS Management Console. 2. Navigate to Amazon Bedrock > AgentCore in the left sidebar. 3. Find your ads_agent runtime in the list and click on it. 4. Scroll down to the Endpoints section. 5. Select the latest version created by your deployment. 6. Click Test endpoint.\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Test 1: Knowledge Base Query"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Send a prompt that exercises the Knowledge Base MCP server:\n"," Verify the response includes information retrieved from your Knowledge Base.\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Test 2: Ads Account Discovery"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Send a prompt that exercises the Amazon Ads MCP Server:\n"," Verify the response includes your Amazon Ads account information.\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Test 3: Combined Query"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Send a prompt that exercises both MCP servers:\n"," A successful response confirms that the agent can orchestrate calls across both the Knowledge Base and Amazon Ads MCP servers.\n","\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":2,"text":"Step 2: Run an End-to-End Test using Code"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Send a natural language prompt to the deployed agent that exercises both MCP servers. A successful response should include data from the Knowledge Base MCP server and the Amazon Ads MCP server.\n"," Create a file named test_e2e.py:\n"," Run the test:\n","\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":2,"text":"Step 3: View CloudWatch Logs"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" AgentCore streams runtime logs to Amazon CloudWatch. The log group name follows the pattern /aws/bedrock-agentcore/runtimes/&lt;RUNTIME_NAME>-&lt;RUNTIME_ID>-DEFAULT (for example, /aws/bedrock-agentcore/runtimes/ads_agent-lGtpPu7CSK-DEFAULT).\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Find Logs in the AWS Console"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":["Open the CloudWatch Logs console. 2. In the Filter box, type /aws/bedrock-agentcore/runtimes/ to see all AgentCore log groups. 3. You should see log groups for each runtime you deployed: 4. Click on a log group, then click on the latest log stream to view the output.\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Filter Logs for Errors"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" In the CloudWatch Logs console:\n","Click on the log group for your agent. 2. Click Search log group at the top. 3. Enter ERROR in the filter pattern field and click Search. 4. This shows only log lines containing \\[ERROR], which helps you quickly identify failures.\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Filter Logs by Time Range"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":["In the log group view, click the Time range dropdown. 2. Select a custom range (for example, last 30 minutes) to narrow results to your most recent test.\n","\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":2,"text":"Step 4: Inspect the Agent Tool Call Chain"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" The agent logs every tool call with \\[INFO] prefixes. By reading the logs in order, you can reconstruct the exact sequence of MCP tool invocations the agent made to answer a prompt.\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"What to Look For"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" When the agent processes a request, the logs show this sequence:\n"," Each pair of Calling and Result lines represents one tool invocation. The sequence shows you:\n","Which MCP server was called (knowledge_base or ads). - Which tool was invoked (for example, query_knowledge_base, account_management-list_profiles). - What arguments were passed. - What result was returned (truncated to 200 characters in the log).\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Filter for Tool Calls Only"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Use a CloudWatch filter pattern to show only tool invocation lines:\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Verify the Correct Tool Sequence"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" For the end-to-end test prompt from Step 1, you should see at least two tool calls:\n","A knowledge_base.\\* tool call for best practices. 2. An ads.\\* tool call for advertising profiles.\n"," If you see only tools from one server being called, check:\n","Both MCP server ARNs are configured in Secrets Manager. - The agent initialization log shows tools loaded from both servers (for example, knowledge_base: 2 tools loaded, ads: 15 tools loaded).\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Check MCP Server Initialization"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Look for initialization messages when the agent starts:\n"," If a server shows 0 tools loaded or Failed to initialize, the agent cannot use the tools from that server. See the Troubleshooting section below.\n","\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":2,"text":"Step 5: Troubleshooting"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" This section covers common issues you may encounter when testing and monitoring your deployed agent and MCP servers.\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Timeout Errors"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Symptom: The invoke_agent_runtime call fails with a timeout or the response takes longer than expected.\n"," Causes and Fixes:\n","| Cause | Fix |\n","\\|---\\|---\\|\n","| First invocation cold start | The first request initializes connections to all MCP servers. Wait 60–90 seconds and retry. Subsequent requests are faster. |\n","| MCP server not responding | Tail the CloudWatch logs of the MCP server to check for startup errors. Verify the server ARN is correct. |\n","| Network configuration | Ensure the network mode of the AgentCore runtime is set to PUBLIC in the deployment configuration. |\n","| Read timeout too low | Increase the read_timeout in the boto3 Config object. The agent code uses read_timeout=30 — increase to 60 or 120 for complex multi-tool workflows. |\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Tool Invocation Failures"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Symptom: The agent log shows MCP call to &lt;server_name>.&lt;method> failed or the response contains Error executing &lt;tool_name>.\n"," Causes and Fixes:\n","| Cause | Fix |\n","\\|---\\|---\\|\n","| MCP server runtime is stopped | Verify the runtime is active: aws bedrock-agentcore get-agent-runtime --agent-runtime-arn &lt;YOUR_RUNTIME_ARN> --region &lt;YOUR_REGION> |\n","| Incorrect tool arguments | Check the agent log for the with args: line. Compare the arguments against the inputSchema of the tool from tools/list. |\n","| MCP server internal error | Tail the CloudWatch logs of the MCP server for \\[ERROR] messages. The server may be missing environment variables or have a dependency issue. |\n","| ARN mismatch | Verify the ARN in Secrets Manager matches the deployed runtime ARN. |\n"," Test an MCP server directly to isolate whether the issue is in the agent or the server:\n"," If tools/list returns an empty list or an error, the problem is in the MCP server, not the agent.\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Authentication Errors"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Symptom: Errors containing AccessDeniedException, UnauthorizedAccess, or Forbidden.\n"," Causes and Fixes:\n","| Cause | Fix |\n","\\|---\\|---\\|\n","| Missing IAM permissions on execution role | Verify the execution role has the permissions listed in Module 6 and Module 8 (Step 10). |\n","| Secrets Manager access denied | Ensure the execution role has secretsmanager:GetSecretValue permission for your secret ARN. |\n","| Bedrock model access not enabled | Open the Amazon Bedrock console and verify the Claude model is enabled in your region. |\n","| Cross-account ARN reference | Ensure all ARNs (MCP servers, secrets, models) are in the same AWS account and region. |\n"," Verify your execution role permissions:\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Missing Environment Variables"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Symptom: The agent log shows Falling back to environment variables followed by None values, or the MCP server log shows KeyError for expected configuration keys.\n"," Causes and Fixes:\n","| Cause | Fix |\n","\\|---\\|---\\|\n","| Secret name not set | Ensure SECRET_NAME is set as an environment variable in the AgentCore deployment or in the .env file before deploying. |\n","| Secret missing required keys | Verify the Secrets Manager secret contains all required keys (MCP_KB_ARN, MCP_ADS_ARN). |\n","| MCP server missing env vars | For the Knowledge Base MCP server, ensure KNOWLEDGE_BASE_ID, AWS_REGION, and MODEL_ID are set. |\n","| .env file not included in deployment | The .env file is not automatically included in the AgentCore deployment. Use Secrets Manager for production deployments. |\n"," Check the Secrets Manager secret contents:\n"," Verify the output contains all required keys:\n"],"documentType":"guide"},{"title":"Module 9: Testing and Monitoring","sectionHeader":{"type":3,"text":"Quick Diagnostic Checklist"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/09-testing-monitoring","content":[" Run through this checklist when something is not working:\n","Agent runtime is active — aws bedrock-agentcore get-agent-runtime --agent-runtime-arn &lt;YOUR_ADS_AGENT_RUNTIME_ARN> --region &lt;YOUR_REGION> -   MCP server runtimes are active — repeat for each MCP server ARN -   Secrets Manager secret exists and contains required keys — aws secretsmanager get-secret-value --secret-id &lt;YOUR_SECRET_NAME> --region &lt;YOUR_REGION> -   IAM execution role has required permissions — secretsmanager:GetSecretValue, bedrock-agentcore:InvokeAgentRuntime, bedrock:InvokeModel, CloudWatch Logs -   CloudWatch logs show successful initialization — both MCP servers report tools loaded -   No \\[ERROR] lines in agent or MCP server logs — aws logs tail \"/aws/bedrock-agentcore/runtimes/&lt;RUNTIME_NAME>-&lt;YOUR_RUNTIME_ID>-DEFAULT\" --filter-pattern \"ERROR\" --since 30m --region &lt;YOUR_REGION> -   AWS credentials are valid — aws sts get-caller-identity\n","\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":["You have completed the workshop (Track A, Track B, or both) and want to tear down all resources - You want to verify that no billable resources remain in your account\n","\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":2,"text":"Step 1: Delete AgentCore Runtimes"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" Delete each AgentCore runtime you created during the workshop. You need the Runtime ARN you noted after each agentcore deploy command.\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"Delete the Ads Campaign Agent (Track B)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"Delete the LangGraph Agent (Track A)"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"Delete the Knowledge Base MCP Server"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" Verify each deletion by confirming the runtime no longer appears in the list.\n","\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":2,"text":"Step 2: Delete Secrets Manager Secrets"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" Delete the secrets you stored in AWS Secrets Manager for MCP server ARNs and credentials.\n"," If you created separate secrets for Ads API credentials, delete those as well:\n","\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":2,"text":"Step 3: Delete the Bedrock Knowledge Base"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" If you created an Amazon Bedrock Knowledge Base for this workshop, delete it along with its associated data source.\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"List Knowledge Bases"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"Delete the Knowledge Base"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":["\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":2,"text":"Step 4: Delete IAM Roles"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" If AgentCore auto-created execution roles during deployment, remove them to keep your account clean.\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"List AgentCore Execution Roles"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"Delete an Execution Role"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" Before deleting a role, detach all policies and remove any inline policies:\n","\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":2,"text":"Step 5: Delete CloudWatch Log Groups"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" AgentCore runtimes stream logs to CloudWatch. Delete the log groups to stop storage charges.\n","\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":2,"text":"Step 6: Resource Deletion Checklist"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" Use this checklist to verify all workshop resources have been removed from your account.\n","AgentCore runtimes — All runtimes deleted (aws bedrock-agentcore list-agent-runtimes returns none from this workshop) -   IAM roles — Execution roles created by AgentCore removed (check for roles containing agentcore in the name) -   Secrets Manager secrets — All workshop secrets deleted (aws secretsmanager list-secrets shows none from this workshop) -   Bedrock Knowledge Base — Knowledge Base deleted if created for this workshop (aws bedrock-agent list-knowledge-bases) -   CloudWatch log groups — Log groups under /aws/bedrock-agentcore/ deleted (aws logs describe-log-groups --log-group-name-prefix \"/aws/bedrock-agentcore/\")\n","\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":2,"text":"Step 7: Next Steps"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" Now that you have completed the workshop, here are resources to continue learning and building.\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"AgentCore Documentation"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" Explore the full Amazon Bedrock AgentCore documentation for advanced deployment options, memory configuration, and production best practices.\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"MCP Specification"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" Read the official Model Context Protocol specification to understand the full protocol, including resources, prompts, and advanced transport options beyond stateless_http.\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"LangGraph Documentation"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" Dive deeper into LangGraph for building more complex agent architectures, including multi-agent workflows, human-in-the-loop patterns, and persistent state management.\n"],"documentType":"guide"},{"title":"Module 10: Cleanup and Next Steps","sectionHeader":{"type":3,"text":"Amazon Ads API Documentation"},"path":"/en-us/knowledge-hub/hands-on-workshops/amazon-ads-mcp-server/10-cleanup","content":[" Explore the full Amazon Ads API to discover additional capabilities beyond what the MCP Server exposes, including bulk operations, audience targeting, and advanced reporting.\n","\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":["\n","\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":2,"text":"What is ADM?"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":[" Amazon Ads Data Manager (ADM) is a centralized data onboarding platform that enables advertisers and agencies to securely upload first-party data and activate it across Amazon Ads products. ADM serves as the bridge between your CRM/CDP data and the Amazon advertising ecosystem.\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":3,"text":"What ADM Enables"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":["Upload hashed customer lists (emails, phones, addresses) for audience matching  Create DSP audiences directly from uploaded data for programmatic campaigns  Share datasets with AMC for advanced analytics and custom audience modeling  Track conversion events by connecting offline/online signals to Amazon campaigns  Manage data lifecycle with retention controls and identity deletion for privacy compliance\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":3,"text":"Data Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":["\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":[],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":3,"text":"1. Amazon Ads API Credentials"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":[" You need the following credentials from the Amazon Ads API console:\n","Client ID (CLIENT_ID)  Client Secret (CLIENT_SECRET)  Refresh Token (REFRESH_TOKEN) \\* Manager Account ID or Advertiser ID\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":3,"text":"2. Python Environment"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":[],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":3,"text":"3. Environment Configuration"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":[" Create a .env file with your credentials:\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":3,"text":"4. Authentication"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":[" Every ADM API call requires these headers:\n"," Plus ONE account identification header:\n","| Header                          | When to Use                               |\n","\\| ------------------------------- \\| ----------------------------------------- \\|\n","| Amazon-Ads-Manager-Account-ID | For manager/agency accounts (recommended) |\n","| Amazon-Ads-AccountId          | For individual advertiser accounts        |\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":3,"text":"5. Base Client Class"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":[" All use cases in this guide share this common client class:\n","\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":2,"text":"Key Concepts"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":["| Concept             | Description                                                                                                   |\n","\\| ------------------- \\| ------------------------------------------------------------------------------------------------------------- \\|\n","| Dataroom            | A container for all your ADM data. One per account. Must be created before any other operation.               |\n","| Dataset             | A named collection of audience records within a dataroom. Has a schema, country code, and retention settings. |\n","| Sharing Rule        | A rule that connects a dataset to a destination application (DSP Audiences, AMC, Events Manager).             |\n","| Identity Resolution | The process of matching your hashed PII to Amazon identities for targeting.                                   |\n","| ID Retention        | When enabled, hashed data is retained for 90 days and UID tokens are refreshed automatically.                 |\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":3,"text":"Supported Destination Applications"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":["| Application ID           | Description                                            |\n","\\| ------------------------ \\| ------------------------------------------------------ \\|\n","| DSP_AUDIENCES          | Create audiences for Amazon DSP programmatic campaigns |\n","| AMAZON_MARKETING_CLOUD | Share data with AMC for analytics and custom queries   |\n","| EVENTS_MANAGER         | Connect conversion events to Amazon campaigns          |\n","\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":2,"text":"Use Cases"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":["| # | Use Case                                                                                                  | Description                                                  |\n","\\| - \\| --------------------------------------------------------------------------------------------------------- \\| ------------------------------------------------------------ \\|\n","| 1 | ​Onboard First-Party Audience Data​ | Upload hashed customer lists to ADM for identity matching    |\n","| 2 | ​Create a DSP Audience​               | Activate ADM data as targetable audiences in Amazon DSP      |\n","| 3 | ​Share Data with AMC​                      | Send ADM data to Amazon Marketing Cloud for analytics        |\n","| 4 | ​Conversion Event Tracking​           | Connect offline/online conversion events to Amazon campaigns |\n","| 5 | ​Manage Audience Lifecycle​     | Update, remove members, and delete datasets                  |\n","| 6 | ​Identity Deletion for Privacy​         | Handle GDPR/CCPA deletion requests                           |\n","| 7 | ​Monitor Dataset Health​           | Track match rates, record counts, and dataset metrics        |\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":2,"text":"Reference"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":["| Page                                                                                               | Description                                               |\n","\\| -------------------------------------------------------------------------------------------------- \\| --------------------------------------------------------- \\|\n","| ​API Quick Reference​                | Complete endpoint map, request limits, and status codes   |\n","| ​Troubleshooting & Best Practices​ | Common errors, data quality checklist, and best practices |\n","\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":2,"text":"Resources"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":["Amazon Ads Data Manager Overview  ADM Dataset Management Guide  Amazon Ads API Documentation  Amazon DSP Documentation  Amazon Marketing Cloud Documentation\n","\n"," This guide is intended for Amazon Ads partners and solutions architects. All code examples are for demonstration purposes and should be adapted for production use with proper error handling, logging, and security practices.\n","\n"],"documentType":"guide"},{"title":"How to onboard first-party data to Amazon Ads using ADM: Implementation Workshop","sectionHeader":{"type":2,"text":"Contributors"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/overview","content":[],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":["You have a CRM export or CDP segment you want to activate on Amazon Ads - You want to build a seed audience for lookalike modeling in DSP - You need to onboard offline customer data for measurement in AMC\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"End-to-End Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":["\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"ADMClient: Additional Methods for This Use Case"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[" The following methods extend the base ADMClient class defined in the Guide Home. Add these to your ADMClient class.\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":3,"text":"List Manager Accounts"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":3,"text":"Get DSP Advertiser IDs"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":3,"text":"Create Dataroom"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":3,"text":"Create Audience Dataset"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":3,"text":"Ingest Audience Members"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":3,"text":"Create DSP Audience (Sharing Rule)"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":3,"text":"List Sharing Rules"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":["\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"Step 1: Accept ADM Terms and Conditions"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[" Before any ADM operation, the account must accept the Terms and Conditions. This is a one-time step that can be completed via the ADM UI.\n","\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"Step 2: Create a Dataroom"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[" A dataroom is the top-level container for all your ADM data. Each account has one dataroom. The ensure_dataroom() helper attempts to create it and silently handles the case where one already exists.\n","\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"Step 3: Create an Audience Dataset"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[" A dataset defines the schema and country for your audience records. The name is generated dynamically using a timestamp to avoid naming collisions across runs.\n","\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"Step 4: Hash PII Data"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[" All personally identifiable information must be normalized and SHA-256 hashed before upload.\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":3,"text":"Example: Hash a Full Customer Record"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":["\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"Step 5: Ingest Audience Members"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[" Upload hashed records to the dataset in batches of up to 10,000 records per request.\n","\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"Step 6: Create DSP Sharing Rule"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[" After ingestion, create a DSP sharing rule to make your dataset available as a targetable audience in Amazon DSP. The destination account ID is resolved from your manager account, with a fallback to DSP_DESTINATION_ACCOUNT_ID in your .env file.\n","\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"Step 7: Verify Sharing Rules"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[" Confirm the sharing rule was created successfully by listing active and pending rules for your dataset.\n","\n"],"documentType":"guide"},{"title":"Use Case 1: Onboard First-Party Audience Data to ADM","sectionHeader":{"type":2,"text":"Complete Example: onboard_audience()"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/01-onboard-audience-data","content":[" The following function runs the entire flow end-to-end: DSP advertiser ID lookup, dataset creation, data ingestion, sharing rule creation, and verification.\n","\n"],"documentType":"guide"},{"title":"Use Case 2: Create a DSP Audience from ADM Data","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/02-create-dsp-audience","content":[],"documentType":"guide"},{"title":"Use Case 2: Create a DSP Audience from ADM Data","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/02-create-dsp-audience","content":["You want to create an additional DSP audience from an existing ADM dataset - You need to share the same dataset with multiple DSP advertiser accounts - You want to create a suppression audience (for example, exclude existing customers) - You want to build a seed audience for DSP lookalike expansion\n"],"documentType":"guide"},{"title":"Use Case 2: Create a DSP Audience from ADM Data","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/02-create-dsp-audience","content":["Complete Use Case 1: Onboard Audience Data first - create_dsp_audience() and list_sharing_rules() are class methods on ADMClient — defined and introduced in UC1 - A DSP advertiser account ID (DSP_DESTINATION_ACCOUNT_ID) in your .env file - A marketplace ID (MARKETPLACE_ID) in your .env file\n"],"documentType":"guide"},{"title":"Use Case 2: Create a DSP Audience from ADM Data","sectionHeader":{"type":2,"text":"Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/02-create-dsp-audience","content":["\n"],"documentType":"guide"},{"title":"Use Case 2: Create a DSP Audience from ADM Data","sectionHeader":{"type":2,"text":"Step 1: Create a Sharing Rule for DSP"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/02-create-dsp-audience","content":[" Key points: - externalAudienceId is automatically generated as a UUID — do not omit it, as the API will return a 500 error - destination_account_id should be read from your .env file, not hardcoded - marketplace_id should be read from your .env file, not hardcoded - account_entity_id is optional — include it only if required by your DSP account setup\n","\n"],"documentType":"guide"},{"title":"Use Case 2: Create a DSP Audience from ADM Data","sectionHeader":{"type":2,"text":"Step 2: Verify the Sharing Rule"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/02-create-dsp-audience","content":["\n"],"documentType":"guide"},{"title":"Use Case 2: Create a DSP Audience from ADM Data","sectionHeader":{"type":2,"text":"Step 3: Create a DSP Audience from an Existing Dataset"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/02-create-dsp-audience","content":[" Use this flow when your data is already uploaded and you want to create an additional DSP sharing rule without re-ingesting data.\n","\n"],"documentType":"guide"},{"title":"Use Case 2: Create a DSP Audience from ADM Data","sectionHeader":{"type":2,"text":"Marketplace IDs"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/02-create-dsp-audience","content":[" For a complete and up-to-date list of Amazon marketplace IDs, refer to the official documentation:\n"," Your marketplace ID should be stored in .env as MARKETPLACE_ID rather than hardcoded in your scripts.\n","\n"],"documentType":"guide"},{"title":"Use Case 2: Create a DSP Audience from ADM Data","sectionHeader":{"type":2,"text":"What Happens After the Sharing Rule is Created?"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/02-create-dsp-audience","content":["The sharing rule status starts as PENDING while ADM processes the audience 2. Once identity resolution is complete, the status changes to ACTIVE 3. The DSP Audience ID (returned in the sharing rule response) can be used in your DSP campaign setup 4. Large datasets may take longer to resolve — poll list_sharing_rules() to monitor status\n","\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":[],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":["You want to analyze overlap between your CRM customers and Amazon shoppers - You need to build custom attribution models combining your data with Amazon signals - You want to create advanced audience segments using SQL queries in AMC - You need to measure incrementality of your Amazon campaigns against your customer base\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":["Complete Use Case 1: Onboard Audience Data first - An AMC instance ID (from your AMC console) - The destination account ID and marketplace ID\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":2,"text":"Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":["\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":2,"text":"Before You Begin: Link Your ADM Account to AMC"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":[" ADM uses two levels of authorization to share data with AMC:\n","Account Link — A one-time manual \"sharing grant\" between your ADM Manager Account and the AMC instance. This must be established by Amazon before any data sharing can occur. 2. Sharing Rule — Set via the API (the share_dataset_with_amc() call in this guide) to control which specific datasets are accessible in the linked AMC instance.\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":3,"text":"How to Request an Account Link"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":[" Contact your Amazon Account Executive (AE) or Partner Manager (PDM) and provide the following information:\n","| Field | Description | Example Format |\n","\\|-------\\|-------------\\|---------------\\|\n","| Manager Account ID | Your ADM Manager Account ID | amzn1.ads1.ma1.xxxxxxxx |\n","| AMC Account ID | Your AMC account identifier | Provided by your AE |\n","| AMC Instance ID | Your AMC instance ID | amcxxxxxxxxxx |\n","| Ownership confirmation | Are the Manager Account and AMC instance owned by the same entity? | Yes / No |\n"," SLA: Account linking requests are fulfilled by Amazon engineering within 3 business days.\n","\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":2,"text":"New ADMClient Method for This Use Case"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":[" Add the following method to your ADMClient class. It is specific to AMC sharing and is not required for the DSP audience flow in Use Cases 1 and 2.\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":3,"text":"Share Dataset with AMC"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":["\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":2,"text":"Step 1: Create a Sharing Rule for AMC"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":["\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":2,"text":"Step 2: Verify the Sharing Rule"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":["\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":2,"text":"Complete Example: share_crm_data_with_amc()"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":["\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":2,"text":"Step 3: Query Your Data in AMC"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":[" Once the sharing rule is active, your ADM dataset appears as a table in AMC. You can write SQL queries to analyze it alongside Amazon data.\n"],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":3,"text":"Example: Find Overlap Between CRM Customers and Amazon Purchasers"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":[],"documentType":"guide"},{"title":"Use Case 3: Share ADM Data with Amazon Marketing Cloud (AMC)","sectionHeader":{"type":3,"text":"Example: Build a Lookalike Seed from High-Value CRM Customers"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/03-share-with-amc","content":["\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":[],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":["You have offline purchase data (in-store, call center) you want to attribute to Amazon campaigns - You need server-to-server conversion tracking (for example, SaaS signups, app installs) - You want to optimize DSP campaigns based on offline conversion signals\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":["Complete Use Case 1: Onboard Audience Data first - DSP_DESTINATION_ACCOUNT_ID and MARKETPLACE_ID set in your .env file - Optionally: DSP_ACCOUNT_ENTITY_ID in your .env file\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":["\n","\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"New ADMClient Methods for This Use Case"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":[" Add the following two methods to your ADMClient class. They are specific to conversion event tracking and are not required for the audience onboarding flow in Use Cases 1 and 2.\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":3,"text":"Create Conversion Dataset"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":[" Conversion datasets use the same /adm/audiences endpoint as audience datasets. The dataset becomes a conversion dataset once an EVENTS_MANAGER sharing rule is attached.\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":3,"text":"Ingest Conversion Events"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":[" Handles batched ingestion of conversion event records. Each event is a build_member()-shaped record whose externalUserId ties the conversion back to a customer for identity resolution.\n","\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Step 1: Create a Conversion Dataset"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":[" Each conversion tracking flow requires its own dataset. Use create_conversion_dataset() with a timestamped name to avoid collisions.\n","\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Step 2: Prepare Conversion Event Records"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":[" Conversion event records use the same hashing and build_member() pattern as audience records. The externalUserId links each event to a customer identity.\n","\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Step 3: Ingest Conversion Events"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":["\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Step 4: Create an Events Manager Sharing Rule"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":["\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Step 5: Verify Sharing Rules"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":["\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Complete Example: track_offline_purchases()"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":["\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Supported Conversion Types"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":["| Type | Description |\n","\\|------\\|-------------\\|\n","| OFF_AMAZON_PURCHASES | Offline or off-Amazon purchase events |\n","| ADD_TO_SHOPPING_CART | Cart addition events |\n","| CHECKOUT | Checkout completion events |\n","| LEAD | Lead generation events |\n","| SIGN_UP | Account registration events |\n","| SUBSCRIBE | Subscription events |\n","| PAGE_VIEW | Page view events |\n","| SEARCH | Search events |\n","| APPLICATION | App-related events |\n","| CONTACT | Contact/inquiry events |\n","| OTHER | Custom event types |\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Supported Sources"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":["| Source | Description |\n","\\|--------\\|-------------\\|\n","| AMAZON_AD_TAG | Events from Amazon ad tags |\n","| MMP | Events from Mobile Measurement Partners |\n","| SERVER_TO_SERVER | Direct server-to-server event uploads |\n"],"documentType":"guide"},{"title":"Use Case 4: Conversion Event Tracking via ADM","sectionHeader":{"type":2,"text":"Supported Source Types"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/04-conversion-tracking","content":["| Source Type | Description |\n","\\|-------------\\|-------------\\|\n","| OFFLINE | Offline events (in-store, call center) |\n","| WEBSITE | Website conversion events |\n","| ANDROID | Android app events |\n","| IOS | iOS app events |\n","| FIRE_TABLET | Fire Tablet app events |\n","| FIRE_TV | Fire TV app events |\n","\n"],"documentType":"guide"},{"title":"Use Case 5: Manage Audience Lifecycle (Update & Delete)","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/05-manage-audience-lifecycle","content":[],"documentType":"guide"},{"title":"Use Case 5: Manage Audience Lifecycle (Update & Delete)","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/05-manage-audience-lifecycle","content":["Your CRM segment has changed and you need to add/remove members - A customer has opted out and needs to be removed from the audience - A campaign has ended and the dataset is no longer needed - A sharing rule should be revoked\n"],"documentType":"guide"},{"title":"Use Case 5: Manage Audience Lifecycle (Update & Delete)","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/05-manage-audience-lifecycle","content":["An existing ADM dataset (from Use Case 1) - The helper functions normalize_and_hash, build_member, and ingest_audience_members from Use Case 1\n","\n","\n"],"documentType":"guide"},{"title":"Use Case 5: Manage Audience Lifecycle (Update & Delete)","sectionHeader":{"type":2,"text":"Add New Members to an Existing Dataset"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/05-manage-audience-lifecycle","content":[" Use the same ingest endpoint with action: 'CREATE':\n","\n"],"documentType":"guide"},{"title":"Use Case 5: Manage Audience Lifecycle (Update & Delete)","sectionHeader":{"type":2,"text":"Remove Members from a Dataset"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/05-manage-audience-lifecycle","content":[" Use action: 'DELETE' to remove specific users:\n","\n"],"documentType":"guide"},{"title":"Use Case 5: Manage Audience Lifecycle (Update & Delete)","sectionHeader":{"type":2,"text":"Delete an Entire Dataset"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/05-manage-audience-lifecycle","content":["\n"],"documentType":"guide"},{"title":"Use Case 5: Manage Audience Lifecycle (Update & Delete)","sectionHeader":{"type":2,"text":"Revoke a Sharing Rule"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/05-manage-audience-lifecycle","content":[" If you no longer want a dataset shared with a destination, revoke the sharing rule:\n","\n"],"documentType":"guide"},{"title":"Use Case 5: Manage Audience Lifecycle (Update & Delete)","sectionHeader":{"type":2,"text":"Example: Full Lifecycle Management"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/05-manage-audience-lifecycle","content":["\n"],"documentType":"guide"},{"title":"Use Case 6: Identity Deletion for Privacy Compliance","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/06-identity-deletion","content":[],"documentType":"guide"},{"title":"Use Case 6: Identity Deletion for Privacy Compliance","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/06-identity-deletion","content":["A customer exercises their \"right to be forgotten\" (GDPR Article 17) - You receive a CCPA deletion request - You need to purge specific user identities from all ADM datasets\n"],"documentType":"guide"},{"title":"Use Case 6: Identity Deletion for Privacy Compliance","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/06-identity-deletion","content":["An authenticated ADM client (see Guide Home) - The external user IDs or hashed PII of the users to delete\n","\n"],"documentType":"guide"},{"title":"Use Case 6: Identity Deletion for Privacy Compliance","sectionHeader":{"type":2,"text":"Step 0: Verify Active Sharing Rules (Optional)"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/06-identity-deletion","content":[" Before processing deletions, use list_sharing_rules() to identify which datasets and destinations are currently active. This helps you understand the scope of any deletion.\n","\n"],"documentType":"guide"},{"title":"Use Case 6: Identity Deletion for Privacy Compliance","sectionHeader":{"type":2,"text":"Delete by External User ID"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/06-identity-deletion","content":[],"documentType":"guide"},{"title":"Use Case 6: Identity Deletion for Privacy Compliance","sectionHeader":{"type":3,"text":"Usage Example"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/06-identity-deletion","content":["\n"],"documentType":"guide"},{"title":"Use Case 6: Identity Deletion for Privacy Compliance","sectionHeader":{"type":2,"text":"Delete by Hashed PII"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/06-identity-deletion","content":[" If you do not have the external user ID, you can delete by hashed PII:\n"],"documentType":"guide"},{"title":"Use Case 6: Identity Deletion for Privacy Compliance","sectionHeader":{"type":3,"text":"Usage Example: Delete by Multiple PII Types"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/06-identity-deletion","content":["\n"],"documentType":"guide"},{"title":"Use Case 6: Identity Deletion for Privacy Compliance","sectionHeader":{"type":2,"text":"Example: Handle a GDPR Deletion Request"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/06-identity-deletion","content":["\n"],"documentType":"guide"},{"title":"Use Case 6: Identity Deletion for Privacy Compliance","sectionHeader":{"type":2,"text":"Key Details"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/06-identity-deletion","content":["Deletions apply across all datasets in the account - Up to 1,000 identities can be deleted per request - You can delete by externalUserId or by identity (hashed PII / external identities), but not both in the same target - Deletion is permanent and cannot be undone\n","\n"],"documentType":"guide"},{"title":"Use Case 7: Monitor Dataset Health & Metrics","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/07-monitor-dataset-health","content":[],"documentType":"guide"},{"title":"Use Case 7: Monitor Dataset Health & Metrics","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/07-monitor-dataset-health","content":["You want to verify data was ingested correctly after an upload - You need to monitor match rates to optimize data quality - You want to audit dataset usage across your account\n"],"documentType":"guide"},{"title":"Use Case 7: Monitor Dataset Health & Metrics","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/07-monitor-dataset-health","content":["An authenticated ADM client (see Guide Home) - At least one existing dataset\n","\n"],"documentType":"guide"},{"title":"Use Case 7: Monitor Dataset Health & Metrics","sectionHeader":{"type":2,"text":"Get Dataset Metrics"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/07-monitor-dataset-health","content":[],"documentType":"guide"},{"title":"Use Case 7: Monitor Dataset Health & Metrics","sectionHeader":{"type":3,"text":"Usage Example"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/07-monitor-dataset-health","content":["\n"],"documentType":"guide"},{"title":"Use Case 7: Monitor Dataset Health & Metrics","sectionHeader":{"type":2,"text":"List All Datasets with Details"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/07-monitor-dataset-health","content":["\n"],"documentType":"guide"},{"title":"Use Case 7: Monitor Dataset Health & Metrics","sectionHeader":{"type":2,"text":"Get Dataroom Overview"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/07-monitor-dataset-health","content":["\n"],"documentType":"guide"},{"title":"Use Case 7: Monitor Dataset Health & Metrics","sectionHeader":{"type":2,"text":"Example: Health Check Dashboard"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/07-monitor-dataset-health","content":["\n"],"documentType":"guide"},{"title":"ADM API Quick Reference","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/08-api-reference","content":[],"documentType":"guide"},{"title":"ADM API Quick Reference","sectionHeader":{"type":2,"text":"Base URL"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/08-api-reference","content":["\n"],"documentType":"guide"},{"title":"ADM API Quick Reference","sectionHeader":{"type":2,"text":"Complete Endpoint Map"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/08-api-reference","content":["| Operation | Method | Endpoint | Description |\n","\\|-----------\\|--------\\|----------\\|-------------\\|\n","| Get Terms | GET | /adm/terms | Check T&C acceptance status |\n","| Accept Terms | PATCH | /adm/terms | Accept T&C |\n","| Get Dataroom | GET | /adm/datarooms | Get dataroom info |\n","| Create Dataroom | POST | /adm/datarooms | Create a new dataroom |\n","| Dataroom Metadata | GET | /adm/datarooms/metadata | Get dataroom stats |\n","| Create Dataset | POST | /adm/audiences | Create audience dataset |\n","| List Datasets | GET | /adm/audiences | List all audience datasets |\n","| Get Dataset | GET | /adm/audiences/{dataSetId} | Get dataset details |\n","| Ingest Members | POST | /adm/audiences/{dataSetId}/members | Upload audience records |\n","| Dataset Metrics | GET | /adm/datasets/{dataSetId}/metrics | Get match rates & counts |\n","| Dataset Details | POST | /adm/datasets/list | Batch get dataset metadata |\n","| Delete Dataset | DELETE | /adm/datasets/{dataSetId} | Delete a dataset |\n","| Delete Identities | POST | /adm/identities/delete | Privacy deletion |\n","| Create Sharing Rule | POST | /adm/sharingRules | Share dataset with DSP/AMC/Events |\n","| List Sharing Rules | POST | /adm/sharingRules/list | List sharing rules |\n","| Revoke Sharing Rule | PATCH | /adm/sharingRules/{sharingRuleId}/revoke | Revoke a sharing rule |\n","\n"],"documentType":"guide"},{"title":"ADM API Quick Reference","sectionHeader":{"type":2,"text":"Request Limits"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/08-api-reference","content":["| Limit | Value |\n","\\|-------\\|-------\\|\n","| Members per ingest request | 10,000 |\n","| Datasets per list details request | 100 |\n","| Identities per delete request | 1,000 |\n","| Dataset name length | 5–100 characters |\n","| Dataset description length | 1–1,000 characters |\n","| DSP audience name length | 10–127 characters |\n","| Hashed PIIs per member | Up to 10 |\n","| External identities per member | Up to 10 |\n","\n"],"documentType":"guide"},{"title":"ADM API Quick Reference","sectionHeader":{"type":2,"text":"Sharing Rule Statuses"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/08-api-reference","content":["| Status | Meaning |\n","\\|--------\\|---------\\|\n","| ACTIVE | Rule is active and data is flowing to the destination |\n","| PENDING | Rule is being processed |\n","| REVOKED_BY_USER | Manually revoked by the user |\n","| REVOKED_BY_DATASET | Revoked because the dataset was deleted |\n","| REVOKED_BY_SHARING_GRANT | Revoked due to sharing grant changes |\n","| SHADOW | Internal state, not typically visible |\n","\n"],"documentType":"guide"},{"title":"ADM API Quick Reference","sectionHeader":{"type":2,"text":"Destination Applications"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/08-api-reference","content":["| Application ID | Description |\n","\\|----------------\\|-------------\\|\n","| DSP_AUDIENCES | Create audiences for Amazon DSP programmatic campaigns |\n","| AMAZON_MARKETING_CLOUD | Share data with AMC for analytics and custom queries |\n","| EVENTS_MANAGER | Connect conversion events to Amazon campaigns |\n","\n"],"documentType":"guide"},{"title":"ADM API Quick Reference","sectionHeader":{"type":2,"text":"Authentication Headers"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/08-api-reference","content":[" Every request requires:\n"," Plus ONE account header:\n","| Header | When to Use |\n","\\|--------\\|-------------\\|\n","| Amazon-Ads-Manager-Account-ID | Manager/agency accounts (recommended) |\n","| Amazon-Ads-AccountId | Individual advertiser accounts |\n"," Special content types: - Dataset metrics: Content-Type: application/vnd.admmetrics.v1+json - Dataroom metadata: Content-Type: application/vnd.admmetrics.v1+json\n","\n"],"documentType":"guide"},{"title":"ADM API Quick Reference","sectionHeader":{"type":2,"text":"Error Codes"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/08-api-reference","content":["| Code | Meaning | Action |\n","\\|------\\|---------\\|--------\\|\n","| 400 | Bad Request | Check request body validation |\n","| 401 | Unauthorized | Re-authenticate with refresh token |\n","| 403 | Forbidden | Verify account permissions |\n","| 404 | Not Found | Resource does not exist (for example, dataroom not created) |\n","| 409 | Conflict | Duplicate resource (for example, dataset name exists) |\n","| 429 | Too Many Requests | Implement exponential backoff |\n","| 500 | Server Error | Retry with backoff |\n","\n"],"documentType":"guide"},{"title":"Troubleshooting & Best Practices","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/09-troubleshooting","content":[],"documentType":"guide"},{"title":"Troubleshooting & Best Practices","sectionHeader":{"type":2,"text":"Common Errors and Solutions"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/09-troubleshooting","content":["| Error | Cause | Solution |\n","\\|-------\\|-------\\|----------\\|\n","| 401 Unauthorized | Expired or invalid access token | Re-authenticate using the refresh token |\n","| 403 Forbidden | Account does not have ADM access | Verify account permissions and ADM enrollment |\n","| 404 Not Found on dataroom | Dataroom not yet created | Call POST /adm/datarooms first |\n","| 409 Duplicate on dataset | Dataset name already exists | Use a unique name or retrieve the existing dataset |\n","| 429 Too Many Requests | Rate limit exceeded | Implement exponential backoff and retry |\n","| Low match rate | Poor data quality or normalization | Review hashing/normalization rules (see below) |\n","| Sharing rule stuck in PENDING | Identity resolution in progress | Wait and re-check; large datasets take longer |\n","\n"],"documentType":"guide"},{"title":"Troubleshooting & Best Practices","sectionHeader":{"type":2,"text":"Data Quality Checklist"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/09-troubleshooting","content":[" Poor match rates are almost always caused by inconsistent normalization before hashing. Follow this checklist:\n","Emails: lowercased, whitespace trimmed, no aliases (for example, +tag removed) -   Phone numbers: digits only, include country code (for example, 15551234567) -   Names: lowercased, whitespace trimmed, no titles (Mr., Dr.) -   Addresses: lowercased, whitespace trimmed, abbreviations standardized -   Zip codes: trimmed, US zips are 5 digits -   All values: SHA-256 hashed after normalization -   No empty strings hashed (skip empty fields instead)\n","\n"],"documentType":"guide"},{"title":"Troubleshooting & Best Practices","sectionHeader":{"type":2,"text":"Retry Logic Example"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/09-troubleshooting","content":["\n"],"documentType":"guide"},{"title":"Troubleshooting & Best Practices","sectionHeader":{"type":2,"text":"Best Practices"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/09-troubleshooting","content":[],"documentType":"guide"},{"title":"Troubleshooting & Best Practices","sectionHeader":{"type":3,"text":"Data Preparation"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/09-troubleshooting","content":["Normalize before hashing — Inconsistent normalization is the #1 cause of low match rates. Always lowercase, trim whitespace, and standardize formats before applying SHA-256.\n","Provide multiple PII fields — The more fields you provide per record (email + phone + name + address), the higher the match rate. Email alone typically yields 30-50% match; adding phone and address can push it to 60-80%.\n","Use ID retention — Enable idRetention: true when creating datasets. This retains hashed data for 90 days and automatically refreshes UID tokens, improving long-term match rates.\n","Batch efficiently — Send up to 10,000 records per ingest call. For large datasets (100K+ records), batch in groups of 10,000 with a 1-second pause between batches.\n"],"documentType":"guide"},{"title":"Troubleshooting & Best Practices","sectionHeader":{"type":3,"text":"Audience Strategy"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/09-troubleshooting","content":["Segment before upload — Create separate datasets for different audience segments (high-value, lapsed, prospects) rather than one large dataset. This gives you more flexibility in DSP targeting.\n","Refresh regularly — Update your audiences at least weekly. Stale audiences lead to wasted spend on users who have already converted or churned.\n","Use suppression audiences — Upload your existing customer list as a suppression audience in DSP to avoid spending on users who have already purchased.\n"],"documentType":"guide"},{"title":"Troubleshooting & Best Practices","sectionHeader":{"type":3,"text":"Privacy & Compliance"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/09-troubleshooting","content":["Honor consent signals — Always include userConsent with accurate consent values. Use DENIED for users who have not consented to ad targeting.\n","Implement identity deletion — Build automated workflows to handle GDPR/CCPA deletion requests using the /adm/identities/delete endpoint. See Use Case 6.\n","Audit sharing rules — Regularly review active sharing rules and revoke any that are no longer needed.\n"],"documentType":"guide"},{"title":"Troubleshooting & Best Practices","sectionHeader":{"type":3,"text":"Architecture"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/09-troubleshooting","content":["Automate the pipeline — Build a scheduled pipeline (for example, daily cron job, AWS Lambda, or Airflow DAG) that exports CRM data, hashes it, and uploads to ADM automatically.\n","Monitor match rates — Set up alerts when match rates drop below your baseline. A sudden drop usually indicates a normalization issue in your data pipeline. See Use Case 7.\n","Use manager accounts for agencies — If you manage multiple brands, use a manager account with Amazon-Ads-Manager-Account-ID header to manage all datasets from a single integration.\n","\n"],"documentType":"guide"},{"title":"Troubleshooting & Best Practices","sectionHeader":{"type":2,"text":"Resources"},"path":"/en-us/knowledge-hub/hands-on-workshops/1st-party-data-workshop/09-troubleshooting","content":["Amazon Ads Data Manager Overview - ADM Dataset Management Guide - Amazon Ads API Documentation - Amazon DSP Documentation - Amazon Marketing Cloud Documentation\n","\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"What the Events API Is"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[" The Amazon Ads Events API, also called CAPI v2, is a server-to-server endpoint for sending conversion events to Amazon Ads. You post a batch of events — a purchase, a lead, a sign-up, an app install — each carrying hashed customer identifiers and a timestamp. Amazon matches those identifiers against Amazon shoppers and attributes the conversions to Amazon DSP campaigns.\n"," It replaces browser tags and file uploads for advertisers who would rather send events from their own systems, where the data already lives and where no ad blocker or cookie policy sits in the path.\n"," The Events API is in open beta. Confirm behaviour against current Amazon Ads documentation before you rely on it in production.\n"," Last reviewed: September 2, 2026.\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"What It Enables"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":["Send conversions from your servers, with no tag on the page and no file drop. - Attribute off-Amazon conversions to Amazon DSP Streaming TV and display campaigns. - Send offline conversions — calls, in-store visits, signed contracts — that no browser tag could see. - Carry your own custom attributes through to Amazon Marketing Cloud. - Send UK and EEA consent signals alongside the events they govern. - Deduplicate against Amazon Ad Tag using your own eventId, so a tag and a server feed can coexist.\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"Who This Workshop Is For"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[" The primary reader is an engineer at a CDP, measurement, or platform company building a reusable connector — one integration sending events on behalf of many advertisers. The secondary reader is an in-house developer at a single advertiser sending their own events.\n"," You should be comfortable with Python, HTTP and REST, OAuth refresh tokens, and SHA-256. No prior knowledge of Amazon Ads Data Manager is needed.\n"," Integrating for a single advertiser? You can skip page 06 on a first pass, and page 05 if you have no UK or EEA data.\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"What You Will Achieve"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[" An event Amazon accepted, match keys reproducing seven known-good digests exactly, and a conversion definition visible in Events Manager.\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"Account Eligibility"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[" Read this before writing any code. More integrations stall here than anywhere else, and the failure arrives as an authorization error that says nothing about eligibility.\n"," The Events API is DSP-scoped. Events Manager states it is available only for Streaming TV and display advertisers with off-Amazon campaigns.\n"," If you are a partner building a connector: a partner's manager account does not need DSP activation. The DSP account belongs to the advertiser, and you send against their DSP Advertiser ID. What you need is access to that account, not a DSP account of your own.\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"Terms Acceptance Is a Send Gate"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[" The advertiser must accept the Events API terms themselves, in their own Amazon Ads account. It cannot be delegated to a partner.\n"," Build for this. A connector should hold sends until acceptance is confirmed — a per-advertiser flag in your own configuration — rather than sending and hoping.\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"Permissions"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[" The API user needs Event Manager = Edit, granted at the advertiser level:\n"," Administration → Account access and settings → invite user → Custom → Event Manager → Edit\n"," Grant it at the advertiser level, not the manager account level. Manager-account-level invites offer only coarse roles with no Custom option.\n"," The required OAuth scope is advertising::campaign_management.\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"Set Up Your Environment"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[" Install the one dependency: \n"," Then set four values in your shell. The client below reads these and nothing else: \n"," The first three come from the advertiser's Login with Amazon (LwA) application. DSP_Advertiser_ID is the value Use Case 1 shows you how to look up - set it to any placeholder for now, run the account lookup on that page, then come back and fill the real one. \n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"The Shared Client"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[" Every page uses this client. Create it once as events_api_client.py.\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"Concepts You Need Once"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":["| Concept                                 | What to know                                                                                                                                                                   |\n","\\| --------------------------------------- \\| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \\|\n","| DSP Advertiser ID                       | The value in the Amazon-Ads-AccountId header. Not a profile ID, not a manager account ID.                                                                                    |\n","| HTTP 207                                | The normal success status. Per-event outcomes live in success\\[] and error\\[].                                                                                           |\n","| Match keys                              | Hashed customer identifiers. SHA-256, lowercase hex, UTF-8, no salt. Opaque identifiers are sent raw, never hashed — MAID, RAMP_ID, MATCH_ID, REAL_ID, MERKLE_ID, KANTAR_ID — and FIP is sent as a plaintext IP address. See page 02 for the rules per field.                      |\n","| Normalization                           | Per-field cleanup before hashing. Skipping it causes no rejection; it silently lowers match rate.                                                                          |\n","| eventSource vs eventIngestionMethod | Where the conversion happened, versus how it was transmitted. Independent — WEBSITE + SERVER_TO_SERVER is valid and common.                                                |\n","| Consent signal                          | For UK and EEA personal data, exactly one of tcf or gpp as a plain string, or amazonConsent as an object. countryCode goes on the event, not inside consent. |\n","| eventId deduplication                 | Your own idempotency key. First-wins with no upsert — a later event with the same eventId is dropped, not applied.                                                       |\n","| Uniqueness tuple                        | name, conversionType, eventSource, eventIngestionMethod, and optional dataSetName. These five are the identity of a conversion definition.                       |\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"The Pages"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":["| Page | Title                                                  | Covers                                                     |\n","\\| ---- \\| ------------------------------------------------------ \\| ---------------------------------------------------------- \\|\n","| 01   | Use Case 1: Send Your First Conversion Event           | Credentials, DSP Advertiser ID, one accepted event         |\n","| 02   | Use Case 2: Normalize and Hash Match Keys              | Per-field rules, seven test vectors, raw-passthrough types |\n","| 03   | Use Case 3: Track Purchase Conversions                 | Revenue, currency, units, tuple stability                  |\n","| 04   | Use Case 4: Track Offline and Non-Purchase Conversions | Mapping the world onto the conversion type enum            |\n","| 05   | Use Case 5: Send Consent Signals for UK and EEA        | Three formats, silent-drop failure, the relay chain        |\n","| 06   | Use Case 6: Batch, Retry, and Deduplicate              | Batches of 1 to 500, per-event rejection, first-wins       |\n","| 07   | Use Case 7: Add Custom Attributes                      | customData, DSP reporting versus AMC                     |\n","| 08   | Events API Quick Reference                             | Every constraint, enum, and limit in one place             |\n","| 09   | Troubleshooting and Best Practices                     | Organised by symptom                                       |\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"What a Test Account Can and Cannot Verify"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[" An ADSP test account serves no ads and has no billing. You can verify ingestion: a 207, per-event acceptance, your own digests, and a conversion definition appearing. You cannot verify outcomes: match rate, attributed revenue, or reported conversions.\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"Resources"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":["Amazon Ads Events API developer documentation, for the endpoint and current schema. - Amazon Ads Data Manager, where events also appear as a conversion dataset. - The ADM hands-on workshop, a sibling under the Knowledge Hub covering first-party audience data.\n","\n"],"documentType":"guide"},{"title":"Amazon Ads Events API: Hands-On Implementation Workshop","sectionHeader":{"type":2,"text":"Contributors"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/overview","content":[],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":[],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":["You are setting up a new Events API integration and need to prove the path end to end. - You are onboarding an advertiser onto an existing connector and want to confirm their DSP Advertiser ID and permissions before sending real volume. - You are debugging an authorization failure and want to isolate credentials from payload.\n"],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":["An eligible DSP advertiser account, with Events API terms accepted by the advertiser. - An LWA client ID and secret, and a refresh token with advertising::campaign_management. - Event Manager = Edit at the advertiser level. - events_api_client.py from the guide home, and the four environment variables set.\n"],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":[" authenticate → validate the DSP Advertiser ID → build one event → send → read the 207\n"],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"The complete script"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":[" Save this as use_case_1.py and run it. Everything the page explains below is in here.\n"],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"Step 1: Authenticate"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":[" A 400 at this point is a credentials problem, not an Events API problem — wrong client secret, or a refresh token issued for different credentials. Resolve it before going further.\n"," A KeyError means the environment variables are not set in this shell session. See the setup section on the guide home.\n"],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"Step 2: Validate the DSP Advertiser ID"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":["| Entry type    | Keys present                           |\n","\\| ------------- \\| -------------------------------------- \\|\n","| DSP           | dspAdvertiserId, region            |\n","| Sponsored Ads | countryCode, entityId, profileId |\n"," DSP entries carry no countryCode at all. If you iterate alternateIds looking for the entry matching the country you are sending for, you either match a Sponsored Ads entry and take its profileId, or find nothing and conclude the advertiser has no DSP access. Both are dead ends, and neither produces an error naming the real cause.\n"," Filter on the presence of dspAdvertiserId, then match region — NA, EU, or FE. The same advertiser account has a different DSP Advertiser ID per region, so selecting the wrong region returns a valid-looking ID for the wrong one, with no error.\n"," The check is deliberately non-blocking. It confirms your ID appears in the list, and warns without stopping if it does not. nextToken paginates and the script reads one page, so an advertiser further down the list will warn even though the ID is valid — which is why the check informs rather than gates.\n"],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"Step 3: Build one event"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":[" countryCode is required. ISO 3166-1 alpha-2, plaintext, and not a match key. Events without it are rejected.\n"," eventTime is ISO 8601 UTC, and no more than 21 days old. Use the conversion's own timestamp, not send time.\n"," The five eventDescription fields are the uniqueness key for a conversion definition, and definitions auto-create. There is no select-a-definition-by-ID call. The first send with a given tuple creates a definition; every later send with the identical tuple lands on it. Any drift creates a second definition and splits reporting. Page 03 treats the tuple as a contract.\n"],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"Step 4: Read the response"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":[" HTTP 207 is the normal success path, not an anomaly. A real captured response:\n"," Three readings matter.\n"," error\\[] is always present, so the signal is that it is empty rather than absent.\n"," The event is echoed back in full, and every field you did not send returns as null. A null means \"you did not send this\" — not \"rejected\", and not \"defaulted\". unitsSold echoes as null while 1 is applied downstream.\n"," A rejection looks like this:\n"],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"Step 5: What a 207 does not mean"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":[" A 207 means accepted and validated. It does not mean processed. Check, in order:\n","Events Manager → Conversions, within up to ~2 hours, for a definition named workshop-first-event. 2. Terms acceptance. Events sent before the advertiser accepts are not processed, and the response looks identical. 3. Attachment to an order. Auto-creating a definition does not attach it to a campaign. An unattached definition reports zero conversions while every send succeeds. This needs a named owner — usually whoever runs the advertiser's campaigns.\n"],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"Reference: minimum viable event"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":["| Field                                   | Required | Notes                                                   |\n","\\| --------------------------------------- \\| -------- \\| ------------------------------------------------------- \\|\n","| eventDescription.name                 | yes      | Uniqueness tuple. Pin it as a constant                  |\n","| eventDescription.conversionType       | yes      | One of 12 values — see page 08                          |\n","| eventDescription.eventSource          | yes      | Where it happened                                       |\n","| eventDescription.eventIngestionMethod | yes      | Always SERVER_TO_SERVER                               |\n","| eventDescription.dataSetName          | optional | Uniqueness tuple. Omitting assigns Default_Events |\n","| countryCode                           | yes      | ISO 3166-1 alpha-2, plaintext                           |\n","| eventTime                             | yes      | ISO 8601 UTC, ≤ 21 days old                             |\n","| matchKeys                             | yes      | At least one. See page 02                               |\n","| eventId                               | optional | ≤ 256 characters, first-wins dedup                      |\n"],"documentType":"guide"},{"title":"Use Case 1: Send Your First Conversion Event","sectionHeader":{"type":2,"text":"Pitfalls"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/01-send-first-event","content":["Using the legacy headers. Amazon-Advertising-API-ClientId and -Scope work on most other Amazon Ads endpoints and fail here. This endpoint wants Amazon-Ads-ClientId and Amazon-Ads-AccountId. - Sending profileId as Amazon-Ads-AccountId. It is a Sponsored Ads identifier and fails here. Filter alternateIds for entries that have dspAdvertiserId. - Selecting the DSP entry by countryCode. DSP entries have region, not countryCode. Matching on country finds nothing or returns the wrong identifier. - Taking the first DSP entry you find. The same account has one ID per region. Match the region you are sending for. - Treating 207 as an error because it is not 200, or treating it as complete success without reading error\\[]. - Assuming a null in the echo means rejected. It means you did not send it. - Sending before terms acceptance. Accepted, never processed, no signal.\n","\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":[],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":["You are building the identity layer of a connector and need match keys that match. - You are porting normalization rules into another language and need known-good vectors to check against. - Match rate is lower than expected and you suspect normalization rather than coverage. - You are handing off MAID, RAMP_ID, MATCH_ID, or an IP address and need to know whether to hash it.\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":["Page 01 — a working client and one accepted event. - SHA-256 available in your language, and UTF-8 encoding you can rely on.\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":[" raw customer record → normalize per field → SHA-256 → verify against the vectors → build matchKeys → send\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"The complete script"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":[" Save this as use_case_2.py. It verifies your normalization against the published vectors, then sends an event using the result. Later pages carry their own copy of this normalization code so each one runs standalone - if you change a rule here, re-run this check to confirm the vectors still pass.\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"Why normalization decides match rate"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":[" Hashing is deterministic, so Jordan.Avery@Example.com and jordan.avery@example.com produce completely different digests. Amazon normalizes its side one specific way. If your side normalizes differently, the digests never meet.\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"The valid match key types"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":[" The API's matchKeys.type enum, in full:\n"," Anything else is rejected with Invalid value: &lt;type>. Must be one of \\[...].\n","| Group              | Types                                                                             | Sent as                                    |\n","\\| ------------------ \\| --------------------------------------------------------------------------------- \\| ------------------------------------------ \\|\n","| Hashed PII         | EMAIL, PHONE, FIRST_NAME, LAST_NAME, ADDRESS, CITY, STATE, POSTAL | SHA-256, lowercase hex, UTF-8, no salt |\n","| Opaque identifiers | MAID, RAMP_ID, MATCH_ID, REAL_ID, MERKLE_ID, KANTAR_ID                | raw, never hashed                      |\n","| IP address         | FIP                                                                             | plaintext IPv4 or IPv6                 |\n"," Hashing an opaque identifier destroys it. Amazon holds the identifier itself, not a digest of it, so a hashed MAID matches nothing and there is no error to tell you.\n"," There is no COUNTRY match key type. countryCode is an event-level plaintext field, required on every event, and not a match key.\n"," Two structural rules the array shape invites you to break:\n","Each match key carries exactly one value. Two values in one entry returns Field length 2 must be between \\[1, 1]. - Each type appears at most once per event. Duplicates return One or more match keys types are duplicated in the event data.\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"The rules that catch people"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":[" Phone is where most integrations lose match rate. 15550101234 and 5550101234 are different digests, and dropping the country code is the common error. Normalize to E.164 digits with the country code and without the +. Note normalize() returns digits only — prefix the country code in your own mapping layer, where you know the market.\n"," State must be the two-letter abbreviation. New York becomes ny, not newyork.\n"," Transliteration is required for non-ASCII names:\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"The expected vectors"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":["| Type        | Raw input                    | Normalized                 | SHA-256                                                            |\n","\\| ----------- \\| ---------------------------- \\| -------------------------- \\| ------------------------------------------------------------------ \\|\n","| EMAIL       | Jordan.Avery@Example.com·· | jordan.avery@example.com | db1b93cc4d9c158fd8418eeb9d6e1cbb2f6b9d2efecc218d63f8b39f86f646f1 |\n","| PHONE       | +1 (555) 010-1234          | 15550101234              | 6f5f87218b71c93bcba2e851e555d077ae8f2fd560f6b5964ab84c2e828471b2 |\n","| FIRST_NAME | ·Ana-Maria·                | anamaria                 | 246b7556cc1e9da32673b5c1ca930f53b6cc1393681f2608bafc39308d66f876 |\n","| LAST_NAME  | O'Brien                    | obrien                   | b4cb6cb33fe4b865868de825023a1e2790dc12ac01ecc8d7c5afe8254071c8ba |\n","| CITY        | New York City              | newyorkcity              | f0802d4c67ac66013292e4d04adeb815b0431c0e1633c999ca1557d64fed5ff9 |\n","| STATE       | New York                   | ny                       | 1b06e2003f8420d6fa42badd8f77ec0f706b976b7a48b13c567dc5a559681683 |\n","| POSTAL      | 10001-2345                 | 10001                    | e443169117a184f91186b401133b20be670c7c0896f9886075e5d9b81e9d076b |\n"," A mismatch on one field points at that field's rule. A mismatch on every field points at something shared — encoding other than UTF-8, uppercase hex, or a salt your crypto wrapper adds without telling you.\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"What going wrong looks like"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":[" Both of these are plausible implementations. Neither raises an error, neither is rejected, and both quietly reduce match rate.\n","| Mistake                            | Value hashed                 | SHA-256                                                            |\n","\\| ---------------------------------- \\| ---------------------------- \\| ------------------------------------------------------------------ \\|\n","| Email hashed with no normalization | Jordan.Avery@Example.com·· | f33c1b0f6fa693f4e3f1ccb06f4264fcd3f79069aa9d0ac5ae6b774fbd630885 |\n","| Phone digits, country code dropped | 5550101234                 | 51ae4fbca21e9f8d793cf9977ebfdded999d060d2e4076bbd884c98bda7d8cc2 |\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"Reference: match key summary"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":["| Type                                  | Sent as          | Source            | Note                                 |\n","\\| ------------------------------------- \\| ---------------- \\| ----------------- \\| ------------------------------------ \\|\n","| EMAIL                               | SHA-256          | CRM               | trim, lowercase                      |\n","| PHONE                               | SHA-256          | CRM               | E.164 digits, country code included  |\n","| FIRST_NAME / LAST_NAME            | SHA-256          | CRM               | transliterate, alphanumerics only    |\n","| ADDRESS / CITY                    | SHA-256          | CRM               | alphanumerics only                   |\n","| STATE                               | SHA-256          | CRM               | two-letter abbreviation              |\n","| POSTAL                              | SHA-256          | CRM               | first five digits for US             |\n","| MAID                                | raw          | mobile SDK        | hashing destroys it                  |\n","| RAMP_ID                             | raw          | identity provider | encrypted value; note the underscore |\n","| MATCH_ID                            | raw          | identity provider | note the underscore                  |\n","| REAL_ID / MERKLE_ID / KANTAR_ID | raw          | identity provider |                                      |\n","| FIP                                 | plaintext IP | request metadata  | IPv4 or IPv6, never hashed           |\n"],"documentType":"guide"},{"title":"Use Case 2: Normalize and Hash Match Keys","sectionHeader":{"type":2,"text":"Pitfalls"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/02-normalize-and-hash","content":["Dropping the phone country code. The single largest silent match-rate loss on this page. - RAMPID or MATCHID without the underscore. Rejected outright — RAMP_ID and MATCH_ID. - Hashing MAID, RAMP_ID, MATCH_ID, or FIP. All are sent as-is. A hashed opaque identifier matches nothing and the API accepts it as well-formed. - Assuming IP is unsupported. It is supported, as FIP, sent plaintext. - Sending a COUNTRY match key. There is no such type. Country lives on the event as countryCode. - Two values in one match key, or one type twice. Both rejected. - Uppercase hex, or a salt. Lowercase, unsalted. A crypto wrapper adding a salt produces valid-looking digests that match nothing. - Skipping the vectors because the API accepted the events. Acceptance says nothing about matching. - Hashing countryCode. It is plaintext and required, and a hashed value is rejected against the country enum.\n","\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":[],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":["You are sending completed purchases from a commerce backend, subscription platform, or order management system. - The advertiser needs revenue and units attributed, not just conversion counts. - You are replacing a browser purchase tag with a server-side feed.\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":["Page 01 — a working client, a DSP Advertiser ID, and one accepted event. - Page 02 — the normalization rules. The script below carries its own copy so this page runs standalone.\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":[" order from your backend → normalize and hash match keys → build a purchase event with monetary fields → send → read the 207\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"The complete script"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":[" Save this as use_case_3.py and run it.\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"Step 1: `OFF_AMAZON_PURCHASES` is the only type where money means money"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":[" Page 04 is entirely about living with that constraint for non-purchase conversions.\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"Step 2: The tuple is a contract, not payload"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":[" The five eventDescription fields are the uniqueness key for a conversion definition, and definitions auto-create. You do not point at a definition; you describe one, and Amazon either finds the match or makes a new one.\n"," Any drift creates a second definition and splits reporting. No error, no warning — a second definition counting some conversions while the original counts the rest. The advertiser sees both and cannot tell which is real.\n"," dataSetName participates. A tuple with it set is not the tuple without it, so adding it later forks the definition. Dataset names are also immutable once set. Omit it and definitions are assigned to Default_Events.\n"," Pin the tuple as a constant, not a string built at call time. A name composed from an environment, hostname, date, or build number forks a definition on every change to that variable.\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"Step 3: `eventSource` is not `eventIngestionMethod`"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":[" eventSource is where the conversion happened. eventIngestionMethod is how it was transmitted. A browser checkout sent from your backend is WEBSITE + SERVER_TO_SERVER. The transmission method does not change where the conversion happened.\n"," Because eventSource is part of the tuple, web and app purchases under the same name land in different definitions. That is usually what you want; decide it deliberately rather than discovering it.\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"Step 4: Monetary fields and their bounds"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":["| Field          | Constraint                          | If omitted                                  |\n","\\| -------------- \\| ----------------------------------- \\| ------------------------------------------- \\|\n","| value        | number, 0.0 to 9999999999999.99 | no value recorded                           |\n","| currencyCode | one of 18 supported codes           | the conversion definition's setting is used |\n","| unitsSold    | 1 to 9999999999999                  | 1 is applied                            |\n"," An advertiser billing in CHF, HKD, KRW, or ZAR will be rejected — those are absent. The script checks against this list before sending so you see the problem in your own output rather than in a rejection.\n"," Omitting unitsSold applies 1. Not zero, not null. A cart of three items sent without it is recorded as one unit at the full cart value: revenue right, units quietly wrong.\n"," Omitting currencyCode uses the definition's setting. Fine for a single-currency advertiser, a trap for a multi-currency one where a EUR order gets relabelled. Send it explicitly.\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"Step 5: Send and verify"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":[" A 207 with both events in success\\[] means accepted — not matched, not processed, not attributed. Check, in order:\n","Events Manager → Conversions, within up to ~2 hours. Look for exactly one definition named web-purchase. Two similar names is the tuple drift from Step 2, and far cheaper to catch on day one than after a month of splits. 2. Ads Data Manager, where events also appear as a conversion dataset. 3. Attachment to an order. Auto-creating a definition does not attach it to a campaign, and an unattached definition reports zero conversions while every send succeeds.\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"Reference: purchase event fields"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":["| Field                                   | Type   | Required | Notes                                                                 |\n","\\| --------------------------------------- \\| ------ \\| -------- \\| --------------------------------------------------------------------- \\|\n","| eventDescription.name                 | string | yes      | Uniqueness tuple. Pin it                                              |\n","| eventDescription.conversionType       | enum   | yes      | OFF_AMAZON_PURCHASES for revenue                                    |\n","| eventDescription.eventSource          | enum   | yes      | Where it happened                                                     |\n","| eventDescription.eventIngestionMethod | enum   | yes      | Always SERVER_TO_SERVER                                             |\n","| eventDescription.dataSetName          | string | optional | Uniqueness tuple, immutable. Omitting assigns Default_Events    |\n","| countryCode                           | string | yes      | ISO 3166-1 alpha-2. Rejected if missing                               |\n","| eventTime                             | string | yes      | ISO 8601, maximum 21 days old                                         |\n","| matchKeys                             | array  | yes      | See page 02                                                           |\n","| value                                 | number | optional | 0.0 to 9999999999999.99. Money only on OFF_AMAZON_PURCHASES |\n","| currencyCode                          | string | optional | One of 18 codes. Falls back to the definition's setting               |\n","| unitsSold                             | number | optional | 1 to 9999999999999. Omitting applies 1                            |\n","| eventId                               | string | optional | ≤ 256 characters. First-wins dedup, no upsert                         |\n","| partner                               | string | optional | Name of the platform sending on the advertiser's behalf               |\n"],"documentType":"guide"},{"title":"Use Case 3: Track Purchase Conversions","sectionHeader":{"type":2,"text":"Pitfalls"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/03-purchase-conversions","content":["A timestamped or environment-derived name. \"web-purchase-2026-08-27\" forks a definition every run. Within a month the advertiser has dozens, each holding a slice of the truth. - Adding dataSetName later. Part of the uniqueness key, so it creates a second definition on an otherwise identical description. Decide before the first send; the name is immutable afterwards. - A negative value. Rejected. The range starts at 0.0. - An unsupported currency. Only 18 codes are accepted. CHF, HKD and ZAR are not among them. - value as a string. \"129.99\" is a string; value is a number. This one fails loudly, which makes it the cheapest mistake here. - More than two decimal places. Quantize before sending. - Omitting unitsSold on multi-item orders. 1 is applied. Revenue looks right, units are wrong — the hardest kind of wrong to notice. - Letting currencyCode default for a multi-currency advertiser. - Hardcoding eventTime in sample code. An event older than 21 days returns 207 with zero rejections and is never processed. Generate timestamps at run time. - Expecting revenue in a test account. Zero attributed revenue is expected and says nothing about your integration.\n","\n"],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":[],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":["The advertiser's conversion happens off the web entirely — a call, a showroom visit, a signed agreement. - You are sending leads, sign-ups, or subscriptions rather than purchases. - Conversions are scored after the fact and you need to decide when to send.\n"],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":["Page 01 — a working client and one accepted event. - Page 02 — the normalization rules. The script below carries its own copy so this page runs standalone. - Page 03 — the uniqueness tuple, which behaves identically here.\n"],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":{"type":2,"text":"Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":[" record from a CRM, call system, or store feed → choose the closest conversion type → decide what value means → send → read the 207\n"],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":{"type":2,"text":"The complete script"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":[" Save this as use_case_4.py and run it.\n"],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":{"type":2,"text":"Step 1: There are twelve types, and yours is probably not on the list"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":[" There is no PHONE_CALL, no STORE_VISIT, no DEMO_BOOKED, no QUOTE_REQUESTED. The work on this page is choosing the nearest honest type and recording your choice somewhere the advertiser can see it.\n","| The advertiser's event       | Reasonable type        | Why                                     |\n","\\| ---------------------------- \\| ---------------------- \\| --------------------------------------- \\|\n","| Inbound sales call           | CONTACT              | The customer initiated contact          |\n","| Form fill, gated content     | LEAD                 | Contact details exchanged for something |\n","| Newsletter or account signup | SIGN_UP              | No commercial commitment yet            |\n","| Recurring plan started       | SUBSCRIBE            | Ongoing commitment                      |\n","| Loan or credit application   | APPLICATION          | Formal submission                       |\n","| Showroom or branch visit     | CONTACT or OTHER   | Depends whether staff engaged           |\n","| Signed contract, closed deal | OFF_AMAZON_PURCHASES | Only if there is a monetary amount      |\n"," Pick one type per advertiser event and never change it. conversionType is part of the uniqueness tuple, so reclassifying later forks the definition and splits history.\n"],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":{"type":2,"text":"Step 2: `eventSource: OFFLINE` and what it means"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":[],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":{"type":2,"text":"Step 3: `value` is not money here"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":[" That makes value genuinely useful for lead quality, as long as everyone knows it is not currency:\n"," The failure to design for is a connector that maps a CRM \"deal value\" field into value on a LEAD event. The number is currency in the source system and non-currency at the destination, and nothing in the response flags the change in meaning. Either use OFF_AMAZON_PURCHASES with a real amount, or agree explicitly that value is a score.\n"," Omitting value is not the same as sending 0. The second record in the script has no score, so the field is left out entirely rather than defaulted — a zero would be a real score of zero.\n"],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":{"type":2,"text":"Step 4: Send early or send scored, and decide before you build"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":[" Offline conversions are often scored after the fact — a lead qualified a week later, a deal closed a month later. eventId deduplication is first-wins with no upsert, so a resent event with the same eventId is dropped rather than applied.\n"," That forces a choice:\n"," Send early, when the conversion happens, and accept that later scoring cannot be reflected. Attribution is timely; the score is whatever you knew at the time.\n"," Send scored, once qualification completes, and accept the delay. eventTime still carries the original conversion timestamp, so attribution is correct — as long as you are inside the 21-day limit. Beyond that the event is not processed.\n"," Sending twice with different eventId values is not a fix. It produces two conversions for one real event.\n"],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":{"type":2,"text":"Reference: non-purchase event fields"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":["| Field            | Purchase meaning       | Non-purchase meaning                                   |\n","\\| ---------------- \\| ---------------------- \\| ------------------------------------------------------ \\|\n","| conversionType | OFF_AMAZON_PURCHASES | one of the other eleven values                         |\n","| value          | currency amount        | non-monetary number on your scale                  |\n","| currencyCode   | applies                | rejected — BAD_REQUEST, field not allowed         |\n","| unitsSold      | items sold             | rejected — BAD_REQUEST, field not allowed         |\n","| eventTime      | order timestamp        | when the conversion happened, not when you scored it   |\n","| eventId        | order ID               | CRM or call ID. First-wins, no upsert                  |\n"],"documentType":"guide"},{"title":"Use Case 4: Track Offline and Non-Purchase Conversions","sectionHeader":{"type":2,"text":"Pitfalls"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/04-offline-and-lead-events","content":["Inventing a conversion type. Only the twelve values exist. Anything else is rejected against the enum. - Forcing a bad fit rather than using OTHER. A store visit reported as LEAD produces plausible, wrong reporting. OTHER is honest. - Reclassifying later. conversionType is part of the uniqueness tuple. Changing it forks the definition and splits history. - Mapping a CRM currency field into value on a non-purchase type. It stops being currency at the destination and nothing warns you. - Sending 0 when you mean \"not scored\". Omit the field instead. - Sending currencyCode or unitsSold on a non-purchase type. Both are rejected with The provided field is not allowed for non-purchase events. A connector that always populates them fails every non-purchase event. - A negative value. Rejected; the range starts at 0.0. - Planning to correct a value later. First-wins with no upsert — a resent event is dropped, not applied. Decide before you build whether you send early or send scored. - Sending twice with different eventId values to force an update. That is two conversions for one event. - Missing the 21-day window while waiting for qualification. It fails silently with a 207.\n","\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":[],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":["The advertiser has customers in the UK or EEA and their events carry personal data. - You are designing the ingestion contract for a connector that will eventually serve EEA advertisers. - An advertiser has a CMP and you need to relay its output.\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":["Page 01 — a working client and one accepted event. - Page 02 — build_match_keys(). - A consent signal captured at the source. You cannot create one.\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":[" CMP captures consent → your platform stores it beside the event → you map it to the Events API shape → send → confirm it came back in the echo\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"Step 1: The consent object has four keys"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":[" The API echoes the consent object back with its full key set, which is the clearest statement of its shape:\n"," There is no consent.countryCode. countryCode is required at the event level — a missing one returns 400 BAD_REQUEST with fieldLocation: countryCode — and a countryCode placed inside consent is silently discarded.\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"Step 2: Three formats, exactly one sent"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":["| Format                 | Field           | Type             |\n","\\| ---------------------- \\| --------------- \\| ---------------- \\|\n","| IAB TCF                | tcf           | plain string |\n","| IAB GPP                | gpp           | plain string |\n","| Amazon Consent Service | amazonConsent | object           |\n"," Of the three formats, only amazonConsent is an object.\n"," Send exactly one format. Not because two are rejected — both are accepted, and both come back populated in the echo — but because the resolution order is undocumented. If the two disagree you can neither predict nor observe which was applied.\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"Step 3: The ACS fields"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":["| Field           | Values                              | Notes                                              |\n","\\| --------------- \\| ----------------------------------- \\| -------------------------------------------------- \\|\n","| amznUserData  | GRANTED, DENIED                 | Required                                       |\n","| amznAdStorage | GRANTED, DENIED, or JSON null | Omittable. The literal string \"NULL\" is rejected |\n"," Sending the string \"NULL\" is rejected per event:\n"," That is exactly the mistake you make if you read NULL in a value list as something to send.\n"," JSON null and omission are not obviously the same thing. If your source distinguishes \"the user declined ad storage\" from \"we never asked\", you have somewhere to put that — map it deliberately rather than letting a serializer decide.\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"Step 4: An unrecognised key is silently dropped"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":[" The API silently ignores unknown fields generally, so the echo is the only proof that what you sent was understood. Two defences:\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"Step 5: You are the middle link, and you cannot manufacture consent"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":[" Consent travels through three parties. The source captures it, at the moment the customer answers — the only point at which consent can come into existence. Your platform relays it, stored beside the event and carried forward unchanged. Your platform maps it into the Events API shape on the way out.\n"," Two consequences for the connector you are building.\n"," Your ingestion contract needs a consent field from day one. If the advertiser's feed into your platform has no column for consent, you cannot add one at send time. Retrofitting is expensive, and it is expensive at exactly the moment an EEA advertiser signs.\n"," \"We rely on legitimate interest\" is a legal determination, not a configuration value. Route it to legal — theirs and yours — rather than encoding it as an assumed GRANTED.\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"Step 6: Consent and `countryCode` are plaintext"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":[" This trips people who have just built the hashing layer on page 02 and apply it uniformly. A hashed countryCode is rejected against the country enum — the error helpfully returns the entire valid list — and a hashed consent string is not a consent string.\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"Reference: consent fields"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":["| Field                                 | Type       | Notes                                                                           |\n","\\| ------------------------------------- \\| ---------- \\| ------------------------------------------------------------------------------- \\|\n","| consent.tcf                         | string | IAB TCF string. Object forms return HTTP 400                                    |\n","| consent.gpp                         | string | IAB GPP string. Object forms return HTTP 400                                    |\n","| consent.amazonConsent               | object     | The only object of the three                                                    |\n","| consent.amazonConsent.amznUserData  | enum       | Required. GRANTED or DENIED                                             |\n","| consent.amazonConsent.amznAdStorage | enum       | GRANTED, DENIED, or JSON null. Omittable. The string \"NULL\" is rejected |\n","| consent.geo                         | object     | Requires ipAddress. Not where country goes                                    |\n","| countryCode                         | string     | Event level, not inside consent. Required, plaintext                      |\n"],"documentType":"guide"},{"title":"Use Case 5: Send Consent Signals for UK and EEA","sectionHeader":{"type":2,"text":"Pitfalls"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/05-consent-uk-eea","content":["Sending tcf or gpp as an object. Request-level HTTP 400 with an empty error\\[] and nothing naming consent. They are plain strings. - Putting countryCode inside consent. No such field; silently discarded. It belongs on the event. - Misspelling a format key. 207, empty error\\[], consent absent. Assert on the echo. - Sending the string \"NULL\" for amznAdStorage. Rejected per event. Use JSON null, or omit the field. - Sending two formats. Both accepted, both echoed, resolution order undocumented — you cannot establish what consent was acted on. - Hashing consent fields or countryCode. Both are plaintext. - Defaulting to GRANTED because the field is required. That is a fabricated legal record, not a data-quality shortcut. - Designing the ingestion contract without a consent field, then discovering it when an EEA advertiser signs.\n","\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":[],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":["You are building the send layer of a multi-tenant connector. - You need to decide what to retry and what to route to a dead-letter store. - An advertiser also runs Amazon Ad Tag and you need both feeds to coexist. - Conversion counts look inflated or short and you suspect deduplication.\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":["Page 01 — a working client and the 207 response shape. - Page 02 — build_match_keys().\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":[" build events → batch up to 500 → send → split success\\[] from error\\[] → retry transient, dead-letter permanent\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Step 1: Batches of 1 to 500, one advertiser each"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":[" 500 events per request is the maximum; 501 is rejected at request level with a validation error. The client on the guide home already chunks for you.\n"," Preserve order between building and sending. The index in the response refers to the position in the array you posted. If your code builds a list, sends a re-sorted copy, and then looks up failures by index against the original, every rejection is attributed to the wrong event.\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Step 2: Reading a partial 207"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":[" A single response can carry both outcomes. This is a real capture from a batch of two where the second event was missing countryCode:\n"," Log rejection counts and alarm on them. A rejection rate that drifts from zero to two percent is invisible without a metric, and two percent of conversions is a real number to an advertiser.\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Step 3: What to retry"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":[" Per-event rejections in error\\[] are validation failures. The payload is wrong, and it will be wrong again.\n"," Retry only transport-level failures: a connection error, a 5xx, or a 429. Use exponential backoff, and note that a 429 can arrive without your throughput being unusual.\n"," Always set a timeout. A request with no timeout can hang indefinitely.\n"," A 400 is not retryable either. It means the request itself was malformed — 501 events, or a tcf object instead of a string.\n"," There is no success or error array, so nothing identifies which event was at fault. Check the status code before parsing per-event results, and dead-letter the whole batch. Code that goes straight to the per-event arrays gets two empty lists and silently loses every event in the batch.\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Step 4: `eventId` deduplication is first-wins with no upsert"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":[" That single behaviour is what makes retries safe and corrections impossible, and it is the same mechanism from both directions:\n"," A stable eventId makes retry safe. If you resend after a timeout and the first attempt actually landed, the duplicate is dropped rather than double-counted.\n"," A stable eventId makes correction impossible. If you send a lead scored 40 and later want it to be 80, resending with the same eventId does nothing. The original stands.\n"," Derive eventId from source data — an order ID, a CRM record ID — so it is stable across retries. Never mint it at send time from a UUID or a timestamp, which makes every retry a new conversion.\n"," Decide before you build whether you need retry safety or correction, because you cannot have both. Page 04 covers the send-early-versus-send-scored choice this forces for offline conversions.\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Step 5: Coexisting with Amazon Ad Tag"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":[" If the advertiser also runs Amazon Ad Tag, the same conversion can arrive twice — once from the browser tag, once from your feed.\n"," Deduplication is not automatic across sources. Pass the same identifier in eventId on the Events API side and in the tag's deduplication field on the client side, so both paths carry one shared key. A transaction ID works well.\n"," If the two feeds send genuinely different event types with no overlap, no deduplication is needed.\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Step 6: The `partner` field"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":[" If you send on an advertiser's behalf, populate partner with your platform's name.\n"," It is optional, accepts an arbitrary string, and is not part of the uniqueness tuple, so setting it does not fork a definition. Set it consistently — it is how the advertiser and Amazon can tell your feed from another.\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Complete Example: `send_all()`"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":[],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Reference: batching and dedup"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":["| Concern                 | Value                                                     |\n","\\| ----------------------- \\| --------------------------------------------------------- \\|\n","| Events per request      | 1 to 500. 501 is rejected at request level                |\n","| Advertisers per request | one — the header carries the ID                           |\n","| Success status          | 207, with per-event outcomes in success\\[] and error\\[] |\n","| index                 | position in the array you posted                          |\n","| Retryable               | connection errors, 5xx, 429                               |\n","| Not retryable           | per-event rejections in error\\[], and any 400            |\n","| eventId               | ≤ 256 characters, first-wins, no upsert               |\n","| partner               | optional string, not part of the uniqueness tuple         |\n"],"documentType":"guide"},{"title":"Use Case 6: Batch, Retry, and Deduplicate","sectionHeader":{"type":2,"text":"Pitfalls"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/06-batching-and-dedup","content":["Checking only the status code. A 207 can carry rejections. Parse the body every time. - Retrying a per-event rejection. It fails identically. Dead-letter it. - Retrying a 400. The request was malformed; retrying changes nothing. - No timeout on the request. It can hang indefinitely. - Re-sorting the batch after building it. index refers to what you posted, so failures get attributed to the wrong events. - A eventId minted at send time. Every retry becomes a new conversion. - Expecting a resend to correct a value. First-wins, no upsert. The original stands. - Mixing advertisers in one batch. The header is per-request. - Assuming Ad Tag and Events API deduplicate automatically. They do not — pass a shared key, and confirm it in the echo. - No alarm on rejection counts. A slow drift from zero is invisible without a metric.\n","\n"],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":[],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":{"type":2,"text":"When to Use"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":["The advertiser wants conversion reporting segmented by their own dimensions. - You are designing what your connector will let advertisers map into customData. - Someone has asked for a breakdown in DSP reporting and you need to know whether it is possible.\n"],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":["Page 01 — a working client and one accepted event. - Page 03 — the purchase event this page extends.\n"],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":{"type":2,"text":"Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":[" your own attributes → declare a type for each → attach as customData → send → find them in DSP reporting or AMC\n"],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":{"type":2,"text":"Step 1: Only three names reach DSP reporting"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":[" That is the single fact that decides what you can promise. An advertiser asking to segment DSP reporting by membership_tier cannot have it — the attribute arrives and is queryable in AMC, but it will not appear as a DSP reporting dimension.\n","| Attribute name | AMC | DSP reporting |\n","\\| -------------- \\| --- \\| ------------- \\|\n","| brand        | yes | yes       |\n","| productId    | yes | yes       |\n","| category     | yes | yes       |\n","| anything else  | yes | no            |\n"," Establish which surface the advertiser actually uses before agreeing to a breakdown. \"It's in the data\" and \"it's in the DSP report\" are different promises, and only one of them is visible to someone who never opens AMC.\n"],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":{"type":2,"text":"Step 2: The shape, and the one thing that breaks it"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":[" Declare honestly. {\"dataType\": \"INTEGER\", \"value\": \"gold\"} declares an integer and supplies a word — the API may accept it, and the attribute is wrong wherever it lands. Catch that in your builder:\n"],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":{"type":2,"text":"Step 3: Naming and limits"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":[" Attribute names should use letters, numbers, and underscores. Keep to 10 attributes or fewer per event.\n"," Both are documented limits that request validation does not currently enforce — a hyphenated name and an eleventh attribute are both accepted. Stay inside them anyway: an unenforced limit can begin being enforced without notice, and the downstream systems that read these attributes are a different matter from the endpoint that accepts them.\n"," Name attributes once and never rename them. customData is not part of the conversion definition's uniqueness tuple, so renaming does not fork a definition — which sounds safe and is not. The old name and the new name become two separate dimensions covering different time ranges, with nothing marking the change.\n"],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":{"type":2,"text":"Step 4: `customData` is context, not identity"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":[],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":{"type":2,"text":"The complete script"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":[" Save this as use_case_7.py and run it.\n"," Fictional order. Note basket_size is declared INTEGER and its value goes out as the string \"3\".\n"],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":{"type":2,"text":"Reference: `customData`"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":["| Field                   | Type       | Notes                                                                                    |\n","\\| ----------------------- \\| ---------- \\| ---------------------------------------------------------------------------------------- \\|\n","| customData            | array      | Up to 10 entries recommended                                                             |\n","| customData\\[].name     | string     | Letters, numbers, underscores. brand, productId, category also reach DSP reporting |\n","| customData\\[].dataType | enum       | STRING, INTEGER, TIMESTAMP                                                         |\n","| customData\\[].value    | string | Always a JSON string. A raw number returns HTTP 400                                      |\n"],"documentType":"guide"},{"title":"Use Case 7: Add Custom Attributes","sectionHeader":{"type":2,"text":"Pitfalls"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/07-custom-attributes","content":["A raw number as value. {\"dataType\": \"INTEGER\", \"value\": 3} returns HTTP 400 and takes the whole batch with it. Send \"3\". - Assuming every attribute reaches DSP reporting. Only brand, productId, and category do. The rest are AMC-only. - Promising a DSP breakdown on a custom name. Check which surface the advertiser uses before agreeing. - A dataType outside the enum. Only STRING, INTEGER, TIMESTAMP. - Declaring a type the value is not. No error, wrong data downstream. - Renaming an attribute. Two dimensions covering different periods, with nothing marking the change. - Personal data in an attribute value. Not hashed, not an identifier. Identifiers go in matchKeys. - Relying on the limits being unenforced. Eleven attributes and hyphenated names are accepted today. That can change.\n","\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[" Every constraint in one place. This is a lookup page, not a tutorial — the use-case pages explain the reasoning, and this one gives you the values.\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"Endpoint and headers"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":["\\|               \\|                                            \\|\n","\\| ------------- \\| ------------------------------------------ \\|\n","| Send events   | POST /adsApi/v1/create/events            |\n","| List accounts | POST /adsApi/v1/query/advertiserAccounts |\n","| Base URL      | https&#x3A;//advertising-api.amazon.com       |\n","| Token URL     | https&#x3A;//api.amazon.com/auth/o2/token     |\n","| OAuth scope   | advertising::campaign_management         |\n","| Header                 | Value                     |\n","\\| ---------------------- \\| ------------------------- \\|\n","| Amazon-Ads-ClientId  | your LWA client ID        |\n","| Amazon-Ads-AccountId | the DSP Advertiser ID |\n","| Authorization        | Bearer &lt;access token>   |\n","| Content-Type         | application/json        |\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"Status codes"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":["| Code      | Meaning                                                                 |\n","\\| --------- \\| ----------------------------------------------------------------------- \\|\n","| 207   | Normal success. Per-event outcomes in success\\[] and error\\[]         |\n","| 400       | Request-level failure. error\\[] is empty — nothing names the field |\n","| 401 / 403 | Credentials, permissions, or account eligibility                        |\n","| 429       | Throttled. Retry with backoff; can occur at ordinary throughput         |\n","| 5xx       | Retry with backoff                                                      |\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"Event fields"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":["| Field                                   | Type   | Required    | Constraint                                                           | If omitted                       |\n","\\| --------------------------------------- \\| ------ \\| ----------- \\| -------------------------------------------------------------------- \\| -------------------------------- \\|\n","| eventDescription.name                 | string | yes         | uniqueness tuple                                                     | —                                |\n","| eventDescription.conversionType       | enum   | yes         | 12 values, below                                                     | —                                |\n","| eventDescription.eventSource          | enum   | yes         | 6 values, below                                                      | —                                |\n","| eventDescription.eventIngestionMethod | enum   | yes         | SERVER_TO_SERVER only                                              | —                                |\n","| eventDescription.dataSetName          | string | optional    | uniqueness tuple; immutable                                      | assigned to Default_Events     |\n","| countryCode                           | string | yes         | ISO 3166-1 alpha-2, plaintext                                        | rejected                     |\n","| eventTime                             | string | yes         | ISO 8601 UTC, ≤ 21 days old                                          | rejected                     |\n","| matchKeys                             | array  | yes         | one value per entry, one entry per type                              | rejected                     |\n","| eventId                               | string | optional    | ≤ 256 characters                                                     | no deduplication key             |\n","| value                                 | number | optional    | 0.0 to 9999999999999.99, ≤ 2 decimal places                      | no value recorded                |\n","| currencyCode                          | string | optional    | one of 18 codes, below                                               | the definition's setting is used |\n","| unitsSold                             | number | optional    | 1 to 9999999999999                                                   | 1 is applied                 |\n","| partner                               | string | optional    | arbitrary string                                                     | not attributed to a platform     |\n","| consent                               | object | conditional | see below                                                            | no consent recorded              |\n","| customData                            | array  | optional    | see below                                                            | —                                |\n","| amazonAdEventKey                      | string | conditional | required when eventSource is MEASUREMENT_ATTRIBUTION_PARTNER | —                                |\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"Match keys"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[" Full matchKeys.type enum:\n","| Types                                                                             | Sent as                                                         |\n","\\| --------------------------------------------------------------------------------- \\| --------------------------------------------------------------- \\|\n","| EMAIL, PHONE, FIRST_NAME, LAST_NAME, ADDRESS, CITY, STATE, POSTAL | SHA-256, lowercase hex, UTF-8, no salt and no pepper        |\n","| MAID, RAMP_ID, MATCH_ID, REAL_ID, MERKLE_ID, KANTAR_ID                | raw, never hashed — hashing destroys the identifier         |\n","| FIP                                                                             | plaintext IPv4 or IPv6 address — a hashed value is rejected |\n","Note the underscores in RAMP_ID and MATCH_ID. The forms without them are rejected. - There is no COUNTRY match key type. countryCode is an event-level plaintext field. - Exactly one value per entry — two returns Field length 2 must be between \\[1, 1]. - Each type at most once per event — duplicates return One or more match keys types are duplicated in the event data.\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"Enums"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":3,"text":"`conversionType` — 12 values"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":3,"text":"`eventSource` — 6 values"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":3,"text":"`eventIngestionMethod`"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":3,"text":"`currencyCode` — 18 values, not all of ISO-4217"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[" CHF, HKD, KRW, ZAR and others are absent. Check the advertiser's markets against this list.\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"`consent`"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[" Exactly one of tcf, gpp, or amazonConsent. countryCode is event level only — there is no consent.countryCode, and one sent inside consent is silently discarded.\n","| Field                                 | Type       | Values                                                                          |\n","\\| ------------------------------------- \\| ---------- \\| ------------------------------------------------------------------------------- \\|\n","| consent.tcf                         | string | IAB TCF string                                                                  |\n","| consent.gpp                         | string | IAB GPP string                                                                  |\n","| consent.amazonConsent.amznUserData  | enum       | required — GRANTED, DENIED                                              |\n","| consent.amazonConsent.amznAdStorage | enum       | GRANTED, DENIED, or JSON null; omittable. The string \"NULL\" is rejected |\n","| consent.geo                         | object     | requires ipAddress                                                            |\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"`customData`"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":["| Field      | Type       | Notes                                                |\n","\\| ---------- \\| ---------- \\| ---------------------------------------------------- \\|\n","| name     | string     | letters, numbers, underscore; 10 attributes or fewer |\n","| dataType | enum       | STRING, INTEGER, TIMESTAMP                     |\n","| value    | string | always a JSON string, including for INTEGER        |\n"," All custom attributes reach AMC. Only brand, productId, and category also reach Amazon DSP reporting.\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"Response shape"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[" Every field you did not send is echoed as null. A null means \"you did not send this\" — not rejected, and not defaulted: unitsSold echoes as null while 1 is applied downstream.\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"Limits"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":["\\|                         \\|                                            \\|\n","\\| ----------------------- \\| ------------------------------------------ \\|\n","| Events per request      | 1 to 500. 501 is rejected at request level |\n","| Advertisers per request | one — the header carries the ID            |\n","| eventTime window      | 21 days                                    |\n","| eventId length        | 256 characters                             |\n","| customData attributes | 10                                         |\n","| value range           | 0.0 to 9999999999999.99                |\n","| unitsSold range       | 1 to 9999999999999                         |\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"Uniqueness tuple"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[" Dataset names are immutable once set. Omitting dataSetName assigns definitions to Default_Events.\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"Verifiable versus not"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[" Verifiable: a 207, per-event acceptance, your own hash digests, a conversion definition appearing in Events Manager, and whether a field survived into the echo.\n"," Not verifiable on a test account: match rate, attributed revenue, reported conversions. A test account serves no ads and has no traffic to attribute against.\n"],"documentType":"guide"},{"title":"Events API Quick Reference","sectionHeader":{"type":2,"text":"Migrating from CAPI v1"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/08-api-reference","content":[" If you are moving an existing CAPI v1 (DSP Conversion Builder) integration onto this API, existing v1 integrations already have a default dataset name assigned.\n"," When you cut over, run both feeds in parallel through an overlap window and deduplicate on a shared eventId. Treat 30 days as a minimum rather than a target — confirm the advertiser's configured attribution window first, because a longer window needs a longer overlap. The asymmetry favours caution: overlapping too long costs some duplicated reporting, while overlapping too briefly costs attribution you cannot recover.\n"," To land v2 events on an existing definition, match the uniqueness tuple exactly — and omit dataSetName if the original did not set it, since a tuple with it is not the same tuple as one without.\n","\n"],"documentType":"guide"},{"title":"Troubleshooting and Best Practices","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/09-troubleshooting","content":[" Organised by symptom. For each one: the likely causes in the order worth checking, and the check that tells them apart. Every check here is runnable by you, with your own credentials and your own data.\n"],"documentType":"guide"},{"title":"Troubleshooting and Best Practices","sectionHeader":{"type":2,"text":"Symptom: 401 or 403 on every request"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/09-troubleshooting","content":[" Likely causes, in order:\n","Legacy headers. Amazon-Advertising-API-ClientId and -Scope work on most Amazon Ads endpoints and fail here. This endpoint wants Amazon-Ads-ClientId and Amazon-Ads-AccountId. 2. profileId in Amazon-Ads-AccountId. A Sponsored Ads identifier. The header wants the DSP Advertiser ID. 3. Manager account ID in the header instead of the advertiser ID. 4. Missing permission. Event Manager = Edit, granted at the advertiser level, not the manager account level. 5. Account not eligible. The Events API is DSP-scoped. A Sponsored Ads-only account is not supported as of September 2026, and no configuration changes that.\n"," The check: resolve the ID from the API rather than trusting configuration.\n"," If this returns nothing with dspAdvertiserId, the credentials reach no DSP account and the problem is eligibility or access, not code.\n"],"documentType":"guide"},{"title":"Troubleshooting and Best Practices","sectionHeader":{"type":2,"text":"Symptom: HTTP 400 with an empty `error[]`"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/09-troubleshooting","content":[" A request-level failure. No fieldLocation, no per-event entry, the whole batch rejected and nothing naming the cause.\n"," Likely causes, in order:\n","tcf or gpp sent as an object rather than a plain string. The most common cause, and it looks nothing like a validation rejection — it gets misdiagnosed as auth or transport. 2. A raw number as a customData value. Returns {\"Message\": \"NUMBER_VALUE can not be converted to a String\"}. 3. More than 500 events in one request. 4. Malformed JSON, or a Content-Type that is not application/json.\n"," The check: bisect. Send the first event of the batch alone. If it succeeds, halve the batch and repeat. A request-level 400 is almost always one malformed field, and bisection finds it faster than reading the payload.\n"],"documentType":"guide"},{"title":"Troubleshooting and Best Practices","sectionHeader":{"type":2,"text":"Symptom: events accepted but nothing appears downstream"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/09-troubleshooting","content":[" Clean 207s, events in success\\[], no rejections, and no evidence anything happened.\n"," Likely causes, in order:\n","Terms not accepted. The advertiser must accept the Events API terms themselves. Events sent before acceptance are not processed and the response is identical to a healthy one. This is the most common cause and there is no response field for it. 2. The conversion definition is not attached to an order. Auto-creating a definition does not attach it to a campaign. An unattached definition reports zero conversions while every send succeeds. 3. Not enough time. Allow up to ~2 hours for a definition and its conversions to appear. 4. A test account. No ads served, no traffic to attribute against. Zero is the expected result.\n"," The check: confirm terms acceptance with the advertiser directly, then look for the definition in Events Manager → Conversions. If the definition exists and conversions are zero, the cause is attachment, not ingestion.\n"," A connector should hold sends until acceptance is confirmed — a per-advertiser flag in your own configuration — rather than sending and hoping.\n"],"documentType":"guide"},{"title":"Troubleshooting and Best Practices","sectionHeader":{"type":2,"text":"Symptom: match rate lower than expected"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/09-troubleshooting","content":[" Likely causes, in order:\n","Phone missing the country code. 5550101234 and 15550101234 are different digests. The largest single silent loss. 2. MAID, RAMP_ID, MATCH_ID or FIP being hashed. All are sent as-is. FIP is a plaintext IP address. Hashing an opaque identifier destroys it, and the API accepts the result as well-formed. 3. RAMPID or MATCHID without the underscore. Rejected outright, so those keys never arrive at all. 4. State not mapped to the two-letter abbreviation. New York must become ny. 5. Missing transliteration. ß→ss, ü→ue, and the rest. Non-ASCII names hash differently without it. 6. Uppercase hex, or a salt added by a crypto wrapper. Valid-looking digests that match nothing. 7. Coverage, not normalization. Only one weak match key per event.\n"," The check: run the seven vectors from page 02. They are the only cheap, complete test, and a mismatch localises the fault to a specific field.\n"],"documentType":"guide"},{"title":"Troubleshooting and Best Practices","sectionHeader":{"type":2,"text":"Symptom: duplicate conversion definitions"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/09-troubleshooting","content":[" Likely causes, in order:\n","A variable name. A timestamp, environment, hostname, or build number in name forks a definition on every change. 2. dataSetName added or removed after the first send. It is part of the uniqueness key, so a tuple with it is not the tuple without it. Dataset names are also immutable once set. 3. eventSource varying for the same logical conversion — web and app under one name land in separate definitions. 4. conversionType reclassified after go-live.\n"," The check: print the distinct tuples your own code produced over a run. The definitions in Events Manager mirror this set.\n"," More than one tuple where you expected one is the answer. Pin the tuple as a module-level constant.\n"],"documentType":"guide"},{"title":"Troubleshooting and Best Practices","sectionHeader":{"type":2,"text":"Symptom: UK or EEA events dropped"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/09-troubleshooting","content":[" Likely causes, in order:\n","An unrecognised key inside consent — a misspelled amazonConsent, a capitalised TCF, or a format name that does not exist. Returns 207 with an empty error\\[] and all four consent keys echoed as null. Consent was never recorded and nothing says so. For a privacy control this is the worst direction to fail in, which is why it is first. 2. tcf or gpp sent as an object instead of a plain string. Request-level HTTP 400 with an empty error\\[], whole batch failed. 3. No consent object at all on events carrying UK or EEA personal data. 4. countryCode missing — a rejection in its own right, and one that names itself via fieldLocation. 5. The string \"NULL\" for amznAdStorage. Rejected per event; use JSON null or omit the field. 6. Both TCF and ACS sent. Both are accepted and both echo back populated, and the resolution order is undocumented — so you cannot determine which was applied. 7. Consent never captured at the source, so there is nothing to relay.\n"," The check: the outgoing payload is not enough. Check it, then assert on the response echo.\n"," Reading the result:\n","check_echo returns False on a 207 — cause 1. Compare your key spelling against tcf, gpp, amazonConsent exactly. - HTTP 400 with an empty error\\[] — cause 2. Check whether tcf or gpp is an object. - check_outgoing prints more than one format — cause 6. Make two structurally impossible rather than fixing the data. - check_outgoing prints an empty list while events are still sending — cause 7, fixed upstream. A platform cannot manufacture consent.\n"],"documentType":"guide"},{"title":"Troubleshooting and Best Practices","sectionHeader":{"type":2,"text":"Symptom: conversion counts wrong"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/09-troubleshooting","content":[" Too many:\n","eventId minted at send time. Every retry becomes a new conversion. 2. Ad Tag and Events API both sending the same conversion with no shared deduplication key. Deduplication is not automatic across sources. 3. A per-event rejection retried into a loop that eventually succeeds more than once.\n"," Too few:\n","Rejections not being read. A 207 can carry error\\[] entries. Parse the body every time. 2. A duplicate eventId across genuinely different conversions, so first-wins drops the later ones. 3. eventTime beyond 21 days.\n"," The check: count what you sent, what came back in success\\[], and what came back in error\\[]. They should reconcile exactly. If they do, the discrepancy is downstream — deduplication or attribution, not ingestion.\n"],"documentType":"guide"},{"title":"Troubleshooting and Best Practices","sectionHeader":{"type":2,"text":"Best practices"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/09-troubleshooting","content":[" Send events as they occur rather than accumulating a nightly batch. Fresher events attribute better.\n"," Parse the response body on every send. Log accepted and rejected counts, and alarm on a rejection rate above zero. A drift from zero to two percent is invisible without a metric.\n"," Dead-letter validation rejections. Never retry them. They will fail identically. Retry only connection errors, 5xx, and 429, with exponential backoff.\n"," Always set a request timeout. A request without one can hang indefinitely.\n"," Pin the uniqueness tuple as a constant, never composed at call time.\n"," Derive eventId from source data so it is stable across retries.\n"," Hold sends until terms acceptance is confirmed, per advertiser.\n"," Assert on the echo for any field you cannot afford to have silently dropped.\n"],"documentType":"guide"},{"title":"Troubleshooting and Best Practices","sectionHeader":{"type":2,"text":"Pre-flight checklist"},"path":"/en-us/knowledge-hub/hands-on-workshops/events-api-workshop/09-troubleshooting","content":["All seven normalization vectors reproduce exactly. -   MAID, RAMP_ID, MATCH_ID sent raw; FIP sent as a plaintext IP address. -   countryCode present, alpha-2, plaintext, on every event. -   eventTime in ISO 8601 UTC, within 21 days, from the conversion's own timestamp. -   eventId present, stable across retries, derived from source data, ≤ 256 characters. -   The eventDescription tuple pinned as a constant — nothing variable in name. -   dataSetName decided before the first send, then left alone. -   value a number, ≥ 0.0, ≤ 2 decimal places. -   currencyCode one of the 18 supported codes, explicit for multi-currency advertisers. -   unitsSold set where units matter — omitting applies 1. -   Money fields only treated as money on OFF_AMAZON_PURCHASES. -   consent present for UK and EEA personal data, exactly one format, tcf and gpp as strings. -   Consent confirmed present in the response echo, not just in the payload. -   customData values sent as strings; names letters, numbers, underscore; 10 attributes or fewer. -   partner populated if you send on an advertiser's behalf. -   Response body parsed on every send; rejection counts logged and alarmed. -   Validation rejections routed to a dead-letter store, not a retry loop. -   Request timeouts set. -   Batch order preserved between building and sending. -   Terms acceptance confirmed per advertiser before any send. -   Conversion definition attachment assigned to a named owner.\n","\n"],"documentType":"guide"},{"title":"Multi-Agent Advertising Campaign Creation Workshop","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/overview","content":[" by Youssry Abubakr Partner Solutions Architect @ Amazon Ads, Chintan Sanghavi Lead Solutions Architect @ Amazon Ads on March 18th 2026\n"," Duration: ~3 hours\n"," Level: Intermediate\n"," Prerequisites: Python 3.12+, AWS account, basic familiarity with LLMs and APIs\n"],"documentType":"guide"},{"title":"Multi-Agent Advertising Campaign Creation Workshop","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/overview","content":[" This workshop walks you through building a production-ready multi-agent system for Amazon Advertising. An orchestration agent intelligently routes user queries to specialized sub-agents:\n"," Each agent is independently deployed to AWS Bedrock AgentCore and communicates using the A2A protocol. The orchestration agent uses an LLM to decide which sub-agent should handle each request.\n"],"documentType":"guide"},{"title":"Multi-Agent Advertising Campaign Creation Workshop","sectionHeader":{"type":2,"text":"Modules"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/overview","content":["| # | Module | Duration |\n","\\|---\\|--------\\|----------\\|\n","| 0 | Environment Setup | 15 min |\n","| 1 | Understanding the Architecture | 15 min |\n","| 2 | Building an MCP Server | 20 min |\n","| 3 | Building an A2A Agent | 25 min |\n","| 4 | Building a RAG Agent with S3 Vectors | 25 min |\n","| 5 | Building the Orchestration Agent | 25 min |\n","| 6 | Deploying Agents to AgentCore | 15–30 min |\n","| 6A | ↳ Option A: Manual Deployment | ~30 min |\n","| 6B | ↳ Option B: Automated Deployment | ~15 min |\n","| 7 | Building the RDS Agent with MCP Gateway | 20 min |\n","| 8 | Connecting the Chat Frontend | 15 min |\n","| 9 | Testing & Troubleshooting | 10 min |\n","| 10 | Cleanup | 10 min |\n"],"documentType":"guide"},{"title":"Multi-Agent Advertising Campaign Creation Workshop","sectionHeader":{"type":2,"text":"Quick Navigation"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/overview","content":[" Just want to understand the concepts? → Modules 1–5\n"," Ready to deploy? → Module 6 (pick Option A or B)\n"," Want the full end-to-end experience? → Modules 0–9 in order\n"," Short on time? → Modules 0, 1, 6B (automated deploy), 8, 9\n"],"documentType":"guide"},{"title":"Multi-Agent Advertising Campaign Creation Workshop","sectionHeader":{"type":2,"text":"Project Structure"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/overview","content":["\n"],"documentType":"guide"},{"title":"Environment Setup","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/00-environment-setup","content":[],"documentType":"guide"},{"title":"Environment Setup","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/00-environment-setup","content":[" Before building agents, you need a working Python environment, the AgentCore CLI, and valid AWS credentials with Bedrock model access.\n"],"documentType":"guide"},{"title":"Environment Setup","sectionHeader":{"type":2,"text":"Download the Workshop Code"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/00-environment-setup","content":["Download the workshop source code: amzn-ads-multi-agent-sample.zip\n","Unzip and navigate into the project directory:\n"],"documentType":"guide"},{"title":"Environment Setup","sectionHeader":{"type":2,"text":"Create a Python Virtual Environment"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/00-environment-setup","content":[],"documentType":"guide"},{"title":"Environment Setup","sectionHeader":{"type":2,"text":"Install the AgentCore CLI"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/00-environment-setup","content":[" You should see the CLI help output listing commands like create, dev, deploy, invoke, etc.\n"],"documentType":"guide"},{"title":"Environment Setup","sectionHeader":{"type":2,"text":"Verify AWS Credentials"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/00-environment-setup","content":[" This should return your AWS account ID and role ARN. If it does not, configure credentials:\n"],"documentType":"guide"},{"title":"Environment Setup","sectionHeader":{"type":2,"text":"Verify Bedrock Model Access"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/00-environment-setup","content":[" Ensure you have access to Claude models in your AWS account. You need: - anthropic.claude-3-5-haiku-20241022-v1:0 (for fast sub-agents) - us.anthropic.claude-sonnet-4-5-20250929-v1:0 (for orchestration and reasoning)\n"," Check access in the AWS Bedrock console under \"Model access\".\n","\n"],"documentType":"guide"},{"title":"Understanding the Architecture","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/01-architecture","content":[],"documentType":"guide"},{"title":"Understanding the Architecture","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/01-architecture","content":[" This module covers the key concepts, agent roles, and communication flow that make up the multi-agent advertising system.\n"],"documentType":"guide"},{"title":"Understanding the Architecture","sectionHeader":{"type":2,"text":"Key Concepts"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/01-architecture","content":[" AWS Bedrock AgentCore is a managed runtime for deploying AI agents. It handles: - Container packaging and deployment - Auto-scaling and session management - SigV4 authentication between agents - Memory (short-term and long-term) for conversation continuity\n"," A2A (Agent-to-Agent) Protocol is a JSON-RPC based protocol that allows agents to discover and communicate with each other. Each A2A agent exposes: - /.well-known/agent-card.json — describes the capabilities of the agent (skills) - POST / — the invocation endpoint for sending messages\n"," MCP (Model Context Protocol) is a protocol for exposing tools to LLMs. An MCP server provides a tools/list endpoint and a tools/call endpoint.\n"],"documentType":"guide"},{"title":"Understanding the Architecture","sectionHeader":{"type":2,"text":"Agent Roles"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/01-architecture","content":["| Agent | Role | Protocol | Key Technology |\n","\\|-------\\|------\\|----------\\|----------------\\|\n","| Custom Ads MCP Server | Wraps Advertising API as MCP tools | MCP | FastMCP |\n","| Custom Ads A2A Agent | Profile & campaign management | A2A | LangGraph + MCP client |\n","| Amazon Ads MCP Agent | Analytics & reporting | A2A | LangGraph + Remote MCP |\n","| S3 Vectors Agent | Documentation & best practices (RAG) | A2A | LangGraph + S3 Vectors |\n","| RDS Campaign Agent | Database queries | A2A | LangGraph + MCP Gateway |\n","| Orchestration Agent | Routes queries to the right sub-agent | HTTP | LangGraph + BedrockAgentCoreApp |\n"],"documentType":"guide"},{"title":"Understanding the Architecture","sectionHeader":{"type":2,"text":"Communication Flow"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/01-architecture","content":["\n"],"documentType":"guide"},{"title":"Building an MCP Server","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/02-mcp-server","content":[],"documentType":"guide"},{"title":"Building an MCP Server","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/02-mcp-server","content":[" In this module, you learn how the Custom Ads MCP Server wraps the Amazon Advertising API as MCP tools that LLMs can call.\n"],"documentType":"guide"},{"title":"Building an MCP Server","sectionHeader":{"type":2,"text":"Explore the MCP Server"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/02-mcp-server","content":[" Open custom-ads-mcp/mcp_server.py. This server uses the FastMCP library to expose API endpoints as tools.\n"," Key patterns: - FastMCP initialization with AgentCore-compatible settings: - Tool definition using the @mcp.tool() decorator: - Credential loading from SSM Parameter Store (production) with env var fallback (local dev)\n"],"documentType":"guide"},{"title":"Building an MCP Server","sectionHeader":{"type":2,"text":"Key Design Decisions"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/02-mcp-server","content":["Stateless HTTP transport — Required by AgentCore. Each request is independent. 2. SSM-first credential loading — Secrets are stored in AWS SSM Parameter Store, not in code. 3. Typed parameters — Each tool has typed, documented parameters that the LLM can understand.\n"],"documentType":"guide"},{"title":"Building an MCP Server","sectionHeader":{"type":2,"text":"Try It Locally"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/02-mcp-server","content":[" The server starts on http&#x3A;//0.0.0.0:8000/mcp. You can test it with:\n"],"documentType":"guide"},{"title":"Building an MCP Server","sectionHeader":{"type":2,"text":"Exercise: Add a New Tool"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/02-mcp-server","content":[" Try adding a get_campaign_status tool that returns the status of a specific campaign:\n","\n"],"documentType":"guide"},{"title":"Building an A2A Agent","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/03-a2a-agent","content":[],"documentType":"guide"},{"title":"Building an A2A Agent","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/03-a2a-agent","content":[" In this module, you learn how the Custom Ads A2A Agent connects to the MCP Server and exposes itself as an A2A agent that the orchestrator can discover and invoke.\n"],"documentType":"guide"},{"title":"Building an A2A Agent","sectionHeader":{"type":2,"text":"Explore the Agent"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/03-a2a-agent","content":[" Open custom-ads-a2a-agent/langgraph_a2a.py. This agent:\n","Connects to the MCP Server via SigV4-signed HTTP calls 2. Converts MCP tools to LangChain tools dynamically 3. Uses the LangGraph create_agent function to build a ReAct agent 4. Exposes an A2A interface via FastAPI\n"],"documentType":"guide"},{"title":"Building an A2A Agent","sectionHeader":{"type":2,"text":"Key Patterns"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/03-a2a-agent","content":[" MCP-to-LangChain Tool Conversion:\n"," Lazy Initialization:\n"," A2A Endpoint:\n"],"documentType":"guide"},{"title":"Building an A2A Agent","sectionHeader":{"type":2,"text":"System Prompt Design"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/03-a2a-agent","content":[" The system prompt is critical for agent behavior. Notice how it: - Defines a clear scope (profiles and campaigns only) - Sets strict rules (one tool call per request) - Lists forbidden actions (no analytics, no knowledge queries) - Provides delegation instructions (which agent handles what)\n"],"documentType":"guide"},{"title":"Building an A2A Agent","sectionHeader":{"type":2,"text":"Agent Card"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/03-a2a-agent","content":[" Every A2A agent exposes an agent card at /.well-known/agent-card.json:\n"," The orchestration agent fetches these cards to discover what each sub-agent can do.\n","\n"],"documentType":"guide"},{"title":"Building a RAG Agent with S3 Vectors","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/04-rag-s3-vectors","content":[],"documentType":"guide"},{"title":"Building a RAG Agent with S3 Vectors","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/04-rag-s3-vectors","content":[" This module covers how the S3 Vectors Agent uses Amazon S3 Vectors for semantic search over a knowledge base, providing documentation and best practices to users.\n"],"documentType":"guide"},{"title":"Building a RAG Agent with S3 Vectors","sectionHeader":{"type":2,"text":"Explore the S3 Vectors Agent"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/04-rag-s3-vectors","content":[" Open s3-vectors-a2a-agent/langgraph_a2a.py. This agent uses Amazon S3 Vectors for semantic search over a knowledge base.\n"],"documentType":"guide"},{"title":"Building a RAG Agent with S3 Vectors","sectionHeader":{"type":2,"text":"How S3 Vectors Works"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/04-rag-s3-vectors","content":["Documents are embedded using Amazon Titan Embed v2 and stored in an S3 Vectors index 2. Queries are embedded at runtime and matched against stored vectors 3. Top-K results are returned with metadata (category, topic, text)\n"],"documentType":"guide"},{"title":"Building a RAG Agent with S3 Vectors","sectionHeader":{"type":2,"text":"Performance Optimizations"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/04-rag-s3-vectors","content":["TTLCache for embeddings — Repeated queries don't regenerate embeddings - aioboto3 — Async AWS SDK calls for non-blocking I/O - Category filtering — Metadata filters narrow search scope\n"],"documentType":"guide"},{"title":"Building a RAG Agent with S3 Vectors","sectionHeader":{"type":2,"text":"Exercise: Upload Knowledge"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/04-rag-s3-vectors","content":[" To populate the knowledge base, use a script like the following:\n","\n"],"documentType":"guide"},{"title":"Building the Orchestration Agent","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/05-orchestration-agent","content":[],"documentType":"guide"},{"title":"Building the Orchestration Agent","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/05-orchestration-agent","content":[" The orchestration agent is the brain of the system. It fetches agent cards from all sub-agents, creates LangChain tools from their skills, and uses an LLM to route each user query to the right agent.\n"],"documentType":"guide"},{"title":"Building the Orchestration Agent","sectionHeader":{"type":2,"text":"Explore the Orchestration Agent"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/05-orchestration-agent","content":[" Open orchestration-a2a-agent/orchestration_a2a.py.\n"],"documentType":"guide"},{"title":"Building the Orchestration Agent","sectionHeader":{"type":2,"text":"How Routing Works"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/05-orchestration-agent","content":["Fetch agent cards from all sub-agents (in parallel using ThreadPoolExecutor) 2. Create LangChain tools from the skills of each agent 3. LLM decides which tool (agent) to call based on the query of the user 4. Call the selected agent via SigV4-signed A2A request 5. Return the response verbatim (no post-processing)\n"],"documentType":"guide"},{"title":"Building the Orchestration Agent","sectionHeader":{"type":2,"text":"Key Differences from Sub-Agents"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/05-orchestration-agent","content":["| Feature | Sub-Agent | Orchestration Agent |\n","\\|---------\\|-----------\\|---------------------\\|\n","| Protocol | A2A (FastAPI) | HTTP (BedrockAgentCoreApp) |\n","| Tools | MCP tools | Other agents as tools |\n","| Memory | Optional | AgentCore Memory (STM) |\n","| LLM | Haiku (fast) | Sonnet (better reasoning) |\n","| return_direct | No | Yes (bypass LLM summary) |\n"],"documentType":"guide"},{"title":"Building the Orchestration Agent","sectionHeader":{"type":2,"text":"BedrockAgentCoreApp Pattern"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/05-orchestration-agent","content":[" The orchestration agent uses the AgentCore SDK runtime:\n"],"documentType":"guide"},{"title":"Building the Orchestration Agent","sectionHeader":{"type":2,"text":"Memory Integration"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/05-orchestration-agent","content":[" The orchestration agent uses AgentCore Memory for conversation continuity:\n"],"documentType":"guide"},{"title":"Building the Orchestration Agent","sectionHeader":{"type":2,"text":"Exercise: Add a Routing Rule"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/05-orchestration-agent","content":[" Try modifying the system prompt to add a new routing rule. For example, if the user asks about \"competitors\", route to the S3 Vectors Agent:\n","\n"],"documentType":"guide"},{"title":"Deploying Agents to AgentCore","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06-deployment","content":[],"documentType":"guide"},{"title":"Deploying Agents to AgentCore","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06-deployment","content":[" This module offers two deployment approaches. Pick the one that matches your goal and skip the other.\n","| Path | Best For | Time | What You Learn |\n","\\|------\\|----------\\|------\\|-------------------\\|\n","| Option A: Manual | Understanding each deployment step in detail | ~30 min | agentcore configure, agentcore deploy, IAM policies, SSM parameters |\n","| Option B: Automated | Getting everything running quickly with one command | ~15 min | The deployment tool CLI, YAML config, state management |\n"," Pick one option and follow that file. Skip the other. Both paths end at the same place — all agents deployed and ready to test. You can always come back and try the other path later.\n"],"documentType":"guide"},{"title":"Deploying Agents to AgentCore","sectionHeader":{"type":2,"text":"What Gets Deployed"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06-deployment","content":[" Regardless of which path you choose, the end result is the same:\n"," Plus: - IAM execution roles with cross-agent invoke permissions - SSM parameters for agent discovery and credentials - AgentCore Memory resources for conversation continuity\n"],"documentType":"guide"},{"title":"Deploying Agents to AgentCore","sectionHeader":{"type":2,"text":"Ready? Pick Your Path"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06-deployment","content":["\n"],"documentType":"guide"},{"title":"Manual Deployment (Agent-by-Agent)","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06a-deployment-manual","content":[],"documentType":"guide"},{"title":"Manual Deployment (Agent-by-Agent)","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06a-deployment-manual","content":[" For each agent, the deployment process is:\n"],"documentType":"guide"},{"title":"Manual Deployment (Agent-by-Agent)","sectionHeader":{"type":2,"text":"Deploy the MCP Server"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06a-deployment-manual","content":[],"documentType":"guide"},{"title":"Manual Deployment (Agent-by-Agent)","sectionHeader":{"type":2,"text":"Deploy a Sub-Agent"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06a-deployment-manual","content":[" Repeat for mcp-ads-a2a-agent and s3-vectors-a2a-agent (see the main README for exact commands per agent).\n"],"documentType":"guide"},{"title":"Manual Deployment (Agent-by-Agent)","sectionHeader":{"type":2,"text":"Deploy Order"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06a-deployment-manual","content":[" Deploy in this order (each step depends on the previous):\n","Custom Ads MCP Server — The MCP server must be running before the A2A agent 2. Custom Ads A2A Agent — Needs the MCP server ARN 3. Amazon Ads MCP Agent — Independent, can deploy in parallel with #2 4. S3 Vectors Agent — Independent, can deploy in parallel 5. RDS Campaign Agent — Needs infrastructure (CDK) deployed first 6. Orchestration Agent — Needs all sub-agent ARNs\n"],"documentType":"guide"},{"title":"Manual Deployment (Agent-by-Agent)","sectionHeader":{"type":2,"text":"Cross-Agent IAM Policies"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06a-deployment-manual","content":[" After deploying all agents, the execution role of each agent needs permission to invoke other agents.\n"," Replace &lt;REGION>, &lt;ACCOUNT_ID>, and each agent ID placeholder with the values returned by agentcore status --verbose (or read from SSM):\n"," Attach this policy to the execution role of each agent using the AWS CLI:\n"],"documentType":"guide"},{"title":"Manual Deployment (Agent-by-Agent)","sectionHeader":{"type":2,"text":"Store ARNs in SSM"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06a-deployment-manual","content":[" After deployment, store agent ARNs in SSM Parameter Store so agents can discover each other:\n"," Repeat for each agent. The orchestration agent reads these SSM parameters at startup to discover sub-agents.\n","\n"],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[" The deployment tool (deployment_tool/) automates the entire deployment lifecycle:\n"," It handles: - SSM Parameter Store setup (prompts for secrets on first run, skips if already set) - Agent deployment in dependency order - Dynamic IAM policy generation with actual resource ARNs - Cross-agent communication policies (InvokeRuntime, memory access) - S3 vector bucket creation and policy attachment - Frontend .env.local configuration - State tracking for safe re-runs\n"],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":{"type":2,"text":"Setup"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":{"type":2,"text":"Configure"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[" Create your deployment configuration from the template:\n"," Edit deployment.yaml and update these fields:\n"," The template comes pre-configured with all 5 agents, their deployment order, IAM policies, and SSM parameters. Review the full file to understand what each section does.\n"," Key sections in the config:\n","| Section | Purpose |\n","\\|---------\\|---------\\|\n","| agents | Agent definitions (directory, entrypoint, protocol, memory mode) |\n","| deployment_order | Order agents are deployed (sub-agents before orchestration) |\n","| iam_policies | Base policy, cross-agent policy, S3 vector policy |\n","| ssm_parameters | OAuth credentials, S3 config, tool filters |\n","| frontend_config | Next.js frontend environment setup |\n","| deployment_options | Verbose logging, retry settings, failure handling |\n"],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":{"type":2,"text":"Validate"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[" Always validate before deploying:\n"," Expected output:\n"],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":{"type":2,"text":"Deploy"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[" The tool walks through these steps automatically:\n"," On first run, the tool prompts for SSM secrets (OAuth tokens, client IDs). These are stored encrypted in SSM and skipped on subsequent runs.\n"," Expect 10–20 minutes for a full deployment depending on container build times.\n"],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":{"type":2,"text":"Deploy Specific Agents"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[" To redeploy only certain agents (for example, after a code change):\n"],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":{"type":2,"text":"Check Status"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[" Shows all deployed agents with their ARNs, execution roles, and deployment timestamps.\n"],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":{"type":2,"text":"Cleanup"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[" When you are done with the workshop:\n"],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":{"type":2,"text":"How the Tool Handles IAM"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[" The deployment tool applies three layers of IAM policies:\n","Base policy (bedrock-agentcore-base-policy.json) — Bedrock model access, CloudWatch logs, ECR pull 2. Cross-agent policy — InvokeRuntime, ListAgentRuntimes, memory access, SSM parameter reads 3. S3 vector policy (s3-vector-policy.json) — Only attached to the s3-vectors agent role\n"," Policies use actual resource ARNs (not wildcards) for least-privilege access.\n"],"documentType":"guide"},{"title":"Automated Deployment (Deployment Tool)","sectionHeader":{"type":2,"text":"State Management"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/06b-deployment-automated","content":[" The tool tracks deployment state in .deployment_state.json. This enables: - Idempotent re-runs (does not re-deploy unchanged agents) - Partial deployments (deploy only what failed) - Clean rollbacks\n"," If state gets corrupted, delete the file and redeploy:\n","\n"],"documentType":"guide"},{"title":"Building the RDS Agent with MCP Gateway","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/07-rds-mcp-gateway","content":[],"documentType":"guide"},{"title":"Building the RDS Agent with MCP Gateway","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/07-rds-mcp-gateway","content":[" This module demonstrates a more complex pattern where an agent queries a PostgreSQL database through an MCP Gateway secured with Cognito OAuth and deployed inside a VPC.\n"],"documentType":"guide"},{"title":"Building the RDS Agent with MCP Gateway","sectionHeader":{"type":2,"text":"Architecture"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/07-rds-mcp-gateway","content":[],"documentType":"guide"},{"title":"Building the RDS Agent with MCP Gateway","sectionHeader":{"type":2,"text":"Deploy Infrastructure with CDK"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/07-rds-mcp-gateway","content":[" This creates: - RDS PostgreSQL instance in a VPC - EC2 bastion instance for port forwarding - SSM parameters for connection details - Security groups\n"],"documentType":"guide"},{"title":"Building the RDS Agent with MCP Gateway","sectionHeader":{"type":2,"text":"Set Up the Database"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/07-rds-mcp-gateway","content":[],"documentType":"guide"},{"title":"Building the RDS Agent with MCP Gateway","sectionHeader":{"type":2,"text":"MCP Gateway Pattern"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/07-rds-mcp-gateway","content":[" The MCP Gateway provides: - Cognito OAuth authentication — Secure access to the MCP server - VPC connectivity — The MCP server runs inside the VPC alongside RDS - Tool discovery — Standard MCP tools/list and tools/call endpoints\n"," The agent authenticates with Cognito, then calls the gateway:\n","\n"],"documentType":"guide"},{"title":"Connecting the Chat Frontend","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/08-chat-frontend","content":[],"documentType":"guide"},{"title":"Connecting the Chat Frontend","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/08-chat-frontend","content":[" The ads-chat-nextjs/ directory contains a Next.js chat application that connects to the orchestration agent. This module covers configuration, running locally, and testing the full end-to-end flow.\n"],"documentType":"guide"},{"title":"Connecting the Chat Frontend","sectionHeader":{"type":2,"text":"Explore the Frontend"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/08-chat-frontend","content":[" The frontend includes: - Conversation sidebar with history - Real-time chat interface - Dark/light theme support - Local storage persistence\n"],"documentType":"guide"},{"title":"Connecting the Chat Frontend","sectionHeader":{"type":2,"text":"Configure the Frontend"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/08-chat-frontend","content":[" Update ads-chat-nextjs/.env.local with the orchestration agent ARN:\n"],"documentType":"guide"},{"title":"Connecting the Chat Frontend","sectionHeader":{"type":2,"text":"Run Locally"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/08-chat-frontend","content":[" Open http&#x3A;//localhost:3000 and try these queries:\n","| Query | Expected Agent |\n","\\|-------\\|---------------\\|\n","| \"List my advertising profiles\" | Custom Ads Agent |\n","| \"Show campaign performance last week\" | Amazon Ads MCP Agent |\n","| \"How do I optimize my budget?\" | S3 Vectors Agent |\n","| \"Show all campaigns in the database\" | RDS Campaign Agent |\n"],"documentType":"guide"},{"title":"Connecting the Chat Frontend","sectionHeader":{"type":2,"text":"How the Frontend Calls the Agent"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/08-chat-frontend","content":[" The frontend submits messages to a Next.js API route, which calls the orchestration agent:\n","\n"],"documentType":"guide"},{"title":"Testing and Troubleshooting","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/09-testing","content":[],"documentType":"guide"},{"title":"Testing and Troubleshooting","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/09-testing","content":[" This module covers how to test individual agents, the orchestration layer, and the full end-to-end system. It also includes common issues and how to resolve them.\n"],"documentType":"guide"},{"title":"Testing and Troubleshooting","sectionHeader":{"type":2,"text":"Test Individual Agents"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/09-testing","content":[],"documentType":"guide"},{"title":"Testing and Troubleshooting","sectionHeader":{"type":2,"text":"Test the Orchestration Agent"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/09-testing","content":[],"documentType":"guide"},{"title":"Testing and Troubleshooting","sectionHeader":{"type":2,"text":"Check Logs"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/09-testing","content":[],"documentType":"guide"},{"title":"Testing and Troubleshooting","sectionHeader":{"type":2,"text":"Common Issues"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/09-testing","content":["| Issue | Cause | Fix |\n","\\|-------\\|-------\\|-----\\|\n","| \"Connection refused\" on invoke | Dev server not running | Run agentcore dev first |\n","| \"Access Denied\" on agent call | Missing IAM policy | Add InvokeRuntime permission |\n","| \"MCP call failed: 401\" | Expired OAuth token | Restart the agent to re-fetch a token, or implement token refresh logic in call_tool |\n","| Agent returns wrong sub-agent | System prompt routing issue | Refine routing rules in system prompt |\n","| \"No agent cards fetched\" | Sub-agents not deployed | Deploy sub-agents before orchestration |\n"],"documentType":"guide"},{"title":"Testing and Troubleshooting","sectionHeader":{"type":2,"text":"Local Development Loop"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/09-testing","content":[" For rapid iteration:\n"],"documentType":"guide"},{"title":"Testing and Troubleshooting","sectionHeader":{"type":2,"text":"Summary"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/09-testing","content":[" In this workshop you explored:\n","MCP Servers — Wrapping APIs as LLM-callable tools using FastMCP 2. A2A Agents — Building agents that communicate via the A2A protocol 3. RAG with S3 Vectors — Semantic search over a knowledge base 4. Agent Orchestration — Routing queries to specialized agents using LLM reasoning 5. MCP Gateway — Secure access to VPC-attached MCP servers via Cognito 6. AgentCore Deployment — Packaging and deploying agents as containers 7. Chat Frontend — Connecting a Next.js UI to the agent system\n"," The multi-agent pattern lets you scale by adding new specialized agents without modifying the orchestration logic — just deploy a new agent and the orchestrator discovers it via its agent card.\n"],"documentType":"guide"},{"title":"Testing and Troubleshooting","sectionHeader":{"type":2,"text":"Next Steps"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/09-testing","content":["Add a new specialized agent (for example, a \"Budget Optimizer\" agent) - Implement long-term memory (LTM) for cross-session context - Add AgentCore Observability for tracing agent interactions - Set up CI/CD with the automated deployment tool - Explore AgentCore Policy Engine for guardrails\n"],"documentType":"guide"},{"title":"Testing and Troubleshooting","sectionHeader":{"type":2,"text":"Resources"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/09-testing","content":["AWS Bedrock AgentCore Documentation - A2A Protocol Specification - MCP Protocol Specification - LangGraph Documentation - S3 Vectors Documentation\n","\n"],"documentType":"guide"},{"title":"Cleanup","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/10-cleanup","content":[],"documentType":"guide"},{"title":"Cleanup","sectionHeader":{"type":2,"text":"Introduction"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/10-cleanup","content":[" Resources should be deleted in reverse deployment order to avoid dependency issues:\n"],"documentType":"guide"},{"title":"Cleanup","sectionHeader":{"type":2,"text":"Option A: Automated Cleanup (if you used the Deployment Tool)"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/10-cleanup","content":[" If you deployed with the deployment tool (Module 6B), cleanup is a single command:\n"," Then continue to Destroy RDS Infrastructure for RDS cleanup and Clean Up SSM Parameters for SSM cleanup.\n"],"documentType":"guide"},{"title":"Cleanup","sectionHeader":{"type":2,"text":"Option B: Manual Cleanup (if you deployed agent-by-agent)"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/10-cleanup","content":[" Destroy each agent from its directory using agentcore destroy:\n"," For each agent, agentcore destroy removes: - The AgentCore runtime - The ECR repository - The CodeBuild project - The associated memory resource\n"],"documentType":"guide"},{"title":"Cleanup","sectionHeader":{"type":2,"text":"Destroy RDS Infrastructure"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/10-cleanup","content":[" If you deployed the RDS Campaign Agent (Module 7), tear down the CDK stack:\n"," This removes: - RDS PostgreSQL instance - VPC and security groups - EC2 bastion instance - Cognito user pool - MCP Gateway resources\n"],"documentType":"guide"},{"title":"Cleanup","sectionHeader":{"type":2,"text":"Clean Up IAM Roles and Policies"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/10-cleanup","content":[" If you manually attached IAM policies (Module 6A), remove them:\n"],"documentType":"guide"},{"title":"Cleanup","sectionHeader":{"type":2,"text":"Clean Up SSM Parameters"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/10-cleanup","content":[" Remove the SSM parameters created during deployment:\n"],"documentType":"guide"},{"title":"Cleanup","sectionHeader":{"type":2,"text":"Delete S3 Vector Bucket"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/10-cleanup","content":[" If you created an S3 Vectors bucket (Module 4):\n"],"documentType":"guide"},{"title":"Cleanup","sectionHeader":{"type":2,"text":"Clean Up Local Environment"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/10-cleanup","content":[],"documentType":"guide"},{"title":"Cleanup","sectionHeader":{"type":2,"text":"Verification Checklist"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/10-cleanup","content":[" Run these commands to confirm everything is cleaned up:\n"," If any of these return results, go back and delete the remaining resources.\n","\n"],"documentType":"guide"},{"title":"Workshop Summary","sectionHeader":null,"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/11-summary","content":[],"documentType":"guide"},{"title":"Workshop Summary","sectionHeader":{"type":2,"text":"What You Built"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/11-summary","content":[" Over the course of this workshop, you built a production-ready multi-agent advertising system on AWS Bedrock AgentCore:\n"],"documentType":"guide"},{"title":"Workshop Summary","sectionHeader":{"type":2,"text":"Key Takeaways"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/11-summary","content":["MCP Servers wrap existing APIs as LLM-callable tools using FastMCP. Stateless HTTP transport and typed parameters make them compatible with AgentCore and easy for LLMs to understand.\n","A2A Agents communicate via the Agent-to-Agent protocol. Each agent publishes an agent card describing its skills, enabling dynamic discovery by the orchestrator.\n","RAG with S3 Vectors provides semantic search over a knowledge base. Embedding caching and async I/O keep latency low.\n","Agent Orchestration uses an LLM to route queries to the right sub-agent based on intent. The orchestrator fetches agent cards in parallel and creates LangChain tools from the skills of each agent.\n","MCP Gateway enables secure access to VPC-attached MCP servers through Cognito OAuth, bridging private infrastructure with the agent runtime.\n","AgentCore Deployment packages agents as containers and manages the full lifecycle — from agentcore configure through agentcore deploy to agentcore destroy.\n","The Deployment Tool automates the entire process with a single command, handling IAM policies, SSM parameters, cross-agent permissions, and state tracking.\n","The Chat Frontend connects a Next.js UI to the orchestration agent, providing a conversational interface over the entire multi-agent system.\n"],"documentType":"guide"},{"title":"Workshop Summary","sectionHeader":{"type":2,"text":"Architecture Principles"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/11-summary","content":[" The multi-agent pattern demonstrated in this workshop follows several key principles:\n","Single responsibility — Each agent handles one domain (profiles, analytics, knowledge, database) - Loose coupling — Agents discover each other via agent cards and SSM, not hardcoded references - Independent deployment — Each agent is its own container, deployable and scalable independently - Incremental growth — Add new agents without modifying the orchestrator; it discovers them automatically - Least-privilege security — IAM policies use actual resource ARNs, not wildcards\n"],"documentType":"guide"},{"title":"Workshop Summary","sectionHeader":{"type":2,"text":"Next Steps"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/11-summary","content":["Add a new agent — Create a \"Budget Optimizer\" or \"Creative Insights\" agent and watch the orchestrator discover it automatically - Long-term memory — Upgrade from STM_ONLY to STM_AND_LTM for cross-session context - Observability — Enable AgentCore Observability for distributed tracing across agent calls - CI/CD — Use the deployment tool in a pipeline for automated deployments on code changes - Policy Engine — Add AgentCore Policy Engine guardrails to control agent behavior - Agentic Marketplace — Package your agents for other advertisers to use\n"],"documentType":"guide"},{"title":"Workshop Summary","sectionHeader":{"type":2,"text":"Resources"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/11-summary","content":["AWS Bedrock AgentCore Documentation - A2A Protocol Specification - MCP Protocol Specification - LangGraph Documentation - S3 Vectors Documentation - Strands Agents SDK\n"," Thanks for completing the workshop.\n"],"documentType":"guide"},{"title":"Workshop Summary","sectionHeader":{"type":2,"text":"About the authors"},"path":"/en-us/knowledge-hub/hands-on-workshops/workshop-gen-ai-langgraph-agents/11-summary","content":["| IMAGE | |\n","\\| --- \\| --- \\|\n","| Youssry AbubakrYoussry is a partner solutions architect at Amazon Ads, designing scalable cloud architectures and Generative AI solutions that accelerate partner integrations. With deep expertise across AWS and Amazon Ads, he helps partners build agentic AI systems and streamline their advertising workflows. | Youssry Abubakr | \n","| IMAGE | |\n","\\| --- \\| --- \\|\n","| Chintan SanghaviChintan is a lead solutions architect at Amazon Ads, driving innovation with Generative AI, AWS, and Amazon Ads solutions. He has extensive experience building complex multi-technology solutions. | Chintan Sanghavi |\n","\n"],"documentType":"guide"}],"toc-no-code-tools":[{"title":"No-code tools overview","sectionHeader":null,"path":"/en-us/no-code-tools/overview","content":[" For advertisers and partners without developer resources, Amazon Ads offers a variety of advanced no-code tools that you can use to manage campaigns and view performance data.\n","| Tool | Description |\n","\\|-----\\|--------\\|\n","| Sponsored ads bulk operations | A spreadsheet-based tool that allows advertisers to manage Sponsored Products, Sponsored Brands, and Sponsored Display campaigns in bulk. |\n","| Amazon DSP bulk operations | A spreadsheet-based tool that allows advertisers to manage Amazon DSP campaigns in bulk.|\n","| Advertising console | A campaign management user interface where advertisers can manage campaigns and view performance reports for Sponsored Products, Sponsored Brands, and Sponsored Display campaigns. |\n","| Amazon DSP console | A campaign management user interface where advertisers can manage campaigns and view performance reports for Amazon DSP campaigns.|\n","| Amazon Marketing Cloud console | A cloud-based, clean room environment that allows advertisers to perform analytics and generate custom audiences. |\n","| Ads data manager | A data upload interface for advertisers to securely upload their first-party data and activate it across Amazon Ads products for measuring conversions, engaging audiences, and optimizing campaigns. |\n"],"documentType":"guide"},{"title":"Overview - About bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/overview-about-bulksheets","content":[" This article provides a high-level overview of the new bulksheets, including key improvements, FAQs, and some examples of managing campaigns using the new template. When you are ready to learn more, check out the getting started guide.\n"],"documentType":"guide"},{"title":"Overview - About bulksheets","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/no-code-tools/bulksheets/overview-about-bulksheets","content":[" Bulksheets is a spreadsheet-based tool that allows sponsored ads advertisers to create and optimize multiple campaigns in batches, reducing time and manual effort. Bulksheets can be a good option if you have already been using the advertising console, but want more robust functionality and the ability to scale without calling the API.\n"],"documentType":"guide"},{"title":"Overview - About bulksheets","sectionHeader":{"type":2,"text":"Key features"},"path":"/en-us/no-code-tools/bulksheets/overview-about-bulksheets","content":[" With bulksheets, you can\n","Update campaign names and ad group names in large batches instead of one by one  Optimize campaigns by updating thousands of keywords, product targeting, and bids at once  See performance metrics such as impressions, clicks and click-through rates, conversions, ACOS, CPC, and ROAS  Download and view search term reports for Sponsored Products   Add multiple ad groups to a single campaign from the same bulksheets file\n"],"documentType":"guide"},{"title":"Overview - About bulksheets","sectionHeader":{"type":2,"text":"Frequently asked questions"},"path":"/en-us/no-code-tools/bulksheets/overview-about-bulksheets","content":[" No. If you upload a legacy spreadsheet, you will see errors. You can check out a side-by-side comparison of the two templates here for an idea of the differences between the previous template and the latest version.\n"," Either option will work. If you create and download a custom spreadsheet the file will contain past campaign data and additional columns with read-only data and performance metrics. These additional columns will not affect the upload, so you can leave them intact if you use the downloaded custom spreadsheet. If you start with the blank template, you will see fewer columns and no pre-filled data. The examples below will give you an idea of what each scenario would look like, and you can see more details in the overview for updating campaigns. \n"," Yes, review these tips about formatting in bulksheet:  Dates: For campaign start and end dates, the format must be YYYYMMDD. December 17, 2023 would be entered as 20231217.  Percentages: Numbers intended to be percentages should be entered as whole numbers, with no symbols or decimals. A bidding adjustment of 25% would be entered as 25.  Percentages exception for Sponsored Brands: Due to the API structure of Sponsored Brands, you should use the percentage symbol to define a bid multiplier for Sponsored Brands campaigns, either a positive or negative value. For instance, a forty percent multiplier would be written as 40%. A negative sixty percent multiplier would be -60%. Learn more about creating Sponsored Brands campaigns in bulksheets.   Commas: Numbers should not include commas. For instance, when writing fifteen hundred, you would write 1500 (NOT 1,500).  Bid: For the CPC bid amount, do not use money symbols or commas. For example, to bid 75 cents, enter 0.75. To bid one dollar, enter 1. Also, there is a 2-place decimal limit. If you enter a number with more than 2 decimal places, we will automatically round to a 2-place decimal figure. For example, if you enter 0.756, we will round to 0.76. If you enter 0.754, we will round to 0.75  Portfolios: When you create a new portfolio, the first two fields (Product and Entity) require strict formatting. The “Product” field should include Portfolios (plural, with the “s”). The “Entity” field should include Portfolio (singular, without the “s”). \n"," We recommend starting with the getting started guide.\n"],"documentType":"guide"},{"title":"Overview - About bulksheets","sectionHeader":{"type":2,"text":"Example scenarios"},"path":"/en-us/no-code-tools/bulksheets/overview-about-bulksheets","content":[" Here are some examples of creating, updating, and archiving campaign entities using bulksheets. For more details on how to create and manage campaigns with bulksheets, refer to the getting started guide. \n"," Note: In the examples below, blank values in the Sites column represent the default site setting.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Portfolio ID\t|Ad ID (Read only)\t|Keyword ID (Read only)\t|Product Targeting ID (Read only)\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|Targeting Type\t|State\t|Daily Budget\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Keyword Text\t|Match Type\t|Bidding Strategy\t|Placement\t|Percentage\t|Product Targeting Expression\t|Sites   |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---    |\n","|Sponsored Products\t|Campaign\t|Update\t|2270350216\t|\t|\t|\t|\t|\t|New Campaign Name 1\t|\t|20220325\t|20221231\t|AUTO\t|enabled\t|15\t|\t|\t|\t|\t|\t|\t|Dynamic bids - up and down\t|\t|\t|\t|   |\n","|Sponsored Products\t|Ad Group\t|Update\t|2270350216\t|1764163005\t|\t|\t|\t|\t|\t|New Ad Group Name 1\t|\t|\t|\t|enabled\t|\t|\t|\t|0.5\t|\t|\t|\t|\t|\t|\t|\t|   |\n","|Sponsored Products\t|Product Ad\t|\t|2270350216\t|1764163005\t|\t|1626147106\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|B01N05APQY\t|\t|\t|\t|\t|\t|\t|\t|\t|   |\n","|Sponsored Products\t|Product Targeting\t|\t|2270350216\t|1764163005\t|\t|\t|\t|1475350320\t|\t|\t|\t|\t|\t|paused\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|close-match\t|   |\n","|Sponsored Products\t|Product Targeting\t|\t|2270350216\t|1764163005\t|\t|\t|\t|15431673257\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|loose-match\t|   |\n","|Sponsored Products\t|Ad Group\t|\t|2270350216\t|472947394\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|0.25\t|\t|\t|\t|\t|\t|\t|\t|   |\n","|Sponsored Products\t|Campaign\t|\t|193847192\t|\t|\t|\t|\t|\t|\t|\t|20220411\t|\t|Auto\t|enabled\t|10\t|\t|\t|\t|\t|\t|\t|Fixed bid\t|\t|\t|\t|   |\n","|Sponsored Products\t|Ad Group\t|\t|193847192\t|2294632947\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|0.75\t|\t|\t|\t|\t|\t|\t|\t|   |\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Portfolio ID\t|Ad ID (Read only)\t|Keyword ID (Read only)\t|Product Targeting ID (Read only)\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|Targeting Type\t|State\t|Daily Budget\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Keyword Text\t|Match Type\t|Bidding Strategy\t|Placement\t|Percentage\t|Product Targeting Expression\t|Sites    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---    |\n","|Sponsored Products\t|Campaign\t|Create\t|SP Campaign Name 2\t|\t|\t|\t|\t|\t|SP Campaign Name 2\t|\t|20220411\t|\t|Auto\t|enabled\t|10\t|\t|\t|\t|\t|\t|\t|Fixed bid\t|\t|\t|\t|    Amazon Business    |\n","|Sponsored Products\t|Ad Group\t|Create\t|SP Campaign Name 2\t|Ad Group Name 2\t|\t|\t|\t|\t|\t|Ad Group Name 2\t|\t|\t|\t|enabled\t|\t|\t|\t|0.75\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Products\t|Campaign\t|\t|2270350216\t|\t|\t|\t|\t|\t|\t|\t|20220325\t|20221231\t|AUTO\t|enabled\t|15\t|\t|\t|\t|\t|\t|\t|Dynamic bids - up and down\t|\t|\t|\t|    |\n","|Sponsored Products\t|Ad Group\t|\t|2270350216\t|1764163005\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|0.5\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Products\t|Product Ad\t|\t|2270350216\t|1764163005\t|\t|1626147106\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|B01N05APQY\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Products\t|Product Targeting\t|\t|2270350216\t|1764163005\t|\t|\t|\t|1475350320\t|\t|\t|\t|\t|\t|paused\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|close-match\t|    |\n","|Sponsored Products\t|Product Targeting\t|\t|2270350216\t|1764163005\t|\t|\t|\t|15431673257\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|loose-match\t|    |\n","|Sponsored Products\t|Ad Group\t|\t|2270350216\t|472947394\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|0.25\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Portfolio ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|Targeting Type\t|State\t|Daily Budget\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Keyword Text\t|Match Type\t|Bidding Strategy\t|Placement\t|Percentage\t|Product Targeting Expression\t|Sites    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---    |\n","|Sponsored Products\t|Campaign\t|Create\t|Spring toys 2022\t|\t|\t|\t|\t|\t|Spring toys 2022\t|\t|20220401\t|\t|Auto\t|Enabled\t|100\t|\t|\t|\t|\t|\t|\t|Fixed bid\t|\t|\t|\t|    Amazon Business    |\n","|Sponsored Products\t|Bidding adjustment\t|Create\t|Spring toys 2022\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Fixed bid\t|placementTop\t|35\t|\t|    |\n","|Sponsored Products\t|Ad group\t|Create\t|Spring toys 2022\t|Outdoors\t|\t|\t|\t|\t|\t|Outdoors\t|\t|\t|\t|Enabled\t|\t|\t|\t|0.75\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Portfolio ID\t|Ad ID (Read only)\t|Keyword ID (Read only)\t|Product Targeting ID (Read only)\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|Targeting Type\t|State\t|Daily Budget\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Keyword Text\t|Match Type\t|Bidding Strategy\t|Placement\t|Percentage\t|Product Targeting Expression\t|Sites    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---    |\n","|Sponsored Products\t|Product Ad\t|Archive\t|2270350216\t|1764163005\t|\t|1626147106\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|B01N05APQY\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Products\t|Product Targeting\t|Update\t|2270350216\t|1764163005\t|\t|\t|\t|1475350320\t|\t|\t|\t|\t|\t|paused\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|close-match\t|    |\n","|Sponsored Products\t|Product Targeting\t|\t|2270350216\t|1764163005\t|\t|\t|\t|15431673257\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|loose-match\t|    |\n","|Sponsored Products\t|Ad Group\t|\t|2270350216\t|Add New Ad Group\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|0.25\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Products\t|Campaign\t|\t|193847192\t|\t|\t|\t|\t|\t|\t|\t|20220411\t|\t|Auto\t|enabled\t|10\t|\t|\t|\t|\t|\t|\t|Fixed bid\t|\t|\t|\t|    |\n","|Sponsored Products\t|Ad Group\t|\t|193847192\t|2294632947\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|0.75\t|\t|\t|\t|\t|\t|\t|\t|    |\n"],"documentType":"guide"},{"title":"Getting started with bulksheets - Part 1","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/get-started-with-bulksheets-part1","content":[" This article gives a general overview of getting started with bulksheets for sponsored ads campaigns, including how to find the \"Bulk operations\" menu, how to create and download your first bulksheets file, and how to interpret the first three foundational columns of the spreadsheet. Then, you can select the appropriate product-specific guide based on the campaign type you want to create.\n"," To get started:\n","|TILESFor Vendors\t|For Sellers\t|\n","|---\t|---\t|\n","|1. Sign in to your Amazon Ads account\t|1. Sign in to your Amazon Ads account\t|\n","|2. Navigate to the advertising console\t|2. Navigate to Seller Central\t|\n","|3. From the left side menu panel, click Sponsored ads > Bulk operations\t|3. Under \"All campaigns,\" click Bulk operations\t|\n"," From the \"Bulk operations\" page, you can create, download, edit, and upload your spreadsheet to create or edit campaigns. You have two options for getting a bulksheets file: either create a custom spreadsheet, or download a blank template:\n","|LINESCreate & download a custom spreadsheet\t|Download a bulk operations template\t|\n","|---\t|---\t|\n","|If you have already created some campaigns (in the ads console or using API), you can create a bulksheets file that contains your past campaign data. If you are new to bulksheets, this might make it easier to see how the campaign data corresponds to spreadsheet entities and column headers.\t|This option will produce a bulksheets template that is completely blank other than the column headers. You will have one tab for each campaign type: Sponsored Products, Sponsored Brands, and Sponsored Display. You can delete all tabs except the one that relates to the campaign type you want to create.\t|\n"," The first step is to download a blank template, or create and download your custom spreadsheet.\n"," The process outlined below walks through creating and downloading a custom spreadsheet. Then, you can get started with editing and uploading a bulksheets file for Sponsored Brands, Sponsored Display, and Sponsored Products campaigns by referencing the product-specific guides linked at the bottom of this article.\n"],"documentType":"guide"},{"title":"Getting started with bulksheets - Part 1","sectionHeader":{"type":2,"text":"How to create and download a custom spreadsheet"},"path":"/en-us/no-code-tools/bulksheets/get-started-with-bulksheets-part1","content":["From the \"Bulk operations\" page, use the dropdown to select a date range. You can include data from a maximum of 60 days.  2. Use the checkboxes to customize the data you want to include:\n","Click Create spreadsheet for download.\n"," We recommend taking a few minutes to review the column headers and related data present in the sheet to get a sense of what the values and entities might look like. If you included Guidance for Sponsored Products in the download, you can click into the headers for tips, and some fields will have dropdown menus. \n"," You will have a \"Portfolios\" tab where you can see budget data and other information for any campaigns that you have grouped into a portfolio. Learn more about using portfolios with bulksheets.\n"," If you are creating a Sponsored Brands campaign and you opted to include brand assets data, your file will include a \"Brand assets data\" tab that contains entity IDs, landing page URLs, and other brand-related data. Learn more about how to understand bulksheets campaign data.\n"," After you review the data, you can delete everything in the sheet except the column headers to create a brand new campaign. When updating existing campaigns, you can keep some of the campaign data in the sheet and edit only the fields you want to change--but this guide will focus on creating a new campaign using the new bulksheets blank template. We recommend reviewing these steps to get familiar with the new functionality before you start updating existing campaigns. \n"," With the newest version of bulksheets, the first three column headers will always be Product, Entity, and Operation. Most of the spreadsheet column headers will vary depending on which type of campaign you are managing, but the first three headers will be identical regardless of campaign type. And while the data you enter will vary based on \"product\" (or campaign type), here are some examples of what you might enter in these first three columns:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Enter the campaign type:|Enter the entity type. A few examples include:|Enter the action you want the spreadsheet to perform for that row. Typically the options are:\n","|Sponsored Products\t|Campaign\t|Create\t|\n","|Sponsored Brands\t|Ad group\t|Update\t|\n","|Sponsored Display\t|Keyword\t|Archive|\n"," You can think of the \"Entity\" column as a hierarchy, with the campaign being the top-level \"parent\" entity. Under any campaign, you will have \"child\" entities such as ad groups. And under any ad group, you will have one or more product ads (or \"Products\" in the UI, in the form of an ASIN or SKU). For each ad, you will have keywords, and so on. The product-specific guides below include entity diagrams for reference. \n"," You will always need a new row for each entity, even if you are creating multiples of the same entity. For instance, to create 10 different keywords, you would need 10 different keyword rows under the \"Entity\" column. The product-specific guides go deeper on this topic. \n"," These first three columns are the foundation of any advertising campaign: Similar to campaign creation in the advertising console UI, the first step is to choose your campaign type before defining the additional campaign attributes. \n"," To continue getting started with the new bulksheets and learn more about product-specific spreadsheet details, select the campaign type you are using:\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sp/get-started","content":[" This article will walk through the steps of getting started with bulksheets for Sponsored Products. You will find guidance and tips for entering campaign data into your downloaded spreadsheet so you can upload the sheet to create campaigns using bulksheets.\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products","sectionHeader":{"type":3,"text":"Prepare to edit your bulksheets file"},"path":"/en-us/no-code-tools/bulksheets/sp/get-started","content":[" Before you start entering data into your file, here are some guidelines and tips to help you understand the functionality of the sheet. \n"," Allowable values for the first three columns\n"," Many of the bulksheets values will vary depending on your specific situation. For example, Bid amount and ASIN values might vary greatly depending on the individual user or campaign. But some columns have strict limitations on what you can enter. In particular, for the first three foundational columns for Sponsored Products, here are the allowed values:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Sponsored Products\t|Campaign\t|Create\t|\n","|\t|Ad group\t|Update\t|\n","|\t|Product ad\t|Archive\t|\n","|\t|Keyword\t|\t|\n","|\t|Negative keyword\t|\t|\n","|\t|Bidding adjustment\t|\t|\n","|\t|Campaign negative keyword\t|\t|\n","|\t|Product targeting\t|\t|\n","|\t|Negative product targeting\t|\t|\n"," TIPS:\n","You can include input guidance in your downloaded file for Sponsored Products for hints about what you should enter in each field.  You will always need a new row for each entity, even if you are creating multiples of the same entity. For instance, to create 10 different keywords, you would need 10 different keyword rows.  With Sponsored Products, you can create multiple ad groups in a single campaign.  Be sure to always include the Product (or campaign type) in Column A for every row that contains an entity you want to create.   Every entity (in Column B) will be in its own separate row. Then, you will define attributes for each entity in the other cells that span that specific row.  \\* The Operation column (Column C) must contain a value in any row where you want updates to occur. Otherwise, the row will be ignored. If you are creating a new campaign, then you would type Create in each row of the Operation column for each entity in that campaign. \n"," EXAMPLE 1: To create a Sponsored Products campaign with one ad group, one product ad, and five keywords, you would set your first three columns as:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Sponsored Products\t|Campaign\t|Create\t|\n","|Sponsored Products\t|Ad group\t|Create\t|\n","|Sponsored Products\t|Product ad\t|Create\t|\n","|Sponsored Products\t|Keyword\t|Create\t|\n","|Sponsored Products\t|Keyword\t|Create\t|\n","|Sponsored Products\t|Keyword\t|Create\t|\n","|Sponsored Products\t|Keyword\t|Create\t|\n","|Sponsored Products\t|Keyword\t|Create\t|\n"," If you wanted to add multiple ad groups to a campaign, you would add more rows setting the Entity and Operation columns accordingly.\n"," EXAMPLE 2: With bulksheets, you can create campaigns that use both keyword and product targeting by creating a new ad group for each targeting type (you cannot have both keyword and product targeting in a single ad group). In the example below, you are creating one campaign with two ad groups. The first ad group contains three keywords. The second ad group contains two product targeting entities. Using this example, you could add as many ad groups as you want in a single campaign using bulksheets:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Sponsored Products\t|Campaign\t|Create\t|\n","|Sponsored Products\t|Ad group\t|Create\t|\n","|Sponsored Products\t|Product ad\t|Create\t|\n","|Sponsored Products\t|Keyword\t|Create\t|\n","|Sponsored Products\t|Keyword\t|Create\t|\n","|Sponsored Products\t|Keyword\t|Create\t|\n","|Sponsored Products\t|Ad group\t|Create\t|\n","|Sponsored Products\t|Product ad\t|Create\t|\n","|Sponsored Products\t|Product targeting\t|Create\t|\n","|Sponsored Products\t|Product targeting\t|Create\t|\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Brands","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sb-legacy/get-started","content":[" This article will walk through the steps of getting started with bulksheets for Sponsored Brands. This article provides guidance and tips for entering campaign data into your spreadsheet so you can upload the sheet to create campaigns using bulksheets. \n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Brands","sectionHeader":{"type":3,"text":"Prepare to edit your bulksheets file"},"path":"/en-us/no-code-tools/bulksheets/sb-legacy/get-started","content":[" Before you start entering data into your file, here are some guidelines and tips to help you understand the functionality of the sheet. \n"," Allowable values for the first three columns\n"," Many of the bulksheets values will vary depending on your specific situation. For example, Budget amount and Keyword text values might vary greatly depending on the individual user or campaign. But some columns have strict limitations on what you can enter. In particular, for the first three foundational columns for Sponsored Brands, here are the allowed values:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Sponsored Brands\t|Campaign\t|Create\t|\n","|\t|Keyword\t|Update\t|\n","|\t|Negative Keyword\t|Archive\t|\n","|\t|Product targeting\t|Submit+\t|\n","|\t|Negative product targeting\t|\t|\n","|\t|Draft campaign+\t|\t|\n","|\t|Draft keyword+\t|\t|\n","|\t|Draft negative keyword+\t|\t|\n","|\t|Draft product targeting+\t|\t|\n","|\t|Draft negative product targeting+\t|\t|\n"," ADDITIONAL TIPS:\n","You will always need a new row for each entity, even if you are creating multiples of the same entity. For instance, to create 10 different keywords, you would need 10 different keyword rows under the Entity column.   Be sure to always include the Product (or campaign type) in Column A for every row that contains an entity you want to create.   Every entity (in Column B) will be in its own separate row. Then, you will define attributes for each entity in the other cells that span that specific row.  \\* The Operation column must contain a value in any row where you want updates to occur. Otherwise, the row will be ignored. If you are creating a new campaign, then you would type Create in each row of the Operation column for each entity in that campaign. \n"," EXAMPLE 1: To create a Sponsored Brands campaign with five keywords, you would set your first three columns as:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Sponsored Brands\t|Campaign\t|Create\t|\n","|Sponsored Brands\t|Keyword\t|Create\t|\n","|Sponsored Brands\t|Keyword\t|Create\t|\n","|Sponsored Brands\t|Keyword\t|Create\t|\n","|Sponsored Brands\t|Keyword\t|Create\t|\n","|Sponsored Brands\t|Keyword\t|Create\t|\n"," EXAMPLE 2: To update three Sponsored Brands keywords, set the first three columns as:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Sponsored Brands\t|Keyword\t|Update\t|\n","|Sponsored Brands\t|Keyword\t|Update\t|\n","|Sponsored Brands\t|Keyword\t|Update\t|\n"," EXAMPLE 3: To archive three Sponsored Brands keywords, set the first three columns as:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Sponsored Brands\t|Keyword\t|Archive\t|\n","|Sponsored Brands\t|Keyword\t|Archive\t|\n","|Sponsored Brands\t|Keyword\t|Archive\t|\n"," The next article walks through the complete Sponsored Brands campaign creation process, including guidelines on Sponsored Brands entities and how they factor into the steps to create a bulksheets file.\n"],"documentType":"guide"},{"title":"How to create and manage Sponsored Brands draft campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/sb-draft-campaigns","content":[" A draft campaign lets you build out a Sponsored Brands campaign's fields in bulksheets before it goes through the standard Sponsored Brands moderation review. While a campaign is a draft, none of the mandatory review fields (such as landing page, brand, and creative details) are required, so you can save partial progress and continue editing across multiple bulksheets uploads. When you are ready, you submit the draft for review, which converts it into a live campaign entity.\n"," To work with drafts, you will use the Draft campaign and Draft keyword entities (Column B), instead of the Campaign and Keyword entities used for standard Sponsored Brands campaigns. There are also Draft negative keyword, Draft product targeting, and Draft negative product targeting entities, which work the same way as their non-draft counterparts.\n"," Key points to note:\n","The Campaign Id column is used only for submitted (live) Sponsored Brands campaigns. For drafts, use the Draft Campaign Id column instead.  The Operation column supports an additional value, Submit, which applies only to the Draft campaign entity. This is the operation you use to send a draft for review.  Headers marked with an asterisk (\\*) cannot be updated after the entity is created. NOTE: Do not edit or alter the bulksheets column headers—this will cause the upload to fail.\n"],"documentType":"guide"},{"title":"How to create and manage Sponsored Brands draft campaigns with bulksheets","sectionHeader":{"type":2,"text":"Step 1. Create a draft campaign"},"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/sb-draft-campaigns","content":[" Use the guidelines below to define a new draft in the first row of your bulksheets file. Only a small subset of fields is mandatory to create the draft—you can leave the rest blank until you are ready to submit it for review.\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Draft campaign\t|\n","|Operation\t|Create\t|\n","|Campaign Id\\*\t|Leave blank for a draft\t|\n","|Draft Campaign Id\\*\t|For a new draft, type a text-based name to identify it. Enter this exact same value in each child entity you create for this draft (for example, a Draft keyword row).  NOTE: When you upload the file, this value becomes the system-generated Draft Campaign ID. Use that generated ID to update the draft later.\t|\n","|Portfolio Id\t|If you want to put the draft into a portfolio, enter the portfolio ID. Otherwise, leave blank.\t|\n","|Campaign Name\t|Enter the same value that you entered in \"Draft Campaign Id.\"\t|\n","|Start Date\\*\t|Optional while in draft. Format must be yyyyMMdd. If left blank, the start date defaults to today's date once the draft is submitted and approved.\t|\n","|End Date\t|Optional while in draft. Format must be yyyyMMdd.\t|\n","|State\t|Optional while in draft. You do not need to set this field until you are ready to submit the draft for review.\t|\n","|Budget Type\t|Enter lifetime or daily.\t|\n","|Budget\t|Do not include symbols such as dollar signs or commas. Be sure your budget does not exceed the limit for your region.\t|\n","|Bid Optimization\t|Enter auto or manual, as described in How to create Sponsored Brands campaigns.\t|\n","|Ad Format\\*\t|Enter productCollection or video. Leave blank for a default (Product Collection) draft. Video drafts are only available in the US, UK, and DE marketplaces.\t|\n","|Landing Page URL, Landing Page asins, Brand Entity Id, Brand Name, Brand Logo Asset Id, Creative Headline, Creative asins, Video Media Ids, Creative Type\\*\t|Optional while the campaign is a draft. These fields become mandatory before you can submit the draft for a full review—see Step 3 below.\t|\n"," If you also want to add a keyword to your draft, add a Draft keyword row underneath the Draft campaign row:\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Draft keyword\t|\n","|Operation\t|Create\t|\n","|Draft Campaign Id\\*\t|Enter the exact same value you entered in the Draft campaign row.\t|\n","|State\t|Optional while in draft.\t|\n","|Bid\t|Enter the CPC amount you are willing to pay when a shopper clicks your ad, for example 0.5.\t|\n","|Keyword Text\\*\t|Enter one keyword or phrase.\t|\n","|Match Type\t|Options are broad, phrase, or exact.\t|\n"," It is not mandatory to add keywords to a draft, but you can use the example above if you want to include them.\n"],"documentType":"guide"},{"title":"How to create and manage Sponsored Brands draft campaigns with bulksheets","sectionHeader":{"type":2,"text":"Step 2. Update a draft campaign"},"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/sb-draft-campaigns","content":[" To update a draft, the fastest way to get the right Draft Campaign Id is to download a bulksheet with the drafts you want to update. Use the Update operation and include only the fields you want to change—all other fields can be left blank.\n"," For example, to update a draft's budget from $10 to $20 and set an end date that was previously empty:\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Draft campaign\t|\n","|Operation\t|Update\t|\n","|Draft Campaign Id\\*\t|Enter the system-generated Draft Campaign ID from your downloaded bulksheet.\t|\n","|Budget\t|Enter the new budget amount, for example 20.\t|\n","|End Date\t|Enter the new end date, using the format yyyyMMdd.\t|\n"," To update a keyword bid within the same draft—for example, raising a keyword's max bid from $0.50 to $0.65—add a Draft keyword row with the Update operation and the keyword's generated ID:\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Draft keyword\t|\n","|Operation\t|Update\t|\n","|Draft Campaign Id\\*\t|Enter the same Draft Campaign ID used for the parent draft.\t|\n","|Bid\t|Enter the new bid amount, for example 0.65.\t|\n"],"documentType":"guide"},{"title":"How to create and manage Sponsored Brands draft campaigns with bulksheets","sectionHeader":{"type":2,"text":"Step 3. Submit a draft for review"},"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/sb-draft-campaigns","content":[" Once your draft has all the necessary Sponsored Brands fields added—including landing page, brand, and creative details—it is ready to be submitted for a full campaign review.\n","In the \"Operation\" field for the Draft campaign row, enter Submit. 2. None of the mandatory fields (landing page details, brand name, brand entity ID, brand logo asset ID, creative headline, and creative ASINs) can be left empty at this point. Otherwise, you will receive an error indicating the missing fields. 3. Upload the file. This initiates the conversion of your draft into an actual Sponsored Brands campaign, which then goes through the standard Sponsored Brands moderation process. 4. If the campaign is accepted, all child entities of the draft (such as Draft keyword rows) are automatically converted to their non-draft equivalents (Keyword, and so on).\n"],"documentType":"guide"},{"title":"Overview - Sponsored Brands multi-ad group campaigns in bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sb/overview","content":[" NOTE: In this guide, we refer to the current Sponsored Brands campaigns without multi-ad group support as legacy campaigns whereas campaigns with multi-ad group support are referred to as multi-ad group campaigns.\n"," This article provides an overview of using Sponsored Brands multi-ad group campaigns using a bulk spreadsheet, including explanations of the new entities and descriptions of each column header in the new spreadsheet tab. For a more detailed explanation on using the new multi-ad group spreadsheet, review the next article: How to create Sponsored Brands multi-ad group campaigns. \n"," With Sponsored Brands multi-ad group campaigns, you can:\n","create and manage multiple (multi) ad groups  add a custom bidding adjustment by placement   update your creative assets in bulksheets, including the creative headline, landing pages, and image files \\* use all Sponsored Brands ad formats, including Manual Collection, Auto Collection, Store spotlight, Video, and Brand video ads.\n"," You can still use the legacy version of Sponsored Brands in bulksheets, but it will eventually be deprecated, so we recommend migrating to the new version soon.\n"," To use Sponsored Brands multi-ad group campaigns with bulksheets, you will use a new tab that is different from the legacy version, and is described below. \n"],"documentType":"guide"},{"title":"Overview - Sponsored Brands multi-ad group campaigns in bulksheets","sectionHeader":{"type":2,"text":"How to get a Sponsored Brands multi-ad group file"},"path":"/en-us/no-code-tools/bulksheets/sb/overview","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","|From the bulk operations homepage, in \"Step 1. Create & download a custom spreadsheet,\" check the box to include Sponsored Brands multi-ad group data →You can leave the other boxes checked by default, or you can deselect (uncheck) them for a potentially faster download. Click Create spreadsheet for download.This will create a tab in the spreadsheet, titled \"SB multi-ad group campaigns.\" This new tab will contain your Sponsored Brands ad group information, including entities for the four Sponsored Brands ad types (or ad formats) in each ad group. You will also see entities for \"Bidding adjustment by placement\" if you have applied custom adjustments to any campaigns. All entities you might find in the new multi-ad group data tab are described in more detail below. |Multi-ad groups in checkbox selection|\n"," Note: The tab labeled Sponsored Brands data is the legacy version, and it will not include any ad group, ad format, or placements information. It will only contain campaign and targeting entities. If you want to view or create ad groups or bidding adjustments, you must do this in the new Sponsored Brands multi-ad group data tab. \n"],"documentType":"guide"},{"title":"Overview - Sponsored Brands multi-ad group campaigns in bulksheets","sectionHeader":{"type":2,"text":"Sponsored Brands multi-ad group entities"},"path":"/en-us/no-code-tools/bulksheets/sb/overview","content":[" In bulksheets, you will always define the campaign \"entity\" in Column B of your spreadsheet. With the introduction of this latest version of Sponsored Brands, you will have additional campaign entities that only apply to the new version. These new entities can be viewed and managed in the Sponsored Brands multi-ad groups data tab in your downloaded bulksheets file. The table below contains more information about Sponsored Brands multi-ad group entities. Learn more about multi-ad group campaign structure in the Sponsored Brands entity diagram\n"," Note: The entities labeled as \"NEW\" will only be shown in the Sponsored Brands multi-ad groups data tab, and will not appear in the legacy Sponsored Brands data tab. \n","|Entity (spreadsheet Column B)    |Description    |\n","\\|---    \\|---    \\|\n","|Campaign    |This entity defines the top-level parent campaign, and will include details such as Campaign ID and Name, the Start date, State, Budget information, and Bid optimization status—set this field to false if you want to create a custom bidding adjustment. Otherwise, enter true and Amazon will automatically set this value.     |\n","|Bidding adjustment by placement NEW    |You can add an optional custom Bidding adjustment by placement if you want to manually configure bid changes depending on placement. To do this, be sure to set the \"Bid optimization\" field to false in the \"Campaign\" entity row. Then, create this entity in its own separate row in the spreadsheet.     |\n","|Ad group NEW    |With the latest version of Sponsored Brands, you can now create and manage ad groups—including adding multiple ad groups to a single campaign. The ad group is a parent of the ad and targeting entities, so you will always include the Ad group ID value in those child entity rows in bulksheets.     |\n","|Manual Collection ad NEW    |Select Manual Collection to feature 3–10 related products you choose from your catalog. Collection ads display your brand logo, a title, and a call-to-action that directs shoppers to a branded experience. Products in the ad link to product detail pages. You need to include brand name, product ASINs (3–10), and optionally a landing page URL and title.    |\n","|Auto Collection ad NEW    |Select Auto Collection to let Amazon AI dynamically group the most relevant products from your catalog into collections based on your keyword targets and shopper search queries. You only need to supply the brand name. Optionally, you can exclude specific ASINs that you do not want included in the auto-curated collection using the Product Exclusions field.    |\n","|Product collection ad DEPRECATED    |DO NOT USE Select Product collection if you want to promote unique collections of products or existing Stores. With this ad format entity, you can promote multiple products from a landing page of your choice: Either Store on Amazon, a new landing page that Amazon will create for you, or a custom URL that you have created. To create this ad format in bulksheets, you need to include creative assets such as landing page URL, brand name and logo, ASINs you want to advertise, and a creative headline.With a product collection, you must also define custom images.Product collection ad is deprecated. Use Manual Collection ad or Auto Collection ad instead. Existing Product collection ads will continue to function, but new campaigns should use collection ad types instead.  |\n","|Video ad NEW    |With video ads, you can promote a single product and drive traffic to the product detail page or your Store. Select the \"Video ad\" entity if you want to drive traffic to a Product detail page, and enter \"Detail page\" as the landing page type. If you want to drive traffic to a Store on Amazon, select the \"Brand video ad\" entity as your ad format, and enter \"Store\" as the landing page type.      |\n","|Brand video ad NEW    |This is a video ad with a Store on Amazon landing page, so if you select this as your ad format in bulksheets, you should enter \"Store\" as the landing page type.     |\n","|Store spotlight ad NEW    |Select Store spotlight if you want to drive traffic to certain Store pages. With a Store spotlight, you drive traffic to a Store and its sub-pages. The landing page type is \"Store,\" and it must include sub-pages.    |\n","|Keyword    |You can choose keywords to help your products appear in shopper searches. To create keyword or product targets for Sponsored Brands multi-ad group campaigns, the functionality is exactly the same as it is in the legacy version of Sponsored Brands. If you want a keyword targeting strategy, you need a row for the keyword entity. Include the Campaign ID and Ad group ID, State, Bid amount, Keyword text, and Match type.     |\n","|Negative keyword    |If keywords are overspending or underperforming, you can negate them to prevent the terms from appearing for certain searches or products. Include the same fields that you use for regular keyword targeting.     |\n","|Product targeting    |With product targeting, you can choose specific products, categories, brands or other product features to target your ads. You will need the ASIN values for the products you want to advertise.     |\n","|Negative Product Targeting    |Similar to negative keyword targeting, you can negate products to prevent your ads from displaying when a shopper's search matches your negative product selections. This helps exclude irrelevant searches, reducing your advertising cost. You will need the ASIN values for the products you want to negate.     |\n"," If you are ready to start creating campaigns using the new Sponsored Brands format, see How to create Sponsored Brands multi-ad group campaigns. If you want more details about each field you will see in the new Sponsored Brands multi-ad group data tab, continue reading. \n"],"documentType":"guide"},{"title":"Overview - Sponsored Brands multi-ad group campaigns in bulksheets","sectionHeader":{"type":2,"text":"Explanation of Sponsored Brands multi-ad group fields"},"path":"/en-us/no-code-tools/bulksheets/sb/overview","content":[" The table below represents a downloaded bulksheets template. Each column header from the Sponsored Brands multi-ad group data tab is represented below, with a description of that field. Read-only and metrics headers are not included. Note that the column headers are transposed when compared with an actual bulksheets file. \n","|Column header    |Description    |\n","\\|---    \\|---    \\|\n","|Product    |This is how you choose your campaign type in bulksheets. Enter Sponsored Brands    |\n","|Entity    |This is where you select the specific campaign entity to create in each row. Enter one of the values described in the entity table above    |\n","|Operation    |This is the action you want to take in each row. Options are Create, Update, or Archive.     |\n","|Campaign ID    |To create a new campaign, enter a temporary ID of your choice. Be sure this exact same ID is entered into all child entity fields as well. This ID will become a unique system-generated ID when the campaign is created, and you use that unique ID to update the campaign later.     |\n","|Portfolio ID    |You can add a campaign to an existing portfolio if you enter the Portfolio ID when you create the campaign.     |\n","|Ad Group ID    |Similar to the Campaign ID field: To create a new ad group, enter a temporary ID of your choice. Be sure this exact same ID is entered into all child entity fields as well. This ID will become a unique system-generated ID when the ad group is created, and you use that unique ID to update the ad group later.     |\n","|Ad ID    |For the Ad ID, Keyword ID, and Product Targeting IDs, leave these blank when you create the entities. A system-generated ID will be created, and you will see this ID in bulksheets when you download your campaigns.     |\n","|Keyword ID    |See above    |\n","|Product Targeting ID    |See above    |\n","|Campaign name    |Enter a unique name in the Campaign entity row    |\n","|Ad group name    |Enter a unique name in the Ad group entity row    |\n","|Ad name    |Enter a unique value in the Ad name entity row     |\n","|Start date    |This value is defined in the Campaign entity row. Leave blank, and the campaign will start on today's date. Otherwise, enter the future date that you want the campaign to start.     |\n","|End date    |Leave blank, and the campaign would run indefinitely. You can stop the campaign by pausing or archiving it. Otherwise, enter the date that you want the campaign to stop running.     |\n","|State    |For all entities other than the \"Bidding adjustment by placement,\" enter a status. Usually this will be enabled, but you can also use this field to pause an entity. To do this, enter Update in the \"Operation\" field, and set this \"State\" field to be paused     |\n","|Brand Entity ID    |When you create the \"Ad format\" entity (e.g. Product collection ad, Video ad, Store spotlight ad, Brand video ad), you will enter creative asset details, including your Brand Entity ID. You can locate this in bulksheets, in the \"Brand assets data\" tab.     |\n","|Campaign state    |You can ignore this field as it is read-only    |\n","|Budget type    |This is defined in the campaign entity row, and will be either Lifetime or Daily    |\n","|Budget    |Your budget determines how much you will spend on this campaign, so enter the numeric value to set your budget. You can edit your campaign to change your budget anytime by entering the new budget value and entering Update in the \"Operation\" field of the campaign.     |\n","|Bid optimization    |In the UI, this is called \"Automated bidding,\" and there is a toggle to turn this on or off. In bulksheets, you do this by entering either True (to enable automated bidding) or False (to set your own custom bidding adjustment by placement).     |\n","|Product location    |You can ignore this field as it is read-only    |\n","|Bid    |The bid is set at the target-level, so you will define this in the row where you create a Keyword or Product targeting entity. You can update this value at any time after you create the campaign. Simply change the bid value, and enter Update as the \"Operation\" for the keyword bid you want to change.     |\n","|Placement    |This lets you set a custom bidding adjustment if you indicated False for the \"Bid optimization\" value of the campaign. You define this in the Bidding adjustment by placement entity row, and options include Home, Detail page, or Other    |\n","|Percentage    |If you are setting a custom bidding adjustment, this is where you enter the percentage value.     |\n","|Keyword text    |If you are using a keyword targeting strategy, you will create a row in your spreadsheet for the Keyword entity. In that entity row, you enter the keyword you want to add.     |\n","|Match type    |For the Keyword entity, this defines the match type: broad, phrase, or exact.     |\n","|Native language keyword    |You can ignore this field as it is read-only    |\n","|Native language locale    |You can ignore this field as it is read-only    |\n","|Product targeting expression    |If you want a product targeting strategy, you will create a Product targeting entity row where you identify this \"Product targeting expression\" value. In the UI, this is where you select either \"individual products\" or \"categories\" to target. For \"individual products,\" use the ASIN and enter asin=\"A000000000000\" (using the actual ASIN ID—note that in this field, asin must be entered all lowercase as shown). For \"categories,\" use the category ID along with other qualifiers such as price limit and star rating. For this field, enter all qualifiers into the same cell of your bulksheets file because they work as a combined unit to define the targeting.    |\n","|Landing page URL    |All creative details are defined in the same row where you create the ad format—including landing page information. The URL is where you want to direct shoppers when they click your ad, and will be either a Store on Amazon, a Product detail page, a new landing page that Amazon creates with the ASINs you are advertising, or a custom URL that you provide. You also have the option to provide custom images if you do not want to use the images from your advertised ASINs—you do this in the \"Custom images\" field.     |\n","|Landing page ASINs    |You can ignore this field as it is read-only    |\n","|Landing page type    |This is where you want to direct shoppers when they interact with your ad. Options include Store, Custom URL, or New landing page.    |\n","|Brand name    |This is your brand name—or the name of the brand you want to manage in a given bulksheets file    |\n","|Consent to translate    |You can ignore this field as it is read-only    |\n","|Brand logo asset ID    |This is the asset ID for your brand logo. You can find this value in the \"Brand assets data\" tab of a downloaded bulksheets file.     |\n","|Brand logo crop    |This field lets you crop the logo if needed, using the format {\"left\":\"0\",\"top\":\"0\",\"width\":\"0\",\"height\":\"0\"} to define the pixels.    |\n","|Custom images    |If you want shoppers to see a different image other than what is represented by your ASINs, enter the image IDs here.     |\n","|Creative headline    |Enter the creative headline to highlight the unique benefits of the products in your ad. We recommend using a conversational tone that matches your brand. Learn more about headline and messaging guidelines    |\n","|Creative ASINs    |This is the list of products you want to feature or advertise. Enter all of them in this one field, separated by commas.     |\n","|Video asset IDs    |If your ad format is Video or Brand video, enter the IDs for the videos you want to use. You can find these asset IDs in the \"Brand assets data\" tab of a downloaded bulksheets file.     |\n","|Sub-pages    |If your landing page is a Store on Amazon, you can enter sub-pages to include here.     |\n","|Product Exclusions    |Applies to Auto Collection ads only. A comma-separated list of product ASINs to exclude from the Amazon AI-powered automatic product selection. Use this field to prevent specific products from appearing in the auto-curated collection; for example, out-of-season items, discontinued products, or ASINs you prefer to advertise separately. Maximum 1,000 ASINs. This field is ignored for other ad entity types.    |\n","|Ad Title    |Applies to Manual Collection ads only. An optional title displayed on the collection ad creative to help shoppers quickly understand what the collection offers. Use this to communicate your brand message or highlight a product theme (e.g., \"Summer Essentials\" or \"Best Sellers\"). Maximum 32 characters. If left blank, Amazon will auto-generate a title based on the products in your collection. Auto-generated titles may reference your brand name, product category, or product attributes. This field is ignored for Auto Collection and other ad entity types.    |\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Display","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sd/get-started","content":[" This article walks through the steps of getting started with bulksheets for Sponsored Display. You will find guidance and tips for entering campaign data into your downloaded spreadsheet so you can upload the sheet to create campaigns using bulksheets. \n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Display","sectionHeader":{"type":3,"text":"Prepare to edit your bulksheets file"},"path":"/en-us/no-code-tools/bulksheets/sd/get-started","content":[" Before you start entering data into your file, here are some guidelines and tips to help you understand the functionality of the sheet. \n"," Allowable values for the first three columns\n"," Many of the bulksheets values will vary depending on your specific situation. For example, Bid amount and ASIN values might vary greatly depending on the individual user or campaign. But some columns have strict limitations on what you can enter. In particular, for the first three foundational columns for Sponsored Display, here are the allowed values:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Sponsored Display\t|Campaign\t|Create\t|\n","|\t|Ad group\t|Update\t|\n","|\t|Product ad\t|Archive\t|\n","|\t|Audience targeting\t|\t|\n","|\t|Contextual targeting\t|\t|\n","|\t|Negative product targeting\t|\t|\n"," TIPS:\n","Sponsored Display campaigns require a targeting tactic: either Audience targeting or Product targeting. To target audiences on and off Amazon, select Audience targeting.  To target the intended product or audience, you need the related IDs for elements such as product category or audience lifestyle. To get these IDs, you can use past campaign data by exporting data into a bulksheet from campaigns where you assigned those targeting expressions. The Resolved Product Targeting Expression column will show the values as they appear in the UI. You can then map this value to the corresponding ID in the Product Targeting Expression column.  Be sure to always include the Product (campaign type like Sponsored Display, Sponsored Products, or Sponsored Brands) in Column A for every row that contains an entity you want to create.   Every entity (in Column B) will be in its own separate row. Then, you will define attributes for each entity in the other cells that span that specific row.   The Operation column must contain a value in any row where you want updates to occur. Otherwise, the row will be ignored. If you are creating a new campaign, then you would type Create in each row of the Operation column for each entity in that campaign. To update or archive, set the Operation column to Update or Archive accordingly. \n"," EXAMPLE 1: To create a Sponsored Display campaign with one ad group, one product ad, and audience targeting, your first three columns would look like this:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Sponsored Display\t|Campaign\t|Create\t|\n","|Sponsored Display\t|Ad group\t|Create\t|\n","|Sponsored Display\t|Product ad\t|Create\t|\n","|Sponsored Display\t|Audience targeting\t|Create\t|\n"," EXAMPLE 2: If you want to have multiple product ads for the campaign, use a new row for each product ad:\n","|grid orangeCol A\t|Col B\t|Col C\t|\n","|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|\n","|Sponsored Display\t|Campaign\t|Create\t|\n","|Sponsored Display\t|Ad group\t|Create\t|\n","|Sponsored Display\t|Product ad\t|Create\t|\n","|Sponsored Display\t|Product ad\t|Create\t|\n","|Sponsored Display\t|Product ad\t|Create\t|\n","|Sponsored Display\t|Product ad\t|Create\t|\n","|Sponsored Display\t|Audience targeting\t|Create\t|\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products across retailers (Retail Ad Service)","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sp/get-started-ras","content":["\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products across retailers (Retail Ad Service)","sectionHeader":{"type":2,"text":"How to manage Sponsored Products campaigns across retailers in bulksheets"},"path":"/en-us/no-code-tools/bulksheets/sp/get-started-ras","content":[" This section describes the process of creating and updating sponsored products campaigns across retailers using bulksheets. \n"," If you want to learn more about bulksheets in general, review the bulksheets overview article.\n"," Bulksheets is a spreadsheet-based tool that allows sponsored ads advertisers to create, update, and optimize multiple campaigns in batches, reducing time and manual effort. For example, you can update the names of campaigns or ad groups, or change bids in large batches via spreadsheet, instead of doing this one-by-one. \n"," This guide will provide detailed instructions for how to proceed. But at a very high level, using bulksheets involves three main steps: 1. Creating a spreadsheet file to download | 2. Editing the spreadsheet | 3. Uploading the file to make the changes\n"," Steps 1 and 3 are completed from the bulk operations homepage while Step 2 is done offline via spreadsheet: \n","\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products across retailers (Retail Ad Service)","sectionHeader":{"type":3,"text":"Access the bulk operations homepage"},"path":"/en-us/no-code-tools/bulksheets/sp/get-started-ras","content":["| IMAGE | \n","\\| --- \\| --- \\|\n","| The first step is to visit the bulk operations home page from campaign manager.From the left side navigation, hover on the “Sponsored ads” tab and click Bulk operations → This will open the bulk operations homepage where you can download a file.  | Bulk operations main screen ras-2 |\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products across retailers (Retail Ad Service)","sectionHeader":{"type":3,"text":"Create & download a custom spreadsheet"},"path":"/en-us/no-code-tools/bulksheets/sp/get-started-ras","content":["| IMAGE | \n","\\| --- \\| --- \\|\n","| In “Step 1. Create & download a custom spreadsheet,” select a date range for performance metrics (clicks, impressions, ROAS, etc.) → Next, select the data you want to include in the download. At a minimum, you must include Sponsored Products data—this will populate an RAS tab in your spreadsheet, which will include the Sponsored Products across retailers campaigns. You can also include Sponsored Products search term data to get insights on the words that shoppers enter when they search on Amazon. Learn more about bulksheets search term reports.You can also include Campaign items with zero impressions to see campaigns that are generating no valuable traffic—or to see campaigns you recently created that might not have gotten impressions yet. Placement data gives insights on where your ads were shown.When you are ready, click Create spreadsheet for download →  | Bulk operations main screen ras-3 |\n"," Scroll down to Bulk spreadsheet history to download the file. Note that it may take several minutes for the “Download” link to appear, and you may need to refresh the page:\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products across retailers (Retail Ad Service)","sectionHeader":{"type":3,"text":"What to expect when you open the file"},"path":"/en-us/no-code-tools/bulksheets/sp/get-started-ras","content":[" Your spreadsheet will have multiple tabs, but should include tabs labeled Portfolios, Sponsored Products Campaigns, SP Search Term Report, and RAS Campaigns if you selected the options shown in the checklist above. \n"," Open the RAS Campaigns sheet. If you already have active campaigns in your account, you will see details about each campaign entity (e.g. Campaign, Ad group, Product ad, etc.) in each row of the spreadsheet. Otherwise, the sheet might contain no data initially. \n"," A few tips:\n","Apply filters to all columns to make the sheet easier to review and navigate\n","Notice that Column A, the Product is always RAS when managing Sponsored Products across retailers campaigns\n","For Column B, RAS Entity options include Campaign, Ad group, Product ad, and Target\n","The Operation field (Col C) is always blank when you download a file. You enter values into this field whenever you want to make changes in that row to either Create, Update, or Archive. This is an important field in bulksheets, so review this getting started guide to learn more about the “Operation” field.\n","Notice that most IDs are populated for their relevant fields—e.g., the Target entities contain Target IDs. For Target and Product ad IDs, leave these blank when you create the campaign initially. When you create the campaign, the IDs will be generated and you can see them when you download the campaign later.\n","For Campaign ID and Ad group IDs ONLY, you will add temporary IDs when you create them initially, and unique numeric IDs will be generated when you create the campaign.  More details on this are in the sections below.\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products across retailers (Retail Ad Service)","sectionHeader":{"type":3,"text":"Deep-dive into the bulksheets file "},"path":"/en-us/no-code-tools/bulksheets/sp/get-started-ras","content":[" The table below shows all column headers, transposed for easier reading in this format, along with guidelines on what to enter and other notes/tips. The values are not case sensitive. \n","|Column header\t|Guidelines on what to enter & other tips\t|\n","|---\t|---\t|\n","|Product\t|Required in every row. Enter RAS \t|\n","|Entity\t|Required in every row. This defines the entity you want to manage in each row. Options for RAS include Campaign, Ad group, Product ad, and Target. \t|\n","|Operation\t|Required in every row to define the action you want to take in that row. Options are Create, Update, or Archive. In a downloaded bulksheet, you can leave this field blank for any row where you do not want to make any changes, and our system will ignore that row. \t|\n","|Campaign ID\t|Required in every row, to associate the child entities with the parent-level campaign, and the IDs must match exactly. When creating new campaigns, you must enter a temporary text-based ID, and a unique numeric one will generate when you create the campaign. For new campaigns, we recommend using the same value that you assign for the Campaign name. \t|\n","|Ad Group ID\t|Required in every row other than the Campaign row. This associates child entities with the parent-level Ad group. Similar to the Campaign ID above, you must enter a temporary text-based ID when creating new Ad groups, and a unique one will be generated upon creation. For new Ad groups, we recommend using the same value that you assign for the Ad group name. \t|\n","|Target ID\t|Leave blank when creating new Targets. To make updates later, you need the unique ID, which is already populated in a downloaded custom spreadsheet. \t|\n","|Product Ad ID\t|Similar to the above: Leave blank when creating new ads. You need the ID to make updates later, and you can find that ID in a downloaded file. \t|\n","|Portfolio ID\t|Required in the Campaign row--but only if the campaign is in a portfolio. Otherwise, leave blank. \t|\n","|Retailer\t|Leave blank\t|\n","|Retailer ID\t|Required in the Campaign and Ad group rows. \t|\n","|Retailer Offer ID\t|This is sometimes referred to as SKU - if you do not know the SKU, you can download the product catalog in the campaign creation workflow (https&#x3A;//advertising.amazon.com/cb/create/rmssp) Note: You need an Amazon Ads Console account to access this link. If you do not have an account, you can set up a vendor account to access RAS.\t|\n","|Name\t|Required in the Campaign and Ad group rows. Enter a unique name. We recommend using this same name for the Campaign ID and Ad group ID when creating new campaigns. \t|\n","|State\t|Required in all rows. Options are ENABLED or PAUSED. You typically enter ENABLED. \t|\n","|Start Date\t|Required in the Campaign row. Format must be YYYYmmDD. For example, July 4, 2025 would be written as 20250704\t|\n","|End Date\t|Optional. Enter a value if you want to set a specific end date, and use the YYYYmmDD format\t|\n","|Targeting Type\t|Required in the Campaign entity row to designate it as a manual targeting or auto targeting campaign. Options are AUTO or MANUAL. If set to AUTO, the Target type can be either Keyword or Auto. If set to MANUAL, the Target type must be Keyword. \t|\n","|Target Type\t|Required in the Target entity row if the campaign targeting type is AUTO. Options include AUTO or KEYWORD. Note that if set to AUTO, the Negative field must be FALSE because these targets cannot be negative.  \t|\n","|Target Level\t|Required in the Target entity row if the campaign targeting type is MANUAL. Enter AD GROUP\t|\n","|Budget\t|Required in the Campaign entity row. Enter a numeric value.\t|\n","|Budget Type\t|Required in the Campaign entity row. Enter DAILY \t|\n","|SKU\t|Leave blank unless otherwise indicated. \t|\n","|Ad Group Default Bid\t|Required in the Ad group entity row. Enter a numeric value.\t|\n","|Negative\t|Required for the Target entity row. Options are TRUE or FALSE. This is a binary to indicate if your target is negative, e.g. a negative keyword target. Negative targets do not need bids, so leave the Bid field blank if this is set to TRUE. Also note that if Target type is AUTO, this value must be FALSE because auto targets cannot be negative\t|\n","|Bid\t|Required in the Target entity row if your Targeting type is Keyword and Negative (Col W) is set to FALSE. Enter a numeric value. This sets your keyword-level bid for keyword targets. \t|\n","|Currency Code\t|\t|\n","|Keyword Text\t|Required in the Target entity row if your Targeting type (Col Q) is Keyword. If you want to add more keyword targets, you need a new row for each Target entity.\t|\n","|Keyword Match Type\t|Required in the Target row if your Target type is Keyword. Enter BROAD, PHRASE, or EXACT \t|\n","|Auto Match Type\t|Required in the Target entity row if your Target type is set to Auto. Options include Keywords Close Match, Keywords Loose Match, and Product Substitutes. \t|\n","|Bidding Strategy\t|Required in the Campaign entity row. Enter MANUAL \t|\n","|Bidding Adjustment Placement\t|Optional in the Campaign entity row. Enter PLACEMENT TOP\t|\n","|Bidding Adjustment Percentage\t|Required in the Campaign entity row if you added a Bidding adjustment placement. Enter a numeric value. \t|\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products across retailers (Retail Ad Service)","sectionHeader":{"type":3,"text":"Create new campaigns "},"path":"/en-us/no-code-tools/bulksheets/sp/get-started-ras","content":[" A few tips:\n","To create a new campaign from scratch, you can add new rows into the downloaded file to create the new entities. In Excel, highlight the number of rows you want to add, click Insert from the top nav, and select “Insert sheet rows.” As long as the Operation field remains blank for the existing campaigns in the sheet, those will remain unchanged when you upload the sheet to create the new entities.  \n","For manual-targeting campaigns, the Target type (Column Q) must be Keyword, and the Negative field must be set to FALSE because manual keyword targets must be positive.\n","For auto-targeting campaigns, the Target type can be either Keyword or Auto. Keyword targets can be either positive or negative, but Auto target type must be positive.\n"," To start filling out the sheet, you start with the first blank row and start working through each field for each entity row—you will need one row for each entity, as shown in Figure 1 above. \n"," Necessary fields for each entity include:\n","Campaign row: Product, Entity, Operation, Campaign ID, Name, State, Start date, Targeting type, Budget, Budget type, bidding strategy\n","Ad group row: Product, Entity, Operation, Campaign ID, Ad group ID, Retailer ID, Name, State, Ad group default bid\n","Product ad row: Product, Entity, Operation, Campaign ID, Ad group ID, Retailer ID, Retailer Offer ID, State\n","Target row: Product, Entity, Operation, Campaign ID, Ad group ID, State, Target type, Target level, Negative, Bid, Keyword text, Keyword match type\n"," Putting it all together, the rows for creating this new campaign might resemble:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Target ID\t|Product Ad ID\t|Portfolio ID\t|Retailer\t|Retailer ID\t|Retailer Offer ID\t|Name\t|State\t|Start Date\t|End Date\t|Targeting Type\t|Target Type\t|Target Level\t|Budget\t|Budget Type\t|SKU\t|Ad Group Default Bid\t|Negative\t|Bid\t|Currency Code\t|Keyword Text\t|Keyword Match Type\t|Auto Match Type\t|Bidding Strategy\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|RAS\t|Campaign\t|Create\t|Campaign name 1\t|\t|\t|\t|\t|\t|\t|\t|Campaign name 1\t|Enabled\t|20240930\t|\t|Auto\t|\t|\t|20000\t|Daily\t|\t|\t|\t|\t|\t|\t|\t|\t|Manual\t|\n","|RAS\t|Ad Group\t|Create\t|Campaign name 1\t|Ad group name 1\t|\t|\t|\t|\t|24483676143932\t|\t|Ad group name 1\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|1.5\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Product Ad\t|Create\t|Campaign name 1\t|Ad group name 1\t|\t|\t|\t|\t|24483676143932\t|7890\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Target\t|Create\t|Campaign name 1\t|Ad group name 1\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|3.5\t|\t|dog collar\t|phrase\t|\t|\t|\n"," If you download this same campaign later, it might resemble the following—note that the temporary Campaign and Ad group IDs have changed to system-generated ones, and the blank Product ad ID and Target ID fields are now populated:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Target ID\t|Product Ad ID\t|Portfolio ID\t|Retailer\t|Retailer ID\t|Retailer Offer ID\t|Name\t|State\t|Start Date\t|End Date\t|Targeting Type\t|Target Type\t|Target Level\t|Budget\t|Budget Type\t|SKU\t|Ad Group Default Bid\t|Negative\t|Bid\t|Currency Code\t|Keyword Text\t|Keyword Match Type\t|Auto Match Type\t|Bidding Strategy\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|RAS\t|Campaign\t|\t|294852839\t|\t|\t|\t|\t|\t|\t|\t|Campaign name 1\t|Enabled\t|20240930\t|\t|Auto\t|\t|\t|20000\t|Daily\t|\t|\t|\t|\t|\t|\t|\t|\t|Manual\t|\n","|RAS\t|Ad Group\t|\t|294852839\t|443678957\t|\t|\t|\t|\t|224958227503444\t|\t|Ad group name 1\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|1.5\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Product Ad\t|\t|294852839\t|443678957\t|\t|3329739\t|\t|\t|224958227503444\t|7890\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Target\t|\t|294852839\t|443678957\t|587584038\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|3.5\t|\t|dog collar\t|phrase\t|\t|\t|\n"," Necessary fields for each entity include:\n","Campaign row: Product, Entity, Operation, Campaign ID, Name, State, Start date, Targeting type, Budget, Budget type, bidding strategy\n","Ad group row: Product, Entity, Operation, Campaign ID, Ad group ID, Retailer ID, Name, State, Ad group default bid\n","Product ad row: Product, Entity, Operation, Campaign ID, Ad group ID, Retailer ID, Retailer Offer ID, State\n","Target rows: Product, Entity, Operation, Campaign ID, Ad group ID, State, Target type, Target level, Negative, Bid (for non-negative keywords only), Keyword text, Keyword match type\n"," Putting it all together, the rows for creating this new campaign might resemble:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Target ID\t|Product Ad ID\t|Portfolio ID\t|Retailer\t|Retailer ID\t|Retailer Offer ID\t|Name\t|State\t|Start Date\t|End Date\t|Targeting Type\t|Target Type\t|Target Level\t|Budget\t|Budget Type\t|SKU\t|Ad Group Default Bid\t|Negative\t|Bid\t|Currency Code\t|Keyword Text\t|Keyword Match Type\t|Auto Match Type\t|Bidding Strategy\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|RAS\t|Campaign\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|\t|\t|Campaign name 2\t|Enabled\t|20241201\t|\t|Manual\t|\t|\t|15000\t|Daily\t|\t|\t|\t|\t|\t|\t|\t|\t|Manual\t|\n","|RAS\t|Ad Group\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|224958227503444\t|\t|Ad group name 2\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Product Ad\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|224958227503444\t|1029384\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|1.75\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Target\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|1.25\t|\t|suit pant\t|Phrase\t|\t|\t|\n","|RAS\t|Target\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|0.75\t|\t|black tie\t|Broad\t|\t|\t|\n","|RAS\t|Target\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|TRUE\t|\t|\t|floral tie\t|Exact\t|\t|\t|\n"," Necessary fields for each entity include:\n","Campaign row: Product, Entity, Operation, Campaign ID, Name, State, Start date, Targeting type, Budget, Budget type, bidding strategy\n","Ad group row: Product, Entity, Operation, Campaign ID, Ad group ID, Retailer ID, Name, State, Ad group default bid\n","Product ad row: Product, Entity, Operation, Campaign ID, Ad group ID, Retailer ID, Retailer Offer ID, State\n","Target rows: Product, Entity, Operation, Campaign ID, Ad group ID, State, Target type, Target level, Negative, Auto match type (because the Target type is AUTO). Also note that the Negative value must be FALSE because Auto targets cannot be negative. \n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Target ID\t|Product Ad ID\t|Portfolio ID\t|Retailer\t|Retailer ID\t|Retailer Offer ID\t|Name\t|State\t|Start Date\t|End Date\t|Targeting Type\t|Target Type\t|Target Level\t|Budget\t|Budget Type\t|SKU\t|Ad Group Default Bid\t|Negative\t|Bid\t|Currency Code\t|Keyword Text\t|Keyword Match Type\t|Auto Match Type\t|Bidding Strategy\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|RAS\t|Campaign\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|\t|\t|Campaign name 2\t|Enabled\t|20241201\t|\t|Auto\t|\t|\t|15000\t|Daily\t|\t|\t|\t|\t|\t|\t|\t|\t|Manual\t|\n","|RAS\t|Ad Group\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|224958227503444\t|\t|Ad group name 2\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|1.75\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Product Ad\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|224958227503444\t|1029384\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Target\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Auto\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|\t|\t|\t|\t|Keywords Close Match\t|\t|\n","|RAS\t|Target\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Auto\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|\t|\t|\t|\t|Keywords Loose Match\t|\t|\n","|RAS\t|Target\t|Create\t|Campaign name 2\t|Ad group name 2\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Auto\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|\t|\t|\t|\t|Product Substitutes\t|\t|\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products across retailers (Retail Ad Service)","sectionHeader":{"type":3,"text":"Update existing campaigns"},"path":"/en-us/no-code-tools/bulksheets/sp/get-started-ras","content":[" After you create campaigns—regardless of whether it is in the advertising console or bulksheets—you can always download the campaigns into bulksheets and make updates directly from the file. The process for updating is typically simple and requires far fewer inputs compared with the Create operation. Assuming you have downloaded a custom spreadsheet as described above, you only need to make two manual inputs: 1. Enter UPDATE in the Operation field, and 2. Enter the value for what you want to change in the relevant spreadsheet field. All other required fields (e.g. IDs) should already be populated in the downloaded file. \n"," The examples below include additional rows beyond the ones being updated because this is typically how you will interact with the downloaded sheet to make updates. You can leave the other data in the sheet, and our system will ignore any rows where the Operation field is left blank. This lets you make quick updates without needing to delete other data from the sheet. \n"," Some common Update actions are shown below. All examples assume you have downloaded a custom spreadsheet that contains your current campaign data, including the entity IDs. \n"," Required fields: Product, Entity, Operation, Campaign ID, Campaign name, State\n"," In the Campaign entity row, be sure all of the required inputs are filled in. Below is what the downloaded sheet might look like after you add the necessary values:. \n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Target ID\t|Product Ad ID\t|Portfolio ID\t|Retailer\t|Retailer ID\t|Retailer Offer ID\t|Name\t|State\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|RAS\t|Campaign\t|Update\t|500371812775953\t|\t|\t|\t|\t|\t|\t|\t|New campaign name\t|Enabled\t|\n","|RAS\t|Ad Group\t|\t|500371812775953\t|410868284805583\t|\t|\t|\t|\t|224958227503444\t|\t|Ad group name 1\t|Enabled\t|\n","|RAS\t|Ad Group\t|\t|500371812775953\t|376584553712841\t|\t|\t|\t|\t|224958227503444\t|\t|Ad group name 2\t|Enabled\t|\n","|RAS\t|Product Ad\t|\t|500371812775953\t|376584553712841\t|\t|308096492277259\t|\t|\t|224958227503444\t|508320885088718\t|\t|Enabled\t|\n"," Note that the campaign row is the only one that needs updates. You can simply leave the other fields unchanged, and the system will ignore those rows since the Operation field has been left blank. This represents how advertisers typically interact with bulksheets to make quick/simple updates. \n"," You can make as many updates in a single file as necessary. For example, to update the ad group name along with the campaign name, the sheet would resemble this: \n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Target ID\t|Product Ad ID\t|Portfolio ID\t|Retailer\t|Retailer ID\t|Retailer Offer ID\t|Name\t|State\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|RAS\t|Campaign\t|Update\t|500371812775953\t|\t|\t|\t|\t|\t|\t|\t|New campaign name\t|Enabled\t|\n","|RAS\t|Ad Group\t|Update\t|500371812775953\t|410868284805583\t|\t|\t|\t|\t|224958227503444\t|\t|New ad group name\t|Enabled\t|\n","|RAS\t|Ad Group\t|\t|500371812775953\t|376584553712841\t|\t|\t|\t|\t|224958227503444\t|\t|Ad group name 2\t|Enabled\t|\n","|RAS\t|Product Ad\t|\t|500371812775953\t|376584553712841\t|\t|308096492277259\t|\t|\t|224958227503444\t|508320885088718\t|\t|Enabled\t|\n"," Required fields: Product, Entity, Operation, Campaign ID, Ad group ID, Target ID, State, Bid\n"," In the relevant Target row, manually enter UPDATE in the Operation field, and the value you want to change the bid to. Your sheet might resemble the following: \n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Target ID\t|Product Ad ID\t|Portfolio ID\t|Retailer\t|Retailer ID\t|Retailer Offer ID\t|Name\t|State\t|Start Date\t|End Date\t|Targeting Type\t|Target Type\t|Target Level\t|Budget\t|Budget Type\t|SKU\t|Ad Group Default Bid\t|Negative\t|Bid\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|RAS\t|Campaign\t|\t|500371812775953\t|\t|\t|\t|\t|\t|\t|\t|Campaign name 1\t|Enabled\t|20241202\t|\t|AUTO\t|\t|\t|1000\t|Daily\t|\t|\t|\t|\t|\n","|RAS\t|Ad Group\t|\t|500371812775953\t|410868284805583\t|\t|\t|\t|\t|224958227503444\t|\t|Ad group name 1\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|1.5\t|\t|\t|\n","|RAS\t|Product Ad\t|\t|500371812775953\t|376584553712841\t|\t|308096492277259\t|\t|\t|224958227503444\t|508320885088718\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Target\t|Update\t|298342158186968\t|466965360570401\t|301890742579947\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|3.5\t|\n","|RAS\t|Target\t|\t|298342158186968\t|466965360570401\t|337887013349256\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|3.09\t|\n"," Required field: Product, Entity, Operation, Campaign ID, State, Budget amount\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Target ID\t|Product Ad ID\t|Portfolio ID\t|Retailer\t|Retailer ID\t|Retailer Offer ID\t|Name\t|State\t|Start Date\t|End Date\t|Targeting Type\t|Target Type\t|Target Level\t|Budget\t|Budget Type\t|SKU\t|Ad Group Default Bid\t|Negative\t|Bid\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|RAS\t|Campaign\t|Update\t|500371812775953\t|\t|\t|\t|\t|\t|\t|\t|Campaign name 1\t|Enabled\t|20241202\t|\t|AUTO\t|\t|\t|2500\t|Daily\t|\t|\t|\t|\t|\n","|RAS\t|Ad Group\t|\t|500371812775953\t|410868284805583\t|\t|\t|\t|\t|224958227503444\t|\t|Ad group name 1\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|1.5\t|\t|\t|\n","|RAS\t|Product Ad\t|\t|500371812775953\t|376584553712841\t|\t|308096492277259\t|\t|\t|224958227503444\t|508320885088718\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Target\t|\t|298342158186968\t|466965360570401\t|301890742579947\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|3.5\t|\n","|RAS\t|Target\t|\t|298342158186968\t|466965360570401\t|337887013349256\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|3.09\t|\n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products across retailers (Retail Ad Service)","sectionHeader":{"type":3,"text":"Pause campaigns and other entities "},"path":"/en-us/no-code-tools/bulksheets/sp/get-started-ras","content":[" Pausing a campaign or other entity requires two inputs, assuming the downloaded file already contains IDs. \n"," To pause, you set the Operation to update, and change the State to paused. All other fields can be left as-is:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Target ID\t|Product Ad ID\t|Portfolio ID\t|Retailer\t|Retailer ID\t|Retailer Offer ID\t|Name\t|State\t|Start Date\t|End Date\t|Targeting Type\t|Target Type\t|Target Level\t|Budget\t|Budget Type\t|SKU\t|Ad Group Default Bid\t|Negative\t|Bid\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|RAS\t|Campaign\t|Update\t|500371812775953\t|\t|\t|\t|\t|\t|\t|\t|Campaign name 1\t|Paused\t|20241202\t|\t|AUTO\t|\t|\t|1000\t|Daily\t|\t|\t|\t|\t|\n","|RAS\t|Ad Group\t|\t|500371812775953\t|410868284805583\t|\t|\t|\t|\t|224958227503444\t|\t|Ad group name 1\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|1.5\t|\t|\t|\n","|RAS\t|Product Ad\t|\t|500371812775953\t|376584553712841\t|\t|308096492277259\t|\t|\t|224958227503444\t|508320885088718\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Target\t|\t|298342158186968\t|466965360570401\t|301890742579947\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|3.5\t|\n"," To make the campaign active again later, perform these same steps, but set the State to enabled. \n"],"documentType":"guide"},{"title":"Getting started with bulksheets for Sponsored Products across retailers (Retail Ad Service)","sectionHeader":{"type":3,"text":"Archive campaigns and other entities"},"path":"/en-us/no-code-tools/bulksheets/sp/get-started-ras","content":[" Archiving a campaign or other entity requires just one input, assuming the downloaded file already contains IDs and other values. \n"," To archive, you set the Operation field to Archive. As long as the entity ID is in the sheet, this is all you need to do—you can even leave the State populated because it will be overridden when you upload the file:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Target ID\t|Product Ad ID\t|Portfolio ID\t|Retailer\t|Retailer ID\t|Retailer Offer ID\t|Name\t|State\t|Start Date\t|End Date\t|Targeting Type\t|Target Type\t|Target Level\t|Budget\t|Budget Type\t|SKU\t|Ad Group Default Bid\t|Negative\t|Bid\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|RAS\t|Campaign\t|Archive\t|500371812775953\t|\t|\t|\t|\t|\t|\t|\t|Campaign name 1\t|Enabled\t|20241202\t|\t|AUTO\t|\t|\t|1000\t|Daily\t|\t|\t|\t|\t|\n","|RAS\t|Ad Group\t|\t|500371812775953\t|410868284805583\t|\t|\t|\t|\t|224958227503444\t|\t|Ad group name 1\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|1.5\t|\t|\t|\n","|RAS\t|Product Ad\t|\t|500371812775953\t|376584553712841\t|\t|308096492277259\t|\t|\t|224958227503444\t|508320885088718\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|RAS\t|Target\t|\t|298342158186968\t|466965360570401\t|301890742579947\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|Keyword\t|Ad Group\t|\t|\t|\t|\t|FALSE\t|3.5\t|\n"],"documentType":"guide"},{"title":"Input guidance for Sponsored Products","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sp/sp-general-info/input-guidance","content":[" Excel input guidance is a feature in bulksheets that helps you understand what you should enter in the spreadsheet fields, and which fields are required for each campaign entity. This article describes how to access and use this feature. \n"],"documentType":"guide"},{"title":"Input guidance for Sponsored Products","sectionHeader":{"type":3,"text":"How to access the input guidance feature "},"path":"/en-us/no-code-tools/bulksheets/sp/sp-general-info/input-guidance","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","|To access this feature, go to the bulk operations main page:1. Under \"1. Create & download a custom spreadsheet,\" select a date range. Note that the date range is for performance metrics, and the range will not affect the input guidance feature. 2. For the feature to appear, you must select the following two checkboxes from the \"Include\" list: Sponsored Products data and Guidance for Sponsored Products inputs BETA →  Note that you can include other selections as well, but these are the two that are relevant for this feature.  3. To get a spreadsheet pre-populated with your current campaigns, click Create spreadsheet for download. If you want a blank template without any campaign data, click the link that reads \"Download a bulk operations template\" instead. →| Data selection for bulksheets | \n"],"documentType":"guide"},{"title":"Input guidance for Sponsored Products","sectionHeader":{"type":3,"text":"Column header hints"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-general-info/input-guidance","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| The spreadsheet will generally look the same as it does without this feature, but note that the top header row, along with the first three columns, are frozen in place so you can always see those fields even if you scroll. You also see hints about each field if you click into any column header. For example, if you click on the start date column header, you see that the value must use the format of YYYYMMDD. → | Depiction of hint in Start Date column header |\n"],"documentType":"guide"},{"title":"Input guidance for Sponsored Products","sectionHeader":{"type":3,"text":"Dropdowns in some fields"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-general-info/input-guidance","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| In addition to the column header hints, you see dropdowns for fields where the required values are finite. Fields with dropdowns include - Product- Entity- Operation- Targeting type- State- Match type- Bidding strategy- Placement- Sites You can see the dropdowns if you click into one of the fields listed above. Allowable values will appear in the list, as shown in this example of the Entity field → | Depiction of dropdown menu in Entity field |\n"],"documentType":"guide"},{"title":"Input guidance for Sponsored Products","sectionHeader":{"type":3,"text":"Highlights to show required and optional fields "},"path":"/en-us/no-code-tools/bulksheets/sp/sp-general-info/input-guidance","content":[" In each row, after you select values for the first three columns (Product, Entity, Operation), cells will automatically highlight to show which fields are required and optional. Required fields will highlight dark blue, and optional fields will be lighter blue. Cells that have no highlighting should remain blank if you are using a blank template. If you are using a custom downloaded sheet, the cells should be left untouched, as the values in unhighlighted cells cannot be changed.\n"," The image below shows examples of highlights for the Campaign and Ad Group entity rows when using the Create operation. This example shows a blank template, with no campaign data populated. \n"," Based on these highlights, the required fields to create a new campaign are\n","Campaign ID  Campaign Name  Start Date  Targeting Type  State  Daily Budget  Bidding Strategy\n"," Portfolio ID, End Date, and Sites are all optional fields. These highlights will change automatically depending on which entity and operation you select—for example, notice that the image above shows different cells highlighted for the Ad Group entity row when compared with the Campaign entity row. \n"," Learn more about managing Sponsored Products campaigns using bulksheets\n"],"documentType":"guide"},{"title":"Bulksheets language guide","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/bulksheets-language-guide","content":[" You can download a bulksheet in your chosen language by selecting that language from your advertiser profile. For example, if Japanese is the language selected in your profile, you will see Japanese text in bulksheets downloads. When you upload the file, you can use any supported language, regardless of the language selected in your profile. This article provides guidance on what you should enter in the \"Operation\" field (Column C) if you want to use a language other than English. \n"," When you download a bulksheets file, the \"Operation\" field will always be blank. To make changes to any row, you must enter a value in this field depending on what you want to do: Either create, update, archive, or submit. Note that the \"submit\" value only applies for Sponsored Brands draft campaigns. \n"],"documentType":"guide"},{"title":"Bulksheets language guide","sectionHeader":{"type":2,"text":"Translation guide for \"Operation\" values"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-language-guide","content":[" The table below shows what you should enter for the \"Operation\" values if you are using a language other than English. The English terms are in the top row. Refer to your preferred language to see the equivalent values that you should enter into the \"Operation\" field, depending on what you want to do in that row. Leave the field blank for any rows where you do not want to take any action.   \n","|English - EN - AU - CA - GB - IN - SG    |Create    |Update    |Archive    |Submit (for Sponsored Brands draft campaigns only)    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Arabic - AE    |إنشاء    |تحديث    |الأرشيف    |إرسال    |\n","|Simplified Chinese - CN    |创建    |更新    |存档    |提交    |\n","|Traditional Chinese - TW    |建立    |更新    |封存    |提交    |\n","|French - FR- CA    |Créer    |Mettre à jour    |Archiver    |Soumettre    |\n","|German - DE    |Erstellen    |Aktualisieren    |Archivieren    |Absenden    |\n","|Italian - IT    |Crea    |Aggiorna    |Archivia    |Invia    |\n","|Japanese - JP    |作成    |更新    |非表示にする    |送信    |\n","|Korean - KO    |생성    |업데이트    |보관    |제출    |\n","|Swedish - SE    |Skapa    |Uppdatera    |Arkiv    |Skicka in    |\n","|Spanish - CO - ES - MX    |Crear    |Actualizar    |Archivar    |Enviar    |\n","|Polish - PL    |Utwórz    |Aktualizuj    |Zarchiwizuj    |Prześlij    |\n","|Portuguese - BR    |Criar    |Atualização    |Arquivar    |Enviar    |\n","|Tamil - IN    |உருவாக்கு    |புதுப்பிப்பு    |காப்பகம்    |சமர்ப்பிக்கவும்    |\n","|Thai - TH    |สร้าง    |อัพเดต    |เก็บถาวร    |ส่ง    |\n","|Turkish - TR    |Oluştur    |Güncelle    |Arşivle    |Gönder    |\n","|Vietnamese - VN    |Tạo    |Cập nhật    |Lưu trữ    |Gửi    |\n","|Dutch - NL    |Maken    |Bijwerken    |Archief    |Indienen    |\n","|Hindi - IN    |बनाएँ    |अपडेट करें    |आर्काइव करें    |सबमिट करें    |\n"],"documentType":"guide"},{"title":"Guide for keyword translations","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/bulksheets-keyword-translations-guide","content":[" When you create Sponsored Products campaigns using bulksheets, you can now add keywords in your preferred or native language. The keywords will be automatically translated into English (or the default language of your locale) when you create the campaign.\n"],"documentType":"guide"},{"title":"Guide for keyword translations","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-keyword-translations-guide","content":[" For some locales, English is the default language in the Amazon Ads system, even though the native language for that locale is not English—this includes Egypt, Saudi Arabia, and United Arab Emirates. For these locales, advertisers must use English when creating keywords, which can be challenging for advertisers who are not proficient in English. For this reason, automatic keyword translations are available in bulksheets. \n"],"documentType":"guide"},{"title":"Guide for keyword translations","sectionHeader":{"type":2,"text":"How to fill out the spreadsheet"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-keyword-translations-guide","content":[" To access this feature, you use two fields in your bulksheets file: Native language keyword and Native language locale. \n","In the \"Native language keyword\" field, you should enter your keywords in your native language.  2. In the \"Native language locale\" field, enter the language code of your native language \n"," As an example, if you are in Egypt, Saudi Arabia, or United Arab Emirates, and your native language is Arabic, your bulksheets file might resemble this:\n","|Keyword Text\t|Native language keyword\t|Native language locale\t|\n","|---\t|---\t|---\t|\n","|\t|أطواق الكلاب\t|ar_AE\t|\n","|\t|أسرة الكلاب\t|ar_AE\t|\n","|\t|مستلزمات الحيوانات الأليفة\t|ar_AE\t|\n","|\t|أزياء الحيوانات الأليفة\t|ar_AE\t|\n","|\t|يعامل الكلب\t|ar_AE\t|\n"," When you upload the file, the Arabic keywords would be translated into English because that is the default language locale for the Egypt, Saudi Arabia, and United Arab Emirates locales. If you download a bulksheets file later, you can see the English versions in the \"Keyword text\" field, which will have been automatically populated with the English translations: \n","|Keyword Text\t|Native language keyword\t|\n","|---\t|---\t|\n","|dog collars\t|أطواق الكلاب\t|\n","|dog beds\t|أسرة الكلاب\t|\n","|pet supplies\t|مستلزمات الحيوانات الأليفة\t|\n","|pet costumes\t|أزياء الحيوانات الأليفة\t|\n","|dog treats\t|يعامل الكلب\t|\n"],"documentType":"guide"},{"title":"Guide for keyword translations","sectionHeader":{"type":2,"text":"Native language locale codes"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-keyword-translations-guide","content":[" You can also use languages other than Arabic if you prefer a different language. The table below shows the languages that are supported and the language codes you should enter in the \"Native language keyword\" field, depending on the language you prefer to use—the code should match the language of the keywords you enter in the \"Native language keyword\" field: \n","|Language\t|Native language locale code\t|\n","|---\t|---\t|\n","|Arabic\t|ar_AE\t|\n","|Dutch\t|nl_NL\t|\n","|French\t|fr_FR\t|\n","|German\t|de_DE\t|\n","|Italian\t|it_IT\t|\n","|Japanese\t|ja_JP\t|\n","|Polish\t|pl_PL\t|\n","|Portuguese \t|pt_BR\t|\n","|Spanish (Spain)\t|es_ES\t|\n","|Spanish (Mexico)\t|es_MX\t|\n","|Swedish\t|sv_SE\t|\n","|Simplified Chinese\t|zh_CN\t|\n"],"documentType":"guide"},{"title":"Bulksheets search term report","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/bulksheets-search-term-report","content":[" A search term report gives visibility into the terms that shoppers enter when searching on Amazon. This report can help you understand exactly what a shopper searched for when they saw your ad, and you can use these insights to adjust your targeting strategy. For example, you can use this report to identify high-performing searches from customers and to create negative keyword or product targets for search terms that do not meet your goals.\n"," Including the search term report in bulksheets can help you analyze your keywords and product targets more efficiently because you do not need to download the report separately from the advertising console. In addition, the bulksheets search term report includes the parent/child entity IDs needed to make quick updates. These parent/child entity relationships are important when managing campaigns in bulksheets, so review the entity diagrams for Sponsored Products and Sponsored Brands if you want to learn more about campaign structure. \n"," Note that some seller- and vendor-specific lookback metrics (for example, 7-day advertised SKU sales, and 14-day advertised ASIN sales) are not included in the bulksheets search term report. For those metrics, you should get a search term report from the advertising console. The lookback window in bulksheets search term reports is always 7 days for both vendors and sellers. \n"],"documentType":"guide"},{"title":"Bulksheets search term report","sectionHeader":{"type":2,"text":"How to access search term reports in bulksheets"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-search-term-report","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| The following steps explain how you can include a search term report tab when you create and download a custom bulksheet file:   1. Log in to your Amazon Ads account  2. Navigate to the advertising console (vendors) or Seller Central (sellers)  3. From the left side menu panel, click Sponsored ads > Bulk operations  4. Select a date range—and note that this date range does not affect the search term report metrics, which will be a 7-day lookback window. This date range selection is for campaign performance only.  5. Select the data you want to see in the custom spreadsheet. Be sure to check the \"Sponsored Products Search term data\" box.  6. Download the file and navigate to the \"Search term report\" tab Learn more about how to create and download a custom bulksheets file. | Search term report in checklist |\n"," The section below explains what columns you should expect to see in the bulksheets search term report, along with descriptions of each field. \n"],"documentType":"guide"},{"title":"Bulksheets search term report","sectionHeader":{"type":2,"text":"Search term report header descriptions "},"path":"/en-us/no-code-tools/bulksheets/bulksheets-search-term-report","content":[" The information below is available in bulksheets search term reports for both sellers and vendors. Note that this sheet is read-only, so you should not make changes in this sheet. Instead, you can review the customer search terms and how these relate to your keywords and product targets. Then, use these insights to make updates in the campaign tab for either Sponsored Products or Sponsored Brands, depending on which campaign type you want to manage.  \n","|Column\t|Header\t|Description\t|\n","|---\t|---\t|---\t|\n","|A\t|Product\t|The campaign type (Sponsored Products or Sponsored Brands)\t|\n","|B\t|Campaign Id\t|Use this ID in the relevant entity row to update keywords or product targeting\t|\n","|C\t|Ad Group Id\t|Use this ID in the relevant entity row to update keywords or product targeting\t|\n","|D\t|Keyword Id (Read only)\t|Use this ID in the \"keyword\" entity row to update keywords\t|\n","|E\t|Product Targeting Id (Read only)\t|Use this ID in the \"product targeting\" entity row to update product targets\t|\n","|F\t|Campaign Name (Informational only)\t|Informational field so you know the name of the campaign associated with your targeting entities\t|\n","|G\t|Ad Group Name (Informational only)\t|Informational field so you know the name of the ad group associated with your targeting entities\t|\n","|H\t|Portfolio Name (Informational only)\t|Informational field so you know the name of the portfolio associated with your targeting entities. Note that this field applies to Sponsored Products only.\t|\n","|I\t|State\t|The state or status of the keyword or targeting entity\t|\n","|J\t|Campaign State (Informational only)\t|Informational field so you know the state of the campaign associated with your targeting entities\t|\n","|K\t|Bid\t|The bid amount for the related targeting entity. Bids can be updated in the Sponsored Products tab. In the keyword or product targeting row, set the \"Operation\" field to update, enter the new bid value, and upload the bulksheets file. Learn more about updating campaigns in bulksheets\t|\n","|L\t|Keyword Text\t|The word or phrase that you have named your keywords. Keyword text cannot be updated, but you can create new versions of a keyword if you want to modify the text. You can also pause or archive keywords, or add negative keywords for ones that are under-performing\t|\n","|M\t|Match Type\t|For manual keyword targeting campaigns, this is the match type for the keyword or phrase used in the bid. Will be either broad, phrase, or exact. This value cannot be updated, but you can create new keywords with the match type you want.\t|\n","|N\t|Product Targeting Expression\t|For auto targeting campaigns, this is the product, category, and other attributes being targeted. For individual products, the expression will be asin=\"VALUE\". For categories and other attributes, the expression will be category=\"VALUE\", price&lt;VALUE, and so on. For bids set at the targeting group level, the values will be either close-match, loose-match, substitutes, or complements.|\n","|O\t|Customer Search Term\t|The term or phrase the customer typed into the search bar when they encountered your ad. Note: You may notice alphanumeric entries such as \"b00ipgvvz4\" in addition to more traditional search terms such as \"phone case.\" These alphanumeric entries correspond to ASINs and the related product detail page on which your ad displayed. You will only see ASIN-related entries listed as customer search terms for your Sponsored Products automatic-targeted campaigns and product-attribute-targeted ad groups. You can block ASINs through negative targeting, or bid for ASINs in manually targeted campaigns.\t|\n","|P\t|Impressions\t|The number of times the ad was displayed, excluding general and sophisticated invalid traffic. The traffic quality filters removed the potentially fraudulent, non-human, and other illegitimate impressions. Also note: If you compare impressions in the search term report with what you see in the advertising console, the numbers might be different. This is because the search term report includes only the terms that resulted in at least one ad click.\t|\n","|Q\t|Clicks\t|The number of times the ad was clicked, excluding general and sophisticated invalid traffic. The traffic quality filter removes potentially fraudulent, non-human, and other illegitimate clicks.\t|\n","|R\t|Click-through Rate\t|The ratio of how often customers click your ad when it is shown. This is calculated as impressions divided by clicks.\t|\n","|S\t|Spend\t|The amount of money spent running the campaign. Cost is assessed per click or per 1,000 views depending on cost type.\t|\n","|T\t|Sales\t|The total product sales that you have received on your ads within 7 days from the date your ad was clicked.\t|\n","|U\t|Orders\t|The number of orders that you have received within 7 days from the date that your ad was clicked. If an order contains multiples of the same unit in one order, this should show as 1 order and 2 units.\t|\n","|V\t|Units\t|The number of unit orders that you have received within 7 days from the date that your ad was clicked.\t|\n","|W\t|Conversion Rate\t|The total number of orders divided by sales within 7 days from the date that your ad was clicked.\t|\n","|X\t|ACOS\t|Total spend divided by your total sales during the campaign. It is expressed as a percentage. For example, if you spend $5 on ads and generate $25 in sales, your ACOS is 20%. This metric provides you a straightforward measure of the profitability of your advertising. Typically, you want a low ACOS.\t|\n","|Y\t|CPC\t|The cost-per-click metric determines how much is paid for the ads placed on websites or social media, based on the number of clicks the ad receives. It is calculated by dividing total spend (cost) by the total number of clicks.\t|\n","|Z\t|ROAS\t|Total product sales divided by the total advertising spend invested on the campaign. It is represented as a number that is interpreted as an index (multiplier) rather than a percent (%). For example, if you spent 20 dollars on a sponsored ads campaign that generated 100 dollars in sales, the ROAS will be 5.\t|\n"],"documentType":"guide"},{"title":"Use portfolios with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/bulksheets-portfolios","content":[" Create, update, and manage portfolios in bulk\n"," Similar to what you might have seen in the advertising console, portfolios are groups of campaigns that you can organize to meet your advertising needs. For example, you can create portfolios to organize campaigns by brand, product category, or season to provide structure and to manage your advertising activity. \n"," With the \"Portfolios\" bulksheets tab, you can create a portfolio and set a budget that will apply to any campaign within the portfolio. To access the tab, you can follow these steps to download and create a custom spreadsheet or download a bulk template from the \"Bulk operations\" page. After you have your spreadsheet or blank template, select the \"Portfolios\" tab to see the column fields below.\n"," With the new Portfolios template, the first three columns have been updated to align with the new bulksheets version, to provide more parity with the API, and to make the upload process more efficient. Here is a preview of the template fields you see when you access the new Portfolios tab in bulksheets:\n","|grid orangeProduct\t|Entity\t|Operation\t|Portfolio ID\t|Portfolio Name\t|Budget Amount\t|Budget Currency\t|Budget Policy\t|Budget Start Date\t|Budget End Date\t|State (Informational only)\t|In Budget (Informational only)\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"Use portfolios with bulksheets","sectionHeader":{"type":2,"text":"Create a new portfolio "},"path":"/en-us/no-code-tools/bulksheets/bulksheets-portfolios","content":[" To create portfolios with bulksheets, you will always complete the first three foundational columns: Product, Entity, and Operation. In addition to these first three fields, the only mandatory field to create a new portfolio is Portfolio Name (Column E). If you want to define a budget when you create the portfolio, you can also add those details.\n"," Use the following guidelines to create a new portfolio:\n","Column A - Product: (Required) You must enter Portfolios — plural, with the s included 2. Column B - Entity: (Required) Enter Portfolio 3. Column C - Operation: (Required) Enter either Create or Update. \"Archive\" is not an option for portfolios. 4. Column D - Portfolio ID: (Required when updating a portfolio) Leave blank for new portfolios. If you are updating an existing portfolio, enter the actual ID. 5. Column E - Portfolio Name: (Required) Enter the name you want to assign the portfolio. You can leave blank if you are updating an existing portfolio unless you want to change the portfolio name. 6. Column F - Budget Amount: (Optional) Enter the maximum you want to spend for the date range or monthly cap, depending on which option you select in the \"Budget Policy\" field. Otherwise, leave blank and it will be auto-set to 0.0. You can update the budget details later using the Update operation and Portfolio ID. TIP: For existing portfolios with a budget assigned, you can remove the budget if you update the portfolio and leave the budget field blank. This will reset the portfolio budget to null and remove it from the portfolio and its child entities. 7. Column G - Budget Currency: (Required if you are setting a budget) Enter the three-letter currency code that matches your account's marketplace (for example, USD, EUR, GBP, JPY, CAD). If you leave this field blank when a Budget Amount is set, the upload will fail with the error \"budget currency code cannot be null.\" If you are not setting a budget, you can leave this field blank. 8. Column H - Budget Policy: (Required only if you are setting a budget) In the advertising console, this is the \"Budget cap\" setting where you select either a date range or recurring monthly policy. For bulksheets, you should enter either dateRange, monthlyRecurring, or noCap to specify no budget cap: 9. Column I - Budget Start Date: (Required only if you are setting a budget) Use the format yyyyMMdd (July 12, 2022 would be 20220712) 10. Column J - Budget End Date: (Optional) You can either leave blank if you want the budget to run indefinitely, or you can enter an end date using the format yyyyMMdd (February 25, 2023 would be 20230225). Note that the end date cannot be changed or updated once you set it. 11. Column K - State: (Leave blank) This field is informational only and will be auto-set to be enabled when you upload the bulksheets file to create the portfolio. 12. Column L - In Budget: (Leave blank) This field is informational only, and you can ignore it completely when creating or updating a portfolio\n"," Using only the mandatory fields to create a new portfolio without setting a budget, the sheet would resemble this:\n","|grid orangeProduct\t|Entity\t|Operation\t|Portfolio ID\t|Portfolio Name\t|Budget Amount\t|Budget Currency\t|Budget Policy\t|Budget Start Date\t|Budget End Date\t|State (Informational only)\t|In Budget (Informational only)\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Portfolios\t|Portfolio\t|Create\t|\t|Summer Sports\t|\t|\t|\t|\t|\t|\t|\t|\n"," You can also create multiple new portfolios in a single upload. The example below adds another portfolio to the example above, and includes budget details:\n","|grid orangeProduct\t|Entity\t|Operation\t|Portfolio ID\t|Portfolio Name\t|Budget Amount\t|Budget Currency\t|Budget Policy\t|Budget Start Date\t|Budget End Date\t|State (Informational only)\t|In Budget (Informational only)\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Portfolios\t|Portfolio\t|Create\t|\t|Summer Sports\t|\t|\t|\t|\t|\t|\t|\t|\n","|Portfolios\t|Portfolio\t|Create\t|\t|Spring Gardening\t|500\t|USD\t|dateRange\t|20220225\t|20220525\t|\t|\t|\n"],"documentType":"guide"},{"title":"Use portfolios with bulksheets","sectionHeader":{"type":2,"text":"Update an existing portfolio"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-portfolios","content":[" You can update existing portfolios if you want to add, change, or remove the budget details or change the portfolio name. You will need the portfolio ID, which you can find if you create and download a custom spreadsheet and select the \"Portfolios\" tab. \n"," NOTE: If you want to update a portfolio to add a new budget, the \"Budget Amount,\" \"Budget Policy,\" and \"Budget Start Date\" fields are required.\n"," Let us assume we created the \"Summer Sports\" portfolio in the example above, and now we want to add budget details. The bulksheets file might resemble this if you choose to set a budget amount: \n","|grid orangeProduct\t|Entity\t|Operation\t|Portfolio ID\t|Portfolio Name\t|Budget Amount\t|Budget Currency\t|Budget Policy\t|Budget Start Date\t|Budget End Date\t|State (Informational only)\t|In Budget (Informational only)\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Portfolios\t|Portfolio\t|Update\t|10293847\t|\t|125\t|USD\t|monthlyRecurring\t|20220327\t|\t|\t|\t|\n"," If you wanted to adjust or modify the budget details for a portfolio, you would follow the same logic shown above. For example, if the budget is set to 125, you could enter 100 in the \"Budget Amount\" field to change the budget to 100.  \n"," You can remove the budget assigned to a portfolio by using the \"Update\" operation, including the portfolio ID, and leaving the \"Budget Amount\" field blank. This will reset the budget to 0.0 for the portfolio and all of its campaigns:\n","|grid orangeProduct\t|Entity\t|Operation\t|Portfolio ID\t|Portfolio Name\t|Budget Amount\t|Budget Currency\t|Budget Policy\t|Budget Start Date\t|Budget End Date\t|State (Informational only)\t|In Budget (Informational only)\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Portfolios\t|Portfolio\t|Update\t|10293847\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"Use portfolios with bulksheets","sectionHeader":{"type":2,"text":"Create a new campaign within a portfolio"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-portfolios","content":[" Here are the recommended steps to add a new campaign to a portfolio using bulksheets:\n","If the portfolio does not already exist, create the new portfolio by following the steps above  2. Then, create and download a custom spreadsheet file from the \"Bulk operations\" page 3. Copy the portfolio ID from the \"Portfolios\" tab of the downloaded file 4. Create a new campaign using the product-specific template, and include the portfolio ID in the \"Portfolio ID\" field of the campaign entity row \n"," Using the portfolio example shown above, here is what your bulksheet might look like. Note that you should include the portfolio ID to create the campaign within a portfolio:\n","|grid orangeProduct\t|Entity\t|Operation\t|Campaign Id\t|Ad Group Id\t|Portfolio Id\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|Targeting Type\t|State\t|Daily Budget\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Keyword Text\t|Match Type\t|Bidding Strategy\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Summer Campaign\t|\t|10293847\t|Summer Campaign\t|\t|20220401\t|\t|Auto\t|Enabled\t|100\t|\t|\t|\t|\t|\t|\t|Fixed bid\t|\n"," Note that the template above is the Sponsored Products bulksheets template. You cannot create or update a campaign using the Portfolios template. To learn more about creating campaigns, see the guides below:\n"],"documentType":"guide"},{"title":"Understand bulksheets campaign data","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/understand-bulksheets-data","content":[" When you create and download a custom spreadsheet for bulk operations, you will use a checklist to decide which data to include. This article will guide you on how to navigate this process. \n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| Depending on what you choose to include, your downloaded bulksheet can have one tab for each campaign type: Sponsored Brands, Sponsored Display, and Sponsored Products. You can see entity IDs that you use to update campaigns in bulk, performance metrics for the date range you select, and other data.  If you include brand assets data, the sheet will also have a \"Brand Assets Data\" tab, which shows the rich media from your assets library. This data is important if you want to manage Sponsored Brands campaigns using bulksheets, so be sure to check this box if you are managing this campaign type. The section below explains more details about customizing bulksheets campaign data. | Use the checklist to customize the data in your bulksheet |\n"],"documentType":"guide"},{"title":"Understand bulksheets campaign data","sectionHeader":{"type":2,"text":"Decide which campaign data you want to see"},"path":"/en-us/no-code-tools/bulksheets/understand-bulksheets-data","content":[" Use the checkboxes to customize the data that will appear in the sheet. \n","Terminated campaigns: Excluded by default. Check this box if you want to see data for campaigns that are no longer active.  Campaign items with zero impressions: Excluded by default. TIP: For keyword optimization, it might be helpful to check this box to include items with zero impressions. This can help you see which keywords you might want to update or negate.   Placement data for campaigns: Included by default. This shows where your ads appeared on the page.   Brand assets data: Excluded by default. If you are managing Sponsored Brands campaigns, it might be helpful to include this data so you can easily see your asset IDs.    Sponsored Products, Sponsored Brands, and Sponsored Display: These are all included by default, but you can exclude any campaign types if you only want to see certain ones. Excluding any of these might speed up the download time.  \\* Guidance for Sponsored Products: Included by default. This guidance will give you tips and help when creating Sponsored Products campaigns. Learn more about input guidance for Sponsored Products\n"," NOTE: Brand assets must be in your creative assets library before they can be uploaded using bulksheets. This means you will need to use the advertising console to create a Sponsored Brands campaign, and then perform a bulksheets download that includes brand assets data to obtain the IDs. \n"],"documentType":"guide"},{"title":"Understand bulksheets campaign data","sectionHeader":{"type":2,"text":"Brand assets data: Additional information"},"path":"/en-us/no-code-tools/bulksheets/understand-bulksheets-data","content":[" Brand assets data is a collection of the creative assets you used to create Sponsored Brands campaigns. When you create a new Sponsored Brands campaign with bulksheets, you will need certain IDs in order to populate your campaign with the correct logos, landing pages, and other data. You can find these IDs in the “brand assets data” tab in your downloaded bulksheets. \n","Column A: Asset Type: Options include backgroundVideo, brandLogo, customImage, otherImage, productImage, video. You can filter this column to isolate certain asset types. This is useful when creating Sponsored Brand campaigns, as you will need IDs such as brand logo or video ID. \n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| TIP: Use a filter on Column A (“Asset Type”) to quickly find asset types →   For example, if you need the “Brand Logo Asset ID,”  you can apply a filter Column A to show only the brandLogo fields.| Sponsored Brands asset type column|\n","Column B: Brand Entity ID: Applies to sellers only. Locate in Column B of the “Brand Assets Data” tab. Format is typically alpha-numeric, resembling ENTITY00BR549.  Column C: Asset ID: Check Column A (“Asset Type”) to see which asset type the ID represents.  Column D: Asset Name: The name you provided when you created/uploaded the asset. \\* Column E: Asset URL: The link to the asset hosted on Amazon servers. \n"," ADDITIONAL TIPS\n"],"documentType":"guide"},{"title":"Bulksheets migration guide","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/migration-guide","content":[" This guide is intended to help you migrate from the legacy bulksheets to the newest version. It will help you understand how the old template relates to the new template with a side-by-side comparison, along with other tips for success. \n"," The new bulksheets give you access to more features that are already available to advertisers who use the API, so you can have the benefits of API functionality with the simplicity of a spreadsheet interface. To access bulksheets:\n","|TILESFor Vendors    |For Sellers    |\n","\\|---    \\|---    \\|\n","|1. Sign in to your Amazon Ads account    |1. Sign in to your Amazon Ads account    |\n","|2. Navigate to the advertising console    |2. Navigate to Seller Central    |\n","|3. From the left side menu panel, click Sponsored ads > Bulk operations    |3. Under \"All campaigns,\" click Bulk operations    |\n"," You can download a new bulksheets file either by creating a custom spreadsheet or by downloading a blank template. If you are not sure how to get a bulksheets file, check out Get started with bulksheets: Part 1. Having a new bulksheets file on hand might make it easier to reference the changes outlined in the following sections. \n"," The sections below describe what you can expect with the new version of bulksheets for Sponsored Products, Sponsored Brands, and Sponsored Display campaigns. \n"," Jump to: What is new | Tips and guidelines | Known issues and workarounds | Side-by-side comparisons\n"],"documentType":"guide"},{"title":"Bulksheets migration guide","sectionHeader":{"type":2,"text":"Changes in the new bulksheets"},"path":"/en-us/no-code-tools/bulksheets/migration-guide","content":[" A high-level overview of important changes in bulksheets\n","|grid orange New in bulksheets    |Important details    |\n","\\|---    \\|---    \\|\n","|Product field (Column A)    |This is where you set the campaign type: Sponsored Products, Sponsored Brands, or Sponsored Display    |\n","|Entity field (Column B)    |This new field was \"record type\" in legacy bulksheets. It defines which part of the campaign you are creating or updating. A few examples include campaign, ad group, keyword.     |\n","|Operation field (Column C)    |In the new \"Operation\" column, you can indicate the action that should occur in a given row. Options include create, update, or archive. With Sponsored Brands bulksheets, there is also a submit option when you create draft campaigns, which creates the campaign but prevents it from launching while in draft mode. For any row where you want to perform an action, the \"Operation\" field is required. This new feature can save time when uploading bulksheets file by ignoring data that you do not want to update.    |\n","|Update campaign and ad group names    |You can now update the names of campaigns and ad groups. This lets you reuse spreadsheets and update these names more efficiently in bulk.     |\n","|Support for Sponsored Display    |You can now use bulksheets to manage your Sponsored Display campaigns. Learn more in Get started with Sponsored Display.     |\n","|Run campaigns indefinitely    |With the new bulksheets, you can allow campaigns to continue running with no set end date by leaving the \"End date\" field blank   |\n","|Support for Sponsored Brands product targeting and all ad formats    |Sponsored Brands now supports product targeting and additional ad formats in bulksheets. Learn more in Get started with Sponsored Brands.    |\n","|New metrics available   |When you create and download a bulksheets file, you can now see CPC, ROAS, and Conversation Rate to facilitate bid optimization.    |\n","|Date format    |In the new bulksheets, the date format must be entered as YYYYMMDD, so February 25, 2022 would be entered as 20220225. July 12, 2023 would be 20230712.     |\n"],"documentType":"guide"},{"title":"Bulksheets migration guide","sectionHeader":{"type":2,"text":"Tips and guidelines"},"path":"/en-us/no-code-tools/bulksheets/migration-guide","content":["|grid orangeTips for using 2.0    |Important details    |\n","\\|---    \\|---    \\|\n","|Brand assets data for Sponsored Brands    |When you download a bulksheets file from the \"Bulk operations\" page, you will see a checkbox that will exclude brand assets data. If you want to see brand assets for your Sponsored Brands campaigns, you should uncheck this box.     |\n","|Updating keywords    |If you want to change the keywords associated with a campaign, you can do this in a single bulksheets upload: For the keywords you want to remove, set the \"Operation\" field to archive and include the Keyword IDs. In that same sheet, you can add new keywords using create in the \"Operation\" field and entering new ones in the \"Keyword Text\" field.      |\n","|Add multiple ad groups in Sponsored Products campaigns    |You can add multiple ad groups under a single Sponsored Products campaign to make it easier to group your ads by category, season, or any other attribute. This is not possible in the advertising console.     |\n","|Read-only fields    |Fields marked as read-only are not important when you are creating a new campaign, and they cannot be edited. But these fields can be helpful when you review downloaded campaign data. For example, there is a read-only \"Campaign ID\" field. If you wanted to view all keywords associated with that campaign, you could filter by Campaign ID to see only the keywords used in that campaign.      |\n"],"documentType":"guide"},{"title":"Bulksheets migration guide","sectionHeader":{"type":2,"text":"Known issues and workarounds"},"path":"/en-us/no-code-tools/bulksheets/migration-guide","content":["|grid orangeKnown issues    |Workarounds    |\n","\\|---    \\|---    \\|\n","|Campaign negative keywords cannot be paused     | For any campaign negative keywords that you want to delete or no longer use, you should set the \"Operation\" to be Archive. Note that archiving a campaign negative keyword will also delete the keyword from all records.\n","|Commas and symbols are not supported in numbers    |When writing numbers, do not use commas or symbols such as % or $. For example, one-thousand five hundred should be written as 1500. Fifty percent would be written as 50.\n","|Keyword limitation for Sponsored Brands    |For Sponsored Brands only: When creating campaigns, 100 keywords is the maximum allowed limit. If you enter more than 100 keywords, you will see an error after you upload the bulksheets file. When updating campaigns, you can add as many keywords as you want. A workaround for the keyword limitation is to submit two bulksheets uploads: First, create the campaign using just one or a few keywords. Then, after the file uploads, submit an additional upload for that same campaign using the update operation. In the updated file, you can add as many keywords as you want to the campaign.     |\n","|Sponsored Brands performance data by placement is not available     |Use the legacy version of Bulksheets to see placement-specific performance data for Sponsored Brands.     |\n"],"documentType":"guide"},{"title":"Bulksheets migration guide","sectionHeader":{"type":2,"text":"Side-by-side comparisons"},"path":"/en-us/no-code-tools/bulksheets/migration-guide","content":[" The table below shows a comparison of the column headers in the legacy version of bulksheets and the new version so you can see how the legacy column data maps to the new version for Sponsored Products and Sponsored Brands. We did not include a comparison for Sponsored Display because that campaign type was not supported in legacy bulksheets.  \n"],"documentType":"guide"},{"title":"Bulksheets migration guide","sectionHeader":{"type":3,"text":"Sponsored Products"},"path":"/en-us/no-code-tools/bulksheets/migration-guide","content":["|grid orangeLegacy column header    |Equivalent header in new bulksheets    |Tips    |\n","\\|---    \\|---    \\|---    \\|\n","|Record ID    |This field no longer exists in the new bulksheets. Instead, each entity now has its own ID column: Campaign ID, Portfolio ID, Product ad ID,  Ad group ID, and so on.    |When you create a new entity, Amazon will generate its ID. Then, you can find the ID when you download a bulksheets file with campaign data.    |\n","|Record Type    |Entity    |The entity you are creating or updating. For example, campaign, ad group, keyword, and so on.    |\n","|Campaign ID    |Campaign Id    |When creating a new campaign, enter a text-based name. When updating a campaign, enter the Amazon-generated ID.    |\n","|Campaign    |Campaign Name    |Enter a text-based campaign name.     |\n","|Campaign Daily Budget    |Daily Budget    |Do not use commas when formatting numbers. Use periods only.     |\n","|Portfolio ID    |Portfolio Id    |To associate a new campaign with an existing portfolio, enter the ID in this field when you define the campaign entity. You cannot create new portfolios with bulksheets at this time.      |\n","|Campaign Start Date    |Start date    | Format is YYYYMMDD. Be sure the start date occurs in the future, or you will get an error. This sometimes happens when you set the date to the current time, but you do not upload the bulksheets file until later.     |\n","|Campaign End Date    |End date    | Optional if you want the campaign to run indefinitely. If used, the format is YYYYMMDD.    |\n","|Campaign Targeting Type    |Targeting Type    |For Sponsored Products campaigns, this is either manual or auto.     |\n","|Ad Group    |Ad Group Name    |    |\n","|Max Bid    |This field is split into separate columns now: Ad Group Default Bid and Bid (for keywords and targeting).     |If the Bid column is left blank for a keyword or targeting entity, the Ad Group Default Bid will be applied.   For example, if you want all keywords within an ad group to have the same bid, you can leave the Bid column blank for those keyword rows and have the Ad Group Default Bid apply to the child entities.     |\n","|Keyword or Product Targeting    |This field is split into separate columns now: Keyword Text and Product Targeting Expression.     |    |\n","|Product Targeting ID    |Product Targeting Id    |You can get this ID, and all entity IDs, in a downloaded bulksheets file with past campaign data.    |\n","|Match Type    |Match Type    |This field is only used when creating a keyword entity.    |\n","|SKU/ASIN    |In the new bulksheets, you will see separate columns for SKU and ASIN.     |You should enter data into one of these fields and leave the other blank, depending on whether you are a vendor (use ASIN) or a seller (use SKU).     |\n","|Campaign Status    |State    |In new bulksheets, you will use the same State column for each entity you create to set the status. For Campaign Status in the new bulksheets, use the State field in the row where you are creating the Campaign entity.     |\n","|Ad Group Status    |State    |Similar to the above: In the row where you are creating an Ad Group, use the State field to define status.     |\n","|Status    |State    |Enter enabled if you want the entity to be live after you upload the file. Other options include paused and archived.    |\n","|Bidding strategy    |Bidding Strategy    | Set at the campaign level. Can be dynamic bids - down only, dynamic bids - up and down, or fixed bid   |\n","|Placement Type    |Placement    |    |\n","|Increase bids by placement    |Percentage    |Do not use symbols such as %. For example, 50% would be entered as 50.    |\n"],"documentType":"guide"},{"title":"Bulksheets migration guide","sectionHeader":{"type":3,"text":"Sponsored Brands"},"path":"/en-us/no-code-tools/bulksheets/migration-guide","content":["|grid orangeLegacy column header    |Equivalent header in new version    |Tips    |\n","\\|---    \\|---    \\|---    \\|\n","|Record ID    |This is replaced by the individual entity IDs (Campaign ID, Keyword ID, and so on).    |When you create a new entity, Amazon will generate its ID. Then, you can find the ID when you download a bulksheets file with campaign data.    |\n","|Record Type    |Entity    |The entity you are creating or updating. For example, campaign, ad group, keyword, and so on.    |\n","|Campaign ID    |This is split up into 2 columns; the \"Campaign Id\" column is for submitted SB campaigns the \"Draft Campaign Id\" column is for draft campaigns.    |When creating a new campaign, enter a text-based name. When updating a campaign, enter the Amazon-generated ID.    |\n","|Campaign    |Campaign Name    |Enter a text-based campaign name.     |\n","|Campaign Type    |This column does not exist in the new bulksheets.     |This information is conveyed in the entity column. Submitted campaigns should be specified as \"Campaign\", whereas draft campaigns should be specified as \"Draft Campaign\".   |\n","|Ad Format    |Ad Format    |Ad format options in bulksheets include \"Product Collection\" and \"Video\". Bulksheets does not support \"Store Spotlight\" currently.    |\n","|Budget    |Budget    |Do not include any symbols such as percent, dollar sign, or commas. Use numbers and periods only.    |\n","|Portfolio ID    |Portfolio Id    |Used only in the campaign entity. You can enter an ID if you want to associate the campaign with a portfolio. This field can only be used if you already have a portfolio in campaign manager--you cannot create new portfolios using bulksheets.    |\n","|Campaign Start Date    |Start date    |Format is YYYYMMDD. Be sure the start date occurs in the future, or you will get an error. This sometimes happens when you set the date to the current time, but you do not upload the bulksheets file until later.    |\n","|Campaign End Date    |End date    | Optional if you want the campaign to run indefinitely. If used, format is YYYYMMDD.    |\n","|Budget Type    |Budget Type    |    |\n","|Landing Page Url    |Landing Page Url    |When you create a SB campaign with Amazon Store or Custom URL landing page type, this defines the landing page URL. Do not use this field to create a new landing page. Use the Landing Page ASINs field instead.    |\n","|Landing Page ASINs    |Landing Page ASINs    |When you create a campaign with a new landing page, this field defines which products are shown on the page.     |\n","|Brand Name    |Brand Name    |    |\n","|Brand Entity ID    |Brand Entity Id    |For sellers only. This field was optional in legacy bulksheets, but is now required in the new version. Each asset (video or picture) has an associated Brand Entity ID, which you should copy from the Brand Assets Data Excel sheet when creating new Sponsored Brands campaigns.    |\n","|Brand Logo Asset ID    |Brand Logo Asset Id    |If you need this ID, be sure to include brand assets data when you download a bulksheets file.    |\n","|Headline    |Creative Headline    |    |\n","|Creative ASINs    |Creative ASINs    |    |\n","|Media ID    |Video Media Ids    |    |\n","|Automated Bidding    |Bid Optimization    |    |\n","|Bid Multiplier    |Bid Multiplier    |    |\n","|Ad Group    |This column does not exist in the new bulksheets.    |This field was removed entirely, because Ad Groups are automatically created and managed by the Sponsored Brands service.    |\n","|Max Bid    |Bid    |The meaning is the same: This is the CPC amount you are willing to pay when a shopper clicks your ad. As with all number formatting in the new bulksheets, do not use symbols or commas.     |\n","|Keyword    |Keyword Text    |Enter one keyword or phrase per row. To enter more keywords, add a new entity for each keyword.    |\n","|Match Type    |Match Type    |    |\n","|Campaign Status    |State    |The \"State\" column now defines the status for each entity.    |\n","|Ad Group Status    |This column does not exist in the new bulksheets.    |This field was removed entirely, because Ad Groups are automatically created and managed by the Sponsored Brands service.    |\n","|Status    |State    |Enter enabled if you want the entity to be live after you upload the file. Other options include paused and archived.    |\n","|Placement Type    |This column does not exist in the new bulksheets.    |Placement-level performance data will be supported in the future.    |\n"],"documentType":"guide"},{"title":"Additional examples of Sponsored Brands multi-ad group campaigns","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/examples","content":[" This article provides additional examples of what a bulk spreadsheet might look like for various Sponsored Brands multi-ad group campaign types, including the different ad formats and targeting types. For a more general overview, see this Overview of Sponsored Brands multi-ad group campaign in bulksheets. For in-depth guidance on creating campaigns, see the guide on How to create Sponsored Brands multi-ad group campaigns.\n"],"documentType":"guide"},{"title":"Additional examples of Sponsored Brands multi-ad group campaigns","sectionHeader":{"type":2,"text":"Examples of  multi-ad group campaigns in bulksheets "},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/examples","content":[" The table below represents a bulksheets file. In the table, you can see the required fields that you must complete in the spreadsheet to create each entity—including the ad formats described here. \n"," NOTE: To save space, we have removed the “Informational only” fields from the example spreadsheets below. You can see where these fields would appear by observing the column header letters. For example, notice that Column S (Brand Entity ID) skips to Column AC—this is because several of the informational fields in that area have been removed.  \n"],"documentType":"guide"},{"title":"Additional examples of Sponsored Brands multi-ad group campaigns","sectionHeader":{"type":3,"text":"Create new Campaign with a Manual Collection ad"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/examples","content":[" Notes about this campaign:\n","Manual Collection ads let you feature 3–10 related products you choose from your catalog  The Creative ASINs field contains the 3–10 ASINs you want to feature in your collection  The Ad Title field is optional (maximum 32 characters). If left blank, Amazon will auto-generate a title  The Landing page type can be Product list (Amazon creates a landing page with your ASINs) or Store (use your Brand Store page)  Custom images are not supported for collection ads — leave the Custom images field blank\n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|BG\t|BH\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Product Exclusions\t|Ad Title\t|Sites\t|\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|New Campaign\t|\t|\t|\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Amazon Business\t|\n","|Sponsored Brands\t|Ad group\t|Create\t|New Campaign\t|\t|New Ad Group\t|\t|\t|\t|\t|New Ad Group\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Manual Collection ad\t|Create\t|New Campaign\t|\t|New Ad Group\t|\t|\t|\t|\t|\t|My Collection Ad\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/23F9CB2E\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|\t|B00K7M3T8Q, B09NXWL4HP, B07DFGR2YZ, B0CRJ5V8KN, B08PQLM7FW\t|\t|\t|\t|Summer Essentials\t|\t|\n","|Sponsored Brands\t|Keyword\t|Create\t|New Campaign\t|\t|New Ad Group\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|2\t|\t|\t|summer essentials\t|Phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"Additional examples of Sponsored Brands multi-ad group campaigns","sectionHeader":{"type":3,"text":"Create new Campaign with an Auto Collection ad"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/examples","content":[" Notes about this campaign:\n","Auto Collection ads let Amazon AI dynamically group the most relevant products from your catalog  You do not need to provide Creative ASINs — Amazon selects them automatically  The Product Exclusions field is optional — use it to prevent specific ASINs from appearing in the auto-curated collection (maximum 1,000 ASINs)  The Ad Title field should be left blank — Amazon auto-generates a title  Leave Landing page URL blank — Amazon auto-generates the landing page\n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|BG\t|BH\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Product Exclusions\t|Ad Title\t|Sites\t|\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|New Campaign\t|\t|\t|\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Amazon Business\t|\n","|Sponsored Brands\t|Ad group\t|Create\t|New Campaign\t|\t|New Ad Group\t|\t|\t|\t|\t|New Ad Group\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Auto Collection ad\t|Create\t|New Campaign\t|\t|New Ad Group\t|\t|\t|\t|\t|\t|My Auto Collection Ad\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|\t|\t|\t|\t|B0BNRV8H4J, B08WJDM6KT, B0CXLP3F7N, B07HZTQ9RW, B09KFML2YC\t|\t|\t|\n","|Sponsored Brands\t|Keyword\t|Create\t|New Campaign\t|\t|New Ad Group\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|2\t|\t|\t|wireless headphones\t|Phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"Additional examples of Sponsored Brands multi-ad group campaigns","sectionHeader":{"type":3,"text":"Create new Campaign with two Ad groups, a Video ad, and a Store spotlight ad"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/examples","content":[" Notes about this campaign:\n","Notice that the Campaign and Ad group IDs are included in all of their child entity rows  This example will create a new campaign, so we are using temporary, text-based IDs. When this campaign is uploaded and created, a system-generated ID will be created, which you would use to update the campaign later   The campaign Bid optimization is set to FALSE, so there is no need to create a custom Bidding adjustment by placement entity for this campaign. However, this entity could be added later if the performance metrics suggest a custom placement would be more optimal.  When you create a Store spotlight ad, you can include three sub-pages from your Store, and an image to best represent each page. In bulksheets, use the following formula in the Sub-pages field of the Store spotlight ad row, replacing the asin values, page title, and URL with your information: {\"asin\":\"B07SBHTQMC\",\"pageTitle\":\"MyDisplayName\",\"url\":\"www.amazon.com/stores/page/MyStore1\"},{\"asin\":\"B0058DKFBS\",\"pageTitle\":\"My DisplayName2\",\"url\":\"www.amazon.com/stores/page/MyStore2\"},{\"asin\":\"B07RF9GMBY\",\"pageTitle\":\"MyDisplayName3\",\"url\":\"www.amazon.com/stores/page/MyStore3\"}  Tip: In the UI, the Store spotlight ad page title is the “Display name.” The asin is the image you want to display. And the URL is the actual URL of your store page. \n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Sites    |\n","|Sponsored Brands\t|Campaign\t|Create\t|Campaign example 1\t|\t|\t|\t|\t|\t|Campaign example 1\t|\t|\t|\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Amazon Business    |\n","|Sponsored Brands\t|Ad group\t|Create\t|Campaign example 1\t|\t|Ad group example 1\t|\t|\t|\t|\t|Ad group example 1\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Video ad\t|Create\t|Campaign example 1\t|\t|Ad group example 1\t|\t|\t|\t|\t|\t|Video ad name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/dp/B08CK9FVB9\t|\t|Detail Page\t|\t|\t|\t|\t|\t|\t|B08CK9FVB9\t|amzn1.assetlibrary.asset1.735ec75f93ae1d0704411a3fc2aeff83:version_v1\t|\t|    |\n","|Sponsored Brands\t|Keyword\t|Create\t|Campaign example 1\t|\t|Ad group example 1\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|1.47\t|\t|\t|dogs collars for large dogs\t|Phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|Create\t|Campaign example 1\t|\t|Ad group example 2\t|\t|\t|\t|\t|Ad group example 2\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Store spotlight ad\t|\t|Campaign example 1\t|\t|Ad group example 2\t|\t|\t|\t|\t|\t|Store spotlight ad name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|www.amazon.com/stores/page/MyStore1\t|\t|Store\t|Store spotlight brand\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|Store spotlight headline\t|\t|\t|{\"asin\":\"B07SBHTQMC\",\"pageTitle\":\"BeautyFit Store\",\"url\":\"www.amazon.com/stores/page/MyStore2\"},{\"asin\":\"B0058DKFBS\",\"pageTitle\":\"Cleansing & Digestion\",\"url\":\"www.amazon.com/stores/page/MyStore3} |    |\n"],"documentType":"guide"},{"title":"Additional examples of Sponsored Brands multi-ad group campaigns","sectionHeader":{"type":3,"text":"Create new Campaign with Brand video ad and Product targeting"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/examples","content":[" Notes about this campaign:\n","A Brand video ad is essentially a Video ad with a Store on Amazon as its landing page  Notice that in the “Brand video ad” row, there is an optional field titled Brand logo crop (Col AY). This field allows you to apply a crop or resize to your logo, using the desired pixel values. You should leave this field blank unless you know the exact dimensions that you need—or, if you are cloning an existing campaign and want to reuse a cropped image that you have the dimensions for.  The creative assets—including Video asset IDs and Brand asset logo IDs—can be found in a downloaded bulksheets file. When you get a bulksheets file from the bulk operations homepage(, be sure to check the box to include “Brand assets data,” and this tab will contain all IDs from your creative assets library. You can also copy or clone your existing Sponsored Brands campaigns to create new ones using the same assets.   For the Product targeting entity row, notice that the Product targeting expression field indicates product category targeting. If you wanted individual\\* product targeting, the category= value would be asin= instead.\n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Sites    |\n","|Sponsored Brands\t|Campaign\t|Create\t|Campaign example 1\t|\t|\t|\t|\t|\t|Campaign example 1\t|\t|\t|\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Amazon Business    |\n","|Sponsored Brands\t|Ad group\t|Create\t|Campaign example 1\t|\t|Ad group example 1\t|\t|\t|\t|\t|Ad group example 1\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Brand video ad\t|Create\t|Campaign example 1\t|\t|Ad group example 1\t|\t|\t|\t|\t|\t|My brand video ad\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/BF7D4D7A-F099-4F46-9121-70690ABAD03E\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|My creative headline\t|B0BM1YWSML, B0BM1MRMWX, B0BLZSSPL2\t|amzn1.assetlibrary.asset1.735ec75f93ae1d0704411a3fc2aeff83:version_v1\t|\t|    |\n","|Sponsored Brands\t|Product targeting\t|Create\t|Campaign example 1\t|\t|Ad group example 1\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|5.69\t|\t|\t|\t|\t|\t|\t|category=\"2975362011\"\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n"],"documentType":"guide"},{"title":"Additional examples of Sponsored Brands multi-ad group campaigns","sectionHeader":{"type":3,"text":"Create an additional Ad group with a Product collection ad in an existing Campaign"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/examples","content":[" Notes about this campaign:\n","Notice that since this is an existing campaign, there are system-generated unique IDs for the entities that already existed. For the new Ad group and Product collection ad (in bold), the parent Campaign ID is included to indicate that these new entities belong to this Campaign   For the new Ad group, a text-based temporary ID is used, which becomes a unique ID once the Ad group is created   The new Ad group and Product collection ad are the only fields that contain an Operation value because those are the only fields where a change is taking place. The other fields where the Operation is blank will be ignored when this file is uploaded \\* For the Landing page type, you can leave this field blank, and the default will be a new landing page that the system creates for you with the products (asins) you provide in the spreadsheet. In this example, the value Store is entered, which also includes the asins (Column BB) and sub-pages (Column BE). The next example shows how to create a Product collection ad with a Product list instead of a Store. \n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Sites    |\n","|Sponsored Brands\t|Campaign\t|\t|292142424756096\t|\t|\t|\t|\t|\t|Campaign Name\t|\t|\t|20231101\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|292142424756096\t|\t|362003785216748\t|\t|\t|\t|\t|Ad Group Name\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Store spotlight ad\t|\t|292142424756096\t|\t|362003785216748\t|465625743252508\t|\t|\t|\t|\t|Ad Name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/6F75E0CE-7A0B-4068-99F4-EAE6D1CDDD77\t|\t|Store\t|Store spotlight brand\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|My creative headline\t|B00AIZBMPY, B07CMFYR77, B074MDFZB1\t|\t|{\"asin\":\"B07SBHTQMC\",\"pageTitle\":\"BeautyFit Store\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/56A2B6B1-3870-4ACD-9368-B6CA6F8AA3D4\"},{\"asin\":\"B0058DKFBS\",\"pageTitle\":\"Cleansing & Digestion\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/94991DEE-76EC-490B-B636-181E4E434B2C\"},{\"asin\":\"B07RF9GMBY\",\"pageTitle\":\"Women's Health\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/C6B05EF3-1EC5-4E5B-99A8-9EB2139F599D\"}\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|292142424756096\t|\t|362003785216748\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|2\t|\t|\t|dog bowl\t|Phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|Create\t|292142424756096\t|\t|New Ad Group 123\t|\t|\t|\t|\t|New Ad Group 123\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|3\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Product collection ad\t|Create\t|292142424756096\t|\t|New Ad Group 123\t|\t|\t|\t|\t|\t|New ad name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/287C0BF2-CBB8-47A0-8667-5FF0B3678722\t|\t|Product list\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|My Other Headline\t|B087TC4NBL, B00FZN1KWE, B07B3VQ8DY\t|\t|\t|    |\n"],"documentType":"guide"},{"title":"Additional examples of Sponsored Brands multi-ad group campaigns","sectionHeader":{"type":3,"text":"Create a new Campaign  with a Product collection ad that uses a Product list landing page"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/examples","content":["|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Sites    |\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|New Campaign\t|\t|\t|\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Amazon Business    |\n","|Sponsored Brands\t|Ad group\t|Create\t|New Campaign\t|\t|New Ad Group\t|\t|\t|\t|\t|New Ad Group\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Product collection ad\t|Create\t|New Campaign\t|\t|New Ad Group\t|\t|\t|\t|\t|\t|New ad name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/287C0BF2-CBB8-47A0-8667-5FF0B3678722\t|\t|Product list\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|New Headline\t|B087TC4NBL, B00FZN1KWE, B07B3VQ8DY\t|\t|\t|    |\n","|Sponsored Brands\t|Keyword\t|Create\t|New Campaign\t|\t|New Ad Group\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|2\t|\t|\t|Cat toys\t|Phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" This article explains the most common bulksheets errors, and provides guidance on how to interpret and resolve these errors. The content is divided into sections based on the error category.\n"," Jump to ID-related | Invalid values | Missing values | Duplicates | Limits | Targeting expressions | Audience IDs | Header and structural errors | Server errors | Other common error messages\n"," When you upload a bulksheets file on the bulk operations home page, you will see a notification in the UI if any errors occurred during the upload process. In the \"Bulk spreadsheet history\" section of the page, the status will read \"Finished with errors\" if any are present, and you can then download an error report to troubleshoot:\n"," The report will contain two tabs\\*: one labeled \"Upload Processing Summary,\" and the other labeled with the sponsored ads campaign type (note that if you were updating more than one campaign type, your report would contain additional tabs for each campaign type). The \"Upload Process Summary\" tab will show the row numbers where the errors occurred, along with an error message to help you troubleshoot.\n"," Here is a sample excerpt from this tab:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows (See note below)\t|\n","|3\t|Input Error\t|Missing Parent ID\t|Invalid value for column: \"Campaign ID\", which can't be found  in any parent entity row\t|\n","|5\t|Input Error\t|Duplicate Text\t|Duplicate \"Keyword Text\", which is the same as row 4\t|\n"," Generally, columns A and D are the most helpful because they indicate where the error occurred and provide more information about what happened: The Original record # is the row number where that particular error occurred, and the Error message will give you more details. Note: This exact same information is also available in the campaign tab, if you scroll all the way over to the far right of the sheet. The error messages will appear in the rows where the errors occurred.\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":2,"text":"ID-related errors"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" A common cause of errors in bulksheets is related to entity IDs—in particular, the Campaign IDs and Ad group IDs. When you create a new campaign from scratch, you must include temporary, text-based IDs for these entities. When you upload the campaign, the temporary IDs will become numeric, system-generated ones that you can find in a downloaded bulksheets file. To update a campaign after it is created, you will use the system-generated IDs.\n","|Error message\t|Notes\t|\n","|---\t|---\t|\n","|Invalid value for column: \"Campaign ID\", which can't be found in any parent entity row\t|This error typically means you have input a Campaign ID value in a child entity row that does not match a parent Campaign ID. A common cause is if you make a typo in one of the child entity rows. For example, if you are creating a new campaign with the temporary ID Spring toys, you would need to input that exact same temporary ID in all child entity rows. If the ID in a child entity row does not match exactly, you will get this error. \t|\n","|Invalid value for column: \"Ad Group ID\", which can't be found in any parent entity row\t|Similar to Campaign ID, you must enter a temporary, text-based value for the Ad Group ID when you create a new one. This same Ad Group ID must be included in all child entity rows of the ad group. You will get an error if these IDs do not match exactly. \t|\n","|This Create operation requires you to specify a temporary \"Campaign ID\" (any non-numeric text)\t|This error typically means you have entered a numeric value in the Campaign ID field when creating a new campaign. To create a new campaign, specify a text-based temporary ID.\t|\n","|This Create operation requires you to specify a temporary \"Ad Group ID\" (any non-numeric text)\t|This error typically means you have entered a numeric value in the Ad group ID field when creating a new ad group. To create a new ad group, specify a text-based temporary ID.\t|\n","|This Update operation requires you to specify an actual \"Campaign ID\", rather than a temporary ID\t|This error implies you have entered an alphabetic value for the Campaign ID in a campaign that already exists. Existing campaign IDs will be numeric, with no letters. Check the ID in a downloaded bulksheets file, and re-enter the correct ID. Be sure you are using the bulksheets download ID—not the ID found in the advertising console.\t|\n","|This Update operation requires you to specify an actual \"Ad Group ID\", rather than a temporary ID\t|Similar to the note above, be sure to enter the actual ID for ad groups that already exist, and use the ID found in bulksheets—not the ID from the advertising console. \t|\n","|Parent entity not found\t|This error relates to ad group child entities—for example, keywords, product targets, product ads. It typically occurs when you try to create new child entities, but you use a parent ID that the system does not recognize. Learn more about parent-child relationships in the campaign entity diagrams\t|\n","|Could not find keyword with id: OBJECT_ID\t|For all of the OBJECT_ID messages in the rows below, this error occurs when you enter an entity ID value that does not exist in the system. Check the ID in a downloaded bulksheets file, and re-enter the correct ID. Be sure you are using the bulksheets download ID—not the ID found in the advertising console.\t|\n","|Could not find targeting clause with id: OBJECT_ID\t|See note above\t|\n","|Could not find campaign with id: OBJECT_ID\t|See note above\t|\n","|Could not find ad group with id: OBJECT_ID\t|See note above\t|\n","|Could not find product ad with id: OBJECT_ID\t|See note above\t|\n","|Could not find negative keyword with id: OBJECT_ID\t|See note above\t|\n","|no campaign found\t|The Campaign ID referenced on this row does not match any existing campaign in your account. Verify the ID against a bulksheets download.\t|\n","|Invalid id provided.\t|This typically appears for portfolio assignments. There is no overlap between the Portfolios sheet and the other ad programs—you must first create the portfolio, then use the system-generated Portfolio ID on the campaign row.\t|\n","|EntityID does not exist.\t|See note above. Use a correct system-generated Portfolio ID on campaign rows.\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: typo in a temporary Campaign ID"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If you make a typo when specifying the temporary Campaign ID or Ad Group ID, child rows cannot be matched back to their parent. The example below also shows the cascading \"Not Processed\" warning that appears on rows blocked by an upstream error.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Springg\t|Outdoors\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Springg\t|Outdoors\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Springg\t|Indoors\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Indoors\t|\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|3\t|Input Error\t|Missing Parent ID\t|Invalid value for column: \"Campaign ID\", which can't be found in any parent entity row\t|\n","|4\t|Input Error\t|Missing Parent ID\t|Invalid value for column: \"Campaign ID\", which can't be found in any parent entity row\t|\n","|5\t|Input Error\t|Missing Parent ID\t|Invalid value for columns: Campaign ID, Ad Group ID, which can't be found in any parent entity row\t|\n","|6\t|Input Error\t|Missing Parent ID\t|Invalid value for column: \"Ad Group ID\", which can't be found in any parent entity row\t|\n"," Fix: Make sure the file contains all the necessary campaigns and ad groups, and that the temporary IDs match exactly across rows.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Outdoors\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Outdoors\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Indoors\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Indoors\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Indoors\t|\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: using a console ID instead of a bulksheets ID"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If you enter the ID from the advertising console (these usually start with \"A\"), you will get errors. Update operations require the numeric system-generated ID found in a bulksheets download. Note how using the console ID also cascades into \"Missing Parent ID\" errors on every child row that references it.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Update\t|A10224222RA856TNH1CKJ\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|A10224222RA856TNH1CKJ\t|Outdoors\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|A10224222RA856TNH1CKJ\t|Outdoors\t|\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Invalid ID\t|This Update operation requires you to specify an actual \"Campaign ID\", rather than a temporary ID\t|\n","|3\t|Input Error\t|Missing Parent ID\t|Invalid value for column: \"Campaign ID\", which can't be found in any parent entity row\t|\n","|4\t|Input Error\t|Missing Parent ID\t|Invalid value for column: \"Campaign ID\", which can't be found in any parent entity row\t|\n"," Fix: Use the numeric ID from the bulksheets download on every row that references the campaign.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Update\t|102059305939203\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|102059305939203\t|Outdoors\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|102059305939203\t|Outdoors\t|\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: temporary IDs on existing campaigns"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If you use temporary text-based IDs when adding child entities (keywords, ad groups, product ads, targets) to a campaign that already exists, the system cannot find the parent entity.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Outdoors\t|\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Missing Parent ID\t|Invalid value for columns: Campaign ID, Ad Group ID, which can't be found in any parent entity row\t|\n"," Fix: Use the system-generated Campaign ID and Ad Group ID from a bulksheets download.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Keyword\t|Create\t|102059305939203\t|4973859309586452\t|\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: wrong system-generated ID"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If you specify a system-generated ID that does not exist (for example, a typo in a Campaign ID, Ad Group ID, or Keyword ID), you will see \"Could not find\" errors. The example below also shows what happens when the Campaign ID is valid but the Ad Group ID is not — you will see \"no campaign found\" or \"Parent entity not found\".\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|Campaign Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Update\t|10000\t|\t|\t|Spring\t|\n","|Sponsored Products\t|Ad Group\t|Update\t|10000\t|20000\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Update\t|10000\t|20000\t|30000\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|10000\t|20000\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|102059305939203\t|20000\t|\t|\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Invalid User Input\t|Could not find campaign with id: 10000\t|\n","|3\t|Input Error\t|Invalid User Input\t|Could not find ad group with id: 20000\t|\n","|4\t|Input Error\t|Invalid User Input\t|Could not find keyword with id: 30000\t|\n","|5\t|Input Error\t|Invalid User Input\t|no campaign found\t|\n","|6\t|Input Error\t|Invalid User Input\t|Parent entity not found\t|\n"," Fix: Verify the IDs by downloading a bulksheets file and finding the campaign by name. Then re-upload with the correct system-generated IDs.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|Campaign Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Update\t|102059305939203\t|\t|\t|Spring\t|\n","|Sponsored Products\t|Ad Group\t|Update\t|102059305939203\t|4973859309586452\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Update\t|102059305939203\t|4973859309586452\t|7329582756923785\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|102059305939203\t|4973859309586452\t|\t|\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: invalid Portfolio ID"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" There is no overlap between the Portfolios sheet and the other ad programs. You must first create the portfolio, then use the system-generated Portfolio ID on the campaign row.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|Portfolio A\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Fall\t|50000\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Invalid User Input\t|Invalid id provided.\t|\n","|3\t|Input Error\t|Invalid User Input\t|EntityID does not exist.\t|\n"," Fix: Use the correct system-generated Portfolio ID on each campaign row.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|5286920683018423\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Fall\t|9478385734910328\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":2,"text":"Invalid values"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" For invalid value errors, the solution is typically simple: You should fix the value, save, and re-upload your file. Most values are not case sensitive, but must be spelled correctly.\n","|Error message\t|Notes\t|\n","|---\t|---\t|\n","|Keyword is invalid\t|This error typically means you included invalid characters in the keyword field. Review the keyword character constraints guide for more information\t|\n","|Invalid value: \"VALUE\" for column: \"Bid\"\t|Bid values should be numeric, and the bid limits vary by marketplace. \t|\n","|Invalid value: \"#VALUE!\" for column: \"Bid\"\t|This and the next three rows almost always indicate an Excel formula error in the bid column. You used a formula to calculate the bid and the formula failed. Fix the formula, or replace the cell with a numeric bid value (for example, 0.85).\t|\n","|Invalid value: \"#N/A\" for column: \"Bid\"\t|See note above\t|\n","|Invalid value: \"#REF!\" for column: \"Bid\"\t|See note above\t|\n","|Invalid value: \"NAN\" for column: \"Bid\"\t|See note above\t|\n","|Invalid value: \"Exact\" for column: \"Match Type\"\t|This often means you used a positive match type (exact, phrase, broad) on a negative keyword row, or a negative match type (negative exact, negative phrase) on a positive keyword row. See the row below for valid values per row type.\t|\n","|Invalid value: \"archived\" for column: \"State\"\t|archived is not a valid State when creating a row. To remove an entity, set Operation to Archive rather than setting State to archived. May also indicate a typo (for example, enbled instead of enabled).\t|\n","|Invalid value: \"VALUE\" for column: \"Match Type\"\t|\"Match type\" is relevant for keyword targeting. For Sponsored Products manual targeting and Sponsored Brands campaigns, options are  broad, phrase, or exact. For negative keywords, options are negative exact or negative phrase. These values are not case sensitive but must be spelled correctly. A common cause is using a positive match type on a negative keyword row, or vice versa.\t|\n","|Invalid value: \"VALUE\" for column: \"State\"\t|The \"State\" field is the status of the entity in that row. Options are enabled, paused, or archived. Note: archived is not a valid state when using the Create operation.\t|\n","|Invalid value: \"VALUE\" for column: \"Bidding Strategy\"\t|Options include Dynamic bids - down only, Dynamic bids - up and down, or Fixed bid. These values are not case sensitive but must be spelled correctly. Note that the \"Bidding strategy\" is defined in the \"Campaign\" entity row. \t|\n","|Invalid product: \"PRODUCT_INPUT\"\t|In bulksheets, the \"Product\" field is the campaign type. The value must be either Sponsored Products, Sponsored Brands, or Sponsored Display, or Portfolios. The field is not case-sensitive, but you will get an error if you misspell or make a typo. \t|\n","|Invalid entity: \"ENTITY_INPUT\"\t|The \"Entity\" field is the campaign component. Common examples of entities include Campaign, Ad group, Keyword, Product ad, Negative product targeting, etc. \t|\n","|Invalid operation: \"OPERATION_INPUT\"\t|The \"Operation\" field is the action you want to take in this row. Values must be either Create, Update, or Archive. Note that if you want to pause an entity, you should set this field to \"Update,\" and change the \"State\" field to paused for the entity row you want to pause. \t|\n","|Campaign name has invalid characters\t|Be sure to use only valid characters in campaign names. Read more about which characters are valid. Sometimes there are special characters that are hard to find (for example, invisible spaces). If the name looks valid but still produces this error, try retyping the text from scratch.\t|\n","|Ad group name has invalid characters\t|Be sure to use only valid characters in ad group names. Read more about which characters are valid. \t|\n","|Invalid value: INVALID_DATE_INPUT specified for field: Start Date, the correct date format is yyyyMMdd\t|The date must be entered as year-month-day in the format yyyyMMdd. So July 12, 2024 would be entered as: 20240712\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: Excel formula error in the Bid column"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Bid\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Outdoors\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Outdoors\t|#VALUE!\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2-3\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|4\t|Input Error\t|Invalid User Input\t|Invalid value: \"#VALUE!\" for column: \"Bid\"\t|\n"," Fix: Replace the Excel formula with a valid numeric bid (for example, 0.85), or correct the formula so it resolves to a number.\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: invalid keyword characters"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" The keyword 100% cotton is invalid because % is not a valid keyword character.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword Text\t|Match Type\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Keyword\t|Create\t|10000\t|20000\t|100% cotton\t|Exact\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Invalid user input\t|Keyword is invalid\t|\n"," Fix: Remove or replace the invalid character.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword Text\t|Match Type\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Keyword\t|Create\t|10000\t|20000\t|100 cotton\t|Exact\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":2,"text":"Missing values"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" A \"missing value\" error can occur for various entities. To fix these errors, the typical solution is to simply add the missing value in the appropriate field. Remember to check the \"Original record #\" value in Column A of the error report (not shown below) to see which row the error occurred in.\n","|Error message\t|Notes\t|\n","|---\t|---\t|\n","|Missing value for column:  \"State\"\t|All entity rows require a \"State\" value. The only exception is the Bidding adjustment row, where this field can be left blank. \t|\n","|Missing value for column: \"Campaign ID\"\t|The Campaign ID is required for every row in your spreadsheet. For the campaign and all child entities (for example, ad group, keyword, product ad), the IDs must match exactly in order to place those child entities into the parent campaign. \t|\n","|Missing value for column: \"Ad Group ID\"\t|The Ad group ID is required for every row in your spreadsheet, other than the \"Campaign\" row. For the ad group and all child entities (for example, keyword, product ad), the IDs must match exactly in order to place those entities into the parent ad group. \t|\n","|Missing value for column: \"Keyword ID\"\t|To update any entity, you must enter the system-generated ID found in a bulksheets download. So for example, to update a keyword bid, you would need to include the Keyword ID. \t|\n","|Missing value for column: \"Ad ID\"\t|To update or archive a product ad, the system-generated Ad ID must be present. Find it in a bulksheets download.\t|\n","|Missing value for column: \"Product Targeting ID\"\t|To update or archive a product target, the system-generated Product Targeting ID must be present. Find it in a bulksheets download.\t|\n","|Missing value for column: \"Keyword Text\"\t|When creating a keyword or negative keyword, the Keyword Text column is required. Fill in the keyword text and re-upload.\t|\n","|Missing value for column: \"Product Targeting Expression\"\t|When creating a product targeting or negative product targeting entity, the Product Targeting Expression column is required (for example, asin=\"B000000000\").\t|\n","|Missing value for columns: Campaign ID, Ad Group ID\t|If multiple values are missing, you will see an error message that mentions all missing values. \t|\n","|Missing value for column: \"Match Type\"\t|To create a Sponsored Products manual targeting campaign, or a Sponsored Brands keyword campaign, you must include the keyword match type. Options for keywords include broad, phrase, or exact. Options for negative keywords include negative exact or negative phrase.\t|\n","|Missing value for column: \"Ad Group Default Bid\"\t|For Sponsored Products campaigns, to create a new ad group, you need to specify a default bid in this row. This default bid amount will apply to all child entities of this ad group if you do not define bids for the child entities explicitly. For instance, if a keyword child entity does not include a defined bid, this default amount would apply.\t|\n","|Missing value for column: \"Ad group name\"\t|All ad groups—as well as campaigns—must have unique names. If you leave the \"Name\" field blank, you will get an error. \t|\n","|Missing value for column: \"Campaign Name\"\t|All campaigns must have a name. If you leave the \"Campaign Name\" field blank when creating a campaign, you will get an error. Fill in the missing value and re-upload.\t|\n","|Product ad did not specify sku for create operation.\t|To create a product ad, you must specify the SKU for the product you want to advertise. If you are a vendor, enter the ASIN.\t|\n"," For example, given the following downloaded bulksheets data, the keyword on row 3 inherits the Ad Group Default Bid of 0.75, while the keyword on row 4 uses its explicit bid of 0.85:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|Ad Group Default Bid\t|Bid\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|\t|10000\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|\t|10000\t|20000\t|\t|0.75\t|\t|\n","|Sponsored Products\t|Keyword\t|\t|10000\t|20000\t|30000\t|\t|blank\t|\n","|Sponsored Products\t|Keyword\t|\t|10000\t|20000\t|30001\t|\t|0.85\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: missing Campaign Name"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" When creating a new campaign, the Campaign Name column must be filled in.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Campaign Name\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Missing parent ID\t|Missing value for column: \"Campaign Name\"\t|\n"," Fix: Fill in the missing value.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Campaign Name\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|Spring\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: missing ID columns"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If you forget to include the parent IDs on child entity rows, the system cannot match those rows to a parent.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|\t|Outdoor\t|\n","|Sponsored Products\t|Keyword\t|Create\t|\t|\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|3\t|Input Error\t|Missing Parent ID\t|Missing value for column: \"Campaign ID\"\t|\n","|4\t|Input Error\t|Missing Parent ID\t|Missing value for columns: Campaign ID, Ad Group ID\t|\n"," The fix depends on your intent:\n","Creating a new campaign: Specify the temporary Campaign ID and Ad Group ID on the Ad Group and Keyword rows.\n","Adding an ad group and keyword to an existing campaign: Specify the system-generated Campaign ID on the Ad Group and Keyword rows.\n","Adding a keyword to an existing ad group: Specify both the system-generated Campaign ID and Ad Group ID on the Keyword row.\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":2,"text":"Duplicate values"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" Many values cannot be duplicated, particularly within the same parent campaign. For example, you cannot have two ad groups with the exact same name within the same parent campaign. Entity IDs are also unique and cannot be duplicated within the same advertiser account. For example, in any given bulk spreadsheet, every Campaign ID and name should be unique. Note that in the error messages below, the ROW_NUMBER would contain a value to show which row the error is in.\n","|Error message\t|Notes\t|\n","|---\t|---\t|\n","|Duplicate Id for column: \"Ad Group ID\", which is the same as row ROW_NUMBER\t|This means you have used the exact same Ad group ID multiple times. To fix, you can create a new ad group within the existing campaign. Or, you can create a new campaign and new ad group. \t|\n","|Duplicate Id for column: \"Campaign ID\", which is the same as row ROW_NUMBER\t|This means you have used the exact same Campaign ID multiple times. If you are trying to create a new campaign, use a temporary text-based ID to create the entity. \t|\n","|Duplicate Id for column: \"Keyword ID\", which is the same as row ROW_NUMBER\t|The next two examples all indicate that you have input a duplicate ID value. When creating new keywords, product targets, and product ads, you should leave the ID field blank. After you create the entities, the IDs will be available in a downloaded bulksheet if you want to update these entities later. For example, to update a keyword bid, you would need the Keyword ID to be included in the sheet. \t|\n","|Duplicate Id for column: \"Product Targeting ID\", which is the same as row ROW_NUMBER\t|See note above\t|\n","|Duplicate Id for column: \"Ad ID\", which is the same as row ROW_NUMBER\t|See note above\t|\n","|Duplicate \"Keyword Text\", which is the same as row ROW_NUMBER\t|In any given ad group, the combination of keyword text and match type must be unique. \t|\n","|Duplicate \"Product Targeting Expression\", which is the same as row ROW_NUMBER\t|Within an ad group, each product targeting expression must be unique. Remove the duplicate row.\t|\n","|Campaign with name=CAMPAIGN_NAME already exists!\t|Within a single advertiser account, campaign names must be unique. \t|\n","|Campaign with name CAMPAIGN_NAME already exists with ID OBJECT_ID\t|Variant of the message above; provides the existing campaign ID. To update the existing campaign, switch the operation to Update and use the system-generated Campaign ID from a bulksheets download.\t|\n","|campaign with that name already exists\t|Lowercase variant of \"Campaign with name=... already exists!\". Same fix: rename the new campaign or update the existing one using its system-generated ID.\t|\n","|AdGroup with name=AD_GROUP_NAME already exists!\t|Within a single campaign, Ad group names must be unique. For this error and the campaign-related one above, the message typically provides the duplicate name so you can identify the issue quickly. \t|\n","|Ad group name already exists with same status\t|An ad group with the same name and same status already exists in this campaign. Rename the new ad group or update the existing one.\t|\n","|An entity with that name already exists\t|Generic variant of the duplicate-name errors above (campaign, ad group, or other named entity). Rename the entity or switch to the Update operation against the existing one.\t|\n","|Duplicates in entity name\t|Two or more rows in your spreadsheet attempt to create entities with the same name in the same parent. Make each name unique within its parent (campaign or ad group).\t|\n","|Targeting Clause name already exists with same status\t|A targeting clause with the same name and status already exists. Use Update with the existing clause's ID, or rename the new entry.\t|\n","|TargetingClause with campaignId=OBJECT_ID, adGroupId=OBJECT_ID, expressionType=MANUAL, expression=(TARGETING_EXPRESSION) already exists!\t|This error is often caused when you try to copy or clone a target from one campaign to another—or from one ad group to another. If you want to copy a keyword or product target into a new campaign or ad group, be sure to replace the IDs with temporary ones. Or, if you want to copy the targets into another existing campaign, change the IDs to match the new campaign. \t|\n","|NegativeTargetingClause with campaignId=OBJECT_ID, adGroupId=OBJECT_ID, expression=(TARGETING_EXPRESSION) already exists!\t|See note above\t|\n","|ProductAd with campaignId=OBJECT_ID, adGroupId=OBJECT_ID, asin=ASIN, sku=SKU already exists!\t|See note above\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: re-uploading an existing campaign name"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" Assume you have already successfully uploaded a Sponsored Products campaign with the data below:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Campaign Name\t|Ad Group Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|\t|Spring\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Outdoors\t|\t|Outdoors\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|Spring\t|Outdoors\t|\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Create\t|Spring\t|Outdoors\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Indoors\t|\t|Indoors\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|Spring\t|Indoors\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Indoors\t|\t|\t|\n"," If you re-upload the same file, you will see this error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Invalid user input\t|Campaign with name=Spring already exists!\t|\n","|3-8\t|Warning\t|Not Processed\t|This row was not processed due to the error in row #2\t|\n"," How to fix this error depends on your intent:\n"," 1\\. Creating a new campaign — change the campaign name to something unique (for example, Spring 2024):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Campaign Name\t|Ad Group Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring 2024\t|\t|Spring 2024\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring 2024\t|Outdoors\t|\t|Outdoors\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|Spring 2024\t|Outdoors\t|\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Create\t|Spring 2024\t|Outdoors\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring 2024\t|Indoors\t|\t|Indoors\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|Spring 2024\t|Indoors\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring 2024\t|Indoors\t|\t|\t|\n"," 2\\. Updating the existing campaign — change the operation to Update and use the system-generated IDs from a bulksheets download. Look up the existing campaign by name to find the correct IDs:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign Name\t|Ad Group Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Update\t|10000\t|\t|\t|\t|\t|Spring\t|\t|\n","|Sponsored Products\t|Ad Group\t|Update\t|10000\t|20000\t|\t|\t|\t|\t|Outdoors\t|\n","|Sponsored Products\t|Product Ad\t|Update\t|10000\t|20000\t|40000\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Update\t|10000\t|20000\t|\t|\t|50000\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Update\t|10000\t|30000\t|\t|\t|\t|\t|Indoors\t|\n","|Sponsored Products\t|Product Ad\t|Update\t|10000\t|30000\t|60000\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Update\t|10000\t|30000\t|\t|70000\t|\t|\t|\t|\n"," 3\\. Re-uploading after a partial failure — if your initial upload succeeded for the campaign but failed for some child rows (for example, missing SKUs on Product Ad rows), the campaign already exists. Re-upload only the failed rows using the system-generated Campaign ID and Ad Group ID from the original error report:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Campaign Name\t|Ad Group Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|10000\t|20000\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|10000\t|30000\t|\t|\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: same ID on multiple rows"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If you reuse the same entity ID on more than one row, every duplicate after the first is rejected. This applies across all entity types:\n","Same Campaign ID on multiple campaign rows 2. Same Ad Group ID on multiple ad group rows 3. Same Keyword ID on multiple keyword, campaign negative keyword, or negative keyword rows 4. Same Product Targeting ID on multiple product targeting or negative product targeting rows 5. Same Ad ID on multiple product ad rows\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Update\t|10000\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Campaign\t|Update\t|10000\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Campaign Negative Keyword\t|Update\t|10000\t|\t|\t|30000\t|\t|\n","|Sponsored Products\t|Campaign Negative Keyword\t|Update\t|10000\t|\t|\t|30000\t|\t|\n","|Sponsored Products\t|Ad Group\t|Update\t|10000\t|20000\t|\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Update\t|10000\t|20000\t|\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|Update\t|10000\t|20000\t|40000\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|Update\t|10000\t|20000\t|40000\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Update\t|10000\t|20000\t|\t|50000\t|\t|\n","|Sponsored Products\t|Keyword\t|Update\t|10000\t|20000\t|\t|50000\t|\t|\n","|Sponsored Products\t|Negative Keyword\t|Update\t|10000\t|20000\t|\t|60000\t|\t|\n","|Sponsored Products\t|Negative Keyword\t|Update\t|10000\t|20000\t|\t|60000\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Update\t|10000\t|20000\t|\t|\t|70000\t|\n","|Sponsored Products\t|Product Targeting\t|Update\t|10000\t|20000\t|\t|\t|70000\t|\n","|Sponsored Products\t|Negative Product Targeting\t|Update\t|10000\t|20000\t|\t|\t|80000\t|\n","|Sponsored Products\t|Negative Product Targeting\t|Update\t|10000\t|20000\t|\t|\t|80000\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|3\t|Input Error\t|Duplicate ID\t|Duplicate Id for column: \"Campaign ID\", which is the same as row 2\t|\n","|4\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|5\t|Input Error\t|Duplicate ID\t|Duplicate Id for column: \"Keyword ID\", which is the same as row 4\t|\n","|6\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|7\t|Input Error\t|Duplicate ID\t|Duplicate Id for column: \"Ad Group ID\", which is the same as row 6\t|\n","|8\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|9\t|Input Error\t|Duplicate ID\t|Duplicate Id for column: \"Ad ID\", which is the same as row 8\t|\n","|10\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|11\t|Input Error\t|Duplicate ID\t|Duplicate Id for column: \"Keyword ID\", which is the same as row 10\t|\n","|12\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|13\t|Input Error\t|Duplicate ID\t|Duplicate Id for column: \"Keyword ID\", which is the same as row 12\t|\n","|14\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|15\t|Input Error\t|Duplicate ID\t|Duplicate Id for column: \"Product Targeting ID\", which is the same as row 14\t|\n","|16\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|17\t|Input Error\t|Duplicate ID\t|Duplicate Id for column: \"Product Targeting ID\", which is the same as row 16\t|\n"," Fix: Remove the duplicate rows. Each entity ID must appear on at most one row in the sheet.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Update\t|10000\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Campaign Negative Keyword\t|Update\t|10000\t|\t|\t|30000\t|\t|\n","|Sponsored Products\t|Ad Group\t|Update\t|10000\t|20000\t|\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|Update\t|10000\t|20000\t|40000\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Update\t|10000\t|20000\t|\t|50000\t|\t|\n","|Sponsored Products\t|Negative Keyword\t|Update\t|10000\t|20000\t|\t|60000\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Update\t|10000\t|20000\t|\t|\t|70000\t|\n","|Sponsored Products\t|Negative Product Targeting\t|Update\t|10000\t|20000\t|\t|\t|80000\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: duplicate keyword text or targeting expression"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" Within an ad group, the combination of keyword text + match type must be unique. Product targeting expressions must also be unique within an ad group.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword Text\t|Match Type\t|Product Targeting Expression\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Outdoors\t|\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Outdoors\t|indoors\t|broad\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Outdoors\t|indoors\t|broad\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Indoors\t|\t|\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Create\t|Spring\t|Indoors\t|\t|\t|asin=\"B000000000\"\t|\n","|Sponsored Products\t|Product Targeting\t|Create\t|Spring\t|Indoors\t|\t|\t|asin=\"B000000000\"\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2-4\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|5\t|Input Error\t|Duplicate Text\t|Duplicate \"Keyword Text\", which is the same as row 4\t|\n","|6-7\t|Warning\t|Not Processed\t|This row was not processed due to errors from other rows\t|\n","|8\t|Input Error\t|Duplicate Text\t|Duplicate \"Product Targeting Expression\", which is the same as row 7\t|\n"," Fix: Remove the duplicate keyword and the duplicate product targeting rows.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword Text\t|Match Type\t|Product Targeting Expression\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Outdoors\t|\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Outdoors\t|indoors\t|broad\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Indoors\t|\t|\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Create\t|Spring\t|Indoors\t|\t|\t|asin=\"B000000000\"\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: duplicate ad group name in an existing campaign"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" Assume your campaign already has two ad groups named Outdoors and Indoors:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign Name\t|Ad Group Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|10000\t|\t|\t|\t|\t|Spring\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|10000\t|20000\t|\t|\t|\t|\t|Outdoors\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|10000\t|20000\t|40000\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Create\t|10000\t|20000\t|\t|\t|50000\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|10000\t|30000\t|\t|\t|\t|\t|Indoors\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|10000\t|30000\t|60000\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Create\t|10000\t|30000\t|\t|70000\t|\t|\t|\t|\n"," If you try to create a new ad group with the name \"Outdoors\", along with new child entities under it:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Ad Group Id\t|Campaign Name\t|Ad Group Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|10000\t|Outdoors\t|\t|Outdoors\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|10000\t|Outdoors\t|\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Create\t|10000\t|Outdoors\t|\t|\t|\n"," You will see this error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Invalid user input\t|AdGroup with name=Outdoors already exists!\t|\n","|3-4\t|Warning\t|Not Processed\t|This row was not processed due to the error in row #2\t|\n"," Fix: Use a unique ad group name within the campaign. The child rows must reference the new ad group's temporary ID:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Ad Group Id\t|Campaign Name\t|Ad Group Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|10000\t|Outdoors 2024\t|\t|Outdoors 2024\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|10000\t|Outdoors 2024\t|\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Create\t|10000\t|Outdoors 2024\t|\t|\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":2,"text":"Limits"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" All sponsored ads campaign types have minimum and/or maximum limitations on various elements. Below are some examples of limits-related errors you might see, along with links to documentation to help troubleshoot:\n","|Error message\t|Notes\t|\n","|---\t|---\t|\n","|Number of non archived campaigns exceeds the limit per advertiser\t|Review this guide for campaign limits. Note that these limits apply to all sponsored ads campaign types, other than keyword limits which are not used in Sponsored Display campaigns. \t|\n","|Number of non archived ad groups exceeds the limit per advertiser\t|See note above\t|\n","|Number of non archived ad groups exceeds the limit per campaign\t|See note above\t|\n","|Number of targeting clauses per ad group exceeds the limit.\t|See note above\t|\n","|Number of targeting clause (keyword) non archived exceed limit per ad group\t|See note above\t|\n","|Campaign name is too long\t|Review this guide for constraints on character limits, bids, and budgets. \t|\n","|Ad group name is too long\t|See note above\t|\n","|Keyword text is too long\t|See note above\t|\n","|Bid is lower than the minimum allowed by the marketplace\t|See note above\t|\n","|Bid is out of range (must be in 1.0, 1000.0)\t|See note above\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":2,"text":"Targeting expression errors"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" These are error messages for the Targeting Expression or Product Targeting Expression column.\n","|Error message\t|Notes\t|\n","|---\t|---\t|\n","|Improper expression value: ASIN\t|The targeting expression syntax is incorrect. For Sponsored Products, see the \"Product Targeting Expression\" section in Create a Sponsored Products campaign. For Sponsored Display, see the \"Targeting Expression\" section in Create a Sponsored Display campaign.\t|\n","|Asin value ASIN for type EXPRESSION_TYPE is invalid\t|The ASIN does not match the expected expression type. Reference Sponsored Products product attribute targeting for valid combinations.\t|\n","|Improper or misused targeting expression type: VALUE\t|The expression type is not supported in this context. If you are unsure of the correct format, create the targeting manually in the advertising console, then run a bulksheets download to see the format and any required category, brand, or audience IDs.\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":2,"text":"Audience ID errors"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":["|Error message\t|Notes\t|\n","|---\t|---\t|\n","|Audience Id: AUDIENCE_ID not found in Audience Discovery API\t|The audience ID does not exist, or the advertiser does not have access to it. Verify the audience ID is correct and that your account has access via the ListTargetableEntities operation.\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: invalid audience ID"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If you specify an audience ID that does not exist, the row is rejected.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Audience ID\t|Shopper Cohort Percentage\t|Shopper Cohort Type\t|Segment Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Bidding Adjustment\t|Create\t|1234134\t|15\t|AUDIENCE_SEGMENT\t|Made up audience\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Combined processing error\t|Audience Id: 1234134 not found in Audience Discovery API https&#x3A;//advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities\t|\n"," Fix: Use a valid Audience ID. Discover available audience IDs through the ListTargetableEntities operation.\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: inaccessible audience"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" You will see the same error message even when the audience ID does exist, if your account does not have access to it.\n"," Input:\n","|Product\t|Entity\t|Operation\t|Audience ID\t|Shopper Cohort Percentage\t|Shopper Cohort Type\t|Segment Name\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Bidding Adjustment\t|Create\t|412978094962770620\t|15\t|AUDIENCE_SEGMENT\t|High interest based on shopping history\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Combined processing error\t|Audience Id: 412978094962770620 not found in Audience Discovery API https&#x3A;//advertising.amazon.com/API/docs/en-us/targetable-entities#operation/ListTargetableEntities\t|\n"," Fix: Verify that your account has access to the audience. Call ListTargetableEntities to confirm. If the audience exists but is not in the response for your account, your account does not have access — contact Amazon Ads support.\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":2,"text":"Header and structural errors"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" These errors occur when the structure of the spreadsheet itself is invalid—for example, duplicate columns or missing operations.\n","|Error message\t|Notes\t|\n","|---\t|---\t|\n","|Duplicate columns: COLUMN_NAMES. Please remove the duplicate columns and try again.\t|Your spreadsheet contains two or more columns with the same header (for example, two \"Campaign ID\" columns). Remove the duplicate columns before re-uploading.\t|\n","|None of the rows in the excel sheet specify an Operation, so there was nothing to process. (All rows that have a blank Operation are skipped)\t|Every row you want processed must have a value in the Operation column (Create, Update, or Archive). Rows with a blank Operation are skipped. Specify the Operation on every row you want to edit.\t|\n","|Invalid operation: \"OPERATION_INPUT\"\t|The Operation column value is not recognized. Valid values are Create, Update, and Archive.\t|\n","|Invalid entity: \"ENTITY_INPUT\"\t|The Entity column value is not recognized. See the bulksheet templates for valid entity names per campaign type.\t|\n","|Invalid product: \"PRODUCT_INPUT\"\t|The Product column value is not recognized. Valid values are Sponsored Products, Sponsored Brands, Sponsored Display, or Portfolios.\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: blank Operation column"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If every row leaves the Operation column blank, the entire upload is skipped because there is nothing to do.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|\t|10000\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|\t|10000\t|20000\t|\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|\t|10000\t|20000\t|40000\t|\t|\t|\n","|Sponsored Products\t|Product Targeting\t|\t|10000\t|20000\t|\t|\t|50000\t|\n","|Sponsored Products\t|Ad Group\t|\t|10000\t|30000\t|\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|\t|10000\t|30000\t|60000\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|\t|10000\t|30000\t|\t|70000\t|\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|\t|Warning\t|Invalid User Input\t|None of the rows in the excel sheet specify an Operation, so there was nothing to process. (All rows that have a blank Operation are skipped)\t|\n"," Fix: Specify the Operation (Create, Update, or Archive) on every row you want processed. Rows you do not want changed can remain blank.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|\t|10000\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Ad Group\t|\t|10000\t|20000\t|\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|\t|10000\t|20000\t|40000\t|\t|\t|\n","|Sponsored Products\t|Product Targeting\t|Update\t|10000\t|20000\t|\t|\t|50000\t|\n","|Sponsored Products\t|Ad Group\t|Update\t|10000\t|30000\t|\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|Update\t|10000\t|30000\t|60000\t|\t|\t|\n","|Sponsored Products\t|Keyword\t|Update\t|10000\t|30000\t|\t|70000\t|\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: duplicate columns"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If your spreadsheet has two columns with the same header (for example, two Campaign ID columns), the upload fails before processing any rows.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Campaign ID\t|Ad Group ID\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|\t|Spring\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Outdoors\t|Spring\t|Outdoors\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Outdoors\t|Spring\t|Outdoors\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|\t|Input Error\t|Invalid headers\t|Duplicate columns: Campaign ID, Ad Group ID. Please remove the duplicate columns and try again.\t|\n"," Fix: Remove the duplicate columns.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Create\t|Spring\t|\t|\n","|Sponsored Products\t|Ad Group\t|Create\t|Spring\t|Outdoors\t|\n","|Sponsored Products\t|Keyword\t|Create\t|Spring\t|Outdoors\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: invalid Product, Entity, or Operation"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If you misspell or use an unrecognized value in the Product, Entity, or Operation column, that row is rejected.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|\n","|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Invalid Operation\t|\n","|Sponsored Products\t|Invalid Entity\t|Create\t|\n","|Invalid Product\t|Campaign\t|Create\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Invalid Operation\t|Invalid operation: \"Invalid Operation\"\t|\n","|3\t|Input Error\t|Invalid Entity\t|Invalid entity: \"Invalid Entity\"\t|\n","|4\t|Input Error\t|Invalid Product\t|Invalid product: \"Invalid Product\"\t|\n"," Fix: Use one of the valid values described in the table above.\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":2,"text":"Server errors"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" If your error report contains a row with Error type = System Error (for example, Unknown Error or Server is busy. Try again later.), the issue is on the bulksheets service side rather than in your input file. Wait a few minutes and retry the upload. If the error persists, contact the Amazon Ads Support Center.\n"," Example error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|System Error\t|System Error\t|Unknown Error\t|\n","|3\t|System Error\t|Server is busy\t|Server is busy. Try again later.\t|\n","|Error message\t|Notes\t|\n","|---\t|---\t|\n","|Unknown Error\t|Transient server-side error. Retry the upload.\t|\n","|Server is busy. Try again later.\t|The service is temporarily overloaded. Wait a few minutes and retry.\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":2,"text":"Other errors"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" Below are other common errors that are outside of the categories grouped above:\n","|Error message\t|Notes\t|\n","|---\t|---\t|\n","|Product is ineligible for advertising\t|If you try creating a product ad with an ASIN or SKU that is ineligible to serve, you will see this error. Eligibility can be affected by many factors, including not having an image or a title, or if the product is out of stock. You can check for eligibility in a downloaded bulksheets file: Look in the column titled Eligibility status. If any are labeled as ineligible, check the column titled Reason for ineligibility to see why. \t|\n","|The category for this product is restricted for advertising\t|The ASIN or SKU you are trying to advertise is in an ineligible category. Check the Eligibility status and Reason for ineligibility columns in a downloaded bulksheets file for details.\t|\n","|Archived entity cannot be modified\t|This error could happen for a couple of reasons: 1. You are trying to un-archive or modify/update an archived entity. Archived entities cannot be changed in any way. To \"re-activate\" an archived entity, you should copy the relevant data from bulksheets, and use it to create a new version of that entity. Be sure to change the entity IDs as needed when you create the new version. If this is the case, then you will need to take additional action because the sheet was not processed correctly. Tip: You can pause entities instead of archiving if you want to re-enable the entities at a later date. To do this, set the \"Operation\" field to Update, and set the \"State\" to paused. To re-enable the paused entity, set the \"Operation\" to Update, and set the \"State\" to enabled. 2. You are trying to archive an entire campaign, including its child entities, and you included the \"Archive\" Operation in the child entity rows. To archive an entire campaign, you only need to archive the parent campaign. If you include the \"Archive\" Operation in child entity rows, you will see this error in each child row. If this is the case, you do not need to take any additional action because the campaign will have been archived, so the errors in the child rows are inconsequential. \t|\n","|Parent entity is archived forbids child creates\t|You are trying to create or update a child entity (ad group, keyword, product ad, target) under a parent campaign or ad group that has been archived. Archived parents cannot accept new or updated children. Create a new parent campaign or ad group and add the child entities there.\t|\n","|Only negative keywords and negative product targets are allowed in auto-targeting campaigns\t|For Sponsored Products campaigns, you can choose either auto or manual targeting. If you select auto targeting, you cannot add your own keywords when you create the campaign. Only negative keywords or product targets can be added for auto campaigns. There is an exception to the product targeting rule: If you want more control over bids in an auto campaign, you can create four product targeting entities as described in this FAQ. In those four rows, you will set the \"Product targeting expression\" fields to the following values—one for each entity: close-match, loose-match, complements, substitutes\t|\n","|Start date cannot be in the past\t|The start date can be the same day you upload or create the campaign, or it can be a date in the future. It cannot be in the past. This error is common, and it often occurs accidentally—for example, if you start working on a bulksheets file on Monday, and you enter that day's date. If you do not upload the file that day, you will need to change the date to be later. \t|\n","|merchantSku cannot be changed\t|Once you create an ad with your SKU or ASIN, these values cannot be updated. If you want to change the product you are advertising, you should create a new \"Product ad\" entity with the SKU or ASIN you want. If you no longer want to advertise a current SKU or ASIN, you can pause or archive them. \t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: changing the SKU on an existing product ad"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" Assume you already have a Product Ad in your account with the data below:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Product Ad ID\t|SKU\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Product Ad\t|\t|10000\t|20000\t|30000\t|OLD-SKU\t|\n"," If you try to edit the SKU using this input:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Product Ad ID\t|SKU\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Product Ad\t|Update\t|10000\t|20000\t|30000\t|NEW-SKU\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Invalid user input\t|merchantSku cannot be changed\t|\n"," Fix: Archive the existing Product Ad and create a new one with the new SKU.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Product Ad ID\t|SKU\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Product Ad\t|Archive\t|10000\t|20000\t|30000\t|OLD-SKU\t|\n","|Sponsored Products\t|Product Ad\t|Create\t|10000\t|20000\t|\t|NEW-SKU\t|\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: re-enabling an archived campaign"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" You cannot re-enable an archived entity. Once a campaign, ad group, keyword, product ad, or target is archived, the row is permanently in that state.\n"," Assume your account already has an archived campaign with Campaign ID 10000. If you try to re-enable it:\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|State\t|\n","|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Update\t|10000\t|enabled\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|2\t|Input Error\t|Invalid User Input\t|Archived entity cannot be modified\t|\n"," Fix: Create a new campaign (or ad group, keyword, etc.) with the same details rather than re-enabling the archived one. To avoid this in the future, pause entities (set Operation = Update, State = paused) instead of archiving them when you may want to re-enable later.\n"],"documentType":"guide"},{"title":"Bulksheets error reports","sectionHeader":{"type":3,"text":"Worked example: archiving a campaign with its child entities"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-error-reports","content":[" When archiving a campaign, only set the Archive operation on the campaign row. The system automatically archives the child entities (ad groups, keywords, product ads, targets) in the same campaign.\n"," Input (incorrect):\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|State\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Archive\t|10000\t|\t|\t|enabled\t|\n","|Sponsored Products\t|Ad Group\t|Archive\t|10000\t|20000\t|\t|enabled\t|\n","|Sponsored Products\t|Keyword\t|Archive\t|10000\t|20000\t|30000\t|enabled\t|\n"," Error report:\n","|Original record #\t|Error type\t|Error code\t|Error message\t|\n","|---\t|---\t|---\t|---\t|\n","|3\t|Input Error\t|Invalid user input\t|Archived entity cannot be modified\t|\n","|4\t|Input Error\t|Invalid user input\t|Archived entity cannot be modified\t|\n"," Fix: Set Archive on the Campaign row only. The campaign and all its children are archived together. The errors above on the child rows are inconsequential — the campaign is still archived.\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Ad Group ID\t|Keyword ID\t|State\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Products\t|Campaign\t|Archive\t|10000\t|\t|\t|enabled\t|\n","|Sponsored Products\t|Ad Group\t|\t|10000\t|20000\t|\t|enabled\t|\n","|Sponsored Products\t|Keyword\t|\t|10000\t|20000\t|30000\t|enabled\t|\n"],"documentType":"guide"},{"title":"How to create Sponsored Products campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sp/sp-examples/create-sp-campaign","content":[" This article shows detailed steps on creating new Sponsored Products campaigns using a blank bulksheets template. If you want information about how to pause, archive, or update campaigns--including how to change campaign or ad group names--see the overview on updating campaigns with bulksheets. \n"," To create a Sponsored Products campaign, first decide which targeting type you want: Either manual targeting or automatic (auto) targeting.  Similar to the advertising console UI, if you select  \"manual,\" you need bulksheets entities for either keyword or product targeting. If you select \"auto,\" Amazon will target keywords and products that are similar to the product in your ad, and those targets will inherit the ad group default bid. With auto targeting, you also have the option to set bids by targeting group if you create product targets.  The next two sections explain how to create bulksheets files for these auto and manual campaigns, starting with auto targeting. Jump to manual targeting\n"],"documentType":"guide"},{"title":"How to create Sponsored Products campaigns with bulksheets","sectionHeader":{"type":3,"text":"Create auto targeting campaign"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-examples/create-sp-campaign","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| Allowable entities (Column B of your bulksheets file) are shown in the hierarchical diagram on the right—the green entities are required fields that you must define for a SP auto targeting campaign. Learn more about SP entity and targeting types, and their relationships to Sponsored Products campaigns. | Sponsored Products entity diagram |\n"," The steps below show which fields you should complete on a row-by-row basis, starting with the top-level campaign entity. Each “step” section represents one row in your bulksheets file. The guidelines describe what you should enter into each field of the blank template.\n"," To create the top-level (parent) campaign entity, required fields include Product, Entity, Operation, Campaign ID, Campaign name, Start date, Targeting type, State, and Daily budget. \n"," Use the guidelines below to define the campaign entity in the first row of your bulksheets file:\n","|gridColumn header    |Guidelines on what to enter    |\n","\\|---    \\|---    \\|\n","|Product    |Sponsored Products    |\n","|Entity    |Campaign    |\n","|Operation    |Create    |\n","|Campaign ID\\*    |For new campaigns, you should type a text-based name to identify your campaign. You will enter this exact Campaign ID for each entity you create underneath this parent campaign. NOTE: When you upload your bulksheets file, the Campaign ID will become the actual unique identifier associated with the campaign and all of its \"child\" entities. So if you want to update this campaign later, you would enter the actual Campaign ID into this field.    |\n","|Ad Group ID\\*    |Leave blank when creating campaign entity    |\n","|Portfolio ID\\*    |If you want to put the new campaign into an existing portfolio, enter the portfolio ID. Otherwise, leave blank. Learn more about using portfolios with bulksheets    |\n","|Ad ID\\*    |Leave blank when creating campaign entity    |\n","|Keyword ID\\*    |Leave blank. This field will be useful when you want to archive or pause keywords    |\n","|Product Targeting ID\\*    |Leave blank when creating campaign entity    |\n","|Campaign Name    |Enter the same campaign name that you entered in the \"Campaign ID\" column.    |\n","|Ad Group Name    |Leave blank when creating campaign entity    |\n","|Start Date    |Format must be yyyyMMdd. For example, the date April 1, 2024 would be 20240401.  NOTE: You can start on today's date or a future date, but the date cannot be in the past. So if you set the date for today, be sure you create and upload the file on today's date. If you leave this field blank, the start date will be set for today's date.   |\n","|End Date    |You can leave this field blank if you do not want to set an end date. Otherwise, the format must be yyyyMMdd.    |\n","|Targeting Type\\*    |Enter auto    |\n","|State    |Options are enabled or paused. Enter  enabled to create a new campaign.    |\n","|Daily Budget    |Do not include symbols such as dollar signs. For example, a daily budget of $100 would be written as 100. If the figure is not a whole number, use a decimal point and not a comma. Be sure your budget is within the allowed limits for your region.    |\n","|sku\\*    |Leave blank when creating campaign entity    |\n","|asin\\*    |Leave blank when creating campaign entity    |\n","|Ad Group Default Bid    |Leave blank when creating campaign entity    |\n","|Bid    |Leave blank when creating campaign entity    |\n","|Keyword Text\\*    |Leave blank when creating campaign entity    |\n","|Match Type\\*    |Leave blank. This field only applies to the keyword entity    |\n","|Bidding Strategy    |Similar to what you see in the UI, you can choose a bidding strategy: Enter Dynamic bids - down only, Dynamic bids - up and down, or Fixed bid.    |\n","|Placement\\*    |Leave blank. To define the placement, create a bidding adjustment entity in this campaign    |\n","|Percentage    |Leave blank. The percentage adjustment is defined with the bidding adjustment entity    |\n","|Product Targeting Expression\\*    |Leave blank when creating campaign entity. Only used for manual campaign product targeting entity    |\n","|Audience Id    |Leave blank. To specify a shopper cohort based bid adjustment, create a bidding adjustment entity in this campaign    |\n","|Shopper Cohort Percentage    |Leave blank. The shopper cohort percentage adjustment is defined with the bidding adjustment entity    |\n","|Shopper Cohort Type    |Leave blank. The shopper cohort type is defined with the bidding adjustment entity     |\n","|Sites    |Optional field. Leave blank for default (Amazon and Beyond), or enter \"Amazon Business\" to target Amazon Business exclusively.    |\n","|Off-Amazon ad serving    |Optional field. Allows advertisers to update settings for ads served off Amazon. Enter Increase reach to increase your reach off Amazon (this setting may result in more impressions and opportunities for sales off Amazon), or enter Limit off-Amazon spend to reduce spend off Amazon for low-performing placements (this setting may result in fewer impressions off Amazon, but it can help control spend). Leave blank to use the default setting. Availability: US.    |\n"," About bidding strategy options:\n","|Bid strategy    |Description    |Dynamic increase    |Dynamic decrease    |\n","\\|---    \\|---    \\|---    \\|---    \\|\n","|Fixed bid    |Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding.    |0    |0    |\n","|Dynamic bids - up and down    |Increases or decreases your bids in real time by a maximum of 100%. Bids increase when your ad is more likely to convert to a sale, and decrease when less likely to convert.    |100    |-100    |\n","|Dynamic bids - down only    |Lowers your bids in real time when your ad is less likely to convert to a sale. This is the default setting for campaigns created before the release of the bidding controls feature.    |0    |-100    |\n"," Putting it all together, this bulksheets row for creating the campaign entity might look like this—note that some fields, such as Campaign ID, contain sample text for reference:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |sku    |asin    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Audience ID    |Shopper Cohort Percentage    |Shopper Cohort Type    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products    |Campaign    |Create    |Spring toys 2024    |    |    |    |    |    |Spring toys 2024    |    |20240401    |    |Auto    |Enabled    |100    |    |    |    |    |    |    |Fixed bid    |    |    |    |    |    |    |Amazon Business    |    |\n","|Sponsored Products    |Bidding adjustment    |Create    |Spring toys 2024    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |placement top    |35    |    |    |    |    |    |    |\n"," In the advertising console UI, the optional bidding adjustment is part of the overall campaign bidding strategy that adjusts bids by placement and shopper cohort. \n"," Bulksheets supports placements for top-of-page (first page), product detail pages, rest-of-search, and Site Amazon Business. To create a placement bidding adjustment, required fields include Product, Entity, Operation, Campaign ID, Bidding Strategy, Placement, and Percentage. \n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| Bulksheets also supports bid adjustment by shopper cohort. To create a shopper cohort bidding adjustment, required fields include Product, Entity, Operation, Campaign ID, Bidding Strategy, Audience ID, Shopper Cohort Percentage, and Shopper Cohort Type. The Audience ID  can be retrieved from the Ad Console. | Sponsored Products Audience ID |\n","|gridColumn header    |Guidelines on what to enter    |\n","\\|---    \\|---    \\|\n","|Product    |Sponsored Products    |\n","|Entity    |Bidding adjustment    |\n","|Operation    |Create    |\n","|Campaign ID\\*    |Enter the exact same campaign ID that you entered in the campaign entity row.     |\n","|Ad Group ID\\*    |Leave blank when creating a bidding adjustment    |\n","|Portfolio ID\\*    |Leave blank when creating a bidding adjustment    |\n","|Ad ID\\*    |Leave blank when creating a bidding adjustment    |\n","|Keyword ID\\*    |Leave blank when creating a bidding adjustment    |\n","|Product Targeting ID\\*    |Leave blank when creating a bidding adjustment    |\n","|Campaign Name    |Leave blank when creating a bidding adjustment    |\n","|Ad Group Name    |Leave blank when creating a bidding adjustment    |\n","|Start Date\\*    |Leave blank when creating a bidding adjustment    |\n","|End Date    |Leave blank when creating a bidding adjustment    |\n","|Targeting Type\\*    |Leave blank when creating a bidding adjustment    |\n","|State    |Leave blank--the bidding adjustment entity is the only one that does not need a value in this field    |\n","|Daily Budget    |Leave blank when creating a bidding adjustment    |\n","|sku\\*    |Leave blank when creating a bidding adjustment    |\n","|asin\\*    |Leave blank when creating a bidding adjustment    |\n","|Ad Group Default Bid    |Leave blank when creating a bidding adjustment    |\n","|Bid    |Leave blank when creating a bidding adjustment    |\n","|Keyword Text\\*    |Leave blank when creating a bidding adjustment    |\n","|Match Type\\*    |Leave blank when creating a bidding adjustment    |\n","|Bidding Strategy    |Leave blank--the bidding strategy is defined in the campaign entity row.     |\n","|Placement\\*    |Enter one of the following values: placementTop (or placement top), placementProductPage (or placement product page), placementRestOfSearch (or placement rest of search), or placementAmazonBusiness (or placement amazon business). These values are not case sensitive.    |\n","|Percentage    |Enter a figure using digits only, up to a maximum of 900. For example, a 35% increase should be entered as 35. This will define the percentage increase applied to your base bid, up to 900% max. Learn more about adjusting bids by placement    |\n","|Product Targeting Expression\\*    |Leave blank when creating a bidding adjustment    |\n","|Audience ID    |Enter the audience ID of the shopper cohort you would like to apply adjustments for.     |\n","|Shopper Cohort Percentage    |Enter a figure using digits only, up to a maximum of 900. For example, a 35% increase should be entered as 35. This will define the percentage increase applied to your base bid, up to 900% max. Learn more about adjusting bids by audience    |\n","|Shopper Cohort Type    |Enter the type of shopper cohort used to apply bid adjustments. AUDIENCE_SEGMENT is the only supported type currently.    |\n","|Sites    |Leave blank when creating bidding adjustment entity    |\n","|Off-Amazon ad serving    |Leave blank when creating bidding adjustment entity    |\n"," After adding the bidding adjustment, your template would look like this:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |sku    |asin    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Audience ID    |Shopper Cohort Percentage    |Shopper Cohort Type    |Sites    |Off-Amazon ad serving   |    \n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products    |Campaign    |Create    |Spring toys 2024    |    |    |    |    |    |Spring toys 2024    |    |20240401    |    |Auto    |Enabled    |100    |    |    |    |    |    |    |Fixed bid    |    |    |    |    |    |    |    |Limit off-Amazon spend   |\n","|Sponsored Products    |Bidding adjustment    |Create    |Spring toys 2024    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |placement top    |35    |    |    |    |    |    |    |\n","|Sponsored Products    |Bidding adjustment    |Create    |Spring toys 2024    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |412978094962770620    |50    |AUDIENCE_SEGMENT    |    |    |\n"," To create the ad group, required fields include Product, Entity, Operation, Campaign ID, Ad group ID, Ad group name, State, and Ad group default bid. \n"," In the next row of your bulksheets template, use the following guidelines to define the “Ad group” entity for this campaign:\n","|gridColumn header    |Guidelines on what to enter    |\n","\\|---    \\|---    \\|\n","|Product    |Sponsored Products    |\n","|Entity    |Ad group    |\n","|Operation    |Create    |\n","|Campaign ID\\*   |Enter the exact same text-based campaign ID that you entered in the \"Campaign\" entity row. This will ensure that the ad group becomes a \"child\" of the top-level campaign \"parent\" entity.    |\n","|Ad Group ID\\*    |For new ad groups, you should type a text-based name to identify the ad group. You will also type this exact same name into the “Entity Name” column for this row.  NOTE: When you upload your bulksheets file, the Ad Group ID will become the actual unique identifier associated with this ad group.    |\n","|Portfolio ID\\*    |Leave blank when creating ad group entity    |\n","|Ad ID\\*    |Leave blank when creating ad group entity    |\n","|Keyword ID\\*    |Leave blank when creating ad group entity    |\n","|Product Targeting ID\\*    |Leave blank when creating ad group entity    |\n","|Campaign Name    |Leave blank when creating ad group entity    |\n","|Ad Group Name    |Enter the same name that you entered in the \"Ad Group ID\" column    |\n","|Start Date\\*    |Leave blank. The start date is set at the campaign level and applies to all child entities    |\n","|End Date    |Leave blank when creating ad group entity    |\n","|Targeting Type\\*    |Leave blank when creating ad group entity    |\n","|State    |Enter enabled to create the ad group.    |\n","|Daily Budget    |Leave blank when creating ad group entity    |\n","|sku\\*    |Leave blank when creating ad group entity    |\n","|asin\\*    |Leave blank when creating ad group entity    |\n","|Ad Group Default Bid    |Enter an exact figure with no money symbols, and use a decimal point (not a comma).  For example, if you want to set this to 75 cents, enter 0.75  NOTE: This default bid amount will apply to all child entities of this ad group if you do not define bids for the child entities explicitly. For instance, if a keyword child entity does not include a defined bid, this default amount would apply.    |\n","|Bid    |Leave blank. This field is for keyword bidding    |\n","|Keyword Text    |\\[Leave blank. This field only applies to the keyword\\* entity]    |\n","|Match Type\\*    |Leave blank when creating ad group entity    |\n","|Bidding Strategy    |Leave blank when creating ad group entity    |\n","|Placement\\*    |Leave blank when creating ad group entity    |\n","|Percentage    |Leave blank when creating ad group entity    |\n","|Product Targeting Expression\\*    |Leave blank when creating ad group entity. Only used for manual campaign product targeting entity    |\n","|Audience ID    |Leave blank when creating ad group entity    |\n","|Shopper Cohort Percentage    |Leave blank when creating ad group entity    |\n","|Shopper Cohort Type  |Leave blank when creating ad group entity    |\n","|Sites    |Leave blank when creating ad group entity    |\n","|Off-Amazon ad serving    |Leave blank when creating ad group entity    |\n"," After you add the “Ad group” entity into the bulksheets template, it might now look like this:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |sku    |asin    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Audience ID    |Shopper Cohort Percentage    |Shopper Cohort Type    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---     \\|\n","|Sponsored Products    |Campaign    |Create    |Spring toys 2024    |    |    |    |    |    |Spring toys 2024    |    |20240401    |    |Auto    |Enabled    |100    |    |    |    |    |    |    |Fixed bid    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |bidding adjustment    |Create    |Spring toys 2024    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |Fixed bid    |placement top    |35    |    |    |    |    |    |    |\n","|Sponsored Products    |Ad group    |Create    |Spring toys 2024    |Outdoors    |    |    |    |    |    |Outdoors    |    |    |    |Enabled    |    |    |    |0.75    |    |    |    |    |    |    |    |    |    |    |    |    |\n"," Next, you define the “Product ad” entity in the row underneath your “Ad group” entity. Required fields include Product, Entity, Operation, Campaign ID, Ad group ID, State, and sku or asin. \n","|gridColumn header    |Guidelines on what to enter    |\n","\\|---    \\|---    \\|\n","|Product    |Sponsored Products    |\n","|Entity    |Product ad    |\n","|Operation    |Create    |\n","|Campaign ID\\*    |Enter the exact same campaign name that you entered in the \"Campaign\" entity row    |\n","|Ad Group ID\\*    |Enter the exact same ad group name that you entered in the \"Ad group ID\" row. (You need Ad Group ID for this entity because the Product ad is a child of the Ad group)    |\n","|Portfolio ID\\*    |Leave blank when creating product ad entity    |\n","|Ad ID\\*    |Leave blank. This field will only be used for updating or archiving an existing product ad    |\n","|Keyword ID\\*    |Leave blank when creating product ad entity    |\n","|Product Targeting ID    |Leave blank when creating product ad entity    |\n","|Campaign Name    |Leave blank when creating product ad entity    |\n","|Ad Group Name    |Leave blank when creating product ad entity    |\n","|Start Date\\*    |Leave blank when creating product ad entity    |\n","|End Date    |Leave blank when creating product ad entity    |\n","|Targeting Type\\*    |Leave blank when creating product ad entity    |\n","|State    |Enter enabled    |\n","|Daily Budget    |Leave blank when creating product ad entity    |\n","|sku\\*    |For sellers, you should enter the product SKU. For vendors, leave the SKU field blank    |\n","|asin\\*    |For vendors, you should enter the product ASIN. For sellers, leave the ASIN field blank.  NOTE: You can see ASIN eligibility statuses, along with reasons for ineligibility, when you download a Sponsored Products bulksheets file. This information is available in two informational-only columns: Eligibility Status and Reason for Ineligibility.    |\n","|Ad Group Default Bid    |Leave blank when creating product ad entity    |\n","|Bid    |Leave blank when creating product ad entity    |\n","|Keyword Text\\*    |Leave blank when creating product ad entity    |\n","|Match Type\\*    |Leave blank when creating product ad entity    |\n","|Bidding Strategy    |Leave blank when creating product ad entity    |\n","|Placement\\*    |Leave blank when creating product ad entity    |\n","|Percentage    |Leave blank when creating product ad entity    |\n","|Product Targeting Expression\\*    |Leave blank when creating product ad entity    |\n","|Audience ID    |Leave blank when creating product ad entity    |\n","|Shopper Cohort Percentage    |Leave blank when creating product ad entity    |\n","|Shopper Cohort Type  |Leave blank when creating product ad entity    |\n","|Sites    |Leave blank when creating product ad entity    |\n","|Off-Amazon ad serving    |Leave blank when creating product ad entity    |\n"," After you add the product ad entity data, your bulksheets file might now look like this:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |sku    |asin    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Audience ID    |Shopper Cohort Percentage    |Shopper Cohort Type    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---   \\|---    \\|---    \\|\n","|Sponsored Products    |Campaign    |Create    |Spring toys 2024    |    |    |    |    |    |Spring toys 2024    |    |20240401    |    |Auto    |Enabled    |100    |    |    |    |    |    |    |Fixed bid    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |bidding adjustment    |Create    |Spring toys 2024    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |Fixed bid    |placement top    |35    |    |    |    |    |    |    |\n","|Sponsored Products    |Ad group    |Create    |Spring toys 2024    |Outdoors    |    |    |    |    |    |Outdoors    |    |    |    |Enabled    |    |    |    |0.75    |    |    |    |    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Product ad    |Create    |Spring toys 2024    |Outdoors    |    |    |    |    |    |    |    |    |    |Enabled    |    |BR549    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |\n"," Note that you will repeat this step four times to create each of the four product targeting entities. If you do not create all four entities, Amazon will automatically create them, and the ad group default bid will apply. Fields with an asterisk ( \\* ) cannot be edited or updated after the campaign is created.\n","|gridColumn header |Guidelines on what to enter |\n","\\|--- \\|--- \\|\n","|Product |Sponsored Products |\n","|Entity |Product targeting |\n","|Operation |Create |\n","|Campaign Id\\* |Enter the exact same campaign name that you entered in the \"Campaign\" entity row |\n","|Ad Group Id\\* |Enter the exact same ad group name that you entered in the \"Ad group ID\" row. (You need Ad Group ID for this entity because Product targeting is a child of the Ad group) |\n","|Portfolio Id |Leave blank when creating product targeting entity |\n","|Ad ID |Leave blank when creating product targeting entity |\n","|Keyword ID |Leave blank when creating product targeting entity |\n","|Product Targeting ID |Leave blank when creating product targeting entity |\n","|Campaign Name |Leave blank when creating product targeting entity |\n","|Ad Group Name |Leave blank when creating product targeting entity |\n","|Start Date\\* |Leave blank when creating product targeting entity |\n","|End Date |Leave blank when creating product targeting entity |\n","|Targeting Type\\* |Leave blank when creating product targeting entity |\n","|State |Enter enabled to create and bid on the product target. Enter paused if you do not want to bid on the product target. |\n","|Daily Budget |Leave blank when creating product targeting entity |\n","|SKU\\* |Leave blank when creating product targeting entity |\n","|ASIN\\* |Leave blank when creating product targeting entity |\n","|Ad Group Default Bid |Leave blank when creating product targeting entity |\n","|Bid |Enter a value if you want to bid on the product targeting entity. Otherwise, the ad group default bid will apply. If you are setting the \"State\" to be paused, you can leave this field blank. |\n","|Keyword Text\\* |Leave blank when creating product targeting entity |\n","|Match Type\\* |Leave blank when creating product targeting entity |\n","|Bidding Strategy |Leave blank when creating product targeting entity |\n","|Placement\\* |Leave blank when creating product targeting entity |\n","|Percentage |Leave blank when creating product targeting entity |\n","|Product Targeting Expression\\* |Enter a value—you need one row for each: close-match, loose-match, substitutes, complements |\n","|Audience ID    |Leave blank when creating product targeting entity    |\n","|Shopper Cohort Percentage    |Leave blank when creating product targeting entity    |\n","|Shopper Cohort Type  |Leave blank when creating product targeting entity    |\n","|Sites    |Leave blank when creating product targeting entity    |\n","|Off-Amazon ad serving    |Leave blank when creating product targeting entity    |\n"," After adding the four product targeting rows, your file might look like this—note that we opted to pause two of these entities because we do not want to bid on those targets:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |sku    |asin    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Audience ID    |Shopper Cohort Percentage    |Shopper Cohort Type    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---   \\|---    \\|---    \\|\n","|Sponsored Products |Campaign |Create |Spring toys 2024 | | | | | |Spring toys 2024 | |20240401 | |Auto |Enabled |100 | | | | | | |Fixed bid | | | |    |    |    |    |    |\n","|Sponsored Products |bidding adjustment |Create |Spring toys 2024 | | | | | | | | | | | | | | | | | | |Fixed bid |placement top |35 | |    |    |    |    |    |\n","|Sponsored Products |Ad group |Create |Spring toys 2024 |Outdoors | | | | | |Outdoors | | | |Enabled | | | |0.75 | | | | | | | |    |    |    |    |    |\n","|Sponsored Products |Product ad |Create |Spring toys 2024 |Outdoors | | | | | | | | | |Enabled | |BR549 | | | | | | | | | |    |    |    |    |    |\n","|Sponsored Products |Product targeting |Create |Spring toys 2024 |Outdoors | | | | | | | | | |Enabled | | | | |0.5 | | | | | |close-match |    |    |    |    |    |\n","|Sponsored Products |Product targeting |Create |Spring toys 2024 |Outdoors | | | | | | | | | |Enabled | | | | |1 | | | | | |loose-match |    |    |    |    |    |\n","|Sponsored Products |Product targeting |Create |Spring toys 2024 |Outdoors | | | | | | | | | |Paused | | | | | | | | | | |substitutes |    |    |    |    |    |\n","|Sponsored Products |Product targeting |Create |Spring toys 2024 |Outdoors | | | | | | | | | |Paused | | | | | | | | | | |complements |    |    |    |    |    |\n"," Next, you can either upload the file if you are ready to create the campaign, or add more entities.\n"],"documentType":"guide"},{"title":"How to create Sponsored Products campaigns with bulksheets","sectionHeader":{"type":3,"text":"Create manual targeting campaign"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-examples/create-sp-campaign","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| The following steps will guide you through creating a new Sponsored Products campaign using manual targeting.  Relevant entities (Column B) are shown in the hierarchical diagram on the right—the green entities are mandatory fields for manual campaigns. Green outlines are entities required depending on targeting strategy. | SP entity diagram for manual campaign |\n"," To create the top-level (parent) campaign entity, required fields include Product, Entity, Operation, Campaign ID, Campaign name, Start date, Targeting type, State, and Daily budget. \n","|gridColumn header    |Guidelines on what to enter    |\n","\\|---    \\|---    \\|\n","|Product    |Sponsored Products    |\n","|Entity    |Campaign    |\n","|Operation    |Create    |\n","|Campaign ID\\*    |For new campaigns, you should type a text-based name to identify your campaign. You will enter this exact Campaign ID for each entity you create underneath this parent campaign. NOTE: When you upload your bulksheets file, the Campaign ID will become the actual unique identifier associated with the campaign and all of its \"child\" entities. So if you want to update this campaign later, you would enter the actual Campaign ID into this field.    |\n","|Ad Group ID\\*    |Leave blank when creating campaign entity    |\n","|Portfolio Id    |If you want to put the new campaign into a portfolio, enter the portfolio ID. Otherwise, leave blank.    |\n","|Ad ID\\*    |Leave blank when creating campaign entity    |\n","|Keyword ID\\*    |Leave blank. This field will be useful when you want to archive or pause keywords    |\n","|Product Targeting ID\\*    |Leave blank when creating campaign entity    |\n","|Campaign Name    |Enter the same campaign name that you entered in the \"Campaign ID\" column.    |\n","|Ad Group Name    |Leave blank when creating campaign entity    |\n","|Start Date\\*    |Format must be yyyyMMdd. For example, the date April 1, 2024 would be 20240401. NOTE: You can start on today's date or a future date, but the date cannot be in the past. So if you set the date for today, be sure you create and upload the file on today's date.    |\n","|End Date    |You can leave this field blank if you do not want to set an end date. Otherwise, the format must be yyyyMMdd.    |\n","|Targeting Type\\*    |Enter manual    |\n","|State    |Enter enabled    |\n","|Daily Budget    |Do not include symbols such as dollar signs. For example, a daily budget of $100 would be written as 100. If the figure is not a whole number, use a decimal point and not a comma. Be sure your budget is within the allowed limits for your region.    |\n","|sku\\*    |Leave blank when creating campaign entity    |\n","|asin\\*    |Leave blank when creating campaign entity    |\n","|Ad Group Default Bid    |Leave blank when creating campaign entity    |\n","|Bid    |Leave blank when creating campaign entity    |\n","|Keyword Text\\*    |Leave blank when creating campaign entity    |\n","|Match Type\\*    |Leave blank. This field only applies to the keyword entity    |\n","|Bidding Strategy    |Similar to what you see in the UI, you can choose a bidding strategy: Dynamic bids - down only, Dynamic bids - up and down, or Fixed bid. See the bidding strategy options table above for a description of each option.    |\n","|Placement\\*    |Leave blank. To define the placement, create a bidding adjustment entity in this campaign    |\n","|Percentage    |Leave blank. The percentage adjustment is defined with the bidding adjustment entity    |\n","|Product Targeting Expression\\*    |Leave blank when creating campaign entity. Only used for manual campaign product targeting entity    |\n","|Audience Id    |Leave blank. To specify a shopper cohort based bid adjustment, create a bidding adjustment entity in this campaign    |\n","|Shopper Cohort Percentage    |Leave blank. The shopper cohort percentage adjustment is defined with the bidding adjustment entity    |\n","|Shopper Cohort Type    |Leave blank. The shopper cohort type is defined with the bidding adjustment entity     |\n","|Sites    |Optional field. Leave blank for default (Amazon and Beyond), or enter \"Amazon Business\" to target Amazon Business exclusively.    |\n","|Off-Amazon ad serving    |Optional field. Allows advertisers to update settings for ads served off Amazon. Enter Increase reach to increase your reach off Amazon (this setting may result in more impressions and opportunities for sales off Amazon), or enter Limit off-Amazon spend to reduce spend off Amazon for low-performing placements (this setting may result in fewer impressions off Amazon, but it can help control spend). Leave blank to use the default setting. Availability: US.    |\n"," After this step, your bulksheets file would look like this—note that “targeting type” is now set to manual:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |sku    |asin    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Audience ID    |Shopper Cohort Percentage    |Shopper Cohort Type    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---   \\|---    \\|---    \\|\n","|Sponsored Products    |Campaign    |Create    |Manual SP Shoes    |    |    |    |    |    |Manual SP Shoes    |    |20240401    |    |Manual    |Enabled    |100    |    |    |    |    |    |    |Fixed bid    |    |    |    |    |    |    |Amazon Business    |    |\n"," To create the ad group, required fields include Product, Entity, Operation, Campaign ID, Ad group ID, Ad group name, State, and Ad group default bid. \n","|gridColumn header    |Guidelines on what to enter    |\n","\\|---    \\|---    \\|\n","|Product    |Sponsored Products    |\n","|Entity    |Ad group    |\n","|Operation    |Create    |\n","|Campaign ID\\*    |Enter the exact same text-based campaign ID that you entered in the \"Campaign\" entity row. This will ensure that the ad group becomes a \"child\" of the top-level campaign \"parent\" entity.    |\n","|Ad Group ID\\*    |For new ad groups, you should type a text-based name to identify the ad group. You will also type this exact same name into the “Entity Name” column for this row.  NOTE: When you upload your bulksheets file, the Ad Group ID will become the actual unique identifier associated with this ad group.    |\n","|Portfolio ID\\*    |Leave blank when creating ad group entity    |\n","|Ad ID\\*    |Leave blank when creating ad group entity    |\n","|Keyword ID\\*    |Leave blank when creating ad group entity    |\n","|Product Targeting ID\\*    |Leave blank when creating ad group entity    |\n","|Campaign Name    |Leave blank when creating ad group entity    |\n","|Ad Group Name    |Enter the same name that you entered in the \"Ad Group ID\" column    |\n","|Start Date\\*    |Leave blank. The start date is set at the campaign level and applies to all child entities    |\n","|End Date    |Leave blank when creating ad group entity    |\n","|Targeting Type\\*    |Leave blank when creating ad group entity    |\n","|State    |Enterenabled to create the ad group.    |\n","|Daily Budget    |Leave blank when creating ad group entity    |\n","|sku\\*    |Leave blank when creating ad group entity    |\n","|asin\\*    |Leave blank when creating ad group entity    |\n","|Ad Group Default Bid    |Enter an exact figure with no money symbols, and use a decimal point (not a comma).  For example, if you want to set this to 75 cents, enter 0.75 NOTE: This default bid amount will apply to all child entities of this ad group if you do not define bids for the child entities explicitly. For instance, if a keyword child entity does not include a defined bid, this default amount would apply.    |\n","|Bid    |Leave blank when creating ad group entity    |\n","|Keyword Text\\*    |Leave blank when creating ad group entity    |\n","|Match Type\\*    |Leave blank when creating ad group entity    |\n","|Bidding Strategy    |Leave blank when creating ad group entity    |\n","|Placement\\*    |Leave blank when creating ad group entity    |\n","|Percentage    |Leave blank when creating ad group entity    |\n","|Product Targeting Expression\\*    |Leave blank when creating ad group entity. Only used for manual campaign product targeting entity    |\n","|Audience Id    |Leave blank when creating ad group entity    |\n","|Shopper Cohort Percentage    |Leave blank when creating ad group entity   |\n","|Shopper Cohort Type    |Leave blank when creating ad group entity     |\n","|Sites    |Leave blank when creating ad group entity    |\n","|Off-Amazon ad serving    |Leave blank when creating ad group entity    |\n"," After adding the ad group entity, your bulksheets file would look like this:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |sku    |asin    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Audience ID    |Shopper Cohort Percentage    |Shopper Cohort Type    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products    |Campaign    |Create    |Manual SP Shoes    |    |    |    |    |    |Manual SP Shoes    |    |20240401    |    |Manual    |Enabled    |100    |    |    |    |    |    |    |Fixed bid    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Ad group    |Create    |Manual SP Shoes    |Running    |    |    |    |    |    |Running    |    |    |    |Enabled    |    |    |    |0.75    |    |    |    |    |    |    |    |    |    |    |    |    |\n"," Required fields include Product, Entity, Operation, Campaign ID, Ad group ID, State, and sku or asin. \n","|gridColumn header    |Guidelines on what to enter    |\n","\\|---    \\|---    \\|\n","|Product    |Sponsored Products    |\n","|Entity    |Product ad    |\n","|Operation    |Create    |\n","|Campaign ID\\*    |Enter the exact same campaign name that you entered in the \"Campaign\" entity row    |\n","|Ad Group ID\\*    |Enter the exact same ad group name that you entered in the \"Ad group ID\" row. (You need Ad Group ID for this entity because the Product ad is a child of the Ad group)    |\n","|Portfolio ID\\*    |Leave blank when creating product ad entity    |\n","|Ad ID\\*    |Leave blank when creating product ad entity    |\n","|Keyword ID\\*    |Leave blank when creating product ad entity    |\n","|Product Targeting ID    |Leave blank when creating product ad entity    |\n","|Campaign Name    |Leave blank when creating product ad entity    |\n","|Ad Group Name    |Leave blank when creating product ad entity    |\n","|Start Date\\*    |Leave blank when creating product ad entity    |\n","|End Date    |Leave blank when creating product ad entity    |\n","|Targeting Type\\*    |Leave blank when creating product ad entity    |\n","|State    |Enter enabled    |\n","|Daily Budget    |Leave blank when creating product ad entity    |\n","|sku\\*    |For sellers, you should enter the product SKU. For vendors, leave the SKU field blank    |\n","|asin\\*    |For vendors, you should enter the product ASIN. For sellers, leave the ASIN field blank    |\n","|Ad Group Default Bid    |Leave blank when creating product ad entity    |\n","|Bid    |Leave blank when creating product ad entity    |\n","|Keyword Text\\*    |Leave blank when creating product ad entity    |\n","|Match Type\\*    |Leave blank when creating product ad entity    |\n","|Bidding Strategy    |Leave blank when creating product ad entity    |\n","|Placement\\*    |Leave blank when creating product ad entity    |\n","|Percentage    |Leave blank when creating product ad entity    |\n","|Product Targeting Expression\\*    |Leave blank when creating product ad entity    |\n","|Audience Id    |Leave blank when creating product ad entity    |\n","|Shopper Cohort Percentage    |Leave blank when creating product ad entity   |\n","|Shopper Cohort Type    |Leave blank when creating product ad entity     |\n","|Sites    |Leave blank when creating product ad entity    |\n","|Off-Amazon ad serving    |Leave blank when creating product ad entity    |\n"," At this point, your file would look like this:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |sku    |asin    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Audience ID    |Shopper Cohort Percentage    |Shopper Cohort Type    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products    |Campaign    |Create    |Manual SP Shoes    |    |    |    |    |    |Manual SP Shoes    |    |20240401    |    |Manual    |Enabled    |100    |    |    |    |    |    |    |Fixed bid    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Ad group    |Create    |Manual SP Shoes    |Running    |    |    |    |    |    |Running    |    |    |    |Enabled    |    |    |    |0.75    |    |    |    |    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Product ad    |Create    |Manual SP Shoes    |Running    |    |    |    |    |    |    |    |    |    |Enabled    |    |BR549    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |\n"," Create this entity only if you want a keyword targeting strategy.  For product targeting, jump to Step 4b. Required fields include Product, Entity, Operation, Campaign ID, Ad group ID, State, Keyword text, and Match type.\n","|gridColumn header    |Guidelines on what to enter    |\n","\\|---    \\|---    \\|\n","|Product    |Sponsored Products    |\n","|Entity    |Keyword    |\n","|Operation    |Create    |\n","|Campaign ID\\*    |Enter the exact same campaign name that you entered in the \"Campaign\" entity row    |\n","|Ad Group ID\\*    |Enter the exact same ad group name that you entered in the \"Ad group ID\" row. (You need Ad Group ID for this entity because the Product ad is a child of the Ad group)    |\n","|Portfolio ID\\*    |Leave blank when creating keyword entity    |\n","|Ad ID\\*    |Leave blank when creating keyword entity    |\n","|Keyword ID\\*    |\\[Leave blank when creating the keyword. This ID will be used for archiving or pausing existing keywords.]    |\n","|Product Targeting ID\\*    |Leave blank when creating keyword entity    |\n","|Campaign Name    |Leave blank when creating keyword entity    |\n","|Ad Group Name    |Leave blank when creating keyword entity    |\n","|Start Date\\*    |Leave blank when creating keyword entity    |\n","|End Date    |Leave blank when creating keyword entity    |\n","|Targeting Type\\*    |Leave blank when creating keyword entity    |\n","|State    |Enter enabled when creating a new keyword. To pause keywords, set the \"Operation\" to update, and enter paused in this field. To archive keywords, set the \"Operation\" to archive and leave this field blank.     |\n","|Daily Budget    |Leave blank when creating keyword entity    |\n","|sku\\*    |Leave blank when creating keyword entity    |\n","|asin\\*    |Leave blank when creating keyword entity    |\n","|Ad Group Default Bid    |Leave blank when creating keyword entity    |\n","|Bid    |To set a keyword-level bid, enter the CPC amount you are willing to pay when a shopper clicks your ad. Be sure your bid is within the limits for your region. Do not use money symbols or commas. For example, to bid 75 cents, enter 0.75. To bid one dollar, enter 1. Leave this field blank if you want the keyword to inherit the ad group default bid.     |\n","|Keyword Text\\*    |Enter the keyword you want to create. To create multiple keywords, add a new row for each keyword.    |\n","|Match Type\\*    |Options are exact, broad, or phrase   |\n","|Bidding Strategy    |Leave blank when creating keyword entity    |\n","|Placement\\*    |Leave blank when creating keyword entity    |\n","|Percentage    |Leave blank when creating keyword entity    |\n","|Product Targeting Expression\\*    |Leave blank when creating keyword entity    |\n","|Audience Id    |Leave blank when creating keyword entity    |\n","|Shopper Cohort Percentage    |Leave blank when creating keyword entity   |\n","|Shopper Cohort Type    |Leave blank when creating keyword entity    |\n","|Sites    |Leave blank when creating keyword entity    |\n","|Off-Amazon ad serving    |Leave blank when creating keyword entity    |\n"," To create additional keywords, add a new row for each keyword. If you add three keywords, your bulksheets file might now look like this:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |sku    |asin    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Audience ID    |Shopper Cohort Percentage    |Shopper Cohort Type    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---   \\|---    \\|---    \\|\n","|Sponsored Products    |Campaign    |Create    |Manual SP Shoes    |    |    |    |    |    |Manual SP Shoes    |    |20240401    |    |Manual    |Enabled    |100    |    |    |    |    |    |    |Fixed bid    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Ad group    |Create    |Manual SP Shoes    |Running    |    |    |    |    |    |Running    |    |    |    |Enabled    |    |    |    |0.75    |    |    |    |    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Product ad    |Create    |Manual SP Shoes    |Running    |    |    |    |    |    |    |    |    |    |Enabled    |    |BR549    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Keyword    |Create    |Manual SP shoes    |Running    |    |    |    |    |    |    |    |    |    |Enabled    |    |    |    |    |1    |shoes    |exact    |    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Keyword    |Create    |Manual SP shoes    |Running    |    |    |    |    |    |    |    |    |    |Enabled    |    |    |    |    |1    |running shoes    |phrase    |    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Keyword    |Create    |Manual SP shoes    |Running    |    |    |    |    |    |    |    |    |    |Enabled    |    |    |    |    |1    |women's shoes    |broad    |    |    |    |    |    |    |    |    |    |\n"," Create this entity only if you want a product targeting strategy. Required fields include Product, Entity, Operation, Campaign ID, Ad group ID, State, Bid, and Product targeting expression.\n","|Column header    |Guidelines on what to enter    |\n","\\|---    \\|---    \\|\n","|Product    |Sponsored Products    |\n","|Entity    |Product targeting    |\n","|Operation    |Create    |\n","|Campaign ID\\*    |Enter the exact same campaign name that you entered in the \"Campaign\" entity row    |\n","|Ad Group ID\\*    |Enter the exact same ad group name that you entered in the \"Ad group ID\" row. (You need Ad Group ID for this entity because the Product targeting is a child of the Ad group)    |\n","|Portfolio ID\\*    |Leave blank when creating product targeting entity    |\n","|Ad ID\\*    |Leave blank when creating product targeting entity    |\n","|Keyword ID\\*    |Leave blank when creating product targeting entity    |\n","|Product Targeting ID\\*    |Leave blank when creating product targeting entity    |\n","|Campaign Name    |Leave blank when creating product targeting entity    |\n","|Ad Group Name    |Leave blank when creating product targeting entity    |\n","|Start Date\\*    |Leave blank when creating product targeting entity    |\n","|End Date    |Leave blank when creating product targeting entity    |\n","|Targeting Type\\*    |Leave blank when creating product targeting entity    |\n","|State    |Enter enabled    |\n","|Daily Budget    |Leave blank when creating product targeting entity    |\n","|sku\\*    |Leave blank when creating product targeting entity    |\n","|asin\\*    |Leave blank when creating product targeting entity    |\n","|Ad Group Default Bid    |Leave blank when creating product targeting entity    |\n","|Bid    |Enter the CPC amount you are willing to pay when a shopper clicks your ad. Be sure your bid is within the limits for your region. Do not use money symbols or commas. For example, to bid 75 cents, enter 0.75. To bid one dollar, enter 1    |\n","|Keyword Text\\*    |Leave blank when creating product targeting entity    |\n","|Match Type\\*    |Leave blank when creating product targeting entity    |\n","|Bidding Strategy    |Leave blank when creating product targeting entity    |\n","|Placement\\*    |Leave blank when creating product targeting entity    |\n","|Percentage    |Leave blank when creating product targeting entity    |\n","|Product Targeting Expression\\*    |In the UI, this is where you select either \"individual products\" or \"categories\" to target. For \"individual products,\" use the ASIN and enter asin=\"A12345\" (using the actual ASIN ID). For expanded product targeting, enter asin-expanded=\"A12345\" (using the actual ASIN ID).For \"categories,\" use the category ID along with other qualifiers such as price limit and star rating. For this field, enter all qualifiers into the same cell of your bulksheets file because they work as a combined unit to define the targeting. Example 1. To target by product category, price, and star rating: category=\"5524098011\" price&lt;49.99 rating>3Example 2. To target by product category and Prime eligibility: category=\"5524098011\" prime-shipping-eligible=\"true\"TIP: To get the numeric values for attributes such as category and age range, you can use past campaign data where you assigned those targeting expressions by exporting the campaign into a bulksheet. Look in the Resolved Targeting Expression (Informational Only) field to see the corresponding category. Learn more about targeting expression rules, and see more sample expressions.\t|\n","|Audience Id    |Leave blank when creating product targeting entity    |\n","|Shopper Cohort Percentage    |Leave blank when creating product targeting entity   |\n","|Shopper Cohort Type    |Leave blank when creating product targeting entity    |\n","|Sites    |Leave blank when creating product targeting entity    |\n","|Off-Amazon ad serving    |Leave blank when creating product targeting entity    |\n"," Now, your bulksheets file might look like this if you add the product targeting expression entity details shown above:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |sku    |asin    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Audience ID    |Shopper Cohort Percentage    |Shopper Cohort Type    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---   \\|---    \\|---    \\|\n","|Sponsored Products    |Campaign    |Create    |Manual SP Shoes    |    |    |    |    |    |Manual SP Shoes    |    |20240401    |    |Manual    |Enabled    |100    |    |    |    |    |    |    |Fixed bid    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Ad group    |Create    |Manual SP Shoes    |Running    |    |    |    |    |    |Running    |    |    |    |Enabled    |    |    |    |0.75    |    |    |    |    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Product ad    |Create    |Manual SP Shoes    |Running    |    |    |    |    |    |    |    |    |    |Enabled    |    |BR549    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |\n","|Sponsored Products    |Product targeting    |Create    |Manual SP shoes    |Running    |    |    |    |    |    |    |    |    |    |Enabled    |    |    |    |    |    |    |    |    |    |    |category=\"20394\" price&lt;19.99    |    |    |    |    |    |\n"],"documentType":"guide"},{"title":"How to create Sponsored Products campaigns with bulksheets","sectionHeader":{"type":3,"text":"Upload your bulksheets file to create the new campaign"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-examples/create-sp-campaign","content":[" At this point, all mandatory entities are included in this Sponsored Products campaign. You can still add more entities if you want to assign negative keyword or product targets. If you are ready to create the campaign, you should save the file and then navigate back to the “Bulk operations” page. \n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| Under “3. Upload your file to update your campaigns,” click Choose file to upload the sheet you just created.  | Upload your file |\n"],"documentType":"guide"},{"title":"How to create Sponsored Products campaigns with bulksheets","sectionHeader":{"type":3,"text":"Optional: Add more entities to the campaign"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-examples/create-sp-campaign","content":[" If you want to add negative product or keyword entities, enter each one into a new row using the process described above. Always include Sponsored Products in the “Product” column for each row, create as the “Operation” for new campaigns, the campaign ID, and set the “State” to enabled. For reference, these are the additional fields you need to complete for the remaining entities:\n"],"documentType":"guide"},{"title":"How to create Sponsored Brands campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/create-sb-campaign","content":[" When you create a Sponsored Brands (SB) campaign, you will need your brand assets information, including some of the IDs found in the \"Brand Assets Data\" tab in a downloaded bulksheets file. Review this article to understand bulksheets downloads and brand assets data.\n"],"documentType":"guide"},{"title":"How to create Sponsored Brands campaigns with bulksheets","sectionHeader":{"type":3,"text":"Create a Sponsored Brands campaign"},"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/create-sb-campaign","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| Allowable entities are shown in the diagram on the right, with required entities shown in green. For SB campaigns, most of the brand-related values are defined at the top-level parent (campaign) entity, so you will usually enter more data in the \"Campaign\" entity row compared with \"Keyword\" and \"Product targeting\" entity rows.Learn more about entity and targeting types, and their relationships to Sponsored Brands campaigns. | Sponsored Brands entity diagram |\n"," Each \"step\" section below represents one row in your bulksheets file. The guidelines describe what you should enter into each field. NOTE: Read-only, informational-only, and metrics columns in your Sponsored Brands bulksheets file are not included in the guide below, and you can ignore these fields completely when you create a new campaign with bulksheets. \n"," TIPS: \n","Be sure to review the Sponsored Brands budget limits and bid limits for your region.  Headers marked with an asterisk  are fields that cannot be updated after you create the campaign.  \\* Sponsored Brands campaigns must be reviewed before they become live. The review process could take up to three days. Learn more about Sponsored Brands moderation. IMPORTANT: Do not edit or alter the bulksheets column headers. This will cause the upload to fail. \n"," Use the guidelines below to define the top-level (parent) campaign entity in the first row of your bulksheets file:\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Campaign\t|\n","|Operation\t|Create\t|\n","|Campaign Id\\*\t|For new campaigns, you should type a text-based name to identify your campaign. You will also enter this exact Campaign ID for each entity you create underneath this parent campaign.  NOTE: When you upload your bulksheets file, the Campaign ID will become the actual unique identifier associated with the campaign and all of its \"child\" entities. So if you want to update this campaign later, you would enter the actual Campaign ID into this field.\t|\n","|Draft Campaign Id\\*\t|Leave blank\t|\n","|Portfolio Id\t|If you want to put the new campaign into a portfolio, enter the portfolio ID. Otherwise, leave blank.\t|\n","|Campaign Name\t|Enter the same campaign name that you entered in the \"Campaign ID\" column.\t|\n","|Start Date\\*\t|Format must be yyyyMMdd. For example, the date April 1, 2022 would be  20220401.  NOTE: You can start on today's date or a future date, but the date cannot  be in the past. So if you set the date for today, be sure you create and  upload the file on today's date. If you leave this field blank, the start date will be set for today's date.\t|\n","|End Date\t|You can leave this field blank if you do not want to set an end date. Otherwise, the format must be yyyyMMdd.\t|\n","|State\t|This is the status you want the campaign to be in after you upload the bulksheets file. To create a new Sponsored Brands campaign, enter enabled.\t|\n","|Budget Type\t|Enter lifetime or daily.\t|\n","|Budget\t|Do not include symbols such as dollar signs or commas. For example, a daily budget of $100 would be written  as 100.  NOTE: Be sure your budget does not exceed the limit for your region.\t|\n","|Bid Optimization\t|Enter auto or manual. If you enter manual, you should enter a value in the \"Bid Multiplier\" column.   In the UI, this is the \"Automated bidding\" toggle. Enter auto if you want to allow Amazon to automatically optimize bids for placements other than top-of-search. Otherwise, enter manual.\t|\n","|Bid Multiplier\t|Enter a positive or negative percentage value to set a custom bid adjustment. For example, to set a 40 percent multiplier, enter 40%.  Leave this field blank if you entered auto for \"Bid Optimization.\"  In the UI, this is a checkbox to Set a custom bid adjustment when automated bidding is not selected.\t|\n","|Bid\t|Leave blank when creating campaign\t|\n","|Keyword Text\\*\t|Leave blank when creating campaign\t|\n","|Match Type\t|Leave blank when creating campaign\t|\n","|Product Targeting Expression\\*\t|Leave blank when creating campaign\t|\n","|Ad Format\t|Enter productCollection or video.  If you select productCollection, you will also need to define the landing page details. For video ad format, you should leave all of the landing page fields blank.  NOTE: When you create a new SB campaign in the UI, you have three options for ad format: \"Product Collection,\" \"Video,\" and \"Store spotlight.\" Bulksheets does not support creating a new \"Store spotlight\" at this time, but you can update\\* this format using bulksheets if you have created a store spotlight in the past.\t|\n","|Landing Page URL\\*\t|Enter a URL if you are using Amazon Store or Custom URL as your landing page type.  Leave blank if you are creating a new landing page. In this case, you should instead enter the product ASINs in the \"Landing Page asins\" column, and Amazon will generate a new landing page for your product collection.  Leave blank if your ad format is video. After you create a video campaign, you will see \"Landing Page Type\" and \"Landing Page URL\" fields populated if you download a bulksheets file. \"Landing Page Type\" will be detailPage. |\n","|Landing Page asins\\*\t|If you are creating a new landing page, enter between 3 and 100 ASINs you want to include in your product collection. You can select up to 3 of these to highlight in the \"Creative asins\" column.  If you are not creating a new landing page, or if your ad format is video, leave this field blank.\t|\n","|Brand Entity Id\\*\t|For sellers only--vendors should leave this field blank  You can find this value in the \"Brand Assets Tab\" when you download campaign data from the \"Bulk operations\" page.  Learn more about brand assets data and bulksheets.\t|\n","|Brand Name\\*\t|Enter your brand name.\t|\n","|Brand Logo Asset Id\\*\t|If your ad format is productCollection, enter the brand logo asset ID. You can find this ID in the \"brand assets data\" tab when you download campaign data from the \"Bulk operations\" page.  Leave blank if ad format is video.\t|\n","|Brand Logo URL\t|Leave blank when you are creating a campaign. After you create a campaign, you will see this URL populated in a downloaded bulksheets file. \t|\n","|Creative Headline\\*\t|Leave blank if ad format is video.  If ad format is productCollection, you should enter any text value, up to 50 characters. In the UI, this is the headline you enter in the \"Creative\" section where you upload creative assets.\t|\n","|Creative asins\\*\t|Enter up to three ASINs for productCollection (separated by commas) or one ASIN if ad format is video. These are the products that will be featured on your landing page.\t|\n","|Video Media Ids\\*\t|If your ad format is video, enter the \"Asset ID\" found in the \"Brand Assets Tab\" of your downloaded bulksheets file.  TIP: To locate the video asset ID, you can filter \"Asset Type\" (Column A) to show video assets. This might make it easier to find the ID in the \"Asset ID\" column (Column C) |\n","|Creative Type\\*\t|Enter video if your ad format is video. Leave blank if ad format is productCollection.\t|\n"," Putting it all together, this bulksheets row for a video ad format might look like this:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Draft Campaign Id\t|Portfolio Id\t|Campaign Name\t|Start Date\t|End Date\t|State\t|Budget Type\t|Budget\t|Bid Optimization\t|Bid Multiplier\t|Bid\t|Keyword Text\t|Match Type\t|Product Targeting Expression\t|Ad Format\t|Landing Page URL\t|Landing Page asins\t|Brand Entity Id\t|Brand Name\t|Brand Logo Asset Id\t|Brand Logo URL\t|Creative Headline\t|Creative asins\t|Video Media Ids\t|Creative Type\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|New Campaign\t|20220101\t|\t|Enabled\t|Daily\t|100\t|Auto\t|\t|\t|\t|\t|\t|video\t|\t|\t|ENTITY1A0PDCYJI5DZG\t|My Brand\t|\t|https&#x3A;//m.media-amazon.com/image.png\t|\t|B0099HD3Y\t|amzn1.assetlibrary.asset1.1031d1a8ae14a71cf04b6e428ec5d276\t|video\t|\n"," To create the campaign entity using a productCollection ad format with an Amazon Store landing page might look like this:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Draft Campaign Id\t|Portfolio Id\t|Campaign Name\t|Start Date\t|End Date\t|State\t|Budget Type\t|Budget\t|Bid Optimization\t|Bid Multiplier\t|Bid\t|Keyword Text\t|Match Type\t|Product Targeting Expression\t|Ad Format\t|Landing Page URL\t|Landing Page asins\t|Brand Entity Id\t|Brand Name\t|Brand Logo Asset Id\t|Brand Logo URL\t|Creative Headline\t|Creative asins\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|New Campaign\t|20220101\t|\t|Enabled\t|Daily\t|100\t|Auto\t|\t|\t|\t|\t|\t|productCollection\t|www.mystore.com\t|\t|ENTITY83028\t|My Brand\t|BR549003\t|\t|My Headline\t|asin1, asin2, asin3\t|\n"," Next, you enter the targeting details in the row underneath the campaign. The entity type will depend on whether you want keyword or product targeting. \n"," In the next row of your bulksheets file, use the following guidelines to define the \"Keyword\" entity for this campaign:\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Keyword\t|\n","|Operation\t|Create\t|\n","|Campaign Id\\*\t|Enter the exact same campaign name that you entered in the \"Campaign\" entity row. This will ensure that the keyword is associated with the top-level campaign \"parent\" entity.\t|\n","|Draft Campaign Id\\*\t|Leave blank\t|\n","|Portfolio Id\t|Leave blank for keyword entity\t|\n","|Campaign Name\t|Leave blank for keyword entity\t|\n","|Start Date\\*\t|Leave blank for keyword entity\t|\n","|End Date\t|Leave blank for keyword entity\t|\n","|State\t|To create the keyword, enter enabled.  For existing keywords that you want to stop running, you could enter paused here and include the keyword ID.\t|\n","|Budget Type\t|Leave blank for keyword entity\t|\n","|Budget\t|Leave blank for keyword entity\t|\n","|Bid Optimization\t|Leave blank for keyword entity\t|\n","|Bid Multiplier\t|Leave blank for keyword entity\t|\n","|Bid\t|Enter the CPC amount you are willing to pay when a shopper clicks your ad. Do not use money symbols or commas. For example, to bid 75 cents, enter 0.75. To bid one dollar, enter 1. NOTE: There is a 2-place decimal limit. If you enter a number with more than 2 decimal places, you will get an error when you upload the file.\t|\n","|Keyword Text\\*\t|Enter one keyword or phrase. To add more keywords, create a new row for each keyword entity.\t|\n","|Match Type\t|Options are: broad, phrase, exact\t|\n","|Product Targeting Expression\\*\t|Leave blank for keyword entity\t|\n","|Ad Format\\*\t|Leave blank for keyword entity\t|\n","|Landing Page URL\\*\t|Leave blank for keyword entity\t|\n","|Landing Page asins\\*\t|Leave blank for keyword entity\t|\n","|Brand Entity Id\\*\t|Leave blank for keyword entity\t|\n","|Brand Name\\*\t|Leave blank for keyword entity\t|\n","|Brand Logo Asset Id\\*\t|Leave blank for keyword entity\t|\n","|Brand Logo URL\t|Leave blank for keyword entity\t|\n","|Creative Headline\\*\t|Leave blank for keyword entity\t|\n","|Creative asins\\*\t|Leave blank for keyword entity\t|\n","|Video Media Ids\\*\t|Leave blank for keyword entity\t|\n","|Creative Type\\*\t|Leave blank for keyword entity\t|\n"," If you add two keywords to a Sponsored Brands \"Product Collection,\" your sheet might look like this:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Draft Campaign Id\t|Portfolio Id\t|Campaign Name\t|Start Date\t|End Date\t|State\t|Budget Type\t|Budget\t|Bid Optimization\t|Bid Multiplier\t|Bid\t|Keyword Text\t|Match Type\t|Product Targeting Expression\t|Ad Format\t|Landing Page URL|Landing Page asins\t|Brand Entity Id\t|Brand Name\t|Brand Logo Asset Id\t|Brand Logo URL\t|Creative Headline\t|Creative asins\t|Video Media Ids\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\n","|Sponsored Brands\t|Keyword\t|Create\t|NewCampaign\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|0.75\t|6th grade math\t|exact\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Keyword\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|1\t|math books kids\t|phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"," Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|New Campaign\t|20220101\t|\t|Enabled\t|Daily\t|100\t|Auto\t|\t|\t|\t|\t|\t|productCollection\t|www.mystore.com\t|store\t|\t|ENTITY83028\t|My Brand\t|BR549003\t|My headline\t|asin1, asin2, asin3\t|\t|\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Product targeting\t|\n","|Operation\t|Create\t|\n","|Campaign Id\\*\t|Enter the exact same campaign name that you entered in the \"Campaign\" entity row.\t|\n","|Draft Campaign Id\\*\t|Leave blank for product targeting\t|\n","|Ad Group Id\\*\t|Leave blank for product targeting\t|\n","|Portfolio Id\t|Leave blank for product targeting\t|\n","|Keyword Id\t|Leave blank for product targeting\t|\n","|Product Targeting Id\t|Leave blank when creating a new campaign. For updating or archiving, you would enter the actual product targeting ID. \t|\n","|Entity Name\t|Leave blank for product targeting\t|\n","|Start Date\\*\t|Leave blank for product targeting\t|\n","|End Date\t|Leave blank for product targeting\t|\n","|Ad Format\\* |Leave blank for product targeting\t|\n","|Budget Type\t|Leave blank for product targeting\t|\n","|Budget\t|Leave blank for product targeting\t|\n","|Bid Optimization\t|Leave blank for product targeting\t|\n","|Bid Multiplier\t|Leave blank for product targeting\t|\n","|State\t|To create a product targeting entity, enter enabled.  NOTE: Options are enabled or paused.\t|\n","|Bid\t|Enter the CPC amount you are willing to pay when a shopper clicks your ad. Do not use money symbols or commas. For example, to bid 75 cents, enter 0.75. To bid one dollar, enter 1.\t|\n","|Keyword Text\\*\t|Leave blank for product targeting\t|\n","|Match Type\\*\t|Leave blank for product targeting\t|\n","|Product Targeting Expression\\*\t|In the UI, this is where you select either \"individual products\" or \"categories\" to target. For \"individual products,\" use the ASIN and enter asin=\"A000000000000\" (using the actual ASIN ID--note that in this field, asin must be entered all lowercase as shown). For \"categories,\" use the category ID along with other qualifiers such as price limit and star rating. For this field, enter all qualifiers into the same cell of your bulksheets file because they work as a combined unit to define the targeting.    Example 1. To target by product category, price, and star rating: category=\"5524098011\" price&lt;49.99 rating>3   Example 2. To target by product category and Prime eligibility: category=\"5524098011\" prime-shipping-eligible=\"true\"   Learn more about targeting expression rules, and see more sample expressions.  TIP: To get the numeric values for attributes such as category and age range, you can use past campaign data where you assigned those targeting expressions by exporting the campaign into a bulksheet.\t|\n","|Landing Page URL\\*\t|Leave blank for product targeting\t|\n","|Landing Page asins\\*\t|Leave blank for product targeting\t|\n","|Brand Entity Id\\*\t|Leave blank for product targeting\t|\n","|Brand Name\\*\t|Leave blank for product targeting\t|\n","|Brand Logo Asset Id\\*\t|Leave blank for product targeting\t|\n","|Brand Logo URL\t|You can leave this blank when you are creating a campaign, and the system will generate a URL that you will find in the \"Brand Assets Data\" tab of a downloaded bulksheet. But if you have a Brand Logo URL that you want to use, you can include it in this field when creating the campaign. \t|\n","|Creative Headline\\*\t|Leave blank for product targeting\t|\n","|Creative Asins\\*\t|Leave blank for product targeting\t|\n","|Video Media Ids\\*\t|Leave blank for product targeting\t|\n","|Creative Type\\*\t|Leave blank for product targeting\t|\n"," After you add the product targeting entity data, your bulksheets file might now look like this:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Draft Campaign Id\t|Portfolio Id\t|Campaign Name\t|Start Date\t|End Date\t|State\t|Budget Type\t|Budget\t|Bid Optimization\t|Bid Multiplier\t|Bid\t|Keyword Text\t|Match Type\t|Product Targeting Expression\t|Ad Format\t|Landing Page URL\t|Landing Page asins\t|Brand Entity Id\t|Brand Name\t|Brand Logo Asset Id\t|Brand Logo URL\t|Creative Headline\t|Creative asins\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|New Campaign\t|20220101\t|\t|Enabled\t|Daily\t|100\t|Auto\t|\t|\t|\t|\t|\t|productCollection\t|www.mystore.com\t|\t|ENTITY83028\t|My Brand\t|BR549003\t|\t|My Headline\t|asin1, asin2, asin3\t|\n"," Sponsored Brands\t|Product targeting\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|0.75\t|\t|\t|asin=\"BR5490003\"\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"," At this point, all mandatory entities are included in this auto targeting Sponsored Brands campaign. (Or you can still add more entities if you want to add negative targeting) If you are ready to create the campaign, you should save the file and then navigate back to the \"Bulk operations\" page. \n","| IMAGE |  |\n","|----\t|----\t|\n","| Under \"3. Upload your file to update your campaigns,\" click Choose file to upload the sheet you just created. |Upload your file|\n"," If you want to add more entities, such as negative keywords, you can continue adding each new entity into a new row using the process described above. Be sure to always include Sponsored Brands in the \"Product\" column for each row, along with Create as the \"Operation\" for new campaigns. For reference, here are the additional fields you need to complete for the remaining entities:\n"],"documentType":"guide"},{"title":"How to create Sponsored Brands multi-ad group campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/create-sb-campaign","content":[],"documentType":"guide"},{"title":"How to create Sponsored Brands multi-ad group campaigns with bulksheets","sectionHeader":{"type":3,"text":"Create a Sponsored Brands multi-ad group campaign"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/create-sb-campaign","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","|The following steps will guide you through creating a new Sponsored Brands multi-ad group campaign. Allowable entities are shown in the diagram on the right, with required entities shown in solid pink →  The entities outlined in pink represent choices you need to make depending on your campaign strategy: For example, you need to choose an ad format from the five options shown, as well as a targeting strategy (either keyword or product targeting).  |Multi-ad group entity diagram|\n"," Learn more about entities and targeting types, and their relationships to Sponsored Brands multi-ad group campaigns. \n"," Each step section below represents one row in your bulksheets file. The guidelines describe what you should enter into each field. Note that the read-only, informational-only, and metrics columns are not included in the guidelines below, and you can ignore these fields completely when you create new campaigns.  Also note that these steps are for a campaign that includes a bidding adjustment by placement, with a Manual Collection ad format. See note below \n"," Note about ad formats: As you see in the steps below, you will have an entity row to define your desired Ad format. Similar to what you would see in the advertising console, you will define a “Landing page type“ in this row, which is related to the Ad format. For instance, a Store spotlight will drive shoppers to your ”Store on Amazon“ landing page whereas a Manual Collection ad can send shoppers either to a ”Store on Amazon“ landing page or a ”New landing page“ that we create based on the ASINs you provide. Options include Manual Collection ad, Auto Collection ad, Store spotlight ad, Video ad, or Brand video ad. The previously available Product collection ad is deprecated — use Manual Collection ad or Auto Collection ad instead.\n"," For additional information about how to create different ad formats, see Examples of Sponsored Brands multi-ad group campaigns in bulksheets\n"," Required fields include: Product, Entity, Operation, Campaign ID, Campaign name, Budget type, Budget, and Bid optimization\n"," Use the guidelines below to define the top-level (parent) campaign entity in the first row of your bulksheets file:\n","|Column header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Campaign\t|\n","|Operation\t|Create\t|\n","|Campaign ID\t|For new campaigns, you should type a text-based name to identify your campaign. You will also enter this exact Campaign ID for each entity you create underneath this parent campaign.  NOTE: When you upload your bulksheets file, the Campaign ID will become the actual unique identifier associated with the campaign and all of its \"child\" entities. So if you want to update this campaign later, you would enter the actual Campaign ID into this field.\t|\n","|Portfolio ID\t|If you want to put the new campaign into a portfolio, enter the portfolio ID. Otherwise, leave blank.\t|\n","|Ad Group ID\t|Leave blank when creating campaign entity\t|\n","|Ad ID\t|Leave blank when creating campaign entity\t|\n","|Keyword ID\t|Leave blank when creating campaign entity\t|\n","|Product Targeting ID\t|Leave blank when creating campaign entity\t|\n","|Campaign name\t|Enter the same campaign name that you entered in the \"Campaign ID\" column\t|\n","|Ad group name\t|Leave blank when creating campaign entity\t|\n","|Ad name\t|Leave blank when creating campaign entity\t|\n","|Start date\t|You can leave this field blank, and the start date will default to today's date. If you want to enter a date, the format must be yyyyMMdd. For example, the date December 1, 2024 would be  20241201. NOTE: You can start on today's date or a future date, but the date cannot  be in the past. So if you manually set the date for today, be sure you create and  upload the file on today's date.\t|\n","|End date\t|You can leave this field blank if you do not want to set an end date. Otherwise, the format must be yyyyMMdd.\t|\n","|State\t|Enter enabled if you want the campaign to go live. You can also enter paused for now, and then change the \"State\" to enabled when you want it to start. \t|\n","|Brand Entity ID\t|For sellers only, vendors should leave this field blank.  This value is located in the Brand Assets Tab when you download campaign data from the Bulk operations page.  Learn more about brand assets data and bulksheets.\t|\n","|Budget type\t|Enter Lifetime or Daily\t|\n","|Budget\t|Enter the max value you want to spend for your budget. Do not include symbols such as dollar signs or commas. For example, a budget of $100 would be written  as 100  NOTE: Be sure your budget does not exceed the limit for your region\t|\n","|Bid optimization\t|Enter true if you want Amazon to automatically adjust your budget. Enter false if you want to define a custom bidding adjustment by placement. If you enter false, you should create a new entity row underneath this campaign for a Bidding adjustment by placement entity. For this example, we enter false so we can enter a custom bid adjustment in the next row. The remaining fields can be left blank when creating the Campaign entity.\t|\n","|Sites    |Optional field. Leave blank for default (Amazon and Beyond), or enter \"Amazon Business\" to target Amazon Business exclusively.    |\n"," Putting it all together, the “campaign” entity row might look like this:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Sites    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---    |\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|New Campaign\t|\t|\t|\t|\t|Enabled\t|\t|Daily\t|100\t|FALSE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Amazon Business    |\n"," Since we entered “false” for the Bid optimization value, we need to define a custom “bidding adjustment” entity. Required fields include: Product, Entity, Operation, Campaign ID, Placement, and a numeric value for the Percentage.\n"," Use the guidelines below to define this entity row. \n","|Column header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Bidding adjustment by placement\t|\n","|Operation\t|Create\t|\n","|Campaign ID\t|Enter the exact same campaign ID that you entered in the \"Campaign\" entity row\t|\n","|Portfolio ID\t|Leave blank for bidding adjustment entity\t|\n","|Ad Group ID\t|Leave blank for bidding adjustment entity\t|\n","|Ad ID\t|Leave blank for bidding adjustment entity\t|\n","|Keyword ID\t|Leave blank for bidding adjustment entity\t|\n","|Product Targeting ID\t|Leave blank for bidding adjustment entity\t|\n","|Campaign name\t|Leave blank for bidding adjustment entity\t|\n","|Ad group name\t|Leave blank for bidding adjustment entity\t|\n","|Ad name\t|Leave blank for bidding adjustment entity\t|\n","|Start date\t|Leave blank for bidding adjustment entity\t|\n","|End date\t|Leave blank for bidding adjustment entity\t|\n","|State\t|Leave blank for bidding adjustment entity\t|\n","|Brand Entity ID\t|Leave blank for bidding adjustment entity\t|\n","|Budget type\t|Leave blank for bidding adjustment entity\t|\n","|Budget\t|Leave blank for bidding adjustment entity\t|\n","|Bid optimization\t|Leave blank for bidding adjustment entity\t|\n","|Product location\t|Leave blank for bidding adjustment entity\t|\n","|Bid\t|Leave blank for bidding adjustment entity\t|\n","|Placement\t|Enter Home, Detail page, or Other. Note that after you create this campaign, you will see three \"Bidding adjustment\" rows in the downloaded file--one for each placement type. The placements that you did not explicitly set a value for will have a value of 0. To update these entities after creating the campaign, set the \"Operation\" field to Update, and change the \"Percentage\" value. \t|\n","|Percentage\t|Enter a positive or negative value to set a custom bid adjustment. For example, to set a 40 percent multiplier, enter 40.\t|\n","|Sites    |Leave blank for bidding adjustment entity    |\n"," After you add the “bidding adjustment by placement” row, your spreadsheet might look like this: \n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Sites    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---    |\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|New Campaign\t|\t|\t|\t|\t|Enabled\t|\t|Daily\t|100\t|FALSE\t|\t|100\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Bidding adjustment by placement\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Home\t|40%\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n"," Next, you enter the Ad group details in the row underneath the campaign. Required fields include: Product, Entity, Operation, Campaign ID, Ad group ID, Ad group name, and State.\n"," In the next row of your bulksheets file, use the following guidelines to define the “Ad group” entity for this campaign:\n","|Column header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Ad group\t|\n","|Operation\t|Create\t|\n","|Campaign ID\t|Enter the exact same campaign ID that you entered in the \"Campaign\" entity row. This will ensure that the ad group becomes a \"child\" of the top-level campaign \"parent\" entity.\t|\n","|Portfolio ID\t|Leave blank for Ad group entity\t|\n","|Ad Group ID\t|For new ad groups, you should type a text-based name to identify the ad group. You will also type this exact same name into the “Entity Name” column for this row. NOTE: When you upload your bulksheets file, the Ad Group ID will become the actual unique identifier associated with this ad group. You will use this unique ID if you want to update this ad group later. \t|\n","|Ad ID\t|Leave blank for Ad group entity\t|\n","|Keyword ID\t|Leave blank for Ad group entity\t|\n","|Product Targeting ID\t|Leave blank for Ad group entity\t|\n","|Campaign name\t|Leave blank for Ad group entity\t|\n","|Ad group name\t|Enter the same name that you entered in the \"Ad Group ID\" column\t|\n","|Ad name\t|Leave blank for Ad group entity\t|\n","|Start date\t|Leave blank for Ad group entity\t|\n","|End date\t|Leave blank for Ad group entity\t|\n","|State\t|Enter enabled \n","|Sites    |Leave blank for ad group entity    |\n"," The remaining fields can be left blank for the \"Ad group\" entity row. \t|\n"," Putting it all together, your spreadsheet rows might now look like this:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Sites    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---    |\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|New Campaign\t|\t|\t|\t|\t|Enabled\t|\t|Daily\t|100\t|FALSE\t|\t|100\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Bidding adjustment by placement\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Home\t|40%\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|Create\t|New Campaign\t|\t|New Ad group\t|\t|\t|\t|\t|New Ad group\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n"," You could add more ad groups to this campaign by repeating the previous step. \n"," In the next row of your bulksheets file, use the following guidelines to define the ad format that you want for this campaign and ad group. Options include Manual Collection ad, Auto Collection ad, Store spotlight ad, Video ad, or Brand video ad. The previously available Product collection ad is deprecated — use Manual Collection ad or Auto Collection ad instead.\n"," For additional information about how to create different ad formats, see Examples of Sponsored Brands multi-ad group campaigns in bulksheets\n"," With Manual Collection, you feature 3–10 related products you choose from your catalog. Collection ads display your brand logo, a title, and a call-to-action that directs shoppers to a branded experience.\n"," Required fields include: Product, Entity, Operation, Campaign ID, Ad Group ID, Ad name, State, Brand name, Creative ASINs (3-10)\n"," Optional fields include: Landing page type, Landing page URL, Ad Title, Brand logo asset ID, Brand logo crop\n","|Column header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Manual Collection ad\t|\n","|Operation\t|Create\t|\n","|Campaign ID\t|Enter the exact same Campaign ID that you entered in the \"Campaign\" entity row. This will ensure that the ad becomes a \"child\" of the top-level campaign \"parent\" entity.\t|\n","|Portfolio ID\t|Leave blank for Manual Collection ad entity\t|\n","|Ad Group ID\t|Enter the exact same Ad group ID that you entered in the \"Ad group\" entity row.\t|\n","|Ad ID\t|Leave blank for Manual Collection ad entity\t|\n","|Keyword ID\t|Leave blank for Manual Collection ad entity\t|\n","|Product Targeting ID\t|Leave blank for Manual Collection ad entity\t|\n","|Campaign name\t|Leave blank for Manual Collection ad entity\t|\n","|Ad group name\t|Leave blank for Manual Collection ad entity\t|\n","|Ad name\t|Enter a unique name for the ad\t|\n","|Start date\t|Leave blank for Manual Collection ad entity\t|\n","|End date\t|Leave blank for Manual Collection ad entity\t|\n","|State\t|Enter enabled\t|\n","|Sites\t|Leave blank for Manual Collection ad entity\t|\n","|Brand Entity ID\t|If you are a seller, you can find this value in the \"Brand assets data\" tab in a downloaded bulksheets file. If you are a vendor, leave this field blank.\t|\n","|Budget type\t|Leave blank for Manual Collection ad entity\t|\n","|Budget\t|Leave blank for Manual Collection ad entity\t|\n","|Bid optimization\t|Leave blank for Manual Collection ad entity\t|\n","|Product location\t|Leave blank for Manual Collection ad entity\t|\n","|Bid\t|Leave blank for Manual Collection ad entity\t|\n","|Placement\t|Leave blank for Manual Collection ad entity\t|\n","|Percentage\t|Leave blank for Manual Collection ad entity\t|\n","|Keyword text\t|Leave blank for Manual Collection ad entity\t|\n","|Match type\t|Leave blank for Manual Collection ad entity\t|\n","|Native language keyword\t|Leave blank for Manual Collection ad entity\t|\n","|Native language locale\t|Leave blank for Manual Collection ad entity\t|\n","|Product targeting expression\t|Leave blank for Manual Collection ad entity\t|\n","|Landing page URL\t|The landing page is where shoppers are directed after they click on your ad title, brand logo, or \"Shop\" call-to-action. You can leave this field blank and Amazon will create a new landing page featuring the products in your ad. If you want to use an existing Store on Amazon page, enter the URL in this field.\t|\n","|Landing page ASINs\t|Leave blank for Manual Collection ad entity. Your advertised ASINs are listed in the Creative ASINs field.\t|\n","|Landing page type\t|Enter Product list to direct shoppers to a new landing page featuring the ASINs in your ad. Enter Store to use a Brand Store page as the landing page — and include the URL in the Landing page URL field above. You can also leave this field blank and it will default to a Product list page.\t|\n","|Brand name\t|Enter your brand name or the name of the brand you want to manage\t|\n","|Consent to translate\t|Leave blank for Manual Collection ad entity\t|\n","|Brand logo asset ID\t|Optional. Enter the ID for your brand logo. You can locate this in a downloaded bulksheets file if you include \"Brand assets data\" from the checklist before you download the file. The ID will look something like this: amzn1.assetlibrary.asset1.38f47f3. If omitted, no logo is displayed.\t|\n","|Brand logo crop\t|Leave this field blank if your image does not need to be resized. If your logo needs to be resized, enter the following string with desired pixel sizes: {\"left\":\"0\",\"top\":\"0\",\"width\":\"0\",\"height\":\"0\"}. Note that 400 x 400 is the minimum px size.\t|\n","|Custom images\t|Leave blank for Manual Collection ad entity. Custom images are not supported for collection ads.\t|\n","|Creative headline\t|Leave blank, not applicable for Manual Collection ads. Manual Collection ads use Ad Title rather than headlines.\t|\n","|Creative ASINs\t|Enter 3 to 10 ASINs, separated by a comma, that you want to feature in your collection. All ASINs must be in-stock and belong to your registered brand.\t|\n","|Video asset IDs\t|Leave blank for Manual Collection ad entity\t|\n","|Sub-pages\t|Leave blank for Manual Collection ad entity\t|\n","|Ad Title\t|Optional. A short custom title displayed on the collection ad creative (maximum 32 characters). Use this to communicate your brand message or highlight a product theme (e.g., \"Summer Essentials\" or \"Best Sellers\"). If left blank, Amazon will auto-generate a title based on the products in your collection.\t|\n","|Product Exclusions\t|Leave blank for Manual Collection ad entity. Product exclusions are only used for Auto Collection ads.\t|\n"," After adding the Manual Collection ad row, your spreadsheet might look like this:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Product Exclusions\t|Ad Title\t|Sites\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|New Campaign\t|\t|\t|\t|\t|Enabled\t|\t|Daily\t|100\t|FALSE\t|\t|100\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Bidding adjustment by placement\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|Home\t|30%\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Ad group\t|Create\t|New Campaign\t|\t|New Ad group\t|\t|\t|\t|\t|New Ad group\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Manual Collection ad\t|Create\t|New Campaign\t|\t|New Ad group\t|\t|\t|\t|\t|\t|My Ad name\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/23F9CB2E\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|\t|B00K7M3T8Q, B09NXWL4HP, B07DFGR2YZ, B0CRJ5V8KN, B08PQLM7FW, B0BHT9X2RD, B06YKZW3JC, B0DFL4N9MS, B07XKRN5VB, B09GTWY6PL\t|\t|\t|\t|My Ad Title\t|\t|\n"," With Auto Collection, Amazon AI dynamically groups the most relevant products from your catalog into collections based on your keyword targets and shopper search queries.\n"," Required fields include: Product, Entity, Operation, Campaign ID, Ad Group ID, Ad name, State, Brand name\n"," Optional fields include: Product Exclusions, Brand logo asset ID, Brand logo crop\n","|Column header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Auto Collection ad\t|\n","|Operation\t|Create\t|\n","|Campaign ID\t|Enter the exact same Campaign ID that you entered in the \"Campaign\" entity row.\t|\n","|Portfolio ID\t|Leave blank for Auto Collection ad entity\t|\n","|Ad Group ID\t|Enter the exact same Ad group ID that you entered in the \"Ad group\" entity row.\t|\n","|Ad ID\t|Leave blank for Auto Collection ad entity\t|\n","|Keyword ID\t|Leave blank for Auto Collection ad entity\t|\n","|Product Targeting ID\t|Leave blank for Auto Collection ad entity\t|\n","|Campaign name\t|Leave blank for Auto Collection ad entity\t|\n","|Ad group name\t|Leave blank for Auto Collection ad entity\t|\n","|Ad name\t|Enter a unique name for the ad\t|\n","|Start date\t|Leave blank for Auto Collection ad entity\t|\n","|End date\t|Leave blank for Auto Collection ad entity\t|\n","|State\t|Enter enabled\t|\n","|Sites\t|Leave blank for Auto Collection ad entity\t|\n","|Brand Entity ID\t|Sellers: find in \"Brand assets data\" tab. Vendors: leave blank.\t|\n","|Budget type\t|Leave blank for Auto Collection ad entity\t|\n","|Budget\t|Leave blank for Auto Collection ad entity\t|\n","|Bid optimization\t|Leave blank for Auto Collection ad entity\t|\n","|Product location\t|Leave blank for Auto Collection ad entity\t|\n","|Bid\t|Leave blank for Auto Collection ad entity\t|\n","|Placement\t|Leave blank for Auto Collection ad entity\t|\n","|Percentage\t|Leave blank for Auto Collection ad entity\t|\n","|Keyword text\t|Leave blank for Auto Collection ad entity\t|\n","|Match type\t|Leave blank for Auto Collection ad entity\t|\n","|Native language keyword\t|Leave blank for Auto Collection ad entity\t|\n","|Native language locale\t|Leave blank for Auto Collection ad entity\t|\n","|Product targeting expression\t|Leave blank for Auto Collection ad entity\t|\n","|Landing page URL\t|Leave blank for Auto Collection ad entity — Amazon auto-generates landing page\t|\n","|Landing page ASINs\t|Leave blank for Auto Collection ad entity\t|\n","|Landing page type\t|Leave blank for Auto Collection ad entity — Amazon defaults to Product list landing page type\t|\n","|Brand name\t|Enter your brand name or the name of the brand you want to manage\t|\n","|Consent to translate\t|Leave blank for Auto Collection ad entity\t|\n","|Brand logo asset ID\t|Optional. Enter the ID for your brand logo. You can locate this in a downloaded bulksheets file if you include \"Brand assets data\" from the checklist before you download the file. The ID will look something like this: amzn1.assetlibrary.asset1.38f47f3. If omitted, no logo is displayed.\t|\n","|Brand logo crop\t|Leave this field blank if your image does not need to be resized. If your logo needs to be resized, enter the following string with desired pixel sizes: {\"left\":\"0\",\"top\":\"0\",\"width\":\"0\",\"height\":\"0\"}. Note that 400 x 400 is the minimum px size.\t|\n","|Custom images\t|Leave blank for Auto Collection ad entity. Custom images are not supported for collection ads.\t|\n","|Creative headline\t|Leave blank — not applicable for collection ads\t|\n","|Creative ASINs\t|Leave blank for Auto Collection ad entity — Amazon automatically selects and groups the most relevant products from your brand catalog based on your keyword targets and shopper search queries.\t|\n","|Video asset IDs\t|Leave blank for Auto Collection ad entity\t|\n","|Sub-pages\t|Leave blank for Auto Collection ad entity\t|\n","|Ad Title\t|Leave blank for Auto Collection ad entity — Amazon automatically generates a title based on the products in your collection.\t|\n","|Product Exclusions\t|Optional. Enter a comma-separated list of product ASINs to exclude from the Amazon automatic product selection (maximum 1,000 ASINs). Use this to prevent specific products from appearing in the automatic curated collection.\t|\n"," After adding the Auto Collection ad row, your spreadsheet might look like this:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Product Exclusions\t|Ad Title\t|Sites\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|New Campaign\t|\t|\t|\t|\t|Enabled\t|\t|Daily\t|100\t|FALSE\t|\t|100\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Bidding adjustment by placement\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|Home\t|30%\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Ad group\t|Create\t|New Campaign\t|\t|New Ad group\t|\t|\t|\t|\t|New Ad group\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Auto Collection ad\t|Create\t|New Campaign\t|\t|New Ad group\t|\t|\t|\t|\t|\t|My Ad name\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|\t|\t|\t|\t|B0BNRV8H4J, B08WJDM6KT, B0CXLP3F7N, B07HZTQ9RW, B09KFML2YC, B0DTN8V5XG, B06XRPW4JH, B0BQK7M3FS, B08YLCN9DV, B09VHWT6KP\t|\t|\t|\n"," For this campaign, we use keyword targeting. If you want to use product targeting instead, you can find an example in Examples of Sponsored Brands multi-ad group campaigns\n"," For keyword targeting, required fields include: Product, Entity, Operation, Campaign ID, Ad group ID, State, Bid, Keyword text, and Match type\n","|Column header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Brands\t|\n","|Entity\t|Keyword\t|\n","|Operation\t|Create\t|\n","|Campaign ID\t|Enter the exact same Campaign ID that you entered in the \"Campaign\" entity row\t|\n","|Portfolio ID\t|Leave blank for keyword targeting\t|\n","|Ad Group ID\t|Use the exact same Ad group ID that you entered in the \"Ad group\" entity row\t|\n","|Ad ID\t|Leave blank for keyword targeting\t|\n","|Keyword ID\t|Leave blank when creating a new keyword entity. To update the keyword later, use the system-generated Keyword ID that you can find in a downloaded bulksheets file. \t|\n","|Product Targeting ID\t|Leave blank for keyword entity\t|\n","|Campaign name\t|Leave blank for keyword entity\t|\n","|Ad group name\t|Leave blank for keyword entity\t|\n","|Ad name\t|Leave blank for keyword entity\t|\n","|Start date\t|Leave blank for keyword entity\t|\n","|End date\t|Leave blank for keyword entity\t|\n","|State\t|To create the keyword, enter enabled. For existing keywords that you want to stop running, you could enter paused here and include the keyword ID.\t|\n","|Brand Entity ID\t|Leave blank for keyword entity\t|\n","|Budget type\t|Leave blank for keyword entity\t|\n","|Budget\t|Leave blank for keyword entity\t|\n","|Bid optimization\t|Leave blank for keyword entity\t|\n","|Product location\t|Leave blank for keyword entity\t|\n","|Bid\t|Enter the CPC amount you are willing to pay when a shopper clicks your ad. Do not use money symbols or commas. For example, to bid 75 cents, enter 0.75. To bid one dollar, enter 1.\t|\n","|Placement\t|Leave blank for keyword entity\t|\n","|Percentage\t|Leave blank for keyword entity\t|\n","|Keyword text\t|Enter one keyword or phrase. To add more keywords, create a new row for each keyword entity.\t|\n","|Match type\t|Options are: broad, phrase, exact\t|\n","|Sites    |Leave blank for keyword targeting entity    |\n"," After you add the keyword targeting entity data, your bulksheets file might now look like this:\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Product Exclusions\t|Ad Title\t|Sites    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---    |\n","|Sponsored Brands\t|Campaign\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|New Campaign\t|\t|\t|\t|\t|Enabled\t|\t|Daily\t|100\t|FALSE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Bidding adjustment by placement\t|Create\t|New Campaign\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|Create\t|New Campaign\t|\t|New Ad group\t|\t|\t|\t|\t|New Ad group\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Manual Collection ad\t|Create\t|New Campaign\t|\t|New Ad group\t|\t|\t|\t|\t|\t|My ad name\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/23F9CB2E\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|\t|B00K7M3T8Q, B09NXWL4HP, B07DFGR2YZ, B0CRJ5V8KN, B08PQLM7FW\t|\t|\t|\t|My Ad Title\t|    |\n","|Sponsored Brands\t|Keyword\t|Create\t|New Campaign\t|\t|New Ad group\t|\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|1\t|\t|\t|My Keyword\t|phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n"," At this point, all mandatory entities are included in this Sponsored Brands multi-ad group campaign—but you could add more ad groups or targets by following the same steps explained above. \n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","|If you are ready to create the campaign, you should save the file and then navigate back to the “Bulk operations” page.   Under “3. Upload your file to update your campaigns,” click Choose file to upload the sheet you just created.  |Upload bulksheets file|\n"," If you want to add more entities, such as additional ad groups or keywords, you can continue adding each new entity into a new row using the processes described above. Be sure to always include Sponsored Brands in the “Product” column for each row, along with Create as the \"Operation\" for new campaigns, along with the parent IDs for child entities. \n"],"documentType":"guide"},{"title":"How to create Sponsored Display campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sd/sd-examples/create-sd-campaign","content":[" When you create a Sponsored Display (SD) campaign, you define a targeting tactic: either audience targeting or contextual targeting. Similar to the advertising console UI, you also include your products that you want to advertise using SKU or ASIN, daily budget, and other details. \n"],"documentType":"guide"},{"title":"How to create Sponsored Display campaigns with bulksheets","sectionHeader":{"type":3,"text":"Sponsored Display campaigns"},"path":"/en-us/no-code-tools/bulksheets/sd/sd-examples/create-sd-campaign","content":["| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","|Allowable entities (Column B of your bulksheets file) are shown in the hierarchical diagram on the right—the green entities are required fields that you must define for a SD campaign. Note that ad group is a required child of the parent-level campaign. This means you need to create an ad group entity anytime you create a new campaign. Also note that you must define the targeting tactic by selecting either audience or contextual targeting. Negative product targeting is optional.  Learn more about entity and targeting types, and their relationships to Sponsored Display campaigns.|Sponsored Display entity diagram| \n"," The steps below show which fields you should complete on a row-by-row basis, starting with the top-level campaign entity. \n"," Each \"step\" section below represents one row in your bulksheets file. The guidelines describe what you should enter into each field.  NOTE: Read-only, informational-only, and metrics columns (impressions, clicks, conversions) are not included in the guide below. \n"," TIPS: \n","Headers marked with an asterisk  are fields that cannot be updated after you create the campaign.    Note that \"cost type\" and \"bid optimization\" fields are related. In the campaign entity row, you define the cost type (either CPC or vCPM) depending on the bid optimization strategy that you define in the ad group entity row. \\* IMPORTANT: Do not edit or alter the bulksheets column headers. This will cause the upload to fail. \n"," Use the guidelines below to define the top-level (parent) campaign entity in the first row of your bulksheets file:\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Display\t|\n","|Entity\t|Campaign\t|\n","|Operation\t|Create\t|\n","|Campaign Id\\*\t|For new campaigns, you should type a text-based name to identify your campaign. You enter this exact Campaign ID for each entity you create underneath this parent campaign. NOTE: When you upload your bulksheets file, the Campaign ID becomes the actual unique identifier associated with the campaign and all of its \"child\" entities. So if you want to update this campaign later, you would enter the actual Campaign ID into this field.\t|\n","|Ad Group Id\\*\t|Leave blank for campaign\t|\n","|Campaign Name\t|Enter the same campaign name that you entered in the \"Campaign ID\" column.\t|\n","|Ad Group Name\t|Leave blank for campaign\t|\n","|Start Date\t|Format must be yyyyMMdd. For example, the date April 1, 2022 would be  20220401.NOTE: You can start on today's date or a future date, but the date cannot  be in the past. So if you set the date for today, be sure you create and  upload the file on today's date. If you leave this field blank, the start date will be set for today's date.\t|\n","|State\t|Options are enabled or paused. Enter enabled to create a new campaign.\t|\n","|Tactic\\*\t|This is the targeting tactic you want for the campaign: either audience or contextual targeting. For bulksheets, you must enter the tactic ID in this field. For audience targeting, enter T00030.  For contextual targeting, enter T00020.\t|\n","|Budget Type\t|Enter daily.\t|\n","|Budget\t|Enter the amount you are willing to spend on the campaign each day. Do not include symbols such as dollar signs. For example, a daily budget of $100 would be written  as 100. Be sure your budget is within the allowed limits for your region.\t|\n","|Cost Type\t|Enter either CPC or vCPM, depending on how you define your bidding strategy in the \"Bid Optimization\" field when you create the ad group. If you want a bidding strategy of \"Optimize for page visits\" or \"Optimize for conversions,\" enter CPC. If you want a bidding strategy of \"Optimize for viewable impressions,\" enter vCPM. In the UI, these settings are in the \"Bidding\" section.|\n","|Bid Optimization\t|Leave this field blank because it is applied at the ad group level, but see the notes in the \"Cost Type\" row above to be sure the cost type and bid optimization fields are aligned.\t|\n","|SKU\t|Leave blank for campaign\t|\n","|ASIN\t|Leave blank for campaign\t|\n","|Ad Group Default Bid\t|Leave blank for campaign\t|\n","|Bid\t|Leave blank for campaign\t|\n","|Targeting Expression\t|Leave blank for campaign\t|\n","|Ad Id\\*\t|Leave blank for campaign\t|\n","|Targeting Id\\*\t|Leave blank for campaign\t|\n"," After this step, your bulksheets file might look like this for a campaign with audience targeting:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Ad Group Id\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|State\t|Tactic\t|Budget Type\t|Budget\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Display\t|Campaign\t|Create\t|SP New Campaign\t|\t|SP New Campaign\t|\t|20220401\t|\t|enabled\t|T00030\t|daily\t|100\t|\n"," Note for vendors: In the advertising console, ad groups are not available, so some of the settings might not be as familiar. \n"," Use the guidelines below to define the ad group entity: \n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Display\t|\n","|Entity\t|Ad group\t|\n","|Operation\t|Create\t|\n","|Campaign Id\\*\t|Enter the exact same campaign ID that you entered in the \"Campaign\" entity row.\t|\n","|Ad Group Id\\*\t|When creating a new ad group, enter the Ad Group Name you defined above. When updating an existing ad group, enter the actual ID found in campaign manager.\t|\n","|Campaign Name\t|Leave blank for ad group. Only used for the campaign entity\t|\n","|Ad Group Name\t|For new ad groups, you should type a text-based name to identify the ad group. NOTE: When you upload your bulksheets file, the Ad Group ID becomes the actual unique identifier associated with this ad group.\t|\n","|Start Date\t|Leave blank for ad group. Only used for the campaign entity\t|\n","|End Date\t|Leave blank when creating ad group. Only used when creating the campaign entity\t|\n","|State\t|Options are enabled or  paused. Enter enabled to create a new ad group.|\n","|Tactic\\*\t|Leave blank for ad group\t|\n","|Budget Type\t|Leave blank for ad group\t|\n","|Budget\t|Leave blank for ad group\t|\n","|Cost Type\t|Leave blank for ad group\t|\n","|Bid Optimization\t|See the notes about \"Cost Type\" in the campaign entity example above. In the \"Bid Optimization\" field, enter the bidding strategy you want to apply to this SD campaign. Options are Optimize for page visits, Optimize for conversions, or Optimize for viewable impressions. Be sure to associate the appropriate cost type depending on which strategy you select.\t|\n","|SKU\t|Leave blank for ad group\t|\n","|ASIN\t|Leave blank for ad group\t|\n","|Ad Group Default Bid\t|If you want to assign a default CPC bid at the ad group level, enter an amount using numbers and periods only. For example, 20 cents would be entered as .20  Leave this field blank if you want the campaign default bid to apply to the ad group and its child entities.\t|\n","|Bid\t|Leave blank for ad group\t|\n","|Targeting Expression\t|Leave blank for ad group\t|\n","|Ad Id\\*\t|Leave blank for ad group\t|\n","|Targeting Id\\*\t|Leave blank for ad group\t|\n"," After this step, your bulksheets file might look like this:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Ad Group Id\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|State\t|Tactic\t|Budget Type\t|Budget\t|Cost Type\t|Bid Optimization\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Targeting Expression\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Display\t|Campaign\t|Create\t|SD New Campaign\t|\t|SD New Campaign\t|\t|20220401\t|\t|enabled\t|T00030\t|daily\t|100\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Display\t|Ad group\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|SD New Ad Group\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|1\t|\t|\t|\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Display\t|\n","|Entity\t|Product ad\t|\n","|Operation\t|Create\t|\n","|Campaign Id\\*\t|Enter the exact same campaign ID that you entered in the \"Campaign\" entity row.\t|\n","|Ad Group Id\\*\t|Enter the exact same name that you entered in the \"Ad Group ID\" field in the Ad Group entity row.\t|\n","|Campaign Name\t|Leave blank for product ad\t|\n","|Ad Group Name\t|Leave blank for product ad\t|\n","|Start Date\t|Leave blank for product ad\t|\n","|End Date\t|Leave blank for product ad\t|\n","|State\t|Options are enabled or paused. Enter enabled to create a new product ad.|\n","|Tactic\\*\t|Leave blank for product ad\t|\n","|Budget Type\t|Leave blank for product ad\t|\n","|Budget\t|Leave blank for product ad\t|\n","|Cost Type\t|Leave blank for product ad\t|\n","|Bid Optimization\t|Leave blank for product ad\t|\n","|SKU\t|If you are a seller, enter the SKU for the product you are advertising. If you are a vendor, leave this blank.\t|\n","|ASIN\t|If you are a vendor, enter the ASIN for the product you are advertising. If you are a seller, leave this blank.\t|\n","|Ad Group Default Bid\t|Leave blank for product ad\t|\n","|Bid\t|Leave blank for product ad\t|\n","|Targeting Expression\t|Leave blank for product ad\t|\n","|Ad Id\\*\t|Leave blank for product ad\t|\n","|Targeting Id\\*\t|Leave blank for product ad\t|\n"," At this point, your file would look like this:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Ad Group Id\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|State\t|Tactic\t|Budget Type\t|Budget\t|Cost Type\t|Bid Optimization\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Targeting Expression\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Display\t|Campaign\t|Create\t|SD New Campaign\t|\t|SD New Campaign\t|\t|20220401\t|\t|enabled\t|T00030\t|daily\t|100\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Display\t|Ad group\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|SD New Ad Group\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|1\t|\t|\t|\n","|Sponsored Display\t|Product ad\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|BR549\t|\t|\t|\t|\n"," Create this entity only if you want audience targeting.  For contextual targeting, jump to Step 4b.\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Display\t|\n","|Entity\t|Audience targeting\t|\n","|Operation\t|Create\t|\n","|Campaign Id\\*\t|Enter the exact same campaign ID that you entered in the \"Campaign\" entity row.\t|\n","|Ad Group Id\\*\t|Enter the exact same name that you entered in the \"Ad Group ID\" field in the Ad Group entity row.\t|\n","|Campaign Name\t|Leave blank for audience targeting. Only used for the campaign entity\t|\n","|Ad Group Name\t|Leave blank for audience targeting. Only used for the ad group entity\t|\n","|Start Date\t|Leave blank for audience targeting\t|\n","|End Date\t|Leave blank for audience targeting\t|\n","|State\t|Options are enabled or paused. Enter enabled to create a new targeting entity.\t|\n","|Tactic\\*\t|Leave blank for audience targeting\t|\n","|Budget Type\t|Leave blank for audience targeting\t|\n","|Budget\t|Leave blank for audience targeting\t|\n","|Cost Type\t|Leave blank for audience targeting\t|\n","|Bid Optimization\t|Leave blank for audience targeting\t|\n","|SKU\t|Leave blank for audience targeting\t|\n","|ASIN\t|Leave blank for audience targeting\t|\n","|Ad Group Default Bid\t|Leave blank for audience targeting\t|\n","|Bid\t|Enter the CPC amount you are willing to pay when a shopper clicks your ad. Do not use money symbols or commas. For example, to bid 75 cents, enter 0.75. To bid one dollar, enter 1.  NOTE: There is a 2-place decimal limit. If you enter a number with more than 2 decimal places, the system automatically rounds to a 2-place decimal figure. For example, if you enter 0.756, the system rounds to 0.76. If you enter 0.754, the system rounds to 0.75 Be sure your bid is within the limits for your region. |\n","| Targeting Expression\t|In the console UI, you define targeting expression in the \"Products to target\" or the \"Audiences\" section, depending on which targeting strategy you selected. In this bulksheets field, you enter values such as category=\"12345\" to target based on a product category, or purchases=(related-product lookback=30) to target based on purchases remarketing. To do this, you need the IDs that represent the expression you want. You can get these values by downloading a bulksheet with some past Sponsored Display campaign data. Look in the Resolved targeting expression (read only) column for values such as category, for example: category=\"Kids' Electronics.\" Then, look in the Targeting expression column in that same row for the corresponding ID, for example: category=\"166164011\" Below are some examples of what you might enter in this field, depending on what you want to target: views=(category=\"2748212011\" price=10-50 lookback=30)  views=(similar-product lookback=30)  purchases=(related-product lookback=30)  purchases=(exact-product lookback=30)  audience=\"360733347960105375\"\t|\n","|Ad Id\\*\t|Leave blank for audience targeting\t|\n","|Targeting Id\\*\t|Leave blank when creating a new targeting entity. When updating, enter the actual targeting ID.\t|\n"," Your bulksheets file might now look like this:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Ad Group Id\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|State\t|Tactic\t|Budget Type\t|Budget\t|Cost Type\t|Bid Optimization\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Targeting Expression\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Display\t|Campaign\t|Create\t|SD New Campaign\t|\t|SD New Campaign\t|\t|20220401\t|\t|enabled\t|T00030\t|daily\t|100\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Display\t|Ad group\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|SD New Ad Group\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|1\t|\t|\t|\n","|Sponsored Display\t|Product ad\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|BR549\t|\t|\t|\t|\n","|Sponsored Display\t|Audience targeting\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|purchases=(exact-product lookback=30)\t|\n"," Create this entity only if you want a contextual targeting tactic.\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Display\t|\n","|Entity\t|Contextual targeting\t|\n","|Operation\t|Create\t|\n","|Campaign Id\\*\t|Enter the exact same campaign ID that you entered in the \"Campaign\" entity row.\t|\n","|Ad Group Id\\*\t|Enter the exact same name that you entered in the \"Ad Group ID\" field in the Ad Group entity row.\t|\n","|Campaign Name\t|Leave blank for contextual targeting. Only used for the campaign entity\t|\n","|Ad Group Name\t|Leave blank for contextual targeting. Only used for the ad group entity\t|\n","|Start Date\t|Leave blank for contextual targeting\t|\n","|End Date\t|Leave blank for contextual targeting\t|\n","|State\t|Options are enabled or  paused. Enter enabled to create a new targeting entity.\t|\n","|Tactic\\*\t|Leave blank for contextual targeting\t|\n","|Budget Type\t|Leave blank for contextual targeting\t|\n","|Budget\t|Leave blank for contextual targeting\t|\n","|Cost Type\t|\tLeave blank for contextual targeting]|\n","|Bid Optimization\t|\tLeave blank for contextual targeting]|\n","|SKU\t|Leave blank for contextual targeting\t|\n","|ASIN\t|Leave blank for contextual targeting\t|\n","|Ad Group Default Bid\t|Leave blank for contextual targeting\t|\n","|Bid\t|Enter the CPC amount you are willing to pay when a shopper clicks your ad. Do not use money symbols or commas. For example, to bid 75 cents, enter 0.75. To bid one dollar, enter 1.   Be sure your bid is within the limits for your region. |\n","|Targeting Expression\t|In the advertising console UI, this is where you select either \"individual products\" or \"categories\" to target and have the option to target similar products. For \"individual products,\" use the ASIN and enter asin=\"A000000000000\" (using the actual ASIN ID). For \"categories,\" use the category ID along with other qualifiers such as price limit and star rating. To target shoppers who viewed the detail pages of products that are similar to your advertised products, enter similar-product. For this field, enter all qualifiers into the same cell of your bulksheets file because they work as a combined unit to define the targeting. Example 1. To target by product category, price, and star rating: category=\"5524098011\" price&lt;49.99 rating>3 Example 2. To target by product category and Prime eligibility: category=\"5524098011\" prime-shipping-eligible=\"true\"Example 3. To target shoppers who viewed the detail pages of similar products (this cannot be combined with other qualifiers for contextual targeting): similar-product TIP: To get the numeric values for attributes such as category, you can use past campaign data where you assigned those targeting expressions by exporting the campaign into a bulksheet. The Resolved Product Targeting Expression column shows the values as they appear in the UI. You can then map this value to the corresponding ID in the Product Targeting Expression column. |\n","|Ad Id\\*\t|Leave blank for contextual targeting\t|\n","|Targeting Id\\*\t|Leave blank when creating a new targeting entity. When updating, enter the actual targeting ID.\t|\n"," Now, your bulksheets file might look like this if you add the entity details shown above—note that instead of adding an additional entity row, the \"contextual targeting\" entity has replaced \"audience targeting.\" You cannot create a campaign using both targeting tactics:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Ad Group Id\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|State\t|Tactic\t|Budget Type\t|Budget\t|Cost Type\t|Bid Optimization\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Targeting Expression\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Display\t|Campaign\t|Create\t|SD New Campaign\t|\t|SD New Campaign\t|\t|20220401\t|\t|enabled\t|T00030\t|daily\t|100\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Display\t|Ad group\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|SD New Ad Group\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|1\t|\t|\t|\n","|Sponsored Display\t|Product ad\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|BR549\t|\t|\t|\t|\n","|Sponsored Display\t|Contextual targeting\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|1\t|category=\"5524098011\" price&lt;49.99 rating>3\t|\n"],"documentType":"guide"},{"title":"How to create Sponsored Display campaigns with bulksheets","sectionHeader":{"type":3,"text":"Upload your bulksheets file to create the new campaign"},"path":"/en-us/no-code-tools/bulksheets/sd/sd-examples/create-sd-campaign","content":[" At this point, all mandatory entities are included in this Sponsored Display campaign. You can still add more entities if you want to assign negative product targeting.\n"," If you are ready to create the campaign, save the file and then navigate back to the \"Bulk operations\" page. \n","| IMAGE |   |\n","\\| ---- \\| ---- \\|\n","| Under \"3. Upload your file to update your campaigns,\" click Choose file to upload the sheet you just created.  | Upload your file |\n"],"documentType":"guide"},{"title":"How to create Sponsored Display campaigns with bulksheets","sectionHeader":{"type":3,"text":"Optional: Add negative targeting entity to the campaign"},"path":"/en-us/no-code-tools/bulksheets/sd/sd-examples/create-sd-campaign","content":[" If you want to add negative targeting, follow the guidelines below:\n","|gridColumn header\t|Guidelines on what to enter\t|\n","|---\t|---\t|\n","|Product\t|Sponsored Display\t|\n","|Entity\t|Negative product targeting\t|\n","|Operation\t|Create\t|\n","|Campaign Id\\*\t|Enter the exact same campaign ID that you entered in the \"Campaign\" entity row.\t|\n","|Ad Group Id\\*\t|Enter the exact same name that you entered in the \"Ad Group ID\" field in the Ad Group entity row.\t|\n","|Campaign Name\t|Leave blank for negative product targeting\t|\n","|Ad Group Name\t|Leave blank for negative product targeting\t|\n","|Start Date\t|Leave blank for negative product targeting\t|\n","|End Date\t|Leave blank for negative product targeting\t|\n","|State\t|Options are enabled or  paused. Enter enabled to create a new targeting entity.|\n","|Tactic\\*\t|Leave blank for negative product targeting\t|\n","|Budget Type\t|Leave blank for negative product targeting\t|\n","|Budget\t|Leave blank for negative product targeting\t|\n","|Cost Type\t|Leave blank for negative product targeting\t|\n","|Bid Optimization\t|Leave blank for negative product targeting\t|\n","|SKU\t|If you are a seller, enter the SKU for the product you are advertising. If you are a vendor, leave this blank.\t|\n","|ASIN\t|If you are a vendor, enter the ASIN for the product you are advertising. If you are a seller, leave this blank.\t|\n","|Ad Group Default Bid\t|Leave blank for negative product targeting\t|\n","|Bid\t|Leave blank for negative product targeting\t|\n","|Targeting Expression\t|Specify either a brand or a product to exclude from targeting, such as asin=\"29485928\" or brand=\"ABCDE\".\t|\n","|Ad Id\\*\t|Leave blank for negative product targeting\t|\n","|Targeting Id\\*\t|Leave blank for negative product targeting\t|\n"," After adding negative product targeting, your file might look like this:\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Ad Group Id\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|State\t|Tactic\t|Budget Type\t|Budget\t|Cost Type\t|Bid Optimization\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Targeting Expression\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Sponsored Display\t|Campaign\t|Create\t|SD New Campaign\t|\t|SD New Campaign\t|\t|20220401\t|\t|enabled\t|T00030\t|daily\t|100\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Display\t|Ad group\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|SD New Ad Group\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|1\t|\t|\t|\n","|Sponsored Display\t|Product ad\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|BR549\t|\t|\t|\t|\n","|Sponsored Display\t|Contextual targeting\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|1\t|category=\"5524098011\" price&lt;49.99 rating>3\t|\n","|Sponsored Display\t|Negative product targeting\t|Create\t|SD New Campaign\t|SD New Ad Group\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|asin=\"B09LYCN35V\"\t|\n"],"documentType":"guide"},{"title":"Overview - how to update campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/campaign-update-overview","content":[" This article provides an overview to help you get started with using bulksheets for campaign management and optimization. This guide covers how you can use a downloaded spreadsheet as the basis for updating a campaign, along with a list of the fields that cannot be changed or updated. \n"],"documentType":"guide"},{"title":"Overview - how to update campaigns with bulksheets","sectionHeader":{"type":2,"text":"Create & download a custom spreadsheet"},"path":"/en-us/no-code-tools/bulksheets/campaign-update-overview","content":[" Before you edit a bulksheets file, you should first download a file from the \"Bulk operations\" page. This file contains past campaign data, including entity IDs and other information depending on which options you select in the download process. You can use this downloaded file as a template to start with when you update a campaign, if you do not want to start from a blank template. Note that the downloaded file contains additional column headers including read-only and performance metrics—these fields are ignored in the upload, so you can leave them in the sheet when you upload your file instead of spending time deleting the data. \n"," The example below shows a downloaded bulksheets template that contains past campaign data, exactly as it might look after you create and download a custom spreadsheet—to save horizontal space, the metrics columns are not included: \n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id (Read only)    |Keyword Id (Read only)    |Product Targeting Id (Read only)    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Campaign\t|\t|6555226389\t|\t|\t|\t|\t|\t|SP Auto Holidays 2022\t|\t|20220105\t|20220719\t|AUTO\t|enabled\t|110\t|\t|\t|\t|\t|\t|\t|Dynamic bids - down only\t|\t|\n","|Sponsored Products\t|Bidding Adjustment\t|\t|6555226389\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Dynamic bids - down only\t|placementProductPage\t|\n","|Sponsored Products\t|Ad Group\t|\t|6555226389\t|8796676911\t|\t|\t|\t|\t|\t|Baseball toys \t|\t|\t|\t|enabled\t|\t|\t|\t|2.75\t|\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|\t|6555226389\t|8796676911\t|\t|729402352\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|B07NDMCL1D\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|\t|6555226389\t|8796676911\t|\t|207480567\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|B0864QL8CG\t|\t|\t|\t|\t|\t|\t|\n"," For this example, assume you only want to update the campaign name. Using the downloaded spreadsheet shown above, you can update the relevant fields only, and leave the other data unchanged to make this update. \n"," To update a campaign name, the mandatory required fields are Product, Entity, Operation, Campaign ID, and Campaign Name. Since some of those fields are already populated in the file, you only need to change values in the Operation field and Campaign Name field for that row. See the additional notes below the example for more information. \n"," Here is how the updated sheet would look—the updated fields are shown in bold:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id (Read only)    |Keyword Id (Read only)    |Product Targeting Id (Read only)    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Campaign\t|Update\t|6555226389\t|\t|\t|\t|\t|\t|New SP Campaign Name\t|\t|20220105\t|20220719\t|AUTO\t|enabled\t|110\t|\t|\t|\t|\t|\t|\t|Dynamic bids - down only\t|\t|\n","|Sponsored Products\t|Bidding Adjustment\t|\t|6555226389\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Dynamic bids - down only\t|placementProductPage\t|\n","|Sponsored Products\t|Ad Group\t|\t|6555226389\t|8796676911\t|\t|\t|\t|\t|\t|Baseball toys\t|\t|\t|\t|enabled\t|\t|\t|\t|2.75\t|\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|\t|6555226389\t|8796676911\t|\t|729402352\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|B07NDMCL1D\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Products\t|Product Ad\t|\t|6555226389\t|8796676911\t|\t|207480567\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|B0864QL8CG\t|\t|\t|\t|\t|\t|\t|\n","If the Operation field is blank, the data in that spreadsheet row is ignored completely when you upload the file. This means that you can leave data in the spreadsheet even if you do not want to update it, as long as you leave the Operation field blank. If your file contains many rows, this might be more efficient than deleting the rows that you do not want to update.   For the remaining fields that contain values, you could delete the values and leave the fields blank since they are not required for updating a campaign name, but you might find it more convenient to leave them unchanged since it does not affect the upload.   Start Date and Targeting Type fields cannot be modified after the campaign is created, so you must either leave them exactly as they are, or delete them altogether. If you change these values, you get an error when you upload the file. Learn more about which fields you can and cannot change when updating campaigns  \\* End Date can be left unchanged, or it can be updated if you enter a new date using the format yyyyMMdd. If you leave this field blank, it removes the end date from the campaign, and the campaign runs indefinitely.\n"],"documentType":"guide"},{"title":"Overview - how to update campaigns with bulksheets","sectionHeader":{"type":2,"text":"More information about updating campaigns "},"path":"/en-us/no-code-tools/bulksheets/campaign-update-overview","content":[" For a more thorough walkthrough of updating specific campaign types, check out the articles linked below. \n"],"documentType":"guide"},{"title":"How to update Sponsored Products campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sp/sp-examples/update-sp-campaigns","content":[" This article explains how to update Sponsored Products campaigns using bulksheets, including instructions for updating the following entities:\n","Change campaign name  Update campaign end date, daily budget, and bidding strategy  Archive a campaign  Change an ad group name and update the default bid  Archive an ad group  Add a new ad group to an existing campaign  Pause a keyword  Archive a keyword  Add new keywords to an existing campaign\n"," If you want a more general explanation of how to use bulksheets or how to create new campaigns, you can review Get Started with Bulksheets Part I. \n"," Some tips to note:\n","Before you edit a bulksheets file, you should first download a file from the \"Bulk operations\" page.   To update campaigns, ad groups, or keywords, you need the entity IDs, which can be found in the Sponsored Products tab of the downloaded file. Note that bulksheets entity IDs are different than the IDs in the advertising console, so be sure to get the IDs from a bulksheets download, and not from the console.   In the file, you can delete any tabs that do not pertain to the campaign you are updating, if they were not excluded from the download.  Note that if an existing campaign is in a portfolio, you must include the Portfolio ID when you update the campaign. Otherwise, it will be removed from the portfolio when you upload the file.  Only certain fields can be updated after a campaign has been created. Learn more about which fields you can and cannot change, along with guidance and tips.\n"],"documentType":"guide"},{"title":"How to update Sponsored Products campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update the campaign entity"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-examples/update-sp-campaigns","content":[" For all updates to the campaign entity, the first three fields of your bulksheets file will be the same: Enter Sponsored Products in Column A (Product), Campaign in Column B (Entity), and Update in Column C (Operation). Then, use the guidelines below to complete the bulksheets file based on what you want to update. \n","Enter the campaign ID in the Campaign ID column. This must be the campaign ID found in bulksheets--not the ID found in the advertising console. Note that if you are using a downloaded bulksheet, this ID will already be populated, and you can leave it unchanged. 2. In the Campaign Name column, enter the new name you want the campaign changed to. When you upload the file, the child entities of the campaign will inherit the new name, so you do not need to update the campaign name in other entity rows 3. In the End Date column, enter a date if you want to specify when the campaign should end. Otherwise, you can leave this blank and the campaign will run indefinitely. Note that leaving this field blank will override any previously set end dates—so if the campaign currently has a defined end date, leaving this field blank will remove the end date.  4. In the State column, enter Enabled if you want the updates to take effect immediately after you upload the file\n"," If you only want to update the campaign name, you can leave all other fields either unchanged or blank. If you are only updating a single campaign name, your file might look like this:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Campaign\t|Update\t|1009384\t|\t|\t|\t|\t|\t|NEW campaign name\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n"," For example, you might have a different campaign where you want to change the end date, daily budget, and bidding strategy. \n","Enter the campaign ID in the Campaign ID column 2. In the End Date column, enter the date when the campaign should end, using the format yyyyMMdd 3. In the Daily Budget column, enter the new amount using numbers only 4. In the Bidding Strategy column, enter the new bidding strategy you want to implement: either Fixed bid, Dynamic bids - down only, or Dynamic bids - up and down (we used Fixed bid in the example below)\n"," All other fields can be left either unchanged or blank: \n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Campaign\t|Update\t|9283347\t|\t|\t|\t|\t|\t|\t|\t|\t|20220331\t|\t|\t|\\*\\*200\\*\\*\t|\t|\t|\t|\t|\t|\t|Fixed bid\t|\t|\t|\t|    |    |\n"," You can update the status of a campaign to be archived using the Operation field—and note that this same process can be applied to any entity you want to archive (ad group, keyword, and so on). You only need to include the ID of the entity you want to archive:\n","In the Operation field, enter archive 2. Enter the campaign ID in the Campaign ID column\n"," All other fields can be left unchanged or blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Campaign\t|Archive\t|738572948\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n"],"documentType":"guide"},{"title":"How to update Sponsored Products campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update the ad group entity"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-examples/update-sp-campaigns","content":[" For all updates to the ad group entity, the first two fields of your bulksheets file will be the same: Enter Sponsored Products in Column A (Product) and Ad group in Column B (Entity). \n","In the Operation field, enter update 2. Enter the campaign ID and ad group ID in their respective column fields 3. In the Ad Group Name column, enter the new name you want the ad group changed to. When you upload the file, the child entities of the ad group will inherit the new name, so you do not need to update the ad group name in other entity rows. \n"," All other fields can be left either unchanged or blank\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Ad group\t|Update\t|88910384\t|3920483\t|\t|\t|\t|\t|\t|NEW ad group name\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n"," If you only want to update the ad group name, the example above could be uploaded to change the name. But if you also want to change the default bid for that same ad group--you could do this in the same row with the new ad group name by also including a value in the Ad Group Default Bid field:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Ad group\t|Update\t|88910384\t|3920483\t|\t|\t|\t|\t|\t|NEW ad group name\t|\t|\t|\t|\t|\t|\t|\t|\\*\\*15\\*\\*\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n"," You can change the status of an ad group to be archived using the Operation field:\n","In the Operation field, enter archive 2. In the Ad Group ID field, enter the ID\n"," All other fields can be left unchanged or blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Ad group\t|Archive\t|\t|6827594\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n"," You can add a new ad group to an existing Sponsored Products campaign if you include the campaign ID in the row where you are creating the new ad group:\n","In the Entity field, enter ad group 2. In the Operation field, enter create 3. In the Campaign ID field, enter the ID of the campaign that you want the ad group to be a part of  4. In the Ad Group ID field, enter the name you want to give the ad group 5. In the Ad Group Name field, enter the same name you entered into the Ad Group ID field 6. In the State field, enter enabled 7. In the Ad Group Default Bid field, enter the amount you want to spend, using numbers only\n"," Your sheet would resemble the example below:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Ad group\t|Create\t|9283745\t|6827594\t|\t|\t|\t|\t|\t|New ad group name\t|\t|\t|\t|Enabled\t|\t|\t|\t|10\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n"],"documentType":"guide"},{"title":"How to update Sponsored Products campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update the keyword entity"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-examples/update-sp-campaigns","content":[" You cannot update or change keywords by changing the keyword text. Instead, you should pause or archive the keywords that you want to stop running, and then create new ones in the campaign. \n"," You can pause keywords by updating its entity and setting the State to paused. You can pause as many keywords as you want in a single bulk upload.  \n","In the Entity field, enter keyword 2. In the Operation field, enter update 3. Enter the campaign ID, ad group ID, and keyword IDs in their respective fields 4. In the State field, enter paused\n"," All other fields can be left unchanged or blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Keyword\t|Update\t|9283745\t|6827594\t|\t|\t|\\*\\*38572938\\*\\*\t|\t|\t|\t|\t|\t|\t|Paused\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n"," To archive keywords, set the Operation field to archive. You can archive as many keywords as you want in a single bulk upload. \n","In the Entity field, enter keyword 2. In the Operation field, enter archive 3. In the Keyword ID field, enter the keyword ID.\n"," All other fields can be left unchanged or blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Keyword\t|Archive\t|\t|\t|\t|\t|7957362\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n"," You can add new keywords to existing campaigns using the campaign and ad group IDs. The example below shows adding a single new keyword, but you can add hundreds, or even thousands, of new keywords in batches. Be sure to use a separate row for each new keyword you want to create.  \n","In the Entity field, enter keyword 2. In the Operation field, enter create 3. Enter the campaign ID and ad group IDs in their respective fields 4. In the State field, enter enabled 5. Enter the keywords in the Keyword Text field\n"," All other fields can be left unchanged or blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Keyword\t|Create\t|9283745\t|6827594\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\texample keyword|\t|\t|\t|\t|\t|    |    |\n"],"documentType":"guide"},{"title":"How to update Sponsored Products campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update campaigns and ad groups within the same bulksheets file"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-examples/update-sp-campaigns","content":[" The examples above show each scenario separately. The following example shows all of the updates in a single file, including\n","Update campaign name  Update campaign end date, daily budget, and bidding strategy  Archive a campaign  Update an ad group name and default bid  Archive an ad group  Add a new ad group to an existing campaign  Pause a keyword \\* Archive a keyword\n"," The following shows what this sheet would look like if other fields are left blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Portfolio Id    |Ad Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |Targeting Type    |State    |Daily Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Keyword Text    |Match Type    |Bidding Strategy    |Placement    |Percentage    |Product Targeting Expression    |Sites    |Off-Amazon ad serving    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Products\t|Campaign\t|Update\t|1009384\t|\t|\t|\t|\t|\t|NEW campaign name\t|\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n","|Sponsored Products\t|Campaign\t|Update\t|9283347\t|\t|\t|\t|\t|\t|\t|\t|\t|20220331\t|\t|Enabled\t|200\t|\t|\t|\t|\t|\t|\t|Fixed bid\t|\t|\t|\t|    |    |\n","|Sponsored Products\t|Campaign\t|Archive\t|738572948\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n","|Sponsored Products\t|Ad group\t|Update\t|88910384\t|3920483\t|\t|\t|\t|\t|\t|NEW ad group name\t|\t|\t|\t|Enabled\t|\t|\t|\t|15\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n","|Sponsored Products\t|Ad group\t|Archive\t|9283745\t|6827594\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n","|Sponsored Products\t|Ad group\t|Create\t|59385793\t|New ad group\t|\t|\t|\t|\t|\t|New ad group\t|\t|\t|\t|Enabled\t|\t|\t|\t|10\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n","|Sponsored Products\t|Keyword\t|Update\t|9283745\t|6827594\t|\t|\t|38572938\t|\t|\t|\t|\t|\t|\t|Paused\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n","|Sponsored Products\t|Keyword\t|Archive\t|9283745\t|6827594\t|\t|\t|7957362\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |    |\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/update-sb-campaigns","content":[" This article explains how to update Sponsored Brands campaigns using bulksheets, including instructions for updating the following entities:\n","Update campaign name  Update campaign end date and budget  Archive a campaign  Pause or archive keywords \\* Archive ASINs for product targeting\n"," If you want a more general explanation of how to use bulksheets or how to create new campaigns, you can review Get Started with Bulksheets Part I. \n"," Some tips to note:\n","Before you edit a bulksheets file, you should first download a file from the “Bulk operations” page.   To update campaigns, ad groups, or keywords, you need the entity IDs, which can be found in the “Sponsored Brands” tab of the downloaded file. IDs for creative library assets will be in the \"Brand Assets\" tab.  In the file, you can delete any tabs that do not pertain to the campaign you are updating, if they were not excluded from the download.  Only certain fields can be updated after a campaign has been created. Learn more about which fields you can and cannot change, along with guidance and tips.  When archiving an entity, the only ID required is the entity you want to archive. For example, to archive an ad group, you only need the ad group ID—you can leave campaign ID blank.\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update the campaign entity"},"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/update-sb-campaigns","content":[" For all updates to the campaign entity, the first three fields should always be Sponsored Brands, Campaign, and Update. In addition, you need to include the following values: \n","Enter the campaign ID in the “Campaign ID” column  2. In the “Campaign Name” column, enter the new name you want the campaign changed to. When you upload the file, the child entities of the campaign will inherit the new name, so you do not need to update the campaign name in other entity rows. \n"," If you only want to update the campaign name, you can leave all other fields blank. If you are only updating a single campaign name, your file would look like this:\n","|Product    |Entity    |Operation    |Campaign Id    |Draft Campaign Id    |Portfolio Id    |Ad Group Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Start Date    |End Date    |State    |Budget Type    |Budget    |Bid Optimization    |Bid Multiplier    |Bid    |Keyword Text    |Match Type    |Product Targeting Expression    |Ad Format    |Landing Page URL    |Landing Page Asins    |Brand Entity Id    |Brand Name    |Brand Logo Asset Id    |Brand Logo URL    |Creative Headline    |Creative ASINs    |Video Media Ids    |Creative Type    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Brands\t|Campaign\t|Update\t|3729461\t|\t|\t|\t|\t|\t|NEW SB campaign name\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"," For a different scenario, say you have a different campaign, and you want to change the end date and the daily budget:\n","Enter the campaign ID in the “Campaign ID” column 2. In the “End Date” column, enter the date when the campaign should end, using the format yyyyMMdd 3. In the “State” column, enter enabled 4. In the “Budget” column, enter the new amount using numbers only\n","|Product    |Entity    |Operation    |Campaign Id    |Draft Campaign Id    |Portfolio Id    |Ad Group Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Start Date    |End Date    |State    |Budget Type    |Budget    |Bid Optimization    |Bid Multiplier    |Bid    |Keyword Text    |Match Type    |Product Targeting Expression    |Ad Format    |Landing Page URL    |Landing Page Asins    |Brand Entity Id    |Brand Name    |Brand Logo Asset Id    |Brand Logo URL    |Creative Headline    |Creative ASINs    |Video Media Ids    |Creative Type    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Brands\t|Campaign\t|Update\t|9283347\t|\t|\t|\t|\t|\t|\t|\t|20220331\t|Enabled\t|\t|150\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"," You can update the status of a campaign to be archived using the “Operation” field—and note that this same process can be applied to any entity you want to archive (ad group, keyword, and so on). Just be sure to always include the entity ID:\n","In the “Operation” field, enter archived 2. Enter the campaign ID in the “Campaign ID” column\n"," All other fields can be left unchanged or blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Draft Campaign Id    |Portfolio Id    |Ad Group Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Start Date    |End Date    |State    |Budget Type    |Budget    |Bid Optimization    |Bid Multiplier    |Bid    |Keyword Text    |Match Type    |Product Targeting Expression    |Ad Format    |Landing Page URL    |Landing Page Asins    |Brand Entity Id    |Brand Name    |Brand Logo Asset Id    |Brand Logo URL    |Creative Headline    |Creative ASINs    |Video Media Ids    |Creative Type    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Brands\t|Campaign\t|Archived\t|738572948\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update the keyword entity"},"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/update-sb-campaigns","content":[" You can pause keywords by updating its entity and setting the “State” to paused. You can pause as many keywords as you want in a single bulk upload.  \n","In the “Operation field,” enter update 2. Enter the campaign ID, ad group ID, and keyword IDs in their respective fields 3. In the “State” field, enter paused\n"," All other fields can be left unchanged or blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Draft Campaign Id    |Portfolio Id    |Ad Group Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Start Date    |End Date    |State    |Budget Type    |Budget    |Bid Optimization    |Bid Multiplier    |Bid    |Keyword Text    |Match Type    |Product Targeting Expression    |Ad Format    |Landing Page URL    |Landing Page Asins    |Brand Entity Id    |Brand Name    |Brand Logo Asset Id    |Brand Logo URL    |Creative Headline    |Creative ASINs    |Video Media Ids    |Creative Type    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Brands\t|Keyword\t|Update\t|88910384\t|\t|\t|\t|3920483\t|\t|\t|\t|\t|Paused\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"," To archive keywords, set the “Operation” field to Archive. You can archive as many keywords as you want in a single bulk upload.  1. In the “Operation field,” enter archive 2. In the “Keyword ID” field, enter the ID\n"," All other fields can be left unchanged or blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Draft Campaign Id    |Portfolio Id    |Ad Group Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Start Date    |End Date    |State    |Budget Type    |Budget    |Bid Optimization    |Bid Multiplier    |Bid    |Keyword Text    |Match Type    |Product Targeting Expression    |Ad Format    |Landing Page URL    |Landing Page Asins    |Brand Entity Id    |Brand Name    |Brand Logo Asset Id    |Brand Logo URL    |Creative Headline    |Creative ASINs    |Video Media Ids    |Creative Type    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Brands\t|Keyword\t|Archive\t|\t|\t|\t|\t|1003948\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update product targeting"},"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/update-sb-campaigns","content":[" Similar to keywords, you cannot change or delete the target, but you can pause or archive any product targeting that you no longer want active. \n","In the “Entity field, enter product targeting 2. In the “Operation” field, enter update 3. Enter the campaign ID and product targeting ID in their respective fields 4. In the “State” column, enter paused \n"," All other fields can be left unchanged or blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Draft Campaign Id    |Portfolio Id    |Ad Group Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Start Date    |End Date    |State    |Budget Type    |Budget    |Bid Optimization    |Bid Multiplier    |Bid    |Keyword Text    |Match Type    |Product Targeting Expression    |Ad Format    |Landing Page URL    |Landing Page Asins    |Brand Entity Id    |Brand Name    |Brand Logo Asset Id    |Brand Logo URL    |Creative Headline    |Creative ASINs    |Video Media Ids    |Creative Type    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Brands\t|Product targeting\t|Update\t|88910384\t|\t|\t|\t|\t|67249384\t|\t|\t|\t|Paused\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update campaigns and ad groups within the same bulksheets file"},"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-examples/update-sb-campaigns","content":[" The examples above show each scenario separately. Here is an example showing all of the updates in a single file, including\n","Update campaign name  Update campaign end date and budget  Archive a campaign  Pause a keyword  Archive a keyword \\* Pause product targeting\n","|Product    |Entity    |Operation    |Campaign Id    |Draft Campaign Id    |Portfolio Id    |Ad Group Id    |Keyword Id    |Product Targeting Id    |Campaign Name    |Start Date    |End Date    |State    |Budget Type    |Budget    |Bid Optimization    |Bid Multiplier    |Bid    |Keyword Text    |Match Type    |Product Targeting Expression    |Ad Format    |Landing Page URL    |Landing Page Asins    |Brand Entity Id    |Brand Name    |Brand Logo Asset Id    |Brand Logo URL    |Creative Headline    |Creative ASINs    |Video Media Ids    |Creative Type    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Brands\t|Campaign\t|Update\t|3729461\t|\t|\t|\t|\t|\t|NEW SB campaign name\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Campaign\t|Update\t|9283347\t|\t|\t|\t|\t|\t|\t|\t|20220331\t|Enabled\t|\t|150\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Campaign\t|Archive\t|738572948\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Keyword\t|Update\t|88910384\t|\t|\t|\t|3920483\t|\t|\t|\t|\t|Paused\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Keyword\t|Archive\t|\t|\t|\t|\t|1003948\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Brands\t|Product targeting\t|Update\t|88910384\t|\t|\t|\t|\t|67249384\t|\t|\t|\t|Paused\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands multi-ad group campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/update-sb-campaigns","content":[" This article explains how to update Sponsored Brands multi-ad group campaigns in bulksheets. Generally when you update a campaign in bulksheets, the steps are similar across all campaign types: Set the Operation field to Update in the row where you want to make a change, and update the value. For example, to update a keyword bid, you would set the Operation field of the keyword row to Update, and then enter the new bid value in the appropriate spreadsheet cell. For general updates to campaigns—including how to change bids, budgets, and campaign names—you can follow the steps found in this Update campaigns section of the help center. \n"," In this article, you will learn how to update values that were not possible with previous versions of Sponsored Brands, including how to:\n","Update or change a landing page URL  Update or change a creative headline  Add a new ad group to an existing campaign\n"," Before you begin, download a custom spreadsheet from the bulk operations home page. Be sure to include the tab labeled Sponsored Brands multi-ad group data. Download and open the file, then review the following guidelines. \n"],"documentType":"guide"},{"title":"How to update Sponsored Brands multi-ad group campaigns with bulksheets","sectionHeader":{"type":2,"text":"Downloaded file example"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/update-sb-campaigns","content":[" The table below represents a sample bulksheet with data for two different campaigns (IDs 2921424247 and 458395749). This section uses the example file to show how to update these campaigns. Read-only fields and performance metrics are omitted to save space. Also notice that the entity IDs and statuses (State field) are already in the spreadsheet since we downloaded a custom file. This makes updating the campaign easier, since you do not need to manually enter the IDs. Also notice that the Operation fields are all blank for each row. This is always the case when you download a bulksheet, so you need to enter a value for any row where you want to make changes. The remaining fields can be left untouched, and the system will ignore those rows as long as the Operation field is left blank. Continue reading to see examples of updating these campaigns. \n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|BG\t|BH    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Product Exclusions\t|Ad Title\t|Sites    |\n","|Sponsored Brands\t|Campaign\t|\t|2921424247\t|\t|\t|\t|\t|\t|Campaign Name\t|\t|\t|20231101\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|2921424247\t|\t|362003785216748\t|\t|\t|\t|\t|Ad Group Name\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Store spotlight ad\t|\t|2921424247\t|\t|362003785216748\t|465625743252508\t|\t|\t|\t|\t|Ad Name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/6F75E0CE-7A0B-4068-99F4-EAE6D1CDDD77\t|\t|Store\t|Store spotlight brand\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|My creative headline\t|B00AIZBMPY, B07CMFYR77, B074MDFZB1\t|\t|{\"asin\":\"B07SBHTQMC\",\"pageTitle\":\"BeautyFit Store\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/56A2B6B1-3870-4ACD-9368-B6CA6F8AA3D4\"},{\"asin\":\"B0058DKFBS\",\"pageTitle\":\"Cleansing & Digestion\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/94991DEE-76EC-490B-B636-181E4E434B2C\"},{\"asin\":\"B07RF9GMBY\",\"pageTitle\":\"Women's Health\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/C6B05EF3-1EC5-4E5B-99A8-9EB2139F599D\"}\t|\t|\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|2921424247\t|\t|362003785216748\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|2\t|\t|\t|dog bowl\t|Phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|2921424247\t|\t|529584950\t|\t|\t|\t|\t|New Ad Group 123\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|3\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Manual Collection ad\t|\t|2921424247\t|\t|529584950\t|782516394\t|\t|\t|\t|\t|New ad name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/287C0BF2-CBB8-47A0-8667-5FF0B3678722\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|\t|B087TC4NBL, B00FZN1KWE, B07B3VQ8DY\t|\t|\t|\t|My Ad Title\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|2921424247\t|\t|529584950\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Campaign\t|\t|458395749\t|\t|\t|\t|\t|\t|Campaign example 1\t|\t|\t|\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|458395749\t|\t|58729395\t|\t|\t|\t|\t|Ad group example 1\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Brand video ad\t|\t|458395749\t|\t|58729395\t|49650395\t|\t|\t|\t|\t|My brand video ad\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/BF7D4D7A-F099-4F46-9121-70690ABAD03E\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|My creative headline\t|B0BM1YWSML, B0BM1MRMWX, B0BLZSSPL2\t|amzn1.assetlibrary.asset1.735ec75f93ae1d0704411a3fc2aeff83:version_v1\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Product targeting\t|\t|458395749\t|\t|58729395\t|\t|\t|582816463\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|5.69\t|\t|\t|\t|\t|\t|\t|category=\"2975362011\"\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands multi-ad group campaigns with bulksheets","sectionHeader":{"type":3,"text":"Update a landing page URL"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/update-sb-campaigns","content":[" From the same example shown above, notice that the Landing page URL for Campaign ID 2921424247 is https&#x3A;//www.amazon.com/stores/page/6F75E0CE. Since the Landing page URL is defined in the ad format entity row (in this case, the Store spotlight ad), set the Operation in that row to Update, and then enter the new landing page URL as shown below. \n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|BG\t|BH    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Product Exclusions\t|Ad Title\t|Sites    |\n","|Sponsored Brands\t|Campaign\t|\t|2921424247\t|\t|\t|\t|\t|\t|Campaign Name\t|\t|\t|20231101\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|2921424247\t|\t|362003785216748\t|\t|\t|\t|\t|Ad Group Name\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Store spotlight ad\t|Update\t|2921424247\t|\t|362003785216748\t|465625743252508\t|\t|\t|\t|\t|Ad Name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/new-landing-page-url\t|\t|Store\t|Store spotlight brand\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|My creative headline\t|B00AIZBMPY, B07CMFYR77, B074MDFZB1\t|\t|{\"asin\":\"B07SBHTQMC\",\"pageTitle\":\"BeautyFit Store\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/56A2B6B1-3870-4ACD-9368-B6CA6F8AA3D4\"},{\"asin\":\"B0058DKFBS\",\"pageTitle\":\"Cleansing & Digestion\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/94991DEE-76EC-490B-B636-181E4E434B2C\"},{\"asin\":\"B07RF9GMBY\",\"pageTitle\":\"Women's Health\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/C6B05EF3-1EC5-4E5B-99A8-9EB2139F599D\"}\t|\t|\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|2921424247\t|\t|362003785216748\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|2\t|\t|\t|dog bowl\t|Phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|2921424247\t|\t|529584950\t|\t|\t|\t|\t|New Ad Group 123\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|3\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Manual Collection ad\t|\t|2921424247\t|\t|529584950\t|782516394\t|\t|\t|\t|\t|New ad name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/287C0BF2-CBB8-47A0-8667-5FF0B3678722\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|\t|B087TC4NBL, B00FZN1KWE, B07B3VQ8DY\t|\t|\t|\t|My Ad Title\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|2921424247\t|\t|529584950\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Campaign\t|\t|458395749\t|\t|\t|\t|\t|\t|Campaign example 1\t|\t|\t|\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|458395749\t|\t|58729395\t|\t|\t|\t|\t|Ad group example 1\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Brand video ad\t|\t|458395749\t|\t|58729395\t|49650395\t|\t|\t|\t|\t|My brand video ad\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/BF7D4D7A-F099-4F46-9121-70690ABAD03E\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|My creative headline\t|B0BM1YWSML, B0BM1MRMWX, B0BLZSSPL2\t|amzn1.assetlibrary.asset1.735ec75f93ae1d0704411a3fc2aeff83:version_v1\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Product targeting\t|\t|458395749\t|\t|58729395\t|\t|\t|582816463\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|5.69\t|\t|\t|\t|\t|\t|\t|category=\"2975362011\"\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands multi-ad group campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update an ad title"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/update-sb-campaigns","content":[" Using the same example, this example updates the Ad Title for the Manual Collection ad. Similar to the steps from above, the only necessary actions are to include the Operation value and input the new Ad Title, because the IDs and statuses are already in the sheet:  \n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|BG\t|BH    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Product Exclusions\t|Ad Title\t|Sites    |\n","|Sponsored Brands\t|Campaign\t|\t|2921424247\t|\t|\t|\t|\t|\t|Campaign Name\t|\t|\t|20231101\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|2921424247\t|\t|362003785216748\t|\t|\t|\t|\t|Ad Group Name\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Store spotlight ad\t|\t|2921424247\t|\t|362003785216748\t|465625743252508\t|\t|\t|\t|\t|Ad Name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/new-landing-page-url\t|\t|Store\t|Store spotlight brand\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|My creative headline\t|B00AIZBMPY, B07CMFYR77, B074MDFZB1\t|\t|{\"asin\":\"B07SBHTQMC\",\"pageTitle\":\"BeautyFit Store\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/56A2B6B1-3870-4ACD-9368-B6CA6F8AA3D4\"},{\"asin\":\"B0058DKFBS\",\"pageTitle\":\"Cleansing & Digestion\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/94991DEE-76EC-490B-B636-181E4E434B2C\"},{\"asin\":\"B07RF9GMBY\",\"pageTitle\":\"Women's Health\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/C6B05EF3-1EC5-4E5B-99A8-9EB2139F599D\"}\t|\t|\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|2921424247\t|\t|362003785216748\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|2\t|\t|\t|dog bowl\t|Phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|2921424247\t|\t|529584950\t|\t|\t|\t|\t|New Ad Group 123\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|3\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Manual Collection ad\t|Update\t|2921424247\t|\t|529584950\t|782516394\t|\t|\t|\t|\t|New ad name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/287C0BF2-CBB8-47A0-8667-5FF0B3678722\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|\t|B087TC4NBL, B00FZN1KWE, B07B3VQ8DY\t|\t|\t|\t|New Ad Title\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|2921424247\t|\t|529584950\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Campaign\t|\t|458395749\t|\t|\t|\t|\t|\t|Campaign example 1\t|\t|\t|\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|458395749\t|\t|58729395\t|\t|\t|\t|\t|Ad group example 1\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Brand video ad\t|\t|458395749\t|\t|58729395\t|49650395\t|\t|\t|\t|\t|My brand video ad\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/BF7D4D7A-F099-4F46-9121-70690ABAD03E\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|My creative headline\t|B0BM1YWSML, B0BM1MRMWX, B0BLZSSPL2\t|amzn1.assetlibrary.asset1.735ec75f93ae1d0704411a3fc2aeff83:version_v1\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Product targeting\t|\t|458395749\t|\t|58729395\t|\t|\t|582816463\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|5.69\t|\t|\t|\t|\t|\t|\t|category=\"2975362011\"\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands multi-ad group campaigns with bulksheets","sectionHeader":{"type":2,"text":"Add a new ad group to an existing campaign"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/update-sb-campaigns","content":[" To add a new entity to an existing campaign, you can start from a downloaded file like the example referenced above. But instead of simply updating values in the existing rows, create new rows underneath the campaign for the new ad group and its child entities. For this example, place the new ad group into the campaign with ID 458395749. \n"," The first step is to add at least three new rows under that campaign, as shown below. These rows are for the new ad group entity, the ad format entity, and the targeting entity. \n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|BG\t|BH    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Product Exclusions\t|Ad Title\t|Sites    |\n","|Sponsored Brands\t|Campaign\t|\t|2921424247\t|\t|\t|\t|\t|\t|Campaign Name\t|\t|\t|20231101\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|2921424247\t|\t|362003785216748\t|\t|\t|\t|\t|Ad Group Name\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Store spotlight ad\t|\t|2921424247\t|\t|362003785216748\t|465625743252508\t|\t|\t|\t|\t|Ad Name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/new-landing-page-url\t|\t|Store\t|Store spotlight brand\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|My creative headline\t|B00AIZBMPY, B07CMFYR77, B074MDFZB1\t|\t|{\"asin\":\"B07SBHTQMC\",\"pageTitle\":\"BeautyFit Store\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/56A2B6B1-3870-4ACD-9368-B6CA6F8AA3D4\"},{\"asin\":\"B0058DKFBS\",\"pageTitle\":\"Cleansing & Digestion\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/94991DEE-76EC-490B-B636-181E4E434B2C\"},{\"asin\":\"B07RF9GMBY\",\"pageTitle\":\"Women's Health\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/C6B05EF3-1EC5-4E5B-99A8-9EB2139F599D\"}\t|\t|\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|2921424247\t|\t|362003785216748\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|2\t|\t|\t|dog bowl\t|Phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|2921424247\t|\t|529584950\t|\t|\t|\t|\t|New Ad Group 123\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|3\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Manual Collection ad\t|\t|2921424247\t|\t|529584950\t|782516394\t|\t|\t|\t|\t|New ad name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/287C0BF2-CBB8-47A0-8667-5FF0B3678722\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|\t|B087TC4NBL, B00FZN1KWE, B07B3VQ8DY\t|\t|\t|\t|My Ad Title\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|2921424247\t|\t|529584950\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Campaign\t|\t|458395749\t|\t|\t|\t|\t|\t|Campaign example 1\t|\t|\t|\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|458395749\t|\t|58729395\t|\t|\t|\t|\t|Ad group example 1\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Brand video ad\t|\t|458395749\t|\t|58729395\t|49650395\t|\t|\t|\t|\t|My brand video ad\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/BF7D4D7A-F099-4F46-9121-70690ABAD03E\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|My creative headline\t|B0BM1YWSML, B0BM1MRMWX, B0BLZSSPL2\t|amzn1.assetlibrary.asset1.735ec75f93ae1d0704411a3fc2aeff83:version_v1\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Product targeting\t|\t|458395749\t|\t|58729395\t|\t|\t|582816463\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|5.69\t|\t|\t|\t|\t|\t|\t|category=\"2975362011\"\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n"," Then, you can add the new entities to the spreadsheet. You can either copy/paste, or drag the values down in order to populate the existing campaign ID into the new ad group and its child entities. Complete each entity row using the same steps described in How to create Sponsored Brands multi-ad group campaigns. Below is an example of the new ad group, which uses a Manual Collection ad ad format and a Keyword targeting strategy. Note that the new entities use the existing unique, system-generated campaign ID since the campaign already exists, but the example includes temporary IDs for the new ad group and its child entities. This temporary ID will become a unique ID when you upload the file and create the new ad group. \n"," The new values are shown in bold. \n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|P\t|Q\t|R\t|S\t|AC\t|AD\t|AE\t|AF\t|AG\t|AH\t|AI\t|AJ\t|AK\t|AL\t|AM\t|AN\t|AR\t|AS\t|AT\t|AU\t|AV\t|AW\t|AY\t|AZ\t|BA\t|BB\t|BC\t|BE\t|BF\t|BG\t|BH    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Campaign name\t|Ad group name\t|Ad name\t|Start date\t|End date\t|State\t|Brand Entity ID\t|Budget type\t|Budget\t|Bid optimization\t|Product location\t|Bid\t|Placement\t|Percentage\t|Keyword text\t|Match type\t|Native language keyword\t|Native language locale\t|Product targeting expression\t|Landing page URL\t|Landing page ASINs\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Brand logo crop\t|Custom images\t|Creative headline\t|Creative ASINs\t|Video asset IDs\t|Sub-pages\t|Product Exclusions\t|Ad Title\t|Sites    |\n","|Sponsored Brands\t|Campaign\t|\t|2921424247\t|\t|\t|\t|\t|\t|Campaign Name\t|\t|\t|20231101\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|2921424247\t|\t|362003785216748\t|\t|\t|\t|\t|Ad Group Name\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Store spotlight ad\t|\t|2921424247\t|\t|362003785216748\t|465625743252508\t|\t|\t|\t|\t|Ad Name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/new-landing-page-url\t|\t|Store\t|Store spotlight brand\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|My creative headline\t|B00AIZBMPY, B07CMFYR77, B074MDFZB1\t|\t|{\"asin\":\"B07SBHTQMC\",\"pageTitle\":\"BeautyFit Store\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/56A2B6B1-3870-4ACD-9368-B6CA6F8AA3D4\"},{\"asin\":\"B0058DKFBS\",\"pageTitle\":\"Cleansing & Digestion\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/94991DEE-76EC-490B-B636-181E4E434B2C\"},{\"asin\":\"B07RF9GMBY\",\"pageTitle\":\"Women's Health\",\"url\":\"https&#x3A;//www.amazon.com/stores/page/C6B05EF3-1EC5-4E5B-99A8-9EB2139F599D\"}\t|\t|\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|2921424247\t|\t|362003785216748\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|2\t|\t|\t|dog bowl\t|Phrase\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|2921424247\t|\t|529584950\t|\t|\t|\t|\t|New Ad Group 123\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|3\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Manual Collection ad\t|\t|2921424247\t|\t|529584950\t|782516394\t|\t|\t|\t|\t|New ad name\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/287C0BF2-CBB8-47A0-8667-5FF0B3678722\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|\t|B087TC4NBL, B00FZN1KWE, B07B3VQ8DY\t|\t|\t|\t|My Ad Title\t|    |\n","|Sponsored Brands\t|Keyword\t|\t|2921424247\t|\t|529584950\t|\t|483071962064133\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Campaign\t|\t|458395749\t|\t|\t|\t|\t|\t|Campaign example 1\t|\t|\t|\t|\t|enabled\t|\t|Daily\t|100\t|TRUE\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|\t|458395749\t|\t|58729395\t|\t|\t|\t|\t|Ad group example 1\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Brand video ad\t|\t|458395749\t|\t|58729395\t|49650395\t|\t|\t|\t|\t|My brand video ad\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/BF7D4D7A-F099-4F46-9121-70690ABAD03E\t|\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|{\"left\":\"0\",\"top\":\"0\",\"width\":\"450\",\"height\":\"450\"}\t|\t|My creative headline\t|B0BM1YWSML, B0BM1MRMWX, B0BLZSSPL2\t|amzn1.assetlibrary.asset1.735ec75f93ae1d0704411a3fc2aeff83:version_v1\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Product targeting\t|\t|458395749\t|\t|58729395\t|\t|\t|582816463\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|5.69\t|\t|\t|\t|\t|\t|\t|category=\"2975362011\"\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Ad group\t|Create\t|458395749\t|\t|New ad group temp ID\t|\t|\t|\t|\t|New ad group name\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n","|Sponsored Brands\t|Manual Collection ad\t|Create\t|458395749\t|\t|New ad group temp ID\t|\t|\t|\t|\t|\t|New manual collection ad name \t|\t|\t|enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|https&#x3A;//www.amazon.com/stores/page/287C0BF2-CBB8-47A0-8667-5FF0B3678722\t|\t|Store\t|Another brand name\t|\t|amzn1.assetlibrary.asset1.38f47f3fd2fa825c5ca2d4923aead105:version_v1\t|\t|\t|\t|B087TC4NBL, B00FZN1KWE, B07B3VQ8DY\t|\t|\t|\t|My Ad Title\t|    |\n","|Sponsored Brands\t|Keyword\t|Create\t|458395749\t|\t|New ad group temp ID\t|\t|\t|\t|\t|\t|\t|\t|\t|enabled\t|\t|\t|\t|\t|\t|0.75\t|\t|\t|pink dog collar\t|exact\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|    |\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands multi-ad group campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update a Manual Collection ad"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/update-sb-campaigns","content":[" To update a Manual Collection ad, set the Operation field to Update in the Manual Collection ad row, and change the desired values. Common updates include changing the state, updating Creative ASINs, or updating the Ad Title.\n"," The example below shows how to:\n","Update the Creative ASINs to feature different products \\* Update the Ad Title to a new title\n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|L\t|R\t|AR\t|AT\t|AU\t|AV\t|AW\t|BB\t|BF\t|BG\t|BH    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Ad name\t|State\t|Landing page URL\t|Landing page type\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Creative ASINs\t|Product Exclusions\t|Ad Title\t|Sites\t|\n","|Sponsored Brands\t|Manual Collection ad\t|Update\t|2921424247\t|\t|529584950\t|782516394\t|\t|\t|My Collection Ad\t|enabled\t|https&#x3A;//www.amazon.com/stores/page/23F9CB2E\t|Store\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3\t|B00K7M3T8Q, B09NXWL4HP, B07DFGR2YZ, B0CRJ5V8KN, B08PQLM7FW, B0BHT9X2RD\t|\t|New Title\t|\t|\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands multi-ad group campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update an Auto Collection ad"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/update-sb-campaigns","content":[" To update an Auto Collection ad, set the Operation field to Update in the Auto Collection ad row. Common updates include changing the state or adding Product Exclusions.\n"," The example below shows how to add Product Exclusions to prevent specific ASINs from appearing in the auto-curated collection:\n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|L\t|R\t|AU\t|AV\t|AW\t|BF\t|BG\t|BH    |\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|Keyword ID\t|Product Targeting ID\t|Ad name\t|State\t|Brand name\t|Consent to translate\t|Brand logo asset ID\t|Product Exclusions\t|Ad Title\t|Sites\t|\n","|Sponsored Brands\t|Auto Collection ad\t|Update\t|2921424247\t|\t|529584950\t|892637415\t|\t|\t|My Auto Ad\t|enabled\t|My Brand Name\t|\t|amzn1.assetlibrary.asset1.38f47f3\t|B0BNRV8H4J, B08WJDM6KT, B0CXLP3F7N\t|\t|\t|\n"],"documentType":"guide"},{"title":"How to update Sponsored Brands multi-ad group campaigns with bulksheets","sectionHeader":{"type":2,"text":"Archive a Collection ad"},"path":"/en-us/no-code-tools/bulksheets/sb/sb-examples/update-sb-campaigns","content":[" To archive a Manual Collection ad or Auto Collection ad, set the Operation field to Archive in the ad entity row. Archiving permanently removes the ad from the campaign — this action cannot be undone.\n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|R\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign ID\t|Portfolio ID\t|Ad Group ID\t|Ad ID\t|State\t|\n","|Sponsored Brands\t|Manual Collection ad\t|Archive\t|2921424247\t|\t|529584950\t|782516394\t|archived\t|\n"],"documentType":"guide"},{"title":"How to update Sponsored Display campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sd/sd-examples/update-sd-campaigns","content":[" This article explains how to update Sponsored Display campaigns using bulksheets, including instructions for updating the following entities:\n","Update campaign name  Update campaign end date and budget  Archive a campaign  Update an ad group name and default bid  Archive an ad group  Add a new ad group to an existing campaign \n"," If you want a more general explanation of how to use bulksheets or how to create new campaigns, you can review Get Started with Bulksheets Part I. \n"," Some tips to note:\n","Before you edit a bulksheets file, you should first download a file from the \"Bulk operations\" page.   To update campaigns, ad groups, or keywords, you will need the entity IDs, which can be found in the \"Sponsored Display\" tab of the downloaded file.   In the file, you can delete any tabs that do not pertain to the campaign you are updating, if they were not excluded from the download. \\* Only certain fields can be updated after a campaign has been created. Learn more about which fields you can and cannot change, along with guidance and tips.\n"],"documentType":"guide"},{"title":"How to update Sponsored Display campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update the campaign entity"},"path":"/en-us/no-code-tools/bulksheets/sd/sd-examples/update-sd-campaigns","content":[" For all updates to the campaign entity, the first three fields of your bulksheets file will be the same: Enter Sponsored Display in Column A (Product), Campaign in Column B (Entity), and Update in Column C (Operation). Then, use the guidelines below to complete the bulksheets file based on what you want to update. \n","Enter the campaign ID in the Campaign ID column  2. In the Campaign Name column, enter the new name you want the campaign changed to. When you upload the file, the child entities of the campaign will inherit the new name, so you do not need to update the campaign name in other entity rows.  3. In the End Date column, enter a date if you want to specify when the campaign should end. Otherwise, you can leave this blank and the campaign will run indefinitely. Note that leaving this field blank will override any previously set end dates—so if the campaign currently has a defined end date, leaving this field blank will remove the end date.  4. In the State column, enter Enabled if you want the updates to take effect immediately after you upload the file\n"," If you only want to update the campaign name, you can leave all other fields blank. If you are only updating a single campaign name, your file would look like this:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Ad Id    |Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |State    |Tactic    |Budget Type    |Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Bid Optimization    |Cost Type    |Targeting Expression    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Display\t|Campaign\t|Update\t|1009384\t|\t|\t|\t|NEW campaign name\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"," For example, you might have a different campaign where you want to change the end date, daily budget, and bidding strategy.\n","Enter the campaign ID in the Campaign ID column 2. In the End Date column, enter the date when the campaign should end, using the format yyyyMMdd 3. In the Budget column, enter the new amount using numbers only 4. In the State column, enter enabled if you want the updates to take effect immediately after you upload the file\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Ad Id    |Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |State    |Tactic    |Budget Type    |Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Bid Optimization    |Cost Type    |Targeting Expression    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Display\t|Campaign\t|Update\t|9283347\t|\t|\t|\t|\t|\t|\t|20220331\t|Enabled\t|\t|\t|100\t|\t|\t|\t|\t|\t|\t|\t|\n"," You can update the status of a campaign to be archived using the Operation field—and note that this same process can be applied to any entity you want to archive (ad group, keyword, and so on). Just be sure to always include the entity ID:\n","In the Operation field, enter archived 2. Enter the campaign ID in the Campaign ID column\n"," All other fields can be left unchanged or blank:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Ad Id    |Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |State    |Tactic    |Budget Type    |Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Bid Optimization    |Cost Type    |Targeting Expression    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Display\t|Campaign\t|Archive\t|738572948\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"How to update Sponsored Display campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update the ad group entity"},"path":"/en-us/no-code-tools/bulksheets/sd/sd-examples/update-sd-campaigns","content":[" For all updates to the ad group entity, the first three fields of your bulksheets file will be the same: Enter Sponsored Display in Column A (Product) and Ad group in Column B (Entity).\n","In the Operation field, enter update 2. Enter the Campaign ID and Ad group ID in their respective column fields 3. In the Ad Group Name column, enter the new name you want the ad group changed to. When you upload the file, the child entities of the ad group will inherit the new name, so you do not need to update the ad group name in other entity rows.  4. In the State column, enter Enabled if you want the updates to take effect immediately after you upload the file\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Ad Id    |Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |State    |Tactic    |Budget Type    |Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Bid Optimization    |Cost Type    |Targeting Expression    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Display\t|Ad group\t|Update\t|88910384\t|3920483\t|\t|\t|\t|NEW ad group name\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"," If you only want to update the ad group name, the example above could be uploaded to change the name. But if you also want to change the default bid for that same ad group--you could do this in the same row with the new ad group name by also including a value in the Ad Group Default Bid field:\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Ad Id    |Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |State    |Tactic    |Budget Type    |Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Bid Optimization    |Cost Type    |Targeting Expression    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Display\t|Ad group\t|Update\t|88910384\t|3920483\t|\t|\t|\t|NEW ad group name\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\\*\\*15\\*\\*\t|\t|\t|\t|\t|\n"," You can change the status of an ad group to be archived using the Operation field:\n","In the Operation field, enter archived 2. In the Ad Group ID field, enter the ID\n"," All other fields can be left unchanged or blank:\n","|A\t|B\t|C\t|D\t|E\t|F\t|G\t|H\t|I\t|J\t|K\t|L\t|M\t|N\t|O\t|P\t|Q\t|R\t|S\t|T\t|U\t|V\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Product\t|Entity\t|Operation\t|Campaign Id\t|Ad Group Id\t|Ad Id\t|Targeting Id\t|Campaign Name\t|Ad Group Name\t|Start Date\t|End Date\t|State\t|Tactic\t|Budget Type\t|Budget\t|SKU\t|ASIN\t|Ad Group Default Bid\t|Bid\t|Bid Optimization\t|Cost Type\t|Targeting Expression\t|\n","|Sponsored Display\t|Ad group\t|Archived\t|\t|6827594\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"How to update Sponsored Display campaigns with bulksheets","sectionHeader":{"type":2,"text":"Update campaigns and ad groups within the same bulksheets file"},"path":"/en-us/no-code-tools/bulksheets/sd/sd-examples/update-sd-campaigns","content":[" The examples above show each scenario separately. The following example shows all of the updates in a single file, including\n","Update campaign name  Update campaign end date and budget  Archive a campaign  Update an ad group name and default bid  Archive an ad group\n","|Product    |Entity    |Operation    |Campaign Id    |Ad Group Id    |Ad Id    |Targeting Id    |Campaign Name    |Ad Group Name    |Start Date    |End Date    |State    |Tactic    |Budget Type    |Budget    |SKU    |ASIN    |Ad Group Default Bid    |Bid    |Bid Optimization    |Cost Type    |Targeting Expression    |\n","\\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|---    \\|\n","|Sponsored Display\t|Campaign\t|Update\t|1009384\t|\t|\t|\t|NEW campaign name\t|\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Display\t|Campaign\t|Update\t|9283347\t|\t|\t|\t|\t|\t|\t|20220331\t|Enabled\t|\t|\t|100\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Display\t|Campaign\t|Archive\t|738572948\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Display\t|Ad group\t|Update\t|88910384\t|3920483\t|\t|\t|\t|NEW ad group name\t|\t|\t|Enabled\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n","|Sponsored Display\t|Ad group\t|Archive\t|\t|6827594\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\t|\n"],"documentType":"guide"},{"title":"Understand which fields can be updated in bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/editable-non-editable-bulksheets-fields","content":[" When you are updating campaigns with bulksheets, it is important to understand which fields can and cannot be updated so you can avoid wasting time or changing a campaign element unintentionally. If you change any non-editable values, you will see error messages when you upload the bulksheets file. For fields that cannot be edited (for example, keyword text or ASIN/SKU), a typical workaround is to archive its associated entity, then create a new one with the updated information. \n"," The tables below provide additional guidance and tips. \n"," Jump to Sponsored Brands fields | Sponsored Display fields\n"],"documentType":"guide"},{"title":"Understand which fields can be updated in bulksheets","sectionHeader":{"type":2,"text":"Sponsored Products fields"},"path":"/en-us/no-code-tools/bulksheets/editable-non-editable-bulksheets-fields","content":["|grid-\t|Can update?\t|Guidelines and tips \t|\n","|---\t|---\t|---\t|\n","|Product\t|N/A\t|This foundational field defines the campaign type\t|\n","|Entity\t|N/A\t|This foundational field defines the entity you want to manage\t|\n","|Operation\t|N/A\t|This foundational field defines the action you want to happen when you upload the file (create, update, or archive). When this field is blank, the row will be ignored in the upload process.\t|\n","|Campaign Id\t|No\t|None of the ID fields can be changed, but you will use them when updating or archiving the associated entity. For example, to update a campaign name, you will enter the Campaign ID in this field and put the new name in the \"Campaign Name\" field. This same general process is used when updating any entity.\t|\n","|Ad Group Id\t|No\t|Include this ID to update or archive the ad group entity. \t|\n","|Portfolio Id\t|No\t|You can create a new campaign within an existing portfolio if you include the Portfolio ID in the same row where you are creating the campaign.\t|\n","|Ad Id\t|No\t|Include this ID to update or archive the product ad entity. \t|\n","|Keyword Id\t|No\t|Include this ID to update or archive the keyword entity.  \t|\n","|Product Targeting Id\t|No\t|\tInclude this ID to update or archive a SKU or ASIN using the product targeting entity. |\n","|Campaign Name\t|Yes\t|Enter the new name in this field, and set \"Operation\" to update. Be sure to also include the Campaign ID.  \t|\n","|Ad Group Name\t|Yes\t|Enter the new name in this field, and set \"Operation\" to update. Be sure to also include the Ad Group and Campaign IDs.\t|\n","|Start Date\t|No\t|When updating a campaign, you cannot change the start date. Either leave the value unchanged, or delete the value and leave the start date field blank. Leaving this field blank will not affect the start date--it will be ignored in the upload process.\t|\n","|End Date\t|Yes\t|When updating a campaign, you can leave this value unchanged to keep the current end date, enter a date if you want to set a new end date, or leave blank if you want the campaign to run indefinitely. Note that leaving this field blank will override and remove the current end date\t|\n","|Targeting Type\t|No\t|You cannot update an auto campaign to be manual, and vice versa. \t|\n","|State\t|N/A\t|This field should almost always contain a value, with these exceptions: If the \"Entity\" is bidding adjustment, leave this field blank. And if the \"Operation\" is set to archive, leave this field blank. Note that you use this field to pause entities (such as keywords) by setting \"State\" to paused and \"Operation\" to update.\t|\n","|Daily Budget\t|Yes\t|Update this field by setting the \"Entity\" to campaign and the \"Operation\" to update\t|\n","|SKU\t|No\t|You cannot update a SKU or ASIN, but you can pause or archive the associated product ad entity and then create a new one with the SKU or ASIN you want to add.\t|\n","|ASIN\t|No\t|You cannot update a SKU or ASIN, but you can pause or archive the associated product ad entity and then create a new one with the SKU or ASIN you want to add.\t|\n","|Ad Group Default Bid\t|Yes\t|Enter a new value and update the associated ad group entity \t|\n","|Bid\t|Yes\t|Enter a new value and update the associated keyword or product targeting entity \t|\n","|Keyword Text\t|No\t|You cannot update keywords by changing the keyword text. Instead, you should pause or archive the keywords that you want to stop running.\t|\n","|Match Type\t|No\t|\t|\n","|Bidding Strategy\t|Yes\t|This field is set at the campaign level. Update using the associated Campaign ID\t|\n","|Placement\t|No\t|\t|\n","|Percentage\t|Yes\t|Enter a new value and update the associated bidding adjustment entity \t|\n","|Product Targeting Expression\t|No\t|Targeting can only be archived or paused.\t|\n","|Off-Amazon ad serving\t|Yes\t|This campaign-level field controls off-Amazon ad serving. Enter Increase reach or Limit off-Amazon spend. Available in US.\t|\n"],"documentType":"guide"},{"title":"Understand which fields can be updated in bulksheets","sectionHeader":{"type":2,"text":"Sponsored Brands fields"},"path":"/en-us/no-code-tools/bulksheets/editable-non-editable-bulksheets-fields","content":["|grid-\t|Can update?\t|Guidelines and tips \t|\n","|---\t|---\t|---\t|\n","|Product\t|N/A\t|This foundational field defines the campaign type\t|\n","|Entity\t|N/A\t|This foundational field defines the entity you want to manage\t|\n","|Operation\t|N/A\t|This foundational field defines the action you want to happen when you upload the file (create, update, or archive). When this field is blank, the row will be ignored in the upload process.\t|\n","|Campaign Id\t|No\t|None of the ID fields can be changed, but you will use them when updating or archiving the associated entity. For example, to update a campaign name, you will enter the Campaign ID in this field and put the new name in the \"Campaign Name\" field. This same general process is used when updating any entity. \t|\n","|Draft Campaign Id\t|No\t|\t|\n","|Portfolio Id\t|No\t|You can create a new campaign within an existing portfolio if you include the Portfolio ID in the same row where you are creating the campaign.\t|\n","|Ad Group Id\t|No\t|Include this ID to update or archive the ad group entity \t|\n","|Keyword Id\t|No\t|Include this ID to update or archive the keyword entity.\t|\n","|Product Targeting Id\t|No\t|When you create a product targeting expression using ASINs, unique IDs will be created and can be found in this \"Product Targeting ID\" field when you download a bulksheets file. You will use this ID if you want to pause or archive the product targeting entity. \t|\n","|Campaign Name\t|Yes\t|Enter the new name in this field, and set \"Operation\" to update. Be sure to also include the Campaign ID.  \t|\n","|Start Date\t|Yes\t|When updating a campaign, you cannot change the start date. Either leave the value unchanged, or delete the value and leave the start date field blank. Leaving this field blank will not affect the start date--it will be ignored in the upload process.\t|\n","|End Date\t|No\t|When updating a campaign, you can leave this value unchanged to keep the current end date, enter a date if you want to set a new end date, or leave blank if you want the campaign to run indefinitely. Note that leaving this field blank will override and remove the current end date\t|\n","|State\t|Yes\t|This field should always contain a value, unless the \"Operation\" is set to archive. In that case, the \"State\" field can be left blank. Note that you use this field to pause entities (such as keywords) by setting \"State\" to paused and \"Operation\" to update.\t|\n","|Budget Type\t|Yes\t|To change the budget type, enter daily or lifetime and update the campaign entity.\t|\n","|Budget\t|Yes\t|Enter a new budget amount, and update the campaign entity.\t|\n","|Bid Optimization\t|Yes\t|If you enter manual, you should also enter a value in the \"Bid Multiplier\" field. If you enter auto, leave the \"Bid Multiplier\" field blank. Bid optimization and multiplier are both set at the campaign entity level. \t|\n","|Bid Multiplier\t|Yes\t|Enter a value if you are also updating the \"Bid Optimization\" field to be manual, and update the campaign entity. \t|\n","|Bid\t|Yes\t|Enter a new value and update the associated keyword or product targeting entity \t|\n","|Keyword Text\t|No\t|Keyword text cannot be updated. Instead, you can archive or pause keywords that you no longer want to be active \t|\n","|Match Type\t|No\t|\t|\n","|Product Targeting Expression\t|No\t|Targeting can only be archived or paused.\t|\n","|Ad Format\t|No\t|\t|\n","|Landing Page URL\t|No\t|None of the creative assets can be changed after they are created. Instead, you can archive the associated entity and create new ones. \t|\n","|Landing Page Asins\t|No\t|\t|\n","|Brand Entity Id\t|No\t|\t|\n","|Brand Name\t|No\t|\t|\n","|Brand Logo Asset Id\t|No\t|\t|\n","|Brand Logo URL\t|No\t|\t|\n","|Creative Headline\t|No\t|If you want to change a creative headline, you must archive the associated campaign and create a new one with the new headline.\t|\n","|Creative ASINs\t|No\t|\t|\n","|Video Media Ids\t|No\t|\t|\n","|Creative Type\t|No\t|\t|\n"],"documentType":"guide"},{"title":"Understand which fields can be updated in bulksheets","sectionHeader":{"type":2,"text":"Sponsored Display fields"},"path":"/en-us/no-code-tools/bulksheets/editable-non-editable-bulksheets-fields","content":["|grid-\t|Can update?\t|Guidelines and tips \t|\n","|---\t|---\t|---\t|\n","|Product\t|N/A\t|This foundational field defines the campaign type\t|\n","|Entity\t|N/A\t|This foundational field defines the entity you want to manage\t|\n","|Operation\t|N/A\t|This foundational field defines the action you want to happen when you upload the file (create, update, or archive). When this field is blank, the row will be ignored in the upload process.\t|\n","|Campaign Id\t|No\t|None of the ID fields can be changed as they are defined by the Amazon ads backend. \t|\n","|Ad Group Id\t|No\t|Include this ID to update or archive the ad group entity. \t|\n","|Ad Id\t|No\t|Include this ID to update or archive the product ad entity.\t|\n","|Targeting Id\t|No\t|Include this ID to update or archive the targeting entity.\t|\n","|Campaign Name\t|Yes\t|Enter the new name in this field, and set \"Operation\" to update. Be sure to also include the Campaign ID.  \t|\n","|Ad Group Name\t|Yes\t|Enter the new name in this field, and set \"Operation\" to update. Be sure to also include the Ad Group and Campaign IDs.\t|\n","|Start Date\t|No\t|When updating a campaign, you cannot change the start date. Either leave the value unchanged, or delete the value and leave the start date field blank. Leaving this field blank will not affect the start date--it will be ignored in the upload process.\t|\n","|End Date\t|Yes\t|When updating a campaign, you can leave this value unchanged to keep the current end date, enter a date if you want to set a new end date, or leave blank if you want the campaign to run indefinitely. Note that leaving this field blank will override and remove the current end date\t|\n","|State\t|N/A\t|This field should always contain a value, unless the \"Operation\" is set to archive. In that case, the \"State\" field can be left blank. Note that you use this field to pause entities by setting \"State\" to paused and \"Operation\" to update.\t|\n","|Tactic\t|No\t|\t|\n","|Budget Type\t|N/A\t|For now, the only supported budget type for Sponsored Display in bulksheets is daily\t|\n","|Budget\t|Yes\t|Enter a new value and update the campaign entity\t|\n","|SKU\t|No\t|You cannot update a SKU or ASIN, but you can pause or archive the associated product ad entity and then create a new one with the SKU or ASIN you want to add.\t|\n","|ASIN\t|No\t|You cannot update a SKU or ASIN, but you can pause or archive the associated product ad entity and then create a new one with the SKU or ASIN you want to add.\t|\n","|Ad Group Default Bid\t|Yes\t|Enter a new amount and update the ad group entity \t|\n","|Bid\t|Yes\t|Enter a new amount and update the targeting entity \t|\n","|Bid Optimization\t|No\t|\t|\n","|Cost Type\t|No\t|\t|\n","|Targeting Expression\t|No\t|\t|\n"],"documentType":"guide"},{"title":"Sponsored Products entities","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sp/sp-entities/sp-entities","content":[" To manage Sponsored Products campaigns effectively using bulksheets, it is helpful to understand the different entities and their relationships. An “entity” starts with a top-level campaign (the “parent”) along with “child” entities underneath. For example, an ad group and bid adjustment are each a child entity of the parent-level campaign. Some child entities have sub-entities of their own. For instance, under the ad group entity, a product ad would be a child of that ad group. \n"," With bulksheets, you will start at the top-level parent entity when you start to create a new campaign in your spreadsheet, and work down from the parent to add child entities in spreadsheet rows underneath. The visual diagrams below show these entity types and their relationships for SP campaigns. These entities correspond to the Entity field (Column B) that you will see in a bulksheets file.  \n"," Whenever you create a new Sponsored Products campaign, you will choose between two targeting types: automatic (auto) or manual. If you create a manual targeting campaign, you will also choose between keyword or product targeting:\n","Auto targeting  \\* Manual targeting\n"," NOTE: For each targeting type, the mandatory entities are colored green for reference. These are the basic entities that you must have in order to successfully create a Sponsored Products campaign. You can also include other entities, such as a bid adjustment or negative keyword, to further customize your campaign.   \n"," \\*\\*\n"],"documentType":"guide"},{"title":"Sponsored Products product attribute targeting expressions","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sp/sp-general-info/sp-product-attribute-targeting","content":[" When you create a Product targeting entity in bulksheets, the Product Targeting Expression field lets you target individual products (by ASIN) or entire categories, optionally refined by brand, price, review rating, Prime shipping eligibility, age range, or genre. This article lists sample expressions for each targeting predicate, along with the rules that govern how you can combine them.\n"," For guidance on the basic asin= and category= syntax, see the Product Targeting Expression field description in How to create Sponsored Products campaigns or How to create Sponsored Brands campaigns.\n"],"documentType":"guide"},{"title":"Sponsored Products product attribute targeting expressions","sectionHeader":{"type":2,"text":"Targeting predicates and sample expressions"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-general-info/sp-product-attribute-targeting","content":["| Targeting predicate         | Sample expression                                                            |\n","\\|-----------------------------\\|------------------------------------------------------------------------------\\|\n","| category same as            | category=\"9\"                                                                 |\n","| asin same as                | asin=\"B0794SNF6C\"                                                            |\n","| brand same as               | category=\"5524098011\" brand=\"8046181011\"                                     |\n","| price less than             | category=\"5524098011\" price&lt;10                                               |\n","| price between               | category=\"5524098011\" price=10-20                                            |\n","| price greater than          | category=\"5524098011\" price>10                                               |\n","| review rating less than     | category=\"5524098011\" rating&lt;4                                               |\n","| review rating between       | category=\"5524098011\" rating=4.5-5                                           |\n","| review rating greater than  | category=\"5524098011\" rating>4.5                                             |\n","| prime shipping eligible     | category=\"5524098011\" prime-shipping-eligible=\"true\"                         |\n","| age range                   | category=\"166099011\" age-range=\"5442387011\" prime-shipping-eligible=\"true\"   |\n","| genre                       | category=\"8619203011\" prime-shipping-eligible=\"true\" age-range=\"1\" genre=\"1\" |\n"],"documentType":"guide"},{"title":"Sponsored Products product attribute targeting expressions","sectionHeader":{"type":2,"text":"Product targeting expression rules"},"path":"/en-us/no-code-tools/bulksheets/sp/sp-general-info/sp-product-attribute-targeting","content":[],"documentType":"guide"},{"title":"Sponsored Brands entities","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sb-legacy/sb-entities/sb-entities","content":[" To manage Sponsored Brands campaigns effectively using bulksheets, it is helpful to understand the different entities and their relationships. An “entity” starts with a top-level campaign (the “parent”) along with “child” entities underneath. For Sponsored Brands, child entities include keyword and negative keyword if you choose keyword targeting, or product targeting and negative product targeting if you choose product targeting.\n"," With bulksheets, you will start at the top-level parent entity when you start to create a new campaign in your spreadsheet, and work down from the parent to add child entities in spreadsheet rows underneath. The visual diagram below shows these entity types and their relationships for SB campaigns. These entities correspond to the Entity field (Column B) that you will see in a bulksheets file.  \n"," NOTE: The mandatory entities are colored green for reference. These are the basic entities that you must have in order to successfully create a Sponsored Brands campaign. After selecting a targeting strategy, you will further define the strategy by creating a bulksheets entity for keyword or product targeting, depending on which approach you use. \n"],"documentType":"guide"},{"title":"Sponsored Brands v4 (multi-ad group) entities","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sb/sb-entities/sb-entities","content":[" To manage Sponsored Brands V4 (multi-ad group) campaigns effectively using bulksheets, it is helpful to understand the different entities and their relationships. An \"entity\" starts with a top-level campaign (the \"parent\") along with \"child\" entities underneath. For Sponsored Brands, child entities include the ad group(s) and optional bidding adjustment by placement. Then, the targets (either keyword or product targeting) are child entities of both the ad group and the campaign—this means that you need to include the parent IDs for the campaign and the ad group when you create the targeting rows in bulksheets. Similarly, the four ad formats are child entities of the ad group and campaign, so those parent IDs are also required in the rows where you create the ad. \n"," With bulksheets, you will start at the top-level parent entity when you start to create a new campaign in your spreadsheet, and work down from the parent to add child entities in spreadsheet rows underneath. The visual diagram below shows these entity types and their relationships for SB campaigns. These entities correspond to the \"Entity\" field (Column B) that you will see in a bulksheets file.  \n"," NOTE: The required entities are colored pink for reference. These are the basic entities that you must have in order to create a successful Sponsored Brands multi-ad group campaign. Thus, based on the diagram below, the mandatory entities you must create include the campaign, ad group, ad format, and targeting strategy. The bidding adjustment by placement and negative targets are optional entities. Each entity will be in its own row in your bulk spreadsheet. \n"," The available ad format entity types are:\n","Manual Collection ad — Feature 3–10 related products you choose from your catalog  Auto Collection ad — Let Amazon AI dynamically group the most relevant products from your catalog  Store spotlight ad — Drive traffic to certain Store pages  Video ad — Promote a single product with video (landing page: Detail page)  Brand video ad — Promote with video (landing page: Store on Amazon) \\* Product collection ad (DEPRECATED) — Use Manual Collection ad or Auto Collection ad instead\n"],"documentType":"guide"},{"title":"Sponsored Display entities","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/sd/sd-entities/sd-entities","content":[" To manage Sponsored Display campaigns effectively using bulksheets, it is helpful to understand the different entities and their relationships. An \"entity\" starts with a top-level campaign (the \"parent\") along with \"child\" entities underneath. For example, an SD campaign always contains an ad group, which is a child entity of the parent-level campaign. Any attributes that are set at the campaign level (such as start dates) will be inherited by the child entities. In some cases, you can set attributes at the child level that will override the campaign-level setting. For example, a bid set at the campaign level will be inherited by the ad group, unless you set an \"ad group default bid.\" \n"," With bulksheets, you will start at the top-level parent entity when you start to create a new campaign in your spreadsheet, and work down from the parent to add child entities in spreadsheet rows underneath. The visual diagram below shows these entity types and their relationships for SD campaigns. These entities correspond to the Entity field (Column B) that you will see in a bulksheets file.  \n"," Whenever you create a new Sponsored Display campaign, you must define the targeting tactic--either audience or contextual targeting.   \n"," NOTE: For each targeting type, the mandatory entities are colored green for reference. These are the basic entities that you must have in order to create a successful campaign. \n"],"documentType":"guide"},{"title":"Bulksheets video tutorials","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/bulksheets-videos","content":[" This article contains a series of eight video tutorials with guidelines and tips for success. Topics range from a general bulksheets overview, to campaign creation, optimization, and more. For each video, you can see a brief description of the content, along with timestamps if you want to skip to a topic within the video. \n"," To jump directly to a particular video, click the links below:\n"],"documentType":"guide"},{"title":"Bulksheets video tutorials","sectionHeader":{"type":2,"text":"Bulksheets overview"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-videos","content":[" This video is for advertisers interested in using bulksheets who want more information. If you are using the advertising console and want to scale to manage multiple campaigns more efficiently, this video will explain how.  Total time: 04:14\n","|Timestamp\t|Topic\t|\n","|---\t|---\t|\n","|00:00\t|Intro and video overview\t|\n","|00:30\t|What the video will and will not cover\t|\n","|01:00\t|Amazon Ads advanced tools: Which one is right for you?\t|\n","|02:20\t|Bulksheets benefits\t|\n","|03:04\t|Bulksheets common use cases\t|\n","|03:45\t|Where to access bulksheets\t|\n","|04:00\t|Where to learn more\t|\n"],"documentType":"guide"},{"title":"Bulksheets video tutorials","sectionHeader":{"type":2,"text":"Bulksheets custom templates "},"path":"/en-us/no-code-tools/bulksheets/bulksheets-videos","content":[" This video is for advertisers who want to use bulksheets and want more clarity on how to get a custom template with the campaign data you want to see. The video also walks through each tab contained within the template.  Total time: 07:00\n","|Timestamp\t|Topic\t|\n","|---\t|---\t|\n","|00:00\t|Intro and video overview\t|\n","|00:40\t|Where to find the bulk operations page\t|\n","|01:05\t|How to select the data you want to see\t|\n","|02:30\t|What to expect when you download and open your bulksheets file\t|\n","|02:48\t|Portfolios tab\t|\n","|03:10\t|Brand assets data tab\t|\n","|04:10\t|Sponsored Products tab\t|\n","|05:05\t|Sponsored Brands tab\t|\n","|06:05\t|Sponsored Display tab\t|\n","|06:46\t|Where to learn more\t|\n"],"documentType":"guide"},{"title":"Bulksheets video tutorials","sectionHeader":{"type":2,"text":"Create campaigns"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-videos","content":[],"documentType":"guide"},{"title":"Bulksheets video tutorials","sectionHeader":{"type":3,"text":"How to create Sponsored Products auto campaigns "},"path":"/en-us/no-code-tools/bulksheets/bulksheets-videos","content":[" This video is ideal for advertisers who want to manage Sponsored Products campaigns using bulksheets.  Total time: 08:59 \n","|Timestamp\t|Topic\t|\n","|---\t|---\t|\n","|00:00\t|Intro and video overview\t|\n","|00:40\t|Download a blank bulksheets template\t|\n","|01:17\t|A few tips for success\t|\n","|02:05\t|Determine campaign goals\t|\n","|03:00\t|Understand campaign structure and hierarchy\t|\n","|04:15\t|Step 1: Campaign entity row\t|\n","|05:40\t|Step 2: Bidding adjustment entity row\t|\n","|06:27\t|Step 3: Ad group entity row\t|\n","|06:47\t|Step 4: Product ad entity row\t|\n","|07:16\t|Save & upload the file\t|\n","|07:42 \t|Important note about product targeting with auto campaigns\t|\n","|08:45\t|Where to learn more\t|\n"],"documentType":"guide"},{"title":"Bulksheets video tutorials","sectionHeader":{"type":3,"text":"How to create Sponsored Brands campaigns"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-videos","content":[" This video is ideal for advertisers who want to manage Sponsored Brands campaigns using bulksheets. Total time: 06:36  \n","|Timestamp\t|Topic\t|\n","|---\t|---\t|\n","|00:00\t|Intro and video overview\t|\n","|00:27\t|Download a blank bulksheets template\t|\n","|00:55\t|A few tips for success\t|\n","|01:45\t|Determine campaign goals\t|\n","|03:00\t|Understand campaign structure and hierarchy\t|\n","|04:03\t|Step 1: Campaign entity row\t|\n","|05:36\t|Step 2: Keyword entity row\t|\n","|06:12\t|Save & upload the file\t|\n","|06:22\t|Where to learn more\t|\n"],"documentType":"guide"},{"title":"Bulksheets video tutorials","sectionHeader":{"type":3,"text":"How to create Sponsored Display campaigns"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-videos","content":[" This video is ideal for advertisers who want to manage Sponsored Display campaigns using bulksheets.  Total time: 09:55  \n","|Timestamp\t|Topic\t|\n","|---\t|---\t|\n","|00:00\t|Intro and video overview\t|\n","|00:40\t|Download a blank bulksheets template\t|\n","|01:08\t|A few tips for success\t|\n","|01:50\t|Determine campaign goals\t|\n","|03:20\t|Understand campaign structure and hierarchy\t|\n","|04:26\t|Step 1: Campaign entity row\t|\n","|05:40\t|Step 2: Ad group entity row\t|\n","|06:00\t|Step 3: Product ad entity row\t|\n","|06:12\t|Step 4: Contextual targeting entity row\t|\n","|07:10\t|Important tips about targeting expression values\t|\n","|07:45\t|Add an audience targeting campaign to the sheet\t|\n","|09:29\t|Save & upload the file\t|\n","|09:42\t|Where to learn more\t|\n"],"documentType":"guide"},{"title":"Bulksheets video tutorials","sectionHeader":{"type":2,"text":"Formatting tips"},"path":"/en-us/no-code-tools/bulksheets/bulksheets-videos","content":[" This video is for advertisers who use bulksheets to manage campaigns. The goal is to help you understand bulksheets formatting so you can avoid errors when you upload the file.   Total time: 04:54\n","|Timestamp\t|Topic\t|\n","|---\t|---\t|\n","|00:00\t|Intro and video overview\t|\n","|00:13\t|What the video will and will not cover\t|\n","|00:25\t|Bulksheets error reports\t|\n","|01:34\t|Formatting dates\t|\n","|02:38\t|Formatting dollar figures\t|\n","|03:00\t|Formatting percent figures\t|\n","|03:34\t|Formatting Sponsored Products placements\t|\n","|04:00\t|Formatting Sponsored Display targeting tactics\t|\n","|04:24\t|Formatting Portfolio terminology\t|\n","|04:37\t|Where to learn more\t|\n"],"documentType":"guide"},{"title":"Bulksheets video tutorials","sectionHeader":{"type":2,"text":"Optimize campaigns "},"path":"/en-us/no-code-tools/bulksheets/bulksheets-videos","content":[" This video is for advertisers who use bulksheets to manage campaigns. The goal is to provide guidelines and tips for reviewing campaigns to optimize performance. You will learn how to archive and pause keywords, adjust bids, and more.  Total time: 08:38\n","|Timestamp\t|Topic\t|\n","|---\t|---\t|\n","|00:00\t|Intro and video overview\t|\n","|00:20\t|Optimization topics the video will cover\t|\n","|00:36\t|Getting a custom template\t|\n","|01:20\t|Optimize keywords\t|\n","|04:45\t|Optimize bids\t|\n","|07:00\t|Optimize ASINs\t|\n","|08:20\t|Where to learn more\t|\n"],"documentType":"guide"},{"title":"Bulksheets video tutorials","sectionHeader":{"type":2,"text":"Migrating from legacy to the new version  "},"path":"/en-us/no-code-tools/bulksheets/bulksheets-videos","content":[" This video is for advertisers who have used the deprecated legacy version of bulksheets and are looking for guidance on using the new version. The content focuses on the differences you will see when you start using the new template. The arrow symbols below indicate what has changed from legacy compared with the new version—for example, the \"Record Type\" field is now labeled \"Entity\".  Total time: 07:19\n","|Timestamp\t|Topic\t|\n","|---\t|---\t|\n","|00:00\t|Intro and video overview\t|\n","|00:28\t|What the video will and will not cover\t|\n","|01:00\t|New: Product, Entity, & Operation columns\t|\n","|01:55\t|Record ID → Entity IDs\t|\n","|02:50\t|Record Type → Entity\t|\n","|03:37\t|Campaign → Campaign Name\t|\n","|03:50\t|Campaign Daily Budget → Daily Budget\t|\n","|04:00\t|Campaign Start Date → Start Date\t|\n","|04:10\t|Status → State\t|\n","|04:45\t|Max Bid → Ad Group Default Bid, Bid\t|\n","|05:05\t|Keyword or Product Targeting → Keyword Text, Product Targeting Expression\t|\n","|05:38\t|Increase bids by placement → Percentage, Placement\t|\n","|06:10\t|A few tips for Sponsored Brands\t|\n","|06:35\t|Automated bidding → Bid optimization\t|\n","|07:02\t|Where to learn more\t|\n"],"documentType":"guide"},{"title":"Bulksheets 2.0 FAQs","sectionHeader":null,"path":"/en-us/no-code-tools/bulksheets/faqs","content":[" This article contains FAQs for general bulksheets questions, along with campaign-specific ones. Click on the questions to see the answers and learn more.\n"," Jump to Sponsored Products | Sponsored Brands | Sponsored Display\n"],"documentType":"guide"},{"title":"Bulksheets 2.0 FAQs","sectionHeader":{"type":2,"text":"General FAQs"},"path":"/en-us/no-code-tools/bulksheets/faqs","content":[" You can find bulksheets templates from the main bulk operations page. Access this page from campaign manager: Look for the sponsored ads icon in the left navigation panel > click Bulk operations. Learn more about how to access bulksheets in the Getting started guide.  We recommend reviewing the support articles here in the advanced tools center, including the introductory Getting started guide. In terms of campaign type, you might find that a Sponsored Products auto-targeting campaign is a good place to start if you want to try using bulksheets. After you create the campaign, you can monitor and optimize by downloading a custom bulksheets file and reviewing the performance metrics.  We recommend starting with the Bulksheets overview article. This resource contains FAQs specifically about the new version, along with other tips and guidelines for migrating.  Yes. Bulksheets now supports all sponsored ads campaigns, including Sponsored Products, Sponsored Brands, and Sponsored Display. Learn more about using bulksheets to create sponsored ads campaigns in the product-specific user guides.  Yes. Many advertisers use a combination of Amazon Ads tools, including bulksheets, the advertising console, and the Amazon Ads API. If you are currently using the console to manage several campaigns, you might find that bulksheets is a more efficient way to make changes to multiple campaigns--and bulksheets requires no developer resources, so it might be a better option than the API. If you are not sure which option to use, the advanced tools center can help you decide which Amazon Ads tool is right for you.  To update a campaign name, the mandatory required fields are Product, Entity, Operation, Campaign ID, and Campaign Name. If you are using a downloaded bulksheets file that contains campaign data, many of those values will already be in the spreadsheet, so you only need to make two edits: Set the \"Operation\" field to update, and enter the new name in the \"Campaign Name\" field. If you are using a blank template, you need to add all of the mandatory fields. Learn more about changing campaign names in Overview - update campaigns with bulksheets.  To update an ad group, the mandatory required fields are Product, Entity, Operation, Campaign ID, Ad Group ID, and Ad Group Name. If you are using a downloaded bulksheets file that contains campaign data, many of those values will already be in the spreadsheet, so you only need to make two edits: Set the \"Operation\" field to update, and enter the new name in the \"Ad Group Name\" field.  When you download a custom bulksheet with campaign data, you will see some fields designated as \"informational only.\" Some examples of these include campaign name and ad group name, campaign status and ad group status, ASIN eligibility status fields, and ad group default bid.  The purpose of these fields is to give you helpful information about names and statuses that would otherwise be hidden when you have filters applied to the \"Entity\" column. For example, if you want to isolate keywords, you might apply a filter to show keyword entities only. In this case, the names and statuses of the associated campaigns and ad groups would be hidden. But with the \"informational only\" fields, you can still see those values regardless of filtering.  If your file contains any errors, you will see a message in the \"Bulk spreadsheet history\" section indicating how many rows were processed and how many rows contained errors. If your sheet contained errors, you can download a report to see exactly which rows have errors and what the cause of the error might be.  Then, you can make edits directly in the error report file, and upload that file to finish creating or updating the campaign. For example, if you received an error because you included a forbidden character in a keyword row, you can fix that error in the error report, save the file, and upload it to fix the issue. You do not need to delete the other sheets because the upload process will simply ignore the summary sheet and error columns.  Before you create the ad in bulksheets, you can check your product inventory to be sure the items you want to advertise are in stock and have the required elements, such as a product image. After you create your campaigns, you can download a bulksheets file with campaign data to check ASIN eligibility. This will show you if any ASINs became ineligible after the campaign started running. If your campaign performance metrics are unusually low, or if you see that lots of customers are clicking your ad but not completing the purchase, this could be due to ASIN eligibility. For example, an ASIN that has gone out of stock might still generate ad clicks, but customers would not be able to purchase. In a downloaded bulksheets file, look for column headers near the ASIN field that indicate \"Eligibility Status\" and \"Reason for Ineligibility.\" In addition to being out of stock, other reasons for ineligibility include missing or incomplete product information, such as a product that does not include a product image.  Similar to campaign management in the advertising console, you can archive or pause campaigns to stop them from running. Archiving is a permanent action that cannot be undone, while pausing is less permanent. To archive a campaign, the mandatory fields are Product, Entity, Operation, and Campaign ID. In a downloaded file, most of these fields will already be populated. In the \"Operation\" field, enter archive to archive the campaign. To pause a campaign, the mandatory fields are Product, Entity, Operation, Campaign ID, and State. In the \"Operation\" field, enter update. In the \"State\" field, enter paused. To undo this action, you can follow these same steps, but enter enabled in the \"State\" field.  Learn more about updating keywords for Sponsored Products and updating keywords for Sponsored Brands.  Similar to keywords, you cannot swap ASINs or change products after the entity is created. Instead, you should archive or pause the product targeting entities that you want to remove. Then, you can create a new product targeting entity within the campaign, using the ASINs you want to apply. No. If the \"Operation\" field is blank for any row, that entire row will be ignored in the upload process. So as long as you only include values in the rows you want to update, you can leave the other data in the sheet for better efficiency. \n"],"documentType":"guide"},{"title":"Bulksheets 2.0 FAQs","sectionHeader":{"type":2,"text":"Sponsored Products FAQs"},"path":"/en-us/no-code-tools/bulksheets/faqs","content":[" To set a bidding adjustment, you should create a new bidding adjustment entity under the campaign, using the campaign ID. For the bidding adjustment row, the required fields include Product, Entity, Operation, Campaign ID, Bidding strategy, Placement, and Percentage. Learn more about adding a bidding adjustment to a Sponsored Products campaign.  Yes, you have the option to create four product targeting entities with auto targeting campaigns, and you can apply bids to any of these. If you want to define these entities, you should create four rows in your auto targeting campaign—one for each product targeting expression: close-match, loose-match, complements, and substitutes (see the definitions listed below). In the ads console, this is the section where you can Set bids by targeting group. For any targets you do not want to bid on, you should set the \"State\" field to be paused in those rows. \n"," If you do not create these product targeting entities, Amazon will automatically create one entity for each targeting expression, and the ad group default bid will apply. Learn more about how to create Sponsored Products auto-targeting campaigns.\n"," Auto-targeting expression definitions:\n"," Close-match: Amazon will show your ad to shoppers who use search terms closely related to your products. If your product is \"Doppler 400-count Cotton Sheets,\" we will show an ad when shoppers use search terms like \"cotton sheets\" and \"400-count sheets.\"  Loose-match: Amazon will show your ad to shoppers who use search terms loosely related to your products. If your product is Doppler 400-count Cotton Sheets, we will show an ad when shoppers use search terms like \"bed sheets,\" \"bath sheets,\" and \"bath towels.\" Substitutes: Amazon will show your ad to shoppers who use detail pages of products similar to yours. If your product is \"Doppler 400-count Cotton Sheets,\" we will show an ad on detail pages that include \"300-count Cotton sheets\" and \"queen 400-count Sheets.\" Complements: Amazon will show your ad to shoppers who view the detail pages of products that complement your product. If your product is \"Doppler 400-count Cotton sheets,\" we will show an ad on detail pages that include \"queen comforter\" and \"feather pillows.\"\n"," The Sites field allows you to specify which Amazon site your Sponsored Products campaign will run on. Valid values are \"Amazon Business\" for B2B customers or \"Amazon Haul\". Leave the field blank for the default setting (Amazon and Beyond). This is particularly useful for advertisers who want to focus their campaigns on specific customer segments. If you leave the Sites field blank, your campaign will default to \"Amazon and Beyond\". No. The Sites field is immutable, meaning it cannot be changed after the campaign is created. If you need to target a different site, you need to archive the existing campaign and create a new one with your desired Sites value. You can copy other campaign settings (like budget, bidding strategy, and targeting) to save time when creating the new campaign. To create an Amazon Business exclusive campaign, set the Sites field to \"Amazon Business\" when creating your campaign entity. This will ensure your ads only show to Amazon Business customers. All other campaign setup steps remain the same—you still need to define your campaign name, budget, targeting type, bidding strategy, and other standard fields. Since the Sites field cannot be changed after campaign creation, you need to create a new campaign to target Amazon Business. Here is the most efficient approach: 1. Download a custom bulksheets file that includes your existing campaign data 2. Locate the campaign row you want to copy 3. Copy that entire campaign row to a new row in your spreadsheet 4. In the new row, change the \"Operation\" field from \"Update\" to \"Create\" 5. Clear the \"Campaign ID\" field (leave it blank so a new ID will be generated) 6. Update the \"Campaign Name\" field to distinguish it from the original (e.g., add \"- AB\" to the name) 7. Set the \"Sites\" field to \"Amazon Business\" 8. Keep all other settings the same (budget, bidding strategy, start date, etc.) 9. If you want to copy ad groups, keywords, or product targeting, repeat this process for those entity rows, making sure to reference the new campaign name 10. Upload the bulksheets file to create your new Amazon Business campaign This approach allows you to quickly replicate a successful campaign structure and settings while targeting Amazon Business customers specifically.\n"],"documentType":"guide"},{"title":"Bulksheets 2.0 FAQs","sectionHeader":{"type":2,"text":"Sponsored Brands FAQs "},"path":"/en-us/no-code-tools/bulksheets/faqs","content":[" No. Creative headlines cannot be updated after you create them. Instead, you should archive the campaign and create a new campaign using the creative headline you want to apply. If the creative headline is the only campaign element you want to update, you can save time by copying some of the other campaign data (brand asset IDs, for example) into the new campaign row.  When you download and create a custom spreadsheet, the file will contain a tab labeled \"Brand Assets Data\" if you select the option to include this data in the download. Learn more about how to understand bulksheets data.\n"," Yes. The Sites field functions identically for both Sponsored Brands and Sponsored Products campaigns. You can set it to \"Amazon Business\" when creating a campaign, or leave it blank for the default (Amazon and Beyond). Amazon Haul is not available for Sponsored Brands. Like Sponsored Products, the Sites field cannot be changed after campaign creation, so you need to create a new campaign if you want to target a different site. To copy an existing Sponsored Brands campaign and convert it to Amazon Business, follow the same process described in the Sponsored Products FAQs above.\n"],"documentType":"guide"},{"title":"Bulksheets 2.0 FAQs","sectionHeader":{"type":2,"text":"Sponsored Display FAQs"},"path":"/en-us/no-code-tools/bulksheets/faqs","content":[],"documentType":"guide"},{"title":"Understand Bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulk-operations/overview","content":[" Manage and create campaigns at scale by editing multiple campaigns, keywords, ads, and ad groups in a single spreadsheet.\n"],"documentType":"guide"},{"title":"Understand Bulksheets","sectionHeader":{"type":2,"text":"What are bulksheets?"},"path":"/en-us/no-code-tools/bulk-operations/overview","content":[" Bulksheets let you create, edit, and optimize advertising campaigns in bulk using spreadsheet files. You can update hundreds of campaigns simultaneously instead of making changes one at a time. Bulksheets are ideal for advertisers who are comfortable with the console workflow, but want access to a more scalable solution as their advertising needs grow.\n"," Benefits:\n","Make multiple edits across campaigns in one spreadsheet  Create multiple campaigns, add multiple ad groups from one file  Change campaign and ad group names in large batches instead of one at a time \\* Adjust bids across hundreds of campaigns simultaneously\n"],"documentType":"guide"},{"title":"Understand Bulksheets","sectionHeader":{"type":2,"text":"Recommended use cases"},"path":"/en-us/no-code-tools/bulk-operations/overview","content":[" It is helpful to have a good understanding of how to create campaigns before using bulksheets. This is because certain fields in bulksheets correspond directly to what you see in the console. The following table provides guidelines to help you understand if bulksheets is the right option for you.\n","| What do you want to do? | Ads console | Bulksheets |\n","\\|---\\|---\\|---\\|\n","| Create your first campaign | ✓ | |\n","| Create multiple campaigns at once | | ✓ |\n","| Get bid recommendations | ✓ | |\n","| Access reports | ✓ | |\n","| Bulk keyword management | | ✓ |\n","| Bulk performance optimization | | ✓ |\n","| Automate campaigns | | ✓ |\n"],"documentType":"guide"},{"title":"Understand Bulksheets","sectionHeader":{"type":2,"text":"Related topics"},"path":"/en-us/no-code-tools/bulk-operations/overview","content":[],"documentType":"guide"},{"title":"Manage Amazon DSP campaigns with bulksheets","sectionHeader":null,"path":"/en-us/no-code-tools/bulk-operations/dsp/overview","content":[" Use Amazon DSP bulk operations to create and manage orders, line items, and creative associations at scale using a spreadsheet.\n"],"documentType":"guide"},{"title":"Manage Amazon DSP campaigns with bulksheets","sectionHeader":{"type":2,"text":"How it works"},"path":"/en-us/no-code-tools/bulk-operations/dsp/overview","content":["Download — Export your existing campaign data or download a blank template from the Bulk Operations page in the Amazon DSP console. You can filter by advertiser, order, ad group, order status, and line item status. 2. Edit — Open the .xlsx file in your spreadsheet application (such as Microsoft Excel or Google Sheets). Make changes to existing rows or add new rows to create new entities. 3. Upload — Upload the edited spreadsheet to apply your changes. The system processes your file and reports success, partial success, or failure for each record.\n"],"documentType":"guide"},{"title":"Manage Amazon DSP campaigns with bulksheets","sectionHeader":{"type":2,"text":"Supported entity types"},"path":"/en-us/no-code-tools/bulk-operations/dsp/overview","content":["| Entity type | Sheet tab(s) | Description |\n","\\|---\\|---\\|---\\|\n","| Orders | ORDERS | Top-level campaign containers that define budget, flight dates, and advertiser settings. Supported order types include MLB line-paced, MLB order-paced, and flighted orders. |\n","| Line items | DISPLAY LINE ITEMS, VIDEO LINE ITEMS, AUDIO LINE ITEMS | Ad groups within an order that define targeting, bidding, pacing, and delivery settings. |\n","| Creative associations | CREATIVE ASSOCIATIONS | Mappings between creatives and line items that determine which ads serve on each line item. |\n"],"documentType":"guide"},{"title":"Manage Amazon DSP campaigns with bulksheets","sectionHeader":{"type":3,"text":"Supported line item types"},"path":"/en-us/no-code-tools/bulk-operations/dsp/overview","content":["Standard Display  Amazon Mobile Display  AAP Mobile App  Video (Online Video, Streaming TV, Live Events)  Audio\n"],"documentType":"guide"},{"title":"Manage Amazon DSP campaigns with bulksheets","sectionHeader":{"type":2,"text":"File format and limits"},"path":"/en-us/no-code-tools/bulk-operations/dsp/overview","content":["| Constraint | Limit |\n","\\|---\\|---\\|\n","| File format | .xlsx (Excel) only |\n","| Maximum allowed file size for upload | 2 MB |\n","| Maximum number of Campaign / Adgroup rows uploaded per file | 1,000 |\n","| Maximum number of Creative Associations rows uploaded per file | 2,000 |\n","| Maximum number of Creative rows uploaded per file | 13,000 |\n","| Maximum number of Campaign / Adgroup rows downloaded per file | 5,000 |\n","| Maximum number of Creative Associations rows downloaded per file | 10,000 |\n","| Maximum number of Creative rows downloaded per file | 13,000 |\n","| Maximum number of rows uploaded or downloaded per day by a customer-id | None |\n","| Maximum tracked products per order | 1,000 (orders with 1,000+ tracked product ASINs cannot be downloaded) |\n"],"documentType":"guide"},{"title":"Manage Amazon DSP campaigns with bulksheets","sectionHeader":{"type":2,"text":"Download options"},"path":"/en-us/no-code-tools/bulk-operations/dsp/overview","content":[" When downloading campaign data, you can customize the export with the following filters:\n","| Filter | Options |\n","\\|---\\|---\\|\n","| Advertisers | One or more advertisers to download |\n","| Custom list of orders | Download a specific list of orders |\n","| Custom list of ad groups | Download a specific list of ad groups |\n","| Filters | Orders, line items, creative associations |\n","| Order products | Download order products, i.e. the conversion tracking ASINs for an order |\n","| Order status | Delivering, Ended, Inactive, Ready to deliver, Processing, Suspended |\n","| Line item status | Delivering, Ended, Inactive, Line items not running, Creatives not running, Ready to deliver, Processing, Suspended |\n"," Processing typically completes within 30 minutes for standard files, with larger datasets requiring additional time.\n"],"documentType":"guide"},{"title":"Manage Amazon DSP campaigns with bulksheets","sectionHeader":{"type":2,"text":"Upload status"},"path":"/en-us/no-code-tools/bulk-operations/dsp/overview","content":[" After uploading a file, you can monitor progress on the Bulk Operations page:\n","| Status | Description |\n","\\|---\\|---\\|\n","| Uploading | File is being processed |\n","| Success | All records were processed successfully |\n","| Partial | Some records succeeded, some failed — download the error report for details |\n","| Failed | The upload could not be processed |\n"," If the upload is partial or failed, you can download the error report to see which records had issues and why, fix those records, and re-upload.\n"],"documentType":"guide"},{"title":"Manage Amazon DSP campaigns with bulksheets","sectionHeader":{"type":2,"text":"Important guidelines"},"path":"/en-us/no-code-tools/bulk-operations/dsp/overview","content":["Do not delete any columns — Removing columns from the spreadsheet will cause upload errors  \\*\\*Required cells are marked with an asterisk () — Ensure all required fields are populated \\* Provide the order ID or line item ID to make updates — If you leave the ID blank, a new entity will be created \\* Date format — Use mm-dd-yyyy-hh-mm format (e.g., 12-30-2021-08-00). Any other format will cause upload errors. \\* Do not use currency symbols or commas — Enter numeric values only for budget and bid fields \\* Save the file before uploading\\*\\* — Ensure all changes are saved in .xlsx format\n"],"documentType":"guide"},{"title":"Manage Amazon DSP campaigns with bulksheets","sectionHeader":{"type":2,"text":"Getting started"},"path":"/en-us/no-code-tools/bulk-operations/dsp/overview","content":[" To access Amazon DSP bulk operations:\n","Sign in to your Amazon Ads account 2. Navigate to the Amazon DSP console 3. From the left navigation, click Bulk operations\n"],"documentType":"guide"},{"title":"Manage Amazon DSP campaigns with bulksheets","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/no-code-tools/bulk-operations/dsp/overview","content":[],"documentType":"guide"},{"title":"Get started with DSP bulk operations","sectionHeader":null,"path":"/en-us/no-code-tools/bulk-operations/dsp/get-started","content":[" This article explains how to get started with Amazon DSP bulk operations, including how to access the feature, download a template or existing campaign data, edit the spreadsheet, and upload your changes.\n"],"documentType":"guide"},{"title":"Get started with DSP bulk operations","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/no-code-tools/bulk-operations/dsp/get-started","content":["An active Amazon DSP account with admin access  Access to the Amazon DSP console  A spreadsheet application that supports .xlsx files (such as Microsoft Excel or Google Sheets)\n"],"documentType":"guide"},{"title":"Get started with DSP bulk operations","sectionHeader":{"type":2,"text":"Step 1: Access the Bulk Operations page"},"path":"/en-us/no-code-tools/bulk-operations/dsp/get-started","content":["Sign in to your Amazon Ads account 2. Navigate to the Amazon DSP console 3. From the left navigation, click Bulk operations\n"," The Bulk Operations page displays two tabs:\n","| Tab | Description |\n","\\|---\\|---\\|\n","| Multimedia solutions with Amazon DSP | Manage orders, line items, and creative associations for DSP campaigns |\n","| Sponsored Products, Brands, Display | Manage sponsored ads campaigns (covered in the sponsored ads bulksheets guide) |\n"],"documentType":"guide"},{"title":"Get started with DSP bulk operations","sectionHeader":{"type":2,"text":"Step 2: Download a spreadsheet"},"path":"/en-us/no-code-tools/bulk-operations/dsp/get-started","content":[" You have two options:\n"],"documentType":"guide"},{"title":"Get started with DSP bulk operations","sectionHeader":{"type":3,"text":"Option A: Download a template"},"path":"/en-us/no-code-tools/bulk-operations/dsp/get-started","content":[" Click Download template and instructions to get a blank spreadsheet with column headers and an instructions sheet. This is useful when creating new campaigns from scratch.\n"],"documentType":"guide"},{"title":"Get started with DSP bulk operations","sectionHeader":{"type":3,"text":"Option B: Download existing campaign data"},"path":"/en-us/no-code-tools/bulk-operations/dsp/get-started","content":[" Click Download to export your existing campaign data. You can filter the download by:\n","Advertisers — All advertisers or a custom list  Export types — All orders and line items, orders only, line items only, or a custom list of orders  Order status — Delivering, Ended, Inactive, Ready to deliver, Processing, Suspended  Line item status — Delivering, Ended, Inactive, Line items not running, Creatives not running, Ready to deliver, Processing, Suspended  Creative associations — Optionally include creative associations in a dedicated sheet \\* Conversion tracking — Optionally download orders' products\n"," Processing typically completes within 30 minutes for standard files, with larger datasets requiring additional time.\n"],"documentType":"guide"},{"title":"Get started with DSP bulk operations","sectionHeader":{"type":2,"text":"Step 3: Edit the spreadsheet"},"path":"/en-us/no-code-tools/bulk-operations/dsp/get-started","content":[" Open the downloaded .xlsx file in your spreadsheet application. The file contains separate sheets (tabs) for each entity type:\n","Orders — One row per order  Line Items — One row per line item  Creative Associations — One row per creative-to-line-item mapping (if included in download)\n"," Edit the spreadsheet according to the entity field guides:\n","To create new entities, add new rows with the required fields filled in  To update existing entities, modify the values in existing rows (entity IDs must be present)  Leave rows unchanged if you do not want to modify them\n"],"documentType":"guide"},{"title":"Get started with DSP bulk operations","sectionHeader":{"type":2,"text":"Step 4: Upload the spreadsheet"},"path":"/en-us/no-code-tools/bulk-operations/dsp/get-started","content":["Return to the Bulk Operations page 2. Click Upload 3. Choose your edited .xlsx file (or drag and drop it) 4. Click Upload campaigns to submit\n"," After uploading, you can monitor progress on the Bulk Operations page. The status will show:\n","| Status | Description |\n","\\|---\\|---\\|\n","| Uploading | File is being processed |\n","| Success | All records were processed successfully |\n","| Partial | Some records succeeded, some failed — download the error report for details |\n","| Failed | The upload could not be processed |\n"," If the upload is partial or failed, click Download error report to see which records had issues and why.\n"],"documentType":"guide"},{"title":"Get started with DSP bulk operations","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/no-code-tools/bulk-operations/dsp/get-started","content":[],"documentType":"guide"},{"title":"DSP bulk operations entities","sectionHeader":null,"path":"/en-us/no-code-tools/bulk-operations/dsp/entities","content":[" This article describes the entity types supported by Amazon DSP bulk operations, their hierarchy, and the complete column reference for each spreadsheet tab.\n"],"documentType":"guide"},{"title":"DSP bulk operations entities","sectionHeader":{"type":2,"text":"Entity hierarchy"},"path":"/en-us/no-code-tools/bulk-operations/dsp/entities","content":[],"documentType":"guide"},{"title":"DSP bulk operations entities","sectionHeader":{"type":2,"text":"Spreadsheet structure"},"path":"/en-us/no-code-tools/bulk-operations/dsp/entities","content":["| Sheet tab | Entity | Description |\n","\\|---\\|---\\|---\\|\n","| ORDERS | Order | One row per order with order-level settings |\n","| DISPLAY LINE ITEMS | Display line item | Standard Display and Amazon Mobile Display line items |\n","| VIDEO LINE ITEMS | Video line item | Video line items (Online Video, Streaming TV, Live Events) |\n","| AUDIO LINE ITEMS | Audio line item | Audio line items |\n","| CREATIVE ASSOCIATIONS | Creative association | One row per creative-to-line-item mapping |\n"],"documentType":"guide"},{"title":"DSP bulk operations entities","sectionHeader":{"type":2,"text":"ORDERS columns"},"path":"/en-us/no-code-tools/bulk-operations/dsp/entities","content":["| Column | Description | Required | Format |\n","\\|---\\|---\\|---\\|---\\|\n","| Order Country | Primary targeting country. Immutable — cannot be updated for existing orders. | | 2 uppercase letter country code (e.g., US) |\n","| Active/Inactive | State of the order. | | Active or Paused |\n","| PO number | External tracking number or code (same as External ID). | | Letters, numbers, symbols. 255 chars max. |\n","| Comments | Free-text note for the order. Set when creating an order and editable on update. | | Free text. 1,000 chars max. |\n","| Media Type | Media types relevant to this order. | | Comma-separated: Display, Online Video, Streaming TV, Audio |\n","| Goal and Goal KPI\\* | Primary goal and key performance metric for the order. | Yes | Choose from list (e.g., Awareness - Reach, Conversions - ROAS) |\n","| Target KPI | KPI target value for reports and optimization. | | Number between 0.01–1,000,000,000. Required for Frequency campaigns. |\n","| Bidding Priority | How Amazon Ads determines bids based on Goal KPI probability. | | Prioritize spending full budget or Prioritize KPI target |\n","| Budget Management Strategy | How the budget of the order is distributed among line items. | | Automate budget allocation or Manage budget manually |\n","| Frequency Caps | Limit on impressions per user/household. Up to 3 caps. | | FrequencyCap1:\\[User, 10, 1, Days]; FrequencyCap2:\\[User, 2, 1, Hours] |\n","| Flight budget and dates\\* | Budget amount and flight dates for the order. | Yes | Flight1:\\[500, 08-01-2020-00-01, 08-21-2020-23-59, Demo Flight] |\n","| Flight- spent and remaining (READ ONLY) | Spent and remaining budget per flight. | | Read-only — do not edit |\n","| Budget Rollover | How unused budget from completed flights is managed. | | Do not change flight budgets, Roll prior flight unused budget, or Roll cumulative unused budget |\n","| Budget cap | Maximum spend per day or month. | | Daily:XX or Monthly:XX or Daily:XX; Monthly:XX |\n","| Agency fee | Percent of order budget paid to an agency. | | Whole number 1–99 |\n","| Order type | Type of order. | | |\n","| Amazon Events | Amazon Events associated with the order. | | |\n","| Products | Tracked product ASINs (max 1,000). If blank when uploaded, no products will be tracked. | | |\n","| Off-Amazon conversions | Conversion definitions relevant to this order. | | |\n"],"documentType":"guide"},{"title":"DSP bulk operations entities","sectionHeader":{"type":2,"text":"LINE ITEMS columns"},"path":"/en-us/no-code-tools/bulk-operations/dsp/entities","content":[" These columns appear across the DISPLAY LINE ITEMS, VIDEO LINE ITEMS, and AUDIO LINE ITEMS sheets. Some columns are specific to certain line item types as noted.\n","| Column | Description | Required | Applies to |\n","\\|---\\|---\\|---\\|---\\|\n","| Video Ad Content Type\\* | Media type of a Video line item. | Yes | Video only |\n","| External ID | External tracking number or code. 255 chars max. | | All |\n","| Line start date | Line item start date. Must be within the date range of the order. Leave blank to default to order start date. | | All |\n","| Line end date | Line item end date. Must be after start date and within the date range of the order. Leave blank to default to order end date. | | All |\n","| Active/Inactive | State of the line item. | | All |\n","| Tactic Tag - (READ ONLY) | Indicates Performance+ or Brand+ tactic. | | All |\n","| Product categories\\* | The type of product being advertised. | Yes | All |\n","| Frequency Caps | Limit on impressions per user/household. Up to 3 caps. | | All |\n","| Device type | Target device types. | | Display, Video, Audio |\n","| Environment Type | Target environments (web, app, etc.). | | Display |\n","| Mobile environment | Target websites, apps, or both. | | Video |\n","| Amazon viewability | Target webpages with a specific viewability rate. | | Display, Video |\n","| Unmeasured viewability | Include or exclude unmeasured viewability. | | Display, Video |\n","| Third-party pre-bid targeting | Pre-bid targeting from DoubleVerify, Oracle, IAS, Pixalate. | | Display, Video |\n","| Supply source | Service determining ad display location. | | Display, Video, Audio |\n","| Deal selection | Private marketplace deal inventory. | | Display, Video, Audio |\n","| Deal Selection names (READ ONLY) | Names of the deals targeted by the line item, shown as deal name (id) in the same order as Deal selection. Informational only — do not edit. | | Display, Video, Audio |\n","| Inventory group | Collection of private marketplace inventory. | | Display, Video, Audio |\n","| Inventory group names (READ ONLY) | Names of the inventory groups targeted by the line item. Informational only — do not edit. | | Display, Video, Audio |\n","| Video initiation type | How videos are started. | | Video |\n","| Video ad format | Specific video placement type. | | Video |\n","| In-stream position | Ad placement within primary content stream. | | Video |\n","| Out-stream position | Video ads outside main content. | | Video |\n","| Video player size | Size of video players ads can run on. | | Video |\n","| Video completion | Target a specific completion rate. | | Video |\n","| Video content duration | Target video content of specific lengths. | | Video |\n","| Mobile OS | Target by mobile operating system. | | Display |\n","| Site language | Target language across third-party publishers. | | Display, Video |\n","| Language targeting | Target supply content language across Amazon and third-party publishers. | | Display, Video |\n","| Contextual targeting by categories | Target pages with relevant content by categories. | | Display, Video |\n","| Target Categories using only contextual signals? | Only use contextual signals for category targeting. | | Display, Video |\n","| Contextual excluding by categories | Exclude pages by content categories. | | Display, Video |\n","| Contextual targeting by products | Target pages with relevant content by products. | | Display, Video |\n","| Contextual excluding by products | Exclude pages by content products. | | Display, Video |\n","| Contextual targeting (on Amazon) | Target detail pages of products frequently viewed/purchased with your advertised products. | | Display |\n","| Targeting by Keywords | Target with relevant keywords. | | Display, Video |\n","| Target Keywords using only contextual signals? | Only use contextual signals for keyword targeting. | | Display, Video |\n","| Targeting - Content | Exclude specific content ratings. | | Video, Display |\n","| Brand suitability content exclusion categories | Prevent campaigns from appearing alongside selected topics. | | Display, Video |\n","| Brand suitability inventory tier | Group inventory to balance reach with brand suitability. | | Display, Video |\n","| Streaming TV app blocking | Exclude specific streaming TV apps. | | Video |\n","| Streaming TV app blocking group ID targeting | IDs of streaming TV app saved groups. | | Video |\n","| Location targeting by | Target by real-time location, or home + real-time location. | | All |\n","| Location targeting 1 of 2 | Locations this line is targeting (part 1). | | All |\n","| Location targeting 2 of 2 | Locations this line is targeting (part 2). | | All |\n","| Location group ID targeting including | IDs of location saved groups to include. | | Display, Video |\n","| Location excluding 1 of 2 | Locations to exclude (part 1). | | All |\n","| Location excluding 2 of 2 | Locations to exclude (part 2). | | All |\n","| Location group ID targeting excluding | IDs of location saved groups to exclude. | | Display, Video |\n","| Audiences - include | Audience groups to include and/or exclude. | | Display, Video, Audio |\n","| Reach similar audiences | Reach audiences similar to included audiences. | | Display, Video, Audio |\n","| Audience names | Informational — helps understand targeted audience types. | | Display, Video, Audio |\n","| Tactics Converters Exclusion Type | Exclusion type for recent tactics ads purchasers. | | Display, Video |\n","| Daypart targeting timezone | Target users by time of day. | | Display, Video, Audio |\n","| Daypart period | Target users during specific periods. | | Display, Video, Audio |\n","| IAB content categories | Target websites by content category. | | Display, Video |\n","| Fold position | Target placements above or below the fold. | | Display, Video |\n","| Native content position | Target specific native ad placements. | | Display, Video |\n","| Content and Genre Blocking | Exclude specific genres and content. | | Audio |\n","| Automated optimization | Automatically optimize budget allocation across lines. | | Display, Video, Audio |\n","| Line item budget | Budget allocated for this line. | | All |\n","| Budget cap | Maximum spend cap (can result in under-delivery). | | Display, Video, Audio |\n","| Daily Minimum Spend | Minimum spend (can negatively impact performance). | | Display, Video, Audio |\n","| Pacing profile | How the DSP spends budget throughout the flight. | | Display, Video, Audio |\n","| 3P fees | Third-party data fees associated with this line. | | Display, Video, Audio |\n","| Base supply bid\\* | Amount to pay for 1,000 ad impressions. | Yes | Display, Video, Audio |\n","| Maximum average CPM | Most you are willing to pay for 1,000 impressions. | | Display, Video, Audio |\n","| Floor | Lowest amount to pay for views and clicks. | | Display, Video |\n","| Domain Targeting - (READ ONLY) | Indicates if line item has domain targeting. | | Display, Video |\n","| Mobile Devices | Target specific mobile devices. | | Display |\n","| Orientation | Target devices by orientation. | | Display |\n","| Mobile app targeting - include or exclude | Include or exclude apps. | | Display, Video, Audio |\n","| App IDs 1 of 2 | List of included or excluded apps (part 1). | | Display, Video, Audio |\n","| App IDs 2 of 2 | List of included or excluded apps (part 2). | | Display, Video, Audio |\n","| Mobile app group ID targeting | IDs of mobile app saved groups. | | Display, Video, Audio |\n","| Advertiser domain targeting - (CREATE ONLY) | Advertiser domain targeting settings. Create only. | | Display, Video |\n","| Line item domain targeting - (CREATE ONLY) | Additional webpage include/exclude settings. Create only. | | Display, Video |\n","| Domains - (CREATE ONLY) | Websites to include or exclude. Create only. | | Display, Video |\n","| Creative rotation type | Method used to rotate creatives within this line item. | | Display, Video, Audio |\n"],"documentType":"guide"},{"title":"DSP bulk operations entities","sectionHeader":{"type":3,"text":"Date format for line items"},"path":"/en-us/no-code-tools/bulk-operations/dsp/entities","content":[" All dates must use mm-dd-yyyy-hh-mm format with no spaces.\n","✓ Good: 12-30-2021-08-00 \\* ✗ Bad: 30-12-2021-08-00\n"],"documentType":"guide"},{"title":"DSP bulk operations entities","sectionHeader":{"type":3,"text":"Line item status values"},"path":"/en-us/no-code-tools/bulk-operations/dsp/entities","content":["Book/Deliver — Creates and activates the line item according to flight dates \\* Pause — Creates the line item in paused state\n"],"documentType":"guide"},{"title":"DSP bulk operations entities","sectionHeader":{"type":3,"text":"Video Ad Content Type values (Video lines only)"},"path":"/en-us/no-code-tools/bulk-operations/dsp/entities","content":["STREAMING_TV  ONLINE_VIDEO  LIVE_EVENTS\n"],"documentType":"guide"},{"title":"DSP bulk operations entities","sectionHeader":{"type":2,"text":"CREATIVE ASSOCIATIONS columns"},"path":"/en-us/no-code-tools/bulk-operations/dsp/entities","content":["| Column | Description | Required | Format |\n","\\|---\\|---\\|---\\|---\\|\n","| Line Item ID\\* | Numeric ID of the line item to associate the creative with. | Yes | Numbers only |\n","| Creative ID\\* | Numeric ID of the creative to associate with the line item. One creative per row. | Yes | Numbers only |\n","| Creative name | Name of the creative. Auto-populated, read-only. | | Read-only |\n","| Start date | Date/time the creative begins serving. Must be within the date range of the line item. | | mm-dd-yyyy-hh-mm (leave blank to default to line start date) |\n","| End date | Date/time the creative stops serving. Must be after start date and within the date range of the line item. | | mm-dd-yyyy-hh-mm (leave blank to default to line end date) |\n","| Active/Inactive | Whether the creative association is active and eligible to serve. | | ACTIVE or INACTIVE |\n","| Creative Association Status | Approval status of the creative association. | | Read-only |\n","| Weight | How frequently this creative is shown relative to others of the same size. Only applicable when creative rotation type is WEIGHTED. | | Whole number 1–999 |\n"],"documentType":"guide"},{"title":"DSP bulk operations entities","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/no-code-tools/bulk-operations/dsp/entities","content":[],"documentType":"guide"},{"title":"Create orders and line items with DSP bulk operations","sectionHeader":null,"path":"/en-us/no-code-tools/bulk-operations/dsp/create-campaigns","content":[" This article explains how to create new orders (campaigns) and line items (ad groups) using Amazon DSP bulk operations.\n"],"documentType":"guide"},{"title":"Create orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/no-code-tools/bulk-operations/dsp/create-campaigns","content":["Download a blank template from the Bulk Operations page 2. Review the entity fields reference to understand required fields\n"],"documentType":"guide"},{"title":"Create orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Create a new order"},"path":"/en-us/no-code-tools/bulk-operations/dsp/create-campaigns","content":[" To create a new order, add a row to the Orders sheet with the following required fields:\n","| Field | What to enter |\n","\\|---\\|---\\|\n","| Order ID | Leave blank — a new ID will be assigned after upload |\n","| Order name\\* | Enter a descriptive name for your campaign |\n","| Flight budget and dates\\* | Enter the budget amount and flight dates |\n","| Budget Management Strategy | Enter the budget management strategy (e.g., Manage budget manually) |\n","| Goal and Goal KPI\\* | Enter the primary goal and KPI (e.g., Awareness - Reach) |\n"],"documentType":"guide"},{"title":"Create orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Create a new line item"},"path":"/en-us/no-code-tools/bulk-operations/dsp/create-campaigns","content":[" To create a new line item, add a row to the appropriate line items sheet (DISPLAY LINE ITEMS, VIDEO LINE ITEMS, or AUDIO LINE ITEMS). You must reference an existing Order ID or the Order ID of a new order being created in the same file.\n","| Field | What to enter |\n","\\|---\\|---\\|\n","| Line Item ID | Leave blank — a new ID will be assigned after upload |\n","| Order ID\\* | Enter the Order ID this line item belongs to |\n","| Line item name\\* | Enter a descriptive name |\n","| Line start date | Enter the start date in mm-dd-yyyy-hh-mm format (e.g., 06-01-2025-00-00). Leave blank to default to order start date. |\n","| Line end date | Enter the end date in mm-dd-yyyy-hh-mm format. Leave blank to default to order end date. |\n","| Active/Inactive | Enter Book/Deliver to activate or Pause to create in paused state |\n","| Video Ad Content Type\\* | (Video lines only) Enter STREAMING_TV, ONLINE_VIDEO, or LIVE_EVENTS |\n"," Example (Display line item):\n","| Line Item ID | Order ID | Line item name | Line start date | Line end date | Active/Inactive |\n","\\|---\\|---\\|---\\|---\\|---\\|---\\|\n","| | 9876543210 | Display - Awareness | 06-01-2025-00-00 | 08-31-2025-23-59 | Book/Deliver |\n"],"documentType":"guide"},{"title":"Create orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Add creative associations"},"path":"/en-us/no-code-tools/bulk-operations/dsp/create-campaigns","content":[" To associate creatives with line items, add rows to the Creative Associations sheet:\n","| Field | What to enter |\n","\\|---\\|---\\|\n","| Line Item ID | Enter the Line Item ID to associate the creative with |\n","| Creative ID | Enter the Creative ID to associate |\n"],"documentType":"guide"},{"title":"Create orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Upload your file"},"path":"/en-us/no-code-tools/bulk-operations/dsp/create-campaigns","content":["Save your spreadsheet as .xlsx 2. Navigate to the Bulk Operations page in the Amazon DSP console 3. Click Upload 4. Select your file and click Upload campaigns\n"," After upload, monitor the status on the Bulk Operations page. If any records fail, download the error report to identify and fix issues.\n"],"documentType":"guide"},{"title":"Create orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Tips for successful uploads"},"path":"/en-us/no-code-tools/bulk-operations/dsp/create-campaigns","content":["Ensure all required fields (marked with ) are populated for each new entity  Do not include currency symbols, commas, or special characters in numeric fields  Dates must be in mm-dd-yyyy-hh-mm format (e.g., 12-30-2021-08-00)  Line item start and end dates must fall within the flight dates of the parent order  Do not delete any columns from the spreadsheet — this will cause upload errors  Each row represents one entity — do not combine multiple entities in a single row  Maximum 1,000 order/line item rows and 2,000 creative association rows per upload file  The newly uploaded settings will replace all existing campaign settings\n"],"documentType":"guide"},{"title":"Create orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/no-code-tools/bulk-operations/dsp/create-campaigns","content":[],"documentType":"guide"},{"title":"Update orders and line items with DSP bulk operations","sectionHeader":null,"path":"/en-us/no-code-tools/bulk-operations/dsp/update-campaigns","content":[" This article explains how to update existing orders and line items using Amazon DSP bulk operations.\n"],"documentType":"guide"},{"title":"Update orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/no-code-tools/bulk-operations/dsp/update-campaigns","content":["Download your existing campaign data from the Bulk Operations page — this ensures entity IDs are pre-populated 2. Review the entity fields reference to understand which fields are mutable\n"],"documentType":"guide"},{"title":"Update orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Key points"},"path":"/en-us/no-code-tools/bulk-operations/dsp/update-campaigns","content":["To update an entity, the ID field (Order ID or Line Item ID) must be present in the row. If you leave it blank, a new entity will be created instead.  The newly uploaded settings will replace all existing campaign settings — review your changes carefully  Do not delete any columns from the spreadsheet — this will cause upload errors  Rows without changes are still processed during upload. To reduce processing time, delete rows that do not contain updates before uploading.  Use the ORDERS sheet to update orders, use the DISPLAY LINE ITEMS sheet to update standard display and mobile line items, use the VIDEO LINE ITEMS sheet to update video line items, and use the AUDIO LINE ITEMS sheet to update audio line items.\n"],"documentType":"guide"},{"title":"Update orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Update an order"},"path":"/en-us/no-code-tools/bulk-operations/dsp/update-campaigns","content":[" To update an existing order, modify the desired fields in the Orders sheet while keeping the Order ID intact.\n"," Example — Update order budget and end date:\n","| Order ID | Order name | Flight budget and dates |\n","\\|---\\|---\\|---\\|\n","| 9876543210 | Summer Campaign 2025 | Flight1:75000, 06-01-2025-00-00, 09-30-2025-23-59, Summer Flight |\n"," Common order updates include:\n","Budget and flight dates — Update the Flight budget and dates field  Status — Change Active/Inactive to pause or reactivate  Name — Update the Order name field\n"],"documentType":"guide"},{"title":"Update orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Update a line item"},"path":"/en-us/no-code-tools/bulk-operations/dsp/update-campaigns","content":[" To update an existing line item, modify the desired fields in the Line Items sheet while keeping the Line Item ID intact.\n"," Example — Update line item bid and budget:\n","| Line Item ID | Order ID | Line item budget | Base supply bid\\* |\n","\\|---\\|---\\|---\\|---\\|\n","| 1122334455 | 9876543210 | 30000 | 6.50 |\n"," Common line item updates include:\n","Budget — Change the Line item budget value  Bid — Modify the Base supply bid  Flight dates — Update Line start date or Line end date  Status — Change Line Item Status to pause or reactivate \\* Pacing — Modify delivery pacing settings\n"],"documentType":"guide"},{"title":"Update orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Update creative associations"},"path":"/en-us/no-code-tools/bulk-operations/dsp/update-campaigns","content":[" To modify creative associations:\n","Add a new association — Add a new row with the Line Item ID and Creative ID \\* Remove an association — Remove the row from the Creative Associations sheet (or set the end date to a past date)\n"],"documentType":"guide"},{"title":"Update orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Pause or deactivate entities"},"path":"/en-us/no-code-tools/bulk-operations/dsp/update-campaigns","content":[" To pause a line item, set the Active/Inactive field to Pause:\n","| Line Item ID | Active/Inactive |\n","\\|---\\|---\\|\n","| 1122334455 | Pause |\n"," To reactivate, set the value to Book/Deliver.\n"],"documentType":"guide"},{"title":"Update orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Upload your changes"},"path":"/en-us/no-code-tools/bulk-operations/dsp/update-campaigns","content":["Save the modified spreadsheet as .xlsx 2. Navigate to the Bulk Operations page 3. Click Upload 4. Select your file and click Upload campaigns\n"],"documentType":"guide"},{"title":"Update orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"Troubleshooting"},"path":"/en-us/no-code-tools/bulk-operations/dsp/update-campaigns","content":[" If your upload results in a Partial status:\n","Click Download error report to see which records failed 2. Review the error messages for each failed record 3. Fix the issues in your spreadsheet 4. Re-upload only the corrected records\n"," Common errors include:\n","Missing required ID fields for updates (leaving ID blank creates a new entity instead)  Deleted columns from the spreadsheet  Invalid date formats (must be mm-dd-yyyy-hh-mm)  Budget values that exceed account limits  Line item dates outside the flight dates of the parent order \\* Orders with 1,000+ tracked product ASINs\n"],"documentType":"guide"},{"title":"Update orders and line items with DSP bulk operations","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/no-code-tools/bulk-operations/dsp/update-campaigns","content":[],"documentType":"guide"},{"title":"DSP bulk operations FAQs","sectionHeader":null,"path":"/en-us/no-code-tools/bulk-operations/dsp/faqs","content":[],"documentType":"guide"},{"title":"DSP bulk operations FAQs","sectionHeader":{"type":2,"text":"General"},"path":"/en-us/no-code-tools/bulk-operations/dsp/faqs","content":[" DSP bulk operations uses the .xlsx (Excel) file format. Other formats such as .xls or .csv are not supported.\n"," DSP bulk operations supports orders (campaigns), line items (ad groups), and creative associations. Supported line item types include Standard Display, Amazon Mobile Display, AAP Mobile App, Video (Online Video, Streaming TV, Live Events), and Audio. Managed service-specific features such as Class 1 video, Kratos package orders, and Amazon Audience Grid (AAG) are not supported.\n"," Yes. You need admin access to the entity (advertiser account) to upload bulk spreadsheets. If you see the message \"You do not have admin access to this entity,\" contact your account administrator.\n"," Processing time depends on the number of records. Most uploads complete within a few minutes. Larger files may take longer. You can monitor progress on the Bulk Operations page.\n"," Processing typically completes within 30 minutes for standard files. Larger datasets with many orders and line items may require additional time.\n"],"documentType":"guide"},{"title":"DSP bulk operations FAQs","sectionHeader":{"type":2,"text":"Downloads and exports"},"path":"/en-us/no-code-tools/bulk-operations/dsp/faqs","content":[" Yes. When downloading, you can filter by advertiser, order status, line item status, and export type (orders only, line items only, or both). You can also choose to include creative associations and conversion tracking data.\n"," Yes. In the download dialog, select \"Custom list of orders\" and search for the specific orders you want to include.\n"," Creative associations have moved from the Line Items sheet to a dedicated Creative Associations sheet. When downloading, check the \"Include creative associations\" option to include this sheet.\n"],"documentType":"guide"},{"title":"DSP bulk operations FAQs","sectionHeader":{"type":2,"text":"Uploads and editing"},"path":"/en-us/no-code-tools/bulk-operations/dsp/faqs","content":[" Yes. You can include new orders in the Orders sheet and new line items in the Line Items sheet within the same file. Line items referencing newly created orders will be processed after the orders are created.\n"," The upload will show a Partial status. Successfully processed records will be applied, and failed records will not. Download the error report to see which records failed and why, then fix and re-upload only the failed records.\n"," No. There is no automatic undo feature. To reverse changes, download the current campaign data, make the necessary corrections, and upload the corrected file. You can also download the original uploaded file from the history for reference.\n"," Use mm-dd-yyyy-hh-mm format for all dates, with no spaces. For example, December 30, 2021 at 8:00 AM should be entered as 12-30-2021-08-00. Any other date format will cause upload errors. Leave date fields blank to default to the start or end date of the order.\n"," No. Enter numeric values only, without currency symbols, commas, or other special characters.\n"," If you leave the ID field blank, a new entity will be created. To update an existing entity, you must provide its ID. The easiest way to get the correct IDs is to download your existing campaign data first.\n"," No. Do not delete any columns from the spreadsheet. Removing columns will cause upload errors. You can leave cells blank if they are not required.\n"],"documentType":"guide"},{"title":"DSP bulk operations FAQs","sectionHeader":{"type":2,"text":"Troubleshooting"},"path":"/en-us/no-code-tools/bulk-operations/dsp/faqs","content":[" This means the file contains no valid data rows. Ensure your spreadsheet has at least one data row below the header row and that the file is not corrupted.\n"," New accounts may take up to 72 hours to be provisioned for bulk operations. Please check back after this period.\n"," This is a temporary system issue. Wait a few minutes and try again. If the problem persists, contact Amazon Ads support.\n"],"documentType":"guide"},{"title":"DSP bulk operations FAQs","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/no-code-tools/bulk-operations/dsp/faqs","content":[],"documentType":"guide"},{"title":"adm console overview","sectionHeader":null,"path":"/en-us/no-code-tools/adm/1_ads-data-manager-console-overview","content":[" Ads data manager is an Amazon Ads offering with options that enable advertisers to securely upload their first-party (1P) data to Amazon Ads using either an intuitive user interface (Ads data manager console) or Ads data manager APIs. The uploaded data can be mapped to the required inputs needed to activate their data across Amazon Ads products and then shared for planning and measurement use cases to gain insights and help you optimize campaigns and create audiences.\n"," Designed for data stewards, data owners, marketers, or programmatic teams that have access to use  their 1P  data; Ads data manager facilitates use of advertiser first-party data within Amazon Ads, and enables the hand-off of data brought to Amazon between multiple accounts.  For example, data can be shared from a manager account to campaign managers who do not handle 1P party data directly but are required to include this data in campaign setup for attribution or targeting purposes.\n"],"documentType":"guide"},{"title":"adm console overview","sectionHeader":{"type":2,"text":"Manager accounts and advertiser account hierarchy"},"path":"/en-us/no-code-tools/adm/1_ads-data-manager-console-overview","content":[" Ads data manager operates at the manager account and advertiser account for advertisers with Display, Video, and Audio campaign access, allowing for centralized data management. When you link advertiser accounts to your manager account you can manage your uploaded data in a centralized location without exposing direct record-level access to your data across advertiser accounts.\n"," Know more about manager accounts using the Ads console.\n"," The image below illustrates how manager accounts function within the Amazon Ads account hierarchy using Kitchen Smart, a kitchen appliances company. In our example, Kitchen Smart operates from US and Europe .\n","Datasets can be uploaded to a parent manager account like “Kitchen Smart  Global\", under which child manager accounts for “Kitchen Smart US” and “Kitchen Smart EU” are created. - These manager accounts then serve as a central repository for data upload and management. - The uploaded data can be shared on-demand with the linked advertiser accounts connected with the manager account.\n"," This setup enables efficient first-party data management, where data uploaded once at the manager account level can be utilized across multiple linked advertiser accounts. And, the structure allows for streamlined data operations, ensuring that advertisers can use their uploaded data across accounts while maintaining control over data access and usage within the Amazon Ads.\n"],"documentType":"guide"},{"title":"adm console overview","sectionHeader":null,"path":"/en-us/no-code-tools/adm/2_ads-data-manager-console","content":[" The Ads data manager console is designed to simplify the process of uploading and sharing your first-party (1P) data. To begin using the Ads data manager, simply set up your advertisers with the manager account, bring in your 1P data, and share it with the linked accounts.\n"],"documentType":"guide"},{"title":"adm console overview","sectionHeader":{"type":2,"text":"Explore the Ads data manager console"},"path":"/en-us/no-code-tools/adm/2_ads-data-manager-console","content":[" Ads data manager sits within the Amazon Ads console and serves as a single point of ingress of 1P data in to Amazon Ads.\n"," To access Ads data manager,\n","Log in to your Amazon Ads console using your Amazon Ads credentials.\n","In the account switcher, select the manager account where you would like to upload or access data.\n","Select Data manager from the left navigation pane of the Amazon ads console.\n","If this is your first time using Ads data manager, review and accept the Ads data manager Terms and Conditions before proceeding to the landing page of the application. Each user accepts once; acceptance by another user on the account does not apply to you.\n"," Ads data manager can be navigated through the Ads data manager pane on the left, which lists the following three primary functions of Ads data manager:\n","Datasets: Datasets are the representations of uploaded advertiser data in the Ads data manager. A dataset is a collection of data within a data table, comprising attributes (columns) as well as metadata, such as the dataset name and the schema template utilized to create the dataset.\n","Sources: The Sources page allows you to ingest your data from various sources to a single Ads data manager account. This page lists the multiple third-party sources from which you could you could bring your data into Ads data manager. The page lists connector libraries for integrating partner applications.\n","Destinations: The Destinations page lists where your data is being activated across accounts and supported Amazon Ads functions.\n"," The Datasets page serves as a dashboard, providing an overview of the advertiser data uploaded through your manager account to Amazon Ads.\n"],"documentType":"guide"},{"title":"adm console account setup","sectionHeader":null,"path":"/en-us/no-code-tools/adm/2a_ads-data-manager_account_setup","content":[" The Ads data manager console is designed to simplify the process of uploading and sharing your first-party (1P) data. To begin using the Ads data manager, simply set up your advertisers with the manager account, bring in your 1P data, and share it with the linked accounts.\n"],"documentType":"guide"},{"title":"adm console account setup","sectionHeader":{"type":2,"text":"Set up your manager account for data manager"},"path":"/en-us/no-code-tools/adm/2a_ads-data-manager_account_setup","content":[" The steps to link advertiser accounts to a manager account are outlined below:\n","It is assumed that you have created a manager account.\n","Now, link advertiser accounts to the manager account.\n"],"documentType":"guide"},{"title":"adm console account setup","sectionHeader":{"type":2,"text":"Set up account hierarchy"},"path":"/en-us/no-code-tools/adm/2a_ads-data-manager_account_setup","content":[" Ads data manager operates exclusively at the manager account level, which means proper account structure is essential for functionality. To upload and manage your datasets, your manager account must either serve as a parent account to your advertiser accounts or maintain Data sharing permissions with them. This hierarchical structure ensures proper data flow and management capabilities within the system.\n"," ADM supports two distinct types of account links to help you manage your advertising data effectively. \n","Admin link\n","Data sharing link\n"],"documentType":"guide"},{"title":"adm console account setup","sectionHeader":{"type":3,"text":"Admin link"},"path":"/en-us/no-code-tools/adm/2a_ads-data-manager_account_setup","content":[" The Admin link is designed for Advertiser Accounts that are created directly within your Manager Account. These links provide comprehensive administrative control over the connected accounts and their associated data.\n"],"documentType":"guide"},{"title":"adm console account setup","sectionHeader":{"type":3,"text":"Data sharing link"},"path":"/en-us/no-code-tools/adm/2a_ads-data-manager_account_setup","content":[" Data sharing links enable you to connect with third-party accounts while maintaining control over your resources. This arrangement allows external users to access and utilize shared data for specific advertising purposes, while ensuring that ultimate control of the data remains within your manager account.\n"],"documentType":"guide"},{"title":"adm console account setup","sectionHeader":{"type":2,"text":"Link accounts"},"path":"/en-us/no-code-tools/adm/2a_ads-data-manager_account_setup","content":[" You can connect accounts to ADM through the account linking process following the steps listed below:\n","Navigate to Administration > Account access & settings > Accounts.\n","Click Add account > Link existing account.\n","Choose an account you have access to.\n","Send a request to link the account to your manager account. \n"," A request will be sent to the invited account's administrator to review and approve the linking.\n"],"documentType":"guide"},{"title":"adm data upload","sectionHeader":null,"path":"/en-us/no-code-tools/adm/3_adm-data-upload-overview","content":[" The Datasets page is the landing page of the Ads data manager, which provides a comprehensive overview of all your uploaded datasets. The page also provides a way to upload and manage your data from Amazon Ads.\n"," The page lists detailed information regarding the total number of datasets, datasets in use, active destinations, and the number of accounts linked to the manager account.\n"," For each dataset listed on the page, you can access comprehensive information like schema, source, creation date, and the status and utilization of your first-party data within the Amazon Ads platform.\n"," Individual data records can only be uploaded within a dataset, and will be displayed under the \"Recent Uploads\" section of the dataset detail page.\n"," Utilizing datasets, you can create advertiser audiences directly as well as analyze granular details such as record counts.\n"," Ads data manager allows you to choose your options to upload your data depending on your convenience, technical capability, or integration preferences. There are three primary methods for uploading data:\n","Ads data manager console upload: The dataset page provides a simple browse-drag-drop method through the Ads data manager console, that allows for direct upload of .csv files.\n","Source connector integrations: For customers already using a Customer Data Platform (CDP), Ads data manager offers integration connectors with popular platforms. This method allows for automated, real-time data syncing between your CDP and Ads data manager.\n","API upload: You can choose to bring in your data programmatically using the Ads data manager APIs. The APIs allow you to send your data via JSON. This method is perfect on frequent data uploads and can be integrated into your existing data pipelines. Refer to the API guide to set up Ads data manager and work with it programmatically. \n"," In the next topic,  we'll dive deeper into each upload method, providing step-by-step instructions and best practices.\n"],"documentType":"guide"},{"title":"adm console upload","sectionHeader":null,"path":"/en-us/no-code-tools/adm/4_adm-console-upload","content":["To upload a new dataset, navigate to the Datasets page, click Upload dataset. Or alternatively, navigate to the Sources page, click Upload dataset under File upload.\n","In the Upload file page, provide the following dataset details:\n","The country you select here will be used as the default country for all records in your uploaded dataset. If a country code is provided in the mapping, it will override the selected country in the uploader.\n","Upload a CSV file (200MiB or smaller) containing the data you want to upload and make available for use in Amazon Ads. For files larger than 200MiB you'll need to use Ads data manager APIs. Access a hashing utility that helps you format hashed PII for upload.\n","Click Map attributes to map at least one of the columns of your uploaded file to the required schema fields. While Ads data manager auto-maps the columns of your uploaded data, you must mandatorily map at least one attribute.\n","Click Continue to proceed. Depending on whether you are uploading audience records or event records,  follow the steps listed in the corresponding section below.\n","When using the Ads data manager console, after you map the attributes, you are automatically prompted to create an audience for activation. When creating an Audience in Amazon DSP, an external audience ID required.\n","The audience name and external audience ID is prepopulated. If your Amazon DSP campaign managers use a specific naming convention for audiences, you can rename your audience here.\n","Select the Destination accounts linked to your manager account to share the uploaded data with. You can also click go to access and settings to add more advertiser accounts as destination accounts.\n","Click Submit.\n"," The uploaded audience dataset gets listed in the Datasets page, and the audiences you've shared with your linked advertiser accounts are listed in the Destinations page. \n"," When using the Ads data manager console, after you map the attribute, you are prompted to provide the necessary conversion definition settings to begin utilizing the uploaded event data right away.\n"," The first time you use a dataset for conversion attribution, you must define:\n","Source type to indicate where the uploaded came from \n","Conversion type to track the specific event type. \n","Value to indicate what each conversion type is worth. This value will be used if the uploaded file does not have a corresponding value indicated for the conversion type. \n","Counting method to indicate whether you're counting every conversion or only the first conversion.\n"," Next, select the Destination accounts linked to your manager account to share the uploaded data with. You can also click go to access and settings to add more advertiser accounts as destination accounts.\n"," If you previously uploaded data to a specific Advertiser Account via the Advertiser Audience API or Conversions API, you may import the data in Ads data manager if you are an Editor or Admin of the Manager Account that is the parent of your advertiser account (linked via Admin permissions), you will see eligible datasets to import into the data manager datasets view.\n"," First establish a connection with child/children accounts.  Then, initiate the migration of existing datasets uploaded data through the Advertiser Audience API or Conversions API into Ads Data Manager.\n"," Follow the steps listed below to migrate previously uploaded datasets to ads data manager:\n","In the Ads data manager console, navigate to the Datasets page.\n","Under the migrate datasets section, locate the datasets  that were uploaded using either the Conversions API or the Advertise Audience  API. \n","To verify the dataset names, click the link under the Dataset  column.\n","Click Import to migrate the datasets. All imported datasets will appear in the ads data manager, under the Datasets page.\n"],"documentType":"guide"},{"title":"adm source connector","sectionHeader":null,"path":"/en-us/no-code-tools/adm/5_adm-source-connector","content":[" The Sources page allows you to ingest your data from various sources to a single Ads data manager account. This page lists the multiple third-party sources from which you could you could bring your data into Ads data manager. The page lists connector libraries for integrating partner applications.\n"," For customers already using a Customer Data Platform (CDP), Ads data manager offers seamless integration with most popular platforms. This method allows for automated, real-time data syncing between your CDP and Ads data. If you are currently integrated with a Customer Data Platform (CDP), you can set up Ads data manager to connect with your CDP to obtain datasets directly from your CDP to Ads data manager.\n"," To connect your CDP with Ads data manager, perform the following steps:\n","Click Sources.\n","Locate your CDP and click Connect to access the connection setup for each partner.\n","After a connection is established and Ads data manager receives your data, a new dataset will be made available in your account.\n"],"documentType":"guide"},{"title":"Ads data manager","sectionHeader":null,"path":"/en-us/no-code-tools/adm/6_adm-manage-data","content":[" Once the data upload is complete using any of the methods Ads data manager supports, the uploaded files show up in the Datasets tab within Ads data manager console. You can do the following with your uploaded data: \n"],"documentType":"guide"},{"title":"Ads data manager","sectionHeader":{"type":2,"text":"View datasets"},"path":"/en-us/no-code-tools/adm/6_adm-manage-data","content":[" You can view the dataset details you uploaded by clicking the dataset name. The page also lists the schema, source from which the dataset was uploaded, the number of active destinations of the dataset, records and the date the dataset was created date.\n"],"documentType":"guide"},{"title":"Ads data manager","sectionHeader":{"type":2,"text":"Create advertiser audience"},"path":"/en-us/no-code-tools/adm/6_adm-manage-data","content":[" You can create an audience using Actions from the Datasets or dataset detail tab and then selecting Create advertiser audience from the Action menu associated with the dataset.\n"," You should be able to see all accounts linked to your manager account in the \"Create Audience\" page.\n"," From the \"Datasets\" tab, you can also click on the dataset that represents the uploaded audience dataset. The Dataset details page that appears provides more granular details, including destinations, counts and match rates, Dataset ID, Dataset Details (Name, Description, etc.) and all counts in the top right: Accepted Records, Rejected Records, Match rates. Once your audience is created, you will find your advertiser audience in your Amazon DSP advertiser account under \"Advertiser Audiences\".\n"],"documentType":"guide"},{"title":"Ads data manager","sectionHeader":{"type":2,"text":"Attribute off-Amazon conversions"},"path":"/en-us/no-code-tools/adm/6_adm-manage-data","content":[" Ads data manager also offers the ability to use event data from sources outside of Amazon for conversion attribution in Amazon DSP campaigns. Any data shared for conversion attribution will also be used in Performance+ and Brand+ campaigns, if this option is selected in Amazon DSP.\n"," To attribute event data to off-Amazon conversions, after your event data is uploaded, select Attribute off-Amazon conversion either by using Actions from the Datasets page or navigate to the dataset's detail tab and then select Attribute off-Amazon conversion.\n"," The first time you use a dataset for conversion attribution, you must define:\n","Conversion definition name  \n","Source type to indicate where the uploaded came from \n","Conversion type to track the specific event type. \n","Value to indicate what each conversion type is worth. This value will be used if the uploaded file does not have a corresponding value indicated for the conversion type. \n","Counting method to indicate whether you're counting every conversion or only the first conversion.\n"," If you have already used a dataset for conversion attribution, secondary shares will inherit the settings selected for your initial share.  \n"," Now, select the Destination accounts linked to your manager account to share the uploaded data with. You can also click go to access and settings to add more advertiser accounts as destination accounts.\n"],"documentType":"guide"},{"title":"Ads data manager","sectionHeader":{"type":2,"text":"Share data with Amazon Marketing Cloud "},"path":"/en-us/no-code-tools/adm/6_adm-manage-data","content":[" You can share uploaded data with your Amazon Marketing Cloud (AMC) instance. \n"," To share uploaded data with AMC, after your event data is uploaded, select Share with Amazon Marketing Cloud either by using Actions from the Datasets page or navigate to the dataset's detail tab and then select Share with Amazon Marketing Cloud\\*.\n"," Now, select the Destination instance to which the data will be shared with.\n"," Navigate to AMC. The uploaded dataset will appear under the Advertiser Uploaded section of the schema editor.   \n"],"documentType":"guide"},{"title":"Ads data manager","sectionHeader":{"type":2,"text":"Remove data from Ads data manager"},"path":"/en-us/no-code-tools/adm/6_adm-manage-data","content":[" You can remove your uploaded data from Ads data manager in two ways:\n","Delete the whole dataset\n","Stop sharing with specific destinations\n"," \\---\\|---\\|---\n"],"documentType":"guide"},{"title":"adm destination information","sectionHeader":null,"path":"/en-us/no-code-tools/adm/7_adm-destinations","content":[" The \"Destinations\" tab displays the various locations where your data is being used. This tab also shows the currently supported product functionalities that utilize your first party data.\n","You can navigate to the \"Destinations\" tab within Ads data Manager to find the audience you just uploaded and shared in the list of destinations.\n","You can view that the audience is correctly linked to the intended Advertiser Account(s).\n","You can view datasets in the destination account, create the dataset in another account, or deactivate the destination account through the Options column.\n","From a given destination record, you can access your Amazon DSP Account to access the audience detail page, if you  have the right permissions to do so. For datasets shared to linked accounts, you may receive a 404 (not found) error page.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":null,"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"Ads data manager and Amazon Marketing Cloud, for Sponsored Ads advertisers"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":["\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"Contents"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":["What this actually does 2. Decide first: which customers are worth more to you 3. What you need before you start 4. Upload your customer list 5. Read your match rate 6. Build the audience 7. Apply the bid boost 8. Plan around the waiting periods 9. When it does not work 10. What good looks like 11. Glossary\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"1. What this actually does"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":["| | Move | What happens |\n","\\|---\\|---\\|---\\|\n","| 1 | Export your customer list | Pull the customers who have already bought from you out of your own systems. This is the only step that happens outside Amazon. |\n","| 2 | Upload it | Amazon matches those records to shopper profiles. You never see which records matched to whom. |\n","| 3 | Turn it into an audience | One template converts the matched records into something your campaigns can use. |\n","| 4 | Raise your bid for them | When one of those shoppers searches your category, you bid a set percentage higher. Everyone else costs you exactly what they cost before. |\n"," Two things shape everything below:\n","Your keywords do not change. The campaign competes for the same searches it competes for today. The bid moves only when the shopper matches your list. - You never see the individuals. Matching happens inside a clean room. Nothing comes back out at the customer level, by design.\n"," 70% of marketers rank first-party data as a very or extremely urgent priority (eMarketer, 2026), and 5% of advertisers have activated theirs (Trellis internal data, 2026). The constraint is execution, not intent.\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"2. Decide first: which customers are worth more to you"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" Most people upload a list, boost everyone on it, and then cannot tell whether it worked. Five minutes here prevents that.\n"," The question to ask about any segment: would this shopper have bought from you without your ad?\n","Where the answer is no, a higher bid buys you a sale you would not otherwise have made. Boost there. - Where the answer is yes, a higher bid buys you a sale you were already going to get, at a higher price. Be careful there.\n"," That single question sorts most customer lists into a clear order:\n","| Segment | What a higher bid buys you | Watch for |\n","\\|---\\|---\\|---\\|\n","| Lapsed buyers (bought once, quiet for 90 days) | A reminder at the exact moment they are shopping your category again. They are not loyal right now, so the ad is doing real work. | Very little. This is the best place to start. |\n","| Cart abandoners | Recovery of demand you already created and nearly captured. | Short shelf life. Refresh this list often or it goes stale. |\n","| Best customers (frequent, recent) | Defence against a competitor taking a customer who is actively shopping. | Highest risk of paying more for a sale you already had. Test it against a control before scaling. |\n"," Start with one segment, usually lapsed buyers. One segment, one campaign, one percentage. You cannot read a result you cannot isolate.\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"3. What you need before you start"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" Three things have to exist before any step in section 4 will work. Each takes a few minutes, and you only ever do them once.\n","A manager account on Amazon Ads -   An Amazon Marketing Cloud clean room -   Your Sponsored Ads account connected to that clean room\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"3.1 Create a manager account"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" A manager account is a wrapper around the advertising accounts you already have. Creating one is what makes Ads data manager appear in your navigation.\n","Go to advertising.amazon.com. 2. In the top-right corner, click the grid icon, then Manager account, then Create Manager account. 3. Enter an account name, and set Account type to Advertiser. 4. Under Link accounts, find your Sponsored Ads account in the Your accounts list and click Add. 5. Click Create Manager account.\n"," The account and the link are created instantly.\n"," Figure 1. The account switcher. Manager accounts you already have are listed here.\n"," Figure 2. Name the account and set Account type to Advertiser.\n"," Figure 3. Your new manager account, ready to use.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"3.2 Create a clean room"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" A clean room is the private workspace where your data and Amazon's data are matched without either side seeing the other's records.\n","In the ads console, click Measurement and reporting, then Amazon Marketing Cloud. 2. If the list is empty, click Create clean room. 3. Give it a name you will recognize later. Description is optional. 4. Leave every AWS setting blank. 5. Click Create clean room, and wait for Status to read Completed.\n"," Figure 4. Your clean rooms. Status must read Completed before you can use one.\n"," Figure 5. Fill in the name. Leave the whole AWS settings block alone.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"3.3 Connect your Sponsored Ads account to the clean room"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":["Open your clean room from the switcher at the top right. 2. Go to the clean room's Accounts page and choose Add accounts. 3. Pick your account from Your accounts, or use Enter manually. 4. For Account type, choose Sponsored ads. 5. Enter your Entity ID and marketplace, then click Add account.\n"," Figure 6. Adding a Sponsored Ads account manually. Sponsored Ads accounts are identified by Entity ID and marketplace.\n"," Figure 7. What success looks like: your account listed, type Sponsored ads, status Active.\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"4. Upload your customer list"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" Before you start, one rule about the file: one column of email addresses, with a header row, saved as CSV. Amazon can hash the file for you, or you can hash it yourself with SHA-256 before upload. Either is fine. Doing both is not.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"Step 1. Open the upload panel"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" In your clean room, open Query editor. In the Explorer panel on the left, expand Advertiser uploaded, then click Upload datasets at the bottom of that list.\n"," Figure 8. Query editor, Explorer panel, Advertiser uploaded, Upload datasets.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"Step 2. Describe the dataset"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":["Enter a Dataset name. Use something you will recognize in a month, for example Lapsed_Buyers_90d_Sep2026. 2. Leave Schema set to Audience. 3. Choose your Country.\n"," Figure 9. The Upload file panel. Note the file rules: CSV only, 200 MiB or smaller.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"Step 3. Attach the file"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" Under Upload, choose the file or drag and drop it, then click Map attributes.\n"," Figure 10. CSV only, 200 MiB or smaller. Split larger files.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"Step 4. Map your column"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" The Review mapping panel lists every field Amazon can accept, down the left. You only need one of them.\n","Find the email row, data type HASHED_EMAIL_ADDRESS. 2. In the Uploaded column dropdown on that row, choose your column, for example em. 3. If you hashed the file yourself, mark it as already hashed so Amazon does not hash it a second time. 4. Click Save.\n"," Figure 11. One column mapped is enough. Everything else stays on Select.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"Step 5. Confirm the dataset landed"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" In Ads data manager, click Datasets. Your file appears in the list with its record count and destinations.\n"," Figure 12. The Datasets list is your record of what you have uploaded.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"Step 6. Open the dataset"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" Click the dataset name to open its detail view, where the match rate appears.\n"," Figure 13. The dataset detail view. Match rate appears on the right, and each upload is listed under Recent uploads.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"Removing a dataset"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" Open Datasets, click the three dots at the end of the row, click Delete, and confirm. Worth knowing before you upload a test file you do not want lingering in your account.\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"5. Read your match rate"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" Records resolved is how many of your hashed emails matched an Amazon shopper profile. Match rate is that number as a percentage of what you uploaded.\n"," Match rates take around 15 minutes to populate, so an empty value right after upload means nothing is wrong.\n","| What you see | What it usually means | What to do |\n","\\|---\\|---\\|---\\|\n","| A healthy share of records resolved | Your list and Amazon's shoppers genuinely overlap | Continue to section 6 |\n","| Near zero | The file was hashed twice, or the column was mapped to the wrong field | Fix the file and upload again as a new dataset |\n","| Low but not zero | Your customers may not be Amazon shoppers in this marketplace, or the emails are old | Try a fresher or larger list before concluding the tactic does not work |\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"6. Build the audience"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" An uploaded dataset is not yet something a campaign can use. One template turns it into an audience.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"6.1 Find the template"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":["In the ads console, click Measurement and reporting, then Amazon Marketing Cloud. 2. Open the clean room connected to your Sponsored Ads account. 3. In the top navigation, click Use cases, then filter to Audience and No code. 4. Open Advertiser uploaded audiences. That screen is the template.\n"," Figure 14. Filter to Audience and No code, then open Advertiser uploaded audiences.\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":3,"text":"6.2 Fill it in"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":["| Field | What to enter |\n","\\|---\\|---\\|\n","| Advertiser | Your Sponsored Ads account |\n","| Audience type | Rule-based reaches the list you uploaded. Lookalike finds shoppers who resemble it. Start with Rule-based. |\n","| Name | Something you will recognize in the campaign dropdown, for example Winback_Lapsed90d_Sep2026 |\n","| Auto adjust date | Leave on Yes |\n","| Advertiser Uploaded Audience Table | The dataset you uploaded in section 4 |\n","| Date range | The window of engagement you care about |\n"," Click Create audience, and watch for the green confirmation.\n"," Figure 15. The whole template. The green toast in the corner is your confirmation that it submitted.\n"," The job runs on its own. Status reads Pending while it works, then turns Active. You can close the tab.\n"," Figure 16. The Audiences list. Completed means the audience was built.\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"7. Apply the bid boost"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":["Open a Sponsored Products campaign, or create one, and scroll to Bid adjustments. 2. Click the Audiences tab. 3. Choose Increase bids on a custom audience created in Amazon Marketing Cloud (AMC). 4. Pick the audience you built. 5. Type a percentage. 6. Read the line underneath it.\n"," Figure 17. Bid adjustments, Audiences tab. Your audience appears in the dropdown.\n"," Figure 18. The console shows you the bid your percentage produces, based on your current bidding strategy.\n"," How to choose the percentage. The console tells you the bid your percentage produces. Pick a number you would be happy to pay on every matched impression, not just the ones that convert. Start low, let it run long enough to read, then raise it.\n"," Where it works. Sponsored Products and Sponsored Brands. One campaign at a time, with no bulk apply yet.\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"8. Plan around the waiting periods"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" Nothing here is slow enough to matter, as long as you know about it in advance. Upload in the morning, build the audience after lunch, and you are live in your campaign inside two days.\n","| Stage | Wait | What is happening |\n","\\|---\\|---\\|---\\|\n","| After upload, before you can build an audience | 2 to 3 hours | The dataset reads Complete in Ads data manager right away, but Amazon Marketing Cloud needs a couple of hours before it can query the records. |\n","| After you click Create audience | Minutes to hours | The job runs on its own. Pending, then Active. |\n","| After the audience is Active, before campaigns can use it | 24 to 48 hours | The audience has to reach the ads console before it becomes selectable in Sponsored Products. |\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"9. When it does not work"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":["| Symptom | Most likely cause | Fix |\n","\\|---\\|---\\|---\\|\n","| Match rate near zero | The file was hashed twice | Upload the raw file and let Amazon hash it, or upload a correctly hashed file once |\n","| Dataset uploaded but cannot be queried | You are inside the 2 to 3 hour window | Wait, then try again |\n","| Dataset is there but useless for audiences | Schema was set to Conversion, not Audience | Upload again with Schema set to Audience |\n","| Use cases missing from the top navigation | Clean room is not connected to your ads account | Section 3.3 |\n","| Audience is Active but not in the campaign dropdown | You are inside the 24 to 48 hour window | Wait. Do not rebuild |\n","| Your Sponsored Ads account is not listed anywhere | Another user administers it | Request access from the account switcher |\n","| Clean room creation keeps failing | Something was entered in the AWS settings | Start again and leave AWS settings blank |\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"10. What good looks like"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":[" A controlled test, same keywords and same spend. One campaign added Corro-Protec's own customer data: 1.5x greater reach, 2.2x more overall engagement, and 2x return on ad spend.\n"," Source: Amazon Ads case study, Corro-Protec, Canada, 2025\n"," After your first audience is live\n","Leave it alone long enough to read. Changing the percentage every few days gives you noise instead of a result. 2. Compare against a campaign without the boost, not against last month. 3. Refresh the list on a schedule. A lapsed-buyer list decays the moment someone buys again. 4. Then add a second segment, not a second percentage on the first one.\n"," The accounts, the clean room and the connection are one-time setup. Every list after this one is just section 4 onward.\n","\n"],"documentType":"guide"},{"title":"AMC Bid Boosting Guide for Sponsored Ads Accounts","sectionHeader":{"type":2,"text":"11. Glossary"},"path":"/en-us/no-code-tools/adm/8_adm_access_guide_advertiser_accounts","content":["| Term | What it means here |\n","\\|---\\|---\\|\n","| Ads data manager | Where your uploaded data lives, and where you control which Amazon Ads products can use it |\n","| Amazon Marketing Cloud | The analysis and audience-building environment. Your clean rooms live here |\n","| Clean room | A private workspace where your data and Amazon's data are matched without either side seeing the other's records |\n","| Dataset | One uploaded file, plus what Amazon knows about it (record count, match rate, destinations) |\n","| Schema | Whether the file is for building audiences (Audience) or for measuring sales (Conversion) |\n","| Hashing | Scrambling an email into a fixed-length string with SHA-256, so matching can happen without sharing the address itself |\n","| Records resolved | How many of your uploaded records matched an Amazon shopper profile |\n","| Entity ID | The identifier for a Sponsored Ads account, used when connecting it to a clean room |\n","| Rule-based audience | An audience made of the people on your list who matched |\n","| Lookalike audience | An audience of shoppers who resemble the people on your list |\n","| Bid adjustment | An instruction to bid a set percentage higher when a shopper matches a condition, leaving all other bids unchanged |\n","\n"],"documentType":"guide"}],"toc-betas":[{"title":"Betas overview","sectionHeader":null,"path":"/en-us/developer/betas","content":[" This section contains beta programs available for the Amazon Ads API v1. \n"],"documentType":"guide"},{"title":"Betas overview","sectionHeader":{"type":2,"text":"Explore the betas "},"path":"/en-us/developer/betas","content":[],"documentType":"guide"},{"title":"Betas overview","sectionHeader":{"type":3,"text":"OpenAPI specification"},"path":"/en-us/developer/betas","content":[" All API operations available in beta are included in the Ads API v1 betas specification, grouped by resource.\n"],"documentType":"guide"},{"title":"Betas overview","sectionHeader":{"type":3,"text":"User guides and resources"},"path":"/en-us/developer/betas","content":[" For betas listed in the table of contents menu, you will find:\n","Name: The name of the beta program. - Overview / Developer guide: An overview of the beta program, including key features, benefits, and requirements. Some betas also include a detailed developer guide. - Available resources: Links to the resource groupings in the specification.\n"],"documentType":"guide"},{"title":"Betas overview","sectionHeader":{"type":2,"text":"FAQ"},"path":"/en-us/developer/betas","content":[],"documentType":"guide"},{"title":"Betas overview","sectionHeader":{"type":3,"text":"Who are these betas for?"},"path":"/en-us/developer/betas","content":[" Betas in the Ads API v1 are intended for Amazon Ads API developers who are interested in providing feedback on the new consistent data models and API structure. These betas may be beneficial for developers integrating across multiple Amazon Ads products now or in the future. During the beta period, breaking changes may occur to address any customer feedback regarding naming, structure, or format.\n"," We refer to betas as closed or open. Closed betas are invite-only and are often the first phase of a beta. Open betas are accessible to developers without an invite, and often occur as a second phase to test scale.\n"],"documentType":"guide"},{"title":"Betas overview","sectionHeader":{"type":3,"text":"How can I join a closed beta?"},"path":"/en-us/developer/betas","content":[" For resources noted as \"closed beta,\" please review the list below to find information about how to submit a request to join a given beta program. Once you are accepted into a beta program, your client ID can be added to the allowlist for the resource. \n","Account registration: The API is currently available to customers who have an existing Amazon DSP Seat and have opted-in for the beta via their sales team.\n"," Your client ID for a closed beta will be the same as the Login With Amazon application created during the onboarding process. If you have an existing integration with the Amazon Ads API, this will be the same client ID you currently use to authorize requests to the API. You do not need a new client ID to access beta functionality.\n"],"documentType":"guide"},{"title":"Betas overview","sectionHeader":{"type":3,"text":"What do we need from you during the beta?"},"path":"/en-us/developer/betas","content":[" We encourage beta participants to:\n","Provide feedback on the new API models and structure. - Identify any regressions compared to their current API experience. - Conduct test calls during the first phase of the beta. - Perform scale testing in the second phase of the beta.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":null,"path":"/en-us/mcp/mcp-overview","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"How it works"},"path":"/en-us/mcp/mcp-overview","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Primitives"},"path":"/en-us/mcp/mcp-overview","content":[" MCP primitives are the fundamental building blocks that define how AI applications and external systems can interact. They specify the types of contextual information that can be shared with AI applications and the range of actions that can be performed.\n"," The Amazon Ads MCP Server translates Amazon Ads APIs into two standardized MCP primitives:\n","A Tool is a function exposed to an agent with a description, input properties, and return values that allows the agent to perform an action. See Types of Tools. \\* A Skill is a pre-defined prompt definition provided by Amazon Ads that guides AI applications through Amazon Ads workflows and tool usage.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Types of Tools"},"path":"/en-us/mcp/mcp-overview","content":[" The Amazon Ads MCP Server offers two types of tools:\n","|Tool type|Description|Example|\n","\\|---\\|---\\|---\\|\n","|Standard tools|Deterministic actions to achieve an outcome.|Update budget; end-to-end campaign creation (multiple API calls performed by a single tool).|\n","|Expert tools|Inference behind the tool interprets the request, applies Amazon intelligence, and produces the finished output.|Generate a correct AMC SQL query.|\n"," The AMC SQL Generator tool is the first available expert tool. Apply for closed beta access: applications are evaluated based on technical readiness and alignment with the current beta scope.\n"," Amazon Ads builds, maintains, and updates the MCP Server so that developers and AI applications can consistently access the latest functionality without re-engineering integrations. LLMs can stay up to date with Amazon Ads context, enabling faster innovation and reducing maintenance overhead.\n"," Amazon Ads does not own or operate the LLMs or AI applications that connect through the MCP Server. Developers can connect to the MCP Server using Claude (Anthropic), ChatGPT (OpenAI), Amazon Kiro, Amazon Bedrock, Amazon AgentCore, and other MCP-compatible applications. The Amazon Ads MCP Server provides a standardized bridge between those external AI systems and Amazon Ads. You maintain full control and flexibility over your AI experiences while benefiting from reliable access to Amazon Ads context.\n"," For additional MCP terms and concepts, refer to documentation from Model Context Protocol.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Typical use cases"},"path":"/en-us/mcp/mcp-overview","content":[" The following are some example prompts and use cases that you can perform using the Amazon Ads MCP Server:\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Standard tools"},"path":"/en-us/mcp/mcp-overview","content":["Query campaign performance with requests such as \"Show me campaign performance for October 2025 on \\[account_id]\"  Access account information by asking \"Show me a list of all of my advertising accounts\" or \"Show me my recent invoices on \\[account_id]\"  Generate reports with requests such as \"Create a Campaign report for \\[account_id]\" \\* Update campaign settings through simple instructions such as \"Increase my campaign budget to $500 on \\[campaign_id]\"\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Expert tools"},"path":"/en-us/mcp/mcp-overview","content":[],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server","sectionHeader":null,"path":"/en-us/mcp/get-started","content":[],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"**Getting Started:**"},"path":"/en-us/mcp/get-started","content":[" Step 1: Use an existing LwA application and Amazon Developer account with access to the Amazon Ads API or complete the onboarding steps\n"," Step 2: Complete an authorization grant and retrieve access and refresh tokens. Save the access and refresh tokens — you will need them to connect to the MCP server later.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"**Account Identifier Context Modes**"},"path":"/en-us/mcp/get-started","content":[" While the Amazon Ads API requires you to input specific accountIds in headers or fields, like inserting a profileId into the Amazon-Advertising-API-Scope header, the MCP server handles this differently.\n"," By default, the MCP server uses a Dynamic Account Context mode. In this mode, the LLM asks you to provide the account identifiers needed to invoke each selected tool. You can use the query_advertiser_accounts tool to get all accounts the user has access to. Once provided to the LLM, this account may be reused for subsequent requests or until new account identifiers are provided to the LLM. The MCP server requires the account identifiers to be passed as a parameter in the request body.\n","profileId: The identifier of a profile associated with the advertiser account.\n","managerAccountId: The manager account ID.\n","advertiserAccountId: The identifier can be either a DSP advertiser account, global account ID, or AMC instance ID depending on the tool you are trying to call.\n"," If you would instead like to support an account identifier context which behaves more closely to the Amazon Ads APIs, the server also supports a Fixed Account Context mode. In this mode, you can set your account identifiers as statically-defined headers. Doing so indicates to the server not to prompt your LLM for account information, and instead uses the pre-set headers for this information. Please note that for this mode, all headers should correspond with a single account.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"**Required Headers**"},"path":"/en-us/mcp/get-started","content":[" To connect to the Amazon Ads MCP server, each request to the Amazon Ads MCP server requires the following headers:\n","Amazon-Ads-ClientId: The client identifier of an LwA application authorized to access the MCP Server. \\* Authorization: The string Bearer prepended to an access token representing the permission of that application to access data and services for a given Amazon user.\n"," Fixed Account Context requires the additional headers defined below: profile ID header, account ID header, or manager account ID header, and a header to indicate fixed mode. Dynamic Account Context only needs the two basic headers defined above (Amazon-Ads-ClientId and Authorization).\n","Amazon-Ads-AI-Account-Selection-Mode: The header that indicates to the MCP server that the client wants to operate in fixed account scope mode.  Amazon-Advertising-API-Scope: The identifier of a profile associated with the advertiser account.  Amazon-Ads-AccountID: The identifier can be either a DSP advertiser account, global account ID, or AMC instance ID depending on the tool you are trying to call. \\* Amazon-Ads-Manager-AccountID: Alternatively to profile ID or account ID, you could pass in the manager account ID. Please note that not all tools work on manager account scope.\n"," Please note that not all three account identifier headers (Amazon-Advertising-API-Scope, Amazon-Ads-AccountID, Amazon-Ads-Manager-AccountID) need to be included, but at least one is required. The header + value Amazon-Ads-AI-Account-Selection-Mode: FIXED is always required when using this context mode.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"**MCP Server URL**"},"path":"/en-us/mcp/get-started","content":[" These URLs are not region agnostic. For connecting to the server in the NA region, please use the NA URL.\n","|Region|Endpoint URL|\n","\\|---\\|---\\|\n","|NA (North America)|https&#x3A;//advertising-ai.amazon.com/mcp|\n","|EU (Europe)|https&#x3A;//advertising-ai-eu.amazon.com/mcp|\n","|FE (Far East)|https&#x3A;//advertising-ai-fe.amazon.com/mcp|\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"Connecting to the MCP server using Kiro CLI"},"path":"/en-us/mcp/get-started","content":[" Step 1: Fetch the clientId of your application as well as access token and refresh token\n"," Sign in to https&#x3A;//developer.amazon.com/ with your Amazon developer account credentials, and then navigate to https&#x3A;//developer.amazon.com/loginwithamazon/console/site/lwa/overview.html. You must be able to retrieve your clientId from that page as shown below:\n"," Step 2: Connect to the MCP server via Kiro CLI by adding the MCP server configuration to ~/.kiro/settings/mcp.json.\n"," Fixed Account Context:\n"," Dynamic Account Context:\n"," Step 3 (optional): Set up tool filters through Kiro configuration\n"," If you would like to disable any of the available tools, you can do so through your Kiro configuration by adding disabledTools. The following example disables the delete_campaign and delete_ad tools.\n"," Step 4: Run Kiro CLI\n"," Once your MCP configuration is properly set up:\n","Start Kiro CLI by running kiro-cli 2. Look for a tick mark (✓) next to your MCP server name during startup — this indicates a successful connection 3. To verify the connection, use the /mcp command to see the list of connected MCP servers 4. To see available tools, use the /tools command to list available tools.\n"," This confirms your Amazon Ads MCP server is properly connected and ready to use.\n"," Step 5: Utilize the Amazon Ads MCP Server\n"," In the fixed account context, you can start directly by creating campaigns or performing other operations. Example of next steps:\n"," The Amazon Ads MCP server uses the header provided from the fixed account context to create the campaign.\n"," In the dynamic account context, before creating campaigns or performing other operations, you must first identify your available advertiser accounts.\n","Ask Kiro to list your accounts with this prompt: 2. This triggers the account_management-query_advertiser_account tool and returns a list of all advertiser accounts which can be accessed with the current context. 3. Note the account IDs from the results — you will need to specify these in subsequent commands.\n"," Example of next steps:\n"," The account ID retrieved becomes the profile/account identifier for all future campaign management operations.\n","\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"Sample Python Client Library and Conversational Agent"},"path":"/en-us/mcp/get-started","content":[" If you are interested in connecting to the Amazon Ads MCP Server programmatically through Python, a sample client library implementation and a working demo are provided that you can copy and customize for your needs. The library includes a fluent builder interface for easy configuration, support for all regions (NA, EU, FE), optional tool filtering, and automatic handling of statically-defined account identifier headers if preferred.\n"," Prerequisites: You will need to install the following dependencies which are used for initializing your client. You can follow the installation steps for each dependency here: 1. Strands Python API 2. MCP Python SDK\n"," Next, if you are running this on your local machine, you will need to configure AWS so that your local execution has access to your AWS credentials. This is not needed to connect to the server, but it is necessary to connect your agent to an LLM.\n"," For more on foundational model access with AWS, see here: https&#x3A;//docs.aws.amazon.com/bedrock/latest/userguide/model-access.html\n"," First, install the AWS CLI if it is not already installed. After that, you can run aws configure to connect your local environment to an AWS account that has access to your desired model. See here for more on using aws configure.\n"," Finally, fetch the clientId of your application, access token, and refresh token. Sign in to https&#x3A;//developer.amazon.com/ with your Amazon developer account credentials, and then navigate to https&#x3A;//developer.amazon.com/loginwithamazon/console/site/lwa/overview.htm to retrieve the required ID and tokens.\n"," Sample Client + Conversational Playground\n"," Create a Python file in your local environment and paste in the following code snippet:\n"," Now, you can start the conversational agent by running your Python script.\n"," You can edit this snippet or use it as a reference point to create your own Ads agent.\n"," If you prefer to use statically-defined account identifiers (Fixed Context Mode), you can add them to your client builder:\n"," The following account identifier headers are supported. Please only set what is appropriate for your use case:\n"," If you prefer using dynamically-set account identifiers provided by your LLM, do not include any of these three values when initializing your client.\n"," Troubleshooting:\n"," Most likely, this means that your LwA token has expired. Follow the prerequisite steps above to fetch a new one, update your client initialization with the fresh header, and restart the code snippet execution to create a new session.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":null,"path":"/en-us/mcp/get-started-lite","content":[],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":2,"text":"**What is the Lite version?**"},"path":"/en-us/mcp/get-started-lite","content":[" The Lite version of the Amazon Ads MCP Server exposes the same Amazon Ads capabilities as the Regular version, but through a compact three-tool interface instead of registering every operation as its own tool. Rather than loading the full tool catalog into your model's context, the Lite server gives your agent three meta-tools that let it discover, inspect, and run any underlying Amazon Ads operation on demand:\n","amazon_ads_mcp-search_tools — Search the Amazon Ads tool catalog with a natural-language query. The response returns the tools that directly match plus the other tools in each matched domain (namespace), each with its name, namespace, and description — so a single search surfaces the whole domain the request falls into, not just the closest hits.  amazon_ads_mcp-describe_tools — Retrieve the full input schema for one or more tools returned by search, so the agent knows exactly which fields to populate.  amazon_ads_mcp-invoke_tool — Invoke a specific tool by name with the arguments assembled from the described schema.\n"," The agent follows a simple search → describe → invoke loop: it searches for the right operation, describes its schema, then invokes it. This keeps the model's context small and predictable regardless of how many operations Amazon Ads exposes, which is useful for smaller-context models, cost-sensitive workloads, or clients that only need a handful of operations per session.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":2,"text":"**Lite vs. Regular at a glance**"},"path":"/en-us/mcp/get-started-lite","content":["| Version | Regular | Lite |\n","\\|---\\|---\\|---\\|\n","| Endpoint path | /mcp | /mcp/lite |\n","| Tools exposed | One tool per Amazon Ads operation | Three tools: search_tools, describe_tools, invoke_tool |\n","| Context footprint | High initial context (all operational tools from MCP), grows with the total number of operations from MCP | Low initial context (3 tools), grows only with more tools discovered on-demand |\n","| Best for | Clients that want every operation visible and directly callable, or manage progressive discovery on client-side | Smaller-context models, cost-sensitive or focused sessions |\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":2,"text":"**Account Identifier Context Modes**"},"path":"/en-us/mcp/get-started-lite","content":[" The Lite version supports the same account context modes as the Regular version.\n"," By default, the MCP server uses a Dynamic Account Context mode. In this mode, the LLM asks you to provide the account identifiers needed to invoke each selected tool. You can discover the account query tool through amazon_ads_mcp-search_tools and then invoke it to get all accounts the user has access to. Once provided to the LLM, this account may be reused for subsequent requests or until new account identifiers are provided to the LLM.\n","profileId: The identifier of a profile associated with the advertiser account.  managerAccountId: The manager account ID.  advertiserAccountId: The identifier can be either a DSP advertiser account, global account ID, or AMC instance ID depending on the tool you are trying to call.\n"," If you would instead like to support an account identifier context which behaves more closely to the Amazon Ads APIs, the server also supports a Fixed Account Context mode. In this mode, you can set your account identifiers as statically-defined headers. Doing so indicates to the server not to prompt your LLM for account information, and instead uses the pre-set headers for this information. Please note that for this mode, all headers should correspond with a single account.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":2,"text":"**Required Headers**"},"path":"/en-us/mcp/get-started-lite","content":[" The Lite version uses the same headers as the Regular version. Each request requires the following headers:\n","Amazon-Ads-ClientId: The client identifier of an LwA application authorized to access the MCP Server. \\* Authorization: The string Bearer prepended to an access token representing the permission of that application to access data and services for a given Amazon user.\n"," Fixed Account Context requires the additional headers defined below:\n","Amazon-Ads-AI-Account-Selection-Mode: Indicates to the MCP server that the client wants to operate in fixed account scope mode. Currently the server only supports Amazon-Ads-AI-Account-Selection-Mode: FIXED. If you prefer dynamically-set account identifiers, do not include this header.  Amazon-Advertising-API-Scope: The identifier of a profile associated with the advertiser account.  Amazon-Ads-AccountID: The identifier can be either a DSP advertiser account, global account ID, or AMC instance ID depending on the tool you are trying to call. \\* Amazon-Ads-Manager-AccountID: Alternatively to profile ID or account ID, you could pass in the manager account ID. Please note that not all tools work on manager account scope.\n"," Please note that not all three account identifier headers need to be included, but at least one is required. The header + value Amazon-Ads-AI-Account-Selection-Mode: FIXED is always required when using this context mode.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":2,"text":"**MCP Server URL**"},"path":"/en-us/mcp/get-started-lite","content":[" The Lite version is served from the /mcp/lite path. These URLs are not region agnostic. For connecting to the server in the NA region, please use the NA URL.\n","|Region|Endpoint URL|\n","\\|---\\|---\\|\n","|NA (North America)|https&#x3A;//advertising-ai.amazon.com/mcp/lite|\n","|EU (Europe)|https&#x3A;//advertising-ai-eu.amazon.com/mcp/lite|\n","|FE (Far East)|https&#x3A;//advertising-ai-fe.amazon.com/mcp/lite|\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":2,"text":"Connecting to the Lite MCP server using Kiro CLI"},"path":"/en-us/mcp/get-started-lite","content":[" Step 1: Fetch the clientId of your application as well as access token and refresh token\n"," Sign in to https&#x3A;//developer.amazon.com/ with your Amazon developer account credentials, and then navigate to https&#x3A;//developer.amazon.com/loginwithamazon/console/site/lwa/overview.html to retrieve your clientId.\n"," Step 2: Connect to the Lite MCP server via Kiro CLI by adding the MCP server configuration to ~/.kiro/settings/mcp.json.\n"," Fixed Account Context:\n"," Dynamic Account Context:\n"," Step 3: Run Kiro CLI\n"," Once your MCP configuration is properly set up:\n","Start Kiro CLI by running kiro-cli 2. Look for a tick mark (✓) next to your MCP server name during startup — this indicates a successful connection 3. Use the /mcp command to see the list of connected MCP servers 4. Use the /tools command to list available tools. For the Lite server you should see exactly three tools: amazon_ads_mcp-search_tools, amazon_ads_mcp-describe_tools, and amazon_ads_mcp-invoke_tool.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":2,"text":"**How the three tools work together**"},"path":"/en-us/mcp/get-started-lite","content":[" When you make a request, the agent works through the three tools in sequence:\n","Search — The agent calls amazon_ads_mcp-search_tools with a short query describing what you want (for example, \"keyword targets ad group\"). The server returns the matching Amazon Ads tools and their descriptions. 2. Describe — The agent calls amazon_ads_mcp-describe_tools with the tool names it picked from the search results. The server returns each tool's full input schema so the agent knows which fields to fill in. 3. Invoke — The agent calls amazon_ads_mcp-invoke_tool with the chosen tool name and the assembled arguments to perform the operation.\n"," More complex requests simply repeat the loop — for example, an eligibility check followed by a create will search/describe/invoke once for each underlying operation.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":2,"text":"**Example prompts**"},"path":"/en-us/mcp/get-started-lite","content":[" The following examples show the kinds of natural-language requests the Lite server handles, along with the search → describe → invoke path the agent takes behind the scenes. You do not need to name the three tools yourself; the agent selects them automatically based on your request.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":3,"text":"Read a target list"},"path":"/en-us/mcp/get-started-lite","content":[" Behind the scenes: amazon_ads_mcp-search_tools (\"keyword targets ad group\") → amazon_ads_mcp-describe_tools (query target schema) → amazon_ads_mcp-invoke_tool (query targets).\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":3,"text":"Add a keyword target"},"path":"/en-us/mcp/get-started-lite","content":[" Behind the scenes: amazon_ads_mcp-search_tools (\"create keyword target\") → amazon_ads_mcp-describe_tools (create target schema) → amazon_ads_mcp-invoke_tool (create target).\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":3,"text":"Update a bid"},"path":"/en-us/mcp/get-started-lite","content":[" Behind the scenes: amazon_ads_mcp-search_tools (\"update target bid\") → amazon_ads_mcp-describe_tools (update bid schema) → amazon_ads_mcp-invoke_tool (update bid).\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":3,"text":"Check product eligibility"},"path":"/en-us/mcp/get-started-lite","content":[" Behind the scenes: amazon_ads_mcp-search_tools (\"product eligibility\") → amazon_ads_mcp-describe_tools (eligibility schema) → amazon_ads_mcp-invoke_tool (check eligibility).\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":3,"text":"Generate a report"},"path":"/en-us/mcp/get-started-lite","content":[" Behind the scenes: the agent runs the search → describe → invoke loop once to create the report, then again to poll and download the results.\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":3,"text":"List your accounts"},"path":"/en-us/mcp/get-started-lite","content":[" Behind the scenes: amazon_ads_mcp-search_tools (\"advertiser accounts\") → amazon_ads_mcp-invoke_tool (query advertiser accounts).\n"],"documentType":"guide"},{"title":"Connecting to the Amazon Ads MCP Server (Lite)","sectionHeader":{"type":2,"text":"Troubleshooting"},"path":"/en-us/mcp/get-started-lite","content":[" Most likely, this means that your LwA token has expired. Fetch a new one, update your Authorization header, and restart your client to create a new session.\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":null,"path":"/en-us/mcp/oauth","content":[" The Amazon Ads MCP Server supports OAuth 2.1. With OAuth 2.1, your MCP client handles token retrieval automatically through a browser-based login flow — you do not need to manage access tokens in your configuration file.\n"," This guide walks you through setting up OAuth 2.1 authorization for Kiro CLI, Claude Code, Claude Desktop, and ChatGPT.\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":2,"text":"Public vs private client"},"path":"/en-us/mcp/oauth","content":["| Mode | What you provide | Token behavior |\n","\\|---\\|---\\|---\\|\n","| Public client | Client ID only | Access token expires after 1 hour. A browser popup prompts you to re-authenticate. |\n","| Private client | Client ID + Client Secret | Refresh token is stored securely in your system keychain (macOS) or credentials file. Tokens refresh automatically. |\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/mcp/oauth","content":["An active Amazon Developer account at developer.amazon.com - An approved application with access to the Amazon Ads API - Your Client ID from your Login with Amazon (LwA) security profile - An MCP-compatible AI client (Kiro CLI, Claude Code, Claude Desktop, or ChatGPT)\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":2,"text":"Step 1: Configure your Login with Amazon security profile"},"path":"/en-us/mcp/oauth","content":[" Your LwA security profile must include the correct callback URL so that the MCP client can complete the authentication handshake.\n","Go to developer.amazon.com and sign in. 2. Navigate to Login with Amazon under your application settings. 3. Open your Security Profile and go to the Web Settings tab. 4. Under Allowed Return URLs, add the callback URL for your MCP client (see below). 5. Save your changes.\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":3,"text":"Callback URLs by client"},"path":"/en-us/mcp/oauth","content":["| Client | Callback URL |\n","\\|---\\|---\\|\n","| Kiro CLI | http&#x3A;//localhost:&lt;PORT>/oauth/callback — Set the port in your mcp.json config (see Step 2) |\n","| Claude Code | http&#x3A;//localhost:&lt;PORT>/callback — Set the port via --callback-port or config (see Step 2) |\n","| Claude Desktop | https&#x3A;//claude.ai/api/mcp/auth_callback |\n","| ChatGPT | https&#x3A;//chatgpt.com/connector/oauth/&lt;APP_ID> — APP_ID is provided by OpenAI in the MCP configuration panel |\n","| Amazon Quick | https&#x3A;//quick.aws.com/sn/oauthcallback |\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":2,"text":"Step 2: Add the MCP server to your client"},"path":"/en-us/mcp/oauth","content":[],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":3,"text":"Kiro CLI"},"path":"/en-us/mcp/oauth","content":[" Update the Kiro CLI config file at ~/.kiro/settings/mcp.json:\n"," Replace &lt;your-client-id> with your LwA Client ID and &lt;your-callback-port> with a fixed port number (for example, 8001). Use this same port when configuring the Allowed Return URL in Step 1.\n"," To authenticate, run kiro-cli then press Ctrl+Y to copy the authentication URL to the clipboard and then open it in your browser.\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":3,"text":"Claude Code"},"path":"/en-us/mcp/oauth","content":[" You can configure the connection using the claude mcp command or by editing the config file directly.\n"," Public client:\n"," Private client:\n"," You will be prompted to enter your Client Secret.\n"," Alternatively, edit ~/.claude.json directly (public client):\n"," To authenticate, run claude, type /mcp, choose amzn-ads-mcp, and select Authenticate:\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":3,"text":"Claude Desktop"},"path":"/en-us/mcp/oauth","content":["Go to Customize > Connectors. 2. Click the plus sign and choose Add custom connector. 3. Enter the server name (e.g., Amazon Ads MCP) and the server URL (https&#x3A;//advertising-ai.amazon.com/mcp). 4. Specify your Client ID and Client Secret under Advanced settings. 5. Click Add.\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":3,"text":"ChatGPT"},"path":"/en-us/mcp/oauth","content":["Click your profile and select Settings. 2. Select the Apps tab and click Create app next to Advanced settings. 3. Enter the server name (e.g., Amazon Ads MCP) and the server URL (https&#x3A;//advertising-ai.amazon.com/mcp). 4. Click Advanced OAuth settings. 5. In the Client registration panel, switch to \"User-Defined OAuth client\". 6. Add the Callback URL to the Allowed Return URLs of your developer account (see Step 1). 7. Enter your Client ID and Client Secret (optional). 8. Click Create.\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":2,"text":"Step 3: Authenticate"},"path":"/en-us/mcp/oauth","content":[" After configuring your client, the OAuth 2.1 flow begins:\n","Your MCP client opens the LwA login page in your browser. 2. Sign in with your Amazon advertising account credentials. 3. Review the permissions and click Allow.\n"," After granting access, you will see a confirmation page. You can close the browser window and return to your MCP client.\n"," You are now connected. Try a prompt like:\n"," The MCP client will call the account_management-query_advertiser_account tool and return your account IDs, marketplace coverage, and account metadata.\n"],"documentType":"guide"},{"title":"Connecting to the Ads MCP Server using OAuth 2.1","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/mcp/oauth","content":[],"documentType":"guide"},{"title":"AMC SQL Generator","sectionHeader":null,"path":"/en-us/mcp/amc-sql-generator","content":[" The AMC SQL Generator tool (amc_sql_generator) is an expert tool on the Amazon Ads MCP Server. It takes a natural language request from your agent and returns a validated AMC SQL query ready for execution. The tool understands the AMC data structure, audience capabilities, and best practices, so it can translate complex business requirements into optimized queries that account for the nuances of how AMC works. This accelerates insight generation and audience development, enabling businesses to unlock AMC use cases that previously required specialized SQL expertise.\n"," The AMC SQL Generator tool is exposed as an MCP tool on the Amazon Ads MCP Server, making it available for programmatic integration into your AI applications and workflows.\n"],"documentType":"guide"},{"title":"AMC SQL Generator","sectionHeader":{"type":2,"text":"What the AMC SQL Generator tool can do"},"path":"/en-us/mcp/amc-sql-generator","content":["SQL generation for audience creation: Generate SQL queries for custom audience creation through natural language. The tool understands the AMC signals structure and audience capabilities, enabling users to quickly translate business requirements into executable queries.  Analytics SQL query generation: Transform business questions into analytics SQL queries through AI-guided exploration. The tool helps discover relevant use cases, understand how to best use signals available in AMC, and generate optimal SQL queries for specific analytical needs.  AI-powered user assistance: Get immediate answers to AMC product questions through a conversational interface, including guidance on best practices, feature capabilities, datasets, and AMC concepts.\n"],"documentType":"guide"},{"title":"AMC SQL Generator","sectionHeader":{"type":2,"text":"Key benefits"},"path":"/en-us/mcp/amc-sql-generator","content":["Converts natural language descriptions into AMC-compliant SQL code  Generates both SQL code and an explanation of the query logic, making the output transparent and reviewable  Answers questions about AMC concepts, datasets, and features \\* Reduces time spent writing complex SQL queries\n"],"documentType":"guide"},{"title":"AMC SQL Generator","sectionHeader":{"type":2,"text":"Who it is for"},"path":"/en-us/mcp/amc-sql-generator","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":null,"path":"/en-us/mcp/skills/skills-overview","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Skills"},"path":"/en-us/mcp/skills/skills-overview","content":[],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"What are Skills?"},"path":"/en-us/mcp/skills/skills-overview","content":[" Skills are pre-defined prompt definitions provided by Amazon Ads that guide AI applications through Amazon Ads workflows and tool usage. There are two types of skills:\n","Workflow Skills orchestrate multi-step processes by combining one or more MCP tools into structured, repeatable patterns. They handle tool sequencing, error recovery, and result formatting — so users can accomplish complex tasks through a single natural language request without needing to understand the underlying tool orchestration. - Capability Skills provide informational guidance on how to effectively use specific tools or features. Rather than orchestrating actions, they describe tool capabilities, explain input/output formats, and offer best practices — helping AI applications generate correct tool calls and interpret results accurately.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"How Skills Work"},"path":"/en-us/mcp/skills/skills-overview","content":[" Skills are triggered automatically by compatible AI applications (such as Claude Code) based on the context of your request. \n"," For example:\n","The dsp-campaign-analysis workflow skill activates when a user asks something like \"How did my Holiday Promo Q4 campaign perform?\" Behind the scenes, it orchestrates a multi-step workflow: resolving the campaign name to an ID, creating two separate performance reports (one for ROAS/sales metrics and one for audience segment breakdowns), polling until both reports complete, and presenting a combined analysis — all from a single conversational request. \\* Asking \"Show me my campaign performance for last month\" triggers the ads-reporting skill, which handles report creation, polling, and retrieval on your behalf.\n"," Skills abstract away multi-step tool orchestration and tool usage complexity so you can focus on your advertising goals rather than API mechanics.\n"],"documentType":"guide"},{"title":"Download Skills from the Amazon Ads MCP Server","sectionHeader":null,"path":"/en-us/mcp/skills/get-started","content":[],"documentType":"guide"},{"title":"Download Skills from the Amazon Ads MCP Server","sectionHeader":{"type":2,"text":"Skills"},"path":"/en-us/mcp/skills/get-started","content":[" The Amazon Ads MCP Server provides downloadable skill definitions that you can use to enhance your AI client capabilities. Skills are pre-defined sets of instructions and configurations that guide an AI agent through specific advertising workflows.\n"],"documentType":"guide"},{"title":"Download Skills from the Amazon Ads MCP Server","sectionHeader":{"type":3,"text":"Skill Server URLs"},"path":"/en-us/mcp/skills/get-started","content":[" These URLs are not region agnostic. Select the endpoint URL that corresponds to your region.\n","|Region|Endpoint URL|\n","\\|---\\|---\\|\n","|NA (North America)|https&#x3A;//advertising-api.amazon.com/skills|\n","|EU (Europe)|https&#x3A;//advertising-api-eu.amazon.com/skills|\n","|FE (Far East)|https&#x3A;//advertising-api-fe.amazon.com/skills|\n"],"documentType":"guide"},{"title":"Download Skills from the Amazon Ads MCP Server","sectionHeader":{"type":3,"text":"Listing Available Skills"},"path":"/en-us/mcp/skills/get-started","content":[" To list all available skills, send a GET request to the /skills endpoint. The request requires the same Amazon-Ads-ClientId and Authorization headers as the MCP server.\n"," The response is a JSON object containing a skills array, where each item includes a skill name and description:\n"],"documentType":"guide"},{"title":"Download Skills from the Amazon Ads MCP Server","sectionHeader":{"type":3,"text":"Downloading Skills as ZIP"},"path":"/en-us/mcp/skills/get-started","content":[" To download a skill as a ZIP archive, add the download=true query parameter:\n"," This returns a ZIP file (for example, example-skill-name.zip) containing the files of the skill.\n"," To download all skills as a single ZIP archive:\n"," This returns all-skills.zip with each skill organized in its own folder.\n"," Use wget to save the file:\n"],"documentType":"guide"},{"title":"Download Skills from the Amazon Ads MCP Server","sectionHeader":{"type":3,"text":"Retrieving Skill Files as JSON"},"path":"/en-us/mcp/skills/get-started","content":[" To retrieve the files for a specific skill as JSON, append the name query parameter with the skill name to the /skills endpoint:\n"," To download files for all available skills at once, use name=all:\n"," The response is a JSON object containing a files array. Each item includes the filename, path, and content of a skill file:\n"],"documentType":"guide"},{"title":"Download Skills from the Amazon Ads MCP Server","sectionHeader":{"type":3,"text":"Loading Skills into Your AI Client"},"path":"/en-us/mcp/skills/get-started","content":[" Once you have downloaded a skill definition, you can load it into your AI client. \n"," Step 1: Download all available skills as a ZIP archive and extract them into your skills directory:\n"," Step 2: In Claude Code, skills are loaded from the .claude/skills/ directory. Once the skill files are saved to this location, Claude Code will automatically detect and make them available for use.\n"," Step 3: You can then invoke the skill within Claude Code by referencing it in your prompt, and the agent will follow the instructions defined in the skill.\n"],"documentType":"guide"},{"title":"Ads Reporting Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/reporting","content":[],"documentType":"guide"},{"title":"Ads Reporting Skill","sectionHeader":{"type":2,"text":"Ads Reporting Skill"},"path":"/en-us/mcp/skills/skills-library/reporting","content":[" What does this skill do? The ads reporting skill enables agents to create and retrieve Amazon Ads reports for performance data, campaign metrics, and advertising insights. This skill guides agents through the multi-step process of resolving account identifiers, creating reports with the correct parameters, and polling for completion.\n"," When to read this skill: Your agent should read the ads reporting skill before invoking any of the following tools:\n"],"documentType":"guide"},{"title":"Advertiser Accounts Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/advertiser-accounts","content":[],"documentType":"guide"},{"title":"Advertiser Accounts Skill","sectionHeader":{"type":2,"text":"Advertiser Accounts Skill"},"path":"/en-us/mcp/skills/skills-library/advertiser-accounts","content":[" What does this skill do? This skill guides agents through creating, querying, and updating advertiser accounts (global accounts) via the account_management APIs. It covers the full account lifecycle—from registration through approval—and includes rules for mutable vs. immutable fields, selling account linking, and manager account association for DSP enablement.\n"," When to read this skill: Read this skill when your agent needs to register a new advertiser account, look up existing accounts by ID or filter, or update account details such as display name, industry, or business information.\n"],"documentType":"guide"},{"title":"Advertiser Product Group Eligibility Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/advertiser-product-group-eligibility","content":[],"documentType":"guide"},{"title":"Advertiser Product Group Eligibility Skill","sectionHeader":{"type":2,"text":"Advertiser Product Group Eligibility Skill"},"path":"/en-us/mcp/skills/skills-library/advertiser-product-group-eligibility","content":[" What does this skill do? This skill guides agents through creating and querying advertiser product group eligibility requests for ad product groups like Amazon DSP (ADSP). It covers the request lifecycle from submission through approval or rejection, including duplicate prevention and rejection reason handling.\n"," When to read this skill: Read this skill when your agent needs to check whether an advertiser has applied for ADSP access, submit a new eligibility request, or understand why a previous request was rejected.\n"],"documentType":"guide"},{"title":"AMC Workflows Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/amc-workflows","content":[],"documentType":"guide"},{"title":"AMC Workflows Skill","sectionHeader":{"type":2,"text":"AMC Workflows Skill"},"path":"/en-us/mcp/skills/skills-library/amc-workflows","content":[" What does this skill do?\n"," The AMC workflow management service provides you the ability to create, store, and execute parameterized workflows. This skill helps agents use the amc-get_workflows tool to discover, run, monitor, and retrieve results from saved workflows in AMC. Learn more about AMC workflows. Note: This skill does not create new workflows. It can list and execute saved workflows in AMC accounts. \n"," When to read this skill: Your agent should read the AMC Workflow Skill before invoking any of the following tools:\n"],"documentType":"guide"},{"title":"Account Context Identifiers Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/account-context-identifiers","content":[],"documentType":"guide"},{"title":"Account Context Identifiers Skill","sectionHeader":{"type":2,"text":"Account Context Identifiers Skill"},"path":"/en-us/mcp/skills/skills-library/account-context-identifiers","content":[" What does this skill do? This skill maps every Amazon Ads API tool to the correct account identifier it requires—profileId, advertiserAccountId, or managerAccountId—and spells out which HTTP header carries each one. It also flags common mix-ups, like accidentally passing an Entity ID or Profile ID where an advertiserAccountId (the amzn1.ads-account.g.… string) is expected.\n"],"documentType":"guide"},{"title":"Create DSP P+/B+ Campaign Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/create-dsp-pb-campaign","content":[],"documentType":"guide"},{"title":"Create DSP P+/B+ Campaign Skill","sectionHeader":{"type":2,"text":"Create DSP P+/B+ Campaign Skill"},"path":"/en-us/mcp/skills/skills-library/create-dsp-pb-campaign","content":[" What does this skill do? This workflow skill lets you create and launch a DSP Performance+ (P+) or Brand+ (B+) campaign through a single conversational request. It handles the full setup — from configuring your campaign budget and schedule, to linking your ASINs for conversion tracking, to creating ad groups for each eligible tactic and inventory type. Once everything is in place, it activates the campaign so it is ready to deliver. The skill supports P+ tactics such as customer acquisition, remarketing, retention, and maximize performance, as well as B+ prospecting, across inventory types including display, online video, and streaming TV.\n"," When to read this skill: Your agent should read the Create DSP P+/B+ Campaign Skill before creating or launching a DSP Performance+ (P+) or Brand+ (B+) campaign.\n"," Example prompt: \"Create a DSP P+ campaign for my products (ASINs B0EXAMPLE1 and B0EXAMPLE2) in the US with a $500 budget, starting tomorrow, targeting DISPLAY inventory.\"\n"," The P+/B+ Skill guides the agent to call the appropriate MCP tools for executing the workflow below:\n"],"documentType":"guide"},{"title":"Manager Accounts Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/manager-accounts","content":[],"documentType":"guide"},{"title":"Manager Accounts Skill","sectionHeader":{"type":2,"text":"Manager Accounts Skill"},"path":"/en-us/mcp/skills/skills-library/manager-accounts","content":[" What does this skill do? This skill guides agents through creating manager accounts and managing their linked advertiser accounts. It covers account types (Advertiser vs. Agency), role assignments, batch linking and unlinking, and nested manager account hierarchies.\n"," When to read this skill: Read this skill when your agent needs to create a new manager account, link or unlink advertiser accounts to a manager, or query existing manager account relationships.\n"],"documentType":"guide"},{"title":"Product Eligibility Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/product-eligibility","content":[],"documentType":"guide"},{"title":"Product Eligibility Skill","sectionHeader":{"type":2,"text":"Product Eligibility Skill"},"path":"/en-us/mcp/skills/skills-library/product-eligibility","content":[" What does this skill do? This skill lets agents check per-ASIN advertising eligibility for a given ad type (Sponsored Products, Sponsored Brands, Sponsored Display, or DSP). It answers the question \"Can these specific products be advertised?\" and surfaces reason codes for ineligible products such as out-of-stock, restricted category, or policy violations.\n"," When to read this skill: Read this skill when your agent needs to verify whether specific ASINs can be advertised before creating campaigns or ad groups targeting those products.\n"],"documentType":"guide"},{"title":"Program Eligibility Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/program-eligibility","content":[],"documentType":"guide"},{"title":"Program Eligibility Skill","sectionHeader":{"type":2,"text":"Program Eligibility Skill"},"path":"/en-us/mcp/skills/skills-library/program-eligibility","content":[" What does this skill do? This skill lets agents check whether an advertiser is eligible for Amazon Ads programs including Sponsored Products, Sponsored Brands, Sponsored Display, DSP, Sponsored TV, MAAS, DTC, RMS, and RAS. It surfaces ineligibility reason codes such as missing payment methods, vetting failures, or account suspensions so the agent can guide the advertiser toward resolution.\n"," When to read this skill: Read this skill when your agent needs to determine which advertising programs an account qualifies for, or to diagnose why an advertiser cannot access a specific program.\n"],"documentType":"guide"},{"title":"Terms Token Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/terms-token","content":[],"documentType":"guide"},{"title":"Terms Token Skill","sectionHeader":{"type":2,"text":"Terms Token Skill"},"path":"/en-us/mcp/skills/skills-library/terms-token","content":[" What does this skill do? This skill guides agents through the advertising terms-of-service acceptance workflow required before the first account of an advertiser can be registered. It handles token creation, user acceptance tracking, and token status polling. Tokens expire 48 hours after creation and are consumed during account registration.\n"," When to read this skill: Read this skill when your agent needs to onboard a new advertiser, initiate terms acceptance before account creation, or check whether a user has already accepted the advertising terms.\n"],"documentType":"guide"},{"title":"User Invitations Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/user-invitations","content":[],"documentType":"guide"},{"title":"User Invitations Skill","sectionHeader":{"type":2,"text":"User Invitations Skill"},"path":"/en-us/mcp/skills/skills-library/user-invitations","content":[" What does this skill do? This skill guides agents through the full user invitation lifecycle on advertising accounts. It covers creating invitations with specified permissions, listing pending invitations, checking invitation status, revoking or resending invitations, and redeeming invitations. Invitations are scoped to a single account per request.\n"," When to read this skill: Read this skill when your agent needs to invite users to an advertising account, check the status of pending invitations, revoke access, or help a user accept an invitation.\n"],"documentType":"guide"},{"title":"User Permissions Skill","sectionHeader":null,"path":"/en-us/mcp/skills/skills-library/user-permissions","content":[],"documentType":"guide"},{"title":"User Permissions Skill","sectionHeader":{"type":2,"text":"User Permissions Skill"},"path":"/en-us/mcp/skills/skills-library/user-permissions","content":[" What does this skill do? This skill guides agents through managing user access on advertising accounts. It covers listing users with account access, viewing and updating granular permissions, checking role assignments (Admin, Editor, Viewer), and removing user access. Permissions can be scoped by resource type, access level, and country.\n"," When to read this skill: Read this skill when your agent needs to list who has access to an account, check or modify the permissions of a user, assign roles, or remove a user from an advertising account.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Inventory API","sectionHeader":null,"path":"/en-us/guides/deal-management/overview","content":[" The Amazon Ads Inventory API allows you to create, update, and manage advertising deals within ADSP, including associating deals with seats, labels, and inventory groups. It also supports managing proposals and commitments. The ADSP platform uses the exchangeID and the exchangeDealId to identify the deal during ad placement; the exchangeDealId is the deal ID provided by an exchange/SSP, visible in the ADSP UI, and used by exchanges/SSPs when communicating with advertisers. The inventory API also generates an internal advertisingDealId, distinct from the exchangeDealId, that must be used to manage the deals within ADSP.  The Proposal Management APIs provide functionality to negotiate and execute deals with various SSPs through a structured proposal workflow.  The Commitment Management API enables buyers to create and manage spending commitments tied to deals on Amazon DSP.\n"," The API currently covers the following entities:\n","| Entity | API Specification |\n","\\| -----------  \\| ------------ \\|\n","| AdvertisingDeal | Advertising Deal API Specification |\n","| BuyerSeats | Buyer Seat API Specification |\n","| DealAdvertiserAccess  | DealAdvertiserAccess API Specification |\n","| DealAdvertiserAccessEntry | DealAdvertiserAccessEntry API Specification |\n","| DealAvails | DealAvails API Specification |\n","| DealPerformance | DealPerformance API Specification |\n","| DealPlanningMetrics | DealPlanningMetrics API Specification |\n","| InventoryGroup | InventoryGroup API Specification |\n","| Label | Label API Specification |\n","| Supplier | Supplier API Specification |\n","| SupplierAdProduct | SupplierAdProduct API Specification |\n","| SupplierAdProductPrice | SupplierAdProductPrice API Specification |\n","| SupplierProposal | SupplierProposal API Specification |\n","| SupplierProposedDeal | SupplierProposedDeal API Specification |\n","| SupplierProposedDealForecast | SupplierProposedDealForecast API Specification |\n","| SupplierProposedDealHistoricalVersion | SupplierProposedDealHistoricalVersion API Specification |\n","| SupplierProposedDealRevision | SupplierProposedDealRevision API Specification |\n","| SupplierProposalDestination | SupplierProposalDestination API Specification |\n","| SupplierPublisher | SupplierPublisher API Specification |\n","| SupplierTargetItem | SupplierTargetItem API Specification |\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Inventory API","sectionHeader":{"type":2,"text":"Before you begin"},"path":"/en-us/guides/deal-management/overview","content":[" Complete the Amazon Ads API Onboarding and Getting started processes to obtain your client ID and access token. You will need these to make all the calls referenced in this tutorial.\n"," Be sure to also note the values for Content-Type in the example requests.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Inventory API","sectionHeader":{"type":2,"text":"Creating and using deal objects"},"path":"/en-us/guides/deal-management/overview","content":[" There are three high-level steps in creating and using a deals object in ADSP using the Amazon Ads API:\n","Retrieve the profile ID of the profile you want to create the deal object for. A profile ID in the Amazon Ads API corresponds to accounts in the Amazon Ads console. 2. Create and manage a deal object. 3. Associate the deal object with an ad group.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Inventory API","sectionHeader":{"type":2,"text":"Creating and using proposal objects"},"path":"/en-us/guides/deal-management/overview","content":[" The Amazon DSP Deal Proposals API is specifically for creating and managing deals with Amazon Publisher Direct (APD), Amazon Publisher Cloud (APC) and with Amazon Owned & Operated publishers (Prime Video and Twitch).\n"," To negotiate a proposal with APD/APC and Amazon Owned & Operated publishers and get an approved deal, the following steps are involved:\n","Retrieve the profile ID of the profile you want to create the deal object for. A profile ID in the Amazon Ads API corresponds to accounts in the Amazon Ads console. 2. Create and manage a proposal object. You can negotiate the proposal with APC/APD and Amazon Owned & Operated publishers. After a proposal is approved, the user gets a deal object. 3. Associate the deal object with an ad group.\n"],"documentType":"guide"},{"title":"Getting started with the Amazon DSP Inventory API","sectionHeader":{"type":2,"text":"Retrieve a profile ID"},"path":"/en-us/guides/deal-management/overview","content":[" Profiles in the Amazon Ads API represent the account of an advertiser in a specific marketplace. A profile ID is required for requests to the deals API. The list of profile IDs can be retrieved using GET /v2/profiles. Once you identify the profile you want to use, you will provide the profileId value as the Amazon-Advertising-API-Scope header in subsequent calls to the deals API.\n"," The following call will retrieve a list of all accounts in the region associated with the user account that provided the access token:\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" An AdvertisingDeal represents a deal between an advertiser and an Amazon Ads offering. Deals allow advertisers to negotiate specific terms for ad inventory, including pricing, placement, and delivery guarantees. The Amazon DSP platform uses the exchangeId and exchangeDealId to identify the deal during ad placement, while the API generates an internal advertisingDealId for managing deals within Amazon DSP.\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"AdvertisingDeal parameters"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| advertisingDealId | A unique identifier generated by ADSP for a deal. This is not the same as the identifier provided by an exchange/SSP for a deal. | □ |\n","| exchangeDealId | An identifier provided by an exchange/SSP for a deal. This is the deal ID visible in the ADSP UI and used by exchanges/SSPs when communicating with advertisers. | ○ |\n","| exchangeId | The exchange/SSP that provides the deal. | ○ |\n","| dealType | The type of the deal such as share of voice. | ✓ |\n","| dealTargetType | The target type of the deal such as branded keyword. | ○ |\n","| name | The name of the deal. | ✓ |\n","| replacingDealId | The ID of an advertising deal that this deal intends to replace. | ○ |\n","| adProduct | The ad product associated with the deal. | ✓ |\n","| state | User intended state of the deal. Set to DRAFT during creation if empty. | ○ |\n","| startDateTime | The start date time for the deal. | ✓ |\n","| endDateTime | The end date time for the deal. | ✓ |\n","| price | Overall price of the advertising deal. | ◐ |\n","| status | Actual status of the deal after processing/moderation. | □ |\n","| customPublisherDescription | Custom description of the publisher providing inventory for this deal. | ○ |\n","| supplyInventoryTypes | The inventory type of the deal declared by the supplier. Use this field to find deals compatible with an ad group. For a DISPLAY ad group, query deals with supplyInventoryType DISPLAY. For a STREAMING_TV or ONLINE_VIDEO ad group, query deals with supplyInventoryType VIDEO. For an AUDIO or PODCAST ad group, query deals with supplyInventoryType AUDIO. Deals with an empty supplyInventoryTypes list have no inventory type restriction. Valid values: DISPLAY, VIDEO, AUDIO. | ○ |\n","| deviceType | The device type that the deal is expected to deliver. Constrains what device types can be used when targeting this deal. | ○ |\n","| countryCode | The country code associated with the deal. | ○ |\n","| moderationRejectionReason | The reason for moderation rejection. | □ |\n","| creationDateTime | The date time that the deal was created. | □ |\n","| lastUpdatedDateTime | The date time that the deal was last updated. | □ |\n","| placements | The placement for the deal such as TOP_OF_SEARCH. | ○ |\n","| creativeRequirements | Creative requirements associated with the deal. | ◐ |\n","| terms | Terms for the deal including pricing, guarantees, and budget. | ◐ |\n","| supplyMetadata | Live-events supply classification for the deal, such as the sports, leagues, and broadcasters that a certified live-sports deal covers. | ◐ |\n","| supplierProposedDealId | The proposed deal associated with this advertising deal. | ○ |\n","| startDateTimeRange | A date-time range filter for the deal start date. Used to query deals whose startDateTime falls within the specified range. | ○ |\n","| endDateTimeRange | A date-time range filter for the deal end date. Used to query deals whose endDateTime falls within the specified range. | ○ |\n","| creationDateTimeRange | A date-time range filter for the deal creation date. Used to query deals whose creationDateTime falls within the specified range. | ○ |\n","| priceRange | A price range filter for the deal price. Used to query deals whose price value falls within the specified range for the given currency. | ○ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealPrice"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| currencyCode | The currency code associated with the price. Computed based on the default currency of the marketplace. | ✓ |\n","| value | The monetary amount of the price in the given currency. | ✓ |\n","| priceType | The type of the price. | ✓ |\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| FLAT_FEE | Deprecated. Use FIXED_PRICE instead. |\n","| FIXED_PRICE | Sale price for a specific ad placement regardless of auction performance. |\n","| FIXED_CPM | Fixed cost per thousand impressions. Buyer pays this exact CPM for every impression won. Used for PREFERRED and PROGRAMMATIC_GUARANTEED deals. |\n","| FLOOR_RATE | Minimum bid price for auction. Buyer must bid at or above this floor to compete. Used for PRIVATE_AUCTION deals. |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealStatus"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| status | Status of the deal. | ✓ |\n","| statusReason | A human readable string explaining the status reason. | ○ |\n","| statusDateTime | Timestamp when the deal entered this status. | ○ |\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| DRAFT | The deal has not been submitted yet. |\n","| PROPOSED | The deal has been submitted for moderation. |\n","| MODERATION_REJECTED | The deal is rejected during moderation process due to policy violation. |\n","| MODERATION_APPROVED | The deal has passed moderation. |\n","| ACCEPTED | The deal is accepted by the advertiser. |\n","| ADVERTISER_REJECTED | The deal is rejected by the advertiser. |\n","| ACTIVE | Deal is ready to serve from SSP perspective. SSP will send bid requests for this deal. |\n","| PAUSED | Deal is temporarily paused from SSP perspective. SSP will not send bid requests for this deal. |\n","| SCHEDULED | Deal is approved and scheduled but has not yet reached its start date. |\n","| ENDED | Deal has passed its end date and is no longer active. |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"CreativeRequirements"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| preApprovalPermission | Indicates whether creative requires pre-approval from exchange/SSP. Values: REQUIRED, ALLOWED, NOT_ALLOWED. | ○ |\n","| clearanceLevel | Indicates whether creative approval is mandatory before deal goes live. Values: RESTRICTIVE, PERMISSIVE. | ○ |\n","| creativeSource | Indicates who hosts and serves the creative for this deal. PUBLISHER means the creative is hosted by the publisher's ad server. ADVERTISER means the creative is provided by the demand side. Values: PUBLISHER, ADVERTISER. | ○ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealTerms"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| price | The price structure for the deal including currency, amount, and price type. | ✓ |\n","| guaranteed | If true, deal is a Programmatic Guaranteed deal. | ✓ |\n","| marketplaceDeal | If true, deal is available to all Amazon DSP entities globally. Marketplace deals cannot be edited by individual buyers. | ✓ |\n","| impressions | The number of impressions for the deal. Required for guaranteed deals. For non-guaranteed deals, indicates expected impressions as guidance. | ○ |\n","| shareOfVoicePercentage | Guaranteed share-of-voice percentage. Used for SOV-based PG deals. Value must be > 0 and &lt;= 100. Mutually exclusive with budget. | ○ |\n","| budget | Target spend of the advertising deal. Applicable to PG deals. | ○ |\n","| forecast | Forecasting for the deal. | ◐ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealForecast"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| estimatedImpressions | Estimated total impressions that can be expected for the deal. | ◐ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"SupplyMetadata"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Supply-specific metadata for the deal, categorized by supply type. One category is populated, identifying the type of supply the deal covers. Live-sports deals populate sportsMetadata.\n"," Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| sportsMetadata | Live-sports classification for the deal, including its sports, leagues, and broadcasters. Populated for certified live-sports deals. | ◐ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"SportsMetadata"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":[" Live-sports classification for the deal. Each field is a list of IDs from the corresponding Amazon Ads Live-Events taxonomy. IDs are scoped to their own taxonomy and are not comparable across fields.\n"," Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| sports | IDs of the sports associated with the deal, such as American Football. | ○ |\n","| leagues | IDs of the leagues associated with the deal, such as the National Football League. | ○ |\n","| broadcasters | IDs of the broadcasters associated with the deal. | ○ |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealType values"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| SHARE_OF_VOICE | Share of voice deal. |\n","| PREFERRED | Preferred deal. |\n","| PROGRAMMATIC_GUARANTEED | Programmatic guaranteed deal. |\n","| PRIVATE_AUCTION | Private auction deal. |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealState values"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| DRAFT | The deal is in draft state and has not been proposed. |\n","| PROPOSED | The deal has been proposed. |\n","| ACCEPTED | The deal has been accepted. |\n","| REJECTED | The deal has been rejected. |\n"],"documentType":"guide"},{"title":"The AdvertisingDeal entity in the Amazon Ads API","sectionHeader":{"type":3,"text":"AdvertisingDealTargetType values"},"path":"/en-us/guides/deal-management/entities/advertising-deal","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| BRANDED_KEYWORD | Deal targets branded keywords. |\n","| UNBRANDED_KEYWORD | Deal targets unbranded keywords. |\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[" A BuyerSeat is an identifier exchanged between Supply-Side Platforms (SSPs) and the Amazon DSP in programmatic advertising. Buyer seats are used for deal eligibility (SSPs include allowed seats in bid requests), spend tracking (included in bid responses), and deal discovery (associating deals with specific buyers).\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":2,"text":"Buyer Seat parameters"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| buyerSeatId | Unique identifier for the buyer seat. Server-generated with format prefix indicating account level (AMZA for advertiser, AMZN for manager account, AMZG for group). | □ |\n","| adProduct | The ad product associated with this buyer seat. | ○ |\n","| seatType | The type of the buyer seat, indicating its purpose in the programmatic transaction. | ✓ |\n","| exchangeId | The exchange/SSP that this seat applies to. | ○ |\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":2,"text":"Supported operations"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":3,"text":"Create Buyer Seats"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[" Creates buyer seats for an advertiser. Requires exactly 2 items in the request (one DEAL_CREATION and one SPEND_TRACKING).\n","Endpoint: POST /adsApi/v1/create/buyerSeats/dsp - Required header: Amazon-Ads-AccountId - Idempotent: If seats already exist for the advertiser, returns existing seat IDs as success.\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":3,"text":"List Buyer Seats"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[" Lists buyer seats resolved per exchange, including parent seats from the account hierarchy.\n","Endpoint: GET /adsApi/v1/buyerSeats/dsp - Required header: Amazon-Ads-AccountId or Amazon-Ads-Manager-AccountId - Filters: buyerSeatType (max 3), exchangeId (max 100) - Pagination: Default 50, max 200 results per page\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":3,"text":"BuyerSeatType values"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| DEAL_CREATION | Identifier shared with publishers/SSPs when setting up deals. Used to allowlist which buyers can bid on a deal. |\n","| SPEND_TRACKING | Identifier included in bid responses for buyer recognition and spend tracking by exchanges. |\n","| BID_TIME | Identifier used to recognize the buyer seat at bid time. |\n"],"documentType":"guide"},{"title":"BuyerSeat","sectionHeader":{"type":3,"text":"Seat hierarchy"},"path":"/en-us/guides/deal-management/entities/buyer-seat","content":[" Buyer seats exist at multiple account levels. When listing seats, all applicable tiers are returned per exchange:\n","| Level | ID prefix | Description |\n","\\| --- \\| --- \\| --- \\|\n","| Advertiser | AMZA | Seats specific to a single advertiser. Created via the Create API. The full seat ID follows the format AMZA + unique identifier (for example, AMZAK6ZZGGQRHGN5). |\n","| Manager Account | AMZN | Seats shared by all advertisers under a manager account. Auto-generated when the first advertiser is created. Format: AMZN + unique identifier. |\n","| Group | AMZG | Seats shared across multiple manager accounts in a holding company group. Format: AMZG + unique identifier. |\n"],"documentType":"guide"},{"title":"Commitment","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/commitment","content":[" A Commitment represents a spending agreement between an advertiser and Amazon Ads. Commitments define a total committed spend over a specified time period and can be scoped to specific advertisers, campaigns, or deals. The fulfillment level determines how aggressively the system prioritizes meeting the commitment target, while the spend calculation mode controls the aggregation level for tracking progress.\n"],"documentType":"guide"},{"title":"Commitment","sectionHeader":{"type":2,"text":"Commitment parameters"},"path":"/en-us/guides/deal-management/entities/commitment","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| commitmentId | A unique identifier for the commitment. | □ |\n","| commitmentName | The name of the commitment. | ✓ |\n","| adProduct | The ad product associated with this commitment. | ○ |\n","| currencyCode | The currency code associated with the commitment. | ✓ |\n","| committedSpend | The total committed spend for the commitment. | ✓ |\n","| startDateTime | The start date and time of the commitment. | ✓ |\n","| endDateTime | The end date and time of the commitment. | ✓ |\n","| fulfillmentLevel | The fulfillment level of the commitment. | ✓ |\n","| spendCalculationMode | The spend calculation mode of a commitment. | ✓ |\n","| advertiserIds | Advertiser IDs associated with the commitment. Maximum 1000 entries. | ○ |\n","| advertiserIdExclusions | Advertiser IDs excluded from the commitment. Maximum 1000 entries. | ○ |\n","| campaignIds | Campaign IDs associated with the commitment. Maximum 1000 entries. | ○ |\n","| campaignIdExclusions | Campaign IDs excluded from the commitment. Maximum 1000 entries. | ○ |\n","| dealIds | Deal IDs associated with the commitment. Maximum 1000 entries. | ○ |\n","| dealIdExclusions | Deal IDs excluded from the commitment. Maximum 1000 entries. | ○ |\n"],"documentType":"guide"},{"title":"Commitment","sectionHeader":{"type":2,"text":"Enumerations"},"path":"/en-us/guides/deal-management/entities/commitment","content":[],"documentType":"guide"},{"title":"Commitment","sectionHeader":{"type":3,"text":"FulfillmentLevel values"},"path":"/en-us/guides/deal-management/entities/commitment","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| LEVEL_0 | Tracking-only commitments. |\n","| LEVEL_5 | Prioritize commitment over campaign performance. |\n"],"documentType":"guide"},{"title":"Commitment","sectionHeader":{"type":3,"text":"SpendCalculationMode values"},"path":"/en-us/guides/deal-management/entities/commitment","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| MANAGER_ACCOUNT | Spend is aggregated at the manager account level. |\n","| ADVERTISER_ACCOUNT | Spend is aggregated at the advertiser account level. |\n","| CAMPAIGN | Spend is aggregated at the campaign level. |\n"],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[" CommitmentSpend provides spend tracking details for a commitment, broken down by a configurable dimension (advertiser, campaign, or deal). It reports accrued spend, spend at risk, and projected spend values, enabling advertisers to monitor their progress toward fulfilling a commitment.\n"],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":2,"text":"CommitmentSpend parameters"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| commitmentId | Identifier for the commitment spend record. | ✓ |\n","| adProduct | The ad product associated with this commitment spend. | ○ |\n","| spendDimensionType | Dimension level at which commitment spend is tracked. | ✓ |\n","| currencyCode | Currency code associated with the spend detail. | ✓ |\n","| accruedToDateTime | Timestamp for accrual spend. | ✓ |\n","| accruedSpendValue | Actual accrual spend amount in commitment currency. | ○ |\n","| spendAtRiskValue | Spend at risk amount in commitment currency. | ○ |\n","| projectedSpendValue | Projected spend amount in commitment currency. | ○ |\n"],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":3,"text":"CommitmentSpendIdentifier"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[" The composite identifier for a commitment spend record.\n"," Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| commitmentId | Commitment ID associated with the commitment. | ✓ |\n","| spendDimension | Identifiers for commitment spend detail. | ○ |\n"],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":3,"text":"SpendDimension"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[" A union type representing the dimension entity for which spend is tracked. Only one of the following fields is populated at a time.\n"," Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| advertiserAccountId | Identifier for an advertising account. | ○ |\n","| campaignId | Identifier for a campaign entity. | ○ |\n","| dealId | Identifier for a deal entity. | ○ |\n"],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":2,"text":"Enumerations"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":[],"documentType":"guide"},{"title":"CommitmentSpend","sectionHeader":{"type":3,"text":"SpendDimensionType values"},"path":"/en-us/guides/deal-management/entities/commitment-spend","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| COMMITMENT | Commitment level spend detail. |\n","| ADVERTISER | Advertiser level spend detail. |\n","| CAMPAIGN | Campaign level spend detail. |\n","| DEAL | Deal level spend detail. |\n"],"documentType":"guide"},{"title":"DealAdvertiserAccess","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/deal-advertiser-access","content":[" DealAdvertiserAccess controls which Amazon DSP advertisers can target a deal. Uses a strategy-based approach where ALLOW means only listed advertisers can target, and BLOCK means listed advertisers cannot target.\n"],"documentType":"guide"},{"title":"DealAdvertiserAccess","sectionHeader":{"type":2,"text":"DealAdvertiserAccess parameters"},"path":"/en-us/guides/deal-management/entities/deal-advertiser-access","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealAdvertiserAccessId | A unique identifier for the access record. | □ |\n","| adProduct | The ad product associated with this access record. | ○ |\n","| advertisingDealId | Reference to the associated advertising deal. | ✓ |\n","| strategy | The access strategy. ALLOW means advertisers in the list can target this deal (allowed list). BLOCK means advertisers in the list cannot target this deal (blocked list). | ✓ |\n","| createdDateTime | Timestamp when the access record was first created. | ○ |\n","| lastUpdatedDateTime | Timestamp when the access record was last modified. | ○ |\n"],"documentType":"guide"},{"title":"DealAdvertiserAccess","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/deal-advertiser-access","content":[],"documentType":"guide"},{"title":"DealAdvertiserAccess","sectionHeader":{"type":3,"text":"AdvertiserAccessStrategy values"},"path":"/en-us/guides/deal-management/entities/deal-advertiser-access","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| ALLOW | Advertisers in the list CAN target this deal. All other advertisers are blocked. |\n","| BLOCK | Advertisers in the list CANNOT target this deal. All other advertisers are allowed. |\n"],"documentType":"guide"},{"title":"DealAdvertiserAccessEntry","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/deal-advertiser-access-entry","content":[" A DealAdvertiserAccessEntry is an individual advertiser entry in the access list of a deal. Supports pagination over large advertiser lists.\n"],"documentType":"guide"},{"title":"DealAdvertiserAccessEntry","sectionHeader":{"type":2,"text":"DealAdvertiserAccessEntry parameters"},"path":"/en-us/guides/deal-management/entities/deal-advertiser-access-entry","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealAdvertiserAccessEntryId | A unique identifier for this access entry. | □ |\n","| adProduct | The ad product associated with this access entry. | ○ |\n","| dealAdvertiserAccessId | Reference to the associated deal advertiser access record. | ✓ |\n","| advertiserId | Reference to the advertiser granted or denied access. | ✓ |\n"],"documentType":"guide"},{"title":"DealAvails","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/deal-avails","content":[" DealAvails provides bid opportunity counts for an advertising deal over the last 7 days, aggregated by selected attributes. An optional targeting expression filters the eligible avails count.\n"],"documentType":"guide"},{"title":"DealAvails","sectionHeader":{"type":2,"text":"DealAvails parameters"},"path":"/en-us/guides/deal-management/entities/deal-avails","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealAvailsId | A unique identifier for the deal avails record. | □ |\n","| advertisingDealId | The advertising deal this avails record belongs to. | ✓ |\n","| inventoryType | Inventory type attribute. Null when not sliced by inventory type. | ○ |\n","| creativeSize | Creative size attribute (width x height in DIPS). | ○ |\n","| supplierSellerId | The supplier seller associated with this avails record. | ○ |\n","| audienceId | Audience segment for this avails slice. | ○ |\n","| appId | App for this avails slice. | ○ |\n","| domainEntry | Domain for this avails slice. | ○ |\n","| deviceType | Device type for this avails slice. | ○ |\n","| countryCode | Country code (ISO 3166-1 alpha-2) for this avails slice. | ○ |\n","| groupByAttributes | Attributes to break results down by. When empty or omitted, results are aggregated to one entry per deal. | ○ |\n","| eligibleAvailsTargeting | Optional targeting filter for the eligibleAvails count. Does not affect totalAvails or which attribute rows are returned. | ◐ |\n","| totalAvails | Total bid opportunities over the last 7 days for this deal, including bids, no-bids, and punts. Not filtered by the EligibleAvailsTargeting. | □ |\n","| eligibleAvails | Bid opportunities over the last 7 days eligible for bidding (bids and no-bids, excluding punts). Filtered by the EligibleAvailsTargeting when provided. | □ |\n"],"documentType":"guide"},{"title":"DealAvails","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/deal-avails","content":[],"documentType":"guide"},{"title":"DealAvails","sectionHeader":{"type":3,"text":"EligibleAvailsTargeting"},"path":"/en-us/guides/deal-management/entities/deal-avails","content":[" Targeting that filters eligible avails. All targeting dimensions are AND'd together. Within a dimension, entries are composed via groupId. The combined total of entries across all targeting dimensions must not exceed 1000.\n"," Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| audienceTargetingEntries | Audience targeting entries. Entries are grouped by groupId. Within a group, audiences are OR'd (union). Across included groups, groups are AND'd (intersection). | ◐ |\n","| locationTargetingEntries | Location targeting entries. | ◐ |\n","| deviceTypeTargetingEntries | Device type targeting entries. | ◐ |\n","| appTargetingEntries | App targeting entries. | ◐ |\n","| domainTargetingEntries | Domain targeting entries. | ◐ |\n","| inventoryTypeTargetingEntries | Inventory type targeting entries. | ◐ |\n","| creativeSizeTargetingEntries | Creative size targeting entries. | ◐ |\n","| supplierSellerTargetingEntries | Supplier seller targeting entries. | ◐ |\n"," Each targeting entry structure contains the following common fields:\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| (target reference) | The target to include or exclude (audience, location, device type, etc.). | ✓ |\n","| groupId | Identifies the group this entry belongs to. Entries sharing the same groupId are OR'd together. | ✓ |\n","| negative | When true, this entry belongs to a negative (exclusion) group. Defaults to false when omitted. | ○ |\n"],"documentType":"guide"},{"title":"DealPerformance","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/deal-performance","content":[" DealPerformance provides performance metrics for a deal, including bid activity, spend, impressions, and engagement metrics.\n"],"documentType":"guide"},{"title":"DealPerformance","sectionHeader":{"type":2,"text":"DealPerformance parameters"},"path":"/en-us/guides/deal-management/entities/deal-performance","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealPerformanceId | A unique identifier for the performance record. | □ |\n","| advertisingDealId | Reference to the associated advertising deal. | ✓ |\n","| bidRequests | The volume of bids with this deal ID that are eligible for the Amazon DSP. | ○ |\n","| bidResponses | The number of bid responses sent back to SSP or publisher for the applicable deal ID. | ○ |\n","| recognizedBids | The number of bid requests which include a recognized deal ID. | ○ |\n","| availsTotal | The total number of impression opportunities. | ○ |\n","| availsByDeviceType | A list of avails broken down by device type. | ◐ |\n","| totalSpend | The total amount spent on the deal over the period of time specified. | ○ |\n","| averageCpm | Historical cost per thousand impressions over the period of time specified. | ○ |\n","| totalImpressions | The number of times an advertisement was displayed. | ○ |\n","| viewableImpressions | The number of impressions that were viewable. | ○ |\n","| measurableImpressions | The number of impressions that were measurable. | ○ |\n","| completionCount | The number of times a video or audio ad is completed. | ○ |\n","| clickthroughCount | The number of times an ad is clicked. | ○ |\n","| conversionCount | The number of times an impression resulted in an action. | ○ |\n"],"documentType":"guide"},{"title":"DealPerformance","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/deal-performance","content":[],"documentType":"guide"},{"title":"DealPerformance","sectionHeader":{"type":3,"text":"AvailsForDeviceType"},"path":"/en-us/guides/deal-management/entities/deal-performance","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| deviceType | The device type. | ✓ |\n","| impressionOpportunities | The number of impression opportunities per day per device. | ✓ |\n"],"documentType":"guide"},{"title":"DealPlanningMetrics","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/deal-planning-metrics","content":[" DealPlanningMetrics provides planning metrics for a deal, including viewability rates, video completion rates, and cost metrics.\n"],"documentType":"guide"},{"title":"DealPlanningMetrics","sectionHeader":{"type":2,"text":"DealPlanningMetrics parameters"},"path":"/en-us/guides/deal-management/entities/deal-planning-metrics","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealPlanningMetricsId | A unique identifier for the planning metrics record. | □ |\n","| advertisingDealId | Reference to the associated advertising deal. | ✓ |\n","| viewRate | Rate of ad impressions that were measured as viewable. | ○ |\n","| measuredRate | Rate of impressions that were measurable for viewability. | ○ |\n","| videoCompletionRate | Rate of video ad views that were viewed to completion. | ○ |\n","| clickThroughRate | Rate of delivered ad impressions that users clicked on. | ○ |\n","| effectiveCPM | Effective CPM actually cleared for impressions. | ○ |\n","| viewableCPM | Average CPM actually cleared for impressions that were deemed in view. | ○ |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/inventory-group","content":[" An Inventory Group is a grouping of advertising deals that can be applied to ad groups for campaign targeting. Represents a curated collection of programmatic deals bundled together to simplify deal management and targeting.\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":2,"text":"Inventory Group parameters"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| inventoryGroupId | Unique identifier for the inventory group. | □ |\n","| name | The name of the inventory group. | ✓ |\n","| description | Optional description of the inventory group. Provides additional context about the deals included and intended use. | ○ |\n","| inventoryType | The type of inventory/media in this group. Determines what creative formats can be used when targeting this inventory group. | ✓ |\n","| curationSourceType | The type of curation source for this inventory group. Indicates how the inventory group was created and by whom. Defaults to ADVERTISER_CURATED if not provided and is immutable. | ○ |\n","| curationSourceSettings | Configuration settings specific to the curation source type. When curationSourceType is AMAZON_CURATED_AGENT, the AutomaticDealSelectionControls variant is used to define deal eligibility preferences. | ○ |\n","| adProduct | The ad product this inventory group is associated with. | ○ |\n","| advertisingDealIds | Collection of advertising deal IDs included in this inventory group. | ○ |\n","| createdByAccountId | The account that created this inventory group. | ○ |\n","| createdInRegion | The region where this inventory group was created. | ○ |\n","| creationDateTime | The date and time the inventory group was created. | □ |\n","| lastUpdatedDateTime | The date and time the inventory group was last updated. | □ |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":[],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":3,"text":"CurationSourceType values"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| AMAZON_CURATED_AGENT | Inventory group was created or recommended through the Automatic Deal Selection system, which uses machine learning to identify optimal deal combinations. |\n","| AMAZON_CURATED | Inventory group was manually curated by Amazon. |\n","| ADVERTISER_CURATED | Inventory group was manually curated by the advertiser or agency. |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":3,"text":"CurationSourceSettings"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":[" A union type containing configuration settings specific to a curation source type. Each variant contains settings applicable to a particular curation mode. Currently, only inventory groups with curationSourceType of AMAZON_CURATED_AGENT support these settings.\n","| Variant | Description |\n","\\| --- \\| --- \\|\n","| AutomaticDealSelectionControls | Advertiser-configured preferences that constrain which deals the automated recommendation system can recommend. |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":3,"text":"AutomaticDealSelectionControls"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":[" Advertiser-configured preferences that constrain which deals the automated recommendation system can recommend. These preferences filter the candidate deal pool before recommendations are generated.\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| adGroupId | The ad group associated with these automatic deal selection controls. | ✓ |\n","| dealTypePreference | Preference controlling which types of deals are eligible for automated recommendations based on their marketplace listing status. When not set, all deal types are eligible. | ○ |\n","| supplyAllowlist | Configuration for which supply sources (exchanges/SSPs) are permitted when generating deal recommendations. When not set, all supply sources are permitted. | ○ |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":3,"text":"DealTypePreference values"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":["| Value | Description |\n","\\| --- \\| --- \\|\n","| ALL | All deal types are eligible regardless of marketplace listing status. |\n","| EXCLUDE_PUBLICLY_AVAILABLE | Only private deals are eligible. Publicly available deals are excluded. |\n","| PUBLICLY_AVAILABLE_ONLY | Only publicly available deals are eligible. Private deals are excluded. |\n"],"documentType":"guide"},{"title":"Inventory Group","sectionHeader":{"type":3,"text":"SupplyAllowlist"},"path":"/en-us/guides/deal-management/entities/inventory-group","content":[" A union type defining which supply sources are permitted for deal recommendations.\n","| Variant | Description |\n","\\| --- \\| --- \\|\n","| CustomSources | Only the specified supply sources are permitted. Requires a list of supplySourceIds (1–1000). |\n","| AmazonOwnedAndOperated | Only deals from Amazon owned and operated supply sources are permitted. |\n","| OpenInternet | Only deals from open internet supply sources are permitted. |\n"],"documentType":"guide"},{"title":"Label","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/label","content":[" A Label is a user-defined tag for organizing and categorizing DSP objects such as deals and inventory groups. Labels are global - once created, they are visible across the account and can be applied to any supported object type.\n"],"documentType":"guide"},{"title":"Label","sectionHeader":{"type":2,"text":"Label parameters"},"path":"/en-us/guides/deal-management/entities/label","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| labelId | Unique identifier for the label. Server-generated with AMZNLBL prefix (e.g., AMZNLBL17F28BCKZST2KW58JG7). | □ |\n","| adProduct | The ad product associated with this label. | ○ |\n","| labelName | Display name of the label. Must be unique. Maximum 255 characters. | ✓ |\n","| state | The state of the label. Supported value: ENABLED. | ✓ |\n","| creationDateTime | The date and time the label was created. | □ |\n","| lastUpdatedDateTime | The date and time the label was last updated. | □ |\n"],"documentType":"guide"},{"title":"Label","sectionHeader":{"type":2,"text":"Supported operations"},"path":"/en-us/guides/deal-management/entities/label","content":[],"documentType":"guide"},{"title":"Label","sectionHeader":{"type":3,"text":"Query Labels"},"path":"/en-us/guides/deal-management/entities/label","content":[" Retrieve labels, filtered by the type of object they are associated with.\n","Endpoint: POST /adsApi/v1/query/labels/dsp - Required headers: Amazon-Ads-AccountId, Amazon-Ads-ClientId - Filters: - Filter priority: labelIdFilter > labelNameFilter > labelObjectTypeFilter (only one applied) - Pagination: maxResults (default 100, max 1000) + nextToken - Sort: Results are returned alphabetically by label name (case-insensitive)\n"],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/label-object-association","content":[" A Label Object Association links a label to an advertising object, enabling cross-entity organizational grouping. A single label can be associated with multiple objects across different object types, such as deals and inventory groups.\n"],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":{"type":2,"text":"Label Object Association parameters"},"path":"/en-us/guides/deal-management/entities/label-object-association","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| labelObjectAssociationId | Unique identifier for the label-to-object association. Maximum 255 characters. | □ |\n","| adProduct | The ad product associated with this label-object association. | ○ |\n","| labelId | The identifier of the label being associated with the object. | ✓ |\n","| labelObjectId | The identifier of the advertising object this label is applied to (e.g., a deal ID, ad group ID). | ✓ |\n","| labelObjectType | The type of advertising object this label is applied to. | ✓ |\n","| creationDateTime | The date and time the association was created. | □ |\n","| lastUpdatedDateTime | The date and time the association was last updated. | □ |\n"],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/label-object-association","content":[],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":{"type":3,"text":"LabelObjectType values"},"path":"/en-us/guides/deal-management/entities/label-object-association","content":[" The types of advertising objects that labels can be applied to.\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| AD_GROUP | An ad group within a campaign. |\n","| CAMPAIGN | A campaign managed through campaign management. |\n","| DEAL | An advertising deal in the deals domain. |\n","| INVENTORY_GROUP | An inventory group for supply management in the deals domain. |\n"],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":{"type":2,"text":"Supported operations"},"path":"/en-us/guides/deal-management/entities/label-object-association","content":[],"documentType":"guide"},{"title":"LabelObjectAssociation","sectionHeader":{"type":3,"text":"Query Label Object Associations"},"path":"/en-us/guides/deal-management/entities/label-object-association","content":[" Retrieve label-object associations, filtered by label or by the object they are associated with.\n","Endpoint: POST /adsApi/v1/query/labelObjectAssociations - Required headers: Amazon-Ads-AccountId, Amazon-Ads-ClientId - Filters: - Pagination: maxResults (default 100, max 5000) + nextToken\n"],"documentType":"guide"},{"title":"Publisher","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/publisher","content":[" A Publisher represents a business entity that owns and/or operates the apps, sites, or video streams where ads are displayed. Identified by domain or app_id from the bid request.\n"],"documentType":"guide"},{"title":"Publisher","sectionHeader":{"type":2,"text":"Publisher parameters"},"path":"/en-us/guides/deal-management/entities/publisher","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| publisherId | The unique identifier of the publisher (Long serialized as String). | □ |\n","| name | Normalized publisher name. NULL when isConfidential is true. | ○ |\n","| rootDomain | Root domain from ads.txt. PSL+1 root. NULL for app-only publishers. | ○ |\n","| publisherOwnerId | The identifier of the company that owns the content rights of this publisher. | ○ |\n","| isConfidential | Whether identity is confidential. | ○ |\n","| isActive | Whether this publisher is active. | ○ |\n","| adProduct | The ad product associated with this publisher. | ✓ |\n"],"documentType":"guide"},{"title":"Seller","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/seller","content":[" A Seller represents a business entity with rights to sell the inventory of a Publisher, holding accounts with Suppliers. Exchange-agnostic: same Seller record regardless of how many exchanges carry its inventory.\n"],"documentType":"guide"},{"title":"Seller","sectionHeader":{"type":2,"text":"Seller parameters"},"path":"/en-us/guides/deal-management/entities/seller","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| sellerId | The unique identifier of the seller (Long serialized as String). | □ |\n","| name | Display name. Normalized across all advertising systems. NULL when isConfidential is true. | ○ |\n","| sellerParentId | The identifier of the parent holding company that owns this seller. | ○ |\n","| isConfidential | Whether identity is confidential per IAB sellers.json. | ○ |\n","| isActive | Whether this seller is currently active. | ○ |\n","| adProduct | The ad product associated with this seller. | ✓ |\n"],"documentType":"guide"},{"title":"Supplier","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier","content":[" A Supplier represents an exchange or SSP that provides deal inventory to Amazon DSP.\n"],"documentType":"guide"},{"title":"Supplier","sectionHeader":{"type":2,"text":"Supplier parameters"},"path":"/en-us/guides/deal-management/entities/supplier","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierId | The unique identifier of the supplier (Long serialized as String). | □ |\n","| supplierName | Canonical display name of the Supplier. Normalized across systems. | ✓ |\n","| domain | Corporate SCO domain in sellers.json supply chain object (e.g., pubmatic.com). | ○ |\n","| brandId | The brand associated with this Supplier. | ○ |\n","| owner | Parent owner company name of the Supplier. Defaults to brand name if unspecified. | ○ |\n","| type | Classification of the integration type of the supplier. | ○ |\n","| integrationType | How the supplier connects to ADSP. | ○ |\n","| state | Lifecycle state of the supplier. | ○ |\n","| isActive | Whether this supplier is currently active. | ○ |\n","| mediaTypes | Media types supported (e.g., AUDIO, VIDEO, BANNER, NATIVE). | ○ |\n","| environments | Delivery environments supported (e.g., MOBILE_APP, WEB, CTV). | ○ |\n","| exchangeName | Legacy exchange identifier (e.g., RUBICON). | ○ |\n","| countries | ISO 3166-1 alpha-2 country codes where supplier operates. | ○ |\n","| previousSupplierId | If migrated from a previous supplier, references the previous Supplier entity. | ○ |\n","| extensions | Extended metadata as a JSON blob (e.g., exchange IDs, IAB identifiers). | ○ |\n","| description | Human-readable description of the supplier. | ○ |\n","| adProduct | The ad product associated with this supplier. | ✓ |\n"],"documentType":"guide"},{"title":"SupplierAdProduct","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-ad-product","content":[" A SupplierAdProduct represents a purchasable advertising product offered by a supplier, with associated constraints and configurations for deal creation.\n"],"documentType":"guide"},{"title":"SupplierAdProduct","sectionHeader":{"type":2,"text":"SupplierAdProduct parameters"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierAdProductId | The supplier ad product unique identifier. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| name | The name of the supplier ad product. | ✓ |\n","| supplierId | The supplier for this supplier ad product. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination for this supplier ad product. | ○ |\n","| supplierPublisherId | Unique publisher id. | ○ |\n","| dealType | The deal type for this supplier ad product. | ✓ |\n","| priceType | The price type for this supplier ad product. | ○ |\n","| creativeRequirements | Creative requirements for this supplier ad product. | ◐ |\n","| constraints | Publisher defined constraints for deal creation from this supplier ad product. | ◐ |\n","| supplierAdProductExtension | Supplier-specific information related to the associated supplier for the supplier ad product. | ◐ |\n","| supplierAdProductType | The proposal type for this supplier ad product. | ○ |\n","| customPublisherDescription | The unstructured name of this product, similar to customPublisherDescription in AdvertisingDeal. | ○ |\n","| countryConfigurations | Supported countries for this supplier ad product. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierAdProduct","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product","content":[],"documentType":"guide"},{"title":"SupplierAdProduct","sectionHeader":{"type":3,"text":"CountryConfiguration"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| country | The country code. | ✓ |\n","| currency | The currency code. | ○ |\n","| timezone | The timezone. | ○ |\n"],"documentType":"guide"},{"title":"SupplierAdProductPrice","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-ad-product-price","content":[" SupplierAdProductPrice follows the resource pattern for implementing an RPC call. Calling the create action on this resource will fetch the price for a SupplierAdProduct for the configuration provided in supplierAdProductPriceDescription at the time that the query was performed.\n"],"documentType":"guide"},{"title":"SupplierAdProductPrice","sectionHeader":{"type":2,"text":"SupplierAdProductPrice parameters"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product-price","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierAdProductPriceDescription | The description of the supplier ad product price request parameters. | ◐ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| price | The total price of a proposed deal configuration. This includes the sum of all prices within itemizedPrice. | ✓ |\n","| itemizedPrice | Itemized breakdown of the price components. | □ |\n","| lastUpdatedProductPriceDateTime | The timestamp at which the rate was calculated. | □ |\n"],"documentType":"guide"},{"title":"SupplierAdProductPrice","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product-price","content":[],"documentType":"guide"},{"title":"SupplierAdProductPrice","sectionHeader":{"type":3,"text":"SupplierAdProductPriceDescription"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product-price","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierId | The proposal supplier ID. | ○ |\n","| supplierProposalDestinationId | The proposal supplier proposal destination ID. | ○ |\n","| supplierAdProductPriceDescriptionType | The type of supplier ad product price, such as AMAZON_MEDIA. | ✓ |\n","| supplierAdProductId | The supplier ad product ID. | ✓ |\n","| startDateTime | Start datetime for rate calculation. | ✓ |\n","| endDateTime | End datetime for rate calculation. | ○ |\n","| creativeRequirements | Creative requirements for this supplier ad product price. | ◐ |\n","| advertiserAccountId | The advertiser ID. A required field since advertiserId may impact the price returned. | ✓ |\n","| countries | The country or countries for rate calculation. | ○ |\n","| targeting | Supplier targeting configuration. | ◐ |\n","| deliveryIntent | Delivery control settings including frequency caps and goals. Used by Amazon Media to adjust the quoted rate based on delivery constraints. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierAdProductPrice","sectionHeader":{"type":3,"text":"PriceComponent"},"path":"/en-us/guides/deal-management/entities/supplier-ad-product-price","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| priceComponentType | Type of the price component. Determines if this component pertains to seller price or a third party fee. | ✓ |\n","| price | Price value for this component. | □ |\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| SUPPLIER_PRICE | The price component pertains to the seller price. |\n","| THIRD_PARTY_DATA_TARGETING_FEE | The price component pertains to a third party data targeting fee. |\n"],"documentType":"guide"},{"title":"SupplierProposal","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposal","content":[" A SupplierProposal is a deal proposal consisting of a collection of proposed deals configured from the publisher products of a supplier. A proposal may only have 15 associated proposed deals.\n"],"documentType":"guide"},{"title":"SupplierProposal","sectionHeader":{"type":2,"text":"SupplierProposal parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposal","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposalId | The unique identifier for the proposal. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierId | The supplier identifier. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination identifier. | ○ |\n","| externalProposalId | The external proposal identifier from the supplier system. | ○ |\n","| supplierProposalExtension | Attributes that are specific to a supplier. | ◐ |\n","| status | The current status of the proposal. | ✓ |\n","| state | The lifecycle state of the proposal, such as DRAFT, PROPOSED, or ARCHIVED. Distinct from status, which tracks the workflow progression. | ○ |\n","| stateReason | Additional context for the current state, such as the reason for archiving. | ○ |\n","| countries | The country this proposal is located. | ○ |\n","| name | The user provided proposal name. | ✓ |\n","| notes | User provided notes for this proposal. | ○ |\n","| startDateTime | The proposal start date. | ○ |\n","| endDateTime | The proposal end date. | ○ |\n","| supplierProposalType | The type of the proposal. | ○ |\n","| version | The version number of the proposal. | ✓ |\n","| creationDateTime | The date time that the proposal was created. | □ |\n","| lastUpdatedDateTime | The date time that the proposal was last updated. | □ |\n","| supplierProposedDealIds | The proposed deals associated with this proposal. | ○ |\n","| advertiserAccountId | The ADSP advertiser ID for this proposal. When null, the proposal is treated as a manager account level proposal. | ○ |\n"],"documentType":"guide"},{"title":"SupplierProposal","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-proposal","content":[],"documentType":"guide"},{"title":"SupplierProposal","sectionHeader":{"type":3,"text":"SupplierProposalStatus"},"path":"/en-us/guides/deal-management/entities/supplier-proposal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| status | Status of the proposal. | ✓ |\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| CANCELLED | A proposal that was previously submitted to a supplier, but was marked as canceled by the buyer before it was approved. |\n","| DRAFT | A proposal that is in draft status, meaning that it may include changes that have not been submitted to a supplier. |\n","| COUNTER_DRAFT | A proposal that is undergoing negotiation with a supplier, where the buyer has begun draft changes to a received proposal but has not yet submitted them. |\n","| PENDING | The buyer has submitted a proposal to a supplier and is waiting for the supplier to take action. |\n","| REJECTED | A proposal has been rejected by the supplier and negotiation has ended. No further changes may be done. |\n","| REVIEWED | All proposed deals related to this proposal have been reviewed and further action by the buyer is required. |\n","| REVIEWED_PARTIAL | Some proposed deals in this proposal have been approved, while some are in PENDING status. |\n","| SUPPLIER_REVIEWED | The supplier has reviewed the proposals and are awaiting buyer action. |\n"],"documentType":"guide"},{"title":"SupplierProposalDestination","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposal-destination","content":[" A SupplierProposalDestination represents a destination configuration for supplier proposals. It defines the name, description, and allowed countries for a proposal destination.\n"],"documentType":"guide"},{"title":"SupplierProposalDestination","sectionHeader":{"type":2,"text":"SupplierProposalDestination parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposal-destination","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposalDestinationId | The identifier ID for this supplier proposal destination. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierProposalDestinationName | The name for the supplier proposal destination. | ✓ |\n","| description | The description of the supplier proposal destination. | ○ |\n","| countries | The list of ISO 3166-1 alpha-2 formatted country codes allowed for the supplier proposal destination. Maximum of 49 entries. | ○ |\n"],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[" A SupplierProposedDeal represents a deal configuration submitted to a supplier for approval. Proposed deals are associated with a supplier proposal and contain the deal terms, targeting, and creative requirements.\n"],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":{"type":2,"text":"SupplierProposedDeal parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealId | The unique identifier for the proposed deal. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierProposalId | The unique ID of the associated proposal for this proposed deal. Only 15 proposed deals may be associated with a proposal. | ✓ |\n","| dealName | The name of the deal. | ✓ |\n","| description | The description of the deal. | ○ |\n","| terms | The terms for this deal. | ◐ |\n","| startDateTime | The delivery start date. | ✓ |\n","| endDateTime | The delivery end date. | ✓ |\n","| supplierProposedDealExtension | Attributes that are specific to a supplier. The extension type is defined by supplierProposedDealType. | ◐ |\n","| supplierProposedDealType | The proposed deal type. | ○ |\n","| notes | User provided notes for this proposed deal. | ○ |\n","| supplierId | The supplier ID for this deal. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination id for this deal. | ○ |\n","| dealType | The deal type for this proposed deal. | ✓ |\n","| externalDealId | The deal ID of the supplier for this proposed deal. Does not get created until the deal is submitted. | ○ |\n","| advertisingDealId | The ADSP deal ID for this proposed deal. Does not get created until the deal is submitted. | ○ |\n","| supplierPublisherId | Unique publisher id. | ○ |\n","| countries | The country for the proposed deal. | ○ |\n","| dealStatus | The current status of the proposed deal. | ◐ |\n","| state | The lifecycle state of the proposed deal, such as DRAFT, PROPOSED, or ARCHIVED. Distinct from dealStatus, which tracks the workflow progression. | ○ |\n","| stateReason | Additional context for the current state, such as the reason for archiving. | ○ |\n","| isBuyerApproved | Whether the buyer has approved the proposed deal. | ○ |\n","| isSupplierApproved | Whether the seller has approved the proposed deal. | ○ |\n","| version | The version number of the proposed deal. | ○ |\n","| proposalVersion | The proposal version corresponding to this proposed deal version. | ○ |\n","| submissionFailure | Metadata object containing information on why a proposed deal failed to finalize when submitted to the supplier. | ◐ |\n","| creationDateTime | The date time that the proposed deal was created. | ✓ |\n","| lastUpdatedDateTime | The date time that the proposed deal was last updated. | ✓ |\n","| creativeRequirements | Creative requirements for this proposed deal. | ◐ |\n","| deliveryIntent | Delivery control settings for this proposed deal. | ◐ |\n","| supplierAdProductId | The supplier ad product unique identifier. | ○ |\n","| customPublisherDescription | Custom description of the publisher providing inventory for this deal. | ○ |\n","| targeting | Supplier targeting configuration. | ◐ |\n","| advertiserAccountId | The ADSP advertiser ID for this proposal. When null, the proposal is treated as a manager account level proposal. | ○ |\n","| forecast | Forecast summary returned by the supplier for this proposed deal, such as available impressions. | ○ |\n"],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":{"type":3,"text":"SupplierProposedDealStatus"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealStatus | Status of the proposed deal. | ✓ |\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| APPROVED | The deal has been submitted and approved by the supplier and added to the ADSP for use. |\n","| APPROVED_CURRENT | The deal is the current approved version after a revision was approved. |\n","| APPROVED_PENDING_REGISTRATION | The deal has been approved by the supplier, but is in the process of being made targetable in the ADSP. |\n","| CANCELLED | The deal has been canceled in both ADSPs and the systems of the supplier. |\n","| DRAFT | The deal has not yet been submitted to the supplier and may be edited. |\n","| DRAFT_REVISION | The deal is a draft revision of an approved deal and may be edited. |\n","| COUNTER_DRAFT | The deal is a counter draft. |\n","| ERROR | Something has gone wrong during the submission of the deal and requires intervention to recover. |\n","| PENDING | The deal is waiting to be updated asynchronously and is not ready to be targeted. |\n","| REJECTED | The deal was rejected for approval by the supplier, and may be edited before being resubmitted. |\n","| REJECTED_REVISED | A previously rejected deal that has since been modified and is ready to be resubmitted. |\n","| REVISED | The deal is a previous version that has been superseded by a newer approved revision. |\n","| REVISION_APPROVED_PENDING_REGISTRATION | The revision has been approved by the supplier, but is in the process of being made targetable. |\n","| SELLER_RESPONDED | The seller responded with a new deal. Waiting for the decision of the buyer. |\n","| SUBMITTED | The deal is currently being evaluated for approval by the supplier. |\n","| SUBMITTED_REVISION | The deal revision is currently being evaluated for approval by the supplier. |\n","| SUBMITTED_TERMINATE | The deal is currently being evaluated for termination by the supplier. |\n","| TERMINATED | The deal has been terminated by the supplier and ingested into the ADSP. |\n","| TERMINATED_PENDING_REGISTRATION | The deal has been terminated by the supplier, but is in the process of being reflected in the ADSP. |\n"],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":{"type":3,"text":"SubmissionFailure"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| traceId | Trace identifier for the submission failure. | ○ |\n","| failures | List of submission failure details. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierProposedDeal","sectionHeader":{"type":3,"text":"SubmissionFailureField"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| code | The failure code. | ○ |\n","| message | The failure message. | ○ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealForecast","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-forecast","content":[" SupplierProposedDealForecast follows the resource pattern for implementing an RPC call. Calling the create action on this resource will generate a forecast for a supplier based on the configuration provided in supplierProposedDealForecastDescription.\n"],"documentType":"guide"},{"title":"SupplierProposedDealForecast","sectionHeader":{"type":2,"text":"SupplierProposedDealForecast parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-forecast","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealForecastDescription | The description of the supplier forecast request parameters. | ◐ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| forecastSummary | Forecast summary metrics. | ◐ |\n","| creationDateTime | The timestamp at which the forecast was generated. | ✓ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealForecast","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-forecast","content":[],"documentType":"guide"},{"title":"SupplierProposedDealForecast","sectionHeader":{"type":3,"text":"SupplierProposedDealForecastDescription"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-forecast","content":[" The request body includes a subset of SupplierProposedDeal fields relevant to generating a forecast.\n"," Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| dealName | The name of the deal. | ✓ |\n","| description | The description of the deal. | ○ |\n","| terms | The terms for this deal. | ◐ |\n","| startDateTime | The delivery start date. | ✓ |\n","| endDateTime | The delivery end date. | ✓ |\n","| supplierProposedDealExtension | Attributes that are specific to a supplier. The extension type is defined by supplierProposedDealType. | ◐ |\n","| supplierProposedDealType | The proposed deal type. | ○ |\n","| notes | User provided notes for this proposed deal. | ○ |\n","| supplierId | The supplier ID for this deal. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination id for this deal. | ○ |\n","| dealType | The deal type for this proposed deal. | ✓ |\n","| countries | The country for the proposed deal. | ○ |\n","| state | The lifecycle state of the proposed deal, such as DRAFT, PROPOSED, or ARCHIVED. Distinct from dealStatus, which tracks the workflow progression. | ○ |\n","| stateReason | Additional context for the current state, such as the reason for archiving. | ○ |\n","| creativeRequirements | Creative requirements for this proposed deal. | ◐ |\n","| deliveryIntent | Delivery control settings for this proposed deal. | ◐ |\n","| supplierAdProductId | The supplier ad product unique identifier. | ○ |\n","| customPublisherDescription | Custom description of the publisher providing inventory for this deal. | ○ |\n","| targeting | Supplier targeting configuration. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealForecast","sectionHeader":{"type":3,"text":"ImpressionsForecastSummary"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-forecast","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| availableImpressions | The total impressions available for purchase. | ✓ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealHistoricalVersion","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-historical-version","content":[" A SupplierProposedDealHistoricalVersion captures a historical version of a proposed deal, preserving past states differentiated by version number.\n"],"documentType":"guide"},{"title":"SupplierProposedDealHistoricalVersion","sectionHeader":{"type":2,"text":"SupplierProposedDealHistoricalVersion parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-historical-version","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealHistoricalVersionId | Composite identifier for proposed deal historical version. | ◐ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierProposalId | The unique ID of the associated proposal for this proposed deal. | ✓ |\n","| dealName | The name of the deal. | ✓ |\n","| description | The description of the deal. | ○ |\n","| terms | The terms for this deal. | ◐ |\n","| startDateTime | The delivery start date. | ✓ |\n","| endDateTime | The delivery end date. | ✓ |\n","| supplierProposedDealExtension | Attributes that are specific to a supplier. The extension type is defined by supplierProposedDealType. | ◐ |\n","| supplierProposedDealType | The proposed deal type. | ○ |\n","| notes | User provided notes for this proposed deal. | ○ |\n","| supplierId | The supplier ID for this deal. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination id for this deal. | ○ |\n","| dealType | The deal type for this proposed deal. | ✓ |\n","| externalDealId | The deal ID of the supplier for this proposed deal. | ○ |\n","| advertisingDealId | The ADSP deal ID for this proposed deal. | ○ |\n","| countries | The country for the proposed deal. | ○ |\n","| dealStatus | The current status of the proposed deal. | ✓ |\n","| state | The lifecycle state of the proposed deal, such as DRAFT, PROPOSED, or ARCHIVED. Distinct from dealStatus, which tracks the workflow progression. | ○ |\n","| stateReason | Additional context for the current state, such as the reason for archiving. | ○ |\n","| isBuyerApproved | Whether the buyer has approved the proposed deal. | ○ |\n","| isSupplierApproved | Whether the seller has approved the proposed deal. | ○ |\n","| version | The version number of the proposed deal. | ○ |\n","| proposalVersion | The proposal version corresponding to this proposed deal version. | ○ |\n","| submissionFailure | Metadata object containing information on why a proposed deal failed to finalize. | ◐ |\n","| creationDateTime | The date time that the proposed deal was created. | □ |\n","| lastUpdatedDateTime | The date time that the proposed deal was last updated. | □ |\n","| creativeRequirements | Creative requirements for this proposed deal. | ◐ |\n","| deliveryIntent | Delivery control settings for this proposed deal. | ◐ |\n","| supplierAdProductId | The supplier ad product unique identifier. | ○ |\n","| customPublisherDescription | Custom description of the publisher providing inventory for this deal. | ○ |\n","| targeting | Supplier targeting configuration. | ◐ |\n","| advertiserAccountId | The ADSP advertiser ID for this proposal. When null, the proposal is treated as a manager account level proposal. | ○ |\n","| supplierPublisherId | Unique publisher id. | ○ |\n","| forecast | Forecast summary returned by the supplier for this proposed deal, such as available impressions. | ○ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealHistoricalVersion","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-historical-version","content":[],"documentType":"guide"},{"title":"SupplierProposedDealHistoricalVersion","sectionHeader":{"type":3,"text":"SupplierProposedDealHistoricalVersionIdentifier"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-historical-version","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealId | The proposed deal identifier. | ✓ |\n","| version | The version number of the proposed deal. | ✓ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealRevision","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-revision","content":[],"documentType":"guide"},{"title":"SupplierProposedDealRevision","sectionHeader":{"type":2,"text":"SupplierProposedDealRevision parameters"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-revision","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealRevisionDescription | The description of the supplier proposed deal revision request parameters. | ◐ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierProposedDealId | The unique identifier for the proposed deal. | ✓ |\n","| version | The version number of the revised proposed deal. | ✓ |\n","| dealStatus | The current status of the revised proposed deal. | ✓ |\n"],"documentType":"guide"},{"title":"SupplierProposedDealRevision","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-revision","content":[],"documentType":"guide"},{"title":"SupplierProposedDealRevision","sectionHeader":{"type":3,"text":"SupplierProposedDealRevisionDescription"},"path":"/en-us/guides/deal-management/entities/supplier-proposed-deal-revision","content":[" Modifiable fields for a proposed deal revision. A revision can only be created for an approved SupplierProposedDeal.\n"," Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierProposedDealId | The unique identifier for the proposed deal to revise. | ✓ |\n","| dealName | The name of the deal. | ○ |\n","| description | The description of the deal. | ○ |\n","| terms | The terms for this deal. | ◐ |\n","| startDateTime | The delivery start date. | ○ |\n","| endDateTime | The delivery end date. | ○ |\n","| supplierProposedDealExtension | Attributes that are specific to a supplier. | ◐ |\n","| supplierProposedDealType | The proposed deal type. | ○ |\n","| notes | User provided notes for this proposed deal. | ○ |\n","| deliveryIntent | Delivery control settings for this proposed deal. | ◐ |\n","| state | The lifecycle state of the proposed deal, such as DRAFT, PROPOSED, or ARCHIVED. Distinct from dealStatus, which tracks the workflow progression. | ○ |\n","| stateReason | Additional context for the current state, such as the reason for archiving. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination id for this deal. | ○ |\n","| targeting | Supplier targeting configuration. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierPublisher","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-publisher","content":[" A SupplierPublisher represents a content provider that offers ad inventory through a supplier.\n"],"documentType":"guide"},{"title":"SupplierPublisher","sectionHeader":{"type":2,"text":"SupplierPublisher parameters"},"path":"/en-us/guides/deal-management/entities/supplier-publisher","content":[" Key: ✓ required | ○ optional | □ read-only | ◐ nested object\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| supplierPublisherId | The publisher identifier. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| supplierPublisherExtension | Supplier-specific information related to the associated supplier for the publisher. The extension type is defined by supplierPublisherType. | ◐ |\n","| supplierPublisherType | The proposal type for this publisher. | ○ |\n","| supplierId | The supplier id for this publisher. | ○ |\n","| supplierProposalDestinationId | The supplier proposal destination id for this publisher. | ○ |\n","| name | The publisher name. | ○ |\n","| logos | Publisher logos. | ◐ |\n","| supportedCreatives | Creative configurations supported by this publisher. | ◐ |\n","| countryConfigurations | Supported countries for this publisher. | ◐ |\n","| dealTypes | Supported deal types. | ○ |\n","| constraints | Constraint options. | ◐ |\n"],"documentType":"guide"},{"title":"SupplierPublisher","sectionHeader":{"type":2,"text":"Nested entities"},"path":"/en-us/guides/deal-management/entities/supplier-publisher","content":[],"documentType":"guide"},{"title":"SupplierPublisher","sectionHeader":{"type":3,"text":"Logo"},"path":"/en-us/guides/deal-management/entities/supplier-publisher","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| size | Logo dimensions. | ○ |\n","| type | Logo file type. | ○ |\n","| url | Logo URL. | ○ |\n"],"documentType":"guide"},{"title":"SupplierTargetItem","sectionHeader":null,"path":"/en-us/guides/deal-management/entities/supplier-target-item","content":[" A SupplierTargetItem represents an individual targeting item that can be used when configuring supplier targeting for a proposed deal.\n"],"documentType":"guide"},{"title":"SupplierTargetItem","sectionHeader":{"type":2,"text":"SupplierTargetItem parameters"},"path":"/en-us/guides/deal-management/entities/supplier-target-item","content":[" Key: ✓ required | ○ optional | □ read-only\n","| Field | Description | Requirement |\n","\\| --- \\| --- \\| --- \\|\n","| id | Unique identifier for the targeting item. | □ |\n","| adProduct | The ad product associated with this resource. | ○ |\n","| name | Name of the targeting item. | ✓ |\n","| supplierTargetType | The type of targeting for this item. | ✓ |\n","| supplierId | Supplier identifier. | ○ |\n","| supplierProposalDestinationId | Supplier proposal destination identifier. | ○ |\n","| supplierAdProductId | The supplier ad product associated with this targeting item. | ○ |\n","| countries | Countries where this targeting item is available. | ○ |\n","| category | Categories for this targeting item. | ○ |\n","| description | Description of the targeting item. | ○ |\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":null,"path":"/en-us/guides/deal-management/deal-management","content":[" The Inventory Management API provides the ability to manage the deals that buyers have negotiated with external and Amazon Owned & Operated suppliers so you can use those deals to place ads through the Amazon DSP platform.\n"," Inventory Groups are a collection of deals, and we provide an API to manage the Inventory Groups so that buyers can use those directly to target at an adGroup level.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Deal Management"},"path":"/en-us/guides/deal-management/deal-management","content":[],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Create a Deal"},"path":"/en-us/guides/deal-management/deal-management","content":[" This endpoint allows you to create a deal object matching the submitted parameters. If your deal is not autoingested to ADSP, you can manually register that in ADSP using the endpoint POST /adsApi/v1/create/advertisingDeals. \n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Update a Deal"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can update a created deal using the endpoint POST /adsApi/v1/update/advertisingDeals.\n"," A deal updated with an end date in the past will be marked as expired in ADSP. \n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get list of Deals"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can get the list of deals based on filters provided in POST /adsApi/v1/query/advertisingDeals.\n"," Deals can be filtered by their live-sports classification (sports, leagues, and broadcasters); see Live-events supply taxonomies to resolve the IDs to names.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Deal Avails"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can get real-time ad opportunities metrics for specified deals with targeting-aware calculations using endpoint POST /adsApi/v1/query/dealAvails.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Deal Planning Metrics"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can get directional average metrics for the input deals. These metrics are meant for planning purposes and not to match customer campaign performance data. Use endpoint POST /adsApi/v1/query/dealPlanningMetrics\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Deal Performance Metrics"},"path":"/en-us/guides/deal-management/deal-management","content":[" This endpoint enables you to retrieve campaign performance and supply side metrics for select deals, either submitted as a query input, or matching the submitted filters. Use endpoint POST /adsApi/v1/query/dealPerformances\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Link a deal to an `adGroup`"},"path":"/en-us/guides/deal-management/deal-management","content":[" To link an advertising deal object to an adGroup, you can create a targeting object using POST /adsApi/v1/create/targets and link that targeting object to adGroup. Select targetType =\"Inventory_Source\" with TargetDetails containing InventorySourceType=\"DEAL\".\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Live-events supply taxonomies"},"path":"/en-us/guides/deal-management/deal-management","content":[" Deals that cover live-sports supply are classified with supplyMetadata.sportsMetadata, which holds lists of sports, leagues, and broadcasters IDs (see the AdvertisingDeal entity reference). Each ID references an entry in one of three Amazon Ads Live-Events taxonomies, published as static JSON:\n","| Taxonomy | URL |\n","\\| --- \\| --- \\|\n","| Sports | https&#x3A;//d1bs9luyrau13z.cloudfront.net/taxonomy/sports |\n","| Leagues | https&#x3A;//d1bs9luyrau13z.cloudfront.net/taxonomy/leagues |\n","| Broadcasters | https&#x3A;//d1bs9luyrau13z.cloudfront.net/taxonomy/broadcasters |\n"," Each taxonomy is independent: an ID is only meaningful within its own taxonomy, and the same numeric value refers to different entities across taxonomies (sport 1 is American Football; league 1 is the National Football League; broadcaster 1 is Disney).\n"," Each document is a JSON object with an array keyed by taxonomy name plus a version and a lastModified timestamp. For example, the sports taxonomy:\n"," To resolve a deal's IDs to names, match each ID in sportsMetadata against the id field in the corresponding taxonomy. A deal with sportsMetadata.leagues of \\[\"1\", \"8\"] covers the National Football League and Major League Baseball.\n"," The taxonomies are stable reference data that changes infrequently. Cache the documents and refresh periodically rather than fetching them on every request; use the version field to detect changes.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Get Deal Advertiser Access"},"path":"/en-us/guides/deal-management/deal-management","content":[" To get details of which Amazon DSP advertisers can target a deal, you can use the endpoint POST /adsApi/v1/query/dealAdvertiserAccessEntries.\n"," To get the details of the access (allow or block) by advertiser ID use POST /adsApi/v1/retrieve/dealAdvertiserAccesses.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Add the Advertiser Access"},"path":"/en-us/guides/deal-management/deal-management","content":[" To add the access of an advertiser on a deal, use endpoint POST /adsApi/v1/create/dealAdvertiserAccessEntries.\n"," To create a deal advertiser access record use POST /adsApi/v1/create/dealAdvertiserAccesses. It uses a strategy-based approach where ALLOW means only listed advertisers can target, and BLOCK means listed advertisers cannot target.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Remove the advertiser access"},"path":"/en-us/guides/deal-management/deal-management","content":[" To delete advertisers from a deal advertiser access list POST /adsApi/v1/delete/dealAdvertiserAccessEntries\n"," To delete a deal advertiser access record and all associated entries POST /adsApi/v1/delete/dealAdvertiserAccesses\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Buyer Seat Management"},"path":"/en-us/guides/deal-management/deal-management","content":[" A buyer seat is an identifier exchanged between Supply-Side Platforms (SSPs) and the Amazon DSP in programmatic advertising. There are two seat types:\n","DEAL_CREATION — shared with publishers/SSPs when setting up deals, used to allowlist which buyers can bid. - SPEND_TRACKING — included in bid responses for buyer recognition and spend tracking by exchanges.\n"," Seats exist at multiple account levels, identified by the prefix of their seat ID:\n","AMZA (Advertiser) — specific to a single advertiser. Created via the Create API. - AMZN (Manager Account) — shared by all advertisers under a manager account. Auto-generated. - AMZG (Group) — shared across multiple manager accounts in a holding company group.\n"," Seats are applicable across exchanges by default.\n"," For full details on the BuyerSeat resource, see BuyerSeat entity reference.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Create Buyer Seats"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can create buyer seats for an advertiser using POST /adsApi/v1/create/buyerSeats. This creates seats for deal creation and spend tracking purposes. Seats are server-generated and unique per advertiser.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"List Buyer Seats"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can list buyer seats for an advertiser or manager account, resolved per exchange, using GET /adsApi/v1/buyerSeats. The response includes seats from all applicable account levels (advertiser, manager account, and group).\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Inventory Group Management"},"path":"/en-us/guides/deal-management/deal-management","content":[" For more details on API usage for Amazon-curated inventory groups, please refer to the Automatic Deal Selection for Inventory Groups section.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Create Inventory Group"},"path":"/en-us/guides/deal-management/deal-management","content":[" You can create your own inventory groups by using POST /adsApi/v1/create/inventoryGroups.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Update Inventory Group "},"path":"/en-us/guides/deal-management/deal-management","content":[" You can update the inventory groups by overwriting the existing metadata using POST /adsApi/v1/update/inventoryGroups. \n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Retrieve list of Inventory Groups"},"path":"/en-us/guides/deal-management/deal-management","content":[" To get a list of inventory groups based on the sorting and filtering criteria provided in the request you can use POST /adsApi/v1/query/inventoryGroups.\n"," To retrieve Inventory Groups in bulk, use POST /adsApi/v1/retrieve/inventoryGroups.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Link an Inventory Group to an `adGroup`"},"path":"/en-us/guides/deal-management/deal-management","content":[" To link an advertising inventory group object to an adGroup, you can create a targeting object using POST /adsApi/v1/create/targets and link that targeting object to adGroup. Select targetType =\"Inventory_Source\" with TargetDetails containing InventorySourceType=\"INVENTORY_GROUP\".\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Automatic Deal Selection for Inventory Groups"},"path":"/en-us/guides/deal-management/deal-management","content":[" This section documents how to use the inventory group (IG) APIs for both Automatic Deal Selection (ADS) inventory groups and standard inventory groups.\n"," An inventory group's curationSourceType determines how it is curated. There are three values:\n","| curationSourceType | Curated by | Category |\n","\\| --- \\| --- \\| --- \\|\n","| ADVERTISER_CURATED | The advertiser or agency, manually (explicit deals) | Standard |\n","| AMAZON_CURATED | Amazon, manually | Standard |\n","| AMAZON_CURATED_AGENT | Amazon's Automatic Deal Selection (ADS) system | ADS |\n"," ADS inventory groups use the AMAZON_CURATED_AGENT curation source type. Deals are selected and managed by Amazon on your behalf and controlled through Deal Eligibility Controls (DEC), rather than being explicitly listed by the advertiser. The workflow is:\n","Create an IG with the AMAZON_CURATED_AGENT curation source type. 2. Attach the IG to the line item via the targeting API to enroll in ADS. 3. Update Deal Eligibility Controls (DEC). 4. Detach the IG from the line item to unenroll from ADS. 5. Re-enroll the IG if needed.\n"," Standard inventory groups are advertiser-managed deal packages that use the ADVERTISER_CURATED curation source type with explicit deals. (Amazon can also manually curate standard inventory groups as AMAZON_CURATED; those are system-managed and cannot be created through the public API.) This guide's standard-IG workflow covers ADVERTISER_CURATED:\n","Create an IG with the ADVERTISER_CURATED curation source type (with explicit deals). 2. Attach the IG to the line item via the targeting API. 3. Update the IG (name, deals). 4. Detach the IG from the line item.\n","| Constraint | Detail |\n","\\| --- \\| --- \\|\n","| Eligible line item types | Streaming TV (STV) Awareness only — the ad group must be Streaming TV (STREAMING_TV) and belong to an Awareness campaign (funnelStage = AWARENESS or AWARENESS_V2) |\n","| Inventory group type | Must be inventoryType: \"VIDEO\" |\n","| Curation source type | Must be AMAZON_CURATED_AGENT |\n","| Deals | advertisingDealIds must be null or empty — ADS deals are system-managed |\n","| adGroupId | Required in curationSourceSettings — this is the line item (ad group) ID |\n"," API: POST /adsApi/v1/create/inventoryGroups\n"," Request:\n"," Request fields:\n","| Field | Required | Description |\n","\\| --- \\| --- \\| --- \\|\n","| name | Yes | 1–250 characters |\n","| inventoryType | Yes | Must be \"VIDEO\" for ADS |\n","| curationSourceType | Yes | Must be \"AMAZON_CURATED_AGENT\" |\n","| curationSourceSettings | No | Optional — omit to accept default Deal Eligibility Controls (dealTypePreference: ALL, all supply). Provide it to configure DEC. |\n","| curationSourceSettings.automaticDealSelectionControls.adGroupId | Conditional | Required when curationSourceSettings is provided — the line item ID to associate with |\n","| curationSourceSettings.automaticDealSelectionControls.dealTypePreference | No | \"ALL\" (default), \"EXCLUDE_PUBLICLY_AVAILABLE\", or \"PUBLICLY_AVAILABLE_ONLY\" |\n","| curationSourceSettings.automaticDealSelectionControls.supplyAllowlist | No | Union type — pick ONE of the variants below |\n"," Supply allowlist variants (mutually exclusive):\n","| Variant | Meaning | Example |\n","\\| --- \\| --- \\| --- \\|\n","| amazonOwnedAndOperated: { enabled: true } | Restrict to Amazon O&O supply (1P only) | { \"supplyAllowlist\": { \"amazonOwnedAndOperated\": { \"enabled\": true } } } |\n","| openInternet: { enabled: true } | Restrict to open internet supply (3P only) | { \"supplyAllowlist\": { \"openInternet\": { \"enabled\": true } } } |\n","| customSources: { supplySourceIds: \\[\"src-1\", ...] } | Restrict to specific supply sources (1–1000). See Appendix: Valid supply source IDs. | { \"supplyAllowlist\": { \"customSources\": { \"supplySourceIds\": \\[\"src-1\"] } } } |\n","| (omit supplyAllowlist entirely) | ALL supply — no restriction | (don't include the field) |\n"," Successful response (HTTP 207):\n"," Possible errors:\n","| Error code | Condition | Message |\n","\\| --- \\| --- \\| --- \\|\n","| FIELD_VALUE_IS_INVALID | name is null/blank | \"name is required at index {i}\" |\n","| CONTENT_TOO_LARGE | name > 250 chars | \"name exceeds maximum length of 250 characters at index {i}\" |\n","| CONTENT_TOO_LARGE | > 100 items in request | \"Maximum 100 inventory groups allowed per request\" |\n","| FIELD_VALUE_IS_INVALID | advertisingDealIds provided for ADS | \"advertisingDealIds cannot be provided for AMAZON_CURATED_AGENT inventory groups at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | adGroupId is null/blank when curationSourceSettings is provided | \"adGroupId is required when curationSourceSettings is provided at index {i}\" |\n","| ACTION_NOT_SUPPORTED | curationSourceSettings on non-AMAZON_CURATED_AGENT IG | \"curationSourceSettings is only supported for AMAZON_CURATED_AGENT inventory groups at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | supplyAllowlist.amazonOwnedAndOperated.enabled = false | \"To remove the supply filter, omit supplyAllowlist entirely at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | supplyAllowlist.openInternet.enabled = false | \"To remove the supply filter, omit supplyAllowlist entirely at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | DEC too restrictive (zero eligible deals) | \"Deal eligibility controls are too restrictive — no deals match the specified criteria\" |\n","| ACTION_NOT_SUPPORTED | curationSourceType = AMAZON_CURATED (system-managed) | \"AMAZON_CURATED inventory groups cannot be created via public API\" |\n","| FIELD_VALUE_IS_INVALID | Unsupported inventoryType | \"Unsupported inventoryType: {value}\" |\n","| INTERNAL_ERROR | Backend unavailable | \"Service temporarily unavailable\" |\n"," API: POST /adsApi/v1/create/targets\n"," Association of an inventory group to an ad group (line item) is done via the targeting API. This creates a target of type INVENTORY_SOURCE that links the IG to the ad group.\n"," Request:\n"," Request fields:\n","| Field | Required | Description |\n","\\| --- \\| --- \\| --- \\|\n","| adGroupId | Yes | The ad group (line item) ID to target |\n","| adProduct | Yes | Must be \"AMAZON_DSP\" |\n","| targetType | Yes | Must be \"INVENTORY_SOURCE\" |\n","| state | Yes | \"ENABLED\" to activate |\n","| negative | Yes | Must be false for inventory groups |\n","| targetDetails.inventorySourceTarget.inventorySourceId.defaultValue | Yes | The inventory group ID from Step 1 |\n","| targetDetails.inventorySourceTarget.inventorySourceType | Yes | Must be \"INVENTORY_GROUP\" |\n"," The association is persisted asynchronously, so allow a short delay after a successful response before querying the association (it is eventually consistent).\n"," Possible errors:\n","| Error | Condition |\n","\\| --- \\| --- \\|\n","| Validation failure | IG does not exist |\n","| Validation failure | Duplicate target — IG already attached to this ad group |\n","| Validation failure | ADS 1:1 constraint — ad group already has a different ADS IG |\n","| Validation failure | ADS 1:1 constraint — ADS IG is already associated with a different ad group |\n","| Validation failure | Deal limit exceeded |\n"," API: POST /adsApi/v1/update/inventoryGroups\n"," For AMAZON_CURATED_AGENT inventory groups, only curationSourceSettings updates are allowed. Any attempt to change name, description, or advertisingDealIds is rejected.\n"," Update DEC request:\n"," To reset DEC to defaults (all deal types, all supply), nullify the curationSourceSettings field on update. Nullifying a field is different from omitting it:\n","Omitting curationSourceSettings leaves the existing DEC unchanged. - Nullifying curationSourceSettings clears it, resetting DEC to dealTypePreference: ALL and supplyAllowlist: ALL (no restriction).\n"," Field nullification follows the Domain Model convention: include the field's path in the request's nullified-fields set (rather than sending the field with a value). Refer to the update request semantics for how to mark a field as nullified in a bulk update. The update body itself only needs the target IG:\n"," with curationSourceSettings marked as nullified. On an AMAZON_CURATED_AGENT IG, an update that neither provides nor nullifies curationSourceSettings is rejected (see the error table below).\n"," Possible errors:\n","| Error code | Condition | Message |\n","\\| --- \\| --- \\| --- \\|\n","| ACTION_NOT_SUPPORTED | Changing name/deals/description on ADS IG | \"AMAZON_CURATED_AGENT inventory groups only support curationSourceSettings updates at index {i}\" |\n","| ACTION_NOT_SUPPORTED | Neither curationSourceSettings provided nor nullified | Same as above |\n","| ACTION_NOT_SUPPORTED | curationSourceSettings on non-AMAZON_CURATED_AGENT IG | \"curationSourceSettings is only supported for AMAZON_CURATED_AGENT inventory groups at index {i}\" |\n","| RESOURCE_ID_NOT_FOUND | IG ID not found | \"Inventory group not found: {id}\" |\n","| FIELD_VALUE_IS_INVALID | DEC too restrictive (zero eligible deals) | \"Deal eligibility controls are too restrictive — no deals match the specified criteria\" |\n","| FIELD_VALUE_IS_INVALID | adGroupId null/blank | \"adGroupId is required when curationSourceSettings is provided at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | supplyAllowlist.\\*.enabled = false | \"To remove the supply filter, omit supplyAllowlist entirely at index {i}\" |\n","| TOO_MANY_REQUESTS | Pre-fetch throttled | \"Request throttled, please retry\" |\n","| INTERNAL_ERROR | Pre-fetch failed | \"Failed to retrieve existing inventory groups\" |\n"," API: POST /adsApi/v1/delete/targets\n"," Unenrollment is done by deleting the targeting association via the targeting API.\n"," Request:\n"," On detach, the ADS IG is archived (status becomes INVENTORY_GROUP_ARCHIVED), not deleted, and continues to occupy the 1:1 slot on that ad group. See Step 5 for the re-enrollment implications.\n"," Possible errors:\n","| Error | Condition |\n","\\| --- \\| --- \\|\n","| Validation failure | Target ID does not exist |\n","| Validation failure | Multiple ADS IGs in a single DELETE request |\n","| Downstream failure | The operation is rejected (e.g., package associated with a different line item) |\n"," After unenrolling, the archived association is retained, and re-enrollment must use the same ADS IG ID that was originally associated with the ad group.\n"," Call POST /adsApi/v1/create/targets with the same ADS IG ID:\n"," How to find the original ADS IG ID:\n","Stored by the caller — Store the IG-to-ad-group mapping in your own system at creation time. This is the recommended approach. 2. Query the InventoryGroups API — POST /adsApi/v1/query/inventoryGroups lists all ADS IGs owned by the entity, but does not reveal which ad group each IG was previously associated with. 3. Error-driven discovery — If you use the wrong ADS IG ID, the error response includes the correct one.\n"," Using a different ADS IG ID for the same ad group fails:\n"," Standard inventory groups are advertiser-managed deal packages. The advertiser explicitly selects which deals to include.\n"," API: POST /adsApi/v1/create/inventoryGroups\n"," Request:\n"," Request fields:\n","| Field | Required | Description |\n","\\| --- \\| --- \\| --- \\|\n","| name | Yes | 1–250 characters |\n","| description | No | 0–1000 characters |\n","| inventoryType | Yes | \"VIDEO\", \"DISPLAY\", or \"AUDIO\" |\n","| advertisingDealIds | No | List of deal IDs (max 100 per IG) |\n","| curationSourceType | No | Defaults to \"ADVERTISER_CURATED\" if omitted |\n"," Successful response (HTTP 207):\n"," Possible errors:\n","| Error code | Condition | Message |\n","\\| --- \\| --- \\| --- \\|\n","| FIELD_VALUE_IS_INVALID | name is null/blank | \"name is required at index {i}\" |\n","| CONTENT_TOO_LARGE | name > 250 chars | \"name exceeds maximum length of 250 characters at index {i}\" |\n","| CONTENT_TOO_LARGE | description > 1000 chars | \"description exceeds maximum length of 1000 characters at index {i}\" |\n","| CONTENT_TOO_LARGE | > 100 deals per IG | \"Maximum 100 deals allowed per inventory group, got {n} at index {i}\" |\n","| CONTENT_TOO_LARGE | > 100 items in request | \"Maximum 100 inventory groups allowed per request\" |\n","| FIELD_VALUE_IS_INVALID | Unsupported inventoryType | \"Unsupported inventoryType: {value}\" |\n"," API: POST /adsApi/v1/create/targets\n"," Use the targeting API (same as ADS):\n"," Standard IGs support many-to-many associations — one IG can target multiple ad groups, and one ad group can have multiple IGs.\n"," Possible errors:\n","| Error | Condition |\n","\\| --- \\| --- \\|\n","| Validation failure | IG does not exist |\n","| Validation failure | Duplicate target — IG already attached to this ad group |\n","| Validation failure | Deal limit exceeded |\n"," API: POST /adsApi/v1/update/inventoryGroups\n"," You can update name and advertisingDealIds for standard IGs:\n","| Field | Required | Description |\n","\\| --- \\| --- \\| --- \\|\n","| inventoryGroupId | Yes | The IG to update |\n","| name | No | New name (if omitting, existing name is kept). Cannot be nullified. |\n","| advertisingDealIds | No | New deal list. Send \\[] to clear all deals. Omit to keep existing. |\n"," Possible errors:\n","| Error code | Condition | Message |\n","\\| --- \\| --- \\| --- \\|\n","| RESOURCE_ID_NOT_FOUND | IG ID not found | \"Inventory group not found: {id}\" |\n","| FIELD_VALUE_IS_INVALID | Name nullified | \"name is required and cannot be cleared at index {i}\" |\n","| FIELD_VALUE_IS_INVALID | Description update attempted | \"description updates are not currently supported\" |\n","| ACTION_NOT_SUPPORTED | curationSourceSettings on non-ADS IG | \"curationSourceSettings is only supported for AMAZON_CURATED_AGENT inventory groups at index {i}\" |\n","| CONTENT_TOO_LARGE | > 100 deals per IG | \"Maximum 100 deals allowed per inventory group, got {n} at index {i}\" |\n","| TOO_MANY_REQUESTS | Pre-fetch throttled | \"Request throttled, please retry\" |\n"," API: POST /adsApi/v1/delete/targets\n"," For standard IGs, the association is fully removed. Re-association can be done with any IG (no 1:1 constraint).\n","| Aspect | ADS (AMAZON_CURATED_AGENT) | Standard (ADVERTISER_CURATED) |\n","\\| --- \\| --- \\| --- \\|\n","| curationSourceType | \"AMAZON_CURATED_AGENT\" (required) | \"ADVERTISER_CURATED\" (default, can be omitted) |\n","| inventoryType | \"VIDEO\" only | \"VIDEO\", \"DISPLAY\", or \"AUDIO\" |\n","| Eligible line items | Streaming TV (STV) Awareness only (STREAMING_TV + Awareness campaign) | Any line item type |\n","| advertisingDealIds | Must be null/empty (deals are system-managed) | Advertiser-specified (0–100 deals) |\n","| description | Not supported (field ignored) | Accepted at create (1000 char max) |\n","| curationSourceSettings | Optional — provide to configure DEC; omit to accept defaults (dealTypePreference: ALL, all supply) | Not supported (returns ACTION_NOT_SUPPORTED) |\n","| adGroupId | Conditional — required only when curationSourceSettings is provided (the line item ID) | N/A |\n","| Attach API | POST /adsApi/v1/create/targets | POST /adsApi/v1/create/targets |\n","| Detach API | POST /adsApi/v1/delete/targets | POST /adsApi/v1/delete/targets |\n","| Detach behavior | IG is archived (INVENTORY_GROUP_ARCHIVED) — still occupies 1:1 slot | Association is removed |\n","| Re-enrollment | Must use the same IG ID | No constraint — any IG can be re-associated |\n","| Line item association | 1:1 (one IG per line item) | Many-to-many (multiple IGs to multiple line items) |\n","| Update: name | Not allowed (rejected) | Allowed |\n","| Update: deals | Not allowed (rejected) | Allowed (send \\[] to clear) |\n","| Update: description | Not allowed (rejected) | Not currently supported |\n","| Update: curationSourceSettings (DEC) | Allowed (the only mutable field) | Not supported |\n","| Bulk limit | 100 per request | 100 per request |\n","| Operation | ADS IG API | Standard IG API |\n","\\| --- \\| --- \\| --- \\|\n","| Create IG | POST /adsApi/v1/create/inventoryGroups | POST /adsApi/v1/create/inventoryGroups |\n","| Attach to line item | POST /adsApi/v1/create/targets | POST /adsApi/v1/create/targets |\n","| Update IG | POST /adsApi/v1/update/inventoryGroups (DEC only) | POST /adsApi/v1/update/inventoryGroups (name, deals) |\n","| Detach from line item | POST /adsApi/v1/delete/targets | POST /adsApi/v1/delete/targets |\n","| Query IGs | POST /adsApi/v1/query/inventoryGroups (filter: AMAZON_CURATED_AGENT) | POST /adsApi/v1/query/inventoryGroups (filter: ADVERTISER_CURATED) |\n","| Constraint | ADS IG | Standard IG |\n","\\| --- \\| --- \\| --- \\|\n","| 1:1 IG-to-ad-group | Enforced — one ADS IG per ad group, one ad group per ADS IG | Not enforced — many-to-many |\n","| Re-enrollment | Must use same IG ID | No constraint |\n","| Batch delete | Cannot delete multiple ADS targets in a single request | No restriction |\n","| Media type match | Not validated at targeting time | Not validated at targeting time |\n"," ADS flow:\n"," Standard IG flow:\n"," DEC controls which deals ADS can select for the line item.\n"," dealTypePreference (deal library preference) controls which deal library the system draws deals from when selecting inventory for the line item. In the DSP UI, this corresponds to the \"Deal Library Preference\" setting — it determines whether ADS considers deals from the public marketplace (available to all advertisers), private/exclusive deals (negotiated specifically for the advertiser), or both.\n","| Value | Description |\n","\\| --- \\| --- \\|\n","| ALL | Both public marketplace deals and private/exclusive deals are eligible (default) |\n","| EXCLUDE_PUBLICLY_AVAILABLE | Only private/exclusive deals — excludes publicly available marketplace deals |\n","| PUBLICLY_AVAILABLE_ONLY | Only publicly available marketplace deals — excludes private/exclusive deals |\n"," Example 1 — use all deal types (default). The system can select from any deal in both public and private libraries:\n"," Example 2 — private deals only. Restrict to deals negotiated specifically for this advertiser. Publicly available marketplace deals are excluded:\n"," Example 3 — marketplace deals only. Restrict to deals available in the public marketplace (open auction deals, open PMPs). Private/exclusive deals are excluded:\n"," Example 4 — combined with supply allowlist. Private deals only, restricted to Amazon O&O supply:\n"," supplyAllowlist mode:\n","| API value | Description |\n","\\| --- \\| --- \\|\n","| amazonOwnedAndOperated: { enabled: true } | Only Amazon-owned supply |\n","| openInternet: { enabled: true } | Only open internet (third-party) supply |\n","| customSources: { supplySourceIds: \\[...] } | Specific supply source IDs (1–1000). See Appendix: Valid supply source IDs. |\n","| (omit supplyAllowlist) | All supply eligible |\n"," Before persisting DEC, the system verifies that at least one deal matches the specified criteria. If zero deals match, the request is rejected with FIELD_VALUE_IS_INVALID.\n","Idempotent creation — Re-creating the same ADS IG for the same line item returns the existing inventory group ID. 2. DEC persistence on create — DEC is always persisted after IG creation. If DEC persistence fails, the entire create operation is reported as failed. 3. DEC defaults — If curationSourceSettings is null or has null automaticDealSelectionControls, DEC defaults to ALL/ALL (all deal types, all supply). 4. Archive on detach — When an ADS IG is removed from a line item, it is archived (status = INVENTORY_GROUP_ARCHIVED), not deleted. This preserves audit history. 5. Single line item association — An ADS inventory group can only be associated with one line item at a time. 6. Bulk operations — Up to 100 inventory groups can be created or updated per request.\n"," To avoid errors, callers should:\n","Persist the IG ID to ad group ID mapping — critical for re-enrollment. 2. Always use inventoryType: \"VIDEO\" for ADS IGs. 3. Always set curationSourceType: \"AMAZON_CURATED_AGENT\" explicitly for ADS IGs. 4. Never provide advertisingDealIds for ADS IGs. 5. Always include adGroupId when providing curationSourceSettings. 6. Use the targeting API (POST /adsApi/v1/create/targets, POST /adsApi/v1/delete/targets) to attach and detach ADS IGs. 7. Delete ADS targets one at a time — never batch multiple ADS target deletions in a single request. 8. Verify the ad group is a Streaming TV (STV) Awareness ad group (STREAMING_TV on an Awareness campaign) before enrolling in ADS. 9. Start with permissive DEC (ALL/ALL) and narrow gradually. 10. Allow for eventual consistency after targeting operations.\n"," When using customSources.supplySourceIds in the supplyAllowlist, you must provide valid supply source IDs. Supply sources are grouped by SSP (supply-side platform). Each ID is a numeric identifier that must be passed as a JSON string (for example, \"100\", not 100) — this matches the supplySourceIds type used throughout the examples in this guide. Pass the IDs (not the SSP names). You can pass IDs from multiple SSPs in a single supplySourceIds array (1–1000 IDs supported).\n"," Amazon (O&O):\n"," APS (Amazon Publisher Services):\n"," Third-party SSPs:\n","| SSP name | Supply source IDs |\n","\\| --- \\| --- \\|\n","| Google AdX (Authorized Buyers) | 1401, 1403, 1404 |\n","| Smartclip | 1984, 1985, 2018 |\n","| Magnite Streaming | 1979, 1980, 1981 |\n","| Unruly | 1967, 2066, 2069 |\n","| Stroer | 1212, 1213, 1214, 1949, 2075, 2077 |\n","| Spotify Ad Exchange (SAX) | 1223 |\n","| Index | 1978, 2048, 2049 |\n","| Sovrn | 1929 |\n","| OpenX | 1302, 1303, 1304 |\n","| MediaGrid | 2028, 2030 |\n","| Yieldmo | 1651, 1653 |\n","| LoopMe | 2091, 2093 |\n","| Triplelift | 1551, 1553, 1556 |\n","| Equativ | 2025, 2026 |\n","| Nativo | 1571, 1573 |\n","| OneTag | 2003, 2004 |\n","| Magnite DV+ | 1701, 1703 |\n","| Improve Digital | 2020, 2021 |\n","| Kargo | 2071, 2073, 2074 |\n","| Unity | 2129 |\n","| BeachFront | 1950, 1951 |\n","| FreeWheel | 1973, 1974, 1983 |\n","| YieldOne | 1923, 1997 |\n","| Connatix | 2010, 2011 |\n","| Sharethrough | 1561, 1563, 1566 |\n","| TVer | 2035, 2060, 2061 |\n","| GumGum | 2110 |\n","| AJA | 1991, 1992, 1998 |\n","| Microsoft Monetize | 1201, 1203, 1204 |\n","| Exte | 2166, 2169 |\n","| Verizon Media Exchange | 1602, 1604 |\n","| Ogury | 2144, 2145 |\n","| Vungle Exchange | 1709 |\n","| Media.net | 1989, 2081 |\n","| Roku | 2180 |\n","| Dailymotion | 1886, 1887 |\n","| Ad Generation | 1954, 1955 |\n","| Fluct | 1926 |\n","| Teads | 1942, 1943 |\n","| PubMatic | 1503, 1505, 1506 |\n","| InMobi | 1996 |\n","| ironSource | 2007 |\n","| Yieldlab | 1920, 1994, 2076 |\n","| Smaato | 1966 |\n"," Example — restrict to only Amazon O&O + Roku + FreeWheel supply:\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Label Management"},"path":"/en-us/guides/deal-management/deal-management","content":[" Labels are global, user-defined tags for organizing DSP objects (deals, inventory groups). Once created, labels are visible across the account and can be applied to any supported object type.\n"," For full details on the Label resource, see Label entity reference.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Query Labels"},"path":"/en-us/guides/deal-management/deal-management","content":[" Query labels visible to the entity of the caller, filtered by object type, using POST /adsApi/v1/query/labels. Supports filtering by label ID or name. Results are sorted alphabetically.\n"," For other label operations such as creating, updating labels, and managing label-object associations, contact the SupplyDesk team.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Query Labels associations"},"path":"/en-us/guides/deal-management/deal-management","content":[" Query labels associated to various objects (like Inventory Group, Deal etc.) by passing either a labelIdFilter or labelObjectIdFilter in POST /adsApi/v1/query/labelObjectAssociations. \n"," For other label association operations such as creating, deleting labels associations, contact the SupplyDesk team.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":2,"text":"Supply Management"},"path":"/en-us/guides/deal-management/deal-management","content":[],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Supplier "},"path":"/en-us/guides/deal-management/deal-management","content":[" A supplier represents a business entity directly integrated with ADSP that sends inventory to bid on. Retrieve the list of available suppliers using POST /adsApi/v1/query/suppliers.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Publisher"},"path":"/en-us/guides/deal-management/deal-management","content":[" A publisher is a business entity that owns and/or operates the apps, sites, or video streams where ads are displayed. Retrieve the list of available publishers using POST /adsApi/v1/query/publishers.\n"],"documentType":"guide"},{"title":"Getting started with Inventory Management API","sectionHeader":{"type":3,"text":"Get Seller"},"path":"/en-us/guides/deal-management/deal-management","content":[],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":null,"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" The Proposal Management API enables buyers to create and manage Programmatic Guaranteed (PG) deals with Amazon Owned and Operated (Amazon O&O) publishers, called \"Amazon Media\" in the UI, such as Prime Video and Twitch. It also supports PG and Private Auction (PA) deals with Amazon Publisher Direct (APD) and Amazon Publisher Cloud (APC) and supports Private Auction deals with Netflix.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"ADSP Proposal level hierarchy"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"How does it work?"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" For Amazon O&O publishers such as Prime Video and Twitch, buyers can create PG deals. Deals are programmatically reviewed and approved based on a set of pre-defined rules.\n"," For third-party publishers via APC and APD, the workflow follows a request-for-proposal model. Buyers submit a proposal, publishers review and respond with deal terms, and both parties can approve, reject, or counter until an agreement is reached. Once agreed, the publisher generates the deal, which becomes available directly in the proposal for activation.\n"," APC enables Signal Enhanced Deals, which combine advertiser audiences with Amazon retail, streaming, and publisher first-party signals to package deals around high-relevance content. APD supports standard deals based on available publisher inventory.\n"," For Netflix as a first-party supply source, buyers can create Private Auction deals with floor-rate pricing through the Amazon DSP Deal Proposals API. The workflow follows a buyer-initiated RFP model where buyers submit a proposal with country-level targeting and video creative specifications, and Netflix's automated seller responds with a quoted floor price and inventory forecast. Buyers can then approve, counter, or resubmit until agreement is reached.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"Supported use cases"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" The Proposals API supports four use cases. Buyers can create PG deals with Amazon O&O publishers, with automated deal proposal review and configurable supply-side targeting, budget, deal duration, frequency cap, and other deal parameters. Buyers can also propose PG and PA deals to APC and APD publishers via a request-for-proposal flow, with configurable deal parameters that depend on the selected ad product. APC additionally supports Signal Enhanced Deals, which layer advertiser audiences with Amazon and publisher signals. Netflix supports PA deals with rich audience and contextual targeting across multiple dimensions—including demographics, interests, device type, dayparting, content genre, and geography—enabling advertisers to programmatically negotiate and activate deals against Netflix's premium video inventory without manual publisher review.\n"," APC deals are great for buyers seeking enhanced control and optimization over their PG and PA buys, particularly those with AMC Audiences strategies or ID-less traffic approaches, as well as advertisers blocked from using Amazon Audiences due to policy/compliance restrictions (e.g., 3PAS creatives or competitive brands). In the APC workflow, buyers can select desired Amazon audience segments (standard or custom) that publishers securely overlay with their owned & operated signals to identify and package content that the desired audiences are most likely to watch.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"Create a proposal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" A proposal contains one or more proposed deals. To create a deal via the Proposals API, first create a proposal, then create a proposed deal that references it. The endpoints below walk through the steps to create a proposal.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Proposal Destination"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" A supplier proposal destination represents a counterparty available to a buyer for negotiating deals (e.g., Amazon O&O, APC, APD, or Netflix) and determines which publishers and ad products can be selected in subsequent steps. Retrieve the list of available suppliers using POST /adsApi/v1/query/supplierProposalDestinations.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Publisher"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Select a publisher to scope the ad products and pricing available in subsequent steps. Retrieve the list of publishers available for the selected supplier using POST /adsApi/v1/query/supplierPublishers. Currently only APD supports this feature. \n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Ad Product"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Select an ad product to define what the proposed deal will target. Retrieve the list of ad products available for the selected supplier and publisher using POST /adsApi/v1/query/supplierAdProducts.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Ad Product Price"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Retrieve the price for the selected ad product using POST /adsApi/v1/create/supplierAdProductPrices. Currently only \"Amazon Media\" supports fetching prices. In all other destinations, the counterparty will provide the price.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Proposed Deal Forecast"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" For the Amazon O&O workflow only, retrieve a forecast for the proposed deal based on the targeting, dates, price, and other deal parameters using POST /adsApi/v1/create/supplierProposedDealForecasts.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Targeting"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Optionally apply supplier-side targeting constraints to the proposed deal. Retrieve the list of targeting options available for the selected ad product using POST /adsApi/v1/query/supplierTargetItems. \n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Create Supplier Proposed Deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Create a proposed deal containing the supplierProposalDestination, publisher, ad product, price, and any optional targeting selected in the prior steps. Create the proposed deal using POST /adsApi/v1/create/supplierProposedDeals.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Create Supplier Proposal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" After creating one or more proposed deals, create the proposal that contains them using POST /adsApi/v1/create/supplierProposals.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"Modify proposal or proposed deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Proposed Deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Retrieve the proposed deals for a proposal using POST /adsApi/v1/query/supplierProposedDeals.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Update Supplier Proposed Deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Update an existing proposed deal using POST /adsApi/v1/update/supplierProposedDeals.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Proposal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Retrieve the proposals for an ADSP advertiser using POST /adsApi/v1/query/supplierProposals.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Update Supplier Proposal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Update an existing proposal using POST /adsApi/v1/update/supplierProposals. Currently Amazon O&O, APC and APD workflow supports it.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Submit Supplier Proposed Deal Revision"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Submit a revised proposed deal when a proposal is in REVIEWED, SUPPLIER_REVIEWED, or REVIEWED_PARTIAL state. The proposed deal must be APPROVED or APPROVED_CURRENT and it must be in an active state. Behavior differs by workflow. For the Amazon O&O workflow, a proposed deal can be revised after it is accepted or rejected by the publisher. Submit the revision using POST /adsApi/v1/create/supplierProposedDealRevisions. For the APD and APC workflow, once a proposal is reviewed (accepted or rejected by either party), the proposed deal cannot be revised further; during negotiation, counter responses from the buyer or publisher are recorded as revisions of the proposed deal. Netflix workflow does not support it.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Update Supplier Proposed Deal Revision"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" For the Amazon O&O workflow only, update a submitted revision using POST /adsApi/v1/update/supplierProposedDealRevisions.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Get Supplier Proposed Deal History"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Retrieve the historical versions of a proposed deal, including all prior revisions, using POST /adsApi/v1/query/supplierProposedDealHistoricalVersions. Currently only the Amazon O&O workflow uses this endpoint. The APC and APD workflows support revisions through their own negotiation flow, so they do not use this endpoint. The Netflix workflow does not support revisions. Retrieve the historical versions of a proposed deal, including all prior revisions, using POST /adsApi/v1/query/supplierProposedDealHistoricalVersions. Currently the Amazon O&O, APC, and APD workflows support this. The Netflix workflow does not.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":2,"text":"Netflix Proposal & Proposed Deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Netflix is both the supplier and the publisher, so the Netflix workflow has no publisher-selection step. Discovery goes directly from destination to ad product to targeting items. Netflix deals are Private Auction with floor-rate pricing and use video creative. Netflix supports one proposed deal per proposal, so create a separate proposal for each deal. Each Netflix ad product declares a mandatory fixed targeting group (for the United States, a LOCATION_COUNTRY group) that the proposed deal must include.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Create and submit a Netflix deal"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Query the Netflix ad products for the destination. Each product lists its deal type, pricing, budget minimum, and required targeting. After you create the proposal, create and submit the proposed deal in a single step with POST /adsApi/v1/create/supplierProposedDeals: set the deal state to PROPOSED.\n"," On create, send these required fields:\n","The product's required country targeting group. - The video creative requirements. - terms.guaranteed, terms.marketplaceDeal, and supplierProposedDealExtension.\n"," If you omit the country group or the creative requirements, Netflix rejects the deal. A create or update returns HTTP 207 with a per-item error array. An empty error array means the item succeeded, so inspect each item's error rather than the top-level HTTP status. Netflix's automated seller then responds with a quoted CPM, which sets the deal's floor price, and an inventory forecast.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Respond to a Netflix seller response"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" After Netflix responds, approve or counter through the proposed-deal endpoint POST /adsApi/v1/update/supplierProposedDeals with a deal state: set the state to PROPOSED to accept Netflix's terms, or to DRAFT to counter, then edit the terms and submit again. Approve and counter are supported only on the proposed-deal endpoint, not on update/supplierProposals. Netflix does not support supply-side frequency caps, and a Netflix proposed deal cannot be revised after you approve it.\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Netflix deal lifecycle"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Netflix uses a buyer-initiated request-for-proposal model with an automated seller. The table below lists the deal and proposal status at each step. The DRAFT and SUBMITTED rows are the two states of the single atomic create+submit call, not two separate API calls. If Netflix soft-rejects a submitted deal, the deal stays in SUBMITTED; correct the configuration (most often a missing required targeting group) and submit again.\n","| Deal status | Action (who) | New deal status | Proposal status |\n","\\|---\\|---\\|---\\|---\\|\n","| — | Create (buyer) | DRAFT | DRAFT |\n","| DRAFT | Submit (buyer, atomic state:PROPOSED) | SUBMITTED | PENDING |\n","| SUBMITTED | Respond (Netflix) | SELLER_RESPONDED | SUPPLIER_REVIEWED |\n","| SELLER_RESPONDED | Approve (buyer, state:PROPOSED) | APPROVED_PENDING_REGISTRATION | REVIEWED |\n","| SELLER_RESPONDED | Counter (buyer, state:DRAFT) | COUNTER_DRAFT | COUNTER_DRAFT |\n","| APPROVED_PENDING_REGISTRATION | Finalize (Netflix) | APPROVED | REVIEWED |\n"],"documentType":"guide"},{"title":"Getting Started with the Proposal Management API","sectionHeader":{"type":3,"text":"Netflix targeting"},"path":"/en-us/guides/deal-management/deal_proposal-management","content":[" Query selectable targeting items with POST /adsApi/v1/query/supplierTargetItems; supplierAdProductIdFilter is required on this endpoint. Netflix supports 21 target types:\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":null,"path":"/en-us/guides/deal-management/commitment-management","content":[" The Commitment Management API enables buyers to create and manage spending commitments on Amazon DSP. A commitment defines a total spend target over a specified time period and can be scoped to specific advertisers, campaigns, or deals. The API also provides spend tracking capabilities to monitor progress toward fulfilling commitments.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":2,"text":"Key concepts"},"path":"/en-us/guides/deal-management/commitment-management","content":["Commitment — A spending agreement that defines a committed spend amount, time period, and fulfillment rules. Commitments can be scoped using inclusion and exclusion lists for advertisers, campaigns, and deals. - Fulfillment level — Controls how aggressively the system prioritizes meeting the commitment target. LEVEL_0 is tracking-only, while LEVEL_5 prioritizes commitment fulfillment over campaign performance. - Spend calculation mode — Determines the aggregation level for tracking spend: manager account, advertiser account, or campaign. - Commitment spend — Tracks accrued, at-risk, and projected spend values for a commitment, broken down by dimension (advertiser, campaign, or deal).\n"," For full details on the data model, see Commitment entity reference and CommitmentSpend entity reference.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":2,"text":"Commitment Management"},"path":"/en-us/guides/deal-management/commitment-management","content":[],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"List Commitments"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Retrieve a list of commitments using GET /adsApi/v1/commitments. This endpoint returns commitments visible to the caller based on the account context.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"Create a Commitment"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Create a new commitment by specifying the commitment name, currency, committed spend amount, start and end dates, fulfillment level, and spend calculation mode. Optionally scope the commitment to specific advertisers, campaigns, or deals using inclusion or exclusion lists.\n"," Use endpoint POST /adsApi/v1/create/commitments.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"Query Commitments"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Query commitments based on sorting and filtering criteria provided in the request using POST /adsApi/v1/query/commitments. This is useful for finding commitments that match specific criteria such as date ranges, ad products, or fulfillment levels.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"Retrieve Commitments"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Retrieve commitments in bulk by providing a list of commitment IDs using POST /adsApi/v1/retrieve/commitments.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"Update a Commitment"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Update an existing commitment using POST /adsApi/v1/update/commitments. You can modify the commitment name, committed spend, dates, fulfillment level, spend calculation mode, and the advertiser, campaign, or deal inclusion and exclusion lists.\n"],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":2,"text":"Commitment Spend Tracking"},"path":"/en-us/guides/deal-management/commitment-management","content":[],"documentType":"guide"},{"title":"Getting started with Commitment Management API","sectionHeader":{"type":3,"text":"Retrieve Commitment Spend"},"path":"/en-us/guides/deal-management/commitment-management","content":[" Retrieve spend tracking details for one or more commitments using POST /adsApi/v1/retrieve/commitmentSpends. The response includes:\n","Accrued spend — The actual spend amount accrued to date in the commitment currency. - Spend at risk — The amount of spend that may not count toward the commitment. - Projected spend — The forecasted total spend based on current pacing.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":null,"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Overview"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[" This page shared details about migration from product specific endpoints to generally available unified endpoints. The new APIs are available worldwide in all marketplaces where ADSP operates.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Endpoint Equivalencies"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Product specific endpoints to unified endpoints mapping"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":["| Old endpoint | New endpoint |\n","\\| -----------  \\| ------------ \\|\n","| Inventory Management Endpoints |  |\n","| POST /adsApi/v1/create/inventoryGroups/dsp | POST /adsApi/v1/create/inventoryGroups |\n","| POST /adsApi/v1/update/inventoryGroups/dsp | POST /adsApi/v1/update/inventoryGroups |\n","| POST /adsApi/v1/query/inventoryGroups/dsp | POST /adsApi/v1/query/inventoryGroups |\n","| POST /adsApi/v1/retrieve/inventoryGroups/dsp|  POST /adsApi/v1/query/inventoryGroups|\n","| Commitment Management Endpoints |  |\n","| POST /adsApi/v1/retrieve/commitmentSpends/dsp | POST /adsApi/v1/retrieve/commitmentSpends |\n","| GET /adsApi/v1/commitments/dsp | GET /adsApi/v1/commitments |\n","| POST /adsApi/v1/create/commitments/dsp | POST /adsApi/v1/create/commitments |\n","| POST /adsApi/v1/query/commitments/dsp | POST /adsApi/v1/query/commitments |\n","| POST /adsApi/v1/retrieve/commitments/dsp | POST /adsApi/v1/retrieve/commitments |\n","| POST /adsApi/v1/update/commitments/dsp | POST /adsApi/v1/update/commitments |\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Commitments Management API migration (product specific to unified endpoints)"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[" From Commitment and CommitmentSpends endpoint perspective, we have removed /dsp from currently available Commitment APIs. Above table shares the old and new endpoint equivalents. For each endpoint we have added an optional adProduct parameter. At present we only support “Amazon_DSP” adProduct. The unified endpoints are functionally identical to the /dsp variants; the only difference is the URL pattern and the addition of an optional adProduct parameter to scope the request (replacing the implicit /dsp scoping). There are no schema changes, no request or response changes. User should:\n","Update endpoint URLs — remove /dsp from the path  2. Verify response parity (schemas are identical)  3. Remove old endpoint calls once verified \n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Inventory Management API migration (product specific to unified endpoints)"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[" From BuyerSeats, Inventory Groups, Labels, DealAdvertiserAccessEntries and DealAdvertiserAccesses APIs, we have removed /dsp from the currently available Inventory Management APIs. Above table shares the old and new endpoint equivalents. For each endpoint we have added an optional adProduct parameter. At present we only support “Amazon_DSP” adProduct. The unified endpoints are functionally identical to the /dsp variants; the only difference is the URL pattern and the addition of an optional adProduct parameter to scope the request (replacing the implicit /dsp scoping). There are no schema changes, no request or response changes. User should:\n","Update endpoint URLs — remove /dsp from the path  2. Verify response parity (schemas are identical)  3. Remove old endpoint calls once verified \n"," Please note that the POST /adsApi/v1/retrieve/inventoryGroups/dsp is replaced by POST /adsApi/v1/query/inventoryGroups endpoint.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Upcoming Legacy to Unified API migration"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[" In future, we will perform migration campaign from legacy to unified endpoints. The new inventory APIs enable self-serve advertisers and their partners to programmatically manage their Amazon DSP deals , proposal and commitments data. These new APIs replace the previous deals management APIs, previous deal performance and exchanges APIs, previous deals proposal APIs, previous deals advertiser permissions APIs and previous Inventory Group APIs.\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":3,"text":"Legacy endpoints to unified endpoints mapping"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":["| Old endpoint | New endpoint |\n","\\| -----------  \\| ------------ \\|\n","| Deal Management Legacy Endpoints |  |\n","| POST /dsp/inventorySourceDeals/list | POST /adsApi/v1/query/advertisingDeals |\n","| POST /dsp/inventory/deals/list | POST /adsApi/v1/query/advertisingDeals |\n","| PUT /dsp/inventory/deals/{dealId} | POST /adsApi/v1/update/advertisingDeals |\n","| POST /dsp/inventory/deals | POST /adsApi/v1/create/advertisingDeals |\n","| GET /dsp/inventory/deals/{dealId}/lineItems | POST /adsApi/v1/query/targets |\n","| POST /dsp/inventory/deals/inferredAttributes/list | POST /adsApi/v1/query/dealAvailses |\n","| POST /dsp/inventory/deals/{dealId}/inferredAttributes/supplySellers/list | POST /adsApi/v1/query/dealAvailses |\n","| GET /dsp/inventory/deals/{dealId}/inferredAttributes | POST /adsApi/v1/query/dealAvailses |\n","| POST /dsp/inventory/deals/performance/list | POST /adsApi/v1/query/dealPerformances |\n","| POST /dsp/inventory/deals/exchanges/list | tbd |\n","| POST /dsp/v1/seats/advertisers/create | POST /adsApi/v1/create/buyerSeats |\n","| POST /dsp/v1/seats/advertisers/current/list | GET /adsApi/v1/buyerSeats |\n","| POST /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertiser/list | n/a |\n","| DELETE /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertisers | n/a |\n","| PUT /dsp/inventory/deals/{dealId}/advertiserPermissions/recommendedAdvertisers | n/a |\n","| POST /dsp/inventory/deals/{dealId}/advertiserPermissions | n/a |\n","| GET /dsp/inventory/deals/{dealId}/advertiserPermissions | n/a |\n","| PUT /dsp/inventory/deals/{dealId}/advertiserPermissions/advertiserList | POST /adsApi/v1/create/dealAdvertiserAccessEntries, POST /adsApi/v1/delete/dealAdvertiserAccessEntries |\n","| GET /dsp/inventory/deals/{dealId}/advertiserPermissions/advertiserList | POST /adsApi/v1/query/dealAdvertiserAccessEntries, POST /adsApi/v1/retrieve/dealAdvertiserAccesses |\n","| DELETE /dsp/inventory/deals/{dealId}/advertiserPermissions | POST /adsApi/v1/delete/dealAdvertiserAccesses, POST /adsApi/v1/delete/dealAdvertiserAccessEntries |\n","| POST /dsp/seats/current/list | GET /adsApi/v1/buyerSeats |\n","| n/a | POST /adsApi/v1/query/labels |\n","| n/a | POST /adsApi/v1/query/labelObjectAssociations |\n","| n/a | POST /adsApi/v1/query/dealPlanningMetricses |\n","| Inventory Group Endpoints |  |\n","| POST /dsp/v1/inventory/inventoryGroups | POST /adsApi/v1/create/inventoryGroups |\n","| PUT /dsp/v1/inventory/inventoryGroups | POST /adsApi/v1/update/inventoryGroups |\n","| POST /dsp/v1/inventory/inventoryGroups/list | POST /adsApi/v1/query/inventoryGroups |\n","| POST /dsp/v1/inventory/eligibility/inventoryGroups/list | POST /adsApi/v1/query/inventoryGroups |\n","| n/a | POST /adsApi/v1/update/inventoryGroups |\n","| n/a | POST /adsApi/v1/query/inventoryGroups |\n","| n/a | POST /adsApi/v1/create/inventoryGroups |\n","| Proposal Management Endpoints |  |\n","| POST /dsp/inventory/proposals | POST /adsApi/v1/create/supplierProposals |\n","| PUT /dsp/inventory/proposal/{proposalId}/status | POST /adsApi/v1/update/supplierProposals |\n","| POST /dsp/inventory/proposalSource/{sourceId}/publisherProduct/{publisherProductId}/rate | POST /adsApi/v1/create/supplierAdProductPrices |\n","| POST /dsp/inventory/proposalSource/{sourceId}/publisherProducts/list | POST /adsApi/v1/query/supplierAdProducts |\n","| POST /dsp/inventory/proposalSource/{sourceId}/publishers/list | POST /adsApi/v1/query/supplierPublishers |\n","| POST /dsp/inventory/proposalSources/amazonMedia/{amazonMediaPublisherId}/signals/collections/list | POST /adsApi/v1/query/supplierTargetItems |\n","| POST /dsp/inventory/proposalSources/list | POST /adsApi/v1/query/supplierProposalDestinations |\n","| POST /dsp/inventory/proposalSource/{sourceId}/productOfferings/list | POST /adsApi/v1/query/supplierAdProducts |\n","| n/a | POST /adsApi/v1/query/supplierProposals |\n","| n/a | POST /adsApi/v1/query/supplierProposedDeals |\n","| n/a | POST /adsApi/v1/create/supplierProposedDeals |\n","| n/a | POST /adsApi/v1/create/supplierProposedDealRevisions |\n","| n/a | POST /adsApi/v1/update/supplierProposedDealRevisions |\n","| n/a | POST /adsApi/v1/create/supplierProposedDealForecasts |\n","| n/a | POST /adsApi/v1/query/supplierProposedDealHistoricalVersions |\n","| n/a | POST /adsApi/v1/update/supplierProposedDeals |\n"],"documentType":"guide"},{"title":"Migrating to the new Amazon DSP Campaign Management API","sectionHeader":{"type":2,"text":"Versioning"},"path":"/en-us/guides/deal-management/adsp-deal-proposal-migration","content":[],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":null,"path":"/en-us/guides/events/events","content":[" The Amazon Events API helps Amazon DSP, SD, and STV advertisers evaluate the effectiveness of their Amazon marketing campaigns, no matter the location of the conversion, and use this information to optimize their campaigns. \n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":2,"text":"What does it do? "},"path":"/en-us/guides/events/events","content":[" With this API, Amazon DSP advertisers can send real-time or offline conversion event data via server-to-server integration. It can be used to send data directly from the server of an advertiser to Amazon Ads or from the preferred Customer Data Platform (CDP) of the advertiser. This allows advertisers to evaluate the effectiveness of their Amazon marketing campaigns, regardless of the location of the conversion, and use this information to drive campaign optimization. The Events API can help strengthen performance and decrease cost per action (CPA) with more complete attribution, improved data reliability, richer audience creation and better optimized delivery. It also serves as a complementary method to Amazon Ad Tag (AAT) for sending website events, because the browser-based tracking is susceptible to ad blockers, browser privacy settings, and cookie limitations. The Events API, on the other hand, sends data directly from your server, bypassing these limitations and ensuring more reliable data collection. This leads to more accurate conversion tracking and better insights for campaign optimization. Additionally, the Events API lets you send more user identifiers (like email, phone number, and rampID) and information about the user journey.\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/events/events","content":[" For how to set up and access the Ads API, see our onboarding and authentication docs. \n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":2,"text":"The datasets concept "},"path":"/en-us/guides/events/events","content":[" The Events API relies on the concept of Datasets, previously used by Ads data manager (ADM). In ADM, datasets represents a grouping of uploaded advertiser data. A dataset closely resembles a data table, comprising attributes (columns), records (rows), and metadata (like the dataset name and the schema template used to create the dataset). Learn more about datasets. \n"," Dataset rules:\n","Dataset names are immutable. Advertisers can optionally name their dataset when setting up their CDP connection or when configuring each event. Once a dataset name is set, it cannot be changed.  Changing the dataset name will result in creating a new conversion definition with the new dataset name.  When building an integration with Amazon Ads, we require CDPs, agencies, and other partners to allow customers to include dataset names as an optional value at the connector level, with the ability to override at an event level.  For existing integrations with Conversions API (CAPI v1) and Events API (closed beta), a default dataset name has already been assigned.  We recommend that advertisers sending data through the Events API for the first time include a dataset name to help organize their conversion definitions. When a dataset name is not provided, new conversion definitions will be assigned to the default_events dataset.\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":2,"text":"Send events "},"path":"/en-us/guides/events/events","content":[" Import events with POST /adsApi/v1/create/events, using the following header parameters: \n","| Name | Description | Data type | Required or optional? |\n","\\|---\\|---\\|---\\|---\\|\n","| Amazon-Ads-ClientId | The identifier of a client associated with a \"Login with Amazon\" account. | string | Required |\n","| Amazon-Ads-AccountId | Account identifier you use to access the DSP. This is your DSP Advertiser ID. This header is required for access to any DSP data. | string | Required |\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":3,"text":"Request schema and sample event data"},"path":"/en-us/guides/events/events","content":[" Schema\n"," API requirements:\n","Each request can contain 1-500 events  Required fields are marked with (required)  Normalize and SHA-256 hash PII match keys. Do not hash MAID, RAMP_ID, MATCH_ID, REAL_ID, MERKLE_ID, KANTAR_ID, or AREF_TOKEN; send FIP as a plaintext IP address  For EU advertisers, consent information is required  Timestamps must be in ISO format  Currency values must have maximum 2 decimal places  Country codes must be in ISO 3166-1 alpha-2 format\n"," Some examples are provided below.\n"," Example: Basic purchase event\n"," Example: Lead generation event\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":3,"text":"Description"},"path":"/en-us/guides/events/events","content":["| Field name | Data type | Description | Required or optional? |\n","\\|---\\|---\\|---\\|---\\|\n","| name | String | The name of the imported event. Example: My Event Name | Required |\n","| conversionType | String | The standard Amazon event type associated with the event and used for reporting. See event types supported. Example: Add to Shopping Cart | Required |\n","| eventSource | String | The platform from which the event was sourced. Example: WEBSITEENUM: ANDROID, FIRE_TV, IOS, OFFLINE, WEBSITE, MEASUREMENT_ATTRIBUTION_PARTNER | Required |\n","| eventIngestionMethod | String | This value should be set to SERVER_TO_SERVER for events sent via Events API | Required |\n","| dataSetName | String | Event Dataset Name to which this event should be added. | Optional |\n","| partner | String | The name of the third-party service used to deliver the events (if applicable). | Optional |\n","| eventTime | String | The reported timestamp of when the event occurred in ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD).For example, 2025-02-17T15:02:33ZThe timestamp can be up to 21 days before you send an event. Greater than 21 days latent data will not be processed. | Required |\n","| amazonAdEventKey | String | Amazon Traffic identifier for post attributed events (if applicable). | Optional |\n","| eventId | String | The advertiser-specified id for the conversion event. For events with the same clientDedupeId only the first event will be kept. All subsequent events with the same clientDedupeID will be dropped. Intended to be used for data redundancy. Example: 3234A398932 | Optional |\n","| matchKeys | Array | Array representing the user and device identifier types/values to be used for attribution to traffic events. EMAIL, PHONE, FIRST_NAME, LAST_NAME, ADDRESS, CITY, STATE, and POSTAL must follow the formatting guidelines before SHA-256 hashing. Send MAID, RAMP_ID, MATCH_ID, REAL_ID, MERKLE_ID, KANTAR_ID, and AREF_TOKEN without SHA-256 hashing. Send FIP as a plaintext IPv4 or IPv6 address. ADID, IDFA, or FIREADID can be passed into the MAID field. | Required |\n","| matchKeys > type | String | The identifier type used for attribution. Example: EMAIL | Required |\n","| matchKeys > values | Array | The identifier value used for attribution. Its format is determined by the selected match key type.Array of size 1 | Required |\n","| value | Number (double) | The value of the event\\*. Example: 5 or 0.99When the conversionType of the associated event template is not OFF_AMAZON_PURCHASES, this represents a non-monetary value based on a scale of your choosing. Can be negative and must not exceed 2 decimal points. If not provided, the static value provided on the event template will be used. | Optional |\n","| currencyCode | String | The currencyCode associated with the value of the event in ISO-4217 format. Only applicable for Off Amazon Purchases event type. If not provided, the currencyCode setting on the conversion definition will be used. Example: AED, AUD, BRL, CAD, CNY, EUR, GBP, INR, JPY, MXN, SAR, SEK, SGD, TRY, USD | Optional |\n","| unitsSold | integer | The number of items purchased. Only applicable for Off Amazon Purchases event type. If not provided on the conversion event, a default of 1 will be applied. | Optional |\n","| countryCode | String | This value is based on ISO 3166-1 alpha-2, two-letter country codes defined in ISO 3166-1, part of the ISO 3166 standard published by the International Organization for Standardization (ISO), to represent countries, dependent territories, and special areas of geographical interest. | Required |\n","| dataProcessingOptions | String | A flag for signaling how an event shall be processed. Events marked for limited data use will not be processed. Example: LIMITED_DATA_USE | Optional |\n","| customData | Array | Custom data associated with the event. | Optional |\n","| customData > name | String | Name of the custom attribute. Only letters, numbers and the underscore character are allowed. For example, brand, category, productId. | Required |\n","| customData > dataType | String | Data type of the custom attribute.ENUM: INTEGER, TIMESTAMP, STRING | Optional |\n","| customData > value | Array | Value of the custom attribute. Only letters, numbers and the underscore character are allowed. | Required |\n","| consent | Object | Describes consent given by the user associated with the conversion event to have their data used for advertising purposes. For EU advertisers, it is required to provide one of geo, amazonConsent, tcf | Optional |\n"," Capture the 10-character aref token from the ad landing-page URL and record the landing-page time as a 13-digit UTC epoch-millisecond timestamp. Send them as a token.timestamp pair in the single AREF_TOKEN values item. If you retain tokens in a first-party cookie, preserve each token's landing-page timestamp. The item can contain one to 147 pipe-separated pairs. Tokens are case-sensitive and alphanumeric. A token is ignored for attribution if its timestamp is after eventTime or more than 30 days before it. AREF_TOKEN can be the only match key for attribution, but a token-only event is not added to an Ads Data Manager dataset. Include another supported identity match key if the event must also appear in Ads Data Manager.\n"," For example:\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":2,"text":"Providing consent signals"},"path":"/en-us/guides/events/events","content":[" If you transmit or make available to Amazon Ads any personal information in connection with your use of any Amazon advertising services in the UK and EEA, you must share a valid consent signal and the country code in which consent was granted by the customer.\n"," You can either use (i) the IAB European Transparency & Consent Framework (TCF) signal(s), (ii) Global Privacy Policy (GPP) or (iii) Amazon Consent Signal, to communicate UK and EEA users' privacy choices to Amazon Ads.\n"," Notes on use: \n","Do not send multiple signals. If multiple signals are provided, Amazon Ads will use TCF and ignore ACS. \\* Country code is required. Data uploaded without specifying a country code will be rejected. The country code is a 2-character string in the ISO 3166 format that indicates in which country the consent was given (for example, US, GB or DE).\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":3,"text":"What is Amazon Consent Signal?"},"path":"/en-us/guides/events/events","content":[" In addition to supporting the Transparency & Consent Framework (TCF) signal from the Interactive Advertising Bureau (IAB) and Global Privacy Policy (GPP), Amazon Ads has introduced Amazon Consent Signal (ACS) which enables advertisers and third parties to transmit the privacy choices of end users to Amazon Ads. There are three required parameters:\n"," CountryCode: The Country Code indicates where consent was given by the user. Acceptable values: 2-character ISO 3166 format (for example, US, GB, DE).\n"," amzn_user_data: Indicates whether the user has consented to Amazon processing personal data (for example, an advertising identifier) for advertising purposes. Acceptable values are GRANTED or DENIED.\n"," amzn_ad_storage: Indicates whether the user has given Amazon consent to read or write advertising cookies or similar technologies on the device of the user. Accepted inputs: GRANTED, DENIED, OR NULL.\n"," Note: When amzn_ad_storage is not relevant, you can use a value of NULL or exclude the parameter.\n","| Field name | Description | Required or optional? | Type |\n","\\|---\\|---\\|---\\|---\\|\n","| amazonConsent > amznAdStorage | Whether the user has consented to cookie based tracking.Enum: GRANTED Consent has been granted.DENIED Consent has been denied.  | optional | String |\n","| amazonConsent > amznUserData | Whether the user has consented to use personal data for advertising purposes.Enum: GRANTED Consent has been granted.DENIED Consent has been denied.  | optional | String |\n","| tcf | An encoded Transparency and Consent Framework (TCF) string describing what the user has consented to. This string contains information about user consent choices in a compressed format. | optional | String |\n","| gpp | An encoded Global Privacy Platform (GPP) string describing what the user has consented to. This string encapsulates user privacy preferences and consent information in a compact format. | optional | String |\n"," Example: Consent object\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":2,"text":"Batch requests"},"path":"/en-us/guides/events/events","content":[" You can send up to 500 events in eventData. However, for optimal performance, we recommend you send events as soon as they occur. Sending events as soon as they occur allows us to attribute the events accurately and utilize these events for optimization. If any event you send in a batch is invalid, we still accept the valid events in the batch.\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":2,"text":"Event de-duplication"},"path":"/en-us/guides/events/events","content":[" If you have implemented Amazon advertising tag (AAT) and intend to send the same events through both AAT and Amazon Events API to Amazon Ads, you will need to set up de-duplication.\n"," De-duplication is not required if distinct event types are being sent from the client (AAT) and server (Events API) without any overlap. To ensure that your reporting is not negatively impacted, you must make sure that any single event that is shared by AAT and the Amazon Events API is de-duplicated. When sending shared events, make sure that every event includes eventId.\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":2,"text":"Custom attributes"},"path":"/en-us/guides/events/events","content":[" You can now name custom attributes. The Events API supports ten custom attributes and three additional attributes (brand, productId, and category) describing the product. These attributes can be specified in the customData object. All the custom attributes are available in AMC. If you send attributes for brand, productId, or category, these attributes are also available in Amazon DSP reporting.\n"," Example: Custom attributes/data\n"," Note : Named custom-attributes are currently only available to be reported on through Amazon Marketing Cloud (AMC). For use of custom attributes in DSP campaigns please continue to use 'attr1' to 'attr10' as the name for the custom attribute.\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":2,"text":"Test events"},"path":"/en-us/guides/events/events","content":[" After you send your events, they may take up to two hours to show up in your Amazon account. Verify they are there by looking in the Events Manager: from the Events Manager, click on the Conversions tab. In the table, you can see the events sent, along with total event count and last activity. \n"," You can also see these events in the Ads Data Manager as conversion data sets. You can use the data sharing options in ADM to share data with other advertiser accounts within the same region. Learn more about data sharing in ADM.\n"],"documentType":"guide"},{"title":"Getting started with the Events API","sectionHeader":{"type":2,"text":"FAQs"},"path":"/en-us/guides/events/events","content":[" This is a common use case for Events API advertisers. Follow these steps to use the extension: \n","Ask the agency to provide access to the specific advertiser account (where they wish to run your campaigns) within their agency. Events Manager must be given 'View and Edit' permission. Learn more about inviting users. \\* Use the Amazon Events API to send data to the specific account they have been given access to in the previous step.\n"," No, the Events API automatically creates conversion definitions based on the fields in the Event Description object. A single conversion is created for events with the same Event name, Conversion Type, Event Source, Event Ingestion Method and Dataset name. The Events API allows you to name the dataset at the time of sending the event.\n"," Example: Event description used when creating a new conversion definition\n"," Yes, you can reuse your existing conversion definition or create new conversion definition with a new dataset. In Events API, Conversion Definition is defined by the fields within the Event Description object. The Event Description object in the Events API includes four required (Event Name, Conversion Type, Event Source and Ingestion Method) and 1 optional (Dataset Name) field. These five fields together inform the uniqueness criteria for the Conversion Definition. When no Dataset name is included in the event description, the Conversion Definition will be assigned to an existing or a default dataset. Events API introduces the use of datasets to help organize data and for easier data governance. The dataset name is included in the uniqueness criteria at the time of creation of conversion definition. Because of this reason events sent through Events API will be added to a new conversion definition based on the uniqueness criteria of the conversion definition. \n"," Advertisers migrating from CAPI v1 to Events API open beta have two options:\n","Use their existing Conversion Definitions: Advertisers that want to use their existing conversion definitions must send the same Event Name, Conversion Type, Event Source and Ingestion Method as their original Conversion Definition. It is important that you do not add a dataset name to the Event Description object. On the ADM side we will use the existing dataset name corresponding to the conversion definition. You can view the dataset name corresponding to the conversion definition in the ADM UI.  2. Create new Conversion Definitions and Dataset: Advertisers migrating from CAPI v1 to Events API open beta that want to create new conversion definition and dataset can send a new Event Description including a new dataset name. If you have any active campaigns and audiences you must follow the steps outlined below:\n"," Advertisers using CDP integrations should also refer to the documentation of their CDP for the updated experience from the connector UI of their CDP.  \n"," If you do not have any existing CAPI conversion definitions that you want to reuse, we recommend including a meaningful dataset name in the Event Description as a best practice. Including a dataset name helps you organize your conversion definitions within the dataset. Datasets are particularly useful when using ADM for data sharing, as you can share a dataset with one or more advertiser or manager accounts and all the conversion definitions within it. Another way datasets can help you organize your data is through grouping similar events tracked across multiple websites or locations. For example, you can create separate datasets for each website to help organize your events across sites.\n"," The Events API offers additional capabilities, such as higher transactions per second (TPS), and larger batch size of up to 500 events per request. Below are some notable differences:\n"," Dataset name: The open beta release introduces the concept of datasets. This is a required field that would enable Amazon Ads to organize advertiser data into separate tables grouped by the dataset name. Learn more about datasets in Ads Data Manager.\n"," Criteria for creating new conversion definition: Fields listed in eventDescription define the uniqueness criteria for a conversion definition. Events with the same Name, Conversion Type, Event Source, Event Ingestion Method, and Dataset Name will be added to the same Conversion Definition.\n"," Consent data: We added a new consent object that allows advertisers to capture user consent and share with Amazon DSP.\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":null,"path":"/en-us/guides/dsp/geo-insights-activation","content":[" GIA lets advertisers discover and act on regional growth opportunities using Amazon first-party retail insights combined with their own geographic data. Amazon Ads API enables advertisers to bring their own indexed data to leverage geographic optimization opportunities.\n","\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/dsp/geo-insights-activation","content":["An Amazon DSP account - Amazon Marketing Cloud (AMC) access (for Amazon Sales Index creation), or your own pre-calculated index data - Active ad groups (for location optimization)\n","\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":2,"text":"Data Model"},"path":"/en-us/guides/dsp/geo-insights-activation","content":["\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":2,"text":"API Endpoints"},"path":"/en-us/guides/dsp/geo-insights-activation","content":["| Operation | Method | Path |\n","\\|---\\|---\\|---\\|\n","| Create location index | POST | /adsApi/v1/create/locationIndexes |\n","| Update location index | POST | /adsApi/v1/update/locationIndexes |\n","| Retrieve location index by ID | POST | /adsApi/v1/retrieve/locationIndexes |\n","| List location indexes | GET | /adsApi/v1/locationIndexes |\n","| Create geo location (smart location) | POST | /adsApi/v1/create/geoLocations |\n","\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":2,"text":"Workflow"},"path":"/en-us/guides/dsp/geo-insights-activation","content":[],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":3,"text":"Step 1: Create a Location Index"},"path":"/en-us/guides/dsp/geo-insights-activation","content":[" Create a named location index with postal code performance data.\n"," Direct index values (pre-calculated scores):\n"," Constituent index values (brand + category sales — system calculates index):\n"," Response (207):\n"," Index data is processed asynchronously. The status field will be PENDING in the initial response and transition to either ENABLED (success) or FAILED (error during processing). Poll the retrieve endpoint to check the status before creating smart locations that reference the index.\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":3,"text":"Step 2: Create a Smart Location"},"path":"/en-us/guides/dsp/geo-insights-activation","content":[" Create a smart location that references the location index and defines the percentile range to target.\n"," Response (207):\n"," SmartLocation fields:\n","| Field | Type | Required | Description |\n","\\|---\\|---\\|---\\|---\\|\n","| locationIndexId | string | ✓ | ID of the location index to use |\n","| minIndexValuePercentile | integer (0–100) | ✓ | Lower bound of the percentile range to target |\n","| maxIndexValuePercentile | integer (0–100) | ✓ | Upper bound of the percentile range to target |\n","| name | string | ✓ | Human-readable name for the smart location |\n","\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":2,"text":"Updating a Location Index"},"path":"/en-us/guides/dsp/geo-insights-activation","content":[" Replace the index data for an existing location index. This will automatically apply to all smart locations currently using this index.\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":2,"text":"Retrieving Location Indexes"},"path":"/en-us/guides/dsp/geo-insights-activation","content":[" By ID:\n"," List all:\n","\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":2,"text":"Adding Smart Locations to Ad Groups"},"path":"/en-us/guides/dsp/geo-insights-activation","content":[" Smart locations are added to ad groups the same way as any other geo location target (postal codes, cities, countries, etc.) — via the Campaign Management Targets API.\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":3,"text":"Add a smart location target to an ad group"},"path":"/en-us/guides/dsp/geo-insights-activation","content":[],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":3,"text":"Remove a smart location target from an ad group"},"path":"/en-us/guides/dsp/geo-insights-activation","content":["\n"],"documentType":"guide"},{"title":"Geographic Insights and Activation API","sectionHeader":{"type":2,"text":"API Reference Links"},"path":"/en-us/guides/dsp/geo-insights-activation","content":[],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":null,"path":"/en-us/guides/account-management/linked-accounts","content":[" The Linked Accounts API provides access to relationship data between advertising accounts. Users can query, update, and remove account links programmatically. Manager Account users can retrieve information about all accounts directly linked to their Manager Account, while advertiser account users can discover which Manager Accounts are associated with their account. This API helps users manage account structure and access relationships within their advertising environment.\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":2,"text":"Account linking model"},"path":"/en-us/guides/account-management/linked-accounts","content":[" Both Sponsored Ads and Amazon DSP (ADSP) accounts follow a one-to-many linking model, where a single Manager Account can be associated with multiple advertiser accounts. In both cases, the links are directional from the Manager Account to the advertiser account and support visibility and access management across accounts.\n"," The key difference lies in how these links are structured:\n","For Sponsored Ads, each link is defined by the Manager Account, the advertiser account, the type of access being granted, and the countries where that access is applicable. To ensure consistency and prevent redundancy, the system disallows multiple links between the same pair of accounts for the same country. \\* For ADSP accounts, the link is determined by the identity of the advertiser and the region in which it operates. While ADSP accounts currently rely on a legacy identifier for account-level operations, this identifier will soon be replaced by a standardized format consistent with Sponsored Ads accounts. This change will not affect existing links, and the legacy identifiers will continue to appear in API responses for backward compatibility.\n"," Manager Accounts can also be linked to multiple other Manager Accounts. This one-to-many model allows hierarchical account structures, where a Manager Account may act as both a parent and a child in different relationships. As with advertiser accounts, the links between Manager Accounts are directional and subject to authorization controls.\n"," The linked accounts API returns only direct children of the account specified in the request. To view the accounts linked to a child manager account, send an additional request using that account's ID as Amazon-Ads-Manager-AccountId.\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Supported roles"},"path":"/en-us/guides/account-management/linked-accounts","content":["| Account type | ADMIN | EDITOR | VIEWER | REPORTS_LIMITED | DATA_SHARING |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| Manager Account | ✓ | ✓ | ✓ | — | — |\n","| Global Account with both SA and DSP | ✓ | ✓ | ✓ | ✓ | ✓ |\n","| Global Account with SA only | ✓ | ✓ | ✓ | — | — |\n","| Global Account with DSP only | — | — | — | ✓ | ✓ |\n","| Standalone ADSP | — | — | — | ✓ | ✓ |\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":2,"text":"Listing linked accounts"},"path":"/en-us/guides/account-management/linked-accounts","content":[" The POST /adsApi/v1/query/accountLinks endpoint supports two operations: listing child accounts linked to a Manager Account, and listing parent Manager Accounts associated with a given account. Child account queries can only be performed using a Manager Account as input, while parent account queries are supported for any account type, including Sponsored Ads accounts, ADSP advertiser accounts, and Manager Accounts. In both cases, the user must be authorized to access the specified account.\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Required headers"},"path":"/en-us/guides/account-management/linked-accounts","content":[" Please follow the getting started guide for the Amazon Ads API to provide correct credentials for the following required headers:\n","Amazon-Advertising-API-ClientId - Authorization\n"," In addition, the Linked Accounts API requires one of two account identification headers, depending on the type of query:\n","For child account queries, include the Amazon-Ads-Manager-AccountId header. This should be set to the Manager Account ID for which you want to retrieve linked child accounts. - For parent account queries:\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Pagination"},"path":"/en-us/guides/account-management/linked-accounts","content":[" The Linked Accounts API supports paginated responses. If a response includes a nextToken, you can retrieve the next page of results by including that token in the request body of a subsequent call to the same endpoint.\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Request parameters"},"path":"/en-us/guides/account-management/linked-accounts","content":[" The request body for POST /adsApi/v1/query/accountLinks supports the following parameters:\n","relationshipTypeFilter.include\n","maxResults\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Response fields"},"path":"/en-us/guides/account-management/linked-accounts","content":[" The response from POST /adsApi/v1/query/accountLinks contains an accountLinks array. Each element in this array represents a link between two accounts and includes metadata about the linked account and the nature of the relationship.\n","| Field | Description |\n","\\| ----- \\| ----- \\|\n","| accountLinkId | An encoded identifier for the account link. Use this value when calling the Update or Delete endpoints to target a specific link. |\n","| accountId | A unique identifier for the linked account. For advertiser accounts, this may be a legacy numeric ID or a standardized Amazon Ads account ID in the format amzn1.ads-account.g.\\*. |\n","| accountName | The display name of the linked account, as defined by the account owner. |\n","| accountType | The type of the linked account. Supported values include: ADVERTISER_ACCOUNT – for Sponsored Ads or ADSP advertiser accountsMANAGER_ACCOUNT – for Manager Accounts |\n","| adProductGroups | A list of advertising product groups associated with the linked account. This may include: \"SPONSORED_ADS\" – for Sponsored Products, Sponsored Brands, or Sponsored Display\"ADSP\" – for Amazon DSP Manager Accounts may return an empty list if they are not explicitly associated with a specific ad product. |\n","| alternateIds | A list of legacy or region-specific identifiers associated with the account. For ADSP accounts, this includes: dspAdvertiserId – the original ADSP ID used before account unificationregion – the ADSP region code where the account operates (e.g., \"NA\")Sponsored Ads and Manager Accounts may return an empty list. |\n","| countryCode | A list of ISO 3166-1 alpha-2 country codes representing the countries where the linked relationship applies. A single link may span multiple countries. |\n","| permissionSet | An object describing the access granted to the Manager Account over the linked account. This may include: role – a high-level access role such as ADMIN or EDITORcustomPermissionSet – a list of specific permission names (e.g., DATA_SHARING, REPORTS_LIMITED) that define fine-grained access controlsAccounts may include both a role and custom permissions, depending on the configuration. |\n","| relationshipType | Indicates the direction of the link relative to the queried account. Possible values are:CHILD – the returned account is a child of the queried Manager AccountPARENT – the returned account is a parent Manager Account of the queried account |\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Usage examples"},"path":"/en-us/guides/account-management/linked-accounts","content":[" Request header:\n"," Request body:\n"," Response:\n"," Request header:\n"," Request body:\n"," Response:\n"," Request header:\n"," Request body:\n"," Response:\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":2,"text":"Updating linked accounts"},"path":"/en-us/guides/account-management/linked-accounts","content":[" The POST /adsApi/v1/update/accountLinks endpoint updates the permission level or marketplace restrictions of one or more existing account links. Only admins of the child account can update a link. Up to 50 account links can be updated per request.\n"," This API operates at the global account level. When updating a link to a Global Account or Single Global Account, the permissions are applied across all marketplaces under that account unless restricted by countryCode.\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Required headers"},"path":"/en-us/guides/account-management/linked-accounts","content":[" Please follow the getting started guide for the Amazon Ads API to provide correct credentials for the following required headers:\n","Amazon-Advertising-API-ClientId - Authorization\n"," In addition, include one of the following account identification headers:\n","Amazon-Ads-AccountId — The account ID of the caller (Global Account ID or ADSP Advertiser ID). - Amazon-Ads-Manager-AccountId — The Manager Account ID of the caller, if the caller is acting as a Manager Account.\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Request parameters"},"path":"/en-us/guides/account-management/linked-accounts","content":[" The request body for POST /adsApi/v1/update/accountLinks contains an accountLinks array with up to 50 items. Each item specifies the link to update and the new permissions to apply.\n","accountLinks\\[].accountLinkId\n","accountLinks\\[].permissionSet\n","accountLinks\\[].countryCode\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Response fields"},"path":"/en-us/guides/account-management/linked-accounts","content":[" The response uses HTTP 207 with per-item results in a success array and an error array.\n","| Field | Description |\n","\\| ----- \\| ----- \\|\n","| success\\[].index | The 0-based position of the item in the request array. |\n","| success\\[].accountLink.accountLinkId | The encoded account link identifier from the request. |\n","| success\\[].accountLink.permissionSet | The updated permission set. |\n","| success\\[].accountLink.countryCode | The marketplace restrictions applied, if any. |\n","| error\\[].index | The 0-based position of the failed item in the request array. |\n","| error\\[].errors\\[].code | Error code (e.g., NOT_FOUND, BAD_REQUEST, UNAUTHORIZED). |\n","| error\\[].errors\\[].message | Human-readable error description. |\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Usage examples"},"path":"/en-us/guides/account-management/linked-accounts","content":[" Request header:\n"," Request body:\n"," Response:\n"," Request header:\n"," Request body:\n"," Response:\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":2,"text":"Unlinking accounts"},"path":"/en-us/guides/account-management/linked-accounts","content":[" The POST /adsApi/v1/delete/accountLinks endpoint removes one or more existing account links. Either the parent Manager Account admin or the child account admin can unlink. Up to 50 account links can be removed per request.\n"," Unlinking removes the entire relationship between the two accounts. It is not possible to unlink at the individual marketplace level. To modify marketplace restrictions without removing the link, use the Update endpoint instead.\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Required headers"},"path":"/en-us/guides/account-management/linked-accounts","content":[" Please follow the getting started guide for the Amazon Ads API to provide correct credentials for the following required headers:\n","Amazon-Advertising-API-ClientId - Authorization\n"," In addition, include one of the following account identification headers:\n","Amazon-Ads-AccountId — The account ID of the caller (Global Account ID or ADSP Advertiser ID). - Amazon-Ads-Manager-AccountId — The Manager Account ID of the caller, if the caller is acting as a Manager Account.\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Request parameters"},"path":"/en-us/guides/account-management/linked-accounts","content":[" The request body for POST /adsApi/v1/delete/accountLinks contains an accountLinkIds array of up to 50 encoded account link identifier strings.\n","accountLinkIds\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Response fields"},"path":"/en-us/guides/account-management/linked-accounts","content":[" The response uses HTTP 207 with per-item results in a success array and an error array.\n","| Field | Description |\n","\\| ----- \\| ----- \\|\n","| success\\[].index | The 0-based position of the item in the request array. |\n","| success\\[].accountLink.accountLinkId | The encoded account link identifier from the request. |\n","| error\\[].index | The 0-based position of the failed item in the request array. |\n","| error\\[].errors\\[].code | Error code (e.g., NOT_FOUND, BAD_REQUEST, UNAUTHORIZED). |\n","| error\\[].errors\\[].message | Human-readable error description. |\n"],"documentType":"guide"},{"title":"Linked accounts","sectionHeader":{"type":3,"text":"Usage example"},"path":"/en-us/guides/account-management/linked-accounts","content":[" Request header:\n"," Request body:\n"," Response:\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":null,"path":"/en-us/guides/account-management/account-link-invites","content":[" The Account Link Invites API enables you to programmatically create and manage invitations to link advertising accounts. A Manager Account admin can initiate an invitation to request access to an advertiser account, streamlining account onboarding at scale.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Invitation model"},"path":"/en-us/guides/account-management/account-link-invites","content":[" An account link invite represents a request to create a relationship between two accounts. The invite does not grant any permissions — permissions are granted only when the invite is approved.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Invite type"},"path":"/en-us/guides/account-management/account-link-invites","content":[" Each invitation has an inviteType of REQUEST_ACCESS: the requester is a Manager Account requesting access to a child account, and the approver (the child account admin) sets permissions when they approve the invitation. The Manager Account always receives access and the child account always grants access.\n"," Set approverAccount to the account ID of the child account you are requesting access to.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Invitation lifecycle"},"path":"/en-us/guides/account-management/account-link-invites","content":[" All invitations are created in PENDING status and are single-use. An invitation can have the following statuses:\n","| Status | Description |\n","\\| --- \\| --- \\|\n","| PENDING | Awaiting action from the approver |\n","| APPROVED | Approver accepted; account link(s) created |\n","| REJECTED | Approver declined the invite |\n","| REVOKED | Requester withdrew the invite |\n","| EXPIRED | Invite expired after 30 days without action |\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Supported roles"},"path":"/en-us/guides/account-management/account-link-invites","content":["| Account type | ADMIN | EDITOR | VIEWER | REPORTS_LIMITED | DATA_SHARING |\n","\\| --- \\| --- \\| --- \\| --- \\| --- \\| --- \\|\n","| Manager Account | ✓ | ✓ | ✓ | — | — |\n","| Global Account with both SA and DSP | ✓ | ✓ | ✓ | ✓ | ✓ |\n","| Global Account with SA only | ✓ | ✓ | ✓ | — | — |\n","| Global Account with DSP only | — | — | — | ✓ | ✓ |\n","| Standalone ADSP | — | — | — | ✓ | ✓ |\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Creating invitations"},"path":"/en-us/guides/account-management/account-link-invites","content":[" The POST /adsApi/v1/create/accountLinkInvites endpoint creates one or more invitations. Only admins of the requester account can create invitations. Up to 50 invitations can be created per request.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Required headers"},"path":"/en-us/guides/account-management/account-link-invites","content":[" Please follow the getting started guide for the Amazon Ads API to provide correct credentials for the following required headers:\n","Amazon-Advertising-API-ClientId - Authorization\n"," In addition, include one of the following account identification headers:\n","For Manager Account callers, include Amazon-Ads-Manager-AccountId. - For advertiser account callers, include Amazon-Ads-AccountId.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Request parameters"},"path":"/en-us/guides/account-management/account-link-invites","content":["inviteType\n","approverAccount\n","accountLinkPermissions\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Response fields"},"path":"/en-us/guides/account-management/account-link-invites","content":[" The response uses HTTP 207 with per-entry results:\n","| Field | Description |\n","\\| --- \\| --- \\|\n","| success\\[].index | The 0-based position of the successful entry in the request array |\n","| success\\[].accountLinkInvite.accountLinkInviteId | The unique identifier for the created invitation |\n","| error\\[].index | The 0-based position of the failed entry in the request array |\n","| error\\[].errors\\[].code | Error code (BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, TOO_MANY_REQUESTS, INTERNAL_ERROR) |\n","| error\\[].errors\\[].message | Human-readable error description |\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Usage example"},"path":"/en-us/guides/account-management/account-link-invites","content":[" The Manager Account requests access to a known child account. Permissions are not set at creation; the child account admin provides them at approval.\n"," Request body:\n"," Response:\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Approving invitations"},"path":"/en-us/guides/account-management/account-link-invites","content":[" The POST /adsApi/v1/update/accountLinkInvites endpoint approves one or more invitations. The caller must be an admin of the approver account. Up to 50 invitations can be approved per request.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Required headers"},"path":"/en-us/guides/account-management/account-link-invites","content":["Amazon-Advertising-API-ClientId - Authorization\n"," In addition, include one of the following account identification headers:\n","For Manager Account callers, include Amazon-Ads-Manager-AccountId. - For advertiser account callers, include Amazon-Ads-AccountId.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Request parameters"},"path":"/en-us/guides/account-management/account-link-invites","content":["accountLinkInviteId\n","accountLinkPermissions\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Response fields"},"path":"/en-us/guides/account-management/account-link-invites","content":["| Field | Description |\n","\\| --- \\| --- \\|\n","| success\\[].index | The 0-based position of the successful entry in the request array |\n","| success\\[].accountLinkInvite.accountLinkInviteId | The approved invitation ID |\n","| success\\[].accountLinkInvite.accountLinkPermissions\\[].linkResult | Outcome per entry: SUCCESS or FAILED |\n","| success\\[].accountLinkInvite.accountLinkPermissions\\[].linkResultMessage | Detail message when linkResult is FAILED |\n","| error\\[].index | The 0-based position of the failed entry in the request array |\n","| error\\[].errors\\[].code | Error code (BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, TOO_MANY_REQUESTS, INTERNAL_ERROR) |\n","| error\\[].errors\\[].message | Human-readable error description |\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Usage example"},"path":"/en-us/guides/account-management/account-link-invites","content":[" The child account approver provides permissions:\n"," Request body:\n"," Response:\n"," The child account approver grants DSP permissions using the CUSTOM role:\n"," Request body:\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Rejecting or revoking invitations"},"path":"/en-us/guides/account-management/account-link-invites","content":[" The POST /adsApi/v1/delete/accountLinkInvites endpoint rejects or revokes one or more invitations. Up to 50 invitations can be processed per request.\n"," Calling delete on a PENDING invitation transitions it to REJECTED or REVOKED. Calling delete on an already REJECTED or REVOKED invitation returns success (idempotent). Calling delete on an APPROVED or EXPIRED invitation returns CONFLICT.\n"," The resulting status depends on who calls the endpoint:\n","If the caller is an admin of the approver account → status is set to REJECTED \\* If the caller is an admin of the requester account → status is set to REVOKED\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Required headers"},"path":"/en-us/guides/account-management/account-link-invites","content":["Amazon-Advertising-API-ClientId - Authorization\n"," In addition, include one of the following account identification headers:\n","For Manager Account callers, include Amazon-Ads-Manager-AccountId. - For advertiser account callers, include Amazon-Ads-AccountId.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Request parameters"},"path":"/en-us/guides/account-management/account-link-invites","content":["accountLinkInviteIds\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Response fields"},"path":"/en-us/guides/account-management/account-link-invites","content":["| Field | Description |\n","\\| --- \\| --- \\|\n","| success\\[].index | The 0-based position of the successful entry in the request array |\n","| success\\[].accountLinkInvite.accountLinkInviteId | The rejected or revoked invitation ID |\n","| error\\[].index | The 0-based position of the failed entry in the request array |\n","| error\\[].errors\\[].code | Error code (BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, TOO_MANY_REQUESTS, INTERNAL_ERROR) |\n","| error\\[].errors\\[].message | Human-readable error description |\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Usage example"},"path":"/en-us/guides/account-management/account-link-invites","content":[" Request body:\n"," Response:\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":2,"text":"Querying invitations"},"path":"/en-us/guides/account-management/account-link-invites","content":[" The POST /adsApi/v1/query/accountLinkInvites endpoint returns invitations visible to the caller. You must provide at least one account filter (requesterAccountFilter or approverAccountFilter), and you must be authorized for each filter value you provide.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Required headers"},"path":"/en-us/guides/account-management/account-link-invites","content":["Amazon-Advertising-API-ClientId - Authorization\n"," In addition, include one of the following account identification headers:\n","For Manager Account callers, include Amazon-Ads-Manager-AccountId. - For advertiser account callers, include Amazon-Ads-AccountId.\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Request parameters"},"path":"/en-us/guides/account-management/account-link-invites","content":["requesterAccountFilter\n","approverAccountFilter\n","statusFilter\n","accountLinkInviteIdFilter\n","maxResults\n","nextToken\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Response fields"},"path":"/en-us/guides/account-management/account-link-invites","content":["| Field | Description |\n","\\| --- \\| --- \\|\n","| accountLinkInvites\\[].accountLinkInviteId | Unique identifier for the invitation |\n","| accountLinkInvites\\[].inviteType | REQUEST_ACCESS |\n","| accountLinkInvites\\[].requesterAccount | Account that initiated the invitation |\n","| accountLinkInvites\\[].approverAccount | Account that must approve |\n","| accountLinkInvites\\[].accountLinkPermissions | Permissions for the link |\n","| accountLinkInvites\\[].status | Current lifecycle status |\n","| accountLinkInvites\\[].creationDateTime | ISO-8601 timestamp when the invite was created |\n","| accountLinkInvites\\[].expirationDateTime | ISO-8601 timestamp when the invite expires |\n","| accountLinkInvites\\[].lastModifiedDateTime | ISO-8601 timestamp when the invite was last modified |\n","| accountLinkInvites\\[].createdByUserId | User ID that created the invitation |\n","| accountLinkInvites\\[].lastModifiedByUserId | User ID that last modified the invitation |\n","| nextToken | Pagination token for the next page (absent if no more results) |\n"],"documentType":"guide"},{"title":"Overview","sectionHeader":{"type":3,"text":"Usage examples"},"path":"/en-us/guides/account-management/account-link-invites","content":[" Request body:\n"," Response:\n"," Request body:\n"],"documentType":"guide"},{"title":"Review Requests overview","sectionHeader":null,"path":"/en-us/guides/review-requests/overview","content":[],"documentType":"guide"},{"title":"Review Requests overview","sectionHeader":{"type":2,"text":"What is Review Requests?"},"path":"/en-us/guides/review-requests/overview","content":[" Review Requests is an advertising solution that helps brands gain authentic reviews from verified purchasers. It places a native \"How was your item?\" card on Amazon's highest-traffic pages that invites a verified purchaser to write a review. Advertisers pay only when a shopper leaves a rating or review on the Review Requests card.\n"," New products face a cold-start problem: shoppers hesitate to buy items with few reviews, yet building authentic reviews takes time, and shoppers often forget to leave reviews on their own. Review Requests breaks that cycle. It reaches shoppers who have already bought and received the product and invites them to review their purchase. It gives new products a faster path to authentic reviews.\n"],"documentType":"guide"},{"title":"Review Requests overview","sectionHeader":{"type":2,"text":"What advertisers can do with the API"},"path":"/en-us/guides/review-requests/overview","content":["Create and manage Review Requests campaigns programmatically. - Choose the products (ASINs) that Review Requests ads run for. - Set a bid and daily budget to control cost and delivery. - Measure performance with five review-specific reporting metrics (reviews, writtenReviews, ratingOnlyReviews, percentOfReviewsWritten, and averageStarRating) available through the standard Amazon Ads reporting API, alongside the usual delivery metrics.\n"],"documentType":"guide"},{"title":"Review Requests overview","sectionHeader":{"type":2,"text":"Availability"},"path":"/en-us/guides/review-requests/overview","content":[" Review Requests (beta) is available in the United States.\n"],"documentType":"guide"},{"title":"Review Requests overview","sectionHeader":{"type":2,"text":"Eligibility"},"path":"/en-us/guides/review-requests/overview","content":[" Review Requests is available for products with fewer than 1,000 total reviews. Eligibility is evaluated when a campaign is created and continuously while it runs. Review Requests ads for a product pause automatically once the product reaches 1,000 total reviews (star ratings and written reviews).\n"],"documentType":"guide"},{"title":"Review Requests overview","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/review-requests/overview","content":["Get started with Review Requests\n"],"documentType":"guide"},{"title":"Review Requests overview","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/review-requests/overview","content":[],"documentType":"guide"},{"title":"Get started with Review Requests","sectionHeader":null,"path":"/en-us/guides/review-requests/get-started","content":[" This guide covers creating a first Review Requests campaign with the Amazon Ads API. The end result is a Review Requests campaign and Review Requests ads that target specific ASINs and run against a chosen bid and daily budget.\n"],"documentType":"guide"},{"title":"Get started with Review Requests","sectionHeader":{"type":2,"text":"Prerequisites"},"path":"/en-us/guides/review-requests/get-started","content":[" This guide assumes the following are in place:\n","Amazon Ads API access, with Login with Amazon access and refresh tokens. - An Amazon-Ads-ClientId header, and an Amazon-Advertising-API-Scope header set to the profile ID for the advertiser and marketplace. - One or more eligible products (ASINs) with fewer than 1,000 total reviews, in the United States.\n"," Callers new to the Amazon Ads API should complete onboarding first.\n"],"documentType":"guide"},{"title":"Get started with Review Requests","sectionHeader":{"type":2,"text":"Steps"},"path":"/en-us/guides/review-requests/get-started","content":[],"documentType":"guide"},{"title":"Get started with Review Requests","sectionHeader":{"type":3,"text":"1. Create a campaign"},"path":"/en-us/guides/review-requests/get-started","content":[" The campaign is the top-level container that holds the Review Requests budget and bidding strategy. Set optimizations.goalSettings.goal to ENGAGEMENT to identify it as a Review Requests campaign, set adProduct to SPONSORED_PRODUCTS, and provide the daily budget and manual bid strategy.\n"," The call returns HTTP 207 with success and error arrays. The new campaign, including its campaignId, is in success.\n"],"documentType":"guide"},{"title":"Get started with Review Requests","sectionHeader":{"type":3,"text":"2. Create an ad group"},"path":"/en-us/guides/review-requests/get-started","content":[" The ad group sits inside the campaign and holds the target and ads created next. It requires no Review Requests-specific fields, and its bid sets the default amount paid per billable click.\n"," The call returns HTTP 207. The new ad group, including its adGroupId, is in success.\n"],"documentType":"guide"},{"title":"Get started with Review Requests","sectionHeader":{"type":3,"text":"3. Create the required target"},"path":"/en-us/guides/review-requests/get-started","content":[" Every Review Requests ad group needs one target so the campaign can serve. Set targetType to THEME and matchType to INTERESTED_AUDIENCE. These are the fixed, required values for Review Requests; they are not configurable targeting options, and keyword and product targets are not supported.\n"," The call returns HTTP 207. The new target, including its targetId, is in success.\n"],"documentType":"guide"},{"title":"Get started with Review Requests","sectionHeader":{"type":3,"text":"4. Create a Review Requests ad"},"path":"/en-us/guides/review-requests/get-started","content":[" The ad names the product to request reviews for. Use adType: COMPONENT with a customerActionSettings object that sets customerActionType to REVIEW_REQUEST and supplies the ASIN. Each ad covers a single product, and its action settings are fixed once created, so create one ad for each ASIN.\n"," The call returns HTTP 207. The new ad, including its adId, is in success.\n"],"documentType":"guide"},{"title":"Get started with Review Requests","sectionHeader":{"type":3,"text":"5. Query Review Requests campaigns"},"path":"/en-us/guides/review-requests/get-started","content":[" To retrieve the campaigns just created, query campaigns with a goalFilter set to ENGAGEMENT. Omitting the filter returns the other Sponsored Products campaigns only, so existing integrations are unaffected.\n"," The call returns HTTP 200 with the matching campaigns. When more results exist, it also returns a nextToken for the next page.\n"],"documentType":"guide"},{"title":"Get started with Review Requests","sectionHeader":{"type":2,"text":"Next steps"},"path":"/en-us/guides/review-requests/get-started","content":["Review Requests FAQ\n"],"documentType":"guide"},{"title":"Get started with Review Requests","sectionHeader":{"type":2,"text":"See also"},"path":"/en-us/guides/review-requests/get-started","content":[],"documentType":"guide"},{"title":"Review Requests FAQ","sectionHeader":null,"path":"/en-us/guides/review-requests/faq","content":[],"documentType":"guide"},{"title":"Review Requests FAQ","sectionHeader":{"type":3,"text":"What is Review Requests?"},"path":"/en-us/guides/review-requests/faq","content":[" Review Requests is an advertising solution that helps brands gain authentic reviews from verified purchasers. A native \"How was your item?\" card on Amazon's highest-traffic pages invites a verified purchaser to write a review.\n"],"documentType":"guide"},{"title":"Review Requests FAQ","sectionHeader":{"type":3,"text":"How am I billed, and how do I control spend?"},"path":"/en-us/guides/review-requests/faq","content":[" Review Requests uses cost-per-click (CPC) billing, where the billable click is a shopper leaving a rating or review on the card. There is no charge for impressions or for shoppers who see the card without leaving a rating or review. Advertisers control spend with two settings: a bid (the maximum paid per billable click) and a daily budget (the cap on daily spend).\n"],"documentType":"guide"},{"title":"Review Requests FAQ","sectionHeader":{"type":3,"text":"How is a campaign identified as a Review Requests campaign?"},"path":"/en-us/guides/review-requests/faq","content":[" A campaign is a Review Requests campaign when optimizations.goalSettings.goal is set to ENGAGEMENT. This value is set when the campaign is created, and it cannot be changed afterward.\n"],"documentType":"guide"},{"title":"Review Requests FAQ","sectionHeader":{"type":3,"text":"Which products are eligible?"},"path":"/en-us/guides/review-requests/faq","content":[" Products with fewer than 1,000 total reviews. Eligibility is evaluated when a campaign is created and continuously while it runs. Review Requests ads for a product pause automatically once the product reaches 1,000 total reviews.\n"],"documentType":"guide"},{"title":"Review Requests FAQ","sectionHeader":{"type":3,"text":"Does Review Requests support audience or keyword targeting?"},"path":"/en-us/guides/review-requests/faq","content":[" No. Review Requests does not offer audience or keyword targeting. Each ad group requires a single target with targetType: THEME and matchType: INTERESTED_AUDIENCE. These are fixed, required values that let the campaign serve, not configurable targeting options. Keyword and product targets are not supported and return a targeting-type-not-supported error.\n"],"documentType":"guide"},{"title":"Review Requests FAQ","sectionHeader":{"type":3,"text":"Can I run Review Requests alongside my existing Sponsored Products campaigns?"},"path":"/en-us/guides/review-requests/faq","content":[" Yes. Review Requests campaigns are separate from an advertiser's other campaigns and do not change how they run. When querying campaigns, Review Requests campaigns are returned only when the request includes a goalFilter of ENGAGEMENT, so existing integrations are unaffected.\n"],"documentType":"guide"},{"title":"Review Requests FAQ","sectionHeader":{"type":3,"text":"Can I influence the rating or which shoppers are asked?"},"path":"/en-us/guides/review-requests/faq","content":[" No. Review Requests invites verified purchasers to leave an honest review, and all submissions are subject to Amazon's Community Guidelines. Advertisers cannot select individual shoppers or influence the star rating a shopper gives.\n"],"documentType":"guide"},{"title":"Review Requests FAQ","sectionHeader":{"type":3,"text":"Which marketplaces support Review Requests?"},"path":"/en-us/guides/review-requests/faq","content":[" Review Requests (beta) is available in the United States.\n"],"documentType":"guide"},{"title":"Review Requests FAQ","sectionHeader":{"type":3,"text":"What reporting metrics are available?"},"path":"/en-us/guides/review-requests/faq","content":[],"documentType":"guide"},{"title":"account_management","content":["MCP tools related to account_management\n"],"path":"/en-us/mcp/account-management","sectionHeader":{"type":2,"text":"account_management"},"documentType":"api-reference"},{"title":"account_management","content":["/mcp/update_account_currency",{"operationId":"update_account_currency","description":"Update the currency code of an advertiser account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"advertiserAccounts":{"type":"array","items":{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The unique identifier for the advertiser account."},"currencyCode":{"type":"string","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EGP","EUR","GBP","INR","JPY","MXN","MXP","NGN","NOK","NZD","PLN","SAR","SEK","SGD","TRY","USD","ZAR"],"description":"Currency code for the advertiser account."}},"required":["advertiserAccountId","currencyCode"]},"minItems":1,"maxItems":100}},"required":["advertiserAccounts"]}},"required":["body"]}}}},"tags":["account_management"]}],"path":"/en-us/mcp/account-management#tag/account_management/operation/update_account_currency","sectionHeader":{"type":3,"text":"POST /mcp/update_account_currency"},"documentType":"api-reference"},{"title":"account_management","content":["/mcp/update_account_timezone",{"operationId":"update_account_timezone","description":"Update the timezone of an advertiser account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"advertiserAccounts":{"type":"array","items":{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The unique identifier for the advertiser account."},"timeZone":{"type":"string","enum":["AMERICA_ANCHORAGE","AMERICA_CARACAS","AMERICA_CHICAGO","AMERICA_DENVER","AMERICA_HALIFAX","AMERICA_LOS_ANGELES","AMERICA_MEXICO_CITY","AMERICA_NEW_YORK","AMERICA_SAO_PAULO","AMERICA_ST_JOHNS","ASIA_ALMATY","ASIA_BAGHDAD","ASIA_BANGKOK","ASIA_DUBAI","ASIA_HONG_KONG","ASIA_KABUL","ASIA_KATHMANDU","ASIA_KOLKATA","ASIA_MAGADAN","ASIA_RIYADH","ASIA_SHANGHAI","ASIA_SINGAPORE","ASIA_TEHRAN","ASIA_TOKYO","ASIA_YEKATERINBURG","ASIA_YEREVAN","ATLANTIC_AZORES","ATLANTIC_SOUTH_GEORGIA","AUSTRALIA_BRISBANE","AUSTRALIA_DARWIN","AUSTRALIA_SYDNEY","EET","EUROPE_AMSTERDAM","EUROPE_ISTANBUL","EUROPE_LONDON","EUROPE_PARIS","EUROPE_STOCKHOLM","INDIAN_COCOS","PACIFIC_AUCKLAND","PACIFIC_FIJI","PACIFIC_HONOLULU","PACIFIC_KWAJALEIN","PACIFIC_MIDWAY"],"description":"Timezone for the advertiser account."}},"required":["advertiserAccountId","timeZone"]},"minItems":1,"maxItems":100}},"required":["advertiserAccounts"]}},"required":["body"]}}}},"tags":["account_management"]}],"path":"/en-us/mcp/account-management#tag/account_management/operation/update_account_timezone","sectionHeader":{"type":3,"text":"POST /mcp/update_account_timezone"},"documentType":"api-reference"},{"title":"account_management","content":["/mcp/update_account_name",{"operationId":"update_account_name","description":"Update the display name of an advertiser account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"advertiserAccounts":{"type":"array","items":{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The unique identifier for the advertiser account."},"displayName":{"type":"string","description":"Display name for the advertiser account."}},"required":["advertiserAccountId","displayName"]},"minItems":1,"maxItems":100}},"required":["advertiserAccounts"]}},"required":["body"]}}}},"tags":["account_management"]}],"path":"/en-us/mcp/account-management#tag/account_management/operation/update_account_name","sectionHeader":{"type":3,"text":"POST /mcp/update_account_name"},"documentType":"api-reference"},{"title":"account_management","content":["/mcp/query_advertiser_account",{"operationId":"query_advertiser_account","description":"List or query advertiser accounts the user has access to. Without filters, returns global accounts. Use `isGlobalAccountFilter: { include: [true] }` for global or `{ include: [false] }` for non-global accounts. Use `advertiserAccountIdFilter` to query specific global accounts by ID (e.g. `amzn1.ads-account.g.XXXXX`). Returns `alternateIds` containing DSP advertiser IDs (`dspAdvertiserId`), Sponsored Ads profile IDs (`profileId`), entity IDs (`entityId`), and marketplace country codes (`countryCode`). Preferred tool for \"which accounts do I have access to?\" questions.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"advertiserAccountIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"isGlobalAccountFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"boolean"}}},"required":["include"]},"maxResults":{"type":"integer"},"nextToken":{"type":"string"}}}}}}}},"tags":["account_management"]}],"path":"/en-us/mcp/account-management#tag/account_management/operation/query_advertiser_account","sectionHeader":{"type":3,"text":"POST /mcp/query_advertiser_account"},"documentType":"api-reference"},{"title":"account_management","content":["/mcp/query_account_link",{"operationId":"query_account_link","description":"Query account links. Manager Account users can retrieve details about all accounts linked to their Manager Accounts. Additionally, advertiser account users can find all Manager Accounts linked to their advertising account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"managerAccountId":{"type":"string","description":"The identifier of an Amazon Ads Manager Account."}},"required":["managerAccountId"]}]},"relationshipTypeFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["PARENT","CHILD"]},"maxItems":1,"minItems":1,"description":"PARENT: Parent Accounts linked to an Advertiser/Manager Account, CHILD: Child Accounts linked to a Manager Account"}},"required":["include"]},"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":100,"maximum":100,"minimum":10}},"required":["accessRequestedAccount","relationshipTypeFilter"]}},"required":["body"]}}}},"tags":["account_management"]}],"path":"/en-us/mcp/account-management#tag/account_management/operation/query_account_link","sectionHeader":{"type":3,"text":"POST /mcp/query_account_link"},"documentType":"api-reference"},{"title":"account_management","content":["/mcp/create_advertiser_account",{"operationId":"create_advertiser_account","description":"Create a new advertiser account (Global Account). Returns an advertiserAccountId in the format amzn1.ads-account.g.*. The account starts in REGISTRATION_IN_PROGRESS status. Requires businessDetails with a valid address.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"advertiserAccounts":{"type":"array","items":{"type":"object","properties":{"businessDetails":{"type":"array","description":"The business details for an advertising account, containing either an address token for sellingAccount, or an address object if the sellingAccount lacks a valid address.","items":{"type":"object","description":"The business details of advertising account.","properties":{"address":{"type":"object","description":"The business address of advertising account.","properties":{"addressLine1":{"type":"string","description":"Primary street address of the business."},"addressLine2":{"type":"string","description":"Secondary address line (suite, unit, etc.)."},"businessName":{"type":"string","description":"The name of business."},"city":{"type":"string","description":"The city where business is located."},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g. \"US\", \"GB\", \"DE\")."},"phoneNumber":{"type":"string","description":"Business phone number."},"state":{"type":"string","description":"The state or subdivision where the business is located. Validated against CLDR subdivision names for the given countryCode."},"zipCode":{"type":"string","description":"The zipCode where business is located."}},"required":["addressLine1","businessName","city","countryCode","phoneNumber"]},"addressToken":{"type":"string","description":"The token of the business address being linked."},"businessRegistrationNumber":{"type":"string","description":"The business registration number of the business."},"website":{"type":"string","description":"Business website URL."}}}},"currencyCode":{"type":"string","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EGP","EUR","GBP","INR","JPY","MXN","MXP","NGN","NOK","NZD","PLN","SAR","SEK","SGD","TRY","USD","ZAR"]},"displayName":{"type":"string","description":"Display name for the advertiser account."},"industry":{"type":"string","enum":["AMS_KEYWORD","AMS_SELF_SERVICE","AUTOMOTIVE","CONSUMER_GOODS","ECOMMERCE","ENTERTAINMENT","FINANCIAL_SERVICES","HARDWARE_AND_ELECTRONICS","HEALTH","HOUSE_ADS","PUBLIC_SERVICES","REMNANT_NETWORKS","RETAIL_GOODS_AND_SERVICES","SOFTWARE","TELECOMMUNICATIONS","TRAVEL","TWITCH","TWITCH_TV","WEB_MEDIA"]},"isGlobalAccount":{"type":"boolean","description":"Indicates whether the advertising account is global or not."},"isTestAccount":{"type":"boolean","description":"Indicates whether the advertising account is a test account or not."},"managerAccountId":{"type":"string","description":"Optional. The ID of the manager (parent) account to link the new advertiser account to."},"sellingAccountLinkRequests":{"type":"array","description":"The selling account link requests for an advertiser account, containing details for linking.","items":{"oneOf":[{"type":"object","properties":{"emailForApprovalDetails":{"type":"object","properties":{"emailForApproval":{"type":"string","description":"The email address associated with the account you want to link to."},"sellingProgram":{"type":"string","enum":["AMAZON_AUTHOR","AMAZON_SELLER","AMAZON_VENDOR"]}},"required":["emailForApproval","sellingProgram"]}},"required":["emailForApprovalDetails"]},{"type":"object","properties":{"sellingAccountLinkDetails":{"type":"object","properties":{"sellingAccountLinkToken":{"type":"string","description":"The token to locate a selling account to be linked."},"sellingProgram":{"type":"string","enum":["AMAZON_AUTHOR","AMAZON_SELLER","AMAZON_VENDOR"]}},"required":["sellingAccountLinkToken"]}},"required":["sellingAccountLinkDetails"]}]}},"timeZone":{"type":"string","description":"Each complies with the ISO 8601 TZ identifier standard","enum":["AMERICA_ANCHORAGE","AMERICA_CARACAS","AMERICA_CHICAGO","AMERICA_DENVER","AMERICA_HALIFAX","AMERICA_LOS_ANGELES","AMERICA_MEXICO_CITY","AMERICA_NEW_YORK","AMERICA_SAO_PAULO","AMERICA_ST_JOHNS","ASIA_ALMATY","ASIA_BAGHDAD","ASIA_BANGKOK","ASIA_DUBAI","ASIA_HONG_KONG","ASIA_KABUL","ASIA_KATHMANDU","ASIA_KOLKATA","ASIA_MAGADAN","ASIA_RIYADH","ASIA_SHANGHAI","ASIA_SINGAPORE","ASIA_TEHRAN","ASIA_TOKYO","ASIA_YEKATERINBURG","ASIA_YEREVAN","ATLANTIC_AZORES","ATLANTIC_SOUTH_GEORGIA","AUSTRALIA_BRISBANE","AUSTRALIA_DARWIN","AUSTRALIA_SYDNEY","EET","EUROPE_AMSTERDAM","EUROPE_ISTANBUL","EUROPE_LONDON","EUROPE_PARIS","EUROPE_STOCKHOLM","INDIAN_COCOS","PACIFIC_AUCKLAND","PACIFIC_FIJI","PACIFIC_HONOLULU","PACIFIC_KWAJALEIN","PACIFIC_MIDWAY"]}},"required":["businessDetails"]}}}}}}}}},"tags":["account_management"]}],"path":"/en-us/mcp/account-management#tag/account_management/operation/create_advertiser_account","sectionHeader":{"type":3,"text":"POST /mcp/create_advertiser_account"},"documentType":"api-reference"},{"title":"account_management","content":["/mcp/update_advertiser_account",{"operationId":"update_advertiser_account","description":"Update an advertiser account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"advertiserAccounts":{"type":"array","items":{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The unique identifier for the advertiser account."},"businessDetails":{"type":"array","description":"The business details for an advertising account, containing either an address token for sellingAccount, or an address object if the sellingAccount lacks a valid address.","items":{"type":"object","description":"The business details of advertising account.","properties":{"address":{"type":"object","description":"The business address of advertising account.","properties":{"addressLine1":{"type":"string","description":"The address details - 1 of business."},"addressLine2":{"type":"string","description":"The address details - 2 of business."},"businessName":{"type":"string","description":"The name of business."},"city":{"type":"string","description":"The city where business is located."},"countryCode":{"type":"string","description":"The country where business is located."},"phoneNumber":{"type":"string","description":"The phone number of business."},"state":{"type":"string","description":"The city where business is located."},"zipCode":{"type":"string","description":"The zipCode where business is located."}},"required":["addressLine1","businessName","city","countryCode"]},"addressToken":{"type":"string","description":"The token of the business address being linked."},"businessRegistrationNumber":{"type":"string","description":"The business registration number of the business."},"website":{"type":"string","description":"The website of the business."}}}},"currencyCode":{"type":"string","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EGP","EUR","GBP","INR","JPY","MXN","MXP","NGN","NOK","NZD","PLN","SAR","SEK","SGD","TRY","USD","ZAR"]},"displayName":{"type":"string","description":"Display name for the advertiser account."},"industry":{"type":"string","enum":["AMS_KEYWORD","AMS_SELF_SERVICE","AUTOMOTIVE","CONSUMER_GOODS","ECOMMERCE","ENTERTAINMENT","FINANCIAL_SERVICES","HARDWARE_AND_ELECTRONICS","HEALTH","HOUSE_ADS","PUBLIC_SERVICES","REMNANT_NETWORKS","RETAIL_GOODS_AND_SERVICES","SOFTWARE","TELECOMMUNICATIONS","TRAVEL","TWITCH","TWITCH_TV","WEB_MEDIA"]},"isGlobalAccount":{"type":"boolean","description":"Indicates whether the advertising account is global or not."},"isTestAccount":{"type":"boolean","description":"Indicates whether the advertising account is a test account or not."},"managerAccountId":{"type":"string","description":"Optional ManagerAccount to link to the advertiser account."},"sellingAccountLinkRequests":{"type":"array","description":"The selling account link requests for an advertiser account, containing details for linking.","items":{"oneOf":[{"type":"object","properties":{"emailForApprovalDetails":{"type":"object","properties":{"emailForApproval":{"type":"string","description":"The email address associated with the account you want to link to."},"sellingProgram":{"type":"string","enum":["AMAZON_AUTHOR","AMAZON_SELLER","AMAZON_VENDOR"]}},"required":["emailForApproval","sellingProgram"]}},"required":["emailForApprovalDetails"]},{"type":"object","properties":{"sellingAccountLinkDetails":{"type":"object","properties":{"sellingAccountLinkToken":{"type":"string","description":"The token to locate a selling account to be linked."},"sellingProgram":{"type":"string","enum":["AMAZON_AUTHOR","AMAZON_SELLER","AMAZON_VENDOR"]}},"required":["sellingAccountLinkToken"]}},"required":["sellingAccountLinkDetails"]}]}},"timeZone":{"type":"string","description":"Each complies with the ISO 8601 TZ identifier standard","enum":["AMERICA_ANCHORAGE","AMERICA_CARACAS","AMERICA_CHICAGO","AMERICA_DENVER","AMERICA_HALIFAX","AMERICA_LOS_ANGELES","AMERICA_MEXICO_CITY","AMERICA_NEW_YORK","AMERICA_SAO_PAULO","AMERICA_ST_JOHNS","ASIA_ALMATY","ASIA_BAGHDAD","ASIA_BANGKOK","ASIA_DUBAI","ASIA_HONG_KONG","ASIA_KABUL","ASIA_KATHMANDU","ASIA_KOLKATA","ASIA_MAGADAN","ASIA_RIYADH","ASIA_SHANGHAI","ASIA_SINGAPORE","ASIA_TEHRAN","ASIA_TOKYO","ASIA_YEKATERINBURG","ASIA_YEREVAN","ATLANTIC_AZORES","ATLANTIC_SOUTH_GEORGIA","AUSTRALIA_BRISBANE","AUSTRALIA_DARWIN","AUSTRALIA_SYDNEY","EET","EUROPE_AMSTERDAM","EUROPE_ISTANBUL","EUROPE_LONDON","EUROPE_PARIS","EUROPE_STOCKHOLM","INDIAN_COCOS","PACIFIC_AUCKLAND","PACIFIC_FIJI","PACIFIC_HONOLULU","PACIFIC_KWAJALEIN","PACIFIC_MIDWAY"]}},"required":["advertiserAccountId"]}}}}}}}}},"tags":["account_management"]}],"path":"/en-us/mcp/account-management#tag/account_management/operation/update_advertiser_account","sectionHeader":{"type":3,"text":"POST /mcp/update_advertiser_account"},"documentType":"api-reference"},{"title":"ads_accounts","content":["MCP tools related to ads_accounts\n"],"path":"/en-us/mcp/ads-accounts","sectionHeader":{"type":2,"text":"ads_accounts"},"documentType":"api-reference"},{"title":"ads_accounts","content":["/mcp/list_ads_accounts",{"operationId":"list_ads_accounts","description":"List all advertising accounts for the user associated with the access token.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"maxResults":{"type":"number","description":"Maximum number of results to return. Default is 100.","minimum":1,"maximum":100},"nextToken":{"type":"string","description":"Token used to fetch the next page of results if they exist."}}}}}}}},"tags":["ads_accounts"]}],"path":"/en-us/mcp/ads-accounts#tag/ads_accounts/operation/list_ads_accounts","sectionHeader":{"type":3,"text":"POST /mcp/list_ads_accounts"},"documentType":"api-reference"},{"title":"ads_accounts","content":["/mcp/create_ads_account",{"operationId":"create_ads_account","description":"Create a new advertising account tied to a specific Amazon vendor, seller or author, or to a business who does not sell on Amazon.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accountName":{"type":"string","description":"Account names are typically the name of the company or brand being advertised. Avoid using personal details such as first name, last name, phone number, or other personally identifiable information."},"associations":{"type":"array","description":"Associations to link to this advertising account. Could be Amazon Vendor, Seller, or a regular business.","maxItems":1,"items":{"type":"object"}},"countryCodes":{"type":"array","description":"The countries that you want this account to operate in.","maxItems":1,"items":{"type":"string"}},"termsToken":{"type":"string","description":"Optional. An obfuscated identifier of the termsToken activated when an advertiser accepts the Amazon Ads Agreement. Not recommended as the system can determine acceptance automatically."}}}}}}}},"tags":["ads_accounts"]}],"path":"/en-us/mcp/ads-accounts#tag/ads_accounts/operation/create_ads_account","sectionHeader":{"type":3,"text":"POST /mcp/create_ads_account"},"documentType":"api-reference"},{"title":"ads_accounts","content":["/mcp/get_ads_account",{"operationId":"get_ads_account","description":"Request attributes of a given advertising account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pathParameters":{"type":"object","properties":{"advertisingAccountId":{"type":"string","description":"The global advertising account Id.","pattern":"^[A-Za-z0-9.-]+$"}},"required":["advertisingAccountId"]}}}}}},"tags":["ads_accounts"]}],"path":"/en-us/mcp/ads-accounts#tag/ads_accounts/operation/get_ads_account","sectionHeader":{"type":3,"text":"POST /mcp/get_ads_account"},"documentType":"api-reference"},{"title":"advertiser_product_group_eligibility","content":["MCP tools related to advertiser_product_group_eligibility\n"],"path":"/en-us/mcp/advertiser-product-group-eligibility","sectionHeader":{"type":2,"text":"advertiser_product_group_eligibility"},"documentType":"api-reference"},{"title":"advertiser_product_group_eligibility","content":["/mcp/query",{"operationId":"query","description":"Query requests for advertiser product group eligibility based on advertiser account ID.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"maxResults":{"type":"number","description":"Max results (0-10)","minimum":0,"maximum":10},"nextToken":{"type":"string","description":"Pagination token"},"statusFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["APPROVED","PENDING","REJECTED"]},"maxItems":1}},"required":["include"]}},"required":["accessRequestedAccount"]}}}}}},"tags":["advertiser_product_group_eligibility"]}],"path":"/en-us/mcp/advertiser-product-group-eligibility#tag/advertiser_product_group_eligibility/operation/query","sectionHeader":{"type":3,"text":"POST /mcp/query"},"documentType":"api-reference"},{"title":"advertiser_product_group_eligibility","content":["/mcp/create",{"operationId":"create","description":"Create request for specific advertiser product group eligibility (e.g., ADSP).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"advertiserProductGroupEligibilities":{"type":"array","items":{"type":"object","properties":{"adProductGroup":{"type":"string","description":"Group of ad products to check eligibility for.","enum":["ADSP"]},"rejectedReasonDetail":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["BUSINESS_VERIFICATION_FAILED","SALES_VERIFICATION_FAILED"]},"description":{"type":"string"}},"required":["code","description"]},"maxItems":2}},"required":["adProductGroup"]},"minItems":1,"maxItems":1}},"required":["accessRequestedAccount"]}}}}}},"tags":["advertiser_product_group_eligibility"]}],"path":"/en-us/mcp/advertiser-product-group-eligibility#tag/advertiser_product_group_eligibility/operation/create","sectionHeader":{"type":3,"text":"POST /mcp/create"},"documentType":"api-reference"},{"title":"amazon_live","content":["MCP tools related to amazon_live\n"],"path":"/en-us/mcp/amazon-live","sectionHeader":{"type":2,"text":"amazon_live"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/list_broadcasts",{"operationId":"list_broadcasts","description":"List all Amazon Live broadcasts for a specific channel. Returns paginated broadcast details filtered by channelId. Use this when you know the channel and want all its broadcasts.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]},"queryParameters":{"type":"object","properties":{"channelId":{"type":"string"},"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":49,"format":"int32","maximum":49,"minimum":1}},"required":["channelId"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/list_broadcasts","sectionHeader":{"type":3,"text":"POST /mcp/list_broadcasts"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/delete_broadcast",{"operationId":"delete_broadcast","description":"Delete an Amazon Live broadcast by its broadcastId. This permanently removes the broadcast and cannot be undone. Only broadcasts that are not currently LIVE can be deleted.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"broadcastIds":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"string"}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["broadcastIds","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/delete_broadcast","sectionHeader":{"type":3,"text":"POST /mcp/delete_broadcast"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/query_promo_code",{"operationId":"query_promo_code","description":"Validate promotion codes by querying Amazon's promotions system. Required: broadcastId filter and promoCode filter (up to 10 codes). Returns validated promo code details including discount percentage, validity window, and associated product IDs (ASINs). Use this to check if a promo code exists and is valid before associating it with a broadcast.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"broadcastIdFilter":{"type":"object","description":"Required filter. The broadcast ID context for validation.","properties":{"queryTermMatchType":{"type":"string","enum":["BROAD_MATCH"]},"include":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"string"}}},"required":["include","queryTermMatchType"]},"promoCodeFilter":{"type":"object","description":"Required filter. Up to 10 promo code strings to validate.","properties":{"queryTermMatchType":{"type":"string","enum":["BROAD_MATCH"]},"include":{"type":"array","maxItems":10,"minItems":1,"items":{"type":"string"}}},"required":["include","queryTermMatchType"]},"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":49,"format":"int32","maximum":49,"minimum":1},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["broadcastIdFilter","promoCodeFilter","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/query_promo_code","sectionHeader":{"type":3,"text":"POST /mcp/query_promo_code"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/list_carousel_items",{"operationId":"list_carousel_items","description":"List carousel items (products or landing pages) shown during an Amazon Live broadcast. Returns display order, activation status, carousel type (PRODUCT or CUSTOM), and metadata such as product ID or landing page details. Use this to see what items are being showcased during a broadcast.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]},"queryParameters":{"type":"object","properties":{"broadcastId":{"type":"string"},"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":49,"format":"int32","maximum":49,"minimum":1}},"required":["broadcastId"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/list_carousel_items","sectionHeader":{"type":3,"text":"POST /mcp/list_carousel_items"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/create_broadcast",{"operationId":"create_broadcast","description":"Create a new Amazon Live broadcast scheduled on a specific channel. Required: title, channelId. Optional: scheduledStartDateTime, videoSource, streamingOrientation, isPublic, isPractice, includesDeals. Returns the created broadcast with a server-assigned broadcastId and initial broadcastStatus. Practice broadcasts (isPractice=true) are test broadcasts that do not appear to end viewers.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"broadcasts":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"broadcastId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Server-assigned on create; present in response."},"channelId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Required. The channel ID this broadcast belongs to."},"title":{"type":"string","description":"Required. Human-readable title for the broadcast."},"broadcastStatus":{"type":"string","description":"Initial status assigned on create.","enum":["UNSCHEDULED","SCHEDULED","PRE_LIVE","LIVE","COMPLETED"]},"scheduledStartDateTime":{"type":"string","description":"Optional. ISO-8601 datetime when the broadcast is scheduled to start.","format":"date-time"},"videoSource":{"type":"string","description":"Optional. Video input source: PHONE_CAMERA, WEB_CAMERA, or THIRD_PARTY_ENCODER.","enum":["PHONE_CAMERA","WEB_CAMERA","THIRD_PARTY_ENCODER"]},"streamingOrientation":{"type":"string","description":"Optional. Stream orientation: HORIZONTAL, VERTICAL, or MULTI_ORIENTATION.","enum":["HORIZONTAL","VERTICAL","MULTI_ORIENTATION"]},"isPractice":{"type":"boolean","description":"Optional. If true, creates a practice (test) broadcast not visible to end viewers. Default false."},"includesDeals":{"type":"boolean","description":"Optional. If true, broadcast includes deals/promotions."},"isPublic":{"type":"boolean","description":"Optional. If true, broadcast is visible to all viewers. Default false."}},"required":["broadcastId","broadcastStatus","channelId","streamingOrientation","title","videoSource"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["broadcasts","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/create_broadcast","sectionHeader":{"type":3,"text":"POST /mcp/create_broadcast"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/update_carousel_item",{"operationId":"update_carousel_item","description":"Update existing carousel items (products or landing pages) in an Amazon Live broadcast. Supports bulk update up to 45 items per call. Required per item: carouselItemId. Only provided fields are modified; others remain unchanged. The type field is immutable after creation. Use isActive=false to hide an item without deleting it.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"carouselItems":{"type":"array","maxItems":45,"minItems":1,"items":{"type":"object","properties":{"carouselItemId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Required. The carousel item ID to update."},"broadcastId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The broadcast ID this carousel item belongs to. Not changeable."},"displayOrder":{"type":"integer","description":"Optional. Updated display order.","format":"int32"},"carouselMetadata":{"description":"Optional. Updated type-specific metadata.","oneOf":[{"type":"object","description":"A carousel item associated with a broadcast","properties":{"productCarouselMetadata":{"type":"object","properties":{"productId":{"type":"string","description":"Optional. Updated Amazon product ID (ASIN) for PRODUCT type items."}}}},"required":["productCarouselMetadata"]},{"type":"object","description":"A custom carousel item associated with a broadcast","properties":{"landingPageCarouselMetadata":{"type":"object","properties":{"title":{"type":"string","description":"Optional. Updated landing page title for CUSTOM type items."},"description":{"type":"string","description":"Optional. Updated landing page description for CUSTOM type items."},"linkUrl":{"type":"string","description":"Optional. Updated landing page target URL."},"imageUrl":{"type":"string","description":"Optional. Updated landing page image URL."}}}},"required":["landingPageCarouselMetadata"]}]},"isActive":{"type":"boolean","description":"Optional. Set to false to hide the item without deleting."}},"required":["carouselItemId"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["carouselItems","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/update_carousel_item","sectionHeader":{"type":3,"text":"POST /mcp/update_carousel_item"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/update_broadcast",{"operationId":"update_broadcast","description":"Update an existing Amazon Live broadcast. Required: broadcastId. Only provided fields are modified; others remain unchanged. CAUTION: broadcastStatus transitions are significant - moving to LIVE starts the stream, moving to COMPLETED ends it permanently. Prefer the dedicated go-live and end-broadcast workflows over direct status updates when possible.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"broadcasts":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"broadcastId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Required. The broadcast ID to update."},"channelId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The channel ID this broadcast belongs to. Not changeable."},"title":{"type":"string","description":"Optional. New title for the broadcast."},"broadcastStatus":{"type":"string","description":"Optional. CAUTION: New broadcast lifecycle status. Transitions to LIVE, COMPLETED are state-changing and may be irreversible.","enum":["UNSCHEDULED","SCHEDULED","PRE_LIVE","LIVE","COMPLETED"]},"scheduledStartDateTime":{"type":"string","description":"Optional. Updated scheduled start ISO-8601 datetime.","format":"date-time"},"videoSource":{"type":"string","description":"Optional. Updated video input source.","enum":["PHONE_CAMERA","WEB_CAMERA","THIRD_PARTY_ENCODER"]},"streamingOrientation":{"type":"string","description":"Optional. Updated stream orientation.","enum":["HORIZONTAL","VERTICAL","MULTI_ORIENTATION"]},"includesDeals":{"type":"boolean","description":"Optional. Updated deals flag."},"isPublic":{"type":"boolean","description":"Optional. Updated visibility flag."}},"required":["broadcastId"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["broadcasts","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/update_broadcast","sectionHeader":{"type":3,"text":"POST /mcp/update_broadcast"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/create_broadcast_media_asset",{"operationId":"create_broadcast_media_asset","description":"Create a media asset (thumbnail, sponsored image, HLS stream, MP4 video, or video clip) associated with an Amazon Live broadcast. Required: broadcastId, type, and at least one of content or metadata (either a binary upload or a metadata record must be supplied). Server assigns mediaAssetId, format, url, and version on creation. Use appropriate type: THUMBNAIL_IMAGE, SPONSORED_IMAGE, HLS_STREAM, MP4_VIDEO, VIDEO_CLIP.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"broadcastMediaAssets":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"broadcastId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Required. The broadcast ID to attach the media asset to."},"type":{"type":"string","description":"Required. Asset type: THUMBNAIL_IMAGE, SPONSORED_IMAGE, HLS_STREAM, MP4_VIDEO, or VIDEO_CLIP.","enum":["THUMBNAIL_IMAGE","SPONSORED_IMAGE","HLS_STREAM","MP4_VIDEO","VIDEO_CLIP"]},"url":{"type":"string","description":"Server-assigned on create; present in response."},"content":{"type":"string","description":"Conditionally required (provide content or metadata, at minimum). Binary content of the asset (for uploads)."},"metadata":{"type":"object","description":"Conditionally required (provide content or metadata, at minimum). Asset metadata - dimensions, orientation, duration.","properties":{"orientation":{"type":"string","description":"Optional. Asset orientation (HORIZONTAL/VERTICAL)."},"height":{"type":"integer","description":"Optional. Height in pixels.","format":"int32"},"width":{"type":"integer","description":"Optional. Width in pixels.","format":"int32"},"duration":{"type":"number","description":"Optional. Duration in seconds (video assets only).","format":"double"},"secondsTrimmedFromStart":{"type":"number","description":"Optional. Seconds trimmed from the start (for clips).","format":"double"}},"required":["orientation"]}},"required":["broadcastId","type"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["broadcastMediaAssets","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/create_broadcast_media_asset","sectionHeader":{"type":3,"text":"POST /mcp/create_broadcast_media_asset"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/list_promo_codes",{"operationId":"list_promo_codes","description":"List promotion codes associated with an Amazon Live broadcast. Returns promo code details including the code string, discount percentage, start/end times, and associated product IDs (ASINs). Use this to see what deals are offered during a broadcast.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]},"queryParameters":{"type":"object","properties":{"broadcastId":{"type":"string"},"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":49,"format":"int32","maximum":49,"minimum":1}},"required":["broadcastId"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/list_promo_codes","sectionHeader":{"type":3,"text":"POST /mcp/list_promo_codes"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/update_channel",{"operationId":"update_channel","description":"Update an existing Amazon Live channel. Required: channelId. Only provided fields are modified; others remain unchanged. channelState, followers, featureFlags, and streamDetailIds are managed by the system and cannot be updated via this tool.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"channels":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"channelId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Required. The channel ID to update."},"brandId":{"type":"string","description":"Optional. Updated brand ID association."},"brandAlternateIds":{"type":"array","description":"Optional. Updated alternate brand identifiers.","maxItems":10,"items":{"type":"object","description":"Other types of brand identifiers for a brand that are used with other operations.","properties":{"alternateBrandIdType":{"type":"string","description":"The type of identifier for the alternate brand identifier.","enum":["BRAND_REGISTRY","BRAND_ENTITY_ID","BOOK_AUTHOR"]},"alternateBrandId":{"type":"string","description":"The alternative brand identifier for the brandId."},"countryCode":{"type":"string","description":"The country where the alternate brand identifier is valid."}},"required":["alternateBrandId","alternateBrandIdType","countryCode"]}},"title":{"type":"string","description":"Optional. New channel title."},"logoUrl":{"type":"string","description":"Optional. Updated channel logo URL."}},"required":["channelId"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["channels","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/update_channel","sectionHeader":{"type":3,"text":"POST /mcp/update_channel"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/update_promo_code",{"operationId":"update_promo_code","description":"Update an existing promo code association on an Amazon Live broadcast. Required: id. Only the associated promo code string and broadcast can be updated here; discount percentage, validity window, and product IDs are derived from the promotions system.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"promoCodes":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Required. The promo code association ID to update."},"broadcastId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Optional. Reassociate with a different broadcast."},"promoCode":{"type":"string","description":"Optional. Updated promo code string."}},"required":["id"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["promoCodes","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/update_promo_code","sectionHeader":{"type":3,"text":"POST /mcp/update_promo_code"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/update_broadcast_media_asset",{"operationId":"update_broadcast_media_asset","description":"Update an existing broadcast media asset's metadata or content. Required: mediaAssetId. Only provided fields are modified. mediaAssetId, url, format, creationDateTime, and version are server-managed and immutable.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"broadcastMediaAssets":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"mediaAssetId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Required. The media asset ID to update."},"broadcastId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"The broadcast ID this asset belongs to. Not changeable."},"type":{"type":"string","description":"Optional. Updated asset type.","enum":["THUMBNAIL_IMAGE","SPONSORED_IMAGE","HLS_STREAM","MP4_VIDEO","VIDEO_CLIP"]},"content":{"type":"string","description":"Optional. Updated binary content (replaces existing)."},"metadata":{"type":"object","description":"Optional. Updated metadata.","properties":{"orientation":{"type":"string","description":"Optional. Updated orientation."},"height":{"type":"integer","description":"Optional. Updated height in pixels.","format":"int32"},"width":{"type":"integer","description":"Optional. Updated width in pixels.","format":"int32"},"duration":{"type":"number","description":"Optional. Updated duration in seconds.","format":"double"},"secondsTrimmedFromStart":{"type":"number","description":"Optional. Updated trim offset in seconds.","format":"double"}}}},"required":["mediaAssetId"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["broadcastMediaAssets","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/update_broadcast_media_asset","sectionHeader":{"type":3,"text":"POST /mcp/update_broadcast_media_asset"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/query_channels",{"operationId":"query_channels","description":"Query Amazon Live channels for a brand. Returns channel details including title, follower count, state (OFFLINE/PREVIEWING/LIVE), feature flags, and associated stream IDs. Use this to find channels owned by a brand.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"brandAlternateIdsFilter":{"type":"object","description":"Alternate brand identifiers (e.g., BRAND_ENTITY_ID) used for filtering channels.","properties":{"include":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","description":"Other types of brand identifiers for a brand that are used with other operations.","properties":{"alternateBrandIdType":{"type":"string","description":"The type of identifier for the alternate brand identifier.","enum":["BRAND_REGISTRY","BRAND_ENTITY_ID","BOOK_AUTHOR"]},"alternateBrandId":{"type":"string","description":"The alternative brand identifier for the brandId."},"countryCode":{"type":"string","description":"The country where the alternate brand identifier is valid."}},"required":["alternateBrandId","alternateBrandIdType","countryCode"]}}},"required":["include"]},"brandIdFilter":{"type":"object","description":"Internal brand ID to filter channels for a specific brand.","properties":{"queryTermMatchType":{"type":"string","enum":["BROAD_MATCH"]},"include":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"string"}}},"required":["include","queryTermMatchType"]},"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":1,"format":"int32","maximum":10,"minimum":1},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/query_channels","sectionHeader":{"type":3,"text":"POST /mcp/query_channels"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/retrieve_promo_code",{"operationId":"retrieve_promo_code","description":"Retrieve a specific promotion code by its id. Returns full promo code details including the code string, discount percentage, validity window, and associated product IDs.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"ids":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"string"}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["ids","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/retrieve_promo_code","sectionHeader":{"type":3,"text":"POST /mcp/retrieve_promo_code"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/retrieve_channel",{"operationId":"retrieve_channel","description":"Retrieve a specific Amazon Live channel by its channelId. Returns full channel details including title, follower count, logo URL, state, feature flags, and associated stream detail IDs.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"channelIds":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"string"}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["channelIds","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/retrieve_channel","sectionHeader":{"type":3,"text":"POST /mcp/retrieve_channel"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/create_channel",{"operationId":"create_channel","description":"Create a new Amazon Live channel for a brand. A channel is the persistent home for a brand's livestreams. Required: title, brandId. Optional: brandAlternateIds, logoUrl. Returns the created channel with a server-assigned channelId and initial channelState (OFFLINE).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"channels":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"brandId":{"type":"string","description":"Required. Internal brand ID this channel belongs to."},"brandAlternateIds":{"type":"array","description":"Optional. Alternate brand identifiers (e.g., BRAND_ENTITY_ID).","maxItems":10,"items":{"type":"object","description":"Other types of brand identifiers for a brand that are used with other operations.","properties":{"alternateBrandIdType":{"type":"string","description":"The type of identifier for the alternate brand identifier.","enum":["BRAND_REGISTRY","BRAND_ENTITY_ID","BOOK_AUTHOR"]},"alternateBrandId":{"type":"string","description":"The alternative brand identifier for the brandId."},"countryCode":{"type":"string","description":"The country where the alternate brand identifier is valid."}},"required":["alternateBrandId","alternateBrandIdType","countryCode"]}},"title":{"type":"string","description":"Required. Human-readable channel title displayed to viewers."},"logoUrl":{"type":"string","description":"Optional. URL of the channel logo image."}},"required":["title"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["channels","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/create_channel","sectionHeader":{"type":3,"text":"POST /mcp/create_channel"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/list_livestream_details",{"operationId":"list_livestream_details","description":"List livestream technical details (streaming infrastructure) for an Amazon Live channel. Returns ingest endpoint, ingest type (WEBRTC/RTMPS/SRT), preview URL, stream state (bitrate/resolution/frame rate), and validation status. Stream keys are NOT included in list responses. Use this to inspect the streaming setup for a channel.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]},"queryParameters":{"type":"object","properties":{"channelId":{"type":"string"},"ingestType":{"description":"Type of streaming protocol used","type":"string","enum":["WEBRTC","RTMPS","SRT"]},"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":49,"format":"int32","maximum":49,"minimum":1}},"required":["channelId"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/list_livestream_details","sectionHeader":{"type":3,"text":"POST /mcp/list_livestream_details"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/query_broadcasts",{"operationId":"query_broadcasts","description":"Query Amazon Live broadcasts for a brand. Supports filtering by brand ID, brand alternate IDs, creation date range, and broadcast status (UNSCHEDULED, SCHEDULED, PRE_LIVE, LIVE, COMPLETED). Returns paginated broadcast details including title, status, scheduled times, and channel association. Use this to find broadcasts matching specific criteria.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"brandAlternateIdsFilter":{"type":"object","description":"Alternate brand identifiers (e.g., BRAND_ENTITY_ID) used for filtering broadcasts.","properties":{"include":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","description":"Other types of brand identifiers for a brand that are used with other operations.","properties":{"alternateBrandIdType":{"type":"string","description":"The type of identifier for the alternate brand identifier.","enum":["BRAND_REGISTRY","BRAND_ENTITY_ID","BOOK_AUTHOR"]},"alternateBrandId":{"type":"string","description":"The alternative brand identifier for the brandId."},"countryCode":{"type":"string","description":"The country where the alternate brand identifier is valid."}},"required":["alternateBrandId","alternateBrandIdType","countryCode"]}}},"required":["include"]},"brandIdFilter":{"type":"object","description":"Internal brand ID. Use to filter broadcasts for a specific brand.","properties":{"queryTermMatchType":{"type":"string","enum":["BROAD_MATCH"]},"include":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"string"}}},"required":["include","queryTermMatchType"]},"broadcastStatusFilter":{"type":"object","description":"Filter by broadcast lifecycle status. Use EXACT_MATCH with values: UNSCHEDULED, SCHEDULED, PRE_LIVE, LIVE, COMPLETED.","properties":{"include":{"type":"array","maxItems":5,"minItems":1,"items":{"type":"string","description":"Filter by broadcast lifecycle status. Use EXACT_MATCH with values: UNSCHEDULED, SCHEDULED, PRE_LIVE, LIVE, COMPLETED.","enum":["UNSCHEDULED","SCHEDULED","PRE_LIVE","LIVE","COMPLETED"]}}},"required":["include"]},"creationDateTimeFilter":{"type":"object","description":"Filter broadcasts by creation date/time range.","properties":{"queryTermMatchType":{"type":"string","enum":["BROAD_MATCH"]},"include":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"string","format":"date-time"}}},"required":["include","queryTermMatchType"]},"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":50,"format":"int32","maximum":100,"minimum":1},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["creationDateTimeFilter","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/query_broadcasts","sectionHeader":{"type":3,"text":"POST /mcp/query_broadcasts"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/list_channels",{"operationId":"list_channels","description":"List all Amazon Live channels for the current advertiser account. No filters required — returns all channels the advertiser has access to, including channelId, title, state (OFFLINE/PREVIEWING/LIVE), logo URL, and feature flags. Use this as the starting point to discover which channels exist before querying broadcasts or livestream details.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]},"queryParameters":{"type":"object","properties":{"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":49,"format":"int32","maximum":49,"minimum":1}}}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/list_channels","sectionHeader":{"type":3,"text":"POST /mcp/list_channels"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/list_broadcast_media_assets",{"operationId":"list_broadcast_media_assets","description":"List media assets (thumbnails, sponsored images, HLS streams, MP4 videos, video clips) associated with an Amazon Live broadcast. Returns asset type, URL, format, and metadata such as dimensions, orientation, and duration.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]},"queryParameters":{"type":"object","properties":{"broadcastId":{"type":"string"},"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":49,"format":"int32","maximum":49,"minimum":1}},"required":["broadcastId"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/list_broadcast_media_assets","sectionHeader":{"type":3,"text":"POST /mcp/list_broadcast_media_assets"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/create_carousel_item",{"operationId":"create_carousel_item","description":"Create carousel items (products or landing pages) to be shown during an Amazon Live broadcast. Supports bulk create up to 45 items per call. Required per item: broadcastId, type (PRODUCT or CUSTOM), carouselMetadata. For PRODUCT type, provide ProductCarouselMetadata with productId (ASIN). For CUSTOM type, provide LandingPageCarouselMetadata with title and description; linkUrl and imageUrl are optional. Returns created items with server-assigned carouselItemIds.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"carouselItems":{"type":"array","maxItems":45,"minItems":1,"items":{"type":"object","properties":{"broadcastId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Required. The broadcast ID the carousel items belong to."},"displayOrder":{"type":"integer","description":"Optional. Display order within the carousel (lower numbers appear first).","format":"int32"},"carouselMetadata":{"description":"Required. Type-specific metadata - ProductCarouselMetadata for PRODUCT, LandingPageCarouselMetadata for CUSTOM.","oneOf":[{"type":"object","description":"A carousel item associated with a broadcast","properties":{"productCarouselMetadata":{"type":"object","properties":{"productId":{"type":"string","description":"Required for PRODUCT type. Amazon product ID (ASIN)."}},"required":["productId"]}},"required":["productCarouselMetadata"]},{"type":"object","description":"A custom carousel item associated with a broadcast","properties":{"landingPageCarouselMetadata":{"type":"object","properties":{"title":{"type":"string","description":"Required for CUSTOM type. Landing page title displayed in carousel."},"description":{"type":"string","description":"Required for CUSTOM type. Landing page short description."},"linkUrl":{"type":"string","description":"Optional for CUSTOM type. Target URL when viewer taps the carousel item."},"imageUrl":{"type":"string","description":"Optional for CUSTOM type. Display image URL."}},"required":["description","title"]}},"required":["landingPageCarouselMetadata"]}]},"isActive":{"type":"boolean","description":"Optional. If true, item is visible in the carousel. Default false."}},"required":["broadcastId","carouselMetadata","displayOrder","isActive"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["carouselItems","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/create_carousel_item","sectionHeader":{"type":3,"text":"POST /mcp/create_carousel_item"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/create_promo_code",{"operationId":"create_promo_code","description":"Associate a promotion code with an Amazon Live broadcast. The promo code string must already exist in the Amazon promotions system. Required: broadcastId, promoCode. The discount percentage, validity window, and associated product IDs are derived from the promo code in the promotions system and cannot be set directly here. Returns the created association with a server-assigned id.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"promoCodes":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"broadcastId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","description":"Required. The broadcast ID to associate the promo code with."},"promoCode":{"type":"string","description":"Required. The promo code string (must exist in Amazon promotions)."}},"required":["broadcastId","promoCode"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["promoCodes","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/create_promo_code","sectionHeader":{"type":3,"text":"POST /mcp/create_promo_code"},"documentType":"api-reference"},{"title":"amazon_live","content":["/mcp/retrieve_broadcast",{"operationId":"retrieve_broadcast","description":"Retrieve a specific Amazon Live broadcast by its broadcastId. Returns full broadcast details including status, scheduling, chat details, moderation events, carousel item IDs, media asset IDs, and promo code IDs. Use the dedicated list tools (list_carousel_items, list_broadcast_media_assets, list_promo_codes) to retrieve full details for these associated resources.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"broadcastIds":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"string"}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["broadcastIds","accessRequestedAccount"]}}}}}},"tags":["amazon_live"]}],"path":"/en-us/mcp/amazon-live#tag/amazon_live/operation/retrieve_broadcast","sectionHeader":{"type":3,"text":"POST /mcp/retrieve_broadcast"},"documentType":"api-reference"},{"title":"amc","content":["MCP tools related to amc\n"],"path":"/en-us/mcp/amc","sectionHeader":{"type":2,"text":"amc"},"documentType":"api-reference"},{"title":"amc","content":["/mcp/get_workflows",{"operationId":"get_workflows","description":"Returns a list of Amazon Marketing Cloud (AMC) workflows for the given instance and AMC Account","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"amcInstanceId":{"type":"string","description":"The AMC instance ID"}},"required":["amcInstanceId"]},"queryParameters":{"type":"object","properties":{"nextToken":{"type":"string"},"limit":{"type":"integer"}}},"body":{"type":"object","properties":{"accessRequestedAccount":{"properties":{"amcAccountId":{"type":"string","description":"The AMC Account ID. Example value: ENTITYABC123XYZ789."},"marketplaceId":{"type":"string","description":"The Marketplace ID"}},"required":["amcAccountId","marketplaceId"]}},"required":["accessRequestedAccount"]}},"required":["pathParameters","body"]}}}},"tags":["amc"]}],"path":"/en-us/mcp/amc#tag/amc/operation/get_workflows","sectionHeader":{"type":3,"text":"POST /mcp/get_workflows"},"documentType":"api-reference"},{"title":"amc","content":["/mcp/get_data_sources",{"operationId":"get_data_sources","description":"Returns a list of Amazon Marketing Cloud (AMC) data sources for a given instance and AMC Account","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"amcInstanceId":{"type":"string","description":"The AMC instance ID"}},"required":["amcInstanceId"]},"queryParameters":{"type":"object","properties":{"nextToken":{"type":"string"},"limit":{"type":"integer"}}},"body":{"type":"object","properties":{"accessRequestedAccount":{"properties":{"amcAccountId":{"type":"string","description":"The AMC Account ID. Example value: ENTITYABC123XYZ789."},"marketplaceId":{"type":"string","description":"The Marketplace ID"}},"required":["amcAccountId","marketplaceId"]}},"required":["accessRequestedAccount"]}},"required":["pathParameters","body"]}}}},"tags":["amc"]}],"path":"/en-us/mcp/amc#tag/amc/operation/get_data_sources","sectionHeader":{"type":3,"text":"POST /mcp/get_data_sources"},"documentType":"api-reference"},{"title":"amc","content":["/mcp/delete_workflow",{"operationId":"delete_workflow","description":"Deletes the specified Amazon Marketing Cloud (AMC) workflow by id. Workflows are defined as a set of operations that take previously defined data sources as input and use them to generate reports.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"amcInstanceId":{"type":"string","description":"The AMC instance ID"},"workflowId":{"type":"string","description":"The workflow ID"}},"required":["amcInstanceId","workflowId"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","properties":{"amcAccountId":{"type":"string","description":"The AMC Account ID. Example value: ENTITYABC123XYZ789."},"marketplaceId":{"type":"string","description":"The Marketplace ID"}},"required":["amcAccountId","marketplaceId"]}},"required":["accessRequestedAccount"]}},"required":["pathParameters","body"]}}}},"tags":["amc"]}],"path":"/en-us/mcp/amc#tag/amc/operation/delete_workflow","sectionHeader":{"type":3,"text":"POST /mcp/delete_workflow"},"documentType":"api-reference"},{"title":"amc","content":["/mcp/get_workflow",{"operationId":"get_workflow","description":"Gets the requested Amazon Marketing Cloud (AMC) workflow by id. Workflows are defined as a set of operations that take previously defined data sources as input and use them to generate reports.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"amcInstanceId":{"type":"string","description":"The AMC instance ID"},"workflowId":{"type":"string","description":"The workflow ID"}},"required":["amcInstanceId","workflowId"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"properties":{"amcAccountId":{"type":"string","description":"The AMC Account ID. Example value: ENTITYABC123XYZ789."},"marketplaceId":{"type":"string","description":"The Marketplace ID"}},"required":["amcAccountId","marketplaceId"]}},"required":["accessRequestedAccount"]}},"required":["pathParameters","body"]}}}},"tags":["amc"]}],"path":"/en-us/mcp/amc#tag/amc/operation/get_workflow","sectionHeader":{"type":3,"text":"POST /mcp/get_workflow"},"documentType":"api-reference"},{"title":"amc","content":["/mcp/create_workflow",{"operationId":"create_workflow","description":"Creates a new Amazon Marketing Cloud (AMC) workflow that can be used to generate reports.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"amcInstanceId":{"type":"string","description":"The AMC instance ID"}},"required":["amcInstanceId"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"properties":{"amcAccountId":{"type":"string","description":"The AMC Account ID. Example value: ENTITYABC123XYZ789."},"marketplaceId":{"type":"string","description":"The Marketplace ID"}},"required":["amcAccountId","marketplaceId"]},"workflowId":{"type":"string","description":"User-supplied ID of the workflow"},"sqlQuery":{"type":"string","description":"The SQL query to run to produce output for the workflow"},"inputParameters":{"maxItems":100,"minItems":0,"type":"array","description":"Defines the parameters that can be referenced by workflow definition. If workflow references a parameter not defined here the compilation fails.","items":{"type":"object","properties":{"columnType":{"type":"string","description":"The type of the column corresponding to the parameter.","enum":["METRIC","DIMENSION"]},"dataType":{"type":"string","description":"The data type of the parameter corresponding to the data type of a column.","enum":["BINARY","BOOLEAN","BYTE","CALENDAR_INTERVAL","DATE","DECIMAL","DOUBLE","FLOAT","INTEGER","LONG","SHORT","STRING","TIMESTAMP"]},"defaultValue":{"type":"string","description":"The value to assign to the parameter if no value is provided."},"description":{"type":"string","description":"The human-readable description of what the parameter is used for."},"displayName":{"type":"string","description":"The human-readable name of the parameter."},"name":{"type":"string","description":"The name of the parameter used as a variable in SQL."}},"required":["columnType","dataType","defaultValue","description","name"]}}},"required":["accessRequestedAccount","workflowId","sqlQuery"]}},"required":["pathParameters","body"]}}}},"tags":["amc"]}],"path":"/en-us/mcp/amc#tag/amc/operation/create_workflow","sectionHeader":{"type":3,"text":"POST /mcp/create_workflow"},"documentType":"api-reference"},{"title":"amc","content":["/mcp/get_data_source",{"operationId":"get_data_source","description":"Gets the requested Amazon Marketing Cloud (AMC) data source by id. Data sources can be used as input for reporting workflows. Each data source has a flat schema consisting of a list of columns that each have a name, a data type, and a column typeof metric or dimension.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"amcInstanceId":{"type":"string","description":"The AMC instance ID"},"dataSourceId":{"type":"string","description":"The data source ID"}},"required":["amcInstanceId","dataSourceId"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"properties":{"amcAccountId":{"type":"string","description":"The AMC Account ID. Example value: ENTITYABC123XYZ789."},"marketplaceId":{"type":"string","description":"The Marketplace ID"}},"required":["amcAccountId","marketplaceId"]}},"required":["accessRequestedAccount"]}},"required":["pathParameters","body"]}}}},"tags":["amc"]}],"path":"/en-us/mcp/amc#tag/amc/operation/get_data_source","sectionHeader":{"type":3,"text":"POST /mcp/get_data_source"},"documentType":"api-reference"},{"title":"amc","content":["/mcp/get_workflow_execution_download_url",{"operationId":"get_workflow_execution_download_url","description":"Retrieves pre-signed url for downloading Amazon Marketing Cloud (AMC) workflow execution results from S3","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"amcInstanceId":{"type":"string","description":"The AMC instance ID"},"workflowExecutionId":{"type":"string","description":"The workflow execution ID"}},"required":["amcInstanceId","workflowExecutionId"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"properties":{"amcAccountId":{"type":"string","description":"The AMC Account ID. Example value: ENTITYABC123XYZ789."},"marketplaceId":{"type":"string","description":"The Marketplace ID"}},"required":["amcAccountId","marketplaceId"]}},"required":["accessRequestedAccount"]}},"required":["pathParameters","body"]}}}},"tags":["amc"]}],"path":"/en-us/mcp/amc#tag/amc/operation/get_workflow_execution_download_url","sectionHeader":{"type":3,"text":"POST /mcp/get_workflow_execution_download_url"},"documentType":"api-reference"},{"title":"amc","content":["/mcp/execute_query",{"operationId":"execute_query","description":"Executes an ad-hoc SQL query on Amazon Marketing Cloud (AMC) without requiring a pre-existing workflow.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"amcInstanceId":{"type":"string","description":"The AMC instance ID"}},"required":["amcInstanceId"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","properties":{"amcAccountId":{"type":"string","description":"The AMC Account ID. Example value: ENTITYABC123XYZ789."},"marketplaceId":{"type":"string","description":"The Marketplace ID"}},"required":["amcAccountId","marketplaceId"]},"timeWindowEnd":{"type":"string","description":"Only used with a timeWindowType of EXPLICIT. The end of the time window for input data for the execution. This is a nominal time window and not a guarantee that timestamps on any rows will be inside this window. If provided, must also provide a `timeWindowStart`. Required format is yyyy-MM-dd'T'HH:mm:ss."},"timeWindowStart":{"type":"string","description":"Only used with a timeWindowType of `EXPLICIT`. The start of the time window for input data for the execution. This is a nominal time window and not a guarantee that timestamps on any rows will be inside this window. If provided, must also provide a `timeWindowEnd`. Required format is yyyy-MM-dd'T'HH:mm:ss."},"timeWindowTimeZone":{"type":"string","description":"The time zone of the specified time window. This applies to both time window start and end if specified for time window type `EXPLICIT` and to the determination of day and month boundaries for other time window types. If not specified, the UTC time zone will be used."},"timeWindowType":{"type":"string","description":"The type of time window to use for specifying input data for the execution. If not provided, the time window type of `MOST_RECENT_DAY` will be used.","enum":["EXPLICIT","MOST_RECENT_DAY","MOST_RECENT_WEEK","CURRENT_MONTH","PREVIOUS_MONTH","ALL"]},"workflow":{"type":"object","description":"Inline workflow definition containing the SQL query to execute.","properties":{"sqlQuery":{"type":"string","description":"The SQL query to execute against AMC. Used for ad-hoc query execution without a pre-existing workflow."}},"required":["sqlQuery"]},"parameterValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Values to use for the parameters specified in the SQL query."},"requireSyntheticData":{"type":"boolean","description":"if true the execution will only be allowed to use data sets that only contain synthetic data."}},"required":["accessRequestedAccount","workflow"]}},"required":["pathParameters","body"]}}}},"tags":["amc"]}],"path":"/en-us/mcp/amc#tag/amc/operation/execute_query","sectionHeader":{"type":3,"text":"POST /mcp/execute_query"},"documentType":"api-reference"},{"title":"amc","content":["/mcp/execute_workflow",{"operationId":"execute_workflow","description":"Creates a new, ad-hoc execution of an existing Amazon Marketing Cloud (AMC) workflow","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"amcInstanceId":{"type":"string","description":"The AMC instance ID"}},"required":["amcInstanceId"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"properties":{"amcAccountId":{"type":"string","description":"The AMC Account ID. Example value: ENTITYABC123XYZ789."},"marketplaceId":{"type":"string","description":"The Marketplace ID"}},"required":["amcAccountId","marketplaceId"]},"timeWindowEnd":{"type":"string","description":"Only used with a timeWindowType of EXPLICIT. The end of the time window for input data for the workflow execution. This is a nominal time window and not a guarantee that timestamps on any rows will be inside this window. If provided, must also provide a `timeWindowStart`. Required format is yyyy-MM-dd'T'HH:mm:ss."},"timeWindowStart":{"type":"string","description":"Only used with a timeWindowType of `EXPLICIT`. The start of the time window for input data for the workflow execution. This is a nominal time window and not a guarantee that timestamps on any rows will be inside this window. If provided, must also provide a `timeWindowEnd`. Required format is yyyy-MM-dd'T'HH:mm:ss."},"timeWindowTimeZone":{"type":"string","description":"The time zone of the specified time window. This applies to both time window start and end if specified for time window type `EXPLICIT` and to the determination of day and month boundaries for other time window types. If not specified, the UTC time zone will be used."},"timeWindowType":{"type":"string","description":"The type of time window to use to for specifying input data for the workflow execution. If not provided, the time window type of `MOST_RECENT_DAY` will be used.","enum":["EXPLICIT","MOST_RECENT_DAY","MOST_RECENT_WEEK","CURRENT_MONTH","PREVIOUS_MONTH","ALL"]},"workflowId":{"type":"string","description":"The ID of the workflow to execute."},"parameterValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Values to use for the parameters specified in the workflow."}},"required":["accessRequestedAccount","workflowId"]}},"required":["pathParameters","body"]}}}},"tags":["amc"]}],"path":"/en-us/mcp/amc#tag/amc/operation/execute_workflow","sectionHeader":{"type":3,"text":"POST /mcp/execute_workflow"},"documentType":"api-reference"},{"title":"amc","content":["/mcp/get_workflow_execution_status",{"operationId":"get_workflow_execution_status","description":"Gets status information about the requested Amazon Marketing Cloud (AMC) workflow execution","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"amcInstanceId":{"type":"string","description":"The AMC instance ID"},"workflowExecutionId":{"type":"string","description":"The workflow execution ID"}},"required":["amcInstanceId","workflowExecutionId"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"properties":{"amcAccountId":{"type":"string","description":"The AMC Account ID. Example value: ENTITYABC123XYZ789."},"marketplaceId":{"type":"string","description":"The Marketplace ID"}},"required":["amcAccountId","marketplaceId"]}},"required":["accessRequestedAccount"]}},"required":["pathParameters","body"]}}}},"tags":["amc"]}],"path":"/en-us/mcp/amc#tag/amc/operation/get_workflow_execution_status","sectionHeader":{"type":3,"text":"POST /mcp/get_workflow_execution_status"},"documentType":"api-reference"},{"title":"billing","content":["MCP tools related to billing\n"],"path":"/en-us/mcp/billing","sectionHeader":{"type":2,"text":"billing"},"documentType":"api-reference"},{"title":"billing","content":["/mcp/list_invoice_summaries",{"operationId":"list_invoice_summaries","description":"Lists billing invoice summaries in a global ads account. Supports filtering by date range, country, status, payment method, invoice number, and reserve order number. Also supports sorting and aggregation.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"maxResults":{"type":"integer","description":"Max results per page. Default 100."},"nextToken":{"type":"string","description":"Offset to fetch next page of billing invoice summaries."},"invoiceIssuedDateRangeFilter":{"type":"object","description":"Filter by invoice issued date range.","properties":{"startDate":{"type":"string","description":"Start date (inclusive) in ISO-8601 date format (e.g. 2024-01-01)."},"endDate":{"type":"string","description":"End date (inclusive) in ISO-8601 date format (e.g. 2024-12-31)."}}},"invoiceDueDateRangeFilter":{"type":"object","description":"Filter by invoice due date range.","properties":{"startDate":{"type":"string","description":"Start date (inclusive) in ISO-8601 date format."},"endDate":{"type":"string","description":"End date (inclusive) in ISO-8601 date format."}}},"countryValueFilter":{"type":"object","description":"Filter by country values.","properties":{"include":{"type":"array","items":{"type":"string"},"description":"List of country values to filter by."},"queryTermMatchType":{"type":"string","description":"Match type for the filter (exact or broad)."}}},"statusValueFilter":{"type":"object","description":"Filter by invoice status values.","properties":{"include":{"type":"array","items":{"type":"string"},"description":"List of invoice status values to filter by."},"queryTermMatchType":{"type":"string","description":"Match type for the filter."}}},"paymentMethodTypeValueFilter":{"type":"object","description":"Filter by payment method type.","properties":{"include":{"type":"array","items":{"type":"string"},"description":"List of payment method types to filter by."},"queryTermMatchType":{"type":"string","description":"Match type for the filter."}}},"invoiceNumberFilter":{"type":"object","description":"Filter by invoice numbers.","properties":{"include":{"type":"array","items":{"type":"string"},"description":"List of invoice numbers to filter by."}}},"reserveOrderNumberFilter":{"type":"object","description":"Filter by reserve order numbers.","properties":{"include":{"type":"array","items":{"type":"string"},"description":"List of reserve order numbers to filter by."}}},"sort":{"type":"object","description":"Sort configuration.","properties":{"attribute":{"type":"string","description":"Sort key/attribute."},"direction":{"type":"string","description":"Sort order: ascending or descending."}}},"aggregation":{"type":"object","description":"Aggregation query configuration.","properties":{"groupBy":{"type":"string","description":"Aggregation bucket."},"attribute":{"type":"string","description":"Aggregation attribute."},"operation":{"type":"string","description":"Aggregate operation."}}}}}},"required":["body"]}}}},"tags":["billing"]}],"path":"/en-us/mcp/billing#tag/billing/operation/list_invoice_summaries","sectionHeader":{"type":3,"text":"POST /mcp/list_invoice_summaries"},"documentType":"api-reference"},{"title":"billing","content":["/mcp/query_billing_notifications",{"operationId":"query_billing_notifications","description":"This tool allows retrieving comprehensive billing notifications for Amazon advertising accounts. The tool provides a comprehensive set of billing-related notifications for an advertiser account, enabling advertisers to understand the billing status for their accounts. These notifications also cover various billing scenarios such as payment method issues, billing profile problems, account suspension related issues, tax registration status, payment failures etc. The notifications are aggregated by their type and  list the advertiserMarketplaces (i.e., the marketplaces/countries in which this notification is applicable), providing a consolidated view  of billing health across all regions where the advertiser operates. The tool provides three types of notifications based on severity: INFO (informational updates), WARNING (issues requiring attention), and ALERT (critical problems requiring immediate action).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","description":"The properties needed to get the billing notifications for a set of advertisers.","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]}]},"advertiserMarketplaces":{"type":"array","items":{"type":"object","properties":{"advertiserId":{"type":"string"},"advertiserType":{"type":"string","enum":["AGENCY","DSP_ADVERTISING_ACCOUNT","SELLER","VENDOR"]},"marketplaceId":{"type":"string"}},"required":["advertiserId","marketplaceId"]}},"locale":{"type":"string","enum":["ar_AE","bn_IN","cs_CZ","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_NG","en_SG","en_US","en_ZA","es_CL","es_CO","es_ES","es_MX","es_US","fr_BE","fr_CA","fr_FR","he_IL","hi_IN","it_IT","ja_JP","ko_KR","ml_IN","mr_IN","nl_BE","nl_NL","pl_PL","pt_BR","pt_PT","sv_SE","ta_IN","te_IN","tr_TR","zh_CN","zh_TW"]}},"required":["accessRequestedAccount"]}},"required":["body"]}}}},"tags":["billing"]}],"path":"/en-us/mcp/billing#tag/billing/operation/query_billing_notifications","sectionHeader":{"type":3,"text":"POST /mcp/query_billing_notifications"},"documentType":"api-reference"},{"title":"billing","content":["/mcp/list_invoices",{"operationId":"list_invoices","description":"This tool allows retrieving invoices for Amazon advertising accounts. The tool fetches invoices across an advertiser account, allowing an account to access comprehensive invoicing and charges summary. It provides detailed invoicing information for the account such as the invoice amounts, fees, due dates, the payment method for the invoice, payment terms, invoice status etc. It supports flexible filtering by start and end dates and the status of invoices.\nThe tool should be invoked without setting the invoiceStatuses parameter to fetch all invoices for an advertiser account. If just unpaid invoices or charges need to be fetched for the account, then the tool should be invoked with invoiceStatuses being ISSUED and PAID_IN_PART","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]},"queryParameters":{"type":"object","properties":{"invoiceStatuses":{"type":"array","items":{"type":"string","enum":["ISSUED","PAID_IN_FULL","PAID_IN_PART","WRITTEN_OFF"]},"description":"* `ISSUED`: An invoice is issued when its charges are finalized and tax is computed on the total amount. \n* `PAID_IN_PART`: When a partial payment is received, the invoice status will change to paid in part.\n* `PAID_IN_PART`: One full payment has been received, the invoice will be paid in full.\n* `WRITTEN_OFF`: If an invoice is written off because of an error, the status will be updated to written off.\n"},"startDate":{"description":"The starting date (inclusive) of the date range for filtering invoices. Please provide the date in ISO-8601 format, representing a UTC date with only the date portion (no time)."},"endDate":{"description":"The ending date (inclusive) of the date range for filtering invoices. Please provide the date in ISO-8601 format, representing a UTC date with only the date portion (no time)."},"count":{"type":"integer","description":"Number of records to include in the paged response. Defaults to 100. Cannot be combined with the cursor parameter."},"cursor":{"type":"string","description":"A cursor representing how far into a result set this query should begin. In the absence of a cursor the request will default to start index of 0 and page size of 100."}}}}}}}},"tags":["billing"]}],"path":"/en-us/mcp/billing#tag/billing/operation/list_invoices","sectionHeader":{"type":3,"text":"POST /mcp/list_invoices"},"documentType":"api-reference"},{"title":"billing","content":["/mcp/list_billing_profile_usages",{"operationId":"list_billing_profile_usages","description":"Lists the billing profiles linked to each country of a global ads account. Can filter by advertiser and optionally expand billing profile details.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"nextToken":{"type":"string","description":"Offset to fetch next page of billing profile usages."},"maxResults":{"type":"integer","description":"Max results per page. Default 100."},"filters":{"type":"object","properties":{"advertiserFilter":{"type":"array","description":"List of country or sellerOfRecord(sor) level filters for which billing profile usage details needs to be fetched.","items":{"type":"object","properties":{"countryCode":{"type":"string","description":"Country code (e.g. US, UK, DE, JP)."}},"required":["countryCode"]}}}},"expandBillingProfile":{"type":"boolean","description":"Set true to include full billing profile content. Default false."},"expandFallbackBillingProfile":{"type":"boolean","description":"Set true to include fallback billing profile[actually visible on the invoice] info. Default false."}}}},"required":["body"]}}}},"tags":["billing"]}],"path":"/en-us/mcp/billing#tag/billing/operation/list_billing_profile_usages","sectionHeader":{"type":3,"text":"POST /mcp/list_billing_profile_usages"},"documentType":"api-reference"},{"title":"campaign_management","content":["MCP tools related to campaign_management\n"],"path":"/en-us/mcp/campaign-management","sectionHeader":{"type":2,"text":"campaign_management"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/delete_ad_association",{"operationId":"delete_ad_association","description":"Delete Amazon Ads Ad Associations. Remove associations between ads and ad groups.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]}]},"adAssociationIds":{"type":"array","items":{"type":"string"}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Ad Association"]}],"path":"/en-us/mcp/campaign-management#tag/Ad%20Association/operation/delete_ad_association","sectionHeader":{"type":3,"text":"POST /mcp/delete_ad_association"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/query_ad",{"operationId":"query_ad","description":"Query Amazon Ads with advanced filtering capabilities. Search and filter individual ads across all Amazon advertising products.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"adGroupIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"adIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"adProductFilter":{"type":"object","properties":{"include":{"type":"array","minItems":1,"maxItems":1,"items":{"type":"string","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"]},"description":"Only one ad product can be queried at a time."}},"required":["include"]},"campaignIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"marketplaceScopeFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]}}},"required":["include"]},"maxResults":{"type":"integer"},"nameFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}},"queryTermMatchType":{"type":"string","enum":["BROAD_MATCH","EXACT_MATCH"]}},"required":["include","queryTermMatchType"]},"nextToken":{"type":"string"},"stateFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["ARCHIVED","ENABLED","PAUSED"]}}},"required":["include"]}},"required":["accessRequestedAccount","adProductFilter"]}},"required":["body"]}}}},"tags":["Ad"]}],"path":"/en-us/mcp/campaign-management#tag/Ad/operation/query_ad","sectionHeader":{"type":3,"text":"POST /mcp/query_ad"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/create_ad_association",{"operationId":"create_ad_association","description":"Create Amazon Ads Ad Associations. Associate ads with ad groups across Amazon advertising products.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]}]},"adAssociations":{"type":"array","items":{"type":"object","properties":{"adGroupId":{"type":"string","description":"The ad group associated with the ad."},"adId":{"type":"string","description":"The ad Id  associated with the ad."},"endDateTime":{"type":"string","description":"The end date time for the ad association."},"startDateTime":{"type":"string","description":"The start date time for the ad association."},"state":{"type":"string","enum":["ENABLED","PAUSED"]},"weight":{"type":"integer","description":"The relative percentage of traffic which would be directed to the associated Ad Creative in the Ad Group."}},"required":["adGroupId","adId","state"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Ad Association"]}],"path":"/en-us/mcp/campaign-management#tag/Ad%20Association/operation/create_ad_association","sectionHeader":{"type":3,"text":"POST /mcp/create_ad_association"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/query_ad_association",{"operationId":"query_ad_association","description":"Query Amazon Ads Ad Associations with advanced filtering capabilities. Search for associations between ads and ad groups.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]}]},"adAssociationIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"adGroupIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"adIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"maxResults":{"type":"integer"},"nextToken":{"type":"string"}},"required":["accessRequestedAccount"]}}}}}},"tags":["Ad Association"]}],"path":"/en-us/mcp/campaign-management#tag/Ad%20Association/operation/query_ad_association","sectionHeader":{"type":3,"text":"POST /mcp/query_ad_association"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/create_target",{"operationId":"create_target","description":"Create Amazon Ads Targets. Create targeting criteria including keywords, products, categories, and audiences.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"targets":{"type":"array","items":{"type":"object","properties":{"adGroupId":{"type":"string","description":"A unique identifier for the ad group associated with the target. Only used for ad-group level targets."},"adProduct":{"type":"string","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"]},"bid":{"type":"object","properties":{"bid":{"type":"number","description":"The maximum bid for a target."},"marketplaceSettings":{"type":"array","description":"The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"type":"object","properties":{"bid":{"type":"number","description":"The maximum bid for a target."},"currencyCode":{"type":"string","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EGP","EUR","GBP","INR","JPY","MXN","MXP","NGN","NOK","NZD","PLN","SAR","SEK","SGD","TRY","USD","ZAR"]},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}}}}},"campaignId":{"type":"string","description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets."},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target's global value is applied to that marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"state":{"type":"string","enum":["ARCHIVED","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the target","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}},"targetDetails":{"oneOf":[{"type":"object","properties":{"keywordTarget":{"type":"object","description":"Targets a specific customer search term.","properties":{"keyword":{"type":"string","description":"The customer search term or text to target"},"matchType":{"type":"string","description":"| KeywordMatchType | Description |\n| --- | --- |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms.This expands matching on user intent beyond EXACT. |\n| `BROAD` | Braod match search terms.This expands matching on user intent beyond PHRASE.  |\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |","enum":["BROAD","EXACT","MULTISIGNAL_BROAD","PHRASE"]},"nativeLanguageKeyword":{"type":"string","description":"The unlocalized keyword text in the preferred locale of the advertiser."},"nativeLanguageLocale":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]}}}},"required":["keywordTarget"]},{"type":"object","properties":{"themeTarget":{"type":"object","description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"type":"string","description":"| ThemeMatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you're advertising. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |","enum":["INTERESTED_AUDIENCE","KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS","PRODUCT_COMPLEMENTS","PRODUCT_SUBSTITUTES"]}}}},"required":["themeTarget"]},{"type":"object","properties":{"inventorySourceTarget":{"type":"object","description":"Target based on the source of the inventory.","properties":{"inventorySourceId":{"type":"object","properties":{"defaultValue":{"type":"string","description":"The default value. Either the default value or the marketplace settings should always be specified"}}},"inventorySourceType":{"type":"string","description":"| InventorySourceType | Description |\n| --- | --- |\n| `AMAZON` |  |\n| `APD` |  |\n| `DEAL` |  |\n| `INVENTORY_GROUP` |  |\n| `THIRD_PARTY_EXCHANGE` |  |","enum":["AMAZON","APD","DEAL","INVENTORY_GROUP","THIRD_PARTY_EXCHANGE"]}},"required":["inventorySourceId","inventorySourceType"]}},"required":["inventorySourceTarget"]}]}}}}}},"marketplaceScope":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]},"marketplaces":{"type":"array","description":"A list of country codes representing Amazon marketplaces","items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"negative":{"type":"boolean","description":"Indicates whether the target is negative or not."},"state":{"type":"string","description":"The user defined state for the resource. DRAFT applies to Amazon DSP targets only; every other ad product accepts ENABLED and PAUSED. Amazon DSP has no update-targets operation, so a draft target cannot be moved to another state afterwards - it can only be deleted.","enum":["DRAFT","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the target","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}},"targetDetails":{"oneOf":[{"type":"object","properties":{"keywordTarget":{"type":"object","description":"Targets a specific customer search term.","properties":{"keyword":{"type":"string","description":"The customer search term or text to target"},"matchType":{"type":"string","description":"| KeywordMatchType | Description |\n| --- | --- |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms.This expands matching on user intent beyond EXACT. |\n| `BROAD` | Braod match search terms.This expands matching on user intent beyond PHRASE.  |\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |","enum":["BROAD","EXACT","MULTISIGNAL_BROAD","PHRASE"]},"nativeLanguageKeyword":{"type":"string","description":"The unlocalized keyword text in the preferred locale of the advertiser."},"nativeLanguageLocale":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]}}}},"required":["keywordTarget"]},{"type":"object","properties":{"productTarget":{"type":"object","description":"Targets a specific product.","properties":{"matchType":{"type":"string","description":"| ProductMatchType | Description |\n| --- | --- |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |","enum":["PRODUCT_EXACT","PRODUCT_SIMILAR"]},"product":{"type":"object","properties":{"marketplaceSettings":{"type":"array","description":"The product ids at specific marketplace level. Either the product id or the marketplace settings should always be specified","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productId":{"type":"string","description":"The product id applicable at the specified marketplace."}}}},"productId":{"type":"string","description":"The product identifier. Either the product id or the marketplace settings should always be specified"}}},"productIdType":{"type":"string","enum":["ASIN","SKU"]}}}},"required":["productTarget"]},{"type":"object","properties":{"productCategoryTarget":{"type":"object","description":"Targets a specific customer search term.","properties":{"productCategoryRefinement":{"type":"object","properties":{"marketplaceSettings":{"type":"array","description":"Marketplace specific product category refinements. Either the value or the marketplaceSettings should always be specified","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productCategoryRefinement":{"type":"object","properties":{"productAgeRangeId":{"type":"string","description":"The age range ID to target."},"productAgeRangeIdResolved":{"type":"string","description":"The resolved age range to target."},"productBrandId":{"type":"string","description":"The brand ID to target."},"productBrandIdResolved":{"type":"string","description":"The resolved name of the brand."},"productCategoryId":{"type":"string","description":"The product category ID to target."},"productCategoryIdResolved":{"type":"string","description":"The resolved product category."},"productGenreId":{"type":"string","description":"The product genre ID to target."},"productPriceGreaterThan":{"type":"number","description":"Refinement to target products with a price greater than the value within the product category."},"productPriceLessThan":{"type":"number","description":"Refinement to target products with a price less than the value within the product category."},"productPrimeShippingEligible":{"type":"boolean","description":"Target based on if a product is Prime-shipping eligible."},"productRatingGreaterThan":{"type":"number","description":"Refinement to target products with a rating greater than the value within the product category."},"productRatingLessThan":{"type":"number","description":"Refinement to target products with a rating less than the value within the product category."}}}}}},"productCategoryRefinement":{"type":"object","properties":{"productAgeRangeId":{"type":"string","description":"The age range ID to target."},"productAgeRangeIdResolved":{"type":"string","description":"The resolved age range to target."},"productBrandId":{"type":"string","description":"The brand ID to target."},"productBrandIdResolved":{"type":"string","description":"The resolved name of the brand."},"productCategoryId":{"type":"string","description":"The product category ID to target."},"productCategoryIdResolved":{"type":"string","description":"The resolved product category."},"productGenreId":{"type":"string","description":"The product genre ID to target."},"productPriceGreaterThan":{"type":"number","description":"Refinement to target products with a price greater than the value within the product category."},"productPriceLessThan":{"type":"number","description":"Refinement to target products with a price less than the value within the product category."},"productPrimeShippingEligible":{"type":"boolean","description":"Target based on if a product is Prime-shipping eligible."},"productRatingGreaterThan":{"type":"number","description":"Refinement to target products with a rating greater than the value within the product category."},"productRatingLessThan":{"type":"number","description":"Refinement to target products with a rating less than the value within the product category."}}}}},"productGenreRefinement":{"type":"object","properties":{"productGenreId":{"type":"string","description":"The product genre ID to target."}}}}}},"required":["productCategoryTarget"]},{"type":"object","properties":{"productAudienceTarget":{"type":"object","description":"Target customers who have viewed or purchased a certain product within a specified lookback window.","properties":{"asin":{"type":"object","properties":{"defaultValue":{"type":"string","description":"The default value. Either the default value or the marketplace settings should always be specified"},"marketplaceSettings":{"type":"array","description":"The marketplace specific value pairs. Either the default value or the marketplace settings should always be specified","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"value":{"type":"string","description":"The value applicable at the specified marketplace."}}}}}},"event":{"type":"string","enum":["PURCHASE","VIEW"]},"lookback":{"type":"string","enum":["DAYS_14","DAYS_180","DAYS_30","DAYS_365","DAYS_60","DAYS_7","DAYS_90"]},"matchType":{"type":"string","enum":["PRODUCT_EXACT","PRODUCT_SIMILAR"]}}}},"required":["productAudienceTarget"]},{"type":"object","properties":{"audienceTarget":{"type":"object","description":"Target based on a specified audience ID.","properties":{"acrossGroupOperator":{"type":"string","enum":["ALL","ANY"]},"audienceId":{"type":"object","properties":{"defaultValue":{"type":"string","description":"The default value. Either the default value or the marketplace settings should always be specified"},"marketplaceSettings":{"type":"array","description":"The marketplace specific value pairs. Either the default value or the marketplace settings should always be specified","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"value":{"type":"string","description":"The value applicable at the specified marketplace."}}}}}},"groupId":{"type":"string","description":"The string identifying a group of audiences. Only numbers formatted as strings are accepted (e.g. '1'). To add audiences to a new group, choose any string not currently being used on this ad group. To add audiences to an existing group, use the existing groupId from this ad group. You may specify up to 10 include groups and 1 exclude group."},"inGroupOperator":{"type":"string","enum":["ALL","ANY"]}}}},"required":["audienceTarget"]},{"type":"object","properties":{"locationTarget":{"type":"object","description":"Target based on geographic location.","properties":{"locationId":{"type":"string","description":"The ID of the geographic location to target."},"locationIdResolved":{"type":"string","description":"A human-readable location text. It's a read-only field."}}}},"required":["locationTarget"]},{"type":"object","properties":{"domainTarget":{"type":"object","description":"Target based on a specified domain.","properties":{"domainTargetDetails":{"oneOf":[{"type":"object","properties":{"domainListTarget":{"type":"object","description":"Targets domains based on an existing domain list.","properties":{"domainListId":{"type":"string","description":"The ID of the domain list to target."}}}},"required":["domainListTarget"]},{"type":"object","properties":{"domainNameTarget":{"type":"object","description":"Targets domains based on URL.","properties":{"domainName":{"type":"string","description":"The URL of the domain to target."}}}},"required":["domainNameTarget"]},{"type":"object","properties":{"domainFileTarget":{"type":"object","description":"Targets domains based on list provided via file upload.","properties":{"domainFileKey":{"type":"string","description":"The URL of the domain to target."},"domainFileName":{"type":"string","description":"The name of the file."}}}},"required":["domainFileTarget"]},{"type":"object","properties":{"advertiserDomainList":{"type":"object","description":"Targets domains based on list inherited from the advertiser.","properties":{"inheritFromAdvertiser":{"type":"boolean","description":"Set to TRUE to inherit domain list from advertiser."}}}},"required":["advertiserDomainList"]}]},"domainTargetType":{"type":"string","enum":["ADVERTISER_DOMAIN_LIST","DOMAIN_FILE","DOMAIN_LIST","DOMAIN_NAME"]}}}},"required":["domainTarget"]},{"type":"object","properties":{"appTarget":{"type":"object","description":"Target based on user application.","properties":{"appId":{"type":"string","description":"The app identifier being targeted."},"appType":{"type":"string","enum":["MOBILE","STREAMING_TV"]}}}},"required":["appTarget"]},{"type":"object","properties":{"deviceTarget":{"type":"object","description":"Target based on user device.","properties":{"deviceOrientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT"]},"deviceType":{"type":"string","description":"| DeviceType | Description |\n| --- | --- |\n| `DESKTOP` |  |\n| `MOBILE` |  |\n| `CONNECTED_TV` |  |\n| `CONNECTED_DEVICE` | Connected TV, smart speakers. Used for audio AdGroup type. |","enum":["CONNECTED_DEVICE","CONNECTED_TV","DESKTOP","MOBILE"]},"mobileDevice":{"type":"string","enum":["ANDROID","IPAD","IPHONE","KINDLE_FIRE","KINDLE_FIRE_HD"]},"mobileEnvironment":{"type":"string","enum":["APP","WEB"]},"mobileOs":{"type":"string","enum":["ANDROID","IOS"]}}}},"required":["deviceTarget"]},{"type":"object","properties":{"dayPartTarget":{"type":"object","description":"Target based on time of day.","properties":{"dayOfWeek":{"type":"string","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"]},"timeOfDay":{"type":"object","properties":{"endTime":{"type":"string","description":"Selected end time"},"startTime":{"type":"string","description":"Selected start time"}}}}}},"required":["dayPartTarget"]},{"type":"object","properties":{"contentCategoryTarget":{"type":"object","description":"Target based on the category of content being viewed.","properties":{"contentCategoryId":{"type":"string","description":"The content category ID being targeted."}}}},"required":["contentCategoryTarget"]},{"type":"object","properties":{"contentGenreTarget":{"type":"object","description":"Target based on the genre of content being viewed.","properties":{"contentGenre":{"type":"string","enum":["ACTION","ADVENTURE","ALTERNATIVE_ROCK","ANIMATION","ARTS","BIOGRAPHY","BLUES","BUSINESS","CHILDRENS_MUSIC","CHRISTIAN_GOSPEL","CHRISTMAS_HOLIDAY","CLASSICAL","CLASSIC_ROCK","COLLEGE_RADIO","COMEDY","COUNTRY","CRIME","DANCE_DJ","DOCUMENTARY","DRAMA","EASY_LISTENING","EDUCATION","EUROPEAN_POP_FOLK","FAMILY","FANTASY","FICTION","FILM_NOIR","FOLK","FRENCH_VARIETY","GAME_SHOW","GENRE_NOT_AVAILABLE","GERMAN_ROCK_POP","GOVERNMENT","HARD_ROCK_METAL","HEALTH_AND_FITNESS","HISTORY","HORROR","INTERNATIONAL","JAPANESE","JAZZ","KIDS_AND_FAMILY","LATIN_MUSIC","LEISURE","MISCELLANEOUS","MUSIC","MUSICAL","MUSICALS_CABARET","MYSTERY","NEWS","NEW_AGE","OLDIES_ADULT_STANDARDS","POP","RAP_HIP_HOP","RB","REALITY_TV","REGGAE_ISLAND","RELIGION_AND_SPIRITUALITY","ROCK","ROMANCE","SCIENCE","SCIENCE_FICTION","SHORT","SOCIETY_AND_CULTURE","SOUNDTRACKS","SPORT","SUPER_HERO","TALK_SHOW","TECHNOLOGY","THRILLER","TRUE_CRIME","TV_AND_FILM","WAR","WESTERN"]}}}},"required":["contentGenreTarget"]},{"type":"object","properties":{"contentRatingTarget":{"type":"object","description":"Target based on the rating of content being viewed.","properties":{"contentRatingType":{"type":"string","enum":["DSP_CONTENT_RATING","TWITCH_CONTENT_RATING"]},"contentRatingTypeDetails":{"oneOf":[{"type":"object","properties":{"dspContentRating":{"type":"object","properties":{"dspContentRating":{"type":"string","description":"| DspContentRatingEnum | Description |\n| --- | --- |\n| `SUITABLE_FOR_ALL_AUDIENCES` | Equivalent to content that is rated G (film), TV-Y (TV), TV-Y7 (TV), TV-G (TV), EC (game), or E (game). |\n| `SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE` | Equivalent to content that is rated PG (film), TV-PG (TV), or E-10+ (game). |\n| `SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES` | Equivalent to content that is rated PG-13 (film), TV-14 (TV), or T (game). |\n| `SUITABLE_FOR_MATURE_AUDIENCES` | Ages 17+. Equivalent to content that is rated R (film), TV-MA (TV), or M (game). |\n| `SUITABLE_FOR_ADULTS` | Ages 18+. Equivalent to content that is rated NC-17 (film). |\n| `RATING_NOT_AVAILABLE` | Content where rating isn't available from the publisher. |","enum":["RATING_NOT_AVAILABLE","SUITABLE_FOR_ADULTS","SUITABLE_FOR_ALL_AUDIENCES","SUITABLE_FOR_MATURE_AUDIENCES","SUITABLE_FOR_MOST_AUDIENCES_WITH_PARENTAL_GUIDANCE","SUITABLE_FOR_TEEN_AND_OLDER_AUDIENCES"]}}}},"required":["dspContentRating"]},{"type":"object","properties":{"twitchContentRating":{"type":"object","properties":{"twitchContentRating":{"type":"string","description":"| TwitchContentRatingEnum | Description |\n| --- | --- |\n| `TWITCH_MODERATE` | Twitch Content with moderate content exclusions based on content classification labels received from Twitch. |\n| `TWITCH_RESTRICTIVE` | Twitch Content with restrictive content exlcusions based on content classification labels received from Twitch. |","enum":["TWITCH_MODERATE","TWITCH_RESTRICTIVE"]}}}},"required":["twitchContentRating"]}]}}}},"required":["contentRatingTarget"]},{"type":"object","properties":{"brandSafetyTierTarget":{"type":"object","description":"Target based on the brand suitability risk levels of content being viewed.","properties":{"brandSafetyTier":{"type":"string","description":"| BrandSafetyTier | Description |\n| --- | --- |\n| `EXPANDED` | Tier that maximizes reach across all ad-eligible inventory. This tier is suitable for brands with a greater risk tolerance for advertising alongside a wide variety of content. |\n| `STANDARD` | Tier that offers broad reach and is the default for all campaigns. This tier is suitable for brands with a moderate risk tolerance for advertising alongside a wide variety of content. |\n| `RESTRICTIVE` | Tier that prioritizes brand suitability over reach. This tier is suitable for brands with the lowest risk tolerance for advertising alongside a wide variety of content. |","enum":["EXPANDED","RESTRICTIVE","STANDARD"]}}}},"required":["brandSafetyTierTarget"]},{"type":"object","properties":{"inventorySourceTarget":{"type":"object","description":"Target based on the source of the inventory.","properties":{"inventorySourceId":{"type":"object","properties":{"defaultValue":{"type":"string","description":"The default value. Either the default value or the marketplace settings should always be specified"},"marketplaceSettings":{"type":"array","description":"The marketplace specific value pairs. Either the default value or the marketplace settings should always be specified","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"value":{"type":"string","description":"The value applicable at the specified marketplace."}}}}}},"inventorySourceType":{"type":"string","enum":["AMAZON","APD","DEAL","INVENTORY_GROUP","THIRD_PARTY_EXCHANGE"]}}}},"required":["inventorySourceTarget"]},{"type":"object","properties":{"adInitiationTarget":{"type":"object","description":"Target based on how the video ad will be started.","properties":{"videoInitiationType":{"type":"string","enum":["AUTOPLAY","UNKNOWN","USER_INITIATED"]}}}},"required":["adInitiationTarget"]},{"type":"object","properties":{"adPlayerSizeTarget":{"type":"object","description":"Target based on the size of the ad player.","properties":{"adPlayerSize":{"type":"string","enum":["LARGE","MEDIUM","SMALL","UNKNOWN"]}}}},"required":["adPlayerSizeTarget"]},{"type":"object","properties":{"videoAdFormatTarget":{"type":"object","description":"Target based on the video ad format.","properties":{"videoAdFormat":{"type":"string","enum":["FULL_EPISODE_PLAYER","INSTREAM","OUTSTREAM"]}}}},"required":["videoAdFormatTarget"]},{"type":"object","properties":{"thirdPartyTarget":{"type":"object","properties":{"thirdPartyTargetDetails":{"oneOf":[{"type":"object","properties":{"doubleVerifyFraudInvalidTraffic":{"type":"object","properties":{"blockAppAndSites":{"type":"boolean","description":"Set to true to block applications and sites with insufficient historical fraud and invalid traffic statistics. This will not be applicable if ALLOW_ALL is chosen."},"excludeAppsAndSites":{"type":"string","enum":["ALLOW_ALL","FRAUD_TRAFFIC_LEVEL_GTE_02","FRAUD_TRAFFIC_LEVEL_GTE_04","FRAUD_TRAFFIC_LEVEL_GTE_06","FRAUD_TRAFFIC_LEVEL_GTE_08","FRAUD_TRAFFIC_LEVEL_GTE_10","FRAUD_TRAFFIC_LEVEL_GTE_100","FRAUD_TRAFFIC_LEVEL_GTE_25","FRAUD_TRAFFIC_LEVEL_GTE_50"]},"excludeImpressions":{"type":"boolean","description":"Set to true to exclude impressions delivered to devices identified to be fraudulent or invalid."}}}},"required":["doubleVerifyFraudInvalidTraffic"]},{"type":"object","properties":{"doubleVerifyStandardDisplayBrandSafety":{"type":"object","properties":{"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","EXTREME_GRAPHIC","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"array","items":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","properties":{"key":{"type":"string","description":"Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC]."},"value":{"type":"string","description":"The Double Verify brand suitability risk level.\n| BrandSuitabilityRiskLevelType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `HIGH` |  |\n| `HIGH_MEDIUM` |  |\n| `HIGH_MEDIUM_LOW` |  |","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]}}}},"unknownContent":{"type":"boolean","description":"Set to true to exclude unknown content."}}}},"required":["doubleVerifyStandardDisplayBrandSafety"]},{"type":"object","properties":{"doubleVerifyBrandSafety":{"type":"object","properties":{"appAgeRating":{"type":"array","description":"A list of app age ratings to be used for excluding apps. For example, TEENS_12_PLUS will only exclude apps with content rated for everyone ages 12 and over. UNKNOWN will exclude apps with content unrated or unknown to Double Verify.","items":{"type":"string","enum":["ADULTS_ONLY_18_PLUS","EVERYONE_4_PLUS","MATURE_17_PLUS","TEENS_12_PLUS","TWEENS_9_PLUS","UNKNOWN"]}},"appStarRating":{"type":"string","description":"App star rating to be used for excluding apps.\n| DVBrandSafetyAppStarRatingType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `APP_STAR_RATING_LT_1_POINT_5_STARS` |  |\n| `APP_STAR_RATING_LT_2_STARS` |  |\n| `APP_STAR_RATING_LT_2_POINT_5_STARS` |  |\n| `APP_STAR_RATING_LT_3_STARS` |  |\n| `APP_STAR_RATING_LT_3_POINT_5_STARS` |  |\n| `APP_STAR_RATING_LT_4_STARS` |  |\n| `APP_STAR_RATING_LT_4_POINT_5_STARS` |  |","enum":["ALLOW_ALL","APP_STAR_RATING_LT_1_POINT_5_STARS","APP_STAR_RATING_LT_2_POINT_5_STARS","APP_STAR_RATING_LT_2_STARS","APP_STAR_RATING_LT_3_POINT_5_STARS","APP_STAR_RATING_LT_3_STARS","APP_STAR_RATING_LT_4_POINT_5_STARS","APP_STAR_RATING_LT_4_STARS"]},"contentCategories":{"type":"array","description":"A list of content categories to exclude from targeting.","items":{"type":"string","enum":["AD_SERVER","CELEBRITY_GOSSIP","CULTS_SURVIVALISM","EXTREME_GRAPHIC","GAMBLING","INCENTIVIZED_MALWARE_CLUTTER","INFLAMMATORY_POLITICS_NEWS","NEGATIVE_NEWS_FINANCIAL","NEGATIVE_NEWS_PHARMACEUTICAL","NON_STANDARD_CONTENT_NON_ENGLISH","NON_STANDARD_CONTENT_PARKING_PAGE","OCCULT","PIRACY_COPYRIGHT_INFRINGEMENT","UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"]}},"contentCategoriesWithRisk":{"type":"array","items":{"type":"object","description":"A map from content categories to risk level to exclude from targeting. Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC].","properties":{"key":{"type":"string","description":"Available keys are: [ADULT_CONTENT, ALCOHOL, CRIME, DEATH_INJURIES, DISASTER_AVIATION, DISASTER_MAN_MADE, DISASTER_NATURAL, DISASTER_TERRORIST_EVENTS, DISASTER_VEHICLE, HATE_SPEECH, PROFANITY, SUBSTANCE_ABUSE, TOBACCO_ECIGARETTES, VIOLENCE_EXTREME_GRAPHIC]."},"value":{"type":"string","description":"The Double Verify brand suitability risk level.\n| BrandSuitabilityRiskLevelType | Description |\n| --- | --- |\n| `ALLOW_ALL` |  |\n| `HIGH` |  |\n| `HIGH_MEDIUM` |  |\n| `HIGH_MEDIUM_LOW` |  |","enum":["ALLOW_ALL","HIGH","HIGH_MEDIUM","HIGH_MEDIUM_LOW"]}}}},"excludeAppsWithInsufficientRating":{"type":"boolean","description":"Set to true to exclude unofficial apps or apps with insufficient user ratings (<100 lifetime)."},"unknownContent":{"type":"boolean","description":"Set to true to exclude unknown content."}}}},"required":["doubleVerifyBrandSafety"]},{"type":"object","properties":{"doubleVerifyViewability":{"type":"object","properties":{"averageCompletionAndFullyViewableRateTargeting":{"type":"string","description":"The type of average completion and fully viewable rate targeting.","enum":["ALLOW_ALL","AVG_COMPLETION_FULLY_VIEWABLE_GTE_10","AVG_COMPLETION_FULLY_VIEWABLE_GTE_20","AVG_COMPLETION_FULLY_VIEWABLE_GTE_25","AVG_COMPLETION_FULLY_VIEWABLE_GTE_30","AVG_COMPLETION_FULLY_VIEWABLE_GTE_35","AVG_COMPLETION_FULLY_VIEWABLE_GTE_40"]},"brandExposureViewabilityTargeting":{"type":"string","description":"The type of brand exposure viewability targeting.","enum":["ALLOW_ALL","BRAND_EXPOSURE_VIEWABILITY_GTE_10_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION","BRAND_EXPOSURE_VIEWABILITY_GTE_5_SEC_AVG_DURATION"]},"includeUnmeasurableImpressions":{"type":"boolean","description":"Set to true to include impressions where impressions can't be measured."},"mrcViewabilityTargeting":{"type":"string","description":"The type of MRC viewability targeting.","enum":["ALLOW_ALL","MRC_VIEWABILITY_GTE_30","MRC_VIEWABILITY_GTE_40","MRC_VIEWABILITY_GTE_50","MRC_VIEWABILITY_GTE_55","MRC_VIEWABILITY_GTE_60","MRC_VIEWABILITY_GTE_65","MRC_VIEWABILITY_GTE_70","MRC_VIEWABILITY_GTE_75","MRC_VIEWABILITY_GTE_80"]}}}},"required":["doubleVerifyViewability"]},{"type":"object","properties":{"doubleVerifyAuthenticBrandSafety":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string"}}}},"required":["doubleVerifyAuthenticBrandSafety"]},{"type":"object","properties":{"doubleVerifyCustomContextualSegmentId":{"type":"object","properties":{"doubleVerifySegmentId":{"type":"string"}}}},"required":["doubleVerifyCustomContextualSegmentId"]},{"type":"object","properties":{"doubleVerifyAuthenticAttention":{"type":"object","properties":{"universalAttention":{"type":"boolean","description":"One omni-channel segment that is informed by data from all DV campaigns to help avoid serving ads on generally poor performing apps and domains."}}}},"required":["doubleVerifyAuthenticAttention"]},{"type":"object","properties":{"integralAdScienceFraudInvalidTraffic":{"type":"object","properties":{"targetSetting":{"type":"string","description":"The type of fraud invalid traffic.","enum":["ALLOW_ALL","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_MODERATE_RISK","FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK"]}}}},"required":["integralAdScienceFraudInvalidTraffic"]},{"type":"object","properties":{"integralAdScienceBrandSafety":{"type":"object","properties":{"excludeContent":{"type":"boolean","description":"Set to true to exclude content that Integral Ad Science is not able to rate."},"iasBrandSafetyAdult":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"]},"iasBrandSafetyAlcohol":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"]},"iasBrandSafetyGambling":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"]},"iasBrandSafetyHateSpeech":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"]},"iasBrandSafetyIllegalDownloads":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"]},"iasBrandSafetyIllegalDrugs":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"]},"iasBrandSafetyOffensiveLanguage":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"]},"iasBrandSafetyViolence":{"type":"string","description":"The IAS brand safety risk level.","enum":["ALLOW_ALL","BRAND_SAFETY_EXCLUDE_HIGH_AND_MODERATE_RISK","BRAND_SAFETY_EXCLUDE_HIGH_RISK"]}}}},"required":["integralAdScienceBrandSafety"]},{"type":"object","properties":{"integralAdScienceViewability":{"type":"object","description":"The IAS viewability standard.","properties":{"standard":{"type":"string","enum":["GROUPM","MRC","NONE","PUBLICIS"]},"viewabilityTargeting":{"type":"string","description":"The type of viewability tier.","enum":["ALLOW_ALL","VIEWABILITY_TIER_GT_40","VIEWABILITY_TIER_GT_50","VIEWABILITY_TIER_GT_60","VIEWABILITY_TIER_GT_70","VIEWABILITY_TIER_LT_40"]}}}},"required":["integralAdScienceViewability"]},{"type":"object","properties":{"integralAdScienceContextualTargeting":{"type":"object","properties":{"topicalSegments":{"type":"array","description":"The unique identifier of the IAS contextual topical targeting segment","items":{"type":"string"}},"verticalSegments":{"type":"array","description":"The unique identifier of the IAS contextual vertical targeting segment","items":{"type":"string"}}}}},"required":["integralAdScienceContextualTargeting"]},{"type":"object","properties":{"integralAdScienceContextualAvoidance":{"type":"object","properties":{"avoidanceSegments":{"type":"array","description":"The unique identifier of the IAS contextual avoidance segment","items":{"type":"string"}}}}},"required":["integralAdScienceContextualAvoidance"]},{"type":"object","properties":{"pixalateFraudInvalidTraffic":{"type":"object","properties":{"excludeAppsAndDomains":{"type":"boolean","description":"Set to true to exclude traffic from Apps and Domains identified to be fraudulent or invalid."},"excludeIpAddressAndUserAgents":{"type":"boolean","description":"Set to true to exclude traffic from IPV4 and IPV6 addresses and user agents identified to be fraudulent or invalid."},"excludeOttAndMobileDevices":{"type":"boolean","description":"Set to true to exclude traffic from OTT and Mobile devices identified to be fraudulent or invalid."},"excludeRemovedAppsFromAppStores":{"type":"boolean","description":"Set to true to exlude traffic from Apps that have been removed from the google play and apple app stores in the last 6 months."}}}},"required":["pixalateFraudInvalidTraffic"]},{"type":"object","properties":{"integralAdScienceQualitySync":{"type":"object","properties":{"segmentId":{"type":"string"}}}},"required":["integralAdScienceQualitySync"]},{"type":"object","properties":{"newsGuardBrandGuardTrustedNewsTargeting":{"type":"object","description":"Only applicable for Web supply.","properties":{"targetingList":{"type":"array","description":"The unique identifiers of trusted news targets","items":{"type":"string","enum":["BASIC_INCLUDE","BUSINESS_INCLUDE","COMMUNITY_INCLUDE","HEALTH_INCLUDE","HIGH_INCLUDE","LIFESTYLE_INCLUDE","LOCAL_INCLUDE","MAX_INCLUDE","POLITICS_INCLUDE","TECH_INCLUDE"]}}}}},"required":["newsGuardBrandGuardTrustedNewsTargeting"]},{"type":"object","properties":{"newsGuardBrandGuardMisinformationSafety":{"type":"object","properties":{"avoidanceList":{"type":"array","description":"The unique identifiers of misinformation targets","items":{"type":"string","enum":["AI_GENERATED_MFA","BASIC_EXCLUDE","CLIMATE_MISINFORMATION","COVID_MISINFORMATION","ELECTION_MISINFORMATION","HEALTH_MISINFORMATION","HIGH_EXCLUDE","ISRAEL_HAMAS_MISINFORMATION","MAX_EXCLUDE","MISINFORMATION_SITES","OPINIONATED_NEWS","QANON_MISINFORMATION","UKRAINE_MISINFORMATION","VACCINE_MISINFORMATION"]}}}}},"required":["newsGuardBrandGuardMisinformationSafety"]}]},"thirdPartyTargetType":{"type":"string","enum":["DOUBLE_VERIFY_AUTHENTIC_ATTENTION","DOUBLE_VERIFY_AUTHENTIC_BRAND_SAFETY","DOUBLE_VERIFY_BRAND_SAFETY","DOUBLE_VERIFY_CUSTOM_CONTEXTUAL_SEGMENT_ID","DOUBLE_VERIFY_FRAUD_INVALID_TRAFFIC","DOUBLE_VERIFY_STANDARD_DISPLAY_BRAND_SAFETY","DOUBLE_VERIFY_VIEWABILITY","INTEGRAL_AD_SCIENCE_BRAND_SAFETY","INTEGRAL_AD_SCIENCE_CONTEXTUAL_AVOIDANCE","INTEGRAL_AD_SCIENCE_CONTEXTUAL_TARGETING","INTEGRAL_AD_SCIENCE_FRAUD_INVALID_TRAFFIC","INTEGRAL_AD_SCIENCE_QUALITY_SYNC","INTEGRAL_AD_SCIENCE_VIEWABILITY","NEWS_GUARD_BRAND_GUARD_MISINFORMATION_SAFETY","NEWS_GUARD_BRAND_GUARD_TRUSTED_NEWS_TARGETING","PIXALATE_FRAUD_INVALID_TRAFFIC"]}}}},"required":["thirdPartyTarget"]},{"type":"object","properties":{"themeTarget":{"type":"object","description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"type":"string","description":"| ThemeMatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you're advertising. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |","enum":["INTERESTED_AUDIENCE","KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS","PRODUCT_COMPLEMENTS","PRODUCT_SUBSTITUTES"]}}}},"required":["themeTarget"]},{"type":"object","properties":{"contentInstreamPositionTarget":{"type":"object","description":"Targets ads in the specified content instream position","properties":{"instreamPosition":{"type":"string","description":"| ContentInstreamPosition | Description |\n| --- | --- |\n| `PRE_ROLL` |  |\n| `MID_ROLL` |  |\n| `POST_ROLL` |  |\n| `UNKNOWN` |  |","enum":["MID_ROLL","POST_ROLL","PRE_ROLL","UNKNOWN"]}}}},"required":["contentInstreamPositionTarget"]},{"type":"object","properties":{"contentOutstreamPositionTarget":{"type":"object","description":"Targets ads in the specified content outstream position","properties":{"outstreamPosition":{"type":"string","description":"| ContentOutstreamPosition | Description |\n| --- | --- |\n| `STANDALONE` |  |\n| `ACCOMPANYING_CONTENT` |  |\n| `INTERSTITIAL` |  |\n| `UNKNOWN` |  |","enum":["ACCOMPANYING_CONTENT","INTERSTITIAL","STANDALONE","UNKNOWN"]}}}},"required":["contentOutstreamPositionTarget"]},{"type":"object","properties":{"videoContentDurationTarget":{"type":"object","description":"Targets ads to a specific video content duration","properties":{"duration":{"type":"string","description":"| VideoContentDuration | Description |\n| --- | --- |\n| `SHORT` | Video content duration of 0 to 10 minutes |\n| `MEDIUM` | Video content duration of 10 to 30 minutes |\n| `LONG` | Video content duration of 30 to 60 minutes |\n| `EXTENDED` | Video content duration of 60+ minutes |\n| `UNKNOWN` | Unknown video content duration |","enum":["EXTENDED","LONG","MEDIUM","SHORT","UNKNOWN"]}}}},"required":["videoContentDurationTarget"]},{"type":"object","properties":{"foldPositionTarget":{"type":"object","description":"Targets ads in the specified fold position","properties":{"foldPosition":{"type":"string","enum":["ABOVE_THE_FOLD","BELOW_THE_FOLD","UNKNOWN"]}}}},"required":["foldPositionTarget"]},{"type":"object","properties":{"nativeContentPositionTarget":{"type":"object","description":"Targets ads to a specific native content position","properties":{"nativePosition":{"type":"string","description":"| NativeContentPosition | Description |\n| --- | --- |\n| `IN_ARTICLE` | Positioned in the atomic unit of the content (e.g., in the article page or single image page). |\n| `IN_FEED` | Positioned in the feed of content (e.g., as an item inside the organic feed, grid, listing, carousel, etc.). |\n| `PERIPHERAL` | Positioned utside the core content (e.g., in the ads section on the right rail, as a banner-style placement near the content, etc.). |\n| `RECOMMENDATION` | Positioned in recommendation widget; most commonly presented below article content. |\n| `UNKNOWN` | Unknown position. |","enum":["IN_ARTICLE","IN_FEED","PERIPHERAL","RECOMMENDATION","UNKNOWN"]}}}},"required":["nativeContentPositionTarget"]}]},"targetType":{"type":"string","enum":["AD_INITIATION","AD_PLAYER_SIZE","APP","AUDIENCE","BRAND_SAFETY_TIER","CONTENT_CATEGORY","CONTENT_GENRE","CONTENT_INSTREAM_POSITION","CONTENT_OUTSTREAM_POSITION","CONTENT_RATING","DAYPART","DEVICE","DOMAIN","FOLD_POSITION","INVENTORY_SOURCE","KEYWORD","LOCATION","NATIVE_CONTENT_POSITION","PRODUCT","PRODUCT_AUDIENCE","PRODUCT_CATEGORY","THEME","THIRD_PARTY","VIDEO_AD_FORMAT","VIDEO_CONTENT_DURATION"]}},"required":["adProduct","negative","state","targetDetails","targetType"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Target"]}],"path":"/en-us/mcp/campaign-management#tag/Target/operation/create_target","sectionHeader":{"type":3,"text":"POST /mcp/create_target"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/create_ad",{"operationId":"create_ad","description":"Create Amazon Ads. Create individual ads within ad groups across all Amazon advertising products.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"ads":{"type":"array","items":{"type":"object","properties":{"adGroupId":{"type":"string","description":"The ad group associated with the ad."},"adProduct":{"type":"string","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"]},"adType":{"type":"string","description":"| AdType | Description |\n| --- | --- |\n| `DISPLAY` | A creative that features one or more custom images. |\n| `VIDEO` | A creative that features one or more videos. |\n| `AUDIO` | A creative that features one or more audio assets. |\n| `THIRD_PARTY` | A creative that is served from a third party ad server. |\n| `COMPONENT` | A creative that can features a collection of videos, images, and products. |\n| `PRODUCT_AD` | A creative built based on a specified product. |","enum":["AUDIO","COMPONENT","DISPLAY","PRODUCT_AD","THIRD_PARTY","VIDEO"]},"creative":{"oneOf":[{"type":"object","properties":{"audioCreative":{"type":"object","properties":{"standardAudioSettings":{"type":"object","properties":{"audio":{"type":"object","properties":{"assetId":{"type":"string","description":"The asset library ID associated with the audio asset."},"assetVersion":{"type":"string","description":"The asset library version associated with the audio asset."}}},"impressionTrackingUrls":{"type":"array","description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"language":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]},"products":{"type":"array","description":"The product(s) being advertised.","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplaceSettings":{"type":"array","description":"List of advertised product selectively applied at the given marketplace level","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productId":{"type":"string","description":"The identifier of the product advertised."}}}},"productId":{"type":"string","description":"The identifier of the advertised product."},"productIdType":{"type":"string","enum":["ASIN","SKU"]}},"required":["productIdType"]}}}}}}},"required":["audioCreative"]},{"type":"object","properties":{"displayCreative":{"type":"object","properties":{"standardDisplaySettings":{"type":"object","properties":{"adChoicesPosition":{"type":"string","enum":["BOTTOM_LEFT","BOTTOM_RIGHT","TOP_LEFT","TOP_RIGHT"]},"callToAction":{"oneOf":[{"type":"object","properties":{"clickToUrlDisplayCallToActionSettings":{"type":"object","description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"type":"string","enum":["DISABLED","ENABLED"]},"url":{"type":"string","description":"The application url that customers are directed to."}}}},"required":["clickToUrlDisplayCallToActionSettings"]},{"type":"object","properties":{"clickToAppDisplayCallToActionSettings":{"type":"object","description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"type":"string","enum":["DISABLED","ENABLED"]},"url":{"type":"string","description":"The app that customers are directed to."}}}},"required":["clickToAppDisplayCallToActionSettings"]}]},"clickTrackingUrls":{"type":"array","description":"The third party urls to trigger when an click is recorded.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"creativeSizes":{"type":"array","description":"The list of placement sizes this creative should serve on.","items":{"type":"object","properties":{"height":{"type":"integer","description":"The height of the creative placement."},"width":{"type":"integer","description":"The width of the creative placement."}}}},"customImages":{"type":"array","description":"The custom images to use for the standard display experience.","items":{"type":"object","properties":{"assetId":{"type":"string","description":"The asset library ID associated with the image asset."},"assetVersion":{"type":"string","description":"The asset library version associated with the image asset."},"formatProperties":{"type":"array","description":"The cropping and positioning properties associated with the asset.","items":{"type":"object","properties":{"applyBorder":{"type":"boolean","description":"Apply a boarder to the image to fit rules for some supplies."},"height":{"type":"integer","description":"The height (in pixels) of the cropped image."},"left":{"type":"integer","description":"The number of pixels from the left of the image where the crop should begin."},"top":{"type":"integer","description":"The number of pixels from the top of the image where the crop should begin."},"width":{"type":"integer","description":"The width (in pixels) of the cropped image."}}}}}}},"impressionTrackingUrls":{"type":"array","description":"The third party urls to trigger when an impression is recorded.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"language":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]}}}}}},"required":["displayCreative"]},{"type":"object","properties":{"videoCreative":{"type":"object","properties":{"onlineVideoSettings":{"type":"object","properties":{"callToActions":{"type":"array","description":"The call to actions for this video.","items":{"oneOf":[{"type":"object","properties":{"learnMoreVideoCallToActionSettings":{"type":"object","properties":{"url":{"type":"string","description":"The url to drive users to learn more via the video CallToAction."}}}},"required":["learnMoreVideoCallToActionSettings"]},{"type":"object","properties":{"clickToUrlVideoCallToActionSettings":{"type":"object","properties":{"deepLinkingBehavior":{"type":"string","enum":["DISABLED","ENABLED"]},"url":{"type":"string","description":"The url to redirect the user via the video CallToAction."}}}},"required":["clickToUrlVideoCallToActionSettings"]}]}},"clickTrackingUrls":{"type":"array","description":"The third party urls to trigger when an click is recorded.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"impressionTrackingUrls":{"type":"array","description":"The third party urls to trigger when an impression is recorded.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"language":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]},"products":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplaceSettings":{"type":"array","description":"List of advertised product selectively applied at the given marketplace level","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productId":{"type":"string","description":"The identifier of the product advertised."}}}},"productId":{"type":"string","description":"The identifier of the advertised product."},"productIdType":{"type":"string","enum":["ASIN","SKU"]}},"required":["productIdType"]},"videos":{"type":"object","properties":{"assetId":{"type":"string","description":"The asset library ID associated with the video asset."},"assetVersion":{"type":"string","description":"The asset library version associated with the video asset."}}}}},"streamingTvSettings":{"type":"object","properties":{"callToActions":{"type":"array","description":"The call to actions for this video.","items":{"oneOf":[{"type":"object","properties":{"learnMoreVideoCallToActionSettings":{"type":"object","properties":{"url":{"type":"string","description":"The url to drive users to learn more via the video CallToAction."}}}},"required":["learnMoreVideoCallToActionSettings"]},{"type":"object","properties":{"clickToUrlVideoCallToActionSettings":{"type":"object","properties":{"deepLinkingBehavior":{"type":"string","enum":["DISABLED","ENABLED"]},"url":{"type":"string","description":"The url to redirect the user via the video CallToAction."}}}},"required":["clickToUrlVideoCallToActionSettings"]}]}},"impressionTrackingUrls":{"type":"array","description":"The third party urls to trigger when an impression is recorded.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"landingPage":{"type":"object","properties":{"landingPageType":{"type":"string","enum":["DETAIL_PAGE","MOMENT","OFF_AMAZON_LINK","STORE"]},"landingPageUrl":{"type":"string","description":"The URL of landing page where the ad directs."}}},"language":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]},"products":{"type":"array","description":"The product advertised on this video creative.","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplaceSettings":{"type":"array","description":"List of advertised product selectively applied at the given marketplace level","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productId":{"type":"string","description":"The identifier of the product advertised."}}}},"productId":{"type":"string","description":"The identifier of the advertised product."},"productIdType":{"type":"string","enum":["ASIN","SKU"]}},"required":["productIdType"]}},"videos":{"type":"object","properties":{"assetId":{"type":"string","description":"The asset library ID associated with the video asset."},"assetVersion":{"type":"string","description":"The asset library version associated with the video asset."}}}}}}}},"required":["videoCreative"]},{"type":"object","properties":{"productCreative":{"type":"object","properties":{"productCreativeSettings":{"type":"object","description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplaceSettings":{"type":"array","description":"List of advertised product selectively applied at the given marketplace level","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productId":{"type":"string","description":"The identifier of the product advertised."}}}},"productId":{"type":"string","description":"The identifier of the advertised product."},"productIdType":{"type":"string","enum":["ASIN","SKU"]}},"required":["productIdType"]},"headline":{"type":"string","description":"The headline/custom text associated with the ad creative."}}}}}},"required":["productCreative"]},{"type":"object","properties":{"componentCreative":{"type":"object","properties":{"responsiveEcommerceSettings":{"type":"object","properties":{"language":{"description":"ISO-639 + ISO-3166 locale code, e.g. en_US","type":"string"},"inventoryTypes":{"description":"Inventory types this creative serves on","type":"array","items":{"enum":["DISPLAY","NATIVE"],"type":"string"}},"products":{"description":"The products advertised for the Responsive eCommerce experience.","type":"array","items":{"type":"object","properties":{"productId":{"description":"The identifier of the advertised product.","type":"string"},"productIdType":{"enum":["ASIN"],"type":"string"}},"required":["productIdType"]}},"creativePropertiesToOptimize":{"description":"The CreativeProperty Amazon will enhance or generate based on various factors like audience, placement etc.","type":"array","items":{"enum":["HEADLINE"],"type":"string"}},"optimizationGoalKpi":{"enum":["PURCHASE_RATE","CLICK_THROUGH_RATE","DETAIL_PAGE_VIEW_RATE"],"type":"string"},"responsiveSizingBehavior":{"enum":["DISABLED","ENABLED"],"type":"string"},"supportedThirdPartySellers":{"enum":["NONE","ALL"],"type":"string"},"headlines":{"description":"The headline to use for the Responsive eCommerce experience.","type":"string"},"disclaimers":{"description":"The disclaimer to use for the Responsive eCommerce experience.","type":"string"},"images":{"description":"The image(s) to use.","type":"array","items":{"type":"object","properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"}},"required":["assetId","assetVersion"]}},"logos":{"type":"object","properties":{"assetId":{"description":"The asset library ID associated with the image asset.","type":"string"},"assetVersion":{"description":"The asset library version associated with the image asset.","type":"string"}},"required":["assetId","assetVersion"]},"landingPage":{"type":"object","properties":{"landingPageType":{"type":"string"},"landingPageUrl":{"description":"The URL of landing page where the ad directs.","type":"string"}},"required":["landingPageType","landingPageUrl"]},"creativeSizes":{"description":"The placement sizes this creative should serve on.","type":"array","items":{"type":"object","properties":{"height":{"description":"The height of the creative placement.","type":"integer"},"width":{"description":"The width of the creative placement.","type":"integer"}},"required":["height","width"]}},"recAdVariations":{"description":"The rendering variations selected for the Responsive eCommerce experience.","type":"array","items":{"enum":["ADD_TO_CART","COUPON","CUSTOMER_REVIEWS","SHOP_NOW"],"type":"string"}},"clickTrackingUrls":{"description":"The third party urls to trigger when a click is recorded.","type":"array","items":{"type":"object","properties":{"url":{"description":"A url to be triggered for tracking events.","type":"string"}},"required":["url"]}},"impressionTrackingUrls":{"description":"The third party urls to trigger when an impression is recorded.","type":"array","items":{"type":"object","properties":{"url":{"description":"A url to be triggered for tracking events.","type":"string"}},"required":["url"]}}}}}}},"required":["componentCreative"]}]},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad's global value is applied to that marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"state":{"type":"string","enum":["ARCHIVED","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the ad","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}}}}}}},"marketplaceScope":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]},"marketplaces":{"type":"array","description":"A list of country codes representing Amazon marketplaces","items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"name":{"type":"string","description":"The name of the ad."},"state":{"type":"string","enum":["ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the ad","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}}},"required":["adProduct","adType","creative","state"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Ad"]}],"path":"/en-us/mcp/campaign-management#tag/Ad/operation/create_ad","sectionHeader":{"type":3,"text":"POST /mcp/create_ad"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/update_target",{"operationId":"update_target","description":"Update Amazon Ads Targets. Modify targeting criteria including bids, state, and targeting parameters.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"targets":{"type":"array","items":{"type":"object","properties":{"bid":{"type":"object","properties":{"bid":{"type":"number","description":"The maximum bid for a target."},"marketplaceSettings":{"type":"array","description":"The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"type":"object","properties":{"bid":{"type":"number","description":"The maximum bid for a target."},"currencyCode":{"type":"string","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EGP","EUR","GBP","INR","JPY","MXN","MXP","NGN","NOK","NZD","PLN","SAR","SEK","SGD","TRY","USD","ZAR"]},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}}}}},"campaignId":{"type":"string","description":"A unique identifier for the campaign associated with the target. Only used for campaign-level targets."},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global target that enables overriding certain attributes at individual marketplace level. For example, if a global target is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the target's global value is applied to that marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"state":{"type":"string","enum":["ARCHIVED","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the target","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}},"targetDetails":{"oneOf":[{"type":"object","properties":{"keywordTarget":{"type":"object","description":"Targets a specific customer search term.","properties":{"keyword":{"type":"string","description":"The customer search term or text to target"},"matchType":{"type":"string","description":"| KeywordMatchType | Description |\n| --- | --- |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms.This expands matching on user intent beyond EXACT. |\n| `BROAD` | Braod match search terms.This expands matching on user intent beyond PHRASE.  |\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |","enum":["BROAD","EXACT","MULTISIGNAL_BROAD","PHRASE"]},"nativeLanguageKeyword":{"type":"string","description":"The unlocalized keyword text in the preferred locale of the advertiser."},"nativeLanguageLocale":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]}}}},"required":["keywordTarget"]},{"type":"object","properties":{"themeTarget":{"type":"object","description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"type":"string","description":"| ThemeMatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you're advertising. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |","enum":["INTERESTED_AUDIENCE","KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS","PRODUCT_COMPLEMENTS","PRODUCT_SUBSTITUTES"]}}}},"required":["themeTarget"]}]}}}}}},"marketplaceScope":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]},"marketplaces":{"type":"array","description":"A list of country codes representing Amazon marketplaces","items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"state":{"type":"string","description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n| UpdateState | Description |\n| --- | --- |\n| `ENABLED` |  |\n| `PAUSED` |  |","enum":["ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the target","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}},"targetId":{"type":"string","description":"A unique identifier for the target."}},"required":["targetId"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Target"]}],"path":"/en-us/mcp/campaign-management#tag/Target/operation/update_target","sectionHeader":{"type":3,"text":"POST /mcp/update_target"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/check_product_eligibility",{"operationId":"check_product_eligibility","description":"Checks whether products are eligible for a specific ad product type. Returns eligibility status per product with detail reasons and help URLs for resolving issues.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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. Using this for Eligibility will only get you responses for the individual country associated with the profileId."}},"required":["profileId"]}]},"adProduct":{"type":"string","description":"The advertising product type to check eligibility for. Only SPONSORED_PRODUCTS is supported for global advertiser.","enum":["SPONSORED_PRODUCTS","SPONSORED_BRANDS","SPONSORED_DISPLAY","AMAZON_DSP"]},"language":{"type":"string","description":"The language for eligibility messages. Defaults to en_US if not provided.","enum":["ar_AE","de_DE","en_AU","en_CA","en_GB","en_IN","en_US","es_ES","es_MX","fr_CA","fr_FR","it_IT","ja_JP","ko_KR","nl_NL","pt_BR","tr_TR","zh_CN"]},"products":{"type":"array","description":"List of products to check eligibility for.","minItems":1,"maxItems":30,"items":{"type":"object","properties":{"productId":{"type":"string","description":"The identifier of the product (e.g., ASIN or SKU value)."},"productIdType":{"type":"string","description":"The type of product identifier. Only ASIN is supported for global advertiser.","enum":["ASIN","SKU"]},"marketplace":{"type":"string","description":"The marketplace country code for this product.","enum":["AE","AU","BE","BR","CA","CL","CO","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NG","NL","PL","SA","SE","SG","TR","US","ZA"]},"globalStoreSetting":{"type":"object","description":"Optional global store setting to scope eligibility evaluation.","properties":{"catalogSourceCountryCode":{"type":"string","description":"Country code of source marketplace where seller has listed the product. Possible source country codes include US, UK, DE, JP, and AE.","minLength":2,"maxLength":2}}}},"required":["productId","productIdType","marketplace"]}}},"required":["accessRequestedAccount","adProduct","products"]}}}}}},"tags":["Eligibility"]}],"path":"/en-us/mcp/campaign-management#tag/Eligibility/operation/check_product_eligibility","sectionHeader":{"type":3,"text":"POST /mcp/check_product_eligibility"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/update_campaign_state",{"operationId":"update_campaign_state","description":"Update Campaign State.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"campaigns":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","enum":["ARCHIVED","ENABLED","PAUSED"]},"campaignId":{"type":"string","description":"A unique identifier for a campaign."}},"required":["campaignId","state"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Campaign"]}],"path":"/en-us/mcp/campaign-management#tag/Campaign/operation/update_campaign_state","sectionHeader":{"type":3,"text":"POST /mcp/update_campaign_state"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/query_portfolio",{"operationId":"query_portfolio","description":"Query an Amazon Ads Portfolios.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"marketplaceScopeFilter":{"type":"object","properties":{"include":{"type":"array","description":"| MarketplaceScope | Description |\n| --- | --- |\n| `GLOBAL` |  |\n| `SINGLE_MARKETPLACE` |  |","maxItems":1,"minItems":1,"items":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]}}},"required":["include"]},"nameFilter":{"type":"object","properties":{"queryTermMatchType":{"type":"string","enum":["EXACT_MATCH","BROAD_MATCH"]},"include":{"type":"array","maxItems":100,"minItems":1,"items":{"type":"string"}}},"required":["include","queryTermMatchType"]},"portfolioIdFilter":{"type":"object","properties":{"include":{"type":"array","maxItems":1000,"minItems":1,"items":{"type":"string"}}},"required":["include"]},"stateFilter":{"type":"object","properties":{"include":{"type":"array","description":"| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","maxItems":1,"minItems":1,"items":{"type":"string","enum":["ENABLED","PAUSED","ARCHIVED"]}}},"required":["include"]},"nextToken":{"type":"string"},"maxResults":{"type":"integer","default":5000,"maximum":5000,"minimum":0},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]}}}}}},"tags":["Portfolio"]}],"path":"/en-us/mcp/campaign-management#tag/Portfolio/operation/query_portfolio","sectionHeader":{"type":3,"text":"POST /mcp/query_portfolio"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/update_ad",{"operationId":"update_ad","description":"Update Amazon Ads. Modify individual ad settings including name and state.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"ads":{"type":"array","items":{"type":"object","properties":{"adId":{"type":"string","description":"The identifier of the ad."},"creative":{"oneOf":[{"type":"object","properties":{"audioCreative":{"type":"object","properties":{"standardAudioSettings":{"type":"object","properties":{"audio":{"type":"object","properties":{"assetId":{"type":"string","description":"The asset library ID associated with the audio asset."},"assetVersion":{"type":"string","description":"The asset library version associated with the audio asset."}}},"impressionTrackingUrls":{"type":"array","description":"The third party urls to trigger when an impression is recorded. Urls cannot exceed 2048 characters.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"language":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]},"products":{"type":"array","description":"The product(s) being advertised.","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplaceSettings":{"type":"array","description":"List of advertised product selectively applied at the given marketplace level","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productId":{"type":"string","description":"The identifier of the product advertised."}}}},"productId":{"type":"string","description":"The identifier of the advertised product."},"productIdType":{"type":"string","enum":["ASIN","SKU"]}},"required":["productIdType"]}}}}}}},"required":["audioCreative"]},{"type":"object","properties":{"displayCreative":{"type":"object","properties":{"standardDisplaySettings":{"type":"object","properties":{"adChoicesPosition":{"type":"string","enum":["BOTTOM_LEFT","BOTTOM_RIGHT","TOP_LEFT","TOP_RIGHT"]},"callToAction":{"oneOf":[{"type":"object","properties":{"clickToUrlDisplayCallToActionSettings":{"type":"object","description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"type":"string","enum":["DISABLED","ENABLED"]},"url":{"type":"string","description":"The application url that customers are directed to."}}}},"required":["clickToUrlDisplayCallToActionSettings"]},{"type":"object","properties":{"clickToAppDisplayCallToActionSettings":{"type":"object","description":"A CTA that directs a customer to a provided url.","properties":{"deepLinkingBehavior":{"type":"string","enum":["DISABLED","ENABLED"]},"url":{"type":"string","description":"The app that customers are directed to."}}}},"required":["clickToAppDisplayCallToActionSettings"]}]},"clickTrackingUrls":{"type":"array","description":"The third party urls to trigger when an click is recorded.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"creativeSizes":{"type":"array","description":"The list of placement sizes this creative should serve on.","items":{"type":"object","properties":{"height":{"type":"integer","description":"The height of the creative placement."},"width":{"type":"integer","description":"The width of the creative placement."}}}},"customImages":{"type":"array","description":"The custom images to use for the standard display experience.","items":{"type":"object","properties":{"assetId":{"type":"string","description":"The asset library ID associated with the image asset."},"assetVersion":{"type":"string","description":"The asset library version associated with the image asset."},"formatProperties":{"type":"array","description":"The cropping and positioning properties associated with the asset.","items":{"type":"object","properties":{"applyBorder":{"type":"boolean","description":"Apply a boarder to the image to fit rules for some supplies."},"height":{"type":"integer","description":"The height (in pixels) of the cropped image."},"left":{"type":"integer","description":"The number of pixels from the left of the image where the crop should begin."},"top":{"type":"integer","description":"The number of pixels from the top of the image where the crop should begin."},"width":{"type":"integer","description":"The width (in pixels) of the cropped image."}}}}}}},"impressionTrackingUrls":{"type":"array","description":"The third party urls to trigger when an impression is recorded.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"language":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]}}}}}},"required":["displayCreative"]},{"type":"object","properties":{"videoCreative":{"type":"object","properties":{"onlineVideoSettings":{"type":"object","properties":{"callToActions":{"type":"array","description":"The call to actions for this video.","items":{"oneOf":[{"type":"object","properties":{"learnMoreVideoCallToActionSettings":{"type":"object","properties":{"url":{"type":"string","description":"The url to drive users to learn more via the video CallToAction."}}}},"required":["learnMoreVideoCallToActionSettings"]},{"type":"object","properties":{"clickToUrlVideoCallToActionSettings":{"type":"object","properties":{"deepLinkingBehavior":{"type":"string","enum":["DISABLED","ENABLED"]},"url":{"type":"string","description":"The url to redirect the user via the video CallToAction."}}}},"required":["clickToUrlVideoCallToActionSettings"]}]}},"clickTrackingUrls":{"type":"array","description":"The third party urls to trigger when an click is recorded.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"impressionTrackingUrls":{"type":"array","description":"The third party urls to trigger when an impression is recorded.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"language":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]},"products":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplaceSettings":{"type":"array","description":"List of advertised product selectively applied at the given marketplace level","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productId":{"type":"string","description":"The identifier of the product advertised."}}}},"productId":{"type":"string","description":"The identifier of the advertised product."},"productIdType":{"type":"string","enum":["ASIN","SKU"]}}},"videos":{"type":"object","properties":{"assetId":{"type":"string","description":"The asset library ID associated with the video asset."},"assetVersion":{"type":"string","description":"The asset library version associated with the video asset."}}}}},"streamingTvSettings":{"type":"object","properties":{"callToActions":{"type":"array","description":"The call to actions for this video.","items":{"oneOf":[{"type":"object","properties":{"learnMoreVideoCallToActionSettings":{"type":"object","properties":{"url":{"type":"string","description":"The url to drive users to learn more via the video CallToAction."}}}},"required":["learnMoreVideoCallToActionSettings"]},{"type":"object","properties":{"clickToUrlVideoCallToActionSettings":{"type":"object","properties":{"deepLinkingBehavior":{"type":"string","enum":["DISABLED","ENABLED"]},"url":{"type":"string","description":"The url to redirect the user via the video CallToAction."}}}},"required":["clickToUrlVideoCallToActionSettings"]}]}},"impressionTrackingUrls":{"type":"array","description":"The third party urls to trigger when an impression is recorded.","items":{"type":"object","properties":{"url":{"type":"string","description":"A url to be triggered for tracking events."}}}},"language":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]},"products":{"type":"array","description":"The product advertised on this video creative.","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplaceSettings":{"type":"array","description":"List of advertised product selectively applied at the given marketplace level","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productId":{"type":"string","description":"The identifier of the product advertised."}}}},"productId":{"type":"string","description":"The identifier of the advertised product."},"productIdType":{"type":"string","enum":["ASIN","SKU"]}},"required":["productIdType"]}},"videos":{"type":"object","properties":{"assetId":{"type":"string","description":"The asset library ID associated with the video asset."},"assetVersion":{"type":"string","description":"The asset library version associated with the video asset."}}}}}}}},"required":["videoCreative"]},{"type":"object","properties":{"productCreative":{"type":"object","properties":{"productCreativeSettings":{"type":"object","description":"An ad with a creative built based on the product being advertised.","properties":{"advertisedProduct":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplaceSettings":{"type":"array","description":"List of advertised product selectively applied at the given marketplace level","items":{"type":"object","properties":{"globalStoreSetting":{"type":"object","properties":{"catalogSourceMarketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productId":{"type":"string","description":"The identifier of the product advertised."}}}},"productId":{"type":"string","description":"The identifier of the advertised product."},"productIdType":{"type":"string","enum":["ASIN","SKU"]}}}}}}}},"required":["productCreative"]}]},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global ad that enables overriding certain attributes at individual marketplace level. For example, if a global ad is ENABLED but needs to be PAUSED in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, the ad's global value is applied to that marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"state":{"type":"string","enum":["ARCHIVED","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the ad","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}}}}}}},"marketplaceScope":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]},"marketplaces":{"type":"array","description":"A list of country codes representing Amazon marketplaces","items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"name":{"type":"string","description":"The name of the ad."},"state":{"type":"string","description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery","enum":["ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the ad","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}}},"required":["adId"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Ad"]}],"path":"/en-us/mcp/campaign-management#tag/Ad/operation/update_ad","sectionHeader":{"type":3,"text":"POST /mcp/update_ad"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/create_singleshot_portfolio",{"operationId":"create_singleshot_portfolio","description":"Creates an Amazon Ads Portfolio and associates it with a campaign in a single operation.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"portfolios":{"type":"array","description":"List of portfolio requests. Each creates a new portfolio or associates an existing portfolio with a campaign.","maxItems":5,"minItems":1,"items":{"type":"object","properties":{"campaignId":{"type":"string","description":"The campaign ID to associate the portfolio with."},"portfolioId":{"type":"string","description":"The portfolio ID to use. When provided, portfolio creation is skipped and the existing portfolio is associated with the campaign directly."},"name":{"type":"string","description":"The name of the portfolio."},"marketplaceScope":{"type":"string","description":"| MarketplaceScope | Description |\n| --- | --- |\n| `GLOBAL` |  |\n| `SINGLE_MARKETPLACE` |  |","enum":["GLOBAL","SINGLE_MARKETPLACE"]},"marketplaces":{"type":"array","description":"The list of country codes representing amazon marketplaces in which the portfolio is applicable.","maxItems":30,"items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"budget":{"type":"object","properties":{"recurrenceTimePeriod":{"type":"string","description":"| Recurrence | Description |\n| --- | --- |\n| `DAILY` |  |\n| `MONTHLY` |  |\n| `LIFETIME` |  |","enum":["DAILY","MONTHLY","LIFETIME"]},"budgetType":{"type":"string","description":"| BudgetType | Description |\n| --- | --- |\n| `MONETARY` |  |","enum":["MONETARY"]},"budgetValue":{"oneOf":[{"type":"object","properties":{"monetaryBudgetValue":{"type":"object","properties":{"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]},"marketplaceSettings":{"type":"array","description":"List of Monetary Budget values selectively applied at the given marketplace level.","maxItems":30,"items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}},"required":["marketplace","monetaryBudget"]}}}}},"required":["monetaryBudgetValue"]}]}},"required":["budgetType","budgetValue","recurrenceTimePeriod"]},"startDateTime":{"type":"string","description":"The start date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME."},"endDateTime":{"type":"string","description":"The end date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME."},"state":{"type":"string","description":"| CreateState | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["ENABLED","PAUSED"]},"budgetControls":{"type":"object","properties":{"campaignBudgetSharing":{"type":"object","properties":{"shareUnspentCampaignBudget":{"type":"string","description":"| ShareUnspentCampaignBudgetStatus | Description |\n| --- | --- |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n| `DISABLED` | Unspent campaign budget is not shared. |","enum":["ENABLED","DISABLED"]}},"required":["shareUnspentCampaignBudget"]}},"required":["campaignBudgetSharing"]},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global portfolio that enables overriding certain attributes at individual marketplace level. When a marketplace-specific override is not provided, the portfolio's global value is applied to that marketplace.","maxItems":30,"items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"state":{"type":"string","description":"| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDateTime":{"type":"string","description":"The start date time for the Portfolio."},"endDateTime":{"type":"string","description":"The end date time for the Portfolio."}}}},"required":["marketplace","overrides"]}}},"required":["campaignId"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]}}}}}},"tags":["Portfolio"]}],"path":"/en-us/mcp/campaign-management#tag/Portfolio/operation/create_singleshot_portfolio","sectionHeader":{"type":3,"text":"POST /mcp/create_singleshot_portfolio"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/update_portfolio",{"operationId":"update_portfolio","description":"Update an Amazon Ads Portfolios.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"portfolios":{"type":"array","maxItems":1000,"minItems":1,"items":{"type":"object","properties":{"portfolioId":{"type":"string","description":"A unique identifier for a portfolio"},"name":{"type":"string","description":"The name of the portfolio"},"marketplaces":{"type":"array","description":"The list of country codes representing amazon marketplaces in which the portfolio is applicable","maxItems":30,"items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"budget":{"type":"object","properties":{"recurrenceTimePeriod":{"type":"string","enum":["DAILY","MONTHLY","LIFETIME"]},"budgetType":{"type":"string","enum":["MONETARY"]},"budgetValue":{"oneOf":[{"type":"object","properties":{"monetaryBudgetValue":{"type":"object","properties":{"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}}},"marketplaceSettings":{"type":"array","description":"List of Monetary Budget values selectively applied at the given marketplace level","maxItems":30,"items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}},"required":["marketplace","monetaryBudget"]}}}}},"required":["monetaryBudgetValue"]}]}}},"startDateTime":{"type":"string","description":"The start date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME"},"endDateTime":{"type":"string","description":"The end date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME"},"state":{"type":"string","description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery","enum":["ENABLED","PAUSED"]},"budgetControls":{"type":"object","properties":{"campaignBudgetSharing":{"type":"object","properties":{"shareUnspentCampaignBudget":{"type":"string","description":"| ShareUnspentCampaignBudgetStatus | Description |\n| --- | --- |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n| `DISABLED` | Unspent campaign budget is not shared. |","enum":["ENABLED","DISABLED"]}}}}},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global portfolio that enables overriding certain attributes at individual marketplace level. When a marketplace-specific override is not provided, the portfolio's global value is applied to that marketplace.","maxItems":30,"items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"state":{"type":"string","description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDateTime":{"type":"string","description":"The start date time for the Portfolio"},"endDateTime":{"type":"string","description":"The end date time for the Portfolio"},"budgetControls":{"type":"object","properties":{"campaignBudgetSharing":{"type":"object","properties":{"shareUnspentCampaignBudget":{"type":"string","description":"| ShareUnspentCampaignBudgetStatus | Description |\n| --- | --- |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n| `DISABLED` | Unspent campaign budget is not shared. |","enum":["ENABLED","DISABLED"]}},"required":["shareUnspentCampaignBudget"]}},"required":["campaignBudgetSharing"]}}}},"required":["marketplace","overrides"]}}},"required":["portfolioId"]}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]}}}}}},"tags":["Portfolio"]}],"path":"/en-us/mcp/campaign-management#tag/Portfolio/operation/update_portfolio","sectionHeader":{"type":3,"text":"POST /mcp/update_portfolio"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/create_singleshot_sp_campaign",{"operationId":"create_singleshot_sp_campaign","description":"Creates a complete Sponsored Products campaign (campaign + ad group + ads) across multiple marketplaces in a single operation. Supports both AUTO targeting (default) and MANUAL targeting with explicit targets. Use autoCreateTargets=false with a target field to create a MANUAL campaign. Creates ONE global campaign with country-specific budgets and ASINs, not separate campaigns per country.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"oneshotCampaigns":{"type":"array","description":"List of oneshot campaign requests. Each creates campaign + ad group + ads.","minItems":1,"maxItems":1,"items":{"type":"object","properties":{"marketplaces":{"type":"array","description":"List of marketplaces where the campaign will run.","items":{"type":"string","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"campaignName":{"type":"string","description":"Name for the campaign. Default: SP|Auto|Campaign [timestamp]"},"startDateTime":{"type":"string","description":"Campaign start date and time in ISO 8601 format. Default: current timestamp"},"budgets":{"type":"object","description":"Budget configuration for the campaign.","properties":{"budgetValue":{"type":"object","properties":{"marketplaceSettings":{"type":"array","description":"Budget settings per marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"Marketplace code.","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"Daily budget amount."}},"required":["value"]}},"required":["marketplace","monetaryBudget"]}}}}},"required":["budgetValue"]},"portfolioId":{"type":"string","description":"Portfolio ID to organize the campaign."},"adGroupName":{"type":"string","description":"Name for the ad group. Default: SP|Auto|AdGroup [timestamp]"},"bid":{"type":"object","description":"Bid configuration for the ad group.","properties":{"marketplaceSettings":{"type":"array","description":"Bid settings per marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"Marketplace code.","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"defaultBid":{"type":"number","description":"The default maximum bid for ads and targets in the ad group."}},"required":["marketplace","defaultBid"]}}}},"creative":{"type":"object","description":"Creative configuration for product ads.","properties":{"productCreativeSettings":{"type":"object","properties":{"advertisedProduct":{"type":"object","properties":{"productIdType":{"type":"string","description":"Type of product identifier.","enum":["ASIN"],"default":"ASIN"},"marketplaceSettings":{"type":"array","description":"Product settings per marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"Marketplace code.","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"productId":{"type":"string","description":"Product identifier (ASIN) to advertise."}},"required":["marketplace","productId"]}}},"required":["productIdType"]}},"required":["advertisedProduct"]}},"required":["productCreativeSettings"]},"autoCreateTargets":{"type":"boolean","description":"When true, creates an auto campaign where Amazon automatically targets. When false, creates a manual campaign requiring explicit targets. Defaults to true."},"target":{"type":"object","description":"Target to create. Required when autoCreateTargets is false.","properties":{"targetType":{"type":"string","description":"The type of target.","enum":["KEYWORD","PRODUCT","PRODUCT_CATEGORY","THEME","LOCATION"]},"negative":{"type":"boolean","description":"Indicates whether the target is negative or not."},"targetDetails":{"type":"object","description":"The details associated with the target, based on the target type.","properties":{"keywordTarget":{"type":"object","description":"Targets a specific customer search term.","properties":{"keyword":{"type":"string","description":"The customer search term or text to target."},"matchType":{"type":"string","description":"The match type associated to the target.","enum":["BROAD","PHRASE","EXACT"]}},"required":["keyword","matchType"]},"productTarget":{"type":"object","description":"Targets a specific product.","properties":{"productIdType":{"type":"string","description":"The type of product and associated identifier.","enum":["ASIN","SKU"]},"matchType":{"type":"string","description":"The match type associated to the target.","enum":["PRODUCT_EXACT","PRODUCT_SIMILAR"]},"product":{"type":"object","description":"The product identifier associated to the product target.","properties":{"marketplaceSettings":{"type":"array","description":"The product ids at specific marketplace level.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A country code representing an Amazon marketplace."},"productId":{"type":"string","description":"The product id applicable at the specified marketplace. Product id depends on the used productIdType. For sellers in Sponsored Products, SKU is used instead of ASIN."}},"required":["marketplace","productId"]}}},"required":["marketplaceSettings"]}},"required":["productIdType","matchType","product"]},"productCategoryTarget":{"type":"object","properties":{"productCategoryRefinement":{"type":"object","description":"The product category to target.","properties":{"marketplaceSettings":{"type":"array","description":"Marketplace specific product category refinements.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A country code representing an Amazon marketplace."},"productCategoryRefinement":{"type":"object","description":"Refinements within the product category.","properties":{"productAgeRangeId":{"type":"string","description":"The age range ID to target. This information is supplied from Discovery APIs."},"productBrandId":{"type":"string","description":"The brand ID to target. This information is supplied from Discovery APIs."},"productCategoryId":{"type":"string","description":"The product category ID to target. This information is supplied from Discovery APIs."},"productPriceGreaterThan":{"type":"number","description":"Refinement to target products with a price greater than the value within the product category."},"productPriceLessThan":{"type":"number","description":"Refinement to target products with a price less than the value within the product category."},"productPrimeShippingEligible":{"type":"boolean","description":"Target based on if a product is Prime-shipping eligible."},"productRatingGreaterThan":{"type":"number","description":"Refinement to target products with a rating greater than the value within the product category."},"productRatingLessThan":{"type":"number","description":"Refinement to target products with a rating less than the value within the product category."}}}},"required":["marketplace","productCategoryRefinement"]}}},"required":["marketplaceSettings"]}},"required":["productCategoryRefinement"]},"themeTarget":{"type":"object","description":"Theme targets let advertisers select high-performing targets based on a common theme.","properties":{"matchType":{"type":"string","description":"The match type associated to the target.","enum":["KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY"]}},"required":["matchType"]},"locationTarget":{"type":"object","description":"Target based on geographic location. Non-global (single-marketplace) campaigns only.","properties":{"locationId":{"type":"string","description":"The ID of the geographic location to target. This information is supplied from Discovery APIs."}},"required":["locationId"]}}}},"required":["targetType","negative","targetDetails"]}},"required":["marketplaces","budgets","bid","creative"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Campaign"]}],"path":"/en-us/mcp/campaign-management#tag/Campaign/operation/create_singleshot_sp_campaign","sectionHeader":{"type":3,"text":"POST /mcp/create_singleshot_sp_campaign"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/update_target_bid",{"operationId":"update_target_bid","description":"Update Target Bid.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"targets":{"type":"array","items":{"type":"object","properties":{"bid":{"type":"object","properties":{"bid":{"type":"number","description":"The maximum bid for a target."},"marketplaceSettings":{"type":"array","description":"The bid associated with the target at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"type":"object","properties":{"bid":{"type":"number","description":"The maximum bid for a target."},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}}}}},"targetId":{"type":"string","description":"A unique identifier for the target."}},"required":["targetId","bid"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Target"]}],"path":"/en-us/mcp/campaign-management#tag/Target/operation/update_target_bid","sectionHeader":{"type":3,"text":"POST /mcp/update_target_bid"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/create_portfolio",{"operationId":"create_portfolio","description":"Create an Amazon Ads Portfolios.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"portfolios":{"type":"array","maxItems":1000,"minItems":1,"items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the portfolio"},"marketplaceScope":{"type":"string","description":"| MarketplaceScope | Description |\n| --- | --- |\n| `GLOBAL` |  |\n| `SINGLE_MARKETPLACE` |  |","enum":["GLOBAL","SINGLE_MARKETPLACE"]},"marketplaces":{"type":"array","description":"The list of country codes representing amazon marketplaces in which the portfolio is applicable","maxItems":30,"items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"budget":{"type":"object","properties":{"recurrenceTimePeriod":{"type":"string","description":"| Recurrence | Description |\n| --- | --- |\n| `DAILY` |  |\n| `MONTHLY` |  |\n| `LIFETIME` |  |","enum":["DAILY","MONTHLY","LIFETIME"]},"budgetType":{"type":"string","description":"| BudgetType | Description |\n| --- | --- |\n| `MONETARY` |  |","enum":["MONETARY"]},"budgetValue":{"oneOf":[{"type":"object","properties":{"monetaryBudgetValue":{"type":"object","properties":{"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]},"marketplaceSettings":{"type":"array","description":"List of Monetary Budget values selectively applied at the given marketplace level","maxItems":30,"items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}},"required":["marketplace","monetaryBudget"]}}}}},"required":["monetaryBudgetValue"]}]}},"required":["budgetType","budgetValue","recurrenceTimePeriod"]},"startDateTime":{"type":"string","description":"The start date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME"},"endDateTime":{"type":"string","description":"The end date time for the portfolio. Only applicable if budget recurrenceTimePeriod is LIFETIME"},"state":{"type":"string","description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n| CreateState | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |","enum":["ENABLED","PAUSED"]},"budgetControls":{"type":"object","properties":{"campaignBudgetSharing":{"type":"object","properties":{"shareUnspentCampaignBudget":{"type":"string","description":"| ShareUnspentCampaignBudgetStatus | Description |\n| --- | --- |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n| `DISABLED` | Unspent campaign budget is not shared. |","enum":["ENABLED","DISABLED"]}},"required":["shareUnspentCampaignBudget"]}},"required":["campaignBudgetSharing"]},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global portfolio that enables overriding certain attributes at individual marketplace level. When a marketplace-specific override is not provided, the portfolio's global value is applied to that marketplace.","maxItems":30,"items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"state":{"type":"string","description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery\n| State | Description |\n| --- | --- |\n| `ENABLED` | The object is set active by user and eligible for delivery. |\n| `PAUSED` | The object is stopped by user and not eligible for delivery. |\n| `ARCHIVED` | The object is permanently stopped and cannot be reactivated. Terminal end state. |","enum":["ENABLED","PAUSED","ARCHIVED"]},"startDateTime":{"type":"string","description":"The start date time for the Portfolio"},"endDateTime":{"type":"string","description":"The end date time for the Portfolio"},"budgetControls":{"type":"object","properties":{"campaignBudgetSharing":{"type":"object","properties":{"shareUnspentCampaignBudget":{"type":"string","description":"| ShareUnspentCampaignBudgetStatus | Description |\n| --- | --- |\n| `ENABLED` | Unspent campaign budget is shared across other campaigns in the portfolio. |\n| `DISABLED` | Unspent campaign budget is not shared. |","enum":["ENABLED","DISABLED"]}},"required":["shareUnspentCampaignBudget"]}},"required":["campaignBudgetSharing"]}}}},"required":["marketplace","overrides"]}}}}},"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]}},"required":["accessRequestedAccount"]}}}}}},"tags":["Portfolio"]}],"path":"/en-us/mcp/campaign-management#tag/Portfolio/operation/create_portfolio","sectionHeader":{"type":3,"text":"POST /mcp/create_portfolio"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/update_campaign_budget",{"operationId":"update_campaign_budget","description":"Update Campaign Budget.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"campaigns":{"type":"array","items":{"type":"object","properties":{"budgets":{"type":"array","description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"type":"object","properties":{"budgetType":{"type":"string","enum":["MONETARY"]},"budgetValue":{"oneOf":[{"type":"object","properties":{"monetaryBudgetValue":{"type":"object","properties":{"marketplaceSettings":{"type":"array","description":"Used only for Global Campaign. List of Monetary Budget values selectively applied at the given marketplace level","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"Used only for Global Campaign. The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"required":["monetaryBudgetValue"]}]},"recurrenceTimePeriod":{"type":"string","enum":["DAILY","LIFETIME","MONTHLY"]}},"required":["budgetType","budgetValue","recurrenceTimePeriod"]}},"campaignId":{"type":"string","description":"A unique identifier for a campaign."}},"required":["campaignId","budgets"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Campaign"]}],"path":"/en-us/mcp/campaign-management#tag/Campaign/operation/update_campaign_budget","sectionHeader":{"type":3,"text":"POST /mcp/update_campaign_budget"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/delete_ad",{"operationId":"delete_ad","description":"Delete Amazon Ads. Remove individual ads from ad groups.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"adIds":{"type":"array","items":{"type":"string"}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Ad"]}],"path":"/en-us/mcp/campaign-management#tag/Ad/operation/delete_ad","sectionHeader":{"type":3,"text":"POST /mcp/delete_ad"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/delete_target",{"operationId":"delete_target","description":"Delete Amazon Ads Targets. Remove targeting criteria from ad groups.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"targetIds":{"type":"array","items":{"type":"string"}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Target"]}],"path":"/en-us/mcp/campaign-management#tag/Target/operation/delete_target","sectionHeader":{"type":3,"text":"POST /mcp/delete_target"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/update_ad_group",{"operationId":"update_ad_group","description":"Update Amazon Ads Ad Groups. Modify ad group settings including name, state, and default bid.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"adGroups":{"type":"array","items":{"type":"object","properties":{"adGroupId":{"type":"string","description":"The unique identifier of the ad group."},"adProduct":{"type":"string","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"]},"advertisedProductCategoryIds":{"type":"array","description":"The array of identifiers of product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.","items":{"type":"string"}},"bid":{"type":"object","properties":{"baseBid":{"type":"number","description":"The lower bound bid used for the ads in the ad group."},"defaultBid":{"type":"number","description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction."},"marketplaceSettings":{"type":"array","description":"The bid associated with the ad group at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"type":"object","properties":{"currencyCode":{"type":"string","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EGP","EUR","GBP","INR","JPY","MXN","MXP","NGN","NOK","NZD","PLN","SAR","SEK","SGD","TRY","USD","ZAR"]},"defaultBid":{"type":"number","description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction."},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}}},"maxAverageBid":{"type":"number","description":"The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number)."}}},"budgets":{"type":"array","description":"An object containing budget details for the ad group.","items":{"type":"object","properties":{"budgetType":{"type":"string","enum":["MONETARY"]},"budgetValue":{"oneOf":[{"type":"object","properties":{"monetaryBudgetValue":{"type":"object","properties":{"marketplaceSettings":{"type":"array","description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"required":["monetaryBudgetValue"]}]},"recurrenceTimePeriod":{"type":"string","enum":["DAILY","LIFETIME","MONTHLY"]}},"required":["budgetType","budgetValue","recurrenceTimePeriod"]}},"creativeRotationType":{"type":"string","enum":["RANDOM","WEIGHTED"]},"endDateTime":{"type":"string","description":"The end date time for the ad group."},"fees":{"type":"array","description":"The fees associated with the ad group.","items":{"type":"object","properties":{"addToBudgetSpentAmount":{"type":"boolean","description":"Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports."},"feeType":{"type":"string","description":"| FeeType | Description |\n| --- | --- |\n| `AMAZON_DSP` | A service fee for using Amazon DSP and subtracted from the budget. This fee is applied as a percent of supply cost. |\n| `AMAZON_AUDIENCE` | CPM fee for using Amazon audiences. |\n| `THIRD_PARTY_AUDIENCE` | CPM fee for using a third party audience. |\n| `OMNICHANNEL_METRICS` | Fee for using Amazon Omnichannel Metrics. |\n| `THIRD_PARTY_APPLIED` | User added CPM fee for using third-party data to track CPM costs. This fee is applied as a percent of supply cost. |\n| `THIRD_PARTY_TARGETING` | CPM fee for using targeting provided by a third-party data provider. |\n| `MANAGED_SERVICE_FEE` | The percentage-based fee applied to the Supply Cost for Amazon programmatic managed service. |","enum":["AMAZON_AUDIENCE","AMAZON_DSP","MANAGED_SERVICE_FEE","OMNICHANNEL_METRICS","THIRD_PARTY_APPLIED","THIRD_PARTY_AUDIENCE","THIRD_PARTY_TARGETING"]},"feeValue":{"type":"number","description":"The fee amount expressed as the feeValueType. AMAZON_AUDIENCE_FEE AND THIRD_PARTY_AUDIENCE_FEE is in the currency of the marketplace. All other CPM based fees are in the currency of the advertiser. For percentages, 100 represents 100%."},"thirdPartyProvider":{"type":"string","enum":["COM_SCORE","CPM_1","CPM_2","CPM_3","DOUBLE_CLICK_CAMPAIGN_MANAGER","DOUBLE_VERIFY","INTEGRAL_AD_SCIENCE"]}}}},"frequencies":{"type":"array","description":"An object containing frequency details for the ad group.","items":{"type":"object","properties":{"eventMaxCount":{"type":"integer","description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500."},"frequencyTargetingSetting":{"type":"string","description":"| FrequencyTargetingSetting | Description |\n| --- | --- |\n| `USER` | Control frequency an ad will be selected to a person. |\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |","enum":["HOUSEHOLD","USER"]},"timeCount":{"type":"integer","description":"The value associated with the time and unit of time for this frequency cap."},"timeUnit":{"type":"string","enum":["DAYS","HOURS","MINUTES"]}}}},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group's global value is applied to that marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group for this marketplace"},"state":{"type":"string","enum":["ARCHIVED","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Marketplace specific tags for the ad group","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}}}}}}},"marketplaceScope":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]},"marketplaces":{"type":"array","description":"A list of country codes representing Amazon marketplaces","items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"name":{"type":"string","description":"The name of the ad group."},"optimization":{"type":"object","properties":{"bidStrategy":{"type":"string","description":"| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` |  |\n| `NEW_TO_BRAND` |  |\n| `SPEND_BUDGET_IN_FULL` |  |\n| `RULE_BASED` |  |\n| `PRIORITIZE_KPI_TARGET` |  |\n| `USE_CAMPAIGN_STRATEGY` |  |","enum":["MANUAL","NEW_TO_BRAND","PRIORITIZE_KPI_TARGET","RULE_BASED","SALES_DOWN_ONLY","SALES_UP_AND_DOWN","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"]},"budgetSettings":{"type":"object","properties":{"budgetAllocation":{"type":"string","enum":["AUTO","MANUAL"]},"dailyMinSpendValue":{"type":"number","description":"Denotes the daily minimum spend on the ad group in local currency."}}},"goalSettings":{"type":"object","properties":{"kpi":{"type":"string","description":"| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |","enum":["ADD_TO_CART","APPLICATIONS","CHECKOUTS","CLICKS","CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","CONTACTS","COST_PER_ACTION","COST_PER_CLICK","COST_PER_CONVERSION_OFF_AMAZON","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_SIGN_UP","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","FREQUENCY_AVERAGE","LEADS","NEW_TO_BRAND_PURCHASES","OTHER","PAGE_VIEWS","PURCHASES","REACH","RETURN_ON_AD_SPEND","ROAS","ROAS_COMBINED","ROAS_PROMOTED","SEARCH","SIGN_UP","SUBSCRIBE","TOP_OF_SEARCH_IMPRESSION_SHARE","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]}}}}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"| DeliveryProfile | Description |\n| --- | --- |\n| `EVEN` | Even pacing spends your budget consistently across the length of the campaign. |\n| `PACE_AHEAD` | Pace Ahead can deliver up to 25% more than the daily Even pace targets. |\n| `ASAP` | Makes your entire budget available to spend immediately. This is ideal for ad groups with limited inventory or when there's no requirement to spend throughout the length of the campaign.Warning: Selecting ASAP may result in your entire budget being spent immediately. |","enum":["ASAP","EVEN","PACE_AHEAD"]}}},"purchaseOrderNumber":{"type":"string","description":"The purchase order number associated with the ad group."},"startDateTime":{"type":"string","description":"The start date time for the ad group."},"state":{"type":"string","description":"The user defined state for the resource. DRAFT applies to Amazon DSP ad groups only; every other ad product accepts ENABLED and PAUSED. For ADSP, campaign and ad group resources are created in the PAUSED or DRAFT state and must be updated to ENABLED to activate for delivery","enum":["DRAFT","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the ad group","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}},"targetingSettings":{"type":"object","properties":{"amazonViewability":{"type":"object","properties":{"includeUnmeasurableImpressions":{"type":"boolean","description":"Must be false if viewabilityTier is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal."},"viewabilityTier":{"type":"string","enum":["ALL_TIERS","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","LESS_THAN_40_PERCENT"]}}},"defaultAudienceTargetingMatchType":{"type":"string","description":"Match type for audience targeting inclusion groups, if any. You can enhance your ad group’s reach to consumers with similar shopping, streaming, and browsing behaviors or interests as your selected audiences across all inventory sources, regardless of the presence of ad identifiers. Only applicable at the adGroup level, rather than at individual audience level. (Default: SIMILAR). Note, SIMILAR is not applicable to certain advertised product categories, [see here](https://advertising.amazon.com/help/GX8G7HNDS5RBX3EF) for more information.\n| DefaultAudienceTargetingMatchType | Description |\n| --- | --- |\n| `SIMILAR` | Reach more audiences who are similar to your included audiences. |\n| `EXACT` | Target the exact audiences specified in the ad group audience targeting. |","enum":["EXACT","SIMILAR"]},"enableLanguageTargeting":{"type":"boolean","description":"If set to true, creatives will only target supply where the content language matches the creative language."},"tacticsConvertersExclusionType":{"type":"string","enum":["NO_EXCLUSION","RECENT_CONVERTERS"]},"targetedPGDealId":{"type":"string","description":"DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here."},"timeZoneType":{"type":"string","enum":["ADVERTISER_REGION","VIEWER"]},"userLocationSignal":{"type":"string","enum":["CURRENT","MULTIPLE_SIGNALS"]},"videoCompletionTier":{"type":"string","enum":["ALL_TIERS","GREATER_THAN_10_PERCENT","GREATER_THAN_20_PERCENT","GREATER_THAN_30_PERCENT","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","GREATER_THAN_80_PERCENT","GREATER_THAN_90_PERCENT"]}}}},"required":["adGroupId"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Ad Group"]}],"path":"/en-us/mcp/campaign-management#tag/Ad%20Group/operation/update_ad_group","sectionHeader":{"type":3,"text":"POST /mcp/update_ad_group"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/delete_campaign",{"operationId":"delete_campaign","description":"Delete Amazon Ads Campaigns. Remove campaigns and all associated ad groups, ads, and targets.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"campaignIds":{"type":"array","items":{"type":"string"}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Campaign"]}],"path":"/en-us/mcp/campaign-management#tag/Campaign/operation/delete_campaign","sectionHeader":{"type":3,"text":"POST /mcp/delete_campaign"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/update_ad_association",{"operationId":"update_ad_association","description":"Update Amazon Ads Ad Associations. Modify associations between ads and ad groups.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]}]},"adAssociations":{"type":"array","items":{"type":"object","properties":{"adAssociationId":{"type":"string","description":"The unique identifier of the ad association."},"endDateTime":{"type":"string","description":"The end date time for the ad association."},"startDateTime":{"type":"string","description":"The start date time for the ad association."},"state":{"type":"string","description":"The user defined state for the resource. For ADSP, campaign and ad group resources can only be created in the PAUSED state and must be updated to ENABLED to activate for delivery","enum":["ENABLED","PAUSED"]},"weight":{"type":"integer","description":"The relative percentage of traffic which would be directed to the associated Ad Creative in the Ad Group."}},"required":["adAssociationId"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Ad Association"]}],"path":"/en-us/mcp/campaign-management#tag/Ad%20Association/operation/update_ad_association","sectionHeader":{"type":3,"text":"POST /mcp/update_ad_association"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/query_ad_group",{"operationId":"query_ad_group","description":"Query Amazon Ads Ad Groups with advanced filtering capabilities. Search and filter ad groups across all Amazon advertising products.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"adGroupIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"adProductFilter":{"type":"object","properties":{"include":{"type":"array","minItems":1,"maxItems":1,"items":{"type":"string","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"]},"description":"Only one ad product can be queried at a time."}},"required":["include"]},"campaignIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"marketplaceScopeFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]}}},"required":["include"]},"maxResults":{"type":"integer"},"nameFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}},"queryTermMatchType":{"type":"string","enum":["BROAD_MATCH","EXACT_MATCH"]}},"required":["include","queryTermMatchType"]},"nextToken":{"type":"string"},"stateFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["ARCHIVED","DRAFT","ENABLED","PAUSED"]},"description":"DRAFT applies to Amazon DSP ad groups only. Send [\"DRAFT\"] on its own to get draft ad groups and nothing else. A state filter that does not name DRAFT leaves draft ad groups out. Naming DRAFT together with other states returns draft ad groups as well as ad groups in those states. Draft ad groups also come back when adGroupIdFilter names specific ad groups and no stateFilter is sent. At most 3 states are accepted per call, so all four values cannot be sent together."}},"required":["include"]}},"required":["accessRequestedAccount","adProductFilter"]}},"required":["body"]}}}},"tags":["Ad Group"]}],"path":"/en-us/mcp/campaign-management#tag/Ad%20Group/operation/query_ad_group","sectionHeader":{"type":3,"text":"POST /mcp/query_ad_group"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/delete_ad_group",{"operationId":"delete_ad_group","description":"Delete Amazon Ads Ad Groups. Remove ad groups and their associated ads from campaigns.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"adGroupIds":{"type":"array","items":{"type":"string"}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Ad Group"]}],"path":"/en-us/mcp/campaign-management#tag/Ad%20Group/operation/delete_ad_group","sectionHeader":{"type":3,"text":"POST /mcp/delete_ad_group"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/create_ad_group",{"operationId":"create_ad_group","description":"Create Amazon Ads Ad Groups. Create ad groups for organizing ads within campaigns across all Amazon advertising products.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"adGroups":{"type":"array","items":{"type":"object","properties":{"adProduct":{"type":"string","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"]},"advertisedProductCategoryIds":{"type":"array","description":"The array of identifiers of product categories associated with the ad group. For VIDEO ad group type only one parent product category or multiple sub-categories from one parent product category are allowed.","items":{"type":"string"}},"bid":{"type":"object","properties":{"baseBid":{"type":"number","description":"The lower bound bid used for the ads in the ad group."},"defaultBid":{"type":"number","description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction."},"marketplaceSettings":{"type":"array","description":"The bid associated with the ad group at specified marketplace level. Either one of bid or marketplaceSettings should always be specified","items":{"type":"object","properties":{"currencyCode":{"type":"string","enum":["AED","AUD","BRL","CAD","CHF","CNY","DKK","EGP","EUR","GBP","INR","JPY","MXN","MXP","NGN","NOK","NZD","PLN","SAR","SEK","SGD","TRY","USD","ZAR"]},"defaultBid":{"type":"number","description":"The default maximum bid for ads and targets in the ad group. This is used in sponsored ads as the maximum bid during the auction."},"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}}}},"maxAverageBid":{"type":"number","description":"The max average bid that will be targeted on the ad group across all of the bids (a single bid could be lower or higher that this number)."}}},"budgets":{"type":"array","description":"An object containing budget details for the ad group.","items":{"type":"object","properties":{"budgetType":{"type":"string","enum":["MONETARY"]},"budgetValue":{"oneOf":[{"type":"object","properties":{"monetaryBudgetValue":{"type":"object","properties":{"marketplaceSettings":{"type":"array","description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"required":["monetaryBudgetValue"]}]},"recurrenceTimePeriod":{"type":"string","enum":["DAILY","LIFETIME","MONTHLY"]}},"required":["budgetType","budgetValue","recurrenceTimePeriod"]}},"campaignId":{"type":"string","description":"The unique identifier of the campaign the ad group belongs to."},"creativeRotationType":{"type":"string","enum":["RANDOM","WEIGHTED"]},"creativeType":{"type":"string","enum":["IMAGE","VIDEO"]},"endDateTime":{"type":"string","description":"The end date time for the ad group."},"fees":{"type":"array","description":"The fees associated with the ad group.","items":{"type":"object","properties":{"addToBudgetSpentAmount":{"type":"boolean","description":"Applies only to THIRD_PARTY_APPLIED_FEE. When set to true, third-party applied fees are are added on top of the total ad group budget spent amount in reports."},"feeType":{"type":"string","description":"| FeeType | Description |\n| --- | --- |\n| `AMAZON_DSP` | A service fee for using Amazon DSP and subtracted from the budget. This fee is applied as a percent of supply cost. |\n| `AMAZON_AUDIENCE` | CPM fee for using Amazon audiences. |\n| `THIRD_PARTY_AUDIENCE` | CPM fee for using a third party audience. |\n| `OMNICHANNEL_METRICS` | Fee for using Amazon Omnichannel Metrics. |\n| `THIRD_PARTY_APPLIED` | User added CPM fee for using third-party data to track CPM costs. This fee is applied as a percent of supply cost. |\n| `THIRD_PARTY_TARGETING` | CPM fee for using targeting provided by a third-party data provider. |\n| `MANAGED_SERVICE_FEE` | The percentage-based fee applied to the Supply Cost for Amazon programmatic managed service. |","enum":["AMAZON_AUDIENCE","AMAZON_DSP","MANAGED_SERVICE_FEE","OMNICHANNEL_METRICS","THIRD_PARTY_APPLIED","THIRD_PARTY_AUDIENCE","THIRD_PARTY_TARGETING"]},"feeValue":{"type":"number","description":"The fee amount expressed as the feeValueType. AMAZON_AUDIENCE_FEE AND THIRD_PARTY_AUDIENCE_FEE is in the currency of the marketplace. All other CPM based fees are in the currency of the advertiser. For percentages, 100 represents 100%."},"thirdPartyProvider":{"type":"string","enum":["COM_SCORE","CPM_1","CPM_2","CPM_3","DOUBLE_CLICK_CAMPAIGN_MANAGER","DOUBLE_VERIFY","INTEGRAL_AD_SCIENCE"]}}}},"frequencies":{"type":"array","description":"An object containing frequency details for the ad group.","items":{"type":"object","properties":{"eventMaxCount":{"type":"integer","description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500."},"frequencyTargetingSetting":{"type":"string","description":"| FrequencyTargetingSetting | Description |\n| --- | --- |\n| `USER` | Control frequency an ad will be selected to a person. |\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |","enum":["HOUSEHOLD","USER"]},"timeCount":{"type":"integer","description":"The value associated with the time and unit of time for this frequency cap."},"timeUnit":{"type":"string","enum":["DAYS","HOURS","MINUTES"]}}}},"inventoryType":{"type":"string","enum":["AAP_MOBILE_APP","AMAZON_MOBILE_DISPLAY","AUDIO","DISPLAY","ONLINE_VIDEO","PODCAST","STANDARD_DISPLAY","STREAMING_TV","VIDEO"]},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global ad group that enables overriding certain attributes at individual marketplace level. For example, if a global ad group state is ENABLED and needs to be PAUSED only in DE marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED}}]. When a marketplace-specific override is not provided, ad group's global value is applied to that marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"name":{"type":"string","description":"The name of the ad group for this marketplace"},"state":{"type":"string","enum":["ARCHIVED","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Marketplace specific tags for the ad group","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}}}}}}},"marketplaceScope":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]},"marketplaces":{"type":"array","description":"A list of country codes representing Amazon marketplaces","items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"name":{"type":"string","description":"The name of the ad group."},"optimization":{"type":"object","properties":{"bidStrategy":{"type":"string","description":"| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` |  |\n| `NEW_TO_BRAND` |  |\n| `SPEND_BUDGET_IN_FULL` |  |\n| `RULE_BASED` |  |\n| `PRIORITIZE_KPI_TARGET` |  |\n| `USE_CAMPAIGN_STRATEGY` |  |","enum":["MANUAL","NEW_TO_BRAND","PRIORITIZE_KPI_TARGET","RULE_BASED","SALES_DOWN_ONLY","SALES_UP_AND_DOWN","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"]},"budgetSettings":{"type":"object","properties":{"budgetAllocation":{"type":"string","enum":["AUTO","MANUAL"]},"dailyMinSpendValue":{"type":"number","description":"Denotes the daily minimum spend on the ad group in local currency."}}},"goalSettings":{"type":"object","properties":{"kpi":{"type":"string","description":"| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |","enum":["ADD_TO_CART","APPLICATIONS","CHECKOUTS","CLICKS","CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","CONTACTS","COST_PER_ACTION","COST_PER_CLICK","COST_PER_CONVERSION_OFF_AMAZON","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_SIGN_UP","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","FREQUENCY_AVERAGE","LEADS","NEW_TO_BRAND_PURCHASES","OTHER","PAGE_VIEWS","PURCHASES","REACH","RETURN_ON_AD_SPEND","ROAS","ROAS_COMBINED","ROAS_PROMOTED","SEARCH","SIGN_UP","SUBSCRIBE","TOP_OF_SEARCH_IMPRESSION_SHARE","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]}}}}},"pacing":{"type":"object","properties":{"deliveryProfile":{"type":"string","description":"| DeliveryProfile | Description |\n| --- | --- |\n| `EVEN` | Even pacing spends your budget consistently across the length of the campaign. |\n| `PACE_AHEAD` | Pace Ahead can deliver up to 25% more than the daily Even pace targets. |\n| `ASAP` | Makes your entire budget available to spend immediately. This is ideal for ad groups with limited inventory or when there's no requirement to spend throughout the length of the campaign.Warning: Selecting ASAP may result in your entire budget being spent immediately. |","enum":["ASAP","EVEN","PACE_AHEAD"]}}},"purchaseOrderNumber":{"type":"string","description":"The purchase order number associated with the ad group."},"startDateTime":{"type":"string","description":"The start date time for the ad group."},"state":{"type":"string","description":"The user defined state for the resource. DRAFT applies to Amazon DSP ad groups only; every other ad product accepts ENABLED and PAUSED. A DRAFT ad group is not eligible for delivery.","enum":["DRAFT","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the ad group","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}},"targetingSettings":{"type":"object","properties":{"amazonViewability":{"type":"object","properties":{"includeUnmeasurableImpressions":{"type":"boolean","description":"Must be false if viewabilityTier is set to ALL_TIERS. You can set to true to include impressions that can not be measured when a viewabilityTier other than ALL_TIERS is selected. We recommend setting to false if high viewability is your goal."},"viewabilityTier":{"type":"string","enum":["ALL_TIERS","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","LESS_THAN_40_PERCENT"]}}},"automatedTargetingTactic":{"type":"string","description":"Represents targeting strategy of auto populated adGroup to drive outcome.","enum":["AWARENESS","CUSTOMER_ACQUISITION","MAXIMIZE_PERFORMANCE","PROSPECTING","REMARKETING","RETENTION","SEARCH"]},"defaultAudienceTargetingMatchType":{"type":"string","description":"Match type for audience targeting inclusion groups, if any. You can enhance your ad group’s reach to consumers with similar shopping, streaming, and browsing behaviors or interests as your selected audiences across all inventory sources, regardless of the presence of ad identifiers. Only applicable at the adGroup level, rather than at individual audience level. (Default: SIMILAR). Note, SIMILAR is not applicable to certain advertised product categories, [see here](https://advertising.amazon.com/help/GX8G7HNDS5RBX3EF) for more information.\n| DefaultAudienceTargetingMatchType | Description |\n| --- | --- |\n| `SIMILAR` | Reach more audiences who are similar to your included audiences. |\n| `EXACT` | Target the exact audiences specified in the ad group audience targeting. |","enum":["EXACT","SIMILAR"]},"enableLanguageTargeting":{"type":"boolean","description":"If set to true, creatives will only target supply where the content language matches the creative language."},"tacticsConvertersExclusionType":{"type":"string","enum":["NO_EXCLUSION","RECENT_CONVERTERS"]},"targetedPGDealId":{"type":"string","description":"DealId to be targeted by the Ad Group being created. If you are creating an ad group targeting a programmatic guaranteed deal, the deal can be provided here."},"timeZoneType":{"type":"string","enum":["ADVERTISER_REGION","VIEWER"]},"userLocationSignal":{"type":"string","enum":["CURRENT","MULTIPLE_SIGNALS"]},"videoCompletionTier":{"type":"string","enum":["ALL_TIERS","GREATER_THAN_10_PERCENT","GREATER_THAN_20_PERCENT","GREATER_THAN_30_PERCENT","GREATER_THAN_40_PERCENT","GREATER_THAN_50_PERCENT","GREATER_THAN_60_PERCENT","GREATER_THAN_70_PERCENT","GREATER_THAN_80_PERCENT","GREATER_THAN_90_PERCENT"]}}}},"required":["adProduct","campaignId","name","state"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Ad Group"]}],"path":"/en-us/mcp/campaign-management#tag/Ad%20Group/operation/create_ad_group","sectionHeader":{"type":3,"text":"POST /mcp/create_ad_group"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/dsp_create_conversion_tracking_products",{"operationId":"dsp_create_conversion_tracking_products","description":"Adds products to a DSP campaign to enable product-related conversion metrics. Newly added products will be appended to an existing list. Products may be added in batches of 2,000 and a campaign can track a maximum of 500,000 products.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"pathParameters":{"type":"object","properties":{"campaignId":{"type":"string","description":"The identifier of the DSP campaign to add conversion tracking products to."}},"required":["campaignId"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]}]},"productTrackingList":{"type":"array","description":"List of products to add for conversion tracking. Products are appended to the existing list.","minItems":1,"maxItems":2000,"items":{"type":"object","properties":{"productId":{"type":"string","minLength":10,"maxLength":10,"description":"The Amazon Standard Identification Number (ASIN) of the product."},"domain":{"type":"string","enum":["AMAZON_AE","AMAZON_AU","AMAZON_BR","AMAZON_CA","AMAZON_DE","AMAZON_ES","AMAZON_FR","AMAZON_IN","AMAZON_IT","AMAZON_JP","AMAZON_MX","AMAZON_NL","AMAZON_SA","AMAZON_SE","AMAZON_TR","AMAZON_UK","AMAZON_US","FRESH_STORES_US","WHOLE_FOODS_MARKET_US"],"description":"The Amazon domain associated with the product."},"productAssociation":{"type":"string","enum":["FEATURED","FEATURED_WITH_VARIATION","NOT_FEATURED"],"description":"A featured ASIN is a specific product that is promoted in creatives within this campaign. Tracking non-featured ASINs or variations, in addition to featured and parent ASINs, will ensure proper conversion metrics and prevent data loss that is not recoverable once a campaign starts."}},"required":["productId","domain","productAssociation"]}}},"required":["accessRequestedAccount","productTrackingList"]}},"required":["pathParameters","body"]}}}},"tags":["Conversion"]}],"path":"/en-us/mcp/campaign-management#tag/Conversion/operation/dsp_create_conversion_tracking_products","sectionHeader":{"type":3,"text":"POST /mcp/dsp_create_conversion_tracking_products"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/query_target",{"operationId":"query_target","description":"Query Amazon Ads Targets with advanced filtering capabilities. Search for keywords, products, categories, audiences, and other targeting options.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"adGroupIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"adProductFilter":{"type":"object","properties":{"include":{"type":"array","minItems":1,"maxItems":1,"items":{"type":"string","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"]},"description":"Only one ad product can be queried at a time."}},"required":["include"]},"campaignIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"keywordFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}},"queryTermMatchType":{"type":"string","enum":["BROAD_MATCH","EXACT_MATCH"]}},"required":["include","queryTermMatchType"]},"marketplaceScopeFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]}}},"required":["include"]},"matchTypeFilter":{"type":"object","properties":{"include":{"type":"array","description":"| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you're advertising. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms.This expands matching on user intent beyond EXACT. |\n| `BROAD` | Braod match search terms.This expands matching on user intent beyond PHRASE.  |\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |","items":{"type":"string","description":"| MatchType | Description |\n| --- | --- |\n| `KEYWORDS_RELATED_TO_YOUR_BRAND` | Search terms related to your brand. |\n| `KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES` | Search terms related to your landing pages. |\n| `KEYWORDS_RELATED_TO_GIFTS` | Search terms related to gifts. |\n| `KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY` | Search terms shoppers often use to search for products in the same category as the products you're advertising. |\n| `KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY` | Search terms that shoppers often use when searching for and interacting with products from other brands in the category of your advertised products. The peer brands are selected automatically. |\n| `KEYWORDS_RELATED_TO_PRIME_DAY` | Search terms that shoppers are likely to use during Prime Day. These keywords can include terms related to the event, like \"prime day\", combined with product-specific terms. These keywords can help you expand reach to shoppers during the sales event. These keywords will only match queries through the end of Prime Day. |\n| `PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS` | Products similar to products advertised as part of the ad group. |\n| `KEYWORDS_LOOSE_MATCH` | Search terms loosely matching advertised product. |\n| `KEYWORDS_CLOSE_MATCH` | Search terms closely matching advertised product. |\n| `PRODUCT_SUBSTITUTES` | Products that can be substituted for advertised product. |\n| `PRODUCT_COMPLEMENTS` | Products that complement advertised product. |\n| `INTERESTED_AUDIENCE` | Audiences that are likely interested in the advertised product or service. |\n| `PRODUCT_EXACT` | Products exactly matching the specified product. |\n| `PRODUCT_SIMILAR` | Products similar to the specified product. |\n| `EXACT` | Exact match search terms. |\n| `PHRASE` | Phrase match search terms.This expands matching on user intent beyond EXACT. |\n| `BROAD` | Braod match search terms.This expands matching on user intent beyond PHRASE.  |\n| `MULTISIGNAL_BROAD` | This expands matching on user intent beyond BROAD by taking multiple behavioral and contextual signals. |","enum":["BROAD","EXACT","INTERESTED_AUDIENCE","KEYWORDS_CLOSE_MATCH","KEYWORDS_LOOSE_MATCH","KEYWORDS_RELATED_TO_GIFTS","KEYWORDS_RELATED_TO_PEER_BRANDS_PRODUCT_CATEGORY","KEYWORDS_RELATED_TO_PRIME_DAY","KEYWORDS_RELATED_TO_YOUR_BRAND","KEYWORDS_RELATED_TO_YOUR_LANDING_PAGES","KEYWORDS_RELATED_TO_YOUR_PRODUCT_CATEGORY","MULTISIGNAL_BROAD","PHRASE","PRODUCTS_SIMILAR_TO_ADVERTISED_PRODUCTS","PRODUCT_COMPLEMENTS","PRODUCT_EXACT","PRODUCT_SIMILAR","PRODUCT_SUBSTITUTES"]}}},"required":["include"]},"maxResults":{"type":"integer"},"nativeLanguageLocaleFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","description":"A combination of ISO-639 standard for language code and ISO-3166 for country code.","enum":["ak_GH","am_ET","an_ES","ar_AE","as_IN","av_RU","ay_BO","ba_RU","be_BY","bg_BG","bh_IN","bi_VU","bm_ML","bo_CN","bs_BA","ca_ES","ce_RU","ch_GU","de_DE","el_GR","en_US","eo_INT","es_ES","et_EE","eu_ES","fa_IR","fi_FI","fj_FJ","fo_FO","fr_FR","fy_NL","ga_IE","gd_GB","gl_ES","gn_PY","gu_IN","gv_IM","ha_NG","he_IL","hi_IN","ho_PG","hr_HR","ht_HT","hu_HU","hy_AM","hz_NA","ia_INT","id_ID","ie_INT","ig_NG","ii_CN","ik_US","io_INT","is_IS","it_IT","iu_CA","ja_JP","jv_ID","ka_GE","kg_CD","ki_KE","kj_NA","kk_KZ","kl_GL","km_KH","kn_IN","ko_KR","kr_NG","ks_IN","ku_TR","kv_RU","kw_GB","ky_KG","la_VA","lb_LU","lg_UG","li_NL","ln_CD","lo_LA","lt_LT","lu_CD","lv_LV","mg_MG","mh_MH","mi_NZ","mk_MK","ml_IN","mn_MN","mr_IN","ms_MY","mt_MT","my_MM","na_NR","nb_NO","nd_ZW","ne_NP","ng_NA","nl_NL","nn_NO","no_NO","nr_ZA","nv_US","ny_MW","oc_FR","oj_CA","om_ET","or_IN","os_RU","pa_IN","pi_IN","pl_PL","ps_AF","pt_PT","qu_PE","rm_CH","rn_BI","ro_RO","ru_RU","rw_RW","sa_IN","sc_IT","sd_PK","se_NO","sg_CF","si_LK","sk_SK","sl_SI","sm_WS","sn_ZW","so_SO","sq_AL","sr_RS","ss_SZ","st_LS","su_ID","sv_SE","sw_TZ","ta_IN","te_IN","tg_TJ","th_TH","ti_ET","tk_TM","tl_PH","tn_BW","to_TO","tr_TR","ts_ZA","tt_RU","tw_GH","ty_PF","ug_CN","uk_UA","ur_PK","uz_UZ","ve_ZA","vi_VN","vo_INT","wa_BE","wo_SN","xh_ZA","yi_IL","yo_NG","za_CN","zh_CN","zu_ZA"]}}},"required":["include"]},"negativeFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"boolean"}}},"required":["include"]},"nextToken":{"type":"string"},"productIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}},"queryTermMatchType":{"type":"string","description":"| TargetProductIdFilterType | Description |\n| --- | --- |\n| `EXACT_MATCH` | Filter by exact match. |\n| `BROAD_MATCH` | Filter by broad match. |","enum":["BROAD_MATCH","EXACT_MATCH"]}},"required":["include","queryTermMatchType"]},"stateFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["ARCHIVED","DRAFT","ENABLED","PAUSED"]},"description":"DRAFT applies to Amazon DSP targets only. Send [\"DRAFT\"] on its own to get draft targets and nothing else. A state filter that does not name DRAFT leaves draft targets out. Naming DRAFT together with other states returns draft targets as well as targets in those states. Draft targets also come back when no stateFilter is sent at all. At most 3 states are accepted per call, so all four values cannot be sent together."}},"required":["include"]},"targetIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"targetTypeFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["AD_INITIATION","AD_PLAYER_SIZE","APP","AUDIENCE","BRAND_SAFETY_TIER","CONTENT_CATEGORY","CONTENT_GENRE","CONTENT_INSTREAM_POSITION","CONTENT_OUTSTREAM_POSITION","CONTENT_RATING","DAYPART","DEVICE","DOMAIN","FOLD_POSITION","INVENTORY_SOURCE","KEYWORD","LOCATION","NATIVE_CONTENT_POSITION","PRODUCT","PRODUCT_AUDIENCE","PRODUCT_CATEGORY","THEME","THIRD_PARTY","VIDEO_AD_FORMAT","VIDEO_CONTENT_DURATION"]}}},"required":["include"]}},"required":["accessRequestedAccount","adProductFilter"]}},"required":["body"]}}}},"tags":["Target"]}],"path":"/en-us/mcp/campaign-management#tag/Target/operation/query_target","sectionHeader":{"type":3,"text":"POST /mcp/query_target"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/update_campaign",{"operationId":"update_campaign","description":"Update Amazon Ads Campaigns. Modify campaign settings including name, state, budget, and targeting options.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"campaigns":{"type":"array","items":{"type":"object","properties":{"adProduct":{"type":"string","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"]},"budgets":{"type":"array","description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"type":"object","properties":{"budgetType":{"type":"string","enum":["MONETARY"]},"budgetValue":{"oneOf":[{"type":"object","properties":{"monetaryBudgetValue":{"type":"object","properties":{"marketplaceSettings":{"type":"array","description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"required":["monetaryBudgetValue"]}]},"recurrenceTimePeriod":{"type":"string","enum":["DAILY","LIFETIME","MONTHLY"]}},"required":["budgetType","budgetValue","recurrenceTimePeriod"]}},"campaignId":{"type":"string","description":"A unique identifier for a campaign."},"costType":{"type":"string","description":"| CostType | Description |\n| --- | --- |\n| `CPC` | Cost per click. |\n| `VCPM` | Cost per thousand views. |","enum":["CPC","VCPM"]},"countries":{"type":"array","description":"This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.","items":{"type":"string","enum":["AE","AT","AU","BE","BH","BR","CA","CH","DE","DK","EG","ES","FI","FR","GB","IE","IL","IN","IT","JO","JP","KW","LU","MA","MK","MX","NL","NO","NZ","OM","PL","QA","SA","SE","SG","TR","US","ZA"]}},"endDateTime":{"type":"string","description":"The end date time for the campaign."},"fees":{"type":"array","description":"Any fees associated with the campaign.","items":{"type":"object","properties":{"feeType":{"type":"string","description":"| CampaignFeeType | Description |\n| --- | --- |\n| `AGENCY` | A service fee that is subtracted from the campaign budget as a percent of budget. |","enum":["AGENCY"]},"feeValue":{"type":"number","description":"A service fee that is subtracted from the campaign budget as a percent of budget. This setting can’t be changed after an ad group has been added to a campaign."},"feeValueType":{"type":"string","description":"| CampaignFeeValueType | Description |\n| --- | --- |\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |","enum":["PERCENTAGE_OF_BUDGET"]}}}},"flights":{"type":"array","description":"Flight details associated with the campaign.","items":{"type":"object","properties":{"budget":{"type":"object","properties":{"budgetType":{"type":"string","enum":["MONETARY"]},"budgetValue":{"oneOf":[{"type":"object","properties":{"monetaryBudgetValue":{"type":"object","properties":{"marketplaceSettings":{"type":"array","description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"required":["monetaryBudgetValue"]}]}}},"endDateTime":{"type":"string"},"flightId":{"type":"string","description":"The ID associated with the flight."},"name":{"type":"string","description":"The name of the flight."},"startDateTime":{"type":"string","description":"The start date of the flight."}}}},"frequencies":{"type":"array","description":"Any frequency caps associated with the campaign.","items":{"type":"object","properties":{"eventMaxCount":{"type":"integer","description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500."},"frequencyTargetingSetting":{"type":"string","description":"| FrequencyTargetingSetting | Description |\n| --- | --- |\n| `USER` | Control frequency an ad will be selected to a person. |\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |","enum":["HOUSEHOLD","USER"]},"timeCount":{"type":"integer","description":"The value associated with the time and unit of time for this frequency cap."},"timeUnit":{"type":"string","enum":["DAYS","HOURS","MINUTES"]}}}},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate '2024-06-01' but needs to be PAUSED in DE with startDateTime '2024-06-02' marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: '2024-06-02'}}]. When a marketplace-specific override is not provided, the campaign's global value is applied to that marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"endDateTime":{"type":"string","description":"The end date time for the campaign"},"name":{"type":"string","description":"The name of the campaign"},"optimizations":{"type":"object","properties":{"bidSettings":{"type":"object","properties":{"bidAdjustments":{"type":"object","properties":{"audienceBidAdjustments":{"type":"array","description":"Bid Adjustments based on the audiences","items":{"type":"object","properties":{"audienceId":{"type":"string","description":"The unique identifier of the Audience to apply bid adjustment."},"percentage":{"type":"integer","description":"The selection of the percentage change associated with a given audience and bid adjustment settings."}}}},"placementBidAdjustments":{"type":"array","description":"Bid adjustments based on ad placements.","items":{"type":"object","properties":{"percentage":{"type":"integer","description":"The selection of the percentage change associated with a given placement and bid adjustment settings."},"placement":{"type":"string","description":"| Placement | Description |\n| --- | --- |\n| `HOME_PAGE` | Home page. |\n| `PRODUCT_PAGE` | Placements on the product detail page, and all nonsearch placements such as the add-to-cart page. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `REST_OF_SEARCH` | Placements on the middle or the bottom of the first-page search results. Also refers to ads on the second page of search results and beyond. |","enum":["HOME_PAGE","PRODUCT_PAGE","REST_OF_SEARCH","SITE_AMAZON_BUSINESS","TOP_OF_SEARCH"]}}}},"shopperSegmentBidAdjustments":{"type":"array","description":"Legacy SB field (marked for deprecation)","items":{"type":"object"}}}},"bidStrategy":{"type":"string","description":"| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` |  |\n| `NEW_TO_BRAND` |  |\n| `SPEND_BUDGET_IN_FULL` |  |\n| `RULE_BASED` |  |\n| `PRIORITIZE_KPI_TARGET` |  |\n| `USE_CAMPAIGN_STRATEGY` |  |","enum":["MANUAL","NEW_TO_BRAND","PRIORITIZE_KPI_TARGET","RULE_BASED","SALES_DOWN_ONLY","SALES_UP_AND_DOWN","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"]}}},"budgetSettings":{"type":"object","properties":{"budgetAllocation":{"type":"string","enum":["AUTO","MANUAL"]},"flightBudgetRolloverStrategy":{"type":"string","description":"| RolloverStrategy | Description |\n| --- | --- |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |","enum":["CUMULATIVE_BUDGET_ROLLOVER","NO_ROLLOVER","PRIOR_BUDGET_ROLLOVER"]},"offAmazonBudgetControlStrategy":{"type":"string","enum":["MAXIMIZE_REACH","MINIMIZE_SPEND"]}}},"goalSettings":{"type":"object","properties":{"goal":{"type":"string","enum":["AWARENESS","CONSIDERATION","CONVERSIONS"]},"kpi":{"type":"string","description":"| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |","enum":["ADD_TO_CART","APPLICATIONS","CHECKOUTS","CLICKS","CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","CONTACTS","COST_PER_ACTION","COST_PER_CLICK","COST_PER_CONVERSION_OFF_AMAZON","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_SIGN_UP","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","FREQUENCY_AVERAGE","LEADS","NEW_TO_BRAND_PURCHASES","OTHER","PAGE_VIEWS","PURCHASES","REACH","RETURN_ON_AD_SPEND","ROAS","ROAS_COMBINED","ROAS_PROMOTED","SEARCH","SIGN_UP","SUBSCRIBE","TOP_OF_SEARCH_IMPRESSION_SHARE","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"kpiValue":{"type":"number","description":"The value of the KPI that the campaign is working to optimize."}}},"primaryInventoryTypes":{"type":"array","description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"type":"string","enum":["AUDIO","DISPLAY","VIDEO_OLV","VIDEO_STV"]}}}},"startDateTime":{"type":"string","description":"The start date time for the campaign"},"state":{"type":"string","enum":["ARCHIVED","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the campaign","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}}}}}}},"marketplaces":{"type":"array","description":"A list of country codes representing Amazon marketplaces","items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"name":{"type":"string","description":"The name of the campaign."},"optimizations":{"type":"object","properties":{"bidSettings":{"type":"object","properties":{"bidAdjustments":{"type":"object","properties":{"audienceBidAdjustments":{"type":"array","description":"Bid Adjustments based on the audiences","items":{"type":"object","properties":{"audienceId":{"type":"string","description":"The unique identifier of the Audience to apply bid adjustment."},"percentage":{"type":"integer","description":"The selection of the percentage change associated with a given audience and bid adjustment settings."}}}},"placementBidAdjustments":{"type":"array","description":"Bid adjustments based on ad placements.","items":{"type":"object","properties":{"percentage":{"type":"integer","description":"The selection of the percentage change associated with a given placement and bid adjustment settings."},"placement":{"type":"string","description":"| Placement | Description |\n| --- | --- |\n| `HOME_PAGE` | Home page. |\n| `PRODUCT_PAGE` | Placements on the product detail page, and all nonsearch placements such as the add-to-cart page. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `REST_OF_SEARCH` | Placements on the middle or the bottom of the first-page search results. Also refers to ads on the second page of search results and beyond. |","enum":["HOME_PAGE","PRODUCT_PAGE","REST_OF_SEARCH","SITE_AMAZON_BUSINESS","TOP_OF_SEARCH"]}}}},"shopperSegmentBidAdjustments":{"type":"array","description":"Legacy SB field (marked for deprecation)","items":{"type":"object"}}}},"bidStrategy":{"type":"string","description":"| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` |  |\n| `NEW_TO_BRAND` |  |\n| `SPEND_BUDGET_IN_FULL` |  |\n| `RULE_BASED` |  |\n| `PRIORITIZE_KPI_TARGET` |  |\n| `USE_CAMPAIGN_STRATEGY` |  |","enum":["MANUAL","NEW_TO_BRAND","PRIORITIZE_KPI_TARGET","RULE_BASED","SALES_DOWN_ONLY","SALES_UP_AND_DOWN","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"]}}},"budgetSettings":{"type":"object","properties":{"budgetAllocation":{"type":"string","enum":["AUTO","MANUAL"]},"flightBudgetRolloverStrategy":{"type":"string","description":"| RolloverStrategy | Description |\n| --- | --- |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |","enum":["CUMULATIVE_BUDGET_ROLLOVER","NO_ROLLOVER","PRIOR_BUDGET_ROLLOVER"]},"offAmazonBudgetControlStrategy":{"type":"string","enum":["MAXIMIZE_REACH","MINIMIZE_SPEND"]}}},"goalSettings":{"type":"object","properties":{"goal":{"type":"string","enum":["AWARENESS","CONSIDERATION","CONVERSIONS"]},"kpi":{"type":"string","description":"| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |","enum":["ADD_TO_CART","APPLICATIONS","CHECKOUTS","CLICKS","CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","CONTACTS","COST_PER_ACTION","COST_PER_CLICK","COST_PER_CONVERSION_OFF_AMAZON","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_SIGN_UP","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","FREQUENCY_AVERAGE","LEADS","NEW_TO_BRAND_PURCHASES","OTHER","PAGE_VIEWS","PURCHASES","REACH","RETURN_ON_AD_SPEND","ROAS","ROAS_COMBINED","ROAS_PROMOTED","SEARCH","SIGN_UP","SUBSCRIBE","TOP_OF_SEARCH_IMPRESSION_SHARE","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"kpiValue":{"type":"number","description":"The value of the KPI that the campaign is working to optimize."}}},"primaryInventoryTypes":{"type":"array","description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"type":"string","enum":["AUDIO","DISPLAY","VIDEO_OLV","VIDEO_STV"]}}}},"portfolioId":{"type":"string","description":"The ID of the portfolio associated with the campaign."},"purchaseOrderNumber":{"type":"string","description":"The purchase order number associated with the campaign."},"siteRestrictions":{"type":"array","description":"Restrict the ad to a particular site","items":{"type":"string","description":"| SiteRestriction | Description |\n| --- | --- |\n| `AMAZON_BUSINESS` | Restrict the ad to only show on Amazon Business. |\n| `AMAZON_HAUL` | Restrict the ad to only show on Amazon Haul. |","enum":["AMAZON_BUSINESS","AMAZON_HAUL"]}},"skanAppId":{"type":"string","description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated."},"startDateTime":{"type":"string","description":"The start date time for the campaign."},"state":{"type":"string","description":"The user defined state for the resource. DRAFT applies to Amazon DSP campaigns only; every other ad product accepts ENABLED and PAUSED. For ADSP, campaign and ad group resources are created in the PAUSED or DRAFT state and must be updated to ENABLED to activate for delivery\n| UpdateState | Description |\n| --- | --- |\n| `DRAFT` | Amazon DSP only. The campaign is a draft and is not eligible for delivery. |\n| `ENABLED` |  |\n| `PAUSED` |  |","enum":["DRAFT","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the campaign","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}}},"required":["campaignId"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Campaign"]}],"path":"/en-us/mcp/campaign-management#tag/Campaign/operation/update_campaign","sectionHeader":{"type":3,"text":"POST /mcp/update_campaign"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/create_campaign",{"operationId":"create_campaign","description":"Create an Amazon Ads Campaign. This tools supports Sponsored Products, Sponsored Brands and ADSP.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"campaigns":{"type":"array","items":{"type":"object","properties":{"adProduct":{"type":"string","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"]},"autoCreationSettings":{"type":"object","properties":{"autoCreateTargets":{"type":"boolean","description":"Gives Amazon permission to automatically create targets associated with the campaign based on the products being advertised."}}},"brandId":{"type":"string","description":"This is the ID of the brand that the campaign is associated with."},"budgets":{"type":"array","description":"The object containing budget details for the campaign (for campaigns that support multiple budgets).","items":{"type":"object","properties":{"budgetType":{"type":"string","enum":["MONETARY"]},"budgetValue":{"oneOf":[{"type":"object","properties":{"monetaryBudgetValue":{"type":"object","properties":{"marketplaceSettings":{"type":"array","description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"required":["monetaryBudgetValue"]}]},"recurrenceTimePeriod":{"type":"string","enum":["DAILY","LIFETIME","MONTHLY"]}},"required":["budgetType","budgetValue","recurrenceTimePeriod"]}},"costType":{"type":"string","description":"| CostType | Description |\n| --- | --- |\n| `CPC` | Cost per click. |\n| `VCPM` | Cost per thousand views. |","enum":["CPC","VCPM"]},"countries":{"type":"array","description":"This field is used in Sponsored Ads and ADSP and impacts targeted supply. For Sponsored Ads, the campaign.countries field determines what Amazon retail supply (Amazon.com, Amazon.co.uk, Amazon.mx, etc) the campaign will serve in. Similarly in ADSP, this has an implicit filter on your inventory targets. If you choose an inventory target of AMAZON with campaign.countries set to US, this will target the retail supply of Amazon.com and non-retail Amazon properties. ADSP options include additional countries - for example, choosing Austria means targeting Austria eligible inventory and Amazon retail supply of Amazon.de.","items":{"type":"string","enum":["AE","AT","AU","BE","BH","BR","CA","CH","DE","DK","EG","ES","FI","FR","GB","IE","IL","IN","IT","JO","JP","KW","LU","MA","MK","MX","NL","NO","NZ","OM","PL","QA","SA","SE","SG","TR","US","ZA"]}},"endDateTime":{"type":"string","format":"date-time","description":"The end date time for the campaign."},"fees":{"type":"array","description":"Any fees associated with the campaign.","items":{"type":"object","properties":{"feeType":{"type":"string","description":"| CampaignFeeType | Description |\n| --- | --- |\n| `AGENCY` | A service fee that is subtracted from the campaign budget as a percent of budget. |","enum":["AGENCY"]},"feeValue":{"type":"number","description":"A service fee that is subtracted from the campaign budget as a percent of budget. This setting can’t be changed after an ad group has been added to a campaign."},"feeValueType":{"type":"string","description":"| CampaignFeeValueType | Description |\n| --- | --- |\n| `PERCENTAGE_OF_BUDGET` | Subtracted from the campaign budget as a percent of budget |","enum":["PERCENTAGE_OF_BUDGET"]}}}},"flights":{"type":"array","description":"Flight details associated with the campaign.","items":{"type":"object","properties":{"budget":{"type":"object","properties":{"budgetType":{"type":"string","enum":["MONETARY"]},"budgetValue":{"oneOf":[{"type":"object","properties":{"monetaryBudgetValue":{"type":"object","properties":{"marketplaceSettings":{"type":"array","description":"List of Monetary Budget values selectively applied at the given marketplace level","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"monetaryBudget":{"type":"object","properties":{"value":{"type":"number","description":"The monetary amount of the budget cap in the given currency."}},"required":["value"]}}}},"required":["monetaryBudgetValue"]}]}}},"endDateTime":{"type":"string","format":"date-time"},"flightId":{"type":"string","description":"The ID associated with the flight."},"name":{"type":"string","description":"The name of the flight."},"startDateTime":{"type":"string","format":"date-time","description":"The start date of the flight."}}}},"frequencies":{"type":"array","description":"Any frequency caps associated with the campaign.","items":{"type":"object","properties":{"eventMaxCount":{"type":"integer","description":"The maximum number of times an EventType is served per user. For ADSP ad group, maximum supported value is 500."},"frequencyTargetingSetting":{"type":"string","description":"| FrequencyTargetingSetting | Description |\n| --- | --- |\n| `USER` | Control frequency an ad will be selected to a person. |\n| `HOUSEHOLD` | Control frequency an ad will be selected across people within the same household. |","enum":["HOUSEHOLD","USER"]},"timeCount":{"type":"integer","description":"The value associated with the time and unit of time for this frequency cap."},"timeUnit":{"type":"string","enum":["DAYS","HOURS","MINUTES"]}}}},"marketplaceConfigurations":{"type":"array","description":"List of marketplace-specific configurations for a global campaign that enables overriding certain attributes at individual marketplace level. For example, if a global campaign is ENABLED and startDate '2024-06-01' but needs to be PAUSED in DE with startDateTime '2024-06-02' marketplace, you can specify: [{marketplace: DE, overrides: {state: PAUSED, startDate: '2024-06-02'}}]. When a marketplace-specific override is not provided, the campaign's global value is applied to that marketplace.","items":{"type":"object","properties":{"marketplace":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]},"overrides":{"type":"object","properties":{"endDateTime":{"type":"string","format":"date-time","description":"The end date time for the campaign"},"name":{"type":"string","description":"The name of the campaign"},"optimizations":{"type":"object","properties":{"bidSettings":{"type":"object","properties":{"bidAdjustments":{"type":"object","properties":{"audienceBidAdjustments":{"type":"array","description":"Bid Adjustments based on the audiences","items":{"type":"object","properties":{"audienceId":{"type":"string","description":"The unique identifier of the Audience to apply bid adjustment."},"percentage":{"type":"integer","description":"The selection of the percentage change associated with a given audience and bid adjustment settings."}}}},"placementBidAdjustments":{"type":"array","description":"Bid adjustments based on ad placements.","items":{"type":"object","properties":{"percentage":{"type":"integer","description":"The selection of the percentage change associated with a given placement and bid adjustment settings."},"placement":{"type":"string","description":"| Placement | Description |\n| --- | --- |\n| `HOME_PAGE` | Home page. |\n| `PRODUCT_PAGE` | Placements on the product detail page, and all nonsearch placements such as the add-to-cart page. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `REST_OF_SEARCH` | Placements on the middle or the bottom of the first-page search results. Also refers to ads on the second page of search results and beyond. |","enum":["HOME_PAGE","PRODUCT_PAGE","REST_OF_SEARCH","SITE_AMAZON_BUSINESS","TOP_OF_SEARCH"]}}}},"shopperSegmentBidAdjustments":{"type":"array","description":"Legacy SB field (marked for deprecation)","items":{"type":"object"}}}},"bidStrategy":{"type":"string","description":"| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` |  |\n| `NEW_TO_BRAND` |  |\n| `SPEND_BUDGET_IN_FULL` |  |\n| `RULE_BASED` |  |\n| `PRIORITIZE_KPI_TARGET` |  |\n| `USE_CAMPAIGN_STRATEGY` |  |","enum":["MANUAL","NEW_TO_BRAND","PRIORITIZE_KPI_TARGET","RULE_BASED","SALES_DOWN_ONLY","SALES_UP_AND_DOWN","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"]}}},"budgetSettings":{"type":"object","properties":{"budgetAllocation":{"type":"string","enum":["AUTO","MANUAL"]},"flightBudgetRolloverStrategy":{"type":"string","description":"| RolloverStrategy | Description |\n| --- | --- |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |","enum":["CUMULATIVE_BUDGET_ROLLOVER","NO_ROLLOVER","PRIOR_BUDGET_ROLLOVER"]},"offAmazonBudgetControlStrategy":{"type":"string","enum":["MAXIMIZE_REACH","MINIMIZE_SPEND"]}}},"goalSettings":{"type":"object","properties":{"goal":{"type":"string","enum":["AWARENESS","CONSIDERATION","CONVERSIONS"]},"kpi":{"type":"string","description":"| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |","enum":["ADD_TO_CART","APPLICATIONS","CHECKOUTS","CLICKS","CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","CONTACTS","COST_PER_ACTION","COST_PER_CLICK","COST_PER_CONVERSION_OFF_AMAZON","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_SIGN_UP","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","FREQUENCY_AVERAGE","LEADS","NEW_TO_BRAND_PURCHASES","OTHER","PAGE_VIEWS","PURCHASES","REACH","RETURN_ON_AD_SPEND","ROAS","ROAS_COMBINED","ROAS_PROMOTED","SEARCH","SIGN_UP","SUBSCRIBE","TOP_OF_SEARCH_IMPRESSION_SHARE","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"kpiValue":{"type":"number","description":"The value of the KPI that the campaign is working to optimize."}}},"primaryInventoryTypes":{"type":"array","description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"type":"string","enum":["AUDIO","DISPLAY","VIDEO_OLV","VIDEO_STV"]}}}},"startDateTime":{"type":"string","format":"date-time","description":"The start date time for the campaign"},"state":{"type":"string","enum":["ARCHIVED","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the campaign","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}}}}}}},"marketplaceScope":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]},"marketplaces":{"type":"array","description":"A list of country codes representing Amazon marketplaces","items":{"type":"string","description":"A list of country codes representing Amazon marketplaces","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","US","ZA"]}},"name":{"type":"string","description":"The name of the campaign."},"optimizations":{"type":"object","properties":{"bidSettings":{"type":"object","properties":{"bidAdjustments":{"type":"object","properties":{"audienceBidAdjustments":{"type":"array","description":"Bid Adjustments based on the audiences","items":{"type":"object","properties":{"audienceId":{"type":"string","description":"The unique identifier of the Audience to apply bid adjustment."},"percentage":{"type":"integer","description":"The selection of the percentage change associated with a given audience and bid adjustment settings."}}}},"placementBidAdjustments":{"type":"array","description":"Bid adjustments based on ad placements.","items":{"type":"object","properties":{"percentage":{"type":"integer","description":"The selection of the percentage change associated with a given placement and bid adjustment settings."},"placement":{"type":"string","description":"| Placement | Description |\n| --- | --- |\n| `HOME_PAGE` | Home page. |\n| `PRODUCT_PAGE` | Placements on the product detail page, and all nonsearch placements such as the add-to-cart page. |\n| `TOP_OF_SEARCH` | Placements on the top row of the first-page search results. |\n| `SITE_AMAZON_BUSINESS` | Amazon Business site placements. |\n| `REST_OF_SEARCH` | Placements on the middle or the bottom of the first-page search results. Also refers to ads on the second page of search results and beyond. |","enum":["HOME_PAGE","PRODUCT_PAGE","REST_OF_SEARCH","SITE_AMAZON_BUSINESS","TOP_OF_SEARCH"]}}}},"shopperSegmentBidAdjustments":{"type":"array","description":"Legacy SB field (marked for deprecation)","items":{"type":"object"}}}},"bidStrategy":{"type":"string","description":"| BidStrategy | Description |\n| --- | --- |\n| `MANUAL` | Uses your exact bid and any placement adjustments you set, and is not subject to dynamic bidding. |\n| `SALES_UP_AND_DOWN` | Increases or decreases your bids in real time by a maximum of 100%. With this setting bids increase when your ad is more likely to convert to a sale, and bids decrease when less likely to convert to a sale. |\n| `SALES_DOWN_ONLY` |  |\n| `NEW_TO_BRAND` |  |\n| `SPEND_BUDGET_IN_FULL` |  |\n| `RULE_BASED` |  |\n| `PRIORITIZE_KPI_TARGET` |  |\n| `USE_CAMPAIGN_STRATEGY` |  |","enum":["MANUAL","NEW_TO_BRAND","PRIORITIZE_KPI_TARGET","RULE_BASED","SALES_DOWN_ONLY","SALES_UP_AND_DOWN","SPEND_BUDGET_IN_FULL","USE_CAMPAIGN_STRATEGY"]}}},"budgetSettings":{"type":"object","properties":{"budgetAllocation":{"type":"string","enum":["AUTO","MANUAL"]},"flightBudgetRolloverStrategy":{"type":"string","description":"| RolloverStrategy | Description |\n| --- | --- |\n| `NO_ROLLOVER` | Do not rollover flight budgets. |\n| `PRIOR_BUDGET_ROLLOVER` | Rollover prior flight unused budget. |\n| `CUMULATIVE_BUDGET_ROLLOVER` | Rollover cumulative unused budget. |","enum":["CUMULATIVE_BUDGET_ROLLOVER","NO_ROLLOVER","PRIOR_BUDGET_ROLLOVER"]},"offAmazonBudgetControlStrategy":{"type":"string","enum":["MAXIMIZE_REACH","MINIMIZE_SPEND"]}}},"goalSettings":{"type":"object","properties":{"goal":{"type":"string","enum":["AWARENESS","CONSIDERATION","CONVERSIONS"]},"kpi":{"type":"string","description":"| KPI | Description |\n| --- | --- |\n| `ADD_TO_CART` | Indicates a goal of driving improved add to cart |\n| `APPLICATIONS` | Indicates a goal of driving applications |\n| `CHECKOUTS` | Indicates a goal of driving improved checkouts |\n| `CLICKS` | Indicates a goal of driving clicks. |\n| `CLICK_THROUGH_RATE` | Indicates a goal of driving clickthrough rate. |\n| `COMBINED_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_COMBINED. |\n| `CONTACTS` | Indicates a goal of driving improved contacts |\n| `COST_PER_ACTION` | Deprecated. Please use COST_PER_CONVERSION_OFF_AMAZON. |\n| `COST_PER_CLICK` | Indicates a goal of driving improved cost per click. |\n| `COST_PER_CONVERSION_OFF_AMAZON` | Indicates a goal of driving improved cost per conversion off Amazon. |\n| `COST_PER_DETAIL_PAGE_VIEW` | Indicates a goal of driving improved cost per detail page view. |\n| `COST_PER_FIRST_APP_OPEN` | Indicates a goal of improved cost per first app open. |\n| `COST_PER_INSTALL` | Indicates a goal of driving improved cost per app install. |\n| `COST_PER_SIGN_UP` | Indicates a goal of driving improved cost per sign up. |\n| `COST_PER_VIDEO_COMPLETION` | Indicates a goal of driving improved cost per video completion. |\n| `DETAIL_PAGE_VIEW_RATE` | Indicates a goal of driving improved detail page view rate. |\n| `FREQUENCY_AVERAGE` | Indicates a goal of driving to a target frequency. |\n| `LEADS` | Indicates a goal of driving leads. |\n| `NEW_TO_BRAND_PURCHASES` | Indicates a goal of maximizing new to brand purchases. |\n| `OTHER` | Indicates a goal of driving other metric |\n| `PAGE_VIEWS` | Indicates a goal of driving improved page views |\n| `PURCHASES` | Indicates a goal of driving improved purchases |\n| `REACH` | Indicates a goal of driving improved reach. |\n| `RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS_PROMOTED. |\n| `ROAS` | Indicates a goal of driving improved return of ad spend. |\n| `ROAS_COMBINED` | Indicates a goal of driving improved return of ad spend (combined). |\n| `ROAS_PROMOTED` | Indicates a goal of driving improved return of ad spend (promoted). |\n| `SEARCH` | Indicates a goal of driving improved search |\n| `SIGN_UP` | Indicates a goal of driving improved sign up |\n| `SUBSCRIBE` | Indicates a goal of driving improved subscriptions |\n| `TOP_OF_SEARCH_IMPRESSION_SHARE` | Indicates a goal of maximizing impression for top search placement. |\n| `TOTAL_RETURN_ON_AD_SPEND` | Deprecated. Please use ROAS. |\n| `VIDEO_COMPLETION_RATE` | Indicates a goal of driving improved video completion rate. |","enum":["ADD_TO_CART","APPLICATIONS","CHECKOUTS","CLICKS","CLICK_THROUGH_RATE","COMBINED_RETURN_ON_AD_SPEND","CONTACTS","COST_PER_ACTION","COST_PER_CLICK","COST_PER_CONVERSION_OFF_AMAZON","COST_PER_DETAIL_PAGE_VIEW","COST_PER_FIRST_APP_OPEN","COST_PER_INSTALL","COST_PER_SIGN_UP","COST_PER_VIDEO_COMPLETION","DETAIL_PAGE_VIEW_RATE","FREQUENCY_AVERAGE","LEADS","NEW_TO_BRAND_PURCHASES","OTHER","PAGE_VIEWS","PURCHASES","REACH","RETURN_ON_AD_SPEND","ROAS","ROAS_COMBINED","ROAS_PROMOTED","SEARCH","SIGN_UP","SUBSCRIBE","TOP_OF_SEARCH_IMPRESSION_SHARE","TOTAL_RETURN_ON_AD_SPEND","VIDEO_COMPLETION_RATE"]},"kpiValue":{"type":"number","description":"The value of the KPI that the campaign is working to optimize."}}},"primaryInventoryTypes":{"type":"array","description":"Primary inventory type of the campaign for filtering KPIs and recommending tactics.","items":{"type":"string","enum":["AUDIO","DISPLAY","VIDEO_OLV","VIDEO_STV"]}}}},"portfolioId":{"type":"string","description":"The ID of the portfolio associated with the campaign."},"productCategoryId":{"type":"string","description":"This is the ID of the product category that the campaign is associated with."},"purchaseOrderNumber":{"type":"string","description":"The purchase order number associated with the campaign."},"salesChannel":{"type":"string","description":"| SalesChannel | Description |\n| --- | --- |\n| `AMAZON` | A product sold on Amazon-owned sites. |\n| `OFF_AMAZON` | A product sold on a site not owned by Amazon. |","enum":["AMAZON","OFF_AMAZON"]},"siteRestrictions":{"type":"array","description":"Restrict the ad to a particular site","items":{"type":"string","description":"| SiteRestriction | Description |\n| --- | --- |\n| `AMAZON_BUSINESS` | Restrict the ad to only show on Amazon Business. |\n| `AMAZON_HAUL` | Restrict the ad to only show on Amazon Haul. |","enum":["AMAZON_BUSINESS","AMAZON_HAUL"]}},"skanAppId":{"type":"string","description":"StoreKit AdNetwork application ID. Represents iTunes application ID with which SKAN-enabled campaigns are associated."},"startDateTime":{"type":"string","format":"date-time","description":"The start date time for the campaign."},"state":{"type":"string","description":"The user defined state for the resource. DRAFT applies to Amazon DSP campaigns only; every other ad product accepts ENABLED and PAUSED. A DRAFT campaign is not eligible for delivery.","enum":["DRAFT","ENABLED","PAUSED"]},"tags":{"type":"array","description":"Open ended labels with a key value pair applied to the campaign","items":{"type":"object","properties":{"key":{"type":"string","description":"A custom key value pair entered by the advertiser."},"value":{"type":"string","description":"A custom key value pair entered by the advertiser."}}}}},"required":["adProduct","name","state"]}}},"required":["accessRequestedAccount"]}}}}}},"tags":["Campaign"]}],"path":"/en-us/mcp/campaign-management#tag/Campaign/operation/create_campaign","sectionHeader":{"type":3,"text":"POST /mcp/create_campaign"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/create_bid_adjustment_rule",{"operationId":"create_bid_adjustment_rule","description":"Creates a bid adjustment rule and associates it with a DSP ad group. A bid adjustment rule contains dimension-based expressions with conditions and actions that define how bids are adjusted based on targeting dimensions such as device type, browser, geography, and more.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."},"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["advertiserAccountId","profileId"]},"rule":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":1024,"description":"The rule name/description."},"onRuleExpressionConflict":{"type":"string","enum":["FIRST","ALL"],"description":"The conflict resolution strategy when multiple rule expressions match the same impression. Defaults to ALL if not provided."},"expression":{"type":"array","minItems":1,"maxItems":1000,"description":"A list of dimension rule expressions that define conditions and bid adjustment actions.","items":{"type":"object","properties":{"conditions":{"type":"object","properties":{"dimensions":{"type":"array","minItems":1,"maxItems":100,"description":"Dimensions to match. Each dimension type must be unique.","items":{"type":"object","properties":{"dimensionType":{"type":"string","enum":["DEVICE_TYPE","BROWSER","DOMAIN","OPERATING_SYSTEM","COUNTRY","REGION","CITY","POSTAL_CODE","DMA","SUPPLY_SOURCE","SUPPLY_SOURCE_TYPE","AD_FORMAT","SLOT_SIZE","SLOT_POSITION","DEAL_ID","APP_ID","APP_NAME","DEVICE_MAKE","BEHAVIORAL_SEGMENT"],"description":"The type of dimension."},"dimensionValues":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"string"},"description":"The values to match for this dimension. Multiple values use OR logic."}},"required":["dimensionType","dimensionValues"]}},"negative":{"type":"boolean","description":"If true, the bid adjustment applies when NONE of the dimensions match. Defaults to false."}},"required":["dimensions"]},"actions":{"type":"object","properties":{"bidAdjustment":{"type":"object","properties":{"adjustmentType":{"type":"string","enum":["MULTIPLIER"],"description":"The adjustment type for bid adjustment rules."},"adjustmentValue":{"type":"number","minimum":0,"maximum":10,"description":"A bid multiplier applied to the DSP computed bid amount. Values will be truncated to 2 decimal places."}},"required":["adjustmentType","adjustmentValue"]}},"required":["bidAdjustment"]}},"required":["conditions","actions"]}}},"required":["expression"]},"ruleLink":{"type":"object","properties":{"ruleLinkEntityType":{"type":"string","enum":["AD_GROUP"],"description":"The type of the object to associate with the rule. Currently only supports DSP ad groups."},"entityId":{"type":"string","minLength":1,"description":"The object ID to associate with the rule (e.g., DSP ad group ID)."}},"required":["ruleLinkEntityType","entityId"]}},"required":["accessRequestedAccount","rule","ruleLink"]}},"required":["body"]}}}},"tags":["Bid Adjustment"]}],"path":"/en-us/mcp/campaign-management#tag/Bid%20Adjustment/operation/create_bid_adjustment_rule","sectionHeader":{"type":3,"text":"POST /mcp/create_bid_adjustment_rule"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/add_country_campaign",{"operationId":"add_country_campaign","description":"Add countries to existing Amazon Ads Sponsored Products Manual campaigns with country-specific budget caps. Enables advertisers to expand campaign reach to new geographical markets while maintaining granular budget control per country. Only supports SPONSORED_PRODUCTS Manual campaigns. Only the first maximum 10 unique ASINs/SKUs under the campaign will be considered for ad creation under the given country code.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account (global account construct representing a single advertiser). This API supports Advertiser Accounts only. Expected format: amzn1.ads-account.g.* (e.g., amzn1.ads-account.g.ABC123XYZ)"}},"required":["profileId"]}]},"campaigns":{"type":"array","maxItems":1,"description":"Array of campaign objects to add countries to (maximum 1 campaign per request).","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the campaign to add countries to."},"countryCodes":{"type":"array","maxItems":1,"description":"Array of ISO 3166-1 alpha-2 country codes to add to the campaign (maximum 1 country per request).","items":{"type":"string","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NL","PL","SA","SE","SG","TR","UK","US","ZA"]}},"budgetCaps":{"type":"object","description":"Budget caps configuration for the countries being added.","properties":{"countryMonetaryBudgetSettings":{"type":"object","description":"Country-specific monetary budget settings with marketplace-specific constraints.","properties":{"US":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for US marketplace (min: 1, max: 1,000,000)"}},"required":["value"]},"CA":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for CA marketplace (min: 1, max: 1,000,000)"}},"required":["value"]},"UK":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for UK marketplace (min: 1, max: 1,000,000)"}},"required":["value"]},"GB":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for GB marketplace (min: 1, max: 1,000,000)"}},"required":["value"]},"DE":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for DE marketplace (min: 1, max: 1,000,000)"}},"required":["value"]},"FR":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for FR marketplace (min: 1, max: 1,000,000)"}},"required":["value"]},"IT":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for IT marketplace (min: 1, max: 1,000,000)"}},"required":["value"]},"ES":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for ES marketplace (min: 1, max: 1,000,000)"}},"required":["value"]},"IN":{"type":"object","properties":{"value":{"type":"number","minimum":50,"maximum":21000000,"description":"Daily budget for IN marketplace (min: 50, max: 21,000,000)"}},"required":["value"]},"JP":{"type":"object","properties":{"value":{"type":"number","minimum":100,"maximum":21000000,"description":"Daily budget for JP marketplace (min: 100, max: 21,000,000)"}},"required":["value"]},"AU":{"type":"object","properties":{"value":{"type":"number","minimum":1.4,"maximum":1500000,"description":"Daily budget for AU marketplace (min: 1.4, max: 1,500,000)"}},"required":["value"]},"MX":{"type":"object","properties":{"value":{"type":"number","minimum":12,"maximum":1000000,"description":"Daily budget for MX marketplace (min: 12, max: 1,000,000)"}},"required":["value"]},"AE":{"type":"object","properties":{"value":{"type":"number","minimum":4,"maximum":3700000,"description":"Daily budget for AE marketplace (min: 4, max: 3,700,000)"}},"required":["value"]},"SA":{"type":"object","properties":{"value":{"type":"number","minimum":4,"maximum":3700000,"description":"Daily budget for SA marketplace (min: 4, max: 3,700,000)"}},"required":["value"]},"BR":{"type":"object","properties":{"value":{"type":"number","minimum":1.32,"maximum":5300000,"description":"Daily budget for BR marketplace (min: 1.32, max: 5,300,000)"}},"required":["value"]},"NL":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for NL marketplace (min: 1, max: 1,000,000)"}},"required":["value"]},"SG":{"type":"object","properties":{"value":{"type":"number","minimum":1.39,"maximum":1300000,"description":"Daily budget for SG marketplace (min: 1.39, max: 1,300,000)"}},"required":["value"]},"TR":{"type":"object","properties":{"value":{"type":"number","minimum":2,"maximum":2500000,"description":"Daily budget for TR marketplace (min: 2, max: 2,500,000)"}},"required":["value"]},"PL":{"type":"object","properties":{"value":{"type":"number","minimum":2,"maximum":2000000,"description":"Daily budget for PL marketplace (min: 2, max: 2,000,000)"}},"required":["value"]},"SE":{"type":"object","properties":{"value":{"type":"number","minimum":9,"maximum":9300000,"description":"Daily budget for SE marketplace (min: 9, max: 9,300,000)"}},"required":["value"]},"EG":{"type":"object","properties":{"value":{"type":"number","minimum":7,"maximum":7400000,"description":"Daily budget for EG marketplace (min: 7, max: 7,400,000)"}},"required":["value"]},"BE":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for BE marketplace (min: 1, max: 1,000,000)"}},"required":["value"]},"ZA":{"type":"object","properties":{"value":{"type":"number","minimum":20,"maximum":7000000,"description":"Daily budget for ZA marketplace (min: 20, max: 7,000,000)"}},"required":["value"]},"IE":{"type":"object","properties":{"value":{"type":"number","minimum":1,"maximum":1000000,"description":"Daily budget for IE marketplace (min: 1, max: 1,000,000)"}},"required":["value"]}},"additionalProperties":false}},"required":["countryMonetaryBudgetSettings"]}},"defaultBid":{"type":"number","description":"Default bid applied to all ad groups in the target country. Must be greater than 0."},"keywords":{"type":"array","minItems":1,"description":"Keywords to target in the expanded country, applied to all ad groups.","items":{"type":"object","properties":{"keyword":{"type":"string","description":"The keyword text to target."},"matchType":{"type":"string","description":"The match type for the keyword.","enum":["BROAD","PHRASE","EXACT"]},"bid":{"type":"number","description":"The bid amount for this keyword. Must be greater than 0."}},"required":["keyword","matchType","bid"]}}},"required":["id","countryCodes","budgetCaps","defaultBid","keywords"]}},"required":["accessRequestedAccount","campaigns"]}},"required":["body"]}}}},"tags":["Campaign"]}],"path":"/en-us/mcp/campaign-management#tag/Campaign/operation/add_country_campaign","sectionHeader":{"type":3,"text":"POST /mcp/add_country_campaign"},"documentType":"api-reference"},{"title":"campaign_management","content":["/mcp/query_campaign",{"operationId":"query_campaign","description":"Query Amazon Ads Campaigns with advanced filtering capabilities. Supports Sponsored Products, Sponsored Brands, Sponsored Display, Sponsored Television, and Amazon DSP campaigns.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"adProductFilter":{"type":"object","properties":{"include":{"type":"array","minItems":1,"maxItems":1,"items":{"type":"string","enum":["AMAZON_DSP","SPONSORED_BRANDS","SPONSORED_DISPLAY","SPONSORED_PRODUCTS","SPONSORED_TELEVISION"]},"description":"Only one ad product can be queried at a time."}},"required":["include"]},"campaignIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"goalFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["AWARENESS","CONSIDERATION","CONVERSIONS"]}}},"required":["include"]},"marketplaceScopeFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["GLOBAL","SINGLE_MARKETPLACE"]}}},"required":["include"]},"maxResults":{"type":"integer"},"nameFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}},"queryTermMatchType":{"type":"string","enum":["BROAD_MATCH","EXACT_MATCH"]}},"required":["include","queryTermMatchType"]},"nextToken":{"type":"string"},"portfolioIdFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}}},"required":["include"]},"stateFilter":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string","enum":["ARCHIVED","DRAFT","ENABLED","PAUSED"]},"description":"DRAFT applies to Amazon DSP campaigns only. Send [\"DRAFT\"] on its own to get draft campaigns and nothing else. A state filter that does not name DRAFT leaves draft campaigns out. Naming DRAFT together with other states returns draft campaigns as well as campaigns in those states. Draft campaigns also come back when campaignIdFilter names specific campaigns and no stateFilter is sent. At most 3 states are accepted per call, so all four values cannot be sent together."}},"required":["include"]}},"required":["accessRequestedAccount","adProductFilter"]}},"required":["body"]}}}},"tags":["Campaign"]}],"path":"/en-us/mcp/campaign-management#tag/Campaign/operation/query_campaign","sectionHeader":{"type":3,"text":"POST /mcp/query_campaign"},"documentType":"api-reference"},{"title":"eligibility","content":["MCP tools related to eligibility\n"],"path":"/en-us/mcp/eligibility","sectionHeader":{"type":2,"text":"eligibility"},"documentType":"api-reference"},{"title":"eligibility","content":["/mcp/programs",{"operationId":"programs","description":"Checks advertiser eligibility for ad programs (Sponsored Products, Sponsored Brands, Sponsored Display, Stores, etc).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"skipChecks":{"type":"object","description":"Optional checks to skip","properties":{"skipAllBillingChecks":{"type":"boolean","description":"Skip all billing/payments/suspension checks"}}}},"required":["accessRequestedAccount"]}}}}}},"tags":["eligibility"]}],"path":"/en-us/mcp/eligibility#tag/eligibility/operation/programs","sectionHeader":{"type":3,"text":"POST /mcp/programs"},"documentType":"api-reference"},{"title":"eligibility","content":["/mcp/product_list",{"operationId":"product_list","description":"Gets advertising eligibility status for a list of products. Returns eligibility objects for products sold by the merchant associated with the profile. If a product is not eligible, includes reasons for ineligibility.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}},"required":["advertiserAccountId"]},{"type":"object","properties":{"profileId":{"type":"string","description":"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 and choose profile id profileId from the response to pass it as input."}},"required":["profileId"]}]},"productDetailsList":{"type":"array","description":"List of product identifier objects (1-50 items).","minItems":1,"maxItems":50,"items":{"type":"object"}},"adType":{"type":"string","description":"Ad type to check eligibility for.","enum":["sp","sb","sd","dsp"]},"locale":{"type":"string","description":"Locale for response language (e.g., en_US)."}},"required":["accessRequestedAccount","productDetailsList"]}}}}}},"tags":["eligibility"]}],"path":"/en-us/mcp/eligibility#tag/eligibility/operation/product_list","sectionHeader":{"type":3,"text":"POST /mcp/product_list"},"documentType":"api-reference"},{"title":"manager_accounts","content":["MCP tools related to manager_accounts\n"],"path":"/en-us/mcp/manager-accounts","sectionHeader":{"type":2,"text":"manager_accounts"},"documentType":"api-reference"},{"title":"manager_accounts","content":["/mcp/disassociate_accounts",{"operationId":"disassociate_accounts","description":"Unlink Amazon Advertising accounts or advertisers from a Manager Account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pathParameters":{"type":"object","properties":{"managerAccountId":{"type":"string","description":"Id of the Manager Account."}},"required":["managerAccountId"]},"body":{"type":"object","properties":{"accounts":{"type":"array","description":"List of Advertising accounts or advertisers to unlink from Manager Account. Maximum of 20 accounts/advertisers using any mix of identifiers.","items":{"type":"object"}}}}}}}}},"tags":["manager_accounts"]}],"path":"/en-us/mcp/manager-accounts#tag/manager_accounts/operation/disassociate_accounts","sectionHeader":{"type":3,"text":"POST /mcp/disassociate_accounts"},"documentType":"api-reference"},{"title":"manager_accounts","content":["/mcp/get_manager_accounts",{"operationId":"get_manager_accounts","description":"Returns all manager accounts that a user has access to, along with metadata for the Amazon Ads accounts linked to each manager account. NOTE: A maximum of 50 linked accounts are returned for each manager account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"tags":["manager_accounts"]}],"path":"/en-us/mcp/manager-accounts#tag/manager_accounts/operation/get_manager_accounts","sectionHeader":{"type":3,"text":"POST /mcp/get_manager_accounts"},"documentType":"api-reference"},{"title":"manager_accounts","content":["/mcp/associate_accounts",{"operationId":"associate_accounts","description":"Link Amazon Advertising accounts or advertisers with a Manager Account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pathParameters":{"type":"object","properties":{"managerAccountId":{"type":"string","description":"Id of the Manager Account."}},"required":["managerAccountId"]},"body":{"type":"object","properties":{"accounts":{"type":"array","description":"List of Advertising accounts or advertisers to link with Manager Account. Maximum of 20 accounts/advertisers using any mix of identifiers.","items":{"type":"object","properties":{"id":{"type":"string","description":"Id of the Amazon Advertising account."},"roles":{"type":"array","description":"The types of role that will exist with the Amazon Advertising account. Depending on account type, the default role will be ENTITY_USER or SELLER_USER. Only one role at a time is currently supported.","items":{"type":"string","enum":["ENTITY_OWNER","ENTITY_USER","ENTITY_VIEWER","SELLER_USER"]}},"type":{"type":"string","description":"The type of the Id.","enum":["ACCOUNT_ID","DSP_ADVERTISER_ID"]}}}}}}}}}}},"tags":["manager_accounts"]}],"path":"/en-us/mcp/manager-accounts#tag/manager_accounts/operation/associate_accounts","sectionHeader":{"type":3,"text":"POST /mcp/associate_accounts"},"documentType":"api-reference"},{"title":"manager_accounts","content":["/mcp/create_manager_account",{"operationId":"create_manager_account","description":"Creates a new Amazon Advertising Manager account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"managerAccountName":{"type":"string","description":"Name of the Manager account."},"managerAccountType":{"type":"string","description":"Type of the Manager account. Use Advertiser if the Manager account will be used for your own products and services, or Agency if you are managing accounts on behalf of your clients.","enum":["Advertiser","Agency"]}}}}}}}},"tags":["manager_accounts"]}],"path":"/en-us/mcp/manager-accounts#tag/manager_accounts/operation/create_manager_account","sectionHeader":{"type":3,"text":"POST /mcp/create_manager_account"},"documentType":"api-reference"},{"title":"promotions","content":["MCP tools related to promotions\n"],"path":"/en-us/mcp/promotions","sectionHeader":{"type":2,"text":"promotions"},"documentType":"api-reference"},{"title":"promotions","content":["/mcp/redeem_promotion_code",{"operationId":"redeem_promotion_code","description":"Redeem a promotion code for an advertiser account. Creates a promotion code redemption that activates a promotional offer for the specified marketplace. Returns the redemption result including the associated promotion offer. On failure, returns error code: INVALID_PROMOTION_CODE (code does not exist), EXPIRED_PROMOTION_CODE (code has expired), MAXIMUM_REDEMPTIONS_REACHED (max redemptions for account reached), ACCOUNT_NOT_ELIGIBLE (account does not meet eligibility criteria), UNSUPPORTED_MARKETPLACE (marketplace not supported).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"]}]},"promotionCodeRedemptions":{"type":"array","maxItems":5,"minItems":1,"items":{"type":"object","properties":{"promotionCodeId":{"type":"string","description":"The promotion code to redeem"},"marketplace":{"type":"string","description":"The marketplace where the promotion code should be redeemed","enum":["AE","AU","BE","BR","CA","CL","CO","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NG","NL","PL","SA","SE","SG","TR","US","ZA"]}},"required":["promotionCodeId","marketplace"]}}},"required":["accessRequestedAccount","promotionCodeRedemptions"]}},"required":["body"]}}}},"tags":["promotions"]}],"path":"/en-us/mcp/promotions#tag/promotions/operation/redeem_promotion_code","sectionHeader":{"type":3,"text":"POST /mcp/redeem_promotion_code"},"documentType":"api-reference"},{"title":"promotions","content":["/mcp/query_promotion_offers",{"operationId":"query_promotion_offers","description":"Query and list promotion offers available for an advertiser account. Returns promotion details including status, marketplace, promotion campaign info, fulfilment criteria, and reward information. Supports filtering by marketplace and offer status. A promotion offer represents an opportunity to earn a reward by meeting specific criteria. The fulfilment criteria defines what the advertiser must do to earn the reward, such as launching a campaign or spending a certain amount within a time period. The promotion campaign is the marketing initiative associated with the offer.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"]}]},"marketplaceFilter":{"type":"object","description":"Filter results by marketplace country codes","properties":{"include":{"type":"array","maxItems":30,"minItems":1,"items":{"type":"string","enum":["AE","AU","BE","BR","CA","CL","CO","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NG","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"required":["include"]},"statusFilter":{"type":"object","description":"Filter results by promotion offer status. AVAILABLE: offer is active and the advertiser has not yet started fulfilling the criteria. IN_PROGRESS: the advertiser has begun working toward the fulfilment criteria but has not yet completed them. REWARDED: fulfilment criteria met and the reward has been applied to the account. MISSED: the offer expired before the advertiser met the fulfilment criteria.","properties":{"include":{"type":"array","maxItems":4,"minItems":1,"items":{"type":"string","enum":["AVAILABLE","IN_PROGRESS","REWARDED","MISSED"]}}},"required":["include"]},"maxResults":{"type":"integer","default":100,"maximum":100,"minimum":1,"description":"Maximum number of promotion offers to return (1-100, default 100)"},"nextToken":{"type":"string","description":"Pagination token from a previous response to retrieve the next page of results"}},"required":["accessRequestedAccount"]}},"required":["body"]}}}},"tags":["promotions"]}],"path":"/en-us/mcp/promotions#tag/promotions/operation/query_promotion_offers","sectionHeader":{"type":3,"text":"POST /mcp/query_promotion_offers"},"documentType":"api-reference"},{"title":"promotions","content":["/mcp/query_promotion_rewards",{"operationId":"query_promotion_rewards","description":"Query and list promotion rewards for an advertiser account. A promotion reward represents financial credit that has been granted to an advertiser and is tracked from issuance to full consumption. Returns reward details including total reward amount, remaining amount, reward type, marketplace, and validity dates. Supports filtering by reward ID, type, marketplace, and start or end date ranges. Optionally returns a per-invoice consumption breakdown showing how the reward has been applied across invoices.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"]}]},"promotionRewardIdFilter":{"type":"object","description":"Filter by specific promotion reward IDs. Accepts up to 10 IDs","properties":{"include":{"type":"array","maxItems":10,"minItems":1,"items":{"type":"string"}}},"required":["include"]},"promotionRewardTypeFilter":{"type":"object","description":"Filter by reward type. ADHOC: one-off reward granted for specific business reasons. SIGNUP: reward granted when an advertiser signs up for an advertising program. PROMO_CODE: reward granted when an advertiser redeems a promotion code","properties":{"include":{"type":"array","maxItems":3,"minItems":1,"items":{"type":"string","enum":["ADHOC","SIGNUP","PROMO_CODE"]}}},"required":["include"]},"marketplaceFilter":{"type":"object","description":"Filter by marketplace country codes. Accepts up to 28 marketplaces","properties":{"include":{"type":"array","maxItems":28,"minItems":1,"items":{"type":"string","enum":["AE","AU","BE","BR","CA","CL","CO","DE","EG","ES","FR","GB","IE","IN","IT","JP","MX","NG","NL","PL","SA","SE","SG","TR","US","ZA"]}}},"required":["include"]},"startDateTimeFilter":{"type":"object","description":"Filter by reward start date. Accepts one value for an exact date match, or two values (from, to) for an inclusive range. ISO 8601 date-time","properties":{"include":{"type":"array","maxItems":2,"minItems":1,"items":{"type":"string","format":"date-time"}}},"required":["include"]},"endDateTimeFilter":{"type":"object","description":"Filter by reward end date. Accepts one value for an exact date match, or two values (from, to) for an inclusive range. ISO 8601 date-time","properties":{"include":{"type":"array","maxItems":2,"minItems":1,"items":{"type":"string","format":"date-time"}}},"required":["include"]},"includePromotionRewardConsumptionFilter":{"type":"object","description":"When include is [true], the response includes a per-invoice consumption breakdown for each reward. Default excludes consumption details for better performance. Set to true only when the caller needs invoice-level detail","properties":{"include":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"boolean"}}},"required":["include"]},"maxResults":{"type":"integer","default":25,"maximum":25,"minimum":1,"description":"Maximum number of promotion rewards to return (1-25, default 25)"},"nextToken":{"type":"string","description":"Pagination token from a previous response to retrieve the next page of results"}},"required":["accessRequestedAccount"]}},"required":["body"]}}}},"tags":["promotions"]}],"path":"/en-us/mcp/promotions#tag/promotions/operation/query_promotion_rewards","sectionHeader":{"type":3,"text":"POST /mcp/query_promotion_rewards"},"documentType":"api-reference"},{"title":"reporting","content":["MCP tools related to reporting\n"],"path":"/en-us/mcp/reporting","sectionHeader":{"type":2,"text":"reporting"},"documentType":"api-reference"},{"title":"reporting","content":["/mcp/create_campaign_report",{"operationId":"create_campaign_report","description":"Create a Campaign report.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"reports":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"format":{"type":"string","description":"Comma-separated values file containing plain text tabular data","enum":["CSV","GZIP_JSON","PARTITIONED_CSV","PARTITIONED_GZIP_JSON"]},"periods":{"type":"array","maxItems":1,"minItems":1,"items":{"oneOf":[{"type":"object","properties":{"datePeriod":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}},"required":["endDate","startDate"]}},"required":["datePeriod"]}]}},"query":{"type":"object","properties":{"filter":{"oneOf":[{"type":"object","properties":{"and":{"type":"object","properties":{"filters":{"type":"array","maxItems":10,"minItems":1,"items":{}}},"required":["filters"]}},"required":["and"]},{"type":"object","properties":{"on":{"type":"object","properties":{"field":{"type":"string","pattern":"^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$"},"comparisonOperator":{"type":"string","enum":["EQUALS","IN"]},"not":{"type":"boolean"},"values":{"type":"array","maxItems":2000,"minItems":1,"items":{"type":"string"}}},"required":["comparisonOperator","field","not","values"]}},"required":["on"]}]}},"required":[]},"currencyOfView":{"type":"string","enum":["AED","ARS","AUD","AZN","BBD","BGN","BMD","BND","BRL","BSD","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DOP","EGP","EUR","GBP","GHS","GTQ","HKD","HUF","IDR","ILS","INR","JMD","JPY","KES","KRW","KYD","KZT","LBP","LKR","MAD","MUR","MXN","MYR","NAD","NGN","NOK","NZD","PAB","PEN","PHP","PKR","PLN","QAR","RON","RUB","SAR","SEK","SGD","THB","TRY","TTD","TWD","TZS","USD","UYU","VND","XAF","XCD","XOF","XPF","ZAR"]}},"required":["format","periods","query"]}},"accessRequestedAccounts":{"type":"array","maxItems":2000,"minItems":1,"items":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"]},{"type":"object","properties":{"managerAccountId":{"type":"string"}},"required":["managerAccountId"]}]}}},"required":["accessRequestedAccounts","reports"]}}}}}},"tags":["reporting"]}],"path":"/en-us/mcp/reporting#tag/reporting/operation/create_campaign_report","sectionHeader":{"type":3,"text":"POST /mcp/create_campaign_report"},"documentType":"api-reference"},{"title":"reporting","content":["/mcp/delete_report",{"operationId":"delete_report","description":"Delete a report.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"reportIds":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"string"}}},"required":["reportIds"]}}}}}},"tags":["reporting"]}],"path":"/en-us/mcp/reporting#tag/reporting/operation/delete_report","sectionHeader":{"type":3,"text":"POST /mcp/delete_report"},"documentType":"api-reference"},{"title":"reporting","content":["/mcp/create_report",{"operationId":"create_report","description":"Create a report.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"reports":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"format":{"type":"string","enum":["CSV","GZIP_JSON","PARTITIONED_CSV","PARTITIONED_GZIP_JSON"]},"periods":{"type":"array","maxItems":1,"minItems":1,"items":{"oneOf":[{"type":"object","properties":{"datePeriod":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}},"required":["endDate","startDate"]}},"required":["datePeriod"]}]}},"query":{"type":"object","properties":{"fields":{"type":"array","maxItems":1000,"minItems":1,"items":{"type":"string"}},"filter":{"oneOf":[{"type":"object","properties":{"and":{"type":"object","properties":{"filters":{"type":"array","maxItems":10,"minItems":1,"items":{}}},"required":["filters"]}},"required":["and"]},{"type":"object","properties":{"on":{"type":"object","properties":{"field":{"type":"string","pattern":"^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$"},"comparisonOperator":{"type":"string","enum":["EQUALS","IN"]},"not":{"type":"boolean"},"values":{"type":"array","maxItems":2000,"minItems":1,"items":{"type":"string"}}},"required":["comparisonOperator","field","not","values"]}},"required":["on"]}]}},"required":["fields"]},"currencyOfView":{"type":"string","enum":["AED","ARS","AUD","AZN","BBD","BGN","BMD","BND","BRL","BSD","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DOP","EGP","EUR","GBP","GHS","GTQ","HKD","HUF","IDR","ILS","INR","JMD","JPY","KES","KRW","KYD","KZT","LBP","LKR","MAD","MUR","MXN","MYR","NAD","NGN","NOK","NZD","PAB","PEN","PHP","PKR","PLN","QAR","RON","RUB","SAR","SEK","SGD","THB","TRY","TTD","TWD","TZS","USD","UYU","VND","XAF","XCD","XOF","XPF","ZAR"]},"managerAccountDspGrouping":{"type":"string","enum":["DSP_ADVERTISER_ACCOUNT","GLOBAL_ADVERTISER_ACCOUNT"]}},"required":["format","periods","query"]}},"accessRequestedAccounts":{"type":"array","maxItems":2000,"minItems":1,"items":{"description":"| ReportCreateAccessRequestedAccountItem | Description |\n| --- | --- |\n| `advertiserAccountId` | ADSP Regional Account or Global Account |\n| `managerAccountId` | Manager Account |","oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"]},{"type":"object","properties":{"managerAccountId":{"type":"string"}},"required":["managerAccountId"]}]}}},"required":["accessRequestedAccounts","reports"]}}}}}},"tags":["reporting"]}],"path":"/en-us/mcp/reporting#tag/reporting/operation/create_report","sectionHeader":{"type":3,"text":"POST /mcp/create_report"},"documentType":"api-reference"},{"title":"reporting","content":["/mcp/retrieve_report",{"operationId":"retrieve_report","description":"Retrieve a report.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"reportIds":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"string"}}},"required":["reportIds"]}}}}}},"tags":["reporting"]}],"path":"/en-us/mcp/reporting#tag/reporting/operation/retrieve_report","sectionHeader":{"type":3,"text":"POST /mcp/retrieve_report"},"documentType":"api-reference"},{"title":"reporting","content":["/mcp/create_inventory_report",{"operationId":"create_inventory_report","description":"Create an Inventory report.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"reports":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"format":{"type":"string","description":"Comma-separated values file containing plain text tabular data","enum":["CSV","GZIP_JSON","PARTITIONED_CSV","PARTITIONED_GZIP_JSON"]},"periods":{"type":"array","maxItems":1,"minItems":1,"items":{"oneOf":[{"type":"object","properties":{"datePeriod":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}},"required":["endDate","startDate"]}},"required":["datePeriod"]}]}},"query":{"type":"object","properties":{"filter":{"oneOf":[{"type":"object","properties":{"and":{"type":"object","properties":{"filters":{"type":"array","maxItems":10,"minItems":1,"items":{}}},"required":["filters"]}},"required":["and"]},{"type":"object","properties":{"on":{"type":"object","properties":{"field":{"type":"string","pattern":"^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$"},"comparisonOperator":{"type":"string","enum":["EQUALS","IN"]},"not":{"type":"boolean"},"values":{"type":"array","maxItems":2000,"minItems":1,"items":{"type":"string"}}},"required":["comparisonOperator","field","not","values"]}},"required":["on"]}]}},"required":[]},"currencyOfView":{"type":"string","enum":["AED","ARS","AUD","AZN","BBD","BGN","BMD","BND","BRL","BSD","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DOP","EGP","EUR","GBP","GHS","GTQ","HKD","HUF","IDR","ILS","INR","JMD","JPY","KES","KRW","KYD","KZT","LBP","LKR","MAD","MUR","MXN","MYR","NAD","NGN","NOK","NZD","PAB","PEN","PHP","PKR","PLN","QAR","RON","RUB","SAR","SEK","SGD","THB","TRY","TTD","TWD","TZS","USD","UYU","VND","XAF","XCD","XOF","XPF","ZAR"]}},"required":["format","periods","query"]}},"accessRequestedAccounts":{"type":"array","maxItems":2000,"minItems":1,"items":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"]},{"type":"object","properties":{"managerAccountId":{"type":"string"}},"required":["managerAccountId"]}]}}},"required":["accessRequestedAccounts","reports"]}}}}}},"tags":["reporting"]}],"path":"/en-us/mcp/reporting#tag/reporting/operation/create_inventory_report","sectionHeader":{"type":3,"text":"POST /mcp/create_inventory_report"},"documentType":"api-reference"},{"title":"reporting","content":["/mcp/create_product_report",{"operationId":"create_product_report","description":"Create a Product report.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skill":{"type":"object","description":"Do not auto-generate or infer values for this object. Only populate it when a skill definition explicitly provides the skillName and version to pass. If no skill definition is involved, omit this field entirely.","properties":{"skillName":{"type":"string"},"version":{"type":"string"}},"required":["skillName","version"]},"body":{"type":"object","properties":{"reports":{"type":"array","maxItems":1,"minItems":1,"items":{"type":"object","properties":{"format":{"type":"string","description":"Comma-separated values file containing plain text tabular data","enum":["CSV","GZIP_JSON","PARTITIONED_CSV","PARTITIONED_GZIP_JSON"]},"periods":{"type":"array","maxItems":1,"minItems":1,"items":{"oneOf":[{"type":"object","properties":{"datePeriod":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}},"required":["endDate","startDate"]}},"required":["datePeriod"]}]}},"query":{"type":"object","properties":{"filter":{"oneOf":[{"type":"object","properties":{"and":{"type":"object","properties":{"filters":{"type":"array","maxItems":10,"minItems":1,"items":{}}},"required":["filters"]}},"required":["and"]},{"type":"object","properties":{"on":{"type":"object","properties":{"field":{"type":"string","pattern":"^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+$"},"comparisonOperator":{"type":"string","enum":["EQUALS","IN"]},"not":{"type":"boolean"},"values":{"type":"array","maxItems":2000,"minItems":1,"items":{"type":"string"}}},"required":["comparisonOperator","field","not","values"]}},"required":["on"]}]}},"required":[]},"currencyOfView":{"type":"string","enum":["AED","ARS","AUD","AZN","BBD","BGN","BMD","BND","BRL","BSD","CAD","CHF","CLP","CNY","COP","CRC","CZK","DKK","DOP","EGP","EUR","GBP","GHS","GTQ","HKD","HUF","IDR","ILS","INR","JMD","JPY","KES","KRW","KYD","KZT","LBP","LKR","MAD","MUR","MXN","MYR","NAD","NGN","NOK","NZD","PAB","PEN","PHP","PKR","PLN","QAR","RON","RUB","SAR","SEK","SGD","THB","TRY","TTD","TWD","TZS","USD","UYU","VND","XAF","XCD","XOF","XPF","ZAR"]}},"required":["format","periods","query"]}},"accessRequestedAccounts":{"type":"array","maxItems":2000,"minItems":1,"items":{"oneOf":[{"type":"object","properties":{"advertiserAccountId":{"type":"string"}},"required":["advertiserAccountId"]},{"type":"object","properties":{"managerAccountId":{"type":"string"}},"required":["managerAccountId"]}]}}},"required":["accessRequestedAccounts","reports"]}}}}}},"tags":["reporting"]}],"path":"/en-us/mcp/reporting#tag/reporting/operation/create_product_report","sectionHeader":{"type":3,"text":"POST /mcp/create_product_report"},"documentType":"api-reference"},{"title":"terms_token","content":["MCP tools related to terms_token\n"],"path":"/en-us/mcp/terms-token","sectionHeader":{"type":2,"text":"terms_token"},"documentType":"api-reference"},{"title":"terms_token","content":["/mcp/create_terms_token",{"operationId":"create_terms_token","description":"Create a new UUID terms token for the customer to accept advertising terms.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"termsType":{"type":"string","description":"Type of terms and conditions for different Amazon advertising platforms.","enum":["ADSP","ADVERTISING","MARKETING_CLOUD","PARTNER_NETWORK"]},"accountId":{"type":"string","description":"Optional. A global advertising account ID (amzn1.ads-account.g.*) or manager account ID (amzn1.ads1.ma1.*) to associate with the terms token. When provided, the caller must have admin access to the account and termsType must be ADVERTISING. Allowlisted clients with accountId will have terms auto-accepted."}}}}}}}},"tags":["terms_token"]}],"path":"/en-us/mcp/terms-token#tag/terms_token/operation/create_terms_token","sectionHeader":{"type":3,"text":"POST /mcp/create_terms_token"},"documentType":"api-reference"},{"title":"terms_token","content":["/mcp/get_terms_token",{"operationId":"get_terms_token","description":"Get the terms token status for the customer.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pathParameters":{"type":"object","properties":{"termsToken":{"type":"string","description":"A Terms Token refers to an UUID token used for terms and conditions acceptance."}},"required":["termsToken"]}}}}}},"tags":["terms_token"]}],"path":"/en-us/mcp/terms-token#tag/terms_token/operation/get_terms_token","sectionHeader":{"type":3,"text":"POST /mcp/get_terms_token"},"documentType":"api-reference"},{"title":"test_accounts","content":["MCP tools related to test_accounts\n"],"path":"/en-us/mcp/test-accounts","sectionHeader":{"type":2,"text":"test_accounts"},"documentType":"api-reference"},{"title":"test_accounts","content":["/mcp/create_test_account",{"operationId":"create_test_account","description":"Submit an async test account creation request (e.g. { body: { accountType: \"VENDOR\", countryCode: \"US\" } }). Limit 1 per account type per marketplace. AUTHOR supported in all marketplaces; VENDOR only in US, CA, MX, BR, UK, DE, FR, ES, IT, JP. Returns a requestId — use test_accounts-get_test_accounts to check status.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accountType":{"type":"string","description":"Type of test account.","enum":["AUTHOR","VENDOR"]},"countryCode":{"type":"string","description":"Country code of the test account.","enum":["AE","AU","BE","BR","CA","DE","EG","ES","FR","IT","JP","MX","NL","PL","SA","SE","SG","TR","UK","US"]},"accountMetaData":{"type":"object","description":"Optional metadata for the account (e.g., vendorCode for VENDOR type)."}},"required":["accountType","countryCode"]}}}}}},"tags":["test_accounts"]}],"path":"/en-us/mcp/test-accounts#tag/test_accounts/operation/create_test_account","sectionHeader":{"type":3,"text":"POST /mcp/create_test_account"},"documentType":"api-reference"},{"title":"test_accounts","content":["/mcp/get_test_accounts",{"operationId":"get_test_accounts","description":"Get test account creation status and details. Pass requestId from a previous create call to check that request, or omit to list all test accounts for the current user.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"queryParameters":{"type":"object","properties":{"requestId":{"type":"string","description":"Request ID from a previous test account creation request."}}}}}}}},"tags":["test_accounts"]}],"path":"/en-us/mcp/test-accounts#tag/test_accounts/operation/get_test_accounts","sectionHeader":{"type":3,"text":"POST /mcp/get_test_accounts"},"documentType":"api-reference"},{"title":"user_invitation","content":["MCP tools related to user_invitation\n"],"path":"/en-us/mcp/user-invitation","sectionHeader":{"type":2,"text":"user_invitation"},"documentType":"api-reference"},{"title":"user_invitation","content":["/mcp/redeem",{"operationId":"redeem","description":"Redeem a user invitation to gain access to an advertising account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"invitationId":{"type":"string","description":"Identifier of the invitation to redeem"}},"required":["invitationId"]}}}}}},"tags":["user_invitation"]}],"path":"/en-us/mcp/user-invitation#tag/user_invitation/operation/redeem","sectionHeader":{"type":3,"text":"POST /mcp/redeem"},"documentType":"api-reference"},{"title":"user_invitation","content":["/mcp/get",{"operationId":"get","description":"Get details of a specific user invitation by its invitationId (e.g. { pathParameters: { invitationId: \"<id>\" } }). Use user_invitations-list first to obtain invitation IDs. Returns invitation state, permissionSet (role or custom permissions), invited user email, expiration, targetId (account), and termsTypes required before redemption.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pathParameters":{"type":"object","properties":{"invitationId":{"type":"string","description":"Identifier of the invitation to fetch"}},"required":["invitationId"]}}}}}},"tags":["user_invitation"]}],"path":"/en-us/mcp/user-invitation#tag/user_invitation/operation/get","sectionHeader":{"type":3,"text":"POST /mcp/get"},"documentType":"api-reference"},{"title":"user_invitations","content":["MCP tools related to user_invitations\n"],"path":"/en-us/mcp/user-invitations","sectionHeader":{"type":2,"text":"user_invitations"},"documentType":"api-reference"},{"title":"user_invitations","content":["/mcp/create",{"operationId":"create","description":"Create user invitations for an advertising account. Pass accessRequestedAccount in the body to specify the account. Each invitation needs a user (emailAddress + userName), permissionSet (type: ROLE or CUSTOM_PERMISSION_SET), and optionally countries. Max 50 per request. Invitations expire after 2 weeks.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","description":"The advertiser account to perform the operation on.","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}}},"notifyInvitedUsers":{"type":"boolean","description":"Indicates if an invitation email will be sent to the invited user. Default: false"},"userInvitationRequests":{"type":"array","description":"List of invitations to be sent to users.","items":{"type":"object","properties":{"user":{"type":"object","properties":{"emailAddress":{"type":"string","description":"Email address of the user to be invited"},"userName":{"type":"string","description":"Name of the user to be invited"}},"required":["emailAddress","userName"]},"countries":{"type":"array","description":"List of two-letter ISO 3166 country codes for the invitation.","items":{"type":"object","properties":{"countryCode":{"type":"string"}}}},"permissionSet":{"type":"object","properties":{"type":{"type":"string","description":"Type of permission set: ROLE or CUSTOM_PERMISSION_SET"},"role":{"type":"object","properties":{"name":{"type":"string"}}},"customPermissionSet":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}}}}}},"minItems":1,"maxItems":50}},"required":["userInvitationRequests"]}}}}}},"tags":["user_invitations"]}],"path":"/en-us/mcp/user-invitations#tag/user_invitations/operation/create","sectionHeader":{"type":3,"text":"POST /mcp/create"},"documentType":"api-reference"},{"title":"user_invitations","content":["/mcp/update",{"operationId":"update","description":"Update user invitations — revoke or resend. Pass accessRequestedAccount in the body to specify the account. Each update needs invitationId (from user_invitations-list) and state (REVOKED or RESENT). Max 50 per request.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","description":"The advertiser account to perform the operation on.","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}}},"notifyInvitedUsers":{"type":"boolean","description":"Indicates if an invitation email will be sent. Default: false"},"updates":{"type":"array","description":"List of updates to perform for invitations.","items":{"type":"object","properties":{"invitationId":{"type":"string","description":"Identifier of the invitation to update"},"state":{"type":"string","description":"State to change invitation to: REVOKED or RESENT"}},"required":["invitationId","state"]},"minItems":1,"maxItems":50}},"required":["updates"]}}}}}},"tags":["user_invitations"]}],"path":"/en-us/mcp/user-invitations#tag/user_invitations/operation/update","sectionHeader":{"type":3,"text":"POST /mcp/update"},"documentType":"api-reference"},{"title":"user_invitations","content":["/mcp/list",{"operationId":"list","description":"List all user invitations for an advertising account. Pass accessRequestedAccount in the body to specify the account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","description":"The advertiser account to perform the operation on.","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}}},"maxResults":{"type":"number","description":"Max results per page (1-50)","minimum":1,"maximum":50},"nextToken":{"type":"string","description":"Pagination token for next page"}}}}}}}},"tags":["user_invitations"]}],"path":"/en-us/mcp/user-invitations#tag/user_invitations/operation/list","sectionHeader":{"type":3,"text":"POST /mcp/list"},"documentType":"api-reference"},{"title":"user_permissions","content":["MCP tools related to user_permissions\n"],"path":"/en-us/mcp/user-permissions","sectionHeader":{"type":2,"text":"user_permissions"},"documentType":"api-reference"},{"title":"user_permissions","content":["/mcp/list_user_permissions",{"operationId":"list_user_permissions","description":"Query user permissions for a specific user on an advertising account. Pass accessRequestedAccount in the body to specify the account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","description":"The advertiser account to perform the operation on.","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}}},"userId":{"type":"string","description":"User ID for the request.","maxLength":150},"maxResults":{"type":"number","description":"Max results for pagination (1-100).","minimum":1,"maximum":100},"nextToken":{"type":"string","description":"Pagination token for next page."},"accessScopeFilter":{"type":"object","description":"Filter by access scope."},"countryCodesFilter":{"type":"object","description":"Filter by country codes."}},"required":["userId"]}}}}}},"tags":["user_permissions"]}],"path":"/en-us/mcp/user-permissions#tag/user_permissions/operation/list_user_permissions","sectionHeader":{"type":3,"text":"POST /mcp/list_user_permissions"},"documentType":"api-reference"},{"title":"user_permissions","content":["/mcp/delete_user_permissions",{"operationId":"delete_user_permissions","description":"Delete user permissions from an advertising account. Pass accessRequestedAccount in the body to specify the account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","description":"The advertiser account to perform the operation on.","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}}},"users":{"type":"array","description":"List of users to remove permissions for (1-200 items).","minItems":1,"maxItems":200,"items":{"type":"object"}}}}}}}}},"tags":["user_permissions"]}],"path":"/en-us/mcp/user-permissions#tag/user_permissions/operation/delete_user_permissions","sectionHeader":{"type":3,"text":"POST /mcp/delete_user_permissions"},"documentType":"api-reference"},{"title":"user_permissions","content":["/mcp/update_user_permissions",{"operationId":"update_user_permissions","description":"Update user permissions for an advertising account. Pass accessRequestedAccount in the body to specify the account. First call user_permissions-list_user_permissions to get the current permission object structure, then pass { body: { accessRequestedAccount: { advertiserAccountId: \"<id>\" }, userPermissions: [...] } } with the updated objects.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","description":"The advertiser account to perform the operation on.","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}}},"userPermissions":{"type":"array","description":"List of user permissions to update.","items":{"type":"object"}}}}}}}}},"tags":["user_permissions"]}],"path":"/en-us/mcp/user-permissions#tag/user_permissions/operation/update_user_permissions","sectionHeader":{"type":3,"text":"POST /mcp/update_user_permissions"},"documentType":"api-reference"},{"title":"user_roles","content":["MCP tools related to user_roles\n"],"path":"/en-us/mcp/user-roles","sectionHeader":{"type":2,"text":"user_roles"},"documentType":"api-reference"},{"title":"user_roles","content":["/mcp/list_user_roles",{"operationId":"list_user_roles","description":"Query roles for a specific user on an advertising account (e.g. { body: { accessRequestedAccount: { advertiserAccountId: \"<id>\" }, userId: \"<id>\" } }). Requires userId from users-list_users. Pass accessRequestedAccount in the body to specify the account. Returns role names and country scopes.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","description":"The advertiser account to perform the operation on.","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}}},"userId":{"type":"string","description":"User ID to query roles for. Obtain from users-list_users.","maxLength":150},"maxResults":{"type":"number","description":"Max results for pagination (1-100).","minimum":1,"maximum":100},"nextToken":{"type":"string","description":"Pagination token for next page."},"countryCodesFilter":{"type":"object","description":"Filter by country codes."}},"required":["userId"]}}}}}},"tags":["user_roles"]}],"path":"/en-us/mcp/user-roles#tag/user_roles/operation/list_user_roles","sectionHeader":{"type":3,"text":"POST /mcp/list_user_roles"},"documentType":"api-reference"},{"title":"users","content":["MCP tools related to users\n"],"path":"/en-us/mcp/users","sectionHeader":{"type":2,"text":"users"},"documentType":"api-reference"},{"title":"users","content":["/mcp/list_users",{"operationId":"list_users","description":"List users with access to an advertising account. Pass accessRequestedAccount in the body to specify the account. Returns userId and masked email for each user. Include maxResults/nextToken in body for pagination.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"accessRequestedAccount":{"type":"object","description":"The advertiser account to perform the operation on.","properties":{"advertiserAccountId":{"type":"string","description":"The identifier of an Amazon Ads Advertiser Account."}}},"maxResults":{"type":"number","description":"Max results for pagination (1-100).","minimum":1,"maximum":100},"nextToken":{"type":"string","description":"Pagination token for next page."},"accessScopeFilter":{"type":"object","description":"Filter by access scope."},"countryCodesFilter":{"type":"object","description":"Filter by country codes."}}}}}}}},"tags":["users"]}],"path":"/en-us/mcp/users#tag/users/operation/list_users","sectionHeader":{"type":3,"text":"POST /mcp/list_users"},"documentType":"api-reference"}],"toc-your-apps":[{"sectionHeader":null,"path":"/en-us/developer/overview","content":[" title: Your apps description: Landing page to display the logged-in user's Login with Amazon applications\n"," Authorization text:\n"],"documentType":"guide"},{"sectionHeader":null,"path":"/en-us/developer/dashboard","content":[" title: Dashboard description: Dashboard page date: 11/01/2023\n"," quickSight: tips:\n"],"documentType":"guide"}],"toc-support":[{"title":"Support","sectionHeader":null,"path":"/en-us/support/overview","content":[],"documentType":"guide"},{"title":"Support","sectionHeader":{"type":2,"text":"Amazon Ads API"},"path":"/en-us/support/overview","content":[" For support with onboarding to the Amazon Ads API, please contact our onboarding support team directly at ads-api-onboarding@amazon.com.\n"," For continuing API support, you can reach our support team directly at ads-api-support@amazon.com to access our Zendesk support platform.\n"," The API support team offers continuing support via the Help Center.\n"],"documentType":"guide"},{"title":"Support","sectionHeader":{"type":2,"text":"Amazon Ads bulk operations "},"path":"/en-us/support/overview","content":[" Support for bulk operations is handled through the Amazon Ads Support Center.\n"],"documentType":"guide"},{"title":"Support","sectionHeader":{"type":2,"text":"Amazon Marketing Cloud (AMC)"},"path":"/en-us/support/overview","content":[" For AMC product-related support, please:\n","Submit a ticket via the AMC Support page in Zendesk (Recommended method) \\* Or, reach out directly to the AMC support team at amc-support@amazon.com or support@marketingcloud.amazon\n"," For support for AMC in the Amazon Ads API, you can reach our API support team directly at ads-api-support@amazon.com.\n"],"documentType":"guide"},{"title":"Support","sectionHeader":{"type":2,"text":"Traffic Events API"},"path":"/en-us/support/overview","content":[" For Traffic Events API support please reach out to support@trafficevents.amazon.\n"],"documentType":"guide"},{"title":"Support","sectionHeader":{"type":2,"text":"Documentation support"},"path":"/en-us/support/overview","content":[" To report issues or offer suggestions on the documentation in the advanced tools center, open an issue in our GitHub repository.\n"],"documentType":"guide"},{"title":"Known issues","sectionHeader":null,"path":"/en-us/support/status","content":[" In the past, there has not been a dedicated location where advertisers or API integrators could look to get the current status of Amazon Ads services. During any service interruption, advertisers could only get that information after they log in to the advertising console or Amazon DSP. With the introduction of Amazon Ads Status, users can now view the current status of Amazon Ads services and be updated with the latest information during any potential service disruptions, without the need to log in to the advertising console or Amazon DSP.\n"],"documentType":"guide"},{"title":"Known issues","sectionHeader":{"type":2,"text":"Programmatic access to Amazon Ads Status"},"path":"/en-us/support/status","content":[" The ads status information can be accessed programmatically using https&#x3A;//status.ads.amazon.com/status.json, which returns Amazon Ads Status in JSON format. \n"," An empty status (indicated by \\[]) means there are no active alerts. If there are active alerts, you will see them listed within the status array, with separate items for region and category. You can refer to the JSON schema to understand the expected structure of each alert type.\n"],"documentType":"guide"},{"title":"Known issues","sectionHeader":{"type":2,"text":"Status history"},"path":"/en-us/support/status","content":[" Advertisers can also review communications and status updates shared by Amazon Ads spanning the past 6 months. The status history can be accessed programmatically using https&#x3A;//status.ads.amazon.com/history.json. \n"," You can refer to the JSON schema to understand the expected structure of the status history.\n"],"documentType":"guide"},{"title":"Known issues","sectionHeader":{"type":2,"text":"Language of preference"},"path":"/en-us/support/status","content":[" Translated status messages and history can be accessed programmatically by replacing en-US in the following URLs with the correct locale string for any of the languages available in the status console view:\n"],"documentType":"guide"},{"title":"Known issues","sectionHeader":null,"path":"/en-us/support/known-issues","content":[" This page lists known issues related to Amazon Ads advanced tools. Resolutions to known issues are posted in the Release notes.\n"],"documentType":"guide"},{"title":"Known issues","sectionHeader":{"type":2,"text":"Amazon Ads API"},"path":"/en-us/support/known-issues","content":[],"documentType":"guide"},{"title":"Known issues","sectionHeader":{"type":3,"text":"Sponsored Display targeting responses for `/sd/targets` will change after targets are deprecated"},"path":"/en-us/support/known-issues","content":[" When a Sponsored Display target has been deprecated, expect a change in the response.\n"," Instead of resolved expressions for GET /sd/targets returning:\n"," Resolved expressions will return:\n"," Workaround: None. These targets do not serve any impressions and should be archived.\n"],"documentType":"guide"},{"title":"Known issues","sectionHeader":{"type":3,"text":"Incomplete data retention for Sponsored Products reports in version 3"},"path":"/en-us/support/known-issues","content":[" The Sponsored Products campaigns, targeting, search term, advertised product, and purchased product reports allow users to request reports up to 95 days in the past. The request will succeed and return a report, however only data for the last 65 days is included. \n"," Workaround: None. The engineering team is working to support up to 95 days as stated in the documentation.\n"],"documentType":"guide"},{"title":"Known issues","sectionHeader":{"type":2,"text":"Amazon Marketing Stream"},"path":"/en-us/support/known-issues","content":[],"documentType":"guide"},{"title":"Known issues","sectionHeader":{"type":3,"text":"Amazon DSP [adsp-adgroup-targets](guides/amazon-marketing-stream/datasets/dsp-campaign-management#amazon-dsp-ad-group-targets-beta) dataset truncates some payloads"},"path":"/en-us/support/known-issues","content":[" There are three types of targets (audience, geolocation, and app) that can have documents that are too large to be written through Amazon Marketing Stream via SQS. This is due to the limitation of SQS message size to 256 KB, and does not impact targets in advertising systems in any way. We are working on an alternate solution to resolve the issue. This limitation impacts a small percentage of overall records, and in this version of the API we still send these records, but we will instead denote the fields have been truncated as PAYLOAD_TRUNCATED.\n"," Workaround: If you would like to retrieve this information in the interim, please call the geotargeting API, audiences targeting API, or the app targeting API to receive the documents in full.\n"],"documentType":"guide"},{"title":"Known issues","sectionHeader":{"type":3,"text":"Unknown records in `sp-conversion` dataset"},"path":"/en-us/support/known-issues","content":[" There is a known bug in Amazon Marketing Stream that may cause a small number of records from another ad product to show up in sp-conversion data without the corresponding records in sp-traffic data. We have confirmed such unwanted data is a very small percentage of the overall conversion records and should not cause any material impact to your analysis.\n"],"documentType":"guide"}],"toc-release-notes":[{"title":"Amazon Ads advanced tools release notes","sectionHeader":null,"path":"/en-us/release-notes/index","content":[" October 30, 2026\n"," Review Requests (beta) is now available through the Amazon Ads API in the United States.\n"," Review Requests helps brands gain authentic reviews from verified purchasers. A native \"How was your item?\" card on Amazon's highest-traffic pages invites a verified purchaser to write a review, and the advertiser pays only when a shopper leaves a rating or review. It gives new products a faster path to authentic reviews.\n"," With the API, advertisers can create and manage Review Requests campaigns, choose the products that ads run for, set a bid and daily budget, and measure results with five review-specific metrics: reviews, writtenReviews, ratingOnlyReviews, percentOfReviewsWritten, and averageStarRating.\n"," Available for products with fewer than 1,000 total reviews. To learn more, see Get started with Review Requests.\n"," October 5, 2026\n"," The new Reporting API (v1) can now return warning signals on a completed report. Warnings are non-fatal: the report still succeeds and the data is valid, but each warning summarizes, at the field level, a condition affecting that field's values in the report — such as values redacted because you are not permissioned to see the field for a requested account, or a field scheduled for a future deprecation. Once a report reaches a terminal state, the AdsApiv1RetrieveReport response (POST /adsApi/v1/retrieve/reports) includes a warnings array when there is something to report, and each entry identifies the field and one or more warningCodes. Treat warningCodes as an open-ended list, since more signals may be added over time.\n"," For the available signals, the response shape, and a per-signal breakdown, see Warning signals in the New features guide.\n"," October 1, 2026\n"," The communications preferences API is now in open beta. These endpoints let you manage how advertisers are contacted by Amazon Ads and what communications they receive, covering communication contacts and channel-level communication preferences.\n"," The open beta endpoints are:\n","Communication contacts: POST /communications/contacts, POST /communications/contacts/query - Communication preferences: POST /communications/preferences/query, POST /communications/preferences/update\n"," To get started, see the communications preferences developer guide.\n"," September 30, 2026\n"," Access complete advertising data two ways. Have it pushed continuously to your Amazon S3, or pull multi-dimensional reports ad hoc.\n"," What launched? Amazon Marketing Stream Version 2 (Stream v2) and the new Reporting API (v1) are now generally available. Together, they provide ongoing and ad-hoc programmatic access to Amazon Ads performance data. Stream v2 pushes complete advertising datasets to your Amazon S3 bucket as Apache Parquet files, with SQS notifications as each file lands. The Reporting API v1 lets you generate ad-hoc reports that combine dimensions, ad products, and accounts in a single request. Both surfaces share the same standardized metric names, definitions, and entity terminology across Amazon Ads products.\n"," Why is this important? Advertisers previously needed Amazon Marketing Stream Version 1 for hourly freshness and v3 reporting for completeness, which meant maintaining two pipelines and reconciling two data models. Stream v2 removes that tradeoff by delivering total metric values (not deltas), historical data for each dataset's restatement period, and updates as frequently as every 15 minutes. The data lands partitioned by dataset, granularity, and time window, so you query it directly with Amazon Athena, AWS Glue, or Amazon EMR, with no ETL pipeline to build. You can consolidate reporting pipelines and build workflows on the data the moment it lands.\n"," The Reporting API v1 is a new ad-hoc programmatic interface for accessing Amazon Ads performance data. It adds multi-dimensional reporting (combine dimensions like geography and technology in one report), cross-ad-product reporting, and cross-account reporting (a single report spanning all accounts you manage). Metrics are organized into three categories — Traffic, Engagement, and Conversion — with standardized names across all ad products. Conversion metrics are reported on traffic date (the date of ad interaction) rather than conversion date, aligning Amazon DSP with Sponsored Ads and industry best practices.\n"," Who can use it and where? Both surfaces are available to all integrated partners and advertisers worldwide. Stream v2 setup takes minutes using AWS CloudFormation or CDK. Two datasets are available at launch, with more planned:\n","Ads Performance Dataset (ads-performance-v1) — Approximately 400 metrics and 50 or more dimensions covering traffic delivery (impressions, clicks, viewability), engagement (video and audio interactions), costs and fees, and attributed conversions across Amazon Ads products. This dataset consolidates data previously available across multiple v3 report types (campaign, ad group, ad, advertised product, search term, targeting, placement, inventory, geography, and technology reports) into a single unified schema. Delivery frequency is as often as every 15 minutes. - Ads Converted Product Dataset (ads-converted-product-v1) — Approximately 170 conversion metrics at the ASIN level, including both directly promoted and halo products. Key dimensions include convertedProduct.id, convertedProductMarketplace.value, and productRelevance.value (promoted or halo). Use this dataset to measure the influence of ads on specific products, including related products not featured in the ad. Delivery frequency is every 4 to 6 hours.\n"," The Reporting API v1 standardizes terminology, metric naming, and definitions across all ad products. Key changes from v3 reporting include:\n","The Reporting API now follows the Amazon Ads API versioning convention (for example, v1), replacing the previous v3 and other legacy reporting endpoints. - Amazon DSP \"Order\" and Sponsored Ads \"Campaign\" are now unified as \"Campaign\". - Metrics are organized into three categories: Traffic, Engagement, and Conversion. - Conversion metrics drop interval suffixes (1d, 7d, 14d, 30d) and use the correct look-back for each campaign type automatically. - \"Promoted\" and \"Halo\" qualifiers replace legacy terms such as \"Brand Halo\" and \"Other SKU\". - The \"Total\" prefix in Amazon DSP metrics is removed; base metrics now include all conversions. - Off-Amazon conversion metrics are consistently prefixed with \"offAmazon\".\n"," API details: Stream v2 uses the Amazon Marketing Stream API to create subscriptions. You provide an S3 bucket and SQS queue, and Stream writes Parquet files partitioned by dataset, granularity, and time window. Each record carries the total value for its time window; when a record is restated, you receive it again with its new total, and you keep the highest streamBatch.version per record. You can combine any available dimensions in a single request without selecting a report type. The Reporting API v1 supports one concurrent report per advertiser, which allows advertisers to run approximately 100 reports per day based on average report run time.\n"," To get started, see the Amazon Marketing Stream v2 overview, the Get started guide, and the Reporting API v1 documentation.\n"," September 29, 2026\n"," The Inventory Management APIs are now generally available. These APIs provide unified programmatic access to Amazon Ads inventory-related data. As part of Amazon Ads API v1, it follows the common model and includes ability to handle resources across deals, labels, labelassociations, buyerseats, dealadvertiseraccess, dealadvertiseraccessentry, dealperformance, dealplanning, publisher, supplier, seller.\n"," The GA endpoints are:\n","Deals: POST /adsApi/v1/create/advertisingDeals, POST /adsApi/v1/update/advertisingDeals, POST /adsApi/v1/query/advertisingDeals - Labels: POST /adsApi/v1/query/labels, POST /adsApi/v1/query/labelObjectAssociations - Deal metrics: POST /adsApi/v1/query/dealPerformances, POST /adsApi/v1/query/dealAvailses, POST /adsApi/v1/query/dealPlanningMetrics - Buyer seats: POST /adsApi/v1/create/buyerSeats, GET /dsp/adsApi/v1/buyerSeats - Deal advertiser access: POST /adsApi/v1/create/dealAdvertiserAccesses, POST /adsApi/v1/retrieve/dealAdvertiserAccesses, POST /adsApi/v1/delete/dealAdvertiserAccesses - Deal advertiser access entries: POST /adsApi/v1/create/dealAdvertiserAccessEntries, POST /adsApi/v1/delete/dealAdvertiserAccessEntries, POST /adsApi/v1/query/dealAdvertiserAccessEntries - Publishers, sellers, suppliers: POST /adsApi/v1/query/publishers, POST /adsApi/v1/query/sellers, POST /adsApi/v1/query/suppliers\n"," Upcoming GA endpoints are:\n","Inventory groups: POST /adsApi/v1/create/inventoryGroups, POST /adsApi/v1/update/inventoryGroups, POST /adsApi/v1/query/inventoryGroups\n"," To get started, refer to the Inventory Management developer guide.\n"," September 29, 2026\n"," The Amazon Ads MCP Server now offers a Lite version, served from the /mcp/lite path. The Lite version exposes the same Amazon Ads capabilities as the Regular version through a compact three-tool interface (search_tools, describe_tools, and invoke_tool) instead of registering every operation as its own tool, keeping the model context small and predictable. This is useful for smaller-context models, cost-sensitive workloads, or clients that only need a handful of operations per session. For setup instructions, see Connecting to the Amazon Ads MCP Server (Lite).\n"," September 28, 2026\n"," The Events API now supports:\n","AREF_TOKEN in matchKeys for click-based attribution. Capture the aref value from the ad landing-page URL and send it with the timestamp recorded when the landing page was reached. - FIP in matchKeys for a plaintext IPv4 or IPv6 address. - deviceInfo.userAgent for the raw browser or app user-agent string captured at the time of the event, up to 512 characters.\n"," See the Events guide for the supported AREF_TOKEN format and limits.\n"," September 28, 2026\n","DSP_ADVERTISER_ACCOUNT (default) returns the DSP advertiser account ID. Existing reports are unchanged. - GLOBAL_ADVERTISER_ACCOUNT returns the global advertiser account ID and groups the advertiser's DSP accounts into a single row.\n"," For details and an example request, see DSP advertiser account identifiers.\n"," September 25, 2026\n"," Benchmarks are available in US, CA, MX, BR, AU, JP, IN, DE, FR, IT, ES, UK, NL, TR, SE, SA, UAE, and EG.\n"," Benchmark reporting helps you compare your brand's advertising performance against similar brands in your category.\n"," Instead of analyzing your metrics in isolation, benchmarks provide context by showing how peer brands perform on the same metrics.\n"," You can access benchmarks (25th, 50th, and 75th percentile) for the following metrics:\n","Add to cart rate - Add to cart rate (new to brand) - Add to cart rate (new to brand, promoted) - Add to cart rate (promoted) - Branded search rate - Completion rate (video ad) - Cost per branded search - Cost per completed view (video ad) - Cost per detail page view - Cost per detail page view (new to brand) - Cost per detail page view (new to brand, promoted) - Cost per detail page view (promoted) - Cost per purchase - Cost per purchase (new to brand) - Cost per purchase (new to brand, promoted) - Cost per purchase (promoted) - Cost per purchase from clicks - Cost per purchase from clicks (new to brand) - Cost per purchase from clicks (promoted) - CPC - CPM - CTR - Detail page view rate - Detail page view rate (new to brand) - Detail page view rate (new to brand, promoted) - Detail page view rate (promoted) - Percent of purchases new to brand - Percent of purchases new to brand (halo) - Percent of purchases new to brand (promoted) - Purchase rate - Purchase rate (combined) - Purchase rate (new to brand) - Purchase rate (new to brand, promoted) - Purchase rate (promoted) - ROAS - ROAS (new to brand) - ROAS (new to brand, promoted) - ROAS (promoted) - Long-term ROAS\n"," September 24, 2026\n"," Fire Tablet Lockscreen is the newest device ad placement to integrate with the Asset Based Creative (ABC) template already used by advertisers across desktop, mobile, and Alexa Home Screen. Managed Service advertisers can traffic ABC creatives to Fire Tablet Lockscreen through the standard ABC intake, and Amazon DSP self-service advertisers can select Fire Tablet Lockscreen as an eligible placement in the DSP Creative Gallery.\n"," Because ABC assembles the ad from standardized advertiser-supplied components — background image, logo, brand name, headline, and Call-to-Action — the same creative can now serve on Fire Tablet lockscreens in addition to existing surfaces, without producing bespoke lockscreen creatives. This launch supports click-to-URL destinations, with click-through opening in the Silk browser.\n"," September 23, 2026\n"," Sponsored Brands Collections is now available worldwide in the Unified Ads API and SB V4 API. Following the initial US launch, the feature has now rolled out to all marketplaces. Advertisers in every marketplace can now create and manage Sponsored Brands Collections ads through the standard campaign management endpoints.\n"," Sponsored Brands Collections lets advertisers promote multiple related products in a single ad unit. With AI-powered automatic collections, Amazon dynamically curates the most relevant products for each shopper, while manual collections allow advertisers to hand-pick their selection.\n"," Advertisers can choose between two collection types:\n","Automatic collections – Let Amazon AI dynamically group the most relevant products from their catalog into collections based on their keyword targets and shopper search queries. \\* Manual collections – Select 3-10 related products to feature in the ad. This ad type supports keyword or product targeting and gives full control over the products in the ad.\n"," API Endpoints\n"," Sponsored Brands Collections can be managed through the Amazon Ads Campaign Management API using the standard campaign management endpoints:\n","Create Ads: POST /adsApi/v1/create/ads \\* Update Ads: POST /adsApi/v1/update/ads\n"," September 22, 2026\n"," Built for the people who build the ads - join our new developer track at unBoxed 2026. Register today to access the keynote livestream and select video on-demand content, post-event. Register here.\n"," September 18, 2026\n"," Sponsored Brands has launched the ListMigrations API (POST /sb/v4/migrations/list) to help advertisers retrieve recommended replacement ads for Product Collection ads and track their migration status. Sponsored Brands collections replace the legacy Product Collection format with improved functionality and performance in the same high-visibility placements. Beginning February 2027, product collections will no longer be supported.\n"," For each eligible source ad, the API returns recommended MANUAL_COLLECTION and AUTO_COLLECTION replacement options along with the source ad details including campaign name, ad group name, and ASINs.\n"," For more information, see the Sponsored Brands API specification or Migrate from Product collections to Sponsored Brands collections.\n"," September 9, 2026\n"," You can now control whether performance data is included in your Sponsored Ads exports in bulk operations. In the export modal, under Include, the Performance data checkbox is selected by default so your file continues to include performance metrics as before.\n"," Uncheck the Performance data checkbox to leave performance metrics out of the exported file. Excluding performance data can make exports faster to generate and download, which is useful when you only need campaign structure and settings and don't require performance information.\n"," Availability: Worldwide\n"," September 9, 2026\n"," Every budget object in the response returns recurrenceTimePeriod set to LIFETIME.\n"," This operation is in open beta, and this is a breaking change under the open beta policy.\n"," To update your integration, refer to the Getting started with the Linear TV Incremental Reach API guide.\n"," August 31, 2026\n"," Amazon Ads has unified endpoints for Commitments, DealAdvertiserAccesses, DealAdvertiserAccessEntries, Labels, Inventory Groups, and BuyerSeats. At present the unified endpoint supports only Amazon_DSP adProduct. The URL of the endpoints has changed.\n"," The updated endpoints launched are:\n","GET /adsApi/v1/commitments - List commitments. 2. POST /adsApi/v1/create/commitments - Create commitments. 3. POST /adsApi/v1/query/commitments - Query commitments with filters. 4. POST /adsApi/v1/retrieve/commitments - Get commitments. 5. POST /adsApi/v1/update/commitments - Update commitments. 6. POST /adsApi/v1/retrieve/commitmentSpends - Retrieve commitment spend. 7. POST /adsApi/v1/create/dealAdvertiserAccesses - Create a deal advertiser access record with a strategy (ALLOW or BLOCK). 8. POST /adsApi/v1/retrieve/dealAdvertiserAccesses - Retrieve a deal advertiser access record by ID. 9. POST /adsApi/v1/delete/dealAdvertiserAccesses - Delete a deal advertiser access record and all associated entries. 10. POST /adsApi/v1/create/dealAdvertiserAccessEntries - Add advertisers to a deal advertiser access list. 11. POST /adsApi/v1/delete/dealAdvertiserAccessEntries - Remove advertisers from a deal advertiser access list. 12. POST /adsApi/v1/query/dealAdvertiserAccessEntries - Query advertiser entries for a deal advertiser access record. 13. POST /adsApi/v1/query/labels - Query labels with filters. 14. POST /adsApi/v1/create/buyerSeats - Create an advertiser seat. 15. GET /adsApi/v1/buyerSeats - Get list of seats based on filter provided. 16. POST /adsApi/v1/update/inventoryGroups - Update an inventory group. 17. POST /adsApi/v1/query/inventoryGroups - Query an inventory group. 18. POST /adsApi/v1/create/inventoryGroups - Create inventory groups. 19. POST /adsApi/v1/retrieve/inventoryGroups - Retrieve inventory groups by ID.\n"," To get started, refer to the Inventory Management developer guide.\n"," August 31, 2026\n"," Amazon Ads has launched the Recommendations API, a single interface for retrieving recommendations across ad products.\n"," Regardless of which ad product a recommendation relates to, the response conforms to a single, standardized recommendation model. Each recommendation includes a unique identifier for tracking, a recommended action, and insights explaining why the advertiser is receiving the recommendation. This eliminates the need to integrate with separate product-specific recommendation APIs.\n"," The API endpoints launched are:\n","GET /adsApi/v1/list/recommendations: Retrieve a list of pre-computed recommendations filtered by query parameters such as language, adProduct, recommendationType, and maxResults. Optimized for low-latency, high-volume retrieval. 2. POST /adsApi/v1/query/recommendations: Retrieve recommendations matching a structured query specification, with support for universal filters and type-specific scoping. Supports both discovery mode (returning all recommendation types currently eligible for your account) and scoped mode (targeting specific recommendation types).\n"," To get started, refer to the Recommendations API overview and How to call the Recommendations API developer guides.\n"," August 31, 2026\n"," You can now limit a Sponsored Ads export to specific campaigns. In the Download Campaigns modal, select Export specific campaigns only under Campaign filter, then search for and select the campaigns you want to include. Each campaign in the list is labeled with its ad type, and you can use Select all or Clear all to adjust your selection quickly. Filtering to specific campaigns keeps exported files smaller and faster to download, which is especially useful for accounts with many campaigns.\n"," Select at least one campaign when the filter is turned on. If you turn on Export specific campaigns only without selecting any campaigns, your exported file will not contain any campaign data. To export all of your campaigns, leave the checkbox cleared. Archived campaigns are not available in the campaign filter.\n"," Availability: Worldwide\n"," August 27, 2026\n"," A new read-only Creative Association Status column is now available for creative associations in Amazon DSP bulk operations. This column displays the approval status of each ad creative association, so you can review the status directly in your downloaded file instead of checking it in the UI. The column is auto-populated on download and is informational only — any edits to this column are ignored on upload.\n"," Availability: Worldwide\n"," To learn more, see the DSP bulk operations entities reference.\n"," August 26, 2026\n"," Fourteen new metrics are now available in Unified Reporting.\n"," The Branded searches (new to brand) and Brand store page views (new to brand) metric families report branded search and brand store page view activity from customers who are new to brand, including counts from clicks and views, rates, and cost per event in both native and converted currency:\n","metric.newToBrandBrandedSearches, metric.newToBrandBrandedSearchesFromClicks, metric.newToBrandBrandedSearchesFromViews, metric.newToBrandBrandedSearchRate, metric.costPerNewToBrandBrandedSearch, and metric.costPerNewToBrandBrandedSearchConverted - metric.newToBrandBrandStorePageViews, metric.newToBrandBrandStorePageViewsFromClicks, metric.newToBrandBrandStorePageViewsFromViews, metric.newToBrandBrandStorePageViewRate, metric.costPerNewToBrandBrandStorePageView, and metric.costPerNewToBrandBrandStorePageViewConverted\n"," The Third-party fees metric family adds metric.thirdPartyPrebidFeesAdelaide and metric.thirdPartyPrebidFeesAdelaideConverted, which report the third-party prebid fees for using Adelaide.\n"," In addition, data retention for the date.value, week.value, day.value, and dayOfWeek.value time dimensions has been extended from 15 months to 24 months. Maximum report date ranges are unchanged. For details, see Dates and historical data retention.\n"," August 24, 2026\n"," The spPromptAdExtension and spVideoAdExtension report types in version 3 of the reporting API now support four additional columns for Sponsored Products:\n","portfolioName - the name of the portfolio associated with the campaign. 2. campaignBudgetCurrencyCode - the currency code associated with the campaign. 3. purchaseClickRate7d - rate of ad-attributed purchase events relative to ad clicks within 7 days. 4. purchaseClickRate14d - rate of ad-attributed purchase events relative to ad clicks within 14 days.\n"," These columns bring both report types to parity with other Sponsored Products report types. Existing columns and report behavior are unchanged, and requests that do not ask for the new columns are unaffected.\n"," Availability: United States.\n"," For the full column lists and sample requests, see the Prompt Ad Extension reports and Video Ad Extension reports documentation.\n"," August 24, 2026\n"," This update applies to templates you download for Amazon DSP bulk operations. When you download a template, its editable columns now validate your entries directly in Excel as you fill them in. Previously these rules only appeared as informational prompts, so a value that was out of range, too long, or in the wrong format looked fine until your upload was processed.\n"," Now the template enforces the same rules up front:\n","Typing shows a pop-up. When you type a value that is out of range, too long, or in the wrong format, Excel stops the entry and shows a pop-up explaining what is expected. - Pasting turns the cell red. Pasted values skip the typing check, so any pasted value that does not meet a column's requirements turns the cell red, making it easy to find and fix before you upload.\n"," Catching these issues while you build the template means fewer errors surface at upload time, so you can complete your bulk changes with fewer round trips.\n"," To learn more, see the DSP bulk operations entities reference.\n"," August 13, 2026\n"," You can now preview your bulk operations files directly on the dashboard—no download needed. Previously, you had to download a file to see its contents.\n"," From the requests table, open a preview of your original uploaded file or its error report to quickly review your entries or see what needs to be fixed—all without leaving the page. If a file is too large to preview, it downloads automatically so you always have a way to access your data.\n"," To learn more, see the bulk operations overview.\n"," August 12, 2026\n"," The Manager Account API is now generally available. These endpoints enable programmatic creation, querying, and updating of manager accounts, which advertisers and agencies use to link and manage multiple advertising accounts from a single dashboard. Previously available in closed beta, these endpoints are now open to all Amazon Ads API customers with an approved LwA client.\n"," Key capabilities:\n","Create manager accounts programmatically via batch request. - Query manager accounts with support for searching by customer ID, filtering by account ID, and paginated responses. - Update manager account details, including business details such as name, address, and phone.\n"," Endpoints:\n","POST /adsApi/v1/create/managerAccounts: Create one or more manager accounts - POST /adsApi/v1/update/managerAccounts: Update one or more manager accounts - POST /adsApi/v1/query/managerAccounts: Query manager accounts by user or by ID\n"," To get started, see the Manager Account API developer guide.\n"," August 10, 2026\n"," A new Comments column is now available for orders in Amazon DSP bulk operations. Use this free-text field to add a note to an order — for example, internal context or a brief description. You can set the value when creating an order and edit it on update. The Comments value accepts up to 1,000 characters.\n"," Availability: Worldwide\n"," To learn more, see the DSP bulk operations entities reference.\n"," August 9, 2026\n"," Documentation is now available for auto-assembled videos in Sponsored Products. Auto-assembled videos are video creative that Amazon generates and attaches to existing Sponsored Products ads on behalf of the advertiser.\n"," The new guide covers:\n","Opt out of auto-assembled videos at the campaign level with POST /adsApi/v1/update/campaigns and the optOuts.videoExtension field. - Query campaign opt-out status with POST /adsApi/v1/query/campaigns. - Identify auto-assembled video extensions in the POST /adsApi/v1/query/adExtensions response by checking adExtensionSettings.videoExtension.videoType.\n"," To get started, see the auto-assembled videos guide. Auto-assembled videos are available for advertisers selling in the United States.\n"," August 7, 2026\n"," The Sponsored Products video ad extensions guides have been updated:\n","Documented the full multi-status response returned when you update ads and ad extensions. - Added account and asset eligibility prerequisites. - Added video engagement columns to the Video Ad Extension report. - Clarified that the ad extension is created asynchronously after you send spotlightVideos, so a query may not return it immediately. - Added guidance for creating a new ad with video in a single call.\n"," To get started, see Create video ad extensions.\n"," August 4, 2026\n"," The Amazon Ads Proposal Management Unified APIs are now generally available. These APIs enable programmatic management of proposals across Amazon Owned and Operated (Amazon O&O) publishers (called \"Amazon Media\" in the UI), Amazon Publisher Direct (APD), Amazon Publisher Cloud (APC), and Netflix. Previously available in beta, these endpoints are now open to all Amazon Ads API customers.  The endpoints launched as GA are:\n","POST /adsApi/v1/create/supplierProposals - Create a proposal 2. POST /adsApi/v1/query/supplierProposals - Get list of proposals for an advertiser 3. POST /adsApi/v1/update/supplierProposals - Update existing supplier proposal 4. POST /adsApi/v1/create/supplierProposedDeals - Create a supplier proposed deal 5. POST /adsApi/v1/query/supplierProposedDeals - Query supplier proposed deals 6. POST /adsApi/v1/update/supplierProposedDeals - Update existing supplier proposed deal 7. POST /adsApi/v1/create/supplierProposedDealRevisions - Submit a proposal revision 8. POST /adsApi/v1/update/supplierProposedDealRevisions - Update a proposal revision 9. POST /adsApi/v1/query/supplierProposedDealHistoricalVersions - Get proposed deal history 10. POST /adsApi/v1/query/supplierPublishers - Get publisher of the supplier 11. POST /adsApi/v1/query/supplierTargetItems - Fetch supplier targeting items 12. POST /adsApi/v1/query/supplierAdProducts - Get supplier ad products 13. POST /adsApi/v1/create/supplierAdProductPrices - Get supplier ad product prices 14. POST /adsApi/v1/query/supplierProposalDestinations - Query supplier proposal destinations 15. POST /adsApi/v1/create/supplierProposedDealForecasts - Create a forecast for a proposed deal\n"," To get started, refer to the Proposal Management guide (see Overview section for onboarding details).\n"," August 3, 2026\n"," Documentation is now available for video ad extensions in Sponsored Products. A video ad extension attaches video creative to an ad that already exists, so campaigns, budgets, bids, and targeting remain unchanged. Video renders on eligible placements, and the same ad renders as a standard image everywhere else.\n"," The new guides cover the full workflow:\n","Attach video creative with POST /adsApi/v1/update/ads and the spotlightVideos settings. - Read extension state with POST /adsApi/v1/query/adExtensions. - Pause and resume video delivery with POST /adsApi/v1/update/adExtensions. - Prepare video assets, interpret creative review outcomes, and handle errors.\n"," To get started, see the ad extensions overview. Video ad extensions are available for advertisers selling in the United States.\n"," July 31, 2026\n"," Amazon Ads has unified endpoints for Proposals (including support for Netflix workflow), Publisher, Supplier, DealAvails, DealPerformance and DealPlanningMetrics. At present the unified endpoint supports only Amazon_DSP adProduct. The URL of the endpoints has changed.\n"," We have also released new endpoints for Seller.\n"," The new and updated endpoints launched are:\n","POST /adsApi/v1/query/dealAvailses - Query deal avails by advertising deal ID 2. POST /adsApi/v1/dealPerformances - Retrieve performance metrics for each specified deal 3. POST /adsApi/v1/dealPlanningMetricses - List deal planning metrics for specified deals 4. POST /adsApi/v1/query/publishers - Query Publishers whose inventory is available on Amazon DSP 5. POST /adsApi/v1/query/sellers - Query sellers that send inventory to Amazon DSP 6. POST /adsApi/v1/query/suppliers - Query suppliers that send advertising inventory to Amazon DSP 7. POST /adsApi/v1/create/supplierProposals - Create a proposal 8. POST /adsApi/v1/query/supplierProposals - Get list of proposals for an advertiser 9. POST /adsApi/v1/update/supplierProposals - Update existing supplier proposal 10. POST /adsApi/v1/create/supplierProposedDeals - Create a supplier proposed deal 11. POST /adsApi/v1/query/supplierProposedDeals - Query supplier proposed deals 12. POST /adsApi/v1/update/supplierProposedDeals - Update existing supplier proposed deal 13. POST /adsApi/v1/create/supplierProposedDealRevisions - Submit a proposal revision 14. POST /adsApi/v1/update/supplierProposedDealRevisions - Update a proposal revision 15. POST /adsApi/v1/query/supplierProposedDealHistoricalVersions - Get proposed deal history 16. POST /adsApi/v1/query/supplierPublishers - Get publisher of the supplier 17. POST /adsApi/v1/query/supplierTargetItems - Fetch supplier targeting items 18. POST /adsApi/v1/query/supplierAdProducts - Get supplier ad products to create a proposed deal 19. POST /adsApi/v1/create/supplierAdProductPrices - Get supplier ad products price 20. POST /adsApi/v1/query/supplierProposalDestinations - Query supplier proposal destinations (like Amazon Media or APD or APC) to create a proposal 21. POST /adsApi/v1/create/supplierProposedDealForecasts - Creates a forecast request for a proposed deal configuration\n"," We will be unifying other Inventory management endpoints on similar lines and will share the update by the end of each month.\n"," To get started, refer to the Inventory Management developer guide.\n"," July 30, 2026\n"," The read-only Deal Selection names column is now populated on export for Amazon DSP bulk operations. Each deal is shown in deal name (id) format, in the same order as the Deal selection column, so the two columns stay row-aligned. This makes it easier to understand which deal you are selecting and to quickly check that the media type aligns with the deal supply. The column is informational only and is ignored on upload.\n"," Availability: Worldwide\n"," To learn more, see the DSP bulk operations entities reference.\n"," July 30, 2026\n"," The bulk operations tracking table now shows more than your 200 most recent requests. Previously, the table was limited to your last 200 uploads and downloads, so older requests dropped off the list. You can now go further back into your bulksheet history to find past uploads and downloads.\n"," To learn more, see the bulk operations overview.\n"," July 28, 2026\n"," You can now upload up to five files in a single bulk upload for Amazon DSP and Sponsored ads bulksheets. Previously, you could upload only one file per interaction.\n"," Select up to five files in the upload modal and each file is submitted as its own upload, appearing as a separate row in the tracking table. This makes it easier to upload a set of files together without repeating the upload flow for each one.\n"," To learn more, see the bulk operations overview.\n"," July 27, 2026\n"," Documentation is now available for the spVideoAdExtension report type in version 3 of the reporting API. This report returns performance data for Sponsored Products ads that include video creative, broken down by individual video, along with video engagement metrics.\n"," The report type has been available since November 2025. This release note announces its documentation, not a change in availability or behavior.\n"," Availability: United States.\n"," Key capabilities: Group results by videoAdExtension to break performance down to the individual video. Identify each video with creativeExtensionId and videoType. Measure engagement with video5SecondViews and video5SecondViewRate alongside the standard Sponsored Products traffic, conversion, and sales columns.\n"," For full technical details, including the supported columns and a sample request, see the Video Ad Extension reports documentation.\n"," July 23, 2026\n"," We have launched the media plan API in closed beta, enabling advertisers and integrators to build media plans programmatically for Amazon DSP and sponsored advertising accounts. The API supports creating plans, submitting them for processing, and accessing outputs including audience sizing, audience insights, performance forecasts, traffic insights, and optimized budget allocations. It streamlines planning workflows so advertisers can build forward-looking plans, uncover audience opportunities, and make data-driven budget decisions.\n"," Availability: United States, Canada, Mexico, Brazil, Germany, Spain, France, Italy, United Kingdom, Sweden, Netherlands, Turkey, United Arab Emirates, Saudi Arabia, India, Japan, Australia.\n"," Who can use it: Vendors, agencies, managed service, self-service, authors, book publishers, enterprises, and manager accounts.\n"," Key capabilities: Full create, read, update, and delete support across media plans, marketing goals, and planning items; budget allocation optimization; audience opportunity definition with audience sizing; behavioral, demographic, and traffic insights alongside performance forecasts; and media plan exports for external analysis.\n"," For full technical details, see the media plan API documentation. To get started, contact your Amazon representative.\n"," July 21, 2026\n"," Reach and Frequency metrics (reach, houseHoldReach, frequencyAverage, householdFrequencyAverage) are not supported for DSP campaign reports when the creative groupBy is included. If your report request includes the creative dimension, these metrics will not be available in the report response.\n"," For full technical details, see the DSP campaign report documentation.\n"," July 21, 2026\n"," Three new skills are now available in the Amazon Ads MCP Skills Library:\n","Terms Token — guides agents through the advertising terms-of-service acceptance workflow required before the first account of an advertiser can be registered. - User Invitations — covers the full invitation lifecycle on advertising accounts, including creating, listing, revoking, resending, and redeeming invitations. - User Permissions — manages user access on advertising accounts, including listing users, viewing and updating granular permissions, checking role assignments, and removing user access.\n"," To learn more, see the MCP Skills Library.\n"," July 20, 2026\n"," The /dsp/advertisers, /dsp/advertisers/{advertiserId}, POST /adsAccounts, POST /adsAccounts/batch, GET /adsAccounts/{accountId}, and POST /adsAccounts/list endpoints are deprecated in favor of the advertiser accounts APIs: POST /adsApi/v1/create/advertiserAccounts for account creation and POST /adsApi/v1/query/advertiserAccounts for account retrieval and listing. Starting July 2026, all six endpoints return Warning: 299 deprecation headers and new client integrations are blocked. Beginning July 2027, requests to these endpoints will return HTTP 404 Not Found. See the deprecations page for full details.\n"," July 20, 2026\n"," Two new endpoints are now available in the Linked Accounts API: Update Account Links and Delete Account Links. Partners can now programmatically update permissions and marketplace restrictions on existing account links, or remove account links entirely. Both endpoints support bulk operations of up to 50 account links per request and operate at the global account level.\n"," To learn more, see the linked accounts developer guide.\n"," July 16, 2026\n"," You can now give your exported file a custom name when you download from bulk operations. When you start an export, an optional File name field lets you enter a name for the exported file. Naming your exports makes it easier to categorize and track downloads—so you can quickly tell one export apart from another without relying on system-generated file names. If you leave the field blank, the export uses the default file name as before.\n"," July 14, 2026\n"," The Marketing Mix Modeling (MMM) API and data feed now support all 21 Amazon Ads locales, up from 14. Newly added marketplaces are NL (The Netherlands), BE (Belgium), PL (Poland), SE (Sweden), TR (Turkey), EG (Egypt), and SG (Singapore).\n"," The full list of supported marketplaces is:\n","North America: United States, Canada, Mexico - South America: Brazil - Europe: United Kingdom, Germany, France, Italy, Spain, The Netherlands, Belgium, Poland, Sweden, Turkey - Middle East: United Arab Emirates, Saudi Arabia, Egypt - Asia Pacific: Japan, Australia, India, Singapore\n"," For more information, see the MMM overview.\n"," July 10, 2026\n"," The QueryAdvertiserAccount API now returns the businessDetails field only when a single global account ID is provided in the advertiserAccountIdFilter. When multiple global account IDs are provided, businessDetails is omitted from the response. To retrieve businessDetails for multiple accounts, call QueryAdvertiserAccount once per global account ID. For more information, see the QueryAdvertiserAccount developer guide.\n"," July 9, 2026\n"," Amazon Ads has unified Advertising Deal endpoints in Open Beta. At present the unified endpoint supports only Amazon_DSP adProduct. The URL of the endpoints changed.\n"," The updated ends points launched are: \n","POST /adsApi/v1/create/advertisingDeals - Create a deal.  2. POST /adsApi/v1/update/advertisingDeals - Update a deal.  3. POST /adsApi/v1/query/advertisingDeals - List all deals based on filters provided. \n"," We will be unifying all other Inventory and Proposal management endpoints on similar lines and will share the update by the end of each month.   To get started, refer to the Inventory Management developer guide.\n"," July 6, 2026\n"," The Amazon Ads MCP Server now supports OAuth 2.1. With OAuth 2.1, your MCP client handles token retrieval automatically through a browser-based login flow - you do not need to manage access tokens in your configuration file. OAuth 2.1 is supported for Kiro CLI, Claude Code, Claude Desktop, and ChatGPT. For setup instructions, see Connecting to the Ads MCP Server using OAuth 2.1.\n"," July 6, 2026\n"," Sponsored Brands multi-ad group bulksheets now support two new ad entity types: Manual Collection ad and Auto Collection ad. Learn more in the Sponsored Brands multi-ad group bulksheets overview.\n","Manual Collection ad — Select 3–10 products from your catalog to feature in a single collection ad. You can optionally provide a custom title (max 32 characters) or let Amazon auto-generate one. \\* Auto Collection ad — Let Amazon AI automatically select and group the most relevant products from your catalog based on your keyword targets and shopper search queries.\n"," New bulksheet columns:\n","|Column    |Applies to    |Description    |\n","\\|---    \\|---    \\|---    \\|\n","|Ad Title    |Manual Collection ad    |Optional title displayed on the collection ad creative (maximum 32 characters). Use this to communicate your brand message or highlight a product theme (e.g., \"Summer Essentials\" or \"Best Sellers\"). If left blank, Amazon will auto-generate a title based on the products in your collection.    |\n","|Product Exclusions    |Auto Collection ad    |Optional comma-separated list of product ASINs to exclude from the Amazon automatic product selection (maximum 1,000 ASINs). Use this to prevent specific products from appearing in the automatic curated collection.    |\n"," Product Collection Deprecation notice:\n"," The Product collection ad entity type is deprecated (Deprecation Notice). Existing Product collection campaigns will continue to function and can be edited, but new campaigns should use Manual Collection ad or Auto Collection ad instead.\n"," Resources:\n","Sponsored Brands multi-ad group bulksheets overview  Create Sponsored Brands multi-ad group campaigns  Examples: Sponsored Brands multi-ad group campaigns\n"," July 1, 2026\n"," You can now filter by ad group when downloading spreadsheets for Amazon DSP bulk operations in the DSP UI worldwide. This filter lets you limit the downloaded file to specific ad groups, making it easier to manage large DSP campaigns at scale. To learn more, see the DSP bulk operations overview.\n"," Availability: All\n"," July 1, 2026\n"," A new read-only Inventory group names column is now available for line items in Amazon DSP bulk operations. This column displays the names of the inventory groups targeted by each line item, making it easier to identify the targeted private marketplace inventory at a glance. The column is informational only and cannot be edited on upload.\n"," Availability: Worldwide\n"," To learn more, see the DSP bulk operations entities reference.\n"," June 30, 2026\n"," The UPPER_FUNNEL_PROSPECTING tactic is now available for campaigns that include Audio in the primaryInventoryTypes setting. Previously, no tactics were supported for Audio inventory. For more information, see Performance+ and Brand+ tactics.\n"," June 29, 2026\n"," The AccountLinkInvite API enables programmatic creation and management of account link invitations. Agencies and advertisers can now automate their account linking workflows with four new endpoints: Create, Update, Delete, and Query. Key capabilities include bulk operations of up to 50 invitations per request, optional restrictions for data sharing, and marketplace specific restrictions for sponsored ads.\n"," To learn more, see the account link invites user guide.\n"," June 25, 2026\n"," Amazon Ads has launched new unified endpoints to manage Labels, Deal Advertiser Access, and Amazon Publisher Cloud (APC) workflow support in Supplier Proposals APIs in Open Beta. \n"," The new and updated endpoints launched are: \n","POST /v1/create/dealAdvertiserAccesses/dsp - Create a deal advertiser access record with a strategy (ALLOW or BLOCK).  2. POST /v1/retrieve/dealAdvertiserAccesses/dsp - Retrieve a deal advertiser access record by ID.  3. POST /v1/delete/dealAdvertiserAccesses/dsp - Delete a deal advertiser access record and all associated entries.  4. POST /v1/create/dealAdvertiserAccessEntries/dsp - Add advertisers to a deal advertiser access list.  5. POST /v1/delete/dealAdvertiserAccessEntries/dsp - Remove advertisers from a deal advertiser access list.  6. POST /v1/query/dealAdvertiserAccessEntries/dsp - Query advertiser entries for a deal advertiser access record.  7. POST /v1/query/labels/dsp - Query labels with filters. Returns labels that have associations of the specified object type and are visible to the entity of the caller.  8. POST /adsApi/v1/query/supplierPublishers/dsp - Get publisher of the supplier (with APC workflow).  9. POST /adsApi/v1/query/supplierTargetItems/dsp - Fetch supplier targeting items (with APC workflow).  10. POST /adsApi/v1/update/supplierProposedDealRevisions/dsp - Update a proposal revision (with APC workflow).  11. POST /adsApi/v1/create/supplierProposedDealRevisions/dsp - Submit a proposal revision (with APC workflow).  12. POST /adsApi/v1/query/supplierProposedDealHistoricalVersions/dsp - Get proposed deal history (with APC workflow).  13. POST /adsApi/v1/create/supplierProposedDeals/dsp - Create a supplier proposed deal (with APC workflow).  14. POST /adsApi/v1/query/supplierProposedDeals/dsp - Get a supplier proposed deal (with APC workflow).  15. POST /adsApi/v1/update/supplierProposedDeals/dsp - Update an existing supplier proposed deal (with APC workflow).  16. POST /adsApi/v1/query/supplierAdProducts/dsp - Get supplier ad products to create a proposed deal (with APC workflow).  17. POST /adsApi/v1/query/supplierProposalDestinations/dsp - Query supplier proposal destinations (with APC workflow).\n"," To get started, refer to the Deals API developer guide.\n"," June 18, 2026\n"," The Advertiser Account Management APIs are now generally available. These APIs enable programmatic creation, querying, and updating of advertiser accounts across all ad products (Amazon DSP and Sponsored Ads) and countries. Previously available in closed beta, these endpoints are now open to all Amazon Ads API customers with an approved LwA client.\n","POST /adsApi/v1/create/advertiserAccounts: Register one or multiple advertiser accounts - POST /adsApi/v1/query/advertiserAccounts: Fetch account details for advertiser accounts - POST /adsApi/v1/update/advertiserAccounts: Update account details for advertiser accounts\n"," To get started, see the Account registration developer guide.\n"," June 11, 2026\n"," The DSP Campaign Management APIs now support the Audio ad group inventory type. Advertisers can programmatically create and manage audio campaigns alongside Display, Streaming TV, and Online Video inventory types.\n"," Getting started\n"," To get started on Audio, you need to have a campaign created. Then, create an ad group with inventory type set to AUDIO, and associate an AUDIO creative. See below for details.\n"," What is new for Audio:\n","Campaign Management: AUDIO is now a supported ad group inventory type for creating and managing campaigns via the DSP Campaign Management APIs. - Creative Management: The AUDIO ad creative format type can now be associated with the AUDIO Ad Experience. See Creative Management for details on creating and managing audio creatives. - Deals and Inventory Groups: The AUDIO inventory type is now available for deals and inventory group management. See Deal Management Overview. - Reporting: Audio reporting is now available, with engagement metrics for Audio Attention (audio ad).\n"," June 8, 2026\n"," A new column header Off-Amazon ad serving is now available in bulksheets for Sponsored Products campaigns. This column allows advertisers to update settings for ads served off amazon.\n"," Availability: US\n"," To learn more, see Get started with bulksheets for Sponsored Products.\n"," June 4, 2026\n"," We updated the Ad Library API to return structured media content for advertisements. The API response now includes a new contents field that provides typed content references, distinguishing between linked pages (product or brand pages) and media files (images, videos, and audio). This replaces the previous behavior where only screenshot URLs or product page links were returned via the contentUrls field.\n"," Previously, the API could only return screenshot images or product page links for ad creatives. Video and audio ad creatives that did not have a screenshot available would return no content at all. This update helps ensure that media files for video and audio ad creatives are returned correctly, improving the completeness and transparency of Ad Library data.\n"," Availability: Germany, Spain, France, Italy, Netherlands, Poland, Sweden, Belgium, Ireland.\n"," Key changes to the ListAds and GetAdsByID endpoints:\n","New contents field (array of Content objects, max 10 items) \\* Content is a union type with two variants:\n"," The existing contentUrls field is maintained for backward compatibility.\n"," Example response for a video ad:\n"," Example response for a product page link:\n"," For full technical details, see the Ad Library API documentation.\n"," June 3, 2026\n"," The DSP Bid Adjustments API now returns HTTP 423 ConcurrentModificationException when two or more mutating requests target the same rule or association in close succession. The error is marked retryable and supported SDK clients will retry it automatically. Previously, racing writes could surface as a 500 InternalServerException.\n"," To minimize 423 responses, serialize create, update, and delete calls against the same bidModifierRuleId or (advertiserId, adGroupId) association, and apply exponential backoff on retry. Note that mutating operations are not strongly consistent within a 5-minute window — a subsequent GET for the same rule or association may not reflect the change for up to 5 minutes. For details, see DSP bid adjustments rate and size limits.\n"," June 3, 2026\n"," A new dimension attribute deal.customDealName is now available in Unified Reporting. This field returns the custom name that a DSP buyer has assigned to a deal, enabling advertisers to identify deals by their own naming conventions in reports. The field requires deal.id and is available under the Deal dimension.\n"," May 29, 2026\n"," We have removed the daily limits for Amazon DSP bulksheets. Advertisers can now create and update orders, line items, and creative associations with DSP bulksheets without being constrained by the previous daily upload limits, making it easier to manage large DSP campaigns at scale. To learn more, see the DSP bulk operations overview.\n"," May 28, 2026\n"," Amazon Ads has launched new unified endpoints to manage Advertising Deals, Buyer Seats, Supplier Proposals (covering Amazon Publisher Direct workflow), and Inventory Groups (supporting deal eligibility controls).  \n"," The new and updated endpoints launched are: \n","POST /adsApi/v1/update/inventoryGroups/dsp - Update an inventory group (updated to support deals eligibility controls).  2. POST /adsApi/v1/query/inventoryGroups/dsp - Query an inventory group (updated to support deals eligibility controls).  3. POST /adsApi/v1/create/inventoryGroups/dsp - Create an inventory group (updated to support deals eligibility controls).  4. POST /adsApi/v1/retrieve/inventoryGroups/dsp - Retrieve an inventory group by ID (updated to support deals eligibility controls).  5. POST /adsApi/v1/create/buyerSeats/dsp - Create an advertiser seat.  6. GET /adsApi/v1/buyerSeats/dsp - Get list of seats based on filters provided.  7. POST /adsApi/v1/create/advertisingDeals/dsp - Create a deal.  8. POST /adsApi/v1/update/advertisingDeals/dsp - Update a deal.  9. POST /adsApi/v1/query/advertisingDeals/dsp - List all deals based on filters provided.  10. POST /adsApi/v1/query/suppliers/dsp - Get supplier details to create a proposal (with Amazon Publisher Direct workflow).  11. POST /adsApi/v1/query/supplierAdProducts/dsp - Get supplier ad products to create a proposed deal (with Amazon Publisher Direct workflow).  12. POST /adsApi/v1/create/supplierProposals/dsp - Create a proposal (with Amazon Publisher Direct workflow).  13. POST /adsApi/v1/query/supplierProposals/dsp - Get list of proposals for an advertiser (with Amazon Publisher Direct workflow).  14. POST /adsApi/v1/update/supplierProposals/dsp - Update existing supplier proposal (with Amazon Publisher Direct workflow).  15. POST /adsApi/v1/create/supplierProposedDeals/dsp - Create a supplier proposed deal (with Amazon Publisher Direct workflow).  16. POST /adsApi/v1/query/supplierProposedDeals/dsp - Get supplier proposed deal (with Amazon Publisher Direct workflow).  17. POST /adsApi/v1/update/supplierProposedDeals/dsp - Update existing supplier proposed deal (with Amazon Publisher Direct workflow).  18. POST /adsApi/v1/query/supplierProposedDealHistoricalVersions/dsp - Get proposed deal history (with Amazon Publisher Direct workflow).  19. POST /adsApi/v1/update/supplierProposedDealRevisions/dsp - Update a proposal revision (with Amazon Publisher Direct workflow).  20. POST /adsApi/v1/create/supplierProposedDealRevisions/dsp - Submit a proposal revision (with Amazon Publisher Direct workflow).  21. POST /adsApi/v1/query/supplierPublishers/dsp - Get publisher of the supplier (with Amazon Publisher Direct workflow). \n"," Upcoming endpoints are: \n","GET /adsApi/v1/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/query/dealAdvertiserAccessEntry/dsp - Fetch advertiser access to a deal.  2. GET /adsApi/v1/dealAdvertiserAccess/dsp / POST /adsApi/v1/query/dealAdvertiserAccess/dsp - Get access details of an advertiser for a deal.  3. POST /adsApi/v1/update/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/update/dealAdvertiserAccess/dsp - Update the advertiser access to a deal.  4. POST /adsApi/v1/delete/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/delete/dealAdvertiserAccess/dsp - Delete advertiser access.  5. Endpoints for Labels Management.  6. Updates to proposal APIs including Amazon Publisher Cloud (APC) workflow. \n"," To get started, refer to the Deals API developer guide.\n"," May 26, 2026\n"," Amazon Ads API has updated its refresh token expiration policy to enhance security and align with industry best practices. Effective July 30, 2026, refresh tokens issued on or after that date expire 365 days from the date of advertiser consent, requiring developers to plan for re-authorization in their applications. Refresh tokens issued before July 30, 2026 are not affected and continue to function as before. They remain valid until the advertiser revokes authorization or another invalidation condition occurs.\n"," Key Changes\n","Effective date: July 30, 2026  365-day expiration: Refresh tokens issued on or after July 30, 2026 expire 365 days from the date of advertiser consent  Fixed expiration: For affected tokens, the expiration date is fixed at consent time and is not extended by token usage or refresh activity  Re-authorization required: After expiration, the advertiser must grant consent again to restore access  Grandfathered tokens: Refresh tokens issued before July 30, 2026 are not subject to the 365-day expiration and remain valid as before\n"," Action Required\n"," Developers should update their applications to:\n","Track refresh token age from the date of advertiser consent for tokens issued on or after July 30, 2026 2. Proactively prompt advertisers to re-authorize before the 365-day expiration 3. Handle expired refresh token errors gracefully 4. Store consent date metadata alongside refresh tokens issued on or after July 30, 2026\n"," For detailed implementation guidance, see the Refresh Tokens documentation.\n"," May 19, 2026\n"," AMC workflow MCP tools and skill now support all AMC instances - no longer limited to those with AWS Clean Room collaboration enabled.\n"," May 18, 2026\n"," Benchmarks reporting is now generally available across all supported marketplaces (US, CA, MX, BR, AU, JP, IN, DE, FR, IT, ES, UK, NL, TR, SE, SA, UAE, EG). Previously in beta and limited to the US, benchmarks provide standardized performance comparisons against category peer brands, allowing advertisers to contextualize performance, evaluate optimization opportunities, and confidently invest with Amazon Ads.\n"," Benchmarks are available for the following metrics:\n","Percent of purchases new to brand 2. Purchase rate (new to brand) 3. Cost per purchase (new to brand) 4. Click-through rate (CTR) 5. Cost per click (CPC) 6. Completion rate (video) 7. Cost per completed view (video) 8. Cost per impressions (CPM)\n"," Benchmarks reports are available as crossProgramBenchmarks (Sponsored Ads) and dspBenchmarks (Amazon DSP) report types in the Reporting API.\n"," May 18, 2026\n"," Amazon DSP bulk operations documentation is now available on the Advertising developer portal. The new documentation covers:\n","Overview — How DSP bulk operations works and supported entity types  Get started — Step-by-step guide to downloading, editing, and uploading spreadsheets  Entities reference — Complete column reference for orders, line items, and creative associations  Create orders and line items — Guide for creating new orders and line items  Update orders and line items — Guide for updating existing orders and line items \\* FAQs — Frequently asked questions\n"," May 14, 2026\n"," Amazon Marketing Cloud (AMC) users can now leverage household-level insights for measurement and audience creation. With these fields, advertisers can analyze how media is consumed collectively across shared devices and screens within households, deduplicate reach at the household level, and build audiences based on household-level exposure patterns. Two new fields — household_id and household_size — have been added to the following AMC traffic tables:\n","amazon_live_traffic - dsp_clicks - dsp_impressions - dsp_impressions_by_matched_segments - dsp_impressions_by_user_segments - dsp_video_events_feed - dsp_views - sponsored_ads_traffic\n"," To get started, refer to the AMC datasources documentation and the Instructional query \"Open internet Amazon DSP household reach and performance\" available in the AMC use cases.\n"," May 7, 2026\n"," The Marketing Mix Modeling (MMM) data feed now includes a new NationalAsinEngagement.tsv.zip file. This file provides daily or weekly national engagement events per ASIN by country, including ASIN, country, and add to cart count. The file is available at country-level geographic granularity.\n"," For more information, see the MMM data feed documentation.\n"," May 4, 2026\n"," The Geographic Insights and Activation (GIA) API for Amazon DSP has graduated from open beta to general availability. This API lets advertisers discover and act on regional growth opportunities using Amazon first-party retail insights combined with their own geographic data.\n"," With GA, the API introduces a simplified workflow and updated endpoints. Location indexes now accept inline postal code data at creation time, replacing the separate location index version step. Smart locations are now created through the /create/geoLocations endpoint and attached to ad groups via the Campaign Management Targets API. The previous open-beta endpoints (/create/smartLocations, /update/smartLocations, /create/locationIndexVersions, /retrieve/locationIndexVersions) are deprecated.\n"," GA endpoints:\n","POST /adsApi/v1/create/locationIndexes: Create a location index with inline postal code data - POST /adsApi/v1/update/locationIndexes: Update location index data - POST /adsApi/v1/retrieve/locationIndexes: Retrieve location index by ID - GET /adsApi/v1/locationIndexes: List location indexes - POST /adsApi/v1/create/geoLocations: Create a geo location (smart location)\n"," To learn more, see the GIA developer guide and the API reference.\n"," May 1, 2026\n"," The Marketing Mix Modeling (MMM) API is now generally available. This API enables programmatic access to Amazon MMM data feed across 14 countries: US, CA, IT, ES, FR, DE, UK, MX, BR, JP, AU, UAE, IN, and KSA. Advertisers and their partners can seamlessly access the Amazon advertising and retail signals needed to derive accurate insights from their MMM solutions.\n"," Since the beta launch, the MMM API now includes new operations that give advertisers greater control over their brand group configurations and improved visibility into report status:\n","Create overrides for brand groups: POST /mmm/v1/brandGroupOverrides  Delete overrides for brand groups: POST /mmm/v1/brandGroupOverrides/delete  List overrides for brand groups: POST /mmm/v1/brandGroupOverrides/list  Retrieve the list of products in a brand group: GET /mmm/v1/brandGroups/{brandGroupId}/products  Retrieve the list of campaigns associated with the products in a brand group: GET /mmm/v1/brandGroups/{brandGroupId}/campaigns \\* List reports and their generation status: POST /mmm/v1/reports/list\n"," For full technical details, see the MMM API user guide and the technical specifications.\n"," April 30, 2026\n"," Amazon Ads has launched new unified endpoints to manage Deal Performance, Supplier Proposals (covering targeting in Amazon Owned and Operated workflow) & Inventory Groups.\n"," The new and updated endpoints launched are: \n","POST /adsApi/v1/query/dealPerformances/dsp - Get performance metrics for a deal per given filters.  2. POST /adsApi/v1/update/inventoryGroups/dsp - Update an inventory group. 3. POST /adsApi/v1/query/inventoryGroups/dsp - Query an inventory group.  4. POST /adsApi/v1/query/suppliers/dsp - Get supplier details to create a proposal (with Amazon Owned and Operated workflow only).  5. POST /adsApi/v1/query/supplierAdProducts/dsp - Get supplier ad products to create a proposed deal (with Amazon Owned and Operated workflow only; excluding product-based targeting).  6. POST /adsApi/v1/create/supplierProposals/dsp - Create a proposal (with Amazon Owned and Operated workflow only).  7. POST /adsApi/v1/query/supplierProposals/dsp - Get a list of proposals for an advertiser (with Amazon Owned and Operated workflow only).  8. POST /adsApi/v1/update/supplierProposals/dsp - Update existing supplier proposal (with Amazon Owned and Operated workflow only).  9. POST /adsApi/v1/create/supplierProposedDeals/dsp - Create supplier proposed deal (with Amazon Owned and Operated workflow only). 10. POST /adsApi/v1/query/supplierProposedDeals/dsp - Get supplier proposed deal (with Amazon Owned and Operated workflow only).  11. POST /adsApi/v1/update/supplierProposedDeals/dsp - Update existing supplier proposed deal (with Amazon Owned and Operated workflow only).  12. POST /adsApi/v1/query/supplierProposedDealHistoricalVersions/dsp - Get proposed deal history (with Amazon Owned and Operated workflow only).  13. POST /adsApi/v1/create/supplierProposedDealRevisions/dsp - Submit a proposal revision (with Amazon Owned and Operated workflow only).  14. POST /adsApi/v1/create/supplierAdProductPrices/dsp - Get supplier ad products price (with Amazon Owned and Operated workflow only).  15. POST /adsApi/v1/update/supplierProposedDealRevisions/dsp - Update a proposal revision (with Amazon Owned and Operated workflow only).  16. POST /adsApi/v1/create/supplierProposedDealForecasts/dsp - Create a forecast request for a proposed deal configuration. The forecast is returned in the response of the create request (with Amazon Owned and Operated workflow only). \n","POST /adsApi/v1/create/advertisingDeals/dsp - Create a deal.  2. POST /adsApi/v1/update/advertisingDeals/dsp - Update a deal.  3. POST /adsApi/v1/query/advertisingDeals/dsp - List all deals based on filters provided.  4. GET /adsApi/v1/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/query/dealAdvertiserAccessEntry/dsp - Fetch advertiser access to a deal.  5. GET /adsApi/v1/dealAdvertiserAccess/dsp / POST /adsApi/v1/query/dealAdvertiserAccess/dsp - Get access details of an advertiser for a deal.  6. POST /adsApi/v1/update/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/update/dealAdvertiserAccess/dsp - Update the advertiser access to a deal.  7. POST /adsApi/v1/delete/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/delete/dealAdvertiserAccess/dsp - Delete advertiser access.  8. Endpoints for Label & Seat Management.  9. POST /adsApi/v1/query/supplierPublishers/dsp - Get publisher of the supplier (with Amazon Publisher Direct (APD), Amazon Publisher Cloud (APC) supply support).  10. Updates to proposal APIs including targeting support and Amazon Publisher Direct (APD), Amazon Publisher Cloud (APC) supply support (where applicable). \n"," To get started, refer to the Deals API developer guide.\n"," April 28, 2026\n"," Amazon DSP bulksheets now support programmatic guaranteed (PG) ad groups worldwide. Advertisers can create and manage programmatic guaranteed line items using DSP bulksheets across all marketplaces where Amazon DSP operates, enabling them to manage guaranteed deals at scale alongside their other DSP campaigns. To learn more, see the DSP bulk operations overview.\n"," April 2, 2026\n"," We launched cross-account reach and frequency (R&F) reporting that allows advertisers to measure de-duplicated reach and frequency across multiple Amazon ads accounts with flexible time granularity options (daily, weekly, monthly, yearly, day of month, and custom time period reporting). Additionally, we launched manager account and cross-manager account frequency group R&F reporting to manage and monitor frequency across multiple accounts.\n"," Key benefits\n","Advertisers can measure total unique audience reach and frequency across Sponsored Ads (excludes Sponsored Product) and Amazon DSP investments in a single view for efficient budget allocation. \\* Advertisers can measure, monitor and manage frequency across their brand product portfolio, spanning across multiple accounts to avoid audience fatigue. \n"," Get Started: Learn more in the reporting API overview page (Betas tab). Refer to the metrics and dimensions guide for details on the R&F metrics and dimensions supported.\n"," March 27, 2026\n"," We have deprecated the Catch-Up Boost pacing feature in Amazon DSP in both UI and API. This legacy manual control, which allowed advertisers to increase delivery aggressiveness under “Even” pacing, was replaced by Dynamic Catchup in 2024. Dynamic Catchup automatically optimizes delivery based on real-time performance and no longer requires user input. API inputs on Catch-Up Boost field can continue to be set, but are ignored in ad delivery. Our UI removed this field on March 23, 2026.\n"," Dynamic Catchup - Key benefits\n","Runs automatically—no manual setup required  Adjusts daily based on under-delivery patterns  Improves smooth delivery and consistency across flights \\* Maximizes budget utilization without delivery volatility\n"," Impacted API Endpoints\n"," The Catch-Up Boost field is marked as deprecated in the following APIs:\n","Ad Groups:\n"," March 15, 2026\n"," Amazon Ads has launched simplified unified endpoints to manage Deals, Supplier Proposals & Inventory Groups.  \n"," The new Ads Inventory Management API provides unified programmatic access to Amazon Ads inventory related data. Part of Amazon Ads API v1, it follows the common model and includes:  \n","Ability to create, update & read deals, labels, manager account and advertiser seats, supplier proposals, supplier proposed deal, supplier proposal deal history, inventory groups  2. Ability to update, delete & read operations for deal access .  3. Ability to read supplier details, supplier ad products, supplier ad products price, supplier proposed deal forecast , supplier targeting, supplier publisher, exchange, deals eligible avails, deal performance and planning metrics.  4. Ability to create proposed deal revision \n"," The API endpoints launched are:\n","POST /adsApi/v1/create/inventoryGroup/dsp: Create an inventory group 2. POST /adsApi/v1/retrieve/inventoryGroup/dsp: Retrieve inventory groups at bulk 3. POST /adsApi/v1/query/dealPlanningMetrics/dsp: Get directional average metrics for the input deals 4. POST /adsApi/v1/query/dealAvails/dsp: Get deal avails details 5. POST /adsApi/v1/query/suppliertargetItem/dsp: Add the targeting constraints to the proposed deal within a supplier ad product (with Amazon owned and operated extensions only)\n"," Upcoming API endpoints are:\n","POST /adsApi/v1/create/advertisingDeals/dsp: Create a deal 2. POST /adsApi/v1/update/advertisingDeals/dsp: Update a deal 3. POST /adsApi/v1/query/advertisingDeals/dsp: List all deals based on filters provided 4. POST /adsApi/v1/query/dealPerformance/dsp: Get performance metrics for a deal per given filters 5. GET /adsApi/v1/exchange/dsp: List all exchanges 6. GET /adsApi/v1/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/query/dealAdvertiserAccessEntry/dsp: Fetch advertiser access to a deal 7. GET /adsApi/v1/dealAdvertiserAccess/dsp / POST /adsApi/v1/query/dealAdvertiserAccess/dsp: Get access details of an advertiser for a deal 8. POST /adsApi/v1/update/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/update/dealAdvertiserAccess/dsp: Update the advertiser access to a deal 9. POST /adsApi/v1/delete/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/delete/dealAdvertiserAccess/dsp: Delete advertiser access. 10. POST /adsApi/v1/update/inventoryGroup/dsp: Update an inventory group 11. POST /adsApi/v1/query/inventoryGroup/dsp: Query an inventory group 12. POST /adsApi/v1/query/supplierTargetDefinition/dsp: Get all targeting per product 13. POST /adsApi/v1/query/supplier/dsp: Get supplier details to create a proposal (with Amazon owned and operated extensions only) 14. POST /adsApi/v1/query/supplierPublisher/dsp: Get publisher of the supplier (with Amazon owned and operated extensions only) 15. POST /adsApi/v1/query/supplierAdProduct/dsp: Get supplier ad products to create a proposed deal (with Amazon owned and operated extensions only) 16. POST /adsApi/v1/create/supplierAdProductPrice/dsp: Get supplier ad products price (with Amazon owned and operated extensions only) 17. POST /adsApi/v1/create/supplierProposedDealForecast/dsp: Get forecast for the proposed deal (with Amazon owned and operated extensions only without targeting) 18. POST /adsApi/v1/create/supplierProposal/dsp: Create a proposal (with Amazon owned and operated extensions only) 19. POST /adsApi/v1/create/supplierProposedDealRevision/dsp: Submit a proposal revision (with Amazon owned and operated extensions only) 20. POST /adsApi/v1/query/supplierProposal/dsp: Get list of proposals for an advertiser (with Amazon owned and operated extensions only) 21. POST /adsApi/v1/query/supplierProposalHistoricalVersion/dsp: Get a proposal history (with Amazon owned and operated extensions only) 22. POST /adsApi/v1/retrieve/supplierProposedDealHistoricalVersion/dsp: Get proposed deal history (with Amazon owned and operated extensions only) 23. POST /adsApi/v1/query/supplierProposedDeal/dsp: Get supplier proposed deal (with Amazon owned and operated extensions only) 24. POST /adsApi/v1/update/supplierProposal/dsp: Update existing supplier proposal (with Amazon owned and operated extensions only) 25. POST /adsApi/v1/update/supplierProposedDeal/dsp: Update existing supplier proposed deal (with Amazon owned and operated extensions only) 26. Updates to proposal APIs including targeting support and Amazon Publisher Direct (APD), Amazon Publisher Cloud (APC) supply support.\n"," To get started, refer to the Deals API developer guide.\n"," February 18, 2026\n"," We are excited to announce the Open Beta launch of the Amazon Ads MCP Server, enabling external developers and advertising partners to build sophisticated AI agents with seamless access to Amazon Ads capabilities through the Model Context Protocol. The MCP Server provides standardized tools for Campaign Management, Reporting, and Account Management, eliminating the need for complex custom implementations while maintaining enterprise-grade security with fine-grained authorization controls.\n"," The Campaign Management tools offer comprehensive CRUD operations and introduce three sophisticated workflows that transform complex processes into single invocations. The single-shot campaign creation tool enables developers to create a complete advertisement—encompassing the campaign, ad group, ad, and targeting—in one call, eliminating what previously required five or more separate operations. Additional workflows streamline country expansion to new marketplaces and automate keyword harvesting from automatic to manual campaigns, allowing advertisers to refine their targeting strategies efficiently.\n"," The Reporting tools offer parity with the new reporting APIs launched in November 2025 to access advertising performance data. This interface enables custom report creation tailored to multi-dimensional, cross-ad product and cross -account reporting needs. The stream subscription tools offer tool capabilities for real-time or scheduled access to performance metrics.\n"," The Account Management tools provide comprehensive capabilities for managing user access and permissions across advertising accounts, enabling programmatic handling of the complete user invitation lifecycle. Developers can list, query, issue, redeem, and update user invitations, allowing automated onboarding workflows particularly valuable for agencies and service providers managing multiple client accounts.\n"," To get started with the Amazon Ads MCP Server, visit the Amazon Ads MCP overview.\n"," February 18, 2026\n"," The Brand Stores management API has graduated from beta to general availability. This API enables brands and advertisers to programmatically manage their Amazon Brand Stores at scale, providing two key capabilities: retrieve Brand Store page content and update product content and selection across Brand Stores pages, and submit store updates for moderation. With GA, the Brand Stores management API is production-ready for all Brand Store owners. Advertisers can use these APIs to automate Brand Store management and maintain product information freshness. These functionalities can be combined with Brand Home APIs to create a more efficient and streamlined management process for Brand Stores on Amazon. To learn more, see the Brand Stores management overview and the technical specifications.\n"," February 18, 2026\n"," We launched new dynamic reach and frequency (R&F) reporting capabilities for advertiser account, supply source and frequency group reporting breakdowns. This includes de-duplicated R&F across custom campaign sets within advertiser account, flexible time granularity options (daily, weekly, monthly, yearly, day of month, and custom time period reporting). Additionally, advertisers can measure de-duplicated R&F for a global account across the associated DSP and Sponsored ads (SA) advertiser accounts. This builds on our Nov 11, 2025 release, which introduced custom time period R&F reporting for past 15 months for Sponsored and DSP campaigns and ad groups.\n"," Learn more about reporting API in the reporting API overview page (Betas tab). Refer to the metrics and dimensions guide for details on the new frequency group dimension, exclusive user reach rate metric and the R&F metrics supported for advertiser account and supply source dimensions.\n"," February 18, 2026\n"," Amazon is launching Sponsored Brands Collections in Unified Ads API & SB V4 API - a new ad format that lets advertisers promote multiple related products in a single ad unit. With AI-powered automatic collections, Amazon dynamically curates the most relevant products for each shopper, while manual collections allow advertisers to hand-pick their selection. This feature is now available worldwide.\n"," Advertisers can choose between two collection types:\n","Automatic collections – Let Amazon AI dynamically group the most relevant products from their catalog into collections based on their keyword targets and shopper search queries. \\* Manual collections - Select 3-10 related products to feature in the ad. This ad type supports keyword or product targeting and gives full control over the products in the ad.\n"," Key benefits\n","Expand product discoverability: Advertisers can feature up to ten related products from their catalog, engaging shoppers in high visibility placements across the Amazon Store.  Branded shopping experience: Collections highlight key product details for quick evaluation and purchase and connect shoppers to branded experiences where they can explore more products from their catalog.  Scaled campaign creation and optimization: Automatic collections highlight to shoppers the best combination of products based on keyword targets and shopper queries without the need to manually setup and optimize multiple campaigns.\n"," API Endpoints\n"," Sponsored Brands Collections can be managed through the Amazon Ads Campaign Management API using the standard campaign management endpoints:\n","Create Ads: POST /adsApi/v1/create/ads \\* Update Ads: POST /adsApi/v1/update/ads\n"," January 27, 2026\n"," The follow suggestion APIs are deprecated and will be shutoff on June 2026:\n"," V2 Suggested Keyword Deprecations\n","/v2/asins/{asin}/suggested/keywords,   /v2/adGroups/{adGroupId}/suggested/keywords/extended,   /v2/adGroups/{adGroupId}/suggested/keywords, \\* /v2/asins/suggested/keywords\n"," Please use the /sp/targets/keywords/recommendations API instead.\n"," V2 Stores deprecation\n","/v2/stores is being deprecated and replaced with /brand/stores/v1/storePages/list\n"," January 27, 2026\n"," Date Extension Notice: We are extending the deprecation timeline from the previously announced February 2nd, 2026 to June 15th, 2026 to provide advertisers with additional time to adjust their campaigns.\n"," As we have introduced positive bid adjustments for Sponsored Brands TOP_OF_SEARCH placement on 6/17/2025, we are standardizing all Sponsored Brands (SB) placement groups to support only positive bid adjustments. This means that negative bid adjustment values for SB placements will not be supported starting June 15th, 2026. While existing campaigns with negative bid adjustments will continue to run with their current settings, no new negative adjustments will be accepted after this date. If you have any questions, please visit the Amazon Ads API Support page and create a ticket with the subject title: \"Sponsored Brands Negative Bid Adjustment Deprecation\".\n"," December 15, 2025\n"," For this open beta, DSP advertisers can adjust both advertiser-level and ad-group level brand suitability settings via the API. For more on advertiser-level brand suitability settings, see the new brandSafetyTierInheritedSettingDetails and brandSafetyCategoryInheritedSettingDetails setting in the DSP inherited settings API specs. For more information on ad-group level targeting, see the new BrandSafetyCategoryTarget setting in the campaign management API spec and the DSP targets API spec. Content Exclusion Categories is now live for Twitch, third-party web and mobile inventory, on Display and Video media types. For reporting details, see Brand suitability reports.\n"," December 1, 2025\n"," Today, we announce the completion of Amazon Marketing Stream campaign datasets mimicking the API model of the Campaign Management APIs. With this launch, customers will find it easier to consume both Sponsored Ads and ADSP campaign data instead of subscribing to two different ones. Customers will receive all their campaign data updates in a single stream mimicking the read operations of our Campaign Management APIs, reducing cognitive load and effort in mapping between API and Stream fields.\n"," To get started, please see our Campaign Management Overview section of Amazon Ads API v1 documentation.\n"," December 1, 2025\n"," If you transmit or make available to Amazon Ads any personal information, you must provide the country code for all data uploads globally. For data with a UK or EEA country code, you must also include a valid consent signal in addition to the country code.\n"," Country Code\n"," You must share a country code when passing customers' consented data to Amazon Ads. The country code is a 2-character string in the ISO 3166 format that indicates in which country the consent was given (for example, US, GB or DE).\n"," Consent Signal\n"," You can either use (i) the IAB European Transparency & Consent Framework (TCF) signal(s), (ii) Global Privacy Protocol (GPP) or (iii) Amazon Consent Signal, to communicate UK and EEA user privacy choices to Amazon Ads. \n"," For detailed consent requirements by product, see Amazon Ads consent signals in the Amazon Ads Support Centre - Before You Begin section.\n"," December 1, 2025\n"," We are excited to announce a significant improvement to Amazon DSP creative management capabilities as we introduce a new Global Creative workflow for 'Standard Display' creatives that eliminates the need to upload identical creatives multiple times for different marketplaces. There is no change to other creative types (Video, Audio, or Component Based, including ASIN-based creative templates).\n"," Global Creatives will allow advertisers with an Advertiser Account (beta) to define display creatives once per region instead of once per marketplace, wherever the creative language is supported. Both Standard Display and HTML5 Ad Experiences are supported. For other legacy DSP advertiser accounts, the marketplace field will no longer be required, but the creative may only be used with their existing marketplace and the creative language must be targetable from their marketplace. For more information see: Creative Management: Standard Display - Business Validation Rules\n"," December 1, 2025\n"," As we have introduced positive bid adjustments for Sponsored Brands TOP_OF_SEARCH placement on 6/17/2025,  we are standardizing all Sponsored Brands (SB) placement groups to support only positive bid adjustments. This means that negative bid adjustment values for SB placements will not be supported starting February 2nd, 2026. While existing campaigns with negative bid adjustments will continue to run with their current settings, no new negative adjustments will be accepted after this date. If you have any questions, please visit the Amazon Ads API Support page and create a ticket with the subject title: \"Sponsored Brands Negative Bid Adjustment Deprecation\".\n"," December 1, 2025\n"," Amazon Ads has launched a single Campaign Management API to unify campaign management into one set of APIs. Built from a common Amazon Ads data model, this API standardizes field and enum values across ad products and features, improves error handling, and helps resource consistency across Campaign, Ad Group, Target, and Ad objects. This API includes feature parity with the existing APIs. Previously, there were nearly 200 separate variations of create, read, update, and delete endpoints that will be reduced to 16 with this launch. Today, we announce the completion of Sponsored Products, Sponsored Brands, and Amazon DSP for worldwide general availability. All of our ad products will be available through the Amazon Ads Campaign Management API, and we will have Sponsored Display and Sponsored TV later this year.\n"," To get started, please see the Campaign Management Overview.\n"," November 17, 2025\n"," The PVC dataset, originally launched to open beta in May 2025, enables Prime Video Channel Partners to conduct detailed audience overlap analysis, activate AMC audiences for Amazon DSP and sponsored ads campaigns, and generate insights incorporating Channel viewership data. This dataset is available only for Amazon Prime Video Channel partners. To get started, subscribe to the Prime Video Channel Insights (PVC) paid feature in AMC.\n"," For more information, refer to the Amazon Prime Video Channel Insights tables.\n"," November 15, 2025\n"," For this open beta, DSP advertisers can adjust both advertiser-level and ad-group level brand suitability settings via the API. For more on advertiser-level brand suitability settings, see the new brandSafetyTierInheritedSettingDetails setting in the DSP inherited settings API specs. For more information on ad-group level targeting, see the new brandSafetyTierTarget setting in the campaign management API spec and the DSP targets API spec. For reporting details, see Brand suitability reports. This feature is already live for Twitch and now expanding to third-party web and mobile inventory. Currently, only Display and Video media types are supported. See the DSP brand safety and suitability roadmap.\n"," November 11, 2025\n"," Amazon Ads introduces new benchmarks, which are self-service insights that enable advertisers to evaluate brand category performance across different ad formats and campaign goals. Advertisers can use benchmarks to optimize current campaigns and plan their next strategic investments based on competitive insights. Through these new expanded capabilities including sophisticated peer brand matching and transparent methodology, advertisers can instantly understand what performance looks like in their category and make data-driven decisions about their advertising investments.\n"," Benchmarks reports will be available as new report types in the existing Offline Reporting API, with a new report for DSP (dspBenchmarks) and a separate new report for Sponsored Ads programs (crossProgramBenchmarks). The new report types will be available in the current Public Reporting API. Users can generate the new reports by passing Benchmarks specific parameters into the existing Reporting API they are familiar with.\n"," November 11, 2025\n"," The new reporting API, now available in open beta, provides programmatic access to Amazon Ads performance data. Part of Amazon Ads API v1, it follows the common model and includes:\n","Multi-dimensional Reporting: 'Report Types' are no longer required as in V3 API. Combine previously separate dimensions (for example, Geo x Technology) to create customized insights that match your business needs. - Cross-Ad Product Reporting: Create reports spanning different ad products and campaign types for a consolidated view of advertising performance that remains consistent as ad products evolve. - Cross-Account Reporting: Generate a single unified report across all accessible accounts, ideal for customers managing multiple ad accounts.\n"," This release also introduces standardized metric names, definitions, and terminology across ad products. Together, these enhancements provide greater data flexibility and a more unified reporting experience.\n"," Learn more in the reporting API overview page (Betas tab).\n"," October 31, 2025\n"," Amazon Marketing Cloud (AMC) on AWS Clean Rooms has launched open beta support for cross-region data collaboration, removing previous regional restrictions and enabling greater flexibility for global organizations. Customers can now collaborate with their partners by leveraging datasets stored in regions outside of their own, making it easier for advertisers, agencies, and third-party partners to bring their identity and event data to AMC collaborations.\n"," Key Enhancements:\n","Cross-region collaboration: Partner with organizations across different AWS regions without data movement constraints.  Upload event and identity data from any AWS Glue-supported region.  Write query results to any AWS S3-supported region. For more information, see Create membership using the AWS Clean Rooms console.\n"," October 26, 2025\n"," We have added new API capabilities that allow you to add and remove customer partners from existing Amazon Marketing Cloud (AMC) on AWS Clean Rooms collaborations without recreating the collaboration instance. These new endpoints allow you to change who can bring in data and/or receive results. This enhancement provides greater flexibility for multi-party collaborations, enabling you to adapt your data partnerships as your business needs evolve while maintaining seamless access to combined analytics and measurement capabilities.\n"," API Endpoints:\n","POST /amc/instances/{instanceId}/collaborations/{collaborationId}/acrCustomerPartners - DELETE /amc/instances/{instanceId}/collaborations/{collaborationId}/acrCustomerPartners/{acrCustomerPartnerId}\n"," For more information, refer to Adding or removing customer partners from the collaboration.\n"," October 21, 2025\n"," Amazon Live signals can now be queried in AMC for customers with US-based managed-service. These signals allow advertisers to evaluate their Amazon Live campaign performance with more flexibility and in the context of other Amazon Ads media campaigns, giving them a full-funnel view of their performance. Amazon Live signals can also be used for audience creation; these audiences can be activated to Amazon DSP (incurring a CPM fee) and select sponsored ads channels. \n"," To connect your Amazon Live media to your AMC instance, please reach out to your Amazon Ads representative. For more information on the AMC Amazon Live signals available, refer to Amazon Live traffic.\n"," October 21, 2025\n"," The Amazon Your Garage dataset, previously launched in USA (US) and Canada (CA), is now available for AMC Paid Features users in the United Kingdom (UK), Germany (DE), France (FR), Italy (IT), Spain (ES), Japan (JP), and Australia (AU). Amazon Your Garage is an Amazon Retail service that enables Amazon customers using Amazon websites in US, CA, UK, DE, FR, IT, ES, Netherlands (NL), Poland (PL), Sweden (SE), JP or AU to self-declare vehicle ownership and share that data within Amazon to expedite product discovery and configure service recommendations. AMC customers can utilize the Amazon Your Garage dataset for both measurement and audience queries within AMC.\n"," For more information, refer to Amazon Your Garage tables.\n"," October 15, 2025\n"," Amazon is launching a new Sponsored Brands feature, reserve share of voice, which enables advertisers to secure top-of-search (TOS) Sponsored Brands placements for branded keywords at a fixed, upfront price. By reserving branded keywords, advertisers ensure that their ad will appear on Sponsored Brands top of search placement for those branded queries most of the time. \n"," With this feature, brands can count on predictable presence to boost brand visibility on top of search and shoppers can engage with branded content matching their queries. The solution is fully self-service to give advertisers flexibility, autonomy, and transparency. The solution enables advertisers to receive recommendations for high traffic branded keywords, validate keywords, receive real-time pricing, launch and manage campaigns directly through the Advertising Console or API, and receive automated invoices. \n"," To get started, see the Reserve share of voice developer guide.\n"," October 15, 2025\n"," Our forecasting API for Amazon DSP has gone from open beta to GA. This API provides access to all real-time forecasts available from the ADSP Campaign Manager. For more information, see the technical specs.\n"," October 15, 2025\n"," For advertisers using Amazon DSP and Amazon Marketing Cloud (AMC), our Geographic Insights and Activation (GIA) feature empowers advertisers to uncover and act on regional growth opportunities using Amazon first-party retail insights and their own geographic signals. Through an intuitive map interface, advertisers can visualize their brand performance against category benchmarks across different regions. With one click, they can activate smart location groups that automatically adjust bids to reach customers in areas of opportunity, such as regions with low brand penetration. AMC users can combine their own geographic data with Amazon retail insights, creating custom strategies that align with their specific business goals.\n"," For advertisers, driving new-to-brand growth is vital for long-term success, but identifying and engaging new audiences effectively remains a significant challenge. Many brands lack the signal-driven insights needed to pinpoint untapped regions to reach these audiences at scale. GIA solves this challenge by combining robust retail insights from Amazon with geographic signals from advertisers. Whether breaking into new territories or strengthening presence in established markets, GIA provides the essential tools needed for advertisers to expand reach strategically and drive measurable business growth.\n"," API endpoints: \n","Create a new smart location optimization: POST /adsApi/v1/create/smartLocations - Update a existing smart location optimization: POST /adsApi/v1/update/smartLocations - Create a location index to use as a container for location optimization signal: POST /adsApi/v1/create/locationIndexes - Retrieves location index by ID: POST /adsApi/v1/retrieve/locationIndexes - Creates a versioned dataset with location optimization signal at postal code level: POST /adsApi/v1/create/locationIndexVersions - Retrieves a location index version by ID: POST /adsApi/v1/retrieve/locationIndexVersions\n"," October 14, 2025\n"," Amazon is updating its Sponsored Brands advertising campaign infrastructure, requiring advertisers to proactively migrate version 3 campaigns to version 4 by specific deadlines. Migrate campaigns with zero impressions and actively generating impressions. Advertisers must convert zero impressions campaigns created before October 2022 by October 30th, 2025, while campaigns with active impressions must complete migration by December 31st, 2025. To support this transition, advertisers can bulk migrate their campaigns through the Amazon Ad Console or Sponsored Brands migration API. For more information, see the legacy campaigns partner migration guide.\n"," October 1, 2025\n"," We have improved how branded searches are identified in attribution. Enhanced brand matching helps Amazon better recognize when shoppers are searching for advertiser products, helping to capture more accurate brand associations across all regions. Advertisers may notice new trends in their branded search metrics after this update. These improvements will be reflected in Amazon Marketing Cloud (AMC) standard attribution reporting, and will extend to custom analysis once updates are completed.\n"," October 1, 2025\n"," Goodreads is now available as a new supply source within Amazon DSP, expanding advertiser reach across Amazon Owned & Operated inventory in the U.S. All display creative formats are eligible to appear on Goodreads, encompassing Standard Display and Component-based creatives, including Responsive eCommerce, Asset-based, and Brand Store creatives. Self-service advertisers can access Goodreads inventory directly through the DSP ad console, where it is included as part of Amazon Owned & Operated Inventory.\n"," Advertising on Goodreads allows brands to reach millions of engaged U.S. readers, driving awareness and consideration. It offers a unique chance for brands to connect with an educated, discovery-oriented audience exploring diverse genres, from fiction to finance, technology, travel, wellness, and culinary arts, making it ideal for brands targeting high-intent audiences across multiple categories.\n"," Goodreads discovery and targeting are available through the following APIs:\n","Discovery Inventory Source Exchanges API \\* Targeting\n"," September 30, 2025\n"," Authors can now create and manage Sponsored Display campaigns through the Amazon Ads API. This expansion gives authors access to the full suite of Amazon advertising products, complementing existing Sponsored Products and Sponsored Brands capabilities. Authors can leverage Sponsored Display contextual and audience targeting options to reach relevant readers across Amazon properties, Twitch, IMDb, and third-party sites. With this launch, we have also added more Kindle-related metrics to our reports.\n"," September 30, 2025\n"," Amazon DSP now offers customizable flight names, enabling advertisers to better organize and track their campaign flights across the platform. This new feature allows you to assign custom names to flights, making it easier to manage complex, multi-flight campaigns and streamline reporting and budgeting workflows. This helps simplify campaign management by providing a clear way to identify and track specific flights. This enhancement is particularly valuable for agencies managing multiple clients and campaigns, enabling more efficient workflow organization and reporting processes. The feature is accessible through the following APIs:\n","Campaigns and Flights \\* Reporting\n"," September 29, 2025\n"," For this open beta, DSP advertisers can adjust both advertiser-level and ad-group level brand suitability settings via the API. For more on advertiser-level brand suitability settings, see the new brandSafetyTierInheritedSettingDetails setting in the DSP inherited settings API specs. For more information on ad-group level targeting, see the new brandSafetyTierTarget setting in the campaign management API spec and the DSP targets API spec. For reporting details, see Brand suitability reports. This feature is currently only available for Twitch inventory. Currently, only Display and Video media types are supported. See the DSP brand safety and suitability roadmap.\n"," September 26, 2025\n"," Amazon Ads announces the launch of Events API, enabling advertisers to send conversion events that occur outside of the Amazon ecosystem. Amazon Events API allows advertisers to send real-time or offline conversion event data via Server to Server integration. It can be used to send data directly from an advertiser server to Amazon Ads or from an advertiser-preferred Customer Data Platform (CDP). \n"," Events API enables advertisers to evaluate the effectiveness of their Amazon marketing campaigns regardless of the location of the conversion and utilize this information to drive campaign optimization. Events API can help strengthen performance and decrease cost per action (CPA) with more complete attribution, improved data reliability, and better optimized delivery. It also serves as a complementary method to Amazon Ad Tag (AAT) for sending website events as the browser-based tracking is susceptible to ad blockers, browser privacy settings, and cookie limitations. Events API, on the other hand, sends data directly from your server, bypassing these limitations and ensuring more reliable data collection. This leads to more accurate conversion tracking and better insights for campaign optimization. Additionally, the Events API allows you to send more user identifiers (like email and phone number) and information about the user journey. \n"," Events API will be available to self-serve Amazon DSP advertisers world-wide. Tracked conversions can be viewed and managed in the Amazon DSP console Events Manager page. To use the conversions for campaign measurement, conversions can be associated with orders using a new 'Off-Amazon conversions' widget when creating orders in the Amazon DSP console. Conversions signals will also be made available as seed information for audience building in the Amazon DSP console within Audiences. \n"," For full technical details, refer to the Events API specifications.\n"," September 26, 2025\n"," We have improved the DSP Bid Adjustments APIs, offering you more flexibility and control over your bidding strategies. Key updates: \n","Rule updating: You can now update existing bid adjustment rules using the UpdateBidAdjustmentRule operation. - Version tracking: Each rule update generates a new version ID, allowing you to track rule performance in BidAdjustments Reports. - Automatic migration: When a rule is updated, all associated adGroups automatically migrate to the new version, while the previous version becomes inactive. - Flexible retrieval: - AdGroup association management: Easily add or remove adGroup associations with the most recent rule version using association endpoints.\n"," These improvements help streamline bidding strategies and improve campaign performance. For implementation details and best practices, see the bid adjustment docs.\n"," September 25, 2025\n"," Amazon Marketing Stream campaign datasets have been released in closed beta. This release mimics the API model of the new Campaign Management APIs. With this launch, customers will find it easier to consume both sponsored ads and ADSP campaign data instead of subscribing to two different datasets. Customers will receive all their campaign data updates in a single stream mimicking the read operations of our Campaign Management APIs, reducing cognitive load and effort in mapping between API and Stream fields. To get started, contact your Amazon representative.\n"," September 25, 2025\n"," Today, we announce Amazon Marketing Stream campaign datasets in open beta, mimicking the API model of the new Campaign Management APIs. With this launch, customers will find it easier to consume both Sponsored Ads and ADSP campaign data instead of subscribing to two different ones. Customers will receive all their campaign data updates in a single stream mimicking the read operations of our Campaign Management APIs, reducing cognitive load and effort in mapping between API and Stream fields.\n"," To get started, please see our Campaign Management Overview section of Amazon Ads API v1 documentation.\n"," September 24, 2025\n"," Amazon DSP Commitments Hub provides customers with a centralized place to manage their spending agreements with publishers (commitments). These new tools simplify tracking pacing, automatically optimize campaign spend, and accelerate spend analysis.\n"," Commitments are available via console and API for all self-service advertisers in all markets where Amazon DSP operates. The Commitments API provides five key endpoints: \n","POST /adsApi/v1/create/commitments/dsp: Create new commitments - GET  /adsApi/v1/commitments/dsp: List all commitments - POST /adsApi/v1/retrieve/commitments/dsp: Get specific commitments by ID - POST /adsApi/v1/update/commitments/dsp: Update existing commitments - POST /adsApi/v1/retrieve/commitmentSpends/dsp: Get specific commitment spends by ID\n"," The Commitments API allows you to create and manage commitments with various properties including commitment name, committed spend amount, currency code, start and end dates, fulfillment level, and spend calculation mode. You can link commitments to entities, advertisers, campaigns, and deals, and track spend accrual across these relationships. \n"," For full technical details, please see the technical specification for the Commitments API.\n"," September 23, 2025\n"," Amazon Marketing Cloud now offers access to NCS CPG Insights Stream dataset for creation of custom audience segments based on modeled transactions at the household level. This dataset represents over 127 million US households and provides valuable insights for CPG advertisers. Leverage this table to reach customers who purchase competitor products in your category, or engage with the top-spending customers of your brand, and much more.\n"," To get started, see the NCS CPG Insights Stream dataset and Introduction to NCS audiences (AMC UI access required).\n"," September 23, 2025\n"," Amazon Marketing Cloud has added support for the IP address field across select datasets, enabling advertisers to improve measurement coverage in scenarios where primary identifiers are unavailable. This new field provides a privacy-safe way to extend reach, frequency, overlap, and attribution analysis by using IP address as a measurement-enhancing identifier subject to applicable regional availability, customer permissions, and policy safeguards.\n"," The IP address field is valuable as a measurement enhancer in scenarios where an additional identifier can expand analysis. By allowing advertisers to analyze impressions, clicks, and conversions that would otherwise lack a linking identifier, AMC helps deliver a more complete view of audience reach and campaign performance. When combined with existing identifiers, and time based constraints, IP address can enhance accuracy while maintaining compliance with privacy requirements. \n"," For more information, refer to Introduction to IP address in AMC (AMC UI access required).\n"," September 16, 2025\n"," Amazon Marketing Cloud (AMC) is now available to all advertisers running sponsored ads campaigns. Advertisers using Sponsored Products, Sponsored Display, Sponsored Brands, or Sponsored TV will now be able to instantly access AMC within minutes. \n"," AMC is a powerful clean room tool that enables advertisers to measure campaigns, uncover actionable insights, and build audiences with advertiser signals, campaign learnings, and the trillions of shopping, browsing, and streaming signals available through Amazon. Advertisers can leverage AMC capabilities in numerous ways to maximize their advertising effectiveness. Through AMC unique signals, flexible analytics, and seamless signal collaboration, advertisers can uncover and assess insights such as identifying their most loyal customers, creating custom audiences for remarketing, and analyzing the path to conversion to adjust media investments that attract more customers — and much more.\n"," To get started, either log into the Amazon ads console and select Amazon Marketing Cloud in the left navigation, or access via API by following the steps in Instant self-service access to AMC.\n"," September 13, 2025\n"," We have expanded online video (OLV) ads on Alexa from US to JP, MX, CA, UK, BR, IN, DE, IT, FR, and ES marketplaces. This expansion will provide advertisers an opportunity to expand their reach with incremental customers on Echo Show devices, while driving awareness and consideration for their brand, with a voice-enabled OLV placement.\n"," Note: A click is recorded when the customer engages, via touch or voice, on the auto-playing online video ad on the Alexa Home Screen to launch the video ad in the full screen view.\n"," August 27, 2025\n"," Amazon DSP now allows advertisers to share frequency groups between manager accounts, providing broader control over reach and frequency across their brand portfolio. This enhancement enables advertisers to manage frequency caps across different manager accounts while maintaining individual account control and visibility.\n"," Key endpoint updates in the API include:\n","ListFrequencyGroupsV1: Added frequencyGroups list parameter and entityName field - ListFrequencyGroupAdvertiserAssociationsV1: Added entityName and entityId attributes - ListFrequencyGroupCampaignAssociationsV1: Added entityName and entityId attributes\n"," For full technical details, see the specifications for the frequency groups and frequency group associations APIs.\n"," August 22, 2025\n"," Sponsored Brands introduces two new Amazon-built audiences to help advertisers re-engage with valuable shopper segments: \"Purchased brand product\" and \"Clicked or Added brand product to cart\". These audiences complement the existing \"New-to-brand shoppers\" audience, giving advertisers more options to optimize their campaigns through audience bid adjustments.\n"," Advertisers can utilize audience bid boosting on both new and existing Sponsored Brands campaigns. To assess the performance of their bid boosted audiences, advertisers can access the Audience Report through the SB API Reporting. \n"," To retrieve Amazon-built audiences, use the Discovery API ListTargetableEntities with the following parameters: adProduct=SPONSORED_BRANDS, targetTypeFilter=AUDIENCE, and pathsFilter = \\[\\[\"Audience Category\", \"Custom-built\", \"Product\"]]. The response will include the audienceId for these audiences, which can then be used with Sponsored Brands Campaign Management API to create or adjust the bids for the audience. Amazon-built audiences retrieved using these filters are usable only with AudienceSegmentType of BEHAVIOR_DYNAMIC when using the campaign management API. For full technical details, see our updated Sponsored Brands documentation.\n"," August 21, 2025\n"," We have expanded Responsive eCommerce on Alexa ads to FR, ES, IN, and BR. Now ADSP-Self Service buyers can include Alexa supply in their campaigns and deliver engaging Responsive eCommerce ads to new customers.\n"," August 7, 2025\n"," Amazon DSP has launched Performance+ Insights, a new feature that provides advertisers with detailed transparency into their machine learning-generated audience targeting through two key components: (1) Shopper Insights that reveal the behavioral patterns and characteristics of customers reached by automated targeting (such as \"premium sports shoes purchasers\" or \"enjoy sports content\") and (2) Time-to-Convert metrics that display the median time between ad interaction and the attributed conversion. \n"," The Performance+ Insights feature is important for marketers because it addresses a critical trust deficit by providing transparency into ML-generated audience composition and performance. By revealing detailed audience behavioral traits and conversion metrics, marketers gain visibility into previously \"black box\" targeting mechanisms, allowing them to validate that their ads are reaching relevant audiences and converting effectively.\n"," For more information about the new campaign insights API endpoint, view the technical specification.\n"," August 6, 2025\n"," Amazon has launched two new APIs that enable access to global brand identifiers through the Advertising API Gateway. Global Brand IDs streamline brand identification by reducing multiple marketplace-specific IDs into a single identifier, enabling consistent brand recognition across all marketplaces. This transforms the multi-marketplace IDs into a single identifier, such as Adidas going from 38 brand IDs to just a single global brand. The introduction of Brand status attributes allows customers to filter and interact with only valid, active brand information while eliminating duplicate or merged entries.\n"," Two new APIs are accessible through the Amazon Ads API:\n","QueryBrandAdvertiserAssociation API (POST /adsApi/v1/query/brandAdvertiserAssociations) is a paginated API that authorizes on Global Advertiser IDs and returns Global Brand IDs associated with Global Advertiser Account.  - RetrieveBrands API (POST /adsApi/v1/retrieve/brands) returns Global Brand IDs metadata, such as brand name, brand status, the list of websites and logos. The API accepts 100 brands in the request at a time.\n"," For more information, see the technical specification for the brand associations APIs.\n"," August 1, 2025\n"," Amazon Ads has launched a single Campaign Management API to unify campaign management into one set of APIs. Built from a common Amazon Ads data model, this API standardizes field and enum values across ad products and features, improves error handling, and helps resource consistency across Campaign, Ad Group, Target, and Ad objects. This API includes feature parity with the existing APIs. Previously, there were nearly 200 separate variations of create, read, update, and delete endpoints that will be reduced to 16 with this launch. \n"," Today, we announce the completion of Sponsored Products, Sponsored Brands, and Amazon DSP for worldwide general availability. All of our ad products will be available through the Amazon Ads Campaign Management API, including Sponsored Display and Sponsored TV later in 2025.\n"," To get started, please see the campaign management overview and the technical specification.\n"," July 29, 2025\n"," With the launch of Sponsored Product Ads on Amazon Global store, API advertisers can now drive more discoverability and improve sales internationally. In this launch phase, we enabled this capability for advertisers in US, UK, and Germany. Log into your seller account to learn more about Global Store. \n","Product Localization /products/localize  Sponsored Products Ads now extends its product localization capabilities to include GlobalStore products, allowing products to be mapped from a source marketplace to one or more target marketplaces. This enhancement enables advertisers to expand their reach across multiple marketplaces through both local and GlobalStore products. To support GlobalStore products, the API response includes additional fields:  Campaign Creation /global/productAds SP API or product ads now support the global store specific features for the Global campaign creation. Global Sponsored product ad creation API accepts the global store specific attribute globalStoreSetting where advertisers can provide the source catalog country of the offer being used for ads creation. Eligibility check of the products for campaign creation would be done using the catalogSourceCountryCode information provided using the globalStoreSetting under CountryAdSubjectSettings.  Global Bid Recommendation /sp/targets/bid/recommendations The Global Bid recommendations API now support the features of the bid recommendation for the Global Store listings. The Global Bid recommendation API for new Ad group supports a new attribute called products that takes the ASIN details along with its source country code. Bidding system uses the globalStoreSetting attribute and the catalogSourceCountryCode information to check the eligibility of the ASINs that are required for the bid recommendation. \\* Global Keyword Recommendation /sp/global/targets/keywords/recommendations The Global Keywords recommendation API now support the features of the keyword recommendation for the Global Store listings. The Global Keywords recommendation API for ASINs supports a new attribute called products that takes the ASIN details along with its source country code. Global Keywords recommendation system uses the globalStoreSetting attribute and the catalogSourceCountryCode information to get the bid suggestions for the keywords.\n"," July 28, 2025\n"," In September 2023, we launched frequency groups for self-service entities in the Amazon advertising console, enabling advertisers to set a frequency cap across multiple orders. With this launch, we are expanding frequency groups to the Amazon DSP Public API, so advertisers can easily create and update frequency groups via the Amazon Ads API.\n"," Brands need broader frequency capping controls to limit the number of times a unique user is exposed to their brands across multiple orders in Amazon DSP, as users could be overexposed to ads when different orders target similar or overlapping audiences. With Hybrid Frequency Caps, advertisers can better manage frequency across their brand portfolio while optimizing campaign performance, such as setting streaming TV frequency caps across specific brands by selecting only streaming TV orders within their frequency groups, helping prevent ad overexposure and maximize budget efficiency, with advertisers seeing an average 6% lift in unique user reach when using Frequency groups to manage frequency across multiple orders in Amazon DSP.\n"," For full technical information, see the API specifications for frequency groups and the frequency group associations.\n"," July 19, 2025\n"," We are introducing a smarter way to manage your campaign budgets within portfolios. Now, when some campaigns do not use their full daily budget, that unspent campaign budget will not go to waste. Instead, it can automatically flow to other campaigns in your portfolio that consistently reach their daily spending limits.\n"," This intelligent budget sharing system allows high-performing campaigns to spend up to twice their daily budget by tapping into unspent campaign budget from previous days in the month. This all happens while staying within your total monthly portfolio budget.\n"," This enhancement helps you capitalize on high-traffic days and maintain momentum when certain campaigns are performing well. Your successful campaigns can keep running longer, generating more clicks, impressions, and sales opportunities that might otherwise have been missed.\n"," Implementing this feature is straightforward. Simply access your budgetControls settings and set the campaignUnspentBudgetSharing feature to ENABLED or DISABLED, depending on your preference. Whether you are a vendor, registered seller, managed-service customer, self-service customer, or author, this feature is available to help optimize your advertising performance.\n"," For step-by-step guidance on setting up and managing this feature, please refer to the User Guide.  \n"," The launch is available in the following geographical areas. \n"," July 15, 2025\n"," The Advertiser Account is the Amazon Ads enhanced workflow for onboarding advertisers and managing their full advertising activity across all ad products (ADSP and Sponsored Ads) and countries. With this launch, customers with an Amazon DSP Seat can use Ads Console to onboard advertisers with a new streamlined account and billing setup. In this account, customers can operate across both ADSP and Sponsored Ads globally across the full advertising lifecycle from campaign management and reporting, to user management and billing. API customers have the same experience on Amazon Ads API, enabling them to onboard advertisers at scale without relying on Ads Console to do so. If you have an ADSP seat and would like to use this feature, please speak with your Amazon ad-tech AE.\n"," Previously, registration and account management functionality for Amazon Ads advertiser accounts was only available through the Ads Console. With this launch, Amazon Ads API customers can execute all account management related actions (create, view, update advertiser accounts etc.) for all Amazon ad products and countries via API without the need to visit Ads Console to do so. Now, customers can register Advertiser Accounts at scale via public API, and they can use the resulting account identifiers to execute campaign management, reporting, billing and user management operations across all countries and ad products (ADSP, SA). Below is the list of new APIs launched:\n","POST /adsApi/v1/create/advertiserAccounts: Register one or multiple advertiser accounts by providing business details or importing them from a selling account token - POST /adsApi/v1/query/advertiserAccounts: Fetch account details/attributes (such as business/billing details, selling accounts, alternate identifiers for public APIs etc.) for a given advertiser account, a group of advertiser accounts, or all advertiser accounts that a given user has access to - POST /adsApi/v1/update/advertiserAccounts: Programmatically update account details/attributes for advertiser account(s) - POST /adsApi/v1/query/sellingAccounts: Fetch all Amazon retail selling account (for example, Seller, Vendor, Author, KDP etc.) that a given user has access to, so that the resulting encrypted selling account token can be used to register an associated advertiser account.\n"," July 15, 2025\n"," Sponsored products campaigns will now be automatically integrated into shopping conversations when customers chat with Alexa+ about products. Customers can discover relevant products when asking Alexa for product recommendations, receiving a mix of organic and sponsored options. Advertisers with active Sponsored Products campaigns may be eligible to appear on Alexa+ as part of Amazon expanded advertising surfaces, helping you connect with customers wherever they shop on Amazon with no additional requirements. Performance metrics will be consolidated within existing reporting dashboards. At this time, Sponsored Products on Alexa+ is only available on the Echo Show. Following the exciting announcement about Alexa+, our next-generation conversational AI assistant, Alexa+ brings a more natural, context-aware conversation experience to users, and this opens up new opportunities for advertisers to engage with customers during their shopping journey.\n"," July 13, 2025\n"," As part of our continued enhancements to the Amazon DSP APIs, we are deprecating several legacy endpoints across Campaign Management, Reporting, and Creatives Management. The deprecation date for the Campaign Management API has been extended to September 30, 2025 (previously June 30, 2025), while the legacy ADSP Reporting API and the legacy Creatives Management API will also be deprecated on September 30, 2025. You can find the full list of deprecated and replacement endpoints on our Deprecations page. For upgrade guidance, refer to the various migration guides for Campaign, Creative and Reporting. If you have questions or need support, submit a ticket via the Amazon Ads API Support page with the subject “ADSP APIs Migration” or contact your account team or use the standard support channels. We recommend migrating early to ensure uninterrupted access and to take advantage of the latest API capabilities.\n"," July 11, 2025\n"," We have launched minute grain frequency caps in Amazon DSP, allowing advertisers to set frequency caps in 10-minute increments (for example, 10, 20, 30, 40, and 50 minutes). This enhancement provides significantly finer control than the previous hourly or daily options, addressing a critical request from customers seeking to prevent ad repetition with greater precision.\n"," Minute grain frequency caps help prevent ad fatigue by controlling how frequently users see ads within shorter time intervals. This granular control is especially valuable for high-impact streaming TV campaigns and time-sensitive promotions where multiple impressions in quick succession can diminish effectiveness. By distributing impressions more optimally, advertisers can improve budget efficiency and brand engagement.\n"," Minute grain frequency caps are accessible through existing campaign management API endpoints. The feature maintains backward compatibility with all existing frequency cap implementations. For full technical details, read our API documentation.\n"," July 9, 2025\n"," Sponsored Brands is now available to all authors, including those with a single title. Create engaging custom image and video ads to drive awareness and boost your book visibility. To learn more about Sponsored Brands, see the Sponsored Brands overview.\n"," July 7, 2025\n"," Your portfolios can now automatically share their unspent campaign budget, accumulated from previous days in the month, with other campaigns in the same portfolio that have already spent their full daily budget, to enable them to spend more (up to 100% over their daily budget). This system allows you to benefit from high traffic days by keeping campaigns in budget longer. \n"," This launch automatically uses unspent campaign budget on campaigns that consistently run out of their own daily budget, enabling them to keep delivering ads and earning you more clicks, impressions, and sales, all without increasing your overall total monthly campaign budget. Users can now set the unspent campaign budget sharing option to on or off by setting featureState for campaignUnspentBudgetSharing as DISABLED/ENABLED inside budgetControls. Reference the user guide for more details. \n"," This feature is available to customers who are vendors, registered sellers, customers from managed-service, self-service, and authors.  \n"," The launch is available in the following geographical areas:\n","North America: United States, Canada, Mexico  South America: Brazil  Europe: Germany, Spain, France, Italy, United Kingdom, Belgium, Switzerland, Poland, Turkey, Austria, Netherlands, Sweden, Finland, Norway, Ireland, Denmark, Luxembourg  Middle East: Saudi Arabia, United Arab Emirates, Israel, Egypt, Morocco, Bahrain, Kuwait  Asia Pacific: Australia, India, Japan, New Zealand, China, Singapore\n"," July 7, 2025\n"," Customers using the DSP Bid Adjustments APIs can now target specific supply sources, source type, and deals to upscale or downscale their bids. This enables customers to more finely tune the parameters of their bidding to their specific use case and increase their campaign performance.\n"," For more details, see the three new dimensions -- dealId, supplySource, supplySourceType -- in the bid adjustment dimensions guide.\n"," June 28, 2025\n"," Brand Stores has launched a new set of APIs that offer brands and advertisers programmatic access to manage their Amazon Brand Stores more efficiently. These APIs, now available through the Amazon Ads API, provide two key functions: 1) retrieve Brand Store page content and update the product content and selection across Brand Stores pages and 2) submit store updates for moderation.\n"," Advertisers can use these APIs to programmatically manage their Brand Stores pages. These functionalities can be combined with Brand Home APIs to automate and maintain product information freshness, creating a more efficient and streamlined management process for Brand Stores on Amazon. \n"," The Brand Stores management APIs are generally available to all Brand Store owners through the Amazon Ads API. To learn more, see the Brand Stores management overview and the technical specifications.\n"," June 27, 2025\n"," Sponsored ads have now launched in Ireland. Eligible sellers and vendors can now leverage Sponsored Products, Sponsored Brands and Stores on Amazon.ie and via the Amazon Ads API.\n"," June 26, 2025\n"," We have introduced a new POST /adsApi/v1/query/accountLinks endpoint that returns information about linked accounts in a paginated manner. Manager Account users can retrieve details about all accounts (Sponsored Ads accounts, ADSP advertiser accounts, and Manager Accounts) linked to their Manager Accounts. Additionally, advertiser account users can find all Manager Accounts linked to their advertising account. This helps users better understand the structure and access relationships across their advertising setup.\n"," This enhancement helps customers with complex account structures better understand their organizational account structure. The new paginated API fixes two key limitations: it removes the previous 50-linked-account limit for Manager Accounts in the GET /managerAccounts API, and it gives advertiser account users the ability to query linked Manager Accounts via API, a feature not previously available. Customers can now retrieve complete information on their account linking structure, helping them make better decisions about their organizational advertising spend and performance.\n"," To learn more, see the linked accounts API user guide and the technical specification.\n"," June 19, 2025\n"," Advertisers can now apply bid adjustments up to 900% for the top search placements in their Sponsored Brands campaigns. Bid adjustments for rest of search placements, which were previously limited to up to 99% can now also be adjusted up to 900%. These updates are available for all ad formats, including video, and all targeting types (keyword and product), and can be used with existing bidding controls (manual bidding, cost controls, audience-level bid adjustments). \n"," The updated placement-level bid adjustment controls will allow advertisers to optimize campaign performance and execute different strategies across search placements. Advertisers will be able view placement-level metrics in the advertising console or can leverage existing Sponsored Brands Placement reports to understand how their campaigns are performing in specific placements, then use the top of search and rest of search placement bid adjustment controls to fine-tune bids to meet their campaign goals. \n"," Top of search and rest of search placement bid adjustment controls will be available for Sponsored Brands campaigns via the Amazon Ads API. For full technical details, see the updated Sponsored Brands API specification.\n"," June 12, 2025\n"," Advertisers using the Amazon Ads API can now create Sponsored Brands campaigns that exclusively reach business shoppers on Amazon Business, available in Amazon Business Marketplaces - US, CA, MX, DE, IT, FR, ES, UK, IN, JP. To create Amazon Business exclusive campaigns, advertisers will need to set the site Restrictions field in the campaign setting to AMAZON_BUSINESS. Advertisers can drive brand awareness across business shoppers and customize their B2B advertising strategy by setting a B2B budget, using B2B keywords, B2B creatives, and B2B-specific store pages, and adjusting bids to increase sales on Amazon Business. All campaign settings apply exclusively to Amazon Business, and ads will only appear on the Amazon Business store. The Sponsored Brands reports will reflect performance solely on Amazon Business, enabling advertisers to evaluate results and optimize their B2B campaign strategies. See our reference documentation for more information.\n"," June 5, 2025\n"," Amazon Ads has launched a new forecasting API for Amazon DSP (ADSP) campaigns. Built on the Amazon Ads data model, this API provides access to all real-time forecasts currently available on ADSP Campaign Manager.\n"," In this launch, the API offers campaign-level performance, delivery, and spend forecasts currently available on forecasting widgets. This includes campaign flight level forecasts for spend, reach, CPC, CPA, and ROAS. The API provides forecasts both for new orders and existing orders that are spending budget.\n"," Throughout 2025, we will expand the capabilities of the API to include forecasts for other features on the campaign manager such as line-level forecasts, additional spend potential, and creative forecasts. These metrics will also be available using datasets through Amazon Marketing Cloud for easier integrations. For more information, please see the technical specification and the Forecast API overview.\n"," June 5, 2025\n"," Long term sales metrics are available in campaign reporting. Long term sales (LTS) and long term sales ROAS (LTS ROAS) are ad-attributed measures that estimate the incremental sales value your brand can expect to generate over the next 12 months, based on how effectively your advertising campaigns are able to move new-to-brand shoppers further down your purchase funnel. This is based on the historical 12-month return of a given customer engagement with your brand. Customer engagements include detail page views, branded searches, add-to-carts, and purchases. Shoppers are new to brand if they have not completed a conversion with a brand in the last 12 months.\n"," For more information, see our updated campaign reports overview.\n"," June 2, 2025\n"," The Posts API will be discontinued as of June 3, 2025. New users will no longer be able to make requests to the Posts API; existing Posts users should expect new Posts creation to be discontinued after June 16, 2025, and a full shut-off date of July 31, 2025. We encourage customers to explore our suite of sponsored advertising solutions as we continue to build and experiment with new creative formats.\n"," May 30, 2025\n"," We have expanded our content transparency reports on Streaming TV to report ad-impressions delivered on Twitch. Advertisers can now see which Content Type, Rating and Title their Twitch ad impressions were delivered on to now assess if their ads were contextually relevant and use the reporting data to plan their future media investments and adjust their campaign settings.\n"," Content Type, Rating and Title traffic reporting are now available in ADSP downloadable reports under the Audio and Video dimension. For full technical details, please see the audio and video reports guide.\n"," May 29, 2025\n"," Amazon Ads has launched a single Campaign Management API for all ad products, starting with Sponsored Products, Sponsored Brands, and Amazon DSP. Built from a common Amazon Ads data model, this API will ensure field naming, enumerated values, and resource consistency across Campaign, Ad Group, Target, and Ad objects. \n"," Today, there are over 190 separate variations of create, read, update, and delete endpoints, which will be reduced to 16 with this launch. With the Amazon Ads Campaign Management API developers can expect to see complete feature parity, improved error handling, consistent request and response patterns, and higher pagination thresholds than previous versions.\n"," Throughout 2025, all of our ad products will become available through the Campaign Management API, including Sponsored Display and Sponsored TV. We will also be launching consistent campaign datasets through Amazon Marketing Stream, built from the same underlying Amazon Ads domain model, for further consistency across all products. \n"," Although we do not anticipate updates to the contract, the contract may be subject to change during the beta period. \n"," For more information, please see the technical specification and the campaign management overview.\n"," May 29, 2025\n"," The Amazon Retail Purchases (ARP) dataset gives AMC customers 5 years (60 months) of historical Amazon store purchase signals across the advertiser catalog of products, regardless of media investment against those products. AMC customers in US/CA/JP/AU regions can now use this AMC dataset for audience creation purposes. To get started, see the Instructional Query (AMC UI access required).\n"," May 29, 2025\n"," We have added a new content section to the advanced tools center: Betas. The new section will host information about the forthcoming Amazon Ads API v1 as well as specifications and guides for new resource APIs in both open and closed beta stages. To learn more, visit Betas.\n"," May 28, 2025\n"," We have extended the Partner Opportunities API so you can filter for specific advertisers you manage. Partner Opportunities continues to provide you scaled access to insights and recommendations for your advertising clients like unlaunched ASINs and click credit promotions. With this launch, you can provide an advertiser ID or profile ID when listing opportunities (GET /partnerOpportunities) and quickly see which opportunities have results for the specified advertisers. \n"," Whether you want to determine which cohorts of your advertising clients have opportunities available or pinpoint results for a single target advertiser, can structure your call pattern to find the right balance for you. Now, you can use the optional advertiserId or profileId filters, see which partner opportunities align with the provided advertisers, then access the detailed recommendation and insights as you always have. For more information, see our API documentation.\n"," Partner Opportunities API is available worldwide to all registered partners. See the overview guide for more information.\n"," May 22, 2025\n"," We have expanded negative targeting so every campaign and ad group has the same options, regardless of targeting type. In bulksheets, negative product targeting uses product targeting expressions to also negatively target brands. Learn more: Get started with bulksheets for Sponsored Products).\n"," May 22, 2025\n"," We have expanded negative targeting so every campaign and ad group has the same options, regardless of targeting type. Now you can negatively target a keyword, ASIN, or brand during campaign creation or on any existing campaign or ad group. Negatively targeting a keyword prevents your ad from showing on search results pages for that keyword, while ASIN and brand negative targeting prevents your ad from showing on the product detail page for that ASIN or ASINs with that brand.\n"," Advertisers might have certain business rules they want to implement but execution was inconsistent across different targeting types. Now, advertisers will have consistent and clear control of negative targets, helping reduce confusion and operational overhead. \n"," API: Now you can succeed saving negative keywords, products, and brands on campaigns and ad groups regardless of targeting type. Learn more: Negative keyword targeting and Sponsored Products negative product and brand targeting overview.\n"," May 22, 2025\n"," We have launched a new API solution that enables programmatic access to Amazon Marketing Mix Modeling (MMM) data feed. This new API is available in 13 countries: US, CA, IT, ES, FR, DE, UK, MX, BR, JP, AU, UAE, and KSA. This launch allows advertisers and their partners to seamlessly access the advertising and retail signals needed to derive accurate insights from their MMM solutions. \n"," This API access streamlines data delivery for advertisers and their MMM partners, reducing manual data exchange efforts, and enabling more frequent, reliable and accurate MMM analysis. \n"," Three API operations are available for MMM management: \n","Request the list of brands you can pull data for: POST /mmm/v1/brandGroups/list  Request the MMM feed for a given brand: POST /mmm/v1/reports  Check the status of a MMM feed request: GET /mmm/v1/reports/{reportId}\n"," For full technical details, see the MMM API user guide and the technical specifications.\n"," May 18, 2025\n"," We have launched the ability to create and assign SSP Seat IDs to individual Amazon DSP advertisers worldwide. With this release, Amazon DSP users can request seats to be created for any advertiser they manage. The SSP Seat IDs are instantly usable to ingest advertiser-specific deals (wherever Amazon DSP automatically ingests them), and are applied within 24 hours to existing line items for the purpose of spend tracking.\n"," SSP Seat IDs by advertisers make it easier for Amazon DSP users to manage scenarios where deals created for specific advertisers must be kept separate from other advertisers (for example, to protect advertiser negotiated CPM rates). They in turn enable spend tracking IDs at the advertiser level, allowing SSPs more granular spend reporting and buyer validation.\n"," For more information, see the technical specifications for the seats API and the seat IDs API.\n"," May 14, 2025\n"," The new Prime Video Insights (PVCI) dataset in AMC allows channel partners to join their own datasets with the Prime Video Channel viewership data associated with their channels. This new dataset can be used for measurement and activation use cases. To get started, see the dataset documentation and the IQ First-streamed titles for Prime Video Channel subscription starts (AMC UI access required).\n"," April 24, 2025\n"," Advertisers using the Amazon Ads API can now create Sponsored Products campaigns that exclusively reach business shoppers on Amazon Business, available in Amazon Business Marketplaces - US, CA, MX, DE, IT, FR, ES, UK, IN, JP. To create Amazon Business exclusive campaigns, advertisers will need to set the siteRestrictions field in the campaign setting to AMAZON_BUSINESS. Advertisers can customize their business-to-business (B2B) advertising strategy by setting a B2B budget, promoting ASINs they want to showcase to B2B shoppers, using B2B keywords, and adjusting bids as well as bidding strategies to increase sales on Amazon Business. All campaign settings are uniquely applied to Amazon Business and these campaigns will only be shown on the Amazon Business store. All existing Sponsored Products reports will reflect performance only on Amazon Business. Advertisers can leverage these reports to review campaign performance on Amazon Business. See our reference documentation for more information.\n"," April 20, 2025\n"," Amazon Marketing Stream has expanded the ADSP Performance dataset to provide advertisers and developers with richer, and more actionable insights:\n","ADSP Conversions dataset now includes Brand Halo metrics, enabling measurement of downstream purchases attributed to brand exposure, even if the purchase occurred in a different product line. - ADSP Clickstream dataset has been enhanced to include Off-Amazon conversions and Video metrics, offering a more comprehensive view of customer engagement beyond Amazon owned and operated properties.\n"," These updates help advertisers better understand the full impact of their campaigns and optimize spend based on more complete performance signals. To learn more, visit the ADSP Performance dataset section of the Amazon Marketing Stream Developer Guide.\n"," April 18, 2025\n"," Amazon Ads has introduced the Well-Architected Framework, enabling developers to build secure, high-performing, and scalable advertising solutions. This framework addresses common integration challenges and accelerates the development of reliable advertising solutions.\n"," The framework includes three key components:\n","Design Principles: Core architectural guidelines for robust solutions - Best Practices: Proven API integration patterns for optimal performance - Implementation Guidance: Step-by-step technical solutions for seamless integration\n"," Getting Started: To get started with the Well-Architected Framework, visit our technical documentation.\n"," April 17, 2025\n"," Sponsored Brands has launched a migration API to help advertisers transition from V3 (legacy) campaigns to V4 (ad group-based)campaigns, which address the complexity of campaign management. The API provides strategic migration pathways for campaigns with no impressions over 180 days, mandating migration or archival by June 30, 2025, otherwise Amazon will archive these campaigns by July 31, 2025. The impression-generating campaigns are required to migrate by September 30, 2025, or face automatic migration by Amazon by December 31, 2025. \n"," The V4 campaigns enable advertisers to leverage advanced machine learning, the theme targeting feature automatically generates and categorizes keywords based on historical performance and brand interactions, offering two pre-configured targeting groups (keywords related to landing pages and brand) that simplify campaign optimization and improve campaign performance.\n"," The migration API is available in US, CA, MX, BR, JP, SG, AU, UK, DE, FR, IT, ES, NL, AE, IN, SA, SE, PL, TR, EG, SG, and ZA. For more information, see the updated Sponsored Brands API specification or refer to our developer guide for the migration API.\n"," April 17, 2025\n"," Sponsored Brands has introduced new headline capabilities allowing advertisers to use dynamic creative optimization (DCO) to improve ad personalization. Advertisers can consent to leveraging DCO during a campaign to enhance or generate new headlines to help better match customer intent. Based on internal testing, headline text optimization can drive up to 1.6% CTR lift vs. non-optimized campaigns.\n"," Advertisers can access headline optimization via the Amazon Ads API by specifying the optional property creativePropertiesToOptimize with a value of \\[ \"HEADLINE\" ] on Product Collection or Store Spotlight creatives in Sponsored Brands.\n"," The feature is enabled for four operations in the Sponsored Brands API. For more information, see the technical specifications for the following:\n","POST /sb/v4/ads/productCollectionExtended  - POST /sb/v4/ads/storeSpotlight - POST /sb/ads/creatives/productCollectionExtended - POST /sb/ads/creatives/storeSpotlight\n"," April 14, 2025\n"," Amazon DSP Bid adjustments support both simple adjustments and complex bidding algorithms through single and multi-dimensional specifications. This means advertisers can now maintain nuanced and tailored bidding within a single line item, while still taking full advantage of Amazon DSP automated bid optimization.\n"," With this launch, we have also released bid adjustments reporting, now available through the reporting API. Availability in the ADSP Report Center will follow shortly. In the console, you can also bulk apply bid adjustments to up to 10 line items from the campaign table on Advertiser and Order page. \n"," You can also access bid adjustments through our API. For full technical details, see our bid adjustments API, detailed developer guide, and new dspBidAdjustment report type available through the reporting API.\n"," April 9, 2025\n"," With global seats, Amazon DSP users can now register once and buy ads in every country where Amazon DSP operates. Users can create country specific advertiser accounts, receive invoices from a single Amazon legal entity for their global spend, and can create consolidated reports for their spend regionally.\n"," Global Manager Accounts will be available in three regions: NA, EU, and FE. The Calling Profiles API returns only the Profile ID of the manager account for the regional endpoint you are calling. Choose the region you would like to make changes in and select the corresponding API endpoint:\n","NA → https&#x3A;//advertising-api.amazon.com  EU → https&#x3A;//advertising-api-eu.amazon.com  FE → https&#x3A;//advertising-api-fe.amazon.com\n"," For more information, see Account management>Profiles.\n"," April 4, 2025\n"," Sponsored Display is enhancing the machine learning algorithm to find improved conversion opportunities and help drive incremental sales for Reach and Page Visit campaigns, moving these campaigns to align with the optimization objective of Sponsored Display Conversion campaigns. With this change, advertisers who have active Reach and Page Visit campaigns are likely to observe increases in performance metrics associated with these campaigns. For more information, see Sponsored Display: Bid optimization.\n"," April 2, 2025\n"," The new Amazon Retail Purchases (ARP) dataset in AMC gives AMC customers 5 years (60 months) of historical Amazon store purchase signals across the advertiser catalog of products,  regardless of media investment against those products. This new dataset can only be used for measurement use cases. To get started, see the technical documentation and the Instructional Query.\n"," March 31, 2025\n"," We will deprecate Amazon Ad Server tables in AMC on June 30, 2025. After these tables and fields are deprecated, any workflows using these tables/fields will fail. For more details, see the deprecation notice of Amazon Ad Server tables in AMC.\n"," March 24, 2025\n"," Sponsored Brands is introducing a new Amazon-built audience segment - \"New-to-brand shoppers\" - that advertisers can leverage for bid boosting to acquire new customers. This audience includes shoppers who have not purchased from the brand in the last 12 months. \n"," Advertisers can utilize the NTB audience bid boosting on both new and existing Sponsored Brands campaigns. To assess the performance of their bid-boosted NTB audience, advertisers can access the Audience report through the reporting API. \n"," To retrieve Amazon-built audiences, you will use the Discovery API ListTargetableEntities with the following parameters: adProduct = SPONSORED_BRANDS, targetTypeFilter = \\[AUDIENCE], and pathsFilter = \\[\\[\"Audience Category\", \"Custom-built\", \"Product\"]]. The response will have the audienceId for new-to-brand shoppers, which can then be used with Sponsored Brands campaign management API to create and adjust the bids for the audience. Note that Amazon-built audiences retrieved using these filters are only usable with AudienceSegmentType of BEHAVIOR_DYNAMIC when using the campaign management API. For more information, see our guide to shopper cohort bidding.\n"," March 20, 2025\n"," By blending SEO best practices with rich customer insights, this playbook helps advertisers identify high-impact keywords, optimize budget allocation, simplify management, and drive brand growth. To get started, see Keyword clustering playbook.\n"," March 20, 2025\n"," Advertiser Data Upload (ADU) APIs enable you to create first-party audience segments in AMC using advertiser audiences. For more information, see Advertiser audience using ADU.\n"," March 18, 2025\n"," Sponsored TV has simplified cost per thousand impressions (CPM) updates for advertisers that do not sell in the Amazon store. Advertisers will now choose a maximum average CPM at the ad group level rather than for each targeting selection. For technical details, see the updated Sponsored TV API specification.\n"," March 15, 2025\n"," By uploading hashed customer information through the ADU APIs, you can create rule-based audiences and activate them directly in Amazon DSP for highly targeted advertising campaigns. For more details, see Create advertiser audiences with Amazon ADU APIs.\n"," Also, see our updated Postman collection, to test AMC administration, reporting (workflow management), and AMC audiences endpoints.\n"," March 15, 2025\n"," Amazon DSP self-service advertisers in US can now book Fire TV Inline Display Banner campaigns across eligible unguaranteed placements on Home, Live, and Games tabs. These banners expand to \"Mini-Details\" view when users scroll past, taking up half the screen. They support 10-30s video with sound and various click-through destinations helping increase reach, awareness, and consideration. For full technical details, please read our API documentation.\n"," March 12, 2025\n"," This capability is in preview only. We will update our release notes once this functionality is made available. Sponsored Products is introducing three new Amazon-built audience segments - \"Purchased brand products\", \"Clicked or added brand product to cart,\" and \"Affinity for similar products\" - that advertisers can leverage for bid boosting to increase their engagement with these highly relevant cohorts of shoppers.\n"," Advertisers can utilize the audience bid boosting on both new and existing Sponsored Products campaigns. To assess the performance of their bid boosted audience, advertisers can access the Audience Report through the reporting API.\n"," To retrieve Amazon-built audiences, you will use the Discovery API ListTargetableEntities with the following parameters: adProduct = SPONSORED_PRODUCTS, targetTypeFilter = \\[AUDIENCE], and pathsFilter = \\[\\[\"Audience Category\", \"Custom-built\", \"Product\"]]. The response will include an audienceId and audienceResolved (the name) for each of the three new audiences, which can then be used with the Sponsored Products campaign management API to create and adjust the bids for the audience. Note that Amazon-built audiences retrieved using these filters are only usable with audienceSegmentType of BEHAVIOR_DYNAMIC when using the campaign management API. Also note that audienceSegmentType has been made optional in campaign creation, and the API will add the correct audience segment type based on the audience ID.\n"," February 28, 2025\n"," This capability is in preview only. We will update our release notes and API documentation once this functionality is made available. Sponsored Brands is introducing a new Amazon-built audience segment - \"New-to-brand shoppers\" - that advertisers can leverage for bid boosting to acquire new customers. This audience includes shoppers who have not purchased from the brand in the last 12 months. \n"," With this new feature, advertisers will have the ability to apply bid adjustments on the New-To-Brand Shoppers audience to increase reach in this valuable segment and drive orders from new customers. Advertisers can utilize the NTB audience bid boosting on both new and existing Sponsored Brands campaigns. To assess the performance of their bid boosted NTB audience, advertisers can access the Audience Report through the SB API Reporting. \n"," To retrieve Amazon-built audiences, you will use the Discovery API ListTargetableEntities with the following parameters: adProduct = SPONSORED_PRODUCTS, targetTypeFilter = \\[AUDIENCE], and pathsFilter = \\[\\[\"Audience Category\", \"Custom-built\", \"Product\"]]. The response will have the audienceId for new-to-brand-shoppers which can then be used with Sponsored Brands Campaign Management API to create and adjust the bids for the audience. Note that Amazon-built audiences retrieved using these filters are only usable with AudienceSegmentType of BEHAVIOR_DYNAMIC when using the campaign management API. For full technical details, see our updated Sponsored Brands documentation.\n"," February 21, 2025\n"," We have published a step-by-step guide and IaC templates to help you stream Amazon Marketing Stream data to Snowflake. You can implement the solution across AWS, Azure, or Google Cloud with our ready-to-use code templates. To learn more, see the implementation guide.\n"," February 19, 2025\n"," Ads data manager expands support for advertiser first-party data uploads through Conversions API (C-API) and adds Amazon Marketing Cloud (AMC) as a destination for all supported datasets. The enhancement unifies data management across C-API and Advertiser Audience APIs, and includes partner-facilitated uploads, with all datasets accessible through the Ads data manager console and the Ads data manager APIs. \n"," Advertisers can leverage audience data via Amazon DSP, and C-API events will be available for conversion attribution through the Events Manager. All audience and events datasets managed through Ads data manager will be available for access in AMC when creating a destination linked to your AMC instance within Ads data manager.\n"," February 15, 2025\n"," Following the launch of audience bid adjustments for Sponsored Products and Sponsored Brands, integrators can now view audience bid adjustment details for campaigns in both exports APIs and Amazon Marketing Stream.\n"," For exports, the new fields are available using POST/campaigns/export as part of the optimizations.shopperSegmentBidAdjustment object. See Common models for more information.\n"," For Stream, the new fields are available in the campaigns dataset as part of the bidSetting.shopperCohortBidAdjustment object.\n"," February 10, 2025\n"," AMC is excited to announce the launch of automated approvals for instance creation and advertiser inclusion requests in their instances. This launch will allow any eligible advertiser or partner to self-provision AMC through the instance management APIs, reducing onboarding time from a 2-day SLA to instant approval.\n"," Read automated instance approval and advertiser inclusion process to learn more.\n"," January 24, 2025\n"," Amazon Ad Server was sunset in Q4 2024, and all resources describing the relevant datasources have been moved to the Deprecated resources section of the Advanced tools center portal.\n"," January 24, 2025\n"," The migration from the AMC instance-level APIs to the new AMC APIs on the Amazon Ads API is now complete and the resources to help you migrate have been consolidated and moved to the Deprecated resources section of the Advanced tools center portal.\n"," January 24, 2025\n"," Advertisers who use audience bid boosting can now access audience bid boosting reports via the Amazon Ads API. Using bid boosting, advertisers can create custom audiences, such as shoppers who have not previously purchased their product and shoppers who were exposed to their streaming TV campaigns. Advertisers can adjust their bids for these audiences to help drive greater product discovery and sales. For more information on audience bid boosting reports, see the Audience report type documentation.\n"," January 23, 2025\n"," The Amazon DSP campaign management APIs are deprecating several enum values for the inventoryType field on POST/dsp/v1/adGroups. After June 30, 2025, users will no longer be able to create ad groups where inventoryType equals STANDARD_DISPLAY, AAP_MOBILE_APP, AMAZON_MOBILE_DISPLAY, or VIDEO. Instead users should use the newer options below:\n","|Endpoint\t|Legacy inventoryType\t|New inventoryType\t|Legacy inventoryType deprecation date\t|\n","|---\t|---\t|---\t|---\t|\n","|POST/dsp/v1/adGroups\t|STANDARD_DISPLAY\t|DISPLAY\t|6/30/2025\t|\n","|POST/dsp/v1/adGroups\t|AMAZON_MOBILE_DISPLAY\t|DISPLAY\t|6/30/2025\t|\n","|POST/dsp/v1/adGroups\t|AAP_MOBILE_APP\t|DISPLAY\t|6/30/2025\t|\n","|POST/dsp/v1/adGroups\t|VIDEO\t|ONLINE_VIDEO or STREAMING_TV\t|6/30/2025\t|\n"," Please contact our support team with any questions or feedback.\n"," January 16, 2025\n"," Amazon DSP advertisers now gain a unified view of reach and frequency, deduplicating audiences exposed to ads across different publishers, channels, and devices.\n"," Advertiser-level reach and frequency metrics provide unified insights that help advertisers understand their total unique reach across all of their Amazon Ads investments. These metrics eliminate overlapping audience counts across multiple devices and ad formats, revealing the true size of the delivered audience.\n"," You can now access the metric through the reach and frequency report through V3 reporting. For full technical details, please see our v3 reporting documentation.\n"," January 16, 2025\n"," The launch of frequency group-level reach allows advertisers the ability to set a single frequency cap to control ad exposure across multiple orders in a campaign. Complementing this feature, new reporting provides combined deduplicated reach and frequency metrics at the frequency group-level.\n"," Cross-order reach and frequency reporting provides advertisers with a unified, deduplicated view of frequency metrics across all orders within a frequency group. This consolidated reporting eliminates double-counting of audiences exposed to ads from different orders, enabling advertisers to analyze the impact of the frequency group.\n"," You can now access the metric through the reach and frequency report through V3 reporting. For full technical details, please see our v3 reporting documentation.\n"," January 14, 2025\n"," In October, we announced the launch of Amazon DSP campaign and creative management APIs in beta. These endpoints are now generally available worldwide for Amazon DSP users and their technology partners.\n"," The campaign and creative management resources enable users to create, read and update their Amazon DSP campaigns and creatives via a programmatic interface. Technology providers and advertisers can use these resources to develop new trader experiences within their own applications and manage Amazon DSP campaigns within their existing workflows. To enable end-to-end campaign management, these new resources can be used together with the audience and deal endpoints.\n"," With this release, we are adding a targetId field to /dsp/v1/targets:\n","When creating a new target via POST/dsp/v1/targets, every successfully created target will have a targetId.  When listing targets via POST/dsp/v1/targets/list, all listed targets will contain a targetId.  A new endpoint, POST/dsp/v1/targets/delete, enables users to remove targets from ad groups using targetId. This endpoint can be used instead of POST/dsp/v1/targets/deleteByObject for a more efficient delete operation.\n"," For more information, refer to these links:\n","|Campaign Management \t|Creative Management\t|Creative Associations\t|\n","|---\t|---\t|---\t|\n","|Developer guide\t|Developer guide\t|Developer guide\t|\n","|Migration guide  \t|Migration guide\t|Migration guide\t|\n","|Reference documentation \t|Reference documentation\t|Reference documentation\t|\n"," January 14, 2025\n"," With the launch of our new Amazon DSP campaign management APIs, we are deprecating the previous version of the campaign management APIs. Previously we announced a deprecation date of March 31, 2025. We are extending this deprecation date to June 30, 2025. The full list of APIs being deprecated can be found on our deprecations page.\n"," January 8, 2025\n"," The version 3 reporting API has a new workflow that enables pulling reports at the individual advertiser level. This new workflow supports these use cases:\n","Advertisers who utilize Amazon managed service and wish to pull performance reporting for their managed service campaigns. \\* Agencies who want to give reporting access for a subset of advertisers they manage instead of all their advertisers.\n"," For more information on this workflow, please review our guide to pulling Amazon DSP reports.\n"," January 1, 2025\n"," We have introduced a new API to facilitate the retrieval of advertising billing promotion data and its corresponding consumption metrics across invoices. This new functionality enhances our existing billing API, enabling customers to programmatically retrieve their promotions data and gain visibility on which invoices have consumed it.\n"," This enhancement is crucial for customers to enhance visibility and transparency into promotions. The new API eliminates the need for customers to manually review each individual invoice to determine if a specific promotion has been consumed. Instead, customers can now access this information programmatically, empowering them to make more informed decisions regarding their advertising expenditures and performance.\n"," For more information, see our API documentation.\n"," December 16, 2024\n"," The playbook Enhanced scoring for overlapping AMC audiences will guide you through the process of integrating the powerful capabilities of Amazon Marketing Cloud (AMC) with the persona builder API to deliver comprehensive audience insights. It guides you through the process of identifying AMC audiences and leveraging the persona builder API to identify additional audience attributes across top retail categories, top overlapping audiences, estimated size, top demographics, and Prime Video insights. All the results are accompanied with an affinity score that refers to the likelihood and a percentage score that refers to the percentage of the customers on the above categories. The derived insights will help you build a holistic approach of audience performance.\n"," To get started, see Enhanced scoring for overlapping AMC audiences.\n"," December 16, 2024\n"," AMC on AWS Clean Rooms self-serve instance creation APIs now allow you to create a multi-party collaboration instance. With this update, advertisers or partners with data stored across multiple AWS accounts can include up to two additional AWS account IDs in the collaboration instance. This enables AMC to query data or create audiences from these associated AWS accounts.\n"," For more details, see Create an AWS Clean Rooms backed AMC instance.\n"," December 15, 2024\n"," We have introduced a new feature that allows advertisers to select and set any of their owned seller accounts as the seller payable payment method globally. They can now also choose one or more seller payable payment methods during registration. This functionality is available for both registration and payment method updates.\n"," This launch enables public API clients to retrieve eligible seller accounts and seamlessly register or update advertiser payment methods, allowing the advertiser to set one or multiple preferred seller accounts.\n","This API now provides a list of seller payable payment methods contains seller account and country code that an advertiser is eligible to register.\n","This API now accepts seller account and country code that can be used to register or update the advertiser payment method.\n","This API now returns seller account and country code that registered by the advertiser.\n","This API now allows advertiser to select specific seller account and country code to set as their default payment method.\n"," December 15, 2024\n"," With the launch of Amazon Exclusive Reach Rate for STV Inventory reporting, advertisers can now isolate and analyze the unique, unduplicated reach delivered by individual Amazon 1P streaming TV inventory sources like Twitch and Prime Video within their total STV investment. This granular reporting provides insights into the exclusive reach generated by Amazon 1P video channels.\n"," Advertisers are seeking deeper insights into the performance of Amazon 1P STV inventory. This new Amazon Exclusive Reach Rate allows advertisers to validate how effective their Amazon STV investment is at extending total campaign reach to net-new users. Additionally, they can measure the total reach delivered by each individual STV inventory, and adjust their advertising strategies and engage this exclusive audience beyond linear tv.\n"," For full technical details, please read our full API documentation.\n"," December 12, 2024\n"," Following the release of Amazon DSP reports to the v3 offline report API, we are announcing the deprecation of the legacy Amazon DSP report endpoints with a shutoff date of June 30, 2025. You can find a full list of legacy and new endpoints on the Deprecations page.\n"," For general guidance, refer to the v3 reporting overview. For more details on how to upgrade, see our migration guide.\n"," For questions, use the Amazon Ads API Support page to submit a ticket with the subject title \"ADSP Report API Migration\".\n"," December 11, 2024\n"," When defining your bucket policy for Advertiser data uploads, you can now associate multiple instance IDs with a single tag. This allows all the specified instances to access the designated S3 bucket or object. For more details, see Define tags.\n"," December 11, 2024\n"," This playbook guides you through optimizing ad spend distribution by maximizing a specified KPI. It uses historical performance data to create diminishing returns curves, which project expected outcomes at various budget levels allowing you to visualize performance expectations and identify the point where additional investment yields diminishing returns. To get started, see Media performance optimization playbook.\n"," December 11, 2024\n"," AMC on AWS Clean Rooms now offers self-serve instance creation and advertiser modification APIs. This new feature enables all AMC account holders, including advertising partners and direct advertisers, to create collaboration instances independently, without requiring assistance from an Amazon representative. For more details, see Create an AWS Clean Rooms backed AMC instance.\n"," December 6, 2024\n"," Following the release of the new ADSP Creatives and Association Management endpoints, we are announcing the deprecation of the legacy endpoints with a shutoff date of May 31, 2025. You can find a full list of legacy and new endpoints on the Deprecations page.\n"," Going forward, you can access all creative, moderation and association data via the new ADSP Creatives and Association endpoints. For more details on how to upgrade, see our Migration Guide.\n"," For questions, use the Amazon Ads API Support page to submit a ticket with the subject title \"ADSP Creative API Migration\".\n"," December 5, 2024\n"," Regions: US, UK, CA, AU\n"," Contextual keyword targeting enables advertisers to connect with audiences by targeting content based on relevant freeform keywords or phrases - without relying on identifiers. Powered by our latest AI models, Amazon DSP places ads on Amazon properties and third-party sites, ensuring ads appear on pages containing or closely related to targeted keywords.\n"," This product is now available in the US, UK, CA, AU to Amazon DSP self-service and managed-service advertisers and is supported on standard display and Amazon mobile display line items.\n"," Contextual keyword targeting overcomes the limitations of category or product retail-based approaches by offering advertisers the flexibility to target freeform keywords, enabling increased reach and performance. Up until now, the existing contextual targeting options available on Amazon DSP restricted advertisers to predefined Amazon retail Categories (Browse Nodes) or Products (ASINs), so advertisers could target ‘picnic baskets’ but not an event like ‘4th of July’ or ‘summer.’ The flexibility of contextual keyword targeting is a universal fit for all of our customers, enabling advertisers increased opportunities to achieve their goals on Amazon DSP.\n"," Relevant API endpoints:\n","Create target: /dsp/v1/targets - List targets: /dsp/v1/targets/list - Delete target: /dsp/v1/targets/deleteByObject\n"," December 2, 2024\n"," The Amazon DSP campaign management APIs now support creating, reading, and updating inventory groups. Inventory groups are reusable groupings of deals into one singular group that can be added to ad groups.\n"," New endpoints:\n","POST /dsp/v1/inventory/inventoryGroups/list: List all inventory groups.  POST /dsp/v1/inventory/inventoryGroups: Create an inventory group.  PUT /dsp/v1/inventory/inventoryGroups: Edit an inventory group. \\* POST /dsp/v1/inventory/eligibility/inventoryGroups/list: List inventory groups eligible to be added to an ad group.\n"," To add an inventory group to an ad group (line item), use POST /dsp/v1/targets to create an inventorySourceTarget with inventorySourceType = INVENTORY_GROUP.\n"," For more information, see the API specification for inventory groups.\n"," December 2, 2024\n"," For information about programmatically accessing status information, visit the Amazon Ads Status page in the advanced tools center.\n"," November 29, 2024\n"," Amazon Marketing Cloud (AMC) adds Amazon Brand Store insights datasets to its Paid features suite, allowing users visibility into Brand Store performance through two comprehensive AMC datasets that include page renders and interactions. Available for both trial and subscription enrollments in the following marketplaces: US, Canada, Japan, Australia, France, Italy, Spain, UK, and Germany.\n"," To learn more, visit Amazon Brand Store insights.\n"," November 20, 2024\n"," AMC Amazon Your Garage is a paid feature and available for enrollment within US and CA AMC account marketplaces. The AMC Amazon Your Garage dataset contains signals from US, CA, and MX.\n"," To learn more, visit the Amazon Your Garage Instructional Query (link only available for AMC UI users).\n"," November 20, 2024\n"," This comprehensive playbook will help advertisers perform an in-depth analysis of previous tentpole events and guide creating targeted lookalike audiences. It addresses key questions about ASINs and campaign selection, audience targeting timing, and effective strategies for keywords, frequency, and ad formats. To learn more, visit Lookalike audiences for promotional events playbook.\n"," November 15, 2024\n"," Amazon DSP has launched a new Guidance API and Quick Action API, enabling advertisers to programmatically access pre-flight and in-flight recommendations for their campaigns. The Guidance API provides the same intelligent suggestions for maximum average CPM, line-item frequency caps, viewability targeting and other optimization opportunities that are available through the DSP console. Advertisers can now retrieve recommendations for new campaigns pre-flight and in-flight optimizations for live campaigns, allowing for seamless integration with their own systems and workflows. The Quick Action API allows advertisers to seamlessly action Amazon DSP recommendations.\n"," The Guidance API empowers advertisers to automate their campaign optimization processes, reducing manual effort and improving efficiency. By providing programmatic access to Amazon machine learning-driven recommendations, advertisers can quickly identify and act on opportunities to enhance campaign performance and delivery. This API integration enables more frequent and consistent optimization, especially beneficial for advertisers managing large-scale campaigns or using custom tools for campaign management.\n"," DSP Guidance API: Advertisers can use this API to view recommendations for their campaigns. The four new endpoints will aggregate the guidance at various object levels (advertiser, order or line items). Recommendations can be fetched for many objects at once.\n"," Listed below are the new endpoints included in this API:\n","POST /dsp/v1/guidance/lineitems/list  POST /dsp/v1/guidance/orders/list  POST /dsp/v1/guidance/advertisers/list\n"," For full technical details, please read our API documentation.\n"," DSP Quick Actions API: This API allows advertisers to adopt the recommended changes returned by the Guidance API. Sending a request to POST /dsp/v1/quickactions/{actionId}/executions using the actionId included in the guidance response will trigger the relevant change to be adopted.\n"," For full technical details, please read our API documentation.\n"," November 15, 2024\n"," Contextual keyword targeting enables advertisers to connect with audiences by targeting content based on relevant freeform keywords or phrases - without relying on identifiers. Powered by our latest AI models, Amazon DSP places ads on Amazon properties and third-party sites, ensuring ads appear on pages containing or closely related to targeted keywords.\n"," This product is now available in the US, UK, CA, AU to Amazon DSP self-service and managed-service advertisers and is supported on standard display and Amazon mobile display line items.\n"," Contextual keyword targeting overcomes the limitations of category or product retail-based approaches by offering advertisers the flexibility to target freeform keywords, enabling increased reach and performance. Up until now, the existing contextual targeting options available on Amazon DSP restricted advertisers to predefined Amazon retail Categories (Browse Nodes) or Products (ASINs), so advertisers could target ‘picnic baskets’ but not an event like ‘4th of July’ or ‘summer.’ The flexibility of contextual keyword targeting is a universal fit for all of our customers, enabling advertisers increased opportunities to achieve their goals on Amazon DSP.\n"," For more information, see our API documentation:\n","Universal targeting:\n"," November 15, 2024\n"," Alexa is the first device ad placement to integrate with the standard Asset Based Creative (ABC) creative template used by desktop and mobile advertisers. Amazon DSP self-service advertisers using ABC creatives, directing to to any landing page, now have the opportunity to run their display ads on Alexa Home Screen (AHS). This will help drive brand awareness and consideration objectives and prove an opportunity to reach incremental customers on Echo Show devices.\n"," Buyers can use the standard Assets Based Creatives (ABC) and be served on the Alexa Home Screen (AHS). Alexa is an Amazon inventory type that will be enabled on Display Media Type Line items. This gives buyers a frictionless experience of serving an ABC ad to an additional Amazon supply.\n"," November 15, 2024\n"," Amazon DSP Creative team will launch the Creative Management APIs into open beta. This release includes the ability to create, update, read, preview creatives; create, delete and update creative ad group association; and get moderation details for Amazon DSP creatives.\n"," This launch allows us to grow our integration offering to more customers using the latest version of the creative APIs. This set of APIs offer the functionality available on the Amazon DSP UI, including the support of add, edit, review setting and moderation status, associate to line items and bulk tools. This set of APIs were redesigned and newly developed to better support integration customer needs.\n"," The new creative management APIs enable self-serve advertisers and their partners to programmatically manage their Amazon DSP AdCreatives, AdCreative-AdGroup associations and moderations. These new APIs replace the previous creative management APIs, with the following improvements:\n","Unified API structure: The API model provides a single, unified structure (the adCreative) that can host multiple variations (the adExperiences). API clients will have access to the new offering automatically without additional API-onboarding overhead.  Worldwide availability: The new APIs are available in all countries supported by Amazon DSP.  Improved Scale: The list endpoint can support up to 100 objects read at a time, and the createCreativeAssociation, patchCreativeAssociation and deleteCreativeAssociation can support batch size of 20. \\* Enhanced Features: The new API supports PATCH operations (partial updates) allowing individual field without sending all the fields. The new AdCreative association API can update association object state (ACTIVE, INACTIVE).\n"," November 15, 2024\n"," We have introduced a new API to streamline the retrieval of individual billing documents, such as invoices, credit memos, debit memos, and prepayment receipts. This new functionality enhances our existing /billing API, allowing customers to programmatically download these documents in various media formats, improving the accessibility and management of billing records.\n"," This enhancement is essential for customers managing complex billing operations. Previously, invoices and related documents could only be accessed in a JSON format, limiting flexibility for users requiring these documents in a downloadable format. Now, with this update, customers can download essential billing documents in PDF and other formats, making it easier to manage and store important financial records.\n"," For more information, see our API documentation.\n"," November 15, 2024\n"," We have expanded our Amazon DSP recommendations to support campaigns running seven days or less. This update enables our machine learning models to provide more timely and relevant optimization suggestions for campaigns during peak shopping events like Prime Day or Black Friday.\n"," Advertisers can now benefit from Amazon DSP recommendations to help their orders pace during peak shopping events, helping them to quickly identify and address issues. Our recommendations are actionable with a single click, helping advertisers focus their time on what matters.\n"," For more information, see our API documentation.\n"," November 15, 2024\n"," Amazon launched support for historic all-up ad supported reach curves in the US, UK, DE and CA. For the first time, Amazon has released the ability to understand Amazon reach by first party, third party, and advertiser audiences. Using the Historic Reach Curve API - Advanced, you can programmatically access ad-supported reach metrics across Amazon portfolio of ad products.\n"," Integrators now have visibility into the historic household and individual reach Amazon achieved. This data can be used as-is or as fuel to power your internal planning tools.\n"," For full technical details, please read our API documentation.\n"," October 21, 2024\n"," The Amazon Business Bid Adjustment and Reporting for Sponsored Products is available to all advertisers using the SPv3 API across US, CA, MX, DE, UK, FR, IT, ES, IN, and JP. The Amazon Business Bid Adjustment is a singular adjustment that allows advertisers to increase their bids by up to 900% across all placements on Amazon Business. This Amazon Business Bid Adjustment can be applied to existing or new Sponsored Products campaigns, and can be set independently or in addition to placement bid adjustments for Top-of-Search (first page), Rest-of-Search (remaining search results), and Product pages. All Sponsored Products advertisers in Amazon Business marketplaces, irrespective of their use of the Amazon Business Bid Adjustment, will now also have access to reporting that shows Sponsored Products campaign performance on Amazon Business from 9/5/2024 onwards. The Amazon Business performance data can be used by advertisers to guide their use of the Amazon Business Bid Adjustment.\n"," By increasing bids for Amazon Business placements, advertisers are more likely to have their ads surface on the Amazon Business store and correspondingly generate more impressions, clicks, and sales (better reach and engagement) from business customers. Relative to B2C customers, business customers are ~3x more likely to purchase an item after viewing its product page, have a ~50% lower return rate, and on average make orders containing ~80% more units. This results in advertisers, on average, seeing a 2-3x higher return on ad spend on Amazon Business relative to their overall campaign performance (based on Amazon internal data, 2024). The Amazon Business performance data can be used by all Sponsored Products advertisers in Amazon Business marketplaces, irrespective of their use of the Amazon Business Bid Adjustment, to understand the effectiveness of their Sponsored Products campaigns on Amazon Business.\n"," SP v3 API: Advertisers can use the new enum value SITE_AMAZON_BUSINESS by providing it when configuring the dynamic bidding specifications of a given campaign. All existing SP endpoints which accept or return this object now accept this new enum with a value from 0 to 900.\n"," Reporting v3 API: Advertisers can use the new filter named campaignSite with the value AmazonBusiness as modifier to the campaignPlacement groupBy parameter in the spCampaigns report. Other groupBy parameters apart from campaignPlacement are not supported in the request. The generated report will show AB-only performance for all of their campaigns irrespective of the use of the AB Bid Adjustment.\n"," For more information, see the technical specifications for the Sponsored Products API and the documentation for the reporting API.\n"," SP API endpoint examples:\n","POST /sp/campaigns for creating a new campaign - PUT /sp/campaigns when updating an existing campaign - POST /sp/campaigns/list when querying upon existing campaigns which contain the enum value.\n"," Reporting API endpoint examples:\n","GET /reporting/reports/{reportId} Gets a generation status of a report by id - DELETE /reporting/reports/{reportId} Deletes a report by id - POST /reporting/reports Creates a report request\n"," October 18, 2024\n"," Starting Nov 6, 2024, the Amazon DSP campaign management APIs will enable read-only support for campaigns targeting Amazon guaranteed deals.\n"," Summary of changes:\n","New boolean field: targetsAmazonDeal \\* New fields: startDateTime, endDateTime\n","New inventoryType enum values: AUDIO_AMAZON_DEAL, STREAMING_TV_AMAZON_DEAL\n","The inventorySourceTarget will list the specific Amazon guaranteed deal being targeted. \\* After pulling the dealId from the targets endpoint, you can use /dsp/inventory/deals/list to pull deal metadata.\n"," We will post an announcement on our release notes page once this feature is released.\n"," October 18, 2024\n"," Amazon Ads has enhanced its existing mechanisms for publishers, advertisers and vendors (referred to as third parties) to share their customers’ consented data with Amazon Ads by introducing Amazon Consent Signal. While we will continue to accept the Interactive Advertising Bureau (IAB) Transparency & Consent Framework (TCF) signal, Amazon Consent Signal provides a way for third parties that do not use TCF to transmit their users’ consent choices along with a country code to Amazon Ads. For Sending Personal Information and Amazon Ads Consent Signal requirements, please click here.\n"," From 1st November 2024, third parties can to share the country code and consent with Amazon Ads. We will continue to honor existing mechanisms for consent and will publish an update by which all data that partners make available to Amazon Ads, must include the IAB European Transparency & Consent Framework (TCF) signal(s) or the Amazon Consent Signal.\n"," From 1st November 2024, you can share a country code when passing customers’ consented data to Amazon Ads. The country code is a 2-character string in the ISO 3166 format that indicates in which country the consent was given (for example, US or GB). If you upload data without specifying a country code, we will automatically reject the data load. The Country Code must indicate the country in which consent was granted by the customer.\n"," From 1st November 2024, you can share a consent string when passing EEA or UK customers’ consented data to Amazon Ads. If you already use TCF, this is sufficient and you do not need to make any changes. If you do not use TCF, you can use the Amazon Consent Signal, see below, to pass your customers’ consent. To be clear, please do not pass both TCF and Amazon Consent Signal. If you do pass both, we will take TCF as the consent signal and ignore Amazon Consent Signal. If you use a Consent Management Platforms (CMP) to manage your consent please ensure your CMP provides you with the necessary data to send a TCF consent string or the Amazon Consent Signal details. If you pass your data to Amazon Ads directly (i.e. not through a CMP) then we have several resources available to help you do this.\n"," Country code is a required field today as part the audience metadata sent via DP API. Additionally, from 1st November 2024, third parties can begin to share consent string with Amazon Ads. Consent string will be a new field (see attachment). Instructions to add consent string are published here.\n"," If you are not sending audiences for countries that are part of EEA and UK then please keep sending country codes; no further action is needed. If you are sending audiences for countries that are part of EEA and UK then please continue reading about Consent string requirements.\n"," Amazon will continue to honor existing mechanisms for consent and also advise customers to utilize the TCF or Amazon Consent Signal. For any questions related to the DP API updates you can contact us here.\n"," We will update the following Help Center articles:\n","https&#x3A;//advertising.amazon.com/help/GLZ54GXQW773A6MG - https&#x3A;//advertising.amazon.com/help/G9Y77VYQ3VJZU5YV - https&#x3A;//advertising.amazon.com/API/docs/en-us/guides/overview\n"," What actions should events manager advertisers and partners take? Events Manager users (AAT, CAPI) can share any one of the consent formats that is most relevant for them.\n","Our GTM Templates will have now have additional consent checkbox and fields. Please use the consent field that is most relevant for you. If you are an agency/ partner working on behalf of your advertiser, use the consent provided by your advertiser. 2. For regular AAT there is a command called setAmazonConsent that takes all of the consent fields as a JSON object. 3. For CAPI and partner integrations there will be an field on the events called AmazonConsent that takes the JSON of the consent fields.\n"," Starting November 6, 2024, AMC will accept Transparency-and-Consent-Framework (TCF), Global Privacy Platform (GPP), and Amazon Consent Signal (ACS) consent signals. These consent signals will be optional in UK/EEA personal data uploads until they become mandatory. AMC will respect provided consent, rejecting records if denied. During the transitional period there will be no impact to data uploaded without consent signals.\n"," We recommend all advertisers and third-party (3P) data providers provide this information to indicate the jurisdiction whose laws apply to processing the user data.\n"," The above-mentioned data decoration standards for country codes and consent signals also applies to all advertisers and 3Ps using AMC — AWS Clean Room collaborations.\n"," Please refer to Sending Personal Information to Amazon Ads & Amazon Consent Signal requirements to know more about the policy. For detailed documentation, please visit the AMC documentation section within the Advanced Tool Center (ATC).\n"," Advertisers uploading their data to Ads data manager can provide consent in one of three formats: TCF, GPP, or Amazon Consent Signal. We require all records containing user-level identifiers uploaded to Amazon Ads to contain at least one consent attribute, as well as country code.\n"," For specific technical instructions, the details are found here.\n"," October 18, 2024\n"," Beginning November 1, advertisers running new and existing display ad campaigns in Amazon DSP will benefit from additional Amazon first-party supply across Echo Show, Fresh stores, Fire Tablet, Fire TV, IMDb, Twitch, and Whole Foods Market and Fresh digital displays. Advertisers who have selected any Amazon inventory source for their display campaign will automatically have all eligible Amazon inventory sources included.\n"," This change comes following improvements to our machine learning models and the previous launch of display ad inventory across Echo Show (US, UK, DE, CA, MX, IT, JP), Fire Tablet (US, UK, DE, JP), IMDb (WW), and Twitch (WW). We will add additional supply from Fire TV, IMDb, Twitch, Whole Foods Market, and Fresh stores in the coming months.Additional expansions across Fire TV display component-based creatives and Twitch custom format ads are planned for the coming months.\n"," This auto-selection will happen in a phased manner and eligibility will be governed by ad policy and creative requirements specific to each inventory source. Advertisers have the option to opt-out of this automatic inventory expansion if they choose by reaching out to Programmatic Solution Consultant or Ad Support via Contact us in Support center.\n"," Prior to this update, advertisers had to manually select Amazon inventory sources for their display ad campaigns. Enabling automatic inventory expansion removes the guesswork, simplifies campaign management, and frees up valuable time and resources, all while giving advertisers the opportunity to connect with a wider audience. This change also provides the ability to maintain control over ad placements and benefit from intelligent optimization strategies that can help achieve campaign goals more effectively.\n"," For full technical details, please read our API documentation.\n"," October 18, 2024\n"," Beginning November 1, advertisers running new and existing online video ad campaigns in Amazon DSP will benefit from additional Amazon first-party supply across Echo Show, Fire TV, IMDb, and Twitch. Advertisers who have selected any Amazon or third-party inventory source for their online video ad campaign will automatically have all eligible Amazon inventory sources included.\n"," This change comes following improvements to our machine learning models and the previous launch of video ad inventory across IMDb (WW) and Twitch (WW). We will add additional online video supply from Echo Show, IMDb and Twitch in the coming months. Additional expansions across Alexa video inventory is planned for the coming months.\n"," This auto-selection will happen in a phased manner and eligibility will be governed by ad policy and creative requirements specific to each inventory source. Advertisers have the option to proactively opt-out of this automatic inventory expansion if they choose by reaching out to a Programmatic Solution Consultant or Ad Support via Contact us in Support center.\n"," Prior to this update, advertisers had to manually select Amazon inventory sources for their online video ad campaigns. Enabling automatic inventory optimization removes the guesswork, simplifies campaign management, and frees up valuable time and resources, all while giving advertisers the opportunity to connect with a wider audience. This change also provides the ability to maintain control over ad placements and benefit from intelligent optimization strategies that can help achieve campaign goals more effectively.\n"," For full technical details, please read our API documentation.\n"," October 18, 2024\n"," Sponsored Brands launched the Optimization Rules Recommendation API to provide suggested Cost-Per-Click (CPC) when using Optimization Rules for Drive Page Visits campaigns. The bid suggestions are personalized based on brands owned by the advertiser, allowing advertisers to input competitive bids to drive campaign objectives.\n"," An effective optimization metric threshold should balance auction performance with cost-effectiveness, and can vary greatly depending on your brand content and targeting strategies. The Optimization Recommendations API was designed with this principle, empowering advertisers to achieve results while still converging to cost efficient bids.\n"," Advertisers can retrieve these recommendations through the new /sb/recommendation/optimization API call, for both existing campaigns and during the campaign creation process. This endpoint takes your cost control metric type, along with up to ten landing page ASINs or URLs, and returns both the recommended value and minimum value for your campaign.  For full technical details, please read our API documentation.\n"," October 15, 2024\n"," The updated campaign management resources for Amazon DSP are now available worldwide in open beta. With this release, we are making the endpoints available to all customers with access to an Amazon DSP account. You no longer need to request permission to access the new endpoints via the Amazon Ads API.\n"," The new campaign management resources enable you to create, read and update Amazon DSP campaigns, ad groups, targets, flights and product conversion tracking details. They replace the legacy campaign management APIs, which are scheduled for deprecation on March 31, 2025 per our previous announcement. In addition to being available worldwide and supporting programmatic guaranteed deals, the new APIs improve the experience developing at scale, for example, through support of PATCH operations and larger batch sizes.\n"," If you are integrated with the legacy resources, we have put together a migration guide to help you transition to the new resources. If you are new to managing Amazon DSP campaigns via API, refer to our reference documentation and developer guide.\n"," For questions, visit the Support page to submit a ticket with the subject title “ADSP CM API Migration.”\n"," October 14, 2024\n"," Advertisers can leverage rule-based or lookalike audiences in Sponsored Display targeting, Sponsored Products bid boost and Sponsored Brands bid boost. This functionality allows advertisers to act on the insights they derive from AMC and reach shoppers at the right time and place in their shopping journey.\n"," Start creating custom audiences in AMC using Rule-based audiences and Rule-based lookalike audiences to activate in your sponsored ads accounts.\n"," October 14, 2024\n"," Announced at unBoxed 2024, Ads data manager (ADM) is a new standalone offering that simplifies and streamlines the process of first-party data management across Amazon Ads ad tech. ADM is a privacy-safe, easy-to-use interface that lets advertisers and their partners onboard their data once and securely reuse it across our ad products (for example, ADSP or AMC) for measuring conversions, engaging relevant audiences, and optimizing campaigns for sustainable business growth- all while retaining visibility and control of their data.\n"," Advertiser first party data is crucial for measuring campaign success and driving better marketing outcomes.  As customers adapt to reduced dependence on third party cookies and mobile advertising IDs, they are increasingly reliant on their first party data as critical inputs into audiences, measurement, optimization strategies.  To enable advertisers to unlock and scale the value of their first party data, we are launching Ads data manager. Through ADM, advertisers can access a single solution within Amazon Ads to build a holistic first party data strategy. Some of the key product differentiators include:\n","Simplified and intuitive CX for data management: We are making data onboarding frictionless, Amazon Ads advertisers (and their partners) will access a unified interface which natively receives data through Amazon Ads Console UI, connected APIs and CDP integrations.  Interoperable experience across all Amazon Ad Tech products: You can upload your data once and reuse it across all 1p data features of ad products (ADSP, AMC) to activate it for various use cases, all through one simple interface.  Fast track onboarding via integrated partners: You will be able to easily stream data wherever you traditionally house it, this will be made possible through a connector library that offers integrations with partners like CDPs, MMPs.  Secured data environments: ADM is a secure data environment with user-level access controls, giving you the ability to create isolated data environments for different use cases — all with end-to-end encryption  Seamless hand-off between brands and agency partners: ADM will allow for streamlined data connections across advertisers and agency partners.\n"," The Ads data manager consolidates all of Amazon Advertiser Data APIs into a single API collection for ease of integration. The main API functions are:\n","DataSet APIs - Manages Datasets.  Datasets are tables with a specific schema. You may use this API to delete a dataset.  Audience APIs - Creates an dataset with the audience dataset type. This API serves as a shortcut to create an audience dataset directly.  Audiences are treated the same as general datasets, but have a pre-defined schema template used for audiences.  Sharing Rules APIs - Sharing rules allow you to list current dataset shares with linked advertiser accounts. You may also create new sharing rules to make datasets available for use in advertiser accounts for a specific application. \\* Status APIs - Provides reporting on the status of uploads, size of your datasets, and volume of data that has been made available for a given sharing rule.\n"," For more information, read our API documentation.\n"," October 14, 2024\n"," Sponsored Products and Sponsored Brands are launching a new bidding control to enable advertisers to reach and engage audiences segments defined and created by them. With the latest offering, advertisers can compose lists of audiences, such as those who have not bought their product before or exposed to their video awareness campaigns and set custom bids for them in their campaigns to drive more discovery and sales.\n"," The new bidding control enables advertisers to engage with audiences created in Amazon Marketing Cloud (AMC), a privacy-safe, cloud-based, clean room solution.  The audiences are then available to their sponsored ads account so they can selectively modify the bids for them when launching their campaigns.\n"," The new control helps advertisers more efficiently engage with selected audiences segments. Using bid controls, they can modify their bids to capture increased engagement and conversions from selected audiences segments, such as re-engaging shoppers in their journey along the marketing funnel, while also reaching the relevant Amazon shoppers that are searching for their targeted keywords. Advertisers can monitor performance through a new field in the AMC sponsored_ads_traffic table to understand when Amazon applied the bid increase by inspecting the column matched_behavior_segment_ids.\n"," Advertisers will use the Targetable Entities API to retrieve Audiences (Discovery) after they are created in AMC. In Sponsored Products, they will then use the Audience ID (Canonical) with the Sponsored Products V3 Campaigns API to create, bid adjust the audience and manage their campaigns. In Sponsored Brands, similarly, advertisers will use Sponsored Brands Campaign Management API to create and manage their campaigns, as well as adjust their audience bids.\n"," October 14, 2024\n"," Ads data manager is a new standalone offering that simplifies and streamlines the process of first-party data management across Amazon Ads, enabling marketers to be in the driver’s seat for making more effective, data-driven decisions. Designed with ‘data stewards’ in mind, ADM is a privacy-safe, easy-to-use interface that lets advertisers and their partners onboard their data once and securely reuse it across our ad products for measuring conversions, engaging relevant audiences, and optimizing campaigns for sustainable business growth- all while retaining visibility and control of their data. For more details, see Ads data manager console and Ads data manager API.\n"," October 11, 2024\n"," Dynamic segments are collections of audiences that change based on performance and relevance criteria to reach consumers who are most likely to engage with your ads. You can select the dynamic segments to launch your campaigns easily and effectively and drive performance at scale. The new “Audiences likely to be interested in your ad“ setting leverages Amazon machine learning algorithms to show your ads to audiences who are most likely to consider and buy from your business — using a variety of signals such as Amazon first-party shopping signals, your own conversion signals, and insights from your business website.\n"," Once you have identified the audiences you want to use, you can add targeting clauses at the ad group level using POST /sd/targets. For more information on setting up audience targeting, see audience targeting campaigns. For more details, refer to the full technical API documentation.\n"," October 9, 2024\n"," We are introducing a new Brand Stores API, which advertisers can use to programmatically to access details of Brand Stores on Amazon. These details include a list of stores and their pages, URL and its status. This information can be combined with other Amazon Ads data and Stores Insights to get holistic views and performance for Brand Stores on Amazon and its pages.\n"," Historically, to get Brand Store details, Store owners could only access this information through the advertising console one store and page at a time. With introduction of the Brand Store APIs, Store owners can access the same information programmatically, through the Amazon Ads API. This is especially helpful for getting Brand Store details across different countries (or locales), or when a Brand is managing multiple Brand Stores.\n"," Advertisers can get details of their Brand Stores and its pages such as name, id, status and url for a given brandEntityId. API response is paginated with max number of documents returned as 30. For full technical details, please read our API documentation.\n"," October 9, 2024\n"," We are excited to launch self-service instance management APIs on the Amazon Ads API as Open Beta. AMC launched the ability to create, modify, and manage AMC instances using self-serve APIs, eliminating the need to contact an Amazon Ads representative. This feature is available to all AMC account holders, including advertising partners and direct advertisers.\n"," The new APIs offer swift instance creation with automated approvals, using which partners can start generating value within minutes of creating an instance with 1 advertiser ID. In case of instances created with multiple advertisers, the instances are activated after a manual validation within 2 days. Authorized AMC admin users can initiate an instance creation by sending a POST /amc/instances request with instance details. Advertisers can be added to an instance by calling POST /amc/instances/{instanceid}/advertisers/updates with advertiser IDs (DSP CFIDs and/or Sponsored Ads Entity IDs).\n"," Listed below are the new endpoints that will help help you with instance creation and management:\n","POST /amc/instances | Creates a new AMC instance. - POST /amc/instances/{instanceId}/advertisers/updates | Creates a new advertiser update for the requested AMC instance. - GET /amc/instances/{instanceId}/advertisers/updates/{updateId} | Gets the requested advertiser update for the requested AMC instance. - GET /amc/instances/{instanceId}/advertisers/updates | Lists advertiser updates for the requested AMC instance. - PUT /amc/instances/{instanceId}| Updates the requested AMC instance. - DELETE /amc/instances/{instanceId} | Deletes the requested AMC instance.\n"," For more information, see the AMC administration guide.\n"," October 9, 2024\n"," All snapshots endpoints are now deprecated, with a target shutoff date of December 15, 2024. Please migrate to the exports API as indicated on our Deprecations page.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/{recordType}/snapshot - /snapshots/{snapshotId} - /v2/sp/{recordType}/snapshot - /v2/sp/snapshots/{snapshotId} - /v2/sp/snapshots/{snapshotId}/download - /v2/hsa/{recordType}/snapshot - /v2/hsa/snapshots/{snapshotId} - /v2/hsa/snapshots/{snapshotId}/download - /sd/{recordType}/snapshot - /sd/snapshots/{snapshotId} - /sd/snapshots/{snapshotId}/download\n"," For more details on integrating with exports, see the Exports overview.\n"," October 9, 2024\n"," Amazon has launched the ability for all Amazon DSP self-service advertisers to book Fire TV Inline Display Banner campaigns in UK, DE, FR, IT, ES, JP and IN. The Inline Display Banner sits above the fold within the Sponsored Row of the Fire TV UI on the home tab. As the user scrolls down their screen, they will pass-over this ad placement to get to content rows below the fold. When they do so, the ad unit will reveal a “Mini-Details” view, taking up about half of the users screen.\n"," This ad unit also accepts an optional video asset (:10-:30s) with sound. Advertisers have the opportunity to set up Entertainment or digital ASIN, Prime Video Channel benefit ID, video and physical ASIN click-through destinations (only available in UK and DE). This provides an opportunity for advertisers to drive incremental reach, brand awareness and consideration.\n"," Offering Fire TV ad placements to be booked self service via Amazon DSP opens up opportunity for advertisers looking to utilize self service buying models and removes minimum spend requirements that come with managed service campaigns. This allows advertisers flexibility to launch campaigns quickly with lower SLAs compared to managed service, as well as the opportunity to optimize campaigns in real-time. Fire TV ad placements provide advertisers an opportunity to drive incremental reach, brand awareness and consideration. On average, Fire TV ad campaigns observed 2x+ incremental reach with only a 3% overlap in audience when added to Prime Video ad campaigns (Source: Amazon Internal, Jan-Mar 2024, US).\n"," For full technical details, please read our API documentation.\n"," October 9, 2024\n"," All Amazon DSP direct advertisers, as well as partners registered with the Amazon Ads Partner Network who serve clients with or without Amazon DSP, are now eligible to register for AMC. For advertisers who use only Sponsored Ads today and work with Amazon Ads partners, AMC is now an accessible clean room where their partners can leverage the rich, granular, and event-level signals to generate bespoke insights, advise optimization tactics, and take insights-based actions on their behalf.\n"," October 3, 2024\n"," Regions: All\n"," Following the release of the new version 3 reporting endpoints, we are announcing the deprecation of version 2 Sponsored Display reporting with a planned shutoff date of October 31, 2024. This includes the POST /sd/{recordType}/report endpoint. Until then, expect additional throttling levels on the current Sponsored Display version 2 endpoint as we begin the deprecation process.\n"," Going forward, you can access all version 2 Sponsored Display report types using the version 3 reporting endpoints. For more details on how to upgrade to version 3, see our Migration guide and Frequently asked questions.\n"," If you have feedback, use the Amazon Ads API Support page to submit a ticket with the subject title “SD reports v2 deprecation” by October 15, 2024.\n"," October 1, 2024\n"," A new table, dsp_video_events_feed, is now available for AMC users. The table provides video metrics for each of the video creative events triggered by the video player and associated with the impression event. For more details, see Amazon DSP video events table.\n"," October 1, 2024\n"," Users of AMC on AWS Clean Rooms can now leverage bespoke solutions from the Solutions tab of the AMC console. Log in to the AMC console to access your first solution - High-value audiences.\n"," September 27, 2024\n"," Amazon DSP has launched the ability to create new preferred deals with Amazon Media directly in inventory hub for self-service customers worldwide. With this feature, customers can create new deals with Amazon Twitch, Amazon Freevee and Amazon Prime Video based on their applicable rate cards. Customers can configure supply-side audience segmentation and submit their deal proposals for approval, and activate new deals instantly on existing line items. This feature is launching to all Amazon DSP self-service customers.\n"," With this release, Amazon DSP customers gain the ability to propose new deals without the need to work with their Amazon Ads representatives. They can discover available deals sold by Amazon Media, understand the applicable rates, choose the deals they are interested in, and precisely configure the supply-side audience segmentation they want. The deals supported at launch are approved programmatically, resulting in customers being able to activate newly created deals within minutes.\n"," For more information, please read our reference documentation.\n"," September 27, 2024\n"," Frequency cap insights show advertisers the impressions and the budget reinvested to reach more shoppers due to frequency caps used at line, order, and frequency group levels. Advertisers can now see these numbers in a new insight card and can download the data. Advertisers can also use a new Amazon Ads API to query frequency cap insights data.\n"," Frequency caps allow advertisers and agencies to save impressions by preventing ads from showing to the same customers repetitively. However, prior to this launch, Amazon DSP did not provide any way to quantify the benefits. To bridge this gap, we built Frequency Cap Insights to quantify impressions reinvested, budget reinvested, and incremental reach.\n"," For more information, see our reference documentation.\n"," September 27, 2024\n"," Advertisers globally now have the ability to target programmatic guaranteed display deals in their Amazon DSP campaigns. Similar to programmatic guaranteed video deals that are already supported with Google AdX, customers need to negotiate and finalize programmatic guaranteed display deals within the Google Authorized Buyers UI. Once the deal is finalized, the deal will now be available for targeting within display line items.\n"," Supporting programmatic guaranteed display deals via AdX expands on the programmatic guaranteed offering within Amazon DSP. Before this release, we only supported video for programmatic guaranteed. But this release provides another method of guaranteed buying to meet advertisers’ needs. For more information on the deals API, see our getting started guide.\n"," September 24, 2024\n"," The ABVP team is excited to announce the launch 3P API access for ABVP. Advertisers with ABVP access can can now use the API feature to access a URL to directly download ABVP reports instead of clicking through the ABVP User Interface.\n"," With 3P API access for our advertisers, users can now access a URL to directly download ABVP reports instead of clicking through the ABVP User Interface. Users are able to configure their API to access either the latest ABVP ASIN grain report and standard report for their advertiser.\n"," Using the two 3P endpoints below\n","/insights/brandBenchmarks/advertisers/{advertiserId}/allReportMetadata \\* /insights/brandBenchmarks/advertisers/{advertiserId}/reports/{reportType}/indexDates/{indexDate}\n"," ABVP users will be able to obtain the latest report metadata information from the first endpoint and then use that report metadata information to get a presigned S3 URL to download the report using the second endpoint. For full technical details, please review our API documentation.\n"," September 24, 2024\n"," Availability: US, UK, DE\n"," With the launch of Sponsored Products on the Amazon Global store, advertisers can now drive more discoverability and improve sales internationally using the Amazon Ads API. Learn more about the Global Store\n"," API details\n"," Product selector \\[/product/metadata]\n"," The product selector API fetches the listings required for campaign creation. With this launch, we made changes in this API to fetch the global store offers for Sponsored Products ads creation. We introduced an attribute called isGlobalStoreSelection which advertisers will set to true to fetch their global store listings.\n"," In the response, we will show a globalStoreSetting attribute that holds the details of the source country from where Amazon Global Store sourced the offer. Advertisers can further use these listings and their corresponding source country information for the campaign creation.\n"," Campaign creation \\[/sp/productAds]\n"," The campaign creation API accepts the global store specific attribute globalStoreSetting where advertisers can provide the source catalog country of the offer being used for ads creation. You can check eligibility of the products for campaign creation using the catalogSourceCountryCode information provided using the globalStoreSetting.\n"," Product eligibility \\[/eligibility/product/list]\n"," We have introduced a new globalStoreSetting attribute that takes the source country code of the Global Store ASIN which is required for the eligibility check. Eligibility check of the offer would be done in the source marketplace for the advertiser.\n"," Bid recommendations \\[/sp/targets/bid/recommendations]\n"," The bid recommendation API for new Ad groups takes a new attribute called productDetailsList, which takes the ASIN details along with its source country code. The bidding system uses the globalStoreSetting attribute and the catalogSourceCountryCode information for eligibility check of the ASINs, which is required for the bid recommendation.\n"," Keyword recommendations \\[/sp/targets/keywords/recommendations]\n"," The keywords recommendation API for ASINs takes a new attribute called productDetailsList, which takes the ASIN details along with its source country code. Keywords recommendation system uses the globalStoreSetting attribute and the catalogSourceCountryCode information to get the bid suggestions for the keywords.\n"," September 24, 2024\n"," Two new metrics have been added to V3 reporting:\n","Add to List (For Book Vendors and Authors) : Number of users who add advertised book to list during ad exposure and within attribution window 2. Qualified Borrow (For Book Vendors) : Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a certain percent of the book within the window.\n"," For more information, refer to our reporting documentation.\n"," September 18, 2024\n"," AMC has updated the Amazon DSP traffic events across impression, interaction, and Amazon Attributed event pairs. 20 new dimensional columns were added to the following AMC data views: dsp_impressions, dsp_views, dsp_clicks, dsp_impressions_by\\_\\*\\_segment, and amazon_attributed_events_by\\_\\*\\_time.\n"," September 18, 2024\n"," AMC users can use the conversion_all data source to create AMC Audiences without needing to subscribe to Paid features. Also, refer to the a complete list data sources you can use to create AMC Audiences.\n"," September 18, 2024\n"," A developer guide for AMC on AWS Clean Rooms is now available on the Advanced tools center for users to reference and set up AMC on AWS Clean Rooms.\n"," September 14, 2024\n"," Regions: All\n"," Sponsored ads and Amazon DSP advertisers can now preview, download, and pay for invoices in all countries from a single page, which also has a country-level summary of the total amount due. Advertisers can also view a country-level summary for billing setup status, which determines campaign activation, total amount due and overdue per country, and pay consolidated amounts at a country level. Third-party integrators can download invoice summaries and pay consolidated amounts at a country level.\n"," Previously, advertisers had to navigate to a billing center page at a specific country level to view the total amount due, overdue, and pay the amount for that particular country. With this launch, advertisers can view a single page with a country-level summary and paid, unpaid invoice table having invoices from all countries they are advertising in. This saves 2-3 clicks each time an advertiser goes to any country-level billing center page. This launch will also be applicable to third-party integrators where they will have public APIs to search and download invoices both individually and in bulk.\n"," More details can be found in the technical documentation(billing#tag/Billing-Invoice-Summary(s)).\n"," September 11, 2024\n"," Amazon Marketing Cloud has increased the parallel query execution capabilities of its workflows. Now, an AMC account can run 200 API queries simultaneously, a 4X increase from the previous limit of 50.  Also, an AMC instance can execute 10 API and 10 UI queries in parallel, doubling the previous limit of 5 for each type of query. See Query execution limit.\n"," September 5, 2024\n"," Regions: US\n"," To help customers discover more products in Amazon generative AI-powered shopping assistant, referred to as Rufus, your ads may appear in Rufus-related placements. Rufus may generate accompanying text based on the context of the conversation. Your campaign reports will not include Rufus metrics. For more information, contact your account representative. See our dedicated page to learn more about Rufus.\n"," September 5, 2024\n"," Regions: All\n"," Following the release of the new version 3 reporting endpoints, we are announcing the deprecation of version 2 Sponsored Display reporting with a planned shutoff date of October 31, 2024. This includes the POST /sd/{recordType}/report endpoint.\n"," Going forward, you can access all version 2 Sponsored Display report types using the version 3 reporting endpoints. For more details on how to upgrade to version 3, see our Migration guide and Frequently asked questions.\n"," If you have feedback, use the Amazon Ads API Support page to submit a ticket with the subject title “SD reports v2 deprecation” by August 31, 2024.\n"," September 5, 2024\n"," We are announcing deprecation of the v2/portfolios endpoints with a shutoff date of March 1, 2025. API callers are encouraged to use the /portfolios endpoints instead.\n"," For more information, see the technical specifications for /portfolios. For information on deprecations, review the Deprecations page.\n"," September 3, 2024\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, NL, SE, TR, UAE, SA, AU, JP, IN, BR\n"," Similar audiences (beta) utilizes the latest in AI to enhance your campaign reach to consumers exhibiting similar shopping, streaming, or browsing behaviors or interests as your selected audiences. This feature helps you serve ads to these highly relevant prospective customers more efficiently at scale, without relying on third-party cookies or ad identifiers. With this beta launch, advertisers can activate similar audiences on any line item that includes custom-built audiences based on Amazon shopping interactions.\n"," For full technical details, please see our API reference documentation.\n"," August 29, 2024\n"," We have recently introduced several enhancements to the Amazon Ads API integration dashboard. We have:\n","improved dashboard update frequency from daily to hourly. You are now able to see data for today. - enabled URL linking with associated dashboard filters. You can now create a link to share a filtered view with colleagues. - enhanced the filtering functionality in two ways: - introduced our feedback module on the “Your apps” and “Dashboard” pages so you can help us understand how to improve these features. - reorganized the help content on the dashboard pages to make it easier to find information about individual tabs and the dashboard overall.\n"," To learn more, see Integration dashboard.\n"," August 29, 2024\n"," Sponsored Brands introducing a landing page edit for Product Collection, Store Spotlight and Brand Video Ads. Advertisers and Partners are now able to change their ads landing page without creating a new campaign or ad group. Now, each ad can have individual landing pages within same ad group. You can now update your ad group based campaigns landing pages without recreating your ad group or campaign. For editing a landing page, advertisers and partners can use /sb/ads/creatives/productCollectionExtended for Product Collection ads, /sb/ads/creatives/storeSpotlight for Store Spotlight ads, and /sb/ads/creatives/brandVideo for Brand Video ads.\n"," With this launch, we have expanded to UK, DE, FR, IT, ES, NL, AE, IN, SA, SE, PL, TR, EG, SG, ZA so more advertisers can access these features using the Amazon Ads API. For full technical details, please see our API reference documentation.\n"," August 28, 2024\n"," Advertisers can now delete product audiences that are not part of an active line item. This feature will be available via the Amazon Ads API, and also in the Amazon DSP console.\n"," Before, advertisers could not delete product audiences after they were created. Being able to delete unused product audiences along with audiences that are no longer targeted will reduce clutter and provide a better experience for advertisers.\n"," For full technical details, please see our API reference documentation.\n"," August 28, 2024\n"," Regions: All\n"," Amazon Marketing Stream is available via the Amazon Ads API. When you are ready to get started, visit our Amazon Marketing Stream onboarding guide, which will walk through the process of getting API access, integrating with AWS, and subscribing to campaign datasets using the Amazon Marketing Stream API. If you are already integrated with Amazon Marketing Stream, see the new Amazon DSP dataset documentation.\n"," August 22, 2024\n"," We are announcing deprecation of the application/vnd.spthemebasedbidrecommendation.v3+json content type for Sponsored Products theme-based bid recommendations with a shutoff date of May 15, 2025. API callers are encouraged to use application/vnd.spthemebasedbidrecommendation.v4+json instead.\n"," For more information on version 4, see the technical specifications for theme-based bid recommendations. For information on deprecations, review the Deprecations page.\n"," August 15, 2024\n"," With the launch of user management APIs for Amazon Ads, AMC admin users can now programmatically invite admin and viewer users to their account. For details, see Account management.\n"," August 15, 2024\n"," The status of audiences created using AMC rule-based audience APIs can be viewed using Amazon DSP list audience endpoint. For details on how to view the status of a specific audience Id, see View audiences.\n"," August 15, 2024\n"," Regions: All\n"," Creative assets is introducing two new batch API endpoints to help you manage your creative assets more efficiently. The new endpoints include POST /assets/batchRegister, which enables you to add custom tags and other metadata to assets to aid in asset management and usage for multiple assets in a batch API call, and GET /assets/register/batch/{requestId}, which provides registration details and current status of the individual assets requested in a batch API call.\n"," These endpoints are available for all sponsored ads campaign types as well as for Amazon DSP, via the Amazon Ads API.\n"," August 15, 2024\n"," This Optimal frequency analysis playbook dives deeper into the concept of ad frequency to and guides users with tactics to get clear optimization insights and direct actions within Amazon Ads to optimize frequency analysis.\n"," An example of the optimization is to define the right value threshold for identifying audiences that are considered under-served from a frequency standpoint and activate those. To learn more, visit Optimal frequency analysis playbook.\n"," August 15, 2024\n"," Note that data that was uploaded using Advertiser data upload, version 1.0 (ADU 1.0) cannot be queried. To continue querying datasets that you had uploaded in ADU 1.0,  delete the previously uploaded data, and re-upload using Advertiser Data Upload 2.0 (ADU 2.0). See Advertiser data upload FAQs. Reach out to amc-support@amazon.com for any further assistance.\n"," August 12, 2024\n"," Regions: US\n"," We have enabled brand store support for Sponsored TV campaigns in the US. Now, vendors and registered brand owners can specify a page within their brand store to link viewers to with their Sponsored TV ads. When these ads are eligible for interactive ad formats, audiences can scan QR codes, click the ad, or even interact with the ad via their remote to discover more about your brand. When viewers interact with these ads with their remote, they will receive an email with a link to an advertiser specified brand store. As always, Sponsored TV interactive ad formats are turnkey, with no action required as long as they meet our eligibility criteria.\n"," Previously, advertisers could only link to ASIN detail pages with their Sponsored TV ads, so if an ASIN went out of stock or assets featured multiple ASINs, advertisers either had to manually create new ads or choose one of many ASINs to link viewers to.  Now, advertisers can use more of their assets— like those those that feature multiple ASINs or size-intensive categories (for example, shoes) for their Sponsored TV campaigns.\n"," For full technical details, review the API documentation.\n"," Learn more about Sponsored TV creative specs and interactive ad formats\n"," August 10, 2024\n"," Amazon Ads API customers can now perform user management-related read operations entirely through API integration. Specifically, they list users as well as their roles and permissions for any Amazon Ads account across all countries and ad products.\n"," Previously, user management functionality was only available through the advertising console. This launch marks the second milestone in a series of authorization API launches which make user management functionality available to Amazon Ads API customers. In April 2024, Amazon Ads launched user invitation APIs. With this launch, customers can list users, as well as their roles and permissions associated with any Amazon Ads account via public API, without the need to visit the advertising console. Customers can use these APIs for advertising accounts across all ad products, including sponsored ads, Amazon DSP, and Amazon Marketing Cloud (AMC). Customers can also use these APIs to list users, roles, and permissions for manager accounts. Finally, customers can pass a Global Account identifier with a country code for the sponsored ads account to invoke these APIs. By integrating with these APIs, third parties can build user management workflows on their own advertising platforms.\n"," New APIs include:\n"," For more information, review the API specification.\n"," August 9, 2024\n"," Advertisers on Amazon DSP now have access to incremental and exclusive reach (vs. Linear TV) reporting for their Amazon streaming TV campaigns. The two metrics that are part of this suite are Incremental Reach Rate and Exclusive Reach Rate. The Incremental Reach Rate quantifies the number of unique households reached by the STV campaign who were not exposed to Linear TV ads for the same product, expressed as a percentage of Linear TV household reach. The Exclusive Reach Rate quantifies the number of unique households reached by the STV campaign that were not exposed to Linear TV ads for the same product, expressed as a percentage of the STV campaign total household reach.\n"," The combination of these two metrics will enable an advertiser to determine the impact of the STV campaign reach in comparison to their Linear TV campaign and also assess the return on investment (ROI) on the STV investments specifically with the Exclusive Reach Rate. STV Incremental Reach complements the Incremental Reach Forecast already available in the STV channel planner, so that advertisers can compare their past performance with potential reach.\n"," To learn more, see the exclusiveReachRate and incrementalReachRate column details.\n"," August 9, 2024\n"," Regions: All\n"," Sponsored Display campaigns using tactic T00030 can now access all targeting capabilities available to endemic advertisers, including contextual targeting. Before this launch, Sponsored Display campaigns with tactic T00030 could only be used alongside audience strategies and entertainment targeting. To ensure backwards capability, there are no changes to tactic T00020 and it can continue to used for contextual targeting. The T00020 tactic will be supported for the foreseeable future, however we recommend using the T00030 tactic for new campaign creation to unlock all Sponsored Display targeting options.\n"," By allowing greater Sponsored Display campaign flexibility with tactic T00030, advertisers can focus on achieving their marketing goals, without campaign level targeting constraints. Advertisers can use contextual targeting to help generate detail page traffic and then lean into audience strategies to reengage audiences to help secure missed sales opportunities or further cultivate brand loyalty. Within audience strategies, we added additional audiences for entertainment targeting (Games, Music & TV, Music & Radio) which can help advertisers reach potential customers during their entertainment journey - whether they are live streaming, watching videos, or researching games and movies on various sites beyond the Amazon store.\n"," For full technical details, please see our Sponsored Display targeting API, including  ContentTargetingPredicate, TargetingPredicate, and TargetingPredicateNested that can now be used for Sponsored Display campaigns using T00030 for endemic advertisers. For more information on entertainment targeting, see our updated developer guide.\n"," August 8, 2024\n"," We are announcing the deprecation of /v2/sp/targets/bidRecommendations effective August 15, 2024. The theme-based bid recommendations endpoint is the replacement for /v2/sp/targets/bidRecommendations. The v2 endpoints will shut off on May 15, 2025.\n"," For more information, review the Deprecations page.\n"," August 6, 2024\n"," Regions: US, AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, BR, SE, TR\n"," For the first time, Amazon has provided the ability to integrate Amazon forecasts across all first-party and third-party supply. Using the Reach Forecasting API, you can programmatically generate reach forecasts showing the available reach based on your brand and campaign parameters.\n"," To learn more, view the technical specifications for the Reach Forecasting API.\n"," August 2, 2024\n"," Following the release of the new version 3 reporting endpoints, we are announcing the deprecation of version 2 Sponsored Display reporting with a planned shutoff date of October 31, 2024. This includes the POST /sd/{recordType}/report endpoint.\n"," Going forward, you can access all version 2 Sponsored Display report types using the version 3 reporting endpoints. For more details on how to upgrade to version 3, see our Migration guide and Frequently asked questions.\n"," If you have feedback, use the Amazon Ads API Support page to submit a ticket with the subject title “SD reports v2 deprecation” by August 31, 2024.\n"," August 2, 2024\n"," Advertisers will now be able to create Sponsored Display campaigns in a test account. Test accounts are beneficial because they allow integrators to make API requests to test and learn about the functionality in a safe manner, without serving ads or incurring costs. These campaigns will not be served to shoppers and will not incur any advertising charges. For more information on using test accounts for Sponsored Display campaigns, see our Using test accounts for Sponsored Display documentation in test accounts.\n"," July 31, 2024\n"," You are now able to create, retrieve, and delete Inherited Settings in Manager and Advertiser accounts in the Amazon DSP UI and API.\n"," Inherited Settings enable Managers and Advertisers to set settings that are used as presets when creating a new line item. Our first release includes Display inventory and viewability. We will communicate additional media types and settings when they become available.\n"," For information, see our API documentation.\n"," July 30, 2024\n"," A collaboration is a secure logical boundary in AWS Clean Rooms in which one member (such as an advertiser) can perform SQL queries on configured tables from other members (such as an advertiser partner or other publisher). AMC and advertiser collaborations in AWS Clean Rooms enable AMC customers to use AWS Clean Rooms to associate their first-party (event and identity) data with AMC data, to collaborate with Amazon Ads unique signals including matching audience identifiers enabled by AWS Entity Resolution, and generate differentiated insights to activate more relevant campaigns with Amazon Ads, all without having to share or move your data from your AWS cloud environment.\n"," See the complete list of AMC - AWS Clean Rooms reference.\n"," July 30, 2024\n"," This new playbook provides an overview of off-Amazon signals, how to load signals into AMC, and 12 non-endemic use-cases along with suggested actions. Advertisers can use this playbook to create valuable analysis of and take action with off-Amazon data. To learn more, visit Off-Amazon conversions playbook.\n"," July 30, 2024\n"," Advertisers can now measure their retail and ads brand-category Subscribe & Save (SNS) performance with two new metrics in Brand Metrics.\n","Subscribe & Save customers: Total individual Subscribe & Save customers in the selected category over the selected timeframe. 2. % Subscribe & Save new-to-brand customers: The percentage of Subscribe & Save customers that are new-to-brand in the selected category over the selected timeframe.\n"," For both SNS metrics, we provide Category Median and Category Top benchmarks:\n","Category Median: The performance of the 50th percentile of brands in the selected category. - Category Top: The average performance of the 95th–99th percentile of brands in the selected category.\n"," Advertisers, agencies, and integrators can now understand their brand Subscribe & Save performance within a retail category, and quantify how many shoppers who purchased in a selected week or month are SNS customers and whether or not they have subscribed for the first time with their brand in the TTM (trailing twelve months for example, new-to-brand). Advertisers can also benchmark their ad attributed and retail performance amongst category peers. With these benchmarks brands not running SNS can get insight into the missed SNS opportunities in category, and for brands running SNS they can gauge their performance in category against peers.\n"," SNS data is also available through the Brand Metrics Public API is the /insights/brandMetrics/report/{reportId} endpoint. For full technical details, please read Brand Metrics API Documentation.\n"," July 25, 2024\n"," Regions: CA, MX, BR, UK\n"," Sponsored TV is now available in Canada, Brazil, Mexico, and United Kingdom to enable advertisers access to a self-service streaming TV advertising solution internationally.\n"," Please see our developer guide to get started on Sponsored TV.\n"," July 25, 2024\n"," We have launched a forecasting service for Sponsored TV (ST), allowing Sponsored TV advertisers to view impressions for their campaigns. The Amazon Ads ST forecasting provides forecasts based on the Sponsored TV campaign and ad group settings. Currently, it supports weekly impressions forecasts and will expand to include other forecast metrics in the future. Forecasts are based on machine-learning models that are built on the observable performance of historical campaigns with similar settings. To learn more, view the technical specifications for the forecasting API.\n"," July 18, 2024\n"," The Portfolios version 3 API brings parity between API integrators and the Amazon Ads console, and is the same API used by the console for portfolio functionality. Use this API to group your campaigns and set budgets for a given portfolio and group of campaigns. To learn more, view the technical specifications for the Portfolios API.\n"," July 11, 2024\n"," Regions: All\n"," To offer a more complete view of campaign results, Amazon Ads uses modeling to account for conversions attributable to your campaign, but that are not directly measured due to the phasing out of third-party cookies and changing regulations. In these cases, Amazon Ads has insights about the ad click or view and the conversion that occurred, but cannot establish a direct link between the two events. In that scenario, Amazon Ads predicts the link between the ad interaction and the conversion event. Modeled conversions are reported in the same columns as directly attributed conversions, such as on the Purchase or Detail Page View column. In some cases, if we cannot produce meaningful estimates at the level of your reporting breakdown—for example at the targeting clause level—we will report conversions on an Unallocated row.\n"," Amazon Ads models conversions so that advertisers can continue to measure the full impact of their advertising spend across all audiences, including previously un-addressable audiences, due to industry changes in third-party cookies and regulations. This helps advertisers continue to set and optimize bids and budgets effectively.\n"," Advertisers using Amazon Ads API may see conversions reported on rows with “Unallocated,” or -20, set as the dimension value for reports grouped by targeting, as an example. These rows represent conversions attributable to that ad line or order that cannot be allocated at the level at which the report is returned. For full technical details, please read our reporting documentation. To learn more about modeled conversions, please visit the Support Center\n"," July 8, 2024\n"," Regions: ZA\n"," We have added support for South Africa (ZA) to the Amazon Ads API. For more details, see the API endpoints by region, Bid constraints by marketplace, Budget constraints by marketplace, as well as the countryCode, currencyCode, and timezone parameters in the profiles reference.\n"," July 8, 2024\n"," Regions: ZA\n"," We have added support for South Africa (ZA) to bulksheets. For bulksheets, you can reference Bid constraints by marketplace and Budget constraints by marketplace.\n"," July 5, 2024\n"," The API onboarding support team will transition from Jira to Zendesk as our primary platform for managing customer support tickets starting July 8, 2024.\n"," This change aims to provide a more direct and recognizable channel for assistance. If you experience issues onboarding to the API, you can reach our support team directly through the following email address: ads-api-onboarding@amazon.com\n"," Please add ads-api-support@amazon.com, ads-api-onboarding@amazon.com, and support@amazon-ads-api.zendesk.com to your email safe sender list to ensure seamless communication.\n"," For more information about support for the Amazon Ads API, see \"Need support?\" in our Zendesk platform.\n"," June 27, 2024\n"," You are now able to delete and edit audiences with “Failed” status via the AMC UI and API. This allows you to only keep the custom audiences of use to you and reduce redundant audiences. For more information, refer to Manage failed audiences.\n"," June 20, 2024\n"," Legacy Sponsored Brands version 3 campaigns created before October 2022 recently went missing in the advertising console after being rejected during creative moderation.  These servingStatusDetails for these campaigns returns REJECTED_DETAIL in POST /sb/v4/campaigns/list. These campaigns will show as ARCHIVED  in POST /sb/v4/campaigns/list and the advertising console by August 15th, 2024.\n"," To prevent similar issues with version 3 campaigns, we strongly recommend recreating all version 3 Sponsored Brands campaigns as new version 4 campaigns. You can use Sponsored Brands version 4 APIs or clone existing campaigns in the advertising console. To learn more about key benefits of using new ad group based campaigns, see our Benefits guide.\n"," June 13, 2024\n"," In October 2022, Sponsored Brands introduced version 4 campaigns, featuring multiple ad groups and ads. Prior to this launch, advertisers lacked the ability to create a Sponsored Brands advertising campaign aligned with their marketing strategy. The introduction of ad groups enhances flexibility, particular for managing campaigns across ad products, as both Sponsored Products and Sponsored Display supports similar campaigns structure.\n"," These campaigns will allow you to leverage new features such as:\n","Increasing brand impression share for top-of-search placement with BRAND IMPRESSION SHARE goal-based campaigns. 2. Expanding product collection ads into slideshow ads by adding two to five lifestyle images. 3. Assigning individual landing page URLs to each ad and modifying existing landing page ads URLs. 4. Testing different creative and landing page combinations within ad groups. 5. Creating campaigns with vertical video optimized for mobile shoppers. 6. Showcasing videos with a brand store featuring three products or no products. 7. Accessing a wide range of new metrics including addToCartViews, newToBrandDetailPageViewViews, and newToBrandDetailPageViewClicks.\n"," To learn more, view our benefits guide.\n"," June 12, 2024\n"," We recently implemented a feature to prevent duplicate requests for version 3 reporting APIs. If you make a createReport request before a duplicative report request is complete, you will now receive an API response status code of 425, indicating that it is too soon to make the new request. If this happens, you should wait for your existing request to complete before creating another identical createReport request. Learn more about v3 reporting and v3 report statuses\n"," If your use case requires multiple identical reporting requests, we encourage you to explore alternative reporting options such as Amazon Marketing Stream, which pushes data to partner or advertiser-owned AWS destinations in near real-time, without needing to call the API repeatedly.\n"," For more help or technical assistance, reach out to the Solutions Architect or Partner Manager assigned to you. If you do not have an assigned contact, you can request additional support through the API service desk.\n"," June 12, 2024\n"," Regions: US, AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, BE, BR, EG, PL, SA, SE, SG, TR, EG, SA\n"," We launched a new API optimization rules (beta), to simplify the campaign management process for advertisers using Sponsored Brands’ drive page visits goal. This launch allows advertisers to set performance-based parameters that remove the guess work from selecting an exact bid for each target. This helps advertisers of any size and with any budget achieve their goals with the help of Amazon first-party data and machine learning capabilities.\n"," For goal-based campaigns set-up to drive page visits, advertisers can apply a cost-per-click threshold. We will then utilize machine learning models to define the bids while adjusting base bids up and down with the goal of increasing clicks, all while adhering to the cost-based rules. While Amazon Ads cannot guarantee performance, if the campaign is not meeting the cost target over a 21-day period (excluding special days), we recommend adjusting cost target or budget to allow our systems meet the cost target and achieve more clicks.\n"," Optimization rules are now available for Sponsored Brands through the Amazon Ads API. For full technical details, see our see our optimization rules API and developer guide.\n"," June 6, 2024\n"," The conversions_all data source has been updated to remove Amazon Ad Server (previously Sizmek Ad Server) traffic events from the ad-exposed, exposure_type column logic. Additionally, there was an update to the conversions_all data source to negate and resolve duplicative conversions_ids for the repeatSnSOrder conversion event sub-type records.\n"," June 6, 2024\n"," The content in the Support Center contains web-based topics to help you learn how to use and navigate the AMC UI. To access AMC UI documentation in the advertising console Support Center, click the ? icon in the AMC console header, at the top-right of the page and select Learn by Product > Amazon Marketing Cloud. Note that you must have access to AMC UI to access AMC content in Support Center.\n"," June 6, 2024\n"," This new resource, a Jupyter Notebook containing a collection of Python scripts, will help you streamline onboarding the Amazon Ads API and exploring AMC APIs. This includes endpoints for administration and workflow management with example request body and automations that make it easy to manage authorization and explore AMC APIs. You can find the collection files in the GitHub repository for Amazon Marketing Cloud\n"," To use the collection, download the Jupyter Notebook from GitHub, and follow the instructions listed to onboard and get started with AMC.\n"," June 6, 2024\n"," Availability: Only within the US AMC account marketplace\n"," AMC dataset name: ncs_cpg_insights_stream\n"," Lookback: 12.5 month, 19 day delay, and refreshed weekly (on Fridays)\n"," NCS CPG Insights Stream provides modeled offline transaction signals for all US households. Transaction signals (dollars and units) are aggregated at the weekly household level for specified product categories. Transaction signals are acquired from a diverse and balanced set of brick-and-mortar stores in the US covering over 3 million UPCs. The subscription allows AMC customers to measure the impact of your advertising on offline sales, understand cross-channel purchasing journeys, and discern audiences with different purchasing patterns online and offline.\n"," June 4, 2024\n"," Availability: Egypt, Saudi Arabia, and United Arab Emirates\n"," When you create Sponsored Products campaigns using bulksheets, you can now add keywords in your preferred or native language. To use this new feature, you will input keywords in your preferred language in a new column labeled “Native language keyword,” and input your preferred language code in a new column labeled “Native language locale.” Leave the “Keyword text” field blank. When you upload your bulksheets file, your “native language” keyword will be automatically translated into English or the default language of your locale.\n"," Before this launch, advertisers in some locales had to enter keywords in English, even if their preferred or native language was not English. With keyword translations, advertisers have the option to enter keywords in their native language instead.\n"," June 3, 2024\n"," Soon, Amazon Marketing Stream will start adding new metrics to existing datasets. Some of these metrics may be in closed beta, so it is possible that you will not have access to the metric values initially and will instead see zero values for the data. We recommend that you ensure your Stream implementation accommodates for new metrics to avoid any breaking changes whenever metrics are added.\n"," We will publish a new release note, along with more guidance about the new metrics, when they are generally available to all customers.\n"," June 3, 2024\n"," With this launch, partners gain visibility into what Amazon account managers suggest for their advertisers. Partners can then determine how to use these recommendations to help their advertisers achieve marketing objectives, including the ability to directly activate them through the new /apply API functionality. Bringing these recommendations into Partner Opportunities gives partners a single distribution channel to download actionable and relevant recommendations for the advertisers each agency or tech partner supports.\n"," Recommendations and insights help advertisers focus more efficiently and spend time on work that is more likely to drive positive results, such as increasing sales or improving return on ad spend (ROAS). Partners have expressed interest in understanding the recommendations from Amazon Ads account teams so they can add context and help activate these recommendations for advertisers. Now, partners can leverage Partner Opportunities API to access these recommendations for each advertiser they manage, giving partners more visibility and flexibility to help advertisers work toward their goals.\n"," This is available to all registered Amazon Ads partners using the Ads API. Partners must be registered in the Amazon Ads Partner Network and setup for API access. For more information on API access for partners, see the onboarding guide.\n"," Within the existing Partner Opportunities API, partners will see new opportunities for each of the new recommendations. These recommendations will be categorized using the AMAZON_ACCOUNT_TEAM_RECOMMENDATIONS Objective Type. Recommendations using this AMAZON_ACCOUNT_TEAM_RECOMMENDATIONS objective type can be used in the new /apply API endpoint to directly activate the recommendations for each specific advertiser. See all Partner Opportunities API documentation for more information.\n"," May 21, 2024\n"," An Amazon Business (AB) bid adjustment for Sponsored Products is in development and will be available in Amazon Business Marketplaces - US, CA, MX, DE, IT, FR, ES, UK, IN, JP. In Q4 2024, advertisers using the Amazon Ads API or bulksheets will be able to apply a custom bid adjustment for placements on AB to their existing or new Sponsored Products campaigns. The new bid adjustment for AB can be set independently or in addition to placement bid adjustments for top-of-search (first page), rest-of-search and product-pages. With this new single AB bid adjustment, advertisers can boost their bids by up to 900% across AB placements. Regardless of their use of the AB bid adjustment, advertisers will have access to reporting that shows campaign performance on AB. Those advertisers who use the AB bid adjustment can gauge its impact on AB campaign performance through this reporting. See our reference documentation for more information.\n"," May 21, 2024\n"," Advertisers in France, Germany, Italy, Netherlands, Spain, Sweden,  United Kingdom and India now have the ability to work with publishers to create programmatic guaranteed deals, and use those deals on video line items. This capability enables advertisers to leverage premium video inventory from publishers through Amazon Publisher Direct (APD), Google, FreeWheel, and Magnite Streaming. When a line item is set to use a programmatic guaranteed deal, the interface is streamlined and simplified to reflect that the publisher will be managing the inventory.\n"," May 15, 2024\n"," Regions: US, AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, BE, BR, EG, PL, SA, SE, SG, TR, EG, SA\n"," We have extended the Sponsored Display optimization rules (beta) API to inflight campaigns enabling advertisers to quickly turn any campaign into optimization rule based campaign while also allowing the feature to be turned on or off. This API helps to simplify the campaign management process for advertisers using Sponsored Display. This launch allows advertisers to set performance-based parameters that remove the guess work from selecting an exact bid for each target.\n"," For campaigns optimized for reach, clicks, or conversions, advertisers can apply a cost-based rule like cost per thousand ad views (vCPM), cost per click (CPC) or cost per order (CPO). We will then utilize machine learning models to define the bids while adjusting base bids up and down with the goal of increasing outcomes, all while adhering to the cost-based rules.  Additionally, we may add targets while your campaign is running to try to stay at or below a cost per order value you have specified. While Amazon Ads cannot guarantee performance, if the campaign is not meeting the cost target over a 21-day period (excluding special days), we recommend adjusting cost target or budget to allow our systems to reach the right audiences.\n"," Optimization rules are now available for Sponsored Display through the Amazon Ads API. For full technical details, see our reference documentation.\n"," May 10, 2024\n"," The Developer Support Engineering team will transition from Jira to Zendesk as our primary platform for managing customer support tickets starting May 13, 2024.\n"," This change aims to provide a more direct and recognizable channel for assistance, streamlining the initial step of ticket creation. Moving forward, you can reach our support team directly through the new email address: ads-api-support@amazon.com\n"," To ensure seamless communication, please add ads-api-support@amazon.com to your email safe sender list. This action will help prevent our communications from being inadvertently marked as spam, allowing us to provide timely and effective support through Zendesk.\n"," As with Jira, the API support team will offer support via the Help Center. Once you have established a login, the Help Center can be accessed at amazon-ads-api.zendesk.com. For more information about support for Amazon Ads advanced tools, see our Support overview.\n"," May 10, 2024\n"," For streaming TV ad-impressions delivered on Freevee, we have expanded our traffic reporting to add content transparency reports in downloadable reports. Advertisers can now see which Content Genre and Content Rating their ad impressions were delivered on. Advertisers can already use Content Genre, and Content Rating during planning and campaign settings. These reports provide advertisers a closed loop feedback with their campaign settings and media plans.\n"," As advertisers transition their budgets from linear TV to digital media like streaming TV, content signals provide them greater visibility into their investments. Advertisers can now assess if their ads were contextually relevant and use the reporting data to plan their future media investments and adjust their campaign settings.\n"," May 3, 2024\n"," Following the release of the new version 3 reporting endpoints, we are announcing the deprecation of version 2 Sponsored Display reporting with a planned shutoff date of October 31, 2024. This includes the POST /sd/{recordType}/report endpoint.\n"," Going forward, you can access all version 2 Sponsored Display report types using the version 3 reporting endpoints. For more details on how to upgrade to version 3, see our Migration guide and Frequently asked questions.\n"," If you have feedback, use the Amazon Ads API Support page to submit a ticket with the subject title “SD reports v2 deprecation” by August 31, 2024.\n"," May 3, 2024\n"," Sponsored Brands campaign performance forecasting provides metric forecasts to advertisers during the campaign creation process.\n"," Currently we have impression metrics for detail page view campaigns which gives the estimated weekly and monthly impression based on targeting, bid, and budget settings. Now we are adding support for click forecasting. To use click forecasting, you will need to add creativeAsins in the ad group setting to help us predict the clicks for campaign. Then the response will include forecasted clicks.\n"," For more information, see the API reference.\n"," May 1, 2024\n"," Amazon Marketing Stream is expanding its data delivery options by introducing Amazon Data Firehose as a new destination. Amazon Data Firehose is a fully managed service for delivering real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Redshift, OpenSearch Service, OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers. With Amazon Data Firehose, customers can subscribe to Amazon Marketing Stream datasets and have them delivered to a location of their choice—including the options mentioned here. Without Firehose, Stream datasets can only be delivered to Amazon SQS, so Firehose provides more flexibility for customers who prefer a different data output.\n"," By integrating Amazon Data Firehose as a delivery option, customers can streamline their data ingestion process and minimize operational costs. As a fully managed service, it automatically scales to accommodate data volume, and eliminates the need for ongoing administration. Additionally, Firehose can batch, compress, and encrypt data before delivery—reducing storage consumption at the destination and enhancing security.\n"," To learn more, view the Getting started guide .\n"," April 23, 2024\n"," Regions: Egypt & Saudi Arabia\n"," Soon, customers in Egypt and Saudi Arabia will be able to add keywords in their preferred or native language. The keywords will then be automatically translated into English when the file is uploaded. When this new feature launches, you will see two new columns labeled Native language keyword and Native language locale, where you can input keywords in your native language along with the language code. When you upload the bulksheets file, the translated keywords will automatically populate the current “Keyword text” field. You can see the translated keywords if you download a file later.\n"," We will provide more details and documentation for using this feature once it launches.\n"," April 23, 2024\n"," Regions: US\n"," Keyword Groups is a new targeting control for Amazon Ads Sponsored Products keyword-based campaigns that enables advertisers to reach relevant audiences through a collection of keywords.\n"," Once a Keyword Group specification is created, the performance of Keyword Groups will be available in the search terms report. Keyword Groups improves campaign performance by dynamically updating the keywords within a group through the campaign lifecycle and eliminates the need for advertisers to constantly curate new keywords. Additionally, Keyword Groups can be used alongside keywords within the same ad group.\n"," Keyword Groups can be accessed through a new Keyword Groups recommendations API included in this release. Furthermore, existing operations for bid suggestions and viewing/updating have been updated to accommodate Keyword Groups.\n"," APIs:\n","POST /sp/targeting/recommendations/keywordGroups: Use this API operation to get recommended Keyword Groups for a list of ASINs. Please use Keyword Groups recommended by this API for your ASINs to benefit from the feature only.  POST /sp/targets: This is an existing operation that has been extended to support creation of Keyword Groups.  POST /sp/targets/list: This existing operation will return all Keyword Groups for an ad group \\* POST /sp/targets/bid/recommendations : This existing API endpoint now gives bid recommendations for Keyword Groups with the following options. See theme based bid recommendations API documentation for more information.\n"," See our documentation for more information.\n"," April 20, 2024\n"," As we recently announced AMC APIs being available on Amazon Ads, we recommend users currently on the AMC instance-level APIs migrate to the upgraded APIs as soon as possible to take advantage of the enhanced security, usability, and performance of new APIs.\n"," After the instance-level APIs retire, calling any of the endpoints will return a 404 error. Migrating to the new APIs at the earliest can help prevent disruptions to your existing business operations. Visit the AMC migration hub to learn more.\n"," In addition, new AMC instances created after March 04, 2024 will not be compatible with the instance-level APIs. You need to build to Amazon Ads APIs before this date to make sure your API workflows can be applied to your new instances.\n"," April 18, 2024\n"," The shutoff date for Sponsored Brands version 3 campaign management APIs will be May 30th, 2024. As a reminder, Sponsored Brands version 3 draft and media APIs were deprecated on January 31, 2024. Please migrate to the new version 4 campaign management endpoints as documented on our deprecations page and in our migration guide. As a part of this deprecation, Sponsored Brands draft endpoints have reached their end of life and will not be replaced with new endpoints.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/sb/campaigns/  /sb/adGroups/  /sb/adGroups/{adGroupId}  /sb/campaigns/{campaignId}  /sb/drafts/campaigns  /sb/drafts/campaigns/{draftCampaignId}  /sb/drafts/campaigns/submit  /media/upload  /media/complete\n"," If you would like to share feedback, please use the Amazon Ads API Service desk to open a ticket with subject title \"SB v3 Campaign CRUD Deprecation\" by April 30th, 2024.\n"," April 18, 2024\n"," These new capabilities are in preview only. We will update our release notes and API documentation once this functionality is made available. Advertisers will soon have access to two new goals, “Acquire New Customers\" and “Drive Ad Views”, each with a unique set of campaign controls that help achieve that goal. The “Acquire New Customers\" goal can be measured using the metric newToBrandPurchases, helping advertisers drive sales from customers who have not purchased a brand product within a 1-year lookback. The “Drive Ad Views\" goal can be measured using the metric viewableImpressions, helping advertisers reach and engage audiences across shopping and entertainment contexts.\n"," Along with the new goals mentioned, advertisers will soon have the option to input specific cost controls to help achieve those goals within a given cost threshold. As we introduce these changes, we will also update and improve our insights and recommendations to help further maximize campaign goals.\n"," For full technical details, see our updated Sponsored Brands API reference documentation. Under the create campaign resource, we have expanded the number of goal options, including ACQUIRE_NEW_CUSTOMERS and AD_VIEWS.\n"," April 9, 2024\n"," Regions: All\n"," Amazon Ads API customers can now invite users to advertising accounts entirely through API integration. They can perform all invitation-related operations throughout the invitation lifecycle, including creating, redeeming, revoking, listing, and resending invitations.\n"," Previously, all user management functionality was only available through the advertising console. This launch marks the first milestone in a series of authorization API launches, which will allow customers to execute invitation and user management-related actions entirely via the Amazon Ads API, without the need to visit the advertising console. Customers can now use the API to create and manage user invitations for sponsored ads accounts, including vendors, authors, merch-on-demand, and FireTV. This new user invitation functionality is also available for manager accounts and Amazon DSP. By integrating with these APIs, third-party partners can also build user invitation workflows on their own advertising platforms.\n"," New APIs:\n","POST /user-invitations: Create a batch of invitations. Given an advertising account identifier, a user email address, and a role or set of permissions, invite one or many (up to 50 in batch) users to the advertising account. Invitations expire after 2 weeks.  PUT /user-invitations: Update a batch of invitations. Given a list of one or many (up to 50) invitation identifiers, update these invitations to revoke them, or resend them to refresh the expiration window.  PUT /user-invitations/redeem: Redeem an invitation. Given an invitation identifier, redeem the invitation, and be added to the account upon redemption. This operation requires that the terms agreement be shown to the user and accepted before redemption.  POST /user-invitations/list: List the pending invitations for a given account.  GET /user-invitations/{invitationId}: Get details about a given invitation, such as role, permissions, email, expiration and account identifier. This API will also return a list of termsTypes, which indicates the type of terms (MARKETING_CLOUD, ADVERTISING, PARTNER_NETWORK) that must be accepted before redemption, using the POST /termsTokens API.\n"," See our reference documentation for more information.\n"," In addition, we have updated the existing POST /termsTokens API.\n","POST /termsTokens: Create a terms token for the customer to accept Amazon Ads terms. With this update, you can now specify the type of terms to be accepted (MARKETING_CLOUD, ADVERTISING, PARTNER_NETWORK) depending on the type of account the user is invited to. For more information, see the API specification.\n"," April 4, 2024\n"," Region: EU\n"," The Ad Library API is now available. The Ad Library API contains data about ads and affiliate marketing content displayed on the Amazon EU store (Germany, France, Italy, Spain, Sweden, Poland, Belgium, Netherlands) and is available globally. Examples of data include advertiser or creator name, impressions by country, and the name of the product, service, or brand featured.\n"," To get started, view the Ad Library overview.\n"," April 3, 2024\n"," This summit is designed to educate integrators who are at the beginning and intermediate stages of their journey with Amazon Ads APIs, Amazon Marketing Stream, and Amazon Marketing Cloud (AMC). You will learn about best practices and hear ideas for capabilities you can build. We will deep dive into Amazon APIs and reporting tools and share advanced use cases. Hear from Amazon product leaders about topics that include:\n","Enhancing reporting and optimization capabilities - Building full-funnel solutions for a variety of advertising customers - Media planning and programmatic capabilities - And much more!\n"," There will also be opportunities to get answers to your technical questions and provide product feedback. The summit will be held on May 16-17, 2024 in NYC.\n"," March 18, 2024\n"," Advertisers in Japan, Saudi Arabia, Turkey, and United Arab Emirates now have the ability to work with publishers to create programmatic guaranteed deals, and use those deals on video line items. This capability enables advertisers to leverage premium, video inventory from publishers through Amazon Publisher Direct (APD), Google, FreeWheel, and Magnite Streaming. When a line item is set to use a programmatic guaranteed deal, the interface is streamlined and simplified to reflect that the publisher will be managing the inventory.\n"," Programmatic guaranteed deals enable direct-buys between advertisers and publishers, while still tapping programmatic model benefits. By using programmatic guaranteed deals, advertisers can access additional video inventory, help reduce manual campaign activation and management processes, and work with publishers on contextual targeting. This can help advertisers save time, become more efficient, meet their delivery goals, and help customers discover new brands.\n"," See our reference documentation for more information.\n"," March 18, 2024\n"," Regions: BE, BR, EG, PL, SA, SE, SG, TR, EG, KSA\n"," We have expanded Sponsored Display optimization rules (beta) API to new regions. This API helps to simplify the campaign management process for advertisers using Sponsored Display. This launch allows advertisers to set performance-based parameters that remove the guess work from selecting an exact bid for each target. This helps advertisers of any size and with any budget achieve their goals with the help of Amazon first-party data and machine learning capabilities. Before this launch, advertisers needed to translate their desired goals into efficient bids and targets across different cost types. In reality, this turns out to be the biggest issue driving lower scale and campaign effectiveness. By translating goals into bids using machine learning with optimization rules (beta), Amazon can help advertisers achieve better results through continuous optimization. In the future this will be extended to targeting optimizations to further maximize goals.\n"," For campaigns optimized for reach or click, advertisers can apply a cost-based rule like cost per thousand ad views (vCPM) and cost per click (CPC). We will then utilize machine learning models to define the bids while adjusting base bids up and down with the goal of increasing outcomes, all while adhering to the cost-based rules. While Amazon Ads cannot guarantee performance, if the campaign is not meeting the cost target over a 21-day period (excluding special days), we recommend adding additional targets to allow our systems to reach the right audiences.\n"," Optimization rules are now available for Sponsored Display through the Amazon Ads API which was previously only available in AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK and US regions. For full technical details, see our reference documentation(sponsored-display/3-0/openapi#tag/Optimization-Rules-(beta)).\n"," March 14, 2024\n"," These premium video ad placements are represented via the enumerated DSP supply sources listed below:\n","Sports on Prime (including TNF and NBA): supply_source = ‘AMAZON LIVE STREAM’ (supply_source_id: 610) \\* Prime Video (on-demand content): supply_source = ‘Prime Video ads’ (supply_source_id: 623)\n"," Both of these DSP supply sources are eligible to produce events within the DSP traffic tables, as well as the joined traffic and conversion event feeds below:\n","dsp_impressions  dsp_views  dsp_clicks  dsp_impressions_by_matched_segments  dsp_impressions_by_user_segments  amazon_attributed_events_by_conversion_time  amazon_attributed_events_by_traffic_time\n"," March 14, 2024\n"," We have released new overview and tutorial content for Sponsored TV. This content helps you create a Sponsored TV campaign and understand its structure and how to create and preview video creatives.\n"," Find all new Sponsored TV content under Sponsored TV > Overview.\n"," Also see our updated Postman collection, where we have added new Sponsored TV request templates.\n"," March 14, 2024\n"," AMC customers now have access to Sponsored TV (ST) signals if the corresponding Sponsored Ads entities are mapped to their AMC instances. The signals can be identified by applying the filter ad_product_type = 'sponsored_television' in the following tables:\n","amazon_attributed_events_by_traffic_time  amazon_attributed_events_by_conversion_time  sponsored_ads_traffic\n"," March 14, 2024\n"," This includes publication of a new column, sns_subscription_id, within the conversions_all schema. The sns_subscription_id is the identifier for the Subscribe and Save (SnS) enrollment and can be used as a join_key for subscription and fulfillment events within the SnS series. Specific to the conversions_all dataset the SnS events are associated with the conversion event subtypes listed below, and are eligible for data decoration within the sns_subscription_id column:\n","snsSubscription  firstSnSOrder  repeatSnSOrder\n"," For all other conversion event datasets, the SnS events are associated with the conversion event subtypes snsSubscription and order, and will not include reference to the sns_subscription_id data attribute.\n"," The above applies to all of the equivalent audience tables. SnS retail events are resolved and joined to advertising data feeds with the user_id_type = adUserId. SnS retail events have an initial publication (backfill) date within AMC of June 2023; there are no SnS retail events within AMC prior to this date.\n"," For more information, refer to the Instructional Query (IQ): Introduction to Subscribe and Save (SnS) repeat purchases (link only available for AMC UI users).\n"," March 7, 2024\n"," Regions: US, CA, MX, BR, UK, DE, FR, IN, ES, IT, AE, SA, NL, SE, TR, JP, AU\n"," In January, we announced the launch of the persona builder API in beta. This feature is now generally available for Amazon DSP users.\n"," The persona builder API takes an audience expression, representing a persona, as input. The API returns aggregated insights for that persona. An advertiser can call the API to save an audience expression to Amazon DSP as a “combined audience.”\n"," To get started, view the API reference.\n"," March 6, 2024\n"," We are excited to launch Amazon DSP reports on the latest version (version 3) of the Amazon Ads API as Open Beta. This release provides agencies, brands, and service providers with Amazon DSP reporting in addition to the existing Sponsored Ads reports. The new reports adhere to a common request and response schema we introduced with V3 reports, and provide customers with the same benefits currently available for Sponsored Ads reports: the ability to select date ranges, standardized metric names, and better reports availability over version 2.\n"," This release launches the following reports on V3 reporting for Amazon DSP: Campaign, Inventory, Geography, Technology, Audiences, Off-Amazon, Product, and Conversion Source, in addition to the already migrated Campaigns and Inventory reports. With this release, customers will find better consistency between Amazon DSP reports and those for other ad products.\n"," The new Amazon DSP reports come with standardized metric names allowing consistent naming across all ad product reports. This will enable customers to easily compare metrics across ad product reports. Another major change with this release is using a 14-day attribution window for all applicable Amazon DSP metrics. We dropped deprecated metrics and attribution suffixes in metric names from the reports, making it easier to read and analyze reporting information.\n"," For full technical details, please see our updated documentation in the advanced tools center.\n"," March 5, 2024\n"," All snapshots endpoints are now deprecated, with a target shutoff date of October 15, 2024. Please migrate to the exports API as indicated on our Deprecations page.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/{recordType}/snapshot - /snapshots/{snapshotId} - /v2/sp/{recordType}/snapshot - /v2/sp/snapshots/{snapshotId} - /v2/sp/snapshots/{snapshotId}/download - /v2/hsa/{recordType}/snapshot - /v2/hsa/snapshots/{snapshotId} - /v2/hsa/snapshots/{snapshotId}/download - /sd/{recordType}/snapshot - /sd/snapshots/{snapshotId} - /sd/snapshots/{snapshotId}/download\n"," For more details on integrating with exports, see the Exports overview.\n"," February 28, 2024\n"," Regions: All\n"," In 2023, we deprecated Pixel functionality within Amazon DSP in a phased manner to provide enough time for advertisers to migrate over to our durable alternative, Amazon Advertising tag.\n"," As we approach Chrome third-party cookie deprecation in the second half of 2024, we plan to shut off legacy Pixel APIs in Amazon DSP by August 1, 2024. We recommend all advertisers currently using Pixels to migrate to Amazon Ad Tag at the earliest. View the deprecation details for more information.\n"," February 28, 2024\n"," Region: EU\n"," We have launched the new traffic events API. This is a data clean room-based service that helps advertisers access event-level data (such as clicks, views and impressions) for eligible EU campaigns. This data can be queried using standard SQL syntax within the body of the traffic events API call. The traffic events API will return results if the advertiser account ID you include in the API call is associated with any eligible campaigns. For full technical details, please visit the traffic events API overview.\n"," February 28, 2024\n"," We have updated the Amazon Ads API compatibility and versioning policy to clarify our approach to enumerated fields and values. For details, see Compatiblity and versioning.\n"," February 20, 2024\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, TR, AE, SA, AU, JP, IN, SG, BR\n"," Sponsored Products budget recommendations and missed opportunities insights are now available in Amazon Marketing Stream. Until today, Sponsored Products budget recommendations and missed opportunities insights were only available to advertisers via the Amazon Ads API. We are excited to now support this insight via Amazon Marketing Stream. This provides an unmodified view of budget recommendations and missed opportunities, which include the additional clicks, impressions and sales from the past 7 days that the campaign could have received had it stayed in budget for the hours it was out of budget.\n"," Sponsored Products budget recommendations and missed opportunities via Amazon Marketing Stream addresses two use cases: 1) delivery of recommendations in near real-time when a campaign goes out of budget, and 2) delivery of recommendations for all campaigns owned by a subscribed advertiser with no additional API calls beyond the initial subscription.\n"," Amazon Marketing Stream is available via the Amazon Ads API. When you are ready to get started, visit our Amazon Marketing Stream onboarding guide that will walk through the process of getting API access, integrating with AWS, and subscribing to campaign datasets using the Amazon Marketing Stream API.\n"," February 15, 2024\n"," Sponsored Brands is making changes to requirements for the product collection ad format. Beginning January 31, 2024, new Sponsored Brands campaigns using the product collection ad format created using the API or Amazon advertising console will require a custom image that meets policy. We will begin enforcing this requirement for all product collection ads on May 31st, 2024. We recommend migrating to the new /sb/v4/ads/productCollectionExtended endpoint which requires a custom image as part of ad creation. The previous /sb/v4/ads/productCollection and /sb/ads/creatives/productCollection will be deprecated, with a target shutoff date of November 30, 2024. The /sb/v4/ads/productCollectionExtended also allows advertisers and partners to create a slide show for product collection ads using collection of custom images and edit their ad landing pages.\n"," In addition, existing product collection ads that do not contain a custom image will stop serving after May 31, 2024. To remediate, we highly recommend that you either use the Amazon ad console to update your product collection campaigns with custom images or use the /sb/ads/creatives/productCollection or /sb/ads/creatives/productCollectionExtended endpoints to update your creatives.\n"," Learn more about product collection and production collection extended ads in the FAQs. If you would like to share feedback, please use the Amazon Ads API Service Desk to open a ticket with subject title \"ASIN only Deprecation\" by March 30, 2024.\n"," February 15, 2024\n"," As we recently announced new version of Sponsored Brands product collection ads APIs on Amazon ads, we recommend advertisers and partners to start migrating to the /sb/v4/ads/productCollectionExtended and /sb/ads/creatives/productCollectionExtended APIs as soon as possible to take advantage of creating the product collection slide show for product collection ads, and edit landing pages of product collection ads.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/sb/v4/ads/productCollection \\* /sb/ads/creatives/productCollection\n"," If you would like to share feedback, please use the Amazon Ads API Service Desk to open a ticket with subject title \"Product collection Ads API Deprecation\" by April 30, 2024.\n"," February 15, 2024\n"," Regions: All\n"," Brand Store quality metrics and recommendations are now available with the Amazon Ads API. Now you can access your Store average dwell time, how you compared to peer groups on Amazon, your Store quality rating, and a list of recommended actions you can take to improve your Store quality and performance. A high rating means that you have taken actions that Amazon believes will increase the duration that shoppers spend on your Store (dwell time). We use your Store rating to recommend specific actions that may help improve your Store performance and dwell time.\n"," Learn more about Brand Store insight metrics.\n"," February 14, 2024\n"," Regions: US, CA, MX, BR, JP, SG, AU\n"," Sponsored Brands introducing a landing page edit for Product Collection, Store Spotlight and Brand Video Ads. Advertisers and Partners are now able to change their ads landing page without recreating a new campaign or ad group. Now, each ad can have individual landing pages within same ad group. You can now update your ad group based campaigns landing pages without recreating new ad group or campaign. For editing a landing page, advertisers and partners can use /sb/ads/creatives/productCollectionExtended for Product Collection ads, /sb/ads/creatives/storeSpotlight for Store Spotlight ads, and /sb/ads/creatives/brandVideo for Brand Video ads.\n"," For full technical details, please see the updated documentation on /sb/ads/creatives/productCollectionExtended,  /sb/ads/creatives/storeSpotlight and /sb/ads/creatives/brandVideo.\n"," February 14, 2024\n"," Regions: All\n"," Sponsored Brands introducing a new creative Slideshow ads, that will appear at the top of search results page. Slideshow ads are an extension of the existing lifestyle creative, with a carousel of 2-5 lifestyle images that will auto-rotate. Shopper can engage with the slideshow by pausing it at any point in time or switching between different images by making forward or backward swipes.\n"," Advertisers can create the new slideshow using POST /sb/v4/ads/productCollectionExtended where advertiser can provide collection on lifestyle images representing the brand. You can also edit your existing Product Collection creatives using POST /sb/ads/creatives/productCollectionExtended where advertiser can add collection of lifestyle images to convert those ads into slideshow. For more details, see Slideshow ads creative.\n"," For full technical details, please read our documentation.\n"," February 14, 2024\n"," Regions: All\n"," We have added support for ads to the exports API. Previously, the exports API was only available for campaigns, ad groups, and targets.\n"," An ad represents the smallest unit of an advertising campaign, including what a customer sees and how they interact with the ad. As part of this release, we have aligned on a common model for all ad types across sponsored ads campaigns. To learn more about the common ad model, see Ads.\n"," With this release, exports now include all functionality provided in snapshots. For more details, see the Exports overview.\n"," To get started with target exports, see:\n","Exports tutorial \\* Exports API reference\n"," February 13, 2024\n"," Regions: US\n"," We have launched three new fields available in the public API for “line item creative associations,” which provide the creative line item association status. These fields are state, associationModerationStatus, and associationModerationReasons, and they can be used to determine which line items the creative is approved or not approved to run on based on policies.\n"," As part of the line item moderation capability, these fields help you determine if a creative is approved to run based on moderation policies.\n"," For full technical details, please read our documentation.\n"," February 13, 2024\n"," Regions: All\n"," Advertisers can now launch vertical video campaigns with a Store as the landing page. Vertical video is available under “Drive page visit” goal, enabling advertisers to highlight a collection of one, two, or three advertised products. Under the “Grow brand impression share” goal, advertisers can launch a video campaign without, or with one, or two, or three advertised products. Shoppers clicking on an advertised product will visit the product detail page; shoppers clicking on any other ad element will visit the brands Store on Amazon. Shoppers will be able to discover the brands they love today - and learn about the brands they will crave tomorrow - with vertical video creatives. Shoppers can explore brands and visit the Amazon Store to learn more about the brand ethos, or explore advertised products by clicking on any of the displayed products. Advertisers will be able to re-use their existing vertical videos from social media, and find new creative ad formats to share their brand story.\n"," For full technical details, please see the updated documentation on Sponsored Brands video.\n"," February 1, 2024\n"," Advertisers and partners can now troubleshoot their Sponsored Products campaigns for any product eligibility, ad policy, or featured offer competitiveness issues by calling the campaign diagnostics API. This API allows partners to programmatically fetch an aggregated list of issues across supported issue types (product eligibility, ad policy, featured offer competitiveness) for a single Sponsored Products campaign or list of Sponsored Products campaigns through a single API call.\n"," Previously, API users had to call separate APIs for product eligibility and ad policy troubleshooting, each taking different entity type (SKU, AdID respectively), then consolidate the results to get an overview of issues impacting their Sponsored Products campaigns. The campaign diagnostics API removes the discovery and cognitive load associated with troubleshooting a Sponsored Products campaign by presenting an aggregated view along with an impact assessment of the issue across the campaign.\n"," For more details, see the technical specifications for the campaign diagnostics API.\n"," January 31, 2024\n"," We have expanded the Amazon Ads payment registration APIs to support credit card and direct debit. Third-party clients can now integrate with the Amazon Ads billing APIs to register credit card and direct debit payment methods, as well as view metadata related to such registrations.\n"," For more details, see the technical specifications for the billing APIs.\n"," January 30, 2024\n"," Regions: All\n"," Amazon Ads is introducing a new, personalized experience for developers using the Amazon Ads API. With this release, developers can now log in to the advanced tools center to view key metrics and trends related to their Amazon Ads API integration.\n"," The logged-in experience displays information about your Login with Amazon application and includes an interactive dashboard showcasing API activity. The integration dashboard can help you monitor your integration health, explore trends, and identify inefficiencies in your call patterns. Available breakdowns include calls by response code, product, marketplace, API resource, and hourly call volume.\n"," Access the new experience directly from the Amazon Ads advanced tools center by signing in using your developer.amazon.com account credentials. Once logged in, you can view the Login with Amazon applications associated with your Amazon Developer account. Select an application that has access to the Amazon Ads API to view the integration dashboard.\n"," To learn more, see Integration dashboard.\n"," January 22, 2024\n"," We recently announced that Sponsored Products search term report data was available in bulksheets. Now, we have expanded to support Sponsored Brands search term reports. This report will be in a new tab and will include much of the same information you would find in the advertising console report, including the customer search terms that were used to discover your ads—-but in bulksheets, you will also have the entity IDs available, so you can quickly make adjustments if needed.\n"," You can include a search term report in bulksheets if you go to the bulk operations main page, create a custom spreadsheet, and check the box labeled Sponsored Brands search term report in Step 1.\n"," Learn more about search term reports in bulksheets.\n"," January 19, 2024\n"," Regions: US, CA, MX, BR, UK, DE, FR, IN, ES, IT, AE, SA, NL, SE, TR, JP, AU\n"," You can now better understand your audiences and create your own custom brand personas with persona builder. Using Amazon insights, you can discover and validate audience shopping and streaming behaviors. Then, seamlessly save and activate those same audiences through your Amazon Ads campaigns.\n"," Persona builder enables you to use Amazon first-party insights to learn more about your audiences, such as their interests and relevant life events. You can create your own custom brand personas by combining existing audiences into a single persona. For example, if you are releasing a premium headphone with fitness branding, you can create a persona by combining the Amazon “interested in technology,” “in market for headphones,” and “in market for fitness clothing” segments. You can reach your personas on Amazon and beyond by saving them to Amazon DSP.\n"," Persona builder API takes an audience expression, representing a persona, as input. The API returns aggregated insights for that persona. An advertiser can call the API to save an audience expression to Amazon DSP as a “combined audience.”\n"," The following are the key API endpoints:\n","POST /insights/bandedSize: Get the size range for the input audience; - POST /insights/demographics: Get aggregated demographic insights for the input audience; - POST /insights/topOverlappingAudiences: Get top audiences overlapping with the input audience; - POST /insights/topCategoriesPurchased: Get top retail categories purchased by the input audience; - POST /insights/primeVideo: Get insights on top content streamed on Prime Video by the input audience; - POST dsp/audiences/combinedAudiences: Create a combined audience based on the input audience expression.\n"," January 15, 2024\n"," Advertiser Data Upload APIs (ADU 2.0) allows users of AMC to bring their own first-party datasets into AMC for custom and advanced analysis use-cases, such as audience overlap reports, custom attribution, frequency analysis, comparison of off-Amazon behaviors to Amazon advertising events, or analysis by product/ASIN. For more details, refer to Advertiser data upload.\n"," January 15, 2024\n"," As we recently announced AMC APIs being available on Amazon Ads, we recommend users currently on the AMC instance-level APIs migrate to the upgraded APIs as soon as possible to take advantage of the enhanced security, usability, and performance of new APIs.\n"," After the instance-level APIs retire, calling any of the endpoints will return a 404 error. Migrating to the new APIs at the earliest can help prevent disruptions to your existing business operations. Visit the AMC migration hub to learn more.\n"," In addition, new AMC instances created after March 04, 2024 will not be compatible with the instance-level APIs. You need to build to Amazon Ads APIs before this date to make sure your API workflows can be applied to your new instances.\n"," January 10, 2024\n"," Technology partners now have globalized registration and account APIs, available in open beta, to offer advertisers an integrated Amazon Ads onboarding experience from within other platforms. They can also get all accounts of a user with a single, global API call. Advertisers that are eligible for multiple countries now get one advertising account that spans all countries through a new globalized account ID. Each country does have its own ID specific to each advertiser, which you will need to make individual requests for most other APIs.\n"," Previously, ads account registration was only available through the Amazon UI. Once an account was created, advertisers could authorize them to technology partners in the context of a single country, where partner APIs needed to call different endpoints in different regions to compile the countries. Now, they can register a single account globally and get all countries and profile IDs with a single request.\n"," Available APIs:\n","Accept Terms and Conditions: All registrations must be accompanied by acceptance of the Amazon Ads Agreement. Anyone registering must be presented with the terms and acknowledge agreement. To register, partners must call to get a terms token and activate it by agreeing to terms. Partners can call to check the activation status of the token. - POST /adsAccounts: Register an account. Given a Seller Central account ID, Vendor Central ID, or business details, tech partners can request an ads account. An account ID will immediately be created and returned synchronously, while the individual countries are created asynchronously. - GET /adsAccounts/{advertisingAccountId}: Get details for an account. For registration status, Amazon will return a status of created, pending, partially created or disabled. Additional globalized metadata is available, such as the profile ID and entity ID for each country within the ads account. - POST /adsAccounts/list: List details for all ads accounts to which the authorized user account has access.\n"," For more information, see the user guides for creating accounts and retrieving accounts or view the API specification.\n"," January 5, 2024\n"," AMC now has access to off-Amazon signals from Amazon DSP Events Manager including Amazon Ad Tag (AAT), Conversions API (CAPI), and Mobile Measurement Partner (MMP) integrations.\n"," With this launch, signals from 10/20/2023 are available.\n"," As part of this launch, two new dimensions (conversion_event_source, and conversion_event_name), and three new metrics (off_amazon_product_sales, off_amazon_conversion_value, and combined_sales) have been added to the following tables:\n","amazon_attributed_events_by_traffic_time  amazon_attributed_events_by_conversion_time  conversions  conversions_all  conversions_with_relevance \\* All equivalent audience tables\n"," To know more about these signals, and how to use them in your analysis, please refer to the new Instructional Query (IQ): Introduction to Events Manager.\n"," January 4, 2024\n"," Regions: US, CA, MX\n"," Advertisers using Sponsored Display can now drive traffic to their Store pages. By launching this new capability, Amazon Ads enables advertisers to use their Sponsored Display images or video ads to redirect shoppers to their Store landing page.\n"," By enabling all creatives within Sponsored Display to link to Stores, advertisers can reach audiences along their shopping and entertainment journey while helping to increase traffic to their Store pages. Sponsored Display allows advertisers to reach shoppers across their entire shopping and entertainment journey, in the Amazon store or third-party destinations. By focusing on driving specific goals using either audiences or contextual targeting, advertisers can quickly set-up powerful display campaigns that link directly to their Store pages.\n"," This new feature drives brand growth by introducing shoppers to a broader product catalog and increasing direct engagement through the Store environment using more Amazon Ads products. Linking back to Store pages allows brands to tell their story in their own voice, without any distractions from other brands or offers.\n"," For full technical details, including the updated landingPageURL for STORE now available within Sponsored Display productAds.\n"," January 4, 2024\n"," Regions: US, CA, DE, ES, BE, NL, SE, EG, AE, SA, JP, IN\n"," In any given marketplace, customers have the option to shop in various languages. For example, on amazon.com in the US, English is the default language, but we also have a full Spanish language experience for customers who select Spanish as their language of preference. We have released a new translation feature that automatically translates Sponsored Display custom creatives to all supported languages within a marketplace. This expands visibility of Sponsored Display, while also providing shoppers with a more seamless experience, enabling them to engage with Sponsored Display ads in the language they have selected.\n"," Previously, Sponsored Display custom creatives ads were only shown in the default language of each marketplace. This feature launch allows for all custom creative ads to be automatically translated, for free, with no extra input required from advertisers, making the ads available for secondary language shoppers to see and engage with.\n"," For full technical details related to Sponsored Display creatives, please see the API reference.\n"," January 2, 2024\n"," Regions: US, UK, DE, FR, IT, ES\n"," We are excited to announce that Sponsored Brands version 4 campaign management API now supports author advertisers. Advertisers, agencies, and tool providers can leverage these APIs to create and manage ad group-based campaigns for authors, which are similar to the advertising console. When setting up a new Sponsored Brands campaign, authors will need to first claim the book, KDP or traditionally published, in their Author Central (A2C) account. The existing Sponsored Brands Ad eligibility still apply.\n"," For full technical details, please see the API reference.\n"," January 2, 2024\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, EG, TR, AE, SA, AU, JP, IN, SG, BR\n"," Sponsored Brands has launched a new API that provides forecasts of impressions based on your campaign settings. Impressions forecasts are an estimate of the number of times your ad(s) will be displayed. These forecasts are available for campaigns with a single ad group that have selected the “Drive page visits” goal-based campaign control. Forecasts are based on machine-learning models that are built on the observable performance of historical campaigns with similar settings. They are not a guarantee of actual impressions.\n"," For full technical details, please see the API reference.\n"," December 26, 2023\n"," A new field, campaign_id_string, was added to the following AMC data sources:\n","sponsored_ads_traffic  amazon_attributed_events_by_conversion_time  amazon_attributed_events_by_traffic_time  conversions_with_relevance  dsp_impressions  dsp_views  dsp_clicks  dsp_impressions_by_user_segments  dsp_impressions_by_matched_segments\n"," This column is the campaign identifier presented as a string datatype. For DSP campaign events, this value will populate with the same value as the campaign_id column and represented the DSP order id. For Sponsored Ads events, this value will populate with the alphanumeric campaign id string that is associated with the Sponsored Ads campaign object settings. For data sets that join traffic and conversion events, this column will be populated for both Sponsored Ads and DSP traffic events, whereas the legacy campaign_id column will only be populated for DSP events. When conducting SQL joins across data sets or implementing SQL filtering within WHERE statements, please ensure the proper data type has been selected, campaign_id(long data type) versus campaign_id_string (string data type).\n"," Additionally, winning_bid_cost field was updated to reflect a \"soft deprecated\" status. The column will still function within AMC SQL queries and populated with LONG data type values, however, it is not recommended for use within customer analysis and insights generation. This value is in the process of being deprecated by upstream data providers from whom AMC sources data attributes for DSP impression events. The winning_bid_cost column is published into the following data sources, and their corresponding \\_for_audiences data sources:\n","amazon_attributed_events_by_conversion_time  amazon_attributed_events_by_traffic_time  dsp_impressions  dsp_clicks  dsp_impressions_by_user_segments \\* dsp_impressions_by_matched_segments\n"," December 26, 2023\n"," AMC launched support for the following most commonly used statistical functions in SQL. These functions can be used in AMC queries, to perform statistical analysis on event-level data.\n","STDDEV_POP: Returns the standard deviation of a set of numeric values, when the values represent the entire population. - STDDEV_SAMP: Returns the standard deviation of a set of numeric values, when the values are for a sample set of data and not the entire population. - STDDEV: An alias for STDDEV_SAMP. Returns the standard deviation of a set of numeric values, when the values are for a sample set of data and not the entire population. - VAR_POP: Returns the variance of a set of numeric values, when the values represent the entire population. - VAR_SAMP: Returns the variance of a set of numeric values, when the values are for a sample set of data and not the entire population. - VARIANCE: An alias for VAR_SAMP. Returns the variance of a set of numeric values, when the values are for a sample set of data and not the entire population. - SKEWNESS: Returns the estimate of the skewness of a set of numeric values. Skewness is a measure of the asymmetry of the distribution. A positively skewed distribution has a thicker upper tail than lower tail, while a negatively skewed distribution has a thicker lower tail than upper tail. A normal distribution has a skewness of zero. - PERCENTILE: Returns the value at a given percentile of a distribution of values. - APPROX_PERCENTILE: Returns the approximate, discrete percentile value. - MEDIAN: An alias for PERCENTILE(&lt;value>, 0.5). Calculates the median value for the range of values.\n"," See AMC SQL reference for a list of SQL functions AMC supports.\n"," December 26, 2023\n"," December 26, 2023\n"," Regions: US, CA, MX, UK, DE, FR, IT, ES, NL, BE, SE, PL, TR, AE, SA, EG, IN, SG, AU, JP, BR\n"," Advertisers can now launch video-only creatives that render exclusively on Top of Search and drive audiences entirely to the Store. Prior to this launch, advertisers could only promote one product, or a collection of products, with their Store video ads. This new creative, available under Grow Brand Impression Share outcome optimization, allows advertisers to share their branded story without tying a video campaign to a product, or a collection of products. Advertisers also have the option to edit their existing live video campaigns without the need to re-create a new campaign - under Grow Brand Impression Share - and eliminate any of the one, two, or three advertised products.\n"," For full technical details, please see the updated API reference.\n"," December 21, 2023\n"," Regions: All\n"," Previously, we launched the exports API in preview with limits on TPS and job queue capacity. We have now lifted all restrictions on the exports API and are designating the API as generally available.\n"," The exports API simplifies ingestion of Amazon Ads data by providing a common model across different ad products, creates parity between asynchronous export APIs and synchronous LIST APIs (including extended data fields), and improves performance over the previous snapshot APIs.\n"," To get started with the exports API, see:\n","Exports overview  Exports tutorial  Exports API reference \\* Postman collection\n"," December 21, 2023\n"," Regions: All\n"," We have added support for targets to the exports API. Previously, the exports API was only available for campaigns and ad groups.\n"," Targets allow advertisers to influence when ads will or will not appear, as well as specify how much how much to bid for an ad when these conditions are met. As part of this release, we have aligned on a common model for all targeting types across sponsored ads campaign types, including keywords, product targeting, auto targeting, theme targeting, and all negative targeting types. To learn more about the common targeting model, see Targets.\n"," To get started with target exports, see:\n","Exports tutorial \\* Exports API reference\n"," December 13, 2023\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, EG, TR, AE, SA, AU, JP, SG, BR\n"," Amazon Ads has launched new APIs to create payment profiles for managing billing operations. A payment profile represents the instructions on how to collect payments for invoices, and can be used in one or more payment agreements. Advertisers can also mark a payment profile as the default profile for their payment operations, and specify which accounts are eligible to share a payment profile.\n"," With this launch, third-party clients now have the option of integrating with the Amazon Ads billing APIs to create independent and reusable payment profiles. For global advertising accounts encompassing multiple advertiser accounts, advertisers now have the option of creating a single payment profile to be shared across all their advertising accounts. A global advertising account can also mark a payment profile as their default payment profile, and all advertising accounts that get created under the global advertising account will automatically use the same payment profile, without needing to setup the payment information.\n"," For full technical details, please see the billing overview and API reference.\n"," December 11, 2023\n"," Third-party integrators can now complete their billing registration for sponsored ads accounts using the Amazon Ads API. Advertisers can add their billing information, apply it to one or more countries where they are advertising, and set it as a default on the account for future countries where they register.\n"," Previously, advertisers had to manage the billing information for each country separately and the registration could only be completed in the advertising console. With the billing registration APIs, advertisers can complete the registration programmatically and/or through integrator platforms, so they can get started faster.\n"," Six APIs for billing profile management are currently in open beta:\n","POST /billingProfiles: Creates one or more billing profiles under a sponsored ads global account. A billing profile can exist even if it is not associated with any country.Note: To ensure accuracy of the information shown on the store, we request that you review the ‘Advertiser Name’ and ‘Payer Name’ in our ad systems and update them if required.  POST /billingProfileUsages: Applies billing profile(s) to one or more countries. Applying a billing profile on a country means corresponding billing information (address & tax) will be used for invoicing, tax computations and other billing workflows.  PUT /billingProfiles: Updates one or more billing profiles under a sponsored ads global account. When you update a billing profile, the new details will be effective across all applied countries.  POST /billingProfiles/list: Fetches the paginated list of billing profiles under a sponsored ads global account.  POST /billingProfileUsages/list: Fetches the billing profile details for all countries under a sponsored ads global account. \\* GET /billingProfileAgreementContents/{billingProfileAgreementContentId}: Fetches the content of agreements (example: tax agreement, non-canadian residency agreement, etc.). Users will need to read the content and provide the consent as part of creating or updating a billing profile.\n"," December 11, 2023\n"," Regions: All\n"," Different brands prioritize different brand building goals depending on their marketing strategy and their brand building journey. Deciding the right campaign controls (budget, targets, bids, ad creative formats) for those goals can be time-consuming. With this launch, we have introduced two new goals: “Drive Page Visits” and “Grow Brand Impressions Share”; each with a unique set of campaign controls to achieve that goal.\n"," To help drive these goals, theme targeting is a new method to control your campaign targeting. It uses advanced machine learning algorithms that take into account historical performance targets and brand interactions to create a large set of keywords. It then categorizes those keywords into relevant groups to use with your campaigns. Two targeting groups are available in this launch: “Keywords related to your landing pages.” and “Keywords related to your brand”. These targeting groups will be pre-selected to simplify the campaign creation process for advertisers.\n"," With this launch, we have expanded to AU, MX, BR, BE, NL, PL, SE, TR, EG, KSA, UAE, SG and UK so more advertisers can access these features via the Amazon Ads API. For instructions on how to enable these features, refer to our developer guide on how to create Sponsored Brands campaigns and our developer guide on how to create theme based targets.\n"," December 11, 2023\n"," Sponsored Brands multi-ad group campaigns are now available in bulksheets. With this latest version, you will be able to manage Sponsored Brands ad groups in bulksheets. You can also add custom bidding adjustments by placement, update creative assets in bulk, and create all Sponsored Brands ad formats–including Store spotlight ads. Previously in bulksheets, you could not create or manage ad groups for Sponsored Brands, add custom bidding adjustments, or update creative assets.\n"," You can still use the previous version of Sponsored Brands in bulksheets, but you will not see ad groups or any placement data in the spreadsheet. To manage these entities, you must use the latest version, which you can get by selecting the checkbox labeled Sponsored Brands multi-ad group data (NEW) when you download a bulksheets file.\n"," December 8, 2023\n"," The /dsp/orders endpoint has added new enum values and fields to support the new simplified optimization experience.\n"," Summary of changes:\n"," 1) Added two new enum values for the goal field:\n","CONVERSIONS \\* CONSIDERATION\n"," 2) Added a new field: targetKpi\n"," These changes can be found in version 2.5. See the changes here in version application/vnd.dsporders.v2.3+json.\n"," December 4, 2023\n"," We are deactivating all non-age-gender-demographics segments for Germany, France, Italy, Spain from the following Amazon DSP services: Audience Central UI, Audience Discovery API, Audience Picker UI, Overlapping Audiences, Audience Insights UI, Insights API, Data Decoration Service (DDS, including data output from the EDX interface). Deactivation means that these segments will not be available for any targeting or insights after December 31, 2023. However, any existing campaigns can continue using it until that date.\n"," We will deprecate the impacted segments from targeting UIs on December 04, 2023. Any new campaigns that are created after this date will no longer be able to add those segments for targeting. While these segments will remain visible in the targeting UIs (as deactivated), these segments cannot be added to any campaigns for targeting.\n"," The non-age-gender demographic segments in EU4 are currently sourced from Experian. Experian EU made a decision to stop offering these segments based on an internal assessment by Experian EU team and was driven by privacy compliance reasons. This decision was not specific to Amazon.\n"," Due to the removal of Experian demographic data provision in EU4 mentioned above (Germany, France, Spain and Italy), in November 2022, the demographic segments in the Standard Catalog are no longer being refreshed, and they would be removed by 12/31/2023.\n"," For a full list of segments to be deactivated, you can reference this table.\n"," November 16, 2023\n"," Regions: All\n"," The Amazon Ads version 3 reporting API now supports the gross and invalid traffic report. For Sponsored Products, Sponsored Brands, and Sponsored Display campaigns, this report can be accessed programmatically.\n"," To optimize the efficacy of their campaigns, large advertisers conduct analytics on metrics such as gross impressions, invalid impressions, invalid impression rate, gross clicks, invalid clicks, and invalid click rate. With this release, advertisers can now programmatically access the data for analytics, whereas previously the data had to be manually downloaded and then used. Amazon Ads traffic quality systems assist in safeguarding advertiser budgets from invalid traffic, such as non-human, fraudulent, and other illegitimate traffic. These metrics provide greater visibility into invalid traffic that Amazon Ads filters and aid advertisers in optimizing their campaign performances.\n"," For full technical details, please read the Gross and invalid report definition.\n"," November 16, 2023\n"," Regions: US, CA, UK, IN, JP\n"," We have added hours of day for schedule-based budget rules for sponsored ads campaigns. Now you can set up budget rules that increase budget at specific times of day. This is in addition to specific days of the week and specific date ranges currently offered as schedules for budget rules.\n"," You can now support campaign budget coverage at specific times of the day by setting up budget rules with hours of day granularity. You can also utilize hourly performance reporting through Amazon Marketing Stream to find the times of day that your campaigns are performing best, and set rules for those time periods to help boost performance.\n"," Budget rules help you plan budget changes in advance so you can spend less time making manual adjustments. Advertisers can use budget rules to reduce the likelihood of campaigns running out of budget, especially during peak days, times, or holiday events. You can set up budget rules with hours of day schedules using the Amazon Ads console or the Amazon Ads API.\n"," For full technical details, please see the user guide and API reference.\n"," November 16, 2023\n"," Region: US\n"," With Sponsored Display, advertisers can discover, reach, and engage audiences in relevant contexts across their shopping and entertainment journey. With this launch, entertainment targeting will allow advertisers to reach audiences who are either actively engaged in those entertainment contexts or have shown interest in them. Advertisers can engage with specific genres or categories including movies/TV, music and games.\n"," Entertainment targeting helps advertisers reach engaged audience during their entertainment journey, whether they are live streaming, watching videos, or researching games and movies on blog sites. This helps advertisers expand their reach beyond the Amazon store. Additionally, you can ensure your brand ads show up next to content category/genre that aligns with the advertisement. These new targets also allow advertisers to further connect with highly engaged Twitch audiences. We have found that viewers that watch Twitch streaming content spend, on average, more than 42 minutes per visit, the highest among all social media platforms.\n"," For full technical details, please see our updated developer guide and our targeting API, including our new ContentTargetingPredicate that can be used for either contextual (T00020) or audience (T00030) campaigns.\n"," November 15, 2023\n"," Regions: All\n"," Developers can now read translations of advanced tools center content in Chinese and Japanese. The current translations reflect the status of advanced tools center documents as of July 2023.\n"," Visit the translations page for more information, or go directly to the Chinese translation or Japanese translation.\n"," November 13, 2023\n"," Regions: US, MX, CA, UK, DE, ES, FR, IT, IN\n"," We are launching schedule bid rules for Sponsored Products campaigns, so advertisers can set up bid rules that increase bids at specific times of the day, days of the week, and date ranges. With the launch of schedule bid rules, advertisers can automate their bid changes without missing sales opportunities. Advertisers can also utilize new hourly performance reporting to find the times of day that your campaigns are performing best, and set rules for those time periods to help boost performance.\n"," To learn more, see our schedule based guide.\n"," November 6, 2023\n"," Sponsored Brands reporting version 2 reports now support view and click attributed data for conversion metrics (that is, conversions, sales, units sold, new-to-brand, and detail-page-view metrics) for Sponsored Brands campaigns with a costType of VCPM. The conversion metrics will have the right data depending on the attribution type for the campaign.  For campaigns with a costType of CPC, metrics will continue to report click attributed data.\n"," Sponsored Brands recently launched campaigns to grow brand impression share campaigns that are transacted on vCPM basis.  It is important to report both view and click attributed conversion metrics for these campaigns, so that advertisers can understand the full performance impact.\n"," See version 2 metrics for updated metric definitions.\n"," November 6, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, US\n"," Sponsored Display has improved the accuracy of the forecasting API by allowing optimization rules to be included as an input.\n"," Forecasting helps advertisers understand the impact of their choices during campaign creation. This includes a minimum and maximum range of available impressions, viewable impressions, and clicks that could be available based on the selected advertised products, optimization type, targeting, bid, and optimization rule.\n"," For full technical details, please see our updated forecasting API.\n"," November 6, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SE, UK, US\n"," Sponsored Display now includes themes in the response of the targeting recommendations API.\n"," Theme-based recommendations offer multiple options to target relevant products without the need for additional research from advertisers. Target products under each theme are curated specific to the use case, with high-quality suggestions based on Amazon first-party signals. Each theme will have up to 50 individually recommended products, with flexibility to choose products individually or select all products within a theme.\n"," For full technical details, please see our updated targeting recommendations API documentation.\n"," November 2, 2023\n"," Regions: All\n"," Advertisers can now edit the name, ASIN list, and lookback period for product audiences that are not part of an active campaign.\n"," For technical specifications, please consult the API reference.\n"," November 1, 2023\n"," Regions: All\n"," Amazon DSP is launching goal-based bidding, which helps advertisers to specify a performance target for their campaigns and allow Amazon DSP to automatically optimize their bids in real-time in order to maximize delivery at their performance target. With this release, advertisers can automatically optimize to both delivery and performance goals.\n"," Goal-based bidding can be used to maximize delivery at a performance threshold that advertisers define. You can now specify a KPI target when creating a campaign—for instance, you can set a target CPA of $10 and choose “Prioritize KPI target” as the optimization strategy. This allows you to maximize your campaign goal, such as conversions, while ensuring that the campaign remains at or near your specified target CPA.\n"," Goal-based bidding is part of the optimization field of the order object in POST /dsp/orders. To get suggested KPI target range, you can use the POST /dsp/campaigns/targetKpi/recommendations endpoint.\n"," October 31, 2023\n"," Regions: US, CA, MX, BR, UK, DE, FR, IN, ES, IT, AE, SA, NL, SE, PL, TR, EG, JP, AU, SG\n"," The Unified Pre-moderation API now offers new capabilities to validate creatives against Technical specifications and Policy requirements. These validations are done ahead of Ad submission. The Unified Pre-moderation API is compatible with Sponsored Ads and DSP.\n"," For technical specifications, please consult the API reference.\n"," October 30, 2023\n"," Regions: All\n"," Sponsored ads advertisers can now choose to download invoices from the last 90 days for one country or for all countries in their global sponsored ads account. Two Amazon Ads APIs are currently in open beta where you can retrieve this information:\n","POST /billingStatements: This API lets you request for a billing statement to be generated, and returns a billing statement ID. \\* GET /billingStatements/{billingStatementRequestId}: Call this API to check the generation status of your statement. When the statement is ready, the response includes the pre-signed URL where you can download the file. Download URLs are valid for three hours.\n"," October 26, 2023\n"," Amazon Marketing Cloud is now available on the Amazon Ads API to automate workflows, establish integrations, and develop tools and apps at scale. Advertisers and partners can now access Amazon Marketing Cloud (AMC) APIs from the Amazon Ads API, along with APIs for other Amazon Ads solutions such as sponsored ads and Amazon DSP. Using standards from the rest of the Amazon Ads APIs, the updated AMC APIs follow the industry-standard OAuth 2.0 authorization framework and consistent endpoint URL paths. A developer guide is also provided to help users get started and use these APIs. As documented in the Advanced tools center, the new AMC APIs currently support features including reporting, signal management, and audience management.\n"," Previously, advertisers and partners have been using AMC APIs that at an AMC instance level. The new set of AMC APIs offer further enhanced security, usability, and performance, allowing developers to easily utilize, manage, and build with these APIs. See what changed and start your onboarding journey to the Amazon Ads API.\n"," October 23, 2023\n"," Regions: All\n"," You can now request new metrics related to add-to-cart actions and new-to-brand details page views. For both Sponsored Brands and Sponsored Display, new metrics include: addToCart, addToCartRate, eCPAddToCart, newToBrandDetailPageViews, newToBrandDetailPageViewRate, and newToBrandECPDetailPageViews for both Sponsored Brands and Sponsored Display reports through the version 3 reporting API.\n"," Sponsored Display also supports additional metrics: brandedSearchesViews, brandedSearchRate, eCPBrandSearch, addToCartViews, newToBrandDetailPageViewViews, and newToBrandDetailPageViewClicks.\n"," For full definitions and report availability for each metric, see Columns.\n"," You can call the version 3 reporting API to access these metrics.\n"," October 23, 2023\n"," Regions: All\n"," We are excited to launch Sponsored Brands reports on the latest version (version 3) of the Amazon Ads API in preview. The new reports adhere to a common request and response schema we introduced with version 3 reporting, as well as the ability to select date ranges, standardized metric names, and better reports availability over version 2.\n"," This release launches the following reports types for Sponsored Brands in version 3: campaign, placement, ad group, targeting, search term, and ad, in addition to the existing purchased product report. With this release, customers will find better consistency between Sponsored Brands reports and those for other ad products.\n"," The new Sponsored Brands reports come with standardized metric names allowing consistent naming across all ad product reports. This will enable customers to easily compare metrics across ad product reports. Another major change with this release is using a 14-day attribution window for all applicable Sponsored Brands metrics. We dropped deprecated metrics and attribution suffixes in metric names from the reports, making it easier to read and analyze reporting information.\n"," For full technical details, please see the migration guide and report types overview. For access, please submit a Jira ticket.\n"," October 23, 2023\n"," Regions: US\n"," Introducing Sponsored TV, a Streaming TV ad solution for brands of any size to connect with new customers in their living rooms—  even if they have never advertised on TV before. Pre-packaged with retail aware, shoppable ad formats, Sponsored TV allows marketers to buy Streaming TV with the same flexibility of Amazon Ads self-service ads — that means no minimum spend requirements or upfront commitments.  In just a few clicks, brands can help engage relevant viewers across 30+ streaming TV services like Twitch or Freevee. Now, any endemic advertiser can benefit from campaigns modeled by Amazon. With this launch, campaigns are optimized in real time, simplifying the complex process of buying programmatic TV ads.\n"," Now, advertisers can easily get started with Streaming TV, with no minimum spend requirements, daily budgets, and evergreen campaigns. Amazon first-party insights help brands brands reach audiences based on likely content interests such as music videos, video games or dramas as well as product categories on Amazon like headphones or running shoes. Finally, Sponsored TV ads are eligible for interactive ad formats to help you connect with viewers as you reach new audiences.\n"," For more information on how to get started with Sponsored TV, please visit the developer guide on how to get started with Sponsored TV.\n"," October 23, 2023\n"," Regions: All\n"," We are excited to launch Sponsored Display reports on the latest version (version 3) of the Amazon Ads API in beta. The new reports adhere to a common request and response schema we introduced with version 3 reporting, as well as the ability to select date ranges, standardized metric names, and better reports availability over version 2.\n"," This release launches the following reports on version 3 reporting for Sponsored Display: campaigns, ad groups, targeting, advertised product, and purchased product. The matched target report is merged into other reports to reduce duplication of metrics across multiple reports. With this release, customers will find better consistency between Sponsored Display reports and those for other ad products.\n"," The new Sponsored Display reports come with standardized metric names allowing consistent naming across all ad product reports. This will enable customers to easily compare metrics across ad product reports. Another major change with this release is using a 14-day attribution window for all applicable Sponsored Display metrics. We dropped deprecated metrics and attribution suffixes in metric names from the reports, making it easier to read and analyze reporting information.\n"," For full technical details, please see the migration guide and report types overview.\n"," October 23, 2023\n"," Regions: All\n"," Sponsored Products budget recommendations and missed opportunities insights are now available in Amazon Marketing Stream. This provides an unmodified view of budget recommendations and missed opportunities, which includes the additional clicks, impressions, and sales from the past 7 days that the campaign could have received had it stayed in budget for the hours it was out of budget.\n"," Sponsored Products budget recommendations and missed opportunities via Amazon Marketing Stream addresses two use cases: delivery of recommendations in near real time when a campaign goes out of budget, and delivery of recommendations for all campaigns owned by a subscribed advertiser with no additional API calls beyond the initial subscription.\n"," Amazon Marketing Stream is available via the Amazon Ads API. When you are ready to get started, visit our Amazon Marketing Stream onboarding guide that will walk through the process of getting API access, integrating with AWS, and subscribing to campaign datasets using the Amazon Marketing Stream API. If you are already integrated with Amazon Marketing Stream, see the new Dataset documentation.\n"," October 23, 2023\n"," Regions: All\n"," We are launching target promotion APIs to allow advertisers to perform target promotion across all their campaigns at scale. Target promotion is a performance advertising strategy that identifies targets for further refinement to drive more efficient spend against high-performing targets and reduce spend on low-performing targets. This combines the common practice of “target harvesting,” which identifies targets to move from broader targeting (for example, automatic targeting) to more focused targeting (for example, manual targeting with broad match), with optimized bids and budget changes.\n"," Before today, Sponsored Products advertisers needed to download a search term report and manually manipulate the report data to add new targets to existing or new campaigns. There was no automated way to add high-performing targets from an automated targeting campaign into a separate manual targeting campaign at scale. With the launch of target promotion APIs, advertisers can achieve more performant campaigns by promoting high-performing targets within auto-targeting campaigns to manual-targeting campaigns at scale.\n"," For more information on how to enable this feature, refer to our developer guide on how to create target promotion.\n"," October 18, 2023\n"," The legacy bid optimization strategy and adjustment by shopper segment feature will be deprecated on March 31, 2024. If the parameters bidAdjustmentsByShopperSegment and bidOptimizationStrategy are included in the bidding object of the POST /sb/v4/campaigns request after March 31, 2024, the values will be treated as null values. If you have any questions, visit the Amazon Ads API Support page and create a ticket with the subject title: \"Sponsored Brand New To Brand optimization.\"\n"," October 13, 2023\n"," Regions: CA, DE, ES, FR, IN, IT, JP, UK, US\n"," Different brands prioritize different brand building goals depending on their marketing strategy and their brand building journey. Deciding the right campaign controls (budget, targets, bids, ad creative formats) for those goals can be time-consuming. With this launch, we have introduced two new goals: “Drive Page Visits” and “Grow Brand Impressions Share”; each with a unique set of campaign controls to achieve that goal.\n"," To help drive these goals, theme targeting is a new method to control your campaign targeting. It uses advanced machine learning algorithms that take into account historical performance targets and brand interactions to create a large set of keywords. It then categorizes those keywords into relevant groups to use with your campaigns. Two targeting groups are available in this launch:  “Keywords related to your landing pages.” and “Keywords related to your brand”. These targeting groups will be pre-selected to simplify the campaign creation process for advertisers.\n"," This feature was previously only available in the US, but with this launch, we have expanded to CA, DE, ES, FR, IN, IT, JP, and UK so more advertisers can access this feature via the Amazon Ads API. For instructions on how to enable these features, refer to our developer guide on how to create Sponsored Brands campaigns and our developer guide on how to create theme based targets.\n"," October 9, 2023\n"," Regions: FR\n"," French advertisers can now measure upper and mid-funnel Amazon Ads campaigns with Amazon Brand Lift, joining advertisers in the United States, United Kingdom, Canada, and Germany, where Amazon Brand Lift was already available.\n"," Amazon Brand Lift is an insightful and privacy-safe way for advertisers to quantify the impact of upper and mid-funnel campaigns. With participation of the sizable, representative, and engaged Amazon Shopper Panel community, Amazon Brand Lift helps provide objective and concrete measurement results. The reporting provides insights, such as how much a campaign has impacted the percentage of respondents who report being aware of a brand or interested in purchasing from a brand.\n"," To create, manage, and retrieve results for Amazon Brand Lift studies, use the following endpoints:\n","Create study: POST /dsp/measurement/studies/brandLift  Update study details: PUT /measurement/studies/brandLift  Get results: GET /measurement/studies/brandLift/{studyId}/result\n"," For more details, view the API reference.\n"," October 5, 2023\n"," Regions: All\n"," To help advertisers achieve specific goals for their Sponsored Brands campaigns, bids can be automatically adjusted up or down. If we find an opportunity where your ad is more likely to lead to page visits or conversions for campaigns with “Drive Page Visits” goal with a costType of CPC, we may increase your bid for that auction to help achieve that goal. Similarly, if we find an opportunity that looks less likely to lead to your campaign goal, we may lower your bid for that auction. For example, Amazon can adjust bids if we see higher expected results that can “Drive Page Visits”.\n"," For more information related to bidding, please see our updated help page.\n"," October 5, 2023\n"," Regions: US\n"," Advertisers in US can now create Posts via the Amazon Ads API. All sellers and vendors now have access to a Brand profile to create Posts. To have a Brand profile, you must be registered in Amazon Brand Registry. By combining the creative assets API and Posts APIs, you can automate Post creation and the publishing process.\n"," Previously, advertisers needed to have a Store before they could create a Posts profile, and could not reuse the existing image assets available in the creative asset library when creating Posts. With this launch, some new capabilities include:\n","Stores dependency removed: Advertisers no longer need to have a Store to create a Post profile, making the process much more streamlined with the introduction of Brand profiles. 2. Asset reuse: Advertisers can reuse an existing image asset available in the creative asset library to create Posts.\n"," For more information, see our guides for Managing and Reporting on Posts, as well as the API reference.\n"," October 5, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, US\n"," Sponsored Display has improved the forecasting API by adding clicks and viewable impressions.\n"," Forecasting helps advertisers understand the impact of their choices during campaign creation with a minimum and maximum range of available impressions, viewable impressions, and clicks that coudld be available for a set of selected advertised products, optimization type, targeting, and bid values. This helps advertisers create campaigns that will deliver results, understanding scale by experimenting with the campaign setup, and forecasting the output of an investment before they get started.\n"," Forecasting will be available for Sponsored Display through the Amazon Ads API. For full technical details, please see our updated forecasting API documentation.\n"," October 2, 2023\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, SE, AU, JP, BR\n"," We have launched new APIs for basic billing operations, so advertisers can check which payment methods are eligible to register to their advertising account. They can then update the payment method their advertiser account is using. Lastly, we also added support for executing payments on open invoices using either the advertiser current payment method or a one-time payment method.\n"," With this launch, third-party clients can integrate with the Amazon Ads billing APIs and trigger basic operations that are part of the billing lifecycle. This feature is already available via the advertising console, so this launch expands access via the public API.\n"," There are four new endpoints included in this release:\n","POST /billing/paymentMethods/list  POST /billing/paymentAgreements  POST /billing/paymentAgreements/list \\* POST /billing/invoices/pay\n"," For full details, see the API reference and overview.\n"," September 28, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, US\n"," Sponsored Display has added forecast status to the API to better understand how targeting can affect delivery and scale.\n"," Forecasting helps advertisers understand the impact of their choices during campaign creation with a minimum and maximum range of available impressions inventory for a set of selected advertised products, optimization type, targeting, and bid values. This helps advertisers create campaigns that will deliver results, understanding scale by experimenting with the campaign setup, and forecasting the output of an investment before they get started.\n"," The new forecastStatus is now available through the Sponsored Display including IMPRESSION_TARGETING_TOO_NARROW and IMPRESSION_TARGETING_TOO_BROAD. For full technical details, please see our updated Sponsored Display documentation.\n"," September 26, 2023\n"," With the launch of export APIs, we have added a new section to the advanced tools center where we document common Amazon Ads models. The goal of these models is to simplify understanding of and reduce differences across ad products. Currently this documentation covers campaigns and ad groups, including the fields and enum values in the common models, usage across ad products, and mapping to the latest versions of each ad product campaign management APIs.\n"," In the future, we will be adding more entities to this documentation, starting with targets and ads, and using these common models in future API releases.\n"," For more details see:\n","Campaign model - Ad group model - Enums\n"," If you have any comments or questions on these models, please leave a comment in Github.\n"," September 26, 2023\n"," Regions: All\n"," Note: We are announcing these APIs in preview so that you can make test calls and start your integration. During preview, these endpoints have a smaller TPS and job queue capacity.  Once these APIs are ready for scaled adoption and support their full TPS and job queue capacity, we will post a new release note.\n"," Amazon Ads API has launched new export APIs as an update to the existing snapshots functionality. The new APIs currently support asynchronous campaign and ad group exports for Sponsored Products, Sponsored Brands, and Sponsored Display.\n"," These APIs simplify ingestion of Amazon Ads data by providing a common model across different ad products, create parity between asynchronous export APIs and synchronous LIST APIs (including extended data fields), and improve performance over the previous snapshot APIs.\n"," To get started with the export API, see:\n","Exports overview  Exports tutorial  Exports API reference \\* Postman collection\n"," In the near future, we will expand exports to add support for targets and ads.\n"," September 21, 2023\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, EG, TR, AE, SA, AU, JP, IN, SG, BR\n"," Sponsored Products Rest Of Search Placement Bid Adjustment is now available in beta. Advertisers using the Amazon Ads API can now apply bid adjustment for rest-of-search placements in their Sponsored Products campaigns. The new placement bid adjustment control for rest of search works same as the adjustments available for top-of-search (first page) and product-page placements. Through the new control, advertisers can adjust their bid for rest of search by up to 900%, same as the other two placements.\n"," The new placement bid adjustment helps advertisers to balance their campaign performance across the three different placements (top of search, rest of search, product pages). The control is available for all targeting types (auto and manual) and bidding strategies (fixed and dynamic bidding). Advertisers already have access to campaign performance split by the three placements in campaign manager and Sponsored Products placement report. Using the available reporting, advertisers can measure the impact of using the new control in Sponsored Products campaigns.\n"," For the API, you can view the relevant API contract changes by looking at dynamicBidding.placementBidding.placement in POST /sp/campaigns. Use the new enum PLACEMENT_REST_OF_SEARCH to add an adjustment percentage.\n"," September 21, 2023\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, EG, TR, AE, SA, AU, JP, IN, SG, BR\n"," Sponsored Products Rest Of Search Placement Bid Adjustment is now available in beta. Advertisers using bulksheets can now apply bid adjustment for rest-of-search placements in their Sponsored Products campaigns. The new placement bid adjustment control for rest of search works same as the adjustments available for top-of-search (first page) and product-page placements. Through the new control, advertisers can adjust their bid for rest of search by up to 900%, same as the other two placements.\n"," For bulksheets, you will apply this new placement in the \"bid adjustment\" entity row when you create or update campaigns. Learn more about creating bid adjustments in bulksheets\n"," September 19, 2023\n"," Regions: All\n"," Amazon DSP now supports Integral Ad Science (IAS) Context Control products for brand suitability (avoidance) and contextual targeting. This feature is available worldwide to DSP self-service advertisers, and supported on standard display, video, and AAP - mobile app line items running on third-party supply sources. Advertisers will pay a CPM fee from their campaign budgets for the use of these products.\n"," Per IAS - “Context Control products use patented cognitive semantic technology that relies on natural language processing (NLP) to dynamically comprehend the nuances of context using sentiment and emotion analysis across 50 languages. This provides customers precise, page-level content classification at scale.”\n"," For brand suitability, advertisers will be able to choose avoidance segments that are suitable for protecting their brands from exposure to specific content, or negative sentiments they do not want their brands to be associated with. They can do this without avoiding all instances of a certain topic and thus implement brand suitability standards that align closely with their brand values.\n"," For contextual targeting, advertisers can target contextually relevant content for their brand or campaign. This also allows them to increase ad relevance in third-party supply environments where ad identifiers are not available. For more information, see our updated documentation.\n"," September 18, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SA, SE, TR, UK and US\n"," Sponsored Display is launching bid recommendations for video creatives. Advertisers can now customize creatives and receive bid recommendations when using any custom creative, including headline and logo, image, or video. Previously, bid recommendations were only customized for campaigns with static images. With this launch, advertisers receive relevant bid recommendations to ensure their video campaigns have improved inputs to help them reach their audiences.\n"," For full technical details, see our updated bid recommendationsresource. This resource will help find relevant bid suggestions when using either video or image creatives.\n"," September 18, 2023\n"," Regions: AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK and US\n"," We launched a new API, optimization rules (beta)(sponsored-display/3-0/openapi#tag/Optimization-Rules-(beta)), to simplify the campaign management process for advertisers using Sponsored Display. This launch allows advertisers to set performance-based parameters that remove the guess work from selecting an exact bid for each target. This helps advertisers of any size and with any budget achieve their goals with the help of Amazon first-party data and machine learning capabilities.\n"," Before this launch, advertisers needed to translate their desired goals into efficient bids and targets across different cost types. In reality, this turns out to be the biggest issue driving lower scale and campaign effectiveness. By translating goals into bids using machine learning with optimization rules (beta), Amazon can help advertisers achieve better results through continuous optimization. In the future this will be extended to targeting optimizations to further maximize goals.\n"," For campaigns optimized for reach or click, advertisers can apply a cost-based rule like cost per thousand ad views (vCPM) and cost per click (CPC). We will then utilize machine learning models to define the bids while adjusting base bids up and down with the goal of increasing outcomes, all while adhering to the cost-based rules. While Amazon Ads cannot guarantee performance, if the campaign is not meeting the cost target over a 21-day period (excluding special days), we recommend adding additional targets to allow our systems to reach the right audiences.\n"," Optimization rules are now available for Sponsored Display through the Amazon Ads API. For full technical details, see our updated documentation(sponsored-display/3-0/openapi#tag/Optimization-Rules-(beta)).\n"," September 15, 2023\n"," Regions: All\n"," You can now download a bulksheet in your chosen language if that language is selected in your advertiser profile. For example, if Japanese is the language selected in your profile, you will see Japanese text in bulksheets downloads. When you upload the file, you can use any supported language, regardless of the language selected in your profile. Note that the “Operation” field will be blank in the downloaded file. If you need guidance on what values to enter into this field for languages other than English, refer to this language guide for bulksheets translations.\n"," September 13, 2023\n"," Regions: All\n"," Amazon Marketing Stream is expanding to include new Amazon DSP campaign datasets. This includes information on Amazon DSP campaigns, flights, ad groups, and ad group targets.\n"," These signals enable Amazon DSP advertisers and partners to be notified in near real time via Amazon Marketing Stream when Amazon DSP campaign data changes (for example, when campaigns pause, budgets change, or bids update) and what the modification was across thousands of advertising campaigns. Amazon Marketing Stream can help improve information integration patterns and operational efficiency by reducing the number of API calls that are required for intraday campaign optimization. Advertisers and partners can use this dataset to react to events in near real time, such as campaign status changes, rather than run multiple intraday snapshots. Amazon Marketing Stream helps simplify the extract, transform, and load operations compared to snapshots, by showing you only information that has changed, when it occurs.\n"," The Amazon DSP campaign data is split into four datasets: campaigns, flights, ad groups, and ad group targets for each AWS region. To learn more and access this feature, review the Amazon Marketing Stream Onboarding guide, and subscribe to the new Amazon DSP campaign datasets.\n"," September 13, 2023\n"," Regions: All\n"," Sponsored Brands API now allows advertisers to download their original video media using the GET /media/describe. Advertisers can use originalMediaUrl to retrieve their original video media in .MP4 format. Previously, advertisers could only download a preview of the original video using publishedMediaUrl.\n"," Going forward, please use the asset library for all creative management as the POST /media/upload will be deprecated on 1/31/2024. For further instruction, refer to the API specifications here.\n"," August 31, 2023\n"," For the kpiName field in the Goal Configurations Discovery API and Orders API, we have added three new enum values and changed two to match the ADSP UI. We have also changed TOTAL_RETURN_AD_SPEND to TOTAL_RETURN_ON_AD_SPEND in the Goal Configurations Discovery API goalKpi field. In addition, we have added definitions for each enum value.\n"," Here are the details:\n"," Goal Configurations Discovery API goalKpi field:\n","Added descriptions - Changed from COST_PER_ACQUISITION to COST_PER_ACTION - Removed COST_PER_DOWNLOAD - Added COST_PER_FIRST_APP_OPEN - Added COST_PER_INSTALL - Added TOTAL_COST_PER_SUBSCRIPTION - Changed from TOTAL_RETURN_AD_SPEND to TOTAL_RETURN_ON_AD_SPEND\n"," Orders API goalKPI field:\n","Added descriptions - Changed from COST_PER_ACQUISITION to COST_PER_ACTION - Removed COST_PER_DOWNLOAD - Added COST_PER_FIRST_APP_OPEN - Added COST_PER_INSTALL - Added TOTAL_COST_PER_SUBSCRIPTION\n"," See the changes here.\n"," August 21, 2023\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/v1/profiles \\* /v1/profiles/{profileId}\n"," If you would like to share feedback, please use the Amazon Ads API Service Desk to open a ticket with subject title \"Profiles v1 Deprecation\" by December 15, 2023.\n"," August 17, 2023\n"," Regions: US\n"," Different brands prioritize different brand building goals depending on their marketing strategy and their brand building journey. Deciding the right campaign controls (budget, targets, bids, ad creative formats) for those goals can be time-consuming and prone to errors. With this release, we are introducing Sponsored Brands goal-based campaigns, providing simplified campaign creation and management workflow for the desired goals to better achieve your brand marketing objectives. In this release, we will introduce two new goals: “Drive Page Visits” and “Grow Brand Impressions Share”; each with a unique set of campaign controls to achieve that goal. This helps advertisers of any size grow their brands and deliver business objectives with simplified campaign controls and guidance powered by Amazon 1P data and machine learning capabilities.\n"," Advertisers can access this feature via the Amazon Ads API. For instructions on how to enable this feature, refer to step one of this guide to getting started with campaigns.\n"," August 17, 2023\n"," Regions: US\n"," Sponsored Brands theme targeting provides a new method to control your campaign targeting. It uses advanced machine learning algorithms that take into account historical performance targets and brand interactions to create a large set of keywords. It then categorizes those keywords into relevant groups to use with your campaigns. Two targeting groups are available in this launch: “Keywords related to your brand” and “Keywords related to your landing pages.” These targeting groups will be pre-selected to simplify the campaign creation process for advertisers.\n"," Advertisers can access this feature via the Amazon Ads API. For instructions on how to enable this feature, refer to this developer guide.\n"," August 15, 2023\n"," Sponsored Brands datasets are now available globally in Amazon Marketing Stream. We are excited to expand the Sponsored Brands datasets in Amazon Marketing Stream to all countries currently supported by the Amazon Ads API. These datasets are currently available in beta. Amazon Marketing Stream delivers Amazon Ads campaign metrics and information to advertiser or integrator AWS accounts via a push-based model in near real time. This data will not be available for Sponsored Brands version 3 (legacy) campaigns.\n"," Amazon Marketing Stream is already available globally for Sponsored Products and Sponsored Display campaigns and sponsored ads budget usage via the Amazon Ads API for agencies, tool providers, and direct advertisers, including vendors and sellers worldwide. When you are ready to get started, visit the Amazon Marketing Stream onboarding guide.\n"," For more information on the new Sponsored Brands datasets, see:\n","Sponsored Brands traffic - Sponsored Brands conversion - Sponsored Brands clickstream - Sponsored Brands rich media\n"," August 11, 2023\n"," Regions: All\n"," As of August 10th, all campaigns created using the version 3 Sponsored Brands POST /sb/campaigns endpoint are stored as multi-ad group (version 4) campaigns. With this change, existing integrations should continue to work as intended. Advertisers, agencies, and tool providers can leverage the Sponsored Brands version 4 endpoints or the Amazon advertising console to create additional ad groups and ads.\n"," Previously, these changes were limited to the US marketplace but we have completed the backend migration across all regions. For full technical details, see the version 4 migration guide.\n"," August 6, 2023\n"," Advertisers will soon be able to apply bid adjustment controls for rest-of-search placements in their Sponsored Products campaigns. The new placement bid adjustment control for rest-of-search placements works in the same way as the adjustments available for top-of-search (first page) and product-page placements. Through the new control, advertisers will be able to adjust their bid for rest of search by up to 900% (same as the other two placements). This will be available for bulksheets as well as the API.\n"," You can view the relevant API contract changes by looking at dynamicBidding.placementBidding.placement in POST /sp/campaigns. Once available, you will be able to use the new enum PLACEMENT_REST_OF_SEARCH and add an adjustment percentage. This enum is currently in a read-only state, and we will update the release notes when you can start using this feature.\n"," August 2, 2023\n"," Regions: DE, ES, IT, FR\n"," Amazon Ads has made it easier for advertisers to create policy-compliant Sponsored Brands video campaigns in marketplaces where they are unfamiliar with the local language. Now, if advertisers add a video to their Sponsored Brands video ad that does not match with the language requirements of the country, they can opt to have their video auto-localized into the country local language. Localization takes up to 72 hours and the campaign goes live automatically once the video is localized. This localization service is offered to advertisers at no extra cost and comes quality assured by professional linguists.  At launch, the service supports English source videos into German, French, Italian, and Spanish.\n"," Every month, thousands of campaigns are rejected due to advertisers submitting an English video for non-English speaking regions. This new feature helps advertisers overcome this friction related to building creatives in non-english languages, and enables more campaigns to be created.\n"," The new consentToTranslate field is supported in the following endpoints:\n","/sb/v4/ads/video  /sb/v4/ads/brandVideo  /sb/v4/ads/list  /sb/ads/creatives/video  /sb/ads/creatives/brandVideo \\* /sb/ads/creatives/list\n"," For full technical details, please see our updated documentation for /sb/v4/ads/brandVideo as an example.\n"," August 1, 2023\n"," Regions: All\n"," We are excited to announce that Amazon Marketing Stream, which was first launched for North America as beta on June 21, 2022, is now generally available. Amazon Marketing Stream delivers Amazon Ads campaign metrics and information to advertisers’ or integrators’ AWS accounts via a push-based model in near real time. You can subscribe to Amazon Marketing Stream datasets using your API token and AWS account. Once you are subscribed, Amazon Marketing Stream delivers hourly, near real-time performance metrics and signals. Stream supports different categories of data: hourly performance reporting metrics, near real-time campaign management notifications, and push-based recommendations. Stream is available in all locations where the Amazon Ads APIs are supported.\n"," In the past, access to scaled campaign reporting was limited to pull-based Amazon Ads API calls that provided daily performance, and on-demand access to other campaign information. API users who desired more real-time, intra-day campaign insights have manually pulled this information by calling Amazon Ads API multiple times a day, sometimes resulting in increased throttling. In addition, the current approach puts the burden on developers to identify changes between new and old data. Such API usage patterns highlighted the need to build a product that better addresses our customers’ evolving use cases.\n"," Amazon Marketing Stream is available via the Amazon Ads API. When you are ready to get started, visit our Amazon Marketing Stream onboarding guide that will walk through the process of getting API access, integrating with AWS, and subscribing to campaign datasets using the Amazon Marketing Stream API.\n"," July 27, 2023\n"," The legacy version of bulksheets will be deprecated on September 28, 2023, and will no longer be available for campaign management. Ahead of this date, we encourage you to migrate to the new version if you have not started already.\n"," To help you through this transition, we have published a new set of bulksheets documentation, getting started guides, video tutorials, detailed instructions for creating and managing all sponsored ads campaigns, and other resources. Please check out these links to learn more:\n","Bulksheets overview  Migration guide  Video tutorials \\* FAQs\n"," July 27, 2023\n"," Sponsored Brands versions 3 campaign management, draft, and media APIs are being deprecated, with a target shutoff date of January 31, 2024. Please migrate to the new versions of campaign management endpoints as documented on our Deprecations page and in our Migration guide. As a part of this deprecation, Sponsored Brands draft endpoints have reached their end of life and will not be replaced with new endpoints.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/sb/campaigns/  /sb/adGroups/  /sb/adGroups/{adGroupId}  /sb/campaigns/{campaignId}  /sb/drafts/campaigns  /sb/drafts/campaigns/{draftCampaignId}  /sb/drafts/campaigns/submit  /media/upload  /media/complete\n"," If you would like to share feedback, please use the Amazon Ads API Service desk to open a ticket with subject title \"SB v3 Campaign CRUD Deprecation\" by August 15th, 2023.\n"," July 24, 2023\n"," Regions: US\n"," We have extended Sponsored Display capabilities to advertisers who do not sell in the Amazon store. Previously, Sponsored Display was only available for brands that sell products on Amazon. With an easy-to-use interface and no minimum spend requirements, advertisers can create compelling display ads in just a few clicks to help grow their business.\n"," Advertisers who do not sell on Amazon can now connect with relevant audiences for their business using Sponsored Display. With this launch, advertisers can:\n","Reach relevant audiences, in relevant locations, on and off the Amazon store: Activate Amazon Ads exclusive audiences built from shopping and streaming signals. Choose postal code, city, designated market area (DMA), and/or state locations. Reach audiences on Amazon.com, Twitch, IMDb, and thousands of websites and apps beyond the Amazon store.  Drive visits to your site with visually-appealing creative formats: Boost visibility and drive visits to your website with engaging display ads. All advertisers need is an image, headline, and logo to get started. We will do the heavy lifting and build ads optimized for a variety of placements, sizes, and devices to increase reach.  Easy and simple campaign set-up: Create compelling display ads in just a few clicks, with a few basic inputs across bidding, targeting, creatives, and landing page destination. \\* Advertise with no minimum budget requirements: With no minimum budget requirements, Sponsored Display unlocks the power of Amazon Ads for any self-service advertiser.\n"," For full technical details, please see our new developer guide on Sponsored Display for all advertisers. You can also explore all the calls needed to build an off-Amazon Sponsored Display campaign in our Postman collection.\n"," July 21, 2023\n"," Regions: All\n"," Campaign ID and ad group ID are now available when you request a Sponsored Brands purchased products report. You can find these IDs in two new columns in the report. These IDs will not be available for Sponsored Brands version 3 (legacy) campaigns.\n"," These IDs are important because they are unique identifiers that do not change over time, whereas the entity names can change. Without the IDs, advertisers would need to locate the IDs outside of the purchased products report, which can waste time and increase manual effort.\n"," To use this feature, request the additional base metrics (campaignId and adGroupId) as part of the Sponsored Brands purchased product report generated via the version 3 reporting API.\n"," July 20, 2023\n"," Regions: All (except BE)\n"," We have enhanced Sponsored Brands brand video ads so that advertisers can highlight a collection of products to direct shoppers to their brand store. Prior to this launch, advertisers could only promote one product with their brand video ads. Now, advertisers can highlight a collection of products (up to three products) when creating a new campaign.\n"," Stores are more discoverable to shoppers, as they are the primary method for advertisers to showcase brands and products in a multi-page, immersive shopping experience on Amazon. Stores allow brands to curate content that inspires, educates, and helps shoppers discover the brand entire product selection, taking shoppers from inspiration to action.\n"," For full technical details, see the updated documentation on Sponsored Brands brand video ads. This feature is only available on the Sponsored Brands version 4 Amazon Ads APIs. If you have not yet migrated from Sponsored Brands version 3 to Sponsored Brands version 4, please review our migration guide.\n"," July 20, 2023\n"," Regions: CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, EG, TR, AE, SA, AU, JP, IN, SG, BR\n"," Sponsored Brands advertisers in CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, EG, TR, AE, SA, AU, JP, IN, SG, BR can now access the missed opportunities and budget recommendations API (previously only available in the US), which provides budget recommendations for campaigns that have gone out-of-budget and estimates of missed business impressions, clicks, and sales.\n"," Advertisers can leverage this service to understand the impact of out-of-budget campaigns and reduce the likelihood of going out-of-budget, which will help campaigns reach their full potential.\n"," For full technical details, see the API reference.\n"," July 19, 2023\n"," Regions: All\n"," We have updated our rendering UI for OpenAPI specifications to provide an easier browsing experience for developers. The new layout allows easier navigation across the different methods and API endpoints. With this change, we have added a consistent layout across the schemas, fixed deep indentation when expanding and collapsing schemas, added the ability to view schemas and examples at the same time, and enabled easy copying of samples and parameters. API reference pages are also now mobile friendly and accessible.\n"," To explore the new layout, check out any of our API reference documents. If you have any feedback, please leave a comment in the related GitHub discussion.\n"," July 18, 2023\n"," Bulksheets downloads are now available in Chinese and Japanese languages. If you have one of these selected as the language in your advertiser profile, you can download a bulksheets file in the selected language. All headers, error messages, and other text will be translated. Some text, such as campaign and ad group names, will remain unchanged. For bulksheets uploads, you can use Chinese, Japanese, or English, regardless of the language selected in your profile. For bulksheets uploads, you can use Chinese or Japanese if these are selected in your profile, or you can upload in English, regardless of the language selected in your profile.\n"," July 18, 2023\n"," Regions: US\n"," As of June 26, 2023, Omnichannel Metrics (OCM) charges a usage fee of “4% of media spend”.\n"," To calculate the OCM fee, 4% will be applied to the \"Supply cost\" in Amazon DSP and only applied to impressions where OCM is enabled. For example, if an order is booked to run from 8/1/23 to 8/30/23, and OCM is enabled on 8/15/23, you will only be charged for impressions that run from 8/15/23 to 8/30/23. Advertisers using OCM will be billed on a monthly basis following standard invoicing timelines.\n"," OCM enables you to measure the impact of your ad tactics on holistic shopping activities across retail outlets, on-Amazon and off-Amazon) while campaigns are mid-flight. Through our automated budget optimization feature, you can reallocate budgets to better performing line-items before the campaign ends, to help improve the overall campaign ROAS. OCM launched for general availability in October 2022 for all US CPG advertisers.\n"," June 30, 2023\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, AU, UAE, JP, BR, NL, TR, SE, IN, SA\n"," Amazon DSP is launching several new endpoints available through the Amazon Ads API to enable advertisers to manage their Amazon DSP programmatic deals:\n","POST /dsp/inventory/deals - Creates a third party deal object  PUT /dsp/inventory/deals/{dealId} - Updates a third party deal object  GET /dsp/inventory/deals/{dealId}/advertiserPermissions/advertiserList - Gets list of advertisers assigned to the deal and its advertiser permissions strategy type  PUT /dsp/inventory/deals/{dealId}/advertiserPermissions/advertiserList - Updates advertiser permissions by adding/removing advertisers to/from the advertiser permission list  POST /dsp/inventory/deals/{dealId}/advertiserPermissions - Assigns permissions strategy to deal object  GET /dsp/inventory/deals/{dealId}/advertiserPermissions - Gets the advertiser permissions strategy type for a given deal  DELETE /dsp/inventory/deals/{dealId}/advertiserPermissions - Deletes both the permission strategy and associated advertisers from the deal advertiser permissions\n"," Though these features were previously available in the Amazon DSP console, advertisers can now access them programmatically through the Amazon Ads API. This helps bring the Amazon Ads API experience in line with the advertising console, and gives advertisers greater flexibility when managing Amazon DSP programmatic deals.\n"," With these additional Amazon Ads API endpoints, advertisers can create and update their Amazon DSP programmatic deal libraries, and build their own business applications leveraging these objects. They can now push their own deals to their Amazon DSP deal library, and assign specific advertiser permissions to each deal.\n"," This release supports all standard deal types, except Amazon Audience Guaranteed deals, which users will need to continue creating/updating via their Amazon DSP console. For full technical details, please see our deal create and update API documentation and deal advertiser permissions API documentation.\n"," June 29, 2023\n"," Regions: All\n"," Amazon Marketing Stream (beta) expands to include new sponsored ads campaign datasets. This includes information on Sponsored Products, Sponsored Brands, and Sponsored Display campaigns, ads, ad groups, and targeting.\n"," These signals enable Amazon Ads advertisers and partners to be notified in near-real-time via Amazon Marketing Stream when sponsored ads campaign data changes (for example, when campaigns pause, budgets change, or bids update) and what the modification was across thousands of advertising campaigns. Amazon Marketing Stream can help improve information integration patterns and operational efficiency by reducing the number of API calls that are typically required for intra-day campaign optimization. Advertisers and partners can use this dataset to react in near real-time to events that happen, such as campaign status changes, rather than run multiple intraday snapshots. Amazon Marketing Stream helps simplify the extract, transform, and load operations compared to snapshots, by showing you only information that has changed, when it occurs.\n"," The new campaign datasets are available to advertisers and partners using Amazon Marketing Stream (beta). This is available worldwide, with campaign datasets available by AWS region.\n"," The sponsored ads campaign data is split into four datasets: campaigns, ad groups, ads, and targets for each AWS region. You can access it following the instructions for Amazon Marketing Stream Onboarding Guide, and subscribe to the new campaign datasets.\n"," June 22, 2023\n"," We have updated the names of some column headers and values to make them more readable. For example, in the Portfolios sheet, the Portfolio Id heading is now Portfolio ID and in the Budget Policy column, the noCap value is now No Cap and the dateRange value is now Date Range.\n"," You will see these new heading and values in any new sheets that you request. Note that previous and new column header values will continue to function as before in bulk upload, and there is no need to update old sheets to the new headings and values.\n"," We are currently updating the documentation and we will continue to document the previous headers and values and add the new headers and values alongside to make these updates clear.\n"," June 21, 2023\n"," Regions: AE, AU, BE, BR, CA, DE, EG, ES, FR, IT, JP, IN, MX, NL, PL, SA, SE, SG, TR, UK, US\n"," Rapid retail analytics, available through the Selling Partner API, allows advertisers to unlock hourly retail metrics. Analytics are available minutes after the close of an hour. This provides access to near real-time retail signals like ordered units and glance views to help advertisers measure performance and adjust their marketing and advertising activities.\n"," Partners and advertisers can leverage this timely information to add a never-before-available layer of measurement and insights to improve ASIN-level analytics, automate campaign changes, and inform cross retail-ads optimizations. Tool providers can add advertiser value by using rapid retail analytics to automatically increase budget allocated to an ASIN when hourly sales are below an expected range. They can also build their own specific strategies, such as ingesting advertiser forecasts.\n"," Rapid retail analytics is exclusively available through the Selling Partner API, with full details here. If you are not yet using the Selling Partner API, see the getting started guide.\n"," June 20, 2023\n"," Regions: All\n"," We have now updated the default rollover value for all accounts to be 100%. This change only impacts accounts that have not yet selected a default, either through the API or the advertising console. If you have already chosen either 25% or 100%, you will not experience any change in your settings. You can set your default to 25% using the POST /accountBudgets/featureFlags endpoint.\n"," For more information, view the User guide.\n"," June 15, 2023\n"," We have released a new user interface for the advanced tools center, featuring an updated look and feel as well as a new navigation. The navigation is now responsive, and readable on mobile devices.\n"," Documentation is split into categories based on use case:\n","Developer guides—featuring tutorials, product overviews, and code samples for developers  API reference—containing OpenAPI specifications and conceptual content about REST APIs  Knowledge Hub—including blogs, workshops, and bulk operations documentation\n"," You can also find a dedicated section for Support and Release notes for all advanced tools.\n"," If you have any feedback on the new design, we would love to hear from you in GitHub.\n"," June 15, 2023\n"," Regions: US\n"," As of May 22, any campaigns created using the version 3 Sponsored Brands POST /sb/campaigns endpoint are stored as multi-ad group (version 4) campaigns. With this change, existing integrations should continue to work as intended. Advertisers, agencies, and tool providers can leverage the Sponsored Brands version 4 endpoints or the Amazon advertising console to create additional ad groups and ads. This change is currently only in place for US advertisers. We will expand this change to advertisers in other regions in the coming months.\n"," See the version 4 migration guide for additional details.\n"," June 15, 2023\n"," Regions: BE\n"," Vendor test accounts are now available for Belgium through the Amazon Ads API. For an updated list of supported marketplaces for both vendor and author test accounts, see Creating test accounts in the advanced tools center.\n"," June 6, 2023\n"," Regions: US, CS, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, EG, TR, AE, AU, JP, IN, SG, BR, SA\n"," We added a new top-of-search impression share metric for Sponsored Products and Sponsored Brands to reporting in the Amazon Ads API. This metrics helps brands measure the effectiveness of their campaigns and keywords at driving brand awareness at scale.\n"," Integrators can now access the top-of-search impression share metric daily through the API. You can apply the metric to your systems to power notifications, automations, and other functionality. This helps support meeting top-of-search impression share goals on critical campaigns and keywords. These metrics can help brands accelerate brand strategy analysis and optimization as well as customer acquisition.\n"," The new top-of-search impression share metric is available at the campaign and keyword level through the sponsored ads reporting APIs. For Sponsored Products, the metric is available in sponsored ads version 3 reporting. For Sponsored Brands, the metric is available through the sponsored ads version 2 reporting. For more information on the metric and its report availability, see topOfSearchImpressionShare in version 3 and version 2.\n"," May 29, 2023\n"," Regions: All\n"," Advertisers tracking conversions occurring on their owned website, app, or offline property (such as an in-store environment) can now leverage two new options for conversion information delivery. Amazon Advertising tag can be used for tracking user actions taken on an advertiser-owned website. In addition to website conversions, Conversions API can accept events occurring in an advertiser-owned app, or offline property, such as an in-store environment through a server-to-server connection with the advertiser server or an integrated third party server. In addition to conversion signal delivery, the Conversions API allows advertisers to create and manage their conversion definitions, as well as access a user information deletion feature to assist advertisers with privacy-compliance for newly opted out users.\n"," Both sources support the use of durable identifiers, such as consented hashed email and are offered as durable alternatives to Simple Pixel (to be deprecated by the end of 2023). Conversions API is a great option for customers who host their event information themselves or in a third party server and prefer not to implement a third party tag on their website. Conversions API newly introduces the ability to import off-Amazon offline transactions, i.e. an end-user making a purchase in a store environment.\n"," Conversions API and corresponding features will be available to managed service and self-serve Amazon DSP advertisers world-wide. Tracked conversions can be viewed and managed in the Amazon DSP console Conversions page. To use the conversions for campaign measurement, conversions can be associated with orders using a new ‘Off-Amazon conversions’ widget when creating orders in the Amazon DSP console. Conversions signals will also be made available as seed information for audience building in the Amazon DSP console within Audiences.\n"," To start importing conversions, customers will use the Amazon DSP API to create a new object called a conversion definition. Conversion definitions enable advertisers to associate additional information about the event, such as fallback value or processing preferences. When importing events, each event will be mapped to a conversion definition using a conversion definition ID. For full technical details, please read the API reference.\n"," May 25, 2023\n"," Regions: All\n"," Partners and advertisers can now use the tactical recommendations API to get suggestions for their Sponsored Products, Sponsored Brands, and Sponsored Display campaigns. Recommendations are made by Amazon Ads machine learning algorithms or account management teams, and each recommendation includes the campaign setting changes needed to execute the recommendation. Example recommendation types include campaign optimizations like recommended bids, budgets, or targets, as well as suggested settings for creating new campaigns.\n"," The tactical recommendations API contains three new endpoints:\n","POST /recommendations/list to retrieve recommendations  POST /recommendations/update to update recommendations  POST /recommendations/apply to automatically apply recommendations to your account\n"," For more information, view the API reference, Overview, and Getting started guide.\n"," May 25, 2023\n"," Regions: US, CA, UK, DE, ES, IT, FR, PL, NL, SE, UA, SA, AU, JP, IN, SG, BR, MX\n"," New metrics are now available for the Sponsored Brands keyword recommendation through the Amazon Ads API. You can now receive search term impression share and search term impression rank for each recommended keyword. Search term impression share and rank are only available if your account has generated impressions for search terms matching the recommended keywords.\n"," These metrics help with making informed keyword selections by identifying potential keywords to target based on your impression share and impression rank of search terms. Search term impression share shows how your account-wide impression share for each search term compares to other advertisers, and the overall percentage of ad impressions you receive compared to other advertisers over last 7 days. For example, if you have a Sponsored Brands impression share of 20% for a search term, it means that you won 20% of all Sponsored Brands ad impressions for that search term. Similarly, search term rank helps you understand the level of activity on terms that you are targeting. For example, if you have a search term impression rank of 3 on a search term, it means that you received the third most Sponsored Brands ad impressions for the same search term over the last 7 days.\n"," For full technical details, please see the API reference.\n"," May 23, 2023\n"," Marketplaces: US, CA, UK, IT, FR, DE, ES, JP, IN, AU, MX\n"," Brand Metrics is a new measurement solution that quantifies opportunities for your brands at each stage of the customer journey on Amazon, and helps brands understand the value of different shopping engagements that impact stages of that journey. With Brand Metrics you can now access awareness and consideration indices that compare brand performance to peers using models predictive of consideration and sales. Brand Metrics is built at scale to measure all shopping engagements with your brand on Amazon, not just ad-attributed engagements and quantifies the number of shoppers in the awareness, consideration, and purchase stages of the shopping journey with your brand. Brand Metrics also provides Return on Engagement, so you can measure the average historical sales following a consideration event or purchase.\n"," Brand Metrics helps you...\n","Understand your brand performance. Brand Metrics measures the number of actual on-Amazon shopper engagements.  Measure the impact of your upper and mid funnel tactics to see how they contribute to shoppers moving through the purchase journey.  Evaluate engagement metrics to understand the value of your branded intent, and how brand purchasers go on to generate additional sales in the 12 months following a purchase.  Monitor your performance relative to your category and peers at each stage of the purchase journey and over time.  Optimize your marketing and advertising efforts on Amazon to engage more shoppers and build your brand.\n"," This release features two new endpoints - /insights/brandMetrics/report and /insights/brandMetrics/{reportId} to generate and retrieve Brand Metrics report in CSV or JSON format.  With these endpoints the developers can now create customizable reports by passing in a date range, a brand name, or by passing in specific metrics from a list of Brand metrics.\n"," For full technical details please see our overview and Brand Metrics reference documentation in the Amazon Ads API.\n"," May 18, 2023\n"," On 05/22/2023, Sponsored Display will introduce dynamic client-level throttling based on the most common partner traffic patterns. These limits are determined on a per-region basis with multiple limit tiers that correspond with our existing service capacity. With these changes, Sponsored Display campaign management client level throttling will be more consistent with Sponsored Products V3 API.\n"," Please note that different time periods of higher utilization may occur each day. Keep this in mind if you encounter a higher occurrence of 429 HTTP response codes. For more information, see our updated rate-limiting documentation. Rate limits in the Amazon Ads API are dynamic and based on system load. If you experience frequent rate limits, you can decrease this by following our best practices to avoid rate limiting.\n"," If you have any questions, visit the Amazon Ads API Support page and create a ticket with the subject title: \"Sponsored Display dynamic client-level throttling.\"\n"," May 12, 2023\n"," Regions: BE\n"," With the launch of Sponsored Display audience targeting in Belgium, registered sellers and vendors can customize the audiences they want to reach based on customer shopping signals and granular product refinements. For example, an advertiser can engage with audiences who searched, viewed, or purchased a collection of products on Amazon and reach them again on and off Amazon. Advertisers using Sponsored Display can also customize their creatives choosing any combination of video, headline, logo, or lifestyle image to help audiences discover their brands and products.\n"," For full technical details, see our Sponsored Display targeting documentation.\n"," May 10, 2023\n"," We are excited to launch Amazon Ads Status (beta), a new offering that provides all advertisers with the latest status information on Amazon Ads services. Advertisers will be able to see the current status of services like campaign creation, campaign management, ad delivery, and reporting on sponsored ads and Amazon DSP. Should there be a service interruption, advertisers can see more details for the event, including the description and status updates for that service.\n"," In the past, there has not been a dedicated location where advertisers or API integrators could look to get the current status of Amazon Ads services. During any service interruption, advertisers could only get that information after they log in to the advertising console or Amazon DSP. With the introduction of Amazon Ads Status (beta), users can now view the current status of Amazon Ads services and be updated with the latest information during any potential service disruptions, without the need to log in to the advertising console or Amazon DSP.\n"," The ad status information can be accessed programmatically using https&#x3A;//status.ads.amazon.com/status.json, which returns Amazon Ads Status in JSON format. The JSON schema is also available using https&#x3A;//status.ads.amazon.com/status.schema.json.\n"," Questions or comments on this feature? We would love to hear your feedback in GitHub.\n"," May 4, 2023\n"," Regions: US, CA, MX, UK, DE, ES, EG, PL, IT, FR, AU, AE, JP, BR, NL, TR, IN, BE, SG, SE, SA\n"," We are introducing new ASIN engagement metrics for select brand Stores\\* using the Amazon Ads API. With these metrics, eligible brands can understand how shoppers are engaging, and to what degree, with products listed on their brand Store. Metrics include ASIN renders, views, in-stock views, in-stock view rate, average in-stock view price, clicks, click-through rate, add-to-cart rate, purchases, units sold, conversion ratio, and average sales price.\n"," Store engagement metrics allow brands to better understand how shoppers interact with ASINs featured on their Store. Brands can use this signal over time to help increase shopper engagement, improve their store merchandising, keep high performing products in stock, and help boost overall Store performance.\n"," The ASIN engagement API returns key ASIN engagement insights for a given brandEntityId. For full technical details, see the API reference.\n"," May 4, 2023\n"," When you create Sponsored Products campaigns with automatic targeting, you can now create the four product targeting entities and apply a custom bid to each targeting expression (close-match, loose-match, complements, and substitutes). You can also set the targeting entities to be paused if you do not want to apply a bid to a specific target. If you want Amazon to automatically create these targeting expression entities, you can choose not to create them, and one targeting entity will be created for each expression type with the ad group default bid applied. Learn more about creating Sponsored Products auto-targeting campaigns.\n"," April 28, 2023\n"," Starting September 30, 2023, any Sponsored Display campaigns that have not delivered any viewable impressions, clicks, or conversions over a 6-month look-back period could be automatically paused. This will allow advertisers and partners to focus on the campaigns that are driving outcomes.\n"," To help campaigns deliver results, Sponsored Display has features to create high-performance campaigns based on the outcomes they have selected. Advertisers and partners can create campaigns that are optimized for reach (to increase awareness), page-visits (to increase consideration), or conversions (to increase sales).\n"," We suggest adopting the following tools to help Sponsored Display campaigns deliver viewable impressions, clicks, or conversions (depending on how the campaigns are optimized):\n","Bid recommendations API  Targeting recommendations API  Budget usage API \\* Campaign diagnostic recommendations through Amazon Marketing Stream\n"," If you have a question, you can go to the Amazon Ads API Support page and create a ticket with the subject title: \"Sponsored Display pausing campaigns with no delivery.\"\n"," April 28, 2023\n"," Search term report data is now available for Sponsored Products in bulksheets. This report will be in a new tab and will include much of the same information you would find in the advertising console report, including the customer search terms that were used to discover your ads—-but in bulksheets, you will also have the entity IDs available, so you can quickly make adjustments if needed.\n"," You can include a search term report in bulksheets if you go to the bulk operations main page, create a custom spreadsheet, and check the box labeled Sponsored Products search term report in Step 1.\n"," Learn more about search term reports in bulksheets\n"," April 25, 2023\n"," We have introduced a new search UI to improve discoverability in the advanced tools center. The new design makes it easier to sort based on the type of content you are looking for: Guides & tutorials, API reference documentation, or release notes. You can also see your past searches.\n"," We have also improved our search algorithm to cover more content and enabled fuzzy match, so even if your search term does not match exactly, you should see results.\n"," Give it a try and let us know if you have any feedback in GitHub.\n"," April 18, 2023\n"," We have improved the design of the advanced tools center homepage to make it easier to discover resources and technical documentation.\n"," From the new homepage you can:\n","Easily access video tutorials, courses, user guides, and events.  Quickly navigate to popular content and see what is new.  Compare our different advanced tools offerings from a single page.\n"," Check out the new homepage now, and if you have any feedback, we would love to hear it in GitHub.\n"," April 6, 2023\n"," Regions: All\n"," In July 2022, we expanded the budget rules API to support performance-based budget rules for Sponsored Brands campaigns using return on ad spend (ROAS). We have now added two new metrics for Sponsored Brands performance-based budget rules: top-of-search impression share (metricName is IS) and percent of sales new-to-brand (metricName is NTB).\n"," Budget rules help you plan budget changes in advance so you can spend less time making manual adjustments. You can set rules based on specific dates or performance goals. Advertisers can use budget rules to reduce the likelihood of campaigns running out of budget, especially during peak days or holiday events.\n"," For more information, see:\n","Sponsored Brands budget rules API reference  Sponsored Brands budget rules overview  Sponsored Brands performance-based budget rules\n"," April 6, 2023\n"," Sponsored Display has launched targeting recommendations for Amazon audiences. Amazon audiences is a catalog of pre-built, easy-to-use audience segments that help advertisers discover and reach new customers.\n"," Advertisers can now find suggestions on Amazon audiences to help discover new customers based on their brand core customers. For example, if an advertiser sells camping accessories, they can select the recommended audience “Outdoor Enthusiasts.” These recommendations are built by Amazon Ads and informed by a variety of first-party shopping signals. Self-service advertisers can now directly connect with audiences relevant to their promoted products by selecting the recommendations. These recommendations are now available for Sponsored Display audience targeting campaigns within the Amazon Ads API.\n"," Advertisers can now find relevant suggestions on audiences across four segments: in-market, lifestyle, interests, and life events that are informed by Amazon first-party shopping and streaming signals.\n"," For full technical details, please see our Sponsored Display documentation, including the updated targeting recommendation documentation.\n"," Note: If you are already specifying a version in the Accept request-header field, you must update to application/vnd.sdtargetingrecommendations.v3.3+json to access the new features.\n"," April 5, 2023\n"," Regions: All\n"," With the new budget usage feature now available to API users without access restrictions, users worldwide can pull their real-time budget usage percentage for Sponsored Products, Sponsored Brands, and Sponsored Display using the Amazon Ads API. You can pull budget usage information for both campaigns and portfolios.\n"," Your budget usage percentage helps you understand how fast your campaigns and portfolios are spending daily budgets, and can give you the information needed to make quick budget decisions.\n"," For more information, see the budget usage resource in the Sponsored Products reference, Sponsored Brands reference, Sponsored Display reference, or Portfolios reference. You can also test the budget usage endpoints using our Postman collection.\n"," April 3, 2023\n"," We have released new overview and tutorial content for Sponsored Brands and the creative asset library API. This content helps you create a Sponsored Brands campaign and understand its structure, the different ad formats, and how to upload and register creatives.\n"," Find all new Sponsored Brands content under Sponsored Brands > Overview. Find all new creative asset library API content under Common resources > Creative Asset Library beta.\n"," Also see our updated Postman collection, where we have added new Sponsored Brands and creative asset library request templates.\n"," March 31, 2023\n"," Amazon Marketing Stream (beta) has added a new dataset, surfacing sponsored ads campaign recommendations to partners worldwide. With this release, partners can now receive targeted recommendations that they can use to manage campaigns more efficiently. These recommendations not only highlight opportunities to improve the performance of existing ad campaigns or create new ad campaigns, but also surface the suggested campaign settings to take action on those opportunities. These recommendations have been available to advertisers in the advertising console and we are now expanding access through Amazon Marketing Stream worldwide.\n"," The sponsored ads campaign recommendations come in the form of pre-packaged campaign setting changes suggested by Amazon Ads machine learning algorithms, based on a diagnosis of the advertiser catalogue and campaigns (for example, campaigns that have opportunity to improve ROAS compared to similar campaigns by optimizing bids, or unadvertised ASINs that can drive incremental sales if added to an ongoing campaign). Each recommendation will have an insight on how the opportunity was identified and details on the inputs for the recommendation. The campaign setting changes are delivered as campaign optimizations including recommended bids, budgets, or targets, as well as suggested settings for creating a new campaign. After subscribing to this dataset on Amazon Marketing Stream, partners receive these recommendations daily. Partners can easily update or apply the recommendations in bulk by calling the tactical recommendations API and passing the recommendation ID. Partners can also use the sponsored ads campaign management APIs to make the suggested campaign changes.\n"," The current recommendations available in the dataset include:\n","Sponsored Products budget recommendations to identify high performing campaigns (ROAS of greater than three) that might run out of budget in next seven days (utilized 80% of their budget).  Sponsored Products budget rules for special events to identify campaigns which might go out of budget during upcoming high-traffic days in the next eight weeks and apply a budget increase for those specific days.  Sponsored Brands and Sponsored Display bid optimization to identify low-performing campaigns and suggest bid optimization to improve ROAS.\n"," We will enabling more recommendations in the coming months.\n"," For more details:\n","View dataset schema and IAM policies - Create SQS queues for the new dataset using our CloudFormation template - View Tactical recommendations API user guide for Stream\n"," March 30, 2023\n"," Regions: BE, EG, SA, SG, PL, TR\n"," Advertisers can now choose to customize creatives using a headline and logo, image, or video through Sponsored Display self-service display solution that helps grow their business with Amazon across more marketplaces. The new video creative capability supports videos up to 45 seconds so advertisers can better tell their stories to customers, helping them understand the product and brand with more engaging content.\n"," Video creatives can help advertisers tell better stories while serving ads on and off Amazon in their own visual language, helping shoppers get excited about the brand and product experience. If insights on creative are available that helps drive traffic or engagement, advertisers can use that creative for their Amazon Ads campaigns. Ads will link directly to the advertiser product detail pages, so audiences can learn more about their product and consider purchasing.\n"," For full technical details, please see our updated Sponsored Display documentation, including contextual targeting support for creativeType of VIDEO.\n"," March 29, 2023\n"," We have released new overview and tutorial content for the DSP reporting API.\n"," This content helps you:\n","Request your first report. - Understand DSP reporting concepts such as dimensions and reporting according to your account type. - Get answers to frequently asked DSP reporting questions. - Reference a consolidated lists of DSP report types and metrics.\n"," Find all new reporting content under Reporting > Amazon DSP.\n"," See also our updated Postman collection. We have included new DSP report request templates for each DSP report type.\n"," March 28, 2023\n"," Regions: All\n"," We have updated our daily budgeting policy for Sponsored Products, Sponsored Brands, and Sponsored Display, allowing you to spend up to 100% more than the average daily budget on any given day. This update enables you to benefit from high-traffic days by using budgets from previous days when your spend is below your daily budget. The daily budget amount is averaged over the course of a month.\n"," This feature is available for vendors, sellers, and authors, and the policy change is effective worldwide for sponsored ads.\n"," You can also choose to set the additional spend from leftover amounts to 25% or 100% for all your campaigns using the average daily budget settings API. For more information, view the user guide and API reference.\n"," March 20, 2023\n"," As announced at the end of January, additive budget rules are now live for users of the Amazon Ads API and advertising console. Now, if multiple budget rules meet their conditions, all rules are applied and increase daily budget independently.\n"," This change will impact all advertisers worldwide (vendors and sellers) who use budget rules for their Sponsored Products, Sponsored Brands, and Sponsored Display campaigns through the Amazon Ads API or advertising console.\n"," You can learn more about additive budget rules in the user guide associated to your product (Sponsored Products, Sponsored Brands, Sponsored Display).\n"," March 14, 2023\n"," Regions: US, UK, DE, FR, JP, CA, IT, ES, IN, AU, NL, AE, SA, TR, BR, MX, SG, EG, BE, SE, PL\n"," We are introducing a new brand Stores insights API you can use to programmatically to access Stores insights. These insights include performance metrics like number of store visitors, sales, orders, and page views. This information can be combined with other ads data for you to get holistic view of your Store performance.\n"," Historically, Store owners could only access insights through the Amazon advertising console one store at a time. With introduction of the Store insights API, Store owners can access the same information through the Amazon Ads API. This is especially helpful for getting Store insights across different countries (or locales).\n"," The insights API returns key Store insights such as views, orders, units purchased, and store visits for a given brandEntityId. Advertisers are also able to filter the results based on date range, Store page, and source of traffic such as ads, organic traffic, and custom tags. The API response is paginated a max number of documents returned of 1500.\n"," For full technical details, see the API reference.\n"," March 8, 2023\n"," We have released a new reference implementation that developers can use to set up and manage an Amazon Marketing Stream integration. This python-based reference application uses the AWS CDK to provision the suggested AWS infrastructure needed to confirm dataset subscriptions and start receiving advertiser data. The package also contains a CLI to create, update, and read Stream dataset subscriptions for any given advertiser.\n"," For more information, find the reference implementation in GitHub or view our Reference implementation overview.\n"," March 8, 2023\n"," Sponsored Display datasets are now available globally in Amazon Marketing Stream (beta). We are excited to expand the Sponsored Display datasets (sd-traffic and sd-conversion) in Amazon Marketing Stream (beta) to all countries currently supported by the Amazon Ads API. Amazon Marketing Stream delivers Amazon Ads campaign metrics and information to the advertiser or integrator AWS accounts via a push-based model in near real time.\n"," To access the Sponsored Display datasets in the EU or FE regions, you should use the following AWS source ARNs as part of your IAM policy:\n"," sd-traffic dataset:\n","EU: arn:aws:sns:eu-west-1:947153514089:\\* - FE: arn:aws:sns:us-west-2:310605068565:\\*\n"," sd-conversion dataset:\n","EU: arn:aws:sns:eu-west-1:664093967423:\\* - FE: arn:aws:sns:us-west-2:818973306977:\\*\n"," For more details:\n","View the Data guide for full IAM policies for each dataset. - Create SQS queues for Sponsored Display datasets in the new regions using our updated CloudFormation template.\n"," March 7, 2023\n"," Regions: US, CA, MX, UK, DE, ES, PL, IT, FR, AU, AE, JP, BR, NL, TR, SE, IN, SA, SG\n"," Sponsored Brands campaign insights provides advertisers with new metrics and insights to inform Sponsored Brands campaign creation. This feature:\n","Provides search term impression share and search term impression rank for keywords.  Informs an advertiser if selected keywords have low search traffic.  Informs an advertiser if bids have a low probability of winning an auction.\n"," Search term impression share indicates the percentage share of all ad-attributed impressions an advertiser received on that keyword in the last seven days and search term impression rank indicates an advertiser ranking among all advertisers for a keyword by ad impressions in a locale or country. Search term metrics are only available for keywords the advertiser has previously targeted with Sponsored Brands ad impressions.\n"," Campaign insights enable advertisers to make informed keyword selections and productive bids during the campaign creation process. The search term metrics can help advertisers identify potential keywords to target. The keyword and bid insights can help advertisers understand if they should make adjustments to their keyword selections or bid amounts. These new metrics and insights can improve an advertiser ability to win and deliver impressions.\n"," Vendors and sellers can use the new POST /sb/campaigns/insights endpoint to send a request. Currently, only keyword targets are supported.\n"," February 28, 2023\n"," We are excited to expand Amazon Marketing Stream (beta) to India. This expansion follows our global launch in October 2022.\n"," Note: Advertisers in India are considered part of the EU region and should be subscribed to queues in AWS region eu-west-1.\n"," February 28, 2023\n"," The following endpoints will be deprecated on August 31, 2023:\n","GET /sp/campaigns/{campaignId}/budgetRules/budgetHistory - GET /sb/campaigns/{campaignId}/budgetRules/budgetHistory - GET /sd/campaigns/{campaignId}/budgetRules/budgetHistory\n"," For more information, see Deprecations.\n"," February 28, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SA, SG, UK, US\n"," Today, we are moving the Sponsored Brands version 4 campaign management API functionality out of beta and into general availability status. Advertisers, agencies, and tool providers can leverage these APIs to create and manage their Amazon Sponsored Brands campaigns worldwide. You can generate create and manage ad group-based campaigns as well as legacy campaigns similar to the advertising console. To encourage adoption, the version 4 APIs follow the existing API pattern for Sponsored Products or Sponsored Display for campaign management. This functionality is available to advertisers, tool providers, and agencies that have self-service access to Sponsored Brands.\n"," We previously released these endpoints in beta. Today, we have added two new endpoints to update and delete campaigns. Note that the endpoint structure has changed. For example, POST /sb/beta/campaigns is now POST /sb/v4/campaigns.\n"," The beta endpoints will be deprecated on August 31, 2023. You will need to start using the general availability endpoints by this date. For more details, see Deprecations.\n"," For more information, see:\n","Migration guide - Creating version 4 campaigns - API reference\n"," February 17, 2023\n"," Regions: US, CA, MX, DE, ES, FR, IT, ES, NL, UK, AU, IN, JP, UAE, SA\n"," To improve the performance and stability of the Amazon DSP reporting API, we have set a limit for entity-level report requests to one hundred advertisers per report request. For entities with more than one hundred advertisers, you now need to request reports of up to one hundred advertiser IDs at a time. For entities with less than one hundred advertisers, there is no change. Additionally, entities that are invalid or do not have any advertisers will now receive an error message. These changes apply to all users of the reporting API across all available regions.\n"," For more details, see the DSP reporting reference.\n"," February 15, 2023\n"," We are updating the version 3 reporting API to fix a bug in the purchased product report for Sponsored Brands and Sponsored Products.\n"," This bug caused currency values to be reported in cents or equivalent denominations instead of dollars and equivalent denominations. This has now been fixed in the purchased product report for both Sponsored Products and Sponsored Brands. Now all currencies will be reported in dollar or equivalent denominations based on the currency of the profile that a given campaign is associated with. For more information, please see the version 3 purchased product report.\n"," February 13, 2023\n"," Regions: US, CA, ES, FR, IT, DE, UK, AE, JP, IN, AU, NL, BR, MX, SE, SG, PL, TR, EG, SA, BE\n"," Sponsored Display is launching reach and frequency metrics for vendors and registered sellers across all regions in the Amazon Ads API.\n"," With the release of the cumulativeReach metric, advertisers can better understand the total number of unique users that an ad was exposed to. With the launch of the averageImpressionFrequency metric, advertisers can better understand the average number of times those users saw an ad and how that drives users down the funnel.\n"," Metric definitions:\n","cumulativeReach = Total number of unique users exposed to an ad from either a campaign, ad group, or product ad over the lifetime of the campaign or the past six months, whichever is shorter. This metric is updated daily. - avgImpressionsFrequency = Average number of times unique users were exposed to an ad over the lifetime of the campaign.\n"," When requesting reports for campaign, ad group and product ad, you can add the new metrics of avgImpressionsFrequency and cumulativeReach for any Sponsored Display campaign (CPC or vCPM) in the Amazon Ads API. For full technical details, please see our updated Sponsored Display reporting documentation.\n"," February 10, 2023\n"," Technical specifications for all endpoints in the Amazon Ads API are now indexed in the search interface in the advanced tools center. Developers will see results for search terms that match paths or descriptions for all operations in the API. To search technical specifications, use the search bar in the Amazon Ads advanced tools center.\n"," February 7, 2023\n"," Amazon DSP introduces new Brand Safety segments which enable greater control over how advertisers serve ads on inventory associated with these topics:\n","‘Death & Injuries - High Risk’ - ‘Death & Injuries - High & Medium Risk’ - ‘Death & Injuries - High, Medium & Low Risk’ - ‘Extreme & Graphic‘\n"," The brand safety functionality gives you more control on where your ads serve to protect your brand and block ads from delivering on content that does not align with your brand. For more details, refer to our API documentation.\n"," February 6, 2023\n"," Regions: BE\n"," We have added support for Belgium (BE) to the Amazon Ads API. For more details, see the API endpoints by region, Bid constraints by marketplace, Budget constraints by marketplace, as well as the countryCode, currencyCode, and timezone parameters in the profiles reference.\n"," February 1, 2023\n"," Regions: US, CA, ES, FR, IT, DE, UK, AE, JP, IN, AU, NL, BR, MX, SE, SG, PL, TR, EG, SA, BE\n"," Sponsored Display expands ASIN report to vendors while adding view-based attribution in the Amazon Ads API. Previously this report was only available for vendors. Also known as the purchased product report, pulling this data provides details on non-advertised products that were purchased by shoppers after they interacted with a Sponsored Display ads. Along with expanding to vendors, we have also added metrics to Sponsored Display view attributed metrics for those campaigns with vCPM (cost per 1 thousand viewable impressions) billing and attribution.\n"," This report helps advertisers identify new products within their portfolio that they may consider advertising, identify new cross-selling product targeting opportunities, and uncover insights into shoppers buying behavior. Use the new view based metrics for both sellers and vendors when pulling data from /sd/asins/report with campaigns using the costType vCPM in the Amazon Ads API. These new metrics include:\n","viewAttributedUnitsOrdered1dOtherSKU - viewAttributedUnitsOrdered7dOtherSKU - viewAttributedUnitsOrdered14dOtherSKU - viewAttributedUnitsOrdered30dOtherSKU - viewAttributedSales1dOtherSKU - viewAttributedSales7dOtherSKU - viewAttributedSales14dOtherSKU - viewAttributedSales30dOtherSKU - viewAttributedConversions1dOtherSKU - viewAttributedConversions7dOtherSKU - viewAttributedConversions14dOtherSKU - viewAttributedConversions30dOtherSKU\n"," For full technical details, please see our updated reporting documentation.\n"," January 31, 2023\n"," Regions: US, UK, DE, JP, FR, IT, IE, IL, ES, CA, CH, MA, LU, FI, NO, DK, MX, KW, AU, AE, AT, BE, BR, BH, NL, IN, SA, SE, TR, NZ\n"," Amazon DSP is launching 4 new endpoints available through the Amazon Ads API to enable advertisers to manage their Amazon DSP programmatic deals:\n","POST /dsp/inventory/deals/list - Retrieves a list of programmatic deals, optionally matching filter inputs.  POST /dsp/inventory/deals/performance/list - Retrieves performance metrics for each specified deal.  GET /dsp/inventory/deals/{dealId}/lineItems - Retrieves list of line items targeting a given single deal. \\* POST /dsp/inventory/deals/exchanges/list - Retrieves list of supply sources for deals.\n"," Though these features were previously available in the Amazon DSP console, advertisers can now access them programmatically through the Amazon Ads API. This helps bring the Amazon Ads API experience in line with the advertising console, and gives advertisers greater flexibility when managing Amazon DSP programmatic deals.\n"," With these additional Amazon Ads API endpoints, advertisers can retrieve their Amazon DSP programmatic deal libraries at scale, and build their own business applications leveraging these objects. They can now synchronize their Amazon DSP deal library with their internal repositories, and retrieve deal metadata, performance metrics, and line items targeting each deal.\n"," This release supports all standard deal types, with some exceptions for Amazon Audience Guaranteed deals: while these deals can be retrieved, Amazon Ads API users may not yet retrieve performance data of these deals. For full technical details, please see our API documentation.\n"," January 31, 2023\n"," Regions: All\n"," By the end of February 2023, we will make budget rules to be additive, meaning that more than one rule can be active at a time. Currently, only a single rule can be active, but with this release, if multiple budget rules meet their conditions, all rules will be applied and increase daily budget independently.\n"," We are making this change so that budget rules are more customizable, allowing advertisers to build strategies for budget increases based on multiple triggers instead of having to consider which budget rule will be active at a given point in time.\n"," This update will impact all advertisers worldwide (vendors and sellers) who use budget rules for their Sponsored Products, Sponsored Brands, or Sponsored Display campaigns through the Amazon Ads API or advertising console. We will post a separate release note to notify advertisers once this change is live.\n"," If you have a question, you can go to the Amazon Ads API Support page and create a ticket with the subject title Budget Rules Additive Behavior.\n"," January 31, 2023\n"," Regions: United States (US)\n"," Sponsored Brands is releasing the new missed opportunities and budget recommendations API which will provide recommendations for campaigns that have gone out of budget. This API will provide predicted missed sales, clicks, and impressions during these out of budget periods, while also recommending a new budget to prevent them in the future.\n"," Roughly ten percent of all Sponsored Brands campaigns go out of budget daily, losing out on numerous interactions with customers. The missed opportunity and budget recommendations API contextualizes the business impact of these periods in the form of measurable key performance indicators. By adopting the suggested budget, advertisers can prevent these cases in the future and ensure their campaigns are reaching their full potential.\n"," This feature is available for vendors and sellers through the Amazon Ads API. Advertisers can use the new POST /sb/campaigns/budgetRecommendations endpoint that accepts a list of campaigns and returns suggested budget, percent time in budget, and missed opportunities in clicks, impressions, and sales.\n"," January 31, 2023\n"," Regions: United States (US)\n"," Omnichannel Metrics (OCM) now offers advertisers the capability to automate budget optimization for the total impact of your campaign, inclusive of both online and offline sales, on and off Amazon. Advertisers opted-in for budget optimization will have their budget automatically shift between line items based on omnichannel performance, thereby helping to optimize the overall outcome of your campaign.\n"," The new OCM automated budget optimization feature alleviates the current manual process of allocating budget across multiple line items to optimize budget and maximize Combined ROAS.\n"," This feature is designed to help our advertisers and agencies to 1) increase efficiency by reducing wasted impressions on lower-performing ad tactics, 2) enable agile optimization allowing for line items with specific budget requirements to be opted out of budget optimization, while other line items in the same campaign could continue to be optimized leveraging this budget feature, and 3) empower advertisers with the control to opt out, pause or re-enroll line items within the budget optimization at any point in the campaign.\n"," This feature is available for CPG and grocery advertisers with an active Omnichannel Sales Study, including both managed service and self-service DSP accounts.\n"," To access this feature, use the Amazon DSP create order API with the optimization goal PURCHASES_ON_OFF_AMAZON and goal KPI of COMBINED_RETURN_ON_AD_SPEND. The budget and bid optimization will be automatically selected. For full technical details, please see our updated documentation.\n"," January 26, 2023\n"," Input guidance is now available for Sponsored Products campaigns in bulksheets. This new feature includes dropdown options for some fields, including Product, Entity, Operation, and more. After you select values for those first three fields, cells in that row will automatically highlight the fields that can be filled in—both required and optional ones. You will also see guidance if you click on cell headers. For example, if you click into a “Daily Budget” cell header, you will see tips on budget limits, along with guidance on entering values such as decimal places.\n"," You can access this new feature if you go to the bulk operations main page and check the box labeled Guidance for Sponsored Products inputs BETA. Then, download a bulksheets template and navigate to the Sponsored Products tab to see the details described above. Learn more about the new input guidance feature for bulksheets\n"," January 26, 2023\n"," Regions: AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, US\n"," Amazon Ads is launching bid recommendations for Amazon audiences (i.e., In-market, Life events, Lifestyle and Interests) and purchase remarketing. Bid recommendations will be provided for all Sponsored Display audience targeting campaigns, including those selected to “Optimize for viewable impressions”, “Optimize for page visits”, or “Optimize for conversions”.  These recommendations will be available for Sponsored Display campaigns within the Amazon Ads API.\n"," This helps advertisers receive bid recommendations based on the bid optimization they select. When the bid optimization is \"Optimize for viewable impressions\", the bid suggestions will be for 1000 viewable impressions rather than per click, which helps advertisers maximize impression share for the selected audiences. When bid optimization is \"Optimize for page visits\", bid suggestions will help advertisers get impressions on requests that are likely to get clicks. When bid optimization is \"Optimize for conversions\", bid suggestions will help advertisers get impressions on requests likely to convert.\n"," For full technical details, please see our Sponsored Display documentation, including the updated bid recommendations documentation.\n"," November 1, 2022\n"," When you create Sponsored Brands campaigns in the advertising console, you can create multiple ad groups within the campaign. Now, you can view targets for all of these ad groups if you download a bulksheets custom spreadsheet and include Sponsored Brands in the file. This feature lets you view keyword and product targeting for all ad groups in the downloaded file. Note that you cannot create multiple Sponsored Brands ad groups using bulksheets — you must still use the console to create.\n"," October 1, 2022\n"," You can now use expanded product targeting for Sponsored Products manual targeting campaigns in bulksheets. With this feature, you can expand targeting to items that are closely related to the product you want to target. This can help you discover additional products related to the ones you are already targeting. \n"," To use expanded product targeting in bulksheets, define the target in the row where you are creating the \"product targeting\" entity in your bulksheet file. Set the product targeting expression value to be asin-expanded=\"12345\", using the value of the ASIN you want to target.\n"," August 1, 2022\n"," We have evolved Sponsored Display product targeting into contextual targeting, allowing advertisers to reach more of their audiences at more points in their shopping and entertainment journey. The contextual targeting strategy will now allow advertisers to reach audiences both in the Amazon store and outside the Amazon store when customers view content related to targeting strategies. If you use bulksheets to create and manage Sponsored Display campaigns, the \"product targeting\" entity will now be \"contextual targeting\". \n"," Learn more about new Sponsored Display contextual targeting, including more details about the launch and why it is important to advertisers.\n"," June 1, 2022\n"," When you download a Sponsored Products bulksheets file, you can now see ASIN eligibility statuses, along with reasons for ineligibility. This information will be available in two new informational-only columns: Eligibility Status and Reason for Ineligibility. Sellers and vendors can find these new columns next to the SKU field in the bulksheets file.\n"," Without this information, it can be difficult to understand why your ad might be getting fewer clicks than expected. For example, a product might become ineligible after you create the ad, or a product might have gone out of stock, resulting in missed sales and wasted time on ASIN troubleshooting. Having ASIN eligibility statuses in bulksheets can help you make more informed decisions when optimizing campaigns, and provides even greater parity with the API when using bulksheets.\n"," May 1, 2022\n"," In Sponsored Brands bulksheets downloads, you can now see the ad format when filters are applied. Previously, when you filtered by keywords, the ad format was not visible. With this change, you can filter by keywords and see if a keyword is for a video campaign or a non-video campaign. When you apply filters, the ad format will now be visible in a new Ad format (informational only) field.\n"," May 1, 2022\n"," You can now see portfolio names in bulksheets downloads. Previously, only the portfolio ID was shown. This update will make it easier to see if a campaign is associated with a particular portfolio.\n"," May 1, 2022\n"," Some of the name-based informational-only fields have been rearranged in bulksheets. Now when you download a bulksheets file, you can see fields such as campaign name and ad group name without needing to scroll as far. Previously, these fields were placed near the end of a bulksheets file, and this made it difficult to associate the names with their related fields such as keyword, budget, and start date.\n"," April 1, 2022\n"," Sellers can now see the ASIN code associated with your SKU input in bulksheets for Sponsored Products and Sponsored Display. The ASIN code will appear in the ASIN (informational only) column when you request a bulksheets download. Previously, the ASIN column was empty for sellers, and there was not a way to know which ASIN values corresponded to SKU values in bulksheets.\n"," April 1, 2022\n"," You can now create multiple ad groups in a single Sponsored Display campaign using bulksheets. For campaigns that are already running, you can also add more ad groups to existing campaigns. Previously, Sponsored Display only supported one ad group per campaign. Learn more about managing Sponsored Display campaigns using bulksheets.\n"," March 1, 2022\n"," We are launching some cosmetic updates for the bulk operations homepage. This is the page where you can create and download a bulksheets file to manage campaigns in bulk. The changes include updates such as button styles. The functionality will not be affected by these updates.\n"," March 1, 2022\n"," Previously, click-through rates had to be calculated manually in bulksheets. Now, you can see click-through rates when you download a bulksheets file. This new column can be found between the \"Spend\" and \"Clicks\" columns in the Sponsored Products, Sponsored Brands, and Sponsored Display tabs.\n"," February 1, 2022\n"," When managing Sponsored Display campaigns using bulksheets, you can now target based on similar products. Using the Targeting Expression field, enter similar-product if you want your ads to be shown to shoppers who viewed the detail pages of products that are similar to your advertised products.\n"," Learn more about managing Sponsored Display campaigns using bulksheets\n"," January 21, 2022\n"," Effective January 21, 2022, you now can filter to include or exclude Sponsored Products, Sponsored Brands, and Sponsored Display during the bulk download process. For advertisers or agencies managing large numbers of campaigns, this new filter can help expedite the download process by limiting the file to certain campaign types.\n"," January 1, 2022\n"," Portfolios are available in bulksheets for Sponsored Products, Sponsored Brands, and Sponsored Display. You can now create and update portfolios, including portfolio budgets. Portfolios in bulksheets can not only help you organize campaigns and budgets, but are also a way to update bid optimizations in bulk.\n"," December 1, 2021\n"," The new bulksheets gives you access to more features that are already available to advertisers who use the API, so you can have the benefits of the API, with the functionality of a spreadsheet interface. With the newest version, you can \n","update campaign and ad group names  add multiple ad groups, keywords, and targets in bulk  see campaign metrics such as impressions, clicks, ACoS, CPC, ROAS, and more \\* manage Sponsored Display campaigns. \n"," Learn more about the new bulksheets\n"," November 17, 2020\n"," Updated keyword restrictions for advertisers. Amazon Ads does not allow the targeting of prescription medicine products or the use of prescription medicine names as targeting keywords or phrases. \n"," For example, prescription medicine keyword or products, such as \"Lipitor\" or \"prednisone\".\n"," As a reminder, keywords or products targeted through Amazon Ads must be relevant to the product being promoted. Ads must not target keywords or products which could result in offensive, insensitive, or undesirable shopper experience.\n"," August 24, 2020\n"," Added link to the Bulksheets portal on the Bulk Operations page. \n"," Simplified the Bulksheets template by removing the \"Instructions\", \"Attribute definitions\" and \"SD Attribute definitions\" tabs from the template. Users can now find detailed instructions and\n"," July 31, 2020\n"," Added Bulksheets documentation with detailed user instructions and examples for all supported Sponsored Ads products to this portal\n"],"documentType":"release-note"},{"title":"Amazon Ads API v1 release notes","sectionHeader":null,"path":"/en-us/release-notes/ads-api-v1","content":[" October 30, 2026\n"," Review Requests (beta) is now available through the Amazon Ads API in the United States.\n"," Review Requests helps brands gain authentic reviews from verified purchasers. A native \"How was your item?\" card on Amazon's highest-traffic pages invites a verified purchaser to write a review, and the advertiser pays only when a shopper leaves a rating or review. It gives new products a faster path to authentic reviews.\n"," With the API, advertisers can create and manage Review Requests campaigns, choose the products that ads run for, set a bid and daily budget, and measure results with five review-specific metrics: reviews, writtenReviews, ratingOnlyReviews, percentOfReviewsWritten, and averageStarRating.\n"," Available for products with fewer than 1,000 total reviews. To learn more, see Get started with Review Requests.\n"," October 5, 2026\n"," The new Reporting API (v1) can now return warning signals on a completed report. Warnings are non-fatal: the report still succeeds and the data is valid, but each warning summarizes, at the field level, a condition affecting that field's values in the report — such as values redacted because you are not permissioned to see the field for a requested account, or a field scheduled for a future deprecation. Once a report reaches a terminal state, the AdsApiv1RetrieveReport response (POST /adsApi/v1/retrieve/reports) includes a warnings array when there is something to report, and each entry identifies the field and one or more warningCodes. Treat warningCodes as an open-ended list, since more signals may be added over time.\n"," For the available signals, the response shape, and a per-signal breakdown, see Warning signals in the New features guide.\n"," October 1, 2026\n"," The communications preferences API is now in open beta. These endpoints let you manage how advertisers are contacted by Amazon Ads and what communications they receive, covering communication contacts and channel-level communication preferences.\n"," The open beta endpoints are:\n","Communication contacts: POST /communications/contacts, POST /communications/contacts/query - Communication preferences: POST /communications/preferences/query, POST /communications/preferences/update\n"," To get started, see the communications preferences developer guide.\n"," September 30, 2026\n"," Access complete advertising data two ways. Have it pushed continuously to your Amazon S3, or pull multi-dimensional reports ad hoc.\n"," What launched? Amazon Marketing Stream Version 2 (Stream v2) and the new Reporting API (v1) are now generally available. Together, they provide ongoing and ad-hoc programmatic access to Amazon Ads performance data. Stream v2 pushes complete advertising datasets to your Amazon S3 bucket as Apache Parquet files, with SQS notifications as each file lands. The Reporting API v1 lets you generate ad-hoc reports that combine dimensions, ad products, and accounts in a single request. Both surfaces share the same standardized metric names, definitions, and entity terminology across Amazon Ads products.\n"," Why is this important? Advertisers previously needed Amazon Marketing Stream Version 1 for hourly freshness and v3 reporting for completeness, which meant maintaining two pipelines and reconciling two data models. Stream v2 removes that tradeoff by delivering total metric values (not deltas), historical data for each dataset's restatement period, and updates as frequently as every 15 minutes. The data lands partitioned by dataset, granularity, and time window, so you query it directly with Amazon Athena, AWS Glue, or Amazon EMR, with no ETL pipeline to build. You can consolidate reporting pipelines and build workflows on the data the moment it lands.\n"," The Reporting API v1 is a new ad-hoc programmatic interface for accessing Amazon Ads performance data. It adds multi-dimensional reporting (combine dimensions like geography and technology in one report), cross-ad-product reporting, and cross-account reporting (a single report spanning all accounts you manage). Metrics are organized into three categories — Traffic, Engagement, and Conversion — with standardized names across all ad products. Conversion metrics are reported on traffic date (the date of ad interaction) rather than conversion date, aligning Amazon DSP with Sponsored Ads and industry best practices.\n"," Who can use it and where? Both surfaces are available to all integrated partners and advertisers worldwide. Stream v2 setup takes minutes using AWS CloudFormation or CDK. Two datasets are available at launch, with more planned:\n","Ads Performance Dataset (ads-performance-v1) — Approximately 400 metrics and 50 or more dimensions covering traffic delivery (impressions, clicks, viewability), engagement (video and audio interactions), costs and fees, and attributed conversions across Amazon Ads products. This dataset consolidates data previously available across multiple v3 report types (campaign, ad group, ad, advertised product, search term, targeting, placement, inventory, geography, and technology reports) into a single unified schema. Delivery frequency is as often as every 15 minutes. - Ads Converted Product Dataset (ads-converted-product-v1) — Approximately 170 conversion metrics at the ASIN level, including both directly promoted and halo products. Key dimensions include convertedProduct.id, convertedProductMarketplace.value, and productRelevance.value (promoted or halo). Use this dataset to measure the influence of ads on specific products, including related products not featured in the ad. Delivery frequency is every 4 to 6 hours.\n"," The Reporting API v1 standardizes terminology, metric naming, and definitions across all ad products. Key changes from v3 reporting include:\n","The Reporting API now follows the Amazon Ads API versioning convention (for example, v1), replacing the previous v3 and other legacy reporting endpoints. - Amazon DSP \"Order\" and Sponsored Ads \"Campaign\" are now unified as \"Campaign\". - Metrics are organized into three categories: Traffic, Engagement, and Conversion. - Conversion metrics drop interval suffixes (1d, 7d, 14d, 30d) and use the correct look-back for each campaign type automatically. - \"Promoted\" and \"Halo\" qualifiers replace legacy terms such as \"Brand Halo\" and \"Other SKU\". - The \"Total\" prefix in Amazon DSP metrics is removed; base metrics now include all conversions. - Off-Amazon conversion metrics are consistently prefixed with \"offAmazon\".\n"," API details: Stream v2 uses the Amazon Marketing Stream API to create subscriptions. You provide an S3 bucket and SQS queue, and Stream writes Parquet files partitioned by dataset, granularity, and time window. Each record carries the total value for its time window; when a record is restated, you receive it again with its new total, and you keep the highest streamBatch.version per record. You can combine any available dimensions in a single request without selecting a report type. The Reporting API v1 supports one concurrent report per advertiser, which allows advertisers to run approximately 100 reports per day based on average report run time.\n"," To get started, see the Amazon Marketing Stream v2 overview, the Get started guide, and the Reporting API v1 documentation.\n"," September 29, 2026\n"," The Inventory Management APIs are now generally available. These APIs provide unified programmatic access to Amazon Ads inventory-related data. As part of Amazon Ads API v1, it follows the common model and includes ability to handle resources across deals, labels, labelassociations, buyerseats, dealadvertiseraccess, dealadvertiseraccessentry, dealperformance, dealplanning, publisher, supplier, seller.\n"," The GA endpoints are:\n","Deals: POST /adsApi/v1/create/advertisingDeals, POST /adsApi/v1/update/advertisingDeals, POST /adsApi/v1/query/advertisingDeals - Labels: POST /adsApi/v1/query/labels, POST /adsApi/v1/query/labelObjectAssociations - Deal metrics: POST /adsApi/v1/query/dealPerformances, POST /adsApi/v1/query/dealAvailses, POST /adsApi/v1/query/dealPlanningMetrics - Buyer seats: POST /adsApi/v1/create/buyerSeats, GET /dsp/adsApi/v1/buyerSeats - Deal advertiser access: POST /adsApi/v1/create/dealAdvertiserAccesses, POST /adsApi/v1/retrieve/dealAdvertiserAccesses, POST /adsApi/v1/delete/dealAdvertiserAccesses - Deal advertiser access entries: POST /adsApi/v1/create/dealAdvertiserAccessEntries, POST /adsApi/v1/delete/dealAdvertiserAccessEntries, POST /adsApi/v1/query/dealAdvertiserAccessEntries - Publishers, sellers, suppliers: POST /adsApi/v1/query/publishers, POST /adsApi/v1/query/sellers, POST /adsApi/v1/query/suppliers\n"," Upcoming GA endpoints are:\n","Inventory groups: POST /adsApi/v1/create/inventoryGroups, POST /adsApi/v1/update/inventoryGroups, POST /adsApi/v1/query/inventoryGroups\n"," To get started, refer to the Inventory Management developer guide.\n"," September 28, 2026\n"," The Events API now supports:\n","AREF_TOKEN in matchKeys for click-based attribution. Capture the aref value from the ad landing-page URL and send it with the timestamp recorded when the landing page was reached. - FIP in matchKeys for a plaintext IPv4 or IPv6 address. - deviceInfo.userAgent for the raw browser or app user-agent string captured at the time of the event, up to 512 characters.\n"," See the Events guide for the supported AREF_TOKEN format and limits.\n"," September 28, 2026\n","DSP_ADVERTISER_ACCOUNT (default) returns the DSP advertiser account ID. Existing reports are unchanged. - GLOBAL_ADVERTISER_ACCOUNT returns the global advertiser account ID and groups the advertiser's DSP accounts into a single row.\n"," For details and an example request, see DSP advertiser account identifiers.\n"," September 25, 2026\n"," Benchmarks are available in US, CA, MX, BR, AU, JP, IN, DE, FR, IT, ES, UK, NL, TR, SE, SA, UAE, and EG.\n"," Benchmark reporting helps you compare your brand's advertising performance against similar brands in your category.\n"," Instead of analyzing your metrics in isolation, benchmarks provide context by showing how peer brands perform on the same metrics.\n"," You can access benchmarks (25th, 50th, and 75th percentile) for the following metrics:\n","Add to cart rate - Add to cart rate (new to brand) - Add to cart rate (new to brand, promoted) - Add to cart rate (promoted) - Branded search rate - Completion rate (video ad) - Cost per branded search - Cost per completed view (video ad) - Cost per detail page view - Cost per detail page view (new to brand) - Cost per detail page view (new to brand, promoted) - Cost per detail page view (promoted) - Cost per purchase - Cost per purchase (new to brand) - Cost per purchase (new to brand, promoted) - Cost per purchase (promoted) - Cost per purchase from clicks - Cost per purchase from clicks (new to brand) - Cost per purchase from clicks (promoted) - CPC - CPM - CTR - Detail page view rate - Detail page view rate (new to brand) - Detail page view rate (new to brand, promoted) - Detail page view rate (promoted) - Percent of purchases new to brand - Percent of purchases new to brand (halo) - Percent of purchases new to brand (promoted) - Purchase rate - Purchase rate (combined) - Purchase rate (new to brand) - Purchase rate (new to brand, promoted) - Purchase rate (promoted) - ROAS - ROAS (new to brand) - ROAS (new to brand, promoted) - ROAS (promoted) - Long-term ROAS\n"," September 23, 2026\n"," Sponsored Brands Collections is now available worldwide in the Unified Ads API and SB V4 API. Following the initial US launch, the feature has now rolled out to all marketplaces. Advertisers in every marketplace can now create and manage Sponsored Brands Collections ads through the standard campaign management endpoints.\n"," Sponsored Brands Collections lets advertisers promote multiple related products in a single ad unit. With AI-powered automatic collections, Amazon dynamically curates the most relevant products for each shopper, while manual collections allow advertisers to hand-pick their selection.\n"," Advertisers can choose between two collection types:\n","Automatic collections – Let Amazon AI dynamically group the most relevant products from their catalog into collections based on their keyword targets and shopper search queries. \\* Manual collections – Select 3-10 related products to feature in the ad. This ad type supports keyword or product targeting and gives full control over the products in the ad.\n"," API Endpoints\n"," Sponsored Brands Collections can be managed through the Amazon Ads Campaign Management API using the standard campaign management endpoints:\n","Create Ads: POST /adsApi/v1/create/ads \\* Update Ads: POST /adsApi/v1/update/ads\n"," September 9, 2026\n"," Every budget object in the response returns recurrenceTimePeriod set to LIFETIME.\n"," This operation is in open beta, and this is a breaking change under the open beta policy.\n"," To update your integration, refer to the Getting started with the Linear TV Incremental Reach API guide.\n"," August 31, 2026\n"," Amazon Ads has unified endpoints for Commitments, DealAdvertiserAccesses, DealAdvertiserAccessEntries, Labels, Inventory Groups, and BuyerSeats. At present the unified endpoint supports only Amazon_DSP adProduct. The URL of the endpoints has changed.\n"," The updated endpoints launched are:\n","GET /adsApi/v1/commitments - List commitments. 2. POST /adsApi/v1/create/commitments - Create commitments. 3. POST /adsApi/v1/query/commitments - Query commitments with filters. 4. POST /adsApi/v1/retrieve/commitments - Get commitments. 5. POST /adsApi/v1/update/commitments - Update commitments. 6. POST /adsApi/v1/retrieve/commitmentSpends - Retrieve commitment spend. 7. POST /adsApi/v1/create/dealAdvertiserAccesses - Create a deal advertiser access record with a strategy (ALLOW or BLOCK). 8. POST /adsApi/v1/retrieve/dealAdvertiserAccesses - Retrieve a deal advertiser access record by ID. 9. POST /adsApi/v1/delete/dealAdvertiserAccesses - Delete a deal advertiser access record and all associated entries. 10. POST /adsApi/v1/create/dealAdvertiserAccessEntries - Add advertisers to a deal advertiser access list. 11. POST /adsApi/v1/delete/dealAdvertiserAccessEntries - Remove advertisers from a deal advertiser access list. 12. POST /adsApi/v1/query/dealAdvertiserAccessEntries - Query advertiser entries for a deal advertiser access record. 13. POST /adsApi/v1/query/labels - Query labels with filters. 14. POST /adsApi/v1/create/buyerSeats - Create an advertiser seat. 15. GET /adsApi/v1/buyerSeats - Get list of seats based on filter provided. 16. POST /adsApi/v1/update/inventoryGroups - Update an inventory group. 17. POST /adsApi/v1/query/inventoryGroups - Query an inventory group. 18. POST /adsApi/v1/create/inventoryGroups - Create inventory groups. 19. POST /adsApi/v1/retrieve/inventoryGroups - Retrieve inventory groups by ID.\n"," To get started, refer to the Inventory Management developer guide.\n"," August 31, 2026\n"," Amazon Ads has launched the Recommendations API, a single interface for retrieving recommendations across ad products.\n"," Regardless of which ad product a recommendation relates to, the response conforms to a single, standardized recommendation model. Each recommendation includes a unique identifier for tracking, a recommended action, and insights explaining why the advertiser is receiving the recommendation. This eliminates the need to integrate with separate product-specific recommendation APIs.\n"," The API endpoints launched are:\n","GET /adsApi/v1/list/recommendations: Retrieve a list of pre-computed recommendations filtered by query parameters such as language, adProduct, recommendationType, and maxResults. Optimized for low-latency, high-volume retrieval. 2. POST /adsApi/v1/query/recommendations: Retrieve recommendations matching a structured query specification, with support for universal filters and type-specific scoping. Supports both discovery mode (returning all recommendation types currently eligible for your account) and scoped mode (targeting specific recommendation types).\n"," To get started, refer to the Recommendations API overview and How to call the Recommendations API developer guides.\n"," August 26, 2026\n"," Fourteen new metrics are now available in Unified Reporting.\n"," The Branded searches (new to brand) and Brand store page views (new to brand) metric families report branded search and brand store page view activity from customers who are new to brand, including counts from clicks and views, rates, and cost per event in both native and converted currency:\n","metric.newToBrandBrandedSearches, metric.newToBrandBrandedSearchesFromClicks, metric.newToBrandBrandedSearchesFromViews, metric.newToBrandBrandedSearchRate, metric.costPerNewToBrandBrandedSearch, and metric.costPerNewToBrandBrandedSearchConverted - metric.newToBrandBrandStorePageViews, metric.newToBrandBrandStorePageViewsFromClicks, metric.newToBrandBrandStorePageViewsFromViews, metric.newToBrandBrandStorePageViewRate, metric.costPerNewToBrandBrandStorePageView, and metric.costPerNewToBrandBrandStorePageViewConverted\n"," The Third-party fees metric family adds metric.thirdPartyPrebidFeesAdelaide and metric.thirdPartyPrebidFeesAdelaideConverted, which report the third-party prebid fees for using Adelaide.\n"," In addition, data retention for the date.value, week.value, day.value, and dayOfWeek.value time dimensions has been extended from 15 months to 24 months. Maximum report date ranges are unchanged. For details, see Dates and historical data retention.\n"," August 12, 2026\n"," The Manager Account API is now generally available. These endpoints enable programmatic creation, querying, and updating of manager accounts, which advertisers and agencies use to link and manage multiple advertising accounts from a single dashboard. Previously available in closed beta, these endpoints are now open to all Amazon Ads API customers with an approved LwA client.\n"," Key capabilities:\n","Create manager accounts programmatically via batch request. - Query manager accounts with support for searching by customer ID, filtering by account ID, and paginated responses. - Update manager account details, including business details such as name, address, and phone.\n"," Endpoints:\n","POST /adsApi/v1/create/managerAccounts: Create one or more manager accounts - POST /adsApi/v1/update/managerAccounts: Update one or more manager accounts - POST /adsApi/v1/query/managerAccounts: Query manager accounts by user or by ID\n"," To get started, see the Manager Account API developer guide.\n"," August 9, 2026\n"," Documentation is now available for auto-assembled videos in Sponsored Products. Auto-assembled videos are video creative that Amazon generates and attaches to existing Sponsored Products ads on behalf of the advertiser.\n"," The new guide covers:\n","Opt out of auto-assembled videos at the campaign level with POST /adsApi/v1/update/campaigns and the optOuts.videoExtension field. - Query campaign opt-out status with POST /adsApi/v1/query/campaigns. - Identify auto-assembled video extensions in the POST /adsApi/v1/query/adExtensions response by checking adExtensionSettings.videoExtension.videoType.\n"," To get started, see the auto-assembled videos guide. Auto-assembled videos are available for advertisers selling in the United States.\n"," August 7, 2026\n"," The Sponsored Products video ad extensions guides have been updated:\n","Documented the full multi-status response returned when you update ads and ad extensions. - Added account and asset eligibility prerequisites. - Added video engagement columns to the Video Ad Extension report. - Clarified that the ad extension is created asynchronously after you send spotlightVideos, so a query may not return it immediately. - Added guidance for creating a new ad with video in a single call.\n"," To get started, see Create video ad extensions.\n"," August 4, 2026\n"," The Amazon Ads Proposal Management Unified APIs are now generally available. These APIs enable programmatic management of proposals across Amazon Owned and Operated (Amazon O&O) publishers (called \"Amazon Media\" in the UI), Amazon Publisher Direct (APD), Amazon Publisher Cloud (APC), and Netflix. Previously available in beta, these endpoints are now open to all Amazon Ads API customers.  The endpoints launched as GA are:\n","POST /adsApi/v1/create/supplierProposals - Create a proposal 2. POST /adsApi/v1/query/supplierProposals - Get list of proposals for an advertiser 3. POST /adsApi/v1/update/supplierProposals - Update existing supplier proposal 4. POST /adsApi/v1/create/supplierProposedDeals - Create a supplier proposed deal 5. POST /adsApi/v1/query/supplierProposedDeals - Query supplier proposed deals 6. POST /adsApi/v1/update/supplierProposedDeals - Update existing supplier proposed deal 7. POST /adsApi/v1/create/supplierProposedDealRevisions - Submit a proposal revision 8. POST /adsApi/v1/update/supplierProposedDealRevisions - Update a proposal revision 9. POST /adsApi/v1/query/supplierProposedDealHistoricalVersions - Get proposed deal history 10. POST /adsApi/v1/query/supplierPublishers - Get publisher of the supplier 11. POST /adsApi/v1/query/supplierTargetItems - Fetch supplier targeting items 12. POST /adsApi/v1/query/supplierAdProducts - Get supplier ad products 13. POST /adsApi/v1/create/supplierAdProductPrices - Get supplier ad product prices 14. POST /adsApi/v1/query/supplierProposalDestinations - Query supplier proposal destinations 15. POST /adsApi/v1/create/supplierProposedDealForecasts - Create a forecast for a proposed deal\n"," To get started, refer to the Proposal Management guide (see Overview section for onboarding details).\n"," August 3, 2026\n"," Documentation is now available for video ad extensions in Sponsored Products. A video ad extension attaches video creative to an ad that already exists, so campaigns, budgets, bids, and targeting remain unchanged. Video renders on eligible placements, and the same ad renders as a standard image everywhere else.\n"," The new guides cover the full workflow:\n","Attach video creative with POST /adsApi/v1/update/ads and the spotlightVideos settings. - Read extension state with POST /adsApi/v1/query/adExtensions. - Pause and resume video delivery with POST /adsApi/v1/update/adExtensions. - Prepare video assets, interpret creative review outcomes, and handle errors.\n"," To get started, see the ad extensions overview. Video ad extensions are available for advertisers selling in the United States.\n"," July 31, 2026\n"," Amazon Ads has unified endpoints for Proposals (including support for Netflix workflow), Publisher, Supplier, DealAvails, DealPerformance and DealPlanningMetrics. At present the unified endpoint supports only Amazon_DSP adProduct. The URL of the endpoints has changed.\n"," We have also released new endpoints for Seller.\n"," The new and updated endpoints launched are:\n","POST /adsApi/v1/query/dealAvailses - Query deal avails by advertising deal ID 2. POST /adsApi/v1/dealPerformances - Retrieve performance metrics for each specified deal 3. POST /adsApi/v1/dealPlanningMetricses - List deal planning metrics for specified deals 4. POST /adsApi/v1/query/publishers - Query Publishers whose inventory is available on Amazon DSP 5. POST /adsApi/v1/query/sellers - Query sellers that send inventory to Amazon DSP 6. POST /adsApi/v1/query/suppliers - Query suppliers that send advertising inventory to Amazon DSP 7. POST /adsApi/v1/create/supplierProposals - Create a proposal 8. POST /adsApi/v1/query/supplierProposals - Get list of proposals for an advertiser 9. POST /adsApi/v1/update/supplierProposals - Update existing supplier proposal 10. POST /adsApi/v1/create/supplierProposedDeals - Create a supplier proposed deal 11. POST /adsApi/v1/query/supplierProposedDeals - Query supplier proposed deals 12. POST /adsApi/v1/update/supplierProposedDeals - Update existing supplier proposed deal 13. POST /adsApi/v1/create/supplierProposedDealRevisions - Submit a proposal revision 14. POST /adsApi/v1/update/supplierProposedDealRevisions - Update a proposal revision 15. POST /adsApi/v1/query/supplierProposedDealHistoricalVersions - Get proposed deal history 16. POST /adsApi/v1/query/supplierPublishers - Get publisher of the supplier 17. POST /adsApi/v1/query/supplierTargetItems - Fetch supplier targeting items 18. POST /adsApi/v1/query/supplierAdProducts - Get supplier ad products to create a proposed deal 19. POST /adsApi/v1/create/supplierAdProductPrices - Get supplier ad products price 20. POST /adsApi/v1/query/supplierProposalDestinations - Query supplier proposal destinations (like Amazon Media or APD or APC) to create a proposal 21. POST /adsApi/v1/create/supplierProposedDealForecasts - Creates a forecast request for a proposed deal configuration\n"," We will be unifying other Inventory management endpoints on similar lines and will share the update by the end of each month.\n"," To get started, refer to the Inventory Management developer guide.\n"," July 21, 2026\n"," Three new skills are now available in the Amazon Ads MCP Skills Library:\n","Terms Token — guides agents through the advertising terms-of-service acceptance workflow required before the first account of an advertiser can be registered. - User Invitations — covers the full invitation lifecycle on advertising accounts, including creating, listing, revoking, resending, and redeeming invitations. - User Permissions — manages user access on advertising accounts, including listing users, viewing and updating granular permissions, checking role assignments, and removing user access.\n"," To learn more, see the MCP Skills Library.\n"," July 20, 2026\n"," Two new endpoints are now available in the Linked Accounts API: Update Account Links and Delete Account Links. Partners can now programmatically update permissions and marketplace restrictions on existing account links, or remove account links entirely. Both endpoints support bulk operations of up to 50 account links per request and operate at the global account level.\n"," To learn more, see the linked accounts developer guide.\n"," July 10, 2026\n"," The QueryAdvertiserAccount API now returns the businessDetails field only when a single global account ID is provided in the advertiserAccountIdFilter. When multiple global account IDs are provided, businessDetails is omitted from the response. To retrieve businessDetails for multiple accounts, call QueryAdvertiserAccount once per global account ID. For more information, see the QueryAdvertiserAccount developer guide.\n"," July 9, 2026\n"," Amazon Ads has unified Advertising Deal endpoints in Open Beta. At present the unified endpoint supports only Amazon_DSP adProduct. The URL of the endpoints changed.\n"," The updated ends points launched are: \n","POST /adsApi/v1/create/advertisingDeals - Create a deal.  2. POST /adsApi/v1/update/advertisingDeals - Update a deal.  3. POST /adsApi/v1/query/advertisingDeals - List all deals based on filters provided. \n"," We will be unifying all other Inventory and Proposal management endpoints on similar lines and will share the update by the end of each month.   To get started, refer to the Inventory Management developer guide.\n"," June 30, 2026\n"," The UPPER_FUNNEL_PROSPECTING tactic is now available for campaigns that include Audio in the primaryInventoryTypes setting. Previously, no tactics were supported for Audio inventory. For more information, see Performance+ and Brand+ tactics.\n"," June 29, 2026\n"," The AccountLinkInvite API enables programmatic creation and management of account link invitations. Agencies and advertisers can now automate their account linking workflows with four new endpoints: Create, Update, Delete, and Query. Key capabilities include bulk operations of up to 50 invitations per request, optional restrictions for data sharing, and marketplace specific restrictions for sponsored ads.\n"," To learn more, see the account link invites user guide.\n"," June 25, 2026\n"," Amazon Ads has launched new unified endpoints to manage Labels, Deal Advertiser Access, and Amazon Publisher Cloud (APC) workflow support in Supplier Proposals APIs in Open Beta. \n"," The new and updated endpoints launched are: \n","POST /v1/create/dealAdvertiserAccesses/dsp - Create a deal advertiser access record with a strategy (ALLOW or BLOCK).  2. POST /v1/retrieve/dealAdvertiserAccesses/dsp - Retrieve a deal advertiser access record by ID.  3. POST /v1/delete/dealAdvertiserAccesses/dsp - Delete a deal advertiser access record and all associated entries.  4. POST /v1/create/dealAdvertiserAccessEntries/dsp - Add advertisers to a deal advertiser access list.  5. POST /v1/delete/dealAdvertiserAccessEntries/dsp - Remove advertisers from a deal advertiser access list.  6. POST /v1/query/dealAdvertiserAccessEntries/dsp - Query advertiser entries for a deal advertiser access record.  7. POST /v1/query/labels/dsp - Query labels with filters. Returns labels that have associations of the specified object type and are visible to the entity of the caller.  8. POST /adsApi/v1/query/supplierPublishers/dsp - Get publisher of the supplier (with APC workflow).  9. POST /adsApi/v1/query/supplierTargetItems/dsp - Fetch supplier targeting items (with APC workflow).  10. POST /adsApi/v1/update/supplierProposedDealRevisions/dsp - Update a proposal revision (with APC workflow).  11. POST /adsApi/v1/create/supplierProposedDealRevisions/dsp - Submit a proposal revision (with APC workflow).  12. POST /adsApi/v1/query/supplierProposedDealHistoricalVersions/dsp - Get proposed deal history (with APC workflow).  13. POST /adsApi/v1/create/supplierProposedDeals/dsp - Create a supplier proposed deal (with APC workflow).  14. POST /adsApi/v1/query/supplierProposedDeals/dsp - Get a supplier proposed deal (with APC workflow).  15. POST /adsApi/v1/update/supplierProposedDeals/dsp - Update an existing supplier proposed deal (with APC workflow).  16. POST /adsApi/v1/query/supplierAdProducts/dsp - Get supplier ad products to create a proposed deal (with APC workflow).  17. POST /adsApi/v1/query/supplierProposalDestinations/dsp - Query supplier proposal destinations (with APC workflow).\n"," To get started, refer to the Deals API developer guide.\n"," June 18, 2026\n"," The Advertiser Account Management APIs are now generally available. These APIs enable programmatic creation, querying, and updating of advertiser accounts across all ad products (Amazon DSP and Sponsored Ads) and countries. Previously available in closed beta, these endpoints are now open to all Amazon Ads API customers with an approved LwA client.\n","POST /adsApi/v1/create/advertiserAccounts: Register one or multiple advertiser accounts - POST /adsApi/v1/query/advertiserAccounts: Fetch account details for advertiser accounts - POST /adsApi/v1/update/advertiserAccounts: Update account details for advertiser accounts\n"," To get started, see the Account registration developer guide.\n"," June 11, 2026\n"," The DSP Campaign Management APIs now support the Audio ad group inventory type. Advertisers can programmatically create and manage audio campaigns alongside Display, Streaming TV, and Online Video inventory types.\n"," Getting started\n"," To get started on Audio, you need to have a campaign created. Then, create an ad group with inventory type set to AUDIO, and associate an AUDIO creative. See below for details.\n"," What is new for Audio:\n","Campaign Management: AUDIO is now a supported ad group inventory type for creating and managing campaigns via the DSP Campaign Management APIs. - Creative Management: The AUDIO ad creative format type can now be associated with the AUDIO Ad Experience. See Creative Management for details on creating and managing audio creatives. - Deals and Inventory Groups: The AUDIO inventory type is now available for deals and inventory group management. See Deal Management Overview. - Reporting: Audio reporting is now available, with engagement metrics for Audio Attention (audio ad).\n"," June 3, 2026\n"," A new dimension attribute deal.customDealName is now available in Unified Reporting. This field returns the custom name that a DSP buyer has assigned to a deal, enabling advertisers to identify deals by their own naming conventions in reports. The field requires deal.id and is available under the Deal dimension.\n"," May 28, 2026\n"," Amazon Ads has launched new unified endpoints to manage Advertising Deals, Buyer Seats, Supplier Proposals (covering Amazon Publisher Direct workflow), and Inventory Groups (supporting deal eligibility controls).  \n"," The new and updated endpoints launched are: \n","POST /adsApi/v1/update/inventoryGroups/dsp - Update an inventory group (updated to support deals eligibility controls).  2. POST /adsApi/v1/query/inventoryGroups/dsp - Query an inventory group (updated to support deals eligibility controls).  3. POST /adsApi/v1/create/inventoryGroups/dsp - Create an inventory group (updated to support deals eligibility controls).  4. POST /adsApi/v1/retrieve/inventoryGroups/dsp - Retrieve an inventory group by ID (updated to support deals eligibility controls).  5. POST /adsApi/v1/create/buyerSeats/dsp - Create an advertiser seat.  6. GET /adsApi/v1/buyerSeats/dsp - Get list of seats based on filters provided.  7. POST /adsApi/v1/create/advertisingDeals/dsp - Create a deal.  8. POST /adsApi/v1/update/advertisingDeals/dsp - Update a deal.  9. POST /adsApi/v1/query/advertisingDeals/dsp - List all deals based on filters provided.  10. POST /adsApi/v1/query/suppliers/dsp - Get supplier details to create a proposal (with Amazon Publisher Direct workflow).  11. POST /adsApi/v1/query/supplierAdProducts/dsp - Get supplier ad products to create a proposed deal (with Amazon Publisher Direct workflow).  12. POST /adsApi/v1/create/supplierProposals/dsp - Create a proposal (with Amazon Publisher Direct workflow).  13. POST /adsApi/v1/query/supplierProposals/dsp - Get list of proposals for an advertiser (with Amazon Publisher Direct workflow).  14. POST /adsApi/v1/update/supplierProposals/dsp - Update existing supplier proposal (with Amazon Publisher Direct workflow).  15. POST /adsApi/v1/create/supplierProposedDeals/dsp - Create a supplier proposed deal (with Amazon Publisher Direct workflow).  16. POST /adsApi/v1/query/supplierProposedDeals/dsp - Get supplier proposed deal (with Amazon Publisher Direct workflow).  17. POST /adsApi/v1/update/supplierProposedDeals/dsp - Update existing supplier proposed deal (with Amazon Publisher Direct workflow).  18. POST /adsApi/v1/query/supplierProposedDealHistoricalVersions/dsp - Get proposed deal history (with Amazon Publisher Direct workflow).  19. POST /adsApi/v1/update/supplierProposedDealRevisions/dsp - Update a proposal revision (with Amazon Publisher Direct workflow).  20. POST /adsApi/v1/create/supplierProposedDealRevisions/dsp - Submit a proposal revision (with Amazon Publisher Direct workflow).  21. POST /adsApi/v1/query/supplierPublishers/dsp - Get publisher of the supplier (with Amazon Publisher Direct workflow). \n"," Upcoming endpoints are: \n","GET /adsApi/v1/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/query/dealAdvertiserAccessEntry/dsp - Fetch advertiser access to a deal.  2. GET /adsApi/v1/dealAdvertiserAccess/dsp / POST /adsApi/v1/query/dealAdvertiserAccess/dsp - Get access details of an advertiser for a deal.  3. POST /adsApi/v1/update/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/update/dealAdvertiserAccess/dsp - Update the advertiser access to a deal.  4. POST /adsApi/v1/delete/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/delete/dealAdvertiserAccess/dsp - Delete advertiser access.  5. Endpoints for Labels Management.  6. Updates to proposal APIs including Amazon Publisher Cloud (APC) workflow. \n"," To get started, refer to the Deals API developer guide.\n"," May 14, 2026\n"," Amazon Marketing Cloud (AMC) users can now leverage household-level insights for measurement and audience creation. With these fields, advertisers can analyze how media is consumed collectively across shared devices and screens within households, deduplicate reach at the household level, and build audiences based on household-level exposure patterns. Two new fields — household_id and household_size — have been added to the following AMC traffic tables:\n","amazon_live_traffic - dsp_clicks - dsp_impressions - dsp_impressions_by_matched_segments - dsp_impressions_by_user_segments - dsp_video_events_feed - dsp_views - sponsored_ads_traffic\n"," To get started, refer to the AMC datasources documentation and the Instructional query \"Open internet Amazon DSP household reach and performance\" available in the AMC use cases.\n"," May 4, 2026\n"," The Geographic Insights and Activation (GIA) API for Amazon DSP has graduated from open beta to general availability. This API lets advertisers discover and act on regional growth opportunities using Amazon first-party retail insights combined with their own geographic data.\n"," With GA, the API introduces a simplified workflow and updated endpoints. Location indexes now accept inline postal code data at creation time, replacing the separate location index version step. Smart locations are now created through the /create/geoLocations endpoint and attached to ad groups via the Campaign Management Targets API. The previous open-beta endpoints (/create/smartLocations, /update/smartLocations, /create/locationIndexVersions, /retrieve/locationIndexVersions) are deprecated.\n"," GA endpoints:\n","POST /adsApi/v1/create/locationIndexes: Create a location index with inline postal code data - POST /adsApi/v1/update/locationIndexes: Update location index data - POST /adsApi/v1/retrieve/locationIndexes: Retrieve location index by ID - GET /adsApi/v1/locationIndexes: List location indexes - POST /adsApi/v1/create/geoLocations: Create a geo location (smart location)\n"," To learn more, see the GIA developer guide and the API reference.\n"," April 30, 2026\n"," Amazon Ads has launched new unified endpoints to manage Deal Performance, Supplier Proposals (covering targeting in Amazon Owned and Operated workflow) & Inventory Groups.\n"," The new and updated endpoints launched are: \n","POST /adsApi/v1/query/dealPerformances/dsp - Get performance metrics for a deal per given filters.  2. POST /adsApi/v1/update/inventoryGroups/dsp - Update an inventory group. 3. POST /adsApi/v1/query/inventoryGroups/dsp - Query an inventory group.  4. POST /adsApi/v1/query/suppliers/dsp - Get supplier details to create a proposal (with Amazon Owned and Operated workflow only).  5. POST /adsApi/v1/query/supplierAdProducts/dsp - Get supplier ad products to create a proposed deal (with Amazon Owned and Operated workflow only; excluding product-based targeting).  6. POST /adsApi/v1/create/supplierProposals/dsp - Create a proposal (with Amazon Owned and Operated workflow only).  7. POST /adsApi/v1/query/supplierProposals/dsp - Get a list of proposals for an advertiser (with Amazon Owned and Operated workflow only).  8. POST /adsApi/v1/update/supplierProposals/dsp - Update existing supplier proposal (with Amazon Owned and Operated workflow only).  9. POST /adsApi/v1/create/supplierProposedDeals/dsp - Create supplier proposed deal (with Amazon Owned and Operated workflow only). 10. POST /adsApi/v1/query/supplierProposedDeals/dsp - Get supplier proposed deal (with Amazon Owned and Operated workflow only).  11. POST /adsApi/v1/update/supplierProposedDeals/dsp - Update existing supplier proposed deal (with Amazon Owned and Operated workflow only).  12. POST /adsApi/v1/query/supplierProposedDealHistoricalVersions/dsp - Get proposed deal history (with Amazon Owned and Operated workflow only).  13. POST /adsApi/v1/create/supplierProposedDealRevisions/dsp - Submit a proposal revision (with Amazon Owned and Operated workflow only).  14. POST /adsApi/v1/create/supplierAdProductPrices/dsp - Get supplier ad products price (with Amazon Owned and Operated workflow only).  15. POST /adsApi/v1/update/supplierProposedDealRevisions/dsp - Update a proposal revision (with Amazon Owned and Operated workflow only).  16. POST /adsApi/v1/create/supplierProposedDealForecasts/dsp - Create a forecast request for a proposed deal configuration. The forecast is returned in the response of the create request (with Amazon Owned and Operated workflow only). \n","POST /adsApi/v1/create/advertisingDeals/dsp - Create a deal.  2. POST /adsApi/v1/update/advertisingDeals/dsp - Update a deal.  3. POST /adsApi/v1/query/advertisingDeals/dsp - List all deals based on filters provided.  4. GET /adsApi/v1/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/query/dealAdvertiserAccessEntry/dsp - Fetch advertiser access to a deal.  5. GET /adsApi/v1/dealAdvertiserAccess/dsp / POST /adsApi/v1/query/dealAdvertiserAccess/dsp - Get access details of an advertiser for a deal.  6. POST /adsApi/v1/update/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/update/dealAdvertiserAccess/dsp - Update the advertiser access to a deal.  7. POST /adsApi/v1/delete/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/delete/dealAdvertiserAccess/dsp - Delete advertiser access.  8. Endpoints for Label & Seat Management.  9. POST /adsApi/v1/query/supplierPublishers/dsp - Get publisher of the supplier (with Amazon Publisher Direct (APD), Amazon Publisher Cloud (APC) supply support).  10. Updates to proposal APIs including targeting support and Amazon Publisher Direct (APD), Amazon Publisher Cloud (APC) supply support (where applicable). \n"," To get started, refer to the Deals API developer guide.\n"," March 15, 2026\n"," Amazon Ads has launched simplified unified endpoints to manage Deals, Supplier Proposals & Inventory Groups.  \n"," The new Ads Inventory Management API provides unified programmatic access to Amazon Ads inventory related data. Part of Amazon Ads API v1, it follows the common model and includes:  \n","Ability to create, update & read deals, labels, manager account and advertiser seats, supplier proposals, supplier proposed deal, supplier proposal deal history, inventory groups  2. Ability to update, delete & read operations for deal access .  3. Ability to read supplier details, supplier ad products, supplier ad products price, supplier proposed deal forecast , supplier targeting, supplier publisher, exchange, deals eligible avails, deal performance and planning metrics.  4. Ability to create proposed deal revision \n"," The API endpoints launched are:\n","POST /adsApi/v1/create/inventoryGroup/dsp: Create an inventory group 2. POST /adsApi/v1/retrieve/inventoryGroup/dsp: Retrieve inventory groups at bulk 3. POST /adsApi/v1/query/dealPlanningMetrics/dsp: Get directional average metrics for the input deals 4. POST /adsApi/v1/query/dealAvails/dsp: Get deal avails details 5. POST /adsApi/v1/query/suppliertargetItem/dsp: Add the targeting constraints to the proposed deal within a supplier ad product (with Amazon owned and operated extensions only)\n"," Upcoming API endpoints are:\n","POST /adsApi/v1/create/advertisingDeals/dsp: Create a deal 2. POST /adsApi/v1/update/advertisingDeals/dsp: Update a deal 3. POST /adsApi/v1/query/advertisingDeals/dsp: List all deals based on filters provided 4. POST /adsApi/v1/query/dealPerformance/dsp: Get performance metrics for a deal per given filters 5. GET /adsApi/v1/exchange/dsp: List all exchanges 6. GET /adsApi/v1/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/query/dealAdvertiserAccessEntry/dsp: Fetch advertiser access to a deal 7. GET /adsApi/v1/dealAdvertiserAccess/dsp / POST /adsApi/v1/query/dealAdvertiserAccess/dsp: Get access details of an advertiser for a deal 8. POST /adsApi/v1/update/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/update/dealAdvertiserAccess/dsp: Update the advertiser access to a deal 9. POST /adsApi/v1/delete/dealAdvertiserAccessEntry/dsp / POST /adsApi/v1/delete/dealAdvertiserAccess/dsp: Delete advertiser access. 10. POST /adsApi/v1/update/inventoryGroup/dsp: Update an inventory group 11. POST /adsApi/v1/query/inventoryGroup/dsp: Query an inventory group 12. POST /adsApi/v1/query/supplierTargetDefinition/dsp: Get all targeting per product 13. POST /adsApi/v1/query/supplier/dsp: Get supplier details to create a proposal (with Amazon owned and operated extensions only) 14. POST /adsApi/v1/query/supplierPublisher/dsp: Get publisher of the supplier (with Amazon owned and operated extensions only) 15. POST /adsApi/v1/query/supplierAdProduct/dsp: Get supplier ad products to create a proposed deal (with Amazon owned and operated extensions only) 16. POST /adsApi/v1/create/supplierAdProductPrice/dsp: Get supplier ad products price (with Amazon owned and operated extensions only) 17. POST /adsApi/v1/create/supplierProposedDealForecast/dsp: Get forecast for the proposed deal (with Amazon owned and operated extensions only without targeting) 18. POST /adsApi/v1/create/supplierProposal/dsp: Create a proposal (with Amazon owned and operated extensions only) 19. POST /adsApi/v1/create/supplierProposedDealRevision/dsp: Submit a proposal revision (with Amazon owned and operated extensions only) 20. POST /adsApi/v1/query/supplierProposal/dsp: Get list of proposals for an advertiser (with Amazon owned and operated extensions only) 21. POST /adsApi/v1/query/supplierProposalHistoricalVersion/dsp: Get a proposal history (with Amazon owned and operated extensions only) 22. POST /adsApi/v1/retrieve/supplierProposedDealHistoricalVersion/dsp: Get proposed deal history (with Amazon owned and operated extensions only) 23. POST /adsApi/v1/query/supplierProposedDeal/dsp: Get supplier proposed deal (with Amazon owned and operated extensions only) 24. POST /adsApi/v1/update/supplierProposal/dsp: Update existing supplier proposal (with Amazon owned and operated extensions only) 25. POST /adsApi/v1/update/supplierProposedDeal/dsp: Update existing supplier proposed deal (with Amazon owned and operated extensions only) 26. Updates to proposal APIs including targeting support and Amazon Publisher Direct (APD), Amazon Publisher Cloud (APC) supply support.\n"," To get started, refer to the Deals API developer guide.\n"," February 18, 2026\n"," The Brand Stores management API has graduated from beta to general availability. This API enables brands and advertisers to programmatically manage their Amazon Brand Stores at scale, providing two key capabilities: retrieve Brand Store page content and update product content and selection across Brand Stores pages, and submit store updates for moderation. With GA, the Brand Stores management API is production-ready for all Brand Store owners. Advertisers can use these APIs to automate Brand Store management and maintain product information freshness. These functionalities can be combined with Brand Home APIs to create a more efficient and streamlined management process for Brand Stores on Amazon. To learn more, see the Brand Stores management overview and the technical specifications.\n"," February 18, 2026\n"," Amazon is launching Sponsored Brands Collections in Unified Ads API & SB V4 API - a new ad format that lets advertisers promote multiple related products in a single ad unit. With AI-powered automatic collections, Amazon dynamically curates the most relevant products for each shopper, while manual collections allow advertisers to hand-pick their selection. This feature is now available worldwide.\n"," Advertisers can choose between two collection types:\n","Automatic collections – Let Amazon AI dynamically group the most relevant products from their catalog into collections based on their keyword targets and shopper search queries. \\* Manual collections - Select 3-10 related products to feature in the ad. This ad type supports keyword or product targeting and gives full control over the products in the ad.\n"," Key benefits\n","Expand product discoverability: Advertisers can feature up to ten related products from their catalog, engaging shoppers in high visibility placements across the Amazon Store.  Branded shopping experience: Collections highlight key product details for quick evaluation and purchase and connect shoppers to branded experiences where they can explore more products from their catalog.  Scaled campaign creation and optimization: Automatic collections highlight to shoppers the best combination of products based on keyword targets and shopper queries without the need to manually setup and optimize multiple campaigns.\n"," API Endpoints\n"," Sponsored Brands Collections can be managed through the Amazon Ads Campaign Management API using the standard campaign management endpoints:\n","Create Ads: POST /adsApi/v1/create/ads \\* Update Ads: POST /adsApi/v1/update/ads\n"," December 15, 2025\n"," For this open beta, DSP advertisers can adjust both advertiser-level and ad-group level brand suitability settings via the API. For more on advertiser-level brand suitability settings, see the new brandSafetyTierInheritedSettingDetails and brandSafetyCategoryInheritedSettingDetails setting in the DSP inherited settings API specs. For more information on ad-group level targeting, see the new BrandSafetyCategoryTarget setting in the campaign management API spec and the DSP targets API spec. Content Exclusion Categories is now live for Twitch, third-party web and mobile inventory, on Display and Video media types. For reporting details, see Brand suitability reports.\n"," December 1, 2025\n"," Amazon Ads has launched a single Campaign Management API to unify campaign management into one set of APIs. Built from a common Amazon Ads data model, this API standardizes field and enum values across ad products and features, improves error handling, and helps resource consistency across Campaign, Ad Group, Target, and Ad objects. This API includes feature parity with the existing APIs. Previously, there were nearly 200 separate variations of create, read, update, and delete endpoints that will be reduced to 16 with this launch. Today, we announce the completion of Sponsored Products, Sponsored Brands, and Amazon DSP for worldwide general availability. All of our ad products will be available through the Amazon Ads Campaign Management API, and we will have Sponsored Display and Sponsored TV later this year.\n"," To get started, please see the Campaign Management Overview.\n"," November 15, 2025\n"," For this open beta, DSP advertisers can adjust both advertiser-level and ad-group level brand suitability settings via the API. For more on advertiser-level brand suitability settings, see the new brandSafetyTierInheritedSettingDetails setting in the DSP inherited settings API specs. For more information on ad-group level targeting, see the new brandSafetyTierTarget setting in the campaign management API spec and the DSP targets API spec. For reporting details, see Brand suitability reports. This feature is already live for Twitch and now expanding to third-party web and mobile inventory. Currently, only Display and Video media types are supported. See the DSP brand safety and suitability roadmap.\n"," October 15, 2025\n"," Our forecasting API for Amazon DSP has gone from open beta to GA. This API provides access to all real-time forecasts available from the ADSP Campaign Manager. For more information, see the technical specs.\n"," October 15, 2025\n"," For advertisers using Amazon DSP and Amazon Marketing Cloud (AMC), our Geographic Insights and Activation (GIA) feature empowers advertisers to uncover and act on regional growth opportunities using Amazon first-party retail insights and their own geographic signals. Through an intuitive map interface, advertisers can visualize their brand performance against category benchmarks across different regions. With one click, they can activate smart location groups that automatically adjust bids to reach customers in areas of opportunity, such as regions with low brand penetration. AMC users can combine their own geographic data with Amazon retail insights, creating custom strategies that align with their specific business goals.\n"," For advertisers, driving new-to-brand growth is vital for long-term success, but identifying and engaging new audiences effectively remains a significant challenge. Many brands lack the signal-driven insights needed to pinpoint untapped regions to reach these audiences at scale. GIA solves this challenge by combining robust retail insights from Amazon with geographic signals from advertisers. Whether breaking into new territories or strengthening presence in established markets, GIA provides the essential tools needed for advertisers to expand reach strategically and drive measurable business growth.\n"," API endpoints: \n","Create a new smart location optimization: POST /adsApi/v1/create/smartLocations - Update a existing smart location optimization: POST /adsApi/v1/update/smartLocations - Create a location index to use as a container for location optimization signal: POST /adsApi/v1/create/locationIndexes - Retrieves location index by ID: POST /adsApi/v1/retrieve/locationIndexes - Creates a versioned dataset with location optimization signal at postal code level: POST /adsApi/v1/create/locationIndexVersions - Retrieves a location index version by ID: POST /adsApi/v1/retrieve/locationIndexVersions\n"," September 29, 2025\n"," For this open beta, DSP advertisers can adjust both advertiser-level and ad-group level brand suitability settings via the API. For more on advertiser-level brand suitability settings, see the new brandSafetyTierInheritedSettingDetails setting in the DSP inherited settings API specs. For more information on ad-group level targeting, see the new brandSafetyTierTarget setting in the campaign management API spec and the DSP targets API spec. For reporting details, see Brand suitability reports. This feature is currently only available for Twitch inventory. Currently, only Display and Video media types are supported. See the DSP brand safety and suitability roadmap.\n"," September 26, 2025\n"," Amazon Ads announces the launch of Events API, enabling advertisers to send conversion events that occur outside of the Amazon ecosystem. Amazon Events API allows advertisers to send real-time or offline conversion event data via Server to Server integration. It can be used to send data directly from an advertiser server to Amazon Ads or from an advertiser-preferred Customer Data Platform (CDP). \n"," Events API enables advertisers to evaluate the effectiveness of their Amazon marketing campaigns regardless of the location of the conversion and utilize this information to drive campaign optimization. Events API can help strengthen performance and decrease cost per action (CPA) with more complete attribution, improved data reliability, and better optimized delivery. It also serves as a complementary method to Amazon Ad Tag (AAT) for sending website events as the browser-based tracking is susceptible to ad blockers, browser privacy settings, and cookie limitations. Events API, on the other hand, sends data directly from your server, bypassing these limitations and ensuring more reliable data collection. This leads to more accurate conversion tracking and better insights for campaign optimization. Additionally, the Events API allows you to send more user identifiers (like email and phone number) and information about the user journey. \n"," Events API will be available to self-serve Amazon DSP advertisers world-wide. Tracked conversions can be viewed and managed in the Amazon DSP console Events Manager page. To use the conversions for campaign measurement, conversions can be associated with orders using a new 'Off-Amazon conversions' widget when creating orders in the Amazon DSP console. Conversions signals will also be made available as seed information for audience building in the Amazon DSP console within Audiences. \n"," For full technical details, refer to the Events API specifications.\n"," September 25, 2025\n"," Today, we announce Amazon Marketing Stream campaign datasets in open beta, mimicking the API model of the new Campaign Management APIs. With this launch, customers will find it easier to consume both Sponsored Ads and ADSP campaign data instead of subscribing to two different ones. Customers will receive all their campaign data updates in a single stream mimicking the read operations of our Campaign Management APIs, reducing cognitive load and effort in mapping between API and Stream fields.\n"," To get started, please see our Campaign Management Overview section of Amazon Ads API v1 documentation.\n"," September 24, 2025\n"," Amazon DSP Commitments Hub provides customers with a centralized place to manage their spending agreements with publishers (commitments). These new tools simplify tracking pacing, automatically optimize campaign spend, and accelerate spend analysis.\n"," Commitments are available via console and API for all self-service advertisers in all markets where Amazon DSP operates. The Commitments API provides five key endpoints: \n","POST /adsApi/v1/create/commitments/dsp: Create new commitments - GET  /adsApi/v1/commitments/dsp: List all commitments - POST /adsApi/v1/retrieve/commitments/dsp: Get specific commitments by ID - POST /adsApi/v1/update/commitments/dsp: Update existing commitments - POST /adsApi/v1/retrieve/commitmentSpends/dsp: Get specific commitment spends by ID\n"," The Commitments API allows you to create and manage commitments with various properties including commitment name, committed spend amount, currency code, start and end dates, fulfillment level, and spend calculation mode. You can link commitments to entities, advertisers, campaigns, and deals, and track spend accrual across these relationships. \n"," For full technical details, please see the technical specification for the Commitments API.\n"," August 6, 2025\n"," Amazon has launched two new APIs that enable access to global brand identifiers through the Advertising API Gateway. Global Brand IDs streamline brand identification by reducing multiple marketplace-specific IDs into a single identifier, enabling consistent brand recognition across all marketplaces. This transforms the multi-marketplace IDs into a single identifier, such as Adidas going from 38 brand IDs to just a single global brand. The introduction of Brand status attributes allows customers to filter and interact with only valid, active brand information while eliminating duplicate or merged entries.\n"," Two new APIs are accessible through the Amazon Ads API:\n","QueryBrandAdvertiserAssociation API (POST /adsApi/v1/query/brandAdvertiserAssociations) is a paginated API that authorizes on Global Advertiser IDs and returns Global Brand IDs associated with Global Advertiser Account.  - RetrieveBrands API (POST /adsApi/v1/retrieve/brands) returns Global Brand IDs metadata, such as brand name, brand status, the list of websites and logos. The API accepts 100 brands in the request at a time.\n"," For more information, see the technical specification for the brand associations APIs.\n"," August 1, 2025\n"," Amazon Ads has launched a single Campaign Management API to unify campaign management into one set of APIs. Built from a common Amazon Ads data model, this API standardizes field and enum values across ad products and features, improves error handling, and helps resource consistency across Campaign, Ad Group, Target, and Ad objects. This API includes feature parity with the existing APIs. Previously, there were nearly 200 separate variations of create, read, update, and delete endpoints that will be reduced to 16 with this launch. \n"," Today, we announce the completion of Sponsored Products, Sponsored Brands, and Amazon DSP for worldwide general availability. All of our ad products will be available through the Amazon Ads Campaign Management API, including Sponsored Display and Sponsored TV later in 2025.\n"," To get started, please see the campaign management overview and the technical specification.\n"," July 15, 2025\n"," The Advertiser Account is the Amazon Ads enhanced workflow for onboarding advertisers and managing their full advertising activity across all ad products (ADSP and Sponsored Ads) and countries. With this launch, customers with an Amazon DSP Seat can use Ads Console to onboard advertisers with a new streamlined account and billing setup. In this account, customers can operate across both ADSP and Sponsored Ads globally across the full advertising lifecycle from campaign management and reporting, to user management and billing. API customers have the same experience on Amazon Ads API, enabling them to onboard advertisers at scale without relying on Ads Console to do so. If you have an ADSP seat and would like to use this feature, please speak with your Amazon ad-tech AE.\n"," Previously, registration and account management functionality for Amazon Ads advertiser accounts was only available through the Ads Console. With this launch, Amazon Ads API customers can execute all account management related actions (create, view, update advertiser accounts etc.) for all Amazon ad products and countries via API without the need to visit Ads Console to do so. Now, customers can register Advertiser Accounts at scale via public API, and they can use the resulting account identifiers to execute campaign management, reporting, billing and user management operations across all countries and ad products (ADSP, SA). Below is the list of new APIs launched:\n","POST /adsApi/v1/create/advertiserAccounts: Register one or multiple advertiser accounts by providing business details or importing them from a selling account token - POST /adsApi/v1/query/advertiserAccounts: Fetch account details/attributes (such as business/billing details, selling accounts, alternate identifiers for public APIs etc.) for a given advertiser account, a group of advertiser accounts, or all advertiser accounts that a given user has access to - POST /adsApi/v1/update/advertiserAccounts: Programmatically update account details/attributes for advertiser account(s) - POST /adsApi/v1/query/sellingAccounts: Fetch all Amazon retail selling account (for example, Seller, Vendor, Author, KDP etc.) that a given user has access to, so that the resulting encrypted selling account token can be used to register an associated advertiser account.\n"," June 28, 2025\n"," Brand Stores has launched a new set of APIs that offer brands and advertisers programmatic access to manage their Amazon Brand Stores more efficiently. These APIs, now available through the Amazon Ads API, provide two key functions: 1) retrieve Brand Store page content and update the product content and selection across Brand Stores pages and 2) submit store updates for moderation.\n"," Advertisers can use these APIs to programmatically manage their Brand Stores pages. These functionalities can be combined with Brand Home APIs to automate and maintain product information freshness, creating a more efficient and streamlined management process for Brand Stores on Amazon. \n"," The Brand Stores management APIs are generally available to all Brand Store owners through the Amazon Ads API. To learn more, see the Brand Stores management overview and the technical specifications.\n"," June 26, 2025\n"," We have introduced a new POST /adsApi/v1/query/accountLinks endpoint that returns information about linked accounts in a paginated manner. Manager Account users can retrieve details about all accounts (Sponsored Ads accounts, ADSP advertiser accounts, and Manager Accounts) linked to their Manager Accounts. Additionally, advertiser account users can find all Manager Accounts linked to their advertising account. This helps users better understand the structure and access relationships across their advertising setup.\n"," This enhancement helps customers with complex account structures better understand their organizational account structure. The new paginated API fixes two key limitations: it removes the previous 50-linked-account limit for Manager Accounts in the GET /managerAccounts API, and it gives advertiser account users the ability to query linked Manager Accounts via API, a feature not previously available. Customers can now retrieve complete information on their account linking structure, helping them make better decisions about their organizational advertising spend and performance.\n"," To learn more, see the linked accounts API user guide and the technical specification.\n"," June 5, 2025\n"," Amazon Ads has launched a new forecasting API for Amazon DSP (ADSP) campaigns. Built on the Amazon Ads data model, this API provides access to all real-time forecasts currently available on ADSP Campaign Manager.\n"," In this launch, the API offers campaign-level performance, delivery, and spend forecasts currently available on forecasting widgets. This includes campaign flight level forecasts for spend, reach, CPC, CPA, and ROAS. The API provides forecasts both for new orders and existing orders that are spending budget.\n"," Throughout 2025, we will expand the capabilities of the API to include forecasts for other features on the campaign manager such as line-level forecasts, additional spend potential, and creative forecasts. These metrics will also be available using datasets through Amazon Marketing Cloud for easier integrations. For more information, please see the technical specification and the Forecast API overview.\n"," May 29, 2025\n"," Amazon Ads has launched a single Campaign Management API for all ad products, starting with Sponsored Products, Sponsored Brands, and Amazon DSP. Built from a common Amazon Ads data model, this API will ensure field naming, enumerated values, and resource consistency across Campaign, Ad Group, Target, and Ad objects. \n"," Today, there are over 190 separate variations of create, read, update, and delete endpoints, which will be reduced to 16 with this launch. With the Amazon Ads Campaign Management API developers can expect to see complete feature parity, improved error handling, consistent request and response patterns, and higher pagination thresholds than previous versions.\n"," Throughout 2025, all of our ad products will become available through the Campaign Management API, including Sponsored Display and Sponsored TV. We will also be launching consistent campaign datasets through Amazon Marketing Stream, built from the same underlying Amazon Ads domain model, for further consistency across all products. \n"," Although we do not anticipate updates to the contract, the contract may be subject to change during the beta period. \n"," For more information, please see the technical specification and the campaign management overview.\n"],"documentType":"release-note"},{"title":"Amazon Ads API v0 release notes","sectionHeader":null,"path":"/en-us/release-notes/ads-api-v0","content":[" September 29, 2026\n"," The Amazon Ads MCP Server now offers a Lite version, served from the /mcp/lite path. The Lite version exposes the same Amazon Ads capabilities as the Regular version through a compact three-tool interface (search_tools, describe_tools, and invoke_tool) instead of registering every operation as its own tool, keeping the model context small and predictable. This is useful for smaller-context models, cost-sensitive workloads, or clients that only need a handful of operations per session. For setup instructions, see Connecting to the Amazon Ads MCP Server (Lite).\n"," September 24, 2026\n"," Fire Tablet Lockscreen is the newest device ad placement to integrate with the Asset Based Creative (ABC) template already used by advertisers across desktop, mobile, and Alexa Home Screen. Managed Service advertisers can traffic ABC creatives to Fire Tablet Lockscreen through the standard ABC intake, and Amazon DSP self-service advertisers can select Fire Tablet Lockscreen as an eligible placement in the DSP Creative Gallery.\n"," Because ABC assembles the ad from standardized advertiser-supplied components — background image, logo, brand name, headline, and Call-to-Action — the same creative can now serve on Fire Tablet lockscreens in addition to existing surfaces, without producing bespoke lockscreen creatives. This launch supports click-to-URL destinations, with click-through opening in the Silk browser.\n"," September 22, 2026\n"," Built for the people who build the ads - join our new developer track at unBoxed 2026. Register today to access the keynote livestream and select video on-demand content, post-event. Register here.\n"," September 18, 2026\n"," Sponsored Brands has launched the ListMigrations API (POST /sb/v4/migrations/list) to help advertisers retrieve recommended replacement ads for Product Collection ads and track their migration status. Sponsored Brands collections replace the legacy Product Collection format with improved functionality and performance in the same high-visibility placements. Beginning February 2027, product collections will no longer be supported.\n"," For each eligible source ad, the API returns recommended MANUAL_COLLECTION and AUTO_COLLECTION replacement options along with the source ad details including campaign name, ad group name, and ASINs.\n"," For more information, see the Sponsored Brands API specification or Migrate from Product collections to Sponsored Brands collections.\n"," August 24, 2026\n"," The spPromptAdExtension and spVideoAdExtension report types in version 3 of the reporting API now support four additional columns for Sponsored Products:\n","portfolioName - the name of the portfolio associated with the campaign. 2. campaignBudgetCurrencyCode - the currency code associated with the campaign. 3. purchaseClickRate7d - rate of ad-attributed purchase events relative to ad clicks within 7 days. 4. purchaseClickRate14d - rate of ad-attributed purchase events relative to ad clicks within 14 days.\n"," These columns bring both report types to parity with other Sponsored Products report types. Existing columns and report behavior are unchanged, and requests that do not ask for the new columns are unaffected.\n"," Availability: United States.\n"," For the full column lists and sample requests, see the Prompt Ad Extension reports and Video Ad Extension reports documentation.\n"," July 27, 2026\n"," Documentation is now available for the spVideoAdExtension report type in version 3 of the reporting API. This report returns performance data for Sponsored Products ads that include video creative, broken down by individual video, along with video engagement metrics.\n"," The report type has been available since November 2025. This release note announces its documentation, not a change in availability or behavior.\n"," Availability: United States.\n"," Key capabilities: Group results by videoAdExtension to break performance down to the individual video. Identify each video with creativeExtensionId and videoType. Measure engagement with video5SecondViews and video5SecondViewRate alongside the standard Sponsored Products traffic, conversion, and sales columns.\n"," For full technical details, including the supported columns and a sample request, see the Video Ad Extension reports documentation.\n"," July 23, 2026\n"," We have launched the media plan API in closed beta, enabling advertisers and integrators to build media plans programmatically for Amazon DSP and sponsored advertising accounts. The API supports creating plans, submitting them for processing, and accessing outputs including audience sizing, audience insights, performance forecasts, traffic insights, and optimized budget allocations. It streamlines planning workflows so advertisers can build forward-looking plans, uncover audience opportunities, and make data-driven budget decisions.\n"," Availability: United States, Canada, Mexico, Brazil, Germany, Spain, France, Italy, United Kingdom, Sweden, Netherlands, Turkey, United Arab Emirates, Saudi Arabia, India, Japan, Australia.\n"," Who can use it: Vendors, agencies, managed service, self-service, authors, book publishers, enterprises, and manager accounts.\n"," Key capabilities: Full create, read, update, and delete support across media plans, marketing goals, and planning items; budget allocation optimization; audience opportunity definition with audience sizing; behavioral, demographic, and traffic insights alongside performance forecasts; and media plan exports for external analysis.\n"," For full technical details, see the media plan API documentation. To get started, contact your Amazon representative.\n"," July 21, 2026\n"," Reach and Frequency metrics (reach, houseHoldReach, frequencyAverage, householdFrequencyAverage) are not supported for DSP campaign reports when the creative groupBy is included. If your report request includes the creative dimension, these metrics will not be available in the report response.\n"," For full technical details, see the DSP campaign report documentation.\n"," July 20, 2026\n"," The /dsp/advertisers, /dsp/advertisers/{advertiserId}, POST /adsAccounts, POST /adsAccounts/batch, GET /adsAccounts/{accountId}, and POST /adsAccounts/list endpoints are deprecated in favor of the advertiser accounts APIs: POST /adsApi/v1/create/advertiserAccounts for account creation and POST /adsApi/v1/query/advertiserAccounts for account retrieval and listing. Starting July 2026, all six endpoints return Warning: 299 deprecation headers and new client integrations are blocked. Beginning July 2027, requests to these endpoints will return HTTP 404 Not Found. See the deprecations page for full details.\n"," July 14, 2026\n"," The Marketing Mix Modeling (MMM) API and data feed now support all 21 Amazon Ads locales, up from 14. Newly added marketplaces are NL (The Netherlands), BE (Belgium), PL (Poland), SE (Sweden), TR (Turkey), EG (Egypt), and SG (Singapore).\n"," The full list of supported marketplaces is:\n","North America: United States, Canada, Mexico - South America: Brazil - Europe: United Kingdom, Germany, France, Italy, Spain, The Netherlands, Belgium, Poland, Sweden, Turkey - Middle East: United Arab Emirates, Saudi Arabia, Egypt - Asia Pacific: Japan, Australia, India, Singapore\n"," For more information, see the MMM overview.\n"," July 6, 2026\n"," The Amazon Ads MCP Server now supports OAuth 2.1. With OAuth 2.1, your MCP client handles token retrieval automatically through a browser-based login flow - you do not need to manage access tokens in your configuration file. OAuth 2.1 is supported for Kiro CLI, Claude Code, Claude Desktop, and ChatGPT. For setup instructions, see Connecting to the Ads MCP Server using OAuth 2.1.\n"," June 4, 2026\n"," We updated the Ad Library API to return structured media content for advertisements. The API response now includes a new contents field that provides typed content references, distinguishing between linked pages (product or brand pages) and media files (images, videos, and audio). This replaces the previous behavior where only screenshot URLs or product page links were returned via the contentUrls field.\n"," Previously, the API could only return screenshot images or product page links for ad creatives. Video and audio ad creatives that did not have a screenshot available would return no content at all. This update helps ensure that media files for video and audio ad creatives are returned correctly, improving the completeness and transparency of Ad Library data.\n"," Availability: Germany, Spain, France, Italy, Netherlands, Poland, Sweden, Belgium, Ireland.\n"," Key changes to the ListAds and GetAdsByID endpoints:\n","New contents field (array of Content objects, max 10 items) \\* Content is a union type with two variants:\n"," The existing contentUrls field is maintained for backward compatibility.\n"," Example response for a video ad:\n"," Example response for a product page link:\n"," For full technical details, see the Ad Library API documentation.\n"," June 3, 2026\n"," The DSP Bid Adjustments API now returns HTTP 423 ConcurrentModificationException when two or more mutating requests target the same rule or association in close succession. The error is marked retryable and supported SDK clients will retry it automatically. Previously, racing writes could surface as a 500 InternalServerException.\n"," To minimize 423 responses, serialize create, update, and delete calls against the same bidModifierRuleId or (advertiserId, adGroupId) association, and apply exponential backoff on retry. Note that mutating operations are not strongly consistent within a 5-minute window — a subsequent GET for the same rule or association may not reflect the change for up to 5 minutes. For details, see DSP bid adjustments rate and size limits.\n"," May 26, 2026\n"," Amazon Ads API has updated its refresh token expiration policy to enhance security and align with industry best practices. Effective July 30, 2026, refresh tokens issued on or after that date expire 365 days from the date of advertiser consent, requiring developers to plan for re-authorization in their applications. Refresh tokens issued before July 30, 2026 are not affected and continue to function as before. They remain valid until the advertiser revokes authorization or another invalidation condition occurs.\n"," Key Changes\n","Effective date: July 30, 2026  365-day expiration: Refresh tokens issued on or after July 30, 2026 expire 365 days from the date of advertiser consent  Fixed expiration: For affected tokens, the expiration date is fixed at consent time and is not extended by token usage or refresh activity  Re-authorization required: After expiration, the advertiser must grant consent again to restore access  Grandfathered tokens: Refresh tokens issued before July 30, 2026 are not subject to the 365-day expiration and remain valid as before\n"," Action Required\n"," Developers should update their applications to:\n","Track refresh token age from the date of advertiser consent for tokens issued on or after July 30, 2026 2. Proactively prompt advertisers to re-authorize before the 365-day expiration 3. Handle expired refresh token errors gracefully 4. Store consent date metadata alongside refresh tokens issued on or after July 30, 2026\n"," For detailed implementation guidance, see the Refresh Tokens documentation.\n"," May 19, 2026\n"," AMC workflow MCP tools and skill now support all AMC instances - no longer limited to those with AWS Clean Room collaboration enabled.\n"," May 18, 2026\n"," Benchmarks reporting is now generally available across all supported marketplaces (US, CA, MX, BR, AU, JP, IN, DE, FR, IT, ES, UK, NL, TR, SE, SA, UAE, EG). Previously in beta and limited to the US, benchmarks provide standardized performance comparisons against category peer brands, allowing advertisers to contextualize performance, evaluate optimization opportunities, and confidently invest with Amazon Ads.\n"," Benchmarks are available for the following metrics:\n","Percent of purchases new to brand 2. Purchase rate (new to brand) 3. Cost per purchase (new to brand) 4. Click-through rate (CTR) 5. Cost per click (CPC) 6. Completion rate (video) 7. Cost per completed view (video) 8. Cost per impressions (CPM)\n"," Benchmarks reports are available as crossProgramBenchmarks (Sponsored Ads) and dspBenchmarks (Amazon DSP) report types in the Reporting API.\n"," May 7, 2026\n"," The Marketing Mix Modeling (MMM) data feed now includes a new NationalAsinEngagement.tsv.zip file. This file provides daily or weekly national engagement events per ASIN by country, including ASIN, country, and add to cart count. The file is available at country-level geographic granularity.\n"," For more information, see the MMM data feed documentation.\n"," May 1, 2026\n"," The Marketing Mix Modeling (MMM) API is now generally available. This API enables programmatic access to Amazon MMM data feed across 14 countries: US, CA, IT, ES, FR, DE, UK, MX, BR, JP, AU, UAE, IN, and KSA. Advertisers and their partners can seamlessly access the Amazon advertising and retail signals needed to derive accurate insights from their MMM solutions.\n"," Since the beta launch, the MMM API now includes new operations that give advertisers greater control over their brand group configurations and improved visibility into report status:\n","Create overrides for brand groups: POST /mmm/v1/brandGroupOverrides  Delete overrides for brand groups: POST /mmm/v1/brandGroupOverrides/delete  List overrides for brand groups: POST /mmm/v1/brandGroupOverrides/list  Retrieve the list of products in a brand group: GET /mmm/v1/brandGroups/{brandGroupId}/products  Retrieve the list of campaigns associated with the products in a brand group: GET /mmm/v1/brandGroups/{brandGroupId}/campaigns \\* List reports and their generation status: POST /mmm/v1/reports/list\n"," For full technical details, see the MMM API user guide and the technical specifications.\n"," April 2, 2026\n"," We launched cross-account reach and frequency (R&F) reporting that allows advertisers to measure de-duplicated reach and frequency across multiple Amazon ads accounts with flexible time granularity options (daily, weekly, monthly, yearly, day of month, and custom time period reporting). Additionally, we launched manager account and cross-manager account frequency group R&F reporting to manage and monitor frequency across multiple accounts.\n"," Key benefits\n","Advertisers can measure total unique audience reach and frequency across Sponsored Ads (excludes Sponsored Product) and Amazon DSP investments in a single view for efficient budget allocation. \\* Advertisers can measure, monitor and manage frequency across their brand product portfolio, spanning across multiple accounts to avoid audience fatigue. \n"," Get Started: Learn more in the reporting API overview page (Betas tab). Refer to the metrics and dimensions guide for details on the R&F metrics and dimensions supported.\n"," March 27, 2026\n"," We have deprecated the Catch-Up Boost pacing feature in Amazon DSP in both UI and API. This legacy manual control, which allowed advertisers to increase delivery aggressiveness under “Even” pacing, was replaced by Dynamic Catchup in 2024. Dynamic Catchup automatically optimizes delivery based on real-time performance and no longer requires user input. API inputs on Catch-Up Boost field can continue to be set, but are ignored in ad delivery. Our UI removed this field on March 23, 2026.\n"," Dynamic Catchup - Key benefits\n","Runs automatically—no manual setup required  Adjusts daily based on under-delivery patterns  Improves smooth delivery and consistency across flights \\* Maximizes budget utilization without delivery volatility\n"," Impacted API Endpoints\n"," The Catch-Up Boost field is marked as deprecated in the following APIs:\n","Ad Groups:\n"," February 18, 2026\n"," We are excited to announce the Open Beta launch of the Amazon Ads MCP Server, enabling external developers and advertising partners to build sophisticated AI agents with seamless access to Amazon Ads capabilities through the Model Context Protocol. The MCP Server provides standardized tools for Campaign Management, Reporting, and Account Management, eliminating the need for complex custom implementations while maintaining enterprise-grade security with fine-grained authorization controls.\n"," The Campaign Management tools offer comprehensive CRUD operations and introduce three sophisticated workflows that transform complex processes into single invocations. The single-shot campaign creation tool enables developers to create a complete advertisement—encompassing the campaign, ad group, ad, and targeting—in one call, eliminating what previously required five or more separate operations. Additional workflows streamline country expansion to new marketplaces and automate keyword harvesting from automatic to manual campaigns, allowing advertisers to refine their targeting strategies efficiently.\n"," The Reporting tools offer parity with the new reporting APIs launched in November 2025 to access advertising performance data. This interface enables custom report creation tailored to multi-dimensional, cross-ad product and cross -account reporting needs. The stream subscription tools offer tool capabilities for real-time or scheduled access to performance metrics.\n"," The Account Management tools provide comprehensive capabilities for managing user access and permissions across advertising accounts, enabling programmatic handling of the complete user invitation lifecycle. Developers can list, query, issue, redeem, and update user invitations, allowing automated onboarding workflows particularly valuable for agencies and service providers managing multiple client accounts.\n"," To get started with the Amazon Ads MCP Server, visit the Amazon Ads MCP overview.\n"," February 18, 2026\n"," We launched new dynamic reach and frequency (R&F) reporting capabilities for advertiser account, supply source and frequency group reporting breakdowns. This includes de-duplicated R&F across custom campaign sets within advertiser account, flexible time granularity options (daily, weekly, monthly, yearly, day of month, and custom time period reporting). Additionally, advertisers can measure de-duplicated R&F for a global account across the associated DSP and Sponsored ads (SA) advertiser accounts. This builds on our Nov 11, 2025 release, which introduced custom time period R&F reporting for past 15 months for Sponsored and DSP campaigns and ad groups.\n"," Learn more about reporting API in the reporting API overview page (Betas tab). Refer to the metrics and dimensions guide for details on the new frequency group dimension, exclusive user reach rate metric and the R&F metrics supported for advertiser account and supply source dimensions.\n"," January 27, 2026\n"," The follow suggestion APIs are deprecated and will be shutoff on June 2026:\n"," V2 Suggested Keyword Deprecations\n","/v2/asins/{asin}/suggested/keywords,   /v2/adGroups/{adGroupId}/suggested/keywords/extended,   /v2/adGroups/{adGroupId}/suggested/keywords, \\* /v2/asins/suggested/keywords\n"," Please use the /sp/targets/keywords/recommendations API instead.\n"," V2 Stores deprecation\n","/v2/stores is being deprecated and replaced with /brand/stores/v1/storePages/list\n"," January 27, 2026\n"," Date Extension Notice: We are extending the deprecation timeline from the previously announced February 2nd, 2026 to June 15th, 2026 to provide advertisers with additional time to adjust their campaigns.\n"," As we have introduced positive bid adjustments for Sponsored Brands TOP_OF_SEARCH placement on 6/17/2025, we are standardizing all Sponsored Brands (SB) placement groups to support only positive bid adjustments. This means that negative bid adjustment values for SB placements will not be supported starting June 15th, 2026. While existing campaigns with negative bid adjustments will continue to run with their current settings, no new negative adjustments will be accepted after this date. If you have any questions, please visit the Amazon Ads API Support page and create a ticket with the subject title: \"Sponsored Brands Negative Bid Adjustment Deprecation\".\n"," December 1, 2025\n"," Today, we announce the completion of Amazon Marketing Stream campaign datasets mimicking the API model of the Campaign Management APIs. With this launch, customers will find it easier to consume both Sponsored Ads and ADSP campaign data instead of subscribing to two different ones. Customers will receive all their campaign data updates in a single stream mimicking the read operations of our Campaign Management APIs, reducing cognitive load and effort in mapping between API and Stream fields.\n"," To get started, please see our Campaign Management Overview section of Amazon Ads API v1 documentation.\n"," December 1, 2025\n"," If you transmit or make available to Amazon Ads any personal information, you must provide the country code for all data uploads globally. For data with a UK or EEA country code, you must also include a valid consent signal in addition to the country code.\n"," Country Code\n"," You must share a country code when passing customers' consented data to Amazon Ads. The country code is a 2-character string in the ISO 3166 format that indicates in which country the consent was given (for example, US, GB or DE).\n"," Consent Signal\n"," You can either use (i) the IAB European Transparency & Consent Framework (TCF) signal(s), (ii) Global Privacy Protocol (GPP) or (iii) Amazon Consent Signal, to communicate UK and EEA user privacy choices to Amazon Ads. \n"," For detailed consent requirements by product, see Amazon Ads consent signals in the Amazon Ads Support Centre - Before You Begin section.\n"," December 1, 2025\n"," We are excited to announce a significant improvement to Amazon DSP creative management capabilities as we introduce a new Global Creative workflow for 'Standard Display' creatives that eliminates the need to upload identical creatives multiple times for different marketplaces. There is no change to other creative types (Video, Audio, or Component Based, including ASIN-based creative templates).\n"," Global Creatives will allow advertisers with an Advertiser Account (beta) to define display creatives once per region instead of once per marketplace, wherever the creative language is supported. Both Standard Display and HTML5 Ad Experiences are supported. For other legacy DSP advertiser accounts, the marketplace field will no longer be required, but the creative may only be used with their existing marketplace and the creative language must be targetable from their marketplace. For more information see: Creative Management: Standard Display - Business Validation Rules\n"," December 1, 2025\n"," As we have introduced positive bid adjustments for Sponsored Brands TOP_OF_SEARCH placement on 6/17/2025,  we are standardizing all Sponsored Brands (SB) placement groups to support only positive bid adjustments. This means that negative bid adjustment values for SB placements will not be supported starting February 2nd, 2026. While existing campaigns with negative bid adjustments will continue to run with their current settings, no new negative adjustments will be accepted after this date. If you have any questions, please visit the Amazon Ads API Support page and create a ticket with the subject title: \"Sponsored Brands Negative Bid Adjustment Deprecation\".\n"," November 17, 2025\n"," The PVC dataset, originally launched to open beta in May 2025, enables Prime Video Channel Partners to conduct detailed audience overlap analysis, activate AMC audiences for Amazon DSP and sponsored ads campaigns, and generate insights incorporating Channel viewership data. This dataset is available only for Amazon Prime Video Channel partners. To get started, subscribe to the Prime Video Channel Insights (PVC) paid feature in AMC.\n"," For more information, refer to the Amazon Prime Video Channel Insights tables.\n"," November 11, 2025\n"," Amazon Ads introduces new benchmarks, which are self-service insights that enable advertisers to evaluate brand category performance across different ad formats and campaign goals. Advertisers can use benchmarks to optimize current campaigns and plan their next strategic investments based on competitive insights. Through these new expanded capabilities including sophisticated peer brand matching and transparent methodology, advertisers can instantly understand what performance looks like in their category and make data-driven decisions about their advertising investments.\n"," Benchmarks reports will be available as new report types in the existing Offline Reporting API, with a new report for DSP (dspBenchmarks) and a separate new report for Sponsored Ads programs (crossProgramBenchmarks). The new report types will be available in the current Public Reporting API. Users can generate the new reports by passing Benchmarks specific parameters into the existing Reporting API they are familiar with.\n"," November 11, 2025\n"," The new reporting API, now available in open beta, provides programmatic access to Amazon Ads performance data. Part of Amazon Ads API v1, it follows the common model and includes:\n","Multi-dimensional Reporting: 'Report Types' are no longer required as in V3 API. Combine previously separate dimensions (for example, Geo x Technology) to create customized insights that match your business needs. - Cross-Ad Product Reporting: Create reports spanning different ad products and campaign types for a consolidated view of advertising performance that remains consistent as ad products evolve. - Cross-Account Reporting: Generate a single unified report across all accessible accounts, ideal for customers managing multiple ad accounts.\n"," This release also introduces standardized metric names, definitions, and terminology across ad products. Together, these enhancements provide greater data flexibility and a more unified reporting experience.\n"," Learn more in the reporting API overview page (Betas tab).\n"," October 31, 2025\n"," Amazon Marketing Cloud (AMC) on AWS Clean Rooms has launched open beta support for cross-region data collaboration, removing previous regional restrictions and enabling greater flexibility for global organizations. Customers can now collaborate with their partners by leveraging datasets stored in regions outside of their own, making it easier for advertisers, agencies, and third-party partners to bring their identity and event data to AMC collaborations.\n"," Key Enhancements:\n","Cross-region collaboration: Partner with organizations across different AWS regions without data movement constraints.  Upload event and identity data from any AWS Glue-supported region.  Write query results to any AWS S3-supported region. For more information, see Create membership using the AWS Clean Rooms console.\n"," October 26, 2025\n"," We have added new API capabilities that allow you to add and remove customer partners from existing Amazon Marketing Cloud (AMC) on AWS Clean Rooms collaborations without recreating the collaboration instance. These new endpoints allow you to change who can bring in data and/or receive results. This enhancement provides greater flexibility for multi-party collaborations, enabling you to adapt your data partnerships as your business needs evolve while maintaining seamless access to combined analytics and measurement capabilities.\n"," API Endpoints:\n","POST /amc/instances/{instanceId}/collaborations/{collaborationId}/acrCustomerPartners - DELETE /amc/instances/{instanceId}/collaborations/{collaborationId}/acrCustomerPartners/{acrCustomerPartnerId}\n"," For more information, refer to Adding or removing customer partners from the collaboration.\n"," October 21, 2025\n"," Amazon Live signals can now be queried in AMC for customers with US-based managed-service. These signals allow advertisers to evaluate their Amazon Live campaign performance with more flexibility and in the context of other Amazon Ads media campaigns, giving them a full-funnel view of their performance. Amazon Live signals can also be used for audience creation; these audiences can be activated to Amazon DSP (incurring a CPM fee) and select sponsored ads channels. \n"," To connect your Amazon Live media to your AMC instance, please reach out to your Amazon Ads representative. For more information on the AMC Amazon Live signals available, refer to Amazon Live traffic.\n"," October 21, 2025\n"," The Amazon Your Garage dataset, previously launched in USA (US) and Canada (CA), is now available for AMC Paid Features users in the United Kingdom (UK), Germany (DE), France (FR), Italy (IT), Spain (ES), Japan (JP), and Australia (AU). Amazon Your Garage is an Amazon Retail service that enables Amazon customers using Amazon websites in US, CA, UK, DE, FR, IT, ES, Netherlands (NL), Poland (PL), Sweden (SE), JP or AU to self-declare vehicle ownership and share that data within Amazon to expedite product discovery and configure service recommendations. AMC customers can utilize the Amazon Your Garage dataset for both measurement and audience queries within AMC.\n"," For more information, refer to Amazon Your Garage tables.\n"," October 15, 2025\n"," Amazon is launching a new Sponsored Brands feature, reserve share of voice, which enables advertisers to secure top-of-search (TOS) Sponsored Brands placements for branded keywords at a fixed, upfront price. By reserving branded keywords, advertisers ensure that their ad will appear on Sponsored Brands top of search placement for those branded queries most of the time. \n"," With this feature, brands can count on predictable presence to boost brand visibility on top of search and shoppers can engage with branded content matching their queries. The solution is fully self-service to give advertisers flexibility, autonomy, and transparency. The solution enables advertisers to receive recommendations for high traffic branded keywords, validate keywords, receive real-time pricing, launch and manage campaigns directly through the Advertising Console or API, and receive automated invoices. \n"," To get started, see the Reserve share of voice developer guide.\n"," October 14, 2025\n"," Amazon is updating its Sponsored Brands advertising campaign infrastructure, requiring advertisers to proactively migrate version 3 campaigns to version 4 by specific deadlines. Migrate campaigns with zero impressions and actively generating impressions. Advertisers must convert zero impressions campaigns created before October 2022 by October 30th, 2025, while campaigns with active impressions must complete migration by December 31st, 2025. To support this transition, advertisers can bulk migrate their campaigns through the Amazon Ad Console or Sponsored Brands migration API. For more information, see the legacy campaigns partner migration guide.\n"," October 1, 2025\n"," We have improved how branded searches are identified in attribution. Enhanced brand matching helps Amazon better recognize when shoppers are searching for advertiser products, helping to capture more accurate brand associations across all regions. Advertisers may notice new trends in their branded search metrics after this update. These improvements will be reflected in Amazon Marketing Cloud (AMC) standard attribution reporting, and will extend to custom analysis once updates are completed.\n"," October 1, 2025\n"," Goodreads is now available as a new supply source within Amazon DSP, expanding advertiser reach across Amazon Owned & Operated inventory in the U.S. All display creative formats are eligible to appear on Goodreads, encompassing Standard Display and Component-based creatives, including Responsive eCommerce, Asset-based, and Brand Store creatives. Self-service advertisers can access Goodreads inventory directly through the DSP ad console, where it is included as part of Amazon Owned & Operated Inventory.\n"," Advertising on Goodreads allows brands to reach millions of engaged U.S. readers, driving awareness and consideration. It offers a unique chance for brands to connect with an educated, discovery-oriented audience exploring diverse genres, from fiction to finance, technology, travel, wellness, and culinary arts, making it ideal for brands targeting high-intent audiences across multiple categories.\n"," Goodreads discovery and targeting are available through the following APIs:\n","Discovery Inventory Source Exchanges API \\* Targeting\n"," September 30, 2025\n"," Authors can now create and manage Sponsored Display campaigns through the Amazon Ads API. This expansion gives authors access to the full suite of Amazon advertising products, complementing existing Sponsored Products and Sponsored Brands capabilities. Authors can leverage Sponsored Display contextual and audience targeting options to reach relevant readers across Amazon properties, Twitch, IMDb, and third-party sites. With this launch, we have also added more Kindle-related metrics to our reports.\n"," September 30, 2025\n"," Amazon DSP now offers customizable flight names, enabling advertisers to better organize and track their campaign flights across the platform. This new feature allows you to assign custom names to flights, making it easier to manage complex, multi-flight campaigns and streamline reporting and budgeting workflows. This helps simplify campaign management by providing a clear way to identify and track specific flights. This enhancement is particularly valuable for agencies managing multiple clients and campaigns, enabling more efficient workflow organization and reporting processes. The feature is accessible through the following APIs:\n","Campaigns and Flights \\* Reporting\n"," September 26, 2025\n"," We have improved the DSP Bid Adjustments APIs, offering you more flexibility and control over your bidding strategies. Key updates: \n","Rule updating: You can now update existing bid adjustment rules using the UpdateBidAdjustmentRule operation. - Version tracking: Each rule update generates a new version ID, allowing you to track rule performance in BidAdjustments Reports. - Automatic migration: When a rule is updated, all associated adGroups automatically migrate to the new version, while the previous version becomes inactive. - Flexible retrieval: - AdGroup association management: Easily add or remove adGroup associations with the most recent rule version using association endpoints.\n"," These improvements help streamline bidding strategies and improve campaign performance. For implementation details and best practices, see the bid adjustment docs.\n"," September 25, 2025\n"," Amazon Marketing Stream campaign datasets have been released in closed beta. This release mimics the API model of the new Campaign Management APIs. With this launch, customers will find it easier to consume both sponsored ads and ADSP campaign data instead of subscribing to two different datasets. Customers will receive all their campaign data updates in a single stream mimicking the read operations of our Campaign Management APIs, reducing cognitive load and effort in mapping between API and Stream fields. To get started, contact your Amazon representative.\n"," September 23, 2025\n"," Amazon Marketing Cloud now offers access to NCS CPG Insights Stream dataset for creation of custom audience segments based on modeled transactions at the household level. This dataset represents over 127 million US households and provides valuable insights for CPG advertisers. Leverage this table to reach customers who purchase competitor products in your category, or engage with the top-spending customers of your brand, and much more.\n"," To get started, see the NCS CPG Insights Stream dataset and Introduction to NCS audiences (AMC UI access required).\n"," September 23, 2025\n"," Amazon Marketing Cloud has added support for the IP address field across select datasets, enabling advertisers to improve measurement coverage in scenarios where primary identifiers are unavailable. This new field provides a privacy-safe way to extend reach, frequency, overlap, and attribution analysis by using IP address as a measurement-enhancing identifier subject to applicable regional availability, customer permissions, and policy safeguards.\n"," The IP address field is valuable as a measurement enhancer in scenarios where an additional identifier can expand analysis. By allowing advertisers to analyze impressions, clicks, and conversions that would otherwise lack a linking identifier, AMC helps deliver a more complete view of audience reach and campaign performance. When combined with existing identifiers, and time based constraints, IP address can enhance accuracy while maintaining compliance with privacy requirements. \n"," For more information, refer to Introduction to IP address in AMC (AMC UI access required).\n"," September 16, 2025\n"," Amazon Marketing Cloud (AMC) is now available to all advertisers running sponsored ads campaigns. Advertisers using Sponsored Products, Sponsored Display, Sponsored Brands, or Sponsored TV will now be able to instantly access AMC within minutes. \n"," AMC is a powerful clean room tool that enables advertisers to measure campaigns, uncover actionable insights, and build audiences with advertiser signals, campaign learnings, and the trillions of shopping, browsing, and streaming signals available through Amazon. Advertisers can leverage AMC capabilities in numerous ways to maximize their advertising effectiveness. Through AMC unique signals, flexible analytics, and seamless signal collaboration, advertisers can uncover and assess insights such as identifying their most loyal customers, creating custom audiences for remarketing, and analyzing the path to conversion to adjust media investments that attract more customers — and much more.\n"," To get started, either log into the Amazon ads console and select Amazon Marketing Cloud in the left navigation, or access via API by following the steps in Instant self-service access to AMC.\n"," September 13, 2025\n"," We have expanded online video (OLV) ads on Alexa from US to JP, MX, CA, UK, BR, IN, DE, IT, FR, and ES marketplaces. This expansion will provide advertisers an opportunity to expand their reach with incremental customers on Echo Show devices, while driving awareness and consideration for their brand, with a voice-enabled OLV placement.\n"," Note: A click is recorded when the customer engages, via touch or voice, on the auto-playing online video ad on the Alexa Home Screen to launch the video ad in the full screen view.\n"," August 27, 2025\n"," Amazon DSP now allows advertisers to share frequency groups between manager accounts, providing broader control over reach and frequency across their brand portfolio. This enhancement enables advertisers to manage frequency caps across different manager accounts while maintaining individual account control and visibility.\n"," Key endpoint updates in the API include:\n","ListFrequencyGroupsV1: Added frequencyGroups list parameter and entityName field - ListFrequencyGroupAdvertiserAssociationsV1: Added entityName and entityId attributes - ListFrequencyGroupCampaignAssociationsV1: Added entityName and entityId attributes\n"," For full technical details, see the specifications for the frequency groups and frequency group associations APIs.\n"," August 22, 2025\n"," Sponsored Brands introduces two new Amazon-built audiences to help advertisers re-engage with valuable shopper segments: \"Purchased brand product\" and \"Clicked or Added brand product to cart\". These audiences complement the existing \"New-to-brand shoppers\" audience, giving advertisers more options to optimize their campaigns through audience bid adjustments.\n"," Advertisers can utilize audience bid boosting on both new and existing Sponsored Brands campaigns. To assess the performance of their bid boosted audiences, advertisers can access the Audience Report through the SB API Reporting. \n"," To retrieve Amazon-built audiences, use the Discovery API ListTargetableEntities with the following parameters: adProduct=SPONSORED_BRANDS, targetTypeFilter=AUDIENCE, and pathsFilter = \\[\\[\"Audience Category\", \"Custom-built\", \"Product\"]]. The response will include the audienceId for these audiences, which can then be used with Sponsored Brands Campaign Management API to create or adjust the bids for the audience. Amazon-built audiences retrieved using these filters are usable only with AudienceSegmentType of BEHAVIOR_DYNAMIC when using the campaign management API. For full technical details, see our updated Sponsored Brands documentation.\n"," August 21, 2025\n"," We have expanded Responsive eCommerce on Alexa ads to FR, ES, IN, and BR. Now ADSP-Self Service buyers can include Alexa supply in their campaigns and deliver engaging Responsive eCommerce ads to new customers.\n"," August 7, 2025\n"," Amazon DSP has launched Performance+ Insights, a new feature that provides advertisers with detailed transparency into their machine learning-generated audience targeting through two key components: (1) Shopper Insights that reveal the behavioral patterns and characteristics of customers reached by automated targeting (such as \"premium sports shoes purchasers\" or \"enjoy sports content\") and (2) Time-to-Convert metrics that display the median time between ad interaction and the attributed conversion. \n"," The Performance+ Insights feature is important for marketers because it addresses a critical trust deficit by providing transparency into ML-generated audience composition and performance. By revealing detailed audience behavioral traits and conversion metrics, marketers gain visibility into previously \"black box\" targeting mechanisms, allowing them to validate that their ads are reaching relevant audiences and converting effectively.\n"," For more information about the new campaign insights API endpoint, view the technical specification.\n"," July 29, 2025\n"," With the launch of Sponsored Product Ads on Amazon Global store, API advertisers can now drive more discoverability and improve sales internationally. In this launch phase, we enabled this capability for advertisers in US, UK, and Germany. Log into your seller account to learn more about Global Store. \n","Product Localization /products/localize  Sponsored Products Ads now extends its product localization capabilities to include GlobalStore products, allowing products to be mapped from a source marketplace to one or more target marketplaces. This enhancement enables advertisers to expand their reach across multiple marketplaces through both local and GlobalStore products. To support GlobalStore products, the API response includes additional fields:  Campaign Creation /global/productAds SP API or product ads now support the global store specific features for the Global campaign creation. Global Sponsored product ad creation API accepts the global store specific attribute globalStoreSetting where advertisers can provide the source catalog country of the offer being used for ads creation. Eligibility check of the products for campaign creation would be done using the catalogSourceCountryCode information provided using the globalStoreSetting under CountryAdSubjectSettings.  Global Bid Recommendation /sp/targets/bid/recommendations The Global Bid recommendations API now support the features of the bid recommendation for the Global Store listings. The Global Bid recommendation API for new Ad group supports a new attribute called products that takes the ASIN details along with its source country code. Bidding system uses the globalStoreSetting attribute and the catalogSourceCountryCode information to check the eligibility of the ASINs that are required for the bid recommendation. \\* Global Keyword Recommendation /sp/global/targets/keywords/recommendations The Global Keywords recommendation API now support the features of the keyword recommendation for the Global Store listings. The Global Keywords recommendation API for ASINs supports a new attribute called products that takes the ASIN details along with its source country code. Global Keywords recommendation system uses the globalStoreSetting attribute and the catalogSourceCountryCode information to get the bid suggestions for the keywords.\n"," July 28, 2025\n"," In September 2023, we launched frequency groups for self-service entities in the Amazon advertising console, enabling advertisers to set a frequency cap across multiple orders. With this launch, we are expanding frequency groups to the Amazon DSP Public API, so advertisers can easily create and update frequency groups via the Amazon Ads API.\n"," Brands need broader frequency capping controls to limit the number of times a unique user is exposed to their brands across multiple orders in Amazon DSP, as users could be overexposed to ads when different orders target similar or overlapping audiences. With Hybrid Frequency Caps, advertisers can better manage frequency across their brand portfolio while optimizing campaign performance, such as setting streaming TV frequency caps across specific brands by selecting only streaming TV orders within their frequency groups, helping prevent ad overexposure and maximize budget efficiency, with advertisers seeing an average 6% lift in unique user reach when using Frequency groups to manage frequency across multiple orders in Amazon DSP.\n"," For full technical information, see the API specifications for frequency groups and the frequency group associations.\n"," July 19, 2025\n"," We are introducing a smarter way to manage your campaign budgets within portfolios. Now, when some campaigns do not use their full daily budget, that unspent campaign budget will not go to waste. Instead, it can automatically flow to other campaigns in your portfolio that consistently reach their daily spending limits.\n"," This intelligent budget sharing system allows high-performing campaigns to spend up to twice their daily budget by tapping into unspent campaign budget from previous days in the month. This all happens while staying within your total monthly portfolio budget.\n"," This enhancement helps you capitalize on high-traffic days and maintain momentum when certain campaigns are performing well. Your successful campaigns can keep running longer, generating more clicks, impressions, and sales opportunities that might otherwise have been missed.\n"," Implementing this feature is straightforward. Simply access your budgetControls settings and set the campaignUnspentBudgetSharing feature to ENABLED or DISABLED, depending on your preference. Whether you are a vendor, registered seller, managed-service customer, self-service customer, or author, this feature is available to help optimize your advertising performance.\n"," For step-by-step guidance on setting up and managing this feature, please refer to the User Guide.  \n"," The launch is available in the following geographical areas. \n"," July 15, 2025\n"," Sponsored products campaigns will now be automatically integrated into shopping conversations when customers chat with Alexa+ about products. Customers can discover relevant products when asking Alexa for product recommendations, receiving a mix of organic and sponsored options. Advertisers with active Sponsored Products campaigns may be eligible to appear on Alexa+ as part of Amazon expanded advertising surfaces, helping you connect with customers wherever they shop on Amazon with no additional requirements. Performance metrics will be consolidated within existing reporting dashboards. At this time, Sponsored Products on Alexa+ is only available on the Echo Show. Following the exciting announcement about Alexa+, our next-generation conversational AI assistant, Alexa+ brings a more natural, context-aware conversation experience to users, and this opens up new opportunities for advertisers to engage with customers during their shopping journey.\n"," July 13, 2025\n"," As part of our continued enhancements to the Amazon DSP APIs, we are deprecating several legacy endpoints across Campaign Management, Reporting, and Creatives Management. The deprecation date for the Campaign Management API has been extended to September 30, 2025 (previously June 30, 2025), while the legacy ADSP Reporting API and the legacy Creatives Management API will also be deprecated on September 30, 2025. You can find the full list of deprecated and replacement endpoints on our Deprecations page. For upgrade guidance, refer to the various migration guides for Campaign, Creative and Reporting. If you have questions or need support, submit a ticket via the Amazon Ads API Support page with the subject “ADSP APIs Migration” or contact your account team or use the standard support channels. We recommend migrating early to ensure uninterrupted access and to take advantage of the latest API capabilities.\n"," July 11, 2025\n"," We have launched minute grain frequency caps in Amazon DSP, allowing advertisers to set frequency caps in 10-minute increments (for example, 10, 20, 30, 40, and 50 minutes). This enhancement provides significantly finer control than the previous hourly or daily options, addressing a critical request from customers seeking to prevent ad repetition with greater precision.\n"," Minute grain frequency caps help prevent ad fatigue by controlling how frequently users see ads within shorter time intervals. This granular control is especially valuable for high-impact streaming TV campaigns and time-sensitive promotions where multiple impressions in quick succession can diminish effectiveness. By distributing impressions more optimally, advertisers can improve budget efficiency and brand engagement.\n"," Minute grain frequency caps are accessible through existing campaign management API endpoints. The feature maintains backward compatibility with all existing frequency cap implementations. For full technical details, read our API documentation.\n"," July 9, 2025\n"," Sponsored Brands is now available to all authors, including those with a single title. Create engaging custom image and video ads to drive awareness and boost your book visibility. To learn more about Sponsored Brands, see the Sponsored Brands overview.\n"," July 7, 2025\n"," Your portfolios can now automatically share their unspent campaign budget, accumulated from previous days in the month, with other campaigns in the same portfolio that have already spent their full daily budget, to enable them to spend more (up to 100% over their daily budget). This system allows you to benefit from high traffic days by keeping campaigns in budget longer. \n"," This launch automatically uses unspent campaign budget on campaigns that consistently run out of their own daily budget, enabling them to keep delivering ads and earning you more clicks, impressions, and sales, all without increasing your overall total monthly campaign budget. Users can now set the unspent campaign budget sharing option to on or off by setting featureState for campaignUnspentBudgetSharing as DISABLED/ENABLED inside budgetControls. Reference the user guide for more details. \n"," This feature is available to customers who are vendors, registered sellers, customers from managed-service, self-service, and authors.  \n"," The launch is available in the following geographical areas:\n","North America: United States, Canada, Mexico  South America: Brazil  Europe: Germany, Spain, France, Italy, United Kingdom, Belgium, Switzerland, Poland, Turkey, Austria, Netherlands, Sweden, Finland, Norway, Ireland, Denmark, Luxembourg  Middle East: Saudi Arabia, United Arab Emirates, Israel, Egypt, Morocco, Bahrain, Kuwait  Asia Pacific: Australia, India, Japan, New Zealand, China, Singapore\n"," July 7, 2025\n"," Customers using the DSP Bid Adjustments APIs can now target specific supply sources, source type, and deals to upscale or downscale their bids. This enables customers to more finely tune the parameters of their bidding to their specific use case and increase their campaign performance.\n"," For more details, see the three new dimensions -- dealId, supplySource, supplySourceType -- in the bid adjustment dimensions guide.\n"," June 27, 2025\n"," Sponsored ads have now launched in Ireland. Eligible sellers and vendors can now leverage Sponsored Products, Sponsored Brands and Stores on Amazon.ie and via the Amazon Ads API.\n"," June 19, 2025\n"," Advertisers can now apply bid adjustments up to 900% for the top search placements in their Sponsored Brands campaigns. Bid adjustments for rest of search placements, which were previously limited to up to 99% can now also be adjusted up to 900%. These updates are available for all ad formats, including video, and all targeting types (keyword and product), and can be used with existing bidding controls (manual bidding, cost controls, audience-level bid adjustments). \n"," The updated placement-level bid adjustment controls will allow advertisers to optimize campaign performance and execute different strategies across search placements. Advertisers will be able view placement-level metrics in the advertising console or can leverage existing Sponsored Brands Placement reports to understand how their campaigns are performing in specific placements, then use the top of search and rest of search placement bid adjustment controls to fine-tune bids to meet their campaign goals. \n"," Top of search and rest of search placement bid adjustment controls will be available for Sponsored Brands campaigns via the Amazon Ads API. For full technical details, see the updated Sponsored Brands API specification.\n"," June 12, 2025\n"," Advertisers using the Amazon Ads API can now create Sponsored Brands campaigns that exclusively reach business shoppers on Amazon Business, available in Amazon Business Marketplaces - US, CA, MX, DE, IT, FR, ES, UK, IN, JP. To create Amazon Business exclusive campaigns, advertisers will need to set the site Restrictions field in the campaign setting to AMAZON_BUSINESS. Advertisers can drive brand awareness across business shoppers and customize their B2B advertising strategy by setting a B2B budget, using B2B keywords, B2B creatives, and B2B-specific store pages, and adjusting bids to increase sales on Amazon Business. All campaign settings apply exclusively to Amazon Business, and ads will only appear on the Amazon Business store. The Sponsored Brands reports will reflect performance solely on Amazon Business, enabling advertisers to evaluate results and optimize their B2B campaign strategies. See our reference documentation for more information.\n"," June 5, 2025\n"," Long term sales metrics are available in campaign reporting. Long term sales (LTS) and long term sales ROAS (LTS ROAS) are ad-attributed measures that estimate the incremental sales value your brand can expect to generate over the next 12 months, based on how effectively your advertising campaigns are able to move new-to-brand shoppers further down your purchase funnel. This is based on the historical 12-month return of a given customer engagement with your brand. Customer engagements include detail page views, branded searches, add-to-carts, and purchases. Shoppers are new to brand if they have not completed a conversion with a brand in the last 12 months.\n"," For more information, see our updated campaign reports overview.\n"," June 2, 2025\n"," The Posts API will be discontinued as of June 3, 2025. New users will no longer be able to make requests to the Posts API; existing Posts users should expect new Posts creation to be discontinued after June 16, 2025, and a full shut-off date of July 31, 2025. We encourage customers to explore our suite of sponsored advertising solutions as we continue to build and experiment with new creative formats.\n"," May 30, 2025\n"," We have expanded our content transparency reports on Streaming TV to report ad-impressions delivered on Twitch. Advertisers can now see which Content Type, Rating and Title their Twitch ad impressions were delivered on to now assess if their ads were contextually relevant and use the reporting data to plan their future media investments and adjust their campaign settings.\n"," Content Type, Rating and Title traffic reporting are now available in ADSP downloadable reports under the Audio and Video dimension. For full technical details, please see the audio and video reports guide.\n"," May 29, 2025\n"," The Amazon Retail Purchases (ARP) dataset gives AMC customers 5 years (60 months) of historical Amazon store purchase signals across the advertiser catalog of products, regardless of media investment against those products. AMC customers in US/CA/JP/AU regions can now use this AMC dataset for audience creation purposes. To get started, see the Instructional Query (AMC UI access required).\n"," May 29, 2025\n"," We have added a new content section to the advanced tools center: Betas. The new section will host information about the forthcoming Amazon Ads API v1 as well as specifications and guides for new resource APIs in both open and closed beta stages. To learn more, visit Betas.\n"," May 28, 2025\n"," We have extended the Partner Opportunities API so you can filter for specific advertisers you manage. Partner Opportunities continues to provide you scaled access to insights and recommendations for your advertising clients like unlaunched ASINs and click credit promotions. With this launch, you can provide an advertiser ID or profile ID when listing opportunities (GET /partnerOpportunities) and quickly see which opportunities have results for the specified advertisers. \n"," Whether you want to determine which cohorts of your advertising clients have opportunities available or pinpoint results for a single target advertiser, can structure your call pattern to find the right balance for you. Now, you can use the optional advertiserId or profileId filters, see which partner opportunities align with the provided advertisers, then access the detailed recommendation and insights as you always have. For more information, see our API documentation.\n"," Partner Opportunities API is available worldwide to all registered partners. See the overview guide for more information.\n"," May 22, 2025\n"," We have expanded negative targeting so every campaign and ad group has the same options, regardless of targeting type. Now you can negatively target a keyword, ASIN, or brand during campaign creation or on any existing campaign or ad group. Negatively targeting a keyword prevents your ad from showing on search results pages for that keyword, while ASIN and brand negative targeting prevents your ad from showing on the product detail page for that ASIN or ASINs with that brand.\n"," Advertisers might have certain business rules they want to implement but execution was inconsistent across different targeting types. Now, advertisers will have consistent and clear control of negative targets, helping reduce confusion and operational overhead. \n"," API: Now you can succeed saving negative keywords, products, and brands on campaigns and ad groups regardless of targeting type. Learn more: Negative keyword targeting and Sponsored Products negative product and brand targeting overview.\n"," May 22, 2025\n"," We have launched a new API solution that enables programmatic access to Amazon Marketing Mix Modeling (MMM) data feed. This new API is available in 13 countries: US, CA, IT, ES, FR, DE, UK, MX, BR, JP, AU, UAE, and KSA. This launch allows advertisers and their partners to seamlessly access the advertising and retail signals needed to derive accurate insights from their MMM solutions. \n"," This API access streamlines data delivery for advertisers and their MMM partners, reducing manual data exchange efforts, and enabling more frequent, reliable and accurate MMM analysis. \n"," Three API operations are available for MMM management: \n","Request the list of brands you can pull data for: POST /mmm/v1/brandGroups/list  Request the MMM feed for a given brand: POST /mmm/v1/reports  Check the status of a MMM feed request: GET /mmm/v1/reports/{reportId}\n"," For full technical details, see the MMM API user guide and the technical specifications.\n"," May 18, 2025\n"," We have launched the ability to create and assign SSP Seat IDs to individual Amazon DSP advertisers worldwide. With this release, Amazon DSP users can request seats to be created for any advertiser they manage. The SSP Seat IDs are instantly usable to ingest advertiser-specific deals (wherever Amazon DSP automatically ingests them), and are applied within 24 hours to existing line items for the purpose of spend tracking.\n"," SSP Seat IDs by advertisers make it easier for Amazon DSP users to manage scenarios where deals created for specific advertisers must be kept separate from other advertisers (for example, to protect advertiser negotiated CPM rates). They in turn enable spend tracking IDs at the advertiser level, allowing SSPs more granular spend reporting and buyer validation.\n"," For more information, see the technical specifications for the seats API and the seat IDs API.\n"," May 14, 2025\n"," The new Prime Video Insights (PVCI) dataset in AMC allows channel partners to join their own datasets with the Prime Video Channel viewership data associated with their channels. This new dataset can be used for measurement and activation use cases. To get started, see the dataset documentation and the IQ First-streamed titles for Prime Video Channel subscription starts (AMC UI access required).\n"," April 24, 2025\n"," Advertisers using the Amazon Ads API can now create Sponsored Products campaigns that exclusively reach business shoppers on Amazon Business, available in Amazon Business Marketplaces - US, CA, MX, DE, IT, FR, ES, UK, IN, JP. To create Amazon Business exclusive campaigns, advertisers will need to set the siteRestrictions field in the campaign setting to AMAZON_BUSINESS. Advertisers can customize their business-to-business (B2B) advertising strategy by setting a B2B budget, promoting ASINs they want to showcase to B2B shoppers, using B2B keywords, and adjusting bids as well as bidding strategies to increase sales on Amazon Business. All campaign settings are uniquely applied to Amazon Business and these campaigns will only be shown on the Amazon Business store. All existing Sponsored Products reports will reflect performance only on Amazon Business. Advertisers can leverage these reports to review campaign performance on Amazon Business. See our reference documentation for more information.\n"," April 20, 2025\n"," Amazon Marketing Stream has expanded the ADSP Performance dataset to provide advertisers and developers with richer, and more actionable insights:\n","ADSP Conversions dataset now includes Brand Halo metrics, enabling measurement of downstream purchases attributed to brand exposure, even if the purchase occurred in a different product line. - ADSP Clickstream dataset has been enhanced to include Off-Amazon conversions and Video metrics, offering a more comprehensive view of customer engagement beyond Amazon owned and operated properties.\n"," These updates help advertisers better understand the full impact of their campaigns and optimize spend based on more complete performance signals. To learn more, visit the ADSP Performance dataset section of the Amazon Marketing Stream Developer Guide.\n"," April 18, 2025\n"," Amazon Ads has introduced the Well-Architected Framework, enabling developers to build secure, high-performing, and scalable advertising solutions. This framework addresses common integration challenges and accelerates the development of reliable advertising solutions.\n"," The framework includes three key components:\n","Design Principles: Core architectural guidelines for robust solutions - Best Practices: Proven API integration patterns for optimal performance - Implementation Guidance: Step-by-step technical solutions for seamless integration\n"," Getting Started: To get started with the Well-Architected Framework, visit our technical documentation.\n"," April 17, 2025\n"," Sponsored Brands has launched a migration API to help advertisers transition from V3 (legacy) campaigns to V4 (ad group-based)campaigns, which address the complexity of campaign management. The API provides strategic migration pathways for campaigns with no impressions over 180 days, mandating migration or archival by June 30, 2025, otherwise Amazon will archive these campaigns by July 31, 2025. The impression-generating campaigns are required to migrate by September 30, 2025, or face automatic migration by Amazon by December 31, 2025. \n"," The V4 campaigns enable advertisers to leverage advanced machine learning, the theme targeting feature automatically generates and categorizes keywords based on historical performance and brand interactions, offering two pre-configured targeting groups (keywords related to landing pages and brand) that simplify campaign optimization and improve campaign performance.\n"," The migration API is available in US, CA, MX, BR, JP, SG, AU, UK, DE, FR, IT, ES, NL, AE, IN, SA, SE, PL, TR, EG, SG, and ZA. For more information, see the updated Sponsored Brands API specification or refer to our developer guide for the migration API.\n"," April 17, 2025\n"," Sponsored Brands has introduced new headline capabilities allowing advertisers to use dynamic creative optimization (DCO) to improve ad personalization. Advertisers can consent to leveraging DCO during a campaign to enhance or generate new headlines to help better match customer intent. Based on internal testing, headline text optimization can drive up to 1.6% CTR lift vs. non-optimized campaigns.\n"," Advertisers can access headline optimization via the Amazon Ads API by specifying the optional property creativePropertiesToOptimize with a value of \\[ \"HEADLINE\" ] on Product Collection or Store Spotlight creatives in Sponsored Brands.\n"," The feature is enabled for four operations in the Sponsored Brands API. For more information, see the technical specifications for the following:\n","POST /sb/v4/ads/productCollectionExtended  - POST /sb/v4/ads/storeSpotlight - POST /sb/ads/creatives/productCollectionExtended - POST /sb/ads/creatives/storeSpotlight\n"," April 14, 2025\n"," Amazon DSP Bid adjustments support both simple adjustments and complex bidding algorithms through single and multi-dimensional specifications. This means advertisers can now maintain nuanced and tailored bidding within a single line item, while still taking full advantage of Amazon DSP automated bid optimization.\n"," With this launch, we have also released bid adjustments reporting, now available through the reporting API. Availability in the ADSP Report Center will follow shortly. In the console, you can also bulk apply bid adjustments to up to 10 line items from the campaign table on Advertiser and Order page. \n"," You can also access bid adjustments through our API. For full technical details, see our bid adjustments API, detailed developer guide, and new dspBidAdjustment report type available through the reporting API.\n"," April 9, 2025\n"," With global seats, Amazon DSP users can now register once and buy ads in every country where Amazon DSP operates. Users can create country specific advertiser accounts, receive invoices from a single Amazon legal entity for their global spend, and can create consolidated reports for their spend regionally.\n"," Global Manager Accounts will be available in three regions: NA, EU, and FE. The Calling Profiles API returns only the Profile ID of the manager account for the regional endpoint you are calling. Choose the region you would like to make changes in and select the corresponding API endpoint:\n","NA → https&#x3A;//advertising-api.amazon.com  EU → https&#x3A;//advertising-api-eu.amazon.com  FE → https&#x3A;//advertising-api-fe.amazon.com\n"," For more information, see Account management>Profiles.\n"," April 4, 2025\n"," Sponsored Display is enhancing the machine learning algorithm to find improved conversion opportunities and help drive incremental sales for Reach and Page Visit campaigns, moving these campaigns to align with the optimization objective of Sponsored Display Conversion campaigns. With this change, advertisers who have active Reach and Page Visit campaigns are likely to observe increases in performance metrics associated with these campaigns. For more information, see Sponsored Display: Bid optimization.\n"," April 2, 2025\n"," The new Amazon Retail Purchases (ARP) dataset in AMC gives AMC customers 5 years (60 months) of historical Amazon store purchase signals across the advertiser catalog of products,  regardless of media investment against those products. This new dataset can only be used for measurement use cases. To get started, see the technical documentation and the Instructional Query.\n"," March 31, 2025\n"," We will deprecate Amazon Ad Server tables in AMC on June 30, 2025. After these tables and fields are deprecated, any workflows using these tables/fields will fail. For more details, see the deprecation notice of Amazon Ad Server tables in AMC.\n"," March 24, 2025\n"," Sponsored Brands is introducing a new Amazon-built audience segment - \"New-to-brand shoppers\" - that advertisers can leverage for bid boosting to acquire new customers. This audience includes shoppers who have not purchased from the brand in the last 12 months. \n"," Advertisers can utilize the NTB audience bid boosting on both new and existing Sponsored Brands campaigns. To assess the performance of their bid-boosted NTB audience, advertisers can access the Audience report through the reporting API. \n"," To retrieve Amazon-built audiences, you will use the Discovery API ListTargetableEntities with the following parameters: adProduct = SPONSORED_BRANDS, targetTypeFilter = \\[AUDIENCE], and pathsFilter = \\[\\[\"Audience Category\", \"Custom-built\", \"Product\"]]. The response will have the audienceId for new-to-brand shoppers, which can then be used with Sponsored Brands campaign management API to create and adjust the bids for the audience. Note that Amazon-built audiences retrieved using these filters are only usable with AudienceSegmentType of BEHAVIOR_DYNAMIC when using the campaign management API. For more information, see our guide to shopper cohort bidding.\n"," March 20, 2025\n"," By blending SEO best practices with rich customer insights, this playbook helps advertisers identify high-impact keywords, optimize budget allocation, simplify management, and drive brand growth. To get started, see Keyword clustering playbook.\n"," March 20, 2025\n"," Advertiser Data Upload (ADU) APIs enable you to create first-party audience segments in AMC using advertiser audiences. For more information, see Advertiser audience using ADU.\n"," March 18, 2025\n"," Sponsored TV has simplified cost per thousand impressions (CPM) updates for advertisers that do not sell in the Amazon store. Advertisers will now choose a maximum average CPM at the ad group level rather than for each targeting selection. For technical details, see the updated Sponsored TV API specification.\n"," March 15, 2025\n"," By uploading hashed customer information through the ADU APIs, you can create rule-based audiences and activate them directly in Amazon DSP for highly targeted advertising campaigns. For more details, see Create advertiser audiences with Amazon ADU APIs.\n"," Also, see our updated Postman collection, to test AMC administration, reporting (workflow management), and AMC audiences endpoints.\n"," March 15, 2025\n"," Amazon DSP self-service advertisers in US can now book Fire TV Inline Display Banner campaigns across eligible unguaranteed placements on Home, Live, and Games tabs. These banners expand to \"Mini-Details\" view when users scroll past, taking up half the screen. They support 10-30s video with sound and various click-through destinations helping increase reach, awareness, and consideration. For full technical details, please read our API documentation.\n"," March 12, 2025\n"," This capability is in preview only. We will update our release notes once this functionality is made available. Sponsored Products is introducing three new Amazon-built audience segments - \"Purchased brand products\", \"Clicked or added brand product to cart,\" and \"Affinity for similar products\" - that advertisers can leverage for bid boosting to increase their engagement with these highly relevant cohorts of shoppers.\n"," Advertisers can utilize the audience bid boosting on both new and existing Sponsored Products campaigns. To assess the performance of their bid boosted audience, advertisers can access the Audience Report through the reporting API.\n"," To retrieve Amazon-built audiences, you will use the Discovery API ListTargetableEntities with the following parameters: adProduct = SPONSORED_PRODUCTS, targetTypeFilter = \\[AUDIENCE], and pathsFilter = \\[\\[\"Audience Category\", \"Custom-built\", \"Product\"]]. The response will include an audienceId and audienceResolved (the name) for each of the three new audiences, which can then be used with the Sponsored Products campaign management API to create and adjust the bids for the audience. Note that Amazon-built audiences retrieved using these filters are only usable with audienceSegmentType of BEHAVIOR_DYNAMIC when using the campaign management API. Also note that audienceSegmentType has been made optional in campaign creation, and the API will add the correct audience segment type based on the audience ID.\n"," February 28, 2025\n"," This capability is in preview only. We will update our release notes and API documentation once this functionality is made available. Sponsored Brands is introducing a new Amazon-built audience segment - \"New-to-brand shoppers\" - that advertisers can leverage for bid boosting to acquire new customers. This audience includes shoppers who have not purchased from the brand in the last 12 months. \n"," With this new feature, advertisers will have the ability to apply bid adjustments on the New-To-Brand Shoppers audience to increase reach in this valuable segment and drive orders from new customers. Advertisers can utilize the NTB audience bid boosting on both new and existing Sponsored Brands campaigns. To assess the performance of their bid boosted NTB audience, advertisers can access the Audience Report through the SB API Reporting. \n"," To retrieve Amazon-built audiences, you will use the Discovery API ListTargetableEntities with the following parameters: adProduct = SPONSORED_PRODUCTS, targetTypeFilter = \\[AUDIENCE], and pathsFilter = \\[\\[\"Audience Category\", \"Custom-built\", \"Product\"]]. The response will have the audienceId for new-to-brand-shoppers which can then be used with Sponsored Brands Campaign Management API to create and adjust the bids for the audience. Note that Amazon-built audiences retrieved using these filters are only usable with AudienceSegmentType of BEHAVIOR_DYNAMIC when using the campaign management API. For full technical details, see our updated Sponsored Brands documentation.\n"," February 21, 2025\n"," We have published a step-by-step guide and IaC templates to help you stream Amazon Marketing Stream data to Snowflake. You can implement the solution across AWS, Azure, or Google Cloud with our ready-to-use code templates. To learn more, see the implementation guide.\n"," February 19, 2025\n"," Ads data manager expands support for advertiser first-party data uploads through Conversions API (C-API) and adds Amazon Marketing Cloud (AMC) as a destination for all supported datasets. The enhancement unifies data management across C-API and Advertiser Audience APIs, and includes partner-facilitated uploads, with all datasets accessible through the Ads data manager console and the Ads data manager APIs. \n"," Advertisers can leverage audience data via Amazon DSP, and C-API events will be available for conversion attribution through the Events Manager. All audience and events datasets managed through Ads data manager will be available for access in AMC when creating a destination linked to your AMC instance within Ads data manager.\n"," February 15, 2025\n"," Following the launch of audience bid adjustments for Sponsored Products and Sponsored Brands, integrators can now view audience bid adjustment details for campaigns in both exports APIs and Amazon Marketing Stream.\n"," For exports, the new fields are available using POST/campaigns/export as part of the optimizations.shopperSegmentBidAdjustment object. See Common models for more information.\n"," For Stream, the new fields are available in the campaigns dataset as part of the bidSetting.shopperCohortBidAdjustment object.\n"," February 10, 2025\n"," AMC is excited to announce the launch of automated approvals for instance creation and advertiser inclusion requests in their instances. This launch will allow any eligible advertiser or partner to self-provision AMC through the instance management APIs, reducing onboarding time from a 2-day SLA to instant approval.\n"," Read automated instance approval and advertiser inclusion process to learn more.\n"," January 24, 2025\n"," Amazon Ad Server was sunset in Q4 2024, and all resources describing the relevant datasources have been moved to the Deprecated resources section of the Advanced tools center portal.\n"," January 24, 2025\n"," The migration from the AMC instance-level APIs to the new AMC APIs on the Amazon Ads API is now complete and the resources to help you migrate have been consolidated and moved to the Deprecated resources section of the Advanced tools center portal.\n"," January 24, 2025\n"," Advertisers who use audience bid boosting can now access audience bid boosting reports via the Amazon Ads API. Using bid boosting, advertisers can create custom audiences, such as shoppers who have not previously purchased their product and shoppers who were exposed to their streaming TV campaigns. Advertisers can adjust their bids for these audiences to help drive greater product discovery and sales. For more information on audience bid boosting reports, see the Audience report type documentation.\n"," January 23, 2025\n"," The Amazon DSP campaign management APIs are deprecating several enum values for the inventoryType field on POST/dsp/v1/adGroups. After June 30, 2025, users will no longer be able to create ad groups where inventoryType equals STANDARD_DISPLAY, AAP_MOBILE_APP, AMAZON_MOBILE_DISPLAY, or VIDEO. Instead users should use the newer options below:\n","|Endpoint\t|Legacy inventoryType\t|New inventoryType\t|Legacy inventoryType deprecation date\t|\n","|---\t|---\t|---\t|---\t|\n","|POST/dsp/v1/adGroups\t|STANDARD_DISPLAY\t|DISPLAY\t|6/30/2025\t|\n","|POST/dsp/v1/adGroups\t|AMAZON_MOBILE_DISPLAY\t|DISPLAY\t|6/30/2025\t|\n","|POST/dsp/v1/adGroups\t|AAP_MOBILE_APP\t|DISPLAY\t|6/30/2025\t|\n","|POST/dsp/v1/adGroups\t|VIDEO\t|ONLINE_VIDEO or STREAMING_TV\t|6/30/2025\t|\n"," Please contact our support team with any questions or feedback.\n"," January 16, 2025\n"," Amazon DSP advertisers now gain a unified view of reach and frequency, deduplicating audiences exposed to ads across different publishers, channels, and devices.\n"," Advertiser-level reach and frequency metrics provide unified insights that help advertisers understand their total unique reach across all of their Amazon Ads investments. These metrics eliminate overlapping audience counts across multiple devices and ad formats, revealing the true size of the delivered audience.\n"," You can now access the metric through the reach and frequency report through V3 reporting. For full technical details, please see our v3 reporting documentation.\n"," January 16, 2025\n"," The launch of frequency group-level reach allows advertisers the ability to set a single frequency cap to control ad exposure across multiple orders in a campaign. Complementing this feature, new reporting provides combined deduplicated reach and frequency metrics at the frequency group-level.\n"," Cross-order reach and frequency reporting provides advertisers with a unified, deduplicated view of frequency metrics across all orders within a frequency group. This consolidated reporting eliminates double-counting of audiences exposed to ads from different orders, enabling advertisers to analyze the impact of the frequency group.\n"," You can now access the metric through the reach and frequency report through V3 reporting. For full technical details, please see our v3 reporting documentation.\n"," January 14, 2025\n"," In October, we announced the launch of Amazon DSP campaign and creative management APIs in beta. These endpoints are now generally available worldwide for Amazon DSP users and their technology partners.\n"," The campaign and creative management resources enable users to create, read and update their Amazon DSP campaigns and creatives via a programmatic interface. Technology providers and advertisers can use these resources to develop new trader experiences within their own applications and manage Amazon DSP campaigns within their existing workflows. To enable end-to-end campaign management, these new resources can be used together with the audience and deal endpoints.\n"," With this release, we are adding a targetId field to /dsp/v1/targets:\n","When creating a new target via POST/dsp/v1/targets, every successfully created target will have a targetId.  When listing targets via POST/dsp/v1/targets/list, all listed targets will contain a targetId.  A new endpoint, POST/dsp/v1/targets/delete, enables users to remove targets from ad groups using targetId. This endpoint can be used instead of POST/dsp/v1/targets/deleteByObject for a more efficient delete operation.\n"," For more information, refer to these links:\n","|Campaign Management \t|Creative Management\t|Creative Associations\t|\n","|---\t|---\t|---\t|\n","|Developer guide\t|Developer guide\t|Developer guide\t|\n","|Migration guide  \t|Migration guide\t|Migration guide\t|\n","|Reference documentation \t|Reference documentation\t|Reference documentation\t|\n"," January 14, 2025\n"," With the launch of our new Amazon DSP campaign management APIs, we are deprecating the previous version of the campaign management APIs. Previously we announced a deprecation date of March 31, 2025. We are extending this deprecation date to June 30, 2025. The full list of APIs being deprecated can be found on our deprecations page.\n"," January 8, 2025\n"," The version 3 reporting API has a new workflow that enables pulling reports at the individual advertiser level. This new workflow supports these use cases:\n","Advertisers who utilize Amazon managed service and wish to pull performance reporting for their managed service campaigns. \\* Agencies who want to give reporting access for a subset of advertisers they manage instead of all their advertisers.\n"," For more information on this workflow, please review our guide to pulling Amazon DSP reports.\n"," January 1, 2025\n"," We have introduced a new API to facilitate the retrieval of advertising billing promotion data and its corresponding consumption metrics across invoices. This new functionality enhances our existing billing API, enabling customers to programmatically retrieve their promotions data and gain visibility on which invoices have consumed it.\n"," This enhancement is crucial for customers to enhance visibility and transparency into promotions. The new API eliminates the need for customers to manually review each individual invoice to determine if a specific promotion has been consumed. Instead, customers can now access this information programmatically, empowering them to make more informed decisions regarding their advertising expenditures and performance.\n"," For more information, see our API documentation.\n"," December 16, 2024\n"," The playbook Enhanced scoring for overlapping AMC audiences will guide you through the process of integrating the powerful capabilities of Amazon Marketing Cloud (AMC) with the persona builder API to deliver comprehensive audience insights. It guides you through the process of identifying AMC audiences and leveraging the persona builder API to identify additional audience attributes across top retail categories, top overlapping audiences, estimated size, top demographics, and Prime Video insights. All the results are accompanied with an affinity score that refers to the likelihood and a percentage score that refers to the percentage of the customers on the above categories. The derived insights will help you build a holistic approach of audience performance.\n"," To get started, see Enhanced scoring for overlapping AMC audiences.\n"," December 16, 2024\n"," AMC on AWS Clean Rooms self-serve instance creation APIs now allow you to create a multi-party collaboration instance. With this update, advertisers or partners with data stored across multiple AWS accounts can include up to two additional AWS account IDs in the collaboration instance. This enables AMC to query data or create audiences from these associated AWS accounts.\n"," For more details, see Create an AWS Clean Rooms backed AMC instance.\n"," December 15, 2024\n"," We have introduced a new feature that allows advertisers to select and set any of their owned seller accounts as the seller payable payment method globally. They can now also choose one or more seller payable payment methods during registration. This functionality is available for both registration and payment method updates.\n"," This launch enables public API clients to retrieve eligible seller accounts and seamlessly register or update advertiser payment methods, allowing the advertiser to set one or multiple preferred seller accounts.\n","This API now provides a list of seller payable payment methods contains seller account and country code that an advertiser is eligible to register.\n","This API now accepts seller account and country code that can be used to register or update the advertiser payment method.\n","This API now returns seller account and country code that registered by the advertiser.\n","This API now allows advertiser to select specific seller account and country code to set as their default payment method.\n"," December 15, 2024\n"," With the launch of Amazon Exclusive Reach Rate for STV Inventory reporting, advertisers can now isolate and analyze the unique, unduplicated reach delivered by individual Amazon 1P streaming TV inventory sources like Twitch and Prime Video within their total STV investment. This granular reporting provides insights into the exclusive reach generated by Amazon 1P video channels.\n"," Advertisers are seeking deeper insights into the performance of Amazon 1P STV inventory. This new Amazon Exclusive Reach Rate allows advertisers to validate how effective their Amazon STV investment is at extending total campaign reach to net-new users. Additionally, they can measure the total reach delivered by each individual STV inventory, and adjust their advertising strategies and engage this exclusive audience beyond linear tv.\n"," For full technical details, please read our full API documentation.\n"," December 12, 2024\n"," Following the release of Amazon DSP reports to the v3 offline report API, we are announcing the deprecation of the legacy Amazon DSP report endpoints with a shutoff date of June 30, 2025. You can find a full list of legacy and new endpoints on the Deprecations page.\n"," For general guidance, refer to the v3 reporting overview. For more details on how to upgrade, see our migration guide.\n"," For questions, use the Amazon Ads API Support page to submit a ticket with the subject title \"ADSP Report API Migration\".\n"," December 11, 2024\n"," When defining your bucket policy for Advertiser data uploads, you can now associate multiple instance IDs with a single tag. This allows all the specified instances to access the designated S3 bucket or object. For more details, see Define tags.\n"," December 11, 2024\n"," This playbook guides you through optimizing ad spend distribution by maximizing a specified KPI. It uses historical performance data to create diminishing returns curves, which project expected outcomes at various budget levels allowing you to visualize performance expectations and identify the point where additional investment yields diminishing returns. To get started, see Media performance optimization playbook.\n"," December 11, 2024\n"," AMC on AWS Clean Rooms now offers self-serve instance creation and advertiser modification APIs. This new feature enables all AMC account holders, including advertising partners and direct advertisers, to create collaboration instances independently, without requiring assistance from an Amazon representative. For more details, see Create an AWS Clean Rooms backed AMC instance.\n"," December 6, 2024\n"," Following the release of the new ADSP Creatives and Association Management endpoints, we are announcing the deprecation of the legacy endpoints with a shutoff date of May 31, 2025. You can find a full list of legacy and new endpoints on the Deprecations page.\n"," Going forward, you can access all creative, moderation and association data via the new ADSP Creatives and Association endpoints. For more details on how to upgrade, see our Migration Guide.\n"," For questions, use the Amazon Ads API Support page to submit a ticket with the subject title \"ADSP Creative API Migration\".\n"," December 5, 2024\n"," Regions: US, UK, CA, AU\n"," Contextual keyword targeting enables advertisers to connect with audiences by targeting content based on relevant freeform keywords or phrases - without relying on identifiers. Powered by our latest AI models, Amazon DSP places ads on Amazon properties and third-party sites, ensuring ads appear on pages containing or closely related to targeted keywords.\n"," This product is now available in the US, UK, CA, AU to Amazon DSP self-service and managed-service advertisers and is supported on standard display and Amazon mobile display line items.\n"," Contextual keyword targeting overcomes the limitations of category or product retail-based approaches by offering advertisers the flexibility to target freeform keywords, enabling increased reach and performance. Up until now, the existing contextual targeting options available on Amazon DSP restricted advertisers to predefined Amazon retail Categories (Browse Nodes) or Products (ASINs), so advertisers could target ‘picnic baskets’ but not an event like ‘4th of July’ or ‘summer.’ The flexibility of contextual keyword targeting is a universal fit for all of our customers, enabling advertisers increased opportunities to achieve their goals on Amazon DSP.\n"," Relevant API endpoints:\n","Create target: /dsp/v1/targets - List targets: /dsp/v1/targets/list - Delete target: /dsp/v1/targets/deleteByObject\n"," December 2, 2024\n"," The Amazon DSP campaign management APIs now support creating, reading, and updating inventory groups. Inventory groups are reusable groupings of deals into one singular group that can be added to ad groups.\n"," New endpoints:\n","POST /dsp/v1/inventory/inventoryGroups/list: List all inventory groups.  POST /dsp/v1/inventory/inventoryGroups: Create an inventory group.  PUT /dsp/v1/inventory/inventoryGroups: Edit an inventory group. \\* POST /dsp/v1/inventory/eligibility/inventoryGroups/list: List inventory groups eligible to be added to an ad group.\n"," To add an inventory group to an ad group (line item), use POST /dsp/v1/targets to create an inventorySourceTarget with inventorySourceType = INVENTORY_GROUP.\n"," For more information, see the API specification for inventory groups.\n"," December 2, 2024\n"," For information about programmatically accessing status information, visit the Amazon Ads Status page in the advanced tools center.\n"," November 29, 2024\n"," Amazon Marketing Cloud (AMC) adds Amazon Brand Store insights datasets to its Paid features suite, allowing users visibility into Brand Store performance through two comprehensive AMC datasets that include page renders and interactions. Available for both trial and subscription enrollments in the following marketplaces: US, Canada, Japan, Australia, France, Italy, Spain, UK, and Germany.\n"," To learn more, visit Amazon Brand Store insights.\n"," November 20, 2024\n"," AMC Amazon Your Garage is a paid feature and available for enrollment within US and CA AMC account marketplaces. The AMC Amazon Your Garage dataset contains signals from US, CA, and MX.\n"," To learn more, visit the Amazon Your Garage Instructional Query (link only available for AMC UI users).\n"," November 20, 2024\n"," This comprehensive playbook will help advertisers perform an in-depth analysis of previous tentpole events and guide creating targeted lookalike audiences. It addresses key questions about ASINs and campaign selection, audience targeting timing, and effective strategies for keywords, frequency, and ad formats. To learn more, visit Lookalike audiences for promotional events playbook.\n"," November 15, 2024\n"," Amazon DSP has launched a new Guidance API and Quick Action API, enabling advertisers to programmatically access pre-flight and in-flight recommendations for their campaigns. The Guidance API provides the same intelligent suggestions for maximum average CPM, line-item frequency caps, viewability targeting and other optimization opportunities that are available through the DSP console. Advertisers can now retrieve recommendations for new campaigns pre-flight and in-flight optimizations for live campaigns, allowing for seamless integration with their own systems and workflows. The Quick Action API allows advertisers to seamlessly action Amazon DSP recommendations.\n"," The Guidance API empowers advertisers to automate their campaign optimization processes, reducing manual effort and improving efficiency. By providing programmatic access to Amazon machine learning-driven recommendations, advertisers can quickly identify and act on opportunities to enhance campaign performance and delivery. This API integration enables more frequent and consistent optimization, especially beneficial for advertisers managing large-scale campaigns or using custom tools for campaign management.\n"," DSP Guidance API: Advertisers can use this API to view recommendations for their campaigns. The four new endpoints will aggregate the guidance at various object levels (advertiser, order or line items). Recommendations can be fetched for many objects at once.\n"," Listed below are the new endpoints included in this API:\n","POST /dsp/v1/guidance/lineitems/list  POST /dsp/v1/guidance/orders/list  POST /dsp/v1/guidance/advertisers/list\n"," For full technical details, please read our API documentation.\n"," DSP Quick Actions API: This API allows advertisers to adopt the recommended changes returned by the Guidance API. Sending a request to POST /dsp/v1/quickactions/{actionId}/executions using the actionId included in the guidance response will trigger the relevant change to be adopted.\n"," For full technical details, please read our API documentation.\n"," November 15, 2024\n"," Contextual keyword targeting enables advertisers to connect with audiences by targeting content based on relevant freeform keywords or phrases - without relying on identifiers. Powered by our latest AI models, Amazon DSP places ads on Amazon properties and third-party sites, ensuring ads appear on pages containing or closely related to targeted keywords.\n"," This product is now available in the US, UK, CA, AU to Amazon DSP self-service and managed-service advertisers and is supported on standard display and Amazon mobile display line items.\n"," Contextual keyword targeting overcomes the limitations of category or product retail-based approaches by offering advertisers the flexibility to target freeform keywords, enabling increased reach and performance. Up until now, the existing contextual targeting options available on Amazon DSP restricted advertisers to predefined Amazon retail Categories (Browse Nodes) or Products (ASINs), so advertisers could target ‘picnic baskets’ but not an event like ‘4th of July’ or ‘summer.’ The flexibility of contextual keyword targeting is a universal fit for all of our customers, enabling advertisers increased opportunities to achieve their goals on Amazon DSP.\n"," For more information, see our API documentation:\n","Universal targeting:\n"," November 15, 2024\n"," Alexa is the first device ad placement to integrate with the standard Asset Based Creative (ABC) creative template used by desktop and mobile advertisers. Amazon DSP self-service advertisers using ABC creatives, directing to to any landing page, now have the opportunity to run their display ads on Alexa Home Screen (AHS). This will help drive brand awareness and consideration objectives and prove an opportunity to reach incremental customers on Echo Show devices.\n"," Buyers can use the standard Assets Based Creatives (ABC) and be served on the Alexa Home Screen (AHS). Alexa is an Amazon inventory type that will be enabled on Display Media Type Line items. This gives buyers a frictionless experience of serving an ABC ad to an additional Amazon supply.\n"," November 15, 2024\n"," Amazon DSP Creative team will launch the Creative Management APIs into open beta. This release includes the ability to create, update, read, preview creatives; create, delete and update creative ad group association; and get moderation details for Amazon DSP creatives.\n"," This launch allows us to grow our integration offering to more customers using the latest version of the creative APIs. This set of APIs offer the functionality available on the Amazon DSP UI, including the support of add, edit, review setting and moderation status, associate to line items and bulk tools. This set of APIs were redesigned and newly developed to better support integration customer needs.\n"," The new creative management APIs enable self-serve advertisers and their partners to programmatically manage their Amazon DSP AdCreatives, AdCreative-AdGroup associations and moderations. These new APIs replace the previous creative management APIs, with the following improvements:\n","Unified API structure: The API model provides a single, unified structure (the adCreative) that can host multiple variations (the adExperiences). API clients will have access to the new offering automatically without additional API-onboarding overhead.  Worldwide availability: The new APIs are available in all countries supported by Amazon DSP.  Improved Scale: The list endpoint can support up to 100 objects read at a time, and the createCreativeAssociation, patchCreativeAssociation and deleteCreativeAssociation can support batch size of 20. \\* Enhanced Features: The new API supports PATCH operations (partial updates) allowing individual field without sending all the fields. The new AdCreative association API can update association object state (ACTIVE, INACTIVE).\n"," November 15, 2024\n"," We have introduced a new API to streamline the retrieval of individual billing documents, such as invoices, credit memos, debit memos, and prepayment receipts. This new functionality enhances our existing /billing API, allowing customers to programmatically download these documents in various media formats, improving the accessibility and management of billing records.\n"," This enhancement is essential for customers managing complex billing operations. Previously, invoices and related documents could only be accessed in a JSON format, limiting flexibility for users requiring these documents in a downloadable format. Now, with this update, customers can download essential billing documents in PDF and other formats, making it easier to manage and store important financial records.\n"," For more information, see our API documentation.\n"," November 15, 2024\n"," We have expanded our Amazon DSP recommendations to support campaigns running seven days or less. This update enables our machine learning models to provide more timely and relevant optimization suggestions for campaigns during peak shopping events like Prime Day or Black Friday.\n"," Advertisers can now benefit from Amazon DSP recommendations to help their orders pace during peak shopping events, helping them to quickly identify and address issues. Our recommendations are actionable with a single click, helping advertisers focus their time on what matters.\n"," For more information, see our API documentation.\n"," November 15, 2024\n"," Amazon launched support for historic all-up ad supported reach curves in the US, UK, DE and CA. For the first time, Amazon has released the ability to understand Amazon reach by first party, third party, and advertiser audiences. Using the Historic Reach Curve API - Advanced, you can programmatically access ad-supported reach metrics across Amazon portfolio of ad products.\n"," Integrators now have visibility into the historic household and individual reach Amazon achieved. This data can be used as-is or as fuel to power your internal planning tools.\n"," For full technical details, please read our API documentation.\n"," October 21, 2024\n"," The Amazon Business Bid Adjustment and Reporting for Sponsored Products is available to all advertisers using the SPv3 API across US, CA, MX, DE, UK, FR, IT, ES, IN, and JP. The Amazon Business Bid Adjustment is a singular adjustment that allows advertisers to increase their bids by up to 900% across all placements on Amazon Business. This Amazon Business Bid Adjustment can be applied to existing or new Sponsored Products campaigns, and can be set independently or in addition to placement bid adjustments for Top-of-Search (first page), Rest-of-Search (remaining search results), and Product pages. All Sponsored Products advertisers in Amazon Business marketplaces, irrespective of their use of the Amazon Business Bid Adjustment, will now also have access to reporting that shows Sponsored Products campaign performance on Amazon Business from 9/5/2024 onwards. The Amazon Business performance data can be used by advertisers to guide their use of the Amazon Business Bid Adjustment.\n"," By increasing bids for Amazon Business placements, advertisers are more likely to have their ads surface on the Amazon Business store and correspondingly generate more impressions, clicks, and sales (better reach and engagement) from business customers. Relative to B2C customers, business customers are ~3x more likely to purchase an item after viewing its product page, have a ~50% lower return rate, and on average make orders containing ~80% more units. This results in advertisers, on average, seeing a 2-3x higher return on ad spend on Amazon Business relative to their overall campaign performance (based on Amazon internal data, 2024). The Amazon Business performance data can be used by all Sponsored Products advertisers in Amazon Business marketplaces, irrespective of their use of the Amazon Business Bid Adjustment, to understand the effectiveness of their Sponsored Products campaigns on Amazon Business.\n"," SP v3 API: Advertisers can use the new enum value SITE_AMAZON_BUSINESS by providing it when configuring the dynamic bidding specifications of a given campaign. All existing SP endpoints which accept or return this object now accept this new enum with a value from 0 to 900.\n"," Reporting v3 API: Advertisers can use the new filter named campaignSite with the value AmazonBusiness as modifier to the campaignPlacement groupBy parameter in the spCampaigns report. Other groupBy parameters apart from campaignPlacement are not supported in the request. The generated report will show AB-only performance for all of their campaigns irrespective of the use of the AB Bid Adjustment.\n"," For more information, see the technical specifications for the Sponsored Products API and the documentation for the reporting API.\n"," SP API endpoint examples:\n","POST /sp/campaigns for creating a new campaign - PUT /sp/campaigns when updating an existing campaign - POST /sp/campaigns/list when querying upon existing campaigns which contain the enum value.\n"," Reporting API endpoint examples:\n","GET /reporting/reports/{reportId} Gets a generation status of a report by id - DELETE /reporting/reports/{reportId} Deletes a report by id - POST /reporting/reports Creates a report request\n"," October 18, 2024\n"," Starting Nov 6, 2024, the Amazon DSP campaign management APIs will enable read-only support for campaigns targeting Amazon guaranteed deals.\n"," Summary of changes:\n","New boolean field: targetsAmazonDeal \\* New fields: startDateTime, endDateTime\n","New inventoryType enum values: AUDIO_AMAZON_DEAL, STREAMING_TV_AMAZON_DEAL\n","The inventorySourceTarget will list the specific Amazon guaranteed deal being targeted. \\* After pulling the dealId from the targets endpoint, you can use /dsp/inventory/deals/list to pull deal metadata.\n"," We will post an announcement on our release notes page once this feature is released.\n"," October 18, 2024\n"," Amazon Ads has enhanced its existing mechanisms for publishers, advertisers and vendors (referred to as third parties) to share their customers’ consented data with Amazon Ads by introducing Amazon Consent Signal. While we will continue to accept the Interactive Advertising Bureau (IAB) Transparency & Consent Framework (TCF) signal, Amazon Consent Signal provides a way for third parties that do not use TCF to transmit their users’ consent choices along with a country code to Amazon Ads. For Sending Personal Information and Amazon Ads Consent Signal requirements, please click here.\n"," From 1st November 2024, third parties can to share the country code and consent with Amazon Ads. We will continue to honor existing mechanisms for consent and will publish an update by which all data that partners make available to Amazon Ads, must include the IAB European Transparency & Consent Framework (TCF) signal(s) or the Amazon Consent Signal.\n"," From 1st November 2024, you can share a country code when passing customers’ consented data to Amazon Ads. The country code is a 2-character string in the ISO 3166 format that indicates in which country the consent was given (for example, US or GB). If you upload data without specifying a country code, we will automatically reject the data load. The Country Code must indicate the country in which consent was granted by the customer.\n"," From 1st November 2024, you can share a consent string when passing EEA or UK customers’ consented data to Amazon Ads. If you already use TCF, this is sufficient and you do not need to make any changes. If you do not use TCF, you can use the Amazon Consent Signal, see below, to pass your customers’ consent. To be clear, please do not pass both TCF and Amazon Consent Signal. If you do pass both, we will take TCF as the consent signal and ignore Amazon Consent Signal. If you use a Consent Management Platforms (CMP) to manage your consent please ensure your CMP provides you with the necessary data to send a TCF consent string or the Amazon Consent Signal details. If you pass your data to Amazon Ads directly (i.e. not through a CMP) then we have several resources available to help you do this.\n"," Country code is a required field today as part the audience metadata sent via DP API. Additionally, from 1st November 2024, third parties can begin to share consent string with Amazon Ads. Consent string will be a new field (see attachment). Instructions to add consent string are published here.\n"," If you are not sending audiences for countries that are part of EEA and UK then please keep sending country codes; no further action is needed. If you are sending audiences for countries that are part of EEA and UK then please continue reading about Consent string requirements.\n"," Amazon will continue to honor existing mechanisms for consent and also advise customers to utilize the TCF or Amazon Consent Signal. For any questions related to the DP API updates you can contact us here.\n"," We will update the following Help Center articles:\n","https&#x3A;//advertising.amazon.com/help/GLZ54GXQW773A6MG - https&#x3A;//advertising.amazon.com/help/G9Y77VYQ3VJZU5YV - https&#x3A;//advertising.amazon.com/API/docs/en-us/guides/overview\n"," What actions should events manager advertisers and partners take? Events Manager users (AAT, CAPI) can share any one of the consent formats that is most relevant for them.\n","Our GTM Templates will have now have additional consent checkbox and fields. Please use the consent field that is most relevant for you. If you are an agency/ partner working on behalf of your advertiser, use the consent provided by your advertiser. 2. For regular AAT there is a command called setAmazonConsent that takes all of the consent fields as a JSON object. 3. For CAPI and partner integrations there will be an field on the events called AmazonConsent that takes the JSON of the consent fields.\n"," Starting November 6, 2024, AMC will accept Transparency-and-Consent-Framework (TCF), Global Privacy Platform (GPP), and Amazon Consent Signal (ACS) consent signals. These consent signals will be optional in UK/EEA personal data uploads until they become mandatory. AMC will respect provided consent, rejecting records if denied. During the transitional period there will be no impact to data uploaded without consent signals.\n"," We recommend all advertisers and third-party (3P) data providers provide this information to indicate the jurisdiction whose laws apply to processing the user data.\n"," The above-mentioned data decoration standards for country codes and consent signals also applies to all advertisers and 3Ps using AMC — AWS Clean Room collaborations.\n"," Please refer to Sending Personal Information to Amazon Ads & Amazon Consent Signal requirements to know more about the policy. For detailed documentation, please visit the AMC documentation section within the Advanced Tool Center (ATC).\n"," Advertisers uploading their data to Ads data manager can provide consent in one of three formats: TCF, GPP, or Amazon Consent Signal. We require all records containing user-level identifiers uploaded to Amazon Ads to contain at least one consent attribute, as well as country code.\n"," For specific technical instructions, the details are found here.\n"," October 18, 2024\n"," Beginning November 1, advertisers running new and existing display ad campaigns in Amazon DSP will benefit from additional Amazon first-party supply across Echo Show, Fresh stores, Fire Tablet, Fire TV, IMDb, Twitch, and Whole Foods Market and Fresh digital displays. Advertisers who have selected any Amazon inventory source for their display campaign will automatically have all eligible Amazon inventory sources included.\n"," This change comes following improvements to our machine learning models and the previous launch of display ad inventory across Echo Show (US, UK, DE, CA, MX, IT, JP), Fire Tablet (US, UK, DE, JP), IMDb (WW), and Twitch (WW). We will add additional supply from Fire TV, IMDb, Twitch, Whole Foods Market, and Fresh stores in the coming months.Additional expansions across Fire TV display component-based creatives and Twitch custom format ads are planned for the coming months.\n"," This auto-selection will happen in a phased manner and eligibility will be governed by ad policy and creative requirements specific to each inventory source. Advertisers have the option to opt-out of this automatic inventory expansion if they choose by reaching out to Programmatic Solution Consultant or Ad Support via Contact us in Support center.\n"," Prior to this update, advertisers had to manually select Amazon inventory sources for their display ad campaigns. Enabling automatic inventory expansion removes the guesswork, simplifies campaign management, and frees up valuable time and resources, all while giving advertisers the opportunity to connect with a wider audience. This change also provides the ability to maintain control over ad placements and benefit from intelligent optimization strategies that can help achieve campaign goals more effectively.\n"," For full technical details, please read our API documentation.\n"," October 18, 2024\n"," Beginning November 1, advertisers running new and existing online video ad campaigns in Amazon DSP will benefit from additional Amazon first-party supply across Echo Show, Fire TV, IMDb, and Twitch. Advertisers who have selected any Amazon or third-party inventory source for their online video ad campaign will automatically have all eligible Amazon inventory sources included.\n"," This change comes following improvements to our machine learning models and the previous launch of video ad inventory across IMDb (WW) and Twitch (WW). We will add additional online video supply from Echo Show, IMDb and Twitch in the coming months. Additional expansions across Alexa video inventory is planned for the coming months.\n"," This auto-selection will happen in a phased manner and eligibility will be governed by ad policy and creative requirements specific to each inventory source. Advertisers have the option to proactively opt-out of this automatic inventory expansion if they choose by reaching out to a Programmatic Solution Consultant or Ad Support via Contact us in Support center.\n"," Prior to this update, advertisers had to manually select Amazon inventory sources for their online video ad campaigns. Enabling automatic inventory optimization removes the guesswork, simplifies campaign management, and frees up valuable time and resources, all while giving advertisers the opportunity to connect with a wider audience. This change also provides the ability to maintain control over ad placements and benefit from intelligent optimization strategies that can help achieve campaign goals more effectively.\n"," For full technical details, please read our API documentation.\n"," October 18, 2024\n"," Sponsored Brands launched the Optimization Rules Recommendation API to provide suggested Cost-Per-Click (CPC) when using Optimization Rules for Drive Page Visits campaigns. The bid suggestions are personalized based on brands owned by the advertiser, allowing advertisers to input competitive bids to drive campaign objectives.\n"," An effective optimization metric threshold should balance auction performance with cost-effectiveness, and can vary greatly depending on your brand content and targeting strategies. The Optimization Recommendations API was designed with this principle, empowering advertisers to achieve results while still converging to cost efficient bids.\n"," Advertisers can retrieve these recommendations through the new /sb/recommendation/optimization API call, for both existing campaigns and during the campaign creation process. This endpoint takes your cost control metric type, along with up to ten landing page ASINs or URLs, and returns both the recommended value and minimum value for your campaign.  For full technical details, please read our API documentation.\n"," October 15, 2024\n"," The updated campaign management resources for Amazon DSP are now available worldwide in open beta. With this release, we are making the endpoints available to all customers with access to an Amazon DSP account. You no longer need to request permission to access the new endpoints via the Amazon Ads API.\n"," The new campaign management resources enable you to create, read and update Amazon DSP campaigns, ad groups, targets, flights and product conversion tracking details. They replace the legacy campaign management APIs, which are scheduled for deprecation on March 31, 2025 per our previous announcement. In addition to being available worldwide and supporting programmatic guaranteed deals, the new APIs improve the experience developing at scale, for example, through support of PATCH operations and larger batch sizes.\n"," If you are integrated with the legacy resources, we have put together a migration guide to help you transition to the new resources. If you are new to managing Amazon DSP campaigns via API, refer to our reference documentation and developer guide.\n"," For questions, visit the Support page to submit a ticket with the subject title “ADSP CM API Migration.”\n"," October 14, 2024\n"," Advertisers can leverage rule-based or lookalike audiences in Sponsored Display targeting, Sponsored Products bid boost and Sponsored Brands bid boost. This functionality allows advertisers to act on the insights they derive from AMC and reach shoppers at the right time and place in their shopping journey.\n"," Start creating custom audiences in AMC using Rule-based audiences and Rule-based lookalike audiences to activate in your sponsored ads accounts.\n"," October 14, 2024\n"," Announced at unBoxed 2024, Ads data manager (ADM) is a new standalone offering that simplifies and streamlines the process of first-party data management across Amazon Ads ad tech. ADM is a privacy-safe, easy-to-use interface that lets advertisers and their partners onboard their data once and securely reuse it across our ad products (for example, ADSP or AMC) for measuring conversions, engaging relevant audiences, and optimizing campaigns for sustainable business growth- all while retaining visibility and control of their data.\n"," Advertiser first party data is crucial for measuring campaign success and driving better marketing outcomes.  As customers adapt to reduced dependence on third party cookies and mobile advertising IDs, they are increasingly reliant on their first party data as critical inputs into audiences, measurement, optimization strategies.  To enable advertisers to unlock and scale the value of their first party data, we are launching Ads data manager. Through ADM, advertisers can access a single solution within Amazon Ads to build a holistic first party data strategy. Some of the key product differentiators include:\n","Simplified and intuitive CX for data management: We are making data onboarding frictionless, Amazon Ads advertisers (and their partners) will access a unified interface which natively receives data through Amazon Ads Console UI, connected APIs and CDP integrations.  Interoperable experience across all Amazon Ad Tech products: You can upload your data once and reuse it across all 1p data features of ad products (ADSP, AMC) to activate it for various use cases, all through one simple interface.  Fast track onboarding via integrated partners: You will be able to easily stream data wherever you traditionally house it, this will be made possible through a connector library that offers integrations with partners like CDPs, MMPs.  Secured data environments: ADM is a secure data environment with user-level access controls, giving you the ability to create isolated data environments for different use cases — all with end-to-end encryption  Seamless hand-off between brands and agency partners: ADM will allow for streamlined data connections across advertisers and agency partners.\n"," The Ads data manager consolidates all of Amazon Advertiser Data APIs into a single API collection for ease of integration. The main API functions are:\n","DataSet APIs - Manages Datasets.  Datasets are tables with a specific schema. You may use this API to delete a dataset.  Audience APIs - Creates an dataset with the audience dataset type. This API serves as a shortcut to create an audience dataset directly.  Audiences are treated the same as general datasets, but have a pre-defined schema template used for audiences.  Sharing Rules APIs - Sharing rules allow you to list current dataset shares with linked advertiser accounts. You may also create new sharing rules to make datasets available for use in advertiser accounts for a specific application. \\* Status APIs - Provides reporting on the status of uploads, size of your datasets, and volume of data that has been made available for a given sharing rule.\n"," For more information, read our API documentation.\n"," October 14, 2024\n"," Sponsored Products and Sponsored Brands are launching a new bidding control to enable advertisers to reach and engage audiences segments defined and created by them. With the latest offering, advertisers can compose lists of audiences, such as those who have not bought their product before or exposed to their video awareness campaigns and set custom bids for them in their campaigns to drive more discovery and sales.\n"," The new bidding control enables advertisers to engage with audiences created in Amazon Marketing Cloud (AMC), a privacy-safe, cloud-based, clean room solution.  The audiences are then available to their sponsored ads account so they can selectively modify the bids for them when launching their campaigns.\n"," The new control helps advertisers more efficiently engage with selected audiences segments. Using bid controls, they can modify their bids to capture increased engagement and conversions from selected audiences segments, such as re-engaging shoppers in their journey along the marketing funnel, while also reaching the relevant Amazon shoppers that are searching for their targeted keywords. Advertisers can monitor performance through a new field in the AMC sponsored_ads_traffic table to understand when Amazon applied the bid increase by inspecting the column matched_behavior_segment_ids.\n"," Advertisers will use the Targetable Entities API to retrieve Audiences (Discovery) after they are created in AMC. In Sponsored Products, they will then use the Audience ID (Canonical) with the Sponsored Products V3 Campaigns API to create, bid adjust the audience and manage their campaigns. In Sponsored Brands, similarly, advertisers will use Sponsored Brands Campaign Management API to create and manage their campaigns, as well as adjust their audience bids.\n"," October 14, 2024\n"," Ads data manager is a new standalone offering that simplifies and streamlines the process of first-party data management across Amazon Ads, enabling marketers to be in the driver’s seat for making more effective, data-driven decisions. Designed with ‘data stewards’ in mind, ADM is a privacy-safe, easy-to-use interface that lets advertisers and their partners onboard their data once and securely reuse it across our ad products for measuring conversions, engaging relevant audiences, and optimizing campaigns for sustainable business growth- all while retaining visibility and control of their data. For more details, see Ads data manager console and Ads data manager API.\n"," October 11, 2024\n"," Dynamic segments are collections of audiences that change based on performance and relevance criteria to reach consumers who are most likely to engage with your ads. You can select the dynamic segments to launch your campaigns easily and effectively and drive performance at scale. The new “Audiences likely to be interested in your ad“ setting leverages Amazon machine learning algorithms to show your ads to audiences who are most likely to consider and buy from your business — using a variety of signals such as Amazon first-party shopping signals, your own conversion signals, and insights from your business website.\n"," Once you have identified the audiences you want to use, you can add targeting clauses at the ad group level using POST /sd/targets. For more information on setting up audience targeting, see audience targeting campaigns. For more details, refer to the full technical API documentation.\n"," October 9, 2024\n"," We are introducing a new Brand Stores API, which advertisers can use to programmatically to access details of Brand Stores on Amazon. These details include a list of stores and their pages, URL and its status. This information can be combined with other Amazon Ads data and Stores Insights to get holistic views and performance for Brand Stores on Amazon and its pages.\n"," Historically, to get Brand Store details, Store owners could only access this information through the advertising console one store and page at a time. With introduction of the Brand Store APIs, Store owners can access the same information programmatically, through the Amazon Ads API. This is especially helpful for getting Brand Store details across different countries (or locales), or when a Brand is managing multiple Brand Stores.\n"," Advertisers can get details of their Brand Stores and its pages such as name, id, status and url for a given brandEntityId. API response is paginated with max number of documents returned as 30. For full technical details, please read our API documentation.\n"," October 9, 2024\n"," We are excited to launch self-service instance management APIs on the Amazon Ads API as Open Beta. AMC launched the ability to create, modify, and manage AMC instances using self-serve APIs, eliminating the need to contact an Amazon Ads representative. This feature is available to all AMC account holders, including advertising partners and direct advertisers.\n"," The new APIs offer swift instance creation with automated approvals, using which partners can start generating value within minutes of creating an instance with 1 advertiser ID. In case of instances created with multiple advertisers, the instances are activated after a manual validation within 2 days. Authorized AMC admin users can initiate an instance creation by sending a POST /amc/instances request with instance details. Advertisers can be added to an instance by calling POST /amc/instances/{instanceid}/advertisers/updates with advertiser IDs (DSP CFIDs and/or Sponsored Ads Entity IDs).\n"," Listed below are the new endpoints that will help help you with instance creation and management:\n","POST /amc/instances | Creates a new AMC instance. - POST /amc/instances/{instanceId}/advertisers/updates | Creates a new advertiser update for the requested AMC instance. - GET /amc/instances/{instanceId}/advertisers/updates/{updateId} | Gets the requested advertiser update for the requested AMC instance. - GET /amc/instances/{instanceId}/advertisers/updates | Lists advertiser updates for the requested AMC instance. - PUT /amc/instances/{instanceId}| Updates the requested AMC instance. - DELETE /amc/instances/{instanceId} | Deletes the requested AMC instance.\n"," For more information, see the AMC administration guide.\n"," October 9, 2024\n"," All snapshots endpoints are now deprecated, with a target shutoff date of December 15, 2024. Please migrate to the exports API as indicated on our Deprecations page.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/{recordType}/snapshot - /snapshots/{snapshotId} - /v2/sp/{recordType}/snapshot - /v2/sp/snapshots/{snapshotId} - /v2/sp/snapshots/{snapshotId}/download - /v2/hsa/{recordType}/snapshot - /v2/hsa/snapshots/{snapshotId} - /v2/hsa/snapshots/{snapshotId}/download - /sd/{recordType}/snapshot - /sd/snapshots/{snapshotId} - /sd/snapshots/{snapshotId}/download\n"," For more details on integrating with exports, see the Exports overview.\n"," October 9, 2024\n"," Amazon has launched the ability for all Amazon DSP self-service advertisers to book Fire TV Inline Display Banner campaigns in UK, DE, FR, IT, ES, JP and IN. The Inline Display Banner sits above the fold within the Sponsored Row of the Fire TV UI on the home tab. As the user scrolls down their screen, they will pass-over this ad placement to get to content rows below the fold. When they do so, the ad unit will reveal a “Mini-Details” view, taking up about half of the users screen.\n"," This ad unit also accepts an optional video asset (:10-:30s) with sound. Advertisers have the opportunity to set up Entertainment or digital ASIN, Prime Video Channel benefit ID, video and physical ASIN click-through destinations (only available in UK and DE). This provides an opportunity for advertisers to drive incremental reach, brand awareness and consideration.\n"," Offering Fire TV ad placements to be booked self service via Amazon DSP opens up opportunity for advertisers looking to utilize self service buying models and removes minimum spend requirements that come with managed service campaigns. This allows advertisers flexibility to launch campaigns quickly with lower SLAs compared to managed service, as well as the opportunity to optimize campaigns in real-time. Fire TV ad placements provide advertisers an opportunity to drive incremental reach, brand awareness and consideration. On average, Fire TV ad campaigns observed 2x+ incremental reach with only a 3% overlap in audience when added to Prime Video ad campaigns (Source: Amazon Internal, Jan-Mar 2024, US).\n"," For full technical details, please read our API documentation.\n"," October 9, 2024\n"," All Amazon DSP direct advertisers, as well as partners registered with the Amazon Ads Partner Network who serve clients with or without Amazon DSP, are now eligible to register for AMC. For advertisers who use only Sponsored Ads today and work with Amazon Ads partners, AMC is now an accessible clean room where their partners can leverage the rich, granular, and event-level signals to generate bespoke insights, advise optimization tactics, and take insights-based actions on their behalf.\n"," October 3, 2024\n"," Regions: All\n"," Following the release of the new version 3 reporting endpoints, we are announcing the deprecation of version 2 Sponsored Display reporting with a planned shutoff date of October 31, 2024. This includes the POST /sd/{recordType}/report endpoint. Until then, expect additional throttling levels on the current Sponsored Display version 2 endpoint as we begin the deprecation process.\n"," Going forward, you can access all version 2 Sponsored Display report types using the version 3 reporting endpoints. For more details on how to upgrade to version 3, see our Migration guide and Frequently asked questions.\n"," If you have feedback, use the Amazon Ads API Support page to submit a ticket with the subject title “SD reports v2 deprecation” by October 15, 2024.\n"," October 1, 2024\n"," A new table, dsp_video_events_feed, is now available for AMC users. The table provides video metrics for each of the video creative events triggered by the video player and associated with the impression event. For more details, see Amazon DSP video events table.\n"," October 1, 2024\n"," Users of AMC on AWS Clean Rooms can now leverage bespoke solutions from the Solutions tab of the AMC console. Log in to the AMC console to access your first solution - High-value audiences.\n"," September 27, 2024\n"," Amazon DSP has launched the ability to create new preferred deals with Amazon Media directly in inventory hub for self-service customers worldwide. With this feature, customers can create new deals with Amazon Twitch, Amazon Freevee and Amazon Prime Video based on their applicable rate cards. Customers can configure supply-side audience segmentation and submit their deal proposals for approval, and activate new deals instantly on existing line items. This feature is launching to all Amazon DSP self-service customers.\n"," With this release, Amazon DSP customers gain the ability to propose new deals without the need to work with their Amazon Ads representatives. They can discover available deals sold by Amazon Media, understand the applicable rates, choose the deals they are interested in, and precisely configure the supply-side audience segmentation they want. The deals supported at launch are approved programmatically, resulting in customers being able to activate newly created deals within minutes.\n"," For more information, please read our reference documentation.\n"," September 27, 2024\n"," Frequency cap insights show advertisers the impressions and the budget reinvested to reach more shoppers due to frequency caps used at line, order, and frequency group levels. Advertisers can now see these numbers in a new insight card and can download the data. Advertisers can also use a new Amazon Ads API to query frequency cap insights data.\n"," Frequency caps allow advertisers and agencies to save impressions by preventing ads from showing to the same customers repetitively. However, prior to this launch, Amazon DSP did not provide any way to quantify the benefits. To bridge this gap, we built Frequency Cap Insights to quantify impressions reinvested, budget reinvested, and incremental reach.\n"," For more information, see our reference documentation.\n"," September 27, 2024\n"," Advertisers globally now have the ability to target programmatic guaranteed display deals in their Amazon DSP campaigns. Similar to programmatic guaranteed video deals that are already supported with Google AdX, customers need to negotiate and finalize programmatic guaranteed display deals within the Google Authorized Buyers UI. Once the deal is finalized, the deal will now be available for targeting within display line items.\n"," Supporting programmatic guaranteed display deals via AdX expands on the programmatic guaranteed offering within Amazon DSP. Before this release, we only supported video for programmatic guaranteed. But this release provides another method of guaranteed buying to meet advertisers’ needs. For more information on the deals API, see our getting started guide.\n"," September 24, 2024\n"," The ABVP team is excited to announce the launch 3P API access for ABVP. Advertisers with ABVP access can can now use the API feature to access a URL to directly download ABVP reports instead of clicking through the ABVP User Interface.\n"," With 3P API access for our advertisers, users can now access a URL to directly download ABVP reports instead of clicking through the ABVP User Interface. Users are able to configure their API to access either the latest ABVP ASIN grain report and standard report for their advertiser.\n"," Using the two 3P endpoints below\n","/insights/brandBenchmarks/advertisers/{advertiserId}/allReportMetadata \\* /insights/brandBenchmarks/advertisers/{advertiserId}/reports/{reportType}/indexDates/{indexDate}\n"," ABVP users will be able to obtain the latest report metadata information from the first endpoint and then use that report metadata information to get a presigned S3 URL to download the report using the second endpoint. For full technical details, please review our API documentation.\n"," September 24, 2024\n"," Availability: US, UK, DE\n"," With the launch of Sponsored Products on the Amazon Global store, advertisers can now drive more discoverability and improve sales internationally using the Amazon Ads API. Learn more about the Global Store\n"," API details\n"," Product selector \\[/product/metadata]\n"," The product selector API fetches the listings required for campaign creation. With this launch, we made changes in this API to fetch the global store offers for Sponsored Products ads creation. We introduced an attribute called isGlobalStoreSelection which advertisers will set to true to fetch their global store listings.\n"," In the response, we will show a globalStoreSetting attribute that holds the details of the source country from where Amazon Global Store sourced the offer. Advertisers can further use these listings and their corresponding source country information for the campaign creation.\n"," Campaign creation \\[/sp/productAds]\n"," The campaign creation API accepts the global store specific attribute globalStoreSetting where advertisers can provide the source catalog country of the offer being used for ads creation. You can check eligibility of the products for campaign creation using the catalogSourceCountryCode information provided using the globalStoreSetting.\n"," Product eligibility \\[/eligibility/product/list]\n"," We have introduced a new globalStoreSetting attribute that takes the source country code of the Global Store ASIN which is required for the eligibility check. Eligibility check of the offer would be done in the source marketplace for the advertiser.\n"," Bid recommendations \\[/sp/targets/bid/recommendations]\n"," The bid recommendation API for new Ad groups takes a new attribute called productDetailsList, which takes the ASIN details along with its source country code. The bidding system uses the globalStoreSetting attribute and the catalogSourceCountryCode information for eligibility check of the ASINs, which is required for the bid recommendation.\n"," Keyword recommendations \\[/sp/targets/keywords/recommendations]\n"," The keywords recommendation API for ASINs takes a new attribute called productDetailsList, which takes the ASIN details along with its source country code. Keywords recommendation system uses the globalStoreSetting attribute and the catalogSourceCountryCode information to get the bid suggestions for the keywords.\n"," September 24, 2024\n"," Two new metrics have been added to V3 reporting:\n","Add to List (For Book Vendors and Authors) : Number of users who add advertised book to list during ad exposure and within attribution window 2. Qualified Borrow (For Book Vendors) : Number of Kindle Unlimited users who have downloaded the book due to ad exposure, during the attribution window, and have read a certain percent of the book within the window.\n"," For more information, refer to our reporting documentation.\n"," September 18, 2024\n"," AMC has updated the Amazon DSP traffic events across impression, interaction, and Amazon Attributed event pairs. 20 new dimensional columns were added to the following AMC data views: dsp_impressions, dsp_views, dsp_clicks, dsp_impressions_by\\_\\*\\_segment, and amazon_attributed_events_by\\_\\*\\_time.\n"," September 18, 2024\n"," AMC users can use the conversion_all data source to create AMC Audiences without needing to subscribe to Paid features. Also, refer to the a complete list data sources you can use to create AMC Audiences.\n"," September 18, 2024\n"," A developer guide for AMC on AWS Clean Rooms is now available on the Advanced tools center for users to reference and set up AMC on AWS Clean Rooms.\n"," September 14, 2024\n"," Regions: All\n"," Sponsored ads and Amazon DSP advertisers can now preview, download, and pay for invoices in all countries from a single page, which also has a country-level summary of the total amount due. Advertisers can also view a country-level summary for billing setup status, which determines campaign activation, total amount due and overdue per country, and pay consolidated amounts at a country level. Third-party integrators can download invoice summaries and pay consolidated amounts at a country level.\n"," Previously, advertisers had to navigate to a billing center page at a specific country level to view the total amount due, overdue, and pay the amount for that particular country. With this launch, advertisers can view a single page with a country-level summary and paid, unpaid invoice table having invoices from all countries they are advertising in. This saves 2-3 clicks each time an advertiser goes to any country-level billing center page. This launch will also be applicable to third-party integrators where they will have public APIs to search and download invoices both individually and in bulk.\n"," More details can be found in the technical documentation(billing#tag/Billing-Invoice-Summary(s)).\n"," September 11, 2024\n"," Amazon Marketing Cloud has increased the parallel query execution capabilities of its workflows. Now, an AMC account can run 200 API queries simultaneously, a 4X increase from the previous limit of 50.  Also, an AMC instance can execute 10 API and 10 UI queries in parallel, doubling the previous limit of 5 for each type of query. See Query execution limit.\n"," September 5, 2024\n"," Regions: US\n"," To help customers discover more products in Amazon generative AI-powered shopping assistant, referred to as Rufus, your ads may appear in Rufus-related placements. Rufus may generate accompanying text based on the context of the conversation. Your campaign reports will not include Rufus metrics. For more information, contact your account representative. See our dedicated page to learn more about Rufus.\n"," September 5, 2024\n"," Regions: All\n"," Following the release of the new version 3 reporting endpoints, we are announcing the deprecation of version 2 Sponsored Display reporting with a planned shutoff date of October 31, 2024. This includes the POST /sd/{recordType}/report endpoint.\n"," Going forward, you can access all version 2 Sponsored Display report types using the version 3 reporting endpoints. For more details on how to upgrade to version 3, see our Migration guide and Frequently asked questions.\n"," If you have feedback, use the Amazon Ads API Support page to submit a ticket with the subject title “SD reports v2 deprecation” by August 31, 2024.\n"," September 5, 2024\n"," We are announcing deprecation of the v2/portfolios endpoints with a shutoff date of March 1, 2025. API callers are encouraged to use the /portfolios endpoints instead.\n"," For more information, see the technical specifications for /portfolios. For information on deprecations, review the Deprecations page.\n"," September 3, 2024\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, NL, SE, TR, UAE, SA, AU, JP, IN, BR\n"," Similar audiences (beta) utilizes the latest in AI to enhance your campaign reach to consumers exhibiting similar shopping, streaming, or browsing behaviors or interests as your selected audiences. This feature helps you serve ads to these highly relevant prospective customers more efficiently at scale, without relying on third-party cookies or ad identifiers. With this beta launch, advertisers can activate similar audiences on any line item that includes custom-built audiences based on Amazon shopping interactions.\n"," For full technical details, please see our API reference documentation.\n"," August 29, 2024\n"," We have recently introduced several enhancements to the Amazon Ads API integration dashboard. We have:\n","improved dashboard update frequency from daily to hourly. You are now able to see data for today. - enabled URL linking with associated dashboard filters. You can now create a link to share a filtered view with colleagues. - enhanced the filtering functionality in two ways: - introduced our feedback module on the “Your apps” and “Dashboard” pages so you can help us understand how to improve these features. - reorganized the help content on the dashboard pages to make it easier to find information about individual tabs and the dashboard overall.\n"," To learn more, see Integration dashboard.\n"," August 29, 2024\n"," Sponsored Brands introducing a landing page edit for Product Collection, Store Spotlight and Brand Video Ads. Advertisers and Partners are now able to change their ads landing page without creating a new campaign or ad group. Now, each ad can have individual landing pages within same ad group. You can now update your ad group based campaigns landing pages without recreating your ad group or campaign. For editing a landing page, advertisers and partners can use /sb/ads/creatives/productCollectionExtended for Product Collection ads, /sb/ads/creatives/storeSpotlight for Store Spotlight ads, and /sb/ads/creatives/brandVideo for Brand Video ads.\n"," With this launch, we have expanded to UK, DE, FR, IT, ES, NL, AE, IN, SA, SE, PL, TR, EG, SG, ZA so more advertisers can access these features using the Amazon Ads API. For full technical details, please see our API reference documentation.\n"," August 28, 2024\n"," Advertisers can now delete product audiences that are not part of an active line item. This feature will be available via the Amazon Ads API, and also in the Amazon DSP console.\n"," Before, advertisers could not delete product audiences after they were created. Being able to delete unused product audiences along with audiences that are no longer targeted will reduce clutter and provide a better experience for advertisers.\n"," For full technical details, please see our API reference documentation.\n"," August 28, 2024\n"," Regions: All\n"," Amazon Marketing Stream is available via the Amazon Ads API. When you are ready to get started, visit our Amazon Marketing Stream onboarding guide, which will walk through the process of getting API access, integrating with AWS, and subscribing to campaign datasets using the Amazon Marketing Stream API. If you are already integrated with Amazon Marketing Stream, see the new Amazon DSP dataset documentation.\n"," August 22, 2024\n"," We are announcing deprecation of the application/vnd.spthemebasedbidrecommendation.v3+json content type for Sponsored Products theme-based bid recommendations with a shutoff date of May 15, 2025. API callers are encouraged to use application/vnd.spthemebasedbidrecommendation.v4+json instead.\n"," For more information on version 4, see the technical specifications for theme-based bid recommendations. For information on deprecations, review the Deprecations page.\n"," August 15, 2024\n"," With the launch of user management APIs for Amazon Ads, AMC admin users can now programmatically invite admin and viewer users to their account. For details, see Account management.\n"," August 15, 2024\n"," The status of audiences created using AMC rule-based audience APIs can be viewed using Amazon DSP list audience endpoint. For details on how to view the status of a specific audience Id, see View audiences.\n"," August 15, 2024\n"," Regions: All\n"," Creative assets is introducing two new batch API endpoints to help you manage your creative assets more efficiently. The new endpoints include POST /assets/batchRegister, which enables you to add custom tags and other metadata to assets to aid in asset management and usage for multiple assets in a batch API call, and GET /assets/register/batch/{requestId}, which provides registration details and current status of the individual assets requested in a batch API call.\n"," These endpoints are available for all sponsored ads campaign types as well as for Amazon DSP, via the Amazon Ads API.\n"," August 15, 2024\n"," This Optimal frequency analysis playbook dives deeper into the concept of ad frequency to and guides users with tactics to get clear optimization insights and direct actions within Amazon Ads to optimize frequency analysis.\n"," An example of the optimization is to define the right value threshold for identifying audiences that are considered under-served from a frequency standpoint and activate those. To learn more, visit Optimal frequency analysis playbook.\n"," August 15, 2024\n"," Note that data that was uploaded using Advertiser data upload, version 1.0 (ADU 1.0) cannot be queried. To continue querying datasets that you had uploaded in ADU 1.0,  delete the previously uploaded data, and re-upload using Advertiser Data Upload 2.0 (ADU 2.0). See Advertiser data upload FAQs. Reach out to amc-support@amazon.com for any further assistance.\n"," August 12, 2024\n"," Regions: US\n"," We have enabled brand store support for Sponsored TV campaigns in the US. Now, vendors and registered brand owners can specify a page within their brand store to link viewers to with their Sponsored TV ads. When these ads are eligible for interactive ad formats, audiences can scan QR codes, click the ad, or even interact with the ad via their remote to discover more about your brand. When viewers interact with these ads with their remote, they will receive an email with a link to an advertiser specified brand store. As always, Sponsored TV interactive ad formats are turnkey, with no action required as long as they meet our eligibility criteria.\n"," Previously, advertisers could only link to ASIN detail pages with their Sponsored TV ads, so if an ASIN went out of stock or assets featured multiple ASINs, advertisers either had to manually create new ads or choose one of many ASINs to link viewers to.  Now, advertisers can use more of their assets— like those those that feature multiple ASINs or size-intensive categories (for example, shoes) for their Sponsored TV campaigns.\n"," For full technical details, review the API documentation.\n"," Learn more about Sponsored TV creative specs and interactive ad formats\n"," August 10, 2024\n"," Amazon Ads API customers can now perform user management-related read operations entirely through API integration. Specifically, they list users as well as their roles and permissions for any Amazon Ads account across all countries and ad products.\n"," Previously, user management functionality was only available through the advertising console. This launch marks the second milestone in a series of authorization API launches which make user management functionality available to Amazon Ads API customers. In April 2024, Amazon Ads launched user invitation APIs. With this launch, customers can list users, as well as their roles and permissions associated with any Amazon Ads account via public API, without the need to visit the advertising console. Customers can use these APIs for advertising accounts across all ad products, including sponsored ads, Amazon DSP, and Amazon Marketing Cloud (AMC). Customers can also use these APIs to list users, roles, and permissions for manager accounts. Finally, customers can pass a Global Account identifier with a country code for the sponsored ads account to invoke these APIs. By integrating with these APIs, third parties can build user management workflows on their own advertising platforms.\n"," New APIs include:\n"," For more information, review the API specification.\n"," August 9, 2024\n"," Advertisers on Amazon DSP now have access to incremental and exclusive reach (vs. Linear TV) reporting for their Amazon streaming TV campaigns. The two metrics that are part of this suite are Incremental Reach Rate and Exclusive Reach Rate. The Incremental Reach Rate quantifies the number of unique households reached by the STV campaign who were not exposed to Linear TV ads for the same product, expressed as a percentage of Linear TV household reach. The Exclusive Reach Rate quantifies the number of unique households reached by the STV campaign that were not exposed to Linear TV ads for the same product, expressed as a percentage of the STV campaign total household reach.\n"," The combination of these two metrics will enable an advertiser to determine the impact of the STV campaign reach in comparison to their Linear TV campaign and also assess the return on investment (ROI) on the STV investments specifically with the Exclusive Reach Rate. STV Incremental Reach complements the Incremental Reach Forecast already available in the STV channel planner, so that advertisers can compare their past performance with potential reach.\n"," To learn more, see the exclusiveReachRate and incrementalReachRate column details.\n"," August 9, 2024\n"," Regions: All\n"," Sponsored Display campaigns using tactic T00030 can now access all targeting capabilities available to endemic advertisers, including contextual targeting. Before this launch, Sponsored Display campaigns with tactic T00030 could only be used alongside audience strategies and entertainment targeting. To ensure backwards capability, there are no changes to tactic T00020 and it can continue to used for contextual targeting. The T00020 tactic will be supported for the foreseeable future, however we recommend using the T00030 tactic for new campaign creation to unlock all Sponsored Display targeting options.\n"," By allowing greater Sponsored Display campaign flexibility with tactic T00030, advertisers can focus on achieving their marketing goals, without campaign level targeting constraints. Advertisers can use contextual targeting to help generate detail page traffic and then lean into audience strategies to reengage audiences to help secure missed sales opportunities or further cultivate brand loyalty. Within audience strategies, we added additional audiences for entertainment targeting (Games, Music & TV, Music & Radio) which can help advertisers reach potential customers during their entertainment journey - whether they are live streaming, watching videos, or researching games and movies on various sites beyond the Amazon store.\n"," For full technical details, please see our Sponsored Display targeting API, including  ContentTargetingPredicate, TargetingPredicate, and TargetingPredicateNested that can now be used for Sponsored Display campaigns using T00030 for endemic advertisers. For more information on entertainment targeting, see our updated developer guide.\n"," August 8, 2024\n"," We are announcing the deprecation of /v2/sp/targets/bidRecommendations effective August 15, 2024. The theme-based bid recommendations endpoint is the replacement for /v2/sp/targets/bidRecommendations. The v2 endpoints will shut off on May 15, 2025.\n"," For more information, review the Deprecations page.\n"," August 6, 2024\n"," Regions: US, AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, BR, SE, TR\n"," For the first time, Amazon has provided the ability to integrate Amazon forecasts across all first-party and third-party supply. Using the Reach Forecasting API, you can programmatically generate reach forecasts showing the available reach based on your brand and campaign parameters.\n"," To learn more, view the technical specifications for the Reach Forecasting API.\n"," August 2, 2024\n"," Following the release of the new version 3 reporting endpoints, we are announcing the deprecation of version 2 Sponsored Display reporting with a planned shutoff date of October 31, 2024. This includes the POST /sd/{recordType}/report endpoint.\n"," Going forward, you can access all version 2 Sponsored Display report types using the version 3 reporting endpoints. For more details on how to upgrade to version 3, see our Migration guide and Frequently asked questions.\n"," If you have feedback, use the Amazon Ads API Support page to submit a ticket with the subject title “SD reports v2 deprecation” by August 31, 2024.\n"," August 2, 2024\n"," Advertisers will now be able to create Sponsored Display campaigns in a test account. Test accounts are beneficial because they allow integrators to make API requests to test and learn about the functionality in a safe manner, without serving ads or incurring costs. These campaigns will not be served to shoppers and will not incur any advertising charges. For more information on using test accounts for Sponsored Display campaigns, see our Using test accounts for Sponsored Display documentation in test accounts.\n"," July 31, 2024\n"," You are now able to create, retrieve, and delete Inherited Settings in Manager and Advertiser accounts in the Amazon DSP UI and API.\n"," Inherited Settings enable Managers and Advertisers to set settings that are used as presets when creating a new line item. Our first release includes Display inventory and viewability. We will communicate additional media types and settings when they become available.\n"," For information, see our API documentation.\n"," July 30, 2024\n"," A collaboration is a secure logical boundary in AWS Clean Rooms in which one member (such as an advertiser) can perform SQL queries on configured tables from other members (such as an advertiser partner or other publisher). AMC and advertiser collaborations in AWS Clean Rooms enable AMC customers to use AWS Clean Rooms to associate their first-party (event and identity) data with AMC data, to collaborate with Amazon Ads unique signals including matching audience identifiers enabled by AWS Entity Resolution, and generate differentiated insights to activate more relevant campaigns with Amazon Ads, all without having to share or move your data from your AWS cloud environment.\n"," See the complete list of AMC - AWS Clean Rooms reference.\n"," July 30, 2024\n"," This new playbook provides an overview of off-Amazon signals, how to load signals into AMC, and 12 non-endemic use-cases along with suggested actions. Advertisers can use this playbook to create valuable analysis of and take action with off-Amazon data. To learn more, visit Off-Amazon conversions playbook.\n"," July 30, 2024\n"," Advertisers can now measure their retail and ads brand-category Subscribe & Save (SNS) performance with two new metrics in Brand Metrics.\n","Subscribe & Save customers: Total individual Subscribe & Save customers in the selected category over the selected timeframe. 2. % Subscribe & Save new-to-brand customers: The percentage of Subscribe & Save customers that are new-to-brand in the selected category over the selected timeframe.\n"," For both SNS metrics, we provide Category Median and Category Top benchmarks:\n","Category Median: The performance of the 50th percentile of brands in the selected category. - Category Top: The average performance of the 95th–99th percentile of brands in the selected category.\n"," Advertisers, agencies, and integrators can now understand their brand Subscribe & Save performance within a retail category, and quantify how many shoppers who purchased in a selected week or month are SNS customers and whether or not they have subscribed for the first time with their brand in the TTM (trailing twelve months for example, new-to-brand). Advertisers can also benchmark their ad attributed and retail performance amongst category peers. With these benchmarks brands not running SNS can get insight into the missed SNS opportunities in category, and for brands running SNS they can gauge their performance in category against peers.\n"," SNS data is also available through the Brand Metrics Public API is the /insights/brandMetrics/report/{reportId} endpoint. For full technical details, please read Brand Metrics API Documentation.\n"," July 25, 2024\n"," Regions: CA, MX, BR, UK\n"," Sponsored TV is now available in Canada, Brazil, Mexico, and United Kingdom to enable advertisers access to a self-service streaming TV advertising solution internationally.\n"," Please see our developer guide to get started on Sponsored TV.\n"," July 25, 2024\n"," We have launched a forecasting service for Sponsored TV (ST), allowing Sponsored TV advertisers to view impressions for their campaigns. The Amazon Ads ST forecasting provides forecasts based on the Sponsored TV campaign and ad group settings. Currently, it supports weekly impressions forecasts and will expand to include other forecast metrics in the future. Forecasts are based on machine-learning models that are built on the observable performance of historical campaigns with similar settings. To learn more, view the technical specifications for the forecasting API.\n"," July 18, 2024\n"," The Portfolios version 3 API brings parity between API integrators and the Amazon Ads console, and is the same API used by the console for portfolio functionality. Use this API to group your campaigns and set budgets for a given portfolio and group of campaigns. To learn more, view the technical specifications for the Portfolios API.\n"," July 11, 2024\n"," Regions: All\n"," To offer a more complete view of campaign results, Amazon Ads uses modeling to account for conversions attributable to your campaign, but that are not directly measured due to the phasing out of third-party cookies and changing regulations. In these cases, Amazon Ads has insights about the ad click or view and the conversion that occurred, but cannot establish a direct link between the two events. In that scenario, Amazon Ads predicts the link between the ad interaction and the conversion event. Modeled conversions are reported in the same columns as directly attributed conversions, such as on the Purchase or Detail Page View column. In some cases, if we cannot produce meaningful estimates at the level of your reporting breakdown—for example at the targeting clause level—we will report conversions on an Unallocated row.\n"," Amazon Ads models conversions so that advertisers can continue to measure the full impact of their advertising spend across all audiences, including previously un-addressable audiences, due to industry changes in third-party cookies and regulations. This helps advertisers continue to set and optimize bids and budgets effectively.\n"," Advertisers using Amazon Ads API may see conversions reported on rows with “Unallocated,” or -20, set as the dimension value for reports grouped by targeting, as an example. These rows represent conversions attributable to that ad line or order that cannot be allocated at the level at which the report is returned. For full technical details, please read our reporting documentation. To learn more about modeled conversions, please visit the Support Center\n"," July 8, 2024\n"," Regions: ZA\n"," We have added support for South Africa (ZA) to the Amazon Ads API. For more details, see the API endpoints by region, Bid constraints by marketplace, Budget constraints by marketplace, as well as the countryCode, currencyCode, and timezone parameters in the profiles reference.\n"," July 5, 2024\n"," The API onboarding support team will transition from Jira to Zendesk as our primary platform for managing customer support tickets starting July 8, 2024.\n"," This change aims to provide a more direct and recognizable channel for assistance. If you experience issues onboarding to the API, you can reach our support team directly through the following email address: ads-api-onboarding@amazon.com\n"," Please add ads-api-support@amazon.com, ads-api-onboarding@amazon.com, and support@amazon-ads-api.zendesk.com to your email safe sender list to ensure seamless communication.\n"," For more information about support for the Amazon Ads API, see \"Need support?\" in our Zendesk platform.\n"," June 27, 2024\n"," You are now able to delete and edit audiences with “Failed” status via the AMC UI and API. This allows you to only keep the custom audiences of use to you and reduce redundant audiences. For more information, refer to Manage failed audiences.\n"," June 20, 2024\n"," Legacy Sponsored Brands version 3 campaigns created before October 2022 recently went missing in the advertising console after being rejected during creative moderation.  These servingStatusDetails for these campaigns returns REJECTED_DETAIL in POST /sb/v4/campaigns/list. These campaigns will show as ARCHIVED  in POST /sb/v4/campaigns/list and the advertising console by August 15th, 2024.\n"," To prevent similar issues with version 3 campaigns, we strongly recommend recreating all version 3 Sponsored Brands campaigns as new version 4 campaigns. You can use Sponsored Brands version 4 APIs or clone existing campaigns in the advertising console. To learn more about key benefits of using new ad group based campaigns, see our Benefits guide.\n"," June 13, 2024\n"," In October 2022, Sponsored Brands introduced version 4 campaigns, featuring multiple ad groups and ads. Prior to this launch, advertisers lacked the ability to create a Sponsored Brands advertising campaign aligned with their marketing strategy. The introduction of ad groups enhances flexibility, particular for managing campaigns across ad products, as both Sponsored Products and Sponsored Display supports similar campaigns structure.\n"," These campaigns will allow you to leverage new features such as:\n","Increasing brand impression share for top-of-search placement with BRAND IMPRESSION SHARE goal-based campaigns. 2. Expanding product collection ads into slideshow ads by adding two to five lifestyle images. 3. Assigning individual landing page URLs to each ad and modifying existing landing page ads URLs. 4. Testing different creative and landing page combinations within ad groups. 5. Creating campaigns with vertical video optimized for mobile shoppers. 6. Showcasing videos with a brand store featuring three products or no products. 7. Accessing a wide range of new metrics including addToCartViews, newToBrandDetailPageViewViews, and newToBrandDetailPageViewClicks.\n"," To learn more, view our benefits guide.\n"," June 12, 2024\n"," We recently implemented a feature to prevent duplicate requests for version 3 reporting APIs. If you make a createReport request before a duplicative report request is complete, you will now receive an API response status code of 425, indicating that it is too soon to make the new request. If this happens, you should wait for your existing request to complete before creating another identical createReport request. Learn more about v3 reporting and v3 report statuses\n"," If your use case requires multiple identical reporting requests, we encourage you to explore alternative reporting options such as Amazon Marketing Stream, which pushes data to partner or advertiser-owned AWS destinations in near real-time, without needing to call the API repeatedly.\n"," For more help or technical assistance, reach out to the Solutions Architect or Partner Manager assigned to you. If you do not have an assigned contact, you can request additional support through the API service desk.\n"," June 12, 2024\n"," Regions: US, AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, BE, BR, EG, PL, SA, SE, SG, TR, EG, SA\n"," We launched a new API optimization rules (beta), to simplify the campaign management process for advertisers using Sponsored Brands’ drive page visits goal. This launch allows advertisers to set performance-based parameters that remove the guess work from selecting an exact bid for each target. This helps advertisers of any size and with any budget achieve their goals with the help of Amazon first-party data and machine learning capabilities.\n"," For goal-based campaigns set-up to drive page visits, advertisers can apply a cost-per-click threshold. We will then utilize machine learning models to define the bids while adjusting base bids up and down with the goal of increasing clicks, all while adhering to the cost-based rules. While Amazon Ads cannot guarantee performance, if the campaign is not meeting the cost target over a 21-day period (excluding special days), we recommend adjusting cost target or budget to allow our systems meet the cost target and achieve more clicks.\n"," Optimization rules are now available for Sponsored Brands through the Amazon Ads API. For full technical details, see our see our optimization rules API and developer guide.\n"," June 6, 2024\n"," The conversions_all data source has been updated to remove Amazon Ad Server (previously Sizmek Ad Server) traffic events from the ad-exposed, exposure_type column logic. Additionally, there was an update to the conversions_all data source to negate and resolve duplicative conversions_ids for the repeatSnSOrder conversion event sub-type records.\n"," June 6, 2024\n"," The content in the Support Center contains web-based topics to help you learn how to use and navigate the AMC UI. To access AMC UI documentation in the advertising console Support Center, click the ? icon in the AMC console header, at the top-right of the page and select Learn by Product > Amazon Marketing Cloud. Note that you must have access to AMC UI to access AMC content in Support Center.\n"," June 6, 2024\n"," This new resource, a Jupyter Notebook containing a collection of Python scripts, will help you streamline onboarding the Amazon Ads API and exploring AMC APIs. This includes endpoints for administration and workflow management with example request body and automations that make it easy to manage authorization and explore AMC APIs. You can find the collection files in the GitHub repository for Amazon Marketing Cloud\n"," To use the collection, download the Jupyter Notebook from GitHub, and follow the instructions listed to onboard and get started with AMC.\n"," June 6, 2024\n"," Availability: Only within the US AMC account marketplace\n"," AMC dataset name: ncs_cpg_insights_stream\n"," Lookback: 12.5 month, 19 day delay, and refreshed weekly (on Fridays)\n"," NCS CPG Insights Stream provides modeled offline transaction signals for all US households. Transaction signals (dollars and units) are aggregated at the weekly household level for specified product categories. Transaction signals are acquired from a diverse and balanced set of brick-and-mortar stores in the US covering over 3 million UPCs. The subscription allows AMC customers to measure the impact of your advertising on offline sales, understand cross-channel purchasing journeys, and discern audiences with different purchasing patterns online and offline.\n"," June 3, 2024\n"," Soon, Amazon Marketing Stream will start adding new metrics to existing datasets. Some of these metrics may be in closed beta, so it is possible that you will not have access to the metric values initially and will instead see zero values for the data. We recommend that you ensure your Stream implementation accommodates for new metrics to avoid any breaking changes whenever metrics are added.\n"," We will publish a new release note, along with more guidance about the new metrics, when they are generally available to all customers.\n"," June 3, 2024\n"," With this launch, partners gain visibility into what Amazon account managers suggest for their advertisers. Partners can then determine how to use these recommendations to help their advertisers achieve marketing objectives, including the ability to directly activate them through the new /apply API functionality. Bringing these recommendations into Partner Opportunities gives partners a single distribution channel to download actionable and relevant recommendations for the advertisers each agency or tech partner supports.\n"," Recommendations and insights help advertisers focus more efficiently and spend time on work that is more likely to drive positive results, such as increasing sales or improving return on ad spend (ROAS). Partners have expressed interest in understanding the recommendations from Amazon Ads account teams so they can add context and help activate these recommendations for advertisers. Now, partners can leverage Partner Opportunities API to access these recommendations for each advertiser they manage, giving partners more visibility and flexibility to help advertisers work toward their goals.\n"," This is available to all registered Amazon Ads partners using the Ads API. Partners must be registered in the Amazon Ads Partner Network and setup for API access. For more information on API access for partners, see the onboarding guide.\n"," Within the existing Partner Opportunities API, partners will see new opportunities for each of the new recommendations. These recommendations will be categorized using the AMAZON_ACCOUNT_TEAM_RECOMMENDATIONS Objective Type. Recommendations using this AMAZON_ACCOUNT_TEAM_RECOMMENDATIONS objective type can be used in the new /apply API endpoint to directly activate the recommendations for each specific advertiser. See all Partner Opportunities API documentation for more information.\n"," May 21, 2024\n"," An Amazon Business (AB) bid adjustment for Sponsored Products is in development and will be available in Amazon Business Marketplaces - US, CA, MX, DE, IT, FR, ES, UK, IN, JP. In Q4 2024, advertisers using the Amazon Ads API or bulksheets will be able to apply a custom bid adjustment for placements on AB to their existing or new Sponsored Products campaigns. The new bid adjustment for AB can be set independently or in addition to placement bid adjustments for top-of-search (first page), rest-of-search and product-pages. With this new single AB bid adjustment, advertisers can boost their bids by up to 900% across AB placements. Regardless of their use of the AB bid adjustment, advertisers will have access to reporting that shows campaign performance on AB. Those advertisers who use the AB bid adjustment can gauge its impact on AB campaign performance through this reporting. See our reference documentation for more information.\n"," May 21, 2024\n"," Advertisers in France, Germany, Italy, Netherlands, Spain, Sweden,  United Kingdom and India now have the ability to work with publishers to create programmatic guaranteed deals, and use those deals on video line items. This capability enables advertisers to leverage premium video inventory from publishers through Amazon Publisher Direct (APD), Google, FreeWheel, and Magnite Streaming. When a line item is set to use a programmatic guaranteed deal, the interface is streamlined and simplified to reflect that the publisher will be managing the inventory.\n"," May 15, 2024\n"," Regions: US, AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, BE, BR, EG, PL, SA, SE, SG, TR, EG, SA\n"," We have extended the Sponsored Display optimization rules (beta) API to inflight campaigns enabling advertisers to quickly turn any campaign into optimization rule based campaign while also allowing the feature to be turned on or off. This API helps to simplify the campaign management process for advertisers using Sponsored Display. This launch allows advertisers to set performance-based parameters that remove the guess work from selecting an exact bid for each target.\n"," For campaigns optimized for reach, clicks, or conversions, advertisers can apply a cost-based rule like cost per thousand ad views (vCPM), cost per click (CPC) or cost per order (CPO). We will then utilize machine learning models to define the bids while adjusting base bids up and down with the goal of increasing outcomes, all while adhering to the cost-based rules.  Additionally, we may add targets while your campaign is running to try to stay at or below a cost per order value you have specified. While Amazon Ads cannot guarantee performance, if the campaign is not meeting the cost target over a 21-day period (excluding special days), we recommend adjusting cost target or budget to allow our systems to reach the right audiences.\n"," Optimization rules are now available for Sponsored Display through the Amazon Ads API. For full technical details, see our reference documentation.\n"," May 10, 2024\n"," The Developer Support Engineering team will transition from Jira to Zendesk as our primary platform for managing customer support tickets starting May 13, 2024.\n"," This change aims to provide a more direct and recognizable channel for assistance, streamlining the initial step of ticket creation. Moving forward, you can reach our support team directly through the new email address: ads-api-support@amazon.com\n"," To ensure seamless communication, please add ads-api-support@amazon.com to your email safe sender list. This action will help prevent our communications from being inadvertently marked as spam, allowing us to provide timely and effective support through Zendesk.\n"," As with Jira, the API support team will offer support via the Help Center. Once you have established a login, the Help Center can be accessed at amazon-ads-api.zendesk.com. For more information about support for Amazon Ads advanced tools, see our Support overview.\n"," May 10, 2024\n"," For streaming TV ad-impressions delivered on Freevee, we have expanded our traffic reporting to add content transparency reports in downloadable reports. Advertisers can now see which Content Genre and Content Rating their ad impressions were delivered on. Advertisers can already use Content Genre, and Content Rating during planning and campaign settings. These reports provide advertisers a closed loop feedback with their campaign settings and media plans.\n"," As advertisers transition their budgets from linear TV to digital media like streaming TV, content signals provide them greater visibility into their investments. Advertisers can now assess if their ads were contextually relevant and use the reporting data to plan their future media investments and adjust their campaign settings.\n"," May 3, 2024\n"," Following the release of the new version 3 reporting endpoints, we are announcing the deprecation of version 2 Sponsored Display reporting with a planned shutoff date of October 31, 2024. This includes the POST /sd/{recordType}/report endpoint.\n"," Going forward, you can access all version 2 Sponsored Display report types using the version 3 reporting endpoints. For more details on how to upgrade to version 3, see our Migration guide and Frequently asked questions.\n"," If you have feedback, use the Amazon Ads API Support page to submit a ticket with the subject title “SD reports v2 deprecation” by August 31, 2024.\n"," May 3, 2024\n"," Sponsored Brands campaign performance forecasting provides metric forecasts to advertisers during the campaign creation process.\n"," Currently we have impression metrics for detail page view campaigns which gives the estimated weekly and monthly impression based on targeting, bid, and budget settings. Now we are adding support for click forecasting. To use click forecasting, you will need to add creativeAsins in the ad group setting to help us predict the clicks for campaign. Then the response will include forecasted clicks.\n"," For more information, see the API reference.\n"," May 1, 2024\n"," Amazon Marketing Stream is expanding its data delivery options by introducing Amazon Data Firehose as a new destination. Amazon Data Firehose is a fully managed service for delivering real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Redshift, OpenSearch Service, OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers. With Amazon Data Firehose, customers can subscribe to Amazon Marketing Stream datasets and have them delivered to a location of their choice—including the options mentioned here. Without Firehose, Stream datasets can only be delivered to Amazon SQS, so Firehose provides more flexibility for customers who prefer a different data output.\n"," By integrating Amazon Data Firehose as a delivery option, customers can streamline their data ingestion process and minimize operational costs. As a fully managed service, it automatically scales to accommodate data volume, and eliminates the need for ongoing administration. Additionally, Firehose can batch, compress, and encrypt data before delivery—reducing storage consumption at the destination and enhancing security.\n"," To learn more, view the Getting started guide .\n"," April 23, 2024\n"," Regions: US\n"," Keyword Groups is a new targeting control for Amazon Ads Sponsored Products keyword-based campaigns that enables advertisers to reach relevant audiences through a collection of keywords.\n"," Once a Keyword Group specification is created, the performance of Keyword Groups will be available in the search terms report. Keyword Groups improves campaign performance by dynamically updating the keywords within a group through the campaign lifecycle and eliminates the need for advertisers to constantly curate new keywords. Additionally, Keyword Groups can be used alongside keywords within the same ad group.\n"," Keyword Groups can be accessed through a new Keyword Groups recommendations API included in this release. Furthermore, existing operations for bid suggestions and viewing/updating have been updated to accommodate Keyword Groups.\n"," APIs:\n","POST /sp/targeting/recommendations/keywordGroups: Use this API operation to get recommended Keyword Groups for a list of ASINs. Please use Keyword Groups recommended by this API for your ASINs to benefit from the feature only.  POST /sp/targets: This is an existing operation that has been extended to support creation of Keyword Groups.  POST /sp/targets/list: This existing operation will return all Keyword Groups for an ad group \\* POST /sp/targets/bid/recommendations : This existing API endpoint now gives bid recommendations for Keyword Groups with the following options. See theme based bid recommendations API documentation for more information.\n"," See our documentation for more information.\n"," April 20, 2024\n"," As we recently announced AMC APIs being available on Amazon Ads, we recommend users currently on the AMC instance-level APIs migrate to the upgraded APIs as soon as possible to take advantage of the enhanced security, usability, and performance of new APIs.\n"," After the instance-level APIs retire, calling any of the endpoints will return a 404 error. Migrating to the new APIs at the earliest can help prevent disruptions to your existing business operations. Visit the AMC migration hub to learn more.\n"," In addition, new AMC instances created after March 04, 2024 will not be compatible with the instance-level APIs. You need to build to Amazon Ads APIs before this date to make sure your API workflows can be applied to your new instances.\n"," April 18, 2024\n"," The shutoff date for Sponsored Brands version 3 campaign management APIs will be May 30th, 2024. As a reminder, Sponsored Brands version 3 draft and media APIs were deprecated on January 31, 2024. Please migrate to the new version 4 campaign management endpoints as documented on our deprecations page and in our migration guide. As a part of this deprecation, Sponsored Brands draft endpoints have reached their end of life and will not be replaced with new endpoints.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/sb/campaigns/  /sb/adGroups/  /sb/adGroups/{adGroupId}  /sb/campaigns/{campaignId}  /sb/drafts/campaigns  /sb/drafts/campaigns/{draftCampaignId}  /sb/drafts/campaigns/submit  /media/upload  /media/complete\n"," If you would like to share feedback, please use the Amazon Ads API Service desk to open a ticket with subject title \"SB v3 Campaign CRUD Deprecation\" by April 30th, 2024.\n"," April 18, 2024\n"," These new capabilities are in preview only. We will update our release notes and API documentation once this functionality is made available. Advertisers will soon have access to two new goals, “Acquire New Customers\" and “Drive Ad Views”, each with a unique set of campaign controls that help achieve that goal. The “Acquire New Customers\" goal can be measured using the metric newToBrandPurchases, helping advertisers drive sales from customers who have not purchased a brand product within a 1-year lookback. The “Drive Ad Views\" goal can be measured using the metric viewableImpressions, helping advertisers reach and engage audiences across shopping and entertainment contexts.\n"," Along with the new goals mentioned, advertisers will soon have the option to input specific cost controls to help achieve those goals within a given cost threshold. As we introduce these changes, we will also update and improve our insights and recommendations to help further maximize campaign goals.\n"," For full technical details, see our updated Sponsored Brands API reference documentation. Under the create campaign resource, we have expanded the number of goal options, including ACQUIRE_NEW_CUSTOMERS and AD_VIEWS.\n"," April 9, 2024\n"," Regions: All\n"," Amazon Ads API customers can now invite users to advertising accounts entirely through API integration. They can perform all invitation-related operations throughout the invitation lifecycle, including creating, redeeming, revoking, listing, and resending invitations.\n"," Previously, all user management functionality was only available through the advertising console. This launch marks the first milestone in a series of authorization API launches, which will allow customers to execute invitation and user management-related actions entirely via the Amazon Ads API, without the need to visit the advertising console. Customers can now use the API to create and manage user invitations for sponsored ads accounts, including vendors, authors, merch-on-demand, and FireTV. This new user invitation functionality is also available for manager accounts and Amazon DSP. By integrating with these APIs, third-party partners can also build user invitation workflows on their own advertising platforms.\n"," New APIs:\n","POST /user-invitations: Create a batch of invitations. Given an advertising account identifier, a user email address, and a role or set of permissions, invite one or many (up to 50 in batch) users to the advertising account. Invitations expire after 2 weeks.  PUT /user-invitations: Update a batch of invitations. Given a list of one or many (up to 50) invitation identifiers, update these invitations to revoke them, or resend them to refresh the expiration window.  PUT /user-invitations/redeem: Redeem an invitation. Given an invitation identifier, redeem the invitation, and be added to the account upon redemption. This operation requires that the terms agreement be shown to the user and accepted before redemption.  POST /user-invitations/list: List the pending invitations for a given account.  GET /user-invitations/{invitationId}: Get details about a given invitation, such as role, permissions, email, expiration and account identifier. This API will also return a list of termsTypes, which indicates the type of terms (MARKETING_CLOUD, ADVERTISING, PARTNER_NETWORK) that must be accepted before redemption, using the POST /termsTokens API.\n"," See our reference documentation for more information.\n"," In addition, we have updated the existing POST /termsTokens API.\n","POST /termsTokens: Create a terms token for the customer to accept Amazon Ads terms. With this update, you can now specify the type of terms to be accepted (MARKETING_CLOUD, ADVERTISING, PARTNER_NETWORK) depending on the type of account the user is invited to. For more information, see the API specification.\n"," April 4, 2024\n"," Region: EU\n"," The Ad Library API is now available. The Ad Library API contains data about ads and affiliate marketing content displayed on the Amazon EU store (Germany, France, Italy, Spain, Sweden, Poland, Belgium, Netherlands) and is available globally. Examples of data include advertiser or creator name, impressions by country, and the name of the product, service, or brand featured.\n"," To get started, view the Ad Library overview.\n"," April 3, 2024\n"," This summit is designed to educate integrators who are at the beginning and intermediate stages of their journey with Amazon Ads APIs, Amazon Marketing Stream, and Amazon Marketing Cloud (AMC). You will learn about best practices and hear ideas for capabilities you can build. We will deep dive into Amazon APIs and reporting tools and share advanced use cases. Hear from Amazon product leaders about topics that include:\n","Enhancing reporting and optimization capabilities - Building full-funnel solutions for a variety of advertising customers - Media planning and programmatic capabilities - And much more!\n"," There will also be opportunities to get answers to your technical questions and provide product feedback. The summit will be held on May 16-17, 2024 in NYC.\n"," March 18, 2024\n"," Advertisers in Japan, Saudi Arabia, Turkey, and United Arab Emirates now have the ability to work with publishers to create programmatic guaranteed deals, and use those deals on video line items. This capability enables advertisers to leverage premium, video inventory from publishers through Amazon Publisher Direct (APD), Google, FreeWheel, and Magnite Streaming. When a line item is set to use a programmatic guaranteed deal, the interface is streamlined and simplified to reflect that the publisher will be managing the inventory.\n"," Programmatic guaranteed deals enable direct-buys between advertisers and publishers, while still tapping programmatic model benefits. By using programmatic guaranteed deals, advertisers can access additional video inventory, help reduce manual campaign activation and management processes, and work with publishers on contextual targeting. This can help advertisers save time, become more efficient, meet their delivery goals, and help customers discover new brands.\n"," See our reference documentation for more information.\n"," March 18, 2024\n"," Regions: BE, BR, EG, PL, SA, SE, SG, TR, EG, KSA\n"," We have expanded Sponsored Display optimization rules (beta) API to new regions. This API helps to simplify the campaign management process for advertisers using Sponsored Display. This launch allows advertisers to set performance-based parameters that remove the guess work from selecting an exact bid for each target. This helps advertisers of any size and with any budget achieve their goals with the help of Amazon first-party data and machine learning capabilities. Before this launch, advertisers needed to translate their desired goals into efficient bids and targets across different cost types. In reality, this turns out to be the biggest issue driving lower scale and campaign effectiveness. By translating goals into bids using machine learning with optimization rules (beta), Amazon can help advertisers achieve better results through continuous optimization. In the future this will be extended to targeting optimizations to further maximize goals.\n"," For campaigns optimized for reach or click, advertisers can apply a cost-based rule like cost per thousand ad views (vCPM) and cost per click (CPC). We will then utilize machine learning models to define the bids while adjusting base bids up and down with the goal of increasing outcomes, all while adhering to the cost-based rules. While Amazon Ads cannot guarantee performance, if the campaign is not meeting the cost target over a 21-day period (excluding special days), we recommend adding additional targets to allow our systems to reach the right audiences.\n"," Optimization rules are now available for Sponsored Display through the Amazon Ads API which was previously only available in AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK and US regions. For full technical details, see our reference documentation(sponsored-display/3-0/openapi#tag/Optimization-Rules-(beta)).\n"," March 14, 2024\n"," These premium video ad placements are represented via the enumerated DSP supply sources listed below:\n","Sports on Prime (including TNF and NBA): supply_source = ‘AMAZON LIVE STREAM’ (supply_source_id: 610) \\* Prime Video (on-demand content): supply_source = ‘Prime Video ads’ (supply_source_id: 623)\n"," Both of these DSP supply sources are eligible to produce events within the DSP traffic tables, as well as the joined traffic and conversion event feeds below:\n","dsp_impressions  dsp_views  dsp_clicks  dsp_impressions_by_matched_segments  dsp_impressions_by_user_segments  amazon_attributed_events_by_conversion_time  amazon_attributed_events_by_traffic_time\n"," March 14, 2024\n"," We have released new overview and tutorial content for Sponsored TV. This content helps you create a Sponsored TV campaign and understand its structure and how to create and preview video creatives.\n"," Find all new Sponsored TV content under Sponsored TV > Overview.\n"," Also see our updated Postman collection, where we have added new Sponsored TV request templates.\n"," March 14, 2024\n"," AMC customers now have access to Sponsored TV (ST) signals if the corresponding Sponsored Ads entities are mapped to their AMC instances. The signals can be identified by applying the filter ad_product_type = 'sponsored_television' in the following tables:\n","amazon_attributed_events_by_traffic_time  amazon_attributed_events_by_conversion_time  sponsored_ads_traffic\n"," March 14, 2024\n"," This includes publication of a new column, sns_subscription_id, within the conversions_all schema. The sns_subscription_id is the identifier for the Subscribe and Save (SnS) enrollment and can be used as a join_key for subscription and fulfillment events within the SnS series. Specific to the conversions_all dataset the SnS events are associated with the conversion event subtypes listed below, and are eligible for data decoration within the sns_subscription_id column:\n","snsSubscription  firstSnSOrder  repeatSnSOrder\n"," For all other conversion event datasets, the SnS events are associated with the conversion event subtypes snsSubscription and order, and will not include reference to the sns_subscription_id data attribute.\n"," The above applies to all of the equivalent audience tables. SnS retail events are resolved and joined to advertising data feeds with the user_id_type = adUserId. SnS retail events have an initial publication (backfill) date within AMC of June 2023; there are no SnS retail events within AMC prior to this date.\n"," For more information, refer to the Instructional Query (IQ): Introduction to Subscribe and Save (SnS) repeat purchases (link only available for AMC UI users).\n"," March 7, 2024\n"," Regions: US, CA, MX, BR, UK, DE, FR, IN, ES, IT, AE, SA, NL, SE, TR, JP, AU\n"," In January, we announced the launch of the persona builder API in beta. This feature is now generally available for Amazon DSP users.\n"," The persona builder API takes an audience expression, representing a persona, as input. The API returns aggregated insights for that persona. An advertiser can call the API to save an audience expression to Amazon DSP as a “combined audience.”\n"," To get started, view the API reference.\n"," March 6, 2024\n"," We are excited to launch Amazon DSP reports on the latest version (version 3) of the Amazon Ads API as Open Beta. This release provides agencies, brands, and service providers with Amazon DSP reporting in addition to the existing Sponsored Ads reports. The new reports adhere to a common request and response schema we introduced with V3 reports, and provide customers with the same benefits currently available for Sponsored Ads reports: the ability to select date ranges, standardized metric names, and better reports availability over version 2.\n"," This release launches the following reports on V3 reporting for Amazon DSP: Campaign, Inventory, Geography, Technology, Audiences, Off-Amazon, Product, and Conversion Source, in addition to the already migrated Campaigns and Inventory reports. With this release, customers will find better consistency between Amazon DSP reports and those for other ad products.\n"," The new Amazon DSP reports come with standardized metric names allowing consistent naming across all ad product reports. This will enable customers to easily compare metrics across ad product reports. Another major change with this release is using a 14-day attribution window for all applicable Amazon DSP metrics. We dropped deprecated metrics and attribution suffixes in metric names from the reports, making it easier to read and analyze reporting information.\n"," For full technical details, please see our updated documentation in the advanced tools center.\n"," March 5, 2024\n"," All snapshots endpoints are now deprecated, with a target shutoff date of October 15, 2024. Please migrate to the exports API as indicated on our Deprecations page.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/{recordType}/snapshot - /snapshots/{snapshotId} - /v2/sp/{recordType}/snapshot - /v2/sp/snapshots/{snapshotId} - /v2/sp/snapshots/{snapshotId}/download - /v2/hsa/{recordType}/snapshot - /v2/hsa/snapshots/{snapshotId} - /v2/hsa/snapshots/{snapshotId}/download - /sd/{recordType}/snapshot - /sd/snapshots/{snapshotId} - /sd/snapshots/{snapshotId}/download\n"," For more details on integrating with exports, see the Exports overview.\n"," February 28, 2024\n"," Regions: All\n"," In 2023, we deprecated Pixel functionality within Amazon DSP in a phased manner to provide enough time for advertisers to migrate over to our durable alternative, Amazon Advertising tag.\n"," As we approach Chrome third-party cookie deprecation in the second half of 2024, we plan to shut off legacy Pixel APIs in Amazon DSP by August 1, 2024. We recommend all advertisers currently using Pixels to migrate to Amazon Ad Tag at the earliest. View the deprecation details for more information.\n"," February 28, 2024\n"," Region: EU\n"," We have launched the new traffic events API. This is a data clean room-based service that helps advertisers access event-level data (such as clicks, views and impressions) for eligible EU campaigns. This data can be queried using standard SQL syntax within the body of the traffic events API call. The traffic events API will return results if the advertiser account ID you include in the API call is associated with any eligible campaigns. For full technical details, please visit the traffic events API overview.\n"," February 28, 2024\n"," We have updated the Amazon Ads API compatibility and versioning policy to clarify our approach to enumerated fields and values. For details, see Compatiblity and versioning.\n"," February 20, 2024\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, TR, AE, SA, AU, JP, IN, SG, BR\n"," Sponsored Products budget recommendations and missed opportunities insights are now available in Amazon Marketing Stream. Until today, Sponsored Products budget recommendations and missed opportunities insights were only available to advertisers via the Amazon Ads API. We are excited to now support this insight via Amazon Marketing Stream. This provides an unmodified view of budget recommendations and missed opportunities, which include the additional clicks, impressions and sales from the past 7 days that the campaign could have received had it stayed in budget for the hours it was out of budget.\n"," Sponsored Products budget recommendations and missed opportunities via Amazon Marketing Stream addresses two use cases: 1) delivery of recommendations in near real-time when a campaign goes out of budget, and 2) delivery of recommendations for all campaigns owned by a subscribed advertiser with no additional API calls beyond the initial subscription.\n"," Amazon Marketing Stream is available via the Amazon Ads API. When you are ready to get started, visit our Amazon Marketing Stream onboarding guide that will walk through the process of getting API access, integrating with AWS, and subscribing to campaign datasets using the Amazon Marketing Stream API.\n"," February 15, 2024\n"," Sponsored Brands is making changes to requirements for the product collection ad format. Beginning January 31, 2024, new Sponsored Brands campaigns using the product collection ad format created using the API or Amazon advertising console will require a custom image that meets policy. We will begin enforcing this requirement for all product collection ads on May 31st, 2024. We recommend migrating to the new /sb/v4/ads/productCollectionExtended endpoint which requires a custom image as part of ad creation. The previous /sb/v4/ads/productCollection and /sb/ads/creatives/productCollection will be deprecated, with a target shutoff date of November 30, 2024. The /sb/v4/ads/productCollectionExtended also allows advertisers and partners to create a slide show for product collection ads using collection of custom images and edit their ad landing pages.\n"," In addition, existing product collection ads that do not contain a custom image will stop serving after May 31, 2024. To remediate, we highly recommend that you either use the Amazon ad console to update your product collection campaigns with custom images or use the /sb/ads/creatives/productCollection or /sb/ads/creatives/productCollectionExtended endpoints to update your creatives.\n"," Learn more about product collection and production collection extended ads in the FAQs. If you would like to share feedback, please use the Amazon Ads API Service Desk to open a ticket with subject title \"ASIN only Deprecation\" by March 30, 2024.\n"," February 15, 2024\n"," As we recently announced new version of Sponsored Brands product collection ads APIs on Amazon ads, we recommend advertisers and partners to start migrating to the /sb/v4/ads/productCollectionExtended and /sb/ads/creatives/productCollectionExtended APIs as soon as possible to take advantage of creating the product collection slide show for product collection ads, and edit landing pages of product collection ads.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/sb/v4/ads/productCollection \\* /sb/ads/creatives/productCollection\n"," If you would like to share feedback, please use the Amazon Ads API Service Desk to open a ticket with subject title \"Product collection Ads API Deprecation\" by April 30, 2024.\n"," February 15, 2024\n"," Regions: All\n"," Brand Store quality metrics and recommendations are now available with the Amazon Ads API. Now you can access your Store average dwell time, how you compared to peer groups on Amazon, your Store quality rating, and a list of recommended actions you can take to improve your Store quality and performance. A high rating means that you have taken actions that Amazon believes will increase the duration that shoppers spend on your Store (dwell time). We use your Store rating to recommend specific actions that may help improve your Store performance and dwell time.\n"," Learn more about Brand Store insight metrics.\n"," February 14, 2024\n"," Regions: US, CA, MX, BR, JP, SG, AU\n"," Sponsored Brands introducing a landing page edit for Product Collection, Store Spotlight and Brand Video Ads. Advertisers and Partners are now able to change their ads landing page without recreating a new campaign or ad group. Now, each ad can have individual landing pages within same ad group. You can now update your ad group based campaigns landing pages without recreating new ad group or campaign. For editing a landing page, advertisers and partners can use /sb/ads/creatives/productCollectionExtended for Product Collection ads, /sb/ads/creatives/storeSpotlight for Store Spotlight ads, and /sb/ads/creatives/brandVideo for Brand Video ads.\n"," For full technical details, please see the updated documentation on /sb/ads/creatives/productCollectionExtended,  /sb/ads/creatives/storeSpotlight and /sb/ads/creatives/brandVideo.\n"," February 14, 2024\n"," Regions: All\n"," Sponsored Brands introducing a new creative Slideshow ads, that will appear at the top of search results page. Slideshow ads are an extension of the existing lifestyle creative, with a carousel of 2-5 lifestyle images that will auto-rotate. Shopper can engage with the slideshow by pausing it at any point in time or switching between different images by making forward or backward swipes.\n"," Advertisers can create the new slideshow using POST /sb/v4/ads/productCollectionExtended where advertiser can provide collection on lifestyle images representing the brand. You can also edit your existing Product Collection creatives using POST /sb/ads/creatives/productCollectionExtended where advertiser can add collection of lifestyle images to convert those ads into slideshow. For more details, see Slideshow ads creative.\n"," For full technical details, please read our documentation.\n"," February 14, 2024\n"," Regions: All\n"," We have added support for ads to the exports API. Previously, the exports API was only available for campaigns, ad groups, and targets.\n"," An ad represents the smallest unit of an advertising campaign, including what a customer sees and how they interact with the ad. As part of this release, we have aligned on a common model for all ad types across sponsored ads campaigns. To learn more about the common ad model, see Ads.\n"," With this release, exports now include all functionality provided in snapshots. For more details, see the Exports overview.\n"," To get started with target exports, see:\n","Exports tutorial \\* Exports API reference\n"," February 13, 2024\n"," Regions: US\n"," We have launched three new fields available in the public API for “line item creative associations,” which provide the creative line item association status. These fields are state, associationModerationStatus, and associationModerationReasons, and they can be used to determine which line items the creative is approved or not approved to run on based on policies.\n"," As part of the line item moderation capability, these fields help you determine if a creative is approved to run based on moderation policies.\n"," For full technical details, please read our documentation.\n"," February 13, 2024\n"," Regions: All\n"," Advertisers can now launch vertical video campaigns with a Store as the landing page. Vertical video is available under “Drive page visit” goal, enabling advertisers to highlight a collection of one, two, or three advertised products. Under the “Grow brand impression share” goal, advertisers can launch a video campaign without, or with one, or two, or three advertised products. Shoppers clicking on an advertised product will visit the product detail page; shoppers clicking on any other ad element will visit the brands Store on Amazon. Shoppers will be able to discover the brands they love today - and learn about the brands they will crave tomorrow - with vertical video creatives. Shoppers can explore brands and visit the Amazon Store to learn more about the brand ethos, or explore advertised products by clicking on any of the displayed products. Advertisers will be able to re-use their existing vertical videos from social media, and find new creative ad formats to share their brand story.\n"," For full technical details, please see the updated documentation on Sponsored Brands video.\n"," February 1, 2024\n"," Advertisers and partners can now troubleshoot their Sponsored Products campaigns for any product eligibility, ad policy, or featured offer competitiveness issues by calling the campaign diagnostics API. This API allows partners to programmatically fetch an aggregated list of issues across supported issue types (product eligibility, ad policy, featured offer competitiveness) for a single Sponsored Products campaign or list of Sponsored Products campaigns through a single API call.\n"," Previously, API users had to call separate APIs for product eligibility and ad policy troubleshooting, each taking different entity type (SKU, AdID respectively), then consolidate the results to get an overview of issues impacting their Sponsored Products campaigns. The campaign diagnostics API removes the discovery and cognitive load associated with troubleshooting a Sponsored Products campaign by presenting an aggregated view along with an impact assessment of the issue across the campaign.\n"," For more details, see the technical specifications for the campaign diagnostics API.\n"," January 31, 2024\n"," We have expanded the Amazon Ads payment registration APIs to support credit card and direct debit. Third-party clients can now integrate with the Amazon Ads billing APIs to register credit card and direct debit payment methods, as well as view metadata related to such registrations.\n"," For more details, see the technical specifications for the billing APIs.\n"," January 30, 2024\n"," Regions: All\n"," Amazon Ads is introducing a new, personalized experience for developers using the Amazon Ads API. With this release, developers can now log in to the advanced tools center to view key metrics and trends related to their Amazon Ads API integration.\n"," The logged-in experience displays information about your Login with Amazon application and includes an interactive dashboard showcasing API activity. The integration dashboard can help you monitor your integration health, explore trends, and identify inefficiencies in your call patterns. Available breakdowns include calls by response code, product, marketplace, API resource, and hourly call volume.\n"," Access the new experience directly from the Amazon Ads advanced tools center by signing in using your developer.amazon.com account credentials. Once logged in, you can view the Login with Amazon applications associated with your Amazon Developer account. Select an application that has access to the Amazon Ads API to view the integration dashboard.\n"," To learn more, see Integration dashboard.\n"," January 19, 2024\n"," Regions: US, CA, MX, BR, UK, DE, FR, IN, ES, IT, AE, SA, NL, SE, TR, JP, AU\n"," You can now better understand your audiences and create your own custom brand personas with persona builder. Using Amazon insights, you can discover and validate audience shopping and streaming behaviors. Then, seamlessly save and activate those same audiences through your Amazon Ads campaigns.\n"," Persona builder enables you to use Amazon first-party insights to learn more about your audiences, such as their interests and relevant life events. You can create your own custom brand personas by combining existing audiences into a single persona. For example, if you are releasing a premium headphone with fitness branding, you can create a persona by combining the Amazon “interested in technology,” “in market for headphones,” and “in market for fitness clothing” segments. You can reach your personas on Amazon and beyond by saving them to Amazon DSP.\n"," Persona builder API takes an audience expression, representing a persona, as input. The API returns aggregated insights for that persona. An advertiser can call the API to save an audience expression to Amazon DSP as a “combined audience.”\n"," The following are the key API endpoints:\n","POST /insights/bandedSize: Get the size range for the input audience; - POST /insights/demographics: Get aggregated demographic insights for the input audience; - POST /insights/topOverlappingAudiences: Get top audiences overlapping with the input audience; - POST /insights/topCategoriesPurchased: Get top retail categories purchased by the input audience; - POST /insights/primeVideo: Get insights on top content streamed on Prime Video by the input audience; - POST dsp/audiences/combinedAudiences: Create a combined audience based on the input audience expression.\n"," January 15, 2024\n"," Advertiser Data Upload APIs (ADU 2.0) allows users of AMC to bring their own first-party datasets into AMC for custom and advanced analysis use-cases, such as audience overlap reports, custom attribution, frequency analysis, comparison of off-Amazon behaviors to Amazon advertising events, or analysis by product/ASIN. For more details, refer to Advertiser data upload.\n"," January 15, 2024\n"," As we recently announced AMC APIs being available on Amazon Ads, we recommend users currently on the AMC instance-level APIs migrate to the upgraded APIs as soon as possible to take advantage of the enhanced security, usability, and performance of new APIs.\n"," After the instance-level APIs retire, calling any of the endpoints will return a 404 error. Migrating to the new APIs at the earliest can help prevent disruptions to your existing business operations. Visit the AMC migration hub to learn more.\n"," In addition, new AMC instances created after March 04, 2024 will not be compatible with the instance-level APIs. You need to build to Amazon Ads APIs before this date to make sure your API workflows can be applied to your new instances.\n"," January 10, 2024\n"," Technology partners now have globalized registration and account APIs, available in open beta, to offer advertisers an integrated Amazon Ads onboarding experience from within other platforms. They can also get all accounts of a user with a single, global API call. Advertisers that are eligible for multiple countries now get one advertising account that spans all countries through a new globalized account ID. Each country does have its own ID specific to each advertiser, which you will need to make individual requests for most other APIs.\n"," Previously, ads account registration was only available through the Amazon UI. Once an account was created, advertisers could authorize them to technology partners in the context of a single country, where partner APIs needed to call different endpoints in different regions to compile the countries. Now, they can register a single account globally and get all countries and profile IDs with a single request.\n"," Available APIs:\n","Accept Terms and Conditions: All registrations must be accompanied by acceptance of the Amazon Ads Agreement. Anyone registering must be presented with the terms and acknowledge agreement. To register, partners must call to get a terms token and activate it by agreeing to terms. Partners can call to check the activation status of the token. - POST /adsAccounts: Register an account. Given a Seller Central account ID, Vendor Central ID, or business details, tech partners can request an ads account. An account ID will immediately be created and returned synchronously, while the individual countries are created asynchronously. - GET /adsAccounts/{advertisingAccountId}: Get details for an account. For registration status, Amazon will return a status of created, pending, partially created or disabled. Additional globalized metadata is available, such as the profile ID and entity ID for each country within the ads account. - POST /adsAccounts/list: List details for all ads accounts to which the authorized user account has access.\n"," For more information, see the user guides for creating accounts and retrieving accounts or view the API specification.\n"," January 5, 2024\n"," AMC now has access to off-Amazon signals from Amazon DSP Events Manager including Amazon Ad Tag (AAT), Conversions API (CAPI), and Mobile Measurement Partner (MMP) integrations.\n"," With this launch, signals from 10/20/2023 are available.\n"," As part of this launch, two new dimensions (conversion_event_source, and conversion_event_name), and three new metrics (off_amazon_product_sales, off_amazon_conversion_value, and combined_sales) have been added to the following tables:\n","amazon_attributed_events_by_traffic_time  amazon_attributed_events_by_conversion_time  conversions  conversions_all  conversions_with_relevance \\* All equivalent audience tables\n"," To know more about these signals, and how to use them in your analysis, please refer to the new Instructional Query (IQ): Introduction to Events Manager.\n"," January 4, 2024\n"," Regions: US, CA, MX\n"," Advertisers using Sponsored Display can now drive traffic to their Store pages. By launching this new capability, Amazon Ads enables advertisers to use their Sponsored Display images or video ads to redirect shoppers to their Store landing page.\n"," By enabling all creatives within Sponsored Display to link to Stores, advertisers can reach audiences along their shopping and entertainment journey while helping to increase traffic to their Store pages. Sponsored Display allows advertisers to reach shoppers across their entire shopping and entertainment journey, in the Amazon store or third-party destinations. By focusing on driving specific goals using either audiences or contextual targeting, advertisers can quickly set-up powerful display campaigns that link directly to their Store pages.\n"," This new feature drives brand growth by introducing shoppers to a broader product catalog and increasing direct engagement through the Store environment using more Amazon Ads products. Linking back to Store pages allows brands to tell their story in their own voice, without any distractions from other brands or offers.\n"," For full technical details, including the updated landingPageURL for STORE now available within Sponsored Display productAds.\n"," January 4, 2024\n"," Regions: US, CA, DE, ES, BE, NL, SE, EG, AE, SA, JP, IN\n"," In any given marketplace, customers have the option to shop in various languages. For example, on amazon.com in the US, English is the default language, but we also have a full Spanish language experience for customers who select Spanish as their language of preference. We have released a new translation feature that automatically translates Sponsored Display custom creatives to all supported languages within a marketplace. This expands visibility of Sponsored Display, while also providing shoppers with a more seamless experience, enabling them to engage with Sponsored Display ads in the language they have selected.\n"," Previously, Sponsored Display custom creatives ads were only shown in the default language of each marketplace. This feature launch allows for all custom creative ads to be automatically translated, for free, with no extra input required from advertisers, making the ads available for secondary language shoppers to see and engage with.\n"," For full technical details related to Sponsored Display creatives, please see the API reference.\n"," January 2, 2024\n"," Regions: US, UK, DE, FR, IT, ES\n"," We are excited to announce that Sponsored Brands version 4 campaign management API now supports author advertisers. Advertisers, agencies, and tool providers can leverage these APIs to create and manage ad group-based campaigns for authors, which are similar to the advertising console. When setting up a new Sponsored Brands campaign, authors will need to first claim the book, KDP or traditionally published, in their Author Central (A2C) account. The existing Sponsored Brands Ad eligibility still apply.\n"," For full technical details, please see the API reference.\n"," January 2, 2024\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, EG, TR, AE, SA, AU, JP, IN, SG, BR\n"," Sponsored Brands has launched a new API that provides forecasts of impressions based on your campaign settings. Impressions forecasts are an estimate of the number of times your ad(s) will be displayed. These forecasts are available for campaigns with a single ad group that have selected the “Drive page visits” goal-based campaign control. Forecasts are based on machine-learning models that are built on the observable performance of historical campaigns with similar settings. They are not a guarantee of actual impressions.\n"," For full technical details, please see the API reference.\n"," December 26, 2023\n"," A new field, campaign_id_string, was added to the following AMC data sources:\n","sponsored_ads_traffic  amazon_attributed_events_by_conversion_time  amazon_attributed_events_by_traffic_time  conversions_with_relevance  dsp_impressions  dsp_views  dsp_clicks  dsp_impressions_by_user_segments  dsp_impressions_by_matched_segments\n"," This column is the campaign identifier presented as a string datatype. For DSP campaign events, this value will populate with the same value as the campaign_id column and represented the DSP order id. For Sponsored Ads events, this value will populate with the alphanumeric campaign id string that is associated with the Sponsored Ads campaign object settings. For data sets that join traffic and conversion events, this column will be populated for both Sponsored Ads and DSP traffic events, whereas the legacy campaign_id column will only be populated for DSP events. When conducting SQL joins across data sets or implementing SQL filtering within WHERE statements, please ensure the proper data type has been selected, campaign_id(long data type) versus campaign_id_string (string data type).\n"," Additionally, winning_bid_cost field was updated to reflect a \"soft deprecated\" status. The column will still function within AMC SQL queries and populated with LONG data type values, however, it is not recommended for use within customer analysis and insights generation. This value is in the process of being deprecated by upstream data providers from whom AMC sources data attributes for DSP impression events. The winning_bid_cost column is published into the following data sources, and their corresponding \\_for_audiences data sources:\n","amazon_attributed_events_by_conversion_time  amazon_attributed_events_by_traffic_time  dsp_impressions  dsp_clicks  dsp_impressions_by_user_segments \\* dsp_impressions_by_matched_segments\n"," December 26, 2023\n"," AMC launched support for the following most commonly used statistical functions in SQL. These functions can be used in AMC queries, to perform statistical analysis on event-level data.\n","STDDEV_POP: Returns the standard deviation of a set of numeric values, when the values represent the entire population. - STDDEV_SAMP: Returns the standard deviation of a set of numeric values, when the values are for a sample set of data and not the entire population. - STDDEV: An alias for STDDEV_SAMP. Returns the standard deviation of a set of numeric values, when the values are for a sample set of data and not the entire population. - VAR_POP: Returns the variance of a set of numeric values, when the values represent the entire population. - VAR_SAMP: Returns the variance of a set of numeric values, when the values are for a sample set of data and not the entire population. - VARIANCE: An alias for VAR_SAMP. Returns the variance of a set of numeric values, when the values are for a sample set of data and not the entire population. - SKEWNESS: Returns the estimate of the skewness of a set of numeric values. Skewness is a measure of the asymmetry of the distribution. A positively skewed distribution has a thicker upper tail than lower tail, while a negatively skewed distribution has a thicker lower tail than upper tail. A normal distribution has a skewness of zero. - PERCENTILE: Returns the value at a given percentile of a distribution of values. - APPROX_PERCENTILE: Returns the approximate, discrete percentile value. - MEDIAN: An alias for PERCENTILE(&lt;value>, 0.5). Calculates the median value for the range of values.\n"," See AMC SQL reference for a list of SQL functions AMC supports.\n"," December 26, 2023\n"," December 26, 2023\n"," Regions: US, CA, MX, UK, DE, FR, IT, ES, NL, BE, SE, PL, TR, AE, SA, EG, IN, SG, AU, JP, BR\n"," Advertisers can now launch video-only creatives that render exclusively on Top of Search and drive audiences entirely to the Store. Prior to this launch, advertisers could only promote one product, or a collection of products, with their Store video ads. This new creative, available under Grow Brand Impression Share outcome optimization, allows advertisers to share their branded story without tying a video campaign to a product, or a collection of products. Advertisers also have the option to edit their existing live video campaigns without the need to re-create a new campaign - under Grow Brand Impression Share - and eliminate any of the one, two, or three advertised products.\n"," For full technical details, please see the updated API reference.\n"," December 21, 2023\n"," Regions: All\n"," Previously, we launched the exports API in preview with limits on TPS and job queue capacity. We have now lifted all restrictions on the exports API and are designating the API as generally available.\n"," The exports API simplifies ingestion of Amazon Ads data by providing a common model across different ad products, creates parity between asynchronous export APIs and synchronous LIST APIs (including extended data fields), and improves performance over the previous snapshot APIs.\n"," To get started with the exports API, see:\n","Exports overview  Exports tutorial  Exports API reference \\* Postman collection\n"," December 21, 2023\n"," Regions: All\n"," We have added support for targets to the exports API. Previously, the exports API was only available for campaigns and ad groups.\n"," Targets allow advertisers to influence when ads will or will not appear, as well as specify how much how much to bid for an ad when these conditions are met. As part of this release, we have aligned on a common model for all targeting types across sponsored ads campaign types, including keywords, product targeting, auto targeting, theme targeting, and all negative targeting types. To learn more about the common targeting model, see Targets.\n"," To get started with target exports, see:\n","Exports tutorial \\* Exports API reference\n"," December 13, 2023\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, EG, TR, AE, SA, AU, JP, SG, BR\n"," Amazon Ads has launched new APIs to create payment profiles for managing billing operations. A payment profile represents the instructions on how to collect payments for invoices, and can be used in one or more payment agreements. Advertisers can also mark a payment profile as the default profile for their payment operations, and specify which accounts are eligible to share a payment profile.\n"," With this launch, third-party clients now have the option of integrating with the Amazon Ads billing APIs to create independent and reusable payment profiles. For global advertising accounts encompassing multiple advertiser accounts, advertisers now have the option of creating a single payment profile to be shared across all their advertising accounts. A global advertising account can also mark a payment profile as their default payment profile, and all advertising accounts that get created under the global advertising account will automatically use the same payment profile, without needing to setup the payment information.\n"," For full technical details, please see the billing overview and API reference.\n"," December 11, 2023\n"," Third-party integrators can now complete their billing registration for sponsored ads accounts using the Amazon Ads API. Advertisers can add their billing information, apply it to one or more countries where they are advertising, and set it as a default on the account for future countries where they register.\n"," Previously, advertisers had to manage the billing information for each country separately and the registration could only be completed in the advertising console. With the billing registration APIs, advertisers can complete the registration programmatically and/or through integrator platforms, so they can get started faster.\n"," Six APIs for billing profile management are currently in open beta:\n","POST /billingProfiles: Creates one or more billing profiles under a sponsored ads global account. A billing profile can exist even if it is not associated with any country.Note: To ensure accuracy of the information shown on the store, we request that you review the ‘Advertiser Name’ and ‘Payer Name’ in our ad systems and update them if required.  POST /billingProfileUsages: Applies billing profile(s) to one or more countries. Applying a billing profile on a country means corresponding billing information (address & tax) will be used for invoicing, tax computations and other billing workflows.  PUT /billingProfiles: Updates one or more billing profiles under a sponsored ads global account. When you update a billing profile, the new details will be effective across all applied countries.  POST /billingProfiles/list: Fetches the paginated list of billing profiles under a sponsored ads global account.  POST /billingProfileUsages/list: Fetches the billing profile details for all countries under a sponsored ads global account. \\* GET /billingProfileAgreementContents/{billingProfileAgreementContentId}: Fetches the content of agreements (example: tax agreement, non-canadian residency agreement, etc.). Users will need to read the content and provide the consent as part of creating or updating a billing profile.\n"," December 11, 2023\n"," Regions: All\n"," Different brands prioritize different brand building goals depending on their marketing strategy and their brand building journey. Deciding the right campaign controls (budget, targets, bids, ad creative formats) for those goals can be time-consuming. With this launch, we have introduced two new goals: “Drive Page Visits” and “Grow Brand Impressions Share”; each with a unique set of campaign controls to achieve that goal.\n"," To help drive these goals, theme targeting is a new method to control your campaign targeting. It uses advanced machine learning algorithms that take into account historical performance targets and brand interactions to create a large set of keywords. It then categorizes those keywords into relevant groups to use with your campaigns. Two targeting groups are available in this launch: “Keywords related to your landing pages.” and “Keywords related to your brand”. These targeting groups will be pre-selected to simplify the campaign creation process for advertisers.\n"," With this launch, we have expanded to AU, MX, BR, BE, NL, PL, SE, TR, EG, KSA, UAE, SG and UK so more advertisers can access these features via the Amazon Ads API. For instructions on how to enable these features, refer to our developer guide on how to create Sponsored Brands campaigns and our developer guide on how to create theme based targets.\n"," December 8, 2023\n"," The /dsp/orders endpoint has added new enum values and fields to support the new simplified optimization experience.\n"," Summary of changes:\n"," 1) Added two new enum values for the goal field:\n","CONVERSIONS \\* CONSIDERATION\n"," 2) Added a new field: targetKpi\n"," These changes can be found in version 2.5. See the changes here in version application/vnd.dsporders.v2.3+json.\n"," December 4, 2023\n"," We are deactivating all non-age-gender-demographics segments for Germany, France, Italy, Spain from the following Amazon DSP services: Audience Central UI, Audience Discovery API, Audience Picker UI, Overlapping Audiences, Audience Insights UI, Insights API, Data Decoration Service (DDS, including data output from the EDX interface). Deactivation means that these segments will not be available for any targeting or insights after December 31, 2023. However, any existing campaigns can continue using it until that date.\n"," We will deprecate the impacted segments from targeting UIs on December 04, 2023. Any new campaigns that are created after this date will no longer be able to add those segments for targeting. While these segments will remain visible in the targeting UIs (as deactivated), these segments cannot be added to any campaigns for targeting.\n"," The non-age-gender demographic segments in EU4 are currently sourced from Experian. Experian EU made a decision to stop offering these segments based on an internal assessment by Experian EU team and was driven by privacy compliance reasons. This decision was not specific to Amazon.\n"," Due to the removal of Experian demographic data provision in EU4 mentioned above (Germany, France, Spain and Italy), in November 2022, the demographic segments in the Standard Catalog are no longer being refreshed, and they would be removed by 12/31/2023.\n"," For a full list of segments to be deactivated, you can reference this table.\n"," November 16, 2023\n"," Regions: All\n"," The Amazon Ads version 3 reporting API now supports the gross and invalid traffic report. For Sponsored Products, Sponsored Brands, and Sponsored Display campaigns, this report can be accessed programmatically.\n"," To optimize the efficacy of their campaigns, large advertisers conduct analytics on metrics such as gross impressions, invalid impressions, invalid impression rate, gross clicks, invalid clicks, and invalid click rate. With this release, advertisers can now programmatically access the data for analytics, whereas previously the data had to be manually downloaded and then used. Amazon Ads traffic quality systems assist in safeguarding advertiser budgets from invalid traffic, such as non-human, fraudulent, and other illegitimate traffic. These metrics provide greater visibility into invalid traffic that Amazon Ads filters and aid advertisers in optimizing their campaign performances.\n"," For full technical details, please read the Gross and invalid report definition.\n"," November 16, 2023\n"," Regions: US, CA, UK, IN, JP\n"," We have added hours of day for schedule-based budget rules for sponsored ads campaigns. Now you can set up budget rules that increase budget at specific times of day. This is in addition to specific days of the week and specific date ranges currently offered as schedules for budget rules.\n"," You can now support campaign budget coverage at specific times of the day by setting up budget rules with hours of day granularity. You can also utilize hourly performance reporting through Amazon Marketing Stream to find the times of day that your campaigns are performing best, and set rules for those time periods to help boost performance.\n"," Budget rules help you plan budget changes in advance so you can spend less time making manual adjustments. Advertisers can use budget rules to reduce the likelihood of campaigns running out of budget, especially during peak days, times, or holiday events. You can set up budget rules with hours of day schedules using the Amazon Ads console or the Amazon Ads API.\n"," For full technical details, please see the user guide and API reference.\n"," November 16, 2023\n"," Region: US\n"," With Sponsored Display, advertisers can discover, reach, and engage audiences in relevant contexts across their shopping and entertainment journey. With this launch, entertainment targeting will allow advertisers to reach audiences who are either actively engaged in those entertainment contexts or have shown interest in them. Advertisers can engage with specific genres or categories including movies/TV, music and games.\n"," Entertainment targeting helps advertisers reach engaged audience during their entertainment journey, whether they are live streaming, watching videos, or researching games and movies on blog sites. This helps advertisers expand their reach beyond the Amazon store. Additionally, you can ensure your brand ads show up next to content category/genre that aligns with the advertisement. These new targets also allow advertisers to further connect with highly engaged Twitch audiences. We have found that viewers that watch Twitch streaming content spend, on average, more than 42 minutes per visit, the highest among all social media platforms.\n"," For full technical details, please see our updated developer guide and our targeting API, including our new ContentTargetingPredicate that can be used for either contextual (T00020) or audience (T00030) campaigns.\n"," November 15, 2023\n"," Regions: All\n"," Developers can now read translations of advanced tools center content in Chinese and Japanese. The current translations reflect the status of advanced tools center documents as of July 2023.\n"," Visit the translations page for more information, or go directly to the Chinese translation or Japanese translation.\n"," November 13, 2023\n"," Regions: US, MX, CA, UK, DE, ES, FR, IT, IN\n"," We are launching schedule bid rules for Sponsored Products campaigns, so advertisers can set up bid rules that increase bids at specific times of the day, days of the week, and date ranges. With the launch of schedule bid rules, advertisers can automate their bid changes without missing sales opportunities. Advertisers can also utilize new hourly performance reporting to find the times of day that your campaigns are performing best, and set rules for those time periods to help boost performance.\n"," To learn more, see our schedule based guide.\n"," November 6, 2023\n"," Sponsored Brands reporting version 2 reports now support view and click attributed data for conversion metrics (that is, conversions, sales, units sold, new-to-brand, and detail-page-view metrics) for Sponsored Brands campaigns with a costType of VCPM. The conversion metrics will have the right data depending on the attribution type for the campaign.  For campaigns with a costType of CPC, metrics will continue to report click attributed data.\n"," Sponsored Brands recently launched campaigns to grow brand impression share campaigns that are transacted on vCPM basis.  It is important to report both view and click attributed conversion metrics for these campaigns, so that advertisers can understand the full performance impact.\n"," See version 2 metrics for updated metric definitions.\n"," November 6, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, US\n"," Sponsored Display has improved the accuracy of the forecasting API by allowing optimization rules to be included as an input.\n"," Forecasting helps advertisers understand the impact of their choices during campaign creation. This includes a minimum and maximum range of available impressions, viewable impressions, and clicks that could be available based on the selected advertised products, optimization type, targeting, bid, and optimization rule.\n"," For full technical details, please see our updated forecasting API.\n"," November 6, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SE, UK, US\n"," Sponsored Display now includes themes in the response of the targeting recommendations API.\n"," Theme-based recommendations offer multiple options to target relevant products without the need for additional research from advertisers. Target products under each theme are curated specific to the use case, with high-quality suggestions based on Amazon first-party signals. Each theme will have up to 50 individually recommended products, with flexibility to choose products individually or select all products within a theme.\n"," For full technical details, please see our updated targeting recommendations API documentation.\n"," November 2, 2023\n"," Regions: All\n"," Advertisers can now edit the name, ASIN list, and lookback period for product audiences that are not part of an active campaign.\n"," For technical specifications, please consult the API reference.\n"," November 1, 2023\n"," Regions: All\n"," Amazon DSP is launching goal-based bidding, which helps advertisers to specify a performance target for their campaigns and allow Amazon DSP to automatically optimize their bids in real-time in order to maximize delivery at their performance target. With this release, advertisers can automatically optimize to both delivery and performance goals.\n"," Goal-based bidding can be used to maximize delivery at a performance threshold that advertisers define. You can now specify a KPI target when creating a campaign—for instance, you can set a target CPA of $10 and choose “Prioritize KPI target” as the optimization strategy. This allows you to maximize your campaign goal, such as conversions, while ensuring that the campaign remains at or near your specified target CPA.\n"," Goal-based bidding is part of the optimization field of the order object in POST /dsp/orders. To get suggested KPI target range, you can use the POST /dsp/campaigns/targetKpi/recommendations endpoint.\n"," October 31, 2023\n"," Regions: US, CA, MX, BR, UK, DE, FR, IN, ES, IT, AE, SA, NL, SE, PL, TR, EG, JP, AU, SG\n"," The Unified Pre-moderation API now offers new capabilities to validate creatives against Technical specifications and Policy requirements. These validations are done ahead of Ad submission. The Unified Pre-moderation API is compatible with Sponsored Ads and DSP.\n"," For technical specifications, please consult the API reference.\n"," October 30, 2023\n"," Regions: All\n"," Sponsored ads advertisers can now choose to download invoices from the last 90 days for one country or for all countries in their global sponsored ads account. Two Amazon Ads APIs are currently in open beta where you can retrieve this information:\n","POST /billingStatements: This API lets you request for a billing statement to be generated, and returns a billing statement ID. \\* GET /billingStatements/{billingStatementRequestId}: Call this API to check the generation status of your statement. When the statement is ready, the response includes the pre-signed URL where you can download the file. Download URLs are valid for three hours.\n"," October 26, 2023\n"," Amazon Marketing Cloud is now available on the Amazon Ads API to automate workflows, establish integrations, and develop tools and apps at scale. Advertisers and partners can now access Amazon Marketing Cloud (AMC) APIs from the Amazon Ads API, along with APIs for other Amazon Ads solutions such as sponsored ads and Amazon DSP. Using standards from the rest of the Amazon Ads APIs, the updated AMC APIs follow the industry-standard OAuth 2.0 authorization framework and consistent endpoint URL paths. A developer guide is also provided to help users get started and use these APIs. As documented in the Advanced tools center, the new AMC APIs currently support features including reporting, signal management, and audience management.\n"," Previously, advertisers and partners have been using AMC APIs that at an AMC instance level. The new set of AMC APIs offer further enhanced security, usability, and performance, allowing developers to easily utilize, manage, and build with these APIs. See what changed and start your onboarding journey to the Amazon Ads API.\n"," October 23, 2023\n"," Regions: All\n"," You can now request new metrics related to add-to-cart actions and new-to-brand details page views. For both Sponsored Brands and Sponsored Display, new metrics include: addToCart, addToCartRate, eCPAddToCart, newToBrandDetailPageViews, newToBrandDetailPageViewRate, and newToBrandECPDetailPageViews for both Sponsored Brands and Sponsored Display reports through the version 3 reporting API.\n"," Sponsored Display also supports additional metrics: brandedSearchesViews, brandedSearchRate, eCPBrandSearch, addToCartViews, newToBrandDetailPageViewViews, and newToBrandDetailPageViewClicks.\n"," For full definitions and report availability for each metric, see Columns.\n"," You can call the version 3 reporting API to access these metrics.\n"," October 23, 2023\n"," Regions: All\n"," We are excited to launch Sponsored Brands reports on the latest version (version 3) of the Amazon Ads API in preview. The new reports adhere to a common request and response schema we introduced with version 3 reporting, as well as the ability to select date ranges, standardized metric names, and better reports availability over version 2.\n"," This release launches the following reports types for Sponsored Brands in version 3: campaign, placement, ad group, targeting, search term, and ad, in addition to the existing purchased product report. With this release, customers will find better consistency between Sponsored Brands reports and those for other ad products.\n"," The new Sponsored Brands reports come with standardized metric names allowing consistent naming across all ad product reports. This will enable customers to easily compare metrics across ad product reports. Another major change with this release is using a 14-day attribution window for all applicable Sponsored Brands metrics. We dropped deprecated metrics and attribution suffixes in metric names from the reports, making it easier to read and analyze reporting information.\n"," For full technical details, please see the migration guide and report types overview. For access, please submit a Jira ticket.\n"," October 23, 2023\n"," Regions: US\n"," Introducing Sponsored TV, a Streaming TV ad solution for brands of any size to connect with new customers in their living rooms—  even if they have never advertised on TV before. Pre-packaged with retail aware, shoppable ad formats, Sponsored TV allows marketers to buy Streaming TV with the same flexibility of Amazon Ads self-service ads — that means no minimum spend requirements or upfront commitments.  In just a few clicks, brands can help engage relevant viewers across 30+ streaming TV services like Twitch or Freevee. Now, any endemic advertiser can benefit from campaigns modeled by Amazon. With this launch, campaigns are optimized in real time, simplifying the complex process of buying programmatic TV ads.\n"," Now, advertisers can easily get started with Streaming TV, with no minimum spend requirements, daily budgets, and evergreen campaigns. Amazon first-party insights help brands brands reach audiences based on likely content interests such as music videos, video games or dramas as well as product categories on Amazon like headphones or running shoes. Finally, Sponsored TV ads are eligible for interactive ad formats to help you connect with viewers as you reach new audiences.\n"," For more information on how to get started with Sponsored TV, please visit the developer guide on how to get started with Sponsored TV.\n"," October 23, 2023\n"," Regions: All\n"," We are excited to launch Sponsored Display reports on the latest version (version 3) of the Amazon Ads API in beta. The new reports adhere to a common request and response schema we introduced with version 3 reporting, as well as the ability to select date ranges, standardized metric names, and better reports availability over version 2.\n"," This release launches the following reports on version 3 reporting for Sponsored Display: campaigns, ad groups, targeting, advertised product, and purchased product. The matched target report is merged into other reports to reduce duplication of metrics across multiple reports. With this release, customers will find better consistency between Sponsored Display reports and those for other ad products.\n"," The new Sponsored Display reports come with standardized metric names allowing consistent naming across all ad product reports. This will enable customers to easily compare metrics across ad product reports. Another major change with this release is using a 14-day attribution window for all applicable Sponsored Display metrics. We dropped deprecated metrics and attribution suffixes in metric names from the reports, making it easier to read and analyze reporting information.\n"," For full technical details, please see the migration guide and report types overview.\n"," October 23, 2023\n"," Regions: All\n"," Sponsored Products budget recommendations and missed opportunities insights are now available in Amazon Marketing Stream. This provides an unmodified view of budget recommendations and missed opportunities, which includes the additional clicks, impressions, and sales from the past 7 days that the campaign could have received had it stayed in budget for the hours it was out of budget.\n"," Sponsored Products budget recommendations and missed opportunities via Amazon Marketing Stream addresses two use cases: delivery of recommendations in near real time when a campaign goes out of budget, and delivery of recommendations for all campaigns owned by a subscribed advertiser with no additional API calls beyond the initial subscription.\n"," Amazon Marketing Stream is available via the Amazon Ads API. When you are ready to get started, visit our Amazon Marketing Stream onboarding guide that will walk through the process of getting API access, integrating with AWS, and subscribing to campaign datasets using the Amazon Marketing Stream API. If you are already integrated with Amazon Marketing Stream, see the new Dataset documentation.\n"," October 23, 2023\n"," Regions: All\n"," We are launching target promotion APIs to allow advertisers to perform target promotion across all their campaigns at scale. Target promotion is a performance advertising strategy that identifies targets for further refinement to drive more efficient spend against high-performing targets and reduce spend on low-performing targets. This combines the common practice of “target harvesting,” which identifies targets to move from broader targeting (for example, automatic targeting) to more focused targeting (for example, manual targeting with broad match), with optimized bids and budget changes.\n"," Before today, Sponsored Products advertisers needed to download a search term report and manually manipulate the report data to add new targets to existing or new campaigns. There was no automated way to add high-performing targets from an automated targeting campaign into a separate manual targeting campaign at scale. With the launch of target promotion APIs, advertisers can achieve more performant campaigns by promoting high-performing targets within auto-targeting campaigns to manual-targeting campaigns at scale.\n"," For more information on how to enable this feature, refer to our developer guide on how to create target promotion.\n"," October 18, 2023\n"," The legacy bid optimization strategy and adjustment by shopper segment feature will be deprecated on March 31, 2024. If the parameters bidAdjustmentsByShopperSegment and bidOptimizationStrategy are included in the bidding object of the POST /sb/v4/campaigns request after March 31, 2024, the values will be treated as null values. If you have any questions, visit the Amazon Ads API Support page and create a ticket with the subject title: \"Sponsored Brand New To Brand optimization.\"\n"," October 13, 2023\n"," Regions: CA, DE, ES, FR, IN, IT, JP, UK, US\n"," Different brands prioritize different brand building goals depending on their marketing strategy and their brand building journey. Deciding the right campaign controls (budget, targets, bids, ad creative formats) for those goals can be time-consuming. With this launch, we have introduced two new goals: “Drive Page Visits” and “Grow Brand Impressions Share”; each with a unique set of campaign controls to achieve that goal.\n"," To help drive these goals, theme targeting is a new method to control your campaign targeting. It uses advanced machine learning algorithms that take into account historical performance targets and brand interactions to create a large set of keywords. It then categorizes those keywords into relevant groups to use with your campaigns. Two targeting groups are available in this launch:  “Keywords related to your landing pages.” and “Keywords related to your brand”. These targeting groups will be pre-selected to simplify the campaign creation process for advertisers.\n"," This feature was previously only available in the US, but with this launch, we have expanded to CA, DE, ES, FR, IN, IT, JP, and UK so more advertisers can access this feature via the Amazon Ads API. For instructions on how to enable these features, refer to our developer guide on how to create Sponsored Brands campaigns and our developer guide on how to create theme based targets.\n"," October 9, 2023\n"," Regions: FR\n"," French advertisers can now measure upper and mid-funnel Amazon Ads campaigns with Amazon Brand Lift, joining advertisers in the United States, United Kingdom, Canada, and Germany, where Amazon Brand Lift was already available.\n"," Amazon Brand Lift is an insightful and privacy-safe way for advertisers to quantify the impact of upper and mid-funnel campaigns. With participation of the sizable, representative, and engaged Amazon Shopper Panel community, Amazon Brand Lift helps provide objective and concrete measurement results. The reporting provides insights, such as how much a campaign has impacted the percentage of respondents who report being aware of a brand or interested in purchasing from a brand.\n"," To create, manage, and retrieve results for Amazon Brand Lift studies, use the following endpoints:\n","Create study: POST /dsp/measurement/studies/brandLift  Update study details: PUT /measurement/studies/brandLift  Get results: GET /measurement/studies/brandLift/{studyId}/result\n"," For more details, view the API reference.\n"," October 5, 2023\n"," Regions: All\n"," To help advertisers achieve specific goals for their Sponsored Brands campaigns, bids can be automatically adjusted up or down. If we find an opportunity where your ad is more likely to lead to page visits or conversions for campaigns with “Drive Page Visits” goal with a costType of CPC, we may increase your bid for that auction to help achieve that goal. Similarly, if we find an opportunity that looks less likely to lead to your campaign goal, we may lower your bid for that auction. For example, Amazon can adjust bids if we see higher expected results that can “Drive Page Visits”.\n"," For more information related to bidding, please see our updated help page.\n"," October 5, 2023\n"," Regions: US\n"," Advertisers in US can now create Posts via the Amazon Ads API. All sellers and vendors now have access to a Brand profile to create Posts. To have a Brand profile, you must be registered in Amazon Brand Registry. By combining the creative assets API and Posts APIs, you can automate Post creation and the publishing process.\n"," Previously, advertisers needed to have a Store before they could create a Posts profile, and could not reuse the existing image assets available in the creative asset library when creating Posts. With this launch, some new capabilities include:\n","Stores dependency removed: Advertisers no longer need to have a Store to create a Post profile, making the process much more streamlined with the introduction of Brand profiles. 2. Asset reuse: Advertisers can reuse an existing image asset available in the creative asset library to create Posts.\n"," For more information, see our guides for Managing and Reporting on Posts, as well as the API reference.\n"," October 5, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, US\n"," Sponsored Display has improved the forecasting API by adding clicks and viewable impressions.\n"," Forecasting helps advertisers understand the impact of their choices during campaign creation with a minimum and maximum range of available impressions, viewable impressions, and clicks that coudld be available for a set of selected advertised products, optimization type, targeting, and bid values. This helps advertisers create campaigns that will deliver results, understanding scale by experimenting with the campaign setup, and forecasting the output of an investment before they get started.\n"," Forecasting will be available for Sponsored Display through the Amazon Ads API. For full technical details, please see our updated forecasting API documentation.\n"," October 2, 2023\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, SE, AU, JP, BR\n"," We have launched new APIs for basic billing operations, so advertisers can check which payment methods are eligible to register to their advertising account. They can then update the payment method their advertiser account is using. Lastly, we also added support for executing payments on open invoices using either the advertiser current payment method or a one-time payment method.\n"," With this launch, third-party clients can integrate with the Amazon Ads billing APIs and trigger basic operations that are part of the billing lifecycle. This feature is already available via the advertising console, so this launch expands access via the public API.\n"," There are four new endpoints included in this release:\n","POST /billing/paymentMethods/list  POST /billing/paymentAgreements  POST /billing/paymentAgreements/list \\* POST /billing/invoices/pay\n"," For full details, see the API reference and overview.\n"," September 28, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, US\n"," Sponsored Display has added forecast status to the API to better understand how targeting can affect delivery and scale.\n"," Forecasting helps advertisers understand the impact of their choices during campaign creation with a minimum and maximum range of available impressions inventory for a set of selected advertised products, optimization type, targeting, and bid values. This helps advertisers create campaigns that will deliver results, understanding scale by experimenting with the campaign setup, and forecasting the output of an investment before they get started.\n"," The new forecastStatus is now available through the Sponsored Display including IMPRESSION_TARGETING_TOO_NARROW and IMPRESSION_TARGETING_TOO_BROAD. For full technical details, please see our updated Sponsored Display documentation.\n"," September 26, 2023\n"," With the launch of export APIs, we have added a new section to the advanced tools center where we document common Amazon Ads models. The goal of these models is to simplify understanding of and reduce differences across ad products. Currently this documentation covers campaigns and ad groups, including the fields and enum values in the common models, usage across ad products, and mapping to the latest versions of each ad product campaign management APIs.\n"," In the future, we will be adding more entities to this documentation, starting with targets and ads, and using these common models in future API releases.\n"," For more details see:\n","Campaign model - Ad group model - Enums\n"," If you have any comments or questions on these models, please leave a comment in Github.\n"," September 26, 2023\n"," Regions: All\n"," Note: We are announcing these APIs in preview so that you can make test calls and start your integration. During preview, these endpoints have a smaller TPS and job queue capacity.  Once these APIs are ready for scaled adoption and support their full TPS and job queue capacity, we will post a new release note.\n"," Amazon Ads API has launched new export APIs as an update to the existing snapshots functionality. The new APIs currently support asynchronous campaign and ad group exports for Sponsored Products, Sponsored Brands, and Sponsored Display.\n"," These APIs simplify ingestion of Amazon Ads data by providing a common model across different ad products, create parity between asynchronous export APIs and synchronous LIST APIs (including extended data fields), and improve performance over the previous snapshot APIs.\n"," To get started with the export API, see:\n","Exports overview  Exports tutorial  Exports API reference \\* Postman collection\n"," In the near future, we will expand exports to add support for targets and ads.\n"," September 21, 2023\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, EG, TR, AE, SA, AU, JP, IN, SG, BR\n"," Sponsored Products Rest Of Search Placement Bid Adjustment is now available in beta. Advertisers using the Amazon Ads API can now apply bid adjustment for rest-of-search placements in their Sponsored Products campaigns. The new placement bid adjustment control for rest of search works same as the adjustments available for top-of-search (first page) and product-page placements. Through the new control, advertisers can adjust their bid for rest of search by up to 900%, same as the other two placements.\n"," The new placement bid adjustment helps advertisers to balance their campaign performance across the three different placements (top of search, rest of search, product pages). The control is available for all targeting types (auto and manual) and bidding strategies (fixed and dynamic bidding). Advertisers already have access to campaign performance split by the three placements in campaign manager and Sponsored Products placement report. Using the available reporting, advertisers can measure the impact of using the new control in Sponsored Products campaigns.\n"," For the API, you can view the relevant API contract changes by looking at dynamicBidding.placementBidding.placement in POST /sp/campaigns. Use the new enum PLACEMENT_REST_OF_SEARCH to add an adjustment percentage.\n"," September 19, 2023\n"," Regions: All\n"," Amazon DSP now supports Integral Ad Science (IAS) Context Control products for brand suitability (avoidance) and contextual targeting. This feature is available worldwide to DSP self-service advertisers, and supported on standard display, video, and AAP - mobile app line items running on third-party supply sources. Advertisers will pay a CPM fee from their campaign budgets for the use of these products.\n"," Per IAS - “Context Control products use patented cognitive semantic technology that relies on natural language processing (NLP) to dynamically comprehend the nuances of context using sentiment and emotion analysis across 50 languages. This provides customers precise, page-level content classification at scale.”\n"," For brand suitability, advertisers will be able to choose avoidance segments that are suitable for protecting their brands from exposure to specific content, or negative sentiments they do not want their brands to be associated with. They can do this without avoiding all instances of a certain topic and thus implement brand suitability standards that align closely with their brand values.\n"," For contextual targeting, advertisers can target contextually relevant content for their brand or campaign. This also allows them to increase ad relevance in third-party supply environments where ad identifiers are not available. For more information, see our updated documentation.\n"," September 18, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SA, SE, TR, UK and US\n"," Sponsored Display is launching bid recommendations for video creatives. Advertisers can now customize creatives and receive bid recommendations when using any custom creative, including headline and logo, image, or video. Previously, bid recommendations were only customized for campaigns with static images. With this launch, advertisers receive relevant bid recommendations to ensure their video campaigns have improved inputs to help them reach their audiences.\n"," For full technical details, see our updated bid recommendationsresource. This resource will help find relevant bid suggestions when using either video or image creatives.\n"," September 18, 2023\n"," Regions: AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK and US\n"," We launched a new API, optimization rules (beta)(sponsored-display/3-0/openapi#tag/Optimization-Rules-(beta)), to simplify the campaign management process for advertisers using Sponsored Display. This launch allows advertisers to set performance-based parameters that remove the guess work from selecting an exact bid for each target. This helps advertisers of any size and with any budget achieve their goals with the help of Amazon first-party data and machine learning capabilities.\n"," Before this launch, advertisers needed to translate their desired goals into efficient bids and targets across different cost types. In reality, this turns out to be the biggest issue driving lower scale and campaign effectiveness. By translating goals into bids using machine learning with optimization rules (beta), Amazon can help advertisers achieve better results through continuous optimization. In the future this will be extended to targeting optimizations to further maximize goals.\n"," For campaigns optimized for reach or click, advertisers can apply a cost-based rule like cost per thousand ad views (vCPM) and cost per click (CPC). We will then utilize machine learning models to define the bids while adjusting base bids up and down with the goal of increasing outcomes, all while adhering to the cost-based rules. While Amazon Ads cannot guarantee performance, if the campaign is not meeting the cost target over a 21-day period (excluding special days), we recommend adding additional targets to allow our systems to reach the right audiences.\n"," Optimization rules are now available for Sponsored Display through the Amazon Ads API. For full technical details, see our updated documentation(sponsored-display/3-0/openapi#tag/Optimization-Rules-(beta)).\n"," September 13, 2023\n"," Regions: All\n"," Amazon Marketing Stream is expanding to include new Amazon DSP campaign datasets. This includes information on Amazon DSP campaigns, flights, ad groups, and ad group targets.\n"," These signals enable Amazon DSP advertisers and partners to be notified in near real time via Amazon Marketing Stream when Amazon DSP campaign data changes (for example, when campaigns pause, budgets change, or bids update) and what the modification was across thousands of advertising campaigns. Amazon Marketing Stream can help improve information integration patterns and operational efficiency by reducing the number of API calls that are required for intraday campaign optimization. Advertisers and partners can use this dataset to react to events in near real time, such as campaign status changes, rather than run multiple intraday snapshots. Amazon Marketing Stream helps simplify the extract, transform, and load operations compared to snapshots, by showing you only information that has changed, when it occurs.\n"," The Amazon DSP campaign data is split into four datasets: campaigns, flights, ad groups, and ad group targets for each AWS region. To learn more and access this feature, review the Amazon Marketing Stream Onboarding guide, and subscribe to the new Amazon DSP campaign datasets.\n"," September 13, 2023\n"," Regions: All\n"," Sponsored Brands API now allows advertisers to download their original video media using the GET /media/describe. Advertisers can use originalMediaUrl to retrieve their original video media in .MP4 format. Previously, advertisers could only download a preview of the original video using publishedMediaUrl.\n"," Going forward, please use the asset library for all creative management as the POST /media/upload will be deprecated on 1/31/2024. For further instruction, refer to the API specifications here.\n"," August 31, 2023\n"," For the kpiName field in the Goal Configurations Discovery API and Orders API, we have added three new enum values and changed two to match the ADSP UI. We have also changed TOTAL_RETURN_AD_SPEND to TOTAL_RETURN_ON_AD_SPEND in the Goal Configurations Discovery API goalKpi field. In addition, we have added definitions for each enum value.\n"," Here are the details:\n"," Goal Configurations Discovery API goalKpi field:\n","Added descriptions - Changed from COST_PER_ACQUISITION to COST_PER_ACTION - Removed COST_PER_DOWNLOAD - Added COST_PER_FIRST_APP_OPEN - Added COST_PER_INSTALL - Added TOTAL_COST_PER_SUBSCRIPTION - Changed from TOTAL_RETURN_AD_SPEND to TOTAL_RETURN_ON_AD_SPEND\n"," Orders API goalKPI field:\n","Added descriptions - Changed from COST_PER_ACQUISITION to COST_PER_ACTION - Removed COST_PER_DOWNLOAD - Added COST_PER_FIRST_APP_OPEN - Added COST_PER_INSTALL - Added TOTAL_COST_PER_SUBSCRIPTION\n"," See the changes here.\n"," August 21, 2023\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/v1/profiles \\* /v1/profiles/{profileId}\n"," If you would like to share feedback, please use the Amazon Ads API Service Desk to open a ticket with subject title \"Profiles v1 Deprecation\" by December 15, 2023.\n"," August 17, 2023\n"," Regions: US\n"," Different brands prioritize different brand building goals depending on their marketing strategy and their brand building journey. Deciding the right campaign controls (budget, targets, bids, ad creative formats) for those goals can be time-consuming and prone to errors. With this release, we are introducing Sponsored Brands goal-based campaigns, providing simplified campaign creation and management workflow for the desired goals to better achieve your brand marketing objectives. In this release, we will introduce two new goals: “Drive Page Visits” and “Grow Brand Impressions Share”; each with a unique set of campaign controls to achieve that goal. This helps advertisers of any size grow their brands and deliver business objectives with simplified campaign controls and guidance powered by Amazon 1P data and machine learning capabilities.\n"," Advertisers can access this feature via the Amazon Ads API. For instructions on how to enable this feature, refer to step one of this guide to getting started with campaigns.\n"," August 17, 2023\n"," Regions: US\n"," Sponsored Brands theme targeting provides a new method to control your campaign targeting. It uses advanced machine learning algorithms that take into account historical performance targets and brand interactions to create a large set of keywords. It then categorizes those keywords into relevant groups to use with your campaigns. Two targeting groups are available in this launch: “Keywords related to your brand” and “Keywords related to your landing pages.” These targeting groups will be pre-selected to simplify the campaign creation process for advertisers.\n"," Advertisers can access this feature via the Amazon Ads API. For instructions on how to enable this feature, refer to this developer guide.\n"," August 15, 2023\n"," Sponsored Brands datasets are now available globally in Amazon Marketing Stream. We are excited to expand the Sponsored Brands datasets in Amazon Marketing Stream to all countries currently supported by the Amazon Ads API. These datasets are currently available in beta. Amazon Marketing Stream delivers Amazon Ads campaign metrics and information to advertiser or integrator AWS accounts via a push-based model in near real time. This data will not be available for Sponsored Brands version 3 (legacy) campaigns.\n"," Amazon Marketing Stream is already available globally for Sponsored Products and Sponsored Display campaigns and sponsored ads budget usage via the Amazon Ads API for agencies, tool providers, and direct advertisers, including vendors and sellers worldwide. When you are ready to get started, visit the Amazon Marketing Stream onboarding guide.\n"," For more information on the new Sponsored Brands datasets, see:\n","Sponsored Brands traffic - Sponsored Brands conversion - Sponsored Brands clickstream - Sponsored Brands rich media\n"," August 11, 2023\n"," Regions: All\n"," As of August 10th, all campaigns created using the version 3 Sponsored Brands POST /sb/campaigns endpoint are stored as multi-ad group (version 4) campaigns. With this change, existing integrations should continue to work as intended. Advertisers, agencies, and tool providers can leverage the Sponsored Brands version 4 endpoints or the Amazon advertising console to create additional ad groups and ads.\n"," Previously, these changes were limited to the US marketplace but we have completed the backend migration across all regions. For full technical details, see the version 4 migration guide.\n"," August 6, 2023\n"," Advertisers will soon be able to apply bid adjustment controls for rest-of-search placements in their Sponsored Products campaigns. The new placement bid adjustment control for rest-of-search placements works in the same way as the adjustments available for top-of-search (first page) and product-page placements. Through the new control, advertisers will be able to adjust their bid for rest of search by up to 900% (same as the other two placements). This will be available for bulksheets as well as the API.\n"," You can view the relevant API contract changes by looking at dynamicBidding.placementBidding.placement in POST /sp/campaigns. Once available, you will be able to use the new enum PLACEMENT_REST_OF_SEARCH and add an adjustment percentage. This enum is currently in a read-only state, and we will update the release notes when you can start using this feature.\n"," August 2, 2023\n"," Regions: DE, ES, IT, FR\n"," Amazon Ads has made it easier for advertisers to create policy-compliant Sponsored Brands video campaigns in marketplaces where they are unfamiliar with the local language. Now, if advertisers add a video to their Sponsored Brands video ad that does not match with the language requirements of the country, they can opt to have their video auto-localized into the country local language. Localization takes up to 72 hours and the campaign goes live automatically once the video is localized. This localization service is offered to advertisers at no extra cost and comes quality assured by professional linguists.  At launch, the service supports English source videos into German, French, Italian, and Spanish.\n"," Every month, thousands of campaigns are rejected due to advertisers submitting an English video for non-English speaking regions. This new feature helps advertisers overcome this friction related to building creatives in non-english languages, and enables more campaigns to be created.\n"," The new consentToTranslate field is supported in the following endpoints:\n","/sb/v4/ads/video  /sb/v4/ads/brandVideo  /sb/v4/ads/list  /sb/ads/creatives/video  /sb/ads/creatives/brandVideo \\* /sb/ads/creatives/list\n"," For full technical details, please see our updated documentation for /sb/v4/ads/brandVideo as an example.\n"," August 1, 2023\n"," Regions: All\n"," We are excited to announce that Amazon Marketing Stream, which was first launched for North America as beta on June 21, 2022, is now generally available. Amazon Marketing Stream delivers Amazon Ads campaign metrics and information to advertisers’ or integrators’ AWS accounts via a push-based model in near real time. You can subscribe to Amazon Marketing Stream datasets using your API token and AWS account. Once you are subscribed, Amazon Marketing Stream delivers hourly, near real-time performance metrics and signals. Stream supports different categories of data: hourly performance reporting metrics, near real-time campaign management notifications, and push-based recommendations. Stream is available in all locations where the Amazon Ads APIs are supported.\n"," In the past, access to scaled campaign reporting was limited to pull-based Amazon Ads API calls that provided daily performance, and on-demand access to other campaign information. API users who desired more real-time, intra-day campaign insights have manually pulled this information by calling Amazon Ads API multiple times a day, sometimes resulting in increased throttling. In addition, the current approach puts the burden on developers to identify changes between new and old data. Such API usage patterns highlighted the need to build a product that better addresses our customers’ evolving use cases.\n"," Amazon Marketing Stream is available via the Amazon Ads API. When you are ready to get started, visit our Amazon Marketing Stream onboarding guide that will walk through the process of getting API access, integrating with AWS, and subscribing to campaign datasets using the Amazon Marketing Stream API.\n"," July 27, 2023\n"," Sponsored Brands versions 3 campaign management, draft, and media APIs are being deprecated, with a target shutoff date of January 31, 2024. Please migrate to the new versions of campaign management endpoints as documented on our Deprecations page and in our Migration guide. As a part of this deprecation, Sponsored Brands draft endpoints have reached their end of life and will not be replaced with new endpoints.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","/sb/campaigns/  /sb/adGroups/  /sb/adGroups/{adGroupId}  /sb/campaigns/{campaignId}  /sb/drafts/campaigns  /sb/drafts/campaigns/{draftCampaignId}  /sb/drafts/campaigns/submit  /media/upload  /media/complete\n"," If you would like to share feedback, please use the Amazon Ads API Service desk to open a ticket with subject title \"SB v3 Campaign CRUD Deprecation\" by August 15th, 2023.\n"," July 24, 2023\n"," Regions: US\n"," We have extended Sponsored Display capabilities to advertisers who do not sell in the Amazon store. Previously, Sponsored Display was only available for brands that sell products on Amazon. With an easy-to-use interface and no minimum spend requirements, advertisers can create compelling display ads in just a few clicks to help grow their business.\n"," Advertisers who do not sell on Amazon can now connect with relevant audiences for their business using Sponsored Display. With this launch, advertisers can:\n","Reach relevant audiences, in relevant locations, on and off the Amazon store: Activate Amazon Ads exclusive audiences built from shopping and streaming signals. Choose postal code, city, designated market area (DMA), and/or state locations. Reach audiences on Amazon.com, Twitch, IMDb, and thousands of websites and apps beyond the Amazon store.  Drive visits to your site with visually-appealing creative formats: Boost visibility and drive visits to your website with engaging display ads. All advertisers need is an image, headline, and logo to get started. We will do the heavy lifting and build ads optimized for a variety of placements, sizes, and devices to increase reach.  Easy and simple campaign set-up: Create compelling display ads in just a few clicks, with a few basic inputs across bidding, targeting, creatives, and landing page destination. \\* Advertise with no minimum budget requirements: With no minimum budget requirements, Sponsored Display unlocks the power of Amazon Ads for any self-service advertiser.\n"," For full technical details, please see our new developer guide on Sponsored Display for all advertisers. You can also explore all the calls needed to build an off-Amazon Sponsored Display campaign in our Postman collection.\n"," July 21, 2023\n"," Regions: All\n"," Campaign ID and ad group ID are now available when you request a Sponsored Brands purchased products report. You can find these IDs in two new columns in the report. These IDs will not be available for Sponsored Brands version 3 (legacy) campaigns.\n"," These IDs are important because they are unique identifiers that do not change over time, whereas the entity names can change. Without the IDs, advertisers would need to locate the IDs outside of the purchased products report, which can waste time and increase manual effort.\n"," To use this feature, request the additional base metrics (campaignId and adGroupId) as part of the Sponsored Brands purchased product report generated via the version 3 reporting API.\n"," July 20, 2023\n"," Regions: All (except BE)\n"," We have enhanced Sponsored Brands brand video ads so that advertisers can highlight a collection of products to direct shoppers to their brand store. Prior to this launch, advertisers could only promote one product with their brand video ads. Now, advertisers can highlight a collection of products (up to three products) when creating a new campaign.\n"," Stores are more discoverable to shoppers, as they are the primary method for advertisers to showcase brands and products in a multi-page, immersive shopping experience on Amazon. Stores allow brands to curate content that inspires, educates, and helps shoppers discover the brand entire product selection, taking shoppers from inspiration to action.\n"," For full technical details, see the updated documentation on Sponsored Brands brand video ads. This feature is only available on the Sponsored Brands version 4 Amazon Ads APIs. If you have not yet migrated from Sponsored Brands version 3 to Sponsored Brands version 4, please review our migration guide.\n"," July 20, 2023\n"," Regions: CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, EG, TR, AE, SA, AU, JP, IN, SG, BR\n"," Sponsored Brands advertisers in CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, EG, TR, AE, SA, AU, JP, IN, SG, BR can now access the missed opportunities and budget recommendations API (previously only available in the US), which provides budget recommendations for campaigns that have gone out-of-budget and estimates of missed business impressions, clicks, and sales.\n"," Advertisers can leverage this service to understand the impact of out-of-budget campaigns and reduce the likelihood of going out-of-budget, which will help campaigns reach their full potential.\n"," For full technical details, see the API reference.\n"," July 19, 2023\n"," Regions: All\n"," We have updated our rendering UI for OpenAPI specifications to provide an easier browsing experience for developers. The new layout allows easier navigation across the different methods and API endpoints. With this change, we have added a consistent layout across the schemas, fixed deep indentation when expanding and collapsing schemas, added the ability to view schemas and examples at the same time, and enabled easy copying of samples and parameters. API reference pages are also now mobile friendly and accessible.\n"," To explore the new layout, check out any of our API reference documents. If you have any feedback, please leave a comment in the related GitHub discussion.\n"," July 18, 2023\n"," Regions: US\n"," As of June 26, 2023, Omnichannel Metrics (OCM) charges a usage fee of “4% of media spend”.\n"," To calculate the OCM fee, 4% will be applied to the \"Supply cost\" in Amazon DSP and only applied to impressions where OCM is enabled. For example, if an order is booked to run from 8/1/23 to 8/30/23, and OCM is enabled on 8/15/23, you will only be charged for impressions that run from 8/15/23 to 8/30/23. Advertisers using OCM will be billed on a monthly basis following standard invoicing timelines.\n"," OCM enables you to measure the impact of your ad tactics on holistic shopping activities across retail outlets, on-Amazon and off-Amazon) while campaigns are mid-flight. Through our automated budget optimization feature, you can reallocate budgets to better performing line-items before the campaign ends, to help improve the overall campaign ROAS. OCM launched for general availability in October 2022 for all US CPG advertisers.\n"," June 30, 2023\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, AU, UAE, JP, BR, NL, TR, SE, IN, SA\n"," Amazon DSP is launching several new endpoints available through the Amazon Ads API to enable advertisers to manage their Amazon DSP programmatic deals:\n","POST /dsp/inventory/deals - Creates a third party deal object  PUT /dsp/inventory/deals/{dealId} - Updates a third party deal object  GET /dsp/inventory/deals/{dealId}/advertiserPermissions/advertiserList - Gets list of advertisers assigned to the deal and its advertiser permissions strategy type  PUT /dsp/inventory/deals/{dealId}/advertiserPermissions/advertiserList - Updates advertiser permissions by adding/removing advertisers to/from the advertiser permission list  POST /dsp/inventory/deals/{dealId}/advertiserPermissions - Assigns permissions strategy to deal object  GET /dsp/inventory/deals/{dealId}/advertiserPermissions - Gets the advertiser permissions strategy type for a given deal  DELETE /dsp/inventory/deals/{dealId}/advertiserPermissions - Deletes both the permission strategy and associated advertisers from the deal advertiser permissions\n"," Though these features were previously available in the Amazon DSP console, advertisers can now access them programmatically through the Amazon Ads API. This helps bring the Amazon Ads API experience in line with the advertising console, and gives advertisers greater flexibility when managing Amazon DSP programmatic deals.\n"," With these additional Amazon Ads API endpoints, advertisers can create and update their Amazon DSP programmatic deal libraries, and build their own business applications leveraging these objects. They can now push their own deals to their Amazon DSP deal library, and assign specific advertiser permissions to each deal.\n"," This release supports all standard deal types, except Amazon Audience Guaranteed deals, which users will need to continue creating/updating via their Amazon DSP console. For full technical details, please see our deal create and update API documentation and deal advertiser permissions API documentation.\n"," June 29, 2023\n"," Regions: All\n"," Amazon Marketing Stream (beta) expands to include new sponsored ads campaign datasets. This includes information on Sponsored Products, Sponsored Brands, and Sponsored Display campaigns, ads, ad groups, and targeting.\n"," These signals enable Amazon Ads advertisers and partners to be notified in near-real-time via Amazon Marketing Stream when sponsored ads campaign data changes (for example, when campaigns pause, budgets change, or bids update) and what the modification was across thousands of advertising campaigns. Amazon Marketing Stream can help improve information integration patterns and operational efficiency by reducing the number of API calls that are typically required for intra-day campaign optimization. Advertisers and partners can use this dataset to react in near real-time to events that happen, such as campaign status changes, rather than run multiple intraday snapshots. Amazon Marketing Stream helps simplify the extract, transform, and load operations compared to snapshots, by showing you only information that has changed, when it occurs.\n"," The new campaign datasets are available to advertisers and partners using Amazon Marketing Stream (beta). This is available worldwide, with campaign datasets available by AWS region.\n"," The sponsored ads campaign data is split into four datasets: campaigns, ad groups, ads, and targets for each AWS region. You can access it following the instructions for Amazon Marketing Stream Onboarding Guide, and subscribe to the new campaign datasets.\n"," June 21, 2023\n"," Regions: AE, AU, BE, BR, CA, DE, EG, ES, FR, IT, JP, IN, MX, NL, PL, SA, SE, SG, TR, UK, US\n"," Rapid retail analytics, available through the Selling Partner API, allows advertisers to unlock hourly retail metrics. Analytics are available minutes after the close of an hour. This provides access to near real-time retail signals like ordered units and glance views to help advertisers measure performance and adjust their marketing and advertising activities.\n"," Partners and advertisers can leverage this timely information to add a never-before-available layer of measurement and insights to improve ASIN-level analytics, automate campaign changes, and inform cross retail-ads optimizations. Tool providers can add advertiser value by using rapid retail analytics to automatically increase budget allocated to an ASIN when hourly sales are below an expected range. They can also build their own specific strategies, such as ingesting advertiser forecasts.\n"," Rapid retail analytics is exclusively available through the Selling Partner API, with full details here. If you are not yet using the Selling Partner API, see the getting started guide.\n"," June 20, 2023\n"," Regions: All\n"," We have now updated the default rollover value for all accounts to be 100%. This change only impacts accounts that have not yet selected a default, either through the API or the advertising console. If you have already chosen either 25% or 100%, you will not experience any change in your settings. You can set your default to 25% using the POST /accountBudgets/featureFlags endpoint.\n"," For more information, view the User guide.\n"," June 15, 2023\n"," We have released a new user interface for the advanced tools center, featuring an updated look and feel as well as a new navigation. The navigation is now responsive, and readable on mobile devices.\n"," Documentation is split into categories based on use case:\n","Developer guides—featuring tutorials, product overviews, and code samples for developers  API reference—containing OpenAPI specifications and conceptual content about REST APIs  Knowledge Hub—including blogs, workshops, and bulk operations documentation\n"," You can also find a dedicated section for Support and Release notes for all advanced tools.\n"," If you have any feedback on the new design, we would love to hear from you in GitHub.\n"," June 15, 2023\n"," Regions: US\n"," As of May 22, any campaigns created using the version 3 Sponsored Brands POST /sb/campaigns endpoint are stored as multi-ad group (version 4) campaigns. With this change, existing integrations should continue to work as intended. Advertisers, agencies, and tool providers can leverage the Sponsored Brands version 4 endpoints or the Amazon advertising console to create additional ad groups and ads. This change is currently only in place for US advertisers. We will expand this change to advertisers in other regions in the coming months.\n"," See the version 4 migration guide for additional details.\n"," June 15, 2023\n"," Regions: BE\n"," Vendor test accounts are now available for Belgium through the Amazon Ads API. For an updated list of supported marketplaces for both vendor and author test accounts, see Creating test accounts in the advanced tools center.\n"," June 6, 2023\n"," Regions: US, CS, MX, UK, DE, ES, IT, FR, BE, PL, NL, SE, EG, TR, AE, AU, JP, IN, SG, BR, SA\n"," We added a new top-of-search impression share metric for Sponsored Products and Sponsored Brands to reporting in the Amazon Ads API. This metrics helps brands measure the effectiveness of their campaigns and keywords at driving brand awareness at scale.\n"," Integrators can now access the top-of-search impression share metric daily through the API. You can apply the metric to your systems to power notifications, automations, and other functionality. This helps support meeting top-of-search impression share goals on critical campaigns and keywords. These metrics can help brands accelerate brand strategy analysis and optimization as well as customer acquisition.\n"," The new top-of-search impression share metric is available at the campaign and keyword level through the sponsored ads reporting APIs. For Sponsored Products, the metric is available in sponsored ads version 3 reporting. For Sponsored Brands, the metric is available through the sponsored ads version 2 reporting. For more information on the metric and its report availability, see topOfSearchImpressionShare in version 3 and version 2.\n"," May 29, 2023\n"," Regions: All\n"," Advertisers tracking conversions occurring on their owned website, app, or offline property (such as an in-store environment) can now leverage two new options for conversion information delivery. Amazon Advertising tag can be used for tracking user actions taken on an advertiser-owned website. In addition to website conversions, Conversions API can accept events occurring in an advertiser-owned app, or offline property, such as an in-store environment through a server-to-server connection with the advertiser server or an integrated third party server. In addition to conversion signal delivery, the Conversions API allows advertisers to create and manage their conversion definitions, as well as access a user information deletion feature to assist advertisers with privacy-compliance for newly opted out users.\n"," Both sources support the use of durable identifiers, such as consented hashed email and are offered as durable alternatives to Simple Pixel (to be deprecated by the end of 2023). Conversions API is a great option for customers who host their event information themselves or in a third party server and prefer not to implement a third party tag on their website. Conversions API newly introduces the ability to import off-Amazon offline transactions, i.e. an end-user making a purchase in a store environment.\n"," Conversions API and corresponding features will be available to managed service and self-serve Amazon DSP advertisers world-wide. Tracked conversions can be viewed and managed in the Amazon DSP console Conversions page. To use the conversions for campaign measurement, conversions can be associated with orders using a new ‘Off-Amazon conversions’ widget when creating orders in the Amazon DSP console. Conversions signals will also be made available as seed information for audience building in the Amazon DSP console within Audiences.\n"," To start importing conversions, customers will use the Amazon DSP API to create a new object called a conversion definition. Conversion definitions enable advertisers to associate additional information about the event, such as fallback value or processing preferences. When importing events, each event will be mapped to a conversion definition using a conversion definition ID. For full technical details, please read the API reference.\n"," May 25, 2023\n"," Regions: All\n"," Partners and advertisers can now use the tactical recommendations API to get suggestions for their Sponsored Products, Sponsored Brands, and Sponsored Display campaigns. Recommendations are made by Amazon Ads machine learning algorithms or account management teams, and each recommendation includes the campaign setting changes needed to execute the recommendation. Example recommendation types include campaign optimizations like recommended bids, budgets, or targets, as well as suggested settings for creating new campaigns.\n"," The tactical recommendations API contains three new endpoints:\n","POST /recommendations/list to retrieve recommendations  POST /recommendations/update to update recommendations  POST /recommendations/apply to automatically apply recommendations to your account\n"," For more information, view the API reference, Overview, and Getting started guide.\n"," May 25, 2023\n"," Regions: US, CA, UK, DE, ES, IT, FR, PL, NL, SE, UA, SA, AU, JP, IN, SG, BR, MX\n"," New metrics are now available for the Sponsored Brands keyword recommendation through the Amazon Ads API. You can now receive search term impression share and search term impression rank for each recommended keyword. Search term impression share and rank are only available if your account has generated impressions for search terms matching the recommended keywords.\n"," These metrics help with making informed keyword selections by identifying potential keywords to target based on your impression share and impression rank of search terms. Search term impression share shows how your account-wide impression share for each search term compares to other advertisers, and the overall percentage of ad impressions you receive compared to other advertisers over last 7 days. For example, if you have a Sponsored Brands impression share of 20% for a search term, it means that you won 20% of all Sponsored Brands ad impressions for that search term. Similarly, search term rank helps you understand the level of activity on terms that you are targeting. For example, if you have a search term impression rank of 3 on a search term, it means that you received the third most Sponsored Brands ad impressions for the same search term over the last 7 days.\n"," For full technical details, please see the API reference.\n"," May 23, 2023\n"," Marketplaces: US, CA, UK, IT, FR, DE, ES, JP, IN, AU, MX\n"," Brand Metrics is a new measurement solution that quantifies opportunities for your brands at each stage of the customer journey on Amazon, and helps brands understand the value of different shopping engagements that impact stages of that journey. With Brand Metrics you can now access awareness and consideration indices that compare brand performance to peers using models predictive of consideration and sales. Brand Metrics is built at scale to measure all shopping engagements with your brand on Amazon, not just ad-attributed engagements and quantifies the number of shoppers in the awareness, consideration, and purchase stages of the shopping journey with your brand. Brand Metrics also provides Return on Engagement, so you can measure the average historical sales following a consideration event or purchase.\n"," Brand Metrics helps you...\n","Understand your brand performance. Brand Metrics measures the number of actual on-Amazon shopper engagements.  Measure the impact of your upper and mid funnel tactics to see how they contribute to shoppers moving through the purchase journey.  Evaluate engagement metrics to understand the value of your branded intent, and how brand purchasers go on to generate additional sales in the 12 months following a purchase.  Monitor your performance relative to your category and peers at each stage of the purchase journey and over time.  Optimize your marketing and advertising efforts on Amazon to engage more shoppers and build your brand.\n"," This release features two new endpoints - /insights/brandMetrics/report and /insights/brandMetrics/{reportId} to generate and retrieve Brand Metrics report in CSV or JSON format.  With these endpoints the developers can now create customizable reports by passing in a date range, a brand name, or by passing in specific metrics from a list of Brand metrics.\n"," For full technical details please see our overview and Brand Metrics reference documentation in the Amazon Ads API.\n"," May 18, 2023\n"," On 05/22/2023, Sponsored Display will introduce dynamic client-level throttling based on the most common partner traffic patterns. These limits are determined on a per-region basis with multiple limit tiers that correspond with our existing service capacity. With these changes, Sponsored Display campaign management client level throttling will be more consistent with Sponsored Products V3 API.\n"," Please note that different time periods of higher utilization may occur each day. Keep this in mind if you encounter a higher occurrence of 429 HTTP response codes. For more information, see our updated rate-limiting documentation. Rate limits in the Amazon Ads API are dynamic and based on system load. If you experience frequent rate limits, you can decrease this by following our best practices to avoid rate limiting.\n"," If you have any questions, visit the Amazon Ads API Support page and create a ticket with the subject title: \"Sponsored Display dynamic client-level throttling.\"\n"," May 12, 2023\n"," Regions: BE\n"," With the launch of Sponsored Display audience targeting in Belgium, registered sellers and vendors can customize the audiences they want to reach based on customer shopping signals and granular product refinements. For example, an advertiser can engage with audiences who searched, viewed, or purchased a collection of products on Amazon and reach them again on and off Amazon. Advertisers using Sponsored Display can also customize their creatives choosing any combination of video, headline, logo, or lifestyle image to help audiences discover their brands and products.\n"," For full technical details, see our Sponsored Display targeting documentation.\n"," May 10, 2023\n"," We are excited to launch Amazon Ads Status (beta), a new offering that provides all advertisers with the latest status information on Amazon Ads services. Advertisers will be able to see the current status of services like campaign creation, campaign management, ad delivery, and reporting on sponsored ads and Amazon DSP. Should there be a service interruption, advertisers can see more details for the event, including the description and status updates for that service.\n"," In the past, there has not been a dedicated location where advertisers or API integrators could look to get the current status of Amazon Ads services. During any service interruption, advertisers could only get that information after they log in to the advertising console or Amazon DSP. With the introduction of Amazon Ads Status (beta), users can now view the current status of Amazon Ads services and be updated with the latest information during any potential service disruptions, without the need to log in to the advertising console or Amazon DSP.\n"," The ad status information can be accessed programmatically using https&#x3A;//status.ads.amazon.com/status.json, which returns Amazon Ads Status in JSON format. The JSON schema is also available using https&#x3A;//status.ads.amazon.com/status.schema.json.\n"," Questions or comments on this feature? We would love to hear your feedback in GitHub.\n"," May 4, 2023\n"," Regions: US, CA, MX, UK, DE, ES, EG, PL, IT, FR, AU, AE, JP, BR, NL, TR, IN, BE, SG, SE, SA\n"," We are introducing new ASIN engagement metrics for select brand Stores\\* using the Amazon Ads API. With these metrics, eligible brands can understand how shoppers are engaging, and to what degree, with products listed on their brand Store. Metrics include ASIN renders, views, in-stock views, in-stock view rate, average in-stock view price, clicks, click-through rate, add-to-cart rate, purchases, units sold, conversion ratio, and average sales price.\n"," Store engagement metrics allow brands to better understand how shoppers interact with ASINs featured on their Store. Brands can use this signal over time to help increase shopper engagement, improve their store merchandising, keep high performing products in stock, and help boost overall Store performance.\n"," The ASIN engagement API returns key ASIN engagement insights for a given brandEntityId. For full technical details, see the API reference.\n"," April 28, 2023\n"," Starting September 30, 2023, any Sponsored Display campaigns that have not delivered any viewable impressions, clicks, or conversions over a 6-month look-back period could be automatically paused. This will allow advertisers and partners to focus on the campaigns that are driving outcomes.\n"," To help campaigns deliver results, Sponsored Display has features to create high-performance campaigns based on the outcomes they have selected. Advertisers and partners can create campaigns that are optimized for reach (to increase awareness), page-visits (to increase consideration), or conversions (to increase sales).\n"," We suggest adopting the following tools to help Sponsored Display campaigns deliver viewable impressions, clicks, or conversions (depending on how the campaigns are optimized):\n","Bid recommendations API  Targeting recommendations API  Budget usage API \\* Campaign diagnostic recommendations through Amazon Marketing Stream\n"," If you have a question, you can go to the Amazon Ads API Support page and create a ticket with the subject title: \"Sponsored Display pausing campaigns with no delivery.\"\n"," April 25, 2023\n"," We have introduced a new search UI to improve discoverability in the advanced tools center. The new design makes it easier to sort based on the type of content you are looking for: Guides & tutorials, API reference documentation, or release notes. You can also see your past searches.\n"," We have also improved our search algorithm to cover more content and enabled fuzzy match, so even if your search term does not match exactly, you should see results.\n"," Give it a try and let us know if you have any feedback in GitHub.\n"," April 18, 2023\n"," We have improved the design of the advanced tools center homepage to make it easier to discover resources and technical documentation.\n"," From the new homepage you can:\n","Easily access video tutorials, courses, user guides, and events.  Quickly navigate to popular content and see what is new.  Compare our different advanced tools offerings from a single page.\n"," Check out the new homepage now, and if you have any feedback, we would love to hear it in GitHub.\n"," April 6, 2023\n"," Regions: All\n"," In July 2022, we expanded the budget rules API to support performance-based budget rules for Sponsored Brands campaigns using return on ad spend (ROAS). We have now added two new metrics for Sponsored Brands performance-based budget rules: top-of-search impression share (metricName is IS) and percent of sales new-to-brand (metricName is NTB).\n"," Budget rules help you plan budget changes in advance so you can spend less time making manual adjustments. You can set rules based on specific dates or performance goals. Advertisers can use budget rules to reduce the likelihood of campaigns running out of budget, especially during peak days or holiday events.\n"," For more information, see:\n","Sponsored Brands budget rules API reference  Sponsored Brands budget rules overview  Sponsored Brands performance-based budget rules\n"," April 6, 2023\n"," Sponsored Display has launched targeting recommendations for Amazon audiences. Amazon audiences is a catalog of pre-built, easy-to-use audience segments that help advertisers discover and reach new customers.\n"," Advertisers can now find suggestions on Amazon audiences to help discover new customers based on their brand core customers. For example, if an advertiser sells camping accessories, they can select the recommended audience “Outdoor Enthusiasts.” These recommendations are built by Amazon Ads and informed by a variety of first-party shopping signals. Self-service advertisers can now directly connect with audiences relevant to their promoted products by selecting the recommendations. These recommendations are now available for Sponsored Display audience targeting campaigns within the Amazon Ads API.\n"," Advertisers can now find relevant suggestions on audiences across four segments: in-market, lifestyle, interests, and life events that are informed by Amazon first-party shopping and streaming signals.\n"," For full technical details, please see our Sponsored Display documentation, including the updated targeting recommendation documentation.\n"," Note: If you are already specifying a version in the Accept request-header field, you must update to application/vnd.sdtargetingrecommendations.v3.3+json to access the new features.\n"," April 5, 2023\n"," Regions: All\n"," With the new budget usage feature now available to API users without access restrictions, users worldwide can pull their real-time budget usage percentage for Sponsored Products, Sponsored Brands, and Sponsored Display using the Amazon Ads API. You can pull budget usage information for both campaigns and portfolios.\n"," Your budget usage percentage helps you understand how fast your campaigns and portfolios are spending daily budgets, and can give you the information needed to make quick budget decisions.\n"," For more information, see the budget usage resource in the Sponsored Products reference, Sponsored Brands reference, Sponsored Display reference, or Portfolios reference. You can also test the budget usage endpoints using our Postman collection.\n"," April 3, 2023\n"," We have released new overview and tutorial content for Sponsored Brands and the creative asset library API. This content helps you create a Sponsored Brands campaign and understand its structure, the different ad formats, and how to upload and register creatives.\n"," Find all new Sponsored Brands content under Sponsored Brands > Overview. Find all new creative asset library API content under Common resources > Creative Asset Library beta.\n"," Also see our updated Postman collection, where we have added new Sponsored Brands and creative asset library request templates.\n"," March 31, 2023\n"," Amazon Marketing Stream (beta) has added a new dataset, surfacing sponsored ads campaign recommendations to partners worldwide. With this release, partners can now receive targeted recommendations that they can use to manage campaigns more efficiently. These recommendations not only highlight opportunities to improve the performance of existing ad campaigns or create new ad campaigns, but also surface the suggested campaign settings to take action on those opportunities. These recommendations have been available to advertisers in the advertising console and we are now expanding access through Amazon Marketing Stream worldwide.\n"," The sponsored ads campaign recommendations come in the form of pre-packaged campaign setting changes suggested by Amazon Ads machine learning algorithms, based on a diagnosis of the advertiser catalogue and campaigns (for example, campaigns that have opportunity to improve ROAS compared to similar campaigns by optimizing bids, or unadvertised ASINs that can drive incremental sales if added to an ongoing campaign). Each recommendation will have an insight on how the opportunity was identified and details on the inputs for the recommendation. The campaign setting changes are delivered as campaign optimizations including recommended bids, budgets, or targets, as well as suggested settings for creating a new campaign. After subscribing to this dataset on Amazon Marketing Stream, partners receive these recommendations daily. Partners can easily update or apply the recommendations in bulk by calling the tactical recommendations API and passing the recommendation ID. Partners can also use the sponsored ads campaign management APIs to make the suggested campaign changes.\n"," The current recommendations available in the dataset include:\n","Sponsored Products budget recommendations to identify high performing campaigns (ROAS of greater than three) that might run out of budget in next seven days (utilized 80% of their budget).  Sponsored Products budget rules for special events to identify campaigns which might go out of budget during upcoming high-traffic days in the next eight weeks and apply a budget increase for those specific days.  Sponsored Brands and Sponsored Display bid optimization to identify low-performing campaigns and suggest bid optimization to improve ROAS.\n"," We will enabling more recommendations in the coming months.\n"," For more details:\n","View dataset schema and IAM policies - Create SQS queues for the new dataset using our CloudFormation template - View Tactical recommendations API user guide for Stream\n"," March 30, 2023\n"," Regions: BE, EG, SA, SG, PL, TR\n"," Advertisers can now choose to customize creatives using a headline and logo, image, or video through Sponsored Display self-service display solution that helps grow their business with Amazon across more marketplaces. The new video creative capability supports videos up to 45 seconds so advertisers can better tell their stories to customers, helping them understand the product and brand with more engaging content.\n"," Video creatives can help advertisers tell better stories while serving ads on and off Amazon in their own visual language, helping shoppers get excited about the brand and product experience. If insights on creative are available that helps drive traffic or engagement, advertisers can use that creative for their Amazon Ads campaigns. Ads will link directly to the advertiser product detail pages, so audiences can learn more about their product and consider purchasing.\n"," For full technical details, please see our updated Sponsored Display documentation, including contextual targeting support for creativeType of VIDEO.\n"," March 29, 2023\n"," We have released new overview and tutorial content for the DSP reporting API.\n"," This content helps you:\n","Request your first report. - Understand DSP reporting concepts such as dimensions and reporting according to your account type. - Get answers to frequently asked DSP reporting questions. - Reference a consolidated lists of DSP report types and metrics.\n"," Find all new reporting content under Reporting > Amazon DSP.\n"," See also our updated Postman collection. We have included new DSP report request templates for each DSP report type.\n"," March 28, 2023\n"," Regions: All\n"," We have updated our daily budgeting policy for Sponsored Products, Sponsored Brands, and Sponsored Display, allowing you to spend up to 100% more than the average daily budget on any given day. This update enables you to benefit from high-traffic days by using budgets from previous days when your spend is below your daily budget. The daily budget amount is averaged over the course of a month.\n"," This feature is available for vendors, sellers, and authors, and the policy change is effective worldwide for sponsored ads.\n"," You can also choose to set the additional spend from leftover amounts to 25% or 100% for all your campaigns using the average daily budget settings API. For more information, view the user guide and API reference.\n"," March 20, 2023\n"," As announced at the end of January, additive budget rules are now live for users of the Amazon Ads API and advertising console. Now, if multiple budget rules meet their conditions, all rules are applied and increase daily budget independently.\n"," This change will impact all advertisers worldwide (vendors and sellers) who use budget rules for their Sponsored Products, Sponsored Brands, and Sponsored Display campaigns through the Amazon Ads API or advertising console.\n"," You can learn more about additive budget rules in the user guide associated to your product (Sponsored Products, Sponsored Brands, Sponsored Display).\n"," March 14, 2023\n"," Regions: US, UK, DE, FR, JP, CA, IT, ES, IN, AU, NL, AE, SA, TR, BR, MX, SG, EG, BE, SE, PL\n"," We are introducing a new brand Stores insights API you can use to programmatically to access Stores insights. These insights include performance metrics like number of store visitors, sales, orders, and page views. This information can be combined with other ads data for you to get holistic view of your Store performance.\n"," Historically, Store owners could only access insights through the Amazon advertising console one store at a time. With introduction of the Store insights API, Store owners can access the same information through the Amazon Ads API. This is especially helpful for getting Store insights across different countries (or locales).\n"," The insights API returns key Store insights such as views, orders, units purchased, and store visits for a given brandEntityId. Advertisers are also able to filter the results based on date range, Store page, and source of traffic such as ads, organic traffic, and custom tags. The API response is paginated a max number of documents returned of 1500.\n"," For full technical details, see the API reference.\n"," March 8, 2023\n"," We have released a new reference implementation that developers can use to set up and manage an Amazon Marketing Stream integration. This python-based reference application uses the AWS CDK to provision the suggested AWS infrastructure needed to confirm dataset subscriptions and start receiving advertiser data. The package also contains a CLI to create, update, and read Stream dataset subscriptions for any given advertiser.\n"," For more information, find the reference implementation in GitHub or view our Reference implementation overview.\n"," March 8, 2023\n"," Sponsored Display datasets are now available globally in Amazon Marketing Stream (beta). We are excited to expand the Sponsored Display datasets (sd-traffic and sd-conversion) in Amazon Marketing Stream (beta) to all countries currently supported by the Amazon Ads API. Amazon Marketing Stream delivers Amazon Ads campaign metrics and information to the advertiser or integrator AWS accounts via a push-based model in near real time.\n"," To access the Sponsored Display datasets in the EU or FE regions, you should use the following AWS source ARNs as part of your IAM policy:\n"," sd-traffic dataset:\n","EU: arn:aws:sns:eu-west-1:947153514089:\\* - FE: arn:aws:sns:us-west-2:310605068565:\\*\n"," sd-conversion dataset:\n","EU: arn:aws:sns:eu-west-1:664093967423:\\* - FE: arn:aws:sns:us-west-2:818973306977:\\*\n"," For more details:\n","View the Data guide for full IAM policies for each dataset. - Create SQS queues for Sponsored Display datasets in the new regions using our updated CloudFormation template.\n"," March 7, 2023\n"," Regions: US, CA, MX, UK, DE, ES, PL, IT, FR, AU, AE, JP, BR, NL, TR, SE, IN, SA, SG\n"," Sponsored Brands campaign insights provides advertisers with new metrics and insights to inform Sponsored Brands campaign creation. This feature:\n","Provides search term impression share and search term impression rank for keywords.  Informs an advertiser if selected keywords have low search traffic.  Informs an advertiser if bids have a low probability of winning an auction.\n"," Search term impression share indicates the percentage share of all ad-attributed impressions an advertiser received on that keyword in the last seven days and search term impression rank indicates an advertiser ranking among all advertisers for a keyword by ad impressions in a locale or country. Search term metrics are only available for keywords the advertiser has previously targeted with Sponsored Brands ad impressions.\n"," Campaign insights enable advertisers to make informed keyword selections and productive bids during the campaign creation process. The search term metrics can help advertisers identify potential keywords to target. The keyword and bid insights can help advertisers understand if they should make adjustments to their keyword selections or bid amounts. These new metrics and insights can improve an advertiser ability to win and deliver impressions.\n"," Vendors and sellers can use the new POST /sb/campaigns/insights endpoint to send a request. Currently, only keyword targets are supported.\n"," February 28, 2023\n"," We are excited to expand Amazon Marketing Stream (beta) to India. This expansion follows our global launch in October 2022.\n"," Note: Advertisers in India are considered part of the EU region and should be subscribed to queues in AWS region eu-west-1.\n"," February 28, 2023\n"," The following endpoints will be deprecated on August 31, 2023:\n","GET /sp/campaigns/{campaignId}/budgetRules/budgetHistory - GET /sb/campaigns/{campaignId}/budgetRules/budgetHistory - GET /sd/campaigns/{campaignId}/budgetRules/budgetHistory\n"," For more information, see Deprecations.\n"," February 28, 2023\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SA, SG, UK, US\n"," Today, we are moving the Sponsored Brands version 4 campaign management API functionality out of beta and into general availability status. Advertisers, agencies, and tool providers can leverage these APIs to create and manage their Amazon Sponsored Brands campaigns worldwide. You can generate create and manage ad group-based campaigns as well as legacy campaigns similar to the advertising console. To encourage adoption, the version 4 APIs follow the existing API pattern for Sponsored Products or Sponsored Display for campaign management. This functionality is available to advertisers, tool providers, and agencies that have self-service access to Sponsored Brands.\n"," We previously released these endpoints in beta. Today, we have added two new endpoints to update and delete campaigns. Note that the endpoint structure has changed. For example, POST /sb/beta/campaigns is now POST /sb/v4/campaigns.\n"," The beta endpoints will be deprecated on August 31, 2023. You will need to start using the general availability endpoints by this date. For more details, see Deprecations.\n"," For more information, see:\n","Migration guide - Creating version 4 campaigns - API reference\n"," February 17, 2023\n"," Regions: US, CA, MX, DE, ES, FR, IT, ES, NL, UK, AU, IN, JP, UAE, SA\n"," To improve the performance and stability of the Amazon DSP reporting API, we have set a limit for entity-level report requests to one hundred advertisers per report request. For entities with more than one hundred advertisers, you now need to request reports of up to one hundred advertiser IDs at a time. For entities with less than one hundred advertisers, there is no change. Additionally, entities that are invalid or do not have any advertisers will now receive an error message. These changes apply to all users of the reporting API across all available regions.\n"," For more details, see the DSP reporting reference.\n"," February 15, 2023\n"," We are updating the version 3 reporting API to fix a bug in the purchased product report for Sponsored Brands and Sponsored Products.\n"," This bug caused currency values to be reported in cents or equivalent denominations instead of dollars and equivalent denominations. This has now been fixed in the purchased product report for both Sponsored Products and Sponsored Brands. Now all currencies will be reported in dollar or equivalent denominations based on the currency of the profile that a given campaign is associated with. For more information, please see the version 3 purchased product report.\n"," February 13, 2023\n"," Regions: US, CA, ES, FR, IT, DE, UK, AE, JP, IN, AU, NL, BR, MX, SE, SG, PL, TR, EG, SA, BE\n"," Sponsored Display is launching reach and frequency metrics for vendors and registered sellers across all regions in the Amazon Ads API.\n"," With the release of the cumulativeReach metric, advertisers can better understand the total number of unique users that an ad was exposed to. With the launch of the averageImpressionFrequency metric, advertisers can better understand the average number of times those users saw an ad and how that drives users down the funnel.\n"," Metric definitions:\n","cumulativeReach = Total number of unique users exposed to an ad from either a campaign, ad group, or product ad over the lifetime of the campaign or the past six months, whichever is shorter. This metric is updated daily. - avgImpressionsFrequency = Average number of times unique users were exposed to an ad over the lifetime of the campaign.\n"," When requesting reports for campaign, ad group and product ad, you can add the new metrics of avgImpressionsFrequency and cumulativeReach for any Sponsored Display campaign (CPC or vCPM) in the Amazon Ads API. For full technical details, please see our updated Sponsored Display reporting documentation.\n"," February 10, 2023\n"," Technical specifications for all endpoints in the Amazon Ads API are now indexed in the search interface in the advanced tools center. Developers will see results for search terms that match paths or descriptions for all operations in the API. To search technical specifications, use the search bar in the Amazon Ads advanced tools center.\n"," February 7, 2023\n"," Amazon DSP introduces new Brand Safety segments which enable greater control over how advertisers serve ads on inventory associated with these topics:\n","‘Death & Injuries - High Risk’ - ‘Death & Injuries - High & Medium Risk’ - ‘Death & Injuries - High, Medium & Low Risk’ - ‘Extreme & Graphic‘\n"," The brand safety functionality gives you more control on where your ads serve to protect your brand and block ads from delivering on content that does not align with your brand. For more details, refer to our API documentation.\n"," February 6, 2023\n"," Regions: BE\n"," We have added support for Belgium (BE) to the Amazon Ads API. For more details, see the API endpoints by region, Bid constraints by marketplace, Budget constraints by marketplace, as well as the countryCode, currencyCode, and timezone parameters in the profiles reference.\n"," February 1, 2023\n"," Regions: US, CA, ES, FR, IT, DE, UK, AE, JP, IN, AU, NL, BR, MX, SE, SG, PL, TR, EG, SA, BE\n"," Sponsored Display expands ASIN report to vendors while adding view-based attribution in the Amazon Ads API. Previously this report was only available for vendors. Also known as the purchased product report, pulling this data provides details on non-advertised products that were purchased by shoppers after they interacted with a Sponsored Display ads. Along with expanding to vendors, we have also added metrics to Sponsored Display view attributed metrics for those campaigns with vCPM (cost per 1 thousand viewable impressions) billing and attribution.\n"," This report helps advertisers identify new products within their portfolio that they may consider advertising, identify new cross-selling product targeting opportunities, and uncover insights into shoppers buying behavior. Use the new view based metrics for both sellers and vendors when pulling data from /sd/asins/report with campaigns using the costType vCPM in the Amazon Ads API. These new metrics include:\n","viewAttributedUnitsOrdered1dOtherSKU - viewAttributedUnitsOrdered7dOtherSKU - viewAttributedUnitsOrdered14dOtherSKU - viewAttributedUnitsOrdered30dOtherSKU - viewAttributedSales1dOtherSKU - viewAttributedSales7dOtherSKU - viewAttributedSales14dOtherSKU - viewAttributedSales30dOtherSKU - viewAttributedConversions1dOtherSKU - viewAttributedConversions7dOtherSKU - viewAttributedConversions14dOtherSKU - viewAttributedConversions30dOtherSKU\n"," For full technical details, please see our updated reporting documentation.\n"," January 31, 2023\n"," Regions: US, UK, DE, JP, FR, IT, IE, IL, ES, CA, CH, MA, LU, FI, NO, DK, MX, KW, AU, AE, AT, BE, BR, BH, NL, IN, SA, SE, TR, NZ\n"," Amazon DSP is launching 4 new endpoints available through the Amazon Ads API to enable advertisers to manage their Amazon DSP programmatic deals:\n","POST /dsp/inventory/deals/list - Retrieves a list of programmatic deals, optionally matching filter inputs.  POST /dsp/inventory/deals/performance/list - Retrieves performance metrics for each specified deal.  GET /dsp/inventory/deals/{dealId}/lineItems - Retrieves list of line items targeting a given single deal. \\* POST /dsp/inventory/deals/exchanges/list - Retrieves list of supply sources for deals.\n"," Though these features were previously available in the Amazon DSP console, advertisers can now access them programmatically through the Amazon Ads API. This helps bring the Amazon Ads API experience in line with the advertising console, and gives advertisers greater flexibility when managing Amazon DSP programmatic deals.\n"," With these additional Amazon Ads API endpoints, advertisers can retrieve their Amazon DSP programmatic deal libraries at scale, and build their own business applications leveraging these objects. They can now synchronize their Amazon DSP deal library with their internal repositories, and retrieve deal metadata, performance metrics, and line items targeting each deal.\n"," This release supports all standard deal types, with some exceptions for Amazon Audience Guaranteed deals: while these deals can be retrieved, Amazon Ads API users may not yet retrieve performance data of these deals. For full technical details, please see our API documentation.\n"," January 31, 2023\n"," Regions: All\n"," By the end of February 2023, we will make budget rules to be additive, meaning that more than one rule can be active at a time. Currently, only a single rule can be active, but with this release, if multiple budget rules meet their conditions, all rules will be applied and increase daily budget independently.\n"," We are making this change so that budget rules are more customizable, allowing advertisers to build strategies for budget increases based on multiple triggers instead of having to consider which budget rule will be active at a given point in time.\n"," This update will impact all advertisers worldwide (vendors and sellers) who use budget rules for their Sponsored Products, Sponsored Brands, or Sponsored Display campaigns through the Amazon Ads API or advertising console. We will post a separate release note to notify advertisers once this change is live.\n"," If you have a question, you can go to the Amazon Ads API Support page and create a ticket with the subject title Budget Rules Additive Behavior.\n"," January 31, 2023\n"," Regions: United States (US)\n"," Sponsored Brands is releasing the new missed opportunities and budget recommendations API which will provide recommendations for campaigns that have gone out of budget. This API will provide predicted missed sales, clicks, and impressions during these out of budget periods, while also recommending a new budget to prevent them in the future.\n"," Roughly ten percent of all Sponsored Brands campaigns go out of budget daily, losing out on numerous interactions with customers. The missed opportunity and budget recommendations API contextualizes the business impact of these periods in the form of measurable key performance indicators. By adopting the suggested budget, advertisers can prevent these cases in the future and ensure their campaigns are reaching their full potential.\n"," This feature is available for vendors and sellers through the Amazon Ads API. Advertisers can use the new POST /sb/campaigns/budgetRecommendations endpoint that accepts a list of campaigns and returns suggested budget, percent time in budget, and missed opportunities in clicks, impressions, and sales.\n"," January 31, 2023\n"," Regions: United States (US)\n"," Omnichannel Metrics (OCM) now offers advertisers the capability to automate budget optimization for the total impact of your campaign, inclusive of both online and offline sales, on and off Amazon. Advertisers opted-in for budget optimization will have their budget automatically shift between line items based on omnichannel performance, thereby helping to optimize the overall outcome of your campaign.\n"," The new OCM automated budget optimization feature alleviates the current manual process of allocating budget across multiple line items to optimize budget and maximize Combined ROAS.\n"," This feature is designed to help our advertisers and agencies to 1) increase efficiency by reducing wasted impressions on lower-performing ad tactics, 2) enable agile optimization allowing for line items with specific budget requirements to be opted out of budget optimization, while other line items in the same campaign could continue to be optimized leveraging this budget feature, and 3) empower advertisers with the control to opt out, pause or re-enroll line items within the budget optimization at any point in the campaign.\n"," This feature is available for CPG and grocery advertisers with an active Omnichannel Sales Study, including both managed service and self-service DSP accounts.\n"," To access this feature, use the Amazon DSP create order API with the optimization goal PURCHASES_ON_OFF_AMAZON and goal KPI of COMBINED_RETURN_ON_AD_SPEND. The budget and bid optimization will be automatically selected. For full technical details, please see our updated documentation.\n"," January 26, 2023\n"," Regions: AE, AU, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, US\n"," Amazon Ads is launching bid recommendations for Amazon audiences (i.e., In-market, Life events, Lifestyle and Interests) and purchase remarketing. Bid recommendations will be provided for all Sponsored Display audience targeting campaigns, including those selected to “Optimize for viewable impressions”, “Optimize for page visits”, or “Optimize for conversions”.  These recommendations will be available for Sponsored Display campaigns within the Amazon Ads API.\n"," This helps advertisers receive bid recommendations based on the bid optimization they select. When the bid optimization is \"Optimize for viewable impressions\", the bid suggestions will be for 1000 viewable impressions rather than per click, which helps advertisers maximize impression share for the selected audiences. When bid optimization is \"Optimize for page visits\", bid suggestions will help advertisers get impressions on requests that are likely to get clicks. When bid optimization is \"Optimize for conversions\", bid suggestions will help advertisers get impressions on requests likely to convert.\n"," For full technical details, please see our Sponsored Display documentation, including the updated bid recommendations documentation.\n"],"documentType":"release-note"},{"title":"Bulksheets and bulk operations release notes","sectionHeader":null,"path":"/en-us/release-notes/bulk-operations","content":[" September 9, 2026\n"," You can now control whether performance data is included in your Sponsored Ads exports in bulk operations. In the export modal, under Include, the Performance data checkbox is selected by default so your file continues to include performance metrics as before.\n"," Uncheck the Performance data checkbox to leave performance metrics out of the exported file. Excluding performance data can make exports faster to generate and download, which is useful when you only need campaign structure and settings and don't require performance information.\n"," Availability: Worldwide\n"," August 31, 2026\n"," You can now limit a Sponsored Ads export to specific campaigns. In the Download Campaigns modal, select Export specific campaigns only under Campaign filter, then search for and select the campaigns you want to include. Each campaign in the list is labeled with its ad type, and you can use Select all or Clear all to adjust your selection quickly. Filtering to specific campaigns keeps exported files smaller and faster to download, which is especially useful for accounts with many campaigns.\n"," Select at least one campaign when the filter is turned on. If you turn on Export specific campaigns only without selecting any campaigns, your exported file will not contain any campaign data. To export all of your campaigns, leave the checkbox cleared. Archived campaigns are not available in the campaign filter.\n"," Availability: Worldwide\n"," August 27, 2026\n"," A new read-only Creative Association Status column is now available for creative associations in Amazon DSP bulk operations. This column displays the approval status of each ad creative association, so you can review the status directly in your downloaded file instead of checking it in the UI. The column is auto-populated on download and is informational only — any edits to this column are ignored on upload.\n"," Availability: Worldwide\n"," To learn more, see the DSP bulk operations entities reference.\n"," August 24, 2026\n"," This update applies to templates you download for Amazon DSP bulk operations. When you download a template, its editable columns now validate your entries directly in Excel as you fill them in. Previously these rules only appeared as informational prompts, so a value that was out of range, too long, or in the wrong format looked fine until your upload was processed.\n"," Now the template enforces the same rules up front:\n","Typing shows a pop-up. When you type a value that is out of range, too long, or in the wrong format, Excel stops the entry and shows a pop-up explaining what is expected. - Pasting turns the cell red. Pasted values skip the typing check, so any pasted value that does not meet a column's requirements turns the cell red, making it easy to find and fix before you upload.\n"," Catching these issues while you build the template means fewer errors surface at upload time, so you can complete your bulk changes with fewer round trips.\n"," To learn more, see the DSP bulk operations entities reference.\n"," August 13, 2026\n"," You can now preview your bulk operations files directly on the dashboard—no download needed. Previously, you had to download a file to see its contents.\n"," From the requests table, open a preview of your original uploaded file or its error report to quickly review your entries or see what needs to be fixed—all without leaving the page. If a file is too large to preview, it downloads automatically so you always have a way to access your data.\n"," To learn more, see the bulk operations overview.\n"," August 10, 2026\n"," A new Comments column is now available for orders in Amazon DSP bulk operations. Use this free-text field to add a note to an order — for example, internal context or a brief description. You can set the value when creating an order and edit it on update. The Comments value accepts up to 1,000 characters.\n"," Availability: Worldwide\n"," To learn more, see the DSP bulk operations entities reference.\n"," July 30, 2026\n"," The read-only Deal Selection names column is now populated on export for Amazon DSP bulk operations. Each deal is shown in deal name (id) format, in the same order as the Deal selection column, so the two columns stay row-aligned. This makes it easier to understand which deal you are selecting and to quickly check that the media type aligns with the deal supply. The column is informational only and is ignored on upload.\n"," Availability: Worldwide\n"," To learn more, see the DSP bulk operations entities reference.\n"," July 30, 2026\n"," The bulk operations tracking table now shows more than your 200 most recent requests. Previously, the table was limited to your last 200 uploads and downloads, so older requests dropped off the list. You can now go further back into your bulksheet history to find past uploads and downloads.\n"," To learn more, see the bulk operations overview.\n"," July 28, 2026\n"," You can now upload up to five files in a single bulk upload for Amazon DSP and Sponsored ads bulksheets. Previously, you could upload only one file per interaction.\n"," Select up to five files in the upload modal and each file is submitted as its own upload, appearing as a separate row in the tracking table. This makes it easier to upload a set of files together without repeating the upload flow for each one.\n"," To learn more, see the bulk operations overview.\n"," July 16, 2026\n"," You can now give your exported file a custom name when you download from bulk operations. When you start an export, an optional File name field lets you enter a name for the exported file. Naming your exports makes it easier to categorize and track downloads—so you can quickly tell one export apart from another without relying on system-generated file names. If you leave the field blank, the export uses the default file name as before.\n"," July 6, 2026\n"," Sponsored Brands multi-ad group bulksheets now support two new ad entity types: Manual Collection ad and Auto Collection ad. Learn more in the Sponsored Brands multi-ad group bulksheets overview.\n","Manual Collection ad — Select 3–10 products from your catalog to feature in a single collection ad. You can optionally provide a custom title (max 32 characters) or let Amazon auto-generate one. \\* Auto Collection ad — Let Amazon AI automatically select and group the most relevant products from your catalog based on your keyword targets and shopper search queries.\n"," New bulksheet columns:\n","|Column    |Applies to    |Description    |\n","\\|---    \\|---    \\|---    \\|\n","|Ad Title    |Manual Collection ad    |Optional title displayed on the collection ad creative (maximum 32 characters). Use this to communicate your brand message or highlight a product theme (e.g., \"Summer Essentials\" or \"Best Sellers\"). If left blank, Amazon will auto-generate a title based on the products in your collection.    |\n","|Product Exclusions    |Auto Collection ad    |Optional comma-separated list of product ASINs to exclude from the Amazon automatic product selection (maximum 1,000 ASINs). Use this to prevent specific products from appearing in the automatic curated collection.    |\n"," Product Collection Deprecation notice:\n"," The Product collection ad entity type is deprecated (Deprecation Notice). Existing Product collection campaigns will continue to function and can be edited, but new campaigns should use Manual Collection ad or Auto Collection ad instead.\n"," Resources:\n","Sponsored Brands multi-ad group bulksheets overview  Create Sponsored Brands multi-ad group campaigns  Examples: Sponsored Brands multi-ad group campaigns\n"," July 1, 2026\n"," You can now filter by ad group when downloading spreadsheets for Amazon DSP bulk operations in the DSP UI worldwide. This filter lets you limit the downloaded file to specific ad groups, making it easier to manage large DSP campaigns at scale. To learn more, see the DSP bulk operations overview.\n"," Availability: All\n"," July 1, 2026\n"," A new read-only Inventory group names column is now available for line items in Amazon DSP bulk operations. This column displays the names of the inventory groups targeted by each line item, making it easier to identify the targeted private marketplace inventory at a glance. The column is informational only and cannot be edited on upload.\n"," Availability: Worldwide\n"," To learn more, see the DSP bulk operations entities reference.\n"," June 8, 2026\n"," A new column header Off-Amazon ad serving is now available in bulksheets for Sponsored Products campaigns. This column allows advertisers to update settings for ads served off amazon.\n"," Availability: US\n"," To learn more, see Get started with bulksheets for Sponsored Products.\n"," May 29, 2026\n"," We have removed the daily limits for Amazon DSP bulksheets. Advertisers can now create and update orders, line items, and creative associations with DSP bulksheets without being constrained by the previous daily upload limits, making it easier to manage large DSP campaigns at scale. To learn more, see the DSP bulk operations overview.\n"," May 18, 2026\n"," Amazon DSP bulk operations documentation is now available on the Advertising developer portal. The new documentation covers:\n","Overview — How DSP bulk operations works and supported entity types  Get started — Step-by-step guide to downloading, editing, and uploading spreadsheets  Entities reference — Complete column reference for orders, line items, and creative associations  Create orders and line items — Guide for creating new orders and line items  Update orders and line items — Guide for updating existing orders and line items \\* FAQs — Frequently asked questions\n"," April 28, 2026\n"," Amazon DSP bulksheets now support programmatic guaranteed (PG) ad groups worldwide. Advertisers can create and manage programmatic guaranteed line items using DSP bulksheets across all marketplaces where Amazon DSP operates, enabling them to manage guaranteed deals at scale alongside their other DSP campaigns. To learn more, see the DSP bulk operations overview.\n"," May 22, 2025\n"," We have expanded negative targeting so every campaign and ad group has the same options, regardless of targeting type. In bulksheets, negative product targeting uses product targeting expressions to also negatively target brands. Learn more: Get started with bulksheets for Sponsored Products).\n"," July 8, 2024\n"," Regions: ZA\n"," We have added support for South Africa (ZA) to bulksheets. For bulksheets, you can reference Bid constraints by marketplace and Budget constraints by marketplace.\n"," June 4, 2024\n"," Availability: Egypt, Saudi Arabia, and United Arab Emirates\n"," When you create Sponsored Products campaigns using bulksheets, you can now add keywords in your preferred or native language. To use this new feature, you will input keywords in your preferred language in a new column labeled “Native language keyword,” and input your preferred language code in a new column labeled “Native language locale.” Leave the “Keyword text” field blank. When you upload your bulksheets file, your “native language” keyword will be automatically translated into English or the default language of your locale.\n"," Before this launch, advertisers in some locales had to enter keywords in English, even if their preferred or native language was not English. With keyword translations, advertisers have the option to enter keywords in their native language instead.\n"," April 23, 2024\n"," Regions: Egypt & Saudi Arabia\n"," Soon, customers in Egypt and Saudi Arabia will be able to add keywords in their preferred or native language. The keywords will then be automatically translated into English when the file is uploaded. When this new feature launches, you will see two new columns labeled Native language keyword and Native language locale, where you can input keywords in your native language along with the language code. When you upload the bulksheets file, the translated keywords will automatically populate the current “Keyword text” field. You can see the translated keywords if you download a file later.\n"," We will provide more details and documentation for using this feature once it launches.\n"," January 22, 2024\n"," We recently announced that Sponsored Products search term report data was available in bulksheets. Now, we have expanded to support Sponsored Brands search term reports. This report will be in a new tab and will include much of the same information you would find in the advertising console report, including the customer search terms that were used to discover your ads—-but in bulksheets, you will also have the entity IDs available, so you can quickly make adjustments if needed.\n"," You can include a search term report in bulksheets if you go to the bulk operations main page, create a custom spreadsheet, and check the box labeled Sponsored Brands search term report in Step 1.\n"," Learn more about search term reports in bulksheets.\n"," December 11, 2023\n"," Sponsored Brands multi-ad group campaigns are now available in bulksheets. With this latest version, you will be able to manage Sponsored Brands ad groups in bulksheets. You can also add custom bidding adjustments by placement, update creative assets in bulk, and create all Sponsored Brands ad formats–including Store spotlight ads. Previously in bulksheets, you could not create or manage ad groups for Sponsored Brands, add custom bidding adjustments, or update creative assets.\n"," You can still use the previous version of Sponsored Brands in bulksheets, but you will not see ad groups or any placement data in the spreadsheet. To manage these entities, you must use the latest version, which you can get by selecting the checkbox labeled Sponsored Brands multi-ad group data (NEW) when you download a bulksheets file.\n"," September 21, 2023\n"," Regions: US, CA, MX, UK, DE, ES, IT, FR, BE, PL, NL, EG, TR, AE, SA, AU, JP, IN, SG, BR\n"," Sponsored Products Rest Of Search Placement Bid Adjustment is now available in beta. Advertisers using bulksheets can now apply bid adjustment for rest-of-search placements in their Sponsored Products campaigns. The new placement bid adjustment control for rest of search works same as the adjustments available for top-of-search (first page) and product-page placements. Through the new control, advertisers can adjust their bid for rest of search by up to 900%, same as the other two placements.\n"," For bulksheets, you will apply this new placement in the \"bid adjustment\" entity row when you create or update campaigns. Learn more about creating bid adjustments in bulksheets\n"," September 15, 2023\n"," Regions: All\n"," You can now download a bulksheet in your chosen language if that language is selected in your advertiser profile. For example, if Japanese is the language selected in your profile, you will see Japanese text in bulksheets downloads. When you upload the file, you can use any supported language, regardless of the language selected in your profile. Note that the “Operation” field will be blank in the downloaded file. If you need guidance on what values to enter into this field for languages other than English, refer to this language guide for bulksheets translations.\n"," July 27, 2023\n"," The legacy version of bulksheets will be deprecated on September 28, 2023, and will no longer be available for campaign management. Ahead of this date, we encourage you to migrate to the new version if you have not started already.\n"," To help you through this transition, we have published a new set of bulksheets documentation, getting started guides, video tutorials, detailed instructions for creating and managing all sponsored ads campaigns, and other resources. Please check out these links to learn more:\n","Bulksheets overview  Migration guide  Video tutorials \\* FAQs\n"," July 18, 2023\n"," Bulksheets downloads are now available in Chinese and Japanese languages. If you have one of these selected as the language in your advertiser profile, you can download a bulksheets file in the selected language. All headers, error messages, and other text will be translated. Some text, such as campaign and ad group names, will remain unchanged. For bulksheets uploads, you can use Chinese, Japanese, or English, regardless of the language selected in your profile. For bulksheets uploads, you can use Chinese or Japanese if these are selected in your profile, or you can upload in English, regardless of the language selected in your profile.\n"," June 22, 2023\n"," We have updated the names of some column headers and values to make them more readable. For example, in the Portfolios sheet, the Portfolio Id heading is now Portfolio ID and in the Budget Policy column, the noCap value is now No Cap and the dateRange value is now Date Range.\n"," You will see these new heading and values in any new sheets that you request. Note that previous and new column header values will continue to function as before in bulk upload, and there is no need to update old sheets to the new headings and values.\n"," We are currently updating the documentation and we will continue to document the previous headers and values and add the new headers and values alongside to make these updates clear.\n"," May 4, 2023\n"," When you create Sponsored Products campaigns with automatic targeting, you can now create the four product targeting entities and apply a custom bid to each targeting expression (close-match, loose-match, complements, and substitutes). You can also set the targeting entities to be paused if you do not want to apply a bid to a specific target. If you want Amazon to automatically create these targeting expression entities, you can choose not to create them, and one targeting entity will be created for each expression type with the ad group default bid applied. Learn more about creating Sponsored Products auto-targeting campaigns.\n"," April 28, 2023\n"," Search term report data is now available for Sponsored Products in bulksheets. This report will be in a new tab and will include much of the same information you would find in the advertising console report, including the customer search terms that were used to discover your ads—-but in bulksheets, you will also have the entity IDs available, so you can quickly make adjustments if needed.\n"," You can include a search term report in bulksheets if you go to the bulk operations main page, create a custom spreadsheet, and check the box labeled Sponsored Products search term report in Step 1.\n"," Learn more about search term reports in bulksheets\n"," January 26, 2023\n"," Input guidance is now available for Sponsored Products campaigns in bulksheets. This new feature includes dropdown options for some fields, including Product, Entity, Operation, and more. After you select values for those first three fields, cells in that row will automatically highlight the fields that can be filled in—both required and optional ones. You will also see guidance if you click on cell headers. For example, if you click into a “Daily Budget” cell header, you will see tips on budget limits, along with guidance on entering values such as decimal places.\n"," You can access this new feature if you go to the bulk operations main page and check the box labeled Guidance for Sponsored Products inputs BETA. Then, download a bulksheets template and navigate to the Sponsored Products tab to see the details described above. Learn more about the new input guidance feature for bulksheets\n"," November 1, 2022\n"," When you create Sponsored Brands campaigns in the advertising console, you can create multiple ad groups within the campaign. Now, you can view targets for all of these ad groups if you download a bulksheets custom spreadsheet and include Sponsored Brands in the file. This feature lets you view keyword and product targeting for all ad groups in the downloaded file. Note that you cannot create multiple Sponsored Brands ad groups using bulksheets — you must still use the console to create.\n"," October 1, 2022\n"," You can now use expanded product targeting for Sponsored Products manual targeting campaigns in bulksheets. With this feature, you can expand targeting to items that are closely related to the product you want to target. This can help you discover additional products related to the ones you are already targeting. \n"," To use expanded product targeting in bulksheets, define the target in the row where you are creating the \"product targeting\" entity in your bulksheet file. Set the product targeting expression value to be asin-expanded=\"12345\", using the value of the ASIN you want to target.\n"," August 1, 2022\n"," We have evolved Sponsored Display product targeting into contextual targeting, allowing advertisers to reach more of their audiences at more points in their shopping and entertainment journey. The contextual targeting strategy will now allow advertisers to reach audiences both in the Amazon store and outside the Amazon store when customers view content related to targeting strategies. If you use bulksheets to create and manage Sponsored Display campaigns, the \"product targeting\" entity will now be \"contextual targeting\". \n"," Learn more about new Sponsored Display contextual targeting, including more details about the launch and why it is important to advertisers.\n"," June 1, 2022\n"," When you download a Sponsored Products bulksheets file, you can now see ASIN eligibility statuses, along with reasons for ineligibility. This information will be available in two new informational-only columns: Eligibility Status and Reason for Ineligibility. Sellers and vendors can find these new columns next to the SKU field in the bulksheets file.\n"," Without this information, it can be difficult to understand why your ad might be getting fewer clicks than expected. For example, a product might become ineligible after you create the ad, or a product might have gone out of stock, resulting in missed sales and wasted time on ASIN troubleshooting. Having ASIN eligibility statuses in bulksheets can help you make more informed decisions when optimizing campaigns, and provides even greater parity with the API when using bulksheets.\n"," May 1, 2022\n"," In Sponsored Brands bulksheets downloads, you can now see the ad format when filters are applied. Previously, when you filtered by keywords, the ad format was not visible. With this change, you can filter by keywords and see if a keyword is for a video campaign or a non-video campaign. When you apply filters, the ad format will now be visible in a new Ad format (informational only) field.\n"," May 1, 2022\n"," You can now see portfolio names in bulksheets downloads. Previously, only the portfolio ID was shown. This update will make it easier to see if a campaign is associated with a particular portfolio.\n"," May 1, 2022\n"," Some of the name-based informational-only fields have been rearranged in bulksheets. Now when you download a bulksheets file, you can see fields such as campaign name and ad group name without needing to scroll as far. Previously, these fields were placed near the end of a bulksheets file, and this made it difficult to associate the names with their related fields such as keyword, budget, and start date.\n"," April 1, 2022\n"," Sellers can now see the ASIN code associated with your SKU input in bulksheets for Sponsored Products and Sponsored Display. The ASIN code will appear in the ASIN (informational only) column when you request a bulksheets download. Previously, the ASIN column was empty for sellers, and there was not a way to know which ASIN values corresponded to SKU values in bulksheets.\n"," April 1, 2022\n"," You can now create multiple ad groups in a single Sponsored Display campaign using bulksheets. For campaigns that are already running, you can also add more ad groups to existing campaigns. Previously, Sponsored Display only supported one ad group per campaign. Learn more about managing Sponsored Display campaigns using bulksheets.\n"," March 1, 2022\n"," We are launching some cosmetic updates for the bulk operations homepage. This is the page where you can create and download a bulksheets file to manage campaigns in bulk. The changes include updates such as button styles. The functionality will not be affected by these updates.\n"," March 1, 2022\n"," Previously, click-through rates had to be calculated manually in bulksheets. Now, you can see click-through rates when you download a bulksheets file. This new column can be found between the \"Spend\" and \"Clicks\" columns in the Sponsored Products, Sponsored Brands, and Sponsored Display tabs.\n"," February 1, 2022\n"," When managing Sponsored Display campaigns using bulksheets, you can now target based on similar products. Using the Targeting Expression field, enter similar-product if you want your ads to be shown to shoppers who viewed the detail pages of products that are similar to your advertised products.\n"," Learn more about managing Sponsored Display campaigns using bulksheets\n"," January 21, 2022\n"," Effective January 21, 2022, you now can filter to include or exclude Sponsored Products, Sponsored Brands, and Sponsored Display during the bulk download process. For advertisers or agencies managing large numbers of campaigns, this new filter can help expedite the download process by limiting the file to certain campaign types.\n"," January 1, 2022\n"," Portfolios are available in bulksheets for Sponsored Products, Sponsored Brands, and Sponsored Display. You can now create and update portfolios, including portfolio budgets. Portfolios in bulksheets can not only help you organize campaigns and budgets, but are also a way to update bid optimizations in bulk.\n"," December 1, 2021\n"," The new bulksheets gives you access to more features that are already available to advertisers who use the API, so you can have the benefits of the API, with the functionality of a spreadsheet interface. With the newest version, you can \n","update campaign and ad group names  add multiple ad groups, keywords, and targets in bulk  see campaign metrics such as impressions, clicks, ACoS, CPC, ROAS, and more \\* manage Sponsored Display campaigns. \n"," Learn more about the new bulksheets\n"," November 17, 2020\n"," Updated keyword restrictions for advertisers. Amazon Ads does not allow the targeting of prescription medicine products or the use of prescription medicine names as targeting keywords or phrases. \n"," For example, prescription medicine keyword or products, such as \"Lipitor\" or \"prednisone\".\n"," As a reminder, keywords or products targeted through Amazon Ads must be relevant to the product being promoted. Ads must not target keywords or products which could result in offensive, insensitive, or undesirable shopper experience.\n"," August 24, 2020\n"," Added link to the Bulksheets portal on the Bulk Operations page. \n"," Simplified the Bulksheets template by removing the \"Instructions\", \"Attribute definitions\" and \"SD Attribute definitions\" tabs from the template. Users can now find detailed instructions and\n"," July 31, 2020\n"," Added Bulksheets documentation with detailed user instructions and examples for all supported Sponsored Ads products to this portal\n"],"documentType":"release-note"},{"title":"Deprecations","sectionHeader":null,"path":"/en-us/release-notes/deprecations","content":[],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"September 2026 - Deprecation of Amazon Marketing Stream Version 1, v3 reporting, and Sponsored Ads v2 reporting"},"path":"/en-us/release-notes/deprecations","content":[" Amazon Marketing Stream Version 1, v3 reporting, and Sponsored Ads v2 reporting are being deprecated. Migrate to Stream v2 and the reporting API v1 for complete datasets, standardized metrics, and simplified infrastructure.\n"," What is being deprecated? Amazon Marketing Stream Version 1 and all associated subscriptions, including reporting data, messaging data, and recommendation data delivered to Amazon Data Firehose and Amazon SQS queue destinations. All v3 reporting endpoints and associated report types are also deprecated, including Sponsored Products, Sponsored Brands, Sponsored Display, and Amazon DSP report types available through POST /reporting/reports. Sponsored Ads v2 reporting endpoints and their associated report types are also deprecated. These deprecations apply to all regions (EU, NA, FE) and all marketplaces globally. The Exports API for campaign metadata is not affected.\n"," What should I use instead? Amazon Marketing Stream v2 replaces Stream Version 1 for all reporting data use cases. Stream v2 delivers the base metrics and dimensions the Reporting API exposes as Parquet files to Amazon S3, with total metric values (not deltas) and updates as frequently as every 15 minutes. See the Version 2 overview and the getting started guide.\n"," The reporting API v1 replaces both v3 reporting and Sponsored Ads v2 reporting for all ad-hoc and periodic reporting use cases. It introduces multi-dimensional reporting, cross-ad-product reporting, and cross-account reporting with standardized metrics organized into Traffic, Engagement, and Conversion categories. Metrics are standardized across all ad products, with conversion metrics now reported on traffic date rather than conversion date. See the reporting API v1 documentation.\n"," For messaging data (entity state changes and budget consumption notifications), use the Campaign Management API. For recommendation data, use the Recommendations API. These features are not carried forward in Stream v2.\n"," Hard shutoff date: Stream Version 1, v3 reporting, and Sponsored Ads v2 reporting will stop delivering data on June 30, 2027.\n"," What happens until shutoff? Existing Stream Version 1 subscriptions will continue to deliver data, and existing v3 reporting and Sponsored Ads v2 reporting integrations will continue to function through June 30, 2027. All surfaces will function as they do today until the shutoff date. We recommend migrating to the replacement surfaces before the shutoff date to avoid disruption.\n"," Migration guidance: For Stream Version 1, see the Migrate from Version 1 to Version 2 guide for step-by-step instructions covering dataset mapping and behavioral changes (delta-to-total values, Firehose/SQS-to-S3 destination, JSON-to-Parquet format). For v3 reporting and Sponsored Ads v2 reporting, see the reporting API v1 Quickstart guide, the Dimensions library, and the Metrics library for the mapping of report types to reporting API v1 dimensions and metrics. Amazon DSP integrations should be reviewed carefully, as some metrics now use broader standardized definitions and may return higher totals than v3 reporting.\n"," Scope: All regions (EU, NA, FE). All marketplaces globally. These deprecations apply to all advertiser types.\n"," Questions? Submit a support ticket with the subject line \"Stream V1, v3 Reporting, and Sponsored Ads v2 Reporting Deprecation\".\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"September 2026 - Deprecation of product specific Commitment Management APIs"},"path":"/en-us/release-notes/deprecations","content":[" As part of our continued enhancements to the Amazon Ads API, we are deprecating product specific (those ending with /dsp) Commitments Management endpoints in favor of unified endpoints. We recommend migrating early to ensure uninterrupted access and to take advantage of the latest API capabilities. \n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Key dates and migration details  "},"path":"/en-us/release-notes/deprecations","content":[" Commitments Management APIs\n","Deprecation Date: Sep 2026  - Shutoff Date: Aug 2027  - Impacted endpoints:\n","Replacements:  \n","Important Transition Notes:  \n"," Support and resources \n"," Refer mapping table for old and new endpoints. For migration steps, view the section API migration under Commitments Management.  If you have questions, submit a ticket via the Amazon Ads API Support page using the appropriate subject line. \n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"September 2026 - Deprecation of product specific Inventory Management APIs"},"path":"/en-us/release-notes/deprecations","content":[" As part of our continued enhancements to the Amazon Ads API, we are deprecating product specific (those ending with /dsp) inventory management endpoints related to BuyerSeats, Inventory Groups, Labels, DealAdvertiserAccessEntries and DealAdvertiserAccesses in favor of unified endpoints. \n"," We recommend migrating early to ensure uninterrupted access and to take advantage of the latest API capabilities. \n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Key dates and migration details"},"path":"/en-us/release-notes/deprecations","content":[" Inventory Management APIs\n","Deprecation Date: Sep 2026  - Shutoff Date: Dec 2026  - Impacted endpoints:\n","Replacements:   - Important Transition Notes:\n"," Support and resources \n"," Refer mapping table for old and new endpoints. For migration steps, view the section API migration under Inventory Management.  If you have questions, submit a ticket via the Amazon Ads API Support page using the appropriate subject line. \n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"July 2026 - Deprecation of legacy account management APIs"},"path":"/en-us/release-notes/deprecations","content":[" Following the general availability of the advertiser accounts APIs (registration and query), we are announcing the deprecation of six legacy account management endpoints across the Amazon Ads API. The key dates and migration resources are listed below.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Key dates and migration details"},"path":"/en-us/release-notes/deprecations","content":[" Legacy account management APIs\n","Deprecation Date: July 2026 - Shutoff Date: July 2027 - Impacted endpoints: - Replacements: - Important Transition Notes:\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Support and resources"},"path":"/en-us/release-notes/deprecations","content":[" For a complete list of legacy and replacement endpoints, view the section below under Amazon Ads API deprecations.\n"," If you have questions, submit a ticket via the Amazon Ads API Support page using the appropriate subject line.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"July 2026 - Deprecation of AMC Advertiser Audience APIs"},"path":"/en-us/release-notes/deprecations","content":[" Following the launch of the Ads data manager v1 APIs, we are announcing the deprecation of the legacy AMC Advertiser Audience endpoints in the Ads API V0. The key dates and migration resources are listed below.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Key dates and migration details"},"path":"/en-us/release-notes/deprecations","content":[" AMC Advertiser Audience V0 APIs\n","Deprecation Date: July 2026 - Migration Guide: Get started with Ads data manager - Important Transition Notes:\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"June 2026 - Deprecation of Sponsored Brands Product Collection Ad Type"},"path":"/en-us/release-notes/deprecations","content":[" Following the launch of Sponsored Brands Collections, we are announcing the deprecation of the legacy Product Collection ad creation endpoints across both the Ads API V0 and V1. The key dates and migration resources are listed below.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Key dates and migration details"},"path":"/en-us/release-notes/deprecations","content":[" Product Collection V0 APIs\n","Shutoff Date: January 2027 - Migration Guide: Product Collection Migration Guide - Important Transition Notes:\n"," Product Collection V1 APIs\n","Shutoff Date: January 2027 - Migration Guide: Product Collection Migration Guide - Important Transition Notes:\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Support and resources"},"path":"/en-us/release-notes/deprecations","content":[" For a complete list of legacy and replacement endpoints, view the section below under Amazon Ads API deprecation.\n"," If you have questions, submit a ticket via the Amazon Ads API Support page using the appropriate subject line.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"March 2026 - Catch-Up Boost deprecated in ADSP API"},"path":"/en-us/release-notes/deprecations","content":[" We have deprecated the Catch-Up Boost pacing feature in Amazon DSP in both UI and API. This legacy manual control, which allowed advertisers to increase delivery aggressiveness under \"Even\" pacing, was replaced by Dynamic Catchup in 2024. Dynamic Catchup automatically optimizes delivery based on real-time performance and no longer requires user input. API inputs on the Catch-Up Boost field can continue to be set, but the system ignores them in ad delivery. The UI removed this field on March 23, 2026.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Dynamic Catchup - Key benefits"},"path":"/en-us/release-notes/deprecations","content":["Runs automatically — no manual setup required  Adjusts daily based on under-delivery patterns  Improves smooth delivery and consistency across flights \\* Maximizes budget utilization without delivery volatility\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Impacted API endpoints"},"path":"/en-us/release-notes/deprecations","content":[" The Catch-Up Boost field is marked as deprecated in the following APIs:\n","Ad Groups:\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"January 2026 - Deprecation of legacy v2 APIs"},"path":"/en-us/release-notes/deprecations","content":[" The following suggestion APIs are deprecated and will be shut off in June 2026:\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"V2 Suggested Keyword Deprecations"},"path":"/en-us/release-notes/deprecations","content":["/v2/asins/{asin}/suggested/keywords,   /v2/adGroups/{adGroupId}/suggested/keywords/extended,   /v2/adGroups/{adGroupId}/suggested/keywords, \\* /v2/asins/suggested/keywords\n"," Please use the /sp/targets/keywords/recommendations API instead.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"V2 Stores deprecation"},"path":"/en-us/release-notes/deprecations","content":["/v2/stores is being deprecated and replaced with /brand/stores/v1/storePages/list.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"Deprecation of Amazon DSP legacy APIs (Campaign, Creative, and Reporting)"},"path":"/en-us/release-notes/deprecations","content":[" As part of ongoing improvements to the Amazon DSP APIs, we are announcing the deprecation of several legacy endpoints across Campaign Management, Reporting, and Creatives Management. The key dates and migration resources are listed below.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Key dates and migration details"},"path":"/en-us/release-notes/deprecations","content":["Campaign Management APIs  ADSP Reporting APIs  Creative Management APIs\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Support and resources"},"path":"/en-us/release-notes/deprecations","content":[" For a complete list of legacy and replacement endpoints, view the section below under Amazon Ads API deprecation.\n"," If you have questions, submit a ticket via the Amazon Ads API Support page using the appropriate subject line.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"Deprecation of Campaign Diagnostics APIs"},"path":"/en-us/release-notes/deprecations","content":[" The Campaign Diagnostics API (POST /diagnostics/campaigns/issues) will be deprecated on December 1, 2025. New users will no longer be able to make requests as of June 20; all access will be shut off on December 1.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"Deprecation Announcement: Sponsored Brands legacy version of moderation results API will shut off on Dec 15, 2025"},"path":"/en-us/release-notes/deprecations","content":[" Following the release of version 4 of Sponsored Brands campaign management and its associated updated moderation results endpoint, we are announcing the deprecation of the legacy moderation results endpoint with a shutoff date of December 15, 2025. See the Amazon Ads API deprecation schedule for these and other upcoming deprecations.\n"," Going forward, customers can access Sponsored Brands moderation results via the new moderation results endpoint.\n"," For questions, use the Amazon Ads API Support page to submit a ticket with the subject title \"Moderation Advertising API Deprecation\".\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"Deprecation of Amazon Ad Server tables in AMC"},"path":"/en-us/release-notes/deprecations","content":[" Following the sunset of Amazon Ad Server in December 2024, the corresponding Amazon Ad Server tables in AMC will be deprecated. While AMC has continued to make the Amazon Ad Server events available to allow customers time to extract any final insights, this support will discontinue on June 30, 2025. Complete any final analyses using these tables before the deprecation date, and then disable any recurring workflows that use these tables.\n"," The following Amazon Ad Server tables are being deprecated: \n","adserver_conversions -  adserver_conversions_with_brands -  adserver_traffic -  adserver_traffic_by_user_segments\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"AMC instance-level deprecation"},"path":"/en-us/release-notes/deprecations","content":[" As we recently announced AMC APIs being available on Amazon Ads, we recommend that users currently on the instance-level APIs migrate to the upgraded APIs as soon as possible to take advantage of the enhanced security, usability, and performance of the new APIs.\n"," After the instance-level APIs retire, calling any of the endpoints will return a 404 error. Migrating to the new APIs at the earliest opportunity can help prevent disruptions to your existing business operations. Visit the AMC migration hub to learn more.\n"," In addition, new AMC instances created after March 04, 2024 will not be compatible with the instance-level APIs. You need to build to Amazon Ads APIs before this date to make sure your API workflows can be applied to your new instances.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"Bulksheets deprecation"},"path":"/en-us/release-notes/deprecations","content":[" As we recently announced, the legacy version of bulksheets has been deprecated effective September 28, 2023. Review the migration guide to learn more about migrating to the latest version.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"Amazon Ads API deprecations"},"path":"/en-us/release-notes/deprecations","content":[" The following section contains details of upcoming deprecations related to the Amazon Ads API. Use this table to understand what deprecations are coming up, and the new endpoints you should use instead.\n","| Resource | Affected URL suffixes | Replacement | Deprecation announcement date | Shutoff date | Migration guide | \n","\\|------\\|------\\|--------\\|----------\\|------\\|-------\\|---------\\|\n","| Sponsored Brands Product Collection V0 API | POST /sb/v4/ads/productCollection  POST /sb/v4/ads/productCollectionExtended  POST /sb/ads/creatives/productCollectionExtended (ProductCollection creative) | POST /sb/v4/ads/manualCollection  POST /sb/v4/ads/autoCollection | June 2026 (Release Note) | January 2027 | Link |\n","| Sponsored Brands Product Collection V1 API | productCollectionSettings in /adsApi/v1/ads | manualCollectionSettings / autoCollectionSettings in /adsApi/v1/ads | June 2026 (Release Note) | January 2027 | Link |\n","| V2 Stores | /v2/stores | /brand/stores/v1/storePages/list | January 2026 | June 1, 2026 | |\n","| Sponsored Products v2 suggested keywords | /v2/asins/{asin}/suggested/keywords  /v2/adGroups/{adGroupId}/suggested/keywords/extended  /v2/adGroups/{adGroupId}/suggested/keywords  /v2/asins/suggested/keywords | /sp/targets/keywords/recommendations | January 2026 | June 1, 2026 (Release Note) | |\n","| Brand Posts | /bp/v2/posts | None | June 3, 2025 | June 16, 2025 / July 31, 2025 | None |\n","| Sponsored Products v2 bid recommendations | /v2/sp/adGroups/{adGroupId}/bidRecommendations  /v2/sp/keywords/{keywordId}/bidRecommendations  /v2/sp/keywords/bidRecommendations | /sp/targets/bid/recommendations | June 2022 (Release note) | March 27, 2024 |  |\n","| Profiles | /v1/profiles  /v1/profiles/{profileId} | /v2/profiles | August 2023 (Release note)  | May 28, 2024 | |\n","|Sponsored Products| /sp/targets/bid/recommendations (application/vnd.spthemebasedbidrecommendation.v3+json content type) | /sp/targets/bid/recommendations (use application/vnd.spthemebasedbidrecommendation.v4+json content type) | August 2024 (Release note) | May 15,2025 | |\n","|Sponsored Products| /v2/sp/targets/bidRecommendations | /sp/targets/bid/recommendations| August 2024 (Release note) | May 15, 2025| |\n","|Amazon DSP \t| GET dsp/orders/{orderId}/conversionTracking/pixels  POST /dsp/orders/{orderId}/conversionTracking/pixels  GET /dsp/pixels\t| GET /accounts/{accountId}/dsp/adTagEvents/{adTagId}/list  POST /accounts/{accountId}/dsp/orders/{orderId}/conversionDefinitionAssociations  GET /accounts/{accountId}/dsp/orders/{orderId}/conversionDefinitionAssociations | February 2024 (Release note)\t| August 1, 2024 | |\n","|Amazon DSP | GET /dsp/lineItems/ | POST /dsp/v1/adGroups/list POST /dsp/v1/targets/list POST /adsApi/v1/query/adGroupsPOST /adsApi/v1/query/targets | January 2025 (Release note)  | September 30, 2025 | Link | \n","|Amazon DSP | POST /dsp/lineItems/ | POST /dsp/v1/adGroups  POST /dsp/v1/targets  POST /dsp/v1/targets/deleteByObject  POST /adsApi/v1/create/adGroupsPOST /adsApi/v1/create/targets | January 2025 (Release note)  | September 30, 2025 | Link | \n","| Amazon DSP | PUT /dsp/lineItems/ | PATCH /dsp/v1/adGroups POST /adsApi/v1/create/adGroups | January 2025 (Release note)  | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/lineItems/{lineItemId} | POST /dsp/v1/adGroups/list POST /adsApi/v1/query/adGroups | January 2025 (Release note)  | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/targeting/domain | POST /dsp/v1/targets/list POST /adsApi/v1/query/targets | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | PUT /dsp/targeting/domain | POST /dsp/v1/targets  POST /dsp/v1/targets/deleteByObject POST /adsApi/v1/update/targets | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | POST /dsp/lineItems/{lineItemId}/deliveryActivationStatus | PATCH /dsp/v1/adGroups POST /adsApi/v1/update/adGroups | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/orders/ | POST /dsp/v1/campaigns/list POST /adsApi/v1/query/campaigns | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | POST /dsp/orders/ | POST /dsp/v1/campaigns POST /adsApi/v1/create/campaigns | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | PUT /dsp/orders/ | PATCH /dsp/v1/campaigns  POST /dsp/v1/campaigns/{campaignId}/flights  PATCH /dsp/v1/campaigns/{campaignId}/flights POST /adsApi/v1/update/campaigns | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/orders/{orderId} | POST /dsp/v1/campaigns/list POST /adsApi/v1/query/campaigns | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/orders/{orderId}/conversionTracking | N/A | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | PUT /dsp/orders/{orderId}/conversionTracking | N/A | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/orders/{orderId}/conversionTracking/pixels | N/A | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | PUT /dsp/orders/{orderId}/conversionTracking/pixels | N/A | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/orders/{orderId}/conversionTracking/products | GET /dsp/v1/campaigns/{campaignId}/conversionTracking/products | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | PUT /dsp/orders/{orderId}/conversionTracking/products | POST /dsp/v1/campaigns/{campaignId}/conversionTracking/products | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/orders/{orderId}/conversionTracking/products/export | N/A | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | POST /dsp/orders/{orderId}/deliveryActivationStatus | PATCH /dsp/v1/campaigns POST /adsApi/v1/update/campaigns | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/productCategories | POST /dsp/v1/advertisedProductCategories/list | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/supplySources | POST /dsp/v1/inventorySourceExchanges/list  POST /dsp/v1/inventorySourceDeals/list | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET /dsp/iabContentCategories | POST /dsp/v1/iabContentCategories/list | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET/dsp/preBidTargeting/doubleVerify/customContextualSegments  GET /dsp/preBidTargeting/oracleDataCloud/customPredicts  GET /dsp/preBidTargeting/oracleDataCloud/standardPredicts | POST /dsp/v1/thirdPartyTargetSegments/list | January 2025 (Release note) | September 30, 2025 | Link | \n","| Amazon DSP | GET/dsp/apps | POST/dsp/v1/apps/list | January 2025 (Release note) | September 30, 2025| Link |\n","| Amazon DSP | GET /dsp/domainLists |  POST /dsp/v1/domainLists/list | January 2025 (Release note) | September 30, 2025 |Link|\n","| Amazon DSP | GET /dsp/pixels | N/A | January 2025 (Release note) | September 30, 2025 |Link|\n","| Amazon DSP | GET /dsp/goalConfigurations | N/A | January 2025 (Release note) | September 30, 2025 |Link| \n","| Sponsored Display snapshots | /sd/{recordType}/snapshot  /sd/snapshots/{snapshotId}  /sd/snapshots/{snapshotId}/download | /campaigns/export  /adGroups/export  /targets/export  /ads/export | March 2024 (Release note) | December 15, 2024 | Link|\n","| Sponsored Display version 2 reporting | /sd/reports | /reporting/reports | May 2024 | October 31, 2024 | Link |\n","| Sponsored Brands product collection|/sb/v4/ads/productCollection  /sb/ads/creatives/productCollection| /sb/v4/ads/productCollectionExtended  /sb/ads/creatives/productCollectionExtended|  February 2024 (Release note)| November 30, 2024 | |\n","| Portfolios| GET, PUT, POST, GET /v2/portfolios | /portfolios| September 2024 (Release note) | March 1, 2025 | |\n","| Amazon DSP | GET /dsp/creatives  GET /dsp/creatives/image  GET /dsp/creatives/video  GET /dsp/creatives/rec  GET /dsp/creatives/thirdparty | POST /dsp/v1/adCreatives/list | December 2024 (Release note) | May 31, 2025 | https&#x3A;//advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives |\n","| Amazon DSP | POST /dsp/creatives/image  POST /dsp/creatives/video  POST /dsp/creatives/rec  POST /dsp/creatives/thirdparty | POST /dsp/v1/adCreatives | December 2024 (Release note) | May 31, 2025 | https&#x3A;//advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives |\n","| Amazon DSP | PUT /dsp/creatives/image  PUT /dsp/creatives/video  PUT /dsp/creatives/rec  PUT /dsp/creatives/thirdparty | PATCH /dsp/v1/adCreatives/{adCreativeId} | December 2024 (Release note) | May 31, 2025 | https&#x3A;//advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives |\n","| Amazon DSP | POST /dsp/creatives/image/preview  POST /dsp/creatives/video/preview  POST /dsp/creatives/rec/preview  POST /dsp/creatives/thirdparty/preview | POST /dsp/v1/adCreatives/preview | December 2024 (Release note) | May 31, 2025 | https&#x3A;//advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives |\n","| Amazon DSP | POST /dsp/lineItemCreativeAssociations | POST /dsp/v1/adCreatives/associations/adGroups  POST /dsp/v1/adCreatives/associations/adGroups/delete | December 2024 (Release note) | May 31, 2025 | https&#x3A;//advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives |\n","| Amazon DSP | PUT /dsp/lineItemCreativeAssociations | PATCH /dsp/v1/adCreatives/associations/adGroups | December 2024 (Release note) | May 31, 2025 | https&#x3A;//advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives |\n","| Amazon DSP | GET /dsp/lineItemCreativeAssociations | POST /dsp/v1/adCreatives/associations/adGroups/list | December 2024 (Release note) | May 31, 2025 | https&#x3A;//advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives |\n","| Amazon DSP | GET /dsp/moderation/creatives | POST /dsp/v1/adCreatives/moderations/list | December 2024 (Release note) | May 31, 2025 | https&#x3A;//advertising.amazon.com/API/docs/en-us/reference/migration-guides/dsp-creatives |\n","|Amazon DSP\t|POST /dsp/reports\t|POST /reporting/reports\t|December 2024\t|June 30, 2025\t|Link\t|\n","|Amazon DSP\t|GET /dsp/reports/{reportId}\t|GET /reporting/reports/{reportId}\t|December 2024\t|June 30, 2025\t|Link\t|\n","|Amazon DSP\t|POST /accounts/{accountId}/dsp/reports\t|POST /reporting/reports\t|December 2024\t|June 30, 2025\t|Link\t|\n","|Amazon DSP\t|GET /accounts/{accountId}/dsp/reports/{reportId}\t|GET /reporting/reports/{reportId}\t|December 2024\t|June 30, 2025\t|Link\t|\n","|POST/dsp/v1/adGroups inventoryType enum value\t|STANDARD_DISPLAY\t|DISPLAY\t|January 2025\t|June 30, 2025\t|\t|\n","|POST/dsp/v1/adGroups inventoryType enum value\t|AMAZON_MOBILE_DISPLAY\t|DISPLAY\t|January 2025\t|June 30, 2025\t|\t|\n","|POST/dsp/v1/adGroups inventoryType enum value\t|AAP_MOBILE_APP\t|DISPLAY\t|January 2025\t|June 30, 2025\t|\t|\n","|POST/dsp/v1/adGroups inventoryType enum value\t|VIDEO\t|ONLINE_VIDEO or STREAMING_TV\t|January 2025\t|June 30, 2025\t|\t|\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"Past shutoffs "},"path":"/en-us/release-notes/deprecations","content":["| Resource | URL suffixes | Replacement | Deprecation date | Shutoff date | \n","\\|----------------\\|----------------------\\|--------------------\\|----------\\|------\\|\n","| Sponsored Brands v2 campaigns, ad groups, & drafts | /sb/campaigns  /sb/campaigns/{campaignId}  /sb/adGroups  /sb/adGroups/{adGroupId}  /sb/drafts/campaigns  /sb/drafts/campaigns/{draftCampaignId}  /sb/drafts/campaigns/submit  | /sb/v4/campaigns  /sb/v4/adGroups  /sb/v4/ads/  | July 2023 (Release note) | January 31, 2024 |\n","| Sponsored Brands media | /media/upload  /media/complete | /assets/ | July 2023 (Release note) | January 31, 2024 |\n","| Beta: Sponsored Brands v4 campaigns, ad groups, and ads | /sb/beta/campaigns  /sb/beta/campaigns/list /sb/beta/adGroups /sb/beta/adGroups/list  /sb/beta/adGroups/delete  /sb/beta/ads  /sb/beta/ads/brandVideo /sb/beta/ads/video  /sb/beta/ads/productCollection  /sb/beta/ads/storeSpotlight  /sb/beta/ads/delete  /sb/beta/ads/list | /sb/v4/campaigns  /sb/v4/campaigns/list  /sb/v4/adGroups  /sb/v4/adGroups/list  /sb/v4/adGroups/delete  /sb/v4/ads  /sb/v4/ads/brandVideo  /sb/v4/ads/video  /sb/v4/ads/productCollection  /sb/v4/ads/storeSpotlight  /sb/v4/ads/delete  /sb/v4/ads/list | February 2023 (Release note) | August 31, 2023 | \n","| Budget rules history | /sp/campaigns/{campaignId}/budgetRules/budgetHistory  /sb/campaigns/{campaignId}/budgetRules/budgetHistory    /sd/campaigns/{campaignId}/budgetRules/budgetHistory | None | February 2023 (Release note) | 8/31/2023 | \n","| Sponsored Products v1 campaign management | /campaigns/  /campaigns/extended/  /adGroups/  /adGroups/extended/  /keywords/  /keywords/extended/  /negativeKeywords/  /negativeKeywords/extended/  /campaignNegativeKeywords/  /campaignNegativeKeywords/extended/  /productAds/  /productAds/extended/ | sp/campaigns  sp/adGroups  sp/keywords  sp/negativeKeywords  sp/campaignNegativeKeywords  sp/productAds | November 2022 (Release note) | 6/30/2023 | \n","| Sponsored Products v2 campaign management | /v2/sp/campaigns/  /v2/sp/campaigns/extended/  /v2/sp/adGroups/  /v2/sp/adGroups/extended/  /v2/sp/keywords/  /v2/sp/keywords/extended/  /v2/sp/negativeKeywords/  /v2/sp/negativeKeywords/extended/  /v2/sp/campaignNegativeKeywords/  /v2/sp/campaignNegativeKeywords/extended/  /v2/sp/productAds/  /v2/sp/productAds/extended/  /v2/sp/targets/  /v2/sp/targets/extended/  /v2/sp/negativeTargets/  /v2/sp/negativeTargets/extended/  /v2/sp/campaignNegativeTargets/  /v2/sp/campaignNegativeTargets/extended/| sp/campaigns  sp/adGroups  sp/keywords  sp/negativeKeywords  sp/campaignNegativeKeywords  sp/productAds  sp/targets  sp/negativeTargets sp/campaignNegativeTargets | November 2022 (Release note) | 6/30/2023 |\n","| Sponsored Products v2 reporting | /v2/sp/{recordType}/report | /reporting/reports | August 2022 (Release note) | 3/30/2023 | \n","| Sponsored Products v2 product targeting recommendations | /v2/sp/targets/productRecommendations | /sp/targets/products/recommendations | April 2021 (Release note) | 2/28/2023 |  \n","| Sponsored Brands v2 / HSA APIs | /v2/hsa/campaigns  /v2/hsa/keywords  /v2/hsa/negativeKeywords | /sb/campaigns  /sb/keywords  /sb/negativeKeywords | June 2022 (Release note) | 12/31/2022 |  \n","| Sponsored Products v1 bid recommendations | /adGroups/{adGroupId}/bidRecommendations  /keywords/{keywordId}/bidRecommendations  /keywords/bidRecommendations | /sp/targets/bid/recommendations |  September 2022 (Release note) | 12/31/2022 | \n","| Sponsored Products v2 brand and category targeting recommendations | /v2/sp/targets/brands  /v2/sp/targets/categories   /v2/sp/targets/categories/refinements | /sp/negativeTargets/brands/search  /sp/targets/categories  /sp/targets/categories/recommendations | April 2021 (Release note) | 10/31/22 |\n","| Sandbox environment | https&#x3A;//advertising-api-test.amazon.com | See test accounts. | May 2022 (Release note) | 06/28/22 |\n"," For access to reference materials for deprecated endpoints, contact the API support team at ads-api-support@amazon.com.\n"],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":2,"text":"Reference"},"path":"/en-us/release-notes/deprecations","content":[],"documentType":"guide"},{"title":"Deprecations","sectionHeader":{"type":3,"text":"Deactivation of non-age-gender demographic segments in Amazon DSP"},"path":"/en-us/release-notes/deprecations","content":[" The following non-age-gender demographic segments will be deactivated for Germany, France, Spain and Italy on December 31, 2023.\n","|Locale\t|Category\t|Sub-Category\t|Name\t|Segment-ID\t|Description\t|\n","|---\t|---\t|---\t|---\t|---\t|---\t|\n","|Germany\t|Demographic\t|Relationship\t|Demo - Alleinstehende\t|s=23051\t|Personen, die alleinstehend sind\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Anwohner seit 11 bis 15 Jahren\t|s=23074\t|Personen, die seit 11 - 15 Jahren Anwohner sind\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Anwohner seit 6 bis 10 Jahren\t|s=23073\t|Personen, die seit 6 - 10 Jahren Anwohner sind\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Anwohner seit mehr als 20 Jahren\t|s=23076\t|Personen, die seit mehr als 20 Jahren Anwohner sind\t|\n","|Germany\t|Demographic\t|Occupation\t|Demo - Arbeitnehmer und Angestellte\t|s=23057\t|Personen, die Arbeitnehmer oder Angestellte sind\t|\n","|Germany\t|Demographic\t|Occupation\t|Demo - Beamte\t|s=23055\t|Personen, die Beamte sind\t|\n","|Germany\t|Demographic\t|Income\t|Demo - Durchschnittlicher Wohlstand\t|s=23100\t|Personen, die in durchschnittlichem Wohlstand leben\t|\n","|Germany\t|Demographic\t|\t|Demo - Eigentümer\t|s=21790\t|Personen, die Eigentümer sind\t|\n","|Germany\t|Demographic\t|Home Ownership\t|Demo - Eigentümer\t|s=23053\t|Personen, die Eigentümer sind\t|\n","|Germany\t|Demographic\t|Home Ownership\t|Demo - Einfamilienhaus oder Doppelhaushälfte\t|s=23093\t|Personen, die in einem Einfamilienhaus oder in einer Doppelhaushälfte leben\t|\n","|Germany\t|Demographic\t|Income\t|Demo - Einkommen 15.600€-24.000€\t|s=16750\t|Personen, deren Einkommen zwischen 15.600€ und 24.000€ liegt\t|\n","|Germany\t|Demographic\t|Income\t|Demo - Einkommen 24.000€-43.200€\t|s=16745\t|Personen, deren Einkommen zwischen 24.000€ und 43.200€ liegt\t|\n","|Germany\t|Demographic\t|Income\t|Demo - Einkommen 43.200€-60.000€\t|s=16747\t|Personen, deren Einkommen zwischen 43.200€ und 60.000€ liegt\t|\n","|Germany\t|Demographic\t|Income\t|Demo - Einkommen 60.000€+\t|s=16749\t|Personen, deren Einkommen über 60.000€+ liegt\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Familienoberhaupt\t|s=23104\t|Personen, die der Familienoberhaupt sind\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Familienoberhaupt jünger als 25 Jahre\t|s=23077\t|Personen, deren Familienoberhaupt jünger als 25 Jahre alt ist\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Familienoberhaupt zwischen 25 und 34 Jahre\t|s=23078\t|Personen, deren Familienoberhaupt zwischen 25 und 34 Jahre alt ist\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Familienoberhaupt zwischen 45 und 64 Jahre\t|s=23079\t|Personen, deren Familienoberhaupt zwischen 45 und 64 Jahre alt ist\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Familienoberhaupt älter als 64\t|s=23080\t|Personen, deren Familienoberhaupt älter als 64 ist\t|\n","|Germany\t|Demographic\t|\t|Demo - Grüner Index: Hoch\t|s=23066\t|Personen, deren grüner Index hoch ist\t|\n","|Germany\t|Demographic\t|\t|Demo - Grüner Index: Medium\t|s=23065\t|Personen, deren grüner Index medium ist\t|\n","|Germany\t|Demographic\t|\t|Demo - Grüner Index: Niedrig\t|s=23064\t|Personen, deren grüner Index niedrig ist\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Haushalt mit 3 Personen\t|s=23067\t|Haushalt mit 3 Personen\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Haushalt mit 4 Erwachsenen\t|s=23085\t|Personen, die in einem Haushalt mit 4 Erwachsenen wohnen\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Haushalt mit 4 Personen\t|s=23068\t|Haushalt mit 4 Personen\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Haushalt mit 5 oder mehr Personen\t|s=23069\t|Haushalt mit 5 oder mehr Personen\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Haushalt mit Erdgas\t|s=23071\t|Personen, die in einem Haushalt mit Erdgas wohnen\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Haushalt mit Kindern\t|s=23062\t|Personen, die in einem Haushalt mit Kindern leben\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Haushalt mit mehr als 5 Erwachsenen\t|s=23086\t|Personen, die in einem Haushalt mit mehr als 5 Erwachsenen wohnen\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Haushalt ohne Kinder\t|s=23063\t|Personen, die in einem Haushalt ohne Kinder leben\t|\n","|Germany\t|Demographic\t|Home Ownership\t|Demo - Immobilie, welche nach 2000 gebaut wurde\t|s=23092\t|Personen, die in einer Immobilie leben welche nach 2000 gebaut wurde\t|\n","|Germany\t|Demographic\t|Home Ownership\t|Demo - Immobilie, welche vor 1900 gebaut wurde\t|s=23087\t|Personen, die in einer Immobilie wohnen welche vor 1900 gebaut wurde\t|\n","|Germany\t|Demographic\t|Home Ownership\t|Demo - Immobilie, welche zwischen 1900 und 1945 gebaut wurde\t|s=23088\t|Personen, die in einer Immobilie leben welche zwischen 1900 und 1945 gebaut wurde\t|\n","|Germany\t|Demographic\t|Home Ownership\t|Demo - Immobilie, welche zwischen 1946 und 1960 gebaut wurde\t|s=23089\t|Personen, die in einer Immobilie leben welche zwischen 1946 und 1960 gebaut wurde\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Immobilie, welche zwischen 1961 und 1980 gebaut wurde\t|s=23090\t|Personen, die in einer Immobilie leben welche zwischen 1961 und 1980 gebaut wurde\t|\n","|Germany\t|Demographic\t|Home Ownership\t|Demo - Immobilie, welche zwischen 1981 und 2000 gebaut wurde\t|s=23091\t|Personen, die in einer Immobilie leben welche zwischen 1981 und 2000 gebaut wurde\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Kein Familienoberhaupt\t|s=23103\t|Personen, die kein Familienoberhaupt sind\t|\n","|Germany\t|Demographic\t|Occupation\t|Demo - Kein Vollzeitverdiener\t|s=23081\t|Personen, die kein Vollzeitverdiener sind\t|\n","|Germany\t|Demographic\t|Home Ownership\t|Demo - Mieter\t|s=23054\t|Personen, die Mieter sind\t|\n","|Germany\t|Demographic\t|Relationship\t|Demo - Paare\t|s=23052\t|Personen, die in einer Beziehung sind\t|\n","|Germany\t|Demographic\t|Home Ownership\t|Demo - Residence Type - Other\t|s=23097\t|Residence Type - Other\t|\n","|Germany\t|Demographic\t|Occupation\t|Demo - Selbständige / Freiberufler\t|s=23056\t|Personen, die selbständig sind\t|\n","|Germany\t|Demographic\t|Occupation\t|Demo - Vollzeitverdiener\t|s=23082\t|Personen, die Vollzeitverdiener sind\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Wohnhaus mit 10 bis 20 Haushalten\t|s=23095\t|Personen, die in einem Wohnhaus mit 10 bis 20 Haushalten wohnen\t|\n","|Germany\t|Demographic\t|Household\t|Demo - Wohnhochhaus mit mehr als 20 Haushalten\t|s=23096\t|Personen, die in einem Wohnhochhaus mit mehr als 20 Haushalten wohnen\t|\n","|Germany\t|Demographic\t|Income\t|Demo - Überdurchschnittlicher Wohlstand\t|s=23101\t|Personen, die in überdurchschnittlichem Wohlstand leben\t|\n","|Italy\t|Demographic\t|Home Ownership\t|Demo - Affittuari\t|s=21857\t|Persone affittuarie\t|\n","|Italy\t|Demographic\t|Relationship\t|Demo - Coniugato\t|s=21848\t|Persone coniugate\t|\n","|Italy\t|Demographic\t|Education\t|Demo - Livello scolastico (laurea o piu’)\t|s=21849\t|Persone che hanno conseguito la laurea o più\t|\n","|Italy\t|Demographic\t|Education\t|Demo - Livello scolastico (scuola secondaria)\t|s=21850\t|Persone che possiedono un diploma di scuola secondaria\t|\n","|Italy\t|Demographic\t|Income\t|Demo - Reddito 15K-28K\t|s=16300\t|Persone che hanno un reddito tra 15K-28K\t|\n","|Italy\t|Demographic\t|Income\t|Demo - Reddito 28K-40K\t|s=16299\t|Persone che hanno un reddito tra 28K-40K\t|\n","|Italy\t|Demographic\t|Income\t|Demo - Reddito 40K-50K\t|s=16293\t|Persone che hanno un reddito tra 40K-50K\t|\n","|Italy\t|Demographic\t|Income\t|Demo - Reddito 50K+\t|s=16301\t|Persone che hanno un reddito superiore a 50K\t|\n","|Italy\t|Demographic\t|Relationship\t|Demo - Single\t|s=21847\t|Persone single\t|\n","|Italy\t|Demographic\t|Home Ownership\t|Demo – Proprietari di casa\t|s=21856\t|Persone proprietarie di casa\t|\n","|Spain\t|Demographic\t|Relationship\t|Demo - Casados\t|s=46275\t|Personas que están Casados\t|\n","|Spain\t|Demographic\t|Home Ownership\t|Demo - Dueño de casa\t|s=46276\t|Dueño de casa\t|\n","|Spain\t|Demographic\t|Relationship\t|Demo - Solteros\t|s=46274\t|Personas que están Solteros\t|\n","|France\t|Demographic\t|Relationship\t|Demo - Célibataire\t|s=21813\t|Personne qui n'est pas marié\t|\n","|France\t|Demographic\t|Household\t|Demo - Famille avec 1 enfant\t|s=21824\t|Famille avec 1 enfant\t|\n","|France\t|Demographic\t|Household\t|Demo - Famille avec 2 enfants\t|s=21825\t|Famille avec 2 enfants\t|\n","|France\t|Demographic\t|Household\t|Demo - Famille avec 3 enfants ou plus\t|s=21826\t|Famille avec 3 enfants\t|\n","|France\t|Demographic\t|Household\t|Demo - Famille sans enfant\t|s=21823\t|Famille sans enfant\t|\n","|France\t|Demographic\t|Home Ownership\t|Demo - Locataires\t|s=21832\t|Personne qui est une locataires\t|\n","|France\t|Demographic\t|Relationship\t|Demo - Mariés\t|s=21814\t|Personne qui est marie\t|\n","|France\t|Demographic\t|Occupation\t|Demo - Occupation: Agriculteurs exploitants\t|s=21815\t|Personne qui travaille dans agriculteurs\t|\n","|France\t|Demographic\t|Occupation\t|Demo - Occupation: Artisans et commerçants\t|s=21816\t|Personne qui travaille dans artisans et\t|\n","|France\t|Demographic\t|Occupation\t|Demo - Occupation: Cadres supérieures\t|s=21817\t|Personne qui travaille dans accupation: Cadres\t|\n","|France\t|Demographic\t|Occupation\t|Demo - Occupation: Professions intermédiaires\t|s=21818\t|Personne qui travaille dans accupation: Professions\t|\n","|France\t|Demographic\t|Occupation\t|Demo - Occupation: Retraités\t|s=21821\t|Personne qui travaille dans retraités\t|\n","|France\t|Demographic\t|Home Ownership\t|Demo - Propriétaires\t|s=21831\t|Personne qui possède une maison\t|\n","|France\t|Demographic\t|Income\t|Demo - Revenu 15K-30K\t|s=16776\t|Personnes avec un revenu entre 15K-30K\t|\n","|France\t|Demographic\t|Income\t|Demo - Revenu 30K-50K\t|s=16783\t|Personnes avec un revenu entre 30K-50K\t|\n","|France\t|Demographic\t|Income\t|Demo - Revenu 50K-80K\t|s=16781\t|Personnes avec un revenu entre 50K-80K\t|\n","|France\t|Demographic\t|Income\t|Demo - Revenu 80K+\t|s=16784\t|Personnes avec un revenu supérieur à 80K+\t|\n"],"documentType":"guide"},{"title":"Amazon Ads API release notes","sectionHeader":null,"path":"/en-us/release-notes/archive/ads-api","content":[" This document contains release notes that have been archived.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"December 2022"},"path":"/en-us/release-notes/archive/ads-api","content":[" Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SE, UK, US\n"," We are expanding Sponsored Display creative offering with video capabilities for campaigns using contextual targeting. Video creatives empower advertisers to showcase their products and brand through immersive storytelling (for example, tutorials, demos, unboxing, and testimonials). Advertisers using Sponsored Display contextual targeting and audiences will be able to build awareness and consideration of their products and brand on and off Amazon using a video ad format.\n"," Similar to campaigns using the audiences strategy, advertisers using contextual targeting can now choose to customize creatives using a headline and logo, image, or video through Sponsored Display self-service display solution that helps grow their business with Amazon. The new video creative capability supports videos up to 45 seconds so advertisers can better tell their stories to customers, helping them understand the product and brand with more engaging content.\n"," If you have insights on creative that helps drive traffic or engagement, you can use that creative for your Amazon Ads campaigns. Ads will link directly to your product detail pages, so audiences can learn more about your product and consider purchasing.\n"," For full technical details, please see our updated Sponsored Display documentation, including contextual targeting support for creativeType of VIDEO.\n"," Regions: CA, DE, ES, FR, IN, IT, JP, MX, UK, US\n"," Sponsored Brands is launching four new API endpoints to enable advertisers to access product targeting information:\n","GET /sb/targets/categories  GET /sb/targets/categories/{categoryRefinementId}/refinements  POST /sb/targets/products/count \\* GET /sb/negativeTargets/brands/recommendations\n"," Though these features were previously available in the advertising console, advertisers can now access them programmatically through the Amazon Ads API. This helps bring the advertiser API experience more in line with the advertising console, and gives advertisers greater flexibility when creating campaigns. \n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SE, UK, US\n"," We launched view metrics for reach-optimized Sponsored Display campaigns with video creatives. The new metrics will provide advertisers with a new set of key metrics for measuring and optimizing video campaign performance. The new metrics include: view-through rate (VTR), video first quartile, video midpoint, video third quartile, video complete, and video unmutes, and click-through rate for views (vCTR). View metrics are available in the advertising console, report center, or through the Amazon Ads API.\n"," Video is an important format that advertisers use to tell their brand and product story. When advertisers deliver video creatives, they want to understand how many customers viewed their ad and how they engaged with the video. With this launch, advertisers can now measure the performance of their campaigns across video viewing engagement, providing transparency into the additional value delivered by Sponsored Display video creative. For example, advertisers can use video completion metrics to measure how many customers completed their video ads and better understand what type of content resonates best with customers. Over time, these insights can help advertisers iterate on video quality and optimize for video viewing to help increase customer engagement and improve outcomes of Sponsored Display video creative ad groups.\n"," For full technical details, please see our reporting documentation, including the updated documentation on the new video creative metrics that include vtr, videoFirstQuartileViews, videoMidpointViews, videoThirdQuartileViews, videoCompleteViews, videoUnmutes, and vctr. \n"," Regions: EG, SA, TR, PL\n"," Vendors and registered sellers in these countries now have access to Sponsored Display, helping them reach relevant audiences throughout their shopping and entertainment journeys with self-service, programmatic display ads that can be created in just a few clicks. Sponsored Display audiences allows you to use Amazon rich shopping and streaming signals to help grow your business. Advertisers can use contextual targeting to help generate detail page traffic and then lean into audience strategies to reengage audiences to help secure missed sales opportunities or further cultivate brand loyalty.\n"," Advertisers can add up to 10,000 products to a campaign and benefit from retail awareness so that marketing campaigns will pause if products go out of stock. Advertisers using Sponsored Display can also customize their creatives choosing any combination of video, headline, logo, or lifestyle image to help audiences discover their brands and products.\n"," Regions: All\n"," Advertisers can now update the ad creatives of their live Sponsored Brands video campaigns that are created using ad groups (Sponsored Brands version 4). Ad group is a feature available through the advertising console and Amazon Ads API that enables advertisers to create a new campaign with multiple ad groups to share targeting across different ads formats. For new campaigns that link to a product detail page, advertisers will have the ability to change the videos. For new campaigns that link to a brand Store, advertisers can edit logo, video, headline, and product using this API. This feature allows advertisers to edit a live campaign without needing to create a new campaign that leads to loss of historical information collected on the live campaign. \n"," Advertisers will also have the option to continue delivering the campaign with the previous creative version while the edited version is reviewed by moderation.\n"," For full technical details, see the API reference and the Managing creatives guide.\n"," Regions: All\n"," We have released an updated version of the Partner Opportunities, v1.1.  The new version contains new features including:\n","Pagination of Partner Opportunities list. \\* Metrics Availability: An API response to indicate Partner Opportunity metric availability and last updated date. \\* Summary of opportunities: A new API response that will return summarized opportunity information, such as the number of accounts included in available opportunities.\n"," For assistance migrating from v1.0 to v1.1, please see our documentation.\n"," As a member of the Amazon Ads Partner Network, you can access Partner Opportunities to receive actionable insights for all your linked clients through your Partner Network account. This program curates custom insights for all of the campaigns you manage within your entire book of business.  Partner Opportunities can assist your business by: simplifying your API call process, saving time on managed advertising activities, and can allow you to better support your clients campaigns.  The types of opportunities available are dynamic and generated based on recent information.\n","Introduction to the Partner Opportunities API 2. Getting started with the Partner Opportunities API 3. FAQs for the Partner Opportunities API\n"," Amazon Marketing Stream (beta) has now expanded to include Sponsored Display in North America, allowing partners and advertisers to receive performance metrics and information on campaign changes in near real time. Information is pushed to advertisers and partners through the Amazon Ads API, eliminating the need to aggregate metrics over time to understand the changes between hourly performance, and enabling timely notifications on campaign changes. \n"," Amazon Marketing Stream can help you improve Sponsored Display performance with traffic and performance metrics summarized hourly instead of daily, informing intra-day optimizations. Advertisers and partners will also receive timely notifications on campaign changes that can help you take actions in near real time, such as a campaign going out of budget.  \n"," New metrics available through this Sponsored Display launch include new-to-brand metrics and view-based attribution for vCPM (cost-per-thousand viewable impressions) campaigns, summarized hourly. Amazon Marketing Stream can help you understand Sponsored Display campaign KPIs such as impressions, clicks, attributable sales, orders, and new-to-brand sales, broken down by hour of day. For example, you may learn that new-to-brand attributed sales, units and orders are higher during hours 8pm-10pm, informing hourly bid adjustments. You can also determine when views or clicks (vCPM) lead to more conversions, by hour of day.\n"," When you are ready to get started, visit the Amazon Marketing Stream onboarding guide.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"November 2022"},"path":"/en-us/release-notes/archive/ads-api","content":[" Note: This deprecation was originally announced for December 31, 2022 and was pushed back based on customer feedback. For the latest information, see our Deprecations page.\n"," The following Sponsored Products bid recommendations resources will be deprecated on March 27, 2024:\n","/v2/sp/adGroups/{adGroupId}/bidRecommendations  /v2/sp/keywords/{keywordId}/bidRecommendations  /v2/sp/keywords/bidRecommendations\n"," We recommend that advertisers located in CA, DE, ES, FR, IN, JP, US, or UK migrate to the new theme-based bid suggestion resource to retrieve bid suggestions. This new resource includes historical impact metrics based on similar products and helps in choosing the right bid for your campaigns. For full technical details on this new resource, please see the theme-based bid suggestions documentation or visit the quick-start guide. Note that for countries in which the theme-based bid suggestion resource is not yet available, we recommend that advertisers use the /v2/sp/targets/bidRecommendations resource instead.\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, UK, US\n"," Sponsored Display has launched a new API in the Amazon Ads API to help forecast impressions. Impression forecasting is available for Sponsored Display campaigns with contextual targeting and Amazon audiences.\n"," Forecasting helps advertisers understand the impact of their choices during campaign creation. Now advertisers can get the minimum and maximum range of available impressions inventory for a set of selected advertised products, optimization type, targeting, and bid values. This will help advertisers in creating performing campaigns, understanding scale by experimenting with the campaign setup, and forecasting the output of an investment before they get started.\n"," Forecasting will be available for Sponsored Display through the Amazon Ads API. For full technical details, please see our updated Sponsored Display documentation.\n"," Regions: All (excluding IN)\n"," We are announcing plans to deprecate Sponsored Products versions 1 and 2 campaign management APIs, with a target shutdown date of June 30, 2023. Please migrate to the new versions of these endpoints as documented on our Deprecations page and in our Migration guide. \n"," Note: This deprecation does not include the version 1 or version 2 snapshot endpoints.\n"," The following endpoints and all associated HTTP operations are included in this deprecation:\n","Version 1 \\* Version 2\n"," If you would like to share feedback, please use the Amazon Ads API Service desk to open a ticket with subject title \"SP v2 CRUD Deprecation\" by February 15, 2023.\n"," Amazon Ads is excited to be attending AWS re:Invent this year. We will be kicking off the week with a Lighting Talk on “Using your technical skills with Amazon Ads” on Tuesday 11/29 at 11:45 AM PST. You can stop by Expo booth #2040 to speak with Technical Account Managers and members of the Tech Learning and Developer Relations team, view short technical demonstrations, and pick up some swag. \n"," To view our full schedule of events, visit the Amazon Ads re:Invent microsite, and if you have not yet registered for re:Invent, tickets are still available.\n"," We hope to see you in Las Vegas!\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SA, SG, UK, US\n"," We are launching a new feature that lets advertisers use their video campaigns to redirect shoppers to their Brand Store landing pages. Prior to this launch, customers were redirected to product detail pages by default, and with this change advertisers can now choose which landing page customers are redirected to - either the Product Detail Page or the Brand Store. Stores are more discoverable to shoppers as they are the primary method for advertisers to showcase brands and products in a multi-page, immersive shopping experience on Amazon. Brand Stores allow brands to curate content that inspires, educates, and helps shoppers discover the brand product selection, taking them from inspiration to action. In addition, video ads with Stores as landing pages offer the opportunity to render in “Top of Search”, Amazon Ads premium placement. Adding video in this placement will increase the reach that advertisers can achieve with Sponsored Brands video by raising the viewability rate to 100% in top slot.\n"," Note: The ad group and ad creation operations are supported for new campaigns using the Amazon advertising console or through the Amazon Ads API using the Sponsored Brands version 4 beta endpoints.\n"," For full technical details, please see the POST /sb/beta/ads/brandVideo endpoint and SB version 4 migration guide.\n"," The creative asset library API now supports videos as well as images. All features supported for images are now available for video assets. \n"," To learn more about creative asset library, read the original release note.\n"," For technical details, see the updated API reference.\n"," Amazon Ads released Sponsored Products version 3 of campaign management create, read, update, and delete (CRUD) APIs. This includes the Sponsored Products campaign, ad group, targeting, negative targeting, keyword, negative keyword, campaign negative keywords, and product ads endpoints.\n"," The Sponsored Products version 3 APIs include usability improvements like token-based pagination, enhanced errors, and response models. The new API is called by the Amazon Ads console, ensuring a consistent experience across the UI and the Amazon Ads API.\n"," Key improvements:\n","This version of the API is currently being called by the Amazon Ads console, ensuring feature parity between the UI and API.  Error responses include additional information developers can use to troubleshoot issues.  Consolidated extended and list endpoints. Developers can use a parameter in the request to request the extended response.  Users can request the API returns full objects created or updated in POST and PUT requests versus just the IDs of the objects created or edited.  Users can filter list operations based on name using broad or exact match. \\* Improved latency compared to version 2.\n"," The new endpoints are available to all advertisers and advertising partners on the Amazon Ads API. Please see our migration guide for information on how to move from version 2 to version 3, and also check out the updated Postman collection for templates to call the version 3 endpoints.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"October 2022"},"path":"/en-us/release-notes/archive/ads-api","content":[" Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SE, UK, US\n"," Sponsored Display has launched video creatives. The new video format empowers advertisers to showcase their products and brand through immersive storytelling (for example, tutorials, demos, unboxing, and testimonials). Advertisers using Sponsored Display audiences will be able to build awareness and consideration of their products and brand on and off Amazon using a video ad format.\n"," Advertisers can now choose to customize creatives using a headline and logo, image, or video through Sponsored Display self-service display solution that helps grow their business with Amazon. The new video creative capability supports videos up to 45 seconds so advertisers can better tell their stories to customers, helping them understand the product and brand with more engaging content. \n"," Video creatives can help tell your story while serving ads on and off Amazon in your own visual language, helping shoppers get excited about your brand and product experience. If you have insights on creative that helps drive traffic or engagement, you can use that creative for your Amazon Ads campaigns. Ads will link directly to your product detail pages, so audiences can learn more about your product and consider purchasing.\n"," For full technical details, please see our Sponsored Display documentation in the advanced tools center, including the updated documentation on video creatives and creativeType within adGroups for the T00030 tactic.\n"," Regions: All (except India)\n"," We are excited to expand Amazon Marketing Stream (beta) to all countries currently supported by the Amazon Ads API, with the exception of India. Amazon Marketing Stream is a new service that delivers Amazon Ads campaign metrics and information to advertiser or integrator AWS accounts via a push-based model in near real time.\n"," Learn more about Amazon Marketing Stream in the original release note or get started using the Onboarding guide.\n"," Regions: UK, DE, CA, US, FR, ES, IT\n"," Bid constraints on Sponsored Display cost-per-click (CPC) campaigns are now identical for sellers and vendors within a given marketplace. Previously, minimum and maximum bids for vendors were different from minimum and maximum bids for sellers in some marketplaces.\n"," For a full list of bid constraints in the Amazon Ads API, see Bid constraints by marketplace.\n"," Regions: SG\n"," Vendors and registered sellers in Singapore now have access to Sponsored Display, helping them reach customers viewing specific products or categories with contextual targeting, and throughout their customer journey, including the Amazon homepage, with Sponsored Display audiences strategy. Sponsored Display flexible controls enable advertisers to use self-service display ads to introduce products, engage new customers, and remarket with scale to supplement Sponsored Products and Sponsored Brands campaigns. Advertisers can add up to 10,000 products to a campaign and benefit from retail awareness, meaning campaigns will pause if your products go out of stock, eliminating wasted marketing spend on advertising that cannot lead to a purchase.\n"," For full technical details, please see our Sponsored Display documentation.\n"," Reports generated in the newest release of the Amazon DSP reporting APIs will support new field names for 20 metrics, bringing the APIs into alignment with Amazon DSP online and downloadable reports. These metrics (formerly 'pixel conversions') have been renamed:\n","|Legacy API field name\t|New API field name\t|\n","|---\t|---\t|\n","|productPurchased\t|offAmazonPurchases14d\t|\n","|productPurchasedViews\t|offAmazonPurchasesViews14d\t|\n","|productPurchasedClicks\t|offAmazonPurchasesClicks14d\t|\n","|productPurchasedCVR\t|offAmazonPurchaseRate14d\t|\n","|productPurchasedCPA\t|offAmazonECPP14d\t|\n","|totalPixel14d\t|offAmazonConversions14d\t|\n","|totalPixelViews14d\t|offAmazonViews14d\t|\n","|totalPixelClicks14d\t|offAmazonClicks14d\t|\n","|totalPixelCVR14d\t|offAmazonCVR14d\t|\n","|totalPixelCPA14d\t|offAmazonCPA\t|\n","|subscriptionPage14d\t|subscribe14d\t|\n","|subscriptionPageViews14d\t|subscribeViews14d\t|\n","|subscriptionPageClicks14d\t|subscribeClicks14d\t|\n","|subscriptionPageCVR14d\t|subscribeCVR14d\t|\n","|subscriptionPageCPA14d\t|subscribeCPA14d\t|\n","|signUpButton14d\t|signUp14d\t|\n","|signUpButtonViews14d\t|signUpViews14d\t|\n","|signUpButtonClicks14d\t|signUpClicks14d\t|\n","|signUpButtonCVR14d\t|signUpCVR14d\t|\n","|signUpButtonCPA14d\t|signUpCPA14d\t|\n"," As we improve the conversion tracking experience for Amazon DSP advertisers, these metrics will include conversions from new, non-pixel-based interfaces. Legacy aliases for these metrics are still supported in version 3.0. \n"," For more information, see the DSP reporting API reference. \n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"September 2022"},"path":"/en-us/release-notes/archive/ads-api","content":[" The following Sponsored Products bid recommendations resources will be deprecated on December 31, 2022:\n","/adGroups/{adGroupId}/bidRecommendations  /keywords/{keywordId}/bidRecommendations  /keywords/bidRecommendations\n"," We recommend that advertisers located in CA, DE, ES, FR, IN, JP, US, or UK migrate to the new theme-based bid suggestion resource to retrieve bid suggestions. This new resource includes historical impact metrics based on similar products and helps in choosing the right bid for your campaigns.  For full technical details on this new resource, see the theme-based bid suggestions documentation or visit the quick-start guide. Note that for countries in which the theme-based bid suggestion resource is not yet available, we recommend that advertisers use the /v2/sp/targets/bidRecommendations resource instead.\n"," Note: We previously announced the deprecation of version 2 Sponsored Products bid recommendations. \n"," See API deprecations for information on all upcoming deprecations.\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SE, UK, US\n"," Sponsored Display theme-based recommendations are targeting options that empower advertisers with flexibility to choose products that are aligned with their specific campaign strategies, based on price, ratings, and views. These recommendations will now be provided for Sponsored Display contextual targeting campaigns within the Amazon Ads API.\n"," Theme-based recommendations offer multiple options to target relevant products without the need for additional research from advertisers. Target products under each theme are curated specific to the use case, with high-quality suggestions based on Amazon first-party signals. Each theme will have up to 50 individually recommended products, with flexibility to choose products individually or select all products within a theme.\n"," For full technical details, refer to the API reference. Note: If you are already specifying a version in the Accept request-header field, you must update to application/vnd.sdtargetingrecommendations.v3.2+json to access the new features.\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SA, SG, UK, US\n"," Advertisers using Sponsored Brands can now create ad groups to better organize and manage Sponsored Brands campaigns. Advertisers can use ad groups to organize their ads by brand, keywords, product, category, ad format, landing page, or other classifications that tie to your goals or marketing strategy. Brands can now run goal-based marketing campaigns by grouping different creative types and landing pages under an ad group and monitoring the effectiveness over time. The launch enables brands to evaluate different creatives within the same ad group, helping advertisers compare performance and develop a better understanding of the impact of creatives versions. \n"," Previously, advertisers could only retrieve ad group information and lacked the support to create or update ad groups. Ad groups are a great way to reduce the cognitive load and complexity, as well as drive consistency when managing campaigns across Sponsored Products and Sponsored Display. With this change, both vendors and sellers can specify multiple ad groups in campaign creation and update operations. \n"," Note: The advertising console will be switching to the new campaign type over the next month. In order to retrieve full details for campaigns created in the ad console, you need to use the new POST /sb/beta/campaigns/list endpoint. To see full reporting data, you will also need to use the creativeType filter set to all in your Sponsored Brands report requests.\n"," For full technical details, refer to the API reference and migration guide.\n"," Advertisers can now receive suggested headlines for Sponsored Display campaigns through the Amazon Ads API. Suggested headlines are generated based on advertised products selected to show in your creative, and they follow our ad policy guidelines. You can also edit the suggested headlines to best match your campaign goals, but edits to suggested headlines will continue to go through the standard moderation review process along with remaining creative elements (logo, image, products, brand name). \n"," Learn more with our reference documentation.\n"," Regions: All\n"," The Sponsored Brands Branded Searches metric is now available in all regions supported by the Amazon Ads API. The branded searches metric helps advertisers better understand the impact of Sponsored Brands campaigns by measuring how many times shoppers executed a search that contained an advertiser brand name after interacting with an ad. \n"," For more information, see the original release note. \n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"August 2022"},"path":"/en-us/release-notes/archive/ads-api","content":[" Regions: All\n"," We have released a new set of content to walk advertisers through the use of the partner opportunities API. The content begins with an overview, follows with a document to help you get started, and ends with a detailed how-to guide with troubleshooting.\n"," The partner opportunities API provides partners who are registered on the Amazon Ads Partner Network with actionable insights for their linked advertisers with a single call to the Amazon Ads API. Example insights may include: high potential ASINs and excess inventory ASINs to advertise, retail readiness scores below a certain threshold, ASINs without branded search key-terms, and more insights to come.\n"," With a single call, partners can receive the actionable insights available through the partner opportunities API to optimize advertising performance for the advertisers they manage. Rather than calling multiple endpoints for every advertiser they manage, partners can save time by calling the Partner Opportunities API to receive custom insights aimed at improving overall campaign performance for their client accounts.\n"," The partner opportunities API is tailored for partners to use across all the advertisers linked to their Partner Network account. To call the partner opportunities API, partners configure their Amazon Ads API call with their Partner Network Account identifier, which is available in the Partner Network user settings.\n"," We are announcing plans to deprecate Sponsored Products version 2 category and brand targeting endpoints on October 30, 2022. Please migrate to the new versions of these endpoints as mentioned in our previous release notes.\n"," The following endpoints are included in this deprecation: \n","/v2/sp/targets/brands - /v2/sp/targets/categories/refinements  - /v2/sp/targets/categories \n"," If you have feedback, contact us through the Amazon Ads API Support webpage with ticket subject title \"SP v2 category and brand targeting recommendations deprecation\" by September 15, 2022.\n"," To view all upcoming deprecations, see our API deprecation page. \n"," We are announcing plans to deprecate a Sponsored Products v2 product targeting recommendation endpoint on February 28, 2022. Please migrate to the new versions of these endpoints as mentioned in our previous release notes.\n"," The following endpoint is included in this deprecation:\n","/v2/sp/targets/productRecommendations\n"," If you have feedback, contact us through the Amazon Ads API Support webpage with ticket subject title \"SP v2 product targeting recommendation deprecation\" by November 15, 2022.\n"," To view all upcoming deprecations, see our API deprecation page. \n"," We updated how we identify the author brand for new Sponsored Brands campaigns created by authors in United States, United Kingdom, Germany, France, Italy, and Spain. The change provides author support for the Sponsored Brands features of the Amazon Ads API. This will allow users to create and modify Sponsored Brands campaigns for KDP and traditional authors, and draft campaigns through the Amazon Ads API. With this change, authors can use Amazon Ads for more of their catalog, including:\n","Titles published outside of Kindle Direct Publishing (i.e., traditionally published titles) \\* Co-authored titles\n"," When setting up a new Sponsored Brands campaign, authors will need to first claim the book, KDP or traditionally published, in their Author Central (A2C) account. See how to claim a book in A2C for more information.\n"," For more details, refer to the Sponsored Brands open API documentation.\n"," Regions: US, UK, DE, FR, IT, ES\n"," Sponsored Brands launched a new Branded Searches metric for US, UK, DE, FR, IT, and ES advertisers. With the release of this metric, advertisers can better understand the impact of their Sponsored Brands campaigns in driving branded search queries. Complete branded search information is available from June 21, 2022.  \n"," The branded searches metric helps advertisers better understand the impact of Sponsored Brands campaigns by measuring how many times shoppers executed a search that contained an advertiser brand name after interacting with a Sponsored Brands ad. The number of branded searches is a strong indicator of brand recall and awareness, and can help advertisers understand the full impact of their campaigns beyond driving sales.\n"," It allows a new value, attributedBrandedSearches14d, in the metrics field for version 2 Sponsored Brands reports. For full technical details, see our updated documentation including the new attributedBrandedSearches14d across campaign, placement, ad group, keyword, target, and ad reports.\n"," Following the release of the new version 3 reporting endpoints, we are announcing the deprecation the version 2 Sponsored Products reporting by March 30, 2023. This includes the POST v2/sp/reports/{recordType} endpoint. \n"," Going forward, you can access all version 2 Sponsored Products report types using the version 3 reporting endpoints. For more details on how to upgrade to version 3, see our Migration guide and Frequently asked questions.\n"," If you have feedback, use the Amazon Ads API Support page to submit a ticket with the subject title “SP reports v2 deprecation” by December 1, 2022.\n"," Regions: All\n"," We are launching the latest version (version 3) of reporting for the Amazon Ads API. This update provides agencies, brands, and service providers with a way to access all their campaign data from a single source, enabling them to spend less time extracting and consolidating data. Additional benefits in this version include: the ability to select date ranges, longer historical data selection, and common request and response schemas for all ad products.\n"," Version 3 reporting currently supports all Sponsored Products version 2 report types, as well as a net new report for Sponsored Brands. The Sponsored Brands purchased products report provides ASIN-level insights for all ad-attributed sales, including promoted products (purchases for your brand products made by shoppers that clicked on your ad) and brand-halo (sales of any product in your advertised brands made by Amazon or other sellers).\n"," Reporting for the rest of sponsored ads suite will be onboarded in the coming months. \n"," For full technical details, see our version 3 overview and migration guide.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"July 2022 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We have added support for Egypt (EG) to the API. For more details, see API endpoints, bid constraints by marketplace, the countryCode parameter of the registerProfile and registerBrands operations, and the regional profile time zone codes section of the profiles reference.\n"," Regions: SE\n"," Vendors and registered sellers in Sweden now have access to Sponsored Display, helping them reach customers viewing specific products or categories with contextual targeting, and throughout their customer journey, including the Amazon homepage, with Sponsored Display audiences strategy. Sponsored Display flexible controls enable advertisers to use self-service display ads to introduce products, engage new customers, and remarket with scale to supplement Sponsored Products and Sponsored Brands campaigns. Advertisers can add up to 10,000 products to a campaign and benefit from retail awareness, meaning campaigns will pause if your products go out of stock, eliminating wasted marketing spend on advertising that cannot lead to a purchase.\n"," For full technical details, please see our Sponsored Display documentation.\n"," Regions: All\n"," With this launch, advertisers using Sponsored Display can now customize their creatives by adding a headline, logo, and lifestyle image either together or individually. Advertisers can choose to add any combination of those assets while creating or editing their creatives. \n"," Advertisers interested in customizing their creatives now have increased flexibility and control. Every creative choice is optional, and they can choose any combination, allowing advertisers to match their style across creatives or repurpose existing assets. Ads will display alongside a product image, creating consistent branded creatives across ad placements. Ads with lifestyle images will support promotional deals and savings badges to help improve ad performance. When customizing creatives in the console, advertisers will now see a menu of customizable assets that provides real-time feedback and moderation status to quickly provide a holistic status of a creative. This feature applies to new and existing creatives.\n"," For full technical details, please see our updated Sponsored Display creative documentation including the ability to choose any combination of headline, brandLogo, or custom image (rectCustomImage and squareCustomImage).\n"," Regions: All\n"," The partner opportunities API provides partners who are registered on the Amazon Ads Partner Network with actionable insights for their linked advertisers with a single call to the Amazon Ads API. Example insights may include: high potential ASINs and excess inventory ASINs to advertise, retail readiness scores below a certain threshold, ASINs without branded search key-terms, and more insights to come.\n"," With a single call, partners can receive the actionable insights available through the partner opportunities API to optimize advertising performance for the advertisers they manage. Rather than calling multiple endpoints for every advertiser they manage, partners can save time by calling the Partner Opportunities API to receive custom insights aimed at improving overall campaign performance for their client accounts.\n"," The partner opportunities API is tailored for partners to use across all the advertisers linked to their Partner Network account. To call the partner opportunities API, partners configure their Amazon Ads API call with their Partner Network Account identifier, which is available in the Partner Network user settings.\n"," To get the list of all available opportunities, partners first call the GET /partnerOpportunities resource to obtain descriptive information about the opportunity, such as which advertising products it pertains to. Once you identify an opportunity of interest, you can retrieve the dataset pertaining to the identified opportunity using the GET /partnerOpportunities/{partnerOpportunityId}/file resource. You will receive a secure URL to the S3 location of the file for each opportunity dataset, which you can download as a CSV file to identify the advertisers, campaigns, or ASINs to which the opportunity applies.\n"," For more information, refer to the partner opportunities API documentation. \n"," Regions: US, CA, MX, BR, DE, ES, FR, IT, NL, UK, UAE, AU, JP, IN\n"," Sponsored Display has launched branded searches metrics for vendors and registered sellers across all available regions. With the release of these metrics, advertisers can better understand the impact of advertising campaigns on searches for their brand.\n"," The branded searches metrics help advertisers better understand the impact of Sponsored Display campaigns by measuring how many times customers executed a search that contained an advertiser brand name after interacting with a Sponsored Display ad. Branded searches works by matching the promoted products within a campaign with searches containing the brand name on Amazon.\n"," With branded search metrics, brand owners can report on how many shoppers executed a search that included their brand name after viewing or clicking (for awareness campaigns using vCPM) a Sponsored Display ad. This data can be used to help you understand the impact of different Sponsored Display creative and targeting strategies on your brand searches. Complete branded search data will be available from June 21st, 2022. Please allow up to 14 days for full restatement of this data.\n"," For full technical details, please see our updated Sponsored Display documentation including the new attributedBrandedSearches14d for campaigns with CPC as costType and viewAttributedBrandedSearches14d for campaigns with vCPM as costType across campaigns, adGroups, targets, and matchedTarget reports.\n"," We have expanded the budget rules API to enable advertisers to create performance-based budget rules for Sponsored Brands campaigns, using return on advertising spend (ROAS) as the performance metric. Budget rules help you plan budget changes in advance so you can spend less time manually adjusting during a campaign. You can set rules based on specific dates or your ROAS performance goals.\n"," Performance-based budget rules can be set to increase budgets based on campaign performance metrics. With budget rules, advertisers can reduce the likelihood of campaigns running out of budget, especially during peak days or holiday events.\n"," Visit our overview pages to learn more: \n","Sponsored Products Budget Rules overview  Sponsored Brands Budget Rules overview  Sponsored Display Budget Rules overview\n"," The validation configuration API supplies commonly-used configuration values that are required to successfully validate Amazon Ads campaigns. These configuration values, such as valid character types, maximum text input lengths, and valid bid and budget ranges, are required fields that are validated when campaigns are submitted or updated. These configuration values are important when launching campaigns in various marketplaces, as the validation values may change due to differing supported languages, as well as marketplace-specific valid bid and budget ranges due to varying currencies. The validation configuration API includes two resources that can be partitioned by marketplace code, entity type, and ad program type: \n","POST /validationConfigurations/campaigns: returns configurations for campaign level validation \\* POST /validationConfigurations/targetingClauses: returns configurations for targeting clause level validation\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"June 2022 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Regions: BR\n"," We have expanded bid optimization controls for Sponsored Display campaigns to BR. You can now select \"Optimize for viewable impressions\" and your campaigns will be optimized to drive viewable impressions for all audiences and contextual targeting campaigns within the Amazon Ads console or Amazon Ads API.\n"," Custom bid optimizations allow you to select bid optimizations based on campaign needs and help you evaluate performance based on viewable impressions, clicks, or conversions. This means you can complement your targeting selection and creative customization with appropriate bid optimizations to meet your needs. You now have more controls over your campaigns and are no longer restricted by pre-defined bid optimizations. All existing campaigns in the expanded regions will default to “Optimize for page visits\". These new flexible controls enable you to help you more effectively introduce new products, drive traffic, and engage new or existing shoppers.\n"," For full technical details and examples of costType and bidOptimization, please see our Sponsored Display developer guide for contextual targeting.\n"," Note: This deprecation date has been extended from December 31 2022 based on customer feedback. For the latest information, see our Deprecations page.\n"," The following Sponsored Products bid recommendations resources will be deprecated on September 30, 2023:\n","/v2/sp/adGroups/{adGroupId}/bidRecommendations  /v2/sp/keywords/{keywordId}/bidRecommendations  /v2/sp/keywords/bidRecommendations\n"," We recommend that advertisers located in CA, DE, ES, FR, IN, JP, US, or UK migrate to the new theme-based bid suggestion resource to retrieve bid suggestions. This new resource includes historical impact metrics based on similar products and helps in choosing the right bid for your campaigns.  For full technical details on this new resource, please see the theme-based bid suggestions documentation or visit the quick-start guide. Note that for countries in which the theme-based bid suggestion resource is not yet available, we recommend that advertisers use the /v2/sp/targets/bidRecommendations resource instead.\n"," We welcome feedback on this deprecation, please contact us by visiting the Amazon Ads API Support page and create a ticket with the subject title SB v2 Deprecation before August 30, 2022.\n"," We have launched version 5.0 of keyword recommendations, giving advertisers more interpretability and control by providing recommended keywords along with bid suggestions from different themes. The recommended keywords can be sorted on two different dimensions: click volume (clicks) and conversion volume (conversions). The theme being released today is bids to generate sales and the response also includes impact metrics at the ad-group level such as weekly clicks and purchase orders received by similar products. Previously, advertisers looking to add additional keywords to their campaigns saw a long list of suggested keywords but were provided no additional context on why Amazon was providing those suggestions. This release allows advertisers to more easily evaluate one suggestion versus another by providing a prioritization for suggested keywords along with an estimated impact of adopting them.\n"," For more information, see the keyword recommendations resource reference. Note that you must click on the version drop-down box in the request and response body sections of the reference and select application/vnd.spkeywordsrecommendation.v5+json to view the documentation for version 5.0 of the resource.\n"," We are evolving Sponsored Display product targeting into contextual targeting, allowing advertisers to reach more of their audiences at more points in their shopping and entertainment journey. The contextual targeting strategy will now allow advertisers to reach audiences both in the Amazon store and outside the Amazon store when customers view content related to targeting strategies. Advertisers do not need to change their targeted products or categories to enable the new feature. Sponsored Display will find the right opportunities to expand advertiser reach beyond the store, to web pages and mobile apps.\n"," Vendors and registered sellers can use Sponsored Display to reach their audiences throughout their shopping and entertainment journeys to drive product consideration and awareness. Previously, contextually targeted campaigns would only show on the Amazon store (for example, on product pages in the “Fitness and Exercise” category). However, there are many opportunities to reach fitness enthusiasts at other points in their day, as they browse other web pages or use their favorite mobile apps. Our machine learning models will now automatically find more opportunities to deliver campaigns, while still adhering to advertiser bidding strategies and objectives: for instance, when optimizing for page views, we will help find additional opportunities beyond Amazon to serve ads at the same or improved cost per click. Advertisers can pair contextual targeting with page view optimization strategies, alongside a remarketing strategy that can help drive additional reach and conversions from the increased visitors to their detail pages. \n"," For full technical details, please see our Sponsored Display documentation, including the updated documentation to reflect the name change from product targeting to contextual targeting. For additional examples, please see our contextual targeting developer guide. Please note, no changes will be needed to your existing T00020 campaigns to take advantage of this change. \n"," Regions: US, CA, MX\n"," Amazon Marketing Stream has launched to open beta, allowing partners and advertisers to receive campaign data in near real time, without needing to repeatedly call the API. Amazon Marketing Stream offers new capabilities compared with an API-based reporting approach, including traffic and conversion data summarized hourly instead of daily, less throttling, additional reporting dimensions, and better insights on deltas instead of aggregates. \n"," In the past, access to scaled campaign reporting was limited to pull-based API calls that provided daily performance. In addition, the API needed to be called multiple times throughout the day, which led to throttling and a less efficient workflow.  \n"," Amazon Marketing Stream is available for Sponsored Products campaigns and sponsored ads budget usage via the Amazon Ads API for agencies, tool providers, and direct advertisers, including vendors and sellers in Canada, Mexico, and the United States. When you are ready to get started, visit the Amazon Marketing Stream onboarding guide.\n"," Regions: US, CA, MX, BR, DE, ES, FR, IT, NL, UK, UAE\n"," Sponsored Display deny lists have launched to general availability in the Amazon Ads console and Amazon Ads API. Sponsored Display ads serve on Amazon and off Amazon on third-party properties, such as websites and mobile apps. The deny list functionality provides you control to manage your brand presence off Amazon on third-party properties that do not align with your brand. You can upload a deny list of websites and mobile apps where you do not want your ads to show across all your Sponsored Display campaigns.\n"," Vendors and registered sellers are now better equipped to engage with audiences off Amazon during their shopping and entertainment journey without concern of their ads showing on websites and mobile apps that are not aligned to their brand. Deny lists provide an additional layer of protection on top of Amazon ads global brand safety policy to allow advertisers to remove websites or mobile apps that are generally brand safe but do not align with the brand values. For example, a vegan food brand may choose not to advertise on websites that discuss meat products to protect their brand reputation, even though the website does not contain sensitive content.\n"," For full technical details, please see our updated Sponsored Display brand safety documentation in the Amazon Ads API.\n"," With Sponsored Display dynamic segments, advertisers can target additional products that are similar to those being advertised. The products selected by similar product targeting are based on the advertised product and are dynamically generated based on retail data. Dynamic segments help advertisers reach relevant audiences most likely to click and help drive traffic to advertised products. These segments allow advertisers to launch Sponsored Display campaigns quickly and easily to help create product consideration.\n"," For full technical details, please see our updated documentation on Sponsored Display dynamic segments in the Amazon Ads API.\n"," Clients may see increased throttles (429 responses) when calling the Sponsored Display POST report endpoint if they are calling the resource more than 1 TPS per unique combination of clientId and profileId. To avoid rate limiting, please reduce the cadence of API reporting calls. Rate limiting, sometimes referred to as throttling, occurs when the Amazon Ads API receives too many requests within a given time period.  \n"," Rate limiting will occur dynamically based on the overall system load. We encourage users to avoid making reporting requests during high-usage times and to smooth their report creation requests throughout the day. For more information, please visit our documentation on rate limiting in the Amazon Ads API.\n"," Regions: US\n"," Consolidated recommendations are now available through the Amazon Ads API. This new feature identifies up to 5 Sponsored Products campaigns with the most incremental sales opportunities for each advertiser. It provides the suggested bids, budget, and targeting changes created with advanced analytics to maximize sales. You also receive the estimate incremental clicks for each campaign if the recommendations are adopted. The initial launch will cover keyword targeting campaigns and automatic targeting campaigns with one ad-group in the US. \n"," Before this launch, advertisers received recommendations at the campaign level, and did not know which of their campaigns had the greatest incremental sales opportunity. With this launch, Amazon helps advertisers identify the top Sponsored Products campaigns with the most incremental sales opportunity, and provide the consolidated recommendations across bids, budget, and targeting for these campaigns in one place.\n"," Advertisers can retrieve new recommendations on a daily basis using the consolidated recommendations resource. When recommendations are available, this resource includes the campaign identifier, recommendations, and estimated incremental clicks. Advertisers can then modify the recommendations or accept the recommendations using the update campaign or update targeting clause operations. The recommendations are refreshed daily.\n"," With the new budget usage feature, users worldwide can now pull their budget usage percentage in real-time for Sponsored Products, Sponsored Brands, and Sponsored Display using the Amazon Ads API. You can pull budget usage information for both campaigns and portfolios. \n"," Your budget usage percentage helps you understand how fast your campaigns and portfolios are spending daily budgets, and can give you the information needed to make quick budget decisions. \n"," For more information see the Budget Usage resource in the Sponsored Products reference, Sponsored Brands reference, the Sponsored Display reference, or the Portfolios reference.\n"," Regions: AU, IN, MX, and NL\n"," We have expanded suggested bids for Sponsored Display to AU, IN, MX, and NL. These recommendations will now be provided for Sponsored Display views remarketing and product targeting campaigns within the ad console and API for those new regions in addition to the existing regions of CA, DE, ES, FR, IT, JP, UAE, UK, and US. These suggested bids will be added by default in the ad console.\n"," Bid recommendations help remove the guesswork when selecting a bid. Now, when you create any CPC-based or vCPM-based Sponsored Display campaigns with product targeting (products, similar products, and category) or views remarketing in AU, IN, MX, or NL, you will receive machine learning powered bid recommendations. These recommendations are presented as a suggested bid and a bid range, and both are calculated by analyzing a group of winning bids for recent, similar ads within your category. Suggested bid and bid range update daily, based on the increase or decrease in competing bids and ads in each auction. If you are unsure which bid to start with, we recommend advertisers select the suggested bid. This is the bid that our algorithms suggest will most likely help deliver impressions for an ad similar to yours.\n"," For full technical details, please see our updated Sponsored Display documentation or recommendations developer guide.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"May 2022 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Join Amazon Ads for a monthly webinar series on the Amazon Ads API to learn about recent product releases, product deep dives, and upcoming product releases. \n"," North American series - Register Now \n"," European series - Register Now\n"," Today we are announcing plans to deprecate the Amazon Advertising API Sandbox environment. We are targeting end of life on June 28, 2022. We recommend migrating to Advertiser Test Accounts, which are a type of advertiser account dedicated to testing. Test accounts do not serve ads or have active billing, allowing integrators to make API requests to test and learn about API functionality in a similar experience to production accounts, as well as access the ads console from a test account to see your API updates reflect in ads console experience. For more information on these test accounts, please see our test accounts overview. If you would like to share feedback, please contact us through the Amazon Ads API Support webpage with ticket subject title \"Sandbox Deprecation\" by June 14, 2022.\n"," Amazon Ads is launching a Postman collection to help get started with the Amazon Ads API. Postman is a third-party tool that allows you to make API calls using a graphical user interface. The Amazon Ads API Postman collection includes common endpoints, example request/responses, and automations that make it easy to test the API and manage authorization. The collection currently supports endpoints related to sponsored ads reports and snapshots, test accounts, and authorization. You can find the collection files in the new GitHub repository for advanced tools docs. \n"," To use the collection, download the collection and environment files from GitHub, input your Amazon Ads API credentials, and start sending requests--no code necessary. \n"," For full technical details, please read our Postman guide.\n"," You can now interact with the Amazon Ads API on Github in our ads-advanced-tools-docs repository. This repository will be home to Postman collections, code artifacts, and other resources to supplement the documentation in the advanced tools center. \n"," Developers are encouraged to open issues on the repository to make suggestions and report problems related to the documentation. Our team will monitor incoming issues to continuously improve the documentation.\n"," To stay up to date on the latest additions, add yourself to the repository as a watcher.\n"," New-to-brand metrics are now available for Sponsored Display campaigns with view-based attribution (vCPM) through the Amazon Ads API. New-to-brand metrics enable you to measure orders and sales of your products generated from first-time customers of your brand. With new-to-brand metrics, you can better measure and optimize in-flight campaigns and plan future marketing strategies to drive customer acquisition and brand loyalty. New customer orders are a key step in establishing a long-term brand relationship with customers.\n"," An order is considered new to your brand if a shopper has not purchased one of the products from your brand in the past 12 months. The following campaign performance metrics are available: new-to-brand sales, new-to-brand orders, and new-to-brand units. Using these metrics, you can calculate the cost to acquire a new-to-brand customer using view-based attribution for campaigns with a costType of vCPM. \n"," For full technical details and to see the new metrics that include viewAttributedSalesNewToBrand14d, viewAttributedOrdersNewToBrand14d, and viewAttributedUnitsOrderedNewToBrand14d, please see our updated reporting documentation.\n"," Starting on June 1, 2022, Sponsored Display will no longer support reporting calls for the legacy remarketing or T00001 tactics on the Amazon Ads API. All of these campaigns were archived in 2021 and reporting data is only available up to 60 days back from the current date via the API. Going forward, Sponsored Display advertisers should only use reporting calls for the audiences strategy via tactic T00030 or product targeting via tactic T00020. \n"," As a reminder, Sponsored Display audiences and product targeting can be used together to help engage shoppers at all stages of the purchase journey. Used together, these strategies can help drive awareness and consideration for your brand as well as product sales.\n"," For more information, see our updated reporting documentation.\n"," Regions: US, UK, DE, JP, FR, IT, ES, CA, MX, AU, AE, BR, NL, IN, SA, SE, TR\n"," Note: Whole Foods Market audience creation is only available in the US.\n"," Amazon Ads API users can now create custom Product and Whole Foods Market audiences for use in Amazon DSP campaigns. To build their audiences, users can choose from the available attributes and use a custom lookback window, listed below. The onboarded audiences are seamlessly available within the advertiser Amazon DSP account. \n"," Attributes:\n","Product: Purchases, Views, Similar Product Views, Searches \\* Whole Foods Market: In-store purchases\n"," Lookback windows:\n","Up to 365 Days: Product Purchases, Whole Foods Market In-store purchases  \\* Up to 90 Days: Product Views, Similar Product Views, Product Searches \n"," This feature is available through the Amazon Ads API. To learn more, please see the audience creation API documentation.\n"," Regions: BR, CA, MX, US\n"," Amazon DSP now supports the ability to read, add, and remove domain targeting on line items via the Amazon Ads API. This release brings parity for domain targeting with the Amazon DSP console and enables users to specify inventory for their campaigns. Domains can be either included or excluded. \n"," This API includes four different methods for domain targeting:\n","Inherit existing domain targeting from the advertiser level. 2. Add one or more existing domain lists from the entity level. 3. Add or remove individual domains at the line item level. 4. Upload a comma-separated values (CSV) file of domains using the file uploads resource.\n"," See the Domain Targeting reference documentation for more details. \n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"April 2022 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Sponsored Brands bid suggestions for product attribute targeting and keywords campaigns support has been expanded to additional regions and ad formats: \n","Keyword Static campaigns in: BR, NL, SG, SE;   Keyword Video campaigns in: CA, MX, JP, AU, UK, IT, ES, FR, DE, AE, IN, NL, SG, SE;   Product Targeting Video campaigns in: CA, MX, JP, UK, IT, ES, FR, DE, IN\n"," Bid suggestions are based on historical winning bids of impressions and auction data. This feature provides advertisers with suggested bids as well as a bid range which can help them rank higher in auctions and receive impressions, reducing the complexity associated with manual bidding optimization. This launch expands this feature to smaller marketplaces that previously required Advertisers to use manual bidding optimization. For more information, see the Sponsored Brands suggested bid and bid range reference.\n"," Sponsored Brands APIs that previously supported bid recommendations for product collection or Stores spotlight ad formats only now support video formats as well. Previously, bid recommendations US was the only marketplace, that supported bid recommendations for the video creative. This launch extends this feature for many more marketplaces, allowing more advertisers to reduce their efforts when opting for video ads. For full technical details, please refer to our updated reference documentation.\n"," The following API has been updated to support this launch:\n","/sb/recommendations/bids marketplace support has expanded to include bid suggestions for video creative ads for additional marketplaces. Specify the adFormat property in your request to specify the video creative type. This ad format was previously available and limited to US marketplace only. \n"," Vendors and Sellers using the Amazon Ads console can now search for and reuse existing creative assets to build their Sponsored Display campaigns. This means you can easily reuse creative you have already uploaded as a part of their Sponsored Brands, Stores, or Posts efforts within your Sponsored Display campaigns.\n"," Integration with creative assets allows you to build Sponsored Display campaigns quickly, as well as provide a consistent shopping experience across your Amazon Ads campaigns. When adding a logo or custom image to a Sponsored Display campaign, you can select “Choose from assets” instead of “Upload image” to browse and reuse existing creatives assets. To help you browse, you can search, sort and filter by name, tag products, and other attributes to find assets easily. Search results can be further narrowed by filtering and sorting by asset types (logo, custom, or product image), upload date, file format, file size, dimension, moderation status, and more. Any brand content you upload to a Sponsored Display campaign will also be saved to creative assets for easy reuse later on.\n"," For full technical details, please see our updated Sponsored Display documentation in the Amazon Ads API and our Sponsored Display creative developer guide to learn more about uploading assets to creative assets.\n"," The operation is in preview only. We will update our release notes once this functionality becomes available. Sponsored Display will be enhancing its creative offering by allowing video formats, empowering advertisers to showcase their products and brand through immersive storytelling made possible via video (for example, tutorials, demos, unboxing, and testimonials). Advertisers will be able to build awareness and consideration of their products and brand off Amazon more effectively using a video ad format. \n"," For full technical details, see our preview of the new creativeType for adGroups in our Sponsored Display documentation. \n"," Join Amazon Ads for a monthly webinar series on the Amazon Ads API to learn about recent product releases, product deep dives, and upcoming product releases. \n"," North American series - Register Now \n"," European series - Register Now\n"," We also offer a recording of our latest Amazon Ads API product updates webinar in the Partner Network. You can access the recording here via your Partner Network account and view on demand. \n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"March 2022 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Join Amazon Ads for a monthly webinar series on the Amazon Ads API to learn about recent product releases, product deep dives, and upcoming product releases. \n"," North American series - Register Now \n"," European series - Register Now\n"," We also offer a recording of our latest Amazon Ads API product updates webinar in the Partner Network. You can access the recording here via your Partner Network account and view on demand. \n"," Regions: All (excluding IN)\n"," We are launching Amazon Ads API test accounts for the Sponsored Products and Sponsored Brands APIs. Advertising test accounts are a type of advertising account dedicated to testing. Test accounts do not serve ads or have active billing, allowing integrators to make API requests to test and learn about API functionality. Our first milestone includes test account types based on vendor and author advertisers.\n"," The test account creation API enables users to provision an advertising test account, which can then be used to test API functionality. \n","POST /testAccounts allows test account creation - GET /testAccounts retrieves information about created test accounts\n"," For more information on the test accounts API and the use of advertising test accounts, please see our test accounts overview. \n"," Regions: US, CA, ES, FR, IT, DE, UK, AE, JP, IN, AU, NL, BR, MX\n"," Matched target reporting is now available for Sponsored Display vendors and sellers registered in Amazon Brand Registry. With the release of this report, advertisers can dive deep into performance based on the product detail page where an ad is displayed.\n"," The matched target report gives visibility into which ASINs and related product detail pages your ads appeared on and resulted in at least one click. For example, if you are using Sponsored Display product targeting to help reach audiences within a specific category like “running shoes,” you can not only analyze performance at the targeting clause level (i.e., the “running shoes” category), but also break down performance based on the product detail pages where your ads appeared within that category. You can use this data to harvest new product targeting options and refine your Sponsored Display product targeting strategy. \n"," Use the segment parameter with the value matchedTarget to segment campaign, ad group, or target reports to include the ASIN associated to the product page where your ads appeared. Note that the matched target report only includes ASINs of product pages with at least one ad click. Data in the matched target report is available from March 1, 2022; data available before that date may be incomplete. For full technical details, see our updated Sponsored Display documentation.\n"," We have added support for Turkey (TR) to the API. For more details, see API endpoints, bid constraints by marketplace, the countryCode parameter of the registerProfile and registerBrands operations, and the regional profile time zone codes section of the profiles reference.\n"," Regions: AE, AU, BR, CA, DE, ES, FR, IN, IT, JP, MX, NL, SA, SG, UK, US\n"," New-to-brand and detail page view metrics are now available for Sponsored Brands video campaigns for vendors and sellers registered in Amazon brand registry. New-to-brand metrics provide the number of first-time purchases for promoted products within the brand over a one-year lookback window. With new-to-brand metrics, advertisers receive campaign performance metrics such as total new-to-brand purchases and sales, new-to-brand purchase rate, and cost per new-to-brand customer. Detail page view metrics help you understand how many shoppers are visiting your product pages as a result of your sponsored brands campaigns. These metrics are calculated based on the number of detail page views generated within a 14-day attribution window.\n"," With this launch, we are introducing a new advertising report that enables you to query ad-level performance metrics. In addition, there is a new optional value called all for creativeType that allows you to query both non-video and video campaigns. For the ads report type, creativeType can only be all (null or video is not allowed).\n"," For more information see our updated Sponsored Brands documentation. These new metrics are available for campaign, ad group, target, and ad reports.\n"," We released a list of all Sponsored Display features and their availability by marketplace. This content will help you understand what each feature does, what regions it is supported in, and what API resource corresponds to the feature. You can find this list under Sponsored Display > Features support by marketplace.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"February 2022 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Join Amazon Ads for a monthly webinar series on the Amazon Ads API to learn about recent product releases, product deep dives, and upcoming product releases. \n"," North American series - Register Now \n"," European series - Register Now\n"," We also offer a recording of our latest Amazon Ads API product updates webinar in the Partner Network. You can access the recording here via your Partner Network account and view on demand. \n"," Regions: US, CA, UK, IT, FR, ES, DE, AE, JP\n"," We have launched suggested bids for Sponsored Display vCPM-based campaigns. These recommendations will be provided for Sponsored Display views remarketing and product targeting through the Amazon Ads API across CA, DE, ES, FR, IT, JP, AE, UK, and the US.\n"," Bid recommendations help remove the guesswork when selecting a bid. Now, when you create any CPC-based or vCPM-based Sponsored Display product targeting or views remarketing campaign, you will receive machine learning-powered bid recommendations. These recommendations are presented as a suggested bid and a bid range, and both are calculated by analyzing a group of winning bids for recent, similar ads within your category. Suggested bid and bid range update daily, based on the increase or decrease in competing bids and ads in each auction. If you are unsure which bid to start with, we recommend advertisers select the suggested bid; this is the bid that our algorithms suggest will most likely help deliver impressions for an ad similar to yours.\n"," For full technical details, please see our updated Sponsored Display documentation or recommendations developer guide.\n"," We released new overview and tutorial content that covers the reporting capabilities of the Amazon Ads API. This content will help you understand API reporting concepts and request your first report. You can also view a consolidated list of report types and metrics for Sponsored Products, Sponsored Brands, and Sponsored Display. It will also help you differentiate between API and advertising console reports.\n","Find all reporting content under Concepts > Reporting.\n"," We also added new documentation that introduces the snapshot feature of the Amazon Ads API. You can use this content to learn about requesting snapshots and how snapshots relate to reports.\n","Find all snapshots content under Concepts > Snapshots.\n"," Regions: US\n"," We are launching capabilities to manage third-party Amazon DSP display creatives through the Amazon Ads API. These capabilities are launching in beta in the United States. \n"," The campaign management third-party creative feature enables you to create, read, update, and retrieve HTML used to generate a preview for third-party-served display creatives. You can integrate Amazon DSP creative management capabilities with your existing Amazon Ads API-enabled applications. \n","POST /dsp/creatives/thirdparty creates one or more third-party creatives.  GET /dsp/creatives/thirdparty retrieves one or more third-party creatives.  PUT /dsp/creatives/thirdparty updates one or more third-party creatives. \\* POST /dsp/creatives/thirdparty/preview posts a request to retrieve HTML content that can be used to create a preview for a third-party creative.\n"," For more information on third-party creatives please see the Help center.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"January 2022 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Theme-based bid suggestions, the next-generation bid suggestion service, helps advertisers choose a bid that aligns with their campaign goals. Bid suggestions include historical impact metrics based on similar products, and they help in choosing the right bid for the campaign. \n"," The first theme released provides suggested bids to generate sales. Metrics included in the response are weekly clicks and purchase orders received by similar products. For example, advertisers looking to generate more sales will call this API endpoint to get bid suggestions from the sales theme. They can then decide which bid to use based on historical results of similar products. \n"," The theme-based bid suggestion for sales helps you set up performant campaigns by providing bid suggestion transparency. You can now look at historical impact metrics that accompany suggested bids. You can request bid suggestions for new campaigns or for existing ad groups. The suggested bids are returned at the targeting clause level and the impact metrics are aggregated at the ad group level.\n"," For full technical details, please see the theme-based bid suggestions documentation or view the quick-start guide.\n"," Regions: All\n"," You can now enable pre-bid filtering for invalid traffic on Amazon owned-and-operated and third-party supply worldwide using Pixalate, on the line item settings page. Pixalate can block invalid traffic from IPv4 and IPv6 addresses, user agents and device identifiers on Streaming TV, mobile or web supply, and mobile apps that were removed from the Google Play or Apple App stores in the last six months.\n"," Enabling invalid traffic pre-bid filtering prevents you from running on supply that Pixalate deems invalid. This product can filter both general invalid traffic and sophisticated invalid traffic. \n"," This feature is available in version 3.1 of the line item resource for STANDARD_DISPLAY, AAP_MOBILE_APP, AMAZON_MOBILE_DISPLAY, and VIDEO line item types. It can be found in the Pixalate property under the targeting object. For full technical details, please select version 3.1 of the /dsp/lineItems resource using the Media type dropdown in our updated reference documentation. \n"," Amazon DSP campaign management APIs now support the Media Rating Council definition of viewability targeting using Pre-Bid by Moat Viewability. The objective and purpose of the Media Rating Council can be found on the Media Rating Council home page. This feature is available through the Amazon Ads API in the United States for standard display, mobile app, and video line items running on third-party supply sources. By enabling pre-bid viewability targeting, advertisers can target the appropriate viewability tier (20%+, 30%+, 40%+, 50%+, 60%+, 70%+, 80%+). Driven by Oracle Data Cloud industry-leading global measurement footprint, Pre-Bid by Moat Viewability can hep you reach/access viewable inventory down to the ad-size level. \n"," This feature is available in versions 3.0 and 3.1 of the line item resource for STANDARD_DISPLAY, AAP_MOBILE_APP, and VIDEO line item types. It can be found in the oracleDataCloud property under the targeting object. For full technical details, please select version 3.0 or 3.1 of the /dsp/lineItems resource using the Media type dropdown in our updated reference documentation. \n"," Amazon DSP campaign management APIs now support Oracle Data Cloud standard predicts product in the United States. Predicts is a contextual targeting feature that allows brands to capitalize on trending content and the associated inventory in real time, helping to drive greater relevancy and reach. Predicts helps you achieve your reach goals by dynamically expanding static keyword based targeting segments in real time on a daily basis and receiving impressions as the conversation evolves. This feature is available through the Amazon Ads API in the US for standard display, mobile app, and video line items running on third-party supply sources. Oracle standard predicts segments are built and maintained by Oracle. Oracle custom predicts segments are custom built and maintained by brands and agencies themselves, or with the help of Oracle.\n"," This feature is available in version 3.1 of the line item resource for STANDARD_DISPLAY, AAP_MOBILE_APP, and VIDEO line item types. It can be found in the oracleDataCloud property under the targeting object. For full technical details, please select version 3.1 of the /dsp/lineItems resource using the Media type dropdown in our updated reference documentation. You can also refer to the discovery endpoint /dsp/preBidTargeting/oracleDataCloud/standardPredicts to retrieve standard predict pre-bid targeting data.\n"," Join Amazon Ads for a monthly webinar series on the Amazon Ads API to learn about recent product releases, product deep dives, and upcoming product releases.\n"," North American series: Register Now\n"," European series: Register Now\n"," We also offer a recording of our latest Amazon Advertising API product updates webinar in the Partner Network. You can access here via your Partner Network account and view on demand. \n"," Regions: US, CA, JP, DE, UK, FR, IT, ES, IN, AU\n"," Amazon Ads API users can now use the hashed records feature to ingest their owned audience records and create their own audiences for their Amazon DSP campaigns. Advertisers can further programmatically create audiences by using the data provider feature with their hashed audiences.\n"," With the hashed records feature, users can choose from the different attributes to create their own audiences and use them in their Amazon DSP campaigns. The onboarded audiences are seamlessly available within the Amazon DSP account of the advertiser.\n"," This feature is available through the Amazon Ads API. To learn more, please see the hashed records API documentation.\n"," We have added support for Poland (PL) to the API. For more details, see API endpoints, bid constraints by marketplace, the countryCode parameter of the registerProfile and registerBrands operations, and the regional profile time zone codes section of the profiles reference.\n"," Regions: AU, NL, MX\n"," We have expanded bid optimization controls for Sponsored Display campaigns to AU, NL, and MX. You can now select \"Optimize for viewable impressions\", \"Optimize for page visits\", or \"Optimize for conversions\" and your campaigns will be optimized to help drive viewable impressions, page visits, or conversions for all audiences and product targeting campaigns across CA, DE, ES, FR, IT, JP, UAE, UK, MX, NL, AU, and the US.\n"," Custom bid optimizations allow you to select bid optimizations based on campaign needs and helps you evaluate performance based on viewable impressions, clicks, or conversions. This means you can complement your targeting selection and creative customization with appropriate bid optimizations to meet your needs. You now have more controls over your campaigns and are no longer restricted by pre-defined bid optimizations. All existing campaigns in the expanded regions will default to \"Optimize for page visits\". These new flexible controls enable you to help you more effectively introduce new products, drive traffic, and engage new or existing shoppers.\n"," For full technical details, including each bidOptimization available through the Amazon Ads API, please see our updated Sponsored Display documentation.\n"," Regions: US, CA, MX, UK, DE, FR, IT, ES, JP, IN, AU, NL, AE, SG, SA, BR\n"," Sponsored Brands now offers bidding by placement groups controls for advertisers to better execute brand advertising strategies. The new capability gives advertisers more granular bidding controls over the various placements where their ads are shown. Advertisers can now adjust bids for detail pages, home pages, and other placements. You can optimize placement groups to help with your campaign performance and marketing goals. Please note that the video ad format is not supported, at this time.\n"," The following APIs have been updated to support bidding by placement groups for Sponsored Brands campaigns:\n","/sb/campaigns and /sb/draft/campaigns now support bid adjustment at placement group level. \\* /v2/reports now supports campaign placement level granularity at placement group level.\n"," For full technical details, please refer to our updated Sponsored Brands Ads API reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"December 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We have started enforcing a 5000-record limit in the response to GET requests for profiles. This limit was previously documented in our developer notes but was not regularly enforced. We are making this change to improve the performance of this endpoint. While we have already reached out to all application owners impacted by this change, if you have any questions please contact our support team via our help desk or your Amazon representative.\n"," We are introducing a new version of reporting endpoints for Amazon DSP. Users can now retrieve reports for advertiser accounts linked to their manager accounts. With this change, advertisers can grant an application access to their DSP advertiser accounts without granting access to the corresponding entity. This improvement enables advertisers that leverage Amazon DSP managed service model to retrieve reports via the API. This new version of the DSP reporting API also introduces simplifications to the developer experience. For example, it does not require a scope header and it can be used with profile endpoint. We made this simplification as part of a larger effort to improve the user experience for authorization.\n"," Developers will notice the new DSP reporting API does not require an Amazon-Advertising-API-Scope header. The new version of DSP reporting includes an accountid URL parameter, and this value can a DSP entity identifier or a DSP advertiser identifier. In the future, the parameter will also support manager account identifiers. Your entity identifier is available from the Amazon DSP web interface.\n"," To learn more about this new experience, see the accountId parameter for each of the resources in the new DSP reporting API documentation.\n"," Regions: US\n"," We are launching capabilities to manage first party Amazon DSP video creatives through the Amazon Advertising API. These capabilities are launching as a beta in the US, at this time.  The campaign management video creative feature enables you to create, read, update, and retrieve HTML used to generate a preview for first party served video creatives. You can integrate Amazon DSP creative management capabilities with your existing API-enabled applications.\n","POST /dsp/creatives/video Create one or more video creatives.  GET /dsp/creatives/video Retrieve one or more video creatives.  PUT /dsp/creatives/video Update one or more video creatives. \\* POST /dsp/creatives/video/preview Post a request to retrieve HTML content that can be used to create a preview for a video creative.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"November 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Sellers and vendors worldwide can now copy and localize advertised products (ASINs/SKUs) from one geography to any combination of countries where Amazon Advertising is available. This is an enhancement to the existing LocalizeProduct API, which was previously only available to localize products across France, Germany, Italy, Spain and the United Kingdom or Canada, Mexico and the United States. This API also checks that the product is eligible for advertising by the advertiser in the target country before localizing the product. \n"," This feature can be used alongside the existing keyword localization, targeting expression localization, currency localization, and profiles APIs. This will help you create Sponsored Products auto or manually targeted campaigns in different countries with minimal effort or local language knowledge. You can take campaign parameters (product targets, keywords, budget, bids and ASINs/SKUs) from one country and localize the parameters to launch campaigns in other countries. \n"," Learn more by reading our reference documentation.\n"," Sellers and vendors worldwide can now copy and localize keywords from one geography to any combination of countries where Amazon Advertising is available. This is an enhancement to the existing keyword localization API, which previously was only available to translate keywords across Chinese, English, French, German, Italian, and Spanish, but now works across additional language combinations where Amazon Advertising is available. Please see the reference documentation for a full list of available languages. This API previously used a machine translation service to translate keywords, but for enhanced keyword translation it now leverages a machine-learning algorithm that uses a combination of similarity between words and Amazon Advertising and search data to find the best matching keyword in the target country. \n"," This feature can be used alongside the existing product localization, targeting expression localization, currency localization, and profiles APIs. This will help you create Sponsored Products manually targeted campaigns in different countries with minimal effort or local language knowledge. You can take campaign parameters (keywords, product targets, budget, bids and ASINs/SKUs) from one country and localize the parameters to launch campaigns in other countries. \n"," Learn more by reading our reference documentation.\n"," Regions: US\n"," We are launching capabilities to manage responsive eCommerce creatives, and retrieve your creative moderation status. These capabilities are launching as a beta in the US, at this time. \n"," The campaign management responsive eCommerce creative feature enabled advertisers to create, read, update, and retrieve HTML used to generate a preview first party served responsive eCommerce creatives through APIs.\n"," The campaign management creative moderation status API enables advertisers to retrieve the moderation status of creatives. Responses include: approved, approved with exceptions, waiting for line item, not approved, and pending. These new capabilities are built to achieve full parity with the Amazon DSP console. They enable you to save time and may increase business efficiency by automating manual creative management tasks. You can integrate Amazon DSP creative management capabilities with your existing API-enabled applications.\n","POST /dsp/creatives/rec/preview: Post a request to retrieve HTML content that can be used to create a preview for a Responsive eCommerce creative  POST /dsp/creatives/rec: Create one or more Responsive eCommerce creatives  GET /dsp/creatives/rec: Retrieve one or more Responsive eCommerce creatives  PUT /dsp/creatives/rec: Update one or more Responsive eCommerce creatives  GET /dsp/moderation/creatives: Retrieves the moderation status of a creative\n"," Detail page view metrics are now available for Sponsored Display campaigns for vendors and sellers registered in Amazon Brand Registry. Detail page views help you understand how many shoppers are visiting your product pages as a result of your Sponsored Display campaigns and are calculated based on the number of advertising attributed detail page views generated from a campaign that occurred within a 14-day attribution window.\n"," For more information see our updated Sponsored Display documentation, including the newly available metrics of attributedDetailPageView14d with click attribution for CPC campaigns and viewAttributedDetailPageView14d with click or view attribution for vCPM campaigns. These new metrics are available for campaign, adGroup, productAd, and target reports. \n"," With this launch, we added customizable lookback windows for both views and purchases remarketing audiences. For each audience, advertisers can now specify time periods of 7, 14, 30, 60, or 90 days to include shoppers who performed the action of visiting a detail page or purchasing a product. For remarketing audiences that purchased a product, we are further extending to time periods of 180 and 365 days so advertisers can reach even more shoppers who purchased exact products, similar products, categories, and refined categories. We recommend using new-to-brand metrics to better measure and optimize in-flight Audiences campaigns to drive customer acquisition and brand loyalty.\n"," For full technical details, please see our updated Sponsored Display documentation, including the new purchases targeting with custom lookback windows that can be used with Audiences campaigns. For additional examples, please visit our Audiences developer guide.\n"," With this launch, vendors can create ad groups to better organize and manage Sponsored Display campaigns. Advertisers can use ad groups to organize their ads based on brand, product, category, price range, or other classifications like theme or targeting strategy. \n"," Previously, an error was returned if an account associated with a vendor attempted to create a campaign that included multiple ad groups. With this change, both vendors and sellers can specify multiple ad groups in campaign creation and update operations. \n"," For more information, see our Sponsored Display documentation.\n"," Join Amazon Ads for a monthly webinar series on the Amazon Ads API to learn about recent product releases, product deep dives, and upcoming product releases. \n"," North American series - Register Now \n"," European series - Register Now\n"," We also offer a recording of our latest Amazon Ads API product updates webinar in the Partner Network. You can access here via your Partner Network account and view on demand. \n"," Regions: US\n"," Sponsored Brands now offers bidding controls to maximize new-to-brand customers in advertiser campaigns. The new bid optimization strategy allows advertisers to choose between maximizing immediate sales, which is the default campaign behavior, or maximizing new-to-brand customers. The new bid adjustment allows advertisers to set higher bids for shoppers that have not purchased from their brand before. Please note that video ad format is not supported at this time. \n"," The following APIs have been updated to version 3.3 to support bid optimization strategy and bid adjustment for new to brand customers on Sponsored Brands: \n","/sb/draft/campaigns \\* /sb/campaigns\n"," For full technical details, please select version 3.3 of each resource using the Media type dropdown in our updated reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"October 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Marketplaces: US, CA, FR, IT, DE, ES, UK\n"," We are expanding Sponsored Display on Twitch to help brands better reach audiences throughout the shopping and entertainment journey. In addition to reaching audiences on Twitch browse tab and directory pages with display ads, brands that use Sponsored Display will now be able to reach Amazon audiences with display ads on Twitch channels, during a creator livestream, for the first time. These display ads are integrated seamlessly to Twitch livestreams, allowing brands to engage viewers without disrupting the streaming experience.\n"," Twitch is a video streaming service with a hyper-engaged audience of over 30 million average daily visitors, nearly half of which are ages 18 to 34. Now any brand using Sponsored Display audiences in the US, CA, FR, IT, DE, ES, or UK can better help build their brand with new creative experiences and additional opportunities to engage or re-engage hard-to-reach, relevant Twitch audiences during their video viewing experience. For more information, see our recent launch announcement.\n"," Regions: US\n"," Advertisers can now design, launch, and view reporting of Amazon Brand Lift studies from within the Amazon DSP console and through the Amazon Ads API. Amazon Brand Lift helps advertisers quantify how their Amazon Ads campaigns are driving marketing objectives such as awareness, purchase intent, and ad recall. Amazon Brand Lift is powered by the Amazon Shopper Panel, an invitation-only, opt-in program where participants can earn monthly rewards by choosing to share receipts from purchases made outside of Amazon.com or complete short surveys from within a standalone mobile app.\n"," Amazon Brand Lift is an easy, insightful, and privacy-safe way for advertisers to quantify the impact of upper and mid-funnel campaigns. With participation of the sizable, representative, and engaged Amazon Shopper Panel community, Amazon Brand Lift helps provide objective and concrete measurement results. The reporting provides insights such as how much an advertiser campaign has impacted the percentage of respondents who report being aware of a brand or interested in purchasing from a brand.\n"," To create, manage, and retrieve results for their Amazon Brand Lift studies, please use the following endpoints:\n","Create study: POST/dsp/measurement/studies/brandLift  Update study details: PUT/measurement/studies/brandLift  Get results: GET/measurement/studies/brandLift/{studyId}/result\n"," Learn more about the Amazon Brand Lift APIs in our technical documentation.\n"," Regions: US, CA, UK, IT, FR, DE, ES, JP\n"," Brand Metrics is a new measurement solution that quantifies opportunities for your brands at each stage of the customer journey on Amazon, and helps brands understand the value of different shopping engagements that impact stages of that journey. With Brand Metrics you can now access awareness and consideration indices that compare brand performance to peers using models predictive of consideration and sales. Brand Metrics is built at scale to measure all shopping engagements with your brand on Amazon, not just ad-attributed engagements and quantifies the number of shoppers in the awareness, consideration, and purchase stages of the shopping journey with your brand. Brand Metrics also provides Return on Engagement, so you can measure the average historical sales following a consideration event or purchase.\n"," Brand Metrics helps you...\n","Understand your brand performance. Brand Metrics measures the number of actual on-Amazon shopper engagements.  Measure the impact of your upper and mid funnel tactics to see how they contribute to shoppers moving through the purchase journey.  Evaluate engagement metrics to understand the value of your branded intent, and how brand purchasers go on to generate additional sales in the 12 months following a purchase.  Monitor your performance relative to your category and peers at each stage of the purchase journey and over time.  Optimize your marketing and advertising efforts on Amazon to engage more shoppers and build your brand.\n"," This release features two new endpoints - /insights/brandMetrics/report and /insights/brandMetrics/{reportId} to generate and retrieve Brand Metrics report in CSV or JSON format.  With these endpoints the developers can now create customizable reports by passing in a date range, a brand name, or by passing in specific metrics from a list of brand metrics.\n"," For full technical details please see our overview and Brand Metrics reference documentation in the Amazon Ads API.\n"," Advertisers worldwide can now set up budget rules for their Sponsored Products, Sponsored Brands, and Sponsored Display campaigns through the Amazon Ads API. Budget rules help you plan budget changes in advance so you can spend less time manually adjusting during a campaign. You can set rules based on specific dates or performance goals.\n"," Schedule-based budget rules can be set to increase daily budgets for any date range or for recommended events such as holidays or peak shopping events. For shopping events, we will provide recommended budgets based on historical shopping activities. Performance-based budget rules can be set to increase budgets based on campaign performance metrics. With budget rules, advertisers can reduce the likelihood of campaigns running out of budget, especially during peak days or holiday events. \n"," Visit our overview pages to learn more: Sponsored Products Budget Rules overview, Sponsored Brands Budget Rules overview, Sponsored Display Budget Rules overview.\n"," We have added support for Sweden (SE) to the API. For more details see the API endpoints and keyword bid constraints by marketplace sections of the overview, the regional profile time zone codes section of the profiles reference, and the countryCode parameter of the registerProfile and registerBrands operations.\n"," The Sponsored Brands API version has been updated from 3.0 to version 3.2. Currently in 3.0, in GET Store Spotlight campaign API call, Store Spotlight campaigns are returned as Product collection. Now in 3.2, the same GET call for Store Spotlight will return the campaign as Store Spotlight.\n"," With this version bump, the advertisers can now create and manage Store Spotlight campaigns for their accounts. The integrator has a choice to specify in the header which version. In GET Store Spotlight call, if the header is not specified, the 3.2 or latest version will be returned (Store Spotlight will return as Store Spotlight). In the header, if version 3.0 is specified, Store Spotlight will return as Product Collection.\n"," Learn more about the Sponsored Brands API in our technical documentation.\n"," With custom images in Sponsored Brands, you can engage shoppers browsing on Amazon with ads that feature rich imagery to tell your brand story. Custom images can include photos representing your brand or your product in use. These new images can help drive engagement. Ads in this beta may display a custom image, brand logo, and products.\n"," With Stores spotlight ads, you can promote Stores subpages and product categories. This lets you feature Amazon Stores pages where shoppers can discover different product collections. You can showcase up to three subpages and will have the ability to customize the headline along with the subpage image and labels.\n"," You can now build custom image and Stores spotlight campaigns through the existing campaigns resources as an optional add-on. Learn more in our Sponsored Brands reference documentation , Sponsored Brands ads).  Learn more about the Sponsored Brands API in our technical documentation.\n"," Creative asset library has launched its newest API. Creative asset library is a new centralized digital asset management and content serving solution for brands to store, organize, and reuse content across Amazon Ads, Amazon Retail, and for our partners.  With this release, you can use the CreativeAssets APIs to upload images for Ad Program and Register the uploaded asset to reuse them.\n"," The creative asset library supplies fresh and fully-optimized brand content that powers consistent shopper experiences.  Once moderated and approved, assets in the library can be easily reused for new ad campaigns.\n"," The creative assets library is available through the Amazon Ads API. We introduced three new features to help you manage your creative assets.  Learn more in our technical documentation in the links below: \n","/assets/upload returns a URL to upload an image or video asset to the chosen Creative assets library.  /assets/register allows you to add custom tags and other metadata to assets to aid in asset management and usage.  /assets/search returns a list of assets that meet the criteria specified in the request. \\* /assets returns detailed information on a single asset, including versions, metadata, and tags.\n"," Learn more about creative assets in our product documentation.\n"," Self-service Amazon DSP customers such as advertisers, agencies, and tool providers can now leverage the campaign management creative image API to programmatically create, read, update, and preview image creatives in the Amazon DSP.\n"," The Amazon DSP campaign management image creative API enables customers to save time and may increase business efficiency by automating manual creative management tasks. Users can also integrate Amazon DSP creative management with the same tools or solutions used to manage other marketing channels, and the seller/vendor business for endemic advertisers.\n","POST/dsp/creatives/image: Creates one or more image creatives  GET/dsp/creatives/image: Get image creative(s)  PUT/dsp/creatives/image: Updates one or more image creatives \\* POST/dsp/creatives/image/preview Preview Image creative\n"," For more information on creatives please see the Help Center.\n"," Sponsored Display support for portfolios enables advertisers to group and organize Sponsored Products, Sponsored Brands, and Sponsored Display campaigns into collections that mirror the structure of their business. This functionality is now extended to Sponsored Display campaigns using the new bid optimization \"Optimize for Viewable Impressions\". You can measure the success of these new campaigns by leveraging metrics like viewable impressions and vCPM.\n"," With portfolios, you now have the flexibility to arrange campaigns in a way that is meaningful for you, such as by brand, product category, or season across all self-service ad products. A key advantage portfolios offer is control over spend across campaigns. Once your portfolio budget is exhausted, all campaigns in that portfolio will automatically pause until you choose to reactivate them by increasing your portfolio budget.\n"," For full technical details, please see our updated Sponsored Display documentation in the Amazon Ads API, including the portfolioId that can be associated to each campaign.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"September 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We are expanding Sponsored Display custom-built audiences with purchases remarketing to help advertisers drive repeat purchases and cultivate brand loyalty. The purchases remarketing strategy helps reach audiences based on historical purchase behaviors on Amazon. Advertisers can now remarket to shoppers who previously purchased their own products, related products, or products from specific retail categories. Like other custom-built audiences, advertisers can choose to refine targeting based on product insights, such as price and star rating.\n"," With this launch, we also added customizable lookback windows for both views and purchases remarketing audiences. For each audience, advertisers can specify a time period of 7, 14, or 30 days to include shoppers who performed the action (visited a detail page or purchased a product).\n"," Vendors and brand registered sellers are now better equipped to help drive brand and product loyalty using Sponsored Display. Advertisers can now leverage purchases remarketing audiences to encourage repeat purchases by remarketing to existing purchasers. This release also helps drive product consideration by cross-selling to audiences who recently bought related products. \n"," For full technical details, please see our updated Sponsored Display documentation in the Amazon Ads API, including the new purchases targeting with custom lookback windows that can be used with Audiences campaigns. For additional examples, please visit our Audiences Developer guide.\n"," Advertisers using Sponsored Display in US, CA, UK, DE, ES, FR, IT, AE, JP, IN, AU, NL, MX, and BR can now add or edit their headlines, logos, or custom product images for existing campaigns. After editing campaign creative, Sponsored Display campaigns will continue to serve the most recent approved creative, so campaign delivery will not be interrupted while new submissions await moderation approval. If your recent edit is rejected, the previously approved version will continue to serve. This allows you to edit and update images, headlines, and logos without worrying about moderation rejections disrupting your campaign delivery.\n"," Advertisers can optimize campaign creative to better tell their story without having to create new campaigns or pause delivery. Rather than create new campaigns to reflect updated imagery, headlines, or logos, advertisers will be able to refresh or edit campaigns with creative elements based on their brand strategy, learnings, or seasonal relevance.\n"," For full technical details, please see our updated Sponsored Display documentation in the Amazon Ads API and our Sponsored Display creative developer guide to learn more about uploading or editing assets.\n"," Sponsored Display product targeting and audiences are now available through the Amazon Ads API for vendors and sellers registered in Amazon Brand Registry in Brazil. As a reminder, Sponsored Display audiences and product targeting can be used together to help reach shoppers at all stages in the shopping journey. Audiences and product targeting help you reach shoppers while they browse and shop on Amazon, and used together these strategies can help drive awareness, consideration, and conversion. \n"," We recommend using new-to-brand metrics to better measure and optimize in-flight audiences campaigns to drive customer acquisition and brand loyalty. You can help increase your reach with Sponsored Display audiences by including audience segments from advertised products, similar to advertised products, and categories or Amazon Audiences for In-market, Lifestyle, Interests, and Life Events segments.\n"," For more information, see our Sponsored Display documentation in the Amazon Ads API.\n"," Marketplaces: US, CA, UK, DE, FR, IT, ES.\n"," Amazon Attribution has launched within the Amazon Ads console, so you are able to access Amazon Attribution alongside other self-service advertising products, including Sponsored Products, Sponsored Brands, Sponsored Display, and Stores. Eligible advertisers will automatically have access with no need to sign up or wait for approval. For API-integrated tool providers, this will simplify authorization and onboarding by leveraging the same advertising account profiles as sponsored ads products. As part of this transition, advertisers already using Amazon Attribution should migrate their data to an advertising console account. Vendor advertisers can do so by logging into their Amazon Attribution DSP account and mapping their Amazon Attribution advertisers to their advertising console accounts. Seller accounts were automatically migrated based on the seller account ID associated to Amazon Attribution and advertising console accounts. If you are currently running Amazon Attribution measurement across live campaigns, they are not impacted. We recommend advertisers interested in measuring new campaigns do so using tags retrieved from their ad console profile. For more information, please refer to the Amazon Attribution API getting started page.\n"," Marketplaces: US, CA, MX, UK, DE, FR, IT, ES, NL, JP, IN, AU, AR, SE, BR, SG\n"," We updated our daily budgeting policy for Sponsored Products, Sponsored Brands, and Sponsored Display, allowing you to spend up to 25% more than the average daily budget on any given day. This allows you to benefit from high traffic days by using budgets from previous days when your spend is below your daily budget. The daily budget amount is averaged over the course of a month.\n"," Visit our Support Center to learn more.\n"," Marketplaces: US, CA, MX, UK, DE, FR, IT, ES, NL, JP, IN, AU, AR, SE, BR, SG\n"," New metrics and bids for all match types are now available for the Sponsored Products custom keyword ranking feature on the Amazon Ads API. You can now receive search term impression share, search term impression rank, and bid recommendations across all match types (broad, phrase, exact) for each recommended keyword when using custom keyword ranking. These metrics are returned as part of the custom keyword ranking call. Search term impression and rank are only available if your account has generated impressions for search terms matching the recommended keywords. \n"," These metrics help with making informed keyword selections by identifying potential keywords to target based on your impression share and impression rank of search terms. Search term impression share shows how your account-wide impression share for each search term compares to other advertisers, and the overall percentage of ad impressions you receive compared to other advertisers over last 30 days. For example, if you have a Sponsored Products impression share of 20% for a search term, it means that you won 20% of all Sponsored Products ad impressions for that search term. Similarly, search term rank helps you understand the level of activity on terms that you are targeting. For example, if you have a search term impression rank of 3 on a search term, it means that you received the third most Sponsored Products ad impressions for the same search term over the last 30 days. \n"," To access these additional metrics, call the API with the Media-Type: application/vnd.spkeywordsrecommendation.v4+json. Visit the reference documentation to learn more.\n"," Sellers and vendors worldwide can now copy product targeting specifications from one geography to any combination of countries where Amazon Ads is available. With this feature, you can match over categories, category refinements, products, negative targeted products, and negative targeted brands. \n"," This feature can be used alongside the existing LocalizeKeyword, LocalizeProduct, LocalizeCurrency and Profiles endpoints. This will help you create Sponsored Products manually targeted campaigns in different countries with minimal effort or local language knowledge. You can take campaign parameters (product targets, budget, bids and ASINs/SKUs) from one country and localize the parameters to launch campaigns in other countries. \n"," Learn more with our reference documentation: LocalizeTargetingExpression.\n"," Rule-based bidding allows advertisers to optimize their Sponsored Products campaigns by enabling a new bidding control, rule-based bidding. This new control can drive sales while maintaining a ROAS greater than or equal to the ROAS guardrail for the campaign. Once enabled, Amazon Ads will adjust bids on each ad opportunity to drive more sales. Amazon Ads does not guarantee to meet ROAS guardrail. If we are not meeting the guardrail and ROAS decreases over a 21-day period (excluding special days like Prime Day) we will disable the rule and restore campaign original bidding strategy and targeting clause bids. Optionally, in addition to ROAS, an advertiser can provide an average bid guardrail. If there is an average bid guardrail provided, and if the campaign CPC over a 7-day period exceeds the average bid guardrail by 125%, the rule will be disabled.\n"," Advertisers can use the endpoints to create, retrieve, update, delete, and retrieve the status of the rule. Advertisers can also use the eligibility API to get a ROAS and average bid guardrail based on campaign historical performance and similar advertisers.\n"," See the overview for more information, then follow the setting up process before you get started with the API.\n"," Advertisers launching Sponsored Brands campaigns and Stores can now receive pre-moderation guidance through the Amazon Ads API. Pre-moderation endpoints provide real-time policy guidance based on creative elements and assist in fixing content that violates policy before being submitted for full moderation review. Guidance will include why a campaign might be rejected if submitted for moderation review, and links to relevant ad policies for additional explanation on the guidelines. Note that this feature is currently available in the US, UK, and Canada. Learn more with our reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"August 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We have expanded our bidding controls for Sponsored Display campaigns; now advertisers and sellers registered in Amazon Brand Registry in the US, UK, CA, FR, ES, IT, DE, AE, JP, and IN can select Optimize for Viewable Impressions to help drive product awareness. When selecting this optimization, advertisers will express their bids for maximizing viewable impressions with vCPM charging (cost per thousand viewed impressions) and access view attribution metrics to help understand the value of these awareness campaigns. \n"," The new bid optimization \"Optimize for Viewable Impressions\" complements broader targeting options available through product targeting and audiences, helping advertisers reach more potential customers and creating more awareness for products and brands. You can measure the success of these new campaigns by leveraging metrics like viewable impressions and vCPM.\n"," Regardless of targeting strategy, ads with this bid optimization may only serve on Amazon, and Sponsored Display reporting helps these advertisers optimize campaigns and learn more about the addressable audiences. Since these are vCPM campaigns, we recommend starting with bids of at least $5 USD to test, then adjusting based on early learnings. For full technical details, including the new reach bidOptimization through the Amazon Ads API, please see our updated Sponsored Display documentation. \n"," Advertisers who create new Sponsored Products and Sponsored Brands campaigns will now be informed when their ads contain ineligible products. When the ads contains ineligible products, the Amazon Ads API will notify you and prevent creation for these ads. This feature helps advertisers streamline their process when conforming with Amazon Ads existing product acceptability and ad policy requirements. Prior to this change, ads containing ineligible products were created but required advertisers to manually troubleshoot issues by using Product Ads Extended data. There has been no change to Amazon Ads product acceptability and ad policy requirements as part of this release. \n"," Advertisers can use this product eligibility feature to get more information about their products. You can retrieve the Sponsored Products and Sponsored Brands eligibility status for a given list of products associated in your Seller Central or Vendor Central account. If products are ineligible for advertising, a provided status update will explain why the product is ineligible so that you can take action to activate them. For more information, see the reference documentation.\n"," Portfolio support is now available for Sponsored Display vendors and sellers registered in Amazon Brand Registry in the US, UK, CA, FR, ES, IT, DE, AE, JP, IN, AU, NL, and MX.\n"," Sponsored Display support for portfolios enables advertisers to group and organize Sponsored Products, Sponsored Brands, and Sponsored Display campaigns into collections that mirror the structure of their business. With portfolios, you now have the flexibility to arrange campaigns in a way that is meaningful for you, such as by brand, product category, or season across all self-service ad products. A key advantage portfolios offer is control over spend across campaigns. Once your portfolio budget is exhausted, all campaigns in that portfolio will automatically pause until you choose to reactivate them by increasing your portfolio budget.\n"," For full technical details, please see our updated Sponsored Display documentation in the Amazon Ads API, including the portfolioId that can be associated to each campaign.\n"," Sponsored Display product targeting and audiences are now available on the Amazon Ads API for vendors and sellers registered in Amazon Brand Registry in Mexico. As a reminder, Sponsored Display audiences and product targeting can be used together to help reach shoppers at all stages in the shopping journey. Audiences & product targeting help you reach shoppers while they browse and shop on Amazon. Used together these strategies can help drive awareness, consideration, and conversion. \n"," We recommend using new-to-brand metrics to better measure and optimize in-flight audiences campaign to drive customer acquisition and brand loyalty. You can help increase your reach with Sponsored Display audiences by including audience segments from advertised products, similar to advertised products, and categories or Amazon Audiences for In-market, Lifestyle, Interests, and Life Events segments.\n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Marketplaces: US, CA, MX, BR, UK, DE, FR, IT, ES, NL, IN, UAE, JP, AU, and SA\n"," The Branded Search metric is now available for Amazon DSP customers worldwide for campaign reports. This metric allows advertisers to quantify how many customers executed a search queries that contained an advertiser brand name after seeing an ad for their campaign. This works by matching the brands of the featured ASINs within a campaign with search queries containing those brand names on Amazon. The metric counts a conversion if the user viewed or clicked an ad for the campaign prior to the search.\n"," Refer to the DSP reports documentation for details on how to request these metrics.\n"," Marketplaces: US, UK, DE, FR, IT, ES, IN, JP, CA, MX, AU, SA, SG, UAE, and NL\n"," Advertisers can now measure the performance of their Sponsored Brands video campaigns against a new set of video viewing metrics, available for download in the report center or through the Amazon Ads API. The new metrics include: viewable impressions, view-through rate (VTR), viewable click-through rate (vCTR), 5 second views, 5 second view rate, video first quartile, video midpoint, video third quartile, video completes, and unmutes. Video view metrics are available in downloadable reports by keyword, campaign, and campaign placement.\n"," Sponsored Display bid recommendations are now available in the Amazon Ads API for vendors and sellers registered within Amazon Brand Registry in the US, CA, DE, UK, FR, IT, ES, JP and UAE. Bid recommendations help remove the guesswork when selecting a bid. Now, when you create any Sponsored Display product targeting or views remarketing campaign, you will receive machine learning powered bid recommendations. These recommendations are presented as a suggested bid and a bid range, and both are calculated by analyzing a group of winning bids for recent, similar ads within your category. Suggested bid and bid range update daily, based on the increase or decrease in competing bids and ads in each auction. The bid recommendation is provided at the target level using the exact structure of existing targets, which enables you to programmatically reuse targeting clauses and obtain bid recommendations.\n"," For full technical details, please see our updated Sponsored Display recommendations developer guide in the Amazon Ads API. You can also refer to the reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"July 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Self-service customers can now leverage the Amazon Ads API to manage Amazon DSP ad campaigns in Canada, Mexico and Brazil. Amazon DSP campaign management functionality enables you to: \n","Create, read and update orders and line items  Retrieve pertinent information required to manage orders and line items such as domain lists, IAB content categories, and supply sources  Read, add, and remove creatives to and from line items\n"," For more information, see our reference documentation. \n"," A new environment type breakdown has been added to the technology dimension for users of the Amazon DSP API. This option allows you to create a report summarized by the environment (i.e. app or web) where customers saw ads. This is in addition to the device type, browser, browser version, and operating system that already exist in the technology dimension.\n"," To request these new reports, you will need to specify TECHNOLOGY in the type object and ENVIRONMENT_TYPE in the dimensions list. The environment type breakdown will help you understand how your campaign performed on apps and websites, which may help inform optimizations for future campaigns. \n"," You can refer to the documentation for details on how to request these new reports. If you are already specifying a version in the Accept header, you must update to application/vnd.dspcreatereports.v2_2+json to access the new features. The new features are available by default if you do not specify a version.\n"," The DSP Reporting API in all regions will be unavailable for approximately 15- 20 minutes between 6 PM UTC to 8 PM UTC on July 29, 2021 for planned maintenance. DSP Reporting API users will see failures for operations that create and retrieve reports operations during this time period. No other Amazon Ads API services are impacted.\n"," The Branded Search metric is now available for Amazon DSP customers worldwide for campaign reports. This metric allows advertisers to quantify how many customers executed a search queries contained an advertiser brand name after seeing an ad for their campaign. This works by matching the brands of the featured ASINs within a campaign with search queries containing those brand names on Amazon. The metric counts a conversion if the user viewed or clicked an ad for the campaign prior to the search.\n"," You can refer to the DSP reports documentation for details on how to request these metrics.\n"," Sponsored Brands video now offers bid suggestions for Product attribute targeting and Keywords campaigns.  \n"," Bid suggestions are based on historical winning bids of impressions and auction data. The new capability provides advertisers with a range of bids they should consider setting to, in order to increase their chances for winning and delivering impressions. As a consequence, advertisers can save time on bid optimizations and increase their return while spending their budget. For more information see the Sponsored Brands Suggested bid and bid range reference\n"," Sponsored Brands APIs that previously only supported bid recommendations for product collection or Store spotlight ad formats, now support video format as well. For full technical details, please refer to our updated reference documentation.\n"," The following API has been updated to support this launch:\n","/sb/recommendations/bids now supports bid suggestions for video creative ads. Use new parameter adFormat in request to specify the ad creative type.\n"," Amazon DSP now supports DoubleVerify (DV), the next evolution of brand safety solution: Brand Suitability Tiers. This will allow alignment of brand safety and suitability settings with the advertiser unique standards. This feature is available for standard display, mobile app, and video line items running on third-party supply sources.\n"," With this release, DV will align brand safety product functionality with approach put forth in the American Association of Advertising Agencies (4A), Advertising Protection Bureau (APB), World Federation of Advertisers (WFA), and Global Alliance for Responsible Media (GARM) standards, which is designed to transition the industry to a more consistent approach for protecting brand reputation while preserving scale and supporting publishers.\n"," You must update to the version 3 accept headers in order to access the new features. If you do not specify a version, the new features are available by default. For more details, refer to our reference documentation.\n"," Note that DoubleVerify brand suitability tiers are supported only on third-party supply. If it is applied on line items targeting both Amazon owned-and-operated supply and third-party supply, line items disregard this for Amazon owned-and-operated supply. For more information on third-party pre-bid targeting, refer to this help article.\n"," Sponsored Brands video now offers a new, simple way to execute brand advertising strategies such as category expansion and brand reach strategies. The new product targeting option allows you to target ads by categories and refine by brand, price, or star reviews. With product targeting, you can engage shoppers that are exploring at a category level. Reporting is now available for campaigns that use product targeting expressions. For more information see the Sponsored Brands product targeting reference.\n"," Sponsored Brands APIs that previously only supported product targeting for product collection or Store spotlight creative formats, now support video format as well. For full technical details, please refer to our updated reference documentation.\n"," The following APIs have been updated to support product targeting for Sponsored Brands video campaigns:\n","/sb/campaigns and /sb/draft/campaigns endpoints now support managing video format campaigns with product targets.  /sb/targets and /sb/negativeTargets endpoints now support managing targets for video campaigns.  /v2/reports endpoints now support product targeted video campaigns.\n"," Sponsored Products advertisers can now receive suggestions for product targeting campaigns grouped by themes via the API. Given an advertised product (ASIN) as input, this API returns a list of ASINs as suggested targets. We generate these suggestions using your ad historical performance, items that shoppers frequently view and purchase together, and various other techniques. Suggested targets can be retrieved either as a single list, or grouped by theme. See below for currently available themes:\n","Top converting targets – These ASINs generated conversions for the input ASIN in the past 30 days (for example, your product appeared as an ad on the detail page of these items, and a shopper clicked and purchased your item). The suggested ASINs under this theme are sorted in decreasing order of sales generated for your promoted item.  Similar items (frequently viewed together) – Items that shoppers frequently view and click along with your advertised item during a shopping session.  Complements – Items that are frequently purchased together as complements. For example, if you are promoting a tennis racquet, you may see tennis balls recommended under this theme.  Similar items with low ratings and reviews – Subset of the similar items theme containing items that are rated lower than 3 stars and/or with fewer than 5 reviews.   Books with similar readership (currently available for e-books only)– Other e-books that Kindle readers often read along-with your advertised book.\n"," The feature is available at /sp/targets/products/recommendations under the v3 Product Targeting APIs. With this release, support for the v2 product recommendations API (/v2/sp/targets/productRecommendations) will be limited to critical bug fixes. The v2 endpoint will be available until Dec 31, 2021. Starting January 1, 2021 API callers will then be required to migrate to v3 to avoid service interruption. We recommend updating to the new endpoints earlier than October 31, 2021 to allow time for testing, and to take advantage of the latest functionality.\n"," For full technical details, please visit Sponsored Products v3 documentation. \n"," Sponsored Display creative customization for headline, logo, and images are now available on the Amazon Ads API in the US, UK, FR, ES, IT, DE, UAE, JP, CA, and IN.\n"," Advertisers can now personalize their Sponsored Display product targeting and audiences ad creatives with custom headlines, brand logos, and images which will help advertisers create more engaging ad creatives to convey their brand message. As a part of this release, Sponsored Display enables custom image creatives, a new option for advertisers to replace default product images with a custom image of their choice. Newly supported custom product images allow for brands to now upload their own graphics, including those with bespoke background colors and art direction, to help convey their brand and product story.\n"," For full technical details, please see our updated Sponsored Display documentation in the Amazon Ads API and our Sponsored Display creative developer guide to learn more about uploading assets to the asset library.\n"," Similar product targeting capability is now available for Sponsored Display campaigns on the Amazon Ads API for vendors and sellers registered in Amazon Brand Registry in the US, CA, UK, DE, FR, IT, ES, AE, JP, AU, NL and IN. \n"," Sponsored Display advertisers can now easily broaden their targeting scope and drive more scale by adding similar products to the targeting.  Using a single targeting clause of similarProduct, advertisers can target additional products that are similar to those being advertised. The products within similar product targeting are based on the advertised product and are dynamically generated using machine learning models that are built on retail data. Similar targeted products have a higher probability of driving traffic (improved CTR) to the advertised product. This helps advertisers launch campaigns faster and improves product consideration by providing a larger number of products to target. \n"," For full technical details, please see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Sponsored Display audiences is now available on the Amazon Ads API for vendors and sellers registered in Amazon Brand Registry in the NL and AU. This strategy helps you reach shoppers on Amazon based on shopping actions. As a reminder, Sponsored Display audiences and product targeting can be used together to help reach shoppers at all stages in the shopping journey. Audiences & product targeting help you reach shoppers while they browse and shop on Amazon. Used together these strategies can help drive awareness, consideration, and conversion. We recommend using new-to-brand metrics to better measure and optimize in-flight audiences campaign to drive customer acquisition and brand loyalty. You can help increase your reach with Sponsored Display audiences by including audience segments from advertised products, similar to advertised products, and categories or Amazon Audiences for In-market, Lifestyle, Interests, and Life Events segments.\n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," The ad status NOT_IN_BUYBOX is no longer supported. The changes to Sponsored Products API are:\n","GET /v2/sp/productAds/extended serving status field no longer returns NOT_IN_BUYBOX as an enum value.\n"," For more information, please refer to the developer notes section and the API reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"June 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We have released an update to the way product and pixel conversion tracking are associated to an order. The current endpoint /dsp/orders/{orderId}/conversionTracking is being replaced by two separate endpoints for products and pixels: \n","/dsp/orders/{orderId}/conversionTracking/products is used for retrieving, adding, and removing tracked products to an order. We increased the maximum number of ASINs you can add to an order in the request payload from 1,000 to 2,000 ASINs. Alternatively, you can upload a csv file with up to 50,000 ASINs. You can now choose to receive a list or a csv file of ASINs when retrieving tracked ASINs for an order. \\* /dsp/orders/{orderId}/conversionTracking/pixels is used for associating existing pixels to an order. \n"," We recommend migrating to the new endpoints to take advantage of these new features, as the existing /conversionTracking endpoint will be deprecated by 12/31/2021. For more details, refer to our reference documentation.\n"," With the /product/metadata API, advertisers can now retrieve product metadata such as inventory status, price, eligibility status, and product details for SKUs or ASINs in their product catalog. Users can leverage this information to launch, manage or optimize their Amazon Ads campaigns. This functionality is available to Sellers, Vendors, and Authors.\n"," Amazon DSP and Sponsored Display advertisers can now retrieve insights on top audiences that overlap with a given audience using the Amazon Ads API. Overlapping audiences help surface other audiences that are similar to your intended audience and that you may want to consider adding to your display campaigns. \n"," A new version of the API is available with three new features to help you generate and apply insights more effectively:\n","maxResults allows you to specify the number of overlapping audiences. Up to 500 can be returned in one call. \\* forecastedDailyReach shows an estimate of the number of unique devices that can be reached across all inventory types when the audience is included in a campaign. \\* forecastedDailyImpressions shows an estimate of the number of available impressions across all inventory types when the audience is included in a campaign. \n"," To use the API we recommend first integrating with /audiences/listAPI. This API will allow you to search for available audiences, which can then be used as an input to generate overlapping audiences.\n"," For more information, please refer to our reference documentation.\n"," Sponsored Display now includes additional controls to optimize bids based on campaign objectives. When building campaigns, advertiser can choose between higher consideration or conversion goals. When selecting click, ads will serve to audiences more likely to click on your ad. These campaigns will bid down only and are more likely to have a higher click through rate and lower cost per click. Advertisers may want to drive more clicks when building awareness for their products. When selecting conversions, the bids will be optimized for higher conversion rates, showing your ads to more shoppers more likely to purchase the product. When selected, ads will serve to audiences who are more likely to click on the ad and then purchase the product within 14 days. These campaigns bid up and down and are more likely to have a higher click conversion rate. Advertisers may want to drive more conversions to increase sales & build customer loyalty.\n"," For full technical details, please see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Sponsored Display audiences campaigns have now launched on Twitch, a live streaming service and global community for content spanning gaming, entertainment, music, sports, and more, in the US, CA, FR, IT, DE, ES, and UK. Now all Sponsored Display audiences campaigns are eligible to serve on the Twitch Browse and Discovery pages to help advertisers reach highly-engaged and relevant audiences watching live-streamed content on Twitch.\n"," Sponsored Display audiences is now available on the Amazon Ads API for vendors and sellers registered in Amazon Brand Registry in India. This strategy helps you reach shoppers on Amazon based on shopping actions. As a reminder, Sponsored Display audiences and product targeting can be used together to help reach shoppers at all stages in the shopping journey. Audiences & product targeting help you reach shoppers while they browse and shop on Amazon. Used together these strategies can help drive awareness, consideration, and conversion. We recommend using new-to-brand metrics to better measure and optimize in-flight audiences campaign to drive customer acquisition and brand loyalty. You can help increase your reach with Sponsored Display audiences by including audience segments from advertised products, similar to advertised products, and categories or Amazon Audiences for In-market, Lifestyle, Interests, and Life Events segments.\n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," We have updated the setting up section of the Amazon Ads Advanced Tools Center that describes authorization and authentication in the Amazon Ads API. The updated content describes how the authorization (OAuth 2.0) flow is implemented, and more clearly aligns each Amazon authorization and authentication API with each step of the flow. We would appreciate your feedback on this new content, so please click on the \"leave feedback\" widget in the site header and give us a thumbs up or thumbs down with any comments you have. \n"," Vendors and registered sellers in the US, CA, UK, DE, FR, IT, and ES can now access product-level daily reporting for Amazon Attribution at the campaignId and adgroupId levels through Amazon Ads API. Previously, Amazon Attribution API customers were only able to access daily reporting without visibility into the purchased products included in their conversion and sales reporting.\n"," With the launch of the new Products Report available on the Amazon Attribution API, you can now gain insight into the specific products purchased in the Amazon store, including performance across promoted products and brand halo products as result of non-Amazon marketing. You can use this insight to help optimize campaigns in-flight or plan future marketing strategies, including opportunities to re-market, cross-sell, or promote new products. When combined with insights from other retail and advertising reports, you have a more comprehensive view of your brand performance on Amazon.\n"," The Products Report can be retrieved by adding an optional reportType parameter to your existing Amazon Attribution reporting request body. You will need to enter PRODUCTS as the parameter value and list the set of desired metrics. If you enter the reportType as PRODUCTS and do not list any metrics, your report will contain all PRODUCTS metrics by default. For a list of PRODUCTS metrics and more information on how you can retrieve product-level reporting, see the reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"May 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Sponsored Display product targeting is now available in the Amazon Ads API for sellers in AU, NL, and IN for professional sellers enrolled in the Amazon Brand Registry and vendors. Product targeting for Sponsored Display gives sellers and vendors additional opportunities to reach and re-engage shoppers. Product targeting enables advertisers to promote product discovery, measure campaigns more effectively by targeting specific products or relevant product categories on Amazon, and gain greater line of sight into campaign optimization. Sellers and vendors now have the ability to: target multiple ASINs within campaigns, access detailed reporting, leverage flexible bidding options, and broaden category targeting capabilities. \n"," Product targeting brings audiences closer to the point of purchase and helps brands stay top of mind. We recommend using new-to-brand metrics to better measure and optimize in-flight audiences campaign to drive customer acquisition and brand loyalty. These ads may appear alongside product description pages, customer reviews, shopping results pages, or under the featured offer. \n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Sponsored Display bid recommendations are now available in the Amazon Ads API for vendors and sellers registered within Amazon Brand Registry in the US, CA, DE, UK, FR, IT, ES, JP and UAE. Bid recommendations provides recommended bids for target clauses with median, lower and upper boundaries based on historical bid values for the ASINs in a recent period. These recommendations will help advertiser select a bid which will more likely win impressions and generate clicks for the targeted ad to the shopper. The bid recommendation is provided at the target level using the exact structure of existing target clauses, which enables you to programmatically reuse campaign target clauses and obtain bid recommendations.\n"," For full technical details, please see our updated Sponsored Display recommendations developer guide in the Amazon Ads API.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"April 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Sponsored Display brand safety is now available in the Amazon Ads API for vendors and sellers registered within Amazon Brand Registry in the US, CA, DE, UK, FR, IT, ES and UAE. Sponsored Display can run ads onsite and offsite on third-party sites and mobile apps. The brand safety functionality gives you more control on where your ads serve to protect your brand and block ads from delivering on third-party sites that do not align with your brand. You can upload a list of domains / mobile applications that you want to prevent ads from showing in your Sponsored Display campaigns. This feature will be available at the advertiser level, allowing each advertiser to control where their ads are shown off-Amazon. \n"," For full technical details, please see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Sponsored Display audiences is now available on the Amazon Ads API for vendors and sellers registered in Amazon Brand Registry in Japan. This strategy helps you reach shoppers on Amazon based on shopping actions. As a reminder, Sponsored Display audiences and product targeting can be used together to help reach shoppers at all stages in the shopping journey. Audiences & product targeting help you reach shoppers while they browse and shop on Amazon. Used together these strategies can help drive awareness, consideration, and conversion. We recommend using new-to-brand metrics to better measure and optimize in-flight audiences campaign to drive customer acquisition and brand loyalty. You can help increase your reach with Sponsored Display audiences by including audience segments from advertised products, similar to advertised products, and categories. \n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Support for managing video ads is now available on the Amazon Ads API for Amazon DSP customers in the US. With this launch, you can manage your streaming TV ads and Online video ads to engage your audiences at scale. \n","With Amazon streaming TV ads video ads, you can showcase your brand alongside premium, brand-safe streaming content, including the latest movies and TV shows on IMDb TV, across broadcast and network apps, and alongside live sports and news.  \\* With online video ads, you can reach audiences with both in-stream and out-stream video ads on Amazon affiliated sites such as IMDb.com and Twitch, and across the web on leading publisher sites through Amazon Publisher Services and third-party exchanges.\n"," This new functionality enables you to create, read and update video line items. Additionally, you can read video creatives, and add or remove video creatives to and from line items. For more information, see our reference documentation.\n"," We have introduced three new features to help you create and manage product targeting campaigns more effectively: \n","/sp/targets/categories returns all categories available to target an advertiser country. The information is returned in a hierarchy, with each parent category (for example, \"shoes\") linked to its child categories (for example, \"running shoes\", \"dress shoes\", \"hiking shoes\" etc.).  /sp/targets/products/count returns an approximate number of products within each category. You can use this while creating category targets to get a sense of how many underlying products will be targeted.  /sp/negativeTargets/brands/recommendations provides suggested brands to negatively target when targeting a category.\n"," In addition, we have released new versions of existing product targeting APIs: \n","/v2/sp/targets/brands endpoint has been updated to /sp/negativeTargets/brands/search. Endpoint returns brands for a given search keyword.  /v2/sp/targets/categories/refinements has been updated to /sp/targets/category/{categoryId}/refinements. Endpoint returns available options to refine a category target - for example, brands, genre, age range, etc.  /v2/sp/targets/categories endpoint has been updated to /sp/targets/categories/recommendations. Endpoint returns suggested categories to target based on the input product.\n"," The updated endpoints provide more intuitive path and field names, improved version management to minimize breaking changes on your end, and improved error codes with more details. With the release of the v3 endpoints, support for v2 endpoints will be limited to critical bug fixes. The v2 endpoints will be available until October 31, 2021. Starting November 1, 2021 API callers will then be required to migrate to v3 to avoid service interruption. We recommend updating to the new endpoints earlier than October 31, 2021 to allow time for testing, and to take advantage of the latest functionality.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"March 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We have added support for Singapore (SG) to the API. For more details see the API endpoints and keyword bid constraints by marketplace sections of the overview, the regional profile time zone codes section of the profiles reference, and the countryCode parameter of the registerProfile and registerBrands operations.\n"," Advertisers, agencies, and tool providers can now leverage the Amazon Ads API to discover audiences for their advertising campaigns. You can use this API to search audiences by the audience name, or audience Id. You can also apply filters to the audiences to narrow down your search.  The API returns all audiences with the specified filters of name, ID, and category. The valid values for category filter are In-market, Lifestyle, Life event, Interest, Demographics, Custom-built, Contextual, and Advertiser audiences. You can now also find the daily reach and impressions forecast for the audiences using this API.\n"," This enables you to discover relevant audiences faster. For example, to find all audiences who are in the in-market category for shoes, you can set the category filter to In-Market and use the audienceName filter to shoes. This functionality is available worldwide to all Amazon Ads API integrators. \n"," For full technical details, please visit list Audiences reference.\n"," Amazon DSP and Sponsored Display advertisers can now retrieve insights on the top audiences that overlap with a given audience using the Amazon Ads API. Advertisers can use any audience available to them as the input, and the API will display the top audiences that the input audience is also likely to be a part of. Overlapping audiences can be filtered by audience type, size, or affinity score.\n"," Overlapping audiences are used to help surface other audiences that are similar to your target audience and that you may want to consider adding to your display campaigns. You can also use the insights to deepen your audience understanding through discovering other interests and shopping behaviors that your brand current or prospective audience shares. This API functionality allows advertisers to view insights within the tools they use to build and manage campaigns in Sponsored Display or Amazon DSP, as well as other marketing channels. \n"," For example, if you are planning a campaign to drive consideration for your storage boxes, you may want to view the overlapping audiences to plan your audience strategy. You can pull these insights for an audience in-market for storage boxes. The API might share that the top overlapping audiences are lifestyle - recent movers (1 month), in-market for standing shelf units, and in-market for tool utility shelves. You may include one or more of these audiences to get further reach in your display campaigns. \n"," To use the API we recommend first integrating with /listAudiences API. This API will allow you to search for available audiences, which can then be used as an input to generate overlapping audiences. \n"," For more information, please refer to our reference documentation.\n"," Sponsored Display audiences expands to support Amazon audiences for vendors and sellers registered in CA, DE, ES, FR, IT, JP, the UAE, the UK and the US on the Amazon Ads API. This launch gives advertisers access to audiences built using Amazon first-party shopping & streaming signals. Sponsored Display audiences empowers advertisers of all sizes to reach audiences across their purchase journey—both on and off-Amazon—to help grow their Amazon business.\n"," Amazon audiences can be used to help engage new customers and help them learn about your brand on Amazon. You can now select audiences in a similar way to how you would describe your brand core customer—for example, \"Outdoor Enthusiasts\" or \"Environmentally Conscious Shoppers\", and connect the language used in your overall brand marketing strategy to your Sponsored Display campaigns. Consider mixing and matching Amazon audiences segments with custom-built views remarketing audiences within your ad group.\n"," For full technical details, please see our updated Sponsored Display documentation on the Amazon Ads API.\n"," The Amazon Ads API supports audience exploration within the taxonomy category. You can now browse by top-level category, sub-category, and see the number of relevant Amazon Ads audiences in each sub-category making it easier and faster to select relevant audiences. This API can be used to filter relevant audiences in sub-categories creating a more seamless audience discovery experience. \n"," For more details, please see our Audience Taxonomy documentation on the Amazon Ads API.\n"," Sponsored Display category recommendations for product targeting and audiences is now available on the Amazon Ads API in the US, CA, DE, UK, FR, IT, ES and UAE.\n"," When Sponsored Display advertisers submit a list of products to advertise for their Sponsored Display campaigns, they will now receive a list of category recommendations, alongside their existing product recommendations. These categories are ranked by their probability of driving higher click-through rate (CTR) for the advertised products selected and also includes a range of products that can help improve the scale of your campaigns. This helps you launch campaigns faster and can help improve product consideration by providing a larger number of products to target.\n"," For full technical details, please see our updated Sponsored Display documentation on the Amazon Ads API.\n"," An earlier release note announced that Sponsored Brands operations in the Advertising API EU Region would be unavailable for approximately 15-20 minutes beginning at 7PM UTC on March 9, 2021 for planned maintenance. This date and time has been updated and is now March 25th beginning at 18:00 UTC. The duration remains 15-20 minutes. Sponsored Brands operations will see API failures for create, read, update, and delete during this planned maintenance event. Sponsored Brands operations in the NA and FE regions are not impacted. No other Advertising API services are impacted in the EU region.\n"," Users of the API can now filter Sponsored Products report requests by state and can exclude inactive campaigns. The new filter can help users reduce the size of reports requests and the time it takes to generate a report. We made this improvement based on user feedback.  For more information see the stateFilter description in Sponsored Product reports. \n"," New-to-brand metrics are now available for Sponsored Display product targeting campaigns on the Amazon Ads API for vendors and sellers registered in Amazon Brand Registry in the US, UK, FR, ES, IT, DE, UAE, JP, and CA. New-to-brand metrics enable you to measure orders and sales of your products generated from first-time customers of your brand. With new-to-brand metrics, you can better measure and optimize in-flight campaigns, as well as plan future marketing strategies, to drive customer acquisition and brand loyalty. A new customer order is a key step in establishing a long-term brand relationship with a customer.\n"," An order is considered new to your brand if a shopper has not purchased one of the products from your brand in the past 12 months. If a shopper has not purchased from your brand within the 12-month look back window, the order is considered new-to-brand. The following campaign performance metrics are available: new-to-brand orders, new-to-brand sales, and new-to-brand units. Using these metrics, you can calculate the cost to acquire a new-to-brand customer. Additionally, based on your objectives and campaign performance, you can optimize your campaigns by broadening or refining your targeting.\n"," For full technical details, please see our updated Sponsored Display documentation on the Amazon Ads API.\n"," Amazon DSP advertisers now have access to new reports and report dimensions through the Amazon DSP API. You can now pull reports based on Technology, Geography, and Products. Additionally, the inventory report now has deals as a dimension to break out private marketplace deals. \n"," These new reports help you get more granular analytics about Amazon DSP campaigns. Each report provides details that can help you learn about performance and optimize your campaign strategies and tactics. \n","Technology report: The technology report has been added to aid campaign optimization based on attributes such as device type, browser, or operating system.  2. Geography report: The geography report has been added to help you optimize campaigns based on geographical attributes such as country, city, or ZIP/postal code.  3. Products report: The product report has been added to help you measure conversions for your campaign at an product level. The report includes the top promoted and brand halo products for your selected campaign. You can see conversions at a child product level, as well as parent product roll-ups in the same report. 4. Deals dimension. The deals dimension has been added to the inventory report type to help customers using private marketplaces (PMP) deals to see a breakdown of performance and delivery metrics by deal name and identifier.  5. OrderId filter. The orderID filter has been added so you can now generate reports for specific orders under a given profile and advertiser. This has been added to help customers reduce the number of rows returned in a single report. \n"," See the reference documentation for Amazon DSP reports for details on how to request these new reports. If you are already specifying a version in the Accept header, you must update to application/vnd.dspcreatereports.v2_1+json to access the new features. If you are not specifying a version, the new features are available by default. \n"," Starting on May 10, 2021, Sponsored Display suggested products will no longer be supported through the Amazon Ads API and ASIN data will no longer be refreshed. This feature is currently only available in the US for the legacy tactic remarketing. Sponsored Display advertisers should use the Sponsored Display recommendations API to guide campaign creation and optimization.\n"," The new Sponsored Display recommendations API provides advertisers with product targeting recommendations for their campaigns by submitting a list of products being featured in a campaign. It is available in the US, UK, FR, ES, IT, DE, UAE, CA and JP. This new functionality in the Amazon Ads API helps you launch campaigns faster by providing relevant product recommendations at scale, which removes friction in discovering the optimal products to target. Recommendations are ranked by their probability of driving higher click through rate (CTR) and are ranked based on the frequency of similar detail page views between the recommended and advertised product .\n"," For more information, see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Starting on May 17, 2021, Sponsored Display will no longer support campaign creation or campaign management for the legacy remarketing tactic in the Amazon Ads API. Going forward, Sponsored Display advertisers should use the audiences strategy via tactic T00030. In addition to the \"advertised products\" and \"similar to advertised products\" targeting functionality previously available in the remarketing tactic, T00030 advertisers will gain access to new controls including the ability to remarket off of \"categories\" and leverage \"category refinements\". As a reminder, Sponsored Display audiences and product targeting can be used together to help engage shoppers at all stages of the purchase journey. Audiences helps you reach shoppers while they browse on Amazon and across the web, while product targeting helps you reach customers as they shop on Amazon. Used together, these strategies can help drive awareness and consideration for your brand as well as product sales.\n"," For more information, see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Sponsored Brands operations in the Advertising API EU Region will be unavailable for approximately 15-20 minutes beginning at 7PM UTC on March 9, 2021 for planned maintenance. Sponsored Brands operations will see API failures for create, read, update, and delete operations starting at 7PM UTC and lasting approximately 15-20 minutes. Sponsored Brands operations in the NA and FE regions are not impacted. No other Advertising API services are impacted.\n"," We have released two new request filters for the Profiles resource. The first is a profile type filter that enables you to filter the response to any combination of Seller, Vendor, or Agency profile types. The second is a valid payment filter that enables you to filter the response to include only profiles that have valid payment methods. These improvements make it easier and faster to retrieve specific profiles. For more information, see the Profiles resource reference.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"February 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We have released a new Advertising program filter for the Profiles resource. This filter enables you to filter the response to include profiles that are associated with the specified advertising program only. \n"," Currently, the only supported advertising program is Billing, and this filters the GET Profiles operation response to include only those profiles to which the user account and application associated with the access token have permission to view billing data.\n"," For more information, see permissions management for Billing.\n"," Starting on March 25th, 2021, the shouldOptimizeAsins flag, also known as product optimization, for Sponsored Brands campaigns will no longer be supported through the Amazon Ads API. This feature is currently available in the US and UK. Existing Sponsored Brands campaigns with product optimization enabled will no longer have the products in the creative automatically optimized. Campaigns with product optimization enabled will be converted to standard Sponsored Brands product collection campaigns with the default selected products showing in the creative. \n"," The changes to the Sponsored Brands API are:\n","POST or PUT /sb/campaigns will no longer honor the shouldOptimizeAsins field in the Sponsored Brands campaign resource. The value of this field will always be false. \\* GET /sb/campaigns will return false as the value of the shouldOptimizeAsins field for all campaigns. \n"," And starting on September 25th, 2021, the shouldOptimizeAsins property will be removed from the Sponsored Brands campaign resource, and will no longer be part of the GET /sb/campaigns response.\n"," New-to-brand metrics are now available for Sponsored Display audiences campaigns on the Amazon Ads API for vendors and sellers registered in Amazon Brand Registry in the US, UK, FR, ES, IT, DE, UAE, and CA. New-to-brand metrics enable you to measure orders and sales of your products generated from first-time customers of your brand. With new-to-brand metrics, you can better measure and optimize in-flight campaigns, as well as plan future marketing strategies, to drive customer acquisition and brand loyalty. A new customer order is a key step in establishing a long-term brand relationship with a customer.\n"," An order is considered new to your brand if they have not purchased one of the products from your brand in the past 12 months. If the customer has not purchased from your brand within the 12-month look back window, the order is considered new-to-brand. The following campaign performance metrics are available: new-to-brand orders, new-to-brand sales, and new-to-brand units. Using these metrics, you can calculate the cost to acquire a new-to-brand customer. Additionally, based on your objectives and campaign performance, you can optimize your campaigns by broadening or refining your targeting.\n"," For full technical details, please see our updated Sponsored Display documentation on the Amazon Ads API.\n"," Advertisers now have the ability to automatically translate keywords for their Sponsored Products and Sponsored Brands campaigns through the Amazon Ads API. Using these new capabilities, you can provide a list of keywords in your preferred language and receive the localized versions for each marketplace default language. This helps you expand your reach and run campaigns across geographies where you may be unfamiliar with the local languages. For example, an English-speaking advertiser from UK can use this feature to translate all keywords into Spanish and French and run campaigns in Spain and France. The feature also works in the reverse direction, giving you the ability to retrieve translations for all keywords in a campaign, in an advertiser preferred language.\n"," You can provide lists of keywords during the campaign creation and management process. The list will be translated to the marketplace default language using the Keyword Localization capability. Both translated and original untranslated keywords, along with the advertiser locale, can be added to the campaign. The translated keywords added to the campaign will be used to target shopper queries in the default language for the country. The untranslated keywords remain retrievable as a reference of your original input. This feature is available today for both Sponsored Products and Sponsored Brands.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"January 2021 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Advertisers can now compare their Sponsored Brands campaign performance to peers using category-level benchmarks. Using the Amazon Ads API, you can pull benchmark data that shows performance compared to the median, lower performing quartile (Bottom 25%), and top performing quartile (Top 25%) values within specific categories. You can use this information to monitor the health of live Sponsored Brand campaigns and as a tool to create effective brand strategies for new campaigns. Benchmarks are available for impressions, click-through rate (CTR), return on ad spend (ROAS), and advertising cost of sales (ACOS). Brand category benchmarks are available for a 90-day look-back window. Learn more in our reference documentation.\n"," To help authors better measure the impact ads are having on their Kindle eBooks enrolled in Kindle Unlimited, we have added Kindle Edition Normalized Pages (KENP) read and estimated royalties to the Amazon Ads API. The KENP read metric is the estimated number of pages read by Kindle Unlimited customers attributed to the ads. The KENP estimated royalties metric estimates the royalties attributed to your Sponsored Products campaigns from customers who borrow your book from Kindle Unlimited or Kindle Owners Lending Library.\n"," At this time, estimated Kindle Edition Normalized Pages (KENP) Royalties is available to KDP authors advertising in the US, CA, UK, DE, FR, IT, ES, and AU. Note that this metric is an estimate. If the reporting date range includes days before the KDP Select Global Fund is announced, we will use the previous month KENP rate to estimate the royalties. Data is reported as of July 15, 2020.\n"," So what exactly does KENP Royalties tell you? For example, a customer clicks a Sponsored Product ad featuring your Kindle eBook and then borrows it through Kindle Unlimited. If the customer reads 120 normalized pages on day 1, we will attribute associated royalties to day 1 within your campaign dashboard and downloadable reports. If the customer reads the rest of your book—for example, 100 pages—on day 2, we will report associated royalties on day 2.\n"," If you build a client-facing interface, you are required to inform the account owner (KDP Author) that the KENP Royalties metrics are an estimate. You can find more information about the KENP metrics in the Amazon Ads Support Center. For more information on how to consume these metrics, please refer to our updated reference documentation.\n"," The POST operations to retrieve a list of target and negative target resources for Sponsored Brands have increased the maximum number of results from 100 to 5000. For more information, see the maxResults request parameter for the POST /sb/targets/list and POST sb/negativeTargets/list.\n"," Sellers and vendors in US, CA, MX, UK, DE, FR, IT, and ES can now create localized Sponsored Products campaigns within their region. This feature makes it easier to create campaigns in different languages with minimal effort or local language knowledge. You can choose which advertising account to use and then localize product ASINs/SKUs (LocalizeProduct), currencies (LocalizeCurrency), or keywords (LocalizeKeyword) from one marketplace to another. Learn more with our reference documentation: profiles resource, localize product, localize currency, and localize keyword.\n"," Sellers and vendors in US, CA, MX, UK, DE, FR, IT, and ES can now copy Sponsored Products auto-targeting campaigns from one marketplace to another within their region. Copying a campaign transfers all settings and localizes them for the target marketplace. Additionally, you can check the status of campaigns which you previously copied. This functionality may help you save time by quickly copying campaigns without needing to translate keywords and currencies or re-add products you want to advertise for each marketplace campaign. Learn more with our reference documentation: campaign copy and campaign copy status.\n"," We have added support for the Netherlands (NL) to the API. For more details see the API endpoints and keyword bid constraints by marketplace sections of the overview, the regional profile time zone codes section of the profiles reference, and the countryCode parameter of the registerProfile and registerBrands operations.\n"," Sponsored Display snapshots functionality is now available on the Amazon Ads API for vendors and sellers registered in Amazon Brand Registry in the US, UK, FR, ES, IT, DE, UAE, CA and JP. The snapshots resource is already available for Sponsored Products and Sponsored Brands and can be used to retrieve a record of your campaigns, ad groups, products ads, or targets using a single API call. This interface can be used to download bulk account snapshots files asynchronously.\n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Translations are available for default languages that are supported in the country a product is being advertised in. This makes it easier for you to understand recommended keywords for countries in which you do not know the default language. Visit the reference documentation for more information, including which countries and languages are supported with translations.\n"," Sponsored Display advertisers can now submit a list of products and receive product targeting recommendations for their product targeting campaigns in the UK, FR, ES, IT, DE, AE, CA and JP. This new functionality in the Amazon Ads API helps you launch campaigns faster by providing higher number of relevant product recommendations at scale. Recommendations are ranked by their probability of driving higher clickthrough rate (CTR) and are based on the similarity of the recommended products to advertised products with similar detail page views.\n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," We are implementing changes to reduce the number of failed and timed-out reports in the Sponsored Brands and Sponsored Products reporting endpoints. Users will now have higher rate limits at low usage times and lower rate limits at high usage times. We will determine usage levels at the endpoint region level.  We encourage users to smooth their report creation requests throughout the day, such as pulling older data periods later in the day, and using exponential backoff when encountering 429 errors. \n"," Advertisers can now reconcile booking data with invoices they receive from Amazon Ads using campaign tags for Sponsored Brands. Advertisers can now add custom identifiers when setting up or updating a campaign. The identifiers will be available within invoicing data, allowing for easier reconciliation against internal records and budgets. This is a follow up to the invoicing release from September, which provided continuous visibility into your billing information. For partners or vendors with multiple accounts, this removes the need to manually match campaigns on your advertising invoices to your own campaign booking systems. Once an invoice has been issued, you will be able to get data for any invoice that is due, has been paid, or was written off, at any time and now see your campaign tags represented. Learn more by visiting our reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"December 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Sponsored ads and Amazon DSP advertisers worldwide can now create and update manager accounts using the Amazon Ads API to maintain a single point of access for all of their advertising accounts.\n"," New operations have been added to the /managerAccount resource to support creating manager accounts. You can also link or unlink advertising accounts to/from the manager account. When new accounts are added or removed from your manager account, the updates will automatically be reflected in the responses from the /profile and /managerAccount resources, which allows both developer and client-facing teams to be in sync on their Amazon Ads accounts. \n"," Manager account helps advertisers and agencies save time and make data-driven decisions when working across several advertising accounts. Manager account users will be able to see detailed performance metrics on the manager account overview page in the Amazon Ads console with a single user invitation. For more information, please refer to our blog post on manager account and API documentation.\n"," We have added support for Brazil (BR) to the API. For more details see the API endpoints and keyword bid constraints by marketplace sections of the overview, the regional profile time zone codes section of the profiles reference, and the countryCode parameter of the registerProfile and registerBrands operations.\n"," We have added support for Mexico (MX) to the API. For more details see the API endpoints and keyword bid constraints by marketplace sections of the overview, the regional profile time zone codes section of the profiles reference, and the countryCode parameter of the registerProfile and registerBrands operations.\n"," Advertisers, agencies, and tool providers can now leverage the Amazon Ads API to manage Amazon DSP display ad campaigns in the US. You can: 1) create, read, and update orders and line items; 2) add and remove creatives to and from line items; and 3) read domain lists, audiences, IAB content categories, product categories, supply sources, pixels, and creatives. This enables you to automate campaign management operations and reduce the time you spend on manual efforts. Additionally, you can include Amazon DSP campaign management into your centralized tools where you manage all of your marketing. This functionality is available to self-service Amazon DSP customers for display ad campaigns in the US. For existing Amazon Ads API customers, check out our reference documentation. For new customers, follow the steps outlined in the setting up guide to get started.\n"," Sponsored Display audiences is now available on the Amazon Ads API for vendors and sellers registered in Amazon Brand Registry in the UK, FR, ES, IT, DE, and CA. This strategy helps you reach shoppers on and off Amazon based on shopping actions. As a reminder, Sponsored Display audiences and product targeting can be used together to help reach shoppers at all stages in the shopping journey. Audiences helps you reach shoppers while they browse on Amazon and across the web while product targeting helps you reach shoppers as they shop on Amazon. Used together these strategies can help drive awareness, consideration, and conversion. You can help increase your reach with Sponsored Display audiences by including audience segments from advertised products, similar to advertised products, and categories.\n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Advertisers now have the ability to set campaign budgets in advance using budget rules (beta) using the Amazon Ads API. Budget rules help reduce manual effort spent on adjusting budgets. You can set budget rules for specific dates or based on performance goals. \n"," Schedule based budget rules can be set to increase daily budgets for any date range or recommended events, such as Black Friday Cyber Monday. During shopping events, we will provide recommended budgets based on historical shopping activities. Performance based budget rules let you set rules to increase budgets based on campaign performance metrics. With budget rules, advertisers can reduce the likelihood of campaigns running out of budgets, especially during peak days or holiday events. \n"," Benefits of using budget rules:\n","Reduces likelihood of campaigns going out of budget preventing missed opportunities   Provides budget recommendations for special events   Gives more control over budget \\* Reduces manual effort and time spent adjusting budgets\n"," Advertisers can now set up budget rules for their campaigns through the Amazon Ads API. Budget rules (beta) helps you plan budget changes in advance so you can spend less time manually adjusting during a campaign. You can set rules based on specific dates or performance goals.\n"," Budget rules based on scheduling can increase daily budgets for any date range or for recommended events like Black Friday or Cyber Monday. For shopping events, we will provide recommended budgets based on historical shopping activities. Budget rules also lets you automate daily budget changes based on performance metrics. This new feature will help reduce the likelihood of campaigns running out of budgets, especially during peak days or holiday events. Learn more in the  Sponsored Products Budget Rules reference and Sponsored Brands Budget Rules reference or the Sponsored Products Budget Rules overview and Sponsored Brands Budget Rules overview.\n"," Advertisers can now reconcile booking data with invoices they receive from Amazon Ads using campaign tags for Sponsored Products. Advertisers can now add custom identifiers when setting up or updating a campaign. The identifiers will be available within invoicing data, allowing for easier reconciliation against internal records and budgets. This is a follow up to the invoicing release from September, which provided continuous visibility into your billing information. For partners or vendors with multiple accounts, this removes the need to manually match campaigns on your advertising invoices to your own campaign booking systems. Once an invoice has been issued, you will be able to get data for any invoice that is due, has been paid, or was written off, at any time and now see your campaign tags represented. Learn more by visiting our reference documentation.\n"," Sellers and vendors in US, CA, MX, UK, DE, FR, IT, and ES can now create localized Sponsored Products campaigns within their region. This feature makes it easier to create campaigns in different languages with minimal effort or local language knowledge. You can choose which advertising account to use and then localize product ASINs/SKUs (LocalizeProduct), currencies (LocalizeCurrency), or keywords (LocalizeKeyword) from one marketplace to another. Learn more with our reference documentation: v2Profiles, LocalizeProduct, LocalizeCurrency, and LocalizeKeyword.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"November 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" You can now receive product moderation information as part of Product Ads Extended data on the Amazon Ads API. Possible product moderation information may include if an item violates advertising policy or has a prohibited attribute. You can access this new information as part of Sponsored Products ad management via the ProductAdsEx endpoint under a new servingStatusDetails field. To provide more information, links to related Support Center topics are included in the call response for select product moderation statuses. To learn more, visit our reference documentation.\n"," Updated keyword restrictions for advertisers. Amazon Ads does not allow the targeting of prescription medicine products or the use of prescription medicine names as targeting keywords or phrases.\n"," For example, prescription medicine keyword or products, such as \"Lipitor\" or \"prednisone\".\n"," As a reminder, keywords or products targeted through Amazon Ads must be relevant to the product being promoted. Ads must not target keywords or products which could result in offensive, insensitive, or undesirable shopper experience. \n"," You can now receive product moderation information as new product eligibility statuses on the Amazon Ads API. Possible product moderation information may include if an item violates advertising policy or has a prohibited attribute. Additionally, you can now retrieve both product moderation and product eligibility information with a single call for a given list of products (ASINs or SKUs) associated with your Seller Central or Vendor Central accounts. To provide more information about product moderation statuses, links to related Support Center topics are included in the call response. Product eligibility supports Sponsored Products and Sponsored Brands. To learn more, visit our reference documentation.\n"," Note that information regarding the content moderation of a campaign is not available via this endpoint. Visit our reference documentation for instructions on retrieving this information for each ad product.\n"," Sponsored Display audiences is now available on the Amazon Ads API for vendors and professional sellers in the US. This strategy helps advertisers reach shoppers on and off-Amazon based on shopping signals. Sponsored Display audiences and product targeting can be used together to help reach shoppers at all stages in the shopping journey. Audiences helps you reach shoppers while they browse on Amazon and across the web while product targeting helps you reach shoppers as they shop on Amazon; used together these strategies can help drive awareness, consideration and conversion. You can help increase your reach with Sponsored Display audiences by including audience segments from advertised products, similar to advertised products, and categories.\n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," As part of our commitment to ensuring ease of use in the Amazon Ads API, we have updated our compatibility and versioning policy. Resources in the Amazon Ads API are now versioned independently. Clients request a specific version of a resource using the Accept request-header field. If the service supports the exact version, the exact version of the resource is always returned. Clients that do not request a specific version receive the most recent compatible version. Clients that request a deprecated version receive the most recent compatible version. We also guarantee resources are backwards compatible within a minor version. See the Amazon Ads API compatibility and versioning policy for more information.\n"," The Amazon Attribution API is now available for vendors and professional sellers enrolled in Brand Registry in CA, DE, FR, IT, and ES. This functionality was previously only available to US and UK vendors, as well as professional sellers enrolled in Brand Registry in the US.  \n"," Now tool providers working with vendors and professional sellers enrolled in Brand Registry in the US, CA, UK, DE, FR, IT, and ES can make Amazon metrics, including detail page views, add to carts, and purchases, conveniently available to their clients without having to log into the Amazon Attribution console to manually create tags and download reports. Amazon Attribution reporting through the API is available for paid non-Amazon (i.e. Google or Facebook) media campaigns that drive clicks to an Amazon product or Stores page.  \n"," Now tool providers who integrate with the Amazon Attribution API can help their clients optimize their non-Amazon media based on how shoppers discover, research, and buy products on Amazon. Through access to on-demand Amazon reporting, tool providers can offer their clients a unified view of campaign performance, with Amazon conversions displayed alongside existing digital marketing metrics. Tool providers can also leverage this reporting to inform their algorithms in order to help improve their client campaign performance through multi-channel recommendations and automated bid/budget optimizations.  \n"," The Amazon Attribution API does not require campaign management (CREATE or POST) calls and is comprised of 5 resources. For more information about Amazon Attribution, and how to register your clients, visit the Amazon Attribution product page. For more details about how to integrate with Amazon Attribution, create API tags for measurement, or retrieve reporting, visit the Amazon Attribution reference documentation.\n"," You can now understand how your Sponsored Brands campaigns compare to other advertisers with search term impression rank, now available on the Amazon Ads API. This metric helps you understand how your campaigns perform compared to other advertisers in relation to ad impressions. It shows the overall rank of ad impressions you receive compared to other advertisers for the same search term over a selected time period. Visit our reference documentation to learn more.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"October 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Advertisers in the US can now receive recommended daily budgets for their Sponsored Products campaigns. This feature provides a budget estimate for your campaign to deliver for a full day. Additionally, you can get more information about campaigns that went out of budget in the past. For those campaigns, you can receive \"percent of time in budget\", \"estimated missed impressions\", \"estimated missed clicks\", and \"estimated missed sales\" metrics. These estimates are based on the advertising opportunities your campaign missed while out of budget and may help inform your future budget allocation decisions. Visit the reference documentation to learn more.\n"," Sponsored Display advertisers can now submit a list of products and receive product targeting recommendations for their product targeting campaigns. This new functionality in the Amazon Ads API helps you launch campaigns faster by providing higher number of relevant product recommendations at scale. Recommendations are ranked by their probability of driving higher clickthrough rate (CTR) and are based on the similarity of the recommended products to advertised products with similar detail page views.\n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Sponsored Display audiences is now available on the Amazon Ads API for vendors in the US. This strategy helps advertisers reach shoppers on and off-Amazon based on shopping signals. Sponsored Display audiences and product targeting can be used together to help reach shoppers at all stages in the shopping journey. Audiences helps you reach shoppers while they browse on Amazon and across the web while product targeting helps you reach shoppers as they shop on Amazon; used together these strategies can help drive awareness, consideration and conversion. You can help increase your reach with Sponsored Display audiences by including audience segments from advertised products, similar to advertised products, and categories.\n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," You can use manager account to create a single point of access for all your advertising across sellers, vendors, and countries. After initial setup in the console, manager account on the API will return a list of all accounts that are linked by advertiser. When new accounts are added or removed from your manager account, they will automatically be returned to you via /profile and /managerAccount endpoints. This allows both developer and client-facing teams to always be in sync on their Amazon Ads accounts. It also enables access to all accounts for an advertiser or agency with a single user invitation. To get started, go to advertising console to create your first manager account and invite your email address to the manager account. For more information, refer to our blog post and API documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"September 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Advertisers can now retrieve invoice information for their sponsored ads and DSP campaigns through the Amazon Ads API. You can now match your Amazon Ads campaign billing with your internal records in an automated manner. This also provides you with continuous visibility into your billing information. For partners or vendors with multiple accounts, this removes the need to manually match campaigns on your advertising invoices to your own campaign booking platforms. Once an invoice has been issued, you will be able to get data for any invoice that is due, has been paid, or was written off, at any time. There will be two endpoints for invoicing: one that will return a list of invoices for a given advertiser, and the other will return details for a specific invoice. Learn more by visiting our reference documentation.\n"," Today we are moving Amazon DSP API reporting functionality out of beta and into general availability status. Advertisers, agencies and tool providers can leverage the Amazon Ads API to retrieve reports for their Amazon DSP campaigns worldwide. Users can generate campaign, audience, and inventory reports similar to custom reports in the DSP console. Metrics are available at the order, line item, creative, site and supply levels. This API functionality will make it easier for advertisers to retrieve reports and view campaign performance in the tools they use to manage other marketing channels. This functionality is available to advertisers, tool providers and agencies that have self-service access to Amazon DSP. To get started, follow the steps outlined in setting up.\n"," Starting this week, manager account will be available on the Amazon Ads API. This update will include a change in the behavior of /profiles for sellers. With the update, when an application does GET /profiles the list of profiles that are returned will include both the seller accounts that the user has access to (as granted via Seller Central) and the seller accounts that are included because of access granted via manager accounts. If you want to differentiate between the two types of access, you can call manager accounts on the API.\n"," With this change, access is in sync to the permissions of the user who granted you LWA access, i.e. you can perform operations on the same set of profiles as the seller. If the user loses permission to the seller account, the integrators to whom the user authorized will no longer be able to access the seller profile. If a user gains access to a new seller account via user invitation or their manager account, the integrators the user authorized will automatically be able to access the new seller profile. This change requires no new integration and will automatically be reflected in your existing integrations.\n"," If you were granted access to any of your user accounts by a user that has since lost permission, you will need to resend consent to the advertiser to regain access. Follow the steps here to gain access. It also automates your access to a new profile when a seller starts advertising with a new country or accounts.\n"," The Amazon Attribution API macro enabled and non-macro Attribution tags have changed. Existing campaigns with the deprecated tags will still enable Amazon Attribution measurement, however all new campaigns should use the new tag. The method for calling for Attribution tags has not changed. More details on the updated Amazon Attribution API tag are available in the Attribution tags reference documentation.\n"," Advertisers in the US can now customize how their keywords are ranked for their Sponsored Products through the Amazon Ads API. You can use custom keyword ranking in keyword targeted campaigns to rank keywords by: estimated clicks; estimated conversions; or a default that combines multiple metrics. You can rank your targeted keywords, recommended keywords, or a combination of both. Ranked keyword recommendations include keyword match type and recommended bid. When you submit your targeted keywords for ranking, you have the option to provide a match type and bid, and those values will be used for ranking. If you do not provide match type or bid, we will include the values used to rank with the results. Recommended keywords can also be translated into a language that is supported in a user country. Visit the reference documentation home to learn more.\n"," Draft campaign support for Sponsored Brands video on the Amazon Ads API\n"," Advertisers in the US can now create and manage draft campaigns for Sponsored Brands video on the Amazon Ads API. Draft campaigns allow you to create and save a campaign before submitting for approval. For more information, see the reference documentation.\n"," Sponsored Brands video preview URL now available on the Amazon Ads API\n"," Advertisers in the US can now get a preview URL for Sponsored Brands video campaigns on the Amazon Ads API. This allows you to review the encoded media being uploaded. For more information, see the reference documentation. \n"," Get Sponsored Brands product collection and video campaigns in a single call on the Amazon Ads API\n"," Advertisers in the US can now get a list of their Sponsored Brands product collection and Sponsored Brands video campaigns in a single call on the API. You can also filter the campaigns by adFormat (productCollection or video). Learn more about getting a campaign list and using adFormat filter in the reference documentation.\n"," The Amazon Ads API now enables customers who have self-service access to Amazon DSP to retrieve advertiser details for their Amazon DSP profiles. ADSP API customers can now get advertiser ID, advertiser name, currency, URL, country, and time zone for the advertisers within their entity. More details on the Advertiser read functionality are available in the reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"August 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Advertisers can now pull a detailed summary of changes made to their Sponsored Products and Sponsored Brands campaigns on the Amazon Ads API. You can view change history for up to 90 days at the individual campaign and ad group levels, and across all Sponsored Products and Sponsored Brands campaigns in the same view. Learn more in our reference documentation.\n"," Amazon Attribution is available to US and UK vendors, as well as US seller brand owners. Amazon Attribution is a free measurement solution that provides visibility into how advertiser non-Amazon digital marketing tactics impact brand shopping activity on Amazon. Now available through the Amazon Ads API, tool providers can make Amazon metrics, including detail page views, add to carts, and purchases, conveniently available to their clients without having to log into the Amazon Attribution console to manually create tags and download reports. Amazon Attribution reporting through the API is available for paid media campaigns that drive clicks to an Amazon product or Stores page.\n"," Now tool providers who integrate with the Amazon Attribution API can help their clients optimize their non-Amazon media based on how shoppers discover, research, and buy products on Amazon. Through access to on-demand Amazon reporting, tool providers can offer their clients a unified view of campaign performance, with Amazon conversions displayed alongside existing digital marketing metrics. With Amazon reporting now available through the API, tool providers can also leverage their algorithms to help improve their client campaign performance through multi-channel recommendations and automated bid/budget optimizations.\n"," The Amazon Attribution API is comprised only of GET calls; it does not require campaign management (CREATE or POST) calls. For more information about Amazon Attribution, and how to register your clients, visit the Amazon Attribution product page. For more details about how to integrate with Amazon Attribution, create tags for measurement through the API, or retrieve reporting, visit the reference documentation.\n"," Sponsored Display product targeting is now available in the Amazon Ads API for sellers in the UK, FR, ES, IT, DE, AE and JP for professional sellers enrolled in the Amazon Brand Registry and vendors. This functionality was previously only available in the US & CA through the API. Product targeting for Sponsored Display gives sellers and vendors additional opportunities to reach and re-engage shoppers. Product targeting enables advertisers to promote product discovery, measure campaigns more effectively by targeting specific products or relevant product categories on Amazon, and gain greater line of sight into campaign optimization. Sellers and vendors now have the ability to: target multiple ASINs within campaigns, access detailed reporting, leverage flexible bidding options, and broaden category targeting capabilities. Product targeting in Sponsored Display brings audiences closer to the point of purchase and helps brands stay top of mind. Product targeting ads may appear alongside product description pages, customer reviews, shopping results pages, or under the featured offer.\n"," For more information see our Sponsored Display documentation in the Amazon Ads API.\n"," Today we are announcing several updates to the Amazon DSP API reporting functionality. Updates include the addition and deprecation of several new features for beta customers. Please note some of these may be breaking changes which will go into effect 8/31. \n"," New! Audience and Inventory Reports: Amazon DSP API customers can now generate AUDIENCE and INVENTORY reports, in addition to CAMPAIGN report types. Audience reports enable you to generate campaign metrics summarized by audience segment targeting method. Inventory reports enable you to generate campaign metrics summarized by site and supply source. More details about how to generate Audience and Inventory reports, and which fields are included in each report type, are available in the reference documentation.\n"," New! Longer date ranges: You can now generate Amazon DSP reports for up to 31 days by specifying a startDate and endDate. The startDate can be up to 90 days from the report request date. By default, metrics will be at the SUMMARY time unit and aggregated over the specified time period. To generate a report with a daily breakdown, you can specify DAILY in the timeUnit object. For more details about how to generate reports across longer date ranges, see the reference documentation. With the introduction of startDate and endDate, we will no longer support reportDate after 8/31.\n"," Changes to default metrics when no Metrics are specified. Currently reports generated through the API contain all available metrics for a given report type and dimension if no metric names are specified in the metrics object. Starting 8/31, only the default fields will be returned when metrics are empty in the report request. For a list of default metrics by reporting dimension, and all available metric fields to include on your report request, see the reference documentation.\n"," New! Support for Additional Currencies and Updated Sales Fields: Campaign reports now include an orderCurrency field by default, which returns the currency used for the order. With the addition of the orderCurrency field, we added four new fields: sales14d, totalSales14d, newToBrandProductSales14d, and totalNewToBrandProductSales14d. The values reported in these and spend-related fields will be based on the currency value returned in the orderCurrency field. With the addition of the new Sales fields mentioned above, we will deprecate the currency-specific sales fields: salesUSD14d, salesGBP14d, salesJPY14d, etc. on 8/31.\n"," New! Additional Metadata: You can now specify advertiserCountry and advertiserTimezone in the metrics field when you create a report request to have these fields returned in the report. In addition, orderCurrency is added by default when ORDER is specified in the dimensions object.\n"," We will notify developers in a release note when audiences functionality transitions from preview to generally available.\n"," Advertisers can now add negative product targeting to Sponsored Products auto targeting campaigns through the API. You can use the search term report to find products to add as negative targets based on performance. Learn more in our reference documentation.\n"," Product eligibility helps advertisers understand which products are eligible for advertising and what actions to take to resolve issues, such as when a product is not the featured offer, is out of stock, or is in a restricted category. You can retrieve the Sponsored Products and Sponsored Brands eligibility status for a given list of products (ASINs or SKUs) associated in your Seller or Vendor Central account. If products are ineligible for advertising, a status update will be provided explaining why the product is ineligible so that you can take action to activate them. For more information, see the reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"July 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Developers can now retrieve custom text as a read-only field from any applicable Sponsored Products (SP) ad. Custom Text for SP provides book advertisers in the United States with a 150 character text string to describe their book beyond just their title and format. This text is displayed in the creative treatment for certain SP placements and provides shoppers with additional information about the advertised book. \n"," Sponsored Display (beta) product targeting is now available in the Amazon Ads API for sellers in the US & CA for professional sellers enrolled in the Amazon Brand Registry and vendors. Product targeting for Sponsored Display gives sellers and vendors additional opportunities to reach and re-engage audiences in combination with views audiences. Product targeting enables advertisers to promote product discovery, measure campaigns more effectively by targeting specific products or relevant product categories on Amazon, and gain greater line of sight into campaign optimization. Sellers and vendors now have the ability to: target multiple ASINs within campaigns, access detailed reporting, leverage flexible bidding options, and broaden category targeting capabilities. Product targeting in Sponsored Display brings audiences closer to the point of purchase and helps brands stay top of mind. Product targeting ads may appear alongside product description pages, customer reviews, shopping results pages, or under the featured offer.\n"," For more information see our updated Sponsored Display documentation in the Amazon Ads API.\n"," Advertisers can now negatively target products or brands when using Sponsored Display (beta) product targeting through the Amazon Ads API. Adding products or brands as negative targets prevent ads from displaying when a shopper browses product pages that match those negative targets. For more information, see the reference documentation.\n"," Title Authority Validation, which prevents repetitive images from appearing in Sponsored Brands (SB) book campaigns, is now available in the SB API for advertisers in the United States. SB campaigns require advertisers to select three ASINs, and for book campaigns, those ASINs must be associated with different titles to avoid displaying repetitive products in the same ad. For more information, see the reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"June 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Product eligibility helps advertisers understand which products are eligible for advertising and what actions to take to resolve issues, such as when a product is not the featured offer, is out of stock, or is in a restricted category. You can retrieve the Sponsored Products and Sponsored Brands eligibility status for a given list of products (ASINs or SKUs) associated in your Seller or Vendor Central account. If products are ineligible for advertising, a status update will be provided explaining why the product is ineligible so that you can take action to activate them. For more information, see the reference documentation.\n"," Support for a new Kindle Direct Publishing (KDP) author identifier is now available as a vendor subtype in the Amazon Ads API. With this release, it is possible to identify Authors programmatically, providing developers with the ability to control access to features or differentiate the customer experience. We also added KDP Author ASIN Validation for Sponsored Products, already enforced in the Amazon Ads Console, which prevents KDP Authors from promoting ASINs outside of their KDP catalogs. This implementation moves us closer to achieving parity between the Advertising Console UI and API for books advertisers. For more information, see the reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"May 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We added support for Australia and United Arab Emirates for Sponsored Products product targeting on the API. For more information see our updated Sponsored Products product targeting documentation.\n"," Advertisers, agencies and tool providers can now leverage the Amazon Ads API to retrieve reports for all their Amazon DSP campaigns worldwide. Users can filter results by advertiser IDs and specify a list of metrics from over 400 available. Metrics are available at the order, line item, and creative levels. This API functionality saves agencies and advertisers hours spent retrieving reports manually. Additionally, it will make it easier for advertisers to retrieve reports in the tools they use to manage other marketing channels. This functionality is available to advertisers, tool providers and agencies that have self-service access to Amazon DSP. To get started, follow the steps outlined in setting up.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"April 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Product eligibility helps advertisers understand which products are eligible for advertising and what actions to take to resolve issues, such as when a product is not the featured offer, is out of stock, or is in a restricted category. Advertisers can retrieve the Sponsored Products eligibility status for a given list of products (ASINs or SKUs) associated in your Seller Central account. If products are ineligible for advertising, a status update will be provided explaining why the product is ineligible so that you can take action to activate them. For more information, see the reference documentation.\n"," Sponsored Display now enables you to separately manage the two default audience segments for views campaign - those who viewed your advertised products (exactProduct) and those who viewed similar products (similarProduct). Advertisers are now able to: add separate bids for each audience segment, and pause or restart delivery to either of the two audience segments.\n"," The feature is now available for all vendors and professional sellers enrolled in the Amazon Brand Registry in the US for views campaigns created after October 29. For more information see the Sponsored Display targeting resource in the Amazon Ads API. We plan to support targeting level reporting with future API functionality.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"March 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Sponsored Display has launched new features for suggested products and product readiness status for sellers using views targeting on the Amazon Ads API. The new functionality will provide a readiness score for each product of high, medium, or low, based on estimated reach and performance. A high, medium, or low score will indicate products that have a high, medium, or low amount of product detail page visits in the last 28 days. When creating audiences based on views, we recommend selecting products with high product detail page views to reach a larger audience. With the new option, you can now quickly launch a campaign with products that have the recommended product detail page views to help achieve effective scale.\n"," This functionality is now available in the US for all sellers creating new Sponsored Display views campaigns. For more information see the Sponsored Display suggested products reference in the Amazon Ads API.\n"," The Amazon Ads API now allows users to create, get, update, and delete draft Sponsored Brands campaigns created with product targeting. The API can also be used to submit product targeting draft campaigns for moderation approval. This capability allows advertisers to make changes and save them as drafts. To learn more, see the Sponsored Brands draft campaign reference documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"January 2020 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" In October 2019, we changed the way we calculate daily budgets for Sponsored Brands campaigns. With this update, budgets for new Sponsored Brands campaigns are calculated as an average over the course of the calendar month. This allows you to spend up to 10% more than your average daily budget while ensuring you do not spend more than the monthly budget (daily budget you have set, multiplied by the number of days in that month).\n"," Starting February 2020, Sponsored Brands campaigns created on or before October 8, 2019, with a daily budget will now be calculated as an average over the course of the calendar month. Visit our Support Center to learn more.\n"," We have added support for United Arab Emirates (AE) to the API. For more details see the API endpoints and keyword bid constraints by marketplace sections of the overview, the regional profile time zone codes section of the profiles reference, and the countryCode parameter of the registerProfile and registerBrands operations. \n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"December 2019 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Use the keyword placement report to get better insight into your keyword performance across different placement types. For more information, see the segmentation section of keyword placement reporting.\n"," Reporting for Sponsored Display campaigns that use interest and product audiences is now available. This functionality allows users to retrieve reports for recently created Sponsored Display campaigns that use these audiences and for Sponsored Display campaigns that were previously Product Display Ads (PDA) campaigns. This functionality is only relevant for vendors as we have not rolled out Sponsored Display interest and product audiences for sellers yet. For more information, see the Sponsored Display reporting documentation. Advertisers can use this functionality in US, CA, UK, FR, ES, IT, DE, and JP.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"November 2019 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Search term reports give visibility into the search terms entered by shoppers searching on Amazon that resulted in at least one click. You can use this report to identify high performing searches from shoppers and to create negative keywords for search terms that do not meet your goals. For more information, see the search term reports documentation. \n"," Reporting for Sponsored Display campaigns that use interest and product audiences is now available. This functionality allows users to retrieve reports for recently created Sponsored Display campaigns that use these audiences and for Sponsored Display campaigns that were previously Product Display Ads (PDA) campaigns. This functionality is only relevant for vendors as we have not rolled out Sponsored Display interest and product audiences for sellers yet. For more information, see the Sponsored Display reporting documentation. Advertisers can use this functionality in US and CA. We will also be rolling out this functionality in UK, FR, ES, IT, DE, JP, and IN soon and will make an announcement in a release note on this page, so check back regularly.\n"," Data providers can now use the Amazon Ads API to create and update audiences that advertisers can use in the Amazon DSP. This provides advertisers with more choice in their audience management. Using new endpoints, API users can edit audience descriptions and add or remove records from an existing audience. To use this functionality, follow the getting started process and review the documentation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"October 2019 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Version 3 of the API includes functionality that was released in open beta earlier this year with no additional changes. Version 3 of API introduces elements that are specific to Sponsored Brands and changes that improve the ease of use of the API. For Sponsored Brands specific elements, the new version of the API introduces the ability to create a Sponsored Brand campaign via the API, upload and retrieve creative assets, retrieve the brand associated with a specific profile, and access creative and landing page information in the Sponsored Brands campaign object. The new version of the API adheres to OpenAPI standards, a widely adopted standard for documenting APIs. This functionality is available to all developers that have access to the Amazon Ads API. Note we are not announcing plans to deprecate version 1 or 2 at this time. To learn more, visit the reference documentation section or the FAQ section in the developer portal and make sure to see this section on Sponsored Brands moderation and campaign life-cycle status.\n"," We have added an RSS feed to the developer portal. The RSS feed allows developer portal users to receive notifications any time there are changes to the API, making it easier to stay up to date. To subscribe to the RSS feed, right-click the RSS icon at the top right of this page, copy the link, and add it to your RSS aggregator.\n"," We have made changes to the default view of the content. The documentation version picker drop-down box now displays the latest version of the reference for each product in the Amazon Ads API in a single view by default. This makes it easier to navigate through the latest reference documentation for all products. If you would like to see previous versions, select \"previous\" from the drop-down box above the table of contents. You can get back to the latest version by selecting \"latest\" from the same drop-down box. \n"," Ad groups are a way to organize and manage Sponsored Products ads within a campaign. Advertisers can use ad groups to group their ads by brand, product, category, price range, or other classifications like theme or targeting strategy. Previously, an error was returned if an account associated with a vendor attempted to create a campaign that included multiple ad groups. With this change, vendors can specify multiple ad groups in campaign create and update operations. See the Amazon Ads support center for more information on ad groups, and the create and update operations in the Developer Portal for more information about using ad groups with the API.\n"," We have released functionality to provide moderation outcomes for Sponsored Brands campaigns though the Amazon Ads API. New moderation endpoints provide guidance to users to assist them in fixing non-approved Sponsored Brands campaigns. The guidance includes information about the reasons the campaign was rejected and links to relevant ad policies for additional explanation. Note that this release is currently available only in the US marketplace. For more information see the Sponsored Brands moderation reference.\n"," Sponsored Brands now offers a new, simple way to execute brand advertising strategies such as category expansion and brand reach strategies. The new product targeting option allows advertisers to target ads for categories they can refine by brand, price or star reviews. With product targeting, advertisers can engage more shoppers still exploring at a category level. With this release we are also making reporting available for campaigns that use product targeting expressions. Product targeting is currently in open beta. For more information see the Sponsored Brands product targeting reference.\n"," Reporting for Sponsored Display campaigns that use interest and product audiences is now available in the sandbox endpoint. This functionality allows users to retrieve reports for recently created Sponsored Display campaigns that use these audiences and for Sponsored Display campaigns that were previously Product Display Ads campaigns. This functionality is only relevant for vendors as we have not rolled out Sponsored Display interest and product audiences for sellers yet. For more information, see the Sponsored Display reporting documentation. Advertisers can use the sandbox endpoint for testing, and will soon be available in an open beta in US, CA, UK, FR, ES, IT, DE, JP, and IN. We will make the announcement in a release note on this page, so check back regularly.\n"," Advertisers can now specify a monthly budget at the Portfolio level that is automatically renewed at the beginning of each month. A recurring budget can be set when a Portfolio is created or updated. For more information about the change to the API, see the createPortfolios and updatePortfolios operations. For more information about budgets, see Portfolio budgets in the Amazon Ads support center.\n"," Daily Budget for Sponsored Brands has changed. New campaigns with a daily budget are calculated as an average over a calendar month, just like Sponsored Products campaigns. Learn more at the Amazon Ads support center.\n"," Advertisers can now edit the name field for Sponsored Brands campaigns. For more details, see the updateCampaign operation.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"September 2019 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Sponsored Display, a new self-service advertising solution that helps advertisers grow their business by reaching relevant audiences both on and off Amazon, is now available through the API. Functionality available today includes create, read, update, delete, and report functionality for Sponsored Display views audiences. Sponsored Display campaigns that use views audiences reach shoppers off Amazon who visited a product detail page or detail pages of similar products but did not make a purchase.  For more information, see the reference documentation. \n"," Earlier today we announced that Product Display Ads campaigns are now part of Sponsored Display, included as campaigns that use product and interest audiences. While this functionality is not yet available through the API, we have published preview documentation for reporting of Sponsored Display campaigns that use product and interest audiences. We are sharing this documentation to help developers plan future implementation. When this functionality becomes available,  we will notify users in a release note on this page. \n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"August 2019 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" Keyword recommendations for Sponsored Brands Campaigns are now available using the API. Advertisers can get keyword recommendations for ASINs that are associated with either a custom landing page, a Store page, or for vendors, a custom landing page. For a simple landing page, ASINs are passed as an array, while just the URL is passed for either a Store page or a custom landing page. To learn more, see the keywords recommendation documentation. \n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"July 2019 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We have added three new category targeting refinements to Sponsored Products: shipping eligibility, genre, and product age range. Each new refinement should help advertisers expand reach and target ads more granularly. With shipping eligibility advertisers can target Prime or non-Prime shipping eligible products, and with genre and product age range targeting advertisers can easily refine targeting for nuanced categories. To learn more, see the product targeting documentation.\n"," Negative keywords prevent ads from displaying when a shopper search terms match negative keywords. Negative keywords can be used with broad, phrase, and exact match types to prevent ads from being displayed.\n"," We added new metrics to Sponsored Brands reports. The new metrics include units, detail page views, and orders. To learn more, see the Sponsored Brands metrics documentation.\n"," The Amazon Ads API now allows users to create, get, update, and delete campaigns that are in a draft state. The API can also be used to submit draft campaigns for moderation approval. To learn more, see the Sponsored Brands draft campaign reference documentation.\n"," This week we will release functionality advertisers can use to engage shoppers with dynamically optimized Sponsored Brand ads. The new product optimization feature automatically selects the most contextually relevant ASINs from a Store or landing page so ads change to match each search. Users can set one campaign for an entire Store or landing page and let Amazon find the relevant products to show in the ad that best match the shoppers search. For more details see relevant documentation here.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"June 2019 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We added functionality enabling users to get Stores information associated with a profile. Users can now get the name and URL for both a Store and its sub pages. This makes it easy for users to find and use Store data when creating a Sponsored Brands campaign.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"May 2019 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" We launched the ability to create Sponsored Brands campaigns via the Amazon Ads API.  This release also introduces version 3 of the API.  This release will bring the Amazon Ads API close to parity with the advertising console for sponsored ads. To learn more visit the blog post, relevant documentation section or the FAQ section in the developer portal. Also, make sure to see the developer notes on Sponsored Brands moderation and campaign life-cycle status.\n"," Target object will now include a ResolvedExpression element for product target methods like getTargetingClause, listTargetingClauses, getNegativeTargetingClause, and listNegativeTargetingClauses. The added element will display the brand or category name for each brand and category included in a target expression. We implemented this improvement based on customer feedback.. To learn more about targeting expression see documentation here.\n"," Sponsored Brands now offers broad match modifiers. Users that want a certain word to always appear in any broad matched keyword can add a broad match modifier by adding a + symbol before the word. For example, if using a keyword +men shoes with broad match, then the ad will only match to queries that contain the word men. The ad may match to men sneakers, or running shoes for men etc. but not to running shoes.\n"," Sponsored Brands broad match now include words that are variations such as plurals, synonyms or other words related to the keyword. For example, an advertiser ad targeting shoes using broad match may show on shopper query for sneakers.  This helps advertisers reach even more shoppers who may be interested in your products. \n"," Users can add the modifiers through API by adding a + symbol before the word.\n"," Advertisers that use the API to create Sponsored Products campaigns can set different bids per different automatic targeting groups (close match, loose match, substitutes, complements) when they create a campaign. This feature is only available through the API, in the advertising console users can only modify bids per targeting group once a campaign has already been created, for auto targeting documentation see here\n"," We launched the ability to retrieve bid recommendations for target expressions. With this functionality users can get recommendations for keywords, product targeting and automatic targeting expressions. For more details see documentation here\n"," We added support for Australia via the API. For more details see these developer portal sections: endpoints and supported countries, keyword bid constraints, regional profile time zone codes and register profile country list.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"March 2019 release notes"},"path":"/en-us/release-notes/archive/ads-api","content":[" New-to-brand metrics for Sponsored Brands are now available in the Amazon Ads API. New-to-brand metrics determine whether an ad-attributed purchase was made by an existing customer or one buying a brand product on Amazon for the first time over the prior year. With new-to-brand, advertisers receive campaign performance metrics such as total new-to-brand purchases and sales, new-to-brand purchase rate, and cost per new-to-brand customer. See  documentation here.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"New or changed objects - January 2019"},"path":"/en-us/release-notes/archive/ads-api","content":["| Entity or service level | Detail |\n","\\| --- \\| --- \\|\n","| Profiles and Supported features | Availability of new marketplace, Japan (JP). Added JP to regional profile time zone codes and JPY currency code to resource representation in Profiles. See additions in Supported Features for Far East (FE) API endpoint and keyword bid constraints for JP marketplace. |\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":2,"text":"Advertising API version advance to v2"},"path":"/en-us/release-notes/archive/ads-api","content":[],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"Advertising terminology and name changes "},"path":"/en-us/release-notes/archive/ads-api","content":[" We recently announced that we are now simply, Amazon Ads. With this, we retired the names Amazon Media Group (AMG), Amazon Marketing Services (AMS), and Amazon Ads Platform (AAP), and announced a simplified product portfolio. This change impacts API users because of syntax built into the structure of the API. The documentation for v2 will continue to reference the older product names in the technical reference sections. A key is provided below to assist in transition to the new terminology.\n","| New terminology| Retired terms |\n","\\| --- \\| --- \\|\n","| Amazon Ads |-\tAmazon Marketing Services (AMS)-\tAmazon Media Group (AMG)-\tAmazon Ads Platform (AAP)\t |\n","| Sponsored Brands (SB) | Headline Search Ads (HSA) |\n","| Amazon DSP | Amazon Ads Platform (AAP) |\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"Requirements for API v2"},"path":"/en-us/release-notes/archive/ads-api","content":["All API calls must be routed to the new v2 endpoints.  -\tAll API calls to v2 endpoints must contain the Amazon-Advertising-API-ClientId header. \n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"Migrating from v1 to v2 "},"path":"/en-us/release-notes/archive/ads-api","content":[" Migrating to v2 means changing your application to use the new v2 endpoints. The API v1 will continue to be supported. Applications that call to v1 endpoints will not require modification to how they currently operate. Integration with v2 is required to access the new features available in v2 and is recommended preparation for future releases.\n"],"documentType":"release-note"},{"title":"Amazon Ads API release notes","sectionHeader":{"type":3,"text":"New or changed objects - October 2018"},"path":"/en-us/release-notes/archive/ads-api","content":["| Entity or service level | Detail |\n","\\| --- \\|\n","| Authorization | Client ID is now a required header for all requests to v2 endpoints. The Client ID header must match the case-sensitive Client ID encapsulated in the access token. This is the same Client ID found in the Web Settings section of the Login with Amazon App Console.The header of your request must contain: Amazon-Advertising-API-ClientId and your unique Client ID.|\n","| Profiles | URL endpoint for profiles changed to /v2/profiles. |\n","| Profiles | There is a new field for Profile objects which are now differentiated by the filter: type. This filter has possible values of: vendor or seller |\n","| Profiles | There is a new field for Profile objects called id that replaces sellerStringId and brandEntityId |\n","| Profiles | Removed the fields: sellerStringId and brandEntityId |\n","| Profiles | The field brandNamehas been renamed to name |\n","| Campaigns | URL endpoint for campaigns changed to /v2/sp/campaigns for Sponsored Products. Endpoint changed to /v2/hsa/campaigns for Sponsored Brands. |\n","| Campaigns | POST method is not supported for Sponsored Brands, new campaigns must be created through the user interface. |\n","| Ad groups | URL endpoint for ad groups changed to /v2/sp/adGroups. Ad groups can only be managed for Sponsored Products and do not apply to Sponsored Brands. |\n","| Ad group biddable keywords | URL endpoint for keywords changed to /v2/sp/keywords for Sponsored Products. Endpoint changed to /v2/hsa/keywords for Sponsored Brands. |\n","| Ad group biddable keywords | Keywords operations support up to 1000 keywords per request for Sponsored Products. |\n","| Ad group biddable keywords | Keywords operations support up to 100 keywords per request for Sponsored Brands. |\n","| Ad group biddable keywords | The adGroupId is a required field for updating keywords for Sponsored Brands through the API. There is only one ad group allowed per campaign and it acts like a placeholder. You will receive the adGroupId as part of the response object for a GET keywords request. |\n","| Ad group negative keywords | URL endpoint for ad group negative keywords changed to /v2/sp/negativeKeywords. Negative keywords are not used with Sponsored Brands. |\n","| Campaign negative keywords | URL endpoint has been changed to /v2/sp/campaignNegativeKeywords for Sponsored Products. Campaign negative keywords are not used for Sponsored Brands. |\n","| Suggested keywords | URL endpoint for Sponsored Products suggested keywords operations has been changed to: /v2/sp/AdGroups/{adGroupId}/suggested/keywords. The change is to use /sp/ to specify Sponsored Products. Suggested keywords are not used for Sponsored Brands. |\n","| Product ads | URL endpoint for product ads changed to /v2/sp/productAds for Sponsored Products. Not used with Sponsored Brands. |\n","| Bid recommendations | URL endpoint for bid recommendations changed to /v2/sp/{record type}/{entity id}/bidRecommendations for Sponsored Products. Not used with Sponsored Brands. |\n","| Reports | Separate URL endpoints for Sponsored Products and Sponsored Brands for reports operations. Changed to: /v2/{sp or hsa}/ |\n","| Reports | URL endpoint for ASINs reports changed to: /v2/asins/report. |\n","| Entity snapshots | Separate URL endpoints for Sponsored Products and Sponsored Brands for snapshots POST operations. Changed to: /v2/{sp or hsa}/ |\n"],"documentType":"release-note"},{"title":"Amazon Marketing Stream release notes","sectionHeader":null,"path":"/en-us/release-notes/archive/amazon-marketing-stream","content":[" This document contains release notes related to Amazon Marketing Stream before 2023. For more recent announcements, see Release notes.\n"],"documentType":"release-note"},{"title":"Amazon Marketing Stream release notes","sectionHeader":{"type":2,"text":"December 2022"},"path":"/en-us/release-notes/archive/amazon-marketing-stream","content":[],"documentType":"release-note"},{"title":"Amazon Marketing Stream release notes","sectionHeader":{"type":3,"text":"Sponsored Display now available in Amazon Marketing Stream (beta) in North America"},"path":"/en-us/release-notes/archive/amazon-marketing-stream","content":[" Amazon Marketing Stream (beta) has now expanded to include Sponsored Display in North America, allowing partners and advertisers to receive performance metrics and information on campaign changes in near real time. Information is pushed to advertisers and partners through the Amazon Ads API, eliminating the need to aggregate metrics over time to understand the changes between hourly performance, and enabling timely notifications on campaign changes. \n"," Amazon Marketing Stream can help you improve Sponsored Display performance with traffic and performance metrics summarized hourly instead of daily, informing intra-day optimizations. Advertisers and partners will also receive timely notifications on campaign changes that can help you take actions in near real time, such as a campaign going out of budget.  \n"," New metrics available through this Sponsored Display launch include new-to-brand metrics and view-based attribution for vCPM (cost-per-thousand viewable impressions) campaigns, summarized hourly. Amazon Marketing Stream can help you understand Sponsored Display campaign KPIs such as impressions, clicks, attributable sales, orders, and new-to-brand sales, broken down by hour of day. For example, you may learn that new-to-brand attributed sales, units and orders are higher during hours 8pm-10pm, informing hourly bid adjustments. You can also determine when views or clicks (vCPM) lead to more conversions, by hour of day.\n"," When you are ready to get started, visit the Amazon Marketing Stream onboarding guide.\n"],"documentType":"release-note"},{"title":"Amazon Marketing Stream release notes","sectionHeader":{"type":2,"text":"October 2022"},"path":"/en-us/release-notes/archive/amazon-marketing-stream","content":[],"documentType":"release-note"},{"title":"Amazon Marketing Stream release notes","sectionHeader":{"type":3,"text":"Amazon Marketing Stream (beta) global launch (except IN)"},"path":"/en-us/release-notes/archive/amazon-marketing-stream","content":[" We are excited to expand Amazon Marketing Stream (beta) to all countries currently supported by the Amazon Ads API, with the exception of India. Amazon Marketing Stream is a new service that delivers Amazon Ads campaign metrics and information to advertiser or integrator AWS accounts via a push-based model in near real time. You can subscribe to Amazon Marketing Stream datasets using your API token and by providing your AWS account details. Once you are subscribed, Amazon Marketing Stream delivers hourly, near real-time performance metrics, with details such as targeting expression performance by placement, and budget consumption messages. Other campaign datasets will be available for subscription in the coming months. The service, which was first launched for North America (United States, Canada, and Mexico) on June 21, 2022, is now available globally (except in India).\n"," Amazon Marketing Stream can help in the following ways:\n","Optimize campaigns more effectively: Hourly performance metrics provide intra-day insights for advanced campaign optimization. For example, during certain hours of the day when your conversion rate is high, you may want to increase bid amounts or make sure your campaign stays in budget during that time. Sponsored Products performance metrics from Amazon Marketing Stream enables new dimensions such as the combination of targeting expression and ad placement, so you can not only optimize on your keywords but keywords by placement.  Respond quickly to campaign changes: Near real-time information such as budget consumption can help advanced API users write responsive applications for further optimization. For example, they may want to increase the campaign budget before it runs out.   Improve operational efficiency: Push-based information delivery eliminates API throttling. Moreover, Amazon Marketing Stream sends you performance metric and campaign information changes in near real time, instead of aggregated over a period of time. You can simplify complex technical operations — which today may entail comparing new aggregated API metrics with the previously pulled metrics, to understand the delta between the two. Instead, Amazon Marketing Stream delivers that delta to you.\n"," Since its launch in North America, customers have been keen to expand the value of Stream globally, and we are excited to address this request. While the above are some common ways in which we believe our customers - agencies, tool providers, and advertisers - will find Amazon Marketing Stream valuable, the ingenuity in using our products to solve problems in unimagined ways has been inspiring. We look forward to learning from our customers and continuing to evolve the product.\n"," Amazon Marketing Stream will be only available via the Amazon Ads API. To learn more about how to onboard onto Amazon Marketing Stream, read the Onboarding guide.\n"],"documentType":"release-note"},{"title":"Amazon Marketing Stream release notes","sectionHeader":{"type":2,"text":"July 2022"},"path":"/en-us/release-notes/archive/amazon-marketing-stream","content":[],"documentType":"release-note"},{"title":"Amazon Marketing Stream release notes","sectionHeader":{"type":3,"text":"Amazon Marketing Stream Postman collection"},"path":"/en-us/release-notes/archive/amazon-marketing-stream","content":[" The Amazon Ads API Postman collection now supports the Amazon Marketing Stream subscription APIs. Advertisers and integrators can use the collection to create and manage Amazon Marketing Stream subscriptions, and view example calls to the API. \n"," To learn more about getting started with Postman, see our Postman tutorial. \n"],"documentType":"release-note"},{"title":"Amazon Marketing Stream release notes","sectionHeader":{"type":3,"text":"Amazon Marketing Stream CloudFormation template"},"path":"/en-us/release-notes/archive/amazon-marketing-stream","content":[" You can now use a CloudFormation template to streamline the Amazon Marketing Stream onboarding process. AWS CloudFormation provides an Infrastructure as Code (IaC) approach to managing your SQS queues and policies. With the template, you can use CloudFormation to programmatically create queues and apply the relevant IAM policy. \n"," To get started using CloudFormation, read our CloudFormation onboarding guide. You can find the CloudFormation template in the ads-advanced-tools GitHub repository.\n"],"documentType":"release-note"},{"title":"Amazon Marketing Stream release notes","sectionHeader":{"type":2,"text":"June 2022"},"path":"/en-us/release-notes/archive/amazon-marketing-stream","content":[],"documentType":"release-note"},{"title":"Amazon Marketing Stream release notes","sectionHeader":{"type":3,"text":"Amazon Marketing Stream (Beta)"},"path":"/en-us/release-notes/archive/amazon-marketing-stream","content":[" Regions: US, CA, MX\n"," Amazon Marketing Stream has launched to open beta, allowing partners and advertisers to receive campaign data in near real time, without needing to repeatedly call the API. Amazon Marketing Stream offers new capabilities compared with an API-based reporting approach, including traffic and conversion data summarized hourly instead of daily, less throttling, additional reporting dimensions, and better insights on deltas instead of aggregates. \n"," In the past, access to scaled campaign reporting was limited to pull-based API calls that provided daily performance. In addition, the API needed to be called multiple times throughout the day, which led to throttling and a less efficient workflow.  \n"],"documentType":"release-note"}]}